Class: UltracartClient::AddLibraryItemRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/add_library_item_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddLibraryItemRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



98
99
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
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 98

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attributes ⇒ Object

Attributes associated with the library item to contain additional configuration.



19
20
21
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 19

def attributes
  @attributes
end

#cjson ⇒ Object

Cjson to be added to library



22
23
24
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 22

def cjson
  @cjson
end

#content_type ⇒ Object

flow, campaign, cjson, email, transactional_email, postcard or upsell



25
26
27
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 25

def content_type
  @content_type
end

#description ⇒ Object

description of library item



28
29
30
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 28

def description
  @description
end

#email_name ⇒ Object

Required if content_type is transactional_email. This is the name of the email template (html, not text). This name should have a .vm file extension. An example is auto_order_cancel_html.vm



31
32
33
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 31

def email_name
  @email_name
end

#email_path ⇒ Object

Required if content_type is transactional_email. This is the full path to the email template stored in the file system. This defines which StoreFront contains the desired email template. An example is /themes/Elements/core/emails/auto_order_cancel_html.vm



34
35
36
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 34

def email_path
  @email_path
end

#screenshots ⇒ Object

Screenshot urls for display



37
38
39
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 37

def screenshots
  @screenshots
end

#storefront_oid ⇒ Object

StoreFront oid where content originates necessary for tracking down relative assets



40
41
42
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 40

def storefront_oid
  @storefront_oid
end

#title ⇒ Object

title of library item, usually the name of the flow or campaign, or description of cjson



43
44
45
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 43

def title
  @title
end

#upsell_offer_oid ⇒ Object

Required if content_type is upsell. This is object identifier of a StoreFront Upsell Offer.



46
47
48
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 46

def upsell_offer_oid
  @upsell_offer_oid
end

#uuid ⇒ Object

UUID of communication flow, campaign, email, postcard, or null if this item is something else. transactional_email do not have a uuid because they are singleton objects within a storefront and easily identifiable by name



49
50
51
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 49

def uuid
  @uuid
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 69

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 52

def self.attribute_map
  {
    :'attributes' => :'attributes',
    :'cjson' => :'cjson',
    :'content_type' => :'content_type',
    :'description' => :'description',
    :'email_name' => :'email_name',
    :'email_path' => :'email_path',
    :'screenshots' => :'screenshots',
    :'storefront_oid' => :'storefront_oid',
    :'title' => :'title',
    :'upsell_offer_oid' => :'upsell_offer_oid',
    :'uuid' => :'uuid'
  }
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



206
207
208
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 206

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 91

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 74

def self.openapi_types
  {
    :'attributes' => :'Array<LibraryItemAttribute>',
    :'cjson' => :'String',
    :'content_type' => :'String',
    :'description' => :'String',
    :'email_name' => :'String',
    :'email_path' => :'String',
    :'screenshots' => :'Array<LibraryItemScreenshot>',
    :'storefront_oid' => :'Integer',
    :'title' => :'String',
    :'upsell_offer_oid' => :'Integer',
    :'uuid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 175

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      attributes == o.attributes &&
      cjson == o.cjson &&
      content_type == o.content_type &&
      description == o.description &&
      email_name == o.email_name &&
      email_path == o.email_path &&
      screenshots == o.screenshots &&
      storefront_oid == o.storefront_oid &&
      title == o.title &&
      upsell_offer_oid == o.upsell_offer_oid &&
      uuid == o.uuid
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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 237

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 308

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 213

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


193
194
195
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 193

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



199
200
201
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 199

def hash
  [attributes, cjson, content_type, description, email_name, email_path, screenshots, storefront_oid, title, upsell_offer_oid, uuid].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



162
163
164
165
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 162

def list_invalid_properties
  invalid_properties = Array.new
  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



284
285
286
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 284

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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 290

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



278
279
280
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 278

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



169
170
171
 
# File 'lib/ultracart_api/models/add_library_item_request.rb', line 169

def valid?
  true
end