sentdm 0.34.0 → 0.35.0

data/lib/sentdm/models/calls/participant_update_params.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Calls
+      # @see Sentdm::Resources::Calls::Participants#update
+      class ParticipantUpdateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute participant_id
+        #
+        #   @return [String]
+        required :participant_id, String
+
+        # @!attribute muted
+        #   true to mute the participant, false to unmute them
+        #
+        #   @return [Boolean, nil]
+        optional :muted, Sentdm::Internal::Type::Boolean
+
+        # @!attribute sandbox
+        #   Sandbox flag - when true, the operation is simulated without side effects Useful
+        #   for testing integrations without actual execution
+        #
+        #   @return [Boolean, nil]
+        optional :sandbox, Sentdm::Internal::Type::Boolean
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(id:, participant_id:, muted: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Calls::ParticipantUpdateParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param participant_id [String]
+        #
+        #   @param muted [Boolean] true to mute the participant, false to unmute them
+        #
+        #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param x_profile_id [String]
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/calls_list.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class CallsList < Sentdm::Internal::Type::BaseModel
+      # @!attribute calls
+      #   The calls on this page, most recent first
+      #
+      #   @return [Array<Sentdm::Models::Call>, nil]
+      optional :calls, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Call] }
+
+      # @!attribute pagination
+      #   Pagination metadata for list responses
+      #
+      #   @return [Sentdm::Models::PaginationMeta, nil]
+      optional :pagination, -> { Sentdm::PaginationMeta }
+
+      # @!method initialize(calls: nil, pagination: nil)
+      #   Paginated list of calls
+      #
+      #   @param calls [Array<Sentdm::Models::Call>] The calls on this page, most recent first
+      #
+      #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
+    end
+  end
+end

