Class: PinterestSdkClient::CatalogsRetailFeedsCreateRequest

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb

Overview

Request object for creating a retail feed.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CatalogsRetailFeedsCreateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 126

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::CatalogsRetailFeedsCreateRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PinterestSdkClient::CatalogsRetailFeedsCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'catalog_id')
    self.catalog_id = attributes[:'catalog_id']
  end

  if attributes.key?(:'catalog_type')
    self.catalog_type = attributes[:'catalog_type']
  else
    self.catalog_type = nil
  end

  if attributes.key?(:'credentials')
    self.credentials = attributes[:'credentials']
  end

  if attributes.key?(:'default_availability')
    self.default_availability = attributes[:'default_availability']
  end

  if attributes.key?(:'default_country')
    self.default_country = attributes[:'default_country']
  else
    self.default_country = nil
  end

  if attributes.key?(:'default_currency')
    self.default_currency = attributes[:'default_currency']
  end

  if attributes.key?(:'default_locale')
    self.default_locale = attributes[:'default_locale']
  else
    self.default_locale = nil
  end

  if attributes.key?(:'format')
    self.format = attributes[:'format']
  else
    self.format = nil
  end

  if attributes.key?(:'location')
    self.location = attributes[:'location']
  else
    self.location = nil
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'preferred_processing_schedule')
    self.preferred_processing_schedule = attributes[:'preferred_processing_schedule']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = 'ACTIVE'
  end
end

Instance Attribute Details

#catalog_id ⇒ Object

Catalog id pertaining to the feed. If not provided, feed will use a default catalog based on type. Currently, this field has no effect.



20
21
22
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 20

def catalog_id
  @catalog_id
end

#catalog_type ⇒ Object

Returns the value of attribute catalog_type.



22
23
24
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 22

def catalog_type
  @catalog_type
end

#credentials ⇒ Object

Returns the value of attribute credentials.



24
25
26
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 24

def credentials
  @credentials
end

#default_availability ⇒ Object

Returns the value of attribute default_availability.



26
27
28
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 26

def default_availability
  @default_availability
end

#default_country ⇒ Object

Returns the value of attribute default_country.



28
29
30
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 28

def default_country
  @default_country
end

#default_currency ⇒ Object

Returns the value of attribute default_currency.



30
31
32
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 30

def default_currency
  @default_currency
end

#default_locale ⇒ Object

Returns the value of attribute default_locale.



32
33
34
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 32

def default_locale
  @default_locale
end

#format ⇒ Object

Returns the value of attribute format.



34
35
36
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 34

def format
  @format
end

#location ⇒ Object

The URL where a feed is available for download. This URL is what Pinterest will use to download a feed for processing.



37
38
39
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 37

def location
  @location
end

#name ⇒ Object

A human-friendly name associated to a given feed.



40
41
42
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 40

def name
  @name
end

#preferred_processing_schedule ⇒ Object

Returns the value of attribute preferred_processing_schedule.



42
43
44
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 42

def preferred_processing_schedule
  @preferred_processing_schedule
end

#status ⇒ Object

Returns the value of attribute status.



44
45
46
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 44

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



87
88
89
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 87

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



92
93
94
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 92

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 69

def self.attribute_map
  {
    :'catalog_id' => :'catalog_id',
    :'catalog_type' => :'catalog_type',
    :'credentials' => :'credentials',
    :'default_availability' => :'default_availability',
    :'default_country' => :'default_country',
    :'default_currency' => :'default_currency',
    :'default_locale' => :'default_locale',
    :'format' => :'format',
    :'location' => :'location',
    :'name' => :'name',
    :'preferred_processing_schedule' => :'preferred_processing_schedule',
    :'status' => :'status'
  }
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



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 374

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



115
116
117
118
119
120
121
122
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 115

def self.openapi_nullable
  Set.new([
    :'credentials',
    :'default_availability',
    :'default_currency',
    :'preferred_processing_schedule',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 97

def self.openapi_types
  {
    :'catalog_id' => :'String',
    :'catalog_type' => :'CatalogsType',
    :'credentials' => :'CatalogsFeedCredentials',
    :'default_availability' => :'ProductAvailabilityType',
    :'default_country' => :'Country',
    :'default_currency' => :'NullableCurrency',
    :'default_locale' => :'CatalogsFeedsCreateRequestDefaultLocale',
    :'format' => :'CatalogsFormat',
    :'location' => :'String',
    :'name' => :'String',
    :'preferred_processing_schedule' => :'CatalogsFeedProcessingSchedule',
    :'status' => :'CatalogsStatus'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 342

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      catalog_id == o.catalog_id &&
      catalog_type == o.catalog_type &&
      credentials == o.credentials &&
      default_availability == o.default_availability &&
      default_country == o.default_country &&
      default_currency == o.default_currency &&
      default_locale == o.default_locale &&
      format == o.format &&
      location == o.location &&
      name == o.name &&
      preferred_processing_schedule == o.preferred_processing_schedule &&
      status == o.status
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


361
362
363
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 361

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



367
368
369
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 367

def hash
  [catalog_id, catalog_type, credentials, default_availability, default_country, default_currency, default_locale, format, location, name, preferred_processing_schedule, status].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 205

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^\d+$/)
  if !@catalog_id.nil? && @catalog_id !~ pattern
    invalid_properties.push("invalid value for \"catalog_id\", must conform to the pattern #{pattern}.")
  end

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

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

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

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

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

  pattern = Regexp.new(/^(http|https|ftp|sftp):\/\//)
  if @location !~ pattern
    invalid_properties.push("invalid value for \"location\", must conform to the pattern #{pattern}.")
  end

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 396

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb', line 247

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@catalog_id.nil? && @catalog_id !~ Regexp.new(/^\d+$/)
  return false if @catalog_type.nil?
  return false if @default_country.nil?
  return false if @default_locale.nil?
  return false if @format.nil?
  return false if @location.nil?
  return false if @location !~ Regexp.new(/^(http|https|ftp|sftp):\/\//)
  return false if @name.nil?
  true
end