Class: UltracartClient::ItemAutoOrderStep

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemAutoOrderStep

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 128

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#arbitrary_schedule_days ⇒ Object

If the schedule is arbitrary, then this is the number of days



18
19
20
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 18

def arbitrary_schedule_days
  @arbitrary_schedule_days
end

#arbitrary_unit_cost ⇒ Object

Arbitrary unit cost used to override the regular item cost



21
22
23
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 21

def arbitrary_unit_cost
  @arbitrary_unit_cost
end

#arbitrary_unit_cost_schedules ⇒ Object

Arbitrary unit costs schedules for more advanced discounting by rebill attempt



24
25
26
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 24

def arbitrary_unit_cost_schedules
  @arbitrary_unit_cost_schedules
end

#grandfather_pricing ⇒ Object

Grand-father pricing configuration if the rebill schedule has changed over time



27
28
29
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 27

def grandfather_pricing
  @grandfather_pricing
end

#managed_by ⇒ Object

Managed by (defaults to UltraCart)



30
31
32
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 30

def managed_by
  @managed_by
end

#pause_days ⇒ Object

Number of days to pause



33
34
35
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 33

def pause_days
  @pause_days
end

#pause_until_date ⇒ Object

Wait for this step to happen until the specified date



36
37
38
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 36

def pause_until_date
  @pause_until_date
end

#preshipment_notice_days ⇒ Object

If set, a pre-shipment notice is sent to the customer this many days in advance



39
40
41
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 39

def preshipment_notice_days
  @preshipment_notice_days
end

#recurring_merchant_item_id ⇒ Object

Item id to rebill



42
43
44
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 42

def recurring_merchant_item_id
  @recurring_merchant_item_id
end

#recurring_merchant_item_oid ⇒ Object

Item object identifier to rebill



45
46
47
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 45

def recurring_merchant_item_oid
  @recurring_merchant_item_oid
end

#repeat_count ⇒ Object

Number of times to rebill. Last step can be null for infinite



48
49
50
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 48

def repeat_count
  @repeat_count
end

#schedule ⇒ Object

Frequency of the rebill



51
52
53
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 51

def schedule
  @schedule
end

#subscribe_email_list_name ⇒ Object

Email list name to subscribe the customer to when the rebill occurs



54
55
56
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 54

def subscribe_email_list_name
  @subscribe_email_list_name
end

#subscribe_email_list_oid ⇒ Object

Email list identifier to subscribe the customer to when this rebill occurs



57
58
59
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 57

def subscribe_email_list_oid
  @subscribe_email_list_oid
end

#type ⇒ Object

Type of step (item or pause)



60
61
62
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 60

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 85

def self.attribute_map
  {
    :'arbitrary_schedule_days' => :'arbitrary_schedule_days',
    :'arbitrary_unit_cost' => :'arbitrary_unit_cost',
    :'arbitrary_unit_cost_schedules' => :'arbitrary_unit_cost_schedules',
    :'grandfather_pricing' => :'grandfather_pricing',
    :'managed_by' => :'managed_by',
    :'pause_days' => :'pause_days',
    :'pause_until_date' => :'pause_until_date',
    :'preshipment_notice_days' => :'preshipment_notice_days',
    :'recurring_merchant_item_id' => :'recurring_merchant_item_id',
    :'recurring_merchant_item_oid' => :'recurring_merchant_item_oid',
    :'repeat_count' => :'repeat_count',
    :'schedule' => :'schedule',
    :'subscribe_email_list_name' => :'subscribe_email_list_name',
    :'subscribe_email_list_oid' => :'subscribe_email_list_oid',
    :'type' => :'type'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 106

def self.swagger_types
  {
    :'arbitrary_schedule_days' => :'Integer',
    :'arbitrary_unit_cost' => :'Float',
    :'arbitrary_unit_cost_schedules' => :'Array<ItemAutoOrderStepArbitraryUnitCostSchedule>',
    :'grandfather_pricing' => :'Array<ItemAutoOrderStepGrandfatherPricing>',
    :'managed_by' => :'String',
    :'pause_days' => :'Integer',
    :'pause_until_date' => :'String',
    :'preshipment_notice_days' => :'Integer',
    :'recurring_merchant_item_id' => :'String',
    :'recurring_merchant_item_oid' => :'Integer',
    :'repeat_count' => :'Integer',
    :'schedule' => :'String',
    :'subscribe_email_list_name' => :'String',
    :'subscribe_email_list_oid' => :'Integer',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 241

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      arbitrary_schedule_days == o.arbitrary_schedule_days &&
      arbitrary_unit_cost == o.arbitrary_unit_cost &&
      arbitrary_unit_cost_schedules == o.arbitrary_unit_cost_schedules &&
      grandfather_pricing == o.grandfather_pricing &&
      managed_by == o.managed_by &&
      pause_days == o.pause_days &&
      pause_until_date == o.pause_until_date &&
      preshipment_notice_days == o.preshipment_notice_days &&
      recurring_merchant_item_id == o.recurring_merchant_item_id &&
      recurring_merchant_item_oid == o.recurring_merchant_item_oid &&
      repeat_count == o.repeat_count &&
      schedule == o.schedule &&
      subscribe_email_list_name == o.subscribe_email_list_name &&
      subscribe_email_list_oid == o.subscribe_email_list_oid &&
      type == o.type
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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 297

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 = UltracartClient.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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 363

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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 276

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 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


263
264
265
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 263

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



269
270
271
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 269

def hash
  [arbitrary_schedule_days, arbitrary_unit_cost, arbitrary_unit_cost_schedules, grandfather_pricing, managed_by, pause_days, pause_until_date, preshipment_notice_days, recurring_merchant_item_id, recurring_merchant_item_oid, repeat_count, schedule, subscribe_email_list_name, subscribe_email_list_oid, 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



201
202
203
204
205
206
207
208
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 201

def list_invalid_properties
  invalid_properties = Array.new
  if !@recurring_merchant_item_id.nil? && @recurring_merchant_item_id.to_s.length > 20
    invalid_properties.push('invalid value for "recurring_merchant_item_id", the character length must be smaller than or equal to 20.')
  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



343
344
345
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 343

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



349
350
351
352
353
354
355
356
357
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 349

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



337
338
339
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 337

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



212
213
214
215
216
217
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 212

def valid?
  return false if !@recurring_merchant_item_id.nil? && @recurring_merchant_item_id.to_s.length > 20
  type_validator = EnumAttributeValidator.new('String', ['item', 'pause'])
  return false unless type_validator.valid?(@type)
  true
end