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



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

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

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

  if attributes.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.key?(:'grandfather_pricing')
    if (value = attributes[:'grandfather_pricing']).is_a?(Array)
      self.grandfather_pricing = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.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



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

def arbitrary_schedule_days
  @arbitrary_schedule_days
end

#arbitrary_unit_cost ⇒ Object

Arbitrary unit cost used to override the regular item cost



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

def arbitrary_unit_cost
  @arbitrary_unit_cost
end

#arbitrary_unit_cost_schedules ⇒ Object

Arbitrary unit costs schedules for more advanced discounting by rebill attempt



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

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



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

def grandfather_pricing
  @grandfather_pricing
end

#managed_by ⇒ Object

Managed by (defaults to UltraCart)



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

def managed_by
  @managed_by
end

#pause_days ⇒ Object

Number of days to pause



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

def pause_days
  @pause_days
end

#pause_until_date ⇒ Object

Wait for this step to happen until the specified date



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

def pause_until_date
  @pause_until_date
end

#pause_until_day_of_month ⇒ Object

Pause until a specific day of the month



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

def pause_until_day_of_month
  @pause_until_day_of_month
end

#pause_until_minimum_delay_days ⇒ Object

Pause at least this many days between the last order and the calculated next day of month



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

def pause_until_minimum_delay_days
  @pause_until_minimum_delay_days
end

#preshipment_notice_days ⇒ Object

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



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

def preshipment_notice_days
  @preshipment_notice_days
end

#recurring_merchant_item_id ⇒ Object

Item id to rebill



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

def recurring_merchant_item_id
  @recurring_merchant_item_id
end

#recurring_merchant_item_oid ⇒ Object

Item object identifier to rebill



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

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



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

def repeat_count
  @repeat_count
end

#schedule ⇒ Object

Frequency of the rebill



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

def schedule
  @schedule
end

#subscribe_email_list_name ⇒ Object

Email list name to subscribe the customer to when the rebill occurs (decommissioned email engine)



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

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 (decommissioned email engine)



64
65
66
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 64

def subscribe_email_list_oid
  @subscribe_email_list_oid
end

#type ⇒ Object

Type of step (item, kit only, loop or pause)



67
68
69
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 67

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



115
116
117
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 115

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 92

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',
    :'pause_until_day_of_month' => :'pause_until_day_of_month',
    :'pause_until_minimum_delay_days' => :'pause_until_minimum_delay_days',
    :'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

.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



315
316
317
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 315

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



143
144
145
146
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 143

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

.openapi_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 120

def self.openapi_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',
    :'pause_until_day_of_month' => :'Integer',
    :'pause_until_minimum_delay_days' => :'Integer',
    :'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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 278

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 &&
      pause_until_day_of_month == o.pause_until_day_of_month &&
      pause_until_minimum_delay_days == o.pause_until_minimum_delay_days &&
      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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 346

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



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 417

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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 322

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


302
303
304
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 302

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



308
309
310
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 308

def hash
  [arbitrary_schedule_days, arbitrary_unit_cost, arbitrary_unit_cost_schedules, grandfather_pricing, managed_by, pause_days, pause_until_date, pause_until_day_of_month, pause_until_minimum_delay_days, 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



238
239
240
241
242
243
244
245
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 238

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



393
394
395
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 393

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



399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 399

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



387
388
389
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 387

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



249
250
251
252
253
254
 
# File 'lib/ultracart_api/models/item_auto_order_step.rb', line 249

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", "loop", "kit only", "pause until"])
  return false unless type_validator.valid?(@type)
  true
end