telnyx 5.150.0 → 5.152.0

data/lib/telnyx/models/dir/reference.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      class Reference < Telnyx::Internal::Type::BaseModel
+        # @!attribute full_name
+        #   Full name of the reference contact.
+        #
+        #   @return [String]
+        required :full_name, String
+
+        # @!attribute phone_e164
+        #   Reference phone number in E.164 format.
+        #
+        #   @return [String]
+        required :phone_e164, String
+
+        # @!attribute ref_type
+        #   Whether this is a business reference or the financial reference.
+        #
+        #   @return [Symbol, Telnyx::Models::Dir::Reference::RefType]
+        required :ref_type, enum: -> { Telnyx::Dir::Reference::RefType }
+
+        # @!attribute slot
+        #   Position within the reference type. Business references occupy slots 0 and 1;
+        #   the financial reference occupies slot 0.
+        #
+        #   @return [Integer]
+        required :slot, Integer
+
+        # @!attribute timezone
+        #   IANA timezone id for the reference. Calls are only placed within the reference's
+        #   local 8am-9pm window.
+        #
+        #   @return [String]
+        required :timezone, String
+
+        # @!attribute email
+        #   Reference contact email address.
+        #
+        #   @return [String, nil]
+        optional :email, String, nil?: true
+
+        # @!attribute job_title
+        #   Job title of the reference contact.
+        #
+        #   @return [String, nil]
+        optional :job_title, String, nil?: true
+
+        # @!attribute organization
+        #   Organization the reference contact belongs to.
+        #
+        #   @return [String, nil]
+        optional :organization, String, nil?: true
+
+        # @!attribute relationship_to_registrant
+        #   How the reference contact is related to the registering business.
+        #
+        #   @return [String, nil]
+        optional :relationship_to_registrant, String, nil?: true
+
+        response_only do
+          # @!attribute record_type
+          #   Always `dir_reference`.
+          #
+          #   @return [Symbol, Telnyx::Models::Dir::Reference::RecordType]
+          required :record_type, enum: -> { Telnyx::Dir::Reference::RecordType }
+        end
+
+        # @!method initialize(full_name:, phone_e164:, record_type:, ref_type:, slot:, timezone:, email: nil, job_title: nil, organization: nil, relationship_to_registrant: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Dir::Reference} for more details.
+        #
+        #   A reference (business or financial) on a DIR, in the customer-facing shape. No
+        #   internal identifiers are exposed.
+        #
+        #   @param full_name [String] Full name of the reference contact.
+        #
+        #   @param phone_e164 [String] Reference phone number in E.164 format.
+        #
+        #   @param record_type [Symbol, Telnyx::Models::Dir::Reference::RecordType] Always `dir_reference`.
+        #
+        #   @param ref_type [Symbol, Telnyx::Models::Dir::Reference::RefType] Whether this is a business reference or the financial reference.
+        #
+        #   @param slot [Integer] Position within the reference type. Business references occupy slots 0 and 1; th
+        #
+        #   @param timezone [String] IANA timezone id for the reference. Calls are only placed within the reference's
+        #
+        #   @param email [String, nil] Reference contact email address.
+        #
+        #   @param job_title [String, nil] Job title of the reference contact.
+        #
+        #   @param organization [String, nil] Organization the reference contact belongs to.
+        #
+        #   @param relationship_to_registrant [String, nil] How the reference contact is related to the registering business.
+
+        # Always `dir_reference`.
+        #
+        # @see Telnyx::Models::Dir::Reference#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          DIR_REFERENCE = :dir_reference
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Whether this is a business reference or the financial reference.
+        #
+        # @see Telnyx::Models::Dir::Reference#ref_type
+        module RefType
+          extend Telnyx::Internal::Type::Enum
+
+          BUSINESS = :business
+          FINANCIAL = :financial
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/reference_create_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      # @see Telnyx::Resources::Dir::References#create
+      class ReferenceCreateParams < 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 business_references
+        #   Exactly two business references.
+        #
+        #   @return [Array<Telnyx::Models::Dir::ReferenceInput>]
+        required :business_references, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Dir::ReferenceInput] }
+
+        # @!attribute financial_reference
+        #   One reference supplied at submit. The reference type is implied by the field
+        #   that carries it (business_references vs financial_reference).
+        #
+        #   @return [Telnyx::Models::Dir::ReferenceInput]
+        required :financial_reference, -> { Telnyx::Dir::ReferenceInput }
+
+        # @!method initialize(dir_id:, business_references:, financial_reference:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Dir::ReferenceCreateParams} for more details.
+        #
+        #   @param dir_id [String]
+        #
+        #   @param business_references [Array<Telnyx::Models::Dir::ReferenceInput>] Exactly two business references.
+        #
+        #   @param financial_reference [Telnyx::Models::Dir::ReferenceInput] One reference supplied at submit. The reference type is implied by the field tha
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/reference_input.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      class ReferenceInput < Telnyx::Internal::Type::BaseModel
+        # @!attribute email
+        #   Reference contact email address. Required: the reference is emailed scheduling
+        #   and dial-in notices.
+        #
+        #   @return [String]
+        required :email, String
+
+        # @!attribute full_name
+        #   Full name of the reference contact.
+        #
+        #   @return [String]
+        required :full_name, String
+
+        # @!attribute phone_e164
+        #   Reference phone number in E.164 format, e.g. +14155550123.
+        #
+        #   @return [String]
+        required :phone_e164, String
+
+        # @!attribute timezone
+        #   IANA timezone id for the reference (e.g. America/New_York). Required: calls are
+        #   only placed within the reference's local 8am-9pm window.
+        #
+        #   @return [String]
+        required :timezone, String
+
+        # @!attribute job_title
+        #   Job title of the reference contact.
+        #
+        #   @return [String, nil]
+        optional :job_title, String, nil?: true
+
+        # @!attribute organization
+        #   Organization the reference contact belongs to.
+        #
+        #   @return [String, nil]
+        optional :organization, String, nil?: true
+
+        # @!attribute relationship_to_registrant
+        #   How the reference contact is related to the registering business.
+        #
+        #   @return [String, nil]
+        optional :relationship_to_registrant, String, nil?: true
+
+        # @!method initialize(email:, full_name:, phone_e164:, timezone:, job_title: nil, organization: nil, relationship_to_registrant: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Dir::ReferenceInput} for more details.
+        #
+        #   One reference supplied at submit. The reference type is implied by the field
+        #   that carries it (business_references vs financial_reference).
+        #
+        #   @param email [String] Reference contact email address. Required: the reference is emailed scheduling a
+        #
+        #   @param full_name [String] Full name of the reference contact.
+        #
+        #   @param phone_e164 [String] Reference phone number in E.164 format, e.g. +14155550123.
+        #
+        #   @param timezone [String] IANA timezone id for the reference (e.g. America/New_York). Required: calls are
+        #
+        #   @param job_title [String, nil] Job title of the reference contact.
+        #
+        #   @param organization [String, nil] Organization the reference contact belongs to.
+        #
+        #   @param relationship_to_registrant [String, nil] How the reference contact is related to the registering business.
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/reference_list.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      # @see Telnyx::Resources::Dir::References#create
+      class ReferenceList < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Telnyx::Models::Dir::Reference>]
+        required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Dir::Reference] }
+
+        # @!method initialize(data:)
+        #   @param data [Array<Telnyx::Models::Dir::Reference>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/{phone_number_delete_all_params.rb → reference_list_params.rb}

