Class: FreightFinancialsWebhookIngestionApi::SearchRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/freight_financials_webhook_ingestion_api/models/search_request.rb

Overview

SearchRequest Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(carrier_dot_numbers: SKIP, carrier_mc_numbers: SKIP, carrier_names: SKIP, invoice_numbers: SKIP, last_updated_after: SKIP, last_updated_before: SKIP, load_numbers: SKIP, page: SKIP, page_size: SKIP, received_after: SKIP, received_before: SKIP, statuses: SKIP) ⇒ SearchRequest

Returns a new instance of SearchRequest.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 113

def initialize(carrier_dot_numbers: SKIP, carrier_mc_numbers: SKIP,
               carrier_names: SKIP, invoice_numbers: SKIP,
               last_updated_after: SKIP, last_updated_before: SKIP,
               load_numbers: SKIP, page: SKIP, page_size: SKIP,
               received_after: SKIP, received_before: SKIP, statuses: SKIP)
  @carrier_dot_numbers = carrier_dot_numbers unless carrier_dot_numbers == SKIP
  @carrier_mc_numbers = carrier_mc_numbers unless carrier_mc_numbers == SKIP
  @carrier_names = carrier_names unless carrier_names == SKIP
  @invoice_numbers = invoice_numbers unless invoice_numbers == SKIP
  @last_updated_after = last_updated_after unless last_updated_after == SKIP
  @last_updated_before = last_updated_before unless last_updated_before == SKIP
  @load_numbers = load_numbers unless load_numbers == SKIP
  @page = page unless page == SKIP
  @page_size = page_size unless page_size == SKIP
  @received_after = received_after unless received_after == SKIP
  @received_before = received_before unless received_before == SKIP
  @statuses = statuses unless statuses == SKIP
end

Instance Attribute Details

#carrier_dot_numbers ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


15
16
17
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 15

def carrier_dot_numbers
  @carrier_dot_numbers
end

#carrier_mc_numbers ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


19
20
21
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 19

def carrier_mc_numbers
  @carrier_mc_numbers
end

#carrier_names ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


23
24
25
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 23

def carrier_names
  @carrier_names
end

#invoice_numbers ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


27
28
29
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 27

def invoice_numbers
  @invoice_numbers
end

#last_updated_after ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


31
32
33
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 31

def last_updated_after
  @last_updated_after
end

#last_updated_before ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


35
36
37
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 35

def last_updated_before
  @last_updated_before
end

#load_numbers ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


39
40
41
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 39

def load_numbers
  @load_numbers
end

#page ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


43
44
45
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 43

def page
  @page
end

#page_size ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


47
48
49
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 47

def page_size
  @page_size
end

#received_after ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


51
52
53
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 51

def received_after
  @received_after
end

#received_before ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


55
56
57
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 55

def received_before
  @received_before
end

#statuses ⇒ Array[Integer]

TODO: Write general description for this method

Returns:

  • (Array[Integer]) 


59
60
61
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 59

def statuses
  @statuses
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 133

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  carrier_dot_numbers =
    hash.key?('carrierDotNumbers') ? hash['carrierDotNumbers'] : SKIP
  carrier_mc_numbers =
    hash.key?('carrierMcNumbers') ? hash['carrierMcNumbers'] : SKIP
  carrier_names = hash.key?('carrierNames') ? hash['carrierNames'] : SKIP
  invoice_numbers =
    hash.key?('invoiceNumbers') ? hash['invoiceNumbers'] : SKIP
  last_updated_after = if hash.key?('lastUpdatedAfter')
                         (DateTimeHelper.from_rfc3339(hash['lastUpdatedAfter']) if hash['lastUpdatedAfter'])
                       else
                         SKIP
                       end
  last_updated_before = if hash.key?('lastUpdatedBefore')
                          (DateTimeHelper.from_rfc3339(hash['lastUpdatedBefore']) if hash['lastUpdatedBefore'])
                        else
                          SKIP
                        end
  load_numbers = hash.key?('loadNumbers') ? hash['loadNumbers'] : SKIP
  page = hash.key?('page') ? hash['page'] : SKIP
  page_size = hash.key?('pageSize') ? hash['pageSize'] : SKIP
  received_after = if hash.key?('receivedAfter')
                     (DateTimeHelper.from_rfc3339(hash['receivedAfter']) if hash['receivedAfter'])
                   else
                     SKIP
                   end
  received_before = if hash.key?('receivedBefore')
                      (DateTimeHelper.from_rfc3339(hash['receivedBefore']) if hash['receivedBefore'])
                    else
                      SKIP
                    end
  statuses = hash.key?('statuses') ? hash['statuses'] : SKIP

  # Create object from extracted values.
  SearchRequest.new(carrier_dot_numbers: carrier_dot_numbers,
                    carrier_mc_numbers: carrier_mc_numbers,
                    carrier_names: carrier_names,
                    invoice_numbers: invoice_numbers,
                    last_updated_after: last_updated_after,
                    last_updated_before: last_updated_before,
                    load_numbers: load_numbers,
                    page: page,
                    page_size: page_size,
                    received_after: received_after,
                    received_before: received_before,
                    statuses: statuses)
end

.names ⇒ Object

A mapping from model property names to API property names.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 62

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['carrier_dot_numbers'] = 'carrierDotNumbers'
  @_hash['carrier_mc_numbers'] = 'carrierMcNumbers'
  @_hash['carrier_names'] = 'carrierNames'
  @_hash['invoice_numbers'] = 'invoiceNumbers'
  @_hash['last_updated_after'] = 'lastUpdatedAfter'
  @_hash['last_updated_before'] = 'lastUpdatedBefore'
  @_hash['load_numbers'] = 'loadNumbers'
  @_hash['page'] = 'page'
  @_hash['page_size'] = 'pageSize'
  @_hash['received_after'] = 'receivedAfter'
  @_hash['received_before'] = 'receivedBefore'
  @_hash['statuses'] = 'statuses'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 98

def self.nullables
  %w[
    carrier_dot_numbers
    carrier_mc_numbers
    carrier_names
    invoice_numbers
    last_updated_after
    last_updated_before
    load_numbers
    received_after
    received_before
    statuses
  ]
end

.optionals ⇒ Object

An array for optional fields



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 80

def self.optionals
  %w[
    carrier_dot_numbers
    carrier_mc_numbers
    carrier_names
    invoice_numbers
    last_updated_after
    last_updated_before
    load_numbers
    page
    page_size
    received_after
    received_before
    statuses
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 212

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} carrier_dot_numbers: #{@carrier_dot_numbers.inspect}, carrier_mc_numbers:"\
  " #{@carrier_mc_numbers.inspect}, carrier_names: #{@carrier_names.inspect}, invoice_numbers:"\
  " #{@invoice_numbers.inspect}, last_updated_after: #{@last_updated_after.inspect},"\
  " last_updated_before: #{@last_updated_before.inspect}, load_numbers:"\
  " #{@load_numbers.inspect}, page: #{@page.inspect}, page_size: #{@page_size.inspect},"\
  " received_after: #{@received_after.inspect}, received_before: #{@received_before.inspect},"\
  " statuses: #{@statuses.inspect}>"
end

#to_custom_last_updated_after ⇒ Object 



184
185
186
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 184

def to_custom_last_updated_after
  DateTimeHelper.to_rfc3339(last_updated_after)
end

#to_custom_last_updated_before ⇒ Object 



188
189
190
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 188

def to_custom_last_updated_before
  DateTimeHelper.to_rfc3339(last_updated_before)
end

#to_custom_received_after ⇒ Object 



192
193
194
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 192

def to_custom_received_after
  DateTimeHelper.to_rfc3339(received_after)
end

#to_custom_received_before ⇒ Object 



196
197
198
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 196

def to_custom_received_before
  DateTimeHelper.to_rfc3339(received_before)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



201
202
203
204
205
206
207
208
209
 
# File 'lib/freight_financials_webhook_ingestion_api/models/search_request.rb', line 201

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} carrier_dot_numbers: #{@carrier_dot_numbers}, carrier_mc_numbers:"\
  " #{@carrier_mc_numbers}, carrier_names: #{@carrier_names}, invoice_numbers:"\
  " #{@invoice_numbers}, last_updated_after: #{@last_updated_after}, last_updated_before:"\
  " #{@last_updated_before}, load_numbers: #{@load_numbers}, page: #{@page}, page_size:"\
  " #{@page_size}, received_after: #{@received_after}, received_before: #{@received_before},"\
  " statuses: #{@statuses}>"
end