Class: ProcessOut::Customer

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Initializes the Customer object Params:

client

ProcessOut client instance

data

data that can be used to fill the object



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
 
# File 'lib/processout/customer.rb', line 214

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.default_token = data.fetch(:default_token, nil)
  self.default_token_id = data.fetch(:default_token_id, nil)
  self.tokens = data.fetch(:tokens, nil)
  self.subscriptions = data.fetch(:subscriptions, nil)
  self.transactions = data.fetch(:transactions, nil)
  self.balance = data.fetch(:balance, nil)
  self.currency = data.fetch(:currency, nil)
  self.email = data.fetch(:email, nil)
  self.first_name = data.fetch(:first_name, nil)
  self.last_name = data.fetch(:last_name, nil)
  self.address1 = data.fetch(:address1, nil)
  self.address2 = data.fetch(:address2, nil)
  self.city = data.fetch(:city, nil)
  self.state = data.fetch(:state, nil)
  self.zip = data.fetch(:zip, nil)
  self.country_code = data.fetch(:country_code, nil)
  self.ip_address = data.fetch(:ip_address, nil)
  self.phone_number = data.fetch(:phone_number, nil)
  self.legal_document = data.fetch(:legal_document, 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

#address1 ⇒ Object

Returns the value of attribute address1.



23
24
25
 
# File 'lib/processout/customer.rb', line 23

def address1
  @address1
end

#address2 ⇒ Object

Returns the value of attribute address2.



24
25
26
 
# File 'lib/processout/customer.rb', line 24

def address2
  @address2
end

#balance ⇒ Object

Returns the value of attribute balance.



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

def balance
  @balance
end

#city ⇒ Object

Returns the value of attribute city.



25
26
27
 
# File 'lib/processout/customer.rb', line 25

def city
  @city
end

#country_code ⇒ Object

Returns the value of attribute country_code.



28
29
30
 
# File 'lib/processout/customer.rb', line 28

def country_code
  @country_code
end

#created_at ⇒ Object

Returns the value of attribute created_at.



34
35
36
 
# File 'lib/processout/customer.rb', line 34

def created_at
  @created_at
end

#currency ⇒ Object

Returns the value of attribute currency.



19
20
21
 
# File 'lib/processout/customer.rb', line 19

def currency
  @currency
end

#default_token ⇒ Object

Returns the value of attribute default_token.



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

def default_token
  @default_token
end

#default_token_id ⇒ Object

Returns the value of attribute default_token_id.



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

def default_token_id
  @default_token_id
end

#email ⇒ Object

Returns the value of attribute email.



20
21
22
 
# File 'lib/processout/customer.rb', line 20

def email
  @email
end

#first_name ⇒ Object

Returns the value of attribute first_name.



21
22
23
 
# File 'lib/processout/customer.rb', line 21

def first_name
  @first_name
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#ip_address ⇒ Object

Returns the value of attribute ip_address.



29
30
31
 
# File 'lib/processout/customer.rb', line 29

def ip_address
  @ip_address
end

#last_name ⇒ Object

Returns the value of attribute last_name.



22
23
24
 
# File 'lib/processout/customer.rb', line 22

def last_name
  @last_name
end

#legal_document ⇒ Object

Returns the value of attribute legal_document.



31
32
33
 
# File 'lib/processout/customer.rb', line 31

def legal_document
  @legal_document
end

#metadata ⇒ Object

Returns the value of attribute metadata.



32
33
34
 
# File 'lib/processout/customer.rb', line 32

def metadata
  @metadata
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



30
31
32
 
# File 'lib/processout/customer.rb', line 30

def phone_number
  @phone_number
end

#project ⇒ Object

Returns the value of attribute project.



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

def project
  @project
end

#project_id ⇒ Object

Returns the value of attribute project_id.



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

def project_id
  @project_id
end

#sandbox ⇒ Object

Returns the value of attribute sandbox.



33
34
35
 
# File 'lib/processout/customer.rb', line 33

def sandbox
  @sandbox
end

#state ⇒ Object

Returns the value of attribute state.



26
27
28
 
# File 'lib/processout/customer.rb', line 26

def state
  @state
end

#subscriptions ⇒ Object

Returns the value of attribute subscriptions.



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

def subscriptions
  @subscriptions
end

#tokens ⇒ Object

Returns the value of attribute tokens.



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

def tokens
  @tokens
end

#transactions ⇒ Object

Returns the value of attribute transactions.



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

def transactions
  @transactions
end

#zip ⇒ Object

Returns the value of attribute zip.



27
28
29
 
# File 'lib/processout/customer.rb', line 27

def zip
  @zip
end

Instance Method Details

#all(options = {}) ⇒ Object

Get all the customers. Params:

options

Hash of options



534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/processout/customer.rb', line 534

def all(options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/customers"
  data    = {

  }

  response = Response.new(request.get(path, data, options))
  return_values = Array.new
  
  a    = Array.new
  body = response.body
  for v in body['customers']
    tmp = Customer.new(@client)
    tmp.fill_with_data(v)
    a.push(tmp)
  end

  return_values.push(a)
  

  
  return_values[0]
end

#create(options = {}) ⇒ Object

Create a new customer. Params:

options

Hash of options



564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/processout/customer.rb', line 564

def create(options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/customers"
  data    = {
    "balance" => @balance, 
    "currency" => @currency, 
    "email" => @email, 
    "first_name" => @first_name, 
    "last_name" => @last_name, 
    "address1" => @address1, 
    "address2" => @address2, 
    "city" => @city, 
    "state" => @state, 
    "zip" => @zip, 
    "country_code" => @country_code, 
    "ip_address" => @ip_address, 
    "phone_number" => @phone_number, 
    "legal_document" => @legal_document, 
    "metadata" => @metadata, 
    "id" => @id
  }

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

  
  return_values[0]
end

#delete(options = {}) ⇒ Object

Delete the customer. Params:

options

Hash of options



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'lib/processout/customer.rb', line 673

def delete(options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/customers/" + CGI.escape(@id) + ""
  data    = {

  }

  response = Response.new(request.delete(path, data, options))
  return_values = Array.new
  
  return_values.push(response.success)

  
  return_values[0]
end

#delete_token(token_id, options = {}) ⇒ Object

Delete a customer’s token by its ID. Params:

token_id

ID of the token

options

Hash of options



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/processout/customer.rb', line 483

def delete_token(token_id, options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/customers/" + CGI.escape(@id) + "/tokens/" + CGI.escape(token_id) + ""
  data    = {

  }

  response = Response.new(request.delete(path, data, options))
  return_values = Array.new
  
  return_values.push(response.success)

  
  return_values[0]
end

#fetch_subscriptions(options = {}) ⇒ Object

Get the subscriptions belonging to the customer. Params:

options

Hash of options



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/processout/customer.rb', line 375

def fetch_subscriptions(options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/customers/" + CGI.escape(@id) + "/subscriptions"
  data    = {

  }

  response = Response.new(request.get(path, data, options))
  return_values = Array.new
  
  a    = Array.new
  body = response.body
  for v in body['subscriptions']
    tmp = Subscription.new(@client)
    tmp.fill_with_data(v)
    a.push(tmp)
  end

  return_values.push(a)
  

  
  return_values[0]
end

#fetch_tokens(options = {}) ⇒ Object

Get the customer’s tokens. Params:

options

Hash of options



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/processout/customer.rb', line 427

def fetch_tokens(options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/customers/" + CGI.escape(@id) + "/tokens"
  data    = {

  }

  response = Response.new(request.get(path, data, options))
  return_values = Array.new
  
  a    = Array.new
  body = response.body
  for v in body['tokens']
    tmp = Token.new(@client)
    tmp.fill_with_data(v)
    a.push(tmp)
  end

  return_values.push(a)
  

  
  return_values[0]
end

#fetch_transactions(options = {}) ⇒ Object

Get the transactions belonging to the customer. Params:

options

Hash of options



504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/processout/customer.rb', line 504

def fetch_transactions(options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/customers/" + CGI.escape(@id) + "/transactions"
  data    = {

  }

  response = Response.new(request.get(path, data, options))
  return_values = Array.new
  
  a    = Array.new
  body = response.body
  for v in body['transactions']
    tmp = Transaction.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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/processout/customer.rb', line 253

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? "default_token"
    self.default_token = data["default_token"]
  end
  if data.include? "default_token_id"
    self.default_token_id = data["default_token_id"]
  end
  if data.include? "tokens"
    self.tokens = data["tokens"]
  end
  if data.include? "subscriptions"
    self.subscriptions = data["subscriptions"]
  end
  if data.include? "transactions"
    self.transactions = data["transactions"]
  end
  if data.include? "balance"
    self.balance = data["balance"]
  end
  if data.include? "currency"
    self.currency = data["currency"]
  end
  if data.include? "email"
    self.email = data["email"]
  end
  if data.include? "first_name"
    self.first_name = data["first_name"]
  end
  if data.include? "last_name"
    self.last_name = data["last_name"]
  end
  if data.include? "address1"
    self.address1 = data["address1"]
  end
  if data.include? "address2"
    self.address2 = data["address2"]
  end
  if data.include? "city"
    self.city = data["city"]
  end
  if data.include? "state"
    self.state = data["state"]
  end
  if data.include? "zip"
    self.zip = data["zip"]
  end
  if data.include? "country_code"
    self.country_code = data["country_code"]
  end
  if data.include? "ip_address"
    self.ip_address = data["ip_address"]
  end
  if data.include? "phone_number"
    self.phone_number = data["phone_number"]
  end
  if data.include? "legal_document"
    self.legal_document = data["legal_document"]
  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(customer_id, options = {}) ⇒ Object

Find a customer by its ID. Params:

customer_id

ID of the customer

options

Hash of options



606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
 
# File 'lib/processout/customer.rb', line 606

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

  request = Request.new(@client)
  path    = "/customers/" + CGI.escape(customer_id) + ""
  data    = {

  }

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

  
  return_values[0]
end

#find_token(token_id, options = {}) ⇒ Object

Find a customer’s token by its ID. Params:

token_id

ID of the token

options

Hash of options



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/processout/customer.rb', line 458

def find_token(token_id, options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/customers/" + CGI.escape(@id) + "/tokens/" + CGI.escape(token_id) + ""
  data    = {

  }

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

  
  return_values[0]
end

#new(data = {}) ⇒ Object

Create a new Customer using the current client



246
247
248
 
# File 'lib/processout/customer.rb', line 246

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

#prefill(data) ⇒ Object

Prefills the object with the data passed as parameters Params:

data

Hash of data



339
340
341
342
343
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
 
# File 'lib/processout/customer.rb', line 339

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.default_token = data.fetch(:default_token, self.default_token)
  self.default_token_id = data.fetch(:default_token_id, self.default_token_id)
  self.tokens = data.fetch(:tokens, self.tokens)
  self.subscriptions = data.fetch(:subscriptions, self.subscriptions)
  self.transactions = data.fetch(:transactions, self.transactions)
  self.balance = data.fetch(:balance, self.balance)
  self.currency = data.fetch(:currency, self.currency)
  self.email = data.fetch(:email, self.email)
  self.first_name = data.fetch(:first_name, self.first_name)
  self.last_name = data.fetch(:last_name, self.last_name)
  self.address1 = data.fetch(:address1, self.address1)
  self.address2 = data.fetch(:address2, self.address2)
  self.city = data.fetch(:city, self.city)
  self.state = data.fetch(:state, self.state)
  self.zip = data.fetch(:zip, self.zip)
  self.country_code = data.fetch(:country_code, self.country_code)
  self.ip_address = data.fetch(:ip_address, self.ip_address)
  self.phone_number = data.fetch(:phone_number, self.phone_number)
  self.legal_document = data.fetch(:legal_document, self.legal_document)
  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

#save(options = {}) ⇒ Object

Save the updated customer attributes. Params:

options

Hash of options



633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
 
# File 'lib/processout/customer.rb', line 633

def save(options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/customers/" + CGI.escape(@id) + ""
  data    = {
    "balance" => @balance, 
    "default_token_id" => @default_token_id, 
    "email" => @email, 
    "first_name" => @first_name, 
    "last_name" => @last_name, 
    "address1" => @address1, 
    "address2" => @address2, 
    "city" => @city, 
    "state" => @state, 
    "zip" => @zip, 
    "country_code" => @country_code, 
    "ip_address" => @ip_address, 
    "phone_number" => @phone_number, 
    "legal_document" => @legal_document, 
    "metadata" => @metadata
  }

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

  
  return_values[0]
end

#verify_token(token_id, options = {}) ⇒ Object

Verify a customer token’s card is valid. Params:

token_id

ID of the token

options

Hash of options



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/processout/customer.rb', line 406

def verify_token(token_id, options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/customers/" + CGI.escape(@id) + "/tokens/" + CGI.escape(token_id) + "/verify"
  data    = {

  }

  response = Response.new(request.post(path, data, options))
  return_values = Array.new
  
  return_values.push(response.success)

  
  return_values[0]
end