Class: ProcessOut::Discount

Inherits:
Object
  • Object
show all
Defined in:
lib/processout/discount.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, data = {}) ⇒ Discount

Initializes the Discount object Params:

client

ProcessOut client instance

data

data that can be used to fill the object



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/processout/discount.rb', line 83

def initialize(client, data = {})
  @client = client

  self.id = data.fetch(:id, nil)
  self.project = data.fetch(:project, nil)
  self.subscription = data.fetch(:subscription, nil)
  self.coupon = data.fetch(:coupon, nil)
  self.amount = data.fetch(:amount, nil)
  self.expires_at = data.fetch(:expires_at, nil)
  self.metadata = data.fetch(:metadata, nil)
  self.sandbox = data.fetch(:sandbox, nil)
  self.created_at = data.fetch(:created_at, nil)
  
end

Instance Attribute Details

#amount ⇒ Object

Returns the value of attribute amount.



14
15
16
 
# File 'lib/processout/discount.rb', line 14

def amount
  @amount
end

#coupon ⇒ Object

Returns the value of attribute coupon.



13
14
15
 
# File 'lib/processout/discount.rb', line 13

def coupon
  @coupon
end

#created_at ⇒ Object

Returns the value of attribute created_at.



18
19
20
 
# File 'lib/processout/discount.rb', line 18

def created_at
  @created_at
end

#expires_at ⇒ Object

Returns the value of attribute expires_at.



15
16
17
 
# File 'lib/processout/discount.rb', line 15

def expires_at
  @expires_at
end

#id ⇒ Object

Returns the value of attribute id.



10
11
12
 
# File 'lib/processout/discount.rb', line 10

def id
  @id
end

#metadata ⇒ Object

Returns the value of attribute metadata.



16
17
18
 
# File 'lib/processout/discount.rb', line 16

def metadata
  @metadata
end

#project ⇒ Object

Returns the value of attribute project.



11
12
13
 
# File 'lib/processout/discount.rb', line 11

def project
  @project
end

#sandbox ⇒ Object

Returns the value of attribute sandbox.



17
18
19
 
# File 'lib/processout/discount.rb', line 17

def sandbox
  @sandbox
end

#subscription ⇒ Object

Returns the value of attribute subscription.



12
13
14
 
# File 'lib/processout/discount.rb', line 12

def subscription
  @subscription
end

Instance Method Details

#apply(subscription_id, options = {}) ⇒ Object

Apply a new discount to the given subscription ID. Params:

subscription_id

ID of the subscription

options

Hash of options



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/processout/discount.rb', line 165

def apply(subscription_id, options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/subscriptions/" + CGI.escape(subscription_id) + "/discounts"
  data    = {
    "amount" => @amount, 
    "expires_at" => @expires_at, 
    "metadata" => @metadata, 
    "coupon_id" => options.fetch(:coupon_id, nil)
  }

  response = Response.new(request.post(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["discount"]
  
  
  return_values.push(self.fill_with_data(body))
  

  
  return_values[0]
end

#apply_coupon(subscription_id, coupon_id, options = {}) ⇒ Object

Apply a new discount on the subscription from a coupon ID. Params:

subscription_id

ID of the subscription

coupon_id

ID of the coupon

options

Hash of options



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/processout/discount.rb', line 196

def apply_coupon(subscription_id, coupon_id, options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/subscriptions/" + CGI.escape(subscription_id) + "/discounts"
  data    = {
    "coupon_id" => coupon_id
  }

  response = Response.new(request.post(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["discount"]
  
  
  obj = Discount.new(@client)
  return_values.push(obj.fill_with_data(body))
  

  
  return_values[0]
end

#fill_with_data(data) ⇒ Object

Fills the object with data coming from the API Params:

data

Hash of data coming from the API



106
107
108
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/processout/discount.rb', line 106

def fill_with_data(data)
  if data.nil?
    return self
  end
  if data.include? "id"
    self.id = data["id"]
  end
  if data.include? "project"
    self.project = data["project"]
  end
  if data.include? "subscription"
    self.subscription = data["subscription"]
  end
  if data.include? "coupon"
    self.coupon = data["coupon"]
  end
  if data.include? "amount"
    self.amount = data["amount"]
  end
  if data.include? "expires_at"
    self.expires_at = data["expires_at"]
  end
  if data.include? "metadata"
    self.metadata = data["metadata"]
  end
  if data.include? "sandbox"
    self.sandbox = data["sandbox"]
  end
  if data.include? "created_at"
    self.created_at = data["created_at"]
  end
  
  self
end

#find(subscription_id, discount_id, options = {}) ⇒ Object

Find a subscription’s discount by its ID. Params:

subscription_id

ID of the subscription on which the discount was applied

discount_id

ID of the discount

options

Hash of options



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/processout/discount.rb', line 225

def find(subscription_id, discount_id, options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/subscriptions/" + CGI.escape(subscription_id) + "/discounts/" + CGI.escape(discount_id) + ""
  data    = {

  }

  response = Response.new(request.get(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["discount"]
  
  
  obj = Discount.new(@client)
  return_values.push(obj.fill_with_data(body))
  

  
  return_values[0]
end

#new(data = {}) ⇒ Object

Create a new Discount using the current client



99
100
101
 
# File 'lib/processout/discount.rb', line 99

def new(data = {})
  Discount.new(@client, data)
end

#prefill(data) ⇒ Object

Prefills the object with the data passed as parameters Params:

data

Hash of data



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/processout/discount.rb', line 144

def prefill(data)
  if data.nil?
    return self
  end
  self.id = data.fetch(:id, self.id)
  self.project = data.fetch(:project, self.project)
  self.subscription = data.fetch(:subscription, self.subscription)
  self.coupon = data.fetch(:coupon, self.coupon)
  self.amount = data.fetch(:amount, self.amount)
  self.expires_at = data.fetch(:expires_at, self.expires_at)
  self.metadata = data.fetch(:metadata, self.metadata)
  self.sandbox = data.fetch(:sandbox, self.sandbox)
  self.created_at = data.fetch(:created_at, self.created_at)
  
  self
end