models

type AuthorizationAddedEventData struct {
	EventType string `json:"event_type"`

	// Scope The OAuth scope that was granted with this authorization. Today
	// the only scope in use is `endpoints:manage`; additional scopes may
	// be introduced in future revisions of this API.
	Scope  string     `json:"scope"`
	Tenant TenantInfo `json:"tenant"`
}

type AuthorizationRevokedEventData struct {
	EventType string `json:"event_type"`

	// Scope The OAuth scope of the authorization that was revoked. Today the
	// only scope in use is `endpoints:manage`; additional scopes may be
	// introduced in future revisions of this API.
	Scope string `json:"scope"`

	// TenantId The tenant whose authorization was revoked.
	TenantId openapi_types.UUID `json:"tenant_id"`
}

type ConfirmMessagesJSONRequestBody = ConfirmMessagesRequest

type ConfirmMessagesParams struct {
	// XAgrirouterTenantId The farmer's tenant ID in relation to which communication is done.
	XAgrirouterTenantId XAgrirouterTenantId `json:"x-agrirouter-tenant-id"`
}

type ConfirmMessagesRequest struct {
	// Confirmations List of message confirmations.
	Confirmations []MessageConfirmation `json:"confirmations"`
}

type DeleteEndpointParams struct {
	// XAgrirouterTenantId The farmer's tenant ID in relation to which communication is done.
	XAgrirouterTenantId XAgrirouterTenantId `json:"x-agrirouter-tenant-id"`
}

type Endpoint struct {
	// AllowDeleteByUser Flag indicating whether the user is allowed to delete this endpoint.
	AllowDeleteByUser *bool                `json:"allow_delete_by_user,omitempty"`
	ApplicationId     openapi_types.UUID   `json:"application_id"`
	Capabilities      []EndpointCapability `json:"capabilities"`

	// ConnectionsUri URI pointing to where the user can manage the entity connected to this endpoint, e.g. to disconnect or delete equipment from an equipment vendor.
	ConnectionsUri    *string            `json:"connections_uri,omitempty"`
	EndpointType      EndpointType       `json:"endpoint_type"`
	ExternalId        string             `json:"external_id"`
	Id                openapi_types.UUID `json:"id"`
	SoftwareVersionId openapi_types.UUID `json:"software_version_id"`

	// TenantId The tenant ID of the endpoint
	TenantId string `json:"tenant_id"`
}

type EndpointCapability struct {
	Direction EndpointCapabilityDirection `json:"direction"`

	// MessageType The message type that the endpoint can send or receive.
	// See available types here:
	// https://docs.agrirouter.com/agrirouter-interface-documentation/latest/tmt/overview.html
	MessageType string `json:"message_type"`
}

type EndpointCapabilityDirection string

type EndpointDeletedEventData struct {
	EventType string `json:"event_type"`

	// ExternalId The external ID of the deleted endpoint, which was provided when creating or updating the endpoint.
	ExternalId string `json:"external_id"`

	// Id The agrirouter endpoint ID of the deleted endpoint.
	Id openapi_types.UUID `json:"id"`
}

type EndpointRouteMap map[string][]string

type EndpointSubscription struct {
	// MessageType The message type that the endpoint is subscribed to.
	// See available types here:
	// https://docs.agrirouter.com/agrirouter-interface-documentation/latest/tmt/overview.html
	MessageType string `json:"message_type"`
}

type EndpointType string

type EndpointsListChangedEventData struct {
	// Endpoints Complete current list of endpoints in the tenant that are visible
	// to the application.
	Endpoints []TenantEndpointInfo `json:"endpoints"`
	EventType string               `json:"event_type"`

	// TenantId The tenant whose endpoint list changed.
	TenantId openapi_types.UUID `json:"tenant_id"`
}

type EndpointsListResponse struct {
	Endpoints []TenantEndpointInfo `json:"endpoints"`
}

type ErrorResponse struct {
	// Message A human-readable error message describing what went wrong.
	Message string `json:"message"`
}

type ExternalId = string

