wavix-ruby-sdk 1.0.0 → 1.4.0

data/lib/wavix/types/whats_app_message_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module WhatsAppMessageStatus
+      extend Wavix::Internal::Types::Enum
+
+      SENT = "sent"
+      DELIVERED = "delivered"
+      UNDELIVERED = "undelivered"
+      EXPIRED = "expired"
+      REJECTED = "rejected"
+      UNKNOWN = "unknown"
+    end
+  end
+end

data/lib/wavix/types/whats_app_message_template.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # The template that a WhatsApp message was sent with. Returned in `template` by `whatsapp_messages_send`.
+    class WhatsAppMessageTemplate < Internal::Types::Model
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :language, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_problem.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # An RFC 9457 problem document that describes an error from the WhatsApp API. Returned with the
+    # `application/problem+json` content type.
+    class WhatsAppProblem < Internal::Types::Model
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :title, -> { String }, optional: false, nullable: false
+
+      field :status, -> { Integer }, optional: false, nullable: false
+
+      field :detail, -> { String }, optional: false, nullable: false
+
+      field :instance, -> { String }, optional: false, nullable: false
+
+      field :error_class, -> { Wavix::Types::WhatsAppProblemErrorClass }, optional: true, nullable: false
+
+      field :error_code, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_problem_error_class.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module WhatsAppProblemErrorClass
+      extend Wavix::Internal::Types::Enum
+
+      PERMANENT = "permanent"
+      RETRIABLE = "retriable"
+      RATE_LIMITED = "rate_limited"
+      INVALID_TEMPLATE = "invalid_template"
+    end
+  end
+end

