sentdm 0.38.1 → 0.40.0

data/rbi/sentdm/resources/calls.rbi

@@ -1,207 +0,0 @@
-# typed: strong
-
-module Sentdm
-  module Resources
-    # Phone calls from the numbers you hold, driven by your own callback URL.
-    #
-    # `POST /v3/channels/voice` enables a number for calls, with the callback URL Sent
-    # asks what to do with each call on it, and `POST /v3/channels/voice/tokens` mints
-    # a short-lived token that lets a user of your app place and receive calls as that
-    # number. When a call arrives or a caller presses a key, a signed question is
-    # POSTed to the callback URL and the answer decides the call;
-    # `POST /v3/channels/voice/{number}/test` checks the URL answers the way we need
-    # before a real call reaches it, and
-    # `POST /v3/channels/voice/{number}/rotate-secret` replaces the signing secret.
-    # The call events themselves (`call.completed` and the rest) arrive through your
-    # webhooks.
-    #
-    # Every call is a record under `/v3/calls`: read it, list its recordings once one
-    # is ready, hang it up, start or stop recording, and add, mute or remove
-    # conference participants while it is live. A leg to a phone number runs for at
-    # most what your balance affords at the destination's rate.
-    class Calls
-      # Phone calls from the numbers you hold, driven by your own callback URL.
-      #
-      # `POST /v3/channels/voice` enables a number for calls, with the callback URL Sent
-      # asks what to do with each call on it, and `POST /v3/channels/voice/tokens` mints
-      # a short-lived token that lets a user of your app place and receive calls as that
-      # number. When a call arrives or a caller presses a key, a signed question is
-      # POSTed to the callback URL and the answer decides the call;
-      # `POST /v3/channels/voice/{number}/test` checks the URL answers the way we need
-      # before a real call reaches it, and
-      # `POST /v3/channels/voice/{number}/rotate-secret` replaces the signing secret.
-      # The call events themselves (`call.completed` and the rest) arrive through your
-      # webhooks.
-      #
-      # Every call is a record under `/v3/calls`: read it, list its recordings once one
-      # is ready, hang it up, start or stop recording, and add, mute or remove
-      # conference participants while it is live. A leg to a phone number runs for at
-      # most what your balance affords at the destination's rate.
-      sig { returns(Sentdm::Resources::Calls::Participants) }
-      attr_reader :participants
-
-      # Retrieves one of your calls by id: the parties, the owning number, the current
-      # status with its failure reason, duration, price, recording availability, and a
-      # timeline of when the call entered each status.
-      sig do
-        params(
-          id: String,
-          x_profile_id: String,
-          request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseOfCall)
-      end
-      def retrieve(
-        # The call id from the route, as carried by call webhooks and the calls list, for
-        # example call_9f2ab000-0000-4000-8000-000000000001
-        id,
-        # Profile UUID to scope the request to a child profile. Only organization API keys
-        # can use this header. The profile must belong to the calling organization.
-        x_profile_id: nil,
-        request_options: {}
-      )
-      end
-
-      # Retrieves a paginated list of your calls, most recent first. Filter by
-      # direction, status, the owning number, and the time the call started (from and to
-      # are inclusive). Use the call webhooks for real-time updates; this list is for
-      # looking calls up afterwards.
-      sig do
-        params(
-          direction: T.nilable(String),
-          from: T.nilable(Time),
-          number: T.nilable(String),
-          page: Integer,
-          page_size: Integer,
-          status: T.nilable(String),
-          to: T.nilable(Time),
-          x_profile_id: String,
-          request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::Internal::CallsPage[Sentdm::Call])
-      end
-      def list(
-        # Query param: Optional direction filter: outbound for calls placed from your app,
-        # inbound for calls to one of your numbers
-        direction: nil,
-        # Query param: Only calls started at or after this time (ISO 8601)
-        from: nil,
-        # Query param: Optional filter on the number that owns the call, one of your
-        # voice-enabled numbers in E.164 format
-        number: nil,
-        # Query param: Page number (1-indexed)
-        page: nil,
-        # Query param: Number of items per page
-        page_size: nil,
-        # Query param: Optional status filter: initiated, ringing, answered, completed,
-        # failed, no_answer or rejected
-        status: nil,
-        # Query param: Only calls started at or before this time (ISO 8601)
-        to: nil,
-        # Header param: Profile UUID to scope the request to a child profile. Only
-        # organization API keys can use this header. The profile must belong to the
-        # calling organization.
-        x_profile_id: nil,
-        request_options: {}
-      )
-      end
-
-      # Ends one of your live calls. The call then ends the way any other call does once
-      # the disconnect is reported: an answered call as COMPLETED with call.completed, a
-      # call still ringing as NO_ANSWER, REJECTED or FAILED with call.failed. A call
-      # that has already ended answers 409, and so does a call with no phone leg, such
-      # as one between two app users.
-      sig do
-        params(
-          id: String,
-          sandbox: T::Boolean,
-          idempotency_key: String,
-          x_profile_id: String,
-          request_options: Sentdm::RequestOptions::OrHash
-        ).void
-      end
-      def hangup(
-        # Path param: The call id from the route, as carried by call webhooks and the
-        # calls list, for example call_9f2ab000-0000-4000-8000-000000000001
-        id,
-        # Body param: Sandbox flag - when true, the operation is simulated without side
-        # effects Useful for testing integrations without actual execution
-        sandbox: nil,
-        # Header param: Unique key to ensure idempotent request processing. Must be 1-255
-        # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
-        # hours per key per customer.
-        idempotency_key: nil,
-        # Header param: Profile UUID to scope the request to a child profile. Only
-        # organization API keys can use this header. The profile must belong to the
-        # calling organization.
-        x_profile_id: nil,
-        request_options: {}
-      )
-      end
-
-      # Returns pre-signed links to the recordings of one of your calls, each valid
-      # until its url_expires_at. A recording appears once the call was recorded, by a
-      # connect answer with record set, a startRecording instruction or the recordings
-      # command, and the call.recording_ready webhook has been sent; until then, and for
-      # a call that was never recorded, the list is empty. A call recorded more than
-      # once lists every recording, oldest first, each under the recording_id its
-      # call.recording_ready webhook carried.
-      sig do
-        params(
-          id: String,
-          x_profile_id: String,
-          request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseOfCallRecordings)
-      end
-      def list_recordings(
-        # The call id from the route, as carried by call webhooks and the calls list, for
-        # example call_9f2ab000-0000-4000-8000-000000000001
-        id,
-        # Profile UUID to scope the request to a child profile. Only organization API keys
-        # can use this header. The profile must belong to the calling organization.
-        x_profile_id: nil,
-        request_options: {}
-      )
-      end
-
-      # Starts or stops recording one of your live calls. Use start to begin recording
-      # mid-call, or stop to end a recording, whether it was started here or by a
-      # connect answer with record set. A call that has already ended answers 409, and
-      # so does a call with no phone leg, such as one between two app users, which can't
-      # be recorded.
-      sig do
-        params(
-          id: String,
-          action: String,
-          sandbox: T::Boolean,
-          idempotency_key: String,
-          x_profile_id: String,
-          request_options: Sentdm::RequestOptions::OrHash
-        ).void
-      end
-      def record(
-        # Path param: The call id from the route, as carried by call webhooks and the
-        # calls list, for example call_9f2ab000-0000-4000-8000-000000000001
-        id,
-        # Body param: start to begin recording, stop to end it
-        action: nil,
-        # Body param: Sandbox flag - when true, the operation is simulated without side
-        # effects Useful for testing integrations without actual execution
-        sandbox: nil,
-        # Header param: Unique key to ensure idempotent request processing. Must be 1-255
-        # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
-        # hours per key per customer.
-        idempotency_key: nil,
-        # Header param: Profile UUID to scope the request to a child profile. Only
-        # organization API keys can use this header. The profile must belong to the
-        # calling organization.
-        x_profile_id: nil,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: Sentdm::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/sig/sentdm/models/api_response_of_call.rbs

@@ -1,39 +0,0 @@
-module Sentdm
-  module Models
-    type api_response_of_call =
-      {
-        data: Sentdm::Call?,
-        error: Sentdm::ErrorDetail?,
-        meta: Sentdm::APIMeta,
-        success: bool
-      }
-
-    class APIResponseOfCall < Sentdm::Internal::Type::BaseModel
-      attr_accessor data: Sentdm::Call?
-
-      attr_accessor error: Sentdm::ErrorDetail?
-
-      attr_reader meta: Sentdm::APIMeta?
-
-      def meta=: (Sentdm::APIMeta) -> Sentdm::APIMeta
-
-      attr_reader success: bool?
-
-      def success=: (bool) -> bool
-
-      def initialize: (
-        ?data: Sentdm::Call?,
-        ?error: Sentdm::ErrorDetail?,
-        ?meta: Sentdm::APIMeta,
-        ?success: bool
-      ) -> void
-
-      def to_hash: -> {
-        data: Sentdm::Call?,
-        error: Sentdm::ErrorDetail?,
-        meta: Sentdm::APIMeta,
-        success: bool
-      }
-    end
-  end
-end

data/sig/sentdm/models/api_response_of_call_recordings.rbs

@@ -1,39 +0,0 @@
-module Sentdm
-  module Models
-    type api_response_of_call_recordings =
-      {
-        data: Sentdm::CallRecordings?,
-        error: Sentdm::ErrorDetail?,
-        meta: Sentdm::APIMeta,
-        success: bool
-      }
-
-    class APIResponseOfCallRecordings < Sentdm::Internal::Type::BaseModel
-      attr_accessor data: Sentdm::CallRecordings?
-
-      attr_accessor error: Sentdm::ErrorDetail?
-
-      attr_reader meta: Sentdm::APIMeta?
-
-      def meta=: (Sentdm::APIMeta) -> Sentdm::APIMeta
-
-      attr_reader success: bool?
-
-      def success=: (bool) -> bool
-
-      def initialize: (
-        ?data: Sentdm::CallRecordings?,
-        ?error: Sentdm::ErrorDetail?,
-        ?meta: Sentdm::APIMeta,
-        ?success: bool
-      ) -> void
-
-      def to_hash: -> {
-        data: Sentdm::CallRecordings?,
-        error: Sentdm::ErrorDetail?,
-        meta: Sentdm::APIMeta,
-        success: bool
-      }
-    end
-  end
-end

data/sig/sentdm/models/api_response_of_calls_list.rbs

@@ -1,39 +0,0 @@
-module Sentdm
-  module Models
-    type api_response_of_calls_list =
-      {
-        data: Sentdm::CallsList?,
-        error: Sentdm::ErrorDetail?,
-        meta: Sentdm::APIMeta,
-        success: bool
-      }
-
-    class APIResponseOfCallsList < Sentdm::Internal::Type::BaseModel
-      attr_accessor data: Sentdm::CallsList?
-
-      attr_accessor error: Sentdm::ErrorDetail?
-
-      attr_reader meta: Sentdm::APIMeta?
-
-      def meta=: (Sentdm::APIMeta) -> Sentdm::APIMeta
-
-      attr_reader success: bool?
-
-      def success=: (bool) -> bool
-
-      def initialize: (
-        ?data: Sentdm::CallsList?,
-        ?error: Sentdm::ErrorDetail?,
-        ?meta: Sentdm::APIMeta,
-        ?success: bool
-      ) -> void
-
-      def to_hash: -> {
-        data: Sentdm::CallsList?,
-        error: Sentdm::ErrorDetail?,
-        meta: Sentdm::APIMeta,
-        success: bool
-      }
-    end
-  end
-end

data/sig/sentdm/models/call.rbs

@@ -1,101 +0,0 @@
-module Sentdm
-  module Models
-    type call =
-      {
-        id: String,
-        answered_at: Time?,
-        direction: String,
-        duration_seconds: Integer?,
-        ended_at: Time?,
-        failure_reason: String?,
-        from: Sentdm::CallParty,
-        number: String,
-        price: Float?,
-        recording_available: bool,
-        started_at: Time,
-        status: String,
-        timeline: ::Array[Sentdm::CallTimelineEntry]?,
-        to: Sentdm::CallParty
-      }
-
-    class Call < Sentdm::Internal::Type::BaseModel
-      attr_reader id: String?
-
-      def id=: (String) -> String
-
-      attr_accessor answered_at: Time?
-
-      attr_reader direction: String?
-
-      def direction=: (String) -> String
-
-      attr_accessor duration_seconds: Integer?
-
-      attr_accessor ended_at: Time?
-
-      attr_accessor failure_reason: String?
-
-      attr_reader from: Sentdm::CallParty?
-
-      def from=: (Sentdm::CallParty) -> Sentdm::CallParty
-
-      attr_reader number: String?
-
-      def number=: (String) -> String
-
-      attr_accessor price: Float?
-
-      attr_reader recording_available: bool?
-
-      def recording_available=: (bool) -> bool
-
-      attr_reader started_at: Time?
-
-      def started_at=: (Time) -> Time
-
-      attr_reader status: String?
-
-      def status=: (String) -> String
-
-      attr_accessor timeline: ::Array[Sentdm::CallTimelineEntry]?
-
-      attr_reader to: Sentdm::CallParty?
-
-      def to=: (Sentdm::CallParty) -> Sentdm::CallParty
-
-      def initialize: (
-        ?id: String,
-        ?answered_at: Time?,
-        ?direction: String,
-        ?duration_seconds: Integer?,
-        ?ended_at: Time?,
-        ?failure_reason: String?,
-        ?from: Sentdm::CallParty,
-        ?number: String,
-        ?price: Float?,
-        ?recording_available: bool,
-        ?started_at: Time,
-        ?status: String,
-        ?timeline: ::Array[Sentdm::CallTimelineEntry]?,
-        ?to: Sentdm::CallParty
-      ) -> void
-
-      def to_hash: -> {
-        id: String,
-        answered_at: Time?,
-        direction: String,
-        duration_seconds: Integer?,
-        ended_at: Time?,
-        failure_reason: String?,
-        from: Sentdm::CallParty,
-        number: String,
-        price: Float?,
-        recording_available: bool,
-        started_at: Time,
-        status: String,
-        timeline: ::Array[Sentdm::CallTimelineEntry]?,
-        to: Sentdm::CallParty
-      }
-    end
-  end
-end

data/sig/sentdm/models/call_hangup_params.rbs

@@ -1,38 +0,0 @@
-module Sentdm
-  module Models
-    type call_hangup_params =
-      { id: String, idempotency_key: String, x_profile_id: String }
-      & Sentdm::Internal::Type::request_parameters
-
-    class CallHangupParams < Sentdm::Models::MutationRequest
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      def id: -> String
-
-      def id=: (String _) -> String
-
-      def idempotency_key: -> String?
-
-      def idempotency_key=: (String _) -> String
-
-      def x_profile_id: -> String?
-
-      def x_profile_id=: (String _) -> String
-
-      def initialize: (
-        id: String,
-        ?idempotency_key: String,
-        ?x_profile_id: String,
-        ?request_options: Sentdm::request_opts
-      ) -> void
-
-      def to_hash: -> {
-        id: String,
-        idempotency_key: String,
-        x_profile_id: String,
-        request_options: Sentdm::RequestOptions
-      }
-    end
-  end
-end

data/sig/sentdm/models/call_list_params.rbs

@@ -1,67 +0,0 @@
-module Sentdm
-  module Models
-    type call_list_params =
-      {
-        direction: String?,
-        from: Time?,
-        number: String?,
-        page: Integer,
-        page_size: Integer,
-        status: String?,
-        to: Time?,
-        x_profile_id: String
-      }
-      & Sentdm::Internal::Type::request_parameters
-
-    class CallListParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      attr_accessor direction: String?
-
-      attr_accessor from: Time?
-
-      attr_accessor number: String?
-
-      attr_reader page: Integer?
-
-      def page=: (Integer) -> Integer
-
-      attr_reader page_size: Integer?
-
-      def page_size=: (Integer) -> Integer
-
-      attr_accessor status: String?
-
-      attr_accessor to: Time?
-
-      attr_reader x_profile_id: String?
-
-      def x_profile_id=: (String) -> String
-
-      def initialize: (
-        ?direction: String?,
-        ?from: Time?,
-        ?number: String?,
-        ?page: Integer,
-        ?page_size: Integer,
-        ?status: String?,
-        ?to: Time?,
-        ?x_profile_id: String,
-        ?request_options: Sentdm::request_opts
-      ) -> void
-
-      def to_hash: -> {
-        direction: String?,
-        from: Time?,
-        number: String?,
-        page: Integer,
-        page_size: Integer,
-        status: String?,
-        to: Time?,
-        x_profile_id: String,
-        request_options: Sentdm::RequestOptions
-      }
-    end
-  end
-end

data/sig/sentdm/models/call_list_recordings_params.rbs

@@ -1,30 +0,0 @@
-module Sentdm
-  module Models
-    type call_list_recordings_params =
-      { id: String, x_profile_id: String }
-      & Sentdm::Internal::Type::request_parameters
-
-    class CallListRecordingsParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      attr_accessor id: String
-
-      attr_reader x_profile_id: String?
-
-      def x_profile_id=: (String) -> String
-
-      def initialize: (
-        id: String,
-        ?x_profile_id: String,
-        ?request_options: Sentdm::request_opts
-      ) -> void
-
-      def to_hash: -> {
-        id: String,
-        x_profile_id: String,
-        request_options: Sentdm::RequestOptions
-      }
-    end
-  end
-end

data/sig/sentdm/models/call_party.rbs

@@ -1,17 +0,0 @@
-module Sentdm
-  module Models
-    type call_party = { kind: String, value: String? }
-
-    class CallParty < Sentdm::Internal::Type::BaseModel
-      attr_reader kind: String?
-
-      def kind=: (String) -> String
-
-      attr_accessor value: String?
-
-      def initialize: (?kind: String, ?value: String?) -> void
-
-      def to_hash: -> { kind: String, value: String? }
-    end
-  end
-end

data/sig/sentdm/models/call_record_params.rbs

@@ -1,54 +0,0 @@
-module Sentdm
-  module Models
-    type call_record_params =
-      {
-        id: String,
-        action: String,
-        sandbox: bool,
-        idempotency_key: String,
-        x_profile_id: String
-      }
-      & Sentdm::Internal::Type::request_parameters
-
-    class CallRecordParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      attr_accessor id: String
-
-      attr_reader action: String?
-
-      def action=: (String) -> String
-
-      attr_reader sandbox: bool?
-
-      def sandbox=: (bool) -> bool
-
-      attr_reader idempotency_key: String?
-
-      def idempotency_key=: (String) -> String
-
-      attr_reader x_profile_id: String?
-
-      def x_profile_id=: (String) -> String
-
-      def initialize: (
-        id: String,
-        ?action: String,
-        ?sandbox: bool,
-        ?idempotency_key: String,
-        ?x_profile_id: String,
-        ?request_options: Sentdm::request_opts
-      ) -> void
-
-      def to_hash: -> {
-        id: String,
-        action: String,
-        sandbox: bool,
-        idempotency_key: String,
-        x_profile_id: String,
-        request_options: Sentdm::RequestOptions
-      }
-    end
-  end
-end

data/sig/sentdm/models/call_recording.rbs

@@ -1,32 +0,0 @@
-module Sentdm
-  module Models
-    type call_recording =
-      { download_url: String, recording_id: String, url_expires_at: Time }
-
-    class CallRecording < Sentdm::Internal::Type::BaseModel
-      attr_reader download_url: String?
-
-      def download_url=: (String) -> String
-
-      attr_reader recording_id: String?
-
-      def recording_id=: (String) -> String
-
-      attr_reader url_expires_at: Time?
-
-      def url_expires_at=: (Time) -> Time
-
-      def initialize: (
-        ?download_url: String,
-        ?recording_id: String,
-        ?url_expires_at: Time
-      ) -> void
-
-      def to_hash: -> {
-        download_url: String,
-        recording_id: String,
-        url_expires_at: Time
-      }
-    end
-  end
-end

data/sig/sentdm/models/call_recordings.rbs

@@ -1,17 +0,0 @@
-module Sentdm
-  module Models
-    type call_recordings = { recordings: ::Array[Sentdm::CallRecording] }
-
-    class CallRecordings < Sentdm::Internal::Type::BaseModel
-      attr_reader recordings: ::Array[Sentdm::CallRecording]?
-
-      def recordings=: (
-        ::Array[Sentdm::CallRecording]
-      ) -> ::Array[Sentdm::CallRecording]
-
-      def initialize: (?recordings: ::Array[Sentdm::CallRecording]) -> void
-
-      def to_hash: -> { recordings: ::Array[Sentdm::CallRecording] }
-    end
-  end
-end