wavix-ruby-sdk 1.1.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a4e64b9cfc47eb4ebebf171011a903d18187d5b713583b287459be4041bd696
-  data.tar.gz: 66904b1cb1a982873ce7efd26f694597488bdf3b1307d210c59e69a554c550bd
+  metadata.gz: d1b4158e5df5671f98f8ed2d24155a900022d7205b27a7df6c21b867d8c9077c
+  data.tar.gz: 8b19d60c85b8faa5d9b9a3ced7d5dc304b7a1231e2c6f5336bb86b7e31fa547b
 SHA512:
-  metadata.gz: 36a2c8615477e84a53ce2566d1507709aa22b9753cfe49e46261953c60fc14515461c9bc6bdee6d6a69109bc9b27877897e96821e2d4268b1b1294b537f7800c
-  data.tar.gz: 5d02b5285f02f9dae41ab94c819429c07a9e361b19302eabe2aa461a972cf0ef80fafd7da897192982265aa38f0d4e68f427a2ef3c55ce01f74fa775f7b422a8
+  metadata.gz: b57b7410186895113d64dca272c4d9049ea57123324572fa6ff5da635f96d0603560d3321c6167717b672a751d9bcb8d494e150a4916f2271dce254fc02be2e8
+  data.tar.gz: 9ef8448161ea8b073793bbd11628873a38066be0036bd1e7351191445f7152fffff582391afada48c4641daf8960692fb328f14be3dc753d37ac3c447e6db4b6

data/.fern/metadata.json

@@ -2,9 +2,10 @@
   "cliVersion": "5.45.3",
   "generatorName": "fernapi/fern-ruby-sdk",
   "generatorVersion": "1.13.1",
-  "originGitCommit": "d29c16cfdf89e832f7792c0c920d6935e231f140",
+  "originGitCommit": "e0d4d73c3ae45a88f9edafbfa9bf22d469aaf8c3",
   "originGitCommitIsDirty": false,
-  "invokedBy": "manual",
-  "requestedVersion": "1.1.1",
-  "sdkVersion": "1.1.1"
+  "invokedBy": "ci",
+  "requestedVersion": "1.4.0",
+  "ciProvider": "github",
+  "sdkVersion": "1.4.0"
 }

data/.fern/replay.lock

@@ -12,5 +12,11 @@ generations:
     cli_version: unknown
     generator_versions:
       fernapi/fern-ruby-sdk: 1.13.1
-current_generation: 6a2e8dd340486da43c8e2d337f7fcce044bd3618
+  - commit_sha: 48c5e27eb6bcdc01947c56e1ccaada7d6a9d8edd
+    tree_hash: 07bed05f8ca839b0c209f3ffa79e7304c063c452
+    timestamp: 2026-11-04T04:39:51.814Z
+    cli_version: unknown
+    generator_versions:
+      fernapi/fern-ruby-sdk: 1.13.1
+current_generation: 48c5e27eb6bcdc01947c56e1ccaada7d6a9d8edd
 patches: []

data/.fernignore

@@ -6,3 +6,4 @@ SECURITY.md
 .fern/replay.lock
 .fern/replay.yml
 .gitattributes
+.github/workflows/release.yml

data/lib/wavix/call_control/streams/client.rb

@@ -11,9 +11,9 @@ module Wavix
           @client = client
         end
 
-        # Starts streaming the audio of the call identified by `call_id` to a WebSocket destination you supply, in the
-        # direction (`stream_type`) and channel (`stream_channel`) you configure. The destination can be any URL you
-        # specify — Wavix does not restrict it. Returns the `stream_id`.
+        # Starts streaming the audio of the call identified by `call_id` to the WebSocket destination in `stream_url`,
+        # in the direction (`stream_type`) and channel (`stream_channel`) you configure. The streamed audio can include
+        # the remote party's voice.
         #
         # @param request_options [Hash]
         # @param params [Wavix::CallControl::Streams::Types::CallStreamCreateRequest]

data/lib/wavix/call_webhooks/client.rb

@@ -47,6 +47,11 @@ module Wavix
       # event occurs. Creates persistent configuration that forwards call metadata to the URL on every matching call
       # until the webhook is deleted.
       #
+      # **Behavior:** Without `expected_url`, the webhook is set to `url` whatever it was before. With `expected_url`,
+      # the webhook is set only while it currently has that URL; an empty string matches an unset webhook. Otherwise the
+      # call returns `409` and the webhook is unchanged. Setting the URL the webhook already has succeeds. If the call
+      # returns a `Something went wrong` error, the webhook is unchanged and you can retry the request.
+      #
       # @param request_options [Hash]
       # @param params [Wavix::CallWebhooks::Types::CallWebhooksCreateRequest]
       # @option request_options [String] :base_url
