Class: ProcessOut::Addon
- Inherits:
-
Object
- Object
- ProcessOut::Addon
- Defined in:
- lib/processout/addon.rb
Instance Attribute Summary collapse
-
#amount ⇒ Object
Returns the value of attribute amount.
-
#created_at ⇒ Object
Returns the value of attribute created_at.
-
#id ⇒ Object
Returns the value of attribute id.
-
#metadata ⇒ Object
Returns the value of attribute metadata.
-
#name ⇒ Object
Returns the value of attribute name.
-
#plan ⇒ Object
Returns the value of attribute plan.
-
#plan_id ⇒ Object
Returns the value of attribute plan_id.
-
#project ⇒ Object
Returns the value of attribute project.
-
#project_id ⇒ Object
Returns the value of attribute project_id.
-
#quantity ⇒ Object
Returns the value of attribute quantity.
-
#sandbox ⇒ Object
Returns the value of attribute sandbox.
-
#subscription ⇒ Object
Returns the value of attribute subscription.
-
#subscription_id ⇒ Object
Returns the value of attribute subscription_id.
-
#type ⇒ Object
Returns the value of attribute type.
Instance Method Summary collapse
-
#create(options = {}) ⇒ Object
Create a new addon to the given subscription ID.
-
#delete(options = {}) ⇒ Object
Delete an addon applied to a subscription.
-
#fetch_subscription_addons(subscription_id, options = {}) ⇒ Object
Get the addons applied to the subscription.
-
#fill_with_data(data) ⇒ Object
- Fills the object with data coming from the API Params:
data
-
Hash
of data coming from the API.
- Fills the object with data coming from the API Params:
-
#find(subscription_id, addon_id, options = {}) ⇒ Object
Find a subscription’s addon by its ID.
-
#initialize(client, data = {}) ⇒ Addon
constructor
- Initializes the Addon object Params:
client
ProcessOut
client instancedata
-
data that can be used to fill the object.
- Initializes the Addon object Params:
-
#new(data = {}) ⇒ Object
Create a new Addon using the current client.
-
#prefill(data) ⇒ Object
- Prefills the object with the data passed as parameters Params:
data
-
Hash
of data.
- Prefills the object with the data passed as parameters Params:
-
#save(options = {}) ⇒ Object
Save the updated addon attributes.
-
#to_json(options) ⇒ Object
Overrides the JSON marshaller to only send the fields we want.
Constructor Details
#initialize(client, data = {}) ⇒ Addon
Initializes the Addon object Params:
client
-
ProcessOut
client instance data
-
data that can be used to fill the object
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/processout/addon.rb', line 124 def initialize(client, data = {}) @client = client self.id = data.fetch(:id, nil) self.project = data.fetch(:project, nil) self.project_id = data.fetch(:project_id, nil) self.subscription = data.fetch(:subscription, nil) self.subscription_id = data.fetch(:subscription_id, nil) self.plan = data.fetch(:plan, nil) self.plan_id = data.fetch(:plan_id, nil) self.type = data.fetch(:type, nil) self.name = data.fetch(:name, nil) self.amount = data.fetch(:amount, nil) self.quantity = data.fetch(:quantity, nil) self. = 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.
20 21 22 |
# File 'lib/processout/addon.rb', line 20 def amount @amount end |
#created_at ⇒ Object
Returns the value of attribute created_at.
24 25 26 |
# File 'lib/processout/addon.rb', line 24 def created_at @created_at end |
#id ⇒ Object
Returns the value of attribute id.
11 12 13 |
# File 'lib/processout/addon.rb', line 11 def id @id end |
#metadata ⇒ Object
Returns the value of attribute metadata.
22 23 24 |
# File 'lib/processout/addon.rb', line 22 def @metadata end |
#name ⇒ Object
Returns the value of attribute name.
19 20 21 |
# File 'lib/processout/addon.rb', line 19 def name @name end |
#plan ⇒ Object
Returns the value of attribute plan.
16 17 18 |
# File 'lib/processout/addon.rb', line 16 def plan @plan end |
#plan_id ⇒ Object
Returns the value of attribute plan_id.
17 18 19 |
# File 'lib/processout/addon.rb', line 17 def plan_id @plan_id end |
#project ⇒ Object
Returns the value of attribute project.
12 13 14 |
# File 'lib/processout/addon.rb', line 12 def project @project end |
#project_id ⇒ Object
Returns the value of attribute project_id.
13 14 15 |
# File 'lib/processout/addon.rb', line 13 def project_id @project_id end |
#quantity ⇒ Object
Returns the value of attribute quantity.
21 22 23 |
# File 'lib/processout/addon.rb', line 21 def quantity @quantity end |
#sandbox ⇒ Object
Returns the value of attribute sandbox.
23 24 25 |
# File 'lib/processout/addon.rb', line 23 def sandbox @sandbox end |
#subscription ⇒ Object
Returns the value of attribute subscription.
14 15 16 |
# File 'lib/processout/addon.rb', line 14 def subscription @subscription end |
#subscription_id ⇒ Object
Returns the value of attribute subscription_id.
15 16 17 |
# File 'lib/processout/addon.rb', line 15 def subscription_id @subscription_id end |
#type ⇒ Object
Returns the value of attribute type.
18 19 20 |
# File 'lib/processout/addon.rb', line 18 def type @type end |
Instance Method Details
#create(options = {}) ⇒ Object
Create a new addon to the given subscription ID. Params:
options
-
Hash
of options
281 282 283 284 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 |
# File 'lib/processout/addon.rb', line 281 def create( = {}) self.prefill() request = Request.new(@client) path = "/subscriptions/" + CGI.escape(@subscription_id) + "/addons" data = { "plan_id" => @plan_id, "type" => @type, "name" => @name, "amount" => @amount, "quantity" => @quantity, "metadata" => @metadata, "prorate" => .fetch(:prorate, nil), "proration_date" => .fetch(:proration_date, nil), "preview" => .fetch(:preview, nil) } response = Response.new(request.post(path, data, )) return_values = Array.new body = response.body body = body["addon"] return_values.push(self.fill_with_data(body)) return_values[0] end |
#delete(options = {}) ⇒ Object
Delete an addon applied to a subscription. Params:
options
-
Hash
of options
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 |
# File 'lib/processout/addon.rb', line 379 def delete( = {}) self.prefill() request = Request.new(@client) path = "/subscriptions/" + CGI.escape(@subscription_id) + "/addons/" + CGI.escape(@id) + "" data = { "prorate" => .fetch(:prorate, nil), "proration_date" => .fetch(:proration_date, nil), "preview" => .fetch(:preview, nil) } response = Response.new(request.delete(path, data, )) return_values = Array.new return_values.push(response.success) return_values[0] end |
#fetch_subscription_addons(subscription_id, options = {}) ⇒ Object
Get the addons applied to the subscription. Params:
subscription_id
-
ID of the subscription
options
-
Hash
of options
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'lib/processout/addon.rb', line 251 def fetch_subscription_addons(subscription_id, = {}) self.prefill() request = Request.new(@client) path = "/subscriptions/" + CGI.escape(subscription_id) + "/addons" data = { } response = Response.new(request.get(path, data, )) return_values = Array.new a = Array.new body = response.body for v in body['addons'] tmp = Addon.new(@client) tmp.fill_with_data(v) a.push(tmp) end return_values.push(a) 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
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 |
# File 'lib/processout/addon.rb', line 172 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? "project_id" self.project_id = data["project_id"] end if data.include? "subscription" self.subscription = data["subscription"] end if data.include? "subscription_id" self.subscription_id = data["subscription_id"] end if data.include? "plan" self.plan = data["plan"] end if data.include? "plan_id" self.plan_id = data["plan_id"] end if data.include? "type" self.type = data["type"] end if data.include? "name" self.name = data["name"] end if data.include? "amount" self.amount = data["amount"] end if data.include? "quantity" self.quantity = data["quantity"] end if data.include? "metadata" self. = 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, addon_id, options = {}) ⇒ Object
Find a subscription’s addon by its ID. Params:
subscription_id
-
ID of the subscription on which the addon was applied
addon_id
-
ID of the addon
options
-
Hash
of options
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 |
# File 'lib/processout/addon.rb', line 317 def find(subscription_id, addon_id, = {}) self.prefill() request = Request.new(@client) path = "/subscriptions/" + CGI.escape(subscription_id) + "/addons/" + CGI.escape(addon_id) + "" data = { } response = Response.new(request.get(path, data, )) return_values = Array.new body = response.body body = body["addon"] obj = Addon.new(@client) return_values.push(obj.fill_with_data(body)) return_values[0] end |
#new(data = {}) ⇒ Object
Create a new Addon using the current client
145 146 147 |
# File 'lib/processout/addon.rb', line 145 def new(data = {}) Addon.new(@client, data) end |
#prefill(data) ⇒ Object
Prefills the object with the data passed as parameters Params:
data
-
Hash
of data
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/processout/addon.rb', line 225 def prefill(data) if data.nil? return self end self.id = data.fetch(:id, self.id) self.project = data.fetch(:project, self.project) self.project_id = data.fetch(:project_id, self.project_id) self.subscription = data.fetch(:subscription, self.subscription) self.subscription_id = data.fetch(:subscription_id, self.subscription_id) self.plan = data.fetch(:plan, self.plan) self.plan_id = data.fetch(:plan_id, self.plan_id) self.type = data.fetch(:type, self.type) self.name = data.fetch(:name, self.name) self.amount = data.fetch(:amount, self.amount) self.quantity = data.fetch(:quantity, self.quantity) self. = data.fetch(:metadata, self.) self.sandbox = data.fetch(:sandbox, self.sandbox) self.created_at = data.fetch(:created_at, self.created_at) self end |
#save(options = {}) ⇒ Object
Save the updated addon attributes. Params:
options
-
Hash
of options
344 345 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 |
# File 'lib/processout/addon.rb', line 344 def save( = {}) self.prefill() request = Request.new(@client) path = "/subscriptions/" + CGI.escape(@subscription_id) + "/addons/" + CGI.escape(@id) + "" data = { "plan_id" => @plan_id, "type" => @type, "name" => @name, "amount" => @amount, "quantity" => @quantity, "metadata" => @metadata, "prorate" => .fetch(:prorate, nil), "proration_date" => .fetch(:proration_date, nil), "preview" => .fetch(:preview, nil), "increment_quantity_by" => .fetch(:increment_quantity_by, nil) } response = Response.new(request.put(path, data, )) return_values = Array.new body = response.body body = body["addon"] return_values.push(self.fill_with_data(body)) return_values[0] end |
#to_json(options) ⇒ Object
Overrides the JSON marshaller to only send the fields we want
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/processout/addon.rb', line 150 def to_json() { "id": self.id, "project": self.project, "project_id": self.project_id, "subscription": self.subscription, "subscription_id": self.subscription_id, "plan": self.plan, "plan_id": self.plan_id, "type": self.type, "name": self.name, "amount": self.amount, "quantity": self.quantity, "metadata": self., "sandbox": self.sandbox, "created_at": self.created_at, }.to_json end |