Class: Telnyx::Models::NumberOrderListParams::Filter

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/number_order_list_params.rb,
sig/telnyx/models/number_order_list_params.rbs

Defined Under Namespace

Classes: CreatedAt

Instance Attribute Summary collapse

Instance Method Summary collapse

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(created_at: nil, customer_reference: nil, phone_numbers_count: nil, requirements_met: nil, status: nil) ⇒ Object

Consolidated filter parameter (deepObject style). Originally: filter, filter, filter, filter, filter

Parameters:

  • created_at (Telnyx::Models::NumberOrderListParams::Filter::CreatedAt) (defaults to: nil) —

    Filter number orders by date range.

  • customer_reference (String) (defaults to: nil) —

    Filter number orders via the customer reference set.

  • phone_numbers_count (String) (defaults to: nil) —

    Filter number order with this amount of numbers

  • requirements_met (Boolean) (defaults to: nil) —

    Filter number orders by requirements met.

  • status (String) (defaults to: nil) —

    Filter number orders by status.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/telnyx/models/number_order_list_params.rb', line 40

class Filter < Telnyx::Internal::Type::BaseModel
  # @!attribute created_at
  #   Filter number orders by date range.
  #
  #   @return [Telnyx::Models::NumberOrderListParams::Filter::CreatedAt, nil]
  optional :created_at, -> { Telnyx::NumberOrderListParams::Filter::CreatedAt }

  # @!attribute customer_reference
  #   Filter number orders via the customer reference set.
  #
  #   @return [String, nil]
  optional :customer_reference, String

  # @!attribute phone_numbers_count
  #   Filter number order with this amount of numbers
  #
  #   @return [String, nil]
  optional :phone_numbers_count, String

  # @!attribute requirements_met
  #   Filter number orders by requirements met.
  #
  #   @return [Boolean, nil]
  optional :requirements_met, Telnyx::Internal::Type::Boolean

  # @!attribute status
  #   Filter number orders by status.
  #
  #   @return [String, nil]
  optional :status, String

  # @!method initialize(created_at: nil, customer_reference: nil, phone_numbers_count: nil, requirements_met: nil, status: nil)
  #   Consolidated filter parameter (deepObject style). Originally: filter[status],
  #   filter[created_at], filter[phone_numbers_count], filter[customer_reference],
  #   filter[requirements_met]
  #
  #   @param created_at [Telnyx::Models::NumberOrderListParams::Filter::CreatedAt] Filter number orders by date range.
  #
  #   @param customer_reference [String] Filter number orders via the customer reference set.
  #
  #   @param phone_numbers_count [String] Filter number order with this amount of numbers
  #
  #   @param requirements_met [Boolean] Filter number orders by requirements met.
  #
  #   @param status [String] Filter number orders by status.

  # @see Telnyx::Models::NumberOrderListParams::Filter#created_at
  class CreatedAt < Telnyx::Internal::Type::BaseModel
    # @!attribute gt
    #   Filter number orders later than this value.
    #
    #   @return [String, nil]
    optional :gt, String

    # @!attribute lt
    #   Filter number orders earlier than this value.
    #
    #   @return [String, nil]
    optional :lt, String

    # @!method initialize(gt: nil, lt: nil)
    #   Filter number orders by date range.
    #
    #   @param gt [String] Filter number orders later than this value.
    #
    #   @param lt [String] Filter number orders earlier than this value.
  end
end

Instance Attribute Details

#created_at ⇒ Telnyx::Models::NumberOrderListParams::Filter::CreatedAt?

Filter number orders by date range.

Returns:



45
 
# File 'lib/telnyx/models/number_order_list_params.rb', line 45

optional :created_at, -> { Telnyx::NumberOrderListParams::Filter::CreatedAt }

#customer_reference ⇒ String?

Filter number orders via the customer reference set.

Parameters:

  • (String)

Returns:

  • (String, nil) 


51
 
# File 'lib/telnyx/models/number_order_list_params.rb', line 51

optional :customer_reference, String

#phone_numbers_count ⇒ String?

Filter number order with this amount of numbers

Parameters:

  • (String)

Returns:

  • (String, nil) 


57
 
# File 'lib/telnyx/models/number_order_list_params.rb', line 57

optional :phone_numbers_count, String

#requirements_met ⇒ Boolean?

Filter number orders by requirements met.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


63
 
# File 'lib/telnyx/models/number_order_list_params.rb', line 63

optional :requirements_met, Telnyx::Internal::Type::Boolean

#status ⇒ String?

Filter number orders by status.

Parameters:

  • (String)

Returns:

  • (String, nil) 


69
 
# File 'lib/telnyx/models/number_order_list_params.rb', line 69

optional :status, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


83
 
# File 'sig/telnyx/models/number_order_list_params.rbs', line 83

def to_hash: -> {