Class: Telnyx::Models::DocumentListParams::Filter

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

Defined Under Namespace

Classes: CreatedAt, CustomerReference, Filename

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(eq: nil, in_: nil) ⇒ Object

Parameters:

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

    Filter documents by a customer reference.

  • in_ (Array<String>) (defaults to: nil) —

    Filter documents by a list of customer references.



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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/telnyx/models/document_list_params.rb', line 48

class Filter < Telnyx::Internal::Type::BaseModel
  # @!attribute created_at
  #
  #   @return [Telnyx::Models::DocumentListParams::Filter::CreatedAt, nil]
  optional :created_at, -> { Telnyx::DocumentListParams::Filter::CreatedAt }

  # @!attribute customer_reference
  #
  #   @return [Telnyx::Models::DocumentListParams::Filter::CustomerReference, nil]
  optional :customer_reference, -> { Telnyx::DocumentListParams::Filter::CustomerReference }

  # @!attribute filename
  #
  #   @return [Telnyx::Models::DocumentListParams::Filter::Filename, nil]
  optional :filename, -> { Telnyx::DocumentListParams::Filter::Filename }

  # @!method initialize(created_at: nil, customer_reference: nil, filename: nil)
  #   Consolidated filter parameter for documents (deepObject style). Originally:
  #   filter[filename][contains], filter[customer_reference][eq],
  #   filter[customer_reference][in][], filter[created_at][gt], filter[created_at][lt]
  #
  #   @param created_at [Telnyx::Models::DocumentListParams::Filter::CreatedAt]
  #   @param customer_reference [Telnyx::Models::DocumentListParams::Filter::CustomerReference]
  #   @param filename [Telnyx::Models::DocumentListParams::Filter::Filename]

  # @see Telnyx::Models::DocumentListParams::Filter#created_at
  class CreatedAt < Telnyx::Internal::Type::BaseModel
    # @!attribute gt
    #   Filter by created at greater than provided value.
    #
    #   @return [Time, nil]
    optional :gt, Time

    # @!attribute lt
    #   Filter by created at less than provided value.
    #
    #   @return [Time, nil]
    optional :lt, Time

    # @!method initialize(gt: nil, lt: nil)
    #   @param gt [Time] Filter by created at greater than provided value.
    #
    #   @param lt [Time] Filter by created at less than provided value.
  end

  # @see Telnyx::Models::DocumentListParams::Filter#customer_reference
  class CustomerReference < Telnyx::Internal::Type::BaseModel
    # @!attribute eq
    #   Filter documents by a customer reference.
    #
    #   @return [String, nil]
    optional :eq, String

    # @!attribute in_
    #   Filter documents by a list of customer references.
    #
    #   @return [Array<String>, nil]
    optional :in_, Telnyx::Internal::Type::ArrayOf[String], api_name: :in

    # @!method initialize(eq: nil, in_: nil)
    #   @param eq [String] Filter documents by a customer reference.
    #
    #   @param in_ [Array<String>] Filter documents by a list of customer references.
  end

  # @see Telnyx::Models::DocumentListParams::Filter#filename
  class Filename < Telnyx::Internal::Type::BaseModel
    # @!attribute contains
    #   Filter by string matching part of filename.
    #
    #   @return [String, nil]
    optional :contains, String

    # @!method initialize(contains: nil)
    #   @param contains [String] Filter by string matching part of filename.
  end
end

Instance Attribute Details

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

Returns:



52
 
# File 'lib/telnyx/models/document_list_params.rb', line 52

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

#customer_reference ⇒ Telnyx::Models::DocumentListParams::Filter::CustomerReference?

Returns:



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

optional :customer_reference, -> { Telnyx::DocumentListParams::Filter::CustomerReference }

#filename ⇒ Telnyx::Models::DocumentListParams::Filter::Filename?

Returns:



62
 
# File 'lib/telnyx/models/document_list_params.rb', line 62

optional :filename, -> { Telnyx::DocumentListParams::Filter::Filename }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


84
 
# File 'sig/telnyx/models/document_list_params.rbs', line 84

def to_hash: -> {