Class: Telnyx::Models::Enterprises::Reputation::RemediationListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/enterprises/reputation/remediation_list_params.rb

Overview

Defined Under Namespace

Modules: FilterStatus

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(enterprise_id:, filter_created_at_gte: nil, filter_created_at_lte: nil, filter_status: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Enterprises::Reputation::RemediationListParams for more details.

Parameters:

  • enterprise_id (String)
  • filter_created_at_gte (Time) (defaults to: nil)

    Only requests created on or after this timestamp (ISO 8601).

  • filter_created_at_lte (Time) (defaults to: nil)

    Only requests created on or before this timestamp (ISO 8601).

  • filter_status (Symbol, Telnyx::Models::Enterprises::Reputation::RemediationListParams::FilterStatus) (defaults to: nil)

    Filter by customer-facing status.

  • page_number (Integer) (defaults to: nil)

    1-based page number. Out-of-range values return an empty page with correct meta.

  • page_size (Integer) (defaults to: nil)

    Items per page. Maximum 250; values above are clamped to 250.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})


# File 'lib/telnyx/models/enterprises/reputation/remediation_list_params.rb', line 47

Instance Attribute Details

#enterprise_idString

Returns:

  • (String)


15
# File 'lib/telnyx/models/enterprises/reputation/remediation_list_params.rb', line 15

required :enterprise_id, String

#filter_created_at_gteTime?

Only requests created on or after this timestamp (ISO 8601).

Returns:

  • (Time, nil)


21
# File 'lib/telnyx/models/enterprises/reputation/remediation_list_params.rb', line 21

optional :filter_created_at_gte, Time

#filter_created_at_lteTime?

Only requests created on or before this timestamp (ISO 8601).

Returns:

  • (Time, nil)


27
# File 'lib/telnyx/models/enterprises/reputation/remediation_list_params.rb', line 27

optional :filter_created_at_lte, Time

#filter_statusSymbol, ...

Filter by customer-facing status.



33
# File 'lib/telnyx/models/enterprises/reputation/remediation_list_params.rb', line 33

optional :filter_status, enum: -> { Telnyx::Enterprises::Reputation::RemediationListParams::FilterStatus }

#page_numberInteger?

1-based page number. Out-of-range values return an empty page with correct meta.

Returns:

  • (Integer, nil)


39
# File 'lib/telnyx/models/enterprises/reputation/remediation_list_params.rb', line 39

optional :page_number, Integer

#page_sizeInteger?

Items per page. Maximum 250; values above are clamped to 250.

Returns:

  • (Integer, nil)


45
# File 'lib/telnyx/models/enterprises/reputation/remediation_list_params.rb', line 45

optional :page_size, Integer