@@ -81,6 +86,12 @@ module Wavix
 
       # Removes the call webhook for the given event type. Wavix stops sending callbacks for that event.
       #
+      # **Behavior:** Without `expected_url`, the webhook is cleared whatever URL it has. With `expected_url`, the
+      # webhook is cleared only while it currently has that URL; an empty value matches an unset webhook. Otherwise the
+      # call returns `409` and the webhook is unchanged. Clearing an unset webhook succeeds. Percent-encode the
+      # `expected_url` value in the query string. If the call returns a `Something went wrong` error, the webhook is
+      # unchanged and you can retry the request.
+      #
       # @param request_options [Hash]
       # @param params [Hash]
       # @option request_options [String] :base_url
@@ -89,12 +100,14 @@ module Wavix
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Wavix::CallWebhooks::Types::DeleteCallWebhooksRequestEventType] :event_type
+      # @option params [String, nil] :expected_url
       #
       # @return [Wavix::Types::SuccessResponse]
       def delete(request_options: {}, **params)
         params = Wavix::Internal::Types::Utils.normalize_keys(params)
         query_params = {}
         query_params["event_type"] = params[:event_type] if params.key?(:event_type)
+        query_params["expected_url"] = params[:expected_url] if params.key?(:expected_url)
 
         request = Wavix::Internal::JSON::Request.new(
           base_url: request_options[:base_url],

data/lib/wavix/call_webhooks/types/call_webhooks_create_request.rb

@@ -7,6 +7,8 @@ module Wavix
         field :url, -> { String }, optional: false, nullable: false
 
         field :event_type, -> { Wavix::CallWebhooks::Types::CallWebhooksCreateRequestEventType }, optional: false, nullable: false
+
+        field :expected_url, -> { String }, optional: true, nullable: false
       end
     end
   end

data/lib/wavix/call_webhooks/types/delete_call_webhooks_request.rb

@@ -5,6 +5,8 @@ module Wavix
     module Types
       class DeleteCallWebhooksRequest < Internal::Types::Model
         field :event_type, -> { Wavix::CallWebhooks::Types::DeleteCallWebhooksRequestEventType }, optional: false, nullable: false
+
+        field :expected_url, -> { String }, optional: true, nullable: false
       end
     end
   end

data/lib/wavix/cdrs/client.rb

@@ -102,7 +102,8 @@ module Wavix
       end
 
       # Transcribes the recording of the call identified by `call_id`. Transcription is asynchronous; poll the
-      # transcription endpoint for the result. Billed per minute at the account's call-transcription rate; fails with an
+      # transcription endpoint for the result. When it completes, the new transcription replaces any earlier one that
+      # the transcription endpoints return. Billed per minute at the account's call-transcription rate; fails with an
       # insufficient-funds error when the balance cannot cover it.
       #
       # @param request_options [Hash]

data/lib/wavix/client.rb

@@ -11,7 +11,7 @@ module Wavix
       @raw_client = Wavix::Internal::Http::RawClient.new(
         base_url: base_url || Wavix::Environment::DEFAULT,
         headers: {
-          "User-Agent" => "wavix-ruby-sdk/1.1.1",
+          "User-Agent" => "wavix-ruby-sdk/1.4.0",
           "X-Fern-Language" => "Ruby",
           Authorization: "Bearer #{token}"
         },

data/lib/wavix/numbers/client.rb

@@ -170,6 +170,13 @@ module Wavix
 
       # Updates the phone number identified by `id`. Only the provided fields are changed.
       #
+      # **Behavior:** With `expected_sms_relay_url`, the `sms_relay_url` change is applied only while the number
+      # currently has that URL; an empty string matches a number with no `sms_relay_url`. Otherwise the call returns
+      # `409` and no field in the request is changed. Setting the URL the number already has succeeds. To clear
+      # `sms_relay_url`, send `null`, not an empty string. If the call returns a `Something went wrong` error, you can
+      # retry the request; repeating the `sms_relay_url` change is a no-op, so it is safe even if the first attempt
+      # already applied it.
+      #
       # @param request_options [Hash]
       # @param params [Wavix::Numbers::Types::NumberUpdateRequest]
       # @option request_options [String] :base_url

data/lib/wavix/numbers/types/number_update_request.rb

@@ -12,6 +12,8 @@ module Wavix
 
         field :sms_relay_url, -> { String }, optional: true, nullable: false
 
+        field :expected_sms_relay_url, -> { String }, optional: true, nullable: false
+
         field :call_recording_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
 
         field :transcription_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false

data/lib/wavix/sip_trunks/client.rb

@@ -53,7 +53,7 @@ module Wavix
       # Creates a SIP trunk for routing inbound and outbound calls. Returns the trunk with its generated `access_token`.
       #
       # @param request_options [Hash]
-      # @param params [Wavix::Types::SipTrunkCreateRequest]
+      # @param params [Wavix::SipTrunks::Types::SipTrunkCreateRequest]
       # @option request_options [String] :base_url
       # @option request_options [Hash{String => Object}] :additional_headers
       # @option request_options [Hash{String => Object}] :additional_query_parameters
@@ -67,7 +67,7 @@ module Wavix
           base_url: request_options[:base_url],
           method: "POST",
           path: "v1/trunks",
-          body: Wavix::Types::SipTrunkCreateRequest.new(params).to_h,
+          body: Wavix::SipTrunks::Types::SipTrunkCreateRequest.new(params).to_h,
           request_options: request_options
         )
         begin
@@ -118,10 +118,11 @@ module Wavix
         end
       end
 
-      # Replaces the configuration of the SIP trunk identified by `id`. Omitted fields revert to their defaults.
+      # Updates the SIP trunk identified by `id`. Only the provided fields are changed. On trial accounts, every update
+      # also applies the trial limits: a `call_limit` of at most 300 seconds (300 when omitted) and one concurrent call.
       #
       # @param request_options [Hash]
-      # @param params [Wavix::Types::SipTrunkCreateRequest]
+      # @param params [Wavix::SipTrunks::Types::SipTrunkUpdateRequest]
       # @option request_options [String] :base_url
       # @option request_options [Hash{String => Object}] :additional_headers
       # @option request_options [Hash{String => Object}] :additional_query_parameters
@@ -132,14 +133,15 @@ module Wavix
       # @return [Wavix::Types::SipTrunkResponse]
       def update(request_options: {}, **params)
         params = Wavix::Internal::Types::Utils.normalize_keys(params)
-        path_param_names = %i[id]
-        body_params = params.except(*path_param_names)
+        request_data = Wavix::SipTrunks::Types::SipTrunkUpdateRequest.new(params).to_h
+        non_body_param_names = %w[id]
+        body = request_data.except(*non_body_param_names)
 
         request = Wavix::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PUT",
           path: "v1/trunks/#{URI.encode_uri_component(params[:id].to_s)}",
-          body: Wavix::Types::SipTrunkCreateRequest.new(body_params).to_h,
+          body: body,
           request_options: request_options
         )
         begin

