Skip to content

Commit 563027b

Browse files
authored
Merge pull request #108 from CyberSource/feature/mar-release-updates
Feature/mar release updates
2 parents b692ed5 + 9a6a894 commit 563027b

File tree

616 files changed

+36656
-10572
lines changed

Some content is hidden

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

616 files changed

+36656
-10572
lines changed
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CyberSource.Accountupdaterv1batchesIncluded
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**tokens** | [**[Accountupdaterv1batchesIncludedTokens]**](Accountupdaterv1batchesIncludedTokens.md) | | [optional]
7+
8+
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CyberSource.Accountupdaterv1batchesIncludedTokens
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **String** | |
7+
**expirationMonth** | **String** | | [optional]
8+
**expirationYear** | **String** | | [optional]
9+
10+

docs/BatchesApi.md

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
# CyberSource.BatchesApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**getBatchReport**](BatchesApi.md#getBatchReport) | **GET** /accountupdater/v1/batches/{batchId}/report | Retrieve a Batch Report
8+
[**getBatchStatus**](BatchesApi.md#getBatchStatus) | **GET** /accountupdater/v1/batches/{batchId}/status | Retrieve a Batch Status
9+
[**getBatchesList**](BatchesApi.md#getBatchesList) | **GET** /accountupdater/v1/batches | List Batches
10+
[**postBatch**](BatchesApi.md#postBatch) | **POST** /accountupdater/v1/batches | Create a Batch
11+
12+
13+
<a name="getBatchReport"></a>
14+
# **getBatchReport**
15+
> InlineResponse20014 getBatchReport(batchId)
16+
17+
Retrieve a Batch Report
18+
19+
**Get Batch Report**&lt;br&gt;This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH) - Source record information including token ids, masked card number, expiration dates &amp; card type. - Response record information including response code, reason, token ids, masked card number, expiration dates &amp; card type.
20+
21+
### Example
22+
```javascript
23+
var CyberSource = require('CyberSource');
24+
25+
var apiInstance = new CyberSource.BatchesApi();
26+
27+
var batchId = "batchId_example"; // String | Unique identification number assigned to the submitted request.
28+
29+
30+
var callback = function(error, data, response) {
31+
if (error) {
32+
console.error(error);
33+
} else {
34+
console.log('API called successfully. Returned data: ' + data);
35+
}
36+
};
37+
apiInstance.getBatchReport(batchId, callback);
38+
```
39+
40+
### Parameters
41+
42+
Name | Type | Description | Notes
43+
------------- | ------------- | ------------- | -------------
44+
**batchId** | **String**| Unique identification number assigned to the submitted request. |
45+
46+
### Return type
47+
48+
[**InlineResponse20014**](InlineResponse20014.md)
49+
50+
### Authorization
51+
52+
No authorization required
53+
54+
### HTTP request headers
55+
56+
- **Content-Type**: application/json;charset=utf-8
57+
- **Accept**: application/json;charset=utf-8
58+
59+
<a name="getBatchStatus"></a>
60+
# **getBatchStatus**
61+
> InlineResponse20013 getBatchStatus(batchId)
62+
63+
Retrieve a Batch Status
64+
65+
**Get Batch Status**&lt;br&gt;This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH)
66+
67+
### Example
68+
```javascript
69+
var CyberSource = require('CyberSource');
70+
71+
var apiInstance = new CyberSource.BatchesApi();
72+
73+
var batchId = "batchId_example"; // String | Unique identification number assigned to the submitted request.
74+
75+
76+
var callback = function(error, data, response) {
77+
if (error) {
78+
console.error(error);
79+
} else {
80+
console.log('API called successfully. Returned data: ' + data);
81+
}
82+
};
83+
apiInstance.getBatchStatus(batchId, callback);
84+
```
85+
86+
### Parameters
87+
88+
Name | Type | Description | Notes
89+
------------- | ------------- | ------------- | -------------
90+
**batchId** | **String**| Unique identification number assigned to the submitted request. |
91+
92+
### Return type
93+
94+
[**InlineResponse20013**](InlineResponse20013.md)
95+
96+
### Authorization
97+
98+
No authorization required
99+
100+
### HTTP request headers
101+
102+
- **Content-Type**: application/json;charset=utf-8
103+
- **Accept**: application/json;charset=utf-8
104+
105+
<a name="getBatchesList"></a>
106+
# **getBatchesList**
107+
> InlineResponse20012 getBatchesList(opts)
108+
109+
List Batches
110+
111+
**List Batches**&lt;br&gt;This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id. - The batch status. - The batch created / modified dates. - The total number of accepted, rejected, updated records. - The total number of card association responses.
112+
113+
### Example
114+
```javascript
115+
var CyberSource = require('CyberSource');
116+
117+
var apiInstance = new CyberSource.BatchesApi();
118+
119+
var opts = {
120+
'offset': 0, // Number | Starting record in zero-based dataset that should be returned as the first object in the array.
121+
'limit': 20, // Number | The maximum number that can be returned in the array starting from the offset record in zero-based dataset.
122+
'fromDate': "fromDate_example", // String | ISO-8601 format: yyyyMMddTHHmmssZ
123+
'toDate': "toDate_example" // String | ISO-8601 format: yyyyMMddTHHmmssZ
124+
};
125+
126+
var callback = function(error, data, response) {
127+
if (error) {
128+
console.error(error);
129+
} else {
130+
console.log('API called successfully. Returned data: ' + data);
131+
}
132+
};
133+
apiInstance.getBatchesList(opts, callback);
134+
```
135+
136+
### Parameters
137+
138+
Name | Type | Description | Notes
139+
------------- | ------------- | ------------- | -------------
140+
**offset** | **Number**| Starting record in zero-based dataset that should be returned as the first object in the array. | [optional] [default to 0]
141+
**limit** | **Number**| The maximum number that can be returned in the array starting from the offset record in zero-based dataset. | [optional] [default to 20]
142+
**fromDate** | **String**| ISO-8601 format: yyyyMMddTHHmmssZ | [optional]
143+
**toDate** | **String**| ISO-8601 format: yyyyMMddTHHmmssZ | [optional]
144+
145+
### Return type
146+
147+
[**InlineResponse20012**](InlineResponse20012.md)
148+
149+
### Authorization
150+
151+
No authorization required
152+
153+
### HTTP request headers
154+
155+
- **Content-Type**: application/json;charset=utf-8
156+
- **Accept**: application/json;charset=utf-8
157+
158+
<a name="postBatch"></a>
159+
# **postBatch**
160+
> InlineResponse2022 postBatch(body)
161+
162+
Create a Batch
163+
164+
**Create a Batch**&lt;br&gt;This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier. &lt;br&gt; The card numbers for the supplied tokens ids are then sent to the relevant card associations to check for updates.&lt;br&gt;The following type of batches can be submitted: - **oneOff** batch containing tokens id for Visa or MasterCard card numbers. - **amexRegistration** batch containing tokens id for Amex card numbers. A batch id will be returned on a successful response which can be used to get the batch status and the batch report.
165+
166+
### Example
167+
```javascript
168+
var CyberSource = require('CyberSource');
169+
170+
var apiInstance = new CyberSource.BatchesApi();
171+
172+
var body = new CyberSource.Body(); // Body |
173+
174+
175+
var callback = function(error, data, response) {
176+
if (error) {
177+
console.error(error);
178+
} else {
179+
console.log('API called successfully. Returned data: ' + data);
180+
}
181+
};
182+
apiInstance.postBatch(body, callback);
183+
```
184+
185+
### Parameters
186+
187+
Name | Type | Description | Notes
188+
------------- | ------------- | ------------- | -------------
189+
**body** | [**Body**](Body.md)| |
190+
191+
### Return type
192+
193+
[**InlineResponse2022**](InlineResponse2022.md)
194+
195+
### Authorization
196+
197+
No authorization required
198+
199+
### HTTP request headers
200+
201+
- **Content-Type**: application/json;charset=utf-8
202+
- **Accept**: application/json;charset=utf-8
203+

docs/Body.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**requestor** | **String** | Identifies the service requesting parsing |
7-
**parsedTagLimit** | **Number** | Number of tags to parse for each EMV tag string provided. | [optional]
8-
**emvDetailsList** | [**[Tssv2transactionsemvTagDetailsEmvDetailsList]**](Tssv2transactionsemvTagDetailsEmvDetailsList.md) | An array of objects, each containing a requestId and the corresponding emvRequestCombinedTags |
6+
**type** | **String** | Valid Values: * oneOff * amexRegistration | [optional] [default to &#39;oneOff&#39;]
7+
**included** | [**Accountupdaterv1batchesIncluded**](Accountupdaterv1batchesIncluded.md) | |
8+
**merchantReference** | **String** | Reference used by merchant to identify batch. | [optional]
9+
**notificationEmail** | **String** | Email used to notify the batch status. |
910

1011

docs/CreatePlanRequest.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CyberSource.CreatePlanRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**clientReferenceInformation** | [**Rbsv1plansClientReferenceInformation**](Rbsv1plansClientReferenceInformation.md) | | [optional]
7+
**planInformation** | [**Rbsv1plansPlanInformation**](Rbsv1plansPlanInformation.md) | | [optional]
8+
**orderInformation** | [**Rbsv1plansOrderInformation**](Rbsv1plansOrderInformation.md) | | [optional]
9+
10+

docs/CreateSubscriptionRequest.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# CyberSource.CreateSubscriptionRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**clientReferenceInformation** | [**Rbsv1subscriptionsClientReferenceInformation**](Rbsv1subscriptionsClientReferenceInformation.md) | | [optional]
7+
**processingInformation** | [**Rbsv1subscriptionsProcessingInformation**](Rbsv1subscriptionsProcessingInformation.md) | | [optional]
8+
**planInformation** | [**Rbsv1subscriptionsPlanInformation**](Rbsv1subscriptionsPlanInformation.md) | | [optional]
9+
**subscriptionInformation** | [**Rbsv1subscriptionsSubscriptionInformation**](Rbsv1subscriptionsSubscriptionInformation.md) | | [optional]
10+
**paymentInformation** | [**Rbsv1subscriptionsPaymentInformation**](Rbsv1subscriptionsPaymentInformation.md) | | [optional]
11+
**orderInformation** | [**InlineResponse200OrderInformation**](InlineResponse200OrderInformation.md) | | [optional]
12+
13+

0 commit comments

Comments
 (0)