Class: WhiteLabelMachineName::ShopifySubscriptionProductCreate

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShopifySubscriptionProductCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 122

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#absolute_price_adjustment ⇒ Object

Returns the value of attribute absolute_price_adjustment.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 24

def absolute_price_adjustment
  @absolute_price_adjustment
end

#billing_day_of_month ⇒ Object

Define the day of the month on which the recurring orders should be created.



27
28
29
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 27

def billing_day_of_month
  @billing_day_of_month
end

#billing_interval_amount ⇒ Object

Returns the value of attribute billing_interval_amount.



30
31
32
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 30

def billing_interval_amount
  @billing_interval_amount
end

#billing_interval_unit ⇒ Object

Define how frequently recurring orders should be created.



33
34
35
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 33

def billing_interval_unit
  @billing_interval_unit
end

#billing_weekday ⇒ Object

Define the weekday on which the recurring orders should be created.



36
37
38
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 36

def billing_weekday
  @billing_weekday
end

#fixed_price ⇒ Object

Returns the value of attribute fixed_price.



39
40
41
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 39

def fixed_price
  @fixed_price
end

#maximal_billing_cycles ⇒ Object

Define the maximum number of orders the subscription will run for.



42
43
44
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 42

def maximal_billing_cycles
  @maximal_billing_cycles
end

#maximal_suspendable_cycles ⇒ Object

Define the maximum number of orders the subscription can be suspended for at a time.



45
46
47
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 45

def maximal_suspendable_cycles
  @maximal_suspendable_cycles
end

#minimal_billing_cycles ⇒ Object

Define the minimal number of orders the subscription will run for.



48
49
50
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 48

def minimal_billing_cycles
  @minimal_billing_cycles
end

#pricing_option ⇒ Object

Returns the value of attribute pricing_option.



51
52
53
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 51

def pricing_option
  @pricing_option
end

#product_id ⇒ Object

The ID of the Shopify product that is enabled to be ordered as subscription.



66
67
68
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 66

def product_id
  @product_id
end

#product_variant_id ⇒ Object

Returns the value of attribute product_variant_id.



69
70
71
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 69

def product_variant_id
  @product_variant_id
end

#relative_price_adjustment ⇒ Object

Returns the value of attribute relative_price_adjustment.



54
55
56
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 54

def relative_price_adjustment
  @relative_price_adjustment
end

#shop ⇒ Object

Returns the value of attribute shop.



72
73
74
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 72

def shop
  @shop
end

#store_order_confirmation_email_enabled ⇒ Object

Define whether the order confirmation email of the Shopify shop is sent to the customer for recurring orders.



57
58
59
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 57

def store_order_confirmation_email_enabled
  @store_order_confirmation_email_enabled
end

#subscriber_suspension_allowed ⇒ Object

Define whether the customer is allowed to suspend subscriptions.



60
61
62
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 60

def subscriber_suspension_allowed
  @subscriber_suspension_allowed
end

#termination_billing_cycles ⇒ Object

Define the number of orders the subscription will keep running for after its termination has been requested.



63
64
65
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 63

def termination_billing_cycles
  @termination_billing_cycles
end

Class Method Details

.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
90
91
92
93
94
95
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 75

def self.attribute_map
  {
    :'absolute_price_adjustment' => :'absolutePriceAdjustment',
    :'billing_day_of_month' => :'billingDayOfMonth',
    :'billing_interval_amount' => :'billingIntervalAmount',
    :'billing_interval_unit' => :'billingIntervalUnit',
    :'billing_weekday' => :'billingWeekday',
    :'fixed_price' => :'fixedPrice',
    :'maximal_billing_cycles' => :'maximalBillingCycles',
    :'maximal_suspendable_cycles' => :'maximalSuspendableCycles',
    :'minimal_billing_cycles' => :'minimalBillingCycles',
    :'pricing_option' => :'pricingOption',
    :'relative_price_adjustment' => :'relativePriceAdjustment',
    :'store_order_confirmation_email_enabled' => :'storeOrderConfirmationEmailEnabled',
    :'subscriber_suspension_allowed' => :'subscriberSuspensionAllowed',
    :'termination_billing_cycles' => :'terminationBillingCycles',
    :'product_id' => :'productId',
    :'product_variant_id' => :'productVariantId',
    :'shop' => :'shop'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 98

def self.swagger_types
  {
    :'absolute_price_adjustment' => :'Float',
    :'billing_day_of_month' => :'Integer',
    :'billing_interval_amount' => :'Integer',
    :'billing_interval_unit' => :'ShopifySubscriptionBillingIntervalUnit',
    :'billing_weekday' => :'ShopifySubscriptionWeekday',
    :'fixed_price' => :'Float',
    :'maximal_billing_cycles' => :'Integer',
    :'maximal_suspendable_cycles' => :'Integer',
    :'minimal_billing_cycles' => :'Integer',
    :'pricing_option' => :'ShopifySubscriptionProductPricingOption',
    :'relative_price_adjustment' => :'Float',
    :'store_order_confirmation_email_enabled' => :'BOOLEAN',
    :'subscriber_suspension_allowed' => :'BOOLEAN',
    :'termination_billing_cycles' => :'Integer',
    :'product_id' => :'String',
    :'product_variant_id' => :'String',
    :'shop' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      absolute_price_adjustment == o.absolute_price_adjustment &&
      billing_day_of_month == o.billing_day_of_month &&
      billing_interval_amount == o.billing_interval_amount &&
      billing_interval_unit == o.billing_interval_unit &&
      billing_weekday == o.billing_weekday &&
      fixed_price == o.fixed_price &&
      maximal_billing_cycles == o.maximal_billing_cycles &&
      maximal_suspendable_cycles == o.maximal_suspendable_cycles &&
      minimal_billing_cycles == o.minimal_billing_cycles &&
      pricing_option == o.pricing_option &&
      relative_price_adjustment == o.relative_price_adjustment &&
      store_order_confirmation_email_enabled == o.store_order_confirmation_email_enabled &&
      subscriber_suspension_allowed == o.subscriber_suspension_allowed &&
      termination_billing_cycles == o.termination_billing_cycles &&
      product_id == o.product_id &&
      product_variant_id == o.product_variant_id &&
      shop == o.shop
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



285
286
287
288
289
290
291
292
293
294
295
296
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 285

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 351

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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 264

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


251
252
253
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 251

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



257
258
259
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 257

def hash
  [absolute_price_adjustment, billing_day_of_month, billing_interval_amount, billing_interval_unit, billing_weekday, fixed_price, maximal_billing_cycles, maximal_suspendable_cycles, minimal_billing_cycles, pricing_option, relative_price_adjustment, store_order_confirmation_email_enabled, subscriber_suspension_allowed, termination_billing_cycles, product_id, product_variant_id, shop].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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 199

def list_invalid_properties
  invalid_properties = Array.new
  if @product_id.nil?
    invalid_properties.push('invalid value for "product_id", product_id cannot be nil.')
  end

  if @product_variant_id.nil?
    invalid_properties.push('invalid value for "product_variant_id", product_variant_id cannot be nil.')
  end

  if @shop.nil?
    invalid_properties.push('invalid value for "shop", shop cannot be nil.')
  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



331
332
333
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 331

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



337
338
339
340
341
342
343
344
345
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 337

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



325
326
327
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 325

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



218
219
220
221
222
223
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/shopify_subscription_product_create.rb', line 218

def valid?
  return false if @product_id.nil?
  return false if @product_variant_id.nil?
  return false if @shop.nil?
  true
end