components

type AddressType string

type ApiCompatibleJsonConverterConfigs struct {
	ReplyToMessageId  string
	SendToPhoneNumber string
}

type AudioMessage struct {
	Id   string `json:"id,omitempty"`
	Link string `json:"link,omitempty"`
}

type AudioMessageApiPayload struct {
	BaseMessagePayload
	Audio AudioMessage `json:"audio" validate:"required"`
}

type AudioMessageConfigs = AudioMessage

type BaseMessage interface {
	ToJson(configs ApiCompatibleJsonConverterConfigs) ([]byte, error)
}

type BaseMessagePayload struct {
	Context          *Context    `json:"context,omitempty"`
	To               string      `json:"to"`
	Type             MessageType `json:"type"`
	MessagingProduct string      `json:"messaging_product"`
	RecipientType    string      `json:"recipient_type"`
}

type CallToAction struct {
	DisplayText string `json:"display_text" validate:"required"`
	Url         string `json:"url" validate:"required"`
}

type CatalogMessage struct {
	Type   InteractiveMessageType `json:"type" validate:"required"`
	Action CatalogMessageAction   `json:"action" validate:"required"`
	Body   CatalogMessageBody     `json:"body" validate:"required"`
	Footer *CatalogMessageFooter  `json:"footer,omitempty"`
	Header *CatalogMessageHeader  `json:"header,omitempty"`
}

type CatalogMessageAction struct {
	Name       string                        `json:"name" validate:"required"`
	Parameters CatalogMessageActionParameter `json:"parameters,omitempty"`
}

type CatalogMessageActionParameter struct {
	ThumbnailProductRetailerId string `json:"thumbnail_product_retailer_id" validate:"required"`
}

type CatalogMessageApiPayload struct {
	BaseMessagePayload
	Interactive CatalogMessage `json:"interactive" validate:"required"`
}

type CatalogMessageBody struct {
	Text string `json:"text" validate:"required"`
}

type CatalogMessageFooter struct {
	Text string `json:"text" validate:"required"`
}

type CatalogMessageHeader struct {
	Text string `json:"text" validate:"required"`
}

type Contact struct {
	Name      ContactName      `json:"name" validate:"required"`
	Org       ContactOrg       `json:"org,omitempty"`
	Addresses []ContactAddress `json:"addresses,omitempty"`
	Urls      []ContactUrl     `json:"urls,omitempty"`
	Emails    []ContactEmail   `json:"emails,omitempty"`
	Phones    []ContactPhone   `json:"phones,omitempty"`
	Birthday  string           `json:"birthday,omitempty"`
}

type ContactAddress struct {
	Street      string      `json:"street,omitempty"`
	City        string      `json:"city,omitempty"`
	State       string      `json:"state,omitempty"`
	Zip         string      `json:"zip,omitempty"`
	Country     string      `json:"country,omitempty"`
	CountryCode string      `json:"countryCode,omitempty"`
	Type        AddressType `json:"type" validate:"required"`
}

type ContactEmail struct {
	Email string    `json:"email,omitempty"`
	Type  EmailType `json:"type,omitempty"`
}

type ContactMessage struct {
	Contacts []Contact `json:"contacts" validate:"required"`
}

type ContactMessageApiPayload struct {
	BaseMessagePayload
	Contacts []Contact `json:"contacts" validate:"required"`
}

type ContactMessageConfigs struct {
	Name string `json:"name" validate:"required"`
}

type ContactName struct {
	FormattedName string `json:"formatted_name" validate:"required"`
	FirstName     string `json:"first_name,omitempty"`
	LastName      string `json:"last_name,omitempty"`
	MiddleName    string `json:"middle_name,omitempty"`
	Suffix        string `json:"suffix,omitempty"`
	Prefix        string `json:"prefix,omitempty"`
}

type ContactOrg struct {
	Company    string `json:"company,omitempty"`
	Title      string `json:"title,omitempty"`
	Department string `json:"department,omitempty"`
}

type ContactPhone struct {
	Phone string    `json:"phone,omitempty"`
	WaId  string    `json:"wa_id,omitempty"`
	Type  PhoneType `json:"type" validate:"required"`
}

