zavudev 0.6.0 → 0.8.0

data/lib/zavudev/models/export_create_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Exports#create
+    class ExportCreateParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute data_types
+      #   List of data types to include in the export.
+      #
+      #   @return [Array<Symbol, Zavudev::Models::ExportCreateParams::DataType>]
+      required :data_types,
+               -> { Zavudev::Internal::Type::ArrayOf[enum: Zavudev::ExportCreateParams::DataType] },
+               api_name: :dataTypes
+
+      # @!attribute date_from
+      #   Start date for data to export (inclusive).
+      #
+      #   @return [Time, nil]
+      optional :date_from, Time, api_name: :dateFrom
+
+      # @!attribute date_to
+      #   End date for data to export (inclusive).
+      #
+      #   @return [Time, nil]
+      optional :date_to, Time, api_name: :dateTo
+
+      # @!method initialize(data_types:, date_from: nil, date_to: nil, request_options: {})
+      #   @param data_types [Array<Symbol, Zavudev::Models::ExportCreateParams::DataType>] List of data types to include in the export.
+      #
+      #   @param date_from [Time] Start date for data to export (inclusive).
+      #
+      #   @param date_to [Time] End date for data to export (inclusive).
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+      # Types of data that can be exported.
+      module DataType
+        extend Zavudev::Internal::Type::Enum
+
+        MESSAGES = :messages
+        CONVERSATIONS = :conversations
+        WEBHOOK_DELIVERIES = :webhookDeliveries
+        AGENT_EXECUTIONS = :agentExecutions
+        ACTIVITIES = :activities
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/zavudev/models/export_create_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Exports#create
+    class ExportCreateResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute export
+      #
+      #   @return [Zavudev::Models::DataExport]
+      required :export, -> { Zavudev::DataExport }
+
+      # @!method initialize(export:)
+      #   @param export [Zavudev::Models::DataExport]
+    end
+  end
+end

data/lib/zavudev/models/export_list_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Exports#list
+    class ExportListParams < 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
+
+      # @!attribute status
+      #   Status of a data export job.
+      #
+      #   @return [Symbol, Zavudev::Models::ExportListParams::Status, nil]
+      optional :status, enum: -> { Zavudev::ExportListParams::Status }
+
+      # @!method initialize(cursor: nil, limit: nil, status: nil, request_options: {})
+      #   @param cursor [String]
+      #
+      #   @param limit [Integer]
+      #
+      #   @param status [Symbol, Zavudev::Models::ExportListParams::Status] Status of a data export job.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+      # Status of a data export job.
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        PENDING = :pending
+        PROCESSING = :processing
+        COMPLETED = :completed
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/zavudev/models/export_retrieve_params.rb

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

data/lib/zavudev/models/export_retrieve_response.rb

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

