telnyx 5.126.0 → 5.128.0

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

@@ -7,10 +7,10 @@ module Telnyx
       class ReputationUpdateFrequencyResponse < Telnyx::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [Telnyx::Models::Enterprises::EnterpriseReputationPublic, nil]
-        optional :data, -> { Telnyx::Enterprises::EnterpriseReputationPublic }
+        #   @return [Telnyx::Models::Enterprises::EnterpriseReputationPublic]
+        required :data, -> { Telnyx::Enterprises::EnterpriseReputationPublic }
 
-        # @!method initialize(data: nil)
+        # @!method initialize(data:)
         #   @param data [Telnyx::Models::Enterprises::EnterpriseReputationPublic]
       end
     end

data/lib/telnyx/models/infringement_claim_contest_params.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::InfringementClaims#contest
+    class InfringementClaimContestParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute claim_id
+      #
+      #   @return [String]
+      required :claim_id, String
+
+      # @!attribute contest_notes
+      #   Customer's response to the claim. 10–2000 characters.
+      #
+      #   @return [String]
+      required :contest_notes, String
+
+      # @!attribute documents
+      #   Up to 20 supporting documents per submission. `document_id` must be unique
+      #   within this submission. Documents are aggregated into the claim's
+      #   `contest_documents` across all submissions.
+      #
+      #   @return [Array<Telnyx::Models::InfringementClaimContestParams::Document>, nil]
+      optional :documents,
+               -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InfringementClaimContestParams::Document] }
+
+      # @!method initialize(claim_id:, contest_notes:, documents: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::InfringementClaimContestParams} for more details.
+      #
+      #   @param claim_id [String]
+      #
+      #   @param contest_notes [String] Customer's response to the claim. 10–2000 characters.
+      #
+      #   @param documents [Array<Telnyx::Models::InfringementClaimContestParams::Document>] Up to 20 supporting documents per submission. `document_id` must be unique withi
+      #
+      #   @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::InfringementClaimContestParams::Document::DocumentType]
+        required :document_type, enum: -> { Telnyx::InfringementClaimContestParams::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::InfringementClaimContestParams::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::InfringementClaimContestParams::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::InfringementClaimContestParams::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

data/lib/telnyx/models/infringement_claim_contest_response.rb

@@ -0,0 +1,377 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::InfringementClaims#contest
+    class InfringementClaimContestResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::InfringementClaimContestResponse::Data]
+      required :data, -> { Telnyx::Models::InfringementClaimContestResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [Telnyx::Models::InfringementClaimContestResponse::Data]
+
+      # @see Telnyx::Models::InfringementClaimContestResponse#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute claim_description
+        #
+        #   @return [String, nil]
+        optional :claim_description, String
+
+        # @!attribute claim_type
+        #   Category of infringement being claimed.
+        #
+        #   @return [Symbol, Telnyx::Models::InfringementClaimContestResponse::Data::ClaimType, nil]
+        optional :claim_type, enum: -> { Telnyx::Models::InfringementClaimContestResponse::Data::ClaimType }
+
+        # @!attribute claimant_contact
+        #
+        #   @return [String, nil]
+        optional :claimant_contact, String
+
+        # @!attribute claimant_name
+        #
+        #   @return [String, nil]
+        optional :claimant_name, String
+
+        # @!attribute contest_documents
+        #   Aggregated across all customer contest submissions on this claim.
+        #
+        #   @return [Array<Telnyx::Models::InfringementClaimContestResponse::Data::ContestDocument>, nil]
+        optional :contest_documents,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::InfringementClaimContestResponse::Data::ContestDocument] }
+
+        # @!attribute dir
+        #   Snapshot of the DIR the claim is filed against, embedded for convenience.
+        #
+        #   @return [Telnyx::Models::InfringementClaimContestResponse::Data::Dir, nil]
+        optional :dir, -> { Telnyx::Models::InfringementClaimContestResponse::Data::Dir }
+
+        # @!attribute dir_id
+        #
+        #   @return [String, nil]
+        optional :dir_id, String
+
+        # @!attribute enterprise_id
+        #
+        #   @return [String, nil]
+        optional :enterprise_id, String
+
+        # @!attribute resolution
+        #   Set only when `status` is `resolved`.
+        #
+        #   @return [Symbol, Telnyx::Models::InfringementClaimContestResponse::Data::Resolution, nil]
+        optional :resolution,
+                 enum: -> { Telnyx::Models::InfringementClaimContestResponse::Data::Resolution },
+                 nil?: true
+
+        # @!attribute status
+        #   Lifecycle status. `pending` - newly filed; the DIR is auto-suspended.
+        #   `contested` - you have submitted contest evidence; awaiting Telnyx review.
+        #   `resolved` - final.
+        #
+        #   @return [Symbol, Telnyx::Models::InfringementClaimContestResponse::Data::Status, nil]
+        optional :status, enum: -> { Telnyx::Models::InfringementClaimContestResponse::Data::Status }
+
+        response_only do
+          # @!attribute id
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute claim_date
+          #   When the claim was filed (set by the claimant's representative at file time).
+          #
+          #   @return [Time, nil]
+          optional :claim_date, Time
+
+          # @!attribute contest_history
+          #   Per-round submission audit trail. Each entry records one
+          #   `POST /infringement_claims/{id}/contest` call (notes, timestamp, document
+          #   count). Aggregated documents live on `contest_documents`.
+          #
+          #   @return [Array<Telnyx::Models::InfringementClaimContestResponse::Data::ContestHistory>, nil]
+          optional :contest_history,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::InfringementClaimContestResponse::Data::ContestHistory] }
+
+          # @!attribute created_at
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute resolution_date
+          #
+          #   @return [Time, nil]
+          optional :resolution_date, Time, nil?: true
+
+          # @!attribute resolution_notes
+          #
+          #   @return [String, nil]
+          optional :resolution_notes, String, nil?: true
+
+          # @!attribute updated_at
+          #
+          #   @return [Time, nil]
+          optional :updated_at, Time
+        end
+
+        # @!method initialize(id: nil, claim_date: nil, claim_description: nil, claim_type: nil, claimant_contact: nil, claimant_name: nil, contest_documents: nil, contest_history: nil, created_at: nil, dir: nil, dir_id: nil, enterprise_id: nil, resolution: nil, resolution_date: nil, resolution_notes: nil, status: nil, updated_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::InfringementClaimContestResponse::Data} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param claim_date [Time] When the claim was filed (set by the claimant's representative at file time).
+        #
+        #   @param claim_description [String]
+        #
+        #   @param claim_type [Symbol, Telnyx::Models::InfringementClaimContestResponse::Data::ClaimType] Category of infringement being claimed.
+        #
+        #   @param claimant_contact [String]
+        #
+        #   @param claimant_name [String]
+        #
+        #   @param contest_documents [Array<Telnyx::Models::InfringementClaimContestResponse::Data::ContestDocument>] Aggregated across all customer contest submissions on this claim.
+        #
+        #   @param contest_history [Array<Telnyx::Models::InfringementClaimContestResponse::Data::ContestHistory>] Per-round submission audit trail. Each entry records one `POST /infringement_cla
+        #
+        #   @param created_at [Time]
+        #
+        #   @param dir [Telnyx::Models::InfringementClaimContestResponse::Data::Dir] Snapshot of the DIR the claim is filed against, embedded for convenience.
+        #
+        #   @param dir_id [String]
+        #
+        #   @param enterprise_id [String]
+        #
+        #   @param resolution [Symbol, Telnyx::Models::InfringementClaimContestResponse::Data::Resolution, nil] Set only when `status` is `resolved`.
+        #
+        #   @param resolution_date [Time, nil]
+        #
+        #   @param resolution_notes [String, nil]
+        #
+        #   @param status [Symbol, Telnyx::Models::InfringementClaimContestResponse::Data::Status] Lifecycle status. `pending` - newly filed; the DIR is auto-suspended. `contested
+        #
+        #   @param updated_at [Time]
+
+        # Category of infringement being claimed.
+        #
+        # @see Telnyx::Models::InfringementClaimContestResponse::Data#claim_type
+        module ClaimType
+          extend Telnyx::Internal::Type::Enum
+
+          TRADEMARK = :trademark
+          COPYRIGHT = :copyright
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class ContestDocument < 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::InfringementClaimContestResponse::Data::ContestDocument::DocumentType]
+          required :document_type,
+                   enum: -> { Telnyx::Models::InfringementClaimContestResponse::Data::ContestDocument::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::InfringementClaimContestResponse::Data::ContestDocument} 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::InfringementClaimContestResponse::Data::ContestDocument::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::InfringementClaimContestResponse::Data::ContestDocument#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 ContestHistory < Telnyx::Internal::Type::BaseModel
+          # @!attribute notes
+          #
+          #   @return [String, nil]
+          optional :notes, String
+
+          response_only do
+            # @!attribute document_count
+            #
+            #   @return [Integer, nil]
+            optional :document_count, Integer
+
+            # @!attribute submitted_at
+            #
+            #   @return [Time, nil]
+            optional :submitted_at, Time
+          end
+
+          # @!method initialize(document_count: nil, notes: nil, submitted_at: nil)
+          #   One round of customer contest evidence on an infringement claim. The aggregated
+          #   documents across rounds live on the parent claim's `contest_documents`; this
+          #   submission record carries only the per-round notes and document count.
+          #
+          #   @param document_count [Integer]
+          #   @param notes [String]
+          #   @param submitted_at [Time]
+        end
+
+        # @see Telnyx::Models::InfringementClaimContestResponse::Data#dir
+        class Dir < Telnyx::Internal::Type::BaseModel
+          # @!attribute display_name
+          #
+          #   @return [String, nil]
+          optional :display_name, String
+
+          # @!attribute enterprise_id
+          #
+          #   @return [String, nil]
+          optional :enterprise_id, String
+
+          # @!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::InfringementClaimContestResponse::Data::Dir::Status, nil]
+          optional :status, enum: -> { Telnyx::Models::InfringementClaimContestResponse::Data::Dir::Status }
+
+          response_only do
+            # @!attribute id
+            #
+            #   @return [String, nil]
+            optional :id, String
+          end
+
+          # @!method initialize(id: nil, display_name: nil, enterprise_id: nil, status: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::InfringementClaimContestResponse::Data::Dir} for more details.
+          #
+          #   Snapshot of the DIR the claim is filed against, embedded for convenience.
+          #
+          #   @param id [String]
+          #
+          #   @param display_name [String]
+          #
+          #   @param enterprise_id [String]
+          #
+          #   @param status [Symbol, Telnyx::Models::InfringementClaimContestResponse::Data::Dir::Status] DIR lifecycle 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.
+          #
+          # @see Telnyx::Models::InfringementClaimContestResponse::Data::Dir#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
+
+        # Set only when `status` is `resolved`.
+        #
+        # @see Telnyx::Models::InfringementClaimContestResponse::Data#resolution
+        module Resolution
+          extend Telnyx::Internal::Type::Enum
+
+          UPHELD = :upheld
+          REJECTED = :rejected
+          MODIFIED = :modified
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Lifecycle status. `pending` - newly filed; the DIR is auto-suspended.
+        # `contested` - you have submitted contest evidence; awaiting Telnyx review.
+        # `resolved` - final.
+        #
+        # @see Telnyx::Models::InfringementClaimContestResponse::Data#status
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          PENDING = :pending
+          CONTESTED = :contested
+          RESOLVED = :resolved
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/infringement_claim_retrieve_params.rb

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