Class: Revox::Models::CallExportParams::Filters

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

Defined Under Namespace

Modules: Direction, Outcome, Result, SortDirection, Status

Instance Attribute Summary collapse

Class Method 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(filters:, include_metadata: nil, include_structured_output_fields: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Revox::Models::CallExportParams for more details.

Parameters:

  • filters (Revox::Models::CallExportParams::Filters)
  • include_metadata (Boolean) (defaults to: nil) —

    Whether to include the metadata in the CSV file. These are the fields you (optio

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

    Whether to include the structured output fields in the CSV file. These are gener

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


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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/revox/models/call_export_params.rb', line 41

class Filters < Revox::Internal::Type::BaseModel
  # @!attribute assignee_ids
  #
  #   @return [Array<String>]
  required :assignee_ids, Revox::Internal::Type::ArrayOf[String]

  # @!attribute assistant_ids
  #
  #   @return [Array<String>]
  required :assistant_ids, Revox::Internal::Type::ArrayOf[String]

  # @!attribute campaign_ids
  #
  #   @return [Array<String>]
  required :campaign_ids, Revox::Internal::Type::ArrayOf[String]

  # @!attribute directions
  #
  #   @return [Array<Symbol, Revox::Models::CallExportParams::Filters::Direction>]
  required :directions,
           -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallExportParams::Filters::Direction] }

  # @!attribute from_phone_numbers
  #
  #   @return [Array<String>]
  required :from_phone_numbers, Revox::Internal::Type::ArrayOf[String]

  # @!attribute outcomes
  #
  #   @return [Array<Symbol, Revox::Models::CallExportParams::Filters::Outcome>]
  required :outcomes, -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallExportParams::Filters::Outcome] }

  # @!attribute page
  #
  #   @return [Integer]
  required :page, Integer

  # @!attribute page_size
  #
  #   @return [Integer]
  required :page_size, Integer

  # @!attribute results
  #
  #   @return [Array<Symbol, Revox::Models::CallExportParams::Filters::Result>]
  required :results, -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallExportParams::Filters::Result] }

  # @!attribute statuses
  #
  #   @return [Array<Symbol, Revox::Models::CallExportParams::Filters::Status>]
  required :statuses, -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallExportParams::Filters::Status] }

  # @!attribute call_ids
  #
  #   @return [Array<String>, nil]
  optional :call_ids, Revox::Internal::Type::ArrayOf[String]

  # @!attribute query
  #
  #   @return [String, nil]
  optional :query, String

  # @!attribute sort_by
  #
  #   @return [String, nil]
  optional :sort_by, String

  # @!attribute sort_direction
  #
  #   @return [Symbol, Revox::Models::CallExportParams::Filters::SortDirection, nil]
  optional :sort_direction, enum: -> { Revox::CallExportParams::Filters::SortDirection }

  # @!attribute to_phone_number
  #
  #   @return [String, nil]
  optional :to_phone_number, String

  # @!method initialize(assignee_ids:, assistant_ids:, campaign_ids:, directions:, from_phone_numbers:, outcomes:, page:, page_size:, results:, statuses:, call_ids: nil, query: nil, sort_by: nil, sort_direction: nil, to_phone_number: nil)
  #   @param assignee_ids [Array<String>]
  #   @param assistant_ids [Array<String>]
  #   @param campaign_ids [Array<String>]
  #   @param directions [Array<Symbol, Revox::Models::CallExportParams::Filters::Direction>]
  #   @param from_phone_numbers [Array<String>]
  #   @param outcomes [Array<Symbol, Revox::Models::CallExportParams::Filters::Outcome>]
  #   @param page [Integer]
  #   @param page_size [Integer]
  #   @param results [Array<Symbol, Revox::Models::CallExportParams::Filters::Result>]
  #   @param statuses [Array<Symbol, Revox::Models::CallExportParams::Filters::Status>]
  #   @param call_ids [Array<String>]
  #   @param query [String]
  #   @param sort_by [String]
  #   @param sort_direction [Symbol, Revox::Models::CallExportParams::Filters::SortDirection]
  #   @param to_phone_number [String]

  module Direction
    extend Revox::Internal::Type::Enum

    INBOUND = :inbound
    OUTBOUND = :outbound

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  module Outcome
    extend Revox::Internal::Type::Enum

    NOT_INTERESTED = :not_interested
    INTERESTED = :interested
    COMPLETED = :completed
    REQUESTED_CALLBACK_LATER = :requested_callback_later
    REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
    DO_NOT_CONTACT = :do_not_contact
    AI_AVERSE = :ai_averse
    NONE = :none

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  module Result
    extend Revox::Internal::Type::Enum

    IVR = :IVR
    VOICEMAIL = :voicemail
    HUMAN = :human
    UNKNOWN = :unknown
    IOS_SCREENING_FILTER = :"ios-screening-filter"
    NONE = :none

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  module Status
    extend Revox::Internal::Type::Enum

    INITIALIZING = :initializing
    QUEUED_FOR_CALLING = :queued_for_calling
    CALLING = :calling
    POST_PROCESSING = :post_processing
    SCHEDULED = :scheduled
    PAUSED = :paused
    COMPLETED = :completed
    CANCELLED = :cancelled
    ERRORED = :errored

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Revox::Models::CallExportParams::Filters#sort_direction
  module SortDirection
    extend Revox::Internal::Type::Enum

    ASC = :asc
    DESC = :desc

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#assignee_ids ⇒ Array<String>

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


