telnyx 5.126.0 → 5.128.0

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

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      # @see Telnyx::Resources::Enterprises::Dir#create
+      class DirCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute enterprise_id
+        #
+        #   @return [String]
+        required :enterprise_id, String
+
+        # @!attribute authorizer_email
+        #   Contact email of the authorizer. Telnyx may send verification or
+        #   infringement-notice email here; use a monitored mailbox.
+        #
+        #   @return [String]
+        required :authorizer_email, String
+
+        # @!attribute authorizer_name
+        #   Name of the person at your enterprise who is authorizing this DIR registration.
+        #   Must be a real individual (used for audit and trademark-claim contests).
+        #
+        #   @return [String]
+        required :authorizer_name, String
+
+        # @!attribute certify_brand_is_accurate
+        #   Must be `true`.
+        #
+        #   @return [Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyBrandIsAccurate]
+        required :certify_brand_is_accurate,
+                 enum: -> { Telnyx::Enterprises::DirCreateParams::CertifyBrandIsAccurate }
+
+        # @!attribute certify_ip_ownership
+        #   Must be `true`. Confirms ownership of any logos/trademarks shown.
+        #
+        #   @return [Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyIPOwnership]
+        required :certify_ip_ownership, enum: -> { Telnyx::Enterprises::DirCreateParams::CertifyIPOwnership }
+
+        # @!attribute certify_no_shaft_content
+        #   Must be `true`. Confirms this DIR is not used for SHAFT content (Sex, Hate,
+        #   Alcohol, Firearms, Tobacco) where prohibited.
+        #
+        #   @return [Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyNoShaftContent]
+        required :certify_no_shaft_content,
+                 enum: -> { Telnyx::Enterprises::DirCreateParams::CertifyNoShaftContent }
+
+        # @!attribute display_name
+        #   Name shown to call recipients. No emoji; not whitespace-only.
+        #
+        #   @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.
+        #
+        #   @return [Array<Telnyx::Models::Enterprises::DirCreateParams::Document>, nil]
+        optional :documents,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Enterprises::DirCreateParams::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).
+        #
+        #   @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: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Enterprises::DirCreateParams} for more details.
+        #
+        #   @param enterprise_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 who is authorizing this DIR registration.
+        #
+        #   @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.
+        #
+        #   @param certify_no_shaft_content [Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyNoShaftContent] Must be `true`. Confirms this DIR is not used for SHAFT content (Sex, Hate, Alco
+        #
+        #   @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::Enterprises::DirCreateParams::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).
+        #
+        #   @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}]
+
+        # Must be `true`.
+        module CertifyBrandIsAccurate
+          extend Telnyx::Internal::Type::Enum
+
+          TRUE = true
+
+          # @!method self.values
+          #   @return [Array<Boolean>]
+        end
+
+        # Must be `true`. Confirms ownership of any logos/trademarks shown.
+        module CertifyIPOwnership
+          extend Telnyx::Internal::Type::Enum
+
+          TRUE = true
+
+          # @!method self.values
+          #   @return [Array<Boolean>]
+        end
+
+        # Must be `true`. Confirms this DIR is not used for SHAFT content (Sex, Hate,
+        # Alcohol, Firearms, Tobacco) where prohibited.
+        module CertifyNoShaftContent
+          extend Telnyx::Internal::Type::Enum
+
+          TRUE = true
+
+          # @!method self.values
+          #   @return [Array<Boolean>]
+        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::Enterprises::DirCreateParams::Document::DocumentType]
+          required :document_type, enum: -> { Telnyx::Enterprises::DirCreateParams::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::Enterprises::DirCreateParams::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::Enterprises::DirCreateParams::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::Enterprises::DirCreateParams::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
+end

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

@@ -0,0 +1,337 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      # @see Telnyx::Resources::Enterprises::Dir#create
+      class DirCreateResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::Enterprises::DirCreateResponse::Data]
+        required :data, -> { Telnyx::Models::Enterprises::DirCreateResponse::Data }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::Enterprises::DirCreateResponse::Data]
+
+        # @see Telnyx::Models::Enterprises::DirCreateResponse#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::Enterprises::DirCreateResponse::Data::CallReason>, nil]
+          optional :call_reasons,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Enterprises::DirCreateResponse::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::Enterprises::DirCreateResponse::Data::Document>, nil]
+          optional :documents,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Enterprises::DirCreateResponse::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::Enterprises::DirCreateResponse::Data::RejectionReason>, nil]
+          optional :rejection_reasons,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Enterprises::DirCreateResponse::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::Enterprises::DirCreateResponse::Data::Status, nil]
+          optional :status, enum: -> { Telnyx::Models::Enterprises::DirCreateResponse::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::Enterprises::DirCreateResponse::Data} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param authorizer_email [String, nil]
+          #
+          #   @param authorizer_name [String, nil]
+          #
+          #   @param call_reasons [Array<Telnyx::Models::Enterprises::DirCreateResponse::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::Enterprises::DirCreateResponse::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::Enterprises::DirCreateResponse::Data::RejectionReason>, nil] Populated when `status` is `rejected`; cleared on `/submit` or successful approv
+          #
+          #   @param reselling [Boolean]
+          #
+          #   @param status [Symbol, Telnyx::Models::Enterprises::DirCreateResponse::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::Enterprises::DirCreateResponse::Data::Document::DocumentType]
+            required :document_type,
+                     enum: -> { Telnyx::Models::Enterprises::DirCreateResponse::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::Enterprises::DirCreateResponse::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::Enterprises::DirCreateResponse::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::Enterprises::DirCreateResponse::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::Enterprises::DirCreateResponse::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::Enterprises::DirCreateResponse::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
+end

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

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      # @see Telnyx::Resources::Enterprises::Dir#list
+      class DirListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute enterprise_id
+        #
+        #   @return [String]
+        required :enterprise_id, String
+
+        # @!attribute filter_call_reason_contains
+        #   Case-insensitive partial match on call reason.
+        #
+        #   @return [String, nil]
+        optional :filter_call_reason_contains, String
+
+        # @!attribute filter_display_name_contains
+        #   Case-insensitive partial match on display name.
+        #
+        #   @return [String, nil]
+        optional :filter_display_name_contains, String
+
+        # @!attribute filter_expiring_at_gte
+        #   Return only DIRs whose `expiring_at` is at or after this ISO-8601 timestamp.
+        #
+        #   @return [Time, nil]
+        optional :filter_expiring_at_gte, Time
+
+        # @!attribute filter_expiring_at_lte
+        #   Return only DIRs whose `expiring_at` is at or before this ISO-8601 timestamp.
+        #
+        #   @return [Time, nil]
+        optional :filter_expiring_at_lte, Time
+
+        # @!attribute filter_expiring_within_days
+        #   Convenience: returns DIRs whose `expiring_at` falls within the next N days
+        #   (1–365). Equivalent to setting `filter[expiring_at][gte]=<now>` +
+        #   `filter[expiring_at][lte]=<now+N>`. Mutually exclusive with the explicit
+        #   `[gte]`/`[lte]` filters - combining returns 400.
+        #
+        #   @return [Integer, nil]
+        optional :filter_expiring_within_days, Integer
+
+        # @!attribute filter_status
+        #   Filter by DIR status.
+        #
+        #   @return [Symbol, Telnyx::Models::Enterprises::DirListParams::FilterStatus, nil]
+        optional :filter_status, enum: -> { Telnyx::Enterprises::DirListParams::FilterStatus }
+
+        # @!attribute page_number
+        #   1-based page number. Out-of-range values return an empty page with correct meta.
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #   Items per page. Maximum 250; values above are clamped to 250.
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!attribute sort
+        #   Sort field. Allowed: `created_at`, `updated_at`, `display_name`, `status`,
+        #   `submitted_at`, `verified_at`, `expiring_at`. Prefix with `-` for descending.
+        #   Default `-created_at`.
+        #
+        #   @return [Symbol, Telnyx::Models::Enterprises::DirListParams::Sort, nil]
+        optional :sort, enum: -> { Telnyx::Enterprises::DirListParams::Sort }
+
+        # @!method initialize(enterprise_id:, filter_call_reason_contains: nil, filter_display_name_contains: nil, filter_expiring_at_gte: nil, filter_expiring_at_lte: nil, filter_expiring_within_days: nil, filter_status: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Enterprises::DirListParams} for more details.
+        #
+        #   @param enterprise_id [String]
+        #
+        #   @param filter_call_reason_contains [String] Case-insensitive partial match on call reason.
+        #
+        #   @param filter_display_name_contains [String] Case-insensitive partial match on display name.
+        #
+        #   @param filter_expiring_at_gte [Time] Return only DIRs whose `expiring_at` is at or after this ISO-8601 timestamp.
+        #
+        #   @param filter_expiring_at_lte [Time] Return only DIRs whose `expiring_at` is at or before this ISO-8601 timestamp.
+        #
+        #   @param filter_expiring_within_days [Integer] Convenience: returns DIRs whose `expiring_at` falls within the next N days (1–36
+        #
+        #   @param filter_status [Symbol, Telnyx::Models::Enterprises::DirListParams::FilterStatus] Filter by DIR status.
+        #
+        #   @param page_number [Integer] 1-based page number. Out-of-range values return an empty page with correct meta.
+        #
+        #   @param page_size [Integer] Items per page. Maximum 250; values above are clamped to 250.
+        #
+        #   @param sort [Symbol, Telnyx::Models::Enterprises::DirListParams::Sort] Sort field. Allowed: `created_at`, `updated_at`, `display_name`, `status`, `subm
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        # Filter by DIR status.
+        module FilterStatus
+          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
+
+        # Sort field. Allowed: `created_at`, `updated_at`, `display_name`, `status`,
+        # `submitted_at`, `verified_at`, `expiring_at`. Prefix with `-` for descending.
+        # Default `-created_at`.
+        module Sort
+          extend Telnyx::Internal::Type::Enum
+
+          CREATED_AT = :created_at
+          CREATED_AT_DESC = :"-created_at"
+          UPDATED_AT = :updated_at
+          UPDATED_AT_DESC = :"-updated_at"
+          DISPLAY_NAME = :display_name
+          MINUS_DISPLAY_NAME = :"-display_name"
+          STATUS = :status
+          STATUS_DESC = :"-status"
+          SUBMITTED_AT = :submitted_at
+          MINUS_SUBMITTED_AT = :"-submitted_at"
+          VERIFIED_AT = :verified_at
+          MINUS_VERIFIED_AT = :"-verified_at"
+          EXPIRING_AT = :expiring_at
+          MINUS_EXPIRING_AT = :"-expiring_at"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end