sentdm 0.38.1 → 0.40.0

data/lib/sentdm/models/call.rb

@@ -1,134 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Calls#list
-    class Call < Sentdm::Internal::Type::BaseModel
-      # @!attribute id
-      #   The call id, the same one carried by the call.request question and every call
-      #   webhook
-      #
-      #   @return [String, nil]
-      optional :id, String
-
-      # @!attribute answered_at
-      #   When the call was answered (UTC). Null until then, and always null for a call
-      #   between two of your app users
-      #
-      #   @return [Time, nil]
-      optional :answered_at, Time, nil?: true
-
-      # @!attribute direction
-      #   outbound for a call placed from your app, inbound for a call to one of your
-      #   numbers
-      #
-      #   @return [String, nil]
-      optional :direction, String
-
-      # @!attribute duration_seconds
-      #   Billable duration in seconds. Null while the call is live
-      #
-      #   @return [Integer, nil]
-      optional :duration_seconds, Integer, nil?: true
-
-      # @!attribute ended_at
-      #   When the call ended (UTC). Null while the call is live
-      #
-      #   @return [Time, nil]
-      optional :ended_at, Time, nil?: true
-
-      # @!attribute failure_reason
-      #   Why the call did not complete: callback_timeout, invalid_answer,
-      #   insufficient_balance, destination_blocked, callback_not_configured, rejected or
-      #   no_answer. Null while the call is live, when it completed, and when it failed
-      #   without a recorded reason
-      #
-      #   @return [String, nil]
-      optional :failure_reason, String, nil?: true
-
-      # @!attribute from
-      #   One end of a call
-      #
-      #   @return [Sentdm::Models::CallParty, nil]
-      optional :from, -> { Sentdm::CallParty }
-
-      # @!attribute number
-      #   Your number that owns the call, in E.164 format: the dialed number for an
-      #   inbound call, the caller's bound number for a call placed from your app
-      #
-      #   @return [String, nil]
-      optional :number, String
-
-      # @!attribute price
-      #   What the call cost. Null until it has been priced
-      #
-      #   @return [Float, nil]
-      optional :price, Float, nil?: true
-
-      # @!attribute recording_available
-      #   True once a recording of the call is available
-      #
-      #   @return [Boolean, nil]
-      optional :recording_available, Sentdm::Internal::Type::Boolean
-
-      # @!attribute started_at
-      #   When the call was placed (UTC)
-      #
-      #   @return [Time, nil]
-      optional :started_at, Time
-
-      # @!attribute status
-      #   INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
-      #
-      #   @return [String, nil]
-      optional :status, String
-
-      # @!attribute timeline
-      #   When the call entered each status, oldest first. Only returned when reading one
-      #   call
-      #
-      #   @return [Array<Sentdm::Models::CallTimelineEntry>, nil]
-      optional :timeline, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::CallTimelineEntry] }, nil?: true
-
-      # @!attribute to
-      #   One end of a call
-      #
-      #   @return [Sentdm::Models::CallParty, nil]
-      optional :to, -> { Sentdm::CallParty }
-
-      # @!method initialize(id: nil, answered_at: nil, direction: nil, duration_seconds: nil, ended_at: nil, failure_reason: nil, from: nil, number: nil, price: nil, recording_available: nil, started_at: nil, status: nil, timeline: nil, to: nil)
-      #   Some parameter documentations has been truncated, see {Sentdm::Models::Call} for
-      #   more details.
-      #
-      #   A call record
-      #
-      #   @param id [String] The call id, the same one carried by the call.request question and every call we
-      #
-      #   @param answered_at [Time, nil] When the call was answered (UTC). Null until then, and always null for a call be
-      #
-      #   @param direction [String] outbound for a call placed from your app, inbound for a call to one of your numb
-      #
-      #   @param duration_seconds [Integer, nil] Billable duration in seconds. Null while the call is live
-      #
-      #   @param ended_at [Time, nil] When the call ended (UTC). Null while the call is live
-      #
-      #   @param failure_reason [String, nil] Why the call did not complete: callback_timeout, invalid_answer, insufficient_ba
-      #
-      #   @param from [Sentdm::Models::CallParty] One end of a call
-      #
-      #   @param number [String] Your number that owns the call, in E.164 format: the dialed number for an inboun
-      #
-      #   @param price [Float, nil] What the call cost. Null until it has been priced
-      #
-      #   @param recording_available [Boolean] True once a recording of the call is available
-      #
-      #   @param started_at [Time] When the call was placed (UTC)
-      #
-      #   @param status [String] INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
-      #
-      #   @param timeline [Array<Sentdm::Models::CallTimelineEntry>, nil] When the call entered each status, oldest first. Only returned when reading one
-      #
-      #   @param to [Sentdm::Models::CallParty] One end of a call
-    end
-  end
-end