type ContactUrl struct {
	Url  string  `json:"url" validate:"required"`
	Type UrlType `json:"type" validate:"required"`
}

type Context struct {
	MessageId string `json:"message_id,omitempty"`
}

type CtaMessage struct {
	Action CtaMessageAction       `json:"action" validate:"required"`
	Body   CtaMessageBody         `json:"body" validate:"required"`
	Footer *CtaMessageFooter      `json:"footer,omitempty"`
	Header CtaMessageHeader       `json:"header,omitempty"`
	Type   InteractiveMessageType `json:"type" validate:"required"`
}

type CtaMessageAction struct {
	Name       string                 `json:"name" validate:"required"`
	Parameters CtaMessageActionParams `json:"parameters" validate:"required"`
}

type CtaMessageActionParams struct {
	DisplayText string `json:"display_text" validate:"required"`
	Url         string `json:"url" validate:"required"`
}

type CtaMessageApiPayload struct {
	BaseMessagePayload
	Interactive CtaMessage `json:"interactive" validate:"required"`
}

type CtaMessageBody struct {
	Text string `json:"text" validate:"required"`
}

type CtaMessageFooter struct {
	Text string `json:"text"`
}

type CtaMessageHeader struct {
	Type CtaMessageHeaderType `json:"type" validate:"required"`
	Text string               `json:"text"`
}

type CtaMessageHeaderType string

type CtaMessageParams struct {
	BodyText string `validate:"required"`
}

type DocumentMessage struct {
	Id       string  `json:"id,omitempty"`
	Link     *string `json:"link,omitempty"`
	Caption  *string `json:"caption,omitempty"`
	FileName string  `json:"filename" validate:"required"`
}

type DocumentMessageApiPayload struct {
	BaseMessagePayload
	Document DocumentMessage `json:"document" validate:"required"`
}

type DocumentMessageConfigs struct {
	Id       string  `json:"id" validate:"required"`
	Link     *string `json:"link,omitempty"`
	Caption  *string `json:"caption,omitempty"`
	FileName string  `json:"filename" validate:"required"`
}

type EmailType string

type FlowAction string

type FlowActionPayload struct {
	// Screen is the unique ID of the Screen to navigate to
	// Default is "FIRST_ENTRY_SCREEN"
	Screen string `json:"screen,omitempty"`
	// Data is the input data for the screen
	Data map[string]interface{} `json:"data,omitempty"`
}

type FlowMessage struct {
	Type   InteractiveMessageType `json:"type" validate:"required"`
	Header *FlowMessageHeader     `json:"header,omitempty"`
	Body   FlowMessageBody        `json:"body" validate:"required"`
	Footer *FlowMessageFooter     `json:"footer,omitempty"`
	Action FlowMessageAction      `json:"action" validate:"required"`
}

type FlowMessageAction struct {
	// Name must be "flow"
	Name string `json:"name" validate:"required"`
	// Parameters contains the flow action parameters
	Parameters FlowMessageActionParams `json:"parameters" validate:"required"`
}

type FlowMessageActionParams struct {
	// FlowMessageVersion is required, typically "3"
	FlowMessageVersion string `json:"flow_message_version" validate:"required"`
	// FlowID is the unique identifier for the flow (either FlowID or FlowName required)
	FlowID string `json:"flow_id,omitempty"`
	// FlowName is the name of the flow (either FlowID or FlowName required)
	FlowName string `json:"flow_name,omitempty"`
	// FlowCTA is the call to action button text (required)
	FlowCTA string `json:"flow_cta" validate:"required"`
	// FlowToken is an optional token to authenticate the flow, default is "unused"
	FlowToken string `json:"flow_token,omitempty"`
	// FlowAction is either "navigate" or "data_exchange", default is "navigate"
	FlowAction FlowAction `json:"flow_action,omitempty"`
	// FlowActionPayload contains screen and data for navigate action
	FlowActionPayload *FlowActionPayload `json:"flow_action_payload,omitempty"`
	// Mode is "draft" or "published", default is "published"
	Mode FlowMessageMode `json:"mode,omitempty"`
}

type FlowMessageApiPayload struct {
	BaseMessagePayload
	Interactive FlowMessage `json:"interactive" validate:"required"`
}

