zavudev 0.0.2

data/lib/zavudev/models/template.rb

@@ -0,0 +1,259 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Templates#create
+    class Template < Zavudev::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute body
+      #   Template body with variables: {{1}}, {{2}}, etc.
+      #
+      #   @return [String]
+      required :body, String
+
+      # @!attribute category
+      #   WhatsApp template category.
+      #
+      #   @return [Symbol, Zavudev::Models::WhatsappCategory]
+      required :category, enum: -> { Zavudev::WhatsappCategory }
+
+      # @!attribute language
+      #   Language code.
+      #
+      #   @return [String]
+      required :language, String
+
+      # @!attribute name
+      #   Template name (must match WhatsApp template name).
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute add_security_recommendation
+      #   Add 'Do not share this code' disclaimer. Only for AUTHENTICATION templates.
+      #
+      #   @return [Boolean, nil]
+      optional :add_security_recommendation,
+               Zavudev::Internal::Type::Boolean,
+               api_name: :addSecurityRecommendation
+
+      # @!attribute buttons
+      #   Template buttons.
+      #
+      #   @return [Array<Zavudev::Models::Template::Button>, nil]
+      optional :buttons, -> { Zavudev::Internal::Type::ArrayOf[Zavudev::Template::Button] }
+
+      # @!attribute code_expiration_minutes
+      #   Code expiration time in minutes. Only for AUTHENTICATION templates.
+      #
+      #   @return [Integer, nil]
+      optional :code_expiration_minutes, Integer, api_name: :codeExpirationMinutes
+
+      # @!attribute created_at
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, api_name: :createdAt
+
+      # @!attribute footer
+      #   Footer text for the template.
+      #
+      #   @return [String, nil]
+      optional :footer, String
+
+      # @!attribute header_content
+      #   Header content (text or media URL).
+      #
+      #   @return [String, nil]
+      optional :header_content, String, api_name: :headerContent
+
+      # @!attribute header_type
+      #   Type of header (text, image, video, document).
+      #
+      #   @return [String, nil]
+      optional :header_type, String, api_name: :headerType
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Zavudev::Models::Template::Status, nil]
+      optional :status, enum: -> { Zavudev::Template::Status }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :updatedAt
+
+      # @!attribute variables
+      #   List of variable names for documentation.
+      #
+      #   @return [Array<String>, nil]
+      optional :variables, Zavudev::Internal::Type::ArrayOf[String]
+
+      # @!attribute whatsapp
+      #   WhatsApp-specific template information.
+      #
+      #   @return [Zavudev::Models::Template::Whatsapp, nil]
+      optional :whatsapp, -> { Zavudev::Template::Whatsapp }
+
+      # @!method initialize(id:, body:, category:, language:, name:, add_security_recommendation: nil, buttons: nil, code_expiration_minutes: nil, created_at: nil, footer: nil, header_content: nil, header_type: nil, status: nil, updated_at: nil, variables: nil, whatsapp: nil)
+      #   @param id [String]
+      #
+      #   @param body [String] Template body with variables: {{1}}, {{2}}, etc.
+      #
+      #   @param category [Symbol, Zavudev::Models::WhatsappCategory] WhatsApp template category.
+      #
+      #   @param language [String] Language code.
+      #
+      #   @param name [String] Template name (must match WhatsApp template name).
+      #
+      #   @param add_security_recommendation [Boolean] Add 'Do not share this code' disclaimer. Only for AUTHENTICATION templates.
+      #
+      #   @param buttons [Array<Zavudev::Models::Template::Button>] Template buttons.
+      #
+      #   @param code_expiration_minutes [Integer] Code expiration time in minutes. Only for AUTHENTICATION templates.
+      #
+      #   @param created_at [Time]
+      #
+      #   @param footer [String] Footer text for the template.
+      #
+      #   @param header_content [String] Header content (text or media URL).
+      #
+      #   @param header_type [String] Type of header (text, image, video, document).
+      #
+      #   @param status [Symbol, Zavudev::Models::Template::Status]
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param variables [Array<String>] List of variable names for documentation.
+      #
+      #   @param whatsapp [Zavudev::Models::Template::Whatsapp] WhatsApp-specific template information.
+
+      class Button < Zavudev::Internal::Type::BaseModel
+        # @!attribute otp_type
+        #   OTP button type. Required when type is 'otp'.
+        #
+        #   @return [Symbol, Zavudev::Models::Template::Button::OtpType, nil]
+        optional :otp_type, enum: -> { Zavudev::Template::Button::OtpType }, api_name: :otpType
+
+        # @!attribute package_name
+        #   Android package name. Required for ONE_TAP buttons.
+        #
+        #   @return [String, nil]
+        optional :package_name, String, api_name: :packageName
+
+        # @!attribute phone_number
+        #
+        #   @return [String, nil]
+        optional :phone_number, String, api_name: :phoneNumber
+
+        # @!attribute signature_hash
+        #   Android app signature hash. Required for ONE_TAP buttons.
+        #
+        #   @return [String, nil]
+        optional :signature_hash, String, api_name: :signatureHash
+
+        # @!attribute text
+        #
+        #   @return [String, nil]
+        optional :text, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Zavudev::Models::Template::Button::Type, nil]
+        optional :type, enum: -> { Zavudev::Template::Button::Type }
+
+        # @!attribute url
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!method initialize(otp_type: nil, package_name: nil, phone_number: nil, signature_hash: nil, text: nil, type: nil, url: nil)
+        #   @param otp_type [Symbol, Zavudev::Models::Template::Button::OtpType] OTP button type. Required when type is 'otp'.
+        #
+        #   @param package_name [String] Android package name. Required for ONE_TAP buttons.
+        #
+        #   @param phone_number [String]
+        #
+        #   @param signature_hash [String] Android app signature hash. Required for ONE_TAP buttons.
+        #
+        #   @param text [String]
+        #
+        #   @param type [Symbol, Zavudev::Models::Template::Button::Type]
+        #
+        #   @param url [String]
+
+        # OTP button type. Required when type is 'otp'.
+        #
+        # @see Zavudev::Models::Template::Button#otp_type
+        module OtpType
+          extend Zavudev::Internal::Type::Enum
+
+          COPY_CODE = :COPY_CODE
+          ONE_TAP = :ONE_TAP
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Zavudev::Models::Template::Button#type
+        module Type
+          extend Zavudev::Internal::Type::Enum
+
+          QUICK_REPLY = :quick_reply
+          URL = :url
+          PHONE = :phone
+          OTP = :otp
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see Zavudev::Models::Template#status
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        DRAFT = :draft
+        PENDING = :pending
+        APPROVED = :approved
+        REJECTED = :rejected
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Zavudev::Models::Template#whatsapp
+      class Whatsapp < Zavudev::Internal::Type::BaseModel
+        # @!attribute namespace
+        #   WhatsApp Business Account namespace.
+        #
+        #   @return [String, nil]
+        optional :namespace, String
+
+        # @!attribute status
+        #   WhatsApp approval status.
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute template_name
+        #   WhatsApp template name.
+        #
+        #   @return [String, nil]
+        optional :template_name, String, api_name: :templateName
+
+        # @!method initialize(namespace: nil, status: nil, template_name: nil)
+        #   WhatsApp-specific template information.
+        #
+        #   @param namespace [String] WhatsApp Business Account namespace.
+        #
+        #   @param status [String] WhatsApp approval status.
+        #
+        #   @param template_name [String] WhatsApp template name.
+      end
+    end
+  end
+end

