telnyx 5.159.0 → 5.160.0

data/lib/telnyx/models/rcs/brand_create_params.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @see Telnyx::Resources::Rcs::Brands#create
+      class BrandCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute addresses
+        #
+        #   @return [Hash{Symbol=>Telnyx::Models::Rcs::BrandCreateParams::Address}]
+        required :addresses, -> { Telnyx::Internal::Type::HashOf[Telnyx::Rcs::BrandCreateParams::Address] }
+
+        # @!attribute contacts
+        #   Named business contacts. Use the `brand` key for the required BRAND contact.
+        #
+        #   @return [Telnyx::Models::Rcs::BrandCreateParams::Contacts]
+        required :contacts, -> { Telnyx::Rcs::BrandCreateParams::Contacts }
+
+        # @!attribute display_name
+        #
+        #   @return [String]
+        required :display_name, String
+
+        # @!attribute identifiers
+        #   Named business identifiers. Use the `ein` key for the required EIN and
+        #   `stock_symbol` for a public-profit brand's stock symbol.
+        #
+        #   @return [Telnyx::Models::Rcs::BrandCreateParams::Identifiers]
+        required :identifiers, -> { Telnyx::Rcs::BrandCreateParams::Identifiers }
+
+        # @!attribute legal_entity_type
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::BrandLegalEntityType]
+        required :legal_entity_type, enum: -> { Telnyx::Rcs::BrandLegalEntityType }
+
+        # @!attribute legal_name
+        #
+        #   @return [String]
+        required :legal_name, String
+
+        # @!attribute organization_type
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::BrandOrganizationType]
+        required :organization_type, enum: -> { Telnyx::Rcs::BrandOrganizationType }
+
+        # @!attribute website_url
+        #
+        #   @return [String]
+        required :website_url, String
+
+        # @!attribute profile_id
+        #   A Messaging Profile owned by the authenticated organization. Agents inherit this
+        #   value when they do not provide their own profile.
+        #
+        #   @return [String, nil]
+        optional :profile_id, String, nil?: true
+
+        # @!method initialize(addresses:, contacts:, display_name:, identifiers:, legal_entity_type:, legal_name:, organization_type:, website_url:, profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Rcs::BrandCreateParams} for more details.
+        #
+        #   @param addresses [Hash{Symbol=>Telnyx::Models::Rcs::BrandCreateParams::Address}]
+        #
+        #   @param contacts [Telnyx::Models::Rcs::BrandCreateParams::Contacts] Named business contacts. Use the `brand` key for the required BRAND contact.
+        #
+        #   @param display_name [String]
+        #
+        #   @param identifiers [Telnyx::Models::Rcs::BrandCreateParams::Identifiers] Named business identifiers. Use the `ein` key for the required EIN and `stock_sy
+        #
+        #   @param legal_entity_type [Symbol, Telnyx::Models::Rcs::BrandLegalEntityType]
+        #
+        #   @param legal_name [String]
+        #
+        #   @param organization_type [Symbol, Telnyx::Models::Rcs::BrandOrganizationType]
+        #
+        #   @param website_url [String]
+        #
+        #   @param profile_id [String, nil] A Messaging Profile owned by the authenticated organization. Agents inherit this
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        class Address < Telnyx::Internal::Type::BaseModel
+          # @!attribute administrative_area
+          #
+          #   @return [String]
+          required :administrative_area, String
+
+          # @!attribute city
+          #
+          #   @return [String]
+          required :city, String
+
+          # @!attribute country_code
+          #   The two-letter ISO 3166-1 country code.
+          #
+          #   @return [String]
+          required :country_code, String
+
+          # @!attribute line_1
+          #
+          #   @return [String]
+          required :line_1, String
+
+          # @!attribute postal_code
+          #
+          #   @return [String]
+          required :postal_code, String
+
+          # @!attribute line_2
+          #
+          #   @return [String, nil]
+          optional :line_2, String, nil?: true
+
+          # @!method initialize(administrative_area:, city:, country_code:, line_1:, postal_code:, line_2: nil)
+          #   @param administrative_area [String]
+          #
+          #   @param city [String]
+          #
+          #   @param country_code [String] The two-letter ISO 3166-1 country code.
+          #
+          #   @param line_1 [String]
+          #
+          #   @param postal_code [String]
+          #
+          #   @param line_2 [String, nil]
+        end
+
+        class Contacts < Telnyx::Internal::Type::BaseModel
+          # @!attribute brand
+          #
+          #   @return [Telnyx::Models::Rcs::BrandCreateParams::Contacts::Brand]
+          required :brand, -> { Telnyx::Rcs::BrandCreateParams::Contacts::Brand }
+
+          # @!method initialize(brand:)
+          #   Named business contacts. Use the `brand` key for the required BRAND contact.
+          #
+          #   @param brand [Telnyx::Models::Rcs::BrandCreateParams::Contacts::Brand]
+
+          # @see Telnyx::Models::Rcs::BrandCreateParams::Contacts#brand
+          class Brand < Telnyx::Models::Rcs::BrandContact
+            # @!attribute contact_type
+            #
+            #   @return [Symbol, Telnyx::Models::Rcs::BrandCreateParams::Contacts::Brand::ContactType, nil]
+            optional :contact_type, enum: -> { Telnyx::Rcs::BrandCreateParams::Contacts::Brand::ContactType }
+
+            # @!method initialize(contact_type: nil)
+            #   @param contact_type [Symbol, Telnyx::Models::Rcs::BrandCreateParams::Contacts::Brand::ContactType]
+
+            module ContactType
+              extend Telnyx::Internal::Type::Enum
+
+              BRAND = :BRAND
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+
+        class Identifiers < Telnyx::Internal::Type::BaseModel
+          # @!attribute ein
+          #
+          #   @return [Telnyx::Models::Rcs::EinBrandIdentifier]
+          required :ein, -> { Telnyx::Rcs::EinBrandIdentifier }
+
+          # @!attribute stock_symbol
+          #
+          #   @return [Telnyx::Models::Rcs::StockSymbolBrandIdentifier, nil]
+          optional :stock_symbol, -> { Telnyx::Rcs::StockSymbolBrandIdentifier }
+
+          # @!method initialize(ein:, stock_symbol: nil)
+          #   Named business identifiers. Use the `ein` key for the required EIN and
+          #   `stock_symbol` for a public-profit brand's stock symbol.
+          #
+          #   @param ein [Telnyx::Models::Rcs::EinBrandIdentifier]
+          #   @param stock_symbol [Telnyx::Models::Rcs::StockSymbolBrandIdentifier]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/brand_legal_entity_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      module BrandLegalEntityType
+        extend Telnyx::Internal::Type::Enum
+
+        LIMITED_LIABILITY_COMPANY = :LIMITED_LIABILITY_COMPANY
+        SOLE_PROPRIETORSHIP = :SOLE_PROPRIETORSHIP
+        PARTNERSHIP = :PARTNERSHIP
+        CORPORATION = :CORPORATION
+        S_CORPORATION = :S_CORPORATION
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/brand_list_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @see Telnyx::Resources::Rcs::Brands#list
+      class BrandListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/brand_list_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @type [Telnyx::Internal::Type::Converter]
+      BrandListResponse = Telnyx::Internal::Type::ArrayOf[-> { Telnyx::Rcs::BrandResponse }]
+    end
+  end
+end