@@ -3,8 +3,8 @@
 module Telnyx
   module Models
     module Dir
-      # @see Telnyx::Resources::Dir::PhoneNumbers#delete_all
-      class PhoneNumberDeleteAllParams < Telnyx::Internal::Type::BaseModel
+      # @see Telnyx::Resources::Dir::References#list
+      class ReferenceListParams < Telnyx::Internal::Type::BaseModel
         extend Telnyx::Internal::Type::RequestParameters::Converter
         include Telnyx::Internal::Type::RequestParameters
 
@@ -13,14 +13,8 @@ module Telnyx
         #   @return [String]
         required :dir_id, String
 
-        # @!attribute phone_numbers
-        #
-        #   @return [Array<String>]
-        required :phone_numbers, Telnyx::Internal::Type::ArrayOf[String]
-
-        # @!method initialize(dir_id:, phone_numbers:, request_options: {})
+        # @!method initialize(dir_id:, request_options: {})
         #   @param dir_id [String]
-        #   @param phone_numbers [Array<String>]
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/telnyx/models/dir/reference_update_params.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      # @see Telnyx::Resources::Dir::References#update
+      class ReferenceUpdateParams < 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 ref_type
+        #
+        #   @return [Symbol, Telnyx::Models::Dir::ReferenceUpdateParams::RefType]
+        required :ref_type, enum: -> { Telnyx::Dir::ReferenceUpdateParams::RefType }
+
+        # @!attribute slot
+        #
+        #   @return [Integer]
+        required :slot, Integer
+
+        # @!attribute email
+        #   Reference contact email address.
+        #
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute full_name
+        #   Full name of the reference contact.
+        #
+        #   @return [String, nil]
+        optional :full_name, String
+
+        # @!attribute job_title
+        #   Job title of the reference contact.
+        #
+        #   @return [String, nil]
+        optional :job_title, String, nil?: true
+
+        # @!attribute organization
+        #   Organization the reference contact belongs to.
+        #
+        #   @return [String, nil]
+        optional :organization, String, nil?: true
+
+        # @!attribute phone_e164
+        #   Reference phone number in E.164 format.
+        #
+        #   @return [String, nil]
+        optional :phone_e164, String
+
+        # @!attribute relationship_to_registrant
+        #   How the reference contact is related to the registering business.
+        #
+        #   @return [String, nil]
+        optional :relationship_to_registrant, String, nil?: true
+
+        # @!attribute timezone
+        #   IANA timezone id for the reference.
+        #
+        #   @return [String, nil]
+        optional :timezone, String
+
+        # @!method initialize(dir_id:, ref_type:, slot:, email: nil, full_name: nil, job_title: nil, organization: nil, phone_e164: nil, relationship_to_registrant: nil, timezone: nil, request_options: {})
+        #   @param dir_id [String]
+        #
+        #   @param ref_type [Symbol, Telnyx::Models::Dir::ReferenceUpdateParams::RefType]
+        #
+        #   @param slot [Integer]
+        #
+        #   @param email [String] Reference contact email address.
+        #
+        #   @param full_name [String] Full name of the reference contact.
+        #
+        #   @param job_title [String, nil] Job title of the reference contact.
+        #
+        #   @param organization [String, nil] Organization the reference contact belongs to.
+        #
+        #   @param phone_e164 [String] Reference phone number in E.164 format.
+        #
+        #   @param relationship_to_registrant [String, nil] How the reference contact is related to the registering business.
+        #
+        #   @param timezone [String] IANA timezone id for the reference.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        module RefType
+          extend Telnyx::Internal::Type::Enum
+
+          BUSINESS = :business
+          FINANCIAL = :financial
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/reference_update_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      # @see Telnyx::Resources::Dir::References#update
+      class ReferenceUpdateResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #   A reference (business or financial) on a DIR, in the customer-facing shape. No
+        #   internal identifiers are exposed.
+        #
+        #   @return [Telnyx::Models::Dir::Reference]
+        required :data, -> { Telnyx::Dir::Reference }
+
+        # @!method initialize(data:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Dir::ReferenceUpdateResponse} for more details.
+        #
+        #   @param data [Telnyx::Models::Dir::Reference] A reference (business or financial) on a DIR, in the customer-facing shape. No i
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/verify_email_confirm_params.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      # @see Telnyx::Resources::Dir::VerifyEmail#confirm
+      class VerifyEmailConfirmParams < 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 code
+        #   The 6-digit code sent to the authorizer email.
+        #
+        #   @return [String]
+        required :code, String
+
+        # @!method initialize(dir_id:, code:, request_options: {})
+        #   @param dir_id [String]
+        #
+        #   @param code [String] The 6-digit code sent to the authorizer email.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/verify_email_create_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      # @see Telnyx::Resources::Dir::VerifyEmail#create
+      class VerifyEmailCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute dir_id
+        #
+        #   @return [String]
+        required :dir_id, String
+
+        # @!method initialize(dir_id:, request_options: {})
+        #   @param dir_id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/verify_email_list_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      # @see Telnyx::Resources::Dir::VerifyEmail#list
+      class VerifyEmailListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute dir_id
+        #
+        #   @return [String]
+        required :dir_id, String
+
+        # @!method initialize(dir_id:, request_options: {})
+        #   @param dir_id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir_update_infringement_params.rb