data/lib/zavudev/models/template_create_params.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Templates#create
+    class TemplateCreateParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute body
+      #
+      #   @return [String]
+      required :body, String
+
+      # @!attribute language
+      #
+      #   @return [String]
+      required :language, String
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute add_security_recommendation
+      #   Add 'Do not share this code' disclaimer. Only for AUTHENTICATION templates.
+      #
+      #   @return [Boolean, nil]
+      optional :add_security_recommendation,
+               Zavudev::Internal::Type::Boolean,
+               api_name: :addSecurityRecommendation
+
+      # @!attribute buttons
+      #   Template buttons (max 3).
+      #
+      #   @return [Array<Zavudev::Models::TemplateCreateParams::Button>, nil]
+      optional :buttons, -> { Zavudev::Internal::Type::ArrayOf[Zavudev::TemplateCreateParams::Button] }
+
+      # @!attribute code_expiration_minutes
+      #   Code expiration time in minutes. Only for AUTHENTICATION templates.
+      #
+      #   @return [Integer, nil]
+      optional :code_expiration_minutes, Integer, api_name: :codeExpirationMinutes
+
+      # @!attribute variables
+      #
+      #   @return [Array<String>, nil]
+      optional :variables, Zavudev::Internal::Type::ArrayOf[String]
+
+      # @!attribute whatsapp_category
+      #   WhatsApp template category.
+      #
+      #   @return [Symbol, Zavudev::Models::WhatsappCategory, nil]
+      optional :whatsapp_category, enum: -> { Zavudev::WhatsappCategory }, api_name: :whatsappCategory
+
+      # @!method initialize(body:, language:, name:, add_security_recommendation: nil, buttons: nil, code_expiration_minutes: nil, variables: nil, whatsapp_category: nil, request_options: {})
+      #   @param body [String]
+      #
+      #   @param language [String]
+      #
+      #   @param name [String]
+      #
+      #   @param add_security_recommendation [Boolean] Add 'Do not share this code' disclaimer. Only for AUTHENTICATION templates.
+      #
+      #   @param buttons [Array<Zavudev::Models::TemplateCreateParams::Button>] Template buttons (max 3).
+      #
+      #   @param code_expiration_minutes [Integer] Code expiration time in minutes. Only for AUTHENTICATION templates.
+      #
+      #   @param variables [Array<String>]
+      #
+      #   @param whatsapp_category [Symbol, Zavudev::Models::WhatsappCategory] WhatsApp template category.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+      class Button < Zavudev::Internal::Type::BaseModel
+        # @!attribute text
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Zavudev::Models::TemplateCreateParams::Button::Type]
+        required :type, enum: -> { Zavudev::TemplateCreateParams::Button::Type }
+
+        # @!attribute otp_type
+        #   Required when type is 'otp'. COPY_CODE shows copy button, ONE_TAP enables
+        #   Android autofill.
+        #
+        #   @return [Symbol, Zavudev::Models::TemplateCreateParams::Button::OtpType, nil]
+        optional :otp_type, enum: -> { Zavudev::TemplateCreateParams::Button::OtpType }, api_name: :otpType
+
+        # @!attribute package_name
+        #   Android package name. Required for ONE_TAP buttons.
+        #
+        #   @return [String, nil]
+        optional :package_name, String, api_name: :packageName
+
+        # @!attribute phone_number
+        #
+        #   @return [String, nil]
+        optional :phone_number, String, api_name: :phoneNumber
+
+        # @!attribute signature_hash
+        #   Android app signature hash. Required for ONE_TAP buttons.
+        #
+        #   @return [String, nil]
+        optional :signature_hash, String, api_name: :signatureHash
+
+        # @!attribute url
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!method initialize(text:, type:, otp_type: nil, package_name: nil, phone_number: nil, signature_hash: nil, url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Zavudev::Models::TemplateCreateParams::Button} for more details.
+        #
+        #   @param text [String]
+        #
+        #   @param type [Symbol, Zavudev::Models::TemplateCreateParams::Button::Type]
+        #
+        #   @param otp_type [Symbol, Zavudev::Models::TemplateCreateParams::Button::OtpType] Required when type is 'otp'. COPY_CODE shows copy button, ONE_TAP enables Androi
+        #
+        #   @param package_name [String] Android package name. Required for ONE_TAP buttons.
+        #
+        #   @param phone_number [String]
+        #
+        #   @param signature_hash [String] Android app signature hash. Required for ONE_TAP buttons.
+        #
+        #   @param url [String]
+
+        # @see Zavudev::Models::TemplateCreateParams::Button#type
+        module Type
+          extend Zavudev::Internal::Type::Enum
+
+          QUICK_REPLY = :quick_reply
+          URL = :url
+          PHONE = :phone
+          OTP = :otp
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Required when type is 'otp'. COPY_CODE shows copy button, ONE_TAP enables
+        # Android autofill.
+        #
+        # @see Zavudev::Models::TemplateCreateParams::Button#otp_type
+        module OtpType
+          extend Zavudev::Internal::Type::Enum
+
+          COPY_CODE = :COPY_CODE
+          ONE_TAP = :ONE_TAP
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/models/template_delete_params.rb

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

