zavudev 0.7.0 → 0.8.0

data/lib/zavudev/models/invitation_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Invitations#retrieve
+    class InvitationRetrieveParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute invitation_id
+      #
+      #   @return [String]
+      required :invitation_id, String
+
+      # @!method initialize(invitation_id:, request_options: {})
+      #   @param invitation_id [String]
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/invitation_retrieve_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Invitations#retrieve
+    class InvitationRetrieveResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute invitation
+      #
+      #   @return [Zavudev::Models::Invitation]
+      required :invitation, -> { Zavudev::Invitation }
+
+      # @!method initialize(invitation:)
+      #   @param invitation [Zavudev::Models::Invitation]
+    end
+  end
+end

data/lib/zavudev/models/message_content.rb

@@ -15,6 +15,39 @@ module Zavudev
       #   @return [Array<Zavudev::Models::MessageContent::Contact>, nil]
       optional :contacts, -> { Zavudev::Internal::Type::ArrayOf[Zavudev::MessageContent::Contact] }
 
+      # @!attribute cta_display_text
+      #   Button label for cta_url messages.
+      #
+      #   @return [String, nil]
+      optional :cta_display_text, String, api_name: :ctaDisplayText
+
+      # @!attribute cta_header_media_url
+      #   Public HTTPS URL of the header media when ctaHeaderType is 'image', 'video', or
+      #   'document'. WhatsApp fetches this URL — it must be publicly reachable and return
+      #   the declared content type.
+      #
+      #   @return [String, nil]
+      optional :cta_header_media_url, String, api_name: :ctaHeaderMediaUrl
+
+      # @!attribute cta_header_text
+      #   Header text when ctaHeaderType is 'text'.
+      #
+      #   @return [String, nil]
+      optional :cta_header_text, String, api_name: :ctaHeaderText
+
+      # @!attribute cta_header_type
+      #   Optional header type for cta_url messages.
+      #
+      #   @return [Symbol, Zavudev::Models::MessageContent::CtaHeaderType, nil]
+      optional :cta_header_type, enum: -> { Zavudev::MessageContent::CtaHeaderType }, api_name: :ctaHeaderType
+
+      # @!attribute cta_url
+      #   Destination URL opened in the device's default browser when the button is
+      #   tapped. Used with messageType=cta_url. WhatsApp requires HTTPS in production.
+      #
+      #   @return [String, nil]
+      optional :cta_url, String, api_name: :ctaUrl
+
       # @!attribute emoji
       #   Emoji for reaction messages.
       #
@@ -27,6 +60,12 @@ module Zavudev
       #   @return [String, nil]
       optional :filename, String
 
+      # @!attribute footer_text
+      #   Optional footer text for cta_url messages.
+      #
+      #   @return [String, nil]
+      optional :footer_text, String, api_name: :footerText
+
       # @!attribute latitude
       #   Latitude for location messages.
       #
@@ -87,6 +126,27 @@ module Zavudev
       #   @return [Array<Zavudev::Models::MessageContent::Section>, nil]
       optional :sections, -> { Zavudev::Internal::Type::ArrayOf[Zavudev::MessageContent::Section] }
 
+      # @!attribute template_button_variables
+      #   Variables for dynamic button placeholders (URL buttons and OTP buttons). Keys
+      #   are the button index (0, 1, 2) in the template's `buttons` array — not the
+      #   placeholder name. Values substitute the `{{1}}` placeholder inside that button's
+      #   URL.
+      #
+      #   **WhatsApp constraints:**
+      #
+      #   - URL buttons only accept `{{1}}` — positional, numeric, no whitespace, no name.
+      #     Named placeholders like `{{token}}` are stored as literal URL text by Meta and
+      #     cannot be substituted.
+      #   - At most one placeholder per URL button.
+      #   - A template may have at most three buttons.
+      #   - Static URL buttons (no placeholder) and `quick_reply` buttons are not included
+      #     here.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :template_button_variables,
+               Zavudev::Internal::Type::HashOf[String],
+               api_name: :templateButtonVariables
+
       # @!attribute template_id
       #   Template ID for template messages.
       #
@@ -94,22 +154,38 @@ module Zavudev
       optional :template_id, String, api_name: :templateId
 
       # @!attribute template_variables
