telnyx 5.150.0 → 5.151.0

data/lib/telnyx/models/dir_retrieve_document_types_response.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    # @see Telnyx::Resources::Dir#retrieve_document_types
-    class DirRetrieveDocumentTypesResponse < Telnyx::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [Array<Telnyx::Models::DirRetrieveDocumentTypesResponse::Data>]
-      required :data,
-               -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::DirRetrieveDocumentTypesResponse::Data] }
-
-      # @!attribute meta
-      #   JSON:API pagination metadata returned with every paginated list response. Page
-      #   numbering is 1-based. `page_size` reports the number of items actually returned
-      #   in `data` for this page; the requested size is taken from the `page[size]` query
-      #   parameter.
-      #
-      #   @return [Telnyx::Models::BrandedCallingPaginationMeta]
-      required :meta, -> { Telnyx::BrandedCallingPaginationMeta }
-
-      # @!method initialize(data:, meta:)
-      #   Some parameter documentations has been truncated, see
-      #   {Telnyx::Models::DirRetrieveDocumentTypesResponse} for more details.
-      #
-      #   @param data [Array<Telnyx::Models::DirRetrieveDocumentTypesResponse::Data>]
-      #
-      #   @param meta [Telnyx::Models::BrandedCallingPaginationMeta] JSON:API pagination metadata returned with every paginated list response. Page n
-
-      class Data < Telnyx::Internal::Type::BaseModel
-        # @!attribute description
-        #
-        #   @return [String, nil]
-        optional :description, String
-
-        # @!attribute short_name
-        #   Stable identifier passed to `Document.document_type`.
-        #
-        #   @return [String, nil]
-        optional :short_name, String
-
-        # @!method initialize(description: nil, short_name: nil)
-        #   Single supported document type.
-        #
-        #   @param description [String]
-        #
-        #   @param short_name [String] Stable identifier passed to `Document.document_type`.
-      end
-    end
-  end
-end

data/lib/telnyx/models/dir_retrieve_infringement_claims_params.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    # @see Telnyx::Resources::Dir#retrieve_infringement_claims
-    class DirRetrieveInfringementClaimsParams < Telnyx::Internal::Type::BaseModel
-      extend Telnyx::Internal::Type::RequestParameters::Converter
-      include Telnyx::Internal::Type::RequestParameters
-
-      # @!attribute dir_id
-      #
-      #   @return [String]
-      required :dir_id, String
-
-      # @!attribute page_number
-      #   1-based page number. Out-of-range values return an empty page with correct meta.
-      #
-      #   @return [Integer, nil]
-      optional :page_number, Integer
-
-      # @!attribute page_size
-      #   Items per page. Maximum 250; values above are clamped to 250.
-      #
-      #   @return [Integer, nil]
-      optional :page_size, Integer
-
-      # @!method initialize(dir_id:, page_number: nil, page_size: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Telnyx::Models::DirRetrieveInfringementClaimsParams} for more details.
-      #
-      #   @param dir_id [String]
-      #
-      #   @param page_number [Integer] 1-based page number. Out-of-range values return an empty page with correct meta.
-      #
-      #   @param page_size [Integer] Items per page. Maximum 250; values above are clamped to 250.
-      #
-      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/telnyx/models/dir_retrieve_infringement_claims_response.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    # @see Telnyx::Resources::Dir#retrieve_infringement_claims
-    class DirRetrieveInfringementClaimsResponse < Telnyx::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [Array<Telnyx::Models::InfringementClaim>]
-      required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InfringementClaim] }
-
-      # @!attribute meta
-      #   JSON:API pagination metadata returned with every paginated list response. Page
-      #   numbering is 1-based. `page_size` reports the number of items actually returned
-      #   in `data` for this page; the requested size is taken from the `page[size]` query
-      #   parameter.
-      #
-      #   @return [Telnyx::Models::BrandedCallingPaginationMeta]
-      required :meta, -> { Telnyx::BrandedCallingPaginationMeta }
-
-      # @!method initialize(data:, meta:)
-      #   Some parameter documentations has been truncated, see
-      #   {Telnyx::Models::DirRetrieveInfringementClaimsResponse} for more details.
-      #
-      #   @param data [Array<Telnyx::Models::InfringementClaim>]
-      #
-      #   @param meta [Telnyx::Models::BrandedCallingPaginationMeta] JSON:API pagination metadata returned with every paginated list response. Page n
-    end
-  end
-end

data/lib/telnyx/models/dir_update_infringement_update_params.rb