data/lib/telnyx/models/rcs/brand_organization_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      module BrandOrganizationType
+        extend Telnyx::Internal::Type::Enum
+
+        PRIVATE_PROFIT = :PRIVATE_PROFIT
+        PUBLIC_PROFIT = :PUBLIC_PROFIT
+        NON_PROFIT = :NON_PROFIT
+        GOVERNMENT = :GOVERNMENT
+        UNKNOWN = :UNKNOWN
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/brand_response.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @see Telnyx::Resources::Rcs::Brands#create
+      class BrandResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute addresses
+        #
+        #   @return [Hash{Symbol=>Telnyx::Models::Rcs::BrandResponse::Address}]
+        required :addresses, -> { Telnyx::Internal::Type::HashOf[Telnyx::Rcs::BrandResponse::Address] }
+
+        # @!attribute brand_id
+        #
+        #   @return [String]
+        required :brand_id, String
+
+        # @!attribute capabilities
+        #
+        #   @return [Telnyx::Models::Rcs::CapabilitiesResponse]
+        required :capabilities, -> { Telnyx::Rcs::CapabilitiesResponse }
+
+        # @!attribute contacts
+        #
+        #   @return [Hash{Symbol=>Telnyx::Models::Rcs::BrandContact}]
+        required :contacts, -> { Telnyx::Internal::Type::HashOf[Telnyx::Rcs::BrandContact] }
+
+        # @!attribute display_name
+        #
+        #   @return [String]
+        required :display_name, String
+
+        # @!attribute identifiers
+        #
+        #   @return [Hash{Symbol=>Telnyx::Models::Rcs::EinBrandIdentifier, Telnyx::Models::Rcs::StockSymbolBrandIdentifier}]
+        required :identifiers,
+                 -> { Telnyx::Internal::Type::HashOf[union: Telnyx::Rcs::BrandResponse::Identifier] }
+
+        # @!attribute legal_entity_type
+        #
+        #   @return [String]
+        required :legal_entity_type, String
+
+        # @!attribute legal_name
+        #
+        #   @return [String]
+        required :legal_name, String
+
+        # @!attribute organization_type
+        #
+        #   @return [String]
+        required :organization_type, String
+
+        # @!attribute profile_id
+        #
+        #   @return [String, nil]
+        required :profile_id, String, nil?: true
+
+        # @!attribute status
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::BrandResponse::Status]
+        required :status, enum: -> { Telnyx::Rcs::BrandResponse::Status }
+
+        # @!attribute website_url
+        #
+        #   @return [String]
+        required :website_url, String
+
+        # @!method initialize(addresses:, brand_id:, capabilities:, contacts:, display_name:, identifiers:, legal_entity_type:, legal_name:, organization_type:, profile_id:, status:, website_url:)
+        #   @param addresses [Hash{Symbol=>Telnyx::Models::Rcs::BrandResponse::Address}]
+        #   @param brand_id [String]
+        #   @param capabilities [Telnyx::Models::Rcs::CapabilitiesResponse]
+        #   @param contacts [Hash{Symbol=>Telnyx::Models::Rcs::BrandContact}]
+        #   @param display_name [String]
+        #   @param identifiers [Hash{Symbol=>Telnyx::Models::Rcs::EinBrandIdentifier, Telnyx::Models::Rcs::StockSymbolBrandIdentifier}]
+        #   @param legal_entity_type [String]
+        #   @param legal_name [String]
+        #   @param organization_type [String]
+        #   @param profile_id [String, nil]
+        #   @param status [Symbol, Telnyx::Models::Rcs::BrandResponse::Status]
+        #   @param website_url [String]
+
+        class Address < Telnyx::Internal::Type::BaseModel
+          # @!attribute administrative_area
+          #
+          #   @return [String]
+          required :administrative_area, String
+
+          # @!attribute city
+          #
+          #   @return [String]
+          required :city, String
+
+          # @!attribute country_code
+          #   The two-letter ISO 3166-1 country code.
+          #
+          #   @return [String]
+          required :country_code, String
+
+          # @!attribute line_1
+          #
+          #   @return [String]
+          required :line_1, String
+
+          # @!attribute postal_code
+          #
+          #   @return [String]
+          required :postal_code, String
+
+          # @!attribute line_2
+          #
+          #   @return [String, nil]
+          optional :line_2, String, nil?: true
+
+          # @!method initialize(administrative_area:, city:, country_code:, line_1:, postal_code:, line_2: nil)
+          #   @param administrative_area [String]
+          #
+          #   @param city [String]
+          #
+          #   @param country_code [String] The two-letter ISO 3166-1 country code.
+          #
+          #   @param line_1 [String]
+          #
+          #   @param postal_code [String]
+          #
+          #   @param line_2 [String, nil]
+        end
+
+        module Identifier
+          extend Telnyx::Internal::Type::Union
+
+          variant -> { Telnyx::Rcs::EinBrandIdentifier }
+
+          variant -> { Telnyx::Rcs::StockSymbolBrandIdentifier }
+
+          # @!method self.variants
+          #   @return [Array(Telnyx::Models::Rcs::EinBrandIdentifier, Telnyx::Models::Rcs::StockSymbolBrandIdentifier)]
+        end
+
+        # @see Telnyx::Models::Rcs::BrandResponse#status
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          CREATED = :CREATED
+          CONFIGURED = :CONFIGURED
+          SUBMITTED = :SUBMITTED
+          REVIEWING = :REVIEWING
+          VETTING = :VETTING
+          VERIFIED = :VERIFIED
+          REJECTED = :REJECTED
+          FAILED = :FAILED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/brand_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @see Telnyx::Resources::Rcs::Brands#retrieve
+      class BrandRetrieveParams < 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

