Class: MundiApi::CreateSubscriptionRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/mundi_api/models/create_subscription_request.rb

Overview

Request for creating a subcription

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(customer = nil, card = nil, code = nil, payment_method = nil, billing_type = nil, statement_descriptor = nil, description = nil, currency = nil, interval = nil, interval_count = nil, pricing_scheme = nil, items = nil, shipping = nil, discounts = nil, metadata = nil, setup = nil, plan_id = nil, customer_id = nil, card_id = nil, billing_day = nil, installments = nil, start_at = nil, minimum_price = nil, cycles = nil, card_token = nil) ⇒ CreateSubscriptionRequest

Returns a new instance of CreateSubscriptionRequest.



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
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 141

def initialize(customer = nil,
               card = nil,
               code = nil,
               payment_method = nil,
               billing_type = nil,
               statement_descriptor = nil,
               description = nil,
               currency = nil,
               interval = nil,
               interval_count = nil,
               pricing_scheme = nil,
               items = nil,
               shipping = nil,
               discounts = nil,
               metadata = nil,
               setup = nil,
               plan_id = nil,
               customer_id = nil,
               card_id = nil,
               billing_day = nil,
               installments = nil,
               start_at = nil,
               minimum_price = nil,
               cycles = nil,
               card_token = nil)
  @customer = customer
  @card = card
  @code = code
  @payment_method = payment_method
  @billing_type = billing_type
  @statement_descriptor = statement_descriptor
  @description = description
  @currency = currency
  @interval = interval
  @interval_count = interval_count
  @pricing_scheme = pricing_scheme
  @items = items
  @shipping = shipping
  @discounts = discounts
  @metadata = metadata
  @setup = setup
  @plan_id = plan_id
  @customer_id = customer_id
  @card_id = card_id
  @billing_day = billing_day
  @installments = installments
  @start_at = start_at
  @minimum_price = minimum_price
  @cycles = cycles
  @card_token = card_token
end

Instance Attribute Details

#billing_day ⇒ Integer

Billing day

Returns:

  • (Integer) 


86
87
88
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 86

def billing_day
  @billing_day
end

#billing_type ⇒ String

Billing type

Returns:



26
27
28
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 26

def billing_type
  @billing_type
end

#card ⇒ CreateCardRequest

Card

Returns:



14
15
16
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 14

def card
  @card
end

#card_id ⇒ String

Card id

Returns:



82
83
84
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 82

def card_id
  @card_id
end

#card_token ⇒ String

Card token

Returns:



106
107
108
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 106

def card_token
  @card_token
end

#code ⇒ String

Subscription code

Returns:



18
19
20
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 18

def code
  @code
end

#currency ⇒ String

Currency

Returns:



38
39
40
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 38

def currency
  @currency
end

#customer ⇒ CreateCustomerRequest

Customer

Returns:



10
11
12
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 10

def customer
  @customer
end

#customer_id ⇒ String

Customer id

Returns:



78
79
80
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 78

def customer_id
  @customer_id
end

#cycles ⇒ Integer

Number of cycles

Returns:

  • (Integer) 


102
103
104
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 102

def cycles
  @cycles
end

#description ⇒ String

Subscription description

Returns:



34
35
36
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 34

def description
  @description
end

#discounts ⇒ List of CreateDiscountRequest

Discounts

Returns:



62
63
64
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 62

def discounts
  @discounts
end

#installments ⇒ Integer

Number of installments

Returns:

  • (Integer) 


90
91
92
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 90

def installments
  @installments
end

#interval ⇒ String

Interval

Returns:



42
43
44
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 42

def interval
  @interval
end

#interval_count ⇒ Integer

Interval count

Returns:

  • (Integer) 


46
47
48
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 46

def interval_count
  @interval_count
end

#items ⇒ List of CreateSubscriptionItemRequest

Subscription items

Returns:



54
55
56
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 54

def items
  @items
end

#metadata ⇒ Array<String, String>

Metadata

Returns:



66
67
68
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 66

def metadata
  @metadata
end

#minimum_price ⇒ Integer

Subscription minimum price

Returns:

  • (Integer) 


98
99
100
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 98

def minimum_price
  @minimum_price
end

#payment_method ⇒ String

Payment method

Returns:



22
23
24
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 22

def payment_method
  @payment_method
end

#plan_id ⇒ String

Plan id

Returns:



74
75
76
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 74

def plan_id
  @plan_id