@@ -1,134 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    # @see Telnyx::Resources::Dir#update_infringement_update
-    class DirUpdateInfringementUpdateParams < Telnyx::Internal::Type::BaseModel
-      extend Telnyx::Internal::Type::RequestParameters::Converter
-      include Telnyx::Internal::Type::RequestParameters
-
-      # @!attribute dir_id
-      #
-      #   @return [String]
-      required :dir_id, String
-
-      # @!attribute certify_brand_is_accurate
-      #   Must be `true`.
-      #
-      #   @return [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyBrandIsAccurate]
-      required :certify_brand_is_accurate,
-               enum: -> { Telnyx::DirUpdateInfringementUpdateParams::CertifyBrandIsAccurate }
-
-      # @!attribute certify_ip_ownership
-      #   Must be `true`.
-      #
-      #   @return [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyIPOwnership]
-      required :certify_ip_ownership, enum: -> { Telnyx::DirUpdateInfringementUpdateParams::CertifyIPOwnership }
-
-      # @!attribute certify_no_infringement
-      #   Must be `true`.
-      #
-      #   @return [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyNoInfringement]
-      required :certify_no_infringement,
-               enum: -> { Telnyx::DirUpdateInfringementUpdateParams::CertifyNoInfringement }
-
-      # @!attribute certify_no_shaft_content
-      #   Must be `true`.
-      #
-      #   @return [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyNoShaftContent]
-      required :certify_no_shaft_content,
-               enum: -> { Telnyx::DirUpdateInfringementUpdateParams::CertifyNoShaftContent }
-
-      # @!attribute infringement_resolution_notes
-      #   Explanation of how the infringement concern was addressed.
-      #
-      #   @return [String]
-      required :infringement_resolution_notes, String
-
-      # @!attribute call_reasons
-      #
-      #   @return [Array<String>, nil]
-      optional :call_reasons, Telnyx::Internal::Type::ArrayOf[String], nil?: true
-
-      # @!attribute display_name
-      #
-      #   @return [String, nil]
-      optional :display_name, String, nil?: true
-
-      # @!attribute documents
-      #   Append-only supporting documents.
-      #
-      #   @return [Array<Telnyx::Models::Document>, nil]
-      optional :documents, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Document] }, nil?: true
-
-      # @!attribute logo_url
-      #   Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).
-      #
-      #   @return [String, nil]
-      optional :logo_url, String, nil?: true
-
-      # @!method initialize(dir_id:, certify_brand_is_accurate:, certify_ip_ownership:, certify_no_infringement:, certify_no_shaft_content:, infringement_resolution_notes:, call_reasons: nil, display_name: nil, documents: nil, logo_url: nil, request_options: {})
-      #   @param dir_id [String]
-      #
-      #   @param certify_brand_is_accurate [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyBrandIsAccurate] Must be `true`.
-      #
-      #   @param certify_ip_ownership [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyIPOwnership] Must be `true`.
-      #
-      #   @param certify_no_infringement [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyNoInfringement] Must be `true`.
-      #
-      #   @param certify_no_shaft_content [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyNoShaftContent] Must be `true`.
-      #
-      #   @param infringement_resolution_notes [String] Explanation of how the infringement concern was addressed.
-      #
-      #   @param call_reasons [Array<String>, nil]
-      #
-      #   @param display_name [String, nil]
-      #
-      #   @param documents [Array<Telnyx::Models::Document>, nil] Append-only supporting documents.
-      #
-      #   @param logo_url [String, nil] Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).
-      #
-      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
-
-      # Must be `true`.
-      module CertifyBrandIsAccurate
-        extend Telnyx::Internal::Type::Enum
-
-        TRUE = true
-
-        # @!method self.values
-        #   @return [Array<Boolean>]
-      end
-
-      # Must be `true`.
-      module CertifyIPOwnership
-        extend Telnyx::Internal::Type::Enum
-
-        TRUE = true
-
-        # @!method self.values
-        #   @return [Array<Boolean>]
-      end
-
-      # Must be `true`.
-      module CertifyNoInfringement
-        extend Telnyx::Internal::Type::Enum
-
-        TRUE = true
-
-        # @!method self.values
-        #   @return [Array<Boolean>]
-      end
-
-      # Must be `true`.
-      module CertifyNoShaftContent
-        extend Telnyx::Internal::Type::Enum
-
-        TRUE = true
-
-        # @!method self.values
-        #   @return [Array<Boolean>]
-      end
-    end
-  end
-end

data/lib/telnyx/models/enterprises/reputation/loa_create_params.rb

