Class: Tpaga::CreditCardApi

Inherits:
Object show all
Defined in:
lib/tpaga/api/credit_card_api.rb

Class Method Summary collapse

Class Method Details

.add_credit_card(customer_id, body, opts = {}) ⇒ CreditCard

Adds a new Credit Card payment method to the Customer Creates a new ‘CreditCard` and associates it to the `Customer`

Parameters:

  • customer_id —

    Identificaiton of ‘Customer` to associate the new `CreditCard`

  • body —

    The ‘CreditCard` object to be associated to the `Customer`, it has the following fieldsn- primaryAccountNumber which is the number as it appears on the credit card.n- cardVerificationCode which is the security code usually found in the back o the credit card.n- expirationMonth which is the month of expiration of the credit card, its entered as a numeric value with single digits or double digits like 5 or 05 to represent may.n- expirationYear which is the year of expiration of the credit card in its complete numeric value.n- cardHolderName which is the name of the card holder exactly as it appears on the credit card.n- billingAddress which is the billing address of the credit card that consists of two address lines, the city, the country, the postalCode and the state of the address.

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

    the optional parameters

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'lib/tpaga/api/credit_card_api.rb', line 94

def self.add_credit_card(customer_id, body, opts = {})

  # verify the required parameter 'customer_id' is set
  raise "Missing the required parameter 'customer_id' when calling add_credit_card" if customer_id.nil?

  # verify the required parameter 'body' is set
  raise "Missing the required parameter 'body' when calling add_credit_card" if body.nil?


  # resource path
  path = "/customer/{customer_id}/credit_card".sub('{format}', 'json').sub('{' + 'customer_id' + '}', customer_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = Swagger::Request.object_to_http_body(body)


  auth_names = ['api_key']
  response = Swagger::Request.new(:POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = CreditCard.new() and obj.build_from_hash(response)
end

.add_credit_card_charge(body, opts = {}) ⇒ CreditCardCharge

Adds a new CreditCardCharge to Customer's CreditCard Creates a new ‘CreditCardCharge` and associates it to a `CreditCard`.

Parameters:

  • body —

    The ‘CreditCardCharge` object to be generated to a `CreditCard` it has the following fieldsn- id its the id of the `CreditCardCharge` thats going to be generated after creation.n- creditCard which is the identificator of the `CreditCard` to be chargedn- customer which is the id of the `Customer` associated with the `CreditCard`n- amount which is the full amount of the chargen- currency its the 3-letter ISO code for the currency.n- installments its the amount of payments to divide the charge amount, it can be minumum 1 maximum 36n- taxAmount the amount that accounts as taxes.n- paid its the status of the charge. true if its paid, false if its not.n- description which is the desciption of the charge being made.n- orderId commerce order identificator

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

    the optional parameters

Returns:



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/tpaga/api/credit_card_api.rb', line 13

def self.add_credit_card_charge(body, opts = {})

  # verify the required parameter 'body' is set
  raise "Missing the required parameter 'body' when calling add_credit_card_charge" if body.nil?


  # resource path
  path = "/charge/credit_card".sub('{format}', 'json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = Swagger::Request.object_to_http_body(body)


  auth_names = ['api_key']
  response = Swagger::Request.new(:POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = CreditCardCharge.new() and obj.build_from_hash(response)
end

.delete_credit_card_by_id(customer_id, card_id, opts = {}) ⇒ nil

Deletes a CreditCard by ID Deletes a ‘CreditCard` when its `id` matches the parameters. Only available when `CreditCard` does not have associated Charges.

Parameters:

  • customer_id —

    Identificaiton of ‘Customer` associated with the `CreditCard`

  • card_id —

    Identification of ‘CreditCard` to be deleted

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

    the optional parameters

Returns:

  • (nil) 


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
 
# File 'lib/tpaga/api/credit_card_api.rb', line 182

def self.delete_credit_card_by_id(customer_id, card_id, opts = {})

  # verify the required parameter 'customer_id' is set
  raise "Missing the required parameter 'customer_id' when calling delete_credit_card_by_id" if customer_id.nil?

  # verify the required parameter 'card_id' is set
  raise "Missing the required parameter 'card_id' when calling delete_credit_card_by_id" if card_id.nil?


  # resource path
  path = "/customer/{customer_id}/credit_card/{card_id}".sub('{format}', 'json').sub('{' + 'customer_id' + '}', customer_id.to_s).sub('{' + 'card_id' + '}', card_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil


  auth_names = ['api_key']
  Swagger::Request.new(:DELETE, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make
  nil
end

.get_credit_card_by_id(customer_id, card_id, opts = {}) ⇒ CreditCard

Retrieve a CreditCard by ID Get the details of an existing ‘CreditCard`. This method only requires an unique `CreditCard` identifier `id` that was returned upon `CreditCard` creation.

Parameters:

  • customer_id —

    Identification of ‘Customer` associated with the `CreditCard`

  • card_id —

    Identification of ‘CreditCard` that needs to be retrieved

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

    the optional parameters

Returns:



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
 
# File 'lib/tpaga/api/credit_card_api.rb', line 138

def self.get_credit_card_by_id(customer_id, card_id, opts = {})

  # verify the required parameter 'customer_id' is set
  raise "Missing the required parameter 'customer_id' when calling get_credit_card_by_id" if customer_id.nil?

  # verify the required parameter 'card_id' is set
  raise "Missing the required parameter 'card_id' when calling get_credit_card_by_id" if card_id.nil?


  # resource path
  path = "/customer/{customer_id}/credit_card/{card_id}".sub('{format}', 'json').sub('{' + 'customer_id' + '}', customer_id.to_s).sub('{' + 'card_id' + '}', card_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil


  auth_names = ['api_key']
  response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = CreditCard.new() and obj.build_from_hash(response)
end

.get_credit_card_charge_by_id(id, opts = {}) ⇒ CreditCardCharge

Retrieve a CreditCardCharge by ID Get the details of an existing ‘CreditCardCharge`. This method only requires an unique `CreditCardCharge` identifier `id` that was returned upon `CreditCardCharge` creation.

Parameters:

  • id —

    Identification of ‘CreditCardCharge` that needs to be retrieved

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

    the optional parameters

Returns:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/tpaga/api/credit_card_api.rb', line 53

def self.get_credit_card_charge_by_id(id, opts = {})

  # verify the required parameter 'id' is set
  raise "Missing the required parameter 'id' when calling get_credit_card_charge_by_id" if id.nil?


  # resource path
  path = "/charge/credit_card/{id}".sub('{format}', 'json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil


  auth_names = ['api_key']
  response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = CreditCardCharge.new() and obj.build_from_hash(response)
end