Class: NewStoreApi::FulfillmentTaskModel

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/new_store_api/models/fulfillment_task_model.rb

Overview

FulfillmentTaskModel 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(created_on = nil, delivery_booking_error_description = nil, delivery_booking_error_type = nil, delivery_booking_status = nil, documents = nil, fulfillment_request_id = nil, fulfillment_task_id = nil, line_items = nil, order_external_id = nil, order_id = nil, packages = nil, shipping_type = nil, status = nil, updated_at = nil, handed_over_at = SKIP, num_of_items = SKIP, service_level = SKIP, shipping_carrier = SKIP) ⇒ FulfillmentTaskModel

Returns a new instance of FulfillmentTaskModel.



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
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 130

def initialize(created_on = nil, delivery_booking_error_description = nil,
               delivery_booking_error_type = nil,
               delivery_booking_status = nil, documents = nil,
               fulfillment_request_id = nil, fulfillment_task_id = nil,
               line_items = nil, order_external_id = nil, order_id = nil,
               packages = nil, shipping_type = nil, status = nil,
               updated_at = nil, handed_over_at = SKIP, num_of_items = SKIP,
               service_level = SKIP, shipping_carrier = SKIP)
  @created_on = created_on
  @delivery_booking_error_description = delivery_booking_error_description
  @delivery_booking_error_type = delivery_booking_error_type
  @delivery_booking_status = delivery_booking_status
  @documents = documents
  @fulfillment_request_id = fulfillment_request_id
  @fulfillment_task_id = fulfillment_task_id
  @handed_over_at = handed_over_at unless handed_over_at == SKIP
  @line_items = line_items
  @num_of_items = num_of_items unless num_of_items == SKIP
  @order_external_id = order_external_id
  @order_id = order_id
  @packages = packages
  @service_level = service_level unless service_level == SKIP
  @shipping_carrier = shipping_carrier unless shipping_carrier == SKIP
  @shipping_type = shipping_type
  @status = status
  @updated_at = updated_at
end

Instance Attribute Details

#created_on ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


15
16
17
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 15

def created_on
  @created_on
end

#delivery_booking_error_description ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


19
20
21
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 19

def delivery_booking_error_description
  @delivery_booking_error_description
end

#delivery_booking_error_type ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


23
24
25
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 23

def delivery_booking_error_type
  @delivery_booking_error_type
end

#delivery_booking_status ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


27
28
29
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 27

def delivery_booking_status
  @delivery_booking_status
end

#documents ⇒ Array[FulfillmentTaskDocument]

TODO: Write general description for this method

Returns:



31
32
33
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 31

def documents
  @documents
end

#fulfillment_request_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


35
36
37
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 35

def fulfillment_request_id
  @fulfillment_request_id
end

#fulfillment_task_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


39
40
41
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 39

def fulfillment_task_id
  @fulfillment_task_id
end

#handed_over_at ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


43
44
45
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 43

def handed_over_at
  @handed_over_at
end

#line_items ⇒ Array[FulfillmentTaskItemModel]

TODO: Write general description for this method

Returns:



47
48
49
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 47

def line_items
  @line_items
end

#num_of_items ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


51
52
53
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 51

def num_of_items
  @num_of_items
end

#order_external_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


55
56
57
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 55

def order_external_id
  @order_external_id
end

#order_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


59
60
61
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 59

def order_id
  @order_id
end

#packages ⇒ Array[TaskPackage]

TODO: Write general description for this method

Returns:



63
64
65
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 63

def packages
  @packages
end

#service_level ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


67
68
69
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 67

def service_level
  @service_level
end

#shipping_carrier ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


71
72
73
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 71

def shipping_carrier
  @shipping_carrier
end

#shipping_type ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


75
76
77
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 75

def shipping_type
  @shipping_type
end

#status ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


79
80
81
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 79

def status
  @status
end

#updated_at ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


83
84
85
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 83