data/lib/sentdm/models/call_hangup_params.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Calls#hangup
-    class CallHangupParams < Sentdm::Models::MutationRequest
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      # @!attribute id
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!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:, idempotency_key: nil, x_profile_id: nil, request_options: {})
-      #   @param id [String]
-      #   @param idempotency_key [String]
-      #   @param x_profile_id [String]
-      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/sentdm/models/call_list_params.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Calls#list
-    class CallListParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      # @!attribute direction
-      #   Optional direction filter: outbound for calls placed from your app, inbound for
-      #   calls to one of your numbers
-      #
-      #   @return [String, nil]
-      optional :direction, String, nil?: true
-
-      # @!attribute from
-      #   Only calls started at or after this time (ISO 8601)
-      #
-      #   @return [Time, nil]
-      optional :from, Time, nil?: true
-
-      # @!attribute number
-      #   Optional filter on the number that owns the call, one of your voice-enabled
-      #   numbers in E.164 format
-      #
-      #   @return [String, nil]
-      optional :number, String, nil?: true
-
-      # @!attribute page
-      #   Page number (1-indexed)
-      #
-      #   @return [Integer, nil]
-      optional :page, Integer
-
-      # @!attribute page_size
-      #   Number of items per page
-      #
-      #   @return [Integer, nil]
-      optional :page_size, Integer
-
-      # @!attribute status
-      #   Optional status filter: initiated, ringing, answered, completed, failed,
-      #   no_answer or rejected
-      #
-      #   @return [String, nil]
-      optional :status, String, nil?: true
-
-      # @!attribute to
-      #   Only calls started at or before this time (ISO 8601)
-      #
-      #   @return [Time, nil]
-      optional :to, Time, nil?: true
-
-      # @!attribute x_profile_id
-      #
-      #   @return [String, nil]
-      optional :x_profile_id, String
-
-      # @!method initialize(direction: nil, from: nil, number: nil, page: nil, page_size: nil, status: nil, to: nil, x_profile_id: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::CallListParams} for more details.
-      #
-      #   @param direction [String, nil] Optional direction filter: outbound for calls placed from your app, inbound for
-      #
-      #   @param from [Time, nil] Only calls started at or after this time (ISO 8601)
-      #
-      #   @param number [String, nil] Optional filter on the number that owns the call, one of your voice-enabled numb
-      #
-      #   @param page [Integer] Page number (1-indexed)
-      #
-      #   @param page_size [Integer] Number of items per page
-      #
-      #   @param status [String, nil] Optional status filter: initiated, ringing, answered, completed, failed, no_answ
-      #
-      #   @param to [Time, nil] Only calls started at or before this time (ISO 8601)
-      #
-      #   @param x_profile_id [String]
-      #
-      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/sentdm/models/call_list_recordings_params.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Calls#list_recordings
-    class CallListRecordingsParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      # @!attribute id
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute x_profile_id
-      #
-      #   @return [String, nil]
-      optional :x_profile_id, String
-
-      # @!method initialize(id:, x_profile_id: nil, request_options: {})
-      #   @param id [String]
-      #   @param x_profile_id [String]
-      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/sentdm/models/call_party.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class CallParty < Sentdm::Internal::Type::BaseModel
-      # @!attribute kind
-      #   user for one of your app users, number for a phone number, conference for a
-      #   room, anonymous for a caller who withheld their number
-      #
-      #   @return [String, nil]
-      optional :kind, String
-
-      # @!attribute value
-      #   The app user's identity, the phone number in E.164 format, or the room name.
-      #   Null when the kind is anonymous
-      #
-      #   @return [String, nil]
-      optional :value, String, nil?: true
-
-      # @!method initialize(kind: nil, value: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::CallParty} for more details.
-      #
-      #   One end of a call
-      #
-      #   @param kind [String] user for one of your app users, number for a phone number, conference for a room
-      #
-      #   @param value [String, nil] The app user's identity, the phone number in E.164 format, or the room name. Nul
-    end
-  end
-end