@@ -55,7 +55,8 @@ module Telnyx
       optional :display_name, String, nil?: true
 
       # @!attribute documents
-      #   Append-only supporting documents.
+      #   Append-only supporting documents to attach while resolving the claim (e.g.
+      #   authorization or licensing proof).
       #
       #   @return [Array<Telnyx::Models::Document>, nil]
       optional :documents, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Document] }, nil?: true
@@ -67,6 +68,9 @@ module Telnyx
       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: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::DirUpdateInfringementParams} for more details.
+      #
       #   @param dir_id [String]
       #
       #   @param certify_brand_is_accurate [Boolean, Telnyx::Models::DirUpdateInfringementParams::CertifyBrandIsAccurate] Must be `true`.
@@ -83,7 +87,7 @@ module Telnyx
       #
       #   @param display_name [String, nil]
       #
-      #   @param documents [Array<Telnyx::Models::Document>, nil] Append-only supporting documents.
+      #   @param documents [Array<Telnyx::Models::Document>, nil] Append-only supporting documents to attach while resolving the claim (e.g. autho
       #
       #   @param logo_url [String, nil] Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).
       #

data/lib/telnyx/models/enterprises/dir_create_params.rb

@@ -27,6 +27,13 @@ module Telnyx
         #   @return [String]
         required :authorizer_name, String
 