type FileReceivedEventData struct {
	EventType string `json:"event_type"`

	// Filename Optional name of the file that is attached to messages as metadata.
	Filename *string `json:"filename,omitempty"`

	// MessageIds List of agrirouter message IDs of the messages that carried the file payload chunks.
	// This is useful for confirming the messages after processing the file.
	MessageIds []openapi_types.UUID `json:"message_ids"`

	// MessageType The message type of the received payload.
	// See available types here:
	// https://docs.agrirouter.com/agrirouter-interface-documentation/latest/tmt/overview.html
	MessageType string `json:"message_type"`

	// Payload The payload of the file, base64 encoded.
	// Only one of `payload` or `payload_uri` can be present.
	Payload *[]byte `json:"payload,omitempty"`

	// PayloadUri The URI to access the payload. May have hostname that is different from
	// the API server, as payloads may be served from a different server or CDN.
	// Clients MUST use provided URI as is without any modifications.
	// If event embeds payload directly, this field would be absent.
	PayloadUri *PayloadURI `json:"payload_uri,omitempty"`

	// ReceivingEndpointId Internally-generated agrirouter ID of the receiving endpoint.
	ReceivingEndpointId openapi_types.UUID `json:"receiving_endpoint_id"`

	// Size The size of file payload in bytes.
	Size int64 `json:"size"`

	// TeamsetContextId The teamset context ID that was provided by sending application when sending the message, if any.
	TeamsetContextId *string `json:"teamset_context_id,omitempty"`

	// TenantId The tenant ID of the to which receiving endpoint belongs. This is useful for confirming messages back to agrirouter.
	TenantId *string `json:"tenant_id,omitempty"`
}

type GenericEventData struct {
	// contains filtered or unexported fields
}

type MessageConfirmation struct {
	// EndpointId The agrirouter endpoint ID that received the message.
	EndpointId openapi_types.UUID `json:"endpoint_id"`

	// MessageId The agrirouter message ID of the confirmed message.
	MessageId openapi_types.UUID `json:"message_id"`
}

type MessageReceivedEventData struct {
	// AppMessageId The application message ID of the received message, generated based on application input.
	AppMessageId string `json:"app_message_id"`
	EventType    string `json:"event_type"`

	// Filename Optional name of the file that is attached to messages as metadata.
	Filename *string `json:"filename,omitempty"`

	// Id The agrirouter message ID of the received message, generated by agrirouter.
	Id openapi_types.UUID `json:"id"`

	// MessageType The message type of the received message.
	// See available types here:
	// https://docs.agrirouter.com/agrirouter-interface-documentation/latest/tmt/overview.html
	MessageType string `json:"message_type"`

	// Payload The payload of the message, base64 encoded. Only one of `payload` or `payload_uri` would be present.
	Payload *[]byte `json:"payload,omitempty"`

	// PayloadUri The URI to access the payload. May have hostname that is different from
	// the API server, as payloads may be served from a different server or CDN.
	// Clients MUST use provided URI as is without any modifications.
	// If event embeds payload directly, this field would be absent.
	PayloadUri *PayloadURI `json:"payload_uri,omitempty"`

	// ReceivedAt The timestamp when the message was received by agrirouter.
	ReceivedAt *time.Time `json:"received_at,omitempty"`

	// ReceivingEndpointId Internally-generated agrirouter ID of the receiving endpoint.
	ReceivingEndpointId openapi_types.UUID `json:"receiving_endpoint_id"`

	// SentAt The timestamp when the message was sent by sending application.
	SentAt time.Time `json:"sent_at"`

	// TeamsetContextId The teamset context ID that was provided by sending application when sending the message, if any.
	TeamsetContextId *string `json:"teamset_context_id,omitempty"`

	// TenantId The tenant ID of the to which receiving endpoint belongs. This is useful for confirming messages back to agrirouter.
	TenantId *string `json:"tenant_id,omitempty"`
}

type PayloadURI = string

type PutEndpointJSONRequestBody = PutEndpointRequest

type PutEndpointParams struct {
	// XAgrirouterTenantId The farmer's tenant ID in relation to which communication is done.
	XAgrirouterTenantId XAgrirouterTenantId `json:"x-agrirouter-tenant-id"`
}