data/lib/telnyx/models/rcs/brand_submit_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @see Telnyx::Resources::Rcs::Brands#submit
+      class BrandSubmitParams < 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

data/lib/telnyx/models/rcs/brand_update_params.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @see Telnyx::Resources::Rcs::Brands#update
+      class BrandUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute addresses
+        #
+        #   @return [Hash{Symbol=>Telnyx::Models::Rcs::BrandUpdateParams::Address}, nil]
+        optional :addresses, -> { Telnyx::Internal::Type::HashOf[Telnyx::Rcs::BrandUpdateParams::Address] }
+
+        # @!attribute contacts
+        #   Named business contacts. Use the `brand` key for the required BRAND contact.
+        #
+        #   @return [Telnyx::Models::Rcs::BrandUpdateParams::Contacts, nil]
+        optional :contacts, -> { Telnyx::Rcs::BrandUpdateParams::Contacts }
+
+        # @!attribute display_name
+        #
+        #   @return [String, nil]
+        optional :display_name, String
+
+        # @!attribute identifiers
+        #   Named business identifiers. Use the `ein` key for the required EIN and
+        #   `stock_symbol` for a public-profit brand's stock symbol.
+        #
+        #   @return [Telnyx::Models::Rcs::BrandUpdateParams::Identifiers, nil]
+        optional :identifiers, -> { Telnyx::Rcs::BrandUpdateParams::Identifiers }
+
+        # @!attribute legal_entity_type
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::BrandLegalEntityType, nil]
+        optional :legal_entity_type, enum: -> { Telnyx::Rcs::BrandLegalEntityType }
+
+        # @!attribute legal_name
+        #
+        #   @return [String, nil]
+        optional :legal_name, String
+
+        # @!attribute organization_type
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::BrandOrganizationType, nil]
+        optional :organization_type, enum: -> { Telnyx::Rcs::BrandOrganizationType }
+
+        # @!attribute profile_id
+        #
+        #   @return [String, nil]
+        optional :profile_id, String
+
+        # @!attribute website_url
+        #
+        #   @return [String, nil]
+        optional :website_url, String
+
+        # @!method initialize(id:, addresses: nil, contacts: nil, display_name: nil, identifiers: nil, legal_entity_type: nil, legal_name: nil, organization_type: nil, profile_id: nil, website_url: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Rcs::BrandUpdateParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param addresses [Hash{Symbol=>Telnyx::Models::Rcs::BrandUpdateParams::Address}]
+        #
+        #   @param contacts [Telnyx::Models::Rcs::BrandUpdateParams::Contacts] Named business contacts. Use the `brand` key for the required BRAND contact.
+        #
+        #   @param display_name [String]
+        #
+        #   @param identifiers [Telnyx::Models::Rcs::BrandUpdateParams::Identifiers] Named business identifiers. Use the `ein` key for the required EIN and `stock_sy
+        #
+        #   @param legal_entity_type [Symbol, Telnyx::Models::Rcs::BrandLegalEntityType]
+        #
+        #   @param legal_name [String]
+        #
+        #   @param organization_type [Symbol, Telnyx::Models::Rcs::BrandOrganizationType]
+        #
+        #   @param profile_id [String]
+        #
+        #   @param website_url [String]
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        class Address < Telnyx::Internal::Type::BaseModel
+          # @!attribute administrative_area
+          #
+          #   @return [String]
+          required :administrative_area, String
+
+          # @!attribute city
+          #
+          #   @return [String]
+          required :city, String
+
+          # @!attribute country_code
+          #   The two-letter ISO 3166-1 country code.
+          #
+          #   @return [String]
+          required :country_code, String
+
+          # @!attribute line_1
+          #
+          #   @return [String]
+          required :line_1, String
+
+          # @!attribute postal_code
+          #
+          #   @return [String]
+          required :postal_code, String
+
+          # @!attribute line_2
+          #
+          #   @return [String, nil]
+          optional :line_2, String, nil?: true
+
+          # @!method initialize(administrative_area:, city:, country_code:, line_1:, postal_code:, line_2: nil)
+          #   @param administrative_area [String]
+          #
+          #   @param city [String]
+          #
+          #   @param country_code [String] The two-letter ISO 3166-1 country code.
+          #
+          #   @param line_1 [String]
+          #
+          #   @param postal_code [String]
+          #
+          #   @param line_2 [String, nil]
+        end
+
+        class Contacts < Telnyx::Internal::Type::BaseModel
+          # @!attribute brand
+          #
+          #   @return [Telnyx::Models::Rcs::BrandUpdateParams::Contacts::Brand]
+          required :brand, -> { Telnyx::Rcs::BrandUpdateParams::Contacts::Brand }
+
+          # @!method initialize(brand:)
+          #   Named business contacts. Use the `brand` key for the required BRAND contact.
+          #
+          #   @param brand [Telnyx::Models::Rcs::BrandUpdateParams::Contacts::Brand]
+
+          # @see Telnyx::Models::Rcs::BrandUpdateParams::Contacts#brand
+          class Brand < Telnyx::Models::Rcs::BrandContact
+            # @!attribute contact_type
+            #
+            #   @return [Symbol, Telnyx::Models::Rcs::BrandUpdateParams::Contacts::Brand::ContactType, nil]
+            optional :contact_type, enum: -> { Telnyx::Rcs::BrandUpdateParams::Contacts::Brand::ContactType }
+
+            # @!method initialize(contact_type: nil)
+            #   @param contact_type [Symbol, Telnyx::Models::Rcs::BrandUpdateParams::Contacts::Brand::ContactType]
+
+            module ContactType
+              extend Telnyx::Internal::Type::Enum
+
+              BRAND = :BRAND
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+
+        class Identifiers < Telnyx::Internal::Type::BaseModel
+          # @!attribute ein
+          #
+          #   @return [Telnyx::Models::Rcs::EinBrandIdentifier]
+          required :ein, -> { Telnyx::Rcs::EinBrandIdentifier }
+
+          # @!attribute stock_symbol
+          #
+          #   @return [Telnyx::Models::Rcs::StockSymbolBrandIdentifier, nil]
+          optional :stock_symbol, -> { Telnyx::Rcs::StockSymbolBrandIdentifier }
+
+          # @!method initialize(ein:, stock_symbol: nil)
+          #   Named business identifiers. Use the `ein` key for the required EIN and
+          #   `stock_symbol` for a public-profit brand's stock symbol.
+          #
+          #   @param ein [Telnyx::Models::Rcs::EinBrandIdentifier]
+          #   @param stock_symbol [Telnyx::Models::Rcs::StockSymbolBrandIdentifier]
+        end
+      end
+    end
+  end
+end