Class: Tradenity::StoreProfile

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StoreProfile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#billing_info ⇒ Object

Returns the value of attribute billing_info.



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

def billing_info
  @billing_info
end

#contact_info ⇒ Object

Returns the value of attribute contact_info.



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

def contact_info
  @contact_info
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#facebook ⇒ Object

Returns the value of attribute facebook.



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

def facebook
  @facebook
end

#instagram ⇒ Object

Returns the value of attribute instagram.



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

def instagram
  @instagram
end

#linkedin ⇒ Object

Returns the value of attribute linkedin.



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

def linkedin
  @linkedin
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#pinterest ⇒ Object

Returns the value of attribute pinterest.



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

def pinterest
  @pinterest
end

#twitter ⇒ Object

Returns the value of attribute twitter.



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

def twitter
  @twitter
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

#youtube ⇒ Object

Returns the value of attribute youtube.



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

def youtube
  @youtube
end

Class Method Details

.api_client ⇒ Object 



333
334
335
 
# File 'lib/tradenity/resources/store_profile.rb', line 333

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/tradenity/resources/store_profile.rb', line 59

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'name' => :'name',
    :'description' => :'description',
    :'contact_info' => :'contactInfo',
    :'billing_info' => :'billingInfo',
    :'facebook' => :'facebook',
    :'twitter' => :'twitter',
    :'youtube' => :'youtube',
    :'instagram' => :'instagram',
    :'pinterest' => :'pinterest',
    :'linkedin' => :'linkedin'
  }
end

.find_by_id(id) ⇒ StoreProfile

Find StoreProfile Return single instance of StoreProfile by its ID.

Parameters:

  • id —

    ID of StoreProfile to return

Returns:



351
352
353
 
# File 'lib/tradenity/resources/store_profile.rb', line 351

def find_by_id(id)
  get_store_profile_by_id(id)
end

.get_store_profile_by_id(store_profile_id, opts = {}) ⇒ StoreProfile

Find StoreProfile Return single instance of StoreProfile by its ID.

Parameters:

  • store_profile_id —

    ID of storeProfile to return

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

    the optional parameters

Returns:



361
362
363
364
 
# File 'lib/tradenity/resources/store_profile.rb', line 361

def get_store_profile_by_id(store_profile_id, opts = {})
  data, _status_code, _headers = get_store_profile_by_id_with_http_info(store_profile_id, opts)
  data
end

.get_store_profile_by_id_with_http_info(store_profile_id, opts = {}) ⇒ Array<(StoreProfile, Fixnum, Hash)>

Find StoreProfile Return single instance of StoreProfile by its ID.

Parameters:

  • store_profile_id —

    ID of storeProfile to return

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

    the optional parameters

Returns:

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

    StoreProfile data, response status code and response headers



371
372
373
374
375
376
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
403
404
405
406
407
408
409
 
# File 'lib/tradenity/resources/store_profile.rb', line 371

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

.replace_store_profile_by_id(store_profile_id, store_profile, opts = {}) ⇒ StoreProfile

Replace StoreProfile Replace all attributes of StoreProfile

Parameters:

  • store_profile_id —

    ID of storeProfile to replace

  • store_profile —

    Attributes of storeProfile to replace

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

    the optional parameters

Returns:



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

def replace_store_profile_by_id(store_profile_id, store_profile, opts = {})
  data, _status_code, _headers = replace_store_profile_by_id_with_http_info(store_profile_id, store_profile, opts)
  data
end

.replace_store_profile_by_id_with_http_info(store_profile_id, store_profile, opts = {}) ⇒ Array<(StoreProfile, Fixnum, Hash)>

Replace StoreProfile Replace all attributes of StoreProfile

Parameters:

  • store_profile_id —

    ID of storeProfile to replace

  • store_profile —

    Attributes of storeProfile to replace

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

    the optional parameters

Returns:

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

    StoreProfile data, response status code and response headers



427
428
429
430
431
432
433
434
435
436
437
438
439
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
 