-      #   Variables for template rendering. Keys are variable positions (1, 2, 3...).
+      #   Variables for body placeholders. Keys are positions (1, 2, 3, ...) matching the
+      #   order placeholders appear in the template body.
       #
       #   @return [Hash{Symbol=>String}, nil]
       optional :template_variables, Zavudev::Internal::Type::HashOf[String], api_name: :templateVariables
 
-      # @!method initialize(buttons: nil, contacts: nil, emoji: nil, filename: nil, latitude: nil, list_button: nil, location_address: nil, location_name: nil, longitude: nil, media_id: nil, media_url: nil, mime_type: nil, react_to_message_id: nil, sections: nil, template_id: nil, template_variables: nil)
+      # @!method initialize(buttons: nil, contacts: nil, cta_display_text: nil, cta_header_media_url: nil, cta_header_text: nil, cta_header_type: nil, cta_url: nil, emoji: nil, filename: nil, footer_text: nil, latitude: nil, list_button: nil, location_address: nil, location_name: nil, longitude: nil, media_id: nil, media_url: nil, mime_type: nil, react_to_message_id: nil, sections: nil, template_button_variables: nil, template_id: nil, template_variables: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Zavudev::Models::MessageContent} for more details.
+      #
       #   Content for non-text message types (WhatsApp and Telegram).
       #
       #   @param buttons [Array<Zavudev::Models::MessageContent::Button>] Interactive buttons (max 3).
       #
       #   @param contacts [Array<Zavudev::Models::MessageContent::Contact>] Contact cards for contact messages.
       #
+      #   @param cta_display_text [String] Button label for cta_url messages.
+      #
+      #   @param cta_header_media_url [String] Public HTTPS URL of the header media when ctaHeaderType is 'image', 'video', or
+      #
+      #   @param cta_header_text [String] Header text when ctaHeaderType is 'text'.
+      #
+      #   @param cta_header_type [Symbol, Zavudev::Models::MessageContent::CtaHeaderType] Optional header type for cta_url messages.
+      #
+      #   @param cta_url [String] Destination URL opened in the device's default browser when the button is tapped
+      #
       #   @param emoji [String] Emoji for reaction messages.
       #
       #   @param filename [String] Filename for documents.
       #
+      #   @param footer_text [String] Optional footer text for cta_url messages.
+      #
       #   @param latitude [Float] Latitude for location messages.
       #
       #   @param list_button [String] Button text for list messages.
@@ -130,9 +206,11 @@ module Zavudev
       #
       #   @param sections [Array<Zavudev::Models::MessageContent::Section>] Sections for list messages.
       #
+      #   @param template_button_variables [Hash{Symbol=>String}] Variables for dynamic button placeholders (URL buttons and OTP buttons). Keys ar
+      #
       #   @param template_id [String] Template ID for template messages.
       #
-      #   @param template_variables [Hash{Symbol=>String}] Variables for template rendering. Keys are variable positions (1, 2, 3...).
+      #   @param template_variables [Hash{Symbol=>String}] Variables for body placeholders. Keys are positions (1, 2, 3, ...) matching the
 
       class Button < Zavudev::Internal::Type::BaseModel
         # @!attribute id
@@ -166,6 +244,21 @@ module Zavudev
         #   @param phones [Array<String>]
       end
 
+      # Optional header type for cta_url messages.
+      #
+      # @see Zavudev::Models::MessageContent#cta_header_type
+      module CtaHeaderType
+        extend Zavudev::Internal::Type::Enum
+
+        TEXT = :text
+        IMAGE = :image
+        VIDEO = :video
+        DOCUMENT = :document
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       class Section < Zavudev::Internal::Type::BaseModel
         # @!attribute rows
         #

data/lib/zavudev/models/message_type.rb

@@ -17,6 +17,7 @@ module Zavudev
       CONTACT = :contact
       BUTTONS = :buttons
       LIST = :list
+      CTA_URL = :cta_url
       REACTION = :reaction
       TEMPLATE = :template
 

