Documentation
¶
Overview ¶
Package api_types provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version v1.16.3 DO NOT EDIT.
Index ¶
- type AggregateAnalyticsSchema
- type AggregateCampaignStatsDataPointsSchema
- type AggregateContactStatsDataPointsSchema
- type AggregateConversationStatsDataPointsSchema
- type AggregateMessageStatsDataPointsSchema
- type ApiKeySchema
- type AssignConversationJSONRequestBody
- type AssignConversationResponseSchema
- type AssignConversationSchema
- type BulkImportContactsJSONRequestBody
- type BulkImportContactsMultipartBody
- type BulkImportContactsMultipartRequestBody
- type BulkImportResponseSchema
- type BulkImportSchema
- type CampaignAnalyticsResponseSchema
- type CampaignSchema
- type CampaignStatusEnum
- type ContactListSchema
- type ContactSchema
- type ContactStatusEnum
- type ConversationAnalyticsDataPointSchema
- type ConversationSchema
- type ConversationStatusEnum
- type CreateCampaignJSONRequestBody
- type CreateContactsJSONBody
- type CreateContactsJSONRequestBody
- type CreateInviteResponseSchema
- type CreateListJSONRequestBody
- type CreateNewCampaignResponseSchema
- type CreateNewContactResponseSchema
- type CreateNewListResponseSchema
- type CreateNewOrganizationInviteSchema
- type CreateNewOrganizationResponseSchema
- type CreateNewOrganizationTagResponseSchema
- type CreateNewRoleResponseSchema
- type CreateOrganizationInviteJSONRequestBody
- type CreateOrganizationJSONRequestBody
- type CreateOrganizationRoleJSONRequestBody
- type CreateOrganizationTagJSONRequestBody
- type DeleteContactsByListParams
- type DeleteConversationByIdResponseSchema
- type DeleteOrganizationMemberByIdResponseSchema
- type DeleteRoleByIdResponseSchema
- type FeatureFlags
- type GetAllMessageTemplatesResponseSchema
- type GetAllPhoneNumbersResponseSchema
- type GetApiKeysResponseSchema
- type GetCampaignByIdResponseSchema
- type GetCampaignResponseSchema
- type GetCampaignsAnalyticsParams
- type GetCampaignsParams
- type GetContactByIdResponseSchema
- type GetContactListByIdSchema
- type GetContactListResponseSchema
- type GetContactListsParams
- type GetContactsParams
- type GetContactsResponseSchema
- type GetConversationByIdResponseSchema
- type GetConversationMessagesParams
- type GetConversationsParams
- type GetConversationsParamsStatus
- type GetFeatureFlagsResponseSchema
- type GetIntegrationResponseSchema
- type GetIntegrationsParams
- type GetMessagesParams
- type GetMessagesParamsStatus
- type GetMetaDataResponseSchema
- type GetOrganizationByIdResponseSchema
- type GetOrganizationInvitesParams
- type GetOrganizationMemberByIdResponseSchema
- type GetOrganizationMemberInvitesResponseSchema
- type GetOrganizationMembersParams
- type GetOrganizationMembersResponseSchema
- type GetOrganizationRolesParams
- type GetOrganizationRolesResponseSchema
- type GetOrganizationSettingsResponseSchema
- type GetOrganizationTagsParams
- type GetOrganizationTagsResponseSchema
- type GetOrganizationsResponseSchema
- type GetPhoneNumberByIdResponseSchema
- type GetPrimaryAnalyticsParams
- type GetRoleByIdResponseSchema
- type GetSecondaryAnalyticsParams
- type GetTemplateByIdResponseSchema
- type GetUserOrganizationsParams
- type GetUserResponseSchema
- type IntegrationFeatureFlags
- type IntegrationSchema
- type IntegrationStatusEnum
- type InviteStatusEnum
- type JoinOrganizationJSONRequestBody
- type JoinOrganizationRequestBodySchema
- type JoinOrganizationResponseBodySchema
- type LinkClicksGraphDataPointSchema
- type LoginJSONRequestBody
- type LoginRequestBodySchema
- type LoginResponseBodySchema
- type MessageAnalyticGraphDataPointSchema
- type MessageDirectionEnum
- type MessageSchema
- type MessageSchemaContent0
- type MessageSchemaContent1
- type MessageSchema_Content
- func (t MessageSchema_Content) AsMessageSchemaContent0() (MessageSchemaContent0, error)
- func (t MessageSchema_Content) AsMessageSchemaContent1() (MessageSchemaContent1, error)
- func (t *MessageSchema_Content) FromMessageSchemaContent0(v MessageSchemaContent0) error
- func (t *MessageSchema_Content) FromMessageSchemaContent1(v MessageSchemaContent1) error
- func (t MessageSchema_Content) MarshalJSON() ([]byte, error)
- func (t *MessageSchema_Content) MergeMessageSchemaContent0(v MessageSchemaContent0) error
- func (t *MessageSchema_Content) MergeMessageSchemaContent1(v MessageSchemaContent1) error
- func (t *MessageSchema_Content) UnmarshalJSON(b []byte) error
- type MessageStatusEnum
- type MessageTemplateCategory
- type MessageTemplateComponentFormat
- type MessageTemplateComponentType
- type MessageTemplateSchema
- type MessageTemplateStatus
- type MessageTypeDistributionGraphDataPointSchema
- type MessageTypeEnum
- type NewCampaignSchema
- type NewContactListSchema
- type NewContactSchema
- type NewOrganizationRoleSchema
- type NewOrganizationSchema
- type NewOrganizationTagSchema
- type NotFoundErrorResponseSchema
- type OrderEnum
- type OrganizationMemberInviteSchema
- type OrganizationMemberSchema
- type OrganizationRoleSchema
- type OrganizationSchema
- type PaginationMeta
- type PhoneNumberSchema
- type PrimaryAnalyticsResponseSchema
- type RegenerateApiKeyResponseSchema
- type RegisterJSONRequestBody
- type RegisterRequestBodySchema
- type RegisterRequestResponseBodySchema
- type RolePermissionEnum
- type RoleUpdateSchema
- type SecondaryAnalyticsDashboardResponseSchema
- type SwitchOrganizationJSONBody
- type SwitchOrganizationJSONRequestBody
- type SwitchOrganizationResponseSchema
- type SystemFeatureFlags
- type TagSchema
- type TemplateMessageButtonType
- type TemplateMessageComponentButton
- type TemplateMessageComponentExample
- type TemplateMessageQualityScore
- type TemplateSchema
- type TransferOrganizationOwnershipJSONRequestBody
- type TransferOrganizationOwnershipResponseSchema
- type TransferOrganizationOwnershipSchema
- type UnassignConversationJSONRequestBody
- type UnassignConversationResponseSchema
- type UnassignConversationSchema
- type UpdateCampaignByIdJSONRequestBody
- type UpdateCampaignByIdResponseSchema
- type UpdateCampaignSchema
- type UpdateContactByIdJSONRequestBody
- type UpdateContactListSchema
- type UpdateContactSchema
- type UpdateConversationByIdJSONRequestBody
- type UpdateConversationByIdResponseSchema
- type UpdateConversationSchema
- type UpdateListByIdJSONRequestBody
- type UpdateListByIdResponseSchema
- type UpdateOrganizationByIdResponseSchema
- type UpdateOrganizationJSONRequestBody
- type UpdateOrganizationMemberByIdJSONRequestBody
- type UpdateOrganizationMemberByIdResponseSchema
- type UpdateOrganizationMemberRoleByIdJSONRequestBody
- type UpdateOrganizationMemberRoleByIdResponseSchema
- type UpdateOrganizationMemberRoleSchema
- type UpdateOrganizationMemberSchema
- type UpdateOrganizationRoleByIdJSONRequestBody
- type UpdateOrganizationSchema
- type UpdateOrganizationSettingsResponseSchema
- type UpdateRoleByIdResponseSchema
- type UpdateSettingsJSONBody
- type UpdateSettingsJSONRequestBody
- type UpdateUserJSONRequestBody
- type UpdateUserResponseSchema
- type UpdateUserSchema
- type UpdateWhatsappBusinessAccountDetailsJSONRequestBody
- type UserPermissionLevel
- type UserSchema
- type VerifyOtpJSONRequestBody
- type VerifyOtpRequestBodySchema
- type VerifyOtpResponseBodySchema
- type WhatsAppBusinessAccountDetailsSchema
- type WhatsAppBusinessHSMWhatsAppHSMComponent
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AggregateAnalyticsSchema ¶
type AggregateAnalyticsSchema struct {
CampaignStats AggregateCampaignStatsDataPointsSchema `json:"campaignStats"`
ContactStats AggregateContactStatsDataPointsSchema `json:"contactStats"`
ConversationStats AggregateConversationStatsDataPointsSchema `json:"conversationStats"`
MessageStats AggregateMessageStatsDataPointsSchema `json:"messageStats"`
}
AggregateAnalyticsSchema defines model for AggregateAnalyticsSchema.
type AggregateCampaignStatsDataPointsSchema ¶
type AggregateCampaignStatsDataPointsSchema struct {
Cancelled int `json:"cancelled"`
Draft int `json:"draft"`
Finished int `json:"finished"`
Paused int `json:"paused"`
Running int `json:"running"`
Scheduled int `json:"scheduled"`
Total int `json:"total"`
}
AggregateCampaignStatsDataPointsSchema defines model for AggregateCampaignStatsDataPointsSchema.
type AggregateContactStatsDataPointsSchema ¶
type AggregateContactStatsDataPointsSchema struct {
Active int `json:"active"`
Blocked int `json:"blocked"`
Total int `json:"total"`
}
AggregateContactStatsDataPointsSchema defines model for AggregateContactStatsDataPointsSchema.
type AggregateConversationStatsDataPointsSchema ¶
type AggregateConversationStatsDataPointsSchema struct {
Active int `json:"active"`
Closed int `json:"closed"`
Pending int `json:"pending"`
Total int `json:"total"`
}
AggregateConversationStatsDataPointsSchema defines model for AggregateConversationStatsDataPointsSchema.
type AggregateMessageStatsDataPointsSchema ¶
type AggregateMessageStatsDataPointsSchema struct {
Delivered int `json:"delivered"`
Failed int `json:"failed"`
Read int `json:"read"`
Sent int `json:"sent"`
Total int `json:"total"`
Undelivered int `json:"undelivered"`
Unread int `json:"unread"`
}
AggregateMessageStatsDataPointsSchema defines model for AggregateMessageStatsDataPointsSchema.
type ApiKeySchema ¶
type ApiKeySchema struct {
CreatedAt time.Time `json:"createdAt"`
Key string `json:"key"`
UniqueId string `json:"uniqueId"`
}
ApiKeySchema defines model for ApiKeySchema.
type AssignConversationJSONRequestBody ¶
type AssignConversationJSONRequestBody = AssignConversationSchema
AssignConversationJSONRequestBody defines body for AssignConversation for application/json ContentType.
type AssignConversationResponseSchema ¶
type AssignConversationResponseSchema struct {
Data bool `json:"data"`
}
AssignConversationResponseSchema defines model for AssignConversationResponseSchema.
type AssignConversationSchema ¶
type AssignConversationSchema struct {
UserId string `json:"userId"`
}
AssignConversationSchema defines model for AssignConversationSchema.
type BulkImportContactsJSONRequestBody ¶
type BulkImportContactsJSONRequestBody = BulkImportSchema
BulkImportContactsJSONRequestBody defines body for BulkImportContacts for application/json ContentType.
type BulkImportContactsMultipartBody ¶
type BulkImportContactsMultipartBody struct {
// File The CSV file to be imported
File *openapi_types.File `json:"file,omitempty"`
}
BulkImportContactsMultipartBody defines parameters for BulkImportContacts.
type BulkImportContactsMultipartRequestBody ¶
type BulkImportContactsMultipartRequestBody BulkImportContactsMultipartBody
BulkImportContactsMultipartRequestBody defines body for BulkImportContacts for multipart/form-data ContentType.
type BulkImportResponseSchema ¶
type BulkImportResponseSchema struct {
Message string `json:"message"`
}
BulkImportResponseSchema defines model for BulkImportResponseSchema.
type BulkImportSchema ¶
type BulkImportSchema struct {
Delimiter *string `json:"delimiter,omitempty"`
ListIds *[]string `json:"listIds,omitempty"`
}
BulkImportSchema defines model for BulkImportSchema.
type CampaignAnalyticsResponseSchema ¶
type CampaignAnalyticsResponseSchema struct {
MessagesDelivered int `json:"messagesDelivered"`
MessagesFailed int `json:"messagesFailed"`
MessagesRead int `json:"messagesRead"`
MessagesSent int `json:"messagesSent"`
MessagesUndelivered int `json:"messagesUndelivered"`
}
CampaignAnalyticsResponseSchema defines model for CampaignAnalyticsResponseSchema.
type CampaignSchema ¶
type CampaignSchema struct {
CreatedAt time.Time `json:"createdAt"`
Description *string `json:"description,omitempty"`
IsLinkTrackingEnabled bool `json:"isLinkTrackingEnabled"`
Lists []ContactListSchema `json:"lists"`
Name string `json:"name"`
PhoneNumberInUse *string `json:"phoneNumberInUse,omitempty"`
ScheduledAt *time.Time `json:"scheduledAt,omitempty"`
SentAt *time.Time `json:"sentAt,omitempty"`
Status CampaignStatusEnum `json:"status"`
Tags []TagSchema `json:"tags"`
TemplateComponentParameters *map[string]interface{} `json:"templateComponentParameters,omitempty"`
TemplateMessageId *string `json:"templateMessageId,omitempty"`
UniqueId string `json:"uniqueId"`
}
CampaignSchema defines model for CampaignSchema.
type CampaignStatusEnum ¶
type CampaignStatusEnum string
CampaignStatusEnum defines model for CampaignStatusEnum.
const ( Cancelled CampaignStatusEnum = "Cancelled" Draft CampaignStatusEnum = "Draft" Finished CampaignStatusEnum = "Finished" Paused CampaignStatusEnum = "Paused" Running CampaignStatusEnum = "Running" Scheduled CampaignStatusEnum = "Scheduled" )
Defines values for CampaignStatusEnum.
type ContactListSchema ¶
type ContactListSchema struct {
CreatedAt time.Time `json:"createdAt"`
Description string `json:"description"`
Name string `json:"name"`
NumberOfCampaignsSent int `json:"numberOfCampaignsSent"`
NumberOfContacts int `json:"numberOfContacts"`
Tags []TagSchema `json:"tags"`
UniqueId string `json:"uniqueId"`
}
ContactListSchema defines model for ContactListSchema.
type ContactSchema ¶
type ContactSchema struct {
Attributes map[string]interface{} `json:"attributes"`
CreatedAt time.Time `json:"createdAt"`
Lists []ContactListSchema `json:"lists"`
Name string `json:"name"`
Phone string `json:"phone"`
UniqueId string `json:"uniqueId"`
}
ContactSchema defines model for ContactSchema.
type ContactStatusEnum ¶
type ContactStatusEnum string
ContactStatusEnum defines model for ContactStatusEnum.
const ( ContactStatusEnumActive ContactStatusEnum = "Active" ContactStatusEnumBlocked ContactStatusEnum = "Blocked" ContactStatusEnumInactive ContactStatusEnum = "Inactive" )
Defines values for ContactStatusEnum.
type ConversationAnalyticsDataPointSchema ¶
type ConversationAnalyticsDataPointSchema struct {
Date time.Time `json:"date"`
Label string `json:"label"`
NumberOfActiveConversation int `json:"numberOfActiveConversation"`
NumberOfNewConversationOpened int `json:"numberOfNewConversationOpened"`
}
ConversationAnalyticsDataPointSchema defines model for ConversationAnalyticsDataPointSchema.
type ConversationSchema ¶
type ConversationSchema struct {
ContactId string `json:"contactId"`
CreatedAt *time.Time `json:"createdAt,omitempty"`
Messages []MessageSchema `json:"messages"`
Status ConversationStatusEnum `json:"status"`
UniqueId string `json:"uniqueId"`
}
ConversationSchema defines model for ConversationSchema.
type ConversationStatusEnum ¶
type ConversationStatusEnum string
ConversationStatusEnum defines model for ConversationStatusEnum.
const ( ConversationStatusEnumActive ConversationStatusEnum = "Active" ConversationStatusEnumClosed ConversationStatusEnum = "Closed" ConversationStatusEnumDeleted ConversationStatusEnum = "Deleted" )
Defines values for ConversationStatusEnum.
type CreateCampaignJSONRequestBody ¶
type CreateCampaignJSONRequestBody = NewCampaignSchema
CreateCampaignJSONRequestBody defines body for CreateCampaign for application/json ContentType.
type CreateContactsJSONBody ¶
type CreateContactsJSONBody = []NewContactSchema
CreateContactsJSONBody defines parameters for CreateContacts.
type CreateContactsJSONRequestBody ¶
type CreateContactsJSONRequestBody = CreateContactsJSONBody
CreateContactsJSONRequestBody defines body for CreateContacts for application/json ContentType.
type CreateInviteResponseSchema ¶
type CreateInviteResponseSchema struct {
Invite OrganizationMemberInviteSchema `json:"invite"`
}
CreateInviteResponseSchema defines model for CreateInviteResponseSchema.
type CreateListJSONRequestBody ¶
type CreateListJSONRequestBody = NewContactListSchema
CreateListJSONRequestBody defines body for CreateList for application/json ContentType.
type CreateNewCampaignResponseSchema ¶
type CreateNewCampaignResponseSchema struct {
Campaign CampaignSchema `json:"campaign"`
}
CreateNewCampaignResponseSchema defines model for CreateNewCampaignResponseSchema.
type CreateNewContactResponseSchema ¶
type CreateNewContactResponseSchema struct {
Message string `json:"message"`
}
CreateNewContactResponseSchema defines model for CreateNewContactResponseSchema.
type CreateNewListResponseSchema ¶
type CreateNewListResponseSchema struct {
List ContactListSchema `json:"list"`
}
CreateNewListResponseSchema defines model for CreateNewListResponseSchema.
type CreateNewOrganizationInviteSchema ¶
type CreateNewOrganizationInviteSchema struct {
AccessLevel UserPermissionLevel `json:"accessLevel"`
Email string `json:"email"`
}
CreateNewOrganizationInviteSchema defines model for CreateNewOrganizationInviteSchema.
type CreateNewOrganizationResponseSchema ¶
type CreateNewOrganizationResponseSchema struct {
Organization OrganizationSchema `json:"organization"`
}
CreateNewOrganizationResponseSchema defines model for CreateNewOrganizationResponseSchema.
type CreateNewOrganizationTagResponseSchema ¶
type CreateNewOrganizationTagResponseSchema struct {
Tag TagSchema `json:"tag"`
}
CreateNewOrganizationTagResponseSchema defines model for CreateNewOrganizationTagResponseSchema.
type CreateNewRoleResponseSchema ¶
type CreateNewRoleResponseSchema struct {
Role OrganizationRoleSchema `json:"role"`
}
CreateNewRoleResponseSchema defines model for CreateNewRoleResponseSchema.
type CreateOrganizationInviteJSONRequestBody ¶
type CreateOrganizationInviteJSONRequestBody = CreateNewOrganizationInviteSchema
CreateOrganizationInviteJSONRequestBody defines body for CreateOrganizationInvite for application/json ContentType.
type CreateOrganizationJSONRequestBody ¶
type CreateOrganizationJSONRequestBody = NewOrganizationSchema
CreateOrganizationJSONRequestBody defines body for CreateOrganization for application/json ContentType.
type CreateOrganizationRoleJSONRequestBody ¶
type CreateOrganizationRoleJSONRequestBody = NewOrganizationRoleSchema
CreateOrganizationRoleJSONRequestBody defines body for CreateOrganizationRole for application/json ContentType.
type CreateOrganizationTagJSONRequestBody ¶
type CreateOrganizationTagJSONRequestBody = NewOrganizationTagSchema
CreateOrganizationTagJSONRequestBody defines body for CreateOrganizationTag for application/json ContentType.
type DeleteContactsByListParams ¶
type DeleteContactsByListParams struct {
// Id contact id/s to be deleted
Id string `form:"id" json:"id"`
}
DeleteContactsByListParams defines parameters for DeleteContactsByList.
type DeleteConversationByIdResponseSchema ¶
type DeleteConversationByIdResponseSchema struct {
Data bool `json:"data"`
}
DeleteConversationByIdResponseSchema defines model for DeleteConversationByIdResponseSchema.
type DeleteOrganizationMemberByIdResponseSchema ¶
type DeleteOrganizationMemberByIdResponseSchema struct {
Data bool `json:"data"`
}
DeleteOrganizationMemberByIdResponseSchema defines model for DeleteOrganizationMemberByIdResponseSchema.
type DeleteRoleByIdResponseSchema ¶
type DeleteRoleByIdResponseSchema struct {
Data bool `json:"data"`
}
DeleteRoleByIdResponseSchema defines model for DeleteRoleByIdResponseSchema.
type FeatureFlags ¶
type FeatureFlags struct {
IntegrationFeatureFlags *IntegrationFeatureFlags `json:"IntegrationFeatureFlags,omitempty"`
SystemFeatureFlags *SystemFeatureFlags `json:"SystemFeatureFlags,omitempty"`
}
FeatureFlags defines model for FeatureFlags.
type GetAllMessageTemplatesResponseSchema ¶
type GetAllMessageTemplatesResponseSchema = []MessageTemplateSchema
GetAllMessageTemplatesResponseSchema defines model for GetAllMessageTemplatesResponseSchema.
type GetAllPhoneNumbersResponseSchema ¶
type GetAllPhoneNumbersResponseSchema = []PhoneNumberSchema
GetAllPhoneNumbersResponseSchema defines model for GetAllPhoneNumbersResponseSchema.
type GetApiKeysResponseSchema ¶
type GetApiKeysResponseSchema struct {
ApiKey ApiKeySchema `json:"apiKey"`
}
GetApiKeysResponseSchema defines model for GetApiKeysResponseSchema.
type GetCampaignByIdResponseSchema ¶
type GetCampaignByIdResponseSchema struct {
Campaign CampaignSchema `json:"campaign"`
}
GetCampaignByIdResponseSchema defines model for GetCampaignByIdResponseSchema.
type GetCampaignResponseSchema ¶
type GetCampaignResponseSchema struct {
Campaigns []CampaignSchema `json:"campaigns"`
PaginationMeta PaginationMeta `json:"paginationMeta"`
}
GetCampaignResponseSchema defines model for GetCampaignResponseSchema.
type GetCampaignsAnalyticsParams ¶
type GetCampaignsAnalyticsParams struct {
// From starting range of time span to get analytics for
From *time.Time `form:"from,omitempty" json:"from,omitempty"`
// To ending range of time span to get analytics for
To *time.Time `form:"to,omitempty" json:"to,omitempty"`
}
GetCampaignsAnalyticsParams defines parameters for GetCampaignsAnalytics.
type GetCampaignsParams ¶
type GetCampaignsParams struct {
// Page number of records to skip
Page int64 `form:"page" json:"page"`
// PerPage max number of records to return per page
PerPage int64 `form:"per_page" json:"per_page"`
// Order order by asc or desc
Order *OrderEnum `form:"order,omitempty" json:"order,omitempty"`
// Status sort by a field
Status *CampaignStatusEnum `form:"status,omitempty" json:"status,omitempty"`
}
GetCampaignsParams defines parameters for GetCampaigns.
type GetContactByIdResponseSchema ¶
type GetContactByIdResponseSchema struct {
Contact ContactSchema `json:"contact"`
}
GetContactByIdResponseSchema defines model for GetContactByIdResponseSchema.
type GetContactListByIdSchema ¶
type GetContactListByIdSchema struct {
List ContactListSchema `json:"list"`
}
GetContactListByIdSchema defines model for GetContactListByIdSchema.
type GetContactListResponseSchema ¶
type GetContactListResponseSchema struct {
Lists []ContactListSchema `json:"lists"`
PaginationMeta PaginationMeta `json:"paginationMeta"`
}
GetContactListResponseSchema defines model for GetContactListResponseSchema.
type GetContactListsParams ¶
type GetContactListsParams struct {
// Page number of records to skip
Page int64 `form:"page" json:"page"`
// PerPage max number of records to return per page
PerPage int64 `form:"per_page" json:"per_page"`
// Order order by asc or desc
Order *OrderEnum `form:"order,omitempty" json:"order,omitempty"`
}
GetContactListsParams defines parameters for GetContactLists.
type GetContactsParams ¶
type GetContactsParams struct {
// Page number of records to skip
Page int64 `form:"page" json:"page"`
// PerPage max number of records to return per page
PerPage int64 `form:"per_page" json:"per_page"`
// ListId query subscribers with a list id.
ListId *string `form:"list_id,omitempty" json:"list_id,omitempty"`
// Order order by asc or desc
Order *OrderEnum `form:"order,omitempty" json:"order,omitempty"`
// Status sort by a field
Status *string `form:"status,omitempty" json:"status,omitempty"`
}
GetContactsParams defines parameters for GetContacts.
type GetContactsResponseSchema ¶
type GetContactsResponseSchema struct {
Contacts []ContactSchema `json:"contacts"`
PaginationMeta PaginationMeta `json:"paginationMeta"`
}
GetContactsResponseSchema defines model for GetContactsResponseSchema.
type GetConversationByIdResponseSchema ¶
type GetConversationByIdResponseSchema struct {
Conversation ConversationSchema `json:"conversation"`
}
GetConversationByIdResponseSchema defines model for GetConversationByIdResponseSchema.
type GetConversationMessagesParams ¶
type GetConversationMessagesParams struct {
// Page number of records to skip
Page int64 `form:"page" json:"page"`
// PerPage max number of records to return per page
PerPage int64 `form:"per_page" json:"per_page"`
// Order order by asc or desc
Order *OrderEnum `form:"order,omitempty" json:"order,omitempty"`
}
GetConversationMessagesParams defines parameters for GetConversationMessages.
type GetConversationsParams ¶
type GetConversationsParams struct {
// Page number of records to skip
Page int64 `form:"page" json:"page"`
// PerPage max number of records to return per page
PerPage int64 `form:"per_page" json:"per_page"`
// Order order by asc or desc
Order *OrderEnum `form:"order,omitempty" json:"order,omitempty"`
// Status sort by a field
Status *GetConversationsParamsStatus `form:"status,omitempty" json:"status,omitempty"`
// ContactId query conversations with a contact id.
ContactId *string `form:"contact_id,omitempty" json:"contact_id,omitempty"`
// CampaignId query conversations with a campaign id.
CampaignId *string `form:"campaign_id,omitempty" json:"campaign_id,omitempty"`
// ListId query conversations with a list id.
ListId *string `form:"list_id,omitempty" json:"list_id,omitempty"`
// MessageId query conversations with a message id.
MessageId *string `form:"message_id,omitempty" json:"message_id,omitempty"`
}
GetConversationsParams defines parameters for GetConversations.
type GetConversationsParamsStatus ¶
type GetConversationsParamsStatus string
GetConversationsParamsStatus defines parameters for GetConversations.
const ( Resolved GetConversationsParamsStatus = "resolved" Unresolved GetConversationsParamsStatus = "unresolved" )
Defines values for GetConversationsParamsStatus.
type GetFeatureFlagsResponseSchema ¶
type GetFeatureFlagsResponseSchema struct {
FeatureFlags *FeatureFlags `json:"featureFlags,omitempty"`
}
GetFeatureFlagsResponseSchema defines model for GetFeatureFlagsResponseSchema.
type GetIntegrationResponseSchema ¶
type GetIntegrationResponseSchema struct {
Integrations []IntegrationSchema `json:"integrations"`
PaginationMeta PaginationMeta `json:"paginationMeta"`
}
GetIntegrationResponseSchema defines model for GetIntegrationResponseSchema.
type GetIntegrationsParams ¶
type GetIntegrationsParams struct {
// Page number of records to skip
Page *int64 `form:"page,omitempty" json:"page,omitempty"`
// PerPage max number of records to return per page
PerPage *int64 `form:"per_page,omitempty" json:"per_page,omitempty"`
// Order order by asc or desc
Order *OrderEnum `form:"order,omitempty" json:"order,omitempty"`
// Status status of the integration
Status *IntegrationStatusEnum `form:"status,omitempty" json:"status,omitempty"`
}
GetIntegrationsParams defines parameters for GetIntegrations.
type GetMessagesParams ¶
type GetMessagesParams struct {
// Page number of records to skip
Page *int64 `form:"page,omitempty" json:"page,omitempty"`
// PerPage max number of records to return per page
PerPage *int64 `form:"per_page,omitempty" json:"per_page,omitempty"`
// Order order by asc or desc
Order *OrderEnum `form:"order,omitempty" json:"order,omitempty"`
// Status status of the message
Status *GetMessagesParamsStatus `form:"status,omitempty" json:"status,omitempty"`
// Direction direction of the message
Direction *MessageDirectionEnum `form:"direction,omitempty" json:"direction,omitempty"`
// ContactId query messages with a contact id.
ContactId *string `form:"contact_id,omitempty" json:"contact_id,omitempty"`
// CampaignId query messages with a campaign id.
CampaignId *string `form:"campaign_id,omitempty" json:"campaign_id,omitempty"`
// ListId query messages with a list id.
ListId *string `form:"list_id,omitempty" json:"list_id,omitempty"`
// ConversationId query messages with a conversation id.
ConversationId *string `form:"conversation_id,omitempty" json:"conversation_id,omitempty"`
}
GetMessagesParams defines parameters for GetMessages.
type GetMessagesParamsStatus ¶
type GetMessagesParamsStatus string
GetMessagesParamsStatus defines parameters for GetMessages.
const ( GetMessagesParamsStatusFailed GetMessagesParamsStatus = "failed" GetMessagesParamsStatusRead GetMessagesParamsStatus = "read" GetMessagesParamsStatusSent GetMessagesParamsStatus = "sent" GetMessagesParamsStatusUnread GetMessagesParamsStatus = "unread" )
Defines values for GetMessagesParamsStatus.
type GetMetaDataResponseSchema ¶
type GetMetaDataResponseSchema struct {
FaviconUrl *string `json:"faviconUrl,omitempty"`
MetaDescription *string `json:"metaDescription,omitempty"`
MetaTitle *string `json:"metaTitle,omitempty"`
}
GetMetaDataResponseSchema defines model for GetMetaDataResponseSchema.
type GetOrganizationByIdResponseSchema ¶
type GetOrganizationByIdResponseSchema struct {
Organization OrganizationSchema `json:"organization"`
}
GetOrganizationByIdResponseSchema defines model for GetOrganizationByIdResponseSchema.
type GetOrganizationInvitesParams ¶
type GetOrganizationInvitesParams struct {
// Page number of records to skip
Page int64 `form:"page" json:"page"`
// PerPage max number of records to return per page
PerPage int64 `form:"per_page" json:"per_page"`
// SortBy sorting order
SortBy *OrderEnum `form:"sortBy,omitempty" json:"sortBy,omitempty"`
}
GetOrganizationInvitesParams defines parameters for GetOrganizationInvites.
type GetOrganizationMemberByIdResponseSchema ¶
type GetOrganizationMemberByIdResponseSchema struct {
Member OrganizationMemberSchema `json:"member"`
}
GetOrganizationMemberByIdResponseSchema defines model for GetOrganizationMemberByIdResponseSchema.
type GetOrganizationMemberInvitesResponseSchema ¶
type GetOrganizationMemberInvitesResponseSchema struct {
Invites []OrganizationMemberInviteSchema `json:"invites"`
PaginationMeta PaginationMeta `json:"paginationMeta"`
}
GetOrganizationMemberInvitesResponseSchema defines model for GetOrganizationMemberInvitesResponseSchema.
type GetOrganizationMembersParams ¶
type GetOrganizationMembersParams struct {
// Page number of records to skip
Page int64 `form:"page" json:"page"`
// PerPage max number of records to return per page
PerPage int64 `form:"per_page" json:"per_page"`
// SortBy sorting order
SortBy *OrderEnum `form:"sortBy,omitempty" json:"sortBy,omitempty"`
}
GetOrganizationMembersParams defines parameters for GetOrganizationMembers.
type GetOrganizationMembersResponseSchema ¶
type GetOrganizationMembersResponseSchema struct {
Members []OrganizationMemberSchema `json:"members"`
PaginationMeta PaginationMeta `json:"paginationMeta"`
}
GetOrganizationMembersResponseSchema defines model for GetOrganizationMembersResponseSchema.
type GetOrganizationRolesParams ¶
type GetOrganizationRolesParams struct {
// Page number of records to skip
Page int64 `form:"page" json:"page"`
// PerPage max number of records to return per page
PerPage int64 `form:"per_page" json:"per_page"`
// SortBy sorting order
SortBy *OrderEnum `form:"sortBy,omitempty" json:"sortBy,omitempty"`
}
GetOrganizationRolesParams defines parameters for GetOrganizationRoles.
type GetOrganizationRolesResponseSchema ¶
type GetOrganizationRolesResponseSchema struct {
PaginationMeta PaginationMeta `json:"paginationMeta"`
Roles []OrganizationRoleSchema `json:"roles"`
}
GetOrganizationRolesResponseSchema defines model for GetOrganizationRolesResponseSchema.
type GetOrganizationSettingsResponseSchema ¶
type GetOrganizationSettingsResponseSchema struct {
Settings *[]struct {
Key *string `json:"key,omitempty"`
Value *string `json:"value,omitempty"`
} `json:"settings,omitempty"`
}
GetOrganizationSettingsResponseSchema defines model for GetOrganizationSettingsResponseSchema.
type GetOrganizationTagsParams ¶
type GetOrganizationTagsParams struct {
// Page number of records to skip
Page int64 `form:"page" json:"page"`
// PerPage max number of records to return per page
PerPage int64 `form:"per_page" json:"per_page"`
// SortBy sorting order
SortBy *OrderEnum `form:"sortBy,omitempty" json:"sortBy,omitempty"`
}
GetOrganizationTagsParams defines parameters for GetOrganizationTags.
type GetOrganizationTagsResponseSchema ¶
type GetOrganizationTagsResponseSchema struct {
PaginationMeta PaginationMeta `json:"paginationMeta"`
Tags []TagSchema `json:"tags"`
}
GetOrganizationTagsResponseSchema defines model for GetOrganizationTagsResponseSchema.
type GetOrganizationsResponseSchema ¶
type GetOrganizationsResponseSchema struct {
Organizations []OrganizationSchema `json:"organizations"`
PaginationMeta PaginationMeta `json:"paginationMeta"`
}
GetOrganizationsResponseSchema defines model for GetOrganizationsResponseSchema.
type GetPhoneNumberByIdResponseSchema ¶
type GetPhoneNumberByIdResponseSchema = PhoneNumberSchema
GetPhoneNumberByIdResponseSchema defines model for GetPhoneNumberByIdResponseSchema.
type GetPrimaryAnalyticsParams ¶
type GetPrimaryAnalyticsParams struct {
// From starting range of time span to get analytics for
From time.Time `form:"from" json:"from"`
// To ending range of time span to get analytics for
To time.Time `form:"to" json:"to"`
}
GetPrimaryAnalyticsParams defines parameters for GetPrimaryAnalytics.
type GetRoleByIdResponseSchema ¶
type GetRoleByIdResponseSchema struct {
Role OrganizationRoleSchema `json:"role"`
}
GetRoleByIdResponseSchema defines model for GetRoleByIdResponseSchema.
type GetSecondaryAnalyticsParams ¶
type GetSecondaryAnalyticsParams struct {
// From starting range of time span to get analytics for
From *time.Time `form:"from,omitempty" json:"from,omitempty"`
// To ending range of time span to get analytics for
To *time.Time `form:"to,omitempty" json:"to,omitempty"`
}
GetSecondaryAnalyticsParams defines parameters for GetSecondaryAnalytics.
type GetTemplateByIdResponseSchema ¶
type GetTemplateByIdResponseSchema struct {
Template TemplateSchema `json:"template"`
}
GetTemplateByIdResponseSchema defines model for GetTemplateByIdResponseSchema.
type GetUserOrganizationsParams ¶
type GetUserOrganizationsParams struct {
// Page number of records to skip
Page int64 `form:"page" json:"page"`
// PerPage max number of records to return per page
PerPage int64 `form:"per_page" json:"per_page"`
// SortBy sorting order
SortBy *OrderEnum `form:"sortBy,omitempty" json:"sortBy,omitempty"`
}
GetUserOrganizationsParams defines parameters for GetUserOrganizations.
type GetUserResponseSchema ¶
type GetUserResponseSchema struct {
User UserSchema `json:"user"`
}
GetUserResponseSchema defines model for GetUserResponseSchema.
type IntegrationFeatureFlags ¶
type IntegrationFeatureFlags struct {
IsCustomChatBoxIntegrationEnabled bool `json:"isCustomChatBoxIntegrationEnabled"`
IsOpenAiIntegrationEnabled bool `json:"isOpenAiIntegrationEnabled"`
IsSlackIntegrationEnabled bool `json:"isSlackIntegrationEnabled"`
}
IntegrationFeatureFlags defines model for IntegrationFeatureFlags.
type IntegrationSchema ¶
type IntegrationSchema struct {
CreatedAt time.Time `json:"createdAt"`
Description string `json:"description"`
Icon string `json:"icon"`
IsPremium bool `json:"isPremium"`
Name string `json:"name"`
Slug string `json:"slug"`
Status IntegrationStatusEnum `json:"status"`
Type string `json:"type"`
UniqueId string `json:"uniqueId"`
}
IntegrationSchema defines model for IntegrationSchema.
type IntegrationStatusEnum ¶
type IntegrationStatusEnum string
IntegrationStatusEnum defines model for IntegrationStatusEnum.
const ( Active IntegrationStatusEnum = "Active" Inactive IntegrationStatusEnum = "Inactive" )
Defines values for IntegrationStatusEnum.
type InviteStatusEnum ¶
type InviteStatusEnum string
InviteStatusEnum defines model for InviteStatusEnum.
const ( Pending InviteStatusEnum = "Pending" Redeemed InviteStatusEnum = "Redeemed" )
Defines values for InviteStatusEnum.
type JoinOrganizationJSONRequestBody ¶
type JoinOrganizationJSONRequestBody = JoinOrganizationRequestBodySchema
JoinOrganizationJSONRequestBody defines body for JoinOrganization for application/json ContentType.
type JoinOrganizationRequestBodySchema ¶
type JoinOrganizationRequestBodySchema struct {
InviteSlug *string `json:"inviteSlug,omitempty"`
}
JoinOrganizationRequestBodySchema defines model for JoinOrganizationRequestBodySchema.
type JoinOrganizationResponseBodySchema ¶
type JoinOrganizationResponseBodySchema struct {
Token string `json:"token"`
}
JoinOrganizationResponseBodySchema defines model for JoinOrganizationResponseBodySchema.
type LinkClicksGraphDataPointSchema ¶
type LinkClicksGraphDataPointSchema struct {
Count int `json:"count"`
Date time.Time `json:"date"`
Label string `json:"label"`
}
LinkClicksGraphDataPointSchema defines model for LinkClicksGraphDataPointSchema.
type LoginJSONRequestBody ¶
type LoginJSONRequestBody = LoginRequestBodySchema
LoginJSONRequestBody defines body for Login for application/json ContentType.
type LoginRequestBodySchema ¶
type LoginRequestBodySchema struct {
Password string `json:"password"`
Username string `json:"username"`
}
LoginRequestBodySchema defines model for LoginRequestBodySchema.
type LoginResponseBodySchema ¶
type LoginResponseBodySchema struct {
IsOnboardingCompleted bool `json:"isOnboardingCompleted"`
Token string `json:"token"`
}
LoginResponseBodySchema defines model for LoginResponseBodySchema.
type MessageAnalyticGraphDataPointSchema ¶
type MessageAnalyticGraphDataPointSchema struct {
Date time.Time `json:"date"`
Label string `json:"label"`
Read int `json:"read"`
Replied int `json:"replied"`
Sent int `json:"sent"`
}
MessageAnalyticGraphDataPointSchema defines model for MessageAnalyticGraphDataPointSchema.
type MessageDirectionEnum ¶
type MessageDirectionEnum string
MessageDirectionEnum defines model for MessageDirectionEnum.
const ( InBound MessageDirectionEnum = "InBound" OutBound MessageDirectionEnum = "OutBound" )
Defines values for MessageDirectionEnum.
type MessageSchema ¶
type MessageSchema struct {
Content *MessageSchema_Content `json:"content,omitempty"`
ConversationId *string `json:"conversationId,omitempty"`
CreatedAt *time.Time `json:"createdAt,omitempty"`
Direction *MessageDirectionEnum `json:"direction,omitempty"`
Message *string `json:"message,omitempty"`
MessageType *MessageTypeEnum `json:"message_type,omitempty"`
Status *MessageStatusEnum `json:"status,omitempty"`
UniqueId *string `json:"uniqueId,omitempty"`
}
MessageSchema defines model for MessageSchema.
type MessageSchemaContent0 ¶
type MessageSchemaContent0 = map[string]interface{}
MessageSchemaContent0 defines model for .
type MessageSchemaContent1 ¶
type MessageSchemaContent1 = string
MessageSchemaContent1 defines model for .
type MessageSchema_Content ¶
type MessageSchema_Content struct {
// contains filtered or unexported fields
}
MessageSchema_Content defines model for MessageSchema.Content.
func (MessageSchema_Content) AsMessageSchemaContent0 ¶
func (t MessageSchema_Content) AsMessageSchemaContent0() (MessageSchemaContent0, error)
AsMessageSchemaContent0 returns the union data inside the MessageSchema_Content as a MessageSchemaContent0
func (MessageSchema_Content) AsMessageSchemaContent1 ¶
func (t MessageSchema_Content) AsMessageSchemaContent1() (MessageSchemaContent1, error)
AsMessageSchemaContent1 returns the union data inside the MessageSchema_Content as a MessageSchemaContent1
func (*MessageSchema_Content) FromMessageSchemaContent0 ¶
func (t *MessageSchema_Content) FromMessageSchemaContent0(v MessageSchemaContent0) error
FromMessageSchemaContent0 overwrites any union data inside the MessageSchema_Content as the provided MessageSchemaContent0
func (*MessageSchema_Content) FromMessageSchemaContent1 ¶
func (t *MessageSchema_Content) FromMessageSchemaContent1(v MessageSchemaContent1) error
FromMessageSchemaContent1 overwrites any union data inside the MessageSchema_Content as the provided MessageSchemaContent1
func (MessageSchema_Content) MarshalJSON ¶
func (t MessageSchema_Content) MarshalJSON() ([]byte, error)
func (*MessageSchema_Content) MergeMessageSchemaContent0 ¶
func (t *MessageSchema_Content) MergeMessageSchemaContent0(v MessageSchemaContent0) error
MergeMessageSchemaContent0 performs a merge with any union data inside the MessageSchema_Content, using the provided MessageSchemaContent0
func (*MessageSchema_Content) MergeMessageSchemaContent1 ¶
func (t *MessageSchema_Content) MergeMessageSchemaContent1(v MessageSchemaContent1) error
MergeMessageSchemaContent1 performs a merge with any union data inside the MessageSchema_Content, using the provided MessageSchemaContent1
func (*MessageSchema_Content) UnmarshalJSON ¶
func (t *MessageSchema_Content) UnmarshalJSON(b []byte) error
type MessageStatusEnum ¶
type MessageStatusEnum string
MessageStatusEnum defines model for MessageStatusEnum.
const ( MessageStatusEnumDelivered MessageStatusEnum = "Delivered" MessageStatusEnumFailed MessageStatusEnum = "Failed" MessageStatusEnumRead MessageStatusEnum = "Read" MessageStatusEnumSent MessageStatusEnum = "Sent" MessageStatusEnumUnDelivered MessageStatusEnum = "UnDelivered" MessageStatusEnumUnread MessageStatusEnum = "Unread" )
Defines values for MessageStatusEnum.
type MessageTemplateCategory ¶
type MessageTemplateCategory string
MessageTemplateCategory defines model for MessageTemplateCategory.
const ( AUTHENTICATION MessageTemplateCategory = "AUTHENTICATION" MARKETING MessageTemplateCategory = "MARKETING" UTILITY MessageTemplateCategory = "UTILITY" )
Defines values for MessageTemplateCategory.
type MessageTemplateComponentFormat ¶
type MessageTemplateComponentFormat string
MessageTemplateComponentFormat defines model for MessageTemplateComponentFormat.
const ( DOCUMENT MessageTemplateComponentFormat = "DOCUMENT" IMAGE MessageTemplateComponentFormat = "IMAGE" LOCATION MessageTemplateComponentFormat = "LOCATION" TEXT MessageTemplateComponentFormat = "TEXT" VIDEO MessageTemplateComponentFormat = "VIDEO" )
Defines values for MessageTemplateComponentFormat.
type MessageTemplateComponentType ¶
type MessageTemplateComponentType string
MessageTemplateComponentType defines model for MessageTemplateComponentType.
const ( BODY MessageTemplateComponentType = "BODY" BUTTONS MessageTemplateComponentType = "BUTTONS" CAROUSEL MessageTemplateComponentType = "CAROUSEL" FOOTER MessageTemplateComponentType = "FOOTER" GREETING MessageTemplateComponentType = "GREETING" HEADER MessageTemplateComponentType = "HEADER" LIMITEDTIMEOFFER MessageTemplateComponentType = "LIMITED_TIME_OFFER" )
Defines values for MessageTemplateComponentType.
type MessageTemplateSchema ¶
type MessageTemplateSchema struct {
Category MessageTemplateCategory `json:"category"`
Components *[]WhatsAppBusinessHSMWhatsAppHSMComponent `json:"components,omitempty"`
CorrectCategory *string `json:"correct_category,omitempty"`
CtaUrlLinkTrackingOptedOut *bool `json:"cta_url_link_tracking_opted_out,omitempty"`
Id string `json:"id"`
Language string `json:"language"`
LibraryTemplateName *string `json:"library_template_name,omitempty"`
MessageSendTtlSeconds *int `json:"message_send_ttl_seconds,omitempty"`
Name string `json:"name"`
PreviousCategory *string `json:"previous_category,omitempty"`
QualityScore *TemplateMessageQualityScore `json:"quality_score,omitempty"`
RejectedReason *string `json:"rejected_reason,omitempty"`
Status MessageTemplateStatus `json:"status"`
}
MessageTemplateSchema defines model for MessageTemplateSchema.
type MessageTemplateStatus ¶
type MessageTemplateStatus string
MessageTemplateStatus defines model for MessageTemplateStatus.
const ( APPROVED MessageTemplateStatus = "APPROVED" PENDING MessageTemplateStatus = "PENDING" REJECTED MessageTemplateStatus = "REJECTED" )
Defines values for MessageTemplateStatus.
type MessageTypeDistributionGraphDataPointSchema ¶
type MessageTypeDistributionGraphDataPointSchema struct {
Received int `json:"received"`
Sent int `json:"sent"`
Type string `json:"type"`
}
MessageTypeDistributionGraphDataPointSchema defines model for MessageTypeDistributionGraphDataPointSchema.
type MessageTypeEnum ¶
type MessageTypeEnum string
MessageTypeEnum defines model for MessageTypeEnum.
const ( Address MessageTypeEnum = "Address" Audio MessageTypeEnum = "Audio" Contacts MessageTypeEnum = "Contacts" Document MessageTypeEnum = "Document" Image MessageTypeEnum = "Image" Location MessageTypeEnum = "Location" Reaction MessageTypeEnum = "Reaction" Sticker MessageTypeEnum = "Sticker" Text MessageTypeEnum = "Text" Video MessageTypeEnum = "Video" )
Defines values for MessageTypeEnum.
type NewCampaignSchema ¶
type NewCampaignSchema struct {
Description *string `json:"description,omitempty"`
IsLinkTrackingEnabled bool `json:"isLinkTrackingEnabled"`
ListIds []string `json:"listIds"`
Name string `json:"name"`
PhoneNumberToUse string `json:"phoneNumberToUse"`
Tags []string `json:"tags"`
TemplateMessageId string `json:"templateMessageId"`
}
NewCampaignSchema defines model for NewCampaignSchema.
type NewContactListSchema ¶
type NewContactListSchema struct {
ContactIds *[]string `json:"contactIds,omitempty"`
Description *string `json:"description,omitempty"`
Name string `json:"name"`
Tags []TagSchema `json:"tags"`
}
NewContactListSchema defines model for NewContactListSchema.
type NewContactSchema ¶
type NewContactSchema struct {
Attributes map[string]interface{} `json:"attributes"`
ListsIds []string `json:"listsIds"`
Name string `json:"name"`
Phone string `json:"phone"`
Status ContactStatusEnum `json:"status"`
}
NewContactSchema defines model for NewContactSchema.
type NewOrganizationRoleSchema ¶
type NewOrganizationRoleSchema struct {
Description *string `json:"description,omitempty"`
Name string `json:"name"`
Permissions []RolePermissionEnum `json:"permissions"`
}
NewOrganizationRoleSchema defines model for NewOrganizationRoleSchema.
type NewOrganizationSchema ¶
type NewOrganizationSchema struct {
Description *string `json:"description,omitempty"`
Name string `json:"name"`
}
NewOrganizationSchema defines model for NewOrganizationSchema.
type NewOrganizationTagSchema ¶
type NewOrganizationTagSchema struct {
Name string `json:"name"`
}
NewOrganizationTagSchema defines model for NewOrganizationTagSchema.
type NotFoundErrorResponseSchema ¶
type NotFoundErrorResponseSchema struct {
Message string `json:"message"`
}
NotFoundErrorResponseSchema defines model for NotFoundErrorResponseSchema.
type OrganizationMemberInviteSchema ¶
type OrganizationMemberInviteSchema struct {
AccessLevel UserPermissionLevel `json:"accessLevel"`
CreatedAt time.Time `json:"createdAt"`
Email string `json:"email"`
Status InviteStatusEnum `json:"status"`
UniqueId string `json:"uniqueId"`
}
OrganizationMemberInviteSchema defines model for OrganizationMemberInviteSchema.
type OrganizationMemberSchema ¶
type OrganizationMemberSchema struct {
AccessLevel UserPermissionLevel `json:"accessLevel"`
CreatedAt time.Time `json:"createdAt"`
Email string `json:"email"`
Name string `json:"name"`
Roles []OrganizationRoleSchema `json:"roles"`
UniqueId string `json:"uniqueId"`
}
OrganizationMemberSchema defines model for OrganizationMemberSchema.
type OrganizationRoleSchema ¶
type OrganizationRoleSchema struct {
Description *string `json:"description,omitempty"`
Name string `json:"name"`
Permissions []RolePermissionEnum `json:"permissions"`
UniqueId string `json:"uniqueId"`
}
OrganizationRoleSchema defines model for OrganizationRoleSchema.
type OrganizationSchema ¶
type OrganizationSchema struct {
BusinessAccountId *string `json:"businessAccountId,omitempty"`
CreatedAt time.Time `json:"createdAt"`
Description *string `json:"description,omitempty"`
FaviconUrl *string `json:"faviconUrl,omitempty"`
LogoUrl *string `json:"logoUrl,omitempty"`
Name string `json:"name"`
UniqueId string `json:"uniqueId"`
WebsiteUrl *string `json:"websiteUrl,omitempty"`
WhatsappBusinessAccountDetails *WhatsAppBusinessAccountDetailsSchema `json:"whatsappBusinessAccountDetails,omitempty"`
}
OrganizationSchema defines model for OrganizationSchema.
type PaginationMeta ¶
type PaginationMeta struct {
Page int64 `json:"page"`
PerPage int64 `json:"per_page"`
Total int `json:"total"`
}
PaginationMeta defines model for PaginationMeta.
type PhoneNumberSchema ¶
type PhoneNumberSchema struct {
CodeVerificationStatus struct {
Status *string `json:"status,omitempty"`
} `json:"code_verification_status"`
DisplayPhoneNumber string `json:"display_phone_number"`
Id string `json:"id"`
PlatformType string `json:"platform_type"`
QualityRating string `json:"quality_rating"`
VerifiedName string `json:"verified_name"`
}
PhoneNumberSchema defines model for PhoneNumberSchema.
type PrimaryAnalyticsResponseSchema ¶
type PrimaryAnalyticsResponseSchema struct {
AggregateAnalytics AggregateAnalyticsSchema `json:"aggregateAnalytics"`
LinkClickAnalytics []LinkClicksGraphDataPointSchema `json:"linkClickAnalytics"`
MessageAnalytics []MessageAnalyticGraphDataPointSchema `json:"messageAnalytics"`
}
PrimaryAnalyticsResponseSchema defines model for PrimaryAnalyticsResponseSchema.
type RegenerateApiKeyResponseSchema ¶
type RegenerateApiKeyResponseSchema struct {
ApiKey *ApiKeySchema `json:"apiKey,omitempty"`
}
RegenerateApiKeyResponseSchema defines model for RegenerateApiKeyResponseSchema.
type RegisterJSONRequestBody ¶
type RegisterJSONRequestBody = RegisterRequestBodySchema
RegisterJSONRequestBody defines body for Register for application/json ContentType.
type RegisterRequestBodySchema ¶
type RegisterRequestBodySchema struct {
Email string `json:"email"`
Name string `json:"name"`
OrganizationInviteSlug *string `json:"organizationInviteSlug,omitempty"`
Password string `json:"password"`
Username string `json:"username"`
}
RegisterRequestBodySchema defines model for RegisterRequestBodySchema.
type RegisterRequestResponseBodySchema ¶
type RegisterRequestResponseBodySchema struct {
IsOtpSent bool `json:"isOtpSent"`
}
RegisterRequestResponseBodySchema defines model for RegisterRequestResponseBodySchema.
type RolePermissionEnum ¶
type RolePermissionEnum string
RolePermissionEnum defines model for RolePermissionEnum.
const ( AssignConversation RolePermissionEnum = "Assign:Conversation" BulkImportContacts RolePermissionEnum = "BulkImport:Contacts" CreateCampaign RolePermissionEnum = "Create:Campaign" CreateContact RolePermissionEnum = "Create:Contact" CreateList RolePermissionEnum = "Create:List" CreateOrganizationMember RolePermissionEnum = "Create:OrganizationMember" CreateOrganizationRole RolePermissionEnum = "Create:OrganizationRole" CreateTag RolePermissionEnum = "Create:Tag" DeleteCampaign RolePermissionEnum = "Delete:Campaign" DeleteContact RolePermissionEnum = "Delete:Contact" DeleteConversation RolePermissionEnum = "Delete:Conversation" DeleteList RolePermissionEnum = "Delete:List" DeleteOrganizationMember RolePermissionEnum = "Delete:OrganizationMember" DeleteOrganizationRole RolePermissionEnum = "Delete:OrganizationRole" DeleteTag RolePermissionEnum = "Delete:Tag" GetApiKey RolePermissionEnum = "Get:ApiKey" GetAppSettings RolePermissionEnum = "Get:AppSettings" GetCampaign RolePermissionEnum = "Get:Campaign" GetCampaignAnalytics RolePermissionEnum = "Get:CampaignAnalytics" GetContact RolePermissionEnum = "Get:Contact" GetConversation RolePermissionEnum = "Get:Conversation" GetList RolePermissionEnum = "Get:List" GetMessageTemplates RolePermissionEnum = "Get:MessageTemplates" GetOrganizationMember RolePermissionEnum = "Get:OrganizationMember" GetOrganizationRole RolePermissionEnum = "Get:OrganizationRole" GetPhoneNumbers RolePermissionEnum = "Get:PhoneNumbers" GetPrimaryAnalytics RolePermissionEnum = "Get:PrimaryAnalytics" GetSecondaryAnalytics RolePermissionEnum = "Get:SecondaryAnalytics" GetTag RolePermissionEnum = "Get:Tag" RegenerateApiKey RolePermissionEnum = "Regenerate:ApiKey" UnassignConversation RolePermissionEnum = "Unassign:Conversation" UpdateAppSettings RolePermissionEnum = "Update:AppSettings" UpdateCampaign RolePermissionEnum = "Update:Campaign" UpdateContact RolePermissionEnum = "Update:Contact" UpdateConversation RolePermissionEnum = "Update:Conversation" UpdateIntegrationSettings RolePermissionEnum = "Update:IntegrationSettings" UpdateList RolePermissionEnum = "Update:List" UpdateOrganization RolePermissionEnum = "Update:Organization" UpdateOrganizationMember RolePermissionEnum = "Update:OrganizationMember" UpdateOrganizationRole RolePermissionEnum = "Update:OrganizationRole" UpdateTag RolePermissionEnum = "Update:Tag" )
Defines values for RolePermissionEnum.
type RoleUpdateSchema ¶
type RoleUpdateSchema struct {
Description *string `json:"description,omitempty"`
Name string `json:"name"`
Permissions []RolePermissionEnum `json:"permissions"`
}
RoleUpdateSchema defines model for RoleUpdateSchema.
type SecondaryAnalyticsDashboardResponseSchema ¶
type SecondaryAnalyticsDashboardResponseSchema struct {
ConversationsAnalytics []ConversationAnalyticsDataPointSchema `json:"conversationsAnalytics"`
MessageTypeTrafficDistributionAnalytics []MessageTypeDistributionGraphDataPointSchema `json:"messageTypeTrafficDistributionAnalytics"`
}
SecondaryAnalyticsDashboardResponseSchema defines model for SecondaryAnalyticsDashboardResponseSchema.
type SwitchOrganizationJSONBody ¶
type SwitchOrganizationJSONBody struct {
OrganizationId *string `json:"organizationId,omitempty"`
}
SwitchOrganizationJSONBody defines parameters for SwitchOrganization.
type SwitchOrganizationJSONRequestBody ¶
type SwitchOrganizationJSONRequestBody SwitchOrganizationJSONBody
SwitchOrganizationJSONRequestBody defines body for SwitchOrganization for application/json ContentType.
type SwitchOrganizationResponseSchema ¶
type SwitchOrganizationResponseSchema struct {
Token string `json:"token"`
}
SwitchOrganizationResponseSchema defines model for SwitchOrganizationResponseSchema.
type SystemFeatureFlags ¶
type SystemFeatureFlags struct {
IsApiAccessEnabled bool `json:"isApiAccessEnabled"`
IsMultiOrganizationEnabled bool `json:"isMultiOrganizationEnabled"`
IsRoleBasedAccessControlEnabled bool `json:"isRoleBasedAccessControlEnabled"`
}
SystemFeatureFlags defines model for SystemFeatureFlags.
type TemplateMessageButtonType ¶
type TemplateMessageButtonType string
TemplateMessageButtonType defines model for TemplateMessageButtonType.
const ( COPYCODE TemplateMessageButtonType = "COPY_CODE" PHONENUMBER TemplateMessageButtonType = "PHONE_NUMBER" QUICKREPLY TemplateMessageButtonType = "QUICK_REPLY" URL TemplateMessageButtonType = "URL" )
Defines values for TemplateMessageButtonType.
type TemplateMessageComponentButton ¶
type TemplateMessageComponentButton struct {
Example *string `json:"example,omitempty"`
PhoneNumber *string `json:"phone_number,omitempty"`
Text *string `json:"text,omitempty"`
Type *TemplateMessageButtonType `json:"type,omitempty"`
Url *string `json:"url,omitempty"`
}
TemplateMessageComponentButton defines model for TemplateMessageComponentButton.
type TemplateMessageComponentExample ¶
type TemplateMessageComponentExample struct {
BodyText *[][]string `json:"body_text,omitempty"`
HeaderHandle *[]string `json:"header_handle,omitempty"`
HeaderText *[]string `json:"header_text,omitempty"`
}
TemplateMessageComponentExample defines model for TemplateMessageComponentExample.
type TemplateMessageQualityScore ¶
type TemplateMessageQualityScore struct {
Date *int `json:"date,omitempty"`
Reasons *[]string `json:"reasons,omitempty"`
Score *int `json:"score,omitempty"`
}
TemplateMessageQualityScore defines model for TemplateMessageQualityScore.
type TemplateSchema ¶
type TemplateSchema struct {
BodyText string `json:"bodyText"`
Content string `json:"content"`
CreatedAt time.Time `json:"createdAt"`
Header struct {
Content *string `json:"content,omitempty"`
HeaderType *string `json:"headerType,omitempty"`
} `json:"header"`
TemplateId string `json:"templateId"`
}
TemplateSchema defines model for TemplateSchema.
type TransferOrganizationOwnershipJSONRequestBody ¶
type TransferOrganizationOwnershipJSONRequestBody = TransferOrganizationOwnershipSchema
TransferOrganizationOwnershipJSONRequestBody defines body for TransferOrganizationOwnership for application/json ContentType.
type TransferOrganizationOwnershipResponseSchema ¶
type TransferOrganizationOwnershipResponseSchema struct {
IsTransferred bool `json:"isTransferred"`
}
TransferOrganizationOwnershipResponseSchema defines model for TransferOrganizationOwnershipResponseSchema.
type TransferOrganizationOwnershipSchema ¶
type TransferOrganizationOwnershipSchema struct {
NewOwnerId string `json:"newOwnerId"`
}
TransferOrganizationOwnershipSchema defines model for TransferOrganizationOwnershipSchema.
type UnassignConversationJSONRequestBody ¶
type UnassignConversationJSONRequestBody = UnassignConversationSchema
UnassignConversationJSONRequestBody defines body for UnassignConversation for application/json ContentType.
type UnassignConversationResponseSchema ¶
type UnassignConversationResponseSchema struct {
Data bool `json:"data"`
}
UnassignConversationResponseSchema defines model for UnassignConversationResponseSchema.
type UnassignConversationSchema ¶
type UnassignConversationSchema struct {
UserId string `json:"userId"`
}
UnassignConversationSchema defines model for UnassignConversationSchema.
type UpdateCampaignByIdJSONRequestBody ¶
type UpdateCampaignByIdJSONRequestBody = UpdateCampaignSchema
UpdateCampaignByIdJSONRequestBody defines body for UpdateCampaignById for application/json ContentType.
type UpdateCampaignByIdResponseSchema ¶
type UpdateCampaignByIdResponseSchema struct {
IsUpdated bool `json:"isUpdated"`
}
UpdateCampaignByIdResponseSchema defines model for UpdateCampaignByIdResponseSchema.
type UpdateCampaignSchema ¶
type UpdateCampaignSchema struct {
Description *string `json:"description,omitempty"`
EnableLinkTracking bool `json:"enableLinkTracking"`
ListIds []string `json:"listIds"`
Name string `json:"name"`
PhoneNumber *string `json:"phoneNumber,omitempty"`
Status *CampaignStatusEnum `json:"status,omitempty"`
Tags []string `json:"tags"`
TemplateComponentParameters *map[string]interface{} `json:"templateComponentParameters,omitempty"`
TemplateMessageId *string `json:"templateMessageId,omitempty"`
}
UpdateCampaignSchema defines model for UpdateCampaignSchema.
type UpdateContactByIdJSONRequestBody ¶
type UpdateContactByIdJSONRequestBody = UpdateContactSchema
UpdateContactByIdJSONRequestBody defines body for UpdateContactById for application/json ContentType.
type UpdateContactListSchema ¶
type UpdateContactListSchema struct {
Description *string `json:"description,omitempty"`
Name string `json:"name"`
Tags []TagSchema `json:"tags"`
}
UpdateContactListSchema defines model for UpdateContactListSchema.
type UpdateContactSchema ¶
type UpdateContactSchema struct {
Attributes map[string]interface{} `json:"attributes"`
Lists *[]string `json:"lists,omitempty"`
Name string `json:"name"`
Phone string `json:"phone"`
Status ContactStatusEnum `json:"status"`
}
UpdateContactSchema defines model for UpdateContactSchema.
type UpdateConversationByIdJSONRequestBody ¶
type UpdateConversationByIdJSONRequestBody = UpdateConversationSchema
UpdateConversationByIdJSONRequestBody defines body for UpdateConversationById for application/json ContentType.
type UpdateConversationByIdResponseSchema ¶
type UpdateConversationByIdResponseSchema struct {
Conversation ConversationSchema `json:"conversation"`
}
UpdateConversationByIdResponseSchema defines model for UpdateConversationByIdResponseSchema.
type UpdateConversationSchema ¶
type UpdateConversationSchema struct {
Status ConversationStatusEnum `json:"status"`
}
UpdateConversationSchema defines model for UpdateConversationSchema.
type UpdateListByIdJSONRequestBody ¶
type UpdateListByIdJSONRequestBody = UpdateContactListSchema
UpdateListByIdJSONRequestBody defines body for UpdateListById for application/json ContentType.
type UpdateListByIdResponseSchema ¶
type UpdateListByIdResponseSchema struct {
List ContactListSchema `json:"list"`
}
UpdateListByIdResponseSchema defines model for UpdateListByIdResponseSchema.
type UpdateOrganizationByIdResponseSchema ¶
type UpdateOrganizationByIdResponseSchema struct {
Organization OrganizationSchema `json:"organization"`
}
UpdateOrganizationByIdResponseSchema defines model for UpdateOrganizationByIdResponseSchema.
type UpdateOrganizationJSONRequestBody ¶
type UpdateOrganizationJSONRequestBody = UpdateOrganizationSchema
UpdateOrganizationJSONRequestBody defines body for UpdateOrganization for application/json ContentType.
type UpdateOrganizationMemberByIdJSONRequestBody ¶
type UpdateOrganizationMemberByIdJSONRequestBody = UpdateOrganizationMemberSchema
UpdateOrganizationMemberByIdJSONRequestBody defines body for UpdateOrganizationMemberById for application/json ContentType.
type UpdateOrganizationMemberByIdResponseSchema ¶
type UpdateOrganizationMemberByIdResponseSchema struct {
Member OrganizationMemberSchema `json:"member"`
}
UpdateOrganizationMemberByIdResponseSchema defines model for UpdateOrganizationMemberByIdResponseSchema.
type UpdateOrganizationMemberRoleByIdJSONRequestBody ¶
type UpdateOrganizationMemberRoleByIdJSONRequestBody = UpdateOrganizationMemberRoleSchema
UpdateOrganizationMemberRoleByIdJSONRequestBody defines body for UpdateOrganizationMemberRoleById for application/json ContentType.
type UpdateOrganizationMemberRoleByIdResponseSchema ¶
type UpdateOrganizationMemberRoleByIdResponseSchema struct {
IsRoleUpdated bool `json:"isRoleUpdated"`
}
UpdateOrganizationMemberRoleByIdResponseSchema defines model for UpdateOrganizationMemberRoleByIdResponseSchema.
type UpdateOrganizationMemberRoleSchema ¶
type UpdateOrganizationMemberRoleSchema struct {
UpdatedRoleIds []string `json:"updatedRoleIds"`
}
UpdateOrganizationMemberRoleSchema defines model for UpdateOrganizationMemberRoleSchema.
type UpdateOrganizationMemberSchema ¶
type UpdateOrganizationMemberSchema struct {
AccessLevel *UserPermissionLevel `json:"accessLevel,omitempty"`
}
UpdateOrganizationMemberSchema defines model for UpdateOrganizationMemberSchema.
type UpdateOrganizationRoleByIdJSONRequestBody ¶
type UpdateOrganizationRoleByIdJSONRequestBody = RoleUpdateSchema
UpdateOrganizationRoleByIdJSONRequestBody defines body for UpdateOrganizationRoleById for application/json ContentType.
type UpdateOrganizationSchema ¶
type UpdateOrganizationSchema struct {
Description *string `json:"description,omitempty"`
Name string `json:"name"`
}
UpdateOrganizationSchema defines model for UpdateOrganizationSchema.
type UpdateOrganizationSettingsResponseSchema ¶
type UpdateOrganizationSettingsResponseSchema struct {
Setting *struct {
Key *string `json:"key,omitempty"`
Value *string `json:"value,omitempty"`
} `json:"setting,omitempty"`
}
UpdateOrganizationSettingsResponseSchema defines model for UpdateOrganizationSettingsResponseSchema.
type UpdateRoleByIdResponseSchema ¶
type UpdateRoleByIdResponseSchema struct {
Role OrganizationRoleSchema `json:"role"`
}
UpdateRoleByIdResponseSchema defines model for UpdateRoleByIdResponseSchema.
type UpdateSettingsJSONBody ¶
type UpdateSettingsJSONBody struct {
Key *string `json:"key,omitempty"`
Value *string `json:"value,omitempty"`
}
UpdateSettingsJSONBody defines parameters for UpdateSettings.
type UpdateSettingsJSONRequestBody ¶
type UpdateSettingsJSONRequestBody UpdateSettingsJSONBody
UpdateSettingsJSONRequestBody defines body for UpdateSettings for application/json ContentType.
type UpdateUserJSONRequestBody ¶
type UpdateUserJSONRequestBody = UpdateUserSchema
UpdateUserJSONRequestBody defines body for UpdateUser for application/json ContentType.
type UpdateUserResponseSchema ¶
type UpdateUserResponseSchema struct {
IsUpdated bool `json:"isUpdated"`
}
UpdateUserResponseSchema defines model for UpdateUserResponseSchema.
type UpdateUserSchema ¶
type UpdateUserSchema struct {
Name string `json:"name"`
ProfilePicture *string `json:"profilePicture,omitempty"`
}
UpdateUserSchema defines model for UpdateUserSchema.
type UpdateWhatsappBusinessAccountDetailsJSONRequestBody ¶
type UpdateWhatsappBusinessAccountDetailsJSONRequestBody = WhatsAppBusinessAccountDetailsSchema
UpdateWhatsappBusinessAccountDetailsJSONRequestBody defines body for UpdateWhatsappBusinessAccountDetails for application/json ContentType.
type UserPermissionLevel ¶
type UserPermissionLevel string
UserPermissionLevel defines model for UserPermissionLevel.
const ( Member UserPermissionLevel = "Member" Owner UserPermissionLevel = "Owner" )
Defines values for UserPermissionLevel.
type UserSchema ¶
type UserSchema struct {
CreatedAt time.Time `json:"createdAt"`
CurrentOrganizationAccessLevel *UserPermissionLevel `json:"currentOrganizationAccessLevel,omitempty"`
Email string `json:"email"`
FeatureFlags *FeatureFlags `json:"featureFlags,omitempty"`
IsOwner bool `json:"isOwner"`
Name string `json:"name"`
Organization OrganizationSchema `json:"organization"`
ProfilePicture *string `json:"profilePicture,omitempty"`
UniqueId string `json:"uniqueId"`
Username string `json:"username"`
}
UserSchema defines model for UserSchema.
type VerifyOtpJSONRequestBody ¶
type VerifyOtpJSONRequestBody = VerifyOtpRequestBodySchema
VerifyOtpJSONRequestBody defines body for VerifyOtp for application/json ContentType.
type VerifyOtpRequestBodySchema ¶
type VerifyOtpRequestBodySchema struct {
Email string `json:"email"`
Name string `json:"name"`
OrganizationInviteSlug *string `json:"organizationInviteSlug,omitempty"`
Otp string `json:"otp"`
Password string `json:"password"`
Username string `json:"username"`
}
VerifyOtpRequestBodySchema defines model for VerifyOtpRequestBodySchema.
type VerifyOtpResponseBodySchema ¶
type VerifyOtpResponseBodySchema struct {
Token string `json:"token"`
}
VerifyOtpResponseBodySchema defines model for VerifyOtpResponseBodySchema.
type WhatsAppBusinessAccountDetailsSchema ¶
type WhatsAppBusinessAccountDetailsSchema struct {
AccessToken string `json:"accessToken"`
BusinessAccountId string `json:"businessAccountId"`
WebhookSecret string `json:"webhookSecret"`
}
WhatsAppBusinessAccountDetailsSchema defines model for WhatsAppBusinessAccountDetailsSchema.
type WhatsAppBusinessHSMWhatsAppHSMComponent ¶
type WhatsAppBusinessHSMWhatsAppHSMComponent struct {
AddSecurityRecommendation *bool `json:"add_security_recommendation,omitempty"`
Buttons *[]TemplateMessageComponentButton `json:"buttons,omitempty"`
Cards *[]map[string]interface{} `json:"cards,omitempty"`
CodeExpirationMinutes *int `json:"code_expiration_minutes,omitempty"`
Example *TemplateMessageComponentExample `json:"example,omitempty"`
Format *MessageTemplateComponentFormat `json:"format,omitempty"`
LimitedTimeOffer *map[string]interface{} `json:"limited_time_offer,omitempty"`
Text *string `json:"text,omitempty"`
Type *MessageTemplateComponentType `json:"type,omitempty"`
}
WhatsAppBusinessHSMWhatsAppHSMComponent defines model for WhatsAppBusinessHSMWhatsAppHSMComponent.