Class: Tradenity::OrderLineItem

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderLineItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:'unitPrice')
    self.unit_price = attributes[:'unitPrice']
  end

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

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

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

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

  if attributes.has_key?(:'promotions')
    if (value = attributes[:'promotions']).is_a?(Array)
      self.promotions = value
    end
  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?(:'shippingAmount')
    self.shipping_amount = attributes[:'shippingAmount']
  end

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

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

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

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

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

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

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#discount_amount ⇒ Object

Returns the value of attribute discount_amount.



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

def discount_amount
  @discount_amount
end

#order ⇒ Object

Returns the value of attribute order.



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

def order
  @order
end

#product ⇒ Object

Returns the value of attribute product.



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

def product
  @product
end

#promotions ⇒ Object

Returns the value of attribute promotions.



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

def promotions
  @promotions
end

#quantity ⇒ Object

Returns the value of attribute quantity.



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

def quantity
  @quantity
end

#shipping_amount ⇒ Object

Returns the value of attribute shipping_amount.



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

def shipping_amount
  @shipping_amount
end

#subtotal ⇒ Object

Returns the value of attribute subtotal.



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

def subtotal
  @subtotal
end

#tax_amount ⇒ Object

Returns the value of attribute tax_amount.



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

def tax_amount
  @tax_amount
end

#taxes ⇒ Object

Returns the value of attribute taxes.



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

def taxes
  @taxes
end

#total ⇒ Object

Returns the value of attribute total.



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

def total
  @total
end

#unit_price ⇒ Object

Returns the value of attribute unit_price.



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

def unit_price
  @unit_price
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



369
370
371
 
# File 'lib/tradenity/resources/order_line_item.rb', line 369

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/tradenity/resources/order_line_item.rb', line 61

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'unit_price' => :'unitPrice',
    :'quantity' => :'quantity',
    :'product' => :'product',
    :'taxes' => :'taxes',
    :'promotions' => :'promotions',
    :'subtotal' => :'subtotal',
    :'total' => :'total',
    :'shipping_amount' => :'shippingAmount',
    :'tax_amount' => :'taxAmount',
    :'discount_amount' => :'discountAmount',
    :'order' => :'order'
  }
end

.create_order_line_item(order_line_item, opts = {}) ⇒ OrderLineItem

Create OrderLineItem Create a new OrderLineItem

Parameters:

  • order_line_item —

    Attributes of orderLineItem to create

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

    the optional parameters

Returns:



442
443
444
445
 
# File 'lib/tradenity/resources/order_line_item.rb', line 442

def create_order_line_item(order_line_item, opts = {})
  data, _status_code, _headers = create_order_line_item_with_http_info(order_line_item, opts)
  data
end

.create_order_line_item_with_http_info(order_line_item, opts = {}) ⇒ Array<(OrderLineItem, Fixnum, Hash)>

Create OrderLineItem Create a new OrderLineItem

Parameters:

  • order_line_item —

    Attributes of orderLineItem to create

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

    the optional parameters

Returns:

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

    OrderLineItem data, response status code and response headers



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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/tradenity/resources/order_line_item.rb', line 452

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

  # 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_line_item)
  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 => 'OrderLineItem')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: OrderLineItem#create_order_line_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.delete_by_id(id) ⇒ nil

Delete OrderLineItem Delete an instance of OrderLineItem by its ID.

Parameters:

  • id —

    ID of OrderLineItem to delete.

Returns:

  • (nil) 


433
434
435
 
# File 'lib/tradenity/resources/order_line_item.rb', line 433

def delete_by_id(id)
  delete_order_line_item_by_id(id)
end

.delete_order_line_item_by_id(order_line_item_id, opts = {}) ⇒ nil

Delete OrderLineItem Delete an instance of OrderLineItem by its ID.

Parameters:

  • order_line_item_id —

    ID of orderLineItem to delete.

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

    the optional parameters

Returns:

  • (nil) 


496
497
498
499
 
# File 'lib/tradenity/resources/order_line_item.rb', line 496

def delete_order_line_item_by_id(order_line_item_id, opts = {})
  delete_order_line_item_by_id_with_http_info(order_line_item_id, opts)
  nil
end

.delete_order_line_item_by_id_with_http_info(order_line_item_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete OrderLineItem Delete an instance of OrderLineItem by its ID.

Parameters:

  • order_line_item_id —

    ID of orderLineItem to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/tradenity/resources/order_line_item.rb', line 506

def delete_order_line_item_by_id_with_http_info(order_line_item_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: OrderLineItem.delete_order_line_item_by_id ...'
  end
  # verify the required parameter 'order_line_item_id' is set
  if api_client.config.client_side_validation && order_line_item_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_line_item_id' when calling OrderLineItem.delete_order_line_item_by_id"
  end
  # resource path
  local_var_path = '/orderLineItems/{orderLineItemId}'.sub('{' + 'orderLineItemId' + '}', order_line_item_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: OrderLineItem#delete_order_line_item_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.find_all ⇒ Page<OrderLineItem>

List OrderLineItems Return a list of OrderLineItems

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



401
402
403
 
# File 'lib/tradenity/resources/order_line_item.rb', line 401

def find_all
  list_all_order_line_items
end

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

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

Parameters:

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

    the search parameters

Returns:



409
410
411
 
# File 'lib/tradenity/resources/order_line_item.rb', line 409

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

.find_by_id(id) ⇒ OrderLineItem

Find OrderLineItem Return single instance of OrderLineItem by its ID.

Parameters:

  • id —

    ID of OrderLineItem to return

Returns:



425
426
427
 
# File 'lib/tradenity/resources/order_line_item.rb', line 425

def find_by_id(id)
  get_order_line_item_by_id(id)
end

.find_one_by(opts = {}) ⇒ OrderLineItem

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

Parameters:

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

    search parameters

Returns:



417
418
419
 
# File 'lib/tradenity/resources/order_line_item.rb', line 417

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

.get_order_line_item_by_id(order_line_item_id, opts = {}) ⇒ OrderLineItem

Find OrderLineItem Return single instance of OrderLineItem by its ID.

Parameters:

  • order_line_item_id —

    ID of orderLineItem to return

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

    the optional parameters

Returns:



549
550
551
552
 
# File 'lib/tradenity/resources/order_line_item.rb', line 549

def get_order_line_item_by_id(order_line_item_id, opts = {})
  data, _status_code, _headers = get_order_line_item_by_id_with_http_info(order_line_item_id, opts)
  data
end

.get_order_line_item_by_id_with_http_info(order_line_item_id, opts = {}) ⇒ Array<(OrderLineItem, Fixnum, Hash)>

Find OrderLineItem Return single instance of OrderLineItem by its ID.

Parameters:

  • order_line_item_id —

    ID of orderLineItem to return

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

    the optional parameters

Returns:

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

    OrderLineItem data, response status code and response headers



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/tradenity/resources/order_line_item.rb', line 559

def get_order_line_item_by_id_with_http_info(order_line_item_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: OrderLineItem.get_order_line_item_by_id ...'
  end
  # verify the required parameter 'order_line_item_id' is set
  if api_client.config.client_side_validation && order_line_item_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_line_item_id' when calling OrderLineItem.get_order_line_item_by_id"
  end
  # resource path
  local_var_path = '/orderLineItems/{orderLineItemId}'.sub('{' + 'orderLineItemId' + '}', order_line_item_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 => 'OrderLineItem')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: OrderLineItem#get_order_line_item_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.list_all_order_line_items(opts = {}) ⇒ Page<OrderLineItem>

List OrderLineItems Return a list of OrderLineItems

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



605
606
607
608
 
# File 'lib/tradenity/resources/order_line_item.rb', line 605

def list_all_order_line_items(opts = {})
  data, _status_code, _headers = list_all_order_line_items_with_http_info(opts)
  data
end

.list_all_order_line_items_with_http_info(opts = {}) ⇒ Array<(Page<OrderLineItem>, Fixnum, Hash)>

List OrderLineItems Return a list of OrderLineItems

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<OrderLineItem>, Fixnum, Hash)>) —

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



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
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'lib/tradenity/resources/order_line_item.rb', line 617

def list_all_order_line_items_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: OrderLineItem.list_all_order_line_items ...'
  end
  # resource path
  local_var_path = '/orderLineItems'

  # 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<OrderLineItem>')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: OrderLineItem#list_all_order_line_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.replace_order_line_item_by_id(order_line_item_id, order_line_item, opts = {}) ⇒ OrderLineItem

Replace OrderLineItem Replace all attributes of OrderLineItem

Parameters:

  • order_line_item_id —

    ID of orderLineItem to replace

  • order_line_item —

    Attributes of orderLineItem to replace

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

    the optional parameters

Returns:



661
662
663
664
 
# File 'lib/tradenity/resources/order_line_item.rb', line 661

def replace_order_line_item_by_id(order_line_item_id, order_line_item, opts = {})
  data, _status_code, _headers = replace_order_line_item_by_id_with_http_info(order_line_item_id, order_line_item, opts)
  data
end

.replace_order_line_item_by_id_with_http_info(order_line_item_id, order_line_item, opts = {}) ⇒ Array<(OrderLineItem, Fixnum, Hash)>

Replace OrderLineItem Replace all attributes of OrderLineItem

Parameters:

  • order_line_item_id —

    ID of orderLineItem to replace

  • order_line_item —

    Attributes of orderLineItem to replace

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

    the optional parameters

Returns:

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

    OrderLineItem data, response status code and response headers



672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/tradenity/resources/order_line_item.rb', line 672

def replace_order_line_item_by_id_with_http_info(order_line_item_id, order_line_item, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: OrderLineItem.replace_order_line_item_by_id ...'
  end
  # verify the required parameter 'order_line_item_id' is set
  if api_client.config.client_side_validation && order_line_item_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_line_item_id' when calling OrderLineItem.replace_order_line_item_by_id"
  end
  # verify the required parameter 'order_line_item' is set
  if api_client.config.client_side_validation && order_line_item.nil?
    fail ArgumentError, "Missing the required parameter 'order_line_item' when calling OrderLineItem.replace_order_line_item_by_id"
  end
  # resource path
  local_var_path = '/orderLineItems/{orderLineItemId}'.sub('{' + 'orderLineItemId' + '}', order_line_item_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_line_item)
  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 => 'OrderLineItem')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: OrderLineItem#replace_order_line_item_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/tradenity/resources/order_line_item.rb', line 82

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'unit_price' => :'Integer',
    :'quantity' => :'Integer',
    :'product' => :'Product',
    :'taxes' => :'Array<TaxRate>',
    :'promotions' => :'Array<Promotion>',
    :'subtotal' => :'Integer',
    :'total' => :'Integer',
    :'shipping_amount' => :'Integer',
    :'tax_amount' => :'Integer',
    :'discount_amount' => :'Integer',
    :'order' => :'Order'
  }
end

.update_order_line_item_by_id(order_line_item_id, order_line_item, opts = {}) ⇒ OrderLineItem

Update OrderLineItem Update attributes of OrderLineItem

Parameters:

  • order_line_item_id —

    ID of orderLineItem to update.

  • order_line_item —

    Attributes of orderLineItem to update.

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

    the optional parameters

Returns:



721
722
723
724
 
# File 'lib/tradenity/resources/order_line_item.rb', line 721

def update_order_line_item_by_id(order_line_item_id, order_line_item, opts = {})
  data, _status_code, _headers = update_order_line_item_by_id_with_http_info(order_line_item_id, order_line_item, opts)
  data
end

.update_order_line_item_by_id_with_http_info(order_line_item_id, order_line_item, opts = {}) ⇒ Array<(OrderLineItem, Fixnum, Hash)>

Update OrderLineItem Update attributes of OrderLineItem

Parameters:

  • order_line_item_id —

    ID of orderLineItem to update.

  • order_line_item —

    Attributes of orderLineItem to update.

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

    the optional parameters

Returns:

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

    OrderLineItem data, response status code and response headers



732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
 
# File 'lib/tradenity/resources/order_line_item.rb', line 732

def update_order_line_item_by_id_with_http_info(order_line_item_id, order_line_item, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: OrderLineItem.update_order_line_item_by_id ...'
  end
  # verify the required parameter 'order_line_item_id' is set
  if api_client.config.client_side_validation && order_line_item_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_line_item_id' when calling OrderLineItem.update_order_line_item_by_id"
  end
  # verify the required parameter 'order_line_item' is set
  if api_client.config.client_side_validation && order_line_item.nil?
    fail ArgumentError, "Missing the required parameter 'order_line_item' when calling OrderLineItem.update_order_line_item_by_id"
  end
  # resource path
  local_var_path = '/orderLineItems/{orderLineItemId}'.sub('{' + 'orderLineItemId' + '}', order_line_item_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_line_item)
  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 => 'OrderLineItem')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: OrderLineItem#update_order_line_item_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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/tradenity/resources/order_line_item.rb', line 233

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 &&
      unit_price == o.unit_price &&
      quantity == o.quantity &&
      product == o.product &&
      taxes == o.taxes &&
      promotions == o.promotions &&
      subtotal == o.subtotal &&
      total == o.total &&
      shipping_amount == o.shipping_amount &&
      tax_amount == o.tax_amount &&
      discount_amount == o.discount_amount &&
      order == o.order
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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/tradenity/resources/order_line_item.rb', line 288

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/tradenity/resources/order_line_item.rb', line 354

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/tradenity/resources/order_line_item.rb', line 267

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 OrderLineItem Create a new OrderLineItem



375
376
377
378
379
 
# File 'lib/tradenity/resources/order_line_item.rb', line 375

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

#delete ⇒ nil

Delete OrderLineItem Delete this instance of OrderLineItem.

Returns:

  • (nil) 


391
392
393
 
# File 'lib/tradenity/resources/order_line_item.rb', line 391

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


254
255
256
 
# File 'lib/tradenity/resources/order_line_item.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



260
261
262
 
# File 'lib/tradenity/resources/order_line_item.rb', line 260

def hash
  [__meta, created_at, updated_at, unit_price, quantity, product, taxes, promotions, subtotal, total, shipping_amount, tax_amount, discount_amount, order].hash
end

#id ⇒ Object 



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/tradenity/resources/order_line_item.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_line_item.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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/tradenity/resources/order_line_item.rb', line 200

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

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

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

  if @order.nil?
    invalid_properties.push('invalid value for "order", order 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



334
335
336
 
# File 'lib/tradenity/resources/order_line_item.rb', line 334

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



340
341
342
343
344
345
346
347
348
 
# File 'lib/tradenity/resources/order_line_item.rb', line 340

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



328
329
330
 
# File 'lib/tradenity/resources/order_line_item.rb', line 328

def to_s
  to_hash.to_s
end

#update ⇒ OrderLineItem

Update OrderLineItem Update attributes of OrderLineItem

Returns:



384
385
386
 
# File 'lib/tradenity/resources/order_line_item.rb', line 384

def update
  self.class.update_order_line_item_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



223
224
225
226
227
228
229
 
# File 'lib/tradenity/resources/order_line_item.rb', line 223

def valid?
  return false if @unit_price.nil?
  return false if @quantity.nil?
  return false if @product.nil?
  return false if @order.nil?
  true
end