type FlowMessageBody struct {
	Text string `json:"text" validate:"required"`
}

type FlowMessageFooter struct {
	Text string `json:"text"`
}

type FlowMessageHeader struct {
	Type FlowMessageHeaderType `json:"type" validate:"required"`
	Text string                `json:"text,omitempty"`
}

type FlowMessageHeaderType string

type FlowMessageMode string

type FlowMessageParams struct {
	// BodyText is the message body text (required)
	BodyText string `validate:"required"`
	// FlowID is the unique ID of the flow (either FlowID or FlowName required)
	FlowID string
	// FlowName is the name of the flow (either FlowID or FlowName required)
	FlowName string
	// FlowCTA is the call to action button text (required)
	FlowCTA string `validate:"required"`
	// FlowMessageVersion is the version of flow message protocol, default is "3"
	FlowMessageVersion string
}

type ImageMessage struct {
	Id      string `json:"id,omitempty"`
	Link    string `json:"link,omitempty"`
	Caption string `json:"caption,omitempty"`
}

type ImageMessageApiPayload struct {
	BaseMessagePayload
	Image ImageMessage `json:"image" validate:"required"`
}

type ImageMessageConfigs = ImageMessage

type InteractiveMessageType string

type ListMessageApiPayload struct {
	BaseMessagePayload
	Interactive listMessage `json:"interactive" validate:"required"` // Interactive message.
}

type ListMessageBody struct {
	Text string `json:"text" validate:"required"` // Text of the body.
}

type ListMessageFooter struct {
	Text string `json:"text" validate:"required"` // Text of the footer.
}

type ListMessageHeader struct {
	Type string `json:"type" validate:"required"` // Type of the header.
	Text string `json:"text" validate:"required"` // Text of the header.
}

type ListMessageParams struct {
	ButtonText string `json:"-" validate:"required"` // Text of the button.
	BodyText   string `json:"-" validate:"required"` // Text of the body.
}

type ListSection struct {
	Title string           `json:"title" validate:"required"` // Title of the section.
	Rows  []listSectionRow `json:"rows" validate:"required"`  // Rows in the section.
}

type LocationMessage struct {
	Latitude  float64 `json:"latitude" validate:"required"`  // Latitude of the location
	Longitude float64 `json:"longitude" validate:"required"` // Longitude of the location
	Address   string  `json:"address,omitempty"`             // Address of the location (optional)
	Name      string  `json:"name,omitempty"`                // Name of the location (optional)
}

type LocationMessageApiPayload struct {
	BaseMessagePayload
	Location LocationMessage `json:"location" validate:"required"` // Location message
}

type LocationRequestMessage struct {
	Type   InteractiveMessageType     `json:"type" validate:"required"`   // Type of the message.
	Action locationMessageAction      `json:"action" validate:"required"` // Action of the message.
	Body   LocationRequestMessageBody `json:"body,omitempty"`             // Body of the message.
}

type LocationRequestMessageApiPayload struct {
	BaseMessagePayload
	Interactive LocationRequestMessage `json:"interactive" validate:"required"` // Interactive message.
}

type LocationRequestMessageBody struct {
	Text string `json:"text" validate:"required"` // Text of the body.
}

type LocationRequestMessageParams struct {
	BodyText string `json:"-" validate:"required"` // Text of the body.
}

type MessageType string

type Order struct {
	CatalogID    string        `json:"catalog_id"`    // CatalogID is the ID of the catalog associated with the order.
	ProductItems []ProductItem `json:"product_items"` // ProductItems is a list of product items in the order.
	Text         *string       `json:"text"`          // Text is an additional text associated with the order.
}

type PhoneType string

type Product struct {
	RetailerId string `json:"product_retailer_id" validate:"required"`
}

type ProductItem struct {
	Currency          string  `json:"currency"`            // Currency is the currency of the product item.
	ItemPrice         float64 `json:"item_price"`          // ItemPrice is the price of the product item.
	ProductRetailerID string  `json:"product_retailer_id"` // ProductRetailerID is the ID of the retailer associated with the product item.
	Quantity          int     `json:"quantity"`            // Quantity is the quantity of the product item.
}