data/lib/wavix/sip_trunks/types/sip_trunk_create_request.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SipTrunks
+    module Types
+      class SipTrunkCreateRequest < Internal::Types::Model
+        field :label, -> { String }, optional: false, nullable: false
+
+        field :password, -> { String }, optional: false, nullable: false
+
+        field :host_request, -> { Wavix::SipTrunks::Types::SipTrunkCreateRequestHostRequest }, optional: true, nullable: false
+
+        field :callerid, -> { String }, optional: false, nullable: false
+
+        field :multiple_numbers, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :ip_restrict, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :allowed_ips, -> { Internal::Types::Array[Wavix::SipTrunks::Types::SipTrunkCreateRequestAllowedIpsItem] }, optional: true, nullable: false
+
+        field :didinfo_enabled, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :call_restrict, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :call_limit, -> { Integer }, optional: true, nullable: false
+
+        field :cost_limit, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :max_call_cost, -> { Integer }, optional: true, nullable: false
+
+        field :channels_restrict, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :max_channels, -> { Integer }, optional: true, nullable: false
+
+        field :rewrite_enabled, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :rewrite_prefix, -> { String }, optional: true, nullable: false
+
+        field :rewrite_cond, -> { String }, optional: true, nullable: false
+
+        field :call_recording_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :transcription_enabled, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :transcription_threshold, -> { Integer }, optional: false, nullable: false
+
+        field :machine_detection_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :encrypted_media, -> { Internal::Types::Boolean }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/sip_trunks/types/sip_trunk_create_request_allowed_ips_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SipTrunks
+    module Types
+      class SipTrunkCreateRequestAllowedIpsItem < Internal::Types::Model
+        field :ip, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/sip_trunks/types/sip_trunk_create_request_host_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SipTrunks
+    module Types
+      # For SIP trunks with IP authentication, includes the SIP endpoint public static IP address and the status of the
+      # authentication request. Wavix authenticates all SIP traffic originating from this IP address.
+      class SipTrunkCreateRequestHostRequest < Internal::Types::Model
+        field :host, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/sip_trunks/types/sip_trunk_update_request.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SipTrunks
+    module Types
+      class SipTrunkUpdateRequest < Internal::Types::Model
+        field :id, -> { Integer }, optional: false, nullable: false
+
+        field :label, -> { String }, optional: true, nullable: false
+
+        field :password, -> { String }, optional: true, nullable: false
+
+        field :host_request, -> { Wavix::SipTrunks::Types::SipTrunkUpdateRequestHostRequest }, optional: true, nullable: false
+
+        field :callerid, -> { String }, optional: true, nullable: false
+
+        field :multiple_numbers, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :ip_restrict, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :allowed_ips, -> { Internal::Types::Array[Wavix::SipTrunks::Types::SipTrunkUpdateRequestAllowedIpsItem] }, optional: true, nullable: false
+
+        field :didinfo_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :call_restrict, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :call_limit, -> { Integer }, optional: true, nullable: false
+
+        field :cost_limit, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :max_call_cost, -> { Integer }, optional: true, nullable: false
+
+        field :channels_restrict, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :max_channels, -> { Integer }, optional: true, nullable: false
+
+        field :rewrite_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :rewrite_prefix, -> { String }, optional: true, nullable: false
+
+        field :rewrite_cond, -> { String }, optional: true, nullable: false
+
+        field :call_recording_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :transcription_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :transcription_threshold, -> { Integer }, optional: true, nullable: false
+
+        field :machine_detection_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :encrypted_media, -> { Internal::Types::Boolean }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/sip_trunks/types/sip_trunk_update_request_allowed_ips_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SipTrunks
+    module Types
+      class SipTrunkUpdateRequestAllowedIpsItem < Internal::Types::Model
+        field :ip, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/sip_trunks/types/sip_trunk_update_request_host_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SipTrunks
+    module Types
+      # For SIP trunks with IP authentication, the SIP endpoint public static IP address. Wavix authenticates all SIP
+      # traffic originating from this IP address. Ignored when the trunk already has a host request that is pending or
+      # approved. Not supported on trial accounts.
+      class SipTrunkUpdateRequestHostRequest < Internal::Types::Model
+        field :host, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/sub_accounts/client.rb

