Class: Tradenity::Order

Inherits:
Object
  • Object
show all
Defined in:
lib/tradenity/resources/order.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Order

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/tradenity/resources/order.rb', line 158

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'__meta')
    self.__meta = attributes[:'__meta']
  end

  if attributes.has_key?(:'createdAt')
    self.created_at = attributes[:'createdAt']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'updatedAt')
    self.updated_at = attributes[:'updatedAt']
  end

  if attributes.has_key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'subtotal')
    self.subtotal = attributes[:'subtotal']
  end

  if attributes.has_key?(:'total')
    self.total = attributes[:'total']
  end

  if attributes.has_key?(:'shippingCost')
    self.shipping_cost = attributes[:'shippingCost']
  end

  if attributes.has_key?(:'shipping_cost')
    self.shipping_cost = attributes[:'shipping_cost']
  end

  if attributes.has_key?(:'itemsTaxAmount')
    self.items_tax_amount = attributes[:'itemsTaxAmount']
  end

  if attributes.has_key?(:'items_tax_amount')
    self.items_tax_amount = attributes[:'items_tax_amount']
  end

  if attributes.has_key?(:'totalItemsDiscount')
    self.total_items_discount = attributes[:'totalItemsDiscount']
  end

  if attributes.has_key?(:'total_items_discount')
    self.total_items_discount = attributes[:'total_items_discount']
  end

  if attributes.has_key?(:'purchaseDay')
    self.purchase_day = attributes[:'purchaseDay']
  end

  if attributes.has_key?(:'purchase_day')
    self.purchase_day = attributes[:'purchase_day']
  end

  if attributes.has_key?(:'purchasedAt')
    self.purchased_at = attributes[:'purchasedAt']
  end

  if attributes.has_key?(:'purchased_at')
    self.purchased_at = attributes[:'purchased_at']
  end

  if attributes.has_key?(:'completedAt')
    self.completed_at = attributes[:'completedAt']
  end

  if attributes.has_key?(:'completed_at')
    self.completed_at = attributes[:'completed_at']
  end

  if attributes.has_key?(:'customer')
    self.customer = attributes[:'customer']
  end

  if attributes.has_key?(:'shippingAddress')
    self.shipping_address = attributes[:'shippingAddress']
  end

  if attributes.has_key?(:'shipping_address')
    self.shipping_address = attributes[:'shipping_address']
  end

  if attributes.has_key?(:'billingAddress')
    self.billing_address = attributes[:'billingAddress']
  end

  if attributes.has_key?(:'billing_address')
    self.billing_address = attributes[:'billing_address']
  end

  if attributes.has_key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.has_key?(:'shippingMethod')
    self.shipping_method = attributes[:'shippingMethod']
  end

  if attributes.has_key?(:'shipping_method')
    self.shipping_method = attributes[:'shipping_method']
  end

  if attributes.has_key?(:'promotions')
    if (value = attributes[:'promotions']).is_a?(Array)
      self.promotions = value
    end
  end

  if attributes.has_key?(:'coupons')
    if (value = attributes[:'coupons']).is_a?(Array)
      self.coupons = value
    end
  end

  if attributes.has_key?(:'items')
    if (value = attributes[:'items']).is_a?(Array)
      self.items = value
    end
  end

  if attributes.has_key?(:'payments')
    if (value = attributes[:'payments']).is_a?(Array)
      self.payments = value
    end
  end

  if attributes.has_key?(:'transactions')
    if (value = attributes[:'transactions']).is_a?(Array)
      self.transactions = value
    end
  end
end

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



32
33
34
 
# File 'lib/tradenity/resources/order.rb', line 32

def __meta
  @__meta
end

#billing_address ⇒ Object

Returns the value of attribute billing_address.



60
61
62
 
# File 'lib/tradenity/resources/order.rb', line 60

def billing_address
  @billing_address
end

#completed_at ⇒ Object

Returns the value of attribute completed_at.



54
55
56
 
# File 'lib/tradenity/resources/order.rb', line 54

def completed_at
  @completed_at
end

#coupons ⇒ Object

Returns the value of attribute coupons.



68
69
70
 
# File 'lib/tradenity/resources/order.rb', line 68

def coupons
  @coupons
end

#created_at ⇒ Object

Returns the value of attribute created_at.



34
35
36
 
# File 'lib/tradenity/resources/order.rb', line 34

def created_at
  @created_at
end

#currency ⇒ Object

