Class: PinterestSdkClient::CatalogsRetailFeedsUpdateRequest

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

Overview

Request object for updating a 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 = {}) ⇒ CatalogsRetailFeedsUpdateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::CatalogsRetailFeedsUpdateRequest` 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::CatalogsRetailFeedsUpdateRequest`. 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_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_currency')
    self.default_currency = attributes[:'default_currency']
  end

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

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

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

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

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

Instance Attribute Details

#catalog_type ⇒ Object

Returns the value of attribute catalog_type.



19
20
21
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 19

def catalog_type
  @catalog_type
end

#credentials ⇒ Object

Returns the value of attribute credentials.



21
22
23
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 21

def credentials
  @credentials
end

#default_availability ⇒ Object

Returns the value of attribute default_availability.



23
24
25
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 23

def default_availability
  @default_availability
end

#default_currency ⇒ Object

Returns the value of attribute default_currency.



25
26
27
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 25

def default_currency
  @default_currency
end

#format ⇒ Object

Returns the value of attribute format.



27
28
29
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 27

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.



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

def location
  @location
end

#name ⇒ Object

A human-friendly name associated to a given feed.



33
34
35
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 33

def name
  @name
end

#preferred_processing_schedule ⇒ Object

Returns the value of attribute preferred_processing_schedule.



35
36
37
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 35

def preferred_processing_schedule
  @preferred_processing_schedule
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



77
78
79
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 77

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



82
83
84
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 82

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 62

def self.attribute_map
  {
    :'catalog_type' => :'catalog_type',
    :'credentials' => :'credentials',
    :'default_availability' => :'default_availability',
    :'default_currency' => :'default_currency',
    :'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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 248

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



102
103
104
105
106
107
108
109
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 87

def self.openapi_types
  {
    :'catalog_type' => :'CatalogsType',
    :'credentials' => :'CatalogsFeedCredentials',
    :'default_availability' => :'ProductAvailabilityType',
    :'default_currency' => :'NullableCurrency',
    :'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



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      catalog_type == o.catalog_type &&
      credentials == o.credentials &&
      default_availability == o.default_availability &&
      default_currency == o.default_currency &&
      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


235
236
237
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



241
242
243
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 241

def hash
  [catalog_type, credentials, default_availability, default_currency, 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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 168

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @catalog_type.nil?
    invalid_properties.push('invalid value for "catalog_type", catalog_type cannot be nil.')
  end

  pattern = Regexp.new(/^(http|https|ftp|sftp):\/\//)
  if !@location.nil? && @location !~ pattern
    invalid_properties.push("invalid value for \"location\", must conform to the pattern #{pattern}.")
  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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 270

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



185
186
187
188
189
190
 
# File 'lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb', line 185

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