@@ -121,7 +121,7 @@ module Wavix
         end
       end
 
-      # Replaces the configuration of the sub-account identified by `id`. Omitted fields revert to their defaults.
+      # Updates the sub-account identified by `id`. Only the provided fields are changed.
       #
       # @param request_options [Hash]
       # @param params [Wavix::SubAccounts::Types::SubAccountsUpdateRequest]

data/lib/wavix/types/webhook_in_use_error_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Error returned when a webhook change is rejected because the webhook no longer has the expected URL.
+    class WebhookInUseErrorResponse < Internal::Types::Model
+      field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :error, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_business_account.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # A WhatsApp Business Account linked to your account. Returned by `whatsapp_wabas_list` and `whatsapp_wabas_get`.
+    class WhatsAppBusinessAccount < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: true
+
+      field :messaging_limit, -> { Wavix::Types::WhatsAppBusinessAccountMessagingLimit }, optional: true, nullable: false
+
+      field :sender_count, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/whats_app_business_account_messaging_limit.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module WhatsAppBusinessAccountMessagingLimit
+      extend Wavix::Internal::Types::Enum
+
+      UP_TO250 = "up_to_250"
+      UP_TO2K = "up_to_2k"
+      UP_TO10K = "up_to_10k"
+      UP_TO100K = "up_to_100k"
+      UNLIMITED = "unlimited"
+    end
+  end
+end

data/lib/wavix/types/whats_app_message.rb

@@ -2,6 +2,7 @@
 
 module Wavix
   module Types
+    # A WhatsApp message you sent. Returned by `whatsapp_messages_send`.
     class WhatsAppMessage < Internal::Types::Model
       field :uuid, -> { String }, optional: false, nullable: false
 
@@ -11,7 +12,7 @@ module Wavix
 
       field :status, -> { Wavix::Types::WhatsAppMessageStatus }, optional: false, nullable: false
 
-      field :template, -> { Wavix::Types::WhatsAppMessageTemplate }, optional: true, nullable: false
+      field :template, -> { Wavix::Types::WhatsAppMessageTemplate }, optional: false, nullable: true
 
       field :created_at, -> { String }, optional: false, nullable: false
     end