end

#pricing_scheme ⇒ CreatePricingSchemeRequest

Subscription pricing scheme

Returns:



50
51
52
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 50

def pricing_scheme
  @pricing_scheme
end

#setup ⇒ CreateSetupRequest

Setup data

Returns:



70
71
72
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 70

def setup
  @setup
end

#shipping ⇒ CreateShippingRequest

Shipping

Returns:



58
59
60
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 58

def shipping
  @shipping
end

#start_at ⇒ DateTime

Subscription start date

Returns:

  • (DateTime) 


94
95
96
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 94

def start_at
  @start_at
end

#statement_descriptor ⇒ String

Statement descriptor for credit card subscriptions

Returns:



30
31
32
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 30

def statement_descriptor
  @statement_descriptor
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
235
236
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
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 194

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  customer = CreateCustomerRequest.from_hash(hash['customer']) if
    hash['customer']
  card = CreateCardRequest.from_hash(hash['card']) if hash['card']
  code = hash['code']
  payment_method = hash['payment_method']
  billing_type = hash['billing_type']
  statement_descriptor = hash['statement_descriptor']
  description = hash['description']
  currency = hash['currency']
  interval = hash['interval']
  interval_count = hash['interval_count']
  pricing_scheme = CreatePricingSchemeRequest.from_hash(hash['pricing_scheme']) if
    hash['pricing_scheme']
  # Parameter is an array, so we need to iterate through it

  items = nil
  unless hash['items'].nil?
    items = []
    hash['items'].each do |structure|
      items << (CreateSubscriptionItemRequest.from_hash(structure) if structure)
    end
  end
  shipping = CreateShippingRequest.from_hash(hash['shipping']) if
    hash['shipping']
  # Parameter is an array, so we need to iterate through it

  discounts = nil
  unless hash['discounts'].nil?
    discounts = []
    hash['discounts'].each do |structure|
      discounts << (CreateDiscountRequest.from_hash(structure) if structure)
    end
  end
  metadata = hash['metadata']
  setup = CreateSetupRequest.from_hash(hash['setup']) if hash['setup']
  plan_id = hash['plan_id']
  customer_id = hash['customer_id']
  card_id = hash['card_id']
  billing_day = hash['billing_day']
  installments = hash['installments']
  start_at = DateTime.rfc3339(hash['start_at']) if hash['start_at']
  minimum_price = hash['minimum_price']
  cycles = hash['cycles']
  card_token = hash['card_token']

  # Create object from extracted values.

  CreateSubscriptionRequest.new(customer,
                                card,
                                code,
                                payment_method,
                                billing_type,
                                statement_descriptor,
                                description,
                                currency,
                                interval,
                                interval_count,
                                pricing_scheme,
                                items,
                                shipping,
                                discounts,
                                metadata,
                                setup,
                                plan_id,
                                customer_id,
                                card_id,
                                billing_day,
                                installments,
                                start_at,
                                minimum_price,
                                cycles,
                                card_token)
end

.names ⇒ Object

A mapping from model property names to API property names.



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
 
# File 'lib/mundi_api/models/create_subscription_request.rb', line 109

def self.names
  if @_hash.nil?
    @_hash = {}
    @_hash['customer'] = 'customer'
    @_hash['card'] = 'card'
    @_hash['code'] = 'code'
    @_hash['payment_method'] = 'payment_method'
    @_hash['billing_type'] = 'billing_type'
    @_hash['statement_descriptor'] = 'statement_descriptor'
    @_hash['description'] = 'description'
    @_hash['currency'] = 'currency'
    @_hash['interval'] = 'interval'
    @_hash['interval_count'] = 'interval_count'
    @_hash['pricing_scheme'] = 'pricing_scheme'
    @_hash['items'] = 'items'
    @_hash['shipping'] = 'shipping'
    @_hash['discounts'] = 'discounts'
    @_hash['metadata'] = 'metadata'
    @_hash['setup'] = 'setup'
    @_hash['plan_id'] = 'plan_id'
    @_hash['customer_id'] = 'customer_id'
    @_hash['card_id'] = 'card_id'
    @_hash['billing_day'] = 'billing_day'
    @_hash['installments'] = 'installments'
    @_hash['start_at'] = 'start_at'
    @_hash['minimum_price'] = 'minimum_price'
    @_hash['cycles'] = 'cycles'
    @_hash['card_token'] = 'card_token'
  end
  @_hash
end