Components

import "github.com/sarthakjdev/wapi.go/pkg/components"

type AddressType string

const (
    HomeAddress AddressType = "HOME"
    WorkAddress AddressType = "WORK"
)

const (
    HomeUrl AddressType = "HOME"
    WorkUrl AddressType = "WORK"
)

type ApiCompatibleJsonConverterConfigs struct {
    ReplyToMessageId  string
    SendToPhoneNumber string
}

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

func NewAudioMessage(params AudioMessageConfigs) (*AudioMessage, error)

func (audio *AudioMessage) ToJson(configs ApiCompatibleJsonConverterConfigs) ([]byte, error)

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"`
}

func NewBaseMessagePayload(to string, messageType MessageType) BaseMessagePayload

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"`
}

func NewContact(name ContactName) *Contact

func (contact *Contact) AddEmail(params ContactEmail)

func (contact *Contact) AddPhone(params ContactPhone)

func (contact *Contact) AddUrl(params ContactUrl)

func (contact *Contact) SetBirthday(params string)

func (contact *Contact) SetFirstName(firstName string)

func (contact *Contact) SetLastName(lastName string)

func (contact *Contact) SetMiddleName(middleName string)

func (contact *Contact) SetOrg(params ContactOrg)

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"`
}

func NewContactMessage(configs []Contact) (*ContactMessage, error)

func (contact *ContactMessage) AddContact(params Contact)

func (m *ContactMessage) ToJson(configs ApiCompatibleJsonConverterConfigs) ([]byte, error)

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 DocumentMessage struct {
}

func NewDocumentMessage(params DocumentMessageConfigs) (*DocumentMessage, error)

func (dm *DocumentMessage) ToJson(configs ApiCompatibleJsonConverterConfigs) ([]byte, error)

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

type DocumentMessageConfigs struct {
}

type EmailType string

const (
    HomeEmail EmailType = "HOME"
    WorkEmail EmailType = "WORK"
)

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

func NewImageMessage(params ImageMessageConfigs) (*ImageMessage, error)

func (image *ImageMessage) SetCaption(params string)

func (image *ImageMessage) ToJson(configs ApiCompatibleJsonConverterConfigs) ([]byte, error)

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

type ImageMessageConfigs = ImageMessage

type InteractiveMessageType string

const (
    InteractiveMessageTypeButton      InteractiveMessageType = "button"
    InteractiveMessageTypeProduct     InteractiveMessageType = "product"
    InteractiveMessageTypeProductList InteractiveMessageType = "product_list"
    InteractiveMessageTypeList        InteractiveMessageType = "list"
)

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 ListMessageParams struct {
    ButtonText string `json:"-" validate:"required"` // Text of the button.
    BodyText   string `json:"-" validate:"required"` // Text of the body.
}

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)
}

func NewLocationMessage(latitude float64, longitude float64) (*LocationMessage, error)

func (location *LocationMessage) SetAddress(params string)

func (location *LocationMessage) SetName(params string)

func (location *LocationMessage) ToJson(configs ApiCompatibleJsonConverterConfigs) ([]byte, error)

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

type MessageType string

const (
    MessageTypeLocation    MessageType = "location"
    MessageTypeAudio       MessageType = "audio"
    MessageTypeVideo       MessageType = "video"
    MessageTypeDocument    MessageType = "document"
    MessageTypeText        MessageType = "text"
    MessageTypeContact     MessageType = "contacts"
    MessageTypeInteractive MessageType = "interactive"
    MessageTypeTemplate    MessageType = "template"
    MessageTypeReaction    MessageType = "reaction"
    MessageTypeSticker     MessageType = "sticker"
    MessageTypeImage       MessageType = "image"
)

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

const (
    CellPhone   PhoneType = "CELL"
    MainPhone   PhoneType = "MAIN"
    IphonePhone PhoneType = "IPHONE"
    HomePhone   PhoneType = "HOME"
    WorkPhone   PhoneType = "WORK"
)