data/lib/zavudev/models/template_list_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Templates#list
+    class TemplateListParams < 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

data/lib/zavudev/models/template_retrieve_params.rb

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

data/lib/zavudev/models/template_submit_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Templates#submit
+    class TemplateSubmitParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute template_id
+      #
+      #   @return [String]
+      required :template_id, String
+
+      # @!attribute sender_id
+      #   The sender ID with the WhatsApp Business Account to submit the template to.
+      #
+      #   @return [String]
+      required :sender_id, String, api_name: :senderId
+
+      # @!attribute category
+      #   Template category. If not provided, uses the category set on the template.
+      #
+      #   @return [Symbol, Zavudev::Models::WhatsappCategory, nil]
+      optional :category, enum: -> { Zavudev::WhatsappCategory }
+
+      # @!method initialize(template_id:, sender_id:, category: nil, request_options: {})
+      #   @param template_id [String]
+      #
+      #   @param sender_id [String] The sender ID with the WhatsApp Business Account to submit the template to.
+      #
+      #   @param category [Symbol, Zavudev::Models::WhatsappCategory] Template category. If not provided, uses the category set on the template.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/webhook_event.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # Type of event that triggers the webhook.
+    #
+    # **Message lifecycle events:**
+    #
+    # - `message.queued`: Message created and queued for sending. `data.status` =
+    #   `queued`
+    # - `message.sent`: Message accepted by the provider. `data.status` = `sent`
+    # - `message.delivered`: Message delivered to recipient. `data.status` =
+    #   `delivered`
+    # - `message.failed`: Message failed to send. `data.status` = `failed`
+    #
+    # **Inbound events:**
+    #
+    # - `message.inbound`: New message received from a contact. Reactions are
+    #   delivered as `message.inbound` with `messageType='reaction'`
+    # - `message.unsupported`: Received a message type that is not supported
+    #
+    # **Other events:**
+    #
+    # - `conversation.new`: New conversation started with a contact
+    # - `template.status_changed`: WhatsApp template approval status changed
+    module WebhookEvent
+      extend Zavudev::Internal::Type::Enum
+
+      MESSAGE_QUEUED = :"message.queued"
+      MESSAGE_SENT = :"message.sent"
+      MESSAGE_DELIVERED = :"message.delivered"
+      MESSAGE_FAILED = :"message.failed"
+      MESSAGE_INBOUND = :"message.inbound"
+      MESSAGE_UNSUPPORTED = :"message.unsupported"
+      CONVERSATION_NEW = :"conversation.new"
+      TEMPLATE_STATUS_CHANGED = :"template.status_changed"
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/zavudev/models/webhook_secret_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Senders#regenerate_webhook_secret
+    class WebhookSecretResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute secret
+      #   The new webhook secret.
+      #
+      #   @return [String]
+      required :secret, String
+
+      # @!method initialize(secret:)
+      #   @param secret [String] The new webhook secret.
+    end
+  end
+end