data/lib/zavudev/models/number_10dlc/brand_create_params.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Brands#create
+      class BrandCreateParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute city
+        #
+        #   @return [String]
+        required :city, String
+
+        # @!attribute country
+        #   Two-letter ISO country code.
+        #
+        #   @return [String]
+        required :country, String
+
+        # @!attribute display_name
+        #   Display name of the brand.
+        #
+        #   @return [String]
+        required :display_name, String, api_name: :displayName
+
+        # @!attribute email
+        #
+        #   @return [String]
+        required :email, String
+
+        # @!attribute entity_type
+        #   Business entity type for 10DLC brand registration.
+        #
+        #   @return [Symbol, Zavudev::Models::Number10dlc::BrandCreateParams::EntityType]
+        required :entity_type,
+                 enum: -> { Zavudev::Number10dlc::BrandCreateParams::EntityType },
+                 api_name: :entityType
+
+        # @!attribute phone
+        #   Contact phone in E.164 format.
+        #
+        #   @return [String]
+        required :phone, String
+
+        # @!attribute postal_code
+        #
+        #   @return [String]
+        required :postal_code, String, api_name: :postalCode
+
+        # @!attribute state
+        #
+        #   @return [String]
+        required :state, String
+
+        # @!attribute street
+        #
+        #   @return [String]
+        required :street, String
+
+        # @!attribute vertical
+        #   Industry vertical.
+        #
+        #   @return [String]
+        required :vertical, String
+
+        # @!attribute company_name
+        #   Legal company name.
+        #
+        #   @return [String, nil]
+        optional :company_name, String, api_name: :companyName
+
+        # @!attribute ein
+        #   Employer Identification Number (format: XX-XXXXXXX).
+        #
+        #   @return [String, nil]
+        optional :ein, String
+
+        # @!attribute first_name
+        #
+        #   @return [String, nil]
+        optional :first_name, String, api_name: :firstName
+
+        # @!attribute last_name
+        #
+        #   @return [String, nil]
+        optional :last_name, String, api_name: :lastName
+
+        # @!attribute stock_exchange
+        #
+        #   @return [String, nil]
+        optional :stock_exchange, String, api_name: :stockExchange
+
+        # @!attribute stock_symbol
+        #
+        #   @return [String, nil]
+        optional :stock_symbol, String, api_name: :stockSymbol
+
+        # @!attribute website
+        #
+        #   @return [String, nil]
+        optional :website, String
+
+        # @!method initialize(city:, country:, display_name:, email:, entity_type:, phone:, postal_code:, state:, street:, vertical:, company_name: nil, ein: nil, first_name: nil, last_name: nil, stock_exchange: nil, stock_symbol: nil, website: nil, request_options: {})
+        #   @param city [String]
+        #
+        #   @param country [String] Two-letter ISO country code.
+        #
+        #   @param display_name [String] Display name of the brand.
+        #
+        #   @param email [String]
+        #
+        #   @param entity_type [Symbol, Zavudev::Models::Number10dlc::BrandCreateParams::EntityType] Business entity type for 10DLC brand registration.
+        #
+        #   @param phone [String] Contact phone in E.164 format.
+        #
+        #   @param postal_code [String]
+        #
+        #   @param state [String]
+        #
+        #   @param street [String]
+        #
+        #   @param vertical [String] Industry vertical.
+        #
+        #   @param company_name [String] Legal company name.
+        #
+        #   @param ein [String] Employer Identification Number (format: XX-XXXXXXX).
+        #
+        #   @param first_name [String]
+        #
+        #   @param last_name [String]
+        #
+        #   @param stock_exchange [String]
+        #
+        #   @param stock_symbol [String]
+        #
+        #   @param website [String]
+        #
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+        # Business entity type for 10DLC brand registration.
+        module EntityType
+          extend Zavudev::Internal::Type::Enum
+
+          PRIVATE_PROFIT = :PRIVATE_PROFIT
+          PUBLIC_PROFIT = :PUBLIC_PROFIT
+          NON_PROFIT = :NON_PROFIT
+          GOVERNMENT = :GOVERNMENT
+          SOLE_PROPRIETOR = :SOLE_PROPRIETOR
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/models/number_10dlc/brand_create_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Brands#create
+      class BrandCreateResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute brand
+        #
+        #   @return [Zavudev::Models::Number10dlc::TenDlcBrand]
+        required :brand, -> { Zavudev::Number10dlc::TenDlcBrand }
+
+        # @!method initialize(brand:)
+        #   @param brand [Zavudev::Models::Number10dlc::TenDlcBrand]
+      end
+    end
+  end
+end