data/lib/wavix/types/whats_app_message_get_response.rb

@@ -2,6 +2,7 @@
 
 module Wavix
   module Types
+    # Returned by `whatsapp_messages_get`.
     class WhatsAppMessageGetResponse < Internal::Types::Model
       field :message, -> { Wavix::Types::WhatsAppMessageListItem }, optional: false, nullable: false
     end

data/lib/wavix/types/whats_app_message_list_item.rb

@@ -2,6 +2,8 @@
 
 module Wavix
   module Types
+    # A WhatsApp message your account sent or received. Returned by `whatsapp_messages_list` and
+    # `whatsapp_messages_get`.
     class WhatsAppMessageListItem < Internal::Types::Model
       field :uuid, -> { String }, optional: false, nullable: false
 
@@ -13,7 +15,7 @@ module Wavix
 
       field :to, -> { String }, optional: false, nullable: false
 
-      field :country, -> { String }, optional: true, nullable: false
+      field :country, -> { String }, optional: false, nullable: true
 
       field :created_at, -> { String }, optional: false, nullable: false
     end

data/lib/wavix/types/whats_app_message_list_item_status.rb

@@ -5,7 +5,6 @@ module Wavix
     module WhatsAppMessageListItemStatus
       extend Wavix::Internal::Types::Enum
 
-      FAILED = "failed"
       SENT = "sent"
       DELIVERED = "delivered"
       UNDELIVERED = "undelivered"

data/lib/wavix/types/whats_app_message_list_response.rb

@@ -2,6 +2,7 @@
 
 module Wavix
   module Types
+    # Returned by `whatsapp_messages_list`.
     class WhatsAppMessageListResponse < Internal::Types::Model
       field :messages, -> { Internal::Types::Array[Wavix::Types::WhatsAppMessageListItem] }, optional: false, nullable: false
 

data/lib/wavix/types/whats_app_message_send_request.rb

@@ -2,12 +2,15 @@
 
 module Wavix
   module Types
+    # Attributes of a WhatsApp template message to send. Consumed by `whatsapp_messages_send`.
     class WhatsAppMessageSendRequest < Internal::Types::Model
       field :from, -> { String }, optional: false, nullable: false
 
       field :to, -> { String }, optional: false, nullable: false
 
-      field :template, -> { Wavix::Types::WhatsAppMessageSendRequestTemplate }, optional: false, nullable: false
+      field :idempotency_key, -> { String }, optional: true, nullable: false
+
+      field :template, -> { Wavix::Types::WhatsAppSendTemplate }, optional: false, nullable: false
     end
   end
 end

data/lib/wavix/types/whats_app_message_send_response.rb

@@ -2,6 +2,7 @@
 
 module Wavix
   module Types
+    # Returned by `whatsapp_messages_send`.
     class WhatsAppMessageSendResponse < Internal::Types::Model
       field :message, -> { Wavix::Types::WhatsAppMessage }, optional: false, nullable: false
     end

data/lib/wavix/types/whats_app_message_status.rb

@@ -5,7 +5,6 @@ module Wavix
     module WhatsAppMessageStatus
       extend Wavix::Internal::Types::Enum
 
-      FAILED = "failed"
       SENT = "sent"
       DELIVERED = "delivered"
       UNDELIVERED = "undelivered"

data/lib/wavix/types/whats_app_message_template.rb

@@ -2,11 +2,11 @@
 
 module Wavix
   module Types
-    # Template used to send the message.
+    # 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: true, nullable: false
+      field :name, -> { String }, optional: false, nullable: false
 
-      field :language, -> { String }, optional: true, nullable: false
+      field :language, -> { String }, optional: false, nullable: false
     end
   end
 end

data/lib/wavix/types/whats_app_problem.rb

@@ -2,7 +2,8 @@
 
 module Wavix
   module Types
-    # RFC 9457 problem document returned by WhatsApp endpoints as `application/problem+json`.
+    # 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
 

data/lib/wavix/types/{whats_app_message_send_request_template.rb → whats_app_send_template.rb}

@@ -2,16 +2,17 @@
 
 module Wavix
   module Types
-    class WhatsAppMessageSendRequestTemplate < Internal::Types::Model
+    # 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::WhatsAppMessageSendRequestTemplateHeader }, optional: true, nullable: false
+      field :header, -> { Wavix::Types::WhatsAppSendTemplateHeader }, optional: true, nullable: false
 
-      field :buttons, -> { Internal::Types::Array[Wavix::Types::WhatsAppMessageSendRequestTemplateButtonsItem] }, 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