type PutEndpointRequest struct {
	// AllowDeleteByUser Flag indicating whether the user is allowed to delete this endpoint.
	// Note that even when this flag is not set, the user can still force deletion of the endpoint. Applications must handle the ENDPOINT_DELETED event on a best-effort basis. It is also possible that an endpoint is deleted immediately after creation due to a race with the user disconnecting the entire application, so applications should not rely on this flag to prevent endpoint deletion entirely.
	AllowDeleteByUser *bool `json:"allow_delete_by_user,omitempty"`

	// ApplicationId The ID of the application that owns the endpoint
	ApplicationId openapi_types.UUID `json:"application_id"`

	// Capabilities The effective capabilities of the endpoint, must be subset of the capabilities of software version.
	Capabilities []EndpointCapability `json:"capabilities"`

	// ConnectionsUri URI pointing to where the user can manage the entity connected to this endpoint, e.g. to disconnect or delete equipment from an equipment vendor. When provided, this URI will be shown when the user attempts to delete the endpoint, instead of the usual deletion dialog, directing them to the vendor's management page.
	ConnectionsUri *string      `json:"connections_uri,omitempty"`
	EndpointType   EndpointType `json:"endpoint_type"`

	// Name Optional name of the endpoint, for easier identification in agrirouter web interface.
	// Does not have to be unique.
	// If not specified, the name would be generated automatically.
	//
	// When provided, must be 1-200 characters long and may contain letters from any
	// script, digits, spaces, and the following special characters: `-`, `_`, `.`, `,`, `:`.
	// Names consisting only of whitespace are not allowed as well, which is not
	// expressed in the regex pattern.
	//
	// It is not guaranteed that this "application-set" name would be used,
	// because user may override it with "user-set" name in agrirouter web interface.
	// Name send via this API cannot override "user-set" name, but
	// it can update "application-set" name at any time and user can choose to
	// switch name back to "application-set".
	Name *string `json:"name,omitempty"`

	// SoftwareVersionId The ID of the software version that owns the endpoint
	SoftwareVersionId openapi_types.UUID     `json:"software_version_id"`
	Subscriptions     []EndpointSubscription `json:"subscriptions"`
}

type ReceiveEventsParams struct {
	// Types Events type filter, if provided would limit the events returned to only those of the specified types.
	// If not provided, all supported events will be streamed.
	Types *[]ReceiveEventsParamsTypes `form:"types,omitempty" json:"types,omitempty"`
}

type ReceiveEventsParamsTypes string

type RoutedEndpoints struct {
	// CanReceiveFrom Map keyed by agrirouter endpoint ID. Each value lists the message types
	// for which routing is currently possible between the two endpoints.
	CanReceiveFrom *EndpointRouteMap `json:"can_receive_from,omitempty"`

	// CanSendTo Map keyed by agrirouter endpoint ID. Each value lists the message types
	// for which routing is currently possible between the two endpoints.
	CanSendTo *EndpointRouteMap `json:"can_send_to,omitempty"`
}

type SendMessagesParams struct {
	// ContentLength The size of the complete payload in bytes.
	// This is used to determine if the payload needs to be
	// split into chunks and how.
	ContentLength int64 `json:"content-length"`

	// XAgrirouterIsPublish If set to true, the message will be sent as a published message
	// and any endpoints that are subscribed to the message type
	// would be able to receive it, provided other conditions for routing are met.
	XAgrirouterIsPublish bool `json:"x-agrirouter-is-publish"`

	// XAgrirouterDirectRecipients Comma-separated list of agrirouter endpoint IDs of the direct recipients.
	// Allows specifying direct recipients of the message, which
	// could receive it even if they are not subscribed to the message type.
	XAgrirouterDirectRecipients *[]openapi_types.UUID `json:"x-agrirouter-direct-recipients,omitempty"`

	// XAgrirouterSentTimestamp Client side timestamp of sending the data.
	XAgrirouterSentTimestamp time.Time `json:"x-agrirouter-sent-timestamp"`

	// XAgrirouterEndpointId The agrirouter endpoint ID of the sender.
	// This is the ID of the endpoint that is sending the message.
	XAgrirouterEndpointId openapi_types.UUID `json:"x-agrirouter-endpoint-id"`

	// XAgrirouterTeamsetContextId A teamset is a set of connected machines that work and move together
	// and are connected to the same (virtual) communication unit.
	// The machines in the teamset are typically connected physically and
	// informationally (for example via ISOBUS).
	XAgrirouterTeamsetContextId *string `json:"x-agrirouter-teamset-context-id,omitempty"`

	// XAgrirouterMessageType Message type of the sent data. See available types here:
	// https://docs.agrirouter.com/agrirouter-interface-documentation/latest/tmt/overview.html
	XAgrirouterMessageType string `json:"x-agrirouter-message-type"`

	// XAgrirouterTenantId The farmer's tenant ID in relation to which communication is done.
	XAgrirouterTenantId XAgrirouterTenantId `json:"x-agrirouter-tenant-id"`

	// XAgrirouterContextId Application side identifier of the sent data.
	// agrirouter will use this to generate application message id
	// and also will pass it on as chunk context id in case if the payload
	// had to be split into several messages.
	// This has to be generated by the application and be unique for
	// every sent payload. Applications may want to reuse the same id
	// in case if they are resending the same payload again, when f.e
	// retrying after a failure.
	XAgrirouterContextId string `json:"x-agrirouter-context-id"`

	// XAgrirouterFilename Optional name of the file that is attached to messages as metadata.
	XAgrirouterFilename *string `json:"x-agrirouter-filename,omitempty"`
}

type TenantEndpointCapabilities struct {
	// CanReceive Message types this endpoint can receive.
	CanReceive []string `json:"can_receive"`

	// CanSend Message types this endpoint can send.
	CanSend []string `json:"can_send"`
}

type TenantEndpointInfo struct {
	// ApplicationId The ID of the application that owns the endpoint.
	ApplicationId openapi_types.UUID         `json:"application_id"`
	Capabilities  TenantEndpointCapabilities `json:"capabilities"`
	EndpointType  EndpointType               `json:"endpoint_type"`

	// ExternalId External identifier of the endpoint, if available to the caller.
	ExternalId *string `json:"external_id,omitempty"`

	// Id The agrirouter endpoint ID.
	Id openapi_types.UUID `json:"id"`

	// Name Display name of the endpoint.
	Name string `json:"name"`

	// OwnedByYourApplication Indicates whether this endpoint belongs to the application that is authorized for the current request.
	OwnedByYourApplication bool `json:"owned_by_your_application"`

	// RoutedEndpoints Route-derived information for this endpoint.
	//
	// This property only exists for endpoints owned by the authorized
	// application. It is omitted for all other endpoints in the tenant.
	RoutedEndpoints *RoutedEndpoints `json:"routed_endpoints,omitempty"`

	// TenantId The tenant ID of the endpoint.
	TenantId openapi_types.UUID `json:"tenant_id"`
}

type TenantId = openapi_types.UUID

type TenantInfo struct {
	// Endpoints Endpoints visible in this tenant, subject to the following
	// privacy rule:
	//
	// - If the application has not yet created any endpoint of its own
	//   in this tenant, this array is empty — even if other endpoints
	//   exist in the tenant. This prevents exposing tenant contents to
	//   applications that have not yet actively participated in it.
	// - Once the application has at least one of its own endpoints in
	//   the tenant, this array contains the full set of endpoints
	//   visible to the application.
	//
	// An authorized tenant with no application-owned endpoint will
	// therefore still appear in `GET /tenants`, but with an empty
	// `endpoints` array. See `owned_by_your_application` on
	// `TenantEndpointInfo` for the distinction between own and other
	// endpoints.
	Endpoints []TenantEndpointInfo `json:"endpoints"`

	// TenantId Authorized tenant ID.
	TenantId openapi_types.UUID `json:"tenant_id"`
}

type TenantsListResponse struct {
	Tenants []TenantInfo `json:"tenants"`
}

type XAgrirouterTenantId = openapi_types.UUID