type ProductListMessage struct {
	Action ProductListMessageAction  `json:"action" validate:"required"`
	Body   ProductListMessageBody    `json:"body" validate:"required"`
	Footer *ProductListMessageFooter `json:"footer,omitempty"`
	Header *ProductListMessageHeader `json:"header,omitempty"`
	Type   InteractiveMessageType    `json:"type" validate:"required"`
}

type ProductListMessageAction struct {
	Sections  []ProductSection `json:"sections" validate:"required"` // minimum 1 and maximum 10
	CatalogId string           `json:"catalog_id" validate:"required"`
}

type ProductListMessageApiPayload struct {
	BaseMessagePayload
	Interactive ProductListMessage `json:"interactive" validate:"required"`
}

type ProductListMessageBody struct {
	Text string `json:"text" validate:"required"`
}

type ProductListMessageFooter struct {
	Text string `json:"text" validate:"required"`
}

type ProductListMessageHeader struct {
	Type ProductListMessageHeaderType `json:"type" validate:"required"`
	Text string                       `json:"text" validate:"required"`
}

type ProductListMessageHeaderType string

type ProductListMessageParams struct {
	CatalogId string `validate:"required"`
	// Deprecated: action-level product_retailer_id. Use item-level IDs in sections.
	ProductRetailerId string
	BodyText          string `validate:"required"`
	Sections          []ProductSection
}

type ProductMessage struct {
	Type   InteractiveMessageType `json:"type" validate:"required"`
	Body   *ProductMessageBody    `json:"body" validate:"required"`
	Footer *ProductMessageFooter  `json:"footer,omitempty"`
	Header *ProductMessageHeader  `json:"header,omitempty"`
	Action productMessageAction   `json:"action" validate:"required"`
}

type ProductMessageApiPayload struct {
	BaseMessagePayload
	Interactive ProductMessage `json:"interactive" validate:"required"`
}

type ProductMessageBody struct {
	Text string `json:"text" validate:"required"`
}

type ProductMessageFooter struct {
	Text string `json:"text" validate:"required"`
}

type ProductMessageHeader struct {
	Text string `json:"text" validate:"required"`
}

type ProductMessageParams struct {
	CatalogId         string `validate:"required"`
	ProductRetailerId string `validate:"required"`
	BodyText          string `validate:"required"`
}

type ProductSection struct {
	Title    string    `json:"title" validate:"required"`
	Products []Product `json:"product_items" validate:"required"`
}

type QuickReplyButtonMessage struct {
	Type   InteractiveMessageType         `json:"type" validate:"required"`   // Type of the quick reply button message.
	Body   QuickReplyButtonMessageBody    `json:"body" validate:"required"`   // Body of the quick reply button message.
	Action QuickReplyButtonMessageAction  `json:"action" validate:"required"` // Action of the quick reply button message.
	Footer *QuickReplyButtonMessageFooter `json:"footer,omitempty"`           // Footer of the quick reply button message.
	Header *QuickReplyButtonMessageHeader `json:"header,omitempty"`           // Header of the quick reply button message.
}

type QuickReplyButtonMessageAction struct {
	Buttons []quickReplyButtonMessageButton `json:"buttons" validate:"required"` // List of quick reply buttons.
}

type QuickReplyButtonMessageApiPayload struct {
	BaseMessagePayload
	Interactive QuickReplyButtonMessage `json:"interactive" validate:"required"` // Interactive part of the API payload.
}

type QuickReplyButtonMessageBody struct {
	Text string `json:"text" validate:"required"` // Text of the quick reply button message.
}

type QuickReplyButtonMessageFooter struct {
	Text string `json:"text" validate:"required"` // Text of the quick reply button message footer.
}

type QuickReplyButtonMessageHeader struct {
	Type string `json:"type" validate:"required"` // Type of the quick reply button message header.
	Text string `json:"text" validate:"required"` // Text of the quick reply button message header.
}

type ReactionMessage struct {
	MessageId string `json:"message_id" validate:"required"` // The ID of the message to react to.
	Emoji     string `json:"emoji" validate:"required"`      // The emoji representing the reaction.
}