data/lib/sentdm/models/call_record_params.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Calls#record
-    class CallRecordParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      # @!attribute id
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute action
-      #   start to begin recording, stop to end it
-      #
-      #   @return [String, nil]
-      optional :action, String
-
-      # @!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:, action: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::CallRecordParams} for more details.
-      #
-      #   @param id [String]
-      #
-      #   @param action [String] start to begin recording, stop to end it
-      #
-      #   @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

data/lib/sentdm/models/call_recording.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class CallRecording < Sentdm::Internal::Type::BaseModel
-      # @!attribute download_url
-      #   A pre-signed link that downloads the recording as an MP3 file. Anyone holding it
-      #   can download the recording until it expires
-      #
-      #   @return [String, nil]
-      optional :download_url, String
-
-      # @!attribute recording_id
-      #   The recording's id, the one the call.recording_ready webhook announced it under
-      #
-      #   @return [String, nil]
-      optional :recording_id, String
-
-      # @!attribute url_expires_at
-      #   When the link stops working (UTC). Request the recordings again for a fresh link
-      #
-      #   @return [Time, nil]
-      optional :url_expires_at, Time
-
-      # @!method initialize(download_url: nil, recording_id: nil, url_expires_at: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::CallRecording} for more details.
-      #
-      #   A short-lived link to a call recording
-      #
-      #   @param download_url [String] A pre-signed link that downloads the recording as an MP3 file. Anyone holding it
-      #
-      #   @param recording_id [String] The recording's id, the one the call.recording_ready webhook announced it under
-      #
-      #   @param url_expires_at [Time] When the link stops working (UTC). Request the recordings again for a fresh link
-    end
-  end
-end

data/lib/sentdm/models/call_recordings.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class CallRecordings < Sentdm::Internal::Type::BaseModel
-      # @!attribute recordings
-      #   Every recording of the call, oldest first. Empty until the first
-      #   call.recording_ready webhook has been sent, and for a call that was never
-      #   recorded
-      #
-      #   @return [Array<Sentdm::Models::CallRecording>, nil]
-      optional :recordings, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::CallRecording] }
-
-      # @!method initialize(recordings: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::CallRecordings} for more details.
-      #
-      #   The recordings of a call, each as a short-lived download link
-      #
-      #   @param recordings [Array<Sentdm::Models::CallRecording>] Every recording of the call, oldest first. Empty until the first
-      #   call.recording\_
-    end
-  end
-end