data/lib/wavix/types/whats_app_send_template.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # The template to send and the values for its dynamic parts. Consumed in `template` by `whatsapp_messages_send`.
+    class WhatsAppSendTemplate < Internal::Types::Model
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :language, -> { String }, optional: false, nullable: false
+
+      field :placeholders, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+      field :header, -> { Wavix::Types::WhatsAppSendTemplateHeader }, optional: true, nullable: false
+
+      field :buttons, -> { Internal::Types::Array[Wavix::Types::WhatsAppSendTemplateButton] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_send_template_button.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Dynamic values for one button of the template. Each `type` requires specific fields and rejects the others, as
+    # listed in the `type` description. Consumed in `template.buttons` by `whatsapp_messages_send`.
+    class WhatsAppSendTemplateButton < Internal::Types::Model
+      field :type, -> { Wavix::Types::WhatsAppSendTemplateButtonType }, optional: false, nullable: false
+
+      field :parameter, -> { String }, optional: true, nullable: false
+
+      field :flow_token, -> { String }, optional: true, nullable: false
+
+      field :data, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+
+      field :thumbnail_product_retailer_id, -> { String }, optional: true, nullable: false
+
+      field :sections, -> { Internal::Types::Array[Internal::Types::Hash[String, Object]] }, optional: true, nullable: false
+
+      field :action, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+
+      field :call_validity_period, -> { Integer }, optional: true, nullable: false
+
+      field :call_context_payload, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_send_template_button_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module WhatsAppSendTemplateButtonType
+      extend Wavix::Internal::Types::Enum
+
+      QUICK_REPLY = "quick_reply"
+      URL = "url"
+      COPY_CODE = "copy_code"
+      FLOW = "flow"
+      CATALOG = "catalog"
+      MULTI_PRODUCT = "multi_product"
+      ORDER_DETAILS = "order_details"
+      VOICE_CALL = "voice_call"
+    end
+  end
+end

data/lib/wavix/types/whats_app_send_template_header.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Header content, required only when the template's `header` component needs one. Each `type` requires specific
+    # fields and rejects the others, as listed in the `type` description. Consumed in `template.header` by
+    # `whatsapp_messages_send`.
+    class WhatsAppSendTemplateHeader < Internal::Types::Model
+      field :type, -> { Wavix::Types::WhatsAppSendTemplateHeaderType }, optional: false, nullable: false
+
+      field :placeholder, -> { String }, optional: true, nullable: false
+
+      field :media_url, -> { String }, optional: true, nullable: false
+
+      field :filename, -> { String }, optional: true, nullable: false
+
+      field :latitude, -> { Integer }, optional: true, nullable: false
+
+      field :longitude, -> { Integer }, optional: true, nullable: false
+
+      field :parameter_name, -> { String }, optional: true, nullable: false
+
+      field :text, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_send_template_header_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module WhatsAppSendTemplateHeaderType
+      extend Wavix::Internal::Types::Enum
+
+      TEXT = "text"
+      TEXT_NAMED_PARAMETERS = "text_named_parameters"
+      IMAGE = "image"
+      VIDEO = "video"
+      DOCUMENT = "document"
+      LOCATION = "location"
+    end
+  end
+end

data/lib/wavix/types/whats_app_sender.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # A WhatsApp sender, which is a phone number registered with WhatsApp in one of your account's WhatsApp Business
+    # Accounts. Returned by `whatsapp_senders_list` and `whatsapp_senders_get`.
+    class WhatsAppSender < Internal::Types::Model
+      field :phone_number, -> { String }, optional: false, nullable: false
+
+      field :display_name, -> { String }, optional: false, nullable: true
+
+      field :status, -> { Wavix::Types::WhatsAppSenderStatus }, optional: false, nullable: false
+
+      field :quality_rating, -> { Wavix::Types::WhatsAppSenderQualityRating }, optional: false, nullable: true
+
+      field :waba, -> { Wavix::Types::WhatsAppWaba }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_sender_list_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Returned by `whatsapp_senders_list`.
+    class WhatsAppSenderListResponse < Internal::Types::Model
+      field :senders, -> { Internal::Types::Array[Wavix::Types::WhatsAppSender] }, optional: false, nullable: false
+
+      field :pagination, -> { Wavix::Types::Pagination }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_sender_quality_rating.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module WhatsAppSenderQualityRating
+      extend Wavix::Internal::Types::Enum
+
+      HIGH = "high"
+      MEDIUM = "medium"
+      LOW = "low"
+      UNKNOWN = "unknown"
+    end
+  end
+end

data/lib/wavix/types/whats_app_sender_status.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module WhatsAppSenderStatus
+      extend Wavix::Internal::Types::Enum
+
+      BANNED = "banned"
+      CONNECTED = "connected"
+      DELETED = "deleted"
+      DISCONNECTED = "disconnected"
+      FLAGGED = "flagged"
+      MIGRATED = "migrated"
+      PENDING = "pending"
+      RATE_LIMITED = "rate_limited"
+      RESTRICTED = "restricted"
+      UNKNOWN = "unknown"
+      UNVERIFIED = "unverified"
+    end
+  end
+end

data/lib/wavix/types/whats_app_template.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # A WhatsApp message template with its review status and components. Returned by `whatsapp_templates_list`,
+    # `whatsapp_templates_get`, and `whatsapp_templates_create`.
+    class WhatsAppTemplate < Internal::Types::Model
+      field :uuid, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :language, -> { String }, optional: false, nullable: false
+
+      field :category, -> { Wavix::Types::WhatsAppTemplateCategory }, optional: false, nullable: false
+
+      field :status, -> { Wavix::Types::WhatsAppTemplateStatus }, optional: false, nullable: false
+
+      field :quality_rating, -> { Wavix::Types::WhatsAppTemplateQualityRating }, optional: false, nullable: true
+
+      field :submitted_at, -> { String }, optional: true, nullable: false
+
+      field :components, -> { Internal::Types::Array[Wavix::Types::WhatsAppTemplateResponseComponent] }, optional: false, nullable: false
+
+      field :waba, -> { Wavix::Types::WhatsAppWaba }, optional: false, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_body_component_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Body of a new WhatsApp template. Required, exactly once. Consumed by `whatsapp_templates_create`.
+    class WhatsAppTemplateBodyComponentRequest < Internal::Types::Model
+      field :text, -> { String }, optional: false, nullable: false
+
+      field :example, -> { Wavix::Types::WhatsAppTemplateBodyComponentRequestExample }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_body_component_request_example.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Sample values for the placeholders in the body text.
+    class WhatsAppTemplateBodyComponentRequestExample < Internal::Types::Model
+      field :body_text, -> { Internal::Types::Array[Internal::Types::Array[String]] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_button_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # A button in the `buttons` component of a new WhatsApp template. Consumed by `whatsapp_templates_create`. The
+    # `type` field selects the variant.
+    class WhatsAppTemplateButtonRequest < Internal::Types::Model
+      extend Wavix::Internal::Types::Union
+
+      discriminant :type
+
+      member -> { Wavix::Types::WhatsAppTemplateQuickReplyButtonRequest }, key: "QUICK_REPLY"
+
+      member -> { Wavix::Types::WhatsAppTemplateURLButtonRequest }, key: "URL"
+
+      member -> { Wavix::Types::WhatsAppTemplatePhoneNumberButtonRequest }, key: "PHONE_NUMBER"
+
+      member -> { Wavix::Types::WhatsAppTemplateCopyCodeButtonRequest }, key: "COPY_CODE"
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_buttons_component_request.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Buttons component of a new WhatsApp template. Consumed by `whatsapp_templates_create`.
+    class WhatsAppTemplateButtonsComponentRequest < Internal::Types::Model
+      field :buttons, -> { Internal::Types::Array[Wavix::Types::WhatsAppTemplateButtonRequest] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_category.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module WhatsAppTemplateCategory
+      extend Wavix::Internal::Types::Enum
+
+      MARKETING = "marketing"
+      AUTHENTICATION = "authentication"
+      UTILITY = "utility"
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_component_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # A header, body, footer, or buttons component of a new WhatsApp template. Consumed by `whatsapp_templates_create`.
+    # The `type` field selects the variant, and a `header` component is further selected by `format`.
+    class WhatsAppTemplateComponentRequest < Internal::Types::Model
+      extend Wavix::Internal::Types::Union
+
+      discriminant :type
+
+      member -> { Wavix::Types::WhatsAppTemplateHeaderComponentRequest }, key: "HEADER"
+
+      member -> { Wavix::Types::WhatsAppTemplateBodyComponentRequest }, key: "BODY"
+
+      member -> { Wavix::Types::WhatsAppTemplateFooterComponentRequest }, key: "FOOTER"
+
+      member -> { Wavix::Types::WhatsAppTemplateButtonsComponentRequest }, key: "BUTTONS"
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_copy_code_button_request.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Button that copies a code to the clipboard. Consumed by `whatsapp_templates_create`.
+    class WhatsAppTemplateCopyCodeButtonRequest < Internal::Types::Model
+      field :example, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_create_request.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Attributes of a new WhatsApp template. Consumed by `whatsapp_templates_create`.
+    class WhatsAppTemplateCreateRequest < Internal::Types::Model
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :language, -> { String }, optional: false, nullable: false
+
+      field :category, -> { Wavix::Types::WhatsAppTemplateCreateRequestCategory }, optional: false, nullable: false
+
+      field :components, -> { Internal::Types::Array[Wavix::Types::WhatsAppTemplateComponentRequest] }, optional: false, nullable: false
+
+      field :waba_id, -> { String }, optional: true, nullable: false
+
+      field :sender, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_create_request_category.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module WhatsAppTemplateCreateRequestCategory
+      extend Wavix::Internal::Types::Enum
+
+      MARKETING = "marketing"
+      AUTHENTICATION = "authentication"
+      UTILITY = "utility"
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_footer_component_request.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Footer of a new WhatsApp template. Consumed by `whatsapp_templates_create`.
+    class WhatsAppTemplateFooterComponentRequest < Internal::Types::Model
+      field :text, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_header_component_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Header of a new WhatsApp template. Consumed by `whatsapp_templates_create`. The `format` field selects the
+    # variant.
+    class WhatsAppTemplateHeaderComponentRequest < Internal::Types::Model
+      extend Wavix::Internal::Types::Union
+
+      discriminant :format
+
+      member -> { Wavix::Types::WhatsAppTemplateTextHeaderComponentRequest }, key: "TEXT"
+
+      member -> { Wavix::Types::WhatsAppTemplateMediaHeaderComponentRequest }, key: "IMAGE"
+
+      member -> { Wavix::Types::WhatsAppTemplateMediaHeaderComponentRequest }, key: "VIDEO"
+
+      member -> { Wavix::Types::WhatsAppTemplateMediaHeaderComponentRequest }, key: "DOCUMENT"
+
+      member -> { Wavix::Types::WhatsAppTemplateLocationHeaderComponentRequest }, key: "LOCATION"
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_location_header_component_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Location header of a new WhatsApp template. Takes neither `text` nor `example`. Consumed by
+    # `whatsapp_templates_create`.
+    class WhatsAppTemplateLocationHeaderComponentRequest < Internal::Types::Model
+      field :type, -> { Wavix::Types::WhatsAppTemplateLocationHeaderComponentRequestType }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/{file_transcription_response_status.rb → whats_app_template_location_header_component_request_type.rb}

@@ -2,11 +2,10 @@
 
 module Wavix
   module Types
-    module FileTranscriptionResponseStatus
+    module WhatsAppTemplateLocationHeaderComponentRequestType
       extend Wavix::Internal::Types::Enum
 
-      COMPLETED = "completed"
-      FAILED = "failed"
+      HEADER = "header"
     end
   end
 end

data/lib/wavix/types/whats_app_template_media_header_component_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Media header of a new WhatsApp template. Takes no `text`. Consumed by `whatsapp_templates_create`.
+    class WhatsAppTemplateMediaHeaderComponentRequest < Internal::Types::Model
+      field :type, -> { Wavix::Types::WhatsAppTemplateMediaHeaderComponentRequestType }, optional: false, nullable: false
+
+      field :example, -> { Wavix::Types::WhatsAppTemplateMediaHeaderComponentRequestExample }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_media_header_component_request_example.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Sample media file.
+    class WhatsAppTemplateMediaHeaderComponentRequestExample < Internal::Types::Model
+      field :header_handle, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_media_header_component_request_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module WhatsAppTemplateMediaHeaderComponentRequestType
+      extend Wavix::Internal::Types::Enum
+
+      HEADER = "header"
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_page_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Returned by `whatsapp_templates_list`.
+    class WhatsAppTemplatePageResponse < Internal::Types::Model
+      field :templates, -> { Internal::Types::Array[Wavix::Types::WhatsAppTemplate] }, optional: false, nullable: false
+
+      field :pagination, -> { Wavix::Types::Pagination }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_phone_number_button_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Button that calls a phone number. Consumed by `whatsapp_templates_create`.
+    class WhatsAppTemplatePhoneNumberButtonRequest < Internal::Types::Model
+      field :text, -> { String }, optional: false, nullable: false
+
+      field :phone_number, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_quality_rating.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module WhatsAppTemplateQualityRating
+      extend Wavix::Internal::Types::Enum
+
+      HIGH = "high"
+      MEDIUM = "medium"
+      LOW = "low"
+      UNKNOWN = "unknown"
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_quick_reply_button_request.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Button that sends its label back as a reply. Consumed by `whatsapp_templates_create`.
+    class WhatsAppTemplateQuickReplyButtonRequest < Internal::Types::Model
+      field :text, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Returned by `whatsapp_templates_get` and `whatsapp_templates_create`.
+    class WhatsAppTemplateResponse < Internal::Types::Model
+      field :template, -> { Wavix::Types::WhatsAppTemplate }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_response_component.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # A component of a stored WhatsApp template. Returned inside templates by `whatsapp_templates_list`,
+    # `whatsapp_templates_get`, and `whatsapp_templates_create`. Section types other than header, body, footer, and
+    # buttons can carry fields of their own.
+    class WhatsAppTemplateResponseComponent < Internal::Types::Model
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :format, -> { Wavix::Types::WhatsAppTemplateResponseComponentFormat }, optional: true, nullable: false
+
+      field :text, -> { String }, optional: true, nullable: false
+
+      field :example, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+
+      field :buttons, -> { Internal::Types::Array[Internal::Types::Hash[String, Object]] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_response_component_format.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module WhatsAppTemplateResponseComponentFormat
+      extend Wavix::Internal::Types::Enum
+
+      TEXT = "text"
+      IMAGE = "image"
+      VIDEO = "video"
+      DOCUMENT = "document"
+      LOCATION = "location"
+    end
+  end
+end

data/lib/wavix/types/whats_app_template_status.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module WhatsAppTemplateStatus
+      extend Wavix::Internal::Types::Enum
+
+      DRAFT = "draft"
+      PENDING = "pending"
+      APPROVED = "approved"
+      REJECTED = "rejected"
+      PAUSED = "paused"
+      FLAGGED = "flagged"
+      DISABLED = "disabled"
+      IN_APPEAL = "in_appeal"
+      PENDING_DELETION = "pending_deletion"
+      DELETED = "deleted"
+      UNKNOWN = "unknown"
+    end
+  end
+end