data/lib/zavudev/models/number_10dlc/brand_delete_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Brands#delete
+      class BrandDeleteParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute brand_id
+        #
+        #   @return [String]
+        required :brand_id, String
+
+        # @!method initialize(brand_id:, request_options: {})
+        #   @param brand_id [String]
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/zavudev/models/number_10dlc/brand_list_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Brands#list
+      class BrandListParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute cursor
+        #
+        #   @return [String, nil]
+        optional :cursor, String
+
+        # @!attribute limit
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!method initialize(cursor: nil, limit: nil, request_options: {})
+        #   @param cursor [String]
+        #   @param limit [Integer]
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/zavudev/models/number_10dlc/brand_list_use_cases_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Brands#list_use_cases
+      class BrandListUseCasesParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/zavudev/models/number_10dlc/brand_list_use_cases_response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Brands#list_use_cases
+      class BrandListUseCasesResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute use_cases
+        #
+        #   @return [Array<Zavudev::Models::Number10dlc::BrandListUseCasesResponse::UseCase>]
+        required :use_cases,
+                 -> { Zavudev::Internal::Type::ArrayOf[Zavudev::Models::Number10dlc::BrandListUseCasesResponse::UseCase] },
+                 api_name: :useCases
+
+        # @!method initialize(use_cases:)
+        #   @param use_cases [Array<Zavudev::Models::Number10dlc::BrandListUseCasesResponse::UseCase>]
+
+        class UseCase < Zavudev::Internal::Type::BaseModel
+          # @!attribute description
+          #
+          #   @return [String, nil]
+          optional :description, String
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(description: nil, name: nil)
+          #   @param description [String]
+          #   @param name [String]
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/models/number_10dlc/brand_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Brands#retrieve
+      class BrandRetrieveParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute brand_id
+        #
+        #   @return [String]
+        required :brand_id, String
+
+        # @!method initialize(brand_id:, request_options: {})
+        #   @param brand_id [String]
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/zavudev/models/number_10dlc/brand_retrieve_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Brands#retrieve
+      class BrandRetrieveResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute brand
+        #
+        #   @return [Zavudev::Models::Number10dlc::TenDlcBrand]
+        required :brand, -> { Zavudev::Number10dlc::TenDlcBrand }
+
+        # @!method initialize(brand:)
+        #   @param brand [Zavudev::Models::Number10dlc::TenDlcBrand]
+      end
+    end
+  end
+end

data/lib/zavudev/models/number_10dlc/brand_submit_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Brands#submit
+      class BrandSubmitParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute brand_id
+        #
+        #   @return [String]
+        required :brand_id, String
+
+        # @!method initialize(brand_id:, request_options: {})
+        #   @param brand_id [String]
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/zavudev/models/number_10dlc/brand_submit_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Brands#submit
+      class BrandSubmitResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute brand
+        #
+        #   @return [Zavudev::Models::Number10dlc::TenDlcBrand]
+        required :brand, -> { Zavudev::Number10dlc::TenDlcBrand }
+
+        # @!method initialize(brand:)
+        #   @param brand [Zavudev::Models::Number10dlc::TenDlcBrand]
+      end
+    end
+  end
+end

data/lib/zavudev/models/number_10dlc/brand_sync_status_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Brands#sync_status
+      class BrandSyncStatusParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute brand_id
+        #
+        #   @return [String]
+        required :brand_id, String
+
+        # @!method initialize(brand_id:, request_options: {})
+        #   @param brand_id [String]
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/zavudev/models/number_10dlc/brand_sync_status_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Brands#sync_status
+      class BrandSyncStatusResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute brand
+        #
+        #   @return [Zavudev::Models::Number10dlc::TenDlcBrand]
+        required :brand, -> { Zavudev::Number10dlc::TenDlcBrand }
+
+        # @!method initialize(brand:)
+        #   @param brand [Zavudev::Models::Number10dlc::TenDlcBrand]
+      end
+    end
+  end
+end