Class: Tradenity::Customer

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Customer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/tradenity/resources/customer.rb', line 122

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'photo')
    self.photo = attributes[:'photo']
  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?(:'shippingAddress')
    self.shipping_address = attributes[:'shippingAddress']
  end

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

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

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

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#billing_address ⇒ Object

Returns the value of attribute billing_address.



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

def billing_address
  @billing_address
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#customer_groups ⇒ Object

Returns the value of attribute customer_groups.



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

def customer_groups
  @customer_groups
end

#email ⇒ Object

Returns the value of attribute email.



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

def email
  @email
end

#first_name ⇒ Object

Returns the value of attribute first_name.



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

def first_name
  @first_name
end

#last_name ⇒ Object

Returns the value of attribute last_name.



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

def last_name
  @last_name
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#photo ⇒ Object

Returns the value of attribute photo.



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

def photo
  @photo
end

#shipping_address ⇒ Object

Returns the value of attribute shipping_address.



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

def shipping_address
  @shipping_address
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

#username ⇒ Object

Returns the value of attribute username.



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

def username
  @username
end

Class Method Details

.api_client ⇒ Object 



408
409
410
 
# File 'lib/tradenity/resources/customer.rb', line 408

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'email' => :'email',
    :'username' => :'username',
    :'password' => :'password',
    :'status' => :'status',
    :'photo' => :'photo',
    :'billing_address' => :'billingAddress',
    :'shipping_address' => :'shippingAddress',
    :'customer_groups' => :'customerGroups'
  }
end

.create_customer(customer, opts = {}) ⇒ Customer

Create Customer Create a new Customer

Parameters:

  • customer —

    Attributes of customer to create

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

    the optional parameters

Returns:



481
482
483
484
 
# File 'lib/tradenity/resources/customer.rb', line 481

def create_customer(customer, opts = {})
  data, _status_code, _headers = create_customer_with_http_info(customer, opts)
  data
end

.create_customer_with_http_info(customer, opts = {}) ⇒ Array<(Customer, Fixnum, Hash)>

Create Customer Create a new Customer

Parameters:

  • customer —

    Attributes of customer to create

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

    the optional parameters

Returns:

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

    Customer data, response status code and response headers



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/tradenity/resources/customer.rb', line 491

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

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

.delete_by_id(id) ⇒ nil

Delete Customer Delete an instance of Customer by its ID.

Parameters:

  • id —

    ID of Customer to delete.

Returns:

  • (nil) 


472
473
474
 
# File 'lib/tradenity/resources/customer.rb', line 472

def delete_by_id(id)
  delete_customer_by_id(id)
end

.delete_customer_by_id(customer_id, opts = {}) ⇒ nil

Delete Customer Delete an instance of Customer by its ID.

Parameters:

  • customer_id —

    ID of customer to delete.

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_customer_by_id(customer_id, opts = {})
  delete_customer_by_id_with_http_info(customer_id, opts)
  nil
end

.delete_customer_by_id_with_http_info(customer_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Customer Delete an instance of Customer by its ID.

Parameters:

  • customer_id —

    ID of customer to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/tradenity/resources/customer.rb', line 545

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

.find_all ⇒ Page<Customer>

List Customers Return a list of Customers

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



440
441
442
 
# File 'lib/tradenity/resources/customer.rb', line 440

def find_all
  list_all_customers
end

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

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

Parameters:

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

    the search parameters

Returns:



448
449
450
 
# File 'lib/tradenity/resources/customer.rb', line 448

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

.find_by_id(id) ⇒ Customer

Find Customer Return single instance of Customer by its ID.

Parameters:

  • id —

    ID of Customer to return

Returns:



464
465
466
 
# File 'lib/tradenity/resources/customer.rb', line 464

def find_by_id(id)
  get_customer_by_id(id)
end

.find_one_by(opts = {}) ⇒ Customer

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

Parameters:

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

    search parameters

Returns:



456
457
458
 
# File 'lib/tradenity/resources/customer.rb', line 456

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

.get_customer_by_id(customer_id, opts = {}) ⇒ Customer

Find Customer Return single instance of Customer by its ID.

Parameters:

  • customer_id —

    ID of customer to return

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

    the optional parameters

Returns:



588
589
590
591
 
# File 'lib/tradenity/resources/customer.rb', line 588

def get_customer_by_id(customer_id, opts = {})
  data, _status_code, _headers = get_customer_by_id_with_http_info(customer_id, opts)
  data
end

.get_customer_by_id_with_http_info(customer_id, opts = {}) ⇒ Array<(Customer, Fixnum, Hash)>

Find Customer Return single instance of Customer by its ID.

Parameters:

  • customer_id —

    ID of customer to return

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

    the optional parameters

Returns:

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

    Customer data, response status code and response headers



598
599
600
601
602
603
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
 
# File 'lib/tradenity/resources/customer.rb', line 598

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

.list_all_customers(opts = {}) ⇒ Page<Customer>

List Customers Return a list of Customers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



644
645
646
647
 
# File 'lib/tradenity/resources/customer.rb', line 644

def list_all_customers(opts = {})
  data, _status_code, _headers = list_all_customers_with_http_info(opts)
  data
end

.list_all_customers_with_http_info(opts = {}) ⇒ Array<(Page<Customer>, Fixnum, Hash)>

List Customers Return a list of Customers

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

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



656
657
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
 
# File 'lib/tradenity/resources/customer.rb', line 656

def list_all_customers_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Customer.list_all_customers ...'
  end
  # resource path
  local_var_path = '/customers'

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

.replace_customer_by_id(customer_id, customer, opts = {}) ⇒ Customer

Replace Customer Replace all attributes of Customer

Parameters:

  • customer_id —

    ID of customer to replace

  • customer —

    Attributes of customer to replace

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

    the optional parameters

Returns:



700
701
702
703
 
# File 'lib/tradenity/resources/customer.rb', line 700

def replace_customer_by_id(customer_id, customer, opts = {})
  data, _status_code, _headers = replace_customer_by_id_with_http_info(customer_id, customer, opts)
  data
end

.replace_customer_by_id_with_http_info(customer_id, customer, opts = {}) ⇒ Array<(Customer, Fixnum, Hash)>

Replace Customer Replace all attributes of Customer

Parameters:

  • customer_id —

    ID of customer to replace

  • customer —

    Attributes of customer to replace

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

    the optional parameters

Returns:

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

    Customer 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
750
751
752
753
 
# File 'lib/tradenity/resources/customer.rb', line 711

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

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/tradenity/resources/customer.rb', line 101

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'email' => :'String',
    :'username' => :'String',
    :'password' => :'String',
    :'status' => :'String',
    :'photo' => :'Photo',
    :'billing_address' => :'Address',
    :'shipping_address' => :'Address',
    :'customer_groups' => :'Array<CustomerGroup>'
  }