data/lib/zavudev/models/whatsapp_business_profile.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    class WhatsappBusinessProfile < Zavudev::Internal::Type::BaseModel
+      # @!attribute about
+      #   Short description of the business (max 139 characters).
+      #
+      #   @return [String, nil]
+      optional :about, String
+
+      # @!attribute address
+      #   Physical address of the business (max 256 characters).
+      #
+      #   @return [String, nil]
+      optional :address, String
+
+      # @!attribute description
+      #   Extended description of the business (max 512 characters).
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute email
+      #   Business email address.
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute profile_picture_url
+      #   URL of the business profile picture.
+      #
+      #   @return [String, nil]
+      optional :profile_picture_url, String, api_name: :profilePictureUrl
+
+      # @!attribute vertical
+      #   Business category for WhatsApp Business profile.
+      #
+      #   @return [Symbol, Zavudev::Models::WhatsappBusinessProfileVertical, nil]
+      optional :vertical, enum: -> { Zavudev::WhatsappBusinessProfileVertical }
+
+      # @!attribute websites
+      #   Business website URLs (maximum 2).
+      #
+      #   @return [Array<String>, nil]
+      optional :websites, Zavudev::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(about: nil, address: nil, description: nil, email: nil, profile_picture_url: nil, vertical: nil, websites: nil)
+      #   WhatsApp Business profile information.
+      #
+      #   @param about [String] Short description of the business (max 139 characters).
+      #
+      #   @param address [String] Physical address of the business (max 256 characters).
+      #
+      #   @param description [String] Extended description of the business (max 512 characters).
+      #
+      #   @param email [String] Business email address.
+      #
+      #   @param profile_picture_url [String] URL of the business profile picture.
+      #
+      #   @param vertical [Symbol, Zavudev::Models::WhatsappBusinessProfileVertical] Business category for WhatsApp Business profile.
+      #
+      #   @param websites [Array<String>] Business website URLs (maximum 2).
+    end
+  end
+end

data/lib/zavudev/models/whatsapp_business_profile_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Senders#get_profile
+    class WhatsappBusinessProfileResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute profile
+      #   WhatsApp Business profile information.
+      #
+      #   @return [Zavudev::Models::WhatsappBusinessProfile]
+      required :profile, -> { Zavudev::WhatsappBusinessProfile }
+
+      # @!method initialize(profile:)
+      #   @param profile [Zavudev::Models::WhatsappBusinessProfile] WhatsApp Business profile information.
+    end
+  end
+end