type ReactionMessageApiPayload struct {
	BaseMessagePayload
	Reaction ReactionMessage `json:"reaction" validate:"required"` // The reaction message.
}

type ReactionMessageParams = ReactionMessage

type StickerMessage struct {
	Id   string `json:"id,omitempty"`
	Link string `json:"link,omitempty"`
}

type StickerMessageApiPayload struct {
	BaseMessagePayload
	Sticker StickerMessage `json:"sticker" validate:"required"`
}

type StickerMessageConfigs struct {
	Id   string `json:"id,omitempty"`
	Link string `json:"link,omitempty"`
}

type TemplateMessage struct {
	Name       string                     `json:"name" validate:"required"`       // Template name.
	Language   TemplateMessageLanguage    `json:"language" validate:"required"`   // Language configuration.
	Components []TemplateMessageComponent `json:"components" validate:"required"` // Array of components.
}

type TemplateMessageApiPayload struct {
	BaseMessagePayload
	Template TemplateMessage `json:"template" validate:"required"`
}

type TemplateMessageBodyAndHeaderParameter struct {
	Type          TemplateMessageParameterType      `json:"type" validate:"required"` // e.g., "text", "currency", etc.
	ParameterName *string                           `json:"parameter_name,omitempty"` // Optional: name of the parameter (for named parameters).
	Currency      *TemplateMessageParameterCurrency `json:"currency,omitempty"`       // Currency details (if type is currency).
	DateTime      *TemplateMessageParameterDateTime `json:"date_time,omitempty"`      // Date/time details (if type is date_time).
	Document      *TemplateMessageParameterMedia    `json:"document,omitempty"`       // Document details (if type is document).
	Image         *TemplateMessageParameterMedia    `json:"image,omitempty"`          // Image details (if type is image).
	Text          *string                           `json:"text,omitempty"`           // Text content (if type is text).
	Video         *TemplateMessageParameterMedia    `json:"video,omitempty"`          // Video details (if type is video).
	Location      *TemplateMessageParameterLocation `json:"location,omitempty"`       // Location details (if type is location).
	Product       *TemplateMessageParameterProduct  `json:"product,omitempty"`        // Product details (if type is product).
}

type TemplateMessageButtonComponentType string

type TemplateMessageButtonParameter struct {
	Type       TemplateMessageButtonParameterType    `json:"type" validate:"required"` // e.g., "payload" or "text" or "action"
	Payload    *string                               `json:"payload,omitempty"`        // Required for quick_reply buttons.
	Text       *string                               `json:"text,omitempty"`           // Required for URL buttons.
	Action     *TemplateMessageButtonParameterAction `json:"action,omitempty"`         // Required for catalog buttons.
	CouponCode *string                               `json:"coupon_code,omitempty"`    // Required for copy code button in coupon_code parameter.
}

type TemplateMessageButtonParameterAction struct {
	ThumbnailProductRetailerId string                                                     `json:"thumbnail_product_retailer_id,omitempty"`
	Sections                   *[]TemplateMessageMultiProductButtonActionParameterSection `json:"sections,omitempty"` // Required for MPM buttons. UPTO 10 sections in a buttons parameter
}

type TemplateMessageButtonParameterType string

type TemplateMessageCaraouselCard struct {
	CardIndex  int                        `json:"card_index" validate:"required"`
	Components []TemplateMessageComponent `json:"components" validate:"required"` // only header, buttons and body
}

type TemplateMessageComponent interface {
	GetComponentType() string
}

type TemplateMessageComponentBodyType struct {
	Type       TemplateMessageComponentType `json:"type" validate:"required"`       // "body"
	Parameters []TemplateMessageParameter   `json:"parameters" validate:"required"` // Parameters for the body component.
}

type TemplateMessageComponentButtonType struct {
	Type       TemplateMessageComponentType       `json:"type" validate:"required"`                 // e.g., "button"
	SubType    TemplateMessageButtonComponentType `json:"sub_type" validate:"required"`             // e.g., "quick_reply", "url", etc.
	Index      int                                `json:"index" validate:"required"`                // Position index of the button (0 to 9)
	Parameters *[]TemplateMessageParameter        `json:"parameters,omitempty" validate:"required"` // Parameters for the button component.
}