Returns the value of attribute currency.



62
63
64
 
# File 'lib/tradenity/resources/order.rb', line 62

def currency
  @currency
end

#customer ⇒ Object

Returns the value of attribute customer.



56
57
58
 
# File 'lib/tradenity/resources/order.rb', line 56

def customer
  @customer
end

#items ⇒ Object

Returns the value of attribute items.



70
71
72
 
# File 'lib/tradenity/resources/order.rb', line 70

def items
  @items
end

#items_tax_amount ⇒ Object

Returns the value of attribute items_tax_amount.



46
47
48
 
# File 'lib/tradenity/resources/order.rb', line 46

def items_tax_amount
  @items_tax_amount
end

#payments ⇒ Object

Returns the value of attribute payments.



72
73
74
 
# File 'lib/tradenity/resources/order.rb', line 72

def payments
  @payments
end

#promotions ⇒ Object

Returns the value of attribute promotions.



66
67
68
 
# File 'lib/tradenity/resources/order.rb', line 66

def promotions
  @promotions
end

#purchase_day ⇒ Object

Returns the value of attribute purchase_day.



50
51
52
 
# File 'lib/tradenity/resources/order.rb', line 50

def purchase_day
  @purchase_day
end

#purchased_at ⇒ Object

Returns the value of attribute purchased_at.



52
53
54
 
# File 'lib/tradenity/resources/order.rb', line 52

def purchased_at
  @purchased_at
end

#shipping_address ⇒ Object

Returns the value of attribute shipping_address.



58
59
60
 
# File 'lib/tradenity/resources/order.rb', line 58

def shipping_address
  @shipping_address
end

#shipping_cost ⇒ Object

Returns the value of attribute shipping_cost.



44
45
46
 
# File 'lib/tradenity/resources/order.rb', line 44

def shipping_cost
  @shipping_cost
end

#shipping_method ⇒ Object

Returns the value of attribute shipping_method.



64
65
66
 
# File 'lib/tradenity/resources/order.rb', line 64

def shipping_method
  @shipping_method
end

#status ⇒ Object

Returns the value of attribute status.



38
39
40
 
# File 'lib/tradenity/resources/order.rb', line 38

def status
  @status
end

#subtotal ⇒ Object

Returns the value of attribute subtotal.



40
41
42
 
# File 'lib/tradenity/resources/order.rb', line 40

def subtotal
  @subtotal
end

#total ⇒ Object

Returns the value of attribute total.



42
43
44
 
# File 'lib/tradenity/resources/order.rb', line 42

def total
  @total
end

#total_items_discount ⇒ Object

Returns the value of attribute total_items_discount.



48
49
50
 
# File 'lib/tradenity/resources/order.rb', line 48

def total_items_discount
  @total_items_discount
end

#transactions ⇒ Object

Returns the value of attribute transactions.



74
75
76
 
# File 'lib/tradenity/resources/order.rb', line 74

def transactions
  @transactions
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



36
37
38
 
# File 'lib/tradenity/resources/order.rb', line 36

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



521
522
523
 
# File 'lib/tradenity/resources/order.rb', line 521

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



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
 
# File 'lib/tradenity/resources/order.rb', line 99

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'status' => :'status',
    :'subtotal' => :'subtotal',
    :'total' => :'total',
    :'shipping_cost' => :'shippingCost',
    :'items_tax_amount' => :'itemsTaxAmount',
    :'total_items_discount' => :'totalItemsDiscount',
    :'purchase_day' => :'purchaseDay',
    :'purchased_at' => :'purchasedAt',
    :'completed_at' => :'completedAt',
    :'customer' => :'customer',
    :'shipping_address' => :'shippingAddress',
    :'billing_address' => :'billingAddress',
    :'currency' => :'currency',
    :'shipping_method' => :'shippingMethod',
    :'promotions' => :'promotions',
    :'coupons' => :'coupons',
    :'items' => :'items',
    :'payments' => :'payments',
    :'transactions' => :'transactions'
  }
end

.create_order(order, opts = {}) ⇒ Order

Create Order Create a new Order

Parameters:

  • order —

    Attributes of order to create

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



594
595
596
597
 
# File 'lib/tradenity/resources/order.rb', line 594

def create_order(order, opts = {})
  data, _status_code, _headers = create_order_with_http_info(order, opts)
  data
end

.create_order_with_http_info(order, opts = {}) ⇒ Array<(Order, Fixnum, Hash)>