data/lib/sentdm/models/call_retrieve_params.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Calls#retrieve
-    class CallRetrieveParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      # @!attribute id
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute x_profile_id
-      #
-      #   @return [String, nil]
-      optional :x_profile_id, String
-
-      # @!method initialize(id:, x_profile_id: nil, request_options: {})
-      #   @param id [String]
-      #   @param x_profile_id [String]
-      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/sentdm/models/call_timeline_entry.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class CallTimelineEntry < Sentdm::Internal::Type::BaseModel
-      # @!attribute status
-      #   INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
-      #
-      #   @return [String, nil]
-      optional :status, String
-
-      # @!attribute timestamp
-      #   When the call entered this status (UTC)
-      #
-      #   @return [Time, nil]
-      optional :timestamp, Time
-
-      # @!method initialize(status: nil, timestamp: nil)
-      #   When a call entered a status
-      #
-      #   @param status [String] INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
-      #
-      #   @param timestamp [Time] When the call entered this status (UTC)
-    end
-  end
-end

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

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    module Calls
-      class CallParticipant < Sentdm::Internal::Type::BaseModel
-        # @!attribute id
-        #   The participant's own call id: what the mute and remove endpoints take, and what
-        #   GET /v3/calls/{id} accepts
-        #
-        #   @return [String, nil]
-        optional :id, String
-
-        # @!attribute duration_seconds
-        #   How long the participant has been connected to the room, in seconds
-        #
-        #   @return [Integer, nil]
-        optional :duration_seconds, Integer
-
-        # @!attribute kind
-        #   user for one of your app users, number for a phone number, anonymous for a
-        #   caller who withheld their number
-        #
-        #   @return [String, nil]
-        optional :kind, String
-
-        # @!attribute muted
-        #   True while the room mutes this participant
-        #
-        #   @return [Boolean, nil]
-        optional :muted, Sentdm::Internal::Type::Boolean
-
-        # @!attribute value
-        #   The app user's identity or the phone number in E.164 format. Null when the kind
-        #   is anonymous
-        #
-        #   @return [String, nil]
-        optional :value, String, nil?: true
-
-        # @!method initialize(id: nil, duration_seconds: nil, kind: nil, muted: nil, value: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::Calls::CallParticipant} for more details.
-        #
-        #   A participant of a conference call
-        #
-        #   @param id [String] The participant's own call id: what the mute and remove endpoints take, and what
-        #
-        #   @param duration_seconds [Integer] How long the participant has been connected to the room, in seconds
-        #
-        #   @param kind [String] user for one of your app users, number for a phone number, anonymous for a calle
-        #
-        #   @param muted [Boolean] True while the room mutes this participant
-        #
-        #   @param value [String, nil] The app user's identity or the phone number in E.164 format. Null when the kind
-      end
-    end
-
-    CallParticipant = Calls::CallParticipant
-  end
-end

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

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    module Calls
-      class CallParticipantTarget < Sentdm::Internal::Type::BaseModel
-        # @!attribute kind
-        #   user for one of your app users, number for a phone number
-        #
-        #   @return [String, nil]
-        optional :kind, String
-
-        # @!attribute value
-        #   The app user's identity, or the phone number in E.164 format
-        #
-        #   @return [String, nil]
-        optional :value, String
-
-        # @!method initialize(kind: nil, value: nil)
-        #   A participant to add to a call
-        #
-        #   @param kind [String] user for one of your app users, number for a phone number
-        #
-        #   @param value [String] The app user's identity, or the phone number in E.164 format
-      end
-    end
-
-    CallParticipantTarget = Calls::CallParticipantTarget
-  end
-end

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

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    module Calls
-      # @see Sentdm::Resources::Calls::Participants#add
-      class ParticipantAddParams < Sentdm::Internal::Type::BaseModel
-        extend Sentdm::Internal::Type::RequestParameters::Converter
-        include Sentdm::Internal::Type::RequestParameters
-
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute caller_id
-        #   The number shown to a phone participant as the caller, in E.164 format. Must be
-        #   one of your numbers. The call's owning number when omitted
-        #
-        #   @return [String, nil]
-        optional :caller_id, 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 to
-        #   A participant to add to a call
-        #
-        #   @return [Sentdm::Models::Calls::CallParticipantTarget, nil]
-        optional :to, -> { Sentdm::Calls::CallParticipantTarget }
-
-        # @!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:, caller_id: nil, sandbox: nil, to: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::Calls::ParticipantAddParams} for more details.
-        #
-        #   @param id [String]
-        #
-        #   @param caller_id [String, nil] The number shown to a phone participant as the caller, in E.164 format. Must be
-        #
-        #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
-        #
-        #   @param to [Sentdm::Models::Calls::CallParticipantTarget] A participant to add to a call
-        #
-        #   @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

@@ -1,26 +0,0 @@
-# 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