+        # @!attribute call_reasons
+        #   1–10 reasons your business calls customers. Validate phrasing against
+        #   `POST /call_reasons/validate`.
+        #
+        #   @return [Array<String>]
+        required :call_reasons, Telnyx::Internal::Type::ArrayOf[String]
+
         # @!attribute certify_brand_is_accurate
         #   Must be `true`.
         #
@@ -54,13 +61,6 @@ module Telnyx
         #   @return [String]
         required :display_name, String
 
-        # @!attribute call_reasons
-        #   1–10 reasons your business calls customers. Validate phrasing against
-        #   `POST /call_reasons/validate`.
-        #
-        #   @return [Array<String>, nil]
-        optional :call_reasons, Telnyx::Internal::Type::ArrayOf[String]
-
         # @!attribute documents
         #   Supporting documents. Each `document_id` may appear at most once on a DIR.
         #
@@ -80,7 +80,7 @@ module Telnyx
         #   @return [Boolean, nil]
         optional :reselling, Telnyx::Internal::Type::Boolean
 
-        # @!method initialize(enterprise_id:, authorizer_email:, authorizer_name:, certify_brand_is_accurate:, certify_ip_ownership:, certify_no_shaft_content:, display_name:, call_reasons: nil, documents: nil, logo_url: nil, reselling: nil, request_options: {})
+        # @!method initialize(enterprise_id:, authorizer_email:, authorizer_name:, call_reasons:, certify_brand_is_accurate:, certify_ip_ownership:, certify_no_shaft_content:, display_name:, documents: nil, logo_url: nil, reselling: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::Enterprises::DirCreateParams} for more details.
         #
@@ -90,6 +90,8 @@ module Telnyx
         #
         #   @param authorizer_name [String] Name of the person at your enterprise who is authorizing this DIR registration.
         #
+        #   @param call_reasons [Array<String>] 1–10 reasons your business calls customers. Validate phrasing against `POST /cal
+        #
         #   @param certify_brand_is_accurate [Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyBrandIsAccurate] Must be `true`.
         #
         #   @param certify_ip_ownership [Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyIPOwnership] Must be `true`. Confirms ownership of any logos/trademarks shown.
@@ -98,8 +100,6 @@ module Telnyx
         #
         #   @param display_name [String] Name shown to call recipients. No emoji; not whitespace-only.
         #
-        #   @param call_reasons [Array<String>] 1–10 reasons your business calls customers. Validate phrasing against `POST /cal
-        #
         #   @param documents [Array<Telnyx::Models::Document>] Supporting documents. Each `document_id` may appear at most once on a DIR.
         #
         #   @param logo_url [String] Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).

data/lib/telnyx/models/public_internet_gateway.rb

@@ -3,7 +3,30 @@
 module Telnyx
   module Models
     class PublicInternetGateway < Telnyx::Models::Record
-      # @!method initialize
+      # @!attribute name
+      #   A user specified name for the interface.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute network_id
+      #   The id of the network associated with the interface.
+      #
+      #   @return [String, nil]
+      optional :network_id, String
+
+      # @!attribute region_code
+      #   The region interface is deployed to.
+      #
+      #   @return [String, nil]
+      optional :region_code, String
+
+      # @!method initialize(name: nil, network_id: nil, region_code: nil)
+      #   @param name [String] A user specified name for the interface.
+      #
+      #   @param network_id [String] The id of the network associated with the interface.
+      #
+      #   @param region_code [String] The region interface is deployed to.
     end
   end
 end

data/lib/telnyx/models/storage/kv_create_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Storage
+      # @see Telnyx::Resources::Storage::Kvs#create
+      class KvCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute name
+        #   Namespace name. May contain lowercase letters, numbers, and hyphens only.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(name:, request_options: {})
+        #   @param name [String] Namespace name. May contain lowercase letters, numbers, and hyphens only.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/storage/kv_delete_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Storage
+      # @see Telnyx::Resources::Storage::Kvs#delete
+      class KvDeleteParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end