45
 
# File 'lib/revox/models/call_export_params.rb', line 45

required :assignee_ids, Revox::Internal::Type::ArrayOf[String]

#assistant_ids ⇒ Array<String>

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


50
 
# File 'lib/revox/models/call_export_params.rb', line 50

required :assistant_ids, Revox::Internal::Type::ArrayOf[String]

#call_ids ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


96
 
# File 'lib/revox/models/call_export_params.rb', line 96

optional :call_ids, Revox::Internal::Type::ArrayOf[String]

#campaign_ids ⇒ Array<String>

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


55
 
# File 'lib/revox/models/call_export_params.rb', line 55

required :campaign_ids, Revox::Internal::Type::ArrayOf[String]

#directions ⇒ Array<Symbol, Revox::Models::CallExportParams::Filters::Direction>

Parameters:

  • value (::Array[Revox::Models::CallExportParams::Filters::direction])

Returns:



60
61
 
# File 'lib/revox/models/call_export_params.rb', line 60

required :directions,
-> { Revox::Internal::Type::ArrayOf[enum: Revox::CallExportParams::Filters::Direction] }

#from_phone_numbers ⇒ Array<String>

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


66
 
# File 'lib/revox/models/call_export_params.rb', line 66

required :from_phone_numbers, Revox::Internal::Type::ArrayOf[String]

#outcomes ⇒ Array<Symbol, Revox::Models::CallExportParams::Filters::Outcome>

Parameters:

  • value (::Array[Revox::Models::CallExportParams::Filters::outcome])

Returns:



71
 
# File 'lib/revox/models/call_export_params.rb', line 71

required :outcomes, -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallExportParams::Filters::Outcome] }

#page ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


76
 
# File 'lib/revox/models/call_export_params.rb', line 76

required :page, Integer

#page_size ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


81
 
# File 'lib/revox/models/call_export_params.rb', line 81

required :page_size, Integer

#query ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


101
 
# File 'lib/revox/models/call_export_params.rb', line 101

optional :query, String

#results ⇒ Array<Symbol, Revox::Models::CallExportParams::Filters::Result>

Parameters:

  • value (::Array[Revox::Models::CallExportParams::Filters::result])

Returns:



86
 
# File 'lib/revox/models/call_export_params.rb', line 86

required :results, -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallExportParams::Filters::Result] }

#sort_by ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


106
 
# File 'lib/revox/models/call_export_params.rb', line 106

optional :sort_by, String

#sort_direction ⇒ Symbol, ...

Returns:



111
 
# File 'lib/revox/models/call_export_params.rb', line 111

optional :sort_direction, enum: -> { Revox::CallExportParams::Filters::SortDirection }

#statuses ⇒ Array<Symbol, Revox::Models::CallExportParams::Filters::Status>

Parameters:

  • value (::Array[Revox::Models::CallExportParams::Filters::status])

Returns:



91
 
# File 'lib/revox/models/call_export_params.rb', line 91

required :statuses, -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallExportParams::Filters::Status] }

#to_phone_number ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


116
 
# File 'lib/revox/models/call_export_params.rb', line 116

optional :to_phone_number, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/revox/models/call_export_params.rb', line 141

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


119
 
# File 'sig/revox/models/call_export_params.rbs', line 119

def to_hash: -> {