Create Order Create a new Order

Parameters:

  • order —

    Attributes of order to create

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Order, Fixnum, Hash)>) —

    Order data, response status code and response headers



604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
 
# File 'lib/tradenity/resources/order.rb', line 604

def create_order_with_http_info(order, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Order.create_order ...'
  end
  # verify the required parameter 'order' is set
  if api_client.config.client_side_validation && order.nil?
    fail ArgumentError, "Missing the required parameter 'order' when calling Order.create_order"
  end
  # resource path
  local_var_path = '/orders'

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = api_client.object_to_http_body(order)
  auth_names = []
  data, status_code, headers = api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Order')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Order#create_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.delete_by_id(id) ⇒ nil

Delete Order Delete an instance of Order by its ID.

Parameters:

  • id —

    ID of Order to delete.

Returns:

  • (nil) 


585
586
587
 
# File 'lib/tradenity/resources/order.rb', line 585

def delete_by_id(id)
  delete_order_by_id(id)
end

.delete_order_by_id(order_id, opts = {}) ⇒ nil

Delete Order Delete an instance of Order by its ID.

Parameters:

  • order_id —

    ID of order to delete.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


648
649
650
651
 
# File 'lib/tradenity/resources/order.rb', line 648

def delete_order_by_id(order_id, opts = {})
  delete_order_by_id_with_http_info(order_id, opts)
  nil
end

.delete_order_by_id_with_http_info(order_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Order Delete an instance of Order by its ID.

Parameters:

  • order_id —

    ID of order to delete.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
 
# File 'lib/tradenity/resources/order.rb', line 658

def delete_order_by_id_with_http_info(order_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Order.delete_order_by_id ...'
  end
  # verify the required parameter 'order_id' is set
  if api_client.config.client_side_validation && order_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_id' when calling Order.delete_order_by_id"
  end
  # resource path
  local_var_path = '/orders/{orderId}'.sub('{' + 'orderId' + '}', order_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Order#delete_order_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.find_all ⇒ Page<Order>

List Orders Return a list of Orders

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



553
554
555
 
# File 'lib/tradenity/resources/order.rb', line 553

def find_all
  list_all_orders
end

.find_all_by(opts = {}) ⇒ Page<Collection>

Find List of Order Return multiple instances of Order by its attributes.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the search parameters

Returns:



561
562
563
 
# File 'lib/tradenity/resources/order.rb', line 561

def find_all_by(opts = {})
  list_all_orders(opts)
end

.find_by_id(id) ⇒ Order

Find Order Return single instance of Order by its ID.

Parameters:

  • id —

    ID of Order to return

Returns:



577
578
579
 
# File 'lib/tradenity/resources/order.rb', line 577

def find_by_id(id)
  get_order_by_id(id)
end

.find_one_by(opts = {}) ⇒ Order

Find Order by its parameters Return single instance of Collection by its attributes.

Parameters:

  • opts (Hash) (defaults to: {}) —

    search parameters

Returns:



569
570
571
 
# File 'lib/tradenity/resources/order.rb', line 569

def find_one_by(opts = {})
  list_all_orders(opts)[0]
end

.get_order_by_id(order_id, opts = {}) ⇒ Order

Find Order Return single instance of Order by its ID.

Parameters:

  • order_id —

    ID of order to return

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



701
702
703
704
 
# File 'lib/tradenity/resources/order.rb', line 701

def get_order_by_id(order_id, opts = {})
  data, _status_code, _headers = get_order_by_id_with_http_info(order_id, opts)
  data
end

.get_order_by_id_with_http_info(order_id, opts = {}) ⇒ Array<(Order, Fixnum, Hash)>

Find Order Return single instance of Order by its ID.

Parameters:

  • order_id —

    ID of order to return

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Order, Fixnum, Hash)>) —

    Order data, response status code and response headers



711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
 
# File 'lib/tradenity/resources/order.rb', line 711

def get_order_by_id_with_http_info(order_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Order.get_order_by_id ...'
  end
  # verify the required parameter 'order_id' is set
  if api_client.config.client_side_validation && order_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_id' when calling Order.get_order_by_id"
  end
  # resource path
  local_var_path = '/orders/{orderId}'.sub('{' + 'orderId' + '}', order_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Order')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Order#get_order_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.list_all_orders(opts = {}) ⇒ Page<Order>

List Orders Return a list of Orders

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



757
758
759
760
 
# File 'lib/tradenity/resources/order.rb', line 757

def list_all_orders(opts = {})
  data, _status_code, _headers = list_all_orders_with_http_info(opts)
  data
end

.list_all_orders_with_http_info(opts = {}) ⇒ Array<(Page<Order>, Fixnum, Hash)>

List Orders Return a list of Orders

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:

  • (Array<(Page<Order>, Fixnum, Hash)>) —

    Page<Order> data, response status code and response headers



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'lib/tradenity/resources/order.rb', line 769

def list_all_orders_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Order.list_all_orders ...'
  end
  # resource path
  local_var_path = '/orders'

  # query parameters
  query_params = opts
  # query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  # query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  # query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Page<Order>')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Order#list_all_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.replace_order_by_id(order_id, order, opts = {}) ⇒ Order

Replace Order Replace all attributes of Order

Parameters:

  • order_id —

    ID of order to replace

  • order —

    Attributes of order to replace

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



813
814
815
816
 
# File 'lib/tradenity/resources/order.rb', line 813

def replace_order_by_id(order_id, order, opts = {})
  data, _status_code, _headers = replace_order_by_id_with_http_info(order_id, order, opts)
  data
end

.replace_order_by_id_with_http_info(order_id, order, opts = {}) ⇒ Array<(Order, Fixnum, Hash)>

Replace Order Replace all attributes of Order

Parameters:

  • order_id —

    ID of order to replace

  • order —

    Attributes of order to replace

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Order, Fixnum, Hash)>) —

    Order data, response status code and response headers



824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'lib/tradenity/resources/order.rb', line 824

def replace_order_by_id_with_http_info(order_id, order, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Order.replace_order_by_id ...'
  end
  # verify the required parameter 'order_id' is set
  if api_client.config.client_side_validation && order_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_id' when calling Order.replace_order_by_id"
  end
  # verify the required parameter 'order' is set
  if api_client.config.client_side_validation && order.nil?
    fail ArgumentError, "Missing the required parameter 'order' when calling Order.replace_order_by_id"
  end
  # resource path
  local_var_path = '/orders/{orderId}'.sub('{' + 'orderId' + '}', order_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = api_client.object_to_http_body(order)
  auth_names = []
  data, status_code, headers = api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Order')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Order#replace_order_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/tradenity/resources/order.rb', line 128

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'status' => :'String',
    :'subtotal' => :'Integer',
    :'total' => :'Integer',
    :'shipping_cost' => :'Integer',
    :'items_tax_amount' => :'Integer',
    :'total_items_discount' => :'Integer',
    :'purchase_day' => :'Date',
    :'purchased_at' => :'DateTime',
    :'completed_at' => :'DateTime',
    :'customer' => :'Customer',
    :'shipping_address' => :'Address',
    :'billing_address' => :'Address',
    :'currency' => :'Currency',
    :'shipping_method' => :'ShippingMethod',
    :'promotions' => :'Array<Promotion>',
    :'coupons' => :'Array<Coupon>',
    :'items' => :'Array<OrderLineItem>',
    :'payments' => :'Array<Payment>',
    :'transactions' => :'Array<PaymentTransaction>'
  }
end

.update_order_by_id(order_id, order, opts = {}) ⇒ Order

Update Order Update attributes of Order

Parameters:

  • order_id —

    ID of order to update.

  • order —

    Attributes of order to update.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



873
874
875
876
 
# File 'lib/tradenity/resources/order.rb', line 873

def update_order_by_id(order_id, order, opts = {})
  data, _status_code, _headers = update_order_by_id_with_http_info(order_id, order, opts)
  data
end

.update_order_by_id_with_http_info(order_id, order, opts = {}) ⇒ Array<(Order, Fixnum, Hash)>

Update Order Update attributes of Order

Parameters:

  • order_id —

    ID of order to update.

  • order —

    Attributes of order to update.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Order, Fixnum, Hash)>) —

    Order data, response status code and response headers



884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/tradenity/resources/order.rb', line 884

def update_order_by_id_with_http_info(order_id, order, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Order.update_order_by_id ...'
  end
  # verify the required parameter 'order_id' is set
  if api_client.config.client_side_validation && order_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_id' when calling Order.update_order_by_id"
  end
  # verify the required parameter 'order' is set
  if api_client.config.client_side_validation && order.nil?
    fail ArgumentError, "Missing the required parameter 'order' when calling Order.update_order_by_id"
  end
  # resource path
  local_var_path = '/orders/{orderId}'.sub('{' + 'orderId' + '}', order_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = api_client.object_to_http_body(order)
  auth_names = []
  data, status_code, headers = api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Order')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Order#update_order_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/tradenity/resources/order.rb', line 377

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      __meta == o.__meta &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      status == o.status &&
      subtotal == o.subtotal &&
      total == o.total &&
      shipping_cost == o.shipping_cost &&
      items_tax_amount == o.items_tax_amount &&
      total_items_discount == o.total_items_discount &&
      purchase_day == o.purchase_day &&
      purchased_at == o.purchased_at &&
      completed_at == o.completed_at &&
      customer == o.customer &&
      shipping_address == o.shipping_address &&
      billing_address == o.billing_address &&
      currency == o.currency &&
      shipping_method == o.shipping_method &&
      promotions == o.promotions &&
      coupons == o.coupons &&
      items == o.items &&
      payments == o.payments &&
      transactions == o.transactions
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/tradenity/resources/order.rb', line 440

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Tradenity.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/tradenity/resources/order.rb', line 506

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/tradenity/resources/order.rb', line 419

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#create ⇒ Object

Create Order Create a new Order



527
528
529
530
531
 
# File 'lib/tradenity/resources/order.rb', line 527

def create
  data = self.class.create_order(self)
  self.id = data.id
  data
end

#delete ⇒ nil

Delete Order Delete this instance of Order.

Returns:

  • (nil) 


543
544
545
 
# File 'lib/tradenity/resources/order.rb', line 543

def delete
  self.class.delete_order_by_id(self.id)
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


406
407
408
 
# File 'lib/tradenity/resources/order.rb', line 406

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



412
413
414
 
# File 'lib/tradenity/resources/order.rb', line 412

def hash
  [__meta, created_at, updated_at, status, subtotal, total, shipping_cost, items_tax_amount, total_items_discount, purchase_day, purchased_at, completed_at, customer, shipping_address, billing_address, currency, shipping_method, promotions, coupons, items, payments, transactions].hash
end

#id ⇒ Object 



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/tradenity/resources/order.rb', line 21

def id
  if instance_variable_defined?('@id') && @id != nil
    @id
  elsif __meta && __meta.href != nil
    @id = __meta.href.split('/')[-1]
    @id
  else
    nil
  end
end

#id=(id) ⇒ Object 



17
18
19
 
# File 'lib/tradenity/resources/order.rb', line 17

def id=(id)
  @id = id
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/tradenity/resources/order.rb', line 312

def list_invalid_properties
  invalid_properties = Array.new
  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @subtotal.nil?
    invalid_properties.push('invalid value for "subtotal", subtotal cannot be nil.')
  end

  if @total.nil?
    invalid_properties.push('invalid value for "total", total cannot be nil.')
  end

  if @purchase_day.nil?
    invalid_properties.push('invalid value for "purchase_day", purchase_day cannot be nil.')
  end

  if @purchased_at.nil?
    invalid_properties.push('invalid value for "purchased_at", purchased_at cannot be nil.')
  end

  if @customer.nil?
    invalid_properties.push('invalid value for "customer", customer cannot be nil.')
  end

  if @billing_address.nil?
    invalid_properties.push('invalid value for "billing_address", billing_address cannot be nil.')
  end

  if @currency.nil?
    invalid_properties.push('invalid value for "currency", currency cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



486
487
488
 
# File 'lib/tradenity/resources/order.rb', line 486

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



492
493
494
495
496
497
498
499
500
 
# File 'lib/tradenity/resources/order.rb', line 492

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



480
481
482
 
# File 'lib/tradenity/resources/order.rb', line 480

def to_s
  to_hash.to_s
end

#update ⇒ Order

Update Order Update attributes of Order

Returns:



536
537
538
 
# File 'lib/tradenity/resources/order.rb', line 536

def update
  self.class.update_order_by_id(self.id, self)
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/tradenity/resources/order.rb', line 351

def valid?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ['new', 'inProgress', 'pending', 'shipping', 'completed', 'refunded'])
  return false unless status_validator.valid?(@status)
  return false if @subtotal.nil?
  return false if @total.nil?
  return false if @purchase_day.nil?
  return false if @purchased_at.nil?
  return false if @customer.nil?
  return false if @billing_address.nil?
  return false if @currency.nil?
  true
end