type TemplateMessageComponentCarouselType struct {
	Type  TemplateMessageComponentType   `json:"type" validate:"required"` // "carousel"
	Cards []TemplateMessageCaraouselCard `json:"cards" validate:"required"`
}

type TemplateMessageComponentHeaderType struct {
	Type       TemplateMessageComponentType `json:"type" validate:"required"`                 // "header"
	Parameters *[]TemplateMessageParameter  `json:"parameters,omitempty" validate:"required"` // Parameters for the header component.
}

type TemplateMessageComponentLimitedTimeOfferType struct {
	Type       TemplateMessageComponentType                `json:"type" validate:"required"`
	Parameters *[]TemplateMessageLimitedTimeOfferParameter `json:"parameters,omitempty" validate:"required"`
}

type TemplateMessageComponentType string

type TemplateMessageConfigs struct {
	Name     string `json:"name" validate:"required"`     // Template name.
	Language string `json:"language" validate:"required"` // Language code.
}

type TemplateMessageLanguage struct {
	Code   string `json:"code" validate:"required"`   // e.g., "en_US"
	Policy string `json:"policy" validate:"required"` // e.g., "deterministic"
}

type TemplateMessageLimitedTimeOfferParameter struct {
	Type             TemplateMessageParameterType `json:"type" validate:"required"` // e.g., "text", "currency", etc.
	LimitedTimeOffer struct {
		ExpirationTimeMs int64 `json:"expiration_time_ms" validate:"required"` // Expiration time in milliseconds.
	} `json:"limited_time_offer" validate:"required"`
}

type TemplateMessageMultiProductButtonActionParameterProductItem struct {
	ProductRetailerId string `json:"product_retailer_id" validate:"required"`
}

type TemplateMessageMultiProductButtonActionParameterSection struct {
	Title string `json:"title" validate:"required"`
	// Upto 30 product items only
	ProductItems []TemplateMessageMultiProductButtonActionParameterProductItem `json:"product_items" validate:"required"`
}

type TemplateMessageParameter interface {
	GetParameterType() string
}

type TemplateMessageParameterCurrency struct {
	FallbackValue string `json:"fallback_value" validate:"required"` // Default text if localization fails.
	Code          string `json:"code" validate:"required"`           // ISO 4217 currency code.
	Amount1000    int    `json:"amount_1000" validate:"required"`    // Amount multiplied by 1000.
}

type TemplateMessageParameterDateTime struct {
	FallbackValue string `json:"fallback_value" validate:"required"` // Default text if localization fails.
}

type TemplateMessageParameterLocation struct {
	Latitude  string `json:"latitude" validate:"required"`  // Latitude.
	Longitude string `json:"longitude" validate:"required"` // Longitude.
	Name      string `json:"name" validate:"required"`      // Location name.
	Address   string `json:"address" validate:"required"`   // Address.
}

type TemplateMessageParameterMedia struct {
	Link string `json:"link" validate:"required"` // URL link of the media.
}

type TemplateMessageParameterProduct struct {
	ProductRetailerId string `json:"product_retailer_id" validate:"required"`
	CatalogId         string `json:"catalog_id" validate:"required"`
}

type TemplateMessageParameterType string

type TextMessageApiPayload struct {
	BaseMessagePayload `json:",inline"`
	Text               TextMessageApiPayloadText `json:"text" validate:"required"` // The text content of the message.
}

type TextMessageApiPayloadText struct {
	Body         string `json:"body" validate:"required"` // The text content of the message.
	AllowPreview bool   `json:"preview_url,omitempty"`    // Whether to allow preview of the message.
}

type TextMessageConfigs struct {
	Text         string `json:"text" validate:"required"` // The text content of the message.
	AllowPreview bool   `json:"allowPreview,omitempty"`   // Whether to allow preview of the message.
}

type UrlType string

type VideoMessage struct {
	Id      string `json:"id,omitempty"`
	Link    string `json:"link,omitempty"`
	Caption string `json:"caption,omitempty"`
}

type VideoMessageApiPayload struct {
	BaseMessagePayload
	Video VideoMessage `json:"video" validate:"required"`
}

type VideoMessageConfigs = VideoMessage