data/lib/zavudev/models/invitation.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Invitations#list
+    class Invitation < Zavudev::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute token
+      #   Unique invitation token.
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute expires_at
+      #
+      #   @return [Time]
+      required :expires_at, Time, api_name: :expiresAt
+
+      # @!attribute status
+      #   Current status of the partner invitation.
+      #
+      #   @return [Symbol, Zavudev::Models::Invitation::Status]
+      required :status, enum: -> { Zavudev::Invitation::Status }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time, api_name: :updatedAt
+
+      # @!attribute url
+      #   Full URL to share with the client.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute client_email
+      #
+      #   @return [String, nil]
+      optional :client_email, String, api_name: :clientEmail, nil?: true
+
+      # @!attribute client_name
+      #
+      #   @return [String, nil]
+      optional :client_name, String, api_name: :clientName, nil?: true
+
+      # @!attribute client_phone
+      #
+      #   @return [String, nil]
+      optional :client_phone, String, api_name: :clientPhone, nil?: true
+
+      # @!attribute completed_at
+      #
+      #   @return [Time, nil]
+      optional :completed_at, Time, api_name: :completedAt, nil?: true
+
+      # @!attribute phone_number_id
+      #   ID of a pre-assigned Zavu phone number for WhatsApp registration.
+      #
+      #   @return [String, nil]
+      optional :phone_number_id, String, api_name: :phoneNumberId, nil?: true
+
+      # @!attribute sender_id
+      #   ID of the sender created when invitation is completed.
+      #
+      #   @return [String, nil]
+      optional :sender_id, String, api_name: :senderId, nil?: true
+
+      # @!attribute started_at
+      #
+      #   @return [Time, nil]
+      optional :started_at, Time, api_name: :startedAt, nil?: true
+
+      # @!attribute viewed_at
+      #
+      #   @return [Time, nil]
+      optional :viewed_at, Time, api_name: :viewedAt, nil?: true
+
+      # @!method initialize(id:, token:, created_at:, expires_at:, status:, updated_at:, url:, client_email: nil, client_name: nil, client_phone: nil, completed_at: nil, phone_number_id: nil, sender_id: nil, started_at: nil, viewed_at: nil)
+      #   @param id [String]
+      #
+      #   @param token [String] Unique invitation token.
+      #
+      #   @param created_at [Time]
+      #
+      #   @param expires_at [Time]
+      #
+      #   @param status [Symbol, Zavudev::Models::Invitation::Status] Current status of the partner invitation.
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param url [String] Full URL to share with the client.
+      #
+      #   @param client_email [String, nil]
+      #
+      #   @param client_name [String, nil]
+      #
+      #   @param client_phone [String, nil]
+      #
+      #   @param completed_at [Time, nil]
+      #
+      #   @param phone_number_id [String, nil] ID of a pre-assigned Zavu phone number for WhatsApp registration.
+      #
+      #   @param sender_id [String, nil] ID of the sender created when invitation is completed.
+      #
+      #   @param started_at [Time, nil]
+      #
+      #   @param viewed_at [Time, nil]
+
+      # Current status of the partner invitation.
+      #
+      # @see Zavudev::Models::Invitation#status
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        PENDING = :pending
+        IN_PROGRESS = :in_progress
+        COMPLETED = :completed
+        EXPIRED = :expired
+        CANCELLED = :cancelled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/zavudev/models/invitation_cancel_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Invitations#cancel
+    class InvitationCancelParams < 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_cancel_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Invitations#cancel
+    class InvitationCancelResponse < 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/invitation_create_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Invitations#create
+    class InvitationCreateParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute allowed_phone_countries
+      #   ISO country codes for allowed phone numbers.
+      #
+      #   @return [Array<String>, nil]
+      optional :allowed_phone_countries,
+               Zavudev::Internal::Type::ArrayOf[String],
+               api_name: :allowedPhoneCountries
+
+      # @!attribute client_email
+      #   Email of the client being invited.
+      #
+      #   @return [String, nil]
+      optional :client_email, String, api_name: :clientEmail
+
+      # @!attribute client_name
+      #   Name of the client being invited.
+      #
+      #   @return [String, nil]
+      optional :client_name, String, api_name: :clientName
+
+      # @!attribute client_phone
+      #   Phone number of the client in E.164 format.
+      #
+      #   @return [String, nil]
+      optional :client_phone, String, api_name: :clientPhone
+
+      # @!attribute expires_in_days
+      #   Number of days until the invitation expires.
+      #
+      #   @return [Integer, nil]
+      optional :expires_in_days, Integer, api_name: :expiresInDays
+
+      # @!attribute phone_number_id
+      #   ID of a Zavu phone number to pre-assign for WhatsApp registration. If provided,
+      #   the client will use this number instead of their own.
+      #
+      #   @return [String, nil]
+      optional :phone_number_id, String, api_name: :phoneNumberId
+
+      # @!method initialize(allowed_phone_countries: nil, client_email: nil, client_name: nil, client_phone: nil, expires_in_days: nil, phone_number_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Zavudev::Models::InvitationCreateParams} for more details.
+      #
+      #   @param allowed_phone_countries [Array<String>] ISO country codes for allowed phone numbers.
+      #
+      #   @param client_email [String] Email of the client being invited.
+      #
+      #   @param client_name [String] Name of the client being invited.
+      #
+      #   @param client_phone [String] Phone number of the client in E.164 format.
+      #
+      #   @param expires_in_days [Integer] Number of days until the invitation expires.
+      #
+      #   @param phone_number_id [String] ID of a Zavu phone number to pre-assign for WhatsApp registration. If provided,
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/invitation_create_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Invitations#create
+    class InvitationCreateResponse < 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/invitation_list_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Invitations#list
+    class InvitationListParams < 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
+
+      # @!attribute status
+      #   Current status of the partner invitation.
+      #
+      #   @return [Symbol, Zavudev::Models::InvitationListParams::Status, nil]
+      optional :status, enum: -> { Zavudev::InvitationListParams::Status }
+
+      # @!method initialize(cursor: nil, limit: nil, status: nil, request_options: {})
+      #   @param cursor [String]
+      #
+      #   @param limit [Integer]
+      #
+      #   @param status [Symbol, Zavudev::Models::InvitationListParams::Status] Current status of the partner invitation.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+      # Current status of the partner invitation.
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        PENDING = :pending
+        IN_PROGRESS = :in_progress
+        COMPLETED = :completed
+        EXPIRED = :expired
+        CANCELLED = :cancelled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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