type ProductItem struct {
    Currency          string `json:"currency"`            // Currency is the currency of the product item.
    ItemPrice         string `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          string `json:"quantity"`            // Quantity is the quantity of the product item.
}

type ProductListMessage struct {
}

func NewProductListMessage(params ProductListMessageParams) (*ProductListMessage, error)

func (m *ProductListMessage) ToJson(configs ApiCompatibleJsonConverterConfigs) ([]byte, error)

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

type ProductListMessageParams struct {
}

type ProductMessage struct {
}

func NewProductMessage(params ProductMessageParams) (*ProductMessage, error)

func (m *ProductMessage) ToJson(configs ApiCompatibleJsonConverterConfigs) ([]byte, error)

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

type ProductMessageParams struct {
}

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.
}

func NewQuickReplyButtonMessage(bodyText string) (*QuickReplyButtonMessage, error)

func (m *QuickReplyButtonMessage) AddButton(id, title string) error

func (m *QuickReplyButtonMessage) ToJson(configs ApiCompatibleJsonConverterConfigs) ([]byte, error)

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 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.
}

func NewReactionMessage(params ReactionMessageParams) (*ReactionMessage, error)

func (reaction *ReactionMessage) ToJson(configs ApiCompatibleJsonConverterConfigs) ([]byte, error)

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"`
}

func NewStickerMessage(params *StickerMessageConfigs) (*StickerMessage, error)

func (sticker *StickerMessage) ToJson(configs ApiCompatibleJsonConverterConfigs) ([]byte, error)

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 {
}

func NewTemplateMessage() (*TemplateMessage, error)

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

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"`
}

func NewVideoMessage(params VideoMessageConfigs) (*VideoMessage, error)

func (video *VideoMessage) SetCaption(params string)

func (video *VideoMessage) ToJson(configs ApiCompatibleJsonConverterConfigs) ([]byte, error)

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

type VideoMessageConfigs = VideoMessage

type listMessage struct {
    Type   InteractiveMessageType `json:"type" validate:"required"`   // Type of the message.
    Action listMessageAction      `json:"action" validate:"required"` // Action of the message.
    Body   ListMessageBody        `json:"body,omitempty"`             // Body of the message.
}

func NewListMessage(params ListMessageParams) (*listMessage, error)

func (m *listMessage) AddSection(section *listSection)

func (m *listMessage) SetBodyText(section *listSection)

func (m *listMessage) ToJson(configs ApiCompatibleJsonConverterConfigs) ([]byte, error)

type listMessageAction struct {
    ButtonText string        `json:"button" validate:"required"`   // Text of the button.
    Sections   []listSection `json:"sections" validate:"required"` // Sections in the list message.
}

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

func NewListSection(title string) (*listSection, error)

func (section *listSection) AddRow(row *listSectionRow)

func (section *listSection) SetTitle(title string)

type listSectionRow struct {
    Id          string `json:"id" validate:"required"`          // ID of the row.
    Description string `json:"description" validate:"required"` // Description of the row.
    Title       string `json:"title" validate:"required"`       // Title of the row.
}

func NewListSectionRow(id, title, description string) (*listSectionRow, error)

func (row *listSectionRow) SetDescription(description string)

func (row *listSectionRow) SetId(id string)

func (row *listSectionRow) SetTitle(title string)

type quickReplyButtonMessageButton struct {
    Type  string                             `json:"type" validate:"required"`  // Type of the quick reply button.
    Reply quickReplyButtonMessageButtonReply `json:"reply" validate:"required"` // Reply structure of the quick reply button.
}

func NewQuickReplyButton(id, title string) (*quickReplyButtonMessageButton, error)

type quickReplyButtonMessageButtonReply struct {
    Title string `json:"title" validate:"required"` // Title of the quick reply button.
    Id    string `json:"id" validate:"required"`    // ID of the quick reply button.
}

type textMessage struct {
    Text         string // The text content of the message.
    AllowPreview bool   // Whether to allow preview of the message.
}

func NewTextMessage(configs TextMessageConfigs) (*textMessage, error)

func (m *textMessage) SetText(text string)

func (m *textMessage) ToJson(configs ApiCompatibleJsonConverterConfigs) ([]byte, error)