Class: PinterestSdkClient::OrderLines

Inherits:
ApiModelBase show all
Defined in:
lib/pinterest_sdk/models/order_lines.rb

Overview

Order Line

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 = {}) ⇒ OrderLines

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ad_account_id ⇒ Object

Ad account ID.



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

def 
  @ad_account_id
end

#budget ⇒ Object

Order line budget in micro currency.



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

def budget
  @budget
end

#end_time ⇒ Object

End time. Unix timestamp.



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

def end_time
  @end_time
end

#id ⇒ Object

Order line ID.



29
30
31
 
# File 'lib/pinterest_sdk/models/order_lines.rb', line 29

def id
  @id
end

#name ⇒ Object

Order line name.



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

def name
  @name
end

Order line paid budget in micro currency.



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

def paid_budget
  @paid_budget
end

Order line paid type.



38
39
40
 
# File 'lib/pinterest_sdk/models/order_lines.rb', line 38

def paid_type
  @paid_type
end

#purchase_order_id ⇒ Object

Purchase order ID.



41
42
43
 
# File 'lib/pinterest_sdk/models/order_lines.rb', line 41

def purchase_order_id
  @purchase_order_id
end

#start_time ⇒ Object

Start time. Unix timestamp.



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

def start_time
  @start_time
end

#status ⇒ Object

Order line status.



47
48
49
 
# File 'lib/pinterest_sdk/models/order_lines.rb', line 47

def status
  @status
end

#type ⇒ Object

Always "orderline".



50
51
52
 
# File 'lib/pinterest_sdk/models/order_lines.rb', line 50

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/pinterest_sdk/models/order_lines.rb', line 97

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'ad_account_id' => :'ad_account_id',
    :'budget' => :'budget',
    :'end_time' => :'end_time',
    :'id' => :'id',
    :'name' => :'name',
    :'paid_budget' => :'paid_budget',
    :'paid_type' => :'paid_type',
    :'purchase_order_id' => :'purchase_order_id',
    :'start_time' => :'start_time',
    :'status' => :'status',
    :'type' => :'type'
  }
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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/pinterest_sdk/models/order_lines.rb', line 260

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



119
120
121
122
123
124
125
126
127
128
 
# File 'lib/pinterest_sdk/models/order_lines.rb', line 119

def self.openapi_nullable
  Set.new([
    :'budget',
    :'end_time',
    :'name',
    :'paid_budget',
    :'paid_type',
    :'purchase_order_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/pinterest_sdk/models/order_lines.rb', line 102

def self.openapi_types
  {
    :'ad_account_id' => :'String',
    :'budget' => :'Float',
    :'end_time' => :'Float',
    :'id' => :'String',
    :'name' => :'String',
    :'paid_budget' => :'Float',
    :'paid_type' => :'OrderLinePaidType',
    :'purchase_order_id' => :'String',
    :'start_time' => :'Float',
    :'status' => :'OrderLineStatus',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/pinterest_sdk/models/order_lines.rb', line 229

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      budget == o.budget &&
      end_time == o.end_time &&
      id == o.id &&
      name == o.name &&
      paid_budget == o.paid_budget &&
      paid_type == o.paid_type &&
      purchase_order_id == o.purchase_order_id &&
      start_time == o.start_time &&
      status == o.status &&
      type == o.type
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


247
248
249
 
# File 'lib/pinterest_sdk/models/order_lines.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



253
254
255
 
# File 'lib/pinterest_sdk/models/order_lines.rb', line 253

def hash
  [, budget, end_time, id, name, paid_budget, paid_type, purchase_order_id, start_time, status, type].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



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/pinterest_sdk/models/order_lines.rb', line 193

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^\d+$/)
  if !@id.nil? && @id !~ pattern
    invalid_properties.push("invalid value for \"id\", 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



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/pinterest_sdk/models/order_lines.rb', line 282

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



206
207
208
209
210
 
# File 'lib/pinterest_sdk/models/order_lines.rb', line 206

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@id.nil? && @id !~ Regexp.new(/^\d+$/)
  true
end