@@ -1,146 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    module Enterprises
-      module Reputation
-        # @see Telnyx::Resources::Enterprises::Reputation::Loa#create
-        class LoaCreateParams < Telnyx::Internal::Type::BaseModel
-          extend Telnyx::Internal::Type::RequestParameters::Converter
-          include Telnyx::Internal::Type::RequestParameters
-
-          # @!attribute enterprise_id
-          #
-          #   @return [String]
-          required :enterprise_id, String
-
-          # @!attribute agent
-          #   Third-party reseller / partner managing the enterprise's phone numbers. Omit
-          #   when the enterprise works directly with Telnyx.
-          #
-          #   @return [Telnyx::Models::Enterprises::Reputation::LoaCreateParams::Agent, nil]
-          optional :agent, -> { Telnyx::Enterprises::Reputation::LoaCreateParams::Agent }
-
-          # @!attribute signature
-          #   Optional signature embedded in the rendered PDF. When omitted the PDF is
-          #   returned unsigned for the customer to sign and upload.
-          #
-          #   @return [Telnyx::Models::Enterprises::Reputation::LoaCreateParams::Signature, nil]
-          optional :signature, -> { Telnyx::Enterprises::Reputation::LoaCreateParams::Signature }
-
-          # @!method initialize(enterprise_id:, agent: nil, signature: nil, request_options: {})
-          #   Some parameter documentations has been truncated, see
-          #   {Telnyx::Models::Enterprises::Reputation::LoaCreateParams} for more details.
-          #
-          #   @param enterprise_id [String]
-          #
-          #   @param agent [Telnyx::Models::Enterprises::Reputation::LoaCreateParams::Agent] Third-party reseller / partner managing the enterprise's phone numbers. Omit whe
-          #
-          #   @param signature [Telnyx::Models::Enterprises::Reputation::LoaCreateParams::Signature] Optional signature embedded in the rendered PDF. When omitted the PDF is returne
-          #
-          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
-
-          class Agent < Telnyx::Internal::Type::BaseModel
-            # @!attribute administrative_area
-            #
-            #   @return [String]
-            required :administrative_area, String
-
-            # @!attribute city
-            #
-            #   @return [String]
-            required :city, String
-
-            # @!attribute contact_email
-            #
-            #   @return [String]
-            required :contact_email, String
-
-            # @!attribute contact_name
-            #
-            #   @return [String]
-            required :contact_name, String
-
-            # @!attribute contact_phone
-            #
-            #   @return [String]
-            required :contact_phone, String
-
-            # @!attribute contact_title
-            #
-            #   @return [String]
-            required :contact_title, String
-
-            # @!attribute country
-            #
-            #   @return [String]
-            required :country, String
-
-            # @!attribute legal_name
-            #
-            #   @return [String]
-            required :legal_name, String
-
-            # @!attribute postal_code
-            #
-            #   @return [String]
-            required :postal_code, String
-
-            # @!attribute street_address
-            #
-            #   @return [String]
-            required :street_address, String
-
-            # @!attribute dba
-            #
-            #   @return [String, nil]
-            optional :dba, String, nil?: true
-
-            # @!attribute extended_address
-            #
-            #   @return [String, nil]
-            optional :extended_address, String, nil?: true
-
-            # @!method initialize(administrative_area:, city:, contact_email:, contact_name:, contact_phone:, contact_title:, country:, legal_name:, postal_code:, street_address:, dba: nil, extended_address: nil)
-            #   Third-party reseller / partner managing the enterprise's phone numbers. Omit
-            #   when the enterprise works directly with Telnyx.
-            #
-            #   @param administrative_area [String]
-            #   @param city [String]
-            #   @param contact_email [String]
-            #   @param contact_name [String]
-            #   @param contact_phone [String]
-            #   @param contact_title [String]
-            #   @param country [String]
-            #   @param legal_name [String]
-            #   @param postal_code [String]
-            #   @param street_address [String]
-            #   @param dba [String, nil]
-            #   @param extended_address [String, nil]
-          end
-
-          class Signature < Telnyx::Internal::Type::BaseModel
-            # @!attribute image_base64
-            #   Base64-encoded signature image.
-            #
-            #   @return [String]
-            required :image_base64, String
-
-            # @!attribute signer_name
-            #
-            #   @return [String, nil]
-            optional :signer_name, String, nil?: true
-
-            # @!method initialize(image_base64:, signer_name: nil)
-            #   Optional signature embedded in the rendered PDF. When omitted the PDF is
-            #   returned unsigned for the customer to sign and upload.
-            #
-            #   @param image_base64 [String] Base64-encoded signature image.
-            #
-            #   @param signer_name [String, nil]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/telnyx/models/enterprises/reputation/loa_patch_all_params.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    module Enterprises
-      module Reputation
-        # @see Telnyx::Resources::Enterprises::Reputation::Loa#patch_all
-        class LoaPatchAllParams < Telnyx::Internal::Type::BaseModel
-          extend Telnyx::Internal::Type::RequestParameters::Converter
-          include Telnyx::Internal::Type::RequestParameters
-
-          # @!attribute enterprise_id
-          #
-          #   @return [String]
-          required :enterprise_id, String
-
-          # @!attribute loa_document_id
-          #   Id of the new signed LOA document (from the Telnyx Documents API). Changing it
-          #   resets LOA approval; the new document must be approved before more numbers can
-          #   be added.
-          #
-          #   @return [String]
-          required :loa_document_id, String
-
-          # @!method initialize(enterprise_id:, loa_document_id:, request_options: {})
-          #   Some parameter documentations has been truncated, see
-          #   {Telnyx::Models::Enterprises::Reputation::LoaPatchAllParams} for more details.
-          #
-          #   @param enterprise_id [String]
-          #
-          #   @param loa_document_id [String] Id of the new signed LOA document (from the Telnyx Documents API). Changing it r
-          #
-          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
-        end
-      end
-    end
-  end
-end