# File 'lib/tradenity/resources/store_profile.rb', line 427

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

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'name' => :'String',
    :'description' => :'String',
    :'contact_info' => :'ContactInfo',
    :'billing_info' => :'ContactInfo',
    :'facebook' => :'String',
    :'twitter' => :'String',
    :'youtube' => :'String',
    :'instagram' => :'String',
    :'pinterest' => :'String',
    :'linkedin' => :'String'
  }
end

.update_store_profile_by_id(store_profile_id, store_profile, opts = {}) ⇒ StoreProfile

Update StoreProfile Update attributes of StoreProfile

Parameters:

  • store_profile_id —

    ID of storeProfile to update.

  • store_profile —

    Attributes of storeProfile to update.

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

    the optional parameters

Returns:



476
477
478
479
 
# File 'lib/tradenity/resources/store_profile.rb', line 476

def update_store_profile_by_id(store_profile_id, store_profile, opts = {})
  data, _status_code, _headers = update_store_profile_by_id_with_http_info(store_profile_id, store_profile, opts)
  data
end

.update_store_profile_by_id_with_http_info(store_profile_id, store_profile, opts = {}) ⇒ Array<(StoreProfile, Fixnum, Hash)>

Update StoreProfile Update attributes of StoreProfile

Parameters:

  • store_profile_id —

    ID of storeProfile to update.

  • store_profile —

    Attributes of storeProfile to update.

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

    the optional parameters

Returns:

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

    StoreProfile data, response status code and response headers



487
488
489
490
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/store_profile.rb', line 487

def update_store_profile_by_id_with_http_info(store_profile_id, store_profile, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: StoreProfile.update_store_profile_by_id ...'
  end
  # verify the required parameter 'store_profile_id' is set
  if api_client.config.client_side_validation && store_profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_profile_id' when calling StoreProfile.update_store_profile_by_id"
  end
  # verify the required parameter 'store_profile' is set
  if api_client.config.client_side_validation && store_profile.nil?
    fail ArgumentError, "Missing the required parameter 'store_profile' when calling StoreProfile.update_store_profile_by_id"
  end
  # resource path
  local_var_path = '/storeProfiles/{storeProfileId}'.sub('{' + 'storeProfileId' + '}', store_profile_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(store_profile)
  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 => 'StoreProfile')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: StoreProfile#update_store_profile_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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/tradenity/resources/store_profile.rb', line 198

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 &&
      name == o.name &&
      description == o.description &&
      contact_info == o.contact_info &&
      billing_info == o.billing_info &&
      facebook == o.facebook &&
      twitter == o.twitter &&
      youtube == o.youtube &&
      instagram == o.instagram &&
      pinterest == o.pinterest &&
      linkedin == o.linkedin
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



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

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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/tradenity/resources/store_profile.rb', line 318

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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/tradenity/resources/store_profile.rb', line 231

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


218
219
220
 
# File 'lib/tradenity/resources/store_profile.rb', line 218

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



224
225
226
 
# File 'lib/tradenity/resources/store_profile.rb', line 224

def hash
  [__meta, created_at, updated_at, name, description, contact_info, billing_info, facebook, twitter, youtube, instagram, pinterest, linkedin].hash
end

#id ⇒ Object 



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



180
181
182
183
184
185
186
187
 
# File 'lib/tradenity/resources/store_profile.rb', line 180

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name 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



298
299
300
 
# File 'lib/tradenity/resources/store_profile.rb', line 298

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



304
305
306
307
308
309
310
311
312
 
# File 'lib/tradenity/resources/store_profile.rb', line 304

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



292
293
294
 
# File 'lib/tradenity/resources/store_profile.rb', line 292

def to_s
  to_hash.to_s
end

#update ⇒ StoreProfile

Update StoreProfile Update attributes of StoreProfile

Returns:



340
341
342
 
# File 'lib/tradenity/resources/store_profile.rb', line 340

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



191
192
193
194
 
# File 'lib/tradenity/resources/store_profile.rb', line 191

def valid?
  return false if @name.nil?
  true
end