data/lib/sentdm/models/channels/api_response_of_list_of_voice_number.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Voice#list
+      class APIResponseOfListOfVoiceNumber < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   The response data (null if error)
+        #
+        #   @return [Array<Sentdm::Models::Channels::VoiceNumber>, nil]
+        optional :data, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Channels::VoiceNumber] }, nil?: true
+
+        # @!attribute error
+        #   Error information
+        #
+        #   @return [Sentdm::Models::ErrorDetail, nil]
+        optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+        # @!attribute meta
+        #   Request and response metadata
+        #
+        #   @return [Sentdm::Models::APIMeta, nil]
+        optional :meta, -> { Sentdm::APIMeta }
+
+        # @!attribute success
+        #   Indicates whether the request was successful
+        #
+        #   @return [Boolean, nil]
+        optional :success, Sentdm::Internal::Type::Boolean
+
+        # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+        #   Standard API response envelope for all v3 endpoints
+        #
+        #   @param data [Array<Sentdm::Models::Channels::VoiceNumber>, nil] The response data (null if error)
+        #
+        #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+        #
+        #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+        #
+        #   @param success [Boolean] Indicates whether the request was successful
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/api_response_of_voice_callback_test.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Voice#test_
+      class APIResponseOfVoiceCallbackTest < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   The verdict of a test question sent to your callback URL
+        #
+        #   @return [Sentdm::Models::Channels::VoiceCallbackTest, nil]
+        optional :data, -> { Sentdm::Channels::VoiceCallbackTest }, nil?: true
+
+        # @!attribute error
+        #   Error information
+        #
+        #   @return [Sentdm::Models::ErrorDetail, nil]
+        optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+        # @!attribute meta
+        #   Request and response metadata
+        #
+        #   @return [Sentdm::Models::APIMeta, nil]
+        optional :meta, -> { Sentdm::APIMeta }
+
+        # @!attribute success
+        #   Indicates whether the request was successful
+        #
+        #   @return [Boolean, nil]
+        optional :success, Sentdm::Internal::Type::Boolean
+
+        # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+        #   Standard API response envelope for all v3 endpoints
+        #
+        #   @param data [Sentdm::Models::Channels::VoiceCallbackTest, nil] The verdict of a test question sent to your callback URL
+        #
+        #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+        #
+        #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+        #
+        #   @param success [Boolean] Indicates whether the request was successful
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/api_response_of_voice_number.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Voice#retrieve
+      class APIResponseOfVoiceNumber < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   One number the profile carries phone calls on.
+        #
+        #   @return [Sentdm::Models::Channels::VoiceNumber, nil]
+        optional :data, -> { Sentdm::Channels::VoiceNumber }, nil?: true
+
+        # @!attribute error
+        #   Error information
+        #
+        #   @return [Sentdm::Models::ErrorDetail, nil]
+        optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+        # @!attribute meta
+        #   Request and response metadata
+        #
+        #   @return [Sentdm::Models::APIMeta, nil]
+        optional :meta, -> { Sentdm::APIMeta }
+
+        # @!attribute success
+        #   Indicates whether the request was successful
+        #
+        #   @return [Boolean, nil]
+        optional :success, Sentdm::Internal::Type::Boolean
+
+        # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+        #   Standard API response envelope for all v3 endpoints
+        #
+        #   @param data [Sentdm::Models::Channels::VoiceNumber, nil] One number the profile carries phone calls on.
+        #
+        #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+        #
+        #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+        #
+        #   @param success [Boolean] Indicates whether the request was successful
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/api_response_of_voice_number_created.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Voice#create
+      class APIResponseOfVoiceNumberCreated < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   The response data (null if error)
+        #
+        #   @return [Sentdm::Models::Channels::VoiceNumberCreated, nil]
+        optional :data, -> { Sentdm::Channels::VoiceNumberCreated }, nil?: true
+
+        # @!attribute error
+        #   Error information
+        #
+        #   @return [Sentdm::Models::ErrorDetail, nil]
+        optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+        # @!attribute meta
+        #   Request and response metadata
+        #
+        #   @return [Sentdm::Models::APIMeta, nil]
+        optional :meta, -> { Sentdm::APIMeta }
+
+        # @!attribute success
+        #   Indicates whether the request was successful
+        #
+        #   @return [Boolean, nil]
+        optional :success, Sentdm::Internal::Type::Boolean
+
+        # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+        #   Standard API response envelope for all v3 endpoints
+        #
+        #   @param data [Sentdm::Models::Channels::VoiceNumberCreated, nil] The response data (null if error)
+        #
+        #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+        #
+        #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+        #
+        #   @param success [Boolean] Indicates whether the request was successful
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/api_response_of_voice_secret.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Voice#rotate_secret
+      class APIResponseOfVoiceSecret < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   A freshly rotated callback signing secret
+        #
+        #   @return [Sentdm::Models::Channels::VoiceSecret, nil]
+        optional :data, -> { Sentdm::Channels::VoiceSecret }, nil?: true
+
+        # @!attribute error
+        #   Error information
+        #
+        #   @return [Sentdm::Models::ErrorDetail, nil]
+        optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+        # @!attribute meta
+        #   Request and response metadata
+        #
+        #   @return [Sentdm::Models::APIMeta, nil]
+        optional :meta, -> { Sentdm::APIMeta }
+
+        # @!attribute success
+        #   Indicates whether the request was successful
+        #
+        #   @return [Boolean, nil]
+        optional :success, Sentdm::Internal::Type::Boolean
+
+        # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+        #   Standard API response envelope for all v3 endpoints
+        #
+        #   @param data [Sentdm::Models::Channels::VoiceSecret, nil] A freshly rotated callback signing secret
+        #
+        #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+        #
+        #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+        #
+        #   @param success [Boolean] Indicates whether the request was successful
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/api_response_of_voice_token.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Voice#create_token
+      class APIResponseOfVoiceToken < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   A short-lived token your app passes to the voice client SDK to register
+        #
+        #   @return [Sentdm::Models::Channels::VoiceToken, nil]
+        optional :data, -> { Sentdm::Channels::VoiceToken }, nil?: true
+
+        # @!attribute error
+        #   Error information
+        #
+        #   @return [Sentdm::Models::ErrorDetail, nil]
+        optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+        # @!attribute meta
+        #   Request and response metadata
+        #
+        #   @return [Sentdm::Models::APIMeta, nil]
+        optional :meta, -> { Sentdm::APIMeta }
+
+        # @!attribute success
+        #   Indicates whether the request was successful
+        #
+        #   @return [Boolean, nil]
+        optional :success, Sentdm::Internal::Type::Boolean
+
+        # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+        #   Standard API response envelope for all v3 endpoints
+        #
+        #   @param data [Sentdm::Models::Channels::VoiceToken, nil] A short-lived token your app passes to the voice client SDK to register
+        #
+        #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+        #
+        #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+        #
+        #   @param success [Boolean] Indicates whether the request was successful
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/voice_callback_test.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceCallbackTest < Sentdm::Internal::Type::BaseModel
+        # @!attribute answer
+        #   Your answer as Sent read it, with numbers in E.164 and a missing caller id
+        #   filled in. Set only when the outcome is ok.
+        #
+        #   @return [Object, nil]
+        optional :answer, Sentdm::Internal::Type::Unknown, nil?: true
+
+        # @!attribute call_id
+        #   The call id the test question carried. It does not exist anywhere else and
+        #   cannot be looked up.
+        #
+        #   @return [String, nil]
+        optional :call_id, String
+
+        # @!attribute error
+        #   Why the test did not end with ok
+        #
+        #   @return [Sentdm::Models::Channels::VoiceCallbackTestErrorInfo, nil]
+        optional :error, -> { Sentdm::Channels::VoiceCallbackTestErrorInfo }, nil?: true
+
+        # @!attribute outcome
+        #   What happened: ok, timeout, connection_failed, http_error or invalid_answer
+        #
+        #   @return [String, nil]
+        optional :outcome, String
+
+        # @!attribute request
+        #   The test question exactly as it was sent
+        #
+        #   @return [Sentdm::Models::Channels::VoiceCallbackTestRequestInfo, nil]
+        optional :request, -> { Sentdm::Channels::VoiceCallbackTestRequestInfo }, nil?: true
+
+        # @!attribute response
+        #   What your endpoint answered
+        #
+        #   @return [Sentdm::Models::Channels::VoiceCallbackTestResponseInfo, nil]
+        optional :response, -> { Sentdm::Channels::VoiceCallbackTestResponseInfo }, nil?: true
+
+        # @!method initialize(answer: nil, call_id: nil, error: nil, outcome: nil, request: nil, response: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::VoiceCallbackTest} for more details.
+        #
+        #   The verdict of a test question sent to your callback URL
+        #
+        #   @param answer [Object, nil] Your answer as Sent read it, with numbers in E.164 and a missing caller id fille
+        #
+        #   @param call_id [String] The call id the test question carried. It does not exist anywhere else and canno
+        #
+        #   @param error [Sentdm::Models::Channels::VoiceCallbackTestErrorInfo, nil] Why the test did not end with ok
+        #
+        #   @param outcome [String] What happened: ok, timeout, connection_failed, http_error or invalid_answer
+        #
+        #   @param request [Sentdm::Models::Channels::VoiceCallbackTestRequestInfo, nil] The test question exactly as it was sent
+        #
+        #   @param response [Sentdm::Models::Channels::VoiceCallbackTestResponseInfo, nil] What your endpoint answered
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/voice_callback_test_error_info.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceCallbackTestErrorInfo < Sentdm::Internal::Type::BaseModel
+        # @!attribute message
+        #   What to fix
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!attribute path
+        #   Dotted path of the answer field at fault, such as action.action, when one field
+        #   is to blame
+        #
+        #   @return [String, nil]
+        optional :path, String, nil?: true
+
+        # @!attribute reason
+        #   Machine-readable reason, such as timeout, http_error, malformed_json,
+        #   missing_action or unknown_action
+        #
+        #   @return [String, nil]
+        optional :reason, String
+
+        # @!method initialize(message: nil, path: nil, reason: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::VoiceCallbackTestErrorInfo} for more details.
+        #
+        #   Why the test did not end with ok
+        #
+        #   @param message [String] What to fix
+        #
+        #   @param path [String, nil] Dotted path of the answer field at fault, such as action.action, when one field
+        #
+        #   @param reason [String] Machine-readable reason, such as timeout, http_error, malformed_json, missing_ac
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/voice_callback_test_request_info.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceCallbackTestRequestInfo < Sentdm::Internal::Type::BaseModel
+        # @!attribute body
+        #   The request body byte for byte. This is what the signature covers.
+        #
+        #   @return [String, nil]
+        optional :body, String
+
+        # @!attribute headers
+        #   Every header Sent added, the signature included, so you can compare against what
+        #   your endpoint verified. The signing secret itself is never included.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :headers, Sentdm::Internal::Type::HashOf[String]
+
+        # @!attribute url
+        #   The callback URL that was called
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!method initialize(body: nil, headers: nil, url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::VoiceCallbackTestRequestInfo} for more details.
+        #
+        #   The test question exactly as it was sent
+        #
+        #   @param body [String] The request body byte for byte. This is what the signature covers.
+        #
+        #   @param headers [Hash{Symbol=>String}] Every header Sent added, the signature included, so you can compare against what
+        #
+        #   @param url [String] The callback URL that was called
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/voice_callback_test_response_info.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceCallbackTestResponseInfo < Sentdm::Internal::Type::BaseModel
+        # @!attribute body
+        #   The start of the raw response body, capped at 2048 characters
+        #
+        #   @return [String, nil]
+        optional :body, String, nil?: true
+
+        # @!attribute status_code
+        #   The HTTP status your endpoint returned
+        #
+        #   @return [Integer, nil]
+        optional :status_code, Integer
+
+        # @!method initialize(body: nil, status_code: nil)
+        #   What your endpoint answered
+        #
+        #   @param body [String, nil] The start of the raw response body, capped at 2048 characters
+        #
+        #   @param status_code [Integer] The HTTP status your endpoint returned
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/voice_create_params.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Voice#create
+      class VoiceCreateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute callback_url
+        #   Where Sent asks what to do with each call on this number: an absolute HTTP or
+        #   HTTPS URL on a public host. A signed question is POSTed here when a call arrives
+        #   or a caller presses a key, and the answer decides the call. Every question is
+        #   signed with the callback_secret the response returns, the same way your webhooks
+        #   are signed. Turning the number on again with a different URL replaces it and
+        #   keeps the secret.
+        #
+        #   @return [String]
+        required :callback_url, String
+
+        # @!attribute area_code
+        #   The US area code a new number should be in, as 212. Only for a request that
+        #   leaves number out — sending both says two different things about which number to
+        #   use, and is refused. Omit it too and the number comes from anywhere in the
+        #   country.
+        #
+        #   @return [String, nil]
+        optional :area_code, String, nil?: true
+
+        # @!attribute default_for_app_calls
+        #   Make this the line app-originated calls are placed from when a voice token names
+        #   no number. Omit it and your first voice number takes that role; a later one
+        #   leaves it where it is.
+        #
+        #   @return [Boolean, nil]
+        optional :default_for_app_calls, Sentdm::Internal::Type::Boolean, nil?: true
+
+        # @!attribute number
+        #   One of your phone numbers, in E.164 format. Leave the field out entirely to be
+        #   given a new one instead; sending it empty is a refused request rather than a
+        #   request for a new number.
+        #
+        #   @return [String, nil]
+        optional :number, String, nil?: true
+
+        # @!attribute sandbox
+        #   Sandbox flag - when true, the operation is simulated without side effects Useful
+        #   for testing integrations without actual execution
+        #
+        #   @return [Boolean, nil]
+        optional :sandbox, Sentdm::Internal::Type::Boolean
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(callback_url:, area_code: nil, default_for_app_calls: nil, number: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::VoiceCreateParams} for more details.
+        #
+        #   @param callback_url [String] Where Sent asks what to do with each call on this number: an absolute HTTP or HT
+        #
+        #   @param area_code [String, nil] The US area code a new number should be in, as 212. Only for a request that leav
+        #
+        #   @param default_for_app_calls [Boolean, nil] Make this the line app-originated calls are placed from when a voice token names
+        #
+        #   @param number [String, nil] One of your phone numbers, in E.164 format. Leave the field out entirely to be g
+        #
+        #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param x_profile_id [String]
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end