data/rbi/telnyx/models/dir/phone_number_create_params.rbi

@@ -1,72 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    module Dir
-      class PhoneNumberCreateParams < Telnyx::Internal::Type::BaseModel
-        extend Telnyx::Internal::Type::RequestParameters::Converter
-        include Telnyx::Internal::Type::RequestParameters
-
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::Dir::PhoneNumberCreateParams,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :dir_id
-
-        # Supporting documents covering this batch. At least one entry with
-        # `document_type: letter_of_authorization` is required - the LOA authorises Telnyx
-        # to register these numbers under the DIR. Each `document_id` must come from the
-        # Telnyx Documents API. Additional document types (e.g. business registration) may
-        # be included alongside the LOA.
-        sig { returns(T::Array[Telnyx::Document]) }
-        attr_accessor :documents
-
-        # 1–15 phone numbers in E.164 format. 10-digit US numbers are auto-prefixed with
-        # `1`.
-        sig { returns(T::Array[String]) }
-        attr_accessor :phone_numbers
-
-        sig do
-          params(
-            dir_id: String,
-            documents: T::Array[Telnyx::Document::OrHash],
-            phone_numbers: T::Array[String],
-            request_options: Telnyx::RequestOptions::OrHash
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          dir_id:,
-          # Supporting documents covering this batch. At least one entry with
-          # `document_type: letter_of_authorization` is required - the LOA authorises Telnyx
-          # to register these numbers under the DIR. Each `document_id` must come from the
-          # Telnyx Documents API. Additional document types (e.g. business registration) may
-          # be included alongside the LOA.
-          documents:,
-          # 1–15 phone numbers in E.164 format. 10-digit US numbers are auto-prefixed with
-          # `1`.
-          phone_numbers:,
-          request_options: {}
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              dir_id: String,
-              documents: T::Array[Telnyx::Document],
-              phone_numbers: T::Array[String],
-              request_options: Telnyx::RequestOptions
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/telnyx/models/dir/phone_number_create_response.rbi

@@ -1,48 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    module Dir
-      class PhoneNumberCreateResponse < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::Models::Dir::PhoneNumberCreateResponse,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        # Phone numbers accepted into the new batch. List order mirrors the request order.
-        # Each element shares the same `batch_id`.
-        sig { returns(T::Array[Telnyx::Dir::DirPhoneNumber]) }
-        attr_accessor :data
-
-        # Bulk-add success response (HTTP 201). All numbers in the request were accepted
-        # into a single new batch. Every entry in `data` shares the same `batch_id` - read
-        # it from any element to obtain the batch id for subsequent
-        # `GET .../phone_number_batches/{batch_id}` calls. If any number in the request
-        # fails (schema-invalid, not in inventory, already attached to another DIR, etc.)
-        # the entire request is rejected with HTTP 400 and the canonical Telnyx error
-        # envelope; the success body described here is therefore an all-or-nothing
-        # payload.
-        sig do
-          params(data: T::Array[Telnyx::Dir::DirPhoneNumber::OrHash]).returns(
-            T.attached_class
-          )
-        end
-        def self.new(
-          # Phone numbers accepted into the new batch. List order mirrors the request order.
-          # Each element shares the same `batch_id`.
-          data:
-        )
-        end
-
-        sig do
-          override.returns({ data: T::Array[Telnyx::Dir::DirPhoneNumber] })
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/telnyx/models/dir/phone_number_delete_all_params.rbi

@@ -1,48 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    module Dir
-      class PhoneNumberDeleteAllParams < Telnyx::Internal::Type::BaseModel
-        extend Telnyx::Internal::Type::RequestParameters::Converter
-        include Telnyx::Internal::Type::RequestParameters
-
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::Dir::PhoneNumberDeleteAllParams,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :dir_id
-
-        sig { returns(T::Array[String]) }
-        attr_accessor :phone_numbers
-
-        sig do
-          params(
-            dir_id: String,
-            phone_numbers: T::Array[String],
-            request_options: Telnyx::RequestOptions::OrHash
-          ).returns(T.attached_class)
-        end
-        def self.new(dir_id:, phone_numbers:, request_options: {})
-        end
-
-        sig do
-          override.returns(
-            {
-              dir_id: String,
-              phone_numbers: T::Array[String],
-              request_options: Telnyx::RequestOptions
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end