def updated_at
  @updated_at
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 159

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  created_on = if hash.key?('created_on')
                 (DateTimeHelper.from_rfc3339(hash['created_on']) if hash['created_on'])
               end
  delivery_booking_error_description =
    hash.key?('delivery_booking_error_description') ? hash['delivery_booking_error_description'] : nil
  delivery_booking_error_type =
    hash.key?('delivery_booking_error_type') ? hash['delivery_booking_error_type'] : nil
  delivery_booking_status =
    hash.key?('delivery_booking_status') ? hash['delivery_booking_status'] : nil
  # Parameter is an array, so we need to iterate through it
  documents = nil
  unless hash['documents'].nil?
    documents = []
    hash['documents'].each do |structure|
      documents << (FulfillmentTaskDocument.from_hash(structure) if structure)
    end
  end

  documents = nil unless hash.key?('documents')
  fulfillment_request_id =
    hash.key?('fulfillment_request_id') ? hash['fulfillment_request_id'] : nil
  fulfillment_task_id =
    hash.key?('fulfillment_task_id') ? hash['fulfillment_task_id'] : nil
  # Parameter is an array, so we need to iterate through it
  line_items = nil
  unless hash['line_items'].nil?
    line_items = []
    hash['line_items'].each do |structure|
      line_items << (FulfillmentTaskItemModel.from_hash(structure) if structure)
    end
  end

  line_items = nil unless hash.key?('line_items')
  order_external_id =
    hash.key?('order_external_id') ? hash['order_external_id'] : nil
  order_id = hash.key?('order_id') ? hash['order_id'] : nil
  # Parameter is an array, so we need to iterate through it
  packages = nil
  unless hash['packages'].nil?
    packages = []
    hash['packages'].each do |structure|
      packages << (TaskPackage.from_hash(structure) if structure)
    end
  end

  packages = nil unless hash.key?('packages')
  shipping_type = hash.key?('shipping_type') ? hash['shipping_type'] : nil
  status = hash.key?('status') ? hash['status'] : nil
  updated_at = if hash.key?('updated_at')
                 (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
               end
  handed_over_at = if hash.key?('handed_over_at')
                     (DateTimeHelper.from_rfc3339(hash['handed_over_at']) if hash['handed_over_at'])
                   else
                     SKIP
                   end
  num_of_items = hash.key?('num_of_items') ? hash['num_of_items'] : SKIP
  service_level = hash.key?('service_level') ? hash['service_level'] : SKIP
  shipping_carrier =
    hash.key?('shipping_carrier') ? hash['shipping_carrier'] : SKIP

  # Create object from extracted values.
  FulfillmentTaskModel.new(created_on,
                           delivery_booking_error_description,
                           delivery_booking_error_type,
                           delivery_booking_status,
                           documents,
                           fulfillment_request_id,
                           fulfillment_task_id,
                           line_items,
                           order_external_id,
                           order_id,
                           packages,
                           shipping_type,
                           status,
                           updated_at,
                           handed_over_at,
                           num_of_items,
                           service_level,
                           shipping_carrier)
end

.names ⇒ Object

A mapping from model property names to API property names.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 86

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['created_on'] = 'created_on'
  @_hash['delivery_booking_error_description'] =
    'delivery_booking_error_description'
  @_hash['delivery_booking_error_type'] = 'delivery_booking_error_type'
  @_hash['delivery_booking_status'] = 'delivery_booking_status'
  @_hash['documents'] = 'documents'
  @_hash['fulfillment_request_id'] = 'fulfillment_request_id'
  @_hash['fulfillment_task_id'] = 'fulfillment_task_id'
  @_hash['handed_over_at'] = 'handed_over_at'
  @_hash['line_items'] = 'line_items'
  @_hash['num_of_items'] = 'num_of_items'
  @_hash['order_external_id'] = 'order_external_id'
  @_hash['order_id'] = 'order_id'
  @_hash['packages'] = 'packages'
  @_hash['service_level'] = 'service_level'
  @_hash['shipping_carrier'] = 'shipping_carrier'
  @_hash['shipping_type'] = 'shipping_type'
  @_hash['status'] = 'status'
  @_hash['updated_at'] = 'updated_at'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



121
122
123
124
125
126
127
128
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 121

def self.nullables
  %w[
    handed_over_at
    num_of_items
    service_level
    shipping_carrier
  ]
end

.optionals ⇒ Object

An array for optional fields



111
112
113
114
115
116
117
118
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 111

def self.optionals
  %w[
    handed_over_at
    num_of_items
    service_level
    shipping_carrier
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 272

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} created_on: #{@created_on.inspect}, delivery_booking_error_description:"\
  " #{@delivery_booking_error_description.inspect}, delivery_booking_error_type:"\
  " #{@delivery_booking_error_type.inspect}, delivery_booking_status:"\
  " #{@delivery_booking_status.inspect}, documents: #{@documents.inspect},"\
  " fulfillment_request_id: #{@fulfillment_request_id.inspect}, fulfillment_task_id:"\
  " #{@fulfillment_task_id.inspect}, handed_over_at: #{@handed_over_at.inspect}, line_items:"\
  " #{@line_items.inspect}, num_of_items: #{@num_of_items.inspect}, order_external_id:"\
  " #{@order_external_id.inspect}, order_id: #{@order_id.inspect}, packages:"\
  " #{@packages.inspect}, service_level: #{@service_level.inspect}, shipping_carrier:"\
  " #{@shipping_carrier.inspect}, shipping_type: #{@shipping_type.inspect}, status:"\
  " #{@status.inspect}, updated_at: #{@updated_at.inspect}>"
end

#to_custom_created_on ⇒ Object 



245
246
247
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 245

def to_custom_created_on
  DateTimeHelper.to_rfc3339(created_on)
end

#to_custom_handed_over_at ⇒ Object 



249
250
251
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 249

def to_custom_handed_over_at
  DateTimeHelper.to_rfc3339(handed_over_at)
end

#to_custom_updated_at ⇒ Object 



253
254
255
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 253

def to_custom_updated_at
  DateTimeHelper.to_rfc3339(updated_at)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/new_store_api/models/fulfillment_task_model.rb', line 258

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} created_on: #{@created_on}, delivery_booking_error_description:"\
  " #{@delivery_booking_error_description}, delivery_booking_error_type:"\
  " #{@delivery_booking_error_type}, delivery_booking_status: #{@delivery_booking_status},"\
  " documents: #{@documents}, fulfillment_request_id: #{@fulfillment_request_id},"\
  " fulfillment_task_id: #{@fulfillment_task_id}, handed_over_at: #{@handed_over_at},"\
  " line_items: #{@line_items}, num_of_items: #{@num_of_items}, order_external_id:"\
  " #{@order_external_id}, order_id: #{@order_id}, packages: #{@packages}, service_level:"\
  " #{@service_level}, shipping_carrier: #{@shipping_carrier}, shipping_type:"\
  " #{@shipping_type}, status: #{@status}, updated_at: #{@updated_at}>"
end