end

.update_customer_by_id(customer_id, customer, opts = {}) ⇒ Customer

Update Customer Update attributes of Customer

Parameters:

  • customer_id —

    ID of customer to update.

  • customer —

    Attributes of customer to update.

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

    the optional parameters

Returns:



760
761
762
763
 
# File 'lib/tradenity/resources/customer.rb', line 760

def update_customer_by_id(customer_id, customer, opts = {})
  data, _status_code, _headers = update_customer_by_id_with_http_info(customer_id, customer, opts)
  data
end

.update_customer_by_id_with_http_info(customer_id, customer, opts = {}) ⇒ Array<(Customer, Fixnum, Hash)>

Update Customer Update attributes of Customer

Parameters:

  • customer_id —

    ID of customer to update.

  • customer —

    Attributes of customer to update.

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

    the optional parameters

Returns:

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

    Customer data, response status code and response headers



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
807
808
809
810
811
812
813
 
# File 'lib/tradenity/resources/customer.rb', line 771

def update_customer_by_id_with_http_info(customer_id, customer, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Customer.update_customer_by_id ...'
  end
  # verify the required parameter 'customer_id' is set
  if api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling Customer.update_customer_by_id"
  end
  # verify the required parameter 'customer' is set
  if api_client.config.client_side_validation && customer.nil?
    fail ArgumentError, "Missing the required parameter 'customer' when calling Customer.update_customer_by_id"
  end
  # resource path
  local_var_path = '/customers/{customerId}'.sub('{' + 'customerId' + '}', customer_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(customer)
  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 => 'Customer')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Customer#update_customer_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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/tradenity/resources/customer.rb', line 273

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 &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      email == o.email &&
      username == o.username &&
      password == o.password &&
      status == o.status &&
      photo == o.photo &&
      billing_address == o.billing_address &&
      shipping_address == o.shipping_address &&
      customer_groups == o.customer_groups
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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/tradenity/resources/customer.rb', line 327

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



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/tradenity/resources/customer.rb', line 393

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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/tradenity/resources/customer.rb', line 306

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



414
415
416
417
418
 
# File 'lib/tradenity/resources/customer.rb', line 414

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

#delete ⇒ nil

Delete Customer Delete this instance of Customer.

Returns:

  • (nil) 


430
431
432
 
# File 'lib/tradenity/resources/customer.rb', line 430

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


293
294
295
 
# File 'lib/tradenity/resources/customer.rb', line 293

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



299
300
301
 
# File 'lib/tradenity/resources/customer.rb', line 299

def hash
  [__meta, created_at, updated_at, first_name, last_name, email, username, password, status, photo, billing_address, shipping_address, customer_groups].hash
end

#id ⇒ Object 



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



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

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

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

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

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

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

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



373
374
375
 
# File 'lib/tradenity/resources/customer.rb', line 373

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



379
380
381
382
383
384
385
386
387
 
# File 'lib/tradenity/resources/customer.rb', line 379

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



367
368
369
 
# File 'lib/tradenity/resources/customer.rb', line 367

def to_s
  to_hash.to_s
end

#update ⇒ Customer

Update Customer Update attributes of Customer

Returns:



423
424
425
 
# File 'lib/tradenity/resources/customer.rb', line 423

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



249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/tradenity/resources/customer.rb', line 249

def valid?
  return false if @first_name.nil?
  return false if @last_name.nil?
  return false if @email.nil?
  return false if @username.nil?
  return false if @password.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ['enabled', 'disabled'])
  return false unless status_validator.valid?(@status)
  true
end