telnyx 5.126.0 → 5.128.0

data/lib/telnyx/models/dir_update_infringement_response.rb

@@ -0,0 +1,335 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::Dir#update_infringement
+    class DirUpdateInfringementResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::DirUpdateInfringementResponse::Data]
+      required :data, -> { Telnyx::Models::DirUpdateInfringementResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [Telnyx::Models::DirUpdateInfringementResponse::Data]
+
+      # @see Telnyx::Models::DirUpdateInfringementResponse#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute authorizer_email
+        #
+        #   @return [String, nil]
+        optional :authorizer_email, String, nil?: true
+
+        # @!attribute authorizer_name
+        #
+        #   @return [String, nil]
+        optional :authorizer_name, String, nil?: true
+
+        # @!attribute call_reasons
+        #
+        #   @return [Array<Telnyx::Models::DirUpdateInfringementResponse::Data::CallReason>, nil]
+        optional :call_reasons,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::DirUpdateInfringementResponse::Data::CallReason] }
+
+        # @!attribute certify_brand_is_accurate
+        #
+        #   @return [Boolean, nil]
+        optional :certify_brand_is_accurate, Telnyx::Internal::Type::Boolean
+
+        # @!attribute certify_ip_ownership
+        #
+        #   @return [Boolean, nil]
+        optional :certify_ip_ownership, Telnyx::Internal::Type::Boolean
+
+        # @!attribute certify_no_shaft_content
+        #
+        #   @return [Boolean, nil]
+        optional :certify_no_shaft_content, Telnyx::Internal::Type::Boolean
+
+        # @!attribute display_name
+        #
+        #   @return [String, nil]
+        optional :display_name, String
+
+        # @!attribute documents
+        #
+        #   @return [Array<Telnyx::Models::DirUpdateInfringementResponse::Data::Document>, nil]
+        optional :documents,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::DirUpdateInfringementResponse::Data::Document] },
+                 nil?: true
+
+        # @!attribute enterprise_id
+        #
+        #   @return [String, nil]
+        optional :enterprise_id, String
+
+        # @!attribute logo_url
+        #
+        #   @return [String, nil]
+        optional :logo_url, String, nil?: true
+
+        # @!attribute rejection_reasons
+        #   Populated when `status` is `rejected`; cleared on `/submit` or successful
+        #   approval.
+        #
+        #   @return [Array<Telnyx::Models::DirUpdateInfringementResponse::Data::RejectionReason>, nil]
+        optional :rejection_reasons,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::DirUpdateInfringementResponse::Data::RejectionReason] },
+                 nil?: true
+
+        # @!attribute reselling
+        #
+        #   @return [Boolean, nil]
+        optional :reselling, Telnyx::Internal::Type::Boolean
+
+        # @!attribute status
+        #   DIR lifecycle status.
+        #
+        #   - `draft` - newly created; editable; not yet submitted.
+        #   - `submitted` / `in_review` - Telnyx is reviewing.
+        #   - `verified` - approved; phone numbers may be attached.
+        #   - `rejected` - Telnyx rejected this submission; `rejection_reasons` is
+        #     populated; customer can edit and resubmit.
+        #   - `unsuccessful` - system-side error during processing; customer can edit and
+        #     resubmit.
+        #   - `suspended` - temporarily disabled (e.g. by an active infringement claim).
+        #   - `expired` - verification expired; customer must resubmit.
+        #   - `infringement_claimed` - a trademark/impersonation claim is open against this
+        #     DIR.
+        #   - `permanently_rejected` - terminal; cannot be resubmitted.
+        #
+        #   @return [Symbol, Telnyx::Models::DirUpdateInfringementResponse::Data::Status, nil]
+        optional :status, enum: -> { Telnyx::Models::DirUpdateInfringementResponse::Data::Status }
+
+        response_only do
+          # @!attribute id
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute created_at
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute expiring_at
+          #
+          #   @return [Time, nil]
+          optional :expiring_at, Time, nil?: true
+
+          # @!attribute rejected_at
+          #
+          #   @return [Time, nil]
+          optional :rejected_at, Time, nil?: true
+
+          # @!attribute submitted_at
+          #
+          #   @return [Time, nil]
+          optional :submitted_at, Time, nil?: true
+
+          # @!attribute updated_at
+          #
+          #   @return [Time, nil]
+          optional :updated_at, Time
+
+          # @!attribute verified_at
+          #
+          #   @return [Time, nil]
+          optional :verified_at, Time, nil?: true
+        end
+
+        # @!method initialize(id: nil, authorizer_email: nil, authorizer_name: nil, call_reasons: nil, certify_brand_is_accurate: nil, certify_ip_ownership: nil, certify_no_shaft_content: nil, created_at: nil, display_name: nil, documents: nil, enterprise_id: nil, expiring_at: nil, logo_url: nil, rejected_at: nil, rejection_reasons: nil, reselling: nil, status: nil, submitted_at: nil, updated_at: nil, verified_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::DirUpdateInfringementResponse::Data} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param authorizer_email [String, nil]
+        #
+        #   @param authorizer_name [String, nil]
+        #
+        #   @param call_reasons [Array<Telnyx::Models::DirUpdateInfringementResponse::Data::CallReason>]
+        #
+        #   @param certify_brand_is_accurate [Boolean]
+        #
+        #   @param certify_ip_ownership [Boolean]
+        #
+        #   @param certify_no_shaft_content [Boolean]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param display_name [String]
+        #
+        #   @param documents [Array<Telnyx::Models::DirUpdateInfringementResponse::Data::Document>, nil]
+        #
+        #   @param enterprise_id [String]
+        #
+        #   @param expiring_at [Time, nil]
+        #
+        #   @param logo_url [String, nil]
+        #
+        #   @param rejected_at [Time, nil]
+        #
+        #   @param rejection_reasons [Array<Telnyx::Models::DirUpdateInfringementResponse::Data::RejectionReason>, nil] Populated when `status` is `rejected`; cleared on `/submit` or successful approv
+        #
+        #   @param reselling [Boolean]
+        #
+        #   @param status [Symbol, Telnyx::Models::DirUpdateInfringementResponse::Data::Status] DIR lifecycle status.
+        #
+        #   @param submitted_at [Time, nil]
+        #
+        #   @param updated_at [Time]
+        #
+        #   @param verified_at [Time, nil]
+
+        class CallReason < Telnyx::Internal::Type::BaseModel
+          # @!attribute reason
+          #
+          #   @return [String, nil]
+          optional :reason, String
+
+          response_only do
+            # @!attribute created_at
+            #
+            #   @return [Time, nil]
+            optional :created_at, Time
+          end
+
+          # @!method initialize(created_at: nil, reason: nil)
+          #   @param created_at [Time]
+          #   @param reason [String]
+        end
+
+        class Document < Telnyx::Internal::Type::BaseModel
+          # @!attribute document_id
+          #   Id returned by the Telnyx Documents API after you upload the file (upload via
+          #   `POST /v2/documents`; see https://developers.telnyx.com/api/documents).
+          #
+          #   @return [String]
+          required :document_id, String
+
+          # @!attribute document_type
+          #   Type of supporting document. Pick the closest match to what the file actually
+          #   contains; `other` triggers manual vetting and may slow approval. The matching
+          #   short_name reference list is at `GET /v2/dir/document_types`.
+          #
+          #   @return [Symbol, Telnyx::Models::DirUpdateInfringementResponse::Data::Document::DocumentType]
+          required :document_type,
+                   enum: -> { Telnyx::Models::DirUpdateInfringementResponse::Data::Document::DocumentType }
+
+          # @!attribute description
+          #
+          #   @return [String, nil]
+          optional :description, String
+
+          # @!method initialize(document_id:, document_type:, description: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::DirUpdateInfringementResponse::Data::Document} for more
+          #   details.
+          #
+          #   @param document_id [String] Id returned by the Telnyx Documents API after you upload the file (upload via `P
+          #
+          #   @param document_type [Symbol, Telnyx::Models::DirUpdateInfringementResponse::Data::Document::DocumentType] Type of supporting document. Pick the closest match to what the file actually co
+          #
+          #   @param description [String]
+
+          # Type of supporting document. Pick the closest match to what the file actually
+          # contains; `other` triggers manual vetting and may slow approval. The matching
+          # short_name reference list is at `GET /v2/dir/document_types`.
+          #
+          # @see Telnyx::Models::DirUpdateInfringementResponse::Data::Document#document_type
+          module DocumentType
+            extend Telnyx::Internal::Type::Enum
+
+            LETTER_OF_AUTHORIZATION = :letter_of_authorization
+            BUSINESS_REGISTRATION = :business_registration
+            ARTICLES_OF_INCORPORATION = :articles_of_incorporation
+            TAX_DOCUMENT = :tax_document
+            EIN_LETTER = :ein_letter
+            TRADEMARK_REGISTRATION = :trademark_registration
+            WEBSITE_OWNERSHIP = :website_ownership
+            BUSINESS_LICENSE = :business_license
+            PROFESSIONAL_LICENSE = :professional_license
+            GOVERNMENT_ID = :government_id
+            UTILITY_BILL = :utility_bill
+            BANK_STATEMENT = :bank_statement
+            OTHER = :other
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class RejectionReason < Telnyx::Internal::Type::BaseModel
+          # @!attribute code
+          #
+          #   @return [String, nil]
+          optional :code, String
+
+          # @!attribute detail
+          #
+          #   @return [String, nil]
+          optional :detail, String
+
+          # @!attribute message
+          #   Customer-visible free-text comment from the Telnyx vetting team. Only the first
+          #   entry of `rejection_reasons` carries this; the rest are `null`.
+          #
+          #   @return [String, nil]
+          optional :message, String, nil?: true
+
+          # @!attribute title
+          #
+          #   @return [String, nil]
+          optional :title, String
+
+          # @!method initialize(code: nil, detail: nil, message: nil, title: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::DirUpdateInfringementResponse::Data::RejectionReason} for more
+          #   details.
+          #
+          #   @param code [String]
+          #
+          #   @param detail [String]
+          #
+          #   @param message [String, nil] Customer-visible free-text comment from the Telnyx vetting team. Only the first
+          #
+          #   @param title [String]
+        end
+
+        # DIR lifecycle status.
+        #
+        # - `draft` - newly created; editable; not yet submitted.
+        # - `submitted` / `in_review` - Telnyx is reviewing.
+        # - `verified` - approved; phone numbers may be attached.
+        # - `rejected` - Telnyx rejected this submission; `rejection_reasons` is
+        #   populated; customer can edit and resubmit.
+        # - `unsuccessful` - system-side error during processing; customer can edit and
+        #   resubmit.
+        # - `suspended` - temporarily disabled (e.g. by an active infringement claim).
+        # - `expired` - verification expired; customer must resubmit.
+        # - `infringement_claimed` - a trademark/impersonation claim is open against this
+        #   DIR.
+        # - `permanently_rejected` - terminal; cannot be resubmitted.
+        #
+        # @see Telnyx::Models::DirUpdateInfringementResponse::Data#status
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          DRAFT = :draft
+          SUBMITTED = :submitted
+          IN_REVIEW = :in_review
+          VERIFIED = :verified
+          REJECTED = :rejected
+          UNSUCCESSFUL = :unsuccessful
+          SUSPENDED = :suspended
+          EXPIRED = :expired
+          INFRINGEMENT_CLAIMED = :infringement_claimed
+          PERMANENTLY_REJECTED = :permanently_rejected
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir_update_params.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::Dir#update
+    class DirUpdateParams < 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 authorizer_email
+      #   Contact email of the authorizer. Telnyx may send verification or infringement
+      #   notices here.
+      #
+      #   @return [String, nil]
+      optional :authorizer_email, String
+
+      # @!attribute authorizer_name
+      #   Name of the person at your enterprise authorizing this DIR. Must be a real
+      #   individual.
+      #
+      #   @return [String, nil]
+      optional :authorizer_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 certify_brand_is_accurate
+      #   Certification that the DIR information is accurate. Must be `true` for the DIR
+      #   to be submitted for vetting.
+      #
+      #   @return [Boolean, nil]
+      optional :certify_brand_is_accurate, Telnyx::Internal::Type::Boolean
+
+      # @!attribute certify_ip_ownership
+      #   Certification of ownership of any logos/trademarks shown. Must be `true` for the
+      #   DIR to be submitted for vetting.
+      #
+      #   @return [Boolean, nil]
+      optional :certify_ip_ownership, Telnyx::Internal::Type::Boolean
+
+      # @!attribute certify_no_shaft_content
+      #   Certification that this DIR is not used for SHAFT content (Sex, Hate, Alcohol,
+      #   Firearms, Tobacco) where prohibited. Must be `true` for the DIR to be submitted
+      #   for vetting.
+      #
+      #   @return [Boolean, nil]
+      optional :certify_no_shaft_content, Telnyx::Internal::Type::Boolean
+
+      # @!attribute display_name
+      #   Name shown to call recipients. 1–35 characters, no emoji, not whitespace-only.
+      #
+      #   @return [String, nil]
+      optional :display_name, String
+
+      # @!attribute documents
+      #   Additional supporting documents to attach. Append-only: existing documents are
+      #   never removed or replaced, and an empty or omitted list is a no-op. Each
+      #   `document_id` may appear at most once on a DIR.
+      #
+      #   @return [Array<Telnyx::Models::DirUpdateParams::Document>, nil]
+      optional :documents, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::DirUpdateParams::Document] }
+
+      # @!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
+
+      # @!attribute reselling
+      #   Set to true if your organization places calls on behalf of other enterprises
+      #   (BPO/reseller). Updating this triggers re-vetting on next submit.
+      #
+      #   @return [Boolean, nil]
+      optional :reselling, Telnyx::Internal::Type::Boolean
+
+      # @!method initialize(dir_id:, authorizer_email: nil, authorizer_name: nil, call_reasons: nil, certify_brand_is_accurate: nil, certify_ip_ownership: nil, certify_no_shaft_content: nil, display_name: nil, documents: nil, logo_url: nil, reselling: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::DirUpdateParams} for more details.
+      #
+      #   @param dir_id [String]
+      #
+      #   @param authorizer_email [String] Contact email of the authorizer. Telnyx may send verification or infringement no
+      #
+      #   @param authorizer_name [String] Name of the person at your enterprise authorizing this DIR. Must be a real indiv
+      #
+      #   @param call_reasons [Array<String>] 1–10 reasons your business calls customers. Validate phrasing against `POST /cal
+      #
+      #   @param certify_brand_is_accurate [Boolean] Certification that the DIR information is accurate. Must be `true` for the DIR t
+      #
+      #   @param certify_ip_ownership [Boolean] Certification of ownership of any logos/trademarks shown. Must be `true` for the
+      #
+      #   @param certify_no_shaft_content [Boolean] Certification that this DIR is not used for SHAFT content (Sex, Hate, Alcohol, F
+      #
+      #   @param display_name [String] Name shown to call recipients. 1–35 characters, no emoji, not whitespace-only.
+      #
+      #   @param documents [Array<Telnyx::Models::DirUpdateParams::Document>] Additional supporting documents to attach. Append-only: existing documents are n
+      #
+      #   @param logo_url [String] Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).
+      #
+      #   @param reselling [Boolean] Set to true if your organization places calls on behalf of other enterprises (BP
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      class Document < Telnyx::Internal::Type::BaseModel
+        # @!attribute document_id
+        #   Id returned by the Telnyx Documents API after you upload the file (upload via
+        #   `POST /v2/documents`; see https://developers.telnyx.com/api/documents).
+        #
+        #   @return [String]
+        required :document_id, String
+
+        # @!attribute document_type
+        #   Type of supporting document. Pick the closest match to what the file actually
+        #   contains; `other` triggers manual vetting and may slow approval. The matching
+        #   short_name reference list is at `GET /v2/dir/document_types`.
+        #
+        #   @return [Symbol, Telnyx::Models::DirUpdateParams::Document::DocumentType]
+        required :document_type, enum: -> { Telnyx::DirUpdateParams::Document::DocumentType }
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!method initialize(document_id:, document_type:, description: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::DirUpdateParams::Document} for more details.
+        #
+        #   @param document_id [String] Id returned by the Telnyx Documents API after you upload the file (upload via `P
+        #
+        #   @param document_type [Symbol, Telnyx::Models::DirUpdateParams::Document::DocumentType] Type of supporting document. Pick the closest match to what the file actually co
+        #
+        #   @param description [String]
+
+        # Type of supporting document. Pick the closest match to what the file actually
+        # contains; `other` triggers manual vetting and may slow approval. The matching
+        # short_name reference list is at `GET /v2/dir/document_types`.
+        #
+        # @see Telnyx::Models::DirUpdateParams::Document#document_type
+        module DocumentType
+          extend Telnyx::Internal::Type::Enum
+
+          LETTER_OF_AUTHORIZATION = :letter_of_authorization
+          BUSINESS_REGISTRATION = :business_registration
+          ARTICLES_OF_INCORPORATION = :articles_of_incorporation
+          TAX_DOCUMENT = :tax_document
+          EIN_LETTER = :ein_letter
+          TRADEMARK_REGISTRATION = :trademark_registration
+          WEBSITE_OWNERSHIP = :website_ownership
+          BUSINESS_LICENSE = :business_license
+          PROFESSIONAL_LICENSE = :professional_license
+          GOVERNMENT_ID = :government_id
+          UTILITY_BILL = :utility_bill
+          BANK_STATEMENT = :bank_statement
+          OTHER = :other
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end