api

type Attachment struct {
	// ContentType Content type of the attached file in [MIME format](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types). Note that some attachments types may not be supported.
	ContentType string `json:"content_type"`

	// Filename Name of the attached file
	Filename string `json:"filename"`

	// Id The unique identifier of the attachment.
	Id string `json:"id"`

	// Metadata Attachment metadata
	Metadata struct {
		// Cid Unique identifier used to link an attachment to where it is used in the message body
		Cid *string `json:"cid,omitempty"`

		// IsInline Whether or not the attachment is part of the message body
		IsInline *bool `json:"is_inline,omitempty"`
	} `json:"metadata"`

	// Size Size (in byte) of the attached file
	Size int `json:"size"`

	// Url URL to download the attached file
	Url string `json:"url"`
}

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

type ClientInterface interface {
	// SearchConversations request
	SearchConversations(ctx context.Context, query string, params *SearchConversationsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetConversationById request
	GetConversationById(ctx context.Context, conversationId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListConversationMessages request
	ListConversationMessages(ctx context.Context, conversationId string, params *ListConversationMessagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListInboxes request
	ListInboxes(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListTeammateInboxes request
	ListTeammateInboxes(ctx context.Context, teammateId string, reqEditors ...RequestEditorFn) (*http.Response, error)
}

type ClientOption func(*Client) error

type ClientWithResponses struct {
	ClientInterface
}

type ClientWithResponsesInterface interface {
	// SearchConversationsWithResponse request
	SearchConversationsWithResponse(ctx context.Context, query string, params *SearchConversationsParams, reqEditors ...RequestEditorFn) (*SearchConversationsResponse, error)

	// GetConversationByIdWithResponse request
	GetConversationByIdWithResponse(ctx context.Context, conversationId string, reqEditors ...RequestEditorFn) (*GetConversationByIdResponse, error)

	// ListConversationMessagesWithResponse request
	ListConversationMessagesWithResponse(ctx context.Context, conversationId string, params *ListConversationMessagesParams, reqEditors ...RequestEditorFn) (*ListConversationMessagesResponse, error)

	// ListInboxesWithResponse request
	ListInboxesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListInboxesResponse, error)

	// ListTeammateInboxesWithResponse request
	ListTeammateInboxesWithResponse(ctx context.Context, teammateId string, reqEditors ...RequestEditorFn) (*ListTeammateInboxesResponse, error)
}

type Conversation = ConversationResponse

type ConversationResponse struct {
	UnderscoreLinks struct {
		Related *struct {
			// Comments Link to conversation comments
			Comments *string `json:"comments,omitempty"`

			// Events Link to conversation events
			Events *string `json:"events,omitempty"`

			// Followers Link to conversation followers
			Followers *string `json:"followers,omitempty"`

			// Inboxes Link to conversation inboxes
			Inboxes *string `json:"inboxes,omitempty"`

			// LastMessage Link to last message of the conversation
			LastMessage *string `json:"last_message,omitempty"`

			// Messages Link to conversation messages
			Messages *string `json:"messages,omitempty"`
		} `json:"related,omitempty"`

		// Self Link to resource
		Self *string `json:"self,omitempty"`
	} `json:"_links"`

	// Assignee A teammate is a user in Front.
	Assignee TeammateResponse `json:"assignee"`

	// CreatedAt Timestamp at which the conversation was created.
	CreatedAt *float32 `json:"created_at,omitempty"`

	// CustomFields An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields
	CustomFields CustomFieldParameter `json:"custom_fields"`

	// Id Unique identifier of the conversation
	Id string `json:"id"`

	// IsPrivate Whether or not the conversation is private
	IsPrivate bool `json:"is_private"`

	// Links List of the links for this conversation
	Links []LinkResponse `json:"links"`

	// Metadata Optional metadata about the conversation
	Metadata struct {
		// ExternalConversationIds List of external_ids for partner channel associated with the conversation. Only present for partner channel token authenticated requests.
		ExternalConversationIds *[]string `json:"external_conversation_ids,omitempty"`
	} `json:"metadata"`
	Recipient RecipientResponse `json:"recipient"`

	// ScheduledReminders List of scheduled (non-expired and non-canceled) reminders for this conversation
	ScheduledReminders []Reminder `json:"scheduled_reminders"`

	// Status Status of the conversation
	Status ConversationResponseStatus `json:"status"`

	// StatusCategory Status category of the conversation
	StatusCategory *ConversationResponseStatusCategory `json:"status_category,omitempty"`

	// StatusId Unique identifier of the conversation status category, only present if ticketing is enabled
	StatusId *string `json:"status_id,omitempty"`

	// Subject Subject of the message for email message
	Subject string `json:"subject"`

	// Tags List of the tags for this conversation
	Tags []TagResponse `json:"tags"`

	// TicketIds List of ticket ids associated with the conversation
	TicketIds []string `json:"ticket_ids"`

	// UpdatedAt Timestamp at which the conversation was last updated.
	UpdatedAt *float32 `json:"updated_at,omitempty"`

	// WaitingSince Timestamp of the oldest unreplied message.
	WaitingSince *float32 `json:"waiting_since,omitempty"`
}

type ConversationResponseStatus string

type ConversationResponseStatusCategory string

type CustomFieldParameter = map[string]interface{}

type GetConversationByIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Conversation
}

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

type InboxResponse struct {
	UnderscoreLinks *struct {
		Related *struct {
			// Channels Link to inbox channels
			Channels *string `json:"channels,omitempty"`

			// Conversations Link to inbox conversations
			Conversations *string `json:"conversations,omitempty"`

			// Owner Link to inbox owner
			Owner *string `json:"owner,omitempty"`

			// Teammates Link to inbox teammates
			Teammates *string `json:"teammates,omitempty"`
		} `json:"related,omitempty"`

		// Self Link to resource
		Self *string `json:"self,omitempty"`
	} `json:"_links,omitempty"`

	// CustomFields An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields
	CustomFields *CustomFieldParameter `json:"custom_fields,omitempty"`

	// Id Unique identifier for the inbox
	Id *string `json:"id,omitempty"`

	// IsPrivate Whether or not the inbox is individual
	IsPrivate *bool `json:"is_private,omitempty"`

	// IsPublic Whether or not the inbox is available to all members of a team by default
	IsPublic *bool `json:"is_public,omitempty"`

	// Name Name of the inbox
	Name *string `json:"name,omitempty"`
}

type Limit = int

type LinkResponse struct {
	UnderscoreLinks struct {
		// Self Link to resource
		Self *string `json:"self,omitempty"`
	} `json:"_links"`

	// CustomFields An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields
	CustomFields CustomFieldParameter `json:"custom_fields"`

	// ExternalUrl Underlying identifying external URL of the link
	ExternalUrl string `json:"external_url"`

	// Id Unique identifier of the link
	Id string `json:"id"`

	// Name Display name of the link
	Name string `json:"name"`

	// Type Type of the link. Typically associated with the underlying link provider (if known)
	Type string `json:"type"`
}

type ListConversationMessagesParams struct {
	// Limit Max number of results per [page](https://dev.frontapp.com/docs/pagination)
	Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`

	// PageToken Token to use to request the [next page](https://dev.frontapp.com/docs/pagination)
	PageToken *PageToken `form:"page_token,omitempty" json:"page_token,omitempty"`

	// SortBy Field used to sort the messages. Only supports `created_at`.
	SortBy *SortByConversationMessages `form:"sort_by,omitempty" json:"sort_by,omitempty"`

	// SortOrder Order by which results should be sorted
	SortOrder *ListConversationMessagesParamsSortOrder `form:"sort_order,omitempty" json:"sort_order,omitempty"`
}

type ListConversationMessagesParamsSortOrder string

type ListConversationMessagesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListOfMessages
}

type ListInboxesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListOfInboxes
}

type ListOfConversationSearchResults struct {
	UnderscoreLinks *struct {
		// Self Link to resource
		Self *string `json:"self,omitempty"`
	} `json:"_links,omitempty"`
	UnderscorePagination *struct {
		// Next Link to next [page of results](https://dev.frontapp.com/docs/pagination)
		Next *string `json:"next,omitempty"`
	} `json:"_pagination,omitempty"`
	UnderscoreResults *[]ConversationResponse `json:"_results,omitempty"`

	// UnderscoreTotal Total number of matching conversations
	UnderscoreTotal *int `json:"_total,omitempty"`
}

type ListOfInboxes struct {
	UnderscoreLinks *struct {
		// Self Link to resource
		Self *string `json:"self,omitempty"`
	} `json:"_links,omitempty"`
	UnderscoreResults *[]InboxResponse `json:"_results,omitempty"`
}

type ListOfMessages struct {
	UnderscoreLinks *struct {
		// Self Link to resource
		Self *string `json:"self,omitempty"`
	} `json:"_links,omitempty"`
	UnderscorePagination *struct {
		// Next Link to next [page of results](https://dev.frontapp.com/docs/pagination)
		Next *string `json:"next,omitempty"`
	} `json:"_pagination,omitempty"`
	UnderscoreResults *[]MessageResponse `json:"_results,omitempty"`
}

type ListTeammateInboxesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListOfInboxes
}

type MessageResponse struct {
	UnderscoreLinks *struct {
		Related *struct {
			// Conversation Link to message conversation
			Conversation *string `json:"conversation,omitempty"`

			// MessageRepliedTo Link to message this message replied to
			MessageRepliedTo *string `json:"message_replied_to,omitempty"`

			// MessageSeen Link to message seen information
			MessageSeen *string `json:"message_seen,omitempty"`
		} `json:"related,omitempty"`

		// Self Link to resource
		Self *string `json:"self,omitempty"`
	} `json:"_links,omitempty"`

	// Attachments List of files attached to the message
	Attachments *[]Attachment `json:"attachments,omitempty"`

	// Author A teammate is a user in Front.
	Author *TeammateResponse `json:"author,omitempty"`

	// Blurb Preview of the message body
	Blurb *string `json:"blurb,omitempty"`

	// Body Body of the message
	Body *string `json:"body,omitempty"`

	// CreatedAt The timestamp when the message was sent or received
	CreatedAt *float32 `json:"created_at,omitempty"`

	// DraftMode If the message is a draft, describes the draft mode. Can be 'private' (draft is visible to the author only) or 'shared' (draft is visible to all teammates with access to the conversation).
	DraftMode *MessageResponseDraftMode `json:"draft_mode,omitempty"`

	// ErrorType Type of the error when the draft failed to be sent
	ErrorType *string `json:"error_type,omitempty"`

	// Id Unique identifier of the message
	Id *string `json:"id,omitempty"`

	// IsInbound Whether or not the message has been received or sent
	IsInbound *bool `json:"is_inbound,omitempty"`

	// MessageUid Secondary unique identifier of a message. Generated by Front on message creation. Learn more at about the [message UID](https://dev.frontapp.com/reference/messages#creating-a-new-message).
	MessageUid *string `json:"message_uid,omitempty"`

	// Metadata Optional metadata about the message
	Metadata *struct {
		// ChatVisitorUrl For `front_chat` messages only. Source URL from the chat widget when sending a message.
		ChatVisitorUrl *string `json:"chat_visitor_url,omitempty"`

		// Duration For `truly-call` messages only. Length of the call in seconds.
		Duration *int `json:"duration,omitempty"`

		// ExternalId For `tweet` or 'custom' (partner channel token authenticated) messages only. Unique message identifier in the underlying provider (Twitter or Partner). For custom messages, only present for partner channel token authenticated requests.
		ExternalId *string `json:"external_id,omitempty"`

		// HaveBeenAnswered For `truly-call` messages only. Whether or not the call have been answered.
		HaveBeenAnswered *bool `json:"have_been_answered,omitempty"`

		// HaveBeenFavorited For `tweet` messages only. Whether or not the tweet have been favorited.
		HaveBeenFavorited *bool `json:"have_been_favorited,omitempty"`

		// HaveBeenRetweeted For `tweet` messages only. Whether or not the tweet have been retweeted.
		HaveBeenRetweeted *bool `json:"have_been_retweeted,omitempty"`

		// Headers For `custom` messages only. Custom object holding internal information.
		Headers *map[string]interface{} `json:"headers,omitempty"`

		// IntercomUrl For `intercom` messages only. URL of the Intercom conversation the message is coming from.
		IntercomUrl *string `json:"intercom_url,omitempty"`

		// IsRetweet For `tweet` messages only. Whether or not the tweet is a retweet.
		IsRetweet *bool `json:"is_retweet,omitempty"`

		// ThreadRef For `custom` messages only. Custom reference which is used to thread messages.
		ThreadRef *string `json:"thread_ref,omitempty"`

		// TwitterUrl For `tweet` messages only. URL of the tweet.
		TwitterUrl *string `json:"twitter_url,omitempty"`
	} `json:"metadata,omitempty"`
	Recipients *[]RecipientResponse `json:"recipients,omitempty"`
	Signature  *SignatureResponse   `json:"signature,omitempty"`

	// Subject Subject of the message
	Subject *string `json:"subject,omitempty"`

	// Text Text version of the body for email messages
	Text *string `json:"text,omitempty"`

	// Type Type of the message
	Type *MessageResponseType `json:"type,omitempty"`

	// Version The current version of the message in Front
	Version *string `json:"version,omitempty"`
}

type MessageResponseDraftMode string

type MessageResponseType string

type PageToken = string

type RecipientResponse struct {
	UnderscoreLinks struct {
		Related *struct {
			// Contact Link to recipient contact
			Contact *string `json:"contact,omitempty"`
		} `json:"related,omitempty"`
	} `json:"_links"`

	// Handle Handle of the contact. Can be any string used to uniquely identify the contact
	Handle string `json:"handle"`

	// Name Name of the recipient.
	Name *string `json:"name"`

	// Role Role of the recipient
	Role RecipientResponseRole `json:"role"`
}

type RecipientResponseRole string

type Reminder struct {
	UnderscoreLinks struct {
		Related *struct {
			// Owner Link to conversation owner
			Owner *string `json:"owner,omitempty"`
		} `json:"related,omitempty"`
	} `json:"_links"`

	// CreatedAt Timestamp at which the conversation reminder has been created
	CreatedAt *float32 `json:"created_at,omitempty"`

	// ScheduledAt Timestamp that the conversation reminder has been scheduled for
	ScheduledAt *float32 `json:"scheduled_at,omitempty"`

	// UpdatedAt Timestamp at which the conversation reminder has been updated
	UpdatedAt *float32 `json:"updated_at,omitempty"`
}

type RequestEditorFn func(ctx context.Context, req *http.Request) error

type SearchConversationsParams struct {
	// Limit Max number of results per [page](https://dev.frontapp.com/docs/pagination)
	Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`

	// PageToken Token to use to request the [next page](https://dev.frontapp.com/docs/pagination)
	PageToken *PageToken `form:"page_token,omitempty" json:"page_token,omitempty"`
}

type SearchConversationsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListOfConversationSearchResults
}

type SignatureResponse struct {
	UnderscoreLinks struct {
		Related *struct {
			// Owner Link to signature's owner (either a team or teammate)
			Owner *string `json:"owner,omitempty"`
		} `json:"related,omitempty"`

		// Self Link to resource
		Self *string `json:"self,omitempty"`
	} `json:"_links"`

	// Body Body of the signature
	Body       string    `json:"body"`
	ChannelIds *[]string `json:"channel_ids"`

	// Id Unique identifier of the signature
	Id string `json:"id"`

	// IsDefault Whether the signature is the default signature for the team or teammate.
	IsDefault bool `json:"is_default"`

	// IsPrivate Whether the signature is private to the teammate.
	IsPrivate bool `json:"is_private"`

	// IsVisibleForAllTeammateChannels Whether or not the signature is available in teammate channels.
	IsVisibleForAllTeammateChannels bool `json:"is_visible_for_all_teammate_channels"`

	// Name Name of the signature
	Name *string `json:"name"`

	// SenderInfo Sender info of the signature
	SenderInfo *string `json:"sender_info"`
}

type SortByConversationMessages = string

type SortOrder string

type TagResponse struct {
	UnderscoreLinks struct {
		Related *struct {
			// Children Link to tag children
			Children *string `json:"children,omitempty"`

			// Conversations Link to tag conversations
			Conversations *string `json:"conversations,omitempty"`

			// Owner Link to tag owner
			Owner *string `json:"owner,omitempty"`

			// ParentTag Link to parent tag
			ParentTag *string `json:"parent_tag,omitempty"`
		} `json:"related,omitempty"`

		// Self Link to resource
		Self *string `json:"self,omitempty"`
	} `json:"_links"`

	// CreatedAt Timestamp of tag create creation
	CreatedAt *float32 `json:"created_at,omitempty"`

	// Description Description of the tag
	Description *string `json:"description"`

	// Highlight Highlight color or emoji of the tag. Null if the tag does not have a highlight.
	Highlight *string `json:"highlight"`

	// Id Unique identifier of the tag
	Id string `json:"id"`

	// IsPrivate Whether or not the tag is individual
	IsPrivate bool `json:"is_private"`

	// IsVisibleInConversationLists Whether the tag is visible in conversation lists.
	IsVisibleInConversationLists bool `json:"is_visible_in_conversation_lists"`

	// Name Name of the tag
	Name string `json:"name"`

	// UpdatedAt Timestamp of the last tag update
	UpdatedAt *float32 `json:"updated_at,omitempty"`
}

type TeammateResponse struct {
	UnderscoreLinks struct {
		Related *struct {
			// BotSource Link to the source resource of the bot (e.g. rule)
			BotSource *string `json:"botSource,omitempty"`

			// Conversations Link to teammate's conversations
			Conversations *string `json:"conversations,omitempty"`

			// Inboxes Link to teammate's inboxes
			Inboxes *string `json:"inboxes,omitempty"`
		} `json:"related,omitempty"`

		// Self Link to resource
		Self *string `json:"self,omitempty"`
	} `json:"_links"`

	// CustomFields An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields
	CustomFields CustomFieldParameter `json:"custom_fields"`

	// Email Email address of the teammate
	Email string `json:"email"`

	// FirstName First name of the teammate
	FirstName string `json:"first_name"`

	// Id Unique identifier of the teammate
	Id string `json:"id"`

	// IsAdmin Whether or not the teammate is an admin in your company
	IsAdmin bool `json:"is_admin"`

	// IsAvailable Whether or not the teammate is available
	IsAvailable bool `json:"is_available"`

	// IsBlocked Whether or not the teammate account has been blocked
	IsBlocked bool `json:"is_blocked"`

	// LastName Last name of the teammate
	LastName string `json:"last_name"`

	// Type Type of the teammate, normal teammates are denoted as "user", while visitors are denoted as "visitor".
	// Bot users are denoted by their parent resource type.
	// The following bot types are available:
	//   * rule: acting on behalf of a Rule, author of comments and drafts
	//   * macro: acting on behalf of a Macro, author of comments and drafts
	//   * API: acting on behalf of OAuth clients
	//   * integration: acting on behalf of an Integration
	//   * CSAT: used for authoring CSAT response comments
	Type TeammateResponseType `json:"type"`

	// Username Username of the teammate (used for "@" mentions)
	Username string `json:"username"`
}

type TeammateResponseType string