Skip to content

Commit 8700ac9

Browse files
Merge pull request #90 from CyberSource/aug_release
aug release
2 parents 063d5bb + 1f5205f commit 8700ac9

File tree

87 files changed

+12073
-240
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+12073
-240
lines changed

cybersource_rest_client.gemspec

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ require "cybersource_rest_client/version"
1717

1818
Gem::Specification.new do |s|
1919
s.name = "cybersource_rest_client"
20-
s.version = "0.0.53"
20+
s.version = "0.0.54"
2121
s.platform = Gem::Platform::RUBY
2222
s.authors = ["CyberSource"]
2323
s.email = ["[email protected]"]

docs/BillingAgreementsApi.md

+158
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
# CyberSource::BillingAgreementsApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**billing_agreements_de_registration**](BillingAgreementsApi.md#billing_agreements_de_registration) | **PATCH** /pts/v2/billing-agreements/{id} | Standing Instruction Cancellation or Modification
8+
[**billing_agreements_intimation**](BillingAgreementsApi.md#billing_agreements_intimation) | **POST** /pts/v2/billing-agreements/{id}/intimations | Standing Instruction intimation
9+
[**billing_agreements_registration**](BillingAgreementsApi.md#billing_agreements_registration) | **POST** /pts/v2/billing-agreements | Standing Instruction completion registration
10+
11+
12+
# **billing_agreements_de_registration**
13+
> PtsV2CreditsPost201Response1 billing_agreements_de_registration(modify_billing_agreement, id)
14+
15+
Standing Instruction Cancellation or Modification
16+
17+
Standing Instruction with or without Token
18+
19+
### Example
20+
```ruby
21+
# load the gem
22+
require 'cybersource_rest_client'
23+
24+
api_instance = CyberSource::BillingAgreementsApi.new
25+
26+
modify_billing_agreement = CyberSource::ModifyBillingAgreement.new # ModifyBillingAgreement |
27+
28+
id = "id_example" # String | ID for de-registration or cancellation of Billing Agreement
29+
30+
31+
begin
32+
#Standing Instruction Cancellation or Modification
33+
result = api_instance.billing_agreements_de_registration(modify_billing_agreement, id)
34+
p result
35+
rescue CyberSource::ApiError => e
36+
puts "Exception when calling BillingAgreementsApi->billing_agreements_de_registration: #{e}"
37+
end
38+
```
39+
40+
### Parameters
41+
42+
Name | Type | Description | Notes
43+
------------- | ------------- | ------------- | -------------
44+
**modify_billing_agreement** | [**ModifyBillingAgreement**](ModifyBillingAgreement.md)| |
45+
**id** | **String**| ID for de-registration or cancellation of Billing Agreement |
46+
47+
### Return type
48+
49+
[**PtsV2CreditsPost201Response1**](PtsV2CreditsPost201Response1.md)
50+
51+
### Authorization
52+
53+
No authorization required
54+
55+
### HTTP request headers
56+
57+
- **Content-Type**: application/json;charset=utf-8
58+
- **Accept**: application/hal+json;charset=utf-8
59+
60+
61+
62+
# **billing_agreements_intimation**
63+
> PtsV2CreditsPost201Response1 billing_agreements_intimation(intimate_billing_agreement, id)
64+
65+
Standing Instruction intimation
66+
67+
Standing Instruction with or without Token.
68+
69+
### Example
70+
```ruby
71+
# load the gem
72+
require 'cybersource_rest_client'
73+
74+
api_instance = CyberSource::BillingAgreementsApi.new
75+
76+
intimate_billing_agreement = CyberSource::IntimateBillingAgreement.new # IntimateBillingAgreement |
77+
78+
id = "id_example" # String | ID for intimation of Billing Agreement
79+
80+
81+
begin
82+
#Standing Instruction intimation
83+
result = api_instance.billing_agreements_intimation(intimate_billing_agreement, id)
84+
p result
85+
rescue CyberSource::ApiError => e
86+
puts "Exception when calling BillingAgreementsApi->billing_agreements_intimation: #{e}"
87+
end
88+
```
89+
90+
### Parameters
91+
92+
Name | Type | Description | Notes
93+
------------- | ------------- | ------------- | -------------
94+
**intimate_billing_agreement** | [**IntimateBillingAgreement**](IntimateBillingAgreement.md)| |
95+
**id** | **String**| ID for intimation of Billing Agreement |
96+
97+
### Return type
98+
99+
[**PtsV2CreditsPost201Response1**](PtsV2CreditsPost201Response1.md)
100+
101+
### Authorization
102+
103+
No authorization required
104+
105+
### HTTP request headers
106+
107+
- **Content-Type**: application/json;charset=utf-8
108+
- **Accept**: application/hal+json;charset=utf-8
109+
110+
111+
112+
# **billing_agreements_registration**
113+
> PtsV2CreditsPost201Response1 billing_agreements_registration(create_billing_agreement)
114+
115+
Standing Instruction completion registration
116+
117+
Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed
118+
119+
### Example
120+
```ruby
121+
# load the gem
122+
require 'cybersource_rest_client'
123+
124+
api_instance = CyberSource::BillingAgreementsApi.new
125+
126+
create_billing_agreement = CyberSource::CreateBillingAgreement.new # CreateBillingAgreement |
127+
128+
129+
begin
130+
#Standing Instruction completion registration
131+
result = api_instance.billing_agreements_registration(create_billing_agreement)
132+
p result
133+
rescue CyberSource::ApiError => e
134+
puts "Exception when calling BillingAgreementsApi->billing_agreements_registration: #{e}"
135+
end
136+
```
137+
138+
### Parameters
139+
140+
Name | Type | Description | Notes
141+
------------- | ------------- | ------------- | -------------
142+
**create_billing_agreement** | [**CreateBillingAgreement**](CreateBillingAgreement.md)| |
143+
144+
### Return type
145+
146+
[**PtsV2CreditsPost201Response1**](PtsV2CreditsPost201Response1.md)
147+
148+
### Authorization
149+
150+
No authorization required
151+
152+
### HTTP request headers
153+
154+
- **Content-Type**: application/json;charset=utf-8
155+
- **Accept**: application/hal+json;charset=utf-8
156+
157+
158+

docs/CreateBillingAgreement.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# CyberSource::CreateBillingAgreement
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**client_reference_information** | [**Ptsv2paymentsClientReferenceInformation**](Ptsv2paymentsClientReferenceInformation.md) | | [optional]
7+
**aggregator_information** | [**Ptsv2billingagreementsAggregatorInformation**](Ptsv2billingagreementsAggregatorInformation.md) | | [optional]
8+
**consumer_authentication_information** | [**Ptsv2billingagreementsConsumerAuthenticationInformation**](Ptsv2billingagreementsConsumerAuthenticationInformation.md) | | [optional]
9+
**device_information** | [**Ptsv2billingagreementsDeviceInformation**](Ptsv2billingagreementsDeviceInformation.md) | | [optional]
10+
**installment_information** | [**Ptsv2billingagreementsInstallmentInformation**](Ptsv2billingagreementsInstallmentInformation.md) | | [optional]
11+
**merchant_information** | [**Ptsv2billingagreementsMerchantInformation**](Ptsv2billingagreementsMerchantInformation.md) | | [optional]
12+
**order_information** | [**Ptsv2billingagreementsOrderInformation**](Ptsv2billingagreementsOrderInformation.md) | | [optional]
13+
**payment_information** | [**Ptsv2billingagreementsPaymentInformation**](Ptsv2billingagreementsPaymentInformation.md) | | [optional]
14+
**processing_information** | [**Ptsv2billingagreementsProcessingInformation**](Ptsv2billingagreementsProcessingInformation.md) | | [optional]
15+
16+

docs/CreateBundledDecisionManagerCaseRequest.md

+1
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,6 @@ Name | Type | Description | Notes
1818
**recurring_payment_information** | [**Ptsv2paymentsRecurringPaymentInformation**](Ptsv2paymentsRecurringPaymentInformation.md) | | [optional]
1919
**consumer_authentication_information** | [**Riskv1decisionsConsumerAuthenticationInformation**](Riskv1decisionsConsumerAuthenticationInformation.md) | | [optional]
2020
**watchlist_screening_information** | [**Ptsv2paymentsWatchlistScreeningInformation**](Ptsv2paymentsWatchlistScreeningInformation.md) | | [optional]
21+
**token_information** | [**Riskv1decisionsTokenInformation**](Riskv1decisionsTokenInformation.md) | | [optional]
2122

2223

docs/IntimateBillingAgreement.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# CyberSource::IntimateBillingAgreement
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**client_reference_information** | [**Ptsv2paymentsClientReferenceInformation**](Ptsv2paymentsClientReferenceInformation.md) | | [optional]
7+
**installment_information** | [**Ptsv2billingagreementsInstallmentInformation**](Ptsv2billingagreementsInstallmentInformation.md) | | [optional]
8+
**merchant_information** | [**Ptsv2billingagreementsMerchantInformation**](Ptsv2billingagreementsMerchantInformation.md) | | [optional]
9+
**order_information** | [**Ptsv2billingagreementsOrderInformation**](Ptsv2billingagreementsOrderInformation.md) | | [optional]
10+
**payment_information** | [**Ptsv2billingagreementsPaymentInformation**](Ptsv2billingagreementsPaymentInformation.md) | | [optional]
11+
12+

docs/InvoiceSettingsApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ No authorization required
4545
### HTTP request headers
4646

4747
- **Content-Type**: application/json;charset=utf-8
48-
- **Accept**: application/json;charset=utf-8
48+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
4949

5050

5151

@@ -92,7 +92,7 @@ No authorization required
9292
### HTTP request headers
9393

9494
- **Content-Type**: application/json;charset=utf-8
95-
- **Accept**: application/json;charset=utf-8
95+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
9696

9797

9898

docs/InvoicesApi.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ No authorization required
5555
### HTTP request headers
5656

5757
- **Content-Type**: application/json;charset=utf-8
58-
- **Accept**: application/json;charset=utf-8
58+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
5959

6060

6161

@@ -109,7 +109,7 @@ No authorization required
109109
### HTTP request headers
110110

111111
- **Content-Type**: application/json;charset=utf-8
112-
- **Accept**: application/json;charset=utf-8
112+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
113113

114114

115115

@@ -156,7 +156,7 @@ No authorization required
156156
### HTTP request headers
157157

158158
- **Content-Type**: application/json;charset=utf-8
159-
- **Accept**: application/json;charset=utf-8
159+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
160160

161161

162162

@@ -203,7 +203,7 @@ No authorization required
203203
### HTTP request headers
204204

205205
- **Content-Type**: application/json;charset=utf-8
206-
- **Accept**: application/json;charset=utf-8
206+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
207207

208208

209209

@@ -250,7 +250,7 @@ No authorization required
250250
### HTTP request headers
251251

252252
- **Content-Type**: application/json;charset=utf-8
253-
- **Accept**: application/json;charset=utf-8
253+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
254254

255255

256256

@@ -300,7 +300,7 @@ No authorization required
300300
### HTTP request headers
301301

302302
- **Content-Type**: application/json;charset=utf-8
303-
- **Accept**: application/json;charset=utf-8
303+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
304304

305305

306306

docs/ModifyBillingAgreement.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# CyberSource::ModifyBillingAgreement
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**client_reference_information** | [**Ptsv2paymentsClientReferenceInformation**](Ptsv2paymentsClientReferenceInformation.md) | | [optional]
7+
**aggregator_information** | [**Ptsv2billingagreementsAggregatorInformation**](Ptsv2billingagreementsAggregatorInformation.md) | | [optional]
8+
**consumer_authentication_information** | [**Ptsv2billingagreementsConsumerAuthenticationInformation**](Ptsv2billingagreementsConsumerAuthenticationInformation.md) | | [optional]
9+
**device_information** | [**Ptsv2billingagreementsDeviceInformation**](Ptsv2billingagreementsDeviceInformation.md) | | [optional]
10+
**installment_information** | [**Ptsv2billingagreementsInstallmentInformation**](Ptsv2billingagreementsInstallmentInformation.md) | | [optional]
11+
**merchant_information** | [**Ptsv2billingagreementsMerchantInformation**](Ptsv2billingagreementsMerchantInformation.md) | | [optional]
12+
**order_information** | [**Ptsv2billingagreementsOrderInformation**](Ptsv2billingagreementsOrderInformation.md) | | [optional]
13+
**payment_information** | [**Ptsv2billingagreementsPaymentInformation**](Ptsv2billingagreementsPaymentInformation.md) | | [optional]
14+
**processing_information** | [**Ptsv2billingagreementsProcessingInformation**](Ptsv2billingagreementsProcessingInformation.md) | | [optional]
15+
16+

docs/PlansApi.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ No authorization required
5757
### HTTP request headers
5858

5959
- **Content-Type**: application/json;charset=utf-8
60-
- **Accept**: application/json;charset=utf-8
60+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
6161

6262

6363

@@ -104,7 +104,7 @@ No authorization required
104104
### HTTP request headers
105105

106106
- **Content-Type**: application/json;charset=utf-8
107-
- **Accept**: application/json;charset=utf-8
107+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
108108

109109

110110

@@ -151,7 +151,7 @@ No authorization required
151151
### HTTP request headers
152152

153153
- **Content-Type**: application/json;charset=utf-8
154-
- **Accept**: application/json;charset=utf-8
154+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
155155

156156

157157

@@ -198,7 +198,7 @@ No authorization required
198198
### HTTP request headers
199199

200200
- **Content-Type**: application/json;charset=utf-8
201-
- **Accept**: application/json;charset=utf-8
201+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
202202

203203

204204

@@ -245,7 +245,7 @@ No authorization required
245245
### HTTP request headers
246246

247247
- **Content-Type**: application/json;charset=utf-8
248-
- **Accept**: application/json;charset=utf-8
248+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
249249

250250

251251

@@ -286,7 +286,7 @@ No authorization required
286286
### HTTP request headers
287287

288288
- **Content-Type**: application/json;charset=utf-8
289-
- **Accept**: application/json;charset=utf-8
289+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
290290

291291

292292

@@ -342,7 +342,7 @@ No authorization required
342342
### HTTP request headers
343343

344344
- **Content-Type**: application/json;charset=utf-8
345-
- **Accept**: application/json;charset=utf-8
345+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
346346

347347

348348

@@ -392,7 +392,7 @@ No authorization required
392392
### HTTP request headers
393393

394394
- **Content-Type**: application/json;charset=utf-8
395-
- **Accept**: application/json;charset=utf-8
395+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
396396

397397

398398

docs/PtsV2CreditsPost201Response1.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# CyberSource::PtsV2CreditsPost201Response1
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **String** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional]
7+
**submit_time_utc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional]
8+
**status** | **String** | The status of the submitted transaction. | [optional]
9+
**processor_information** | [**PtsV2CreditsPost201Response1ProcessorInformation**](PtsV2CreditsPost201Response1ProcessorInformation.md) | | [optional]
10+
**installment_information** | [**PtsV2CreditsPost201Response1InstallmentInformation**](PtsV2CreditsPost201Response1InstallmentInformation.md) | | [optional]
11+
12+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CyberSource::PtsV2CreditsPost201Response1InstallmentInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**identifier** | **String** | Identifier | [optional]
7+
8+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# CyberSource::PtsV2CreditsPost201Response1ProcessorInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**approval_code** | **String** | Authorization code. Returned only when the processor returns this value. The length of this value depends on your processor. Returned by authorization service. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit credit. #### Elavon Encrypted Account Number Program The returned value is OFFLINE. #### TSYS Acquiring Solutions The returned value for a successful zero amount authorization is 000000. | [optional]
7+
**response_code** | **String** | For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### PIN debit Response value that is returned by the processor or bank. **Important** Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `processorInformation.responseCategoryCode` field. String (3) | [optional]
8+
9+

0 commit comments

Comments
 (0)