Skip to content

Commit 9a88847

Browse files
authored
Merge pull request #102 from CyberSource/nov-release
nov release update
2 parents 38379d2 + 08c0c82 commit 9a88847

File tree

73 files changed

+4043
-448
lines changed

Some content is hidden

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

73 files changed

+4043
-448
lines changed

docs/AsymmetricKeyManagementApi.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Method | HTTP request | Description
77
[**createP12Keys**](AsymmetricKeyManagementApi.md#createP12Keys) | **POST** /kms/v2/keys-asym | Create one or more PKCS12 keys
88
[**deleteBulkP12Keys**](AsymmetricKeyManagementApi.md#deleteBulkP12Keys) | **POST** /kms/v2/keys-asym/deletes | Delete one or more PKCS12 keys
99
[**getP12KeyDetails**](AsymmetricKeyManagementApi.md#getP12KeyDetails) | **GET** /kms/v2/keys-asym/{keyId} | Retrieves PKCS12 key details
10+
[**updateAsymKey**](AsymmetricKeyManagementApi.md#updateAsymKey) | **PATCH** /kms/v2/keys-asym/{keyId} | Activate or De-activate Asymmetric Key
1011

1112

1213
<a name="createP12Keys"></a>
@@ -147,3 +148,52 @@ No authorization required
147148
- **Content-Type**: application/json;charset=utf-8
148149
- **Accept**: application/hal+json;charset=utf-8
149150

151+
<a name="updateAsymKey"></a>
152+
# **updateAsymKey**
153+
> Object updateAsymKey(keyId, updateAsymKeysRequest)
154+
155+
Activate or De-activate Asymmetric Key
156+
157+
Activate or De-activate Asymmetric Key
158+
159+
### Example
160+
```javascript
161+
var CyberSource = require('CyberSource');
162+
163+
var apiInstance = new CyberSource.AsymmetricKeyManagementApi();
164+
165+
var keyId = "keyId_example"; // String | Key ID.
166+
167+
var updateAsymKeysRequest = new CyberSource.UpdateAsymKeysRequest(); // UpdateAsymKeysRequest |
168+
169+
170+
var callback = function(error, data, response) {
171+
if (error) {
172+
console.error(error);
173+
} else {
174+
console.log('API called successfully. Returned data: ' + data);
175+
}
176+
};
177+
apiInstance.updateAsymKey(keyId, updateAsymKeysRequest, callback);
178+
```
179+
180+
### Parameters
181+
182+
Name | Type | Description | Notes
183+
------------- | ------------- | ------------- | -------------
184+
**keyId** | **String**| Key ID. |
185+
**updateAsymKeysRequest** | [**UpdateAsymKeysRequest**](UpdateAsymKeysRequest.md)| |
186+
187+
### Return type
188+
189+
**Object**
190+
191+
### Authorization
192+
193+
No authorization required
194+
195+
### HTTP request headers
196+
197+
- **Content-Type**: application/json;charset=utf-8
198+
- **Accept**: application/hal+json;charset=utf-8
199+

docs/CreateSearchRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**timezone** | **String** | Merchant’s time zone in ISO standard, using the TZ database format. For example: &#x60;America/Chicago&#x60; | [optional]
99
**query** | **String** | String that contains the filters and variables for which you want to search. For information about supported field-filters and operators, see the [Query Filters]( https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn-search-intro/txn-filtering.html) section of the Transaction Search Developer Guide. | [optional]
1010
**offset** | **Number** | Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit&#x3D;5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: &#x60;offset&#x3D;0&#x60; &#x60;offset&#x3D;5&#x60; &#x60;offset&#x3D;10&#x60; **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned. | [optional]
11-
**limit** | **Number** | Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2000. | [optional]
11+
**limit** | **Number** | Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. | [optional]
1212
**sort** | **String** | A comma separated list of the following form: &#x60;submitTimeUtc:desc&#x60; | [optional]
1313

1414

docs/InlineResponse200.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# CyberSource.InlineResponse200
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**submitTimeUtc** | **String** | Time of request in UTC. &#x60;Format: YYYY-MM-DDThh:mm:ssZ&#x60; 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. | [optional]
7+
**totalCount** | **Number** | Specifies the total number of items found based on the request | [optional]
8+
**offset** | **Number** | Specifies the record offset from the records are returned part of the response | [optional]
9+
**limit** | **Number** | Specifies the maximum number of records requested part of the response | [optional]
10+
**sort** | **String** | Specifies a comma separated list of field names based on which the result is sorted. | [optional]
11+
**keys** | [**[InlineResponse200Keys]**](InlineResponse200Keys.md) | | [optional]
12+
13+

docs/InlineResponse200Keys.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# CyberSource.InlineResponse200Keys
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**organizationId** | **String** | Merchant Id | [optional]
7+
**merchantName** | **String** | Merchant Name | [optional]
8+
**keyId** | **String** | Key Id | [optional]
9+
**keyType** | **String** | Key Type | [optional]
10+
**status** | **String** | Status can be active/inactive | [optional]
11+
**expirationDate** | **Date** | Expiry Date. example - 2028-07-15 22:11:56 UTC | [optional]
12+
**dateAdded** | **Date** | Date Addded. example - 2018-04-25 22:11:56 UTC | [optional]
13+
**addedBy** | **String** | Added By | [optional]
14+
**dateModified** | **Date** | Modified Date. | [optional]
15+
**modifiedBy** | **String** | Modified By | [optional]
16+
**version** | **String** | Version | [optional]
17+
**serialNumber** | **String** | Serial Number | [optional]
18+
**issuerName** | **String** | Issuer Name | [optional]
19+
20+

docs/InlineResponse4003.md

Lines changed: 5 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -3,47 +3,10 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**correlationId** | **String** | | [optional]
7-
**details** | [**[InlineResponse4003Details]**](InlineResponse4003Details.md) | | [optional]
8-
**informationLink** | **String** | | [optional]
9-
**message** | **String** | |
10-
**reason** | **String** | |
11-
12-
13-
<a name="ReasonEnum"></a>
14-
## Enum: ReasonEnum
15-
16-
17-
* `INVALID_APIKEY` (value: `"INVALID_APIKEY"`)
18-
19-
* `INVALID_SHIPPING_INPUT_PARAMS` (value: `"INVALID_SHIPPING_INPUT_PARAMS"`)
20-
21-
* `CAPTURE_CONTEXT_INVALID` (value: `"CAPTURE_CONTEXT_INVALID"`)
22-
23-
* `CAPTURE_CONTEXT_EXPIRED` (value: `"CAPTURE_CONTEXT_EXPIRED"`)
24-
25-
* `SDK_XHR_ERROR` (value: `"SDK_XHR_ERROR"`)
26-
27-
* `UNIFIEDPAYMENTS_VALIDATION_PARAMS` (value: `"UNIFIEDPAYMENTS_VALIDATION_PARAMS"`)
28-
29-
* `UNIFIEDPAYMENTS_VALIDATION_FIELDS` (value: `"UNIFIEDPAYMENTS_VALIDATION_FIELDS"`)
30-
31-
* `UNIFIEDPAYMENT_PAYMENT_PARAMITERS` (value: `"UNIFIEDPAYMENT_PAYMENT_PARAMITERS"`)
32-
33-
* `CREATE_TOKEN_TIMEOUT` (value: `"CREATE_TOKEN_TIMEOUT"`)
34-
35-
* `CREATE_TOKEN_XHR_ERROR` (value: `"CREATE_TOKEN_XHR_ERROR"`)
36-
37-
* `SHOW_LOAD_CONTAINER_SELECTOR` (value: `"SHOW_LOAD_CONTAINER_SELECTOR"`)
38-
39-
* `SHOW_LOAD_INVALID_CONTAINER` (value: `"SHOW_LOAD_INVALID_CONTAINER"`)
40-
41-
* `SHOW_TOKEN_TIMEOUT` (value: `"SHOW_TOKEN_TIMEOUT"`)
42-
43-
* `SHOW_TOKEN_XHR_ERROR` (value: `"SHOW_TOKEN_XHR_ERROR"`)
44-
45-
* `SHOW_PAYMENT_TIMEOUT` (value: `"SHOW_PAYMENT_TIMEOUT"`)
46-
47-
6+
**submitTimeUtc** | **String** | Time of request in UTC. Format: &#x60;YYYY-MM-DDThh:mm:ssZ&#x60; **Example** &#x60;2016-08-11T22:47:57Z&#x60; equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The &#x60;T&#x60; separates the date and the time. The &#x60;Z&#x60; indicates UTC. Returned by Cybersource for all services. | [optional]
7+
**status** | **String** | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional]
8+
**reason** | **String** | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA | [optional]
9+
**message** | **String** | The detail message related to the status and reason listed above. | [optional]
10+
**details** | [**[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.md) | | [optional]
4811

4912

docs/InlineResponse4004.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# CyberSource.InlineResponse4004
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**correlationId** | **String** | | [optional]
7+
**details** | [**[InlineResponse4004Details]**](InlineResponse4004Details.md) | | [optional]
8+
**informationLink** | **String** | | [optional]
9+
**message** | **String** | |
10+
**reason** | **String** | |
11+
12+
13+
<a name="ReasonEnum"></a>
14+
## Enum: ReasonEnum
15+
16+
17+
* `INVALID_APIKEY` (value: `"INVALID_APIKEY"`)
18+
19+
* `INVALID_SHIPPING_INPUT_PARAMS` (value: `"INVALID_SHIPPING_INPUT_PARAMS"`)
20+
21+
* `CAPTURE_CONTEXT_INVALID` (value: `"CAPTURE_CONTEXT_INVALID"`)
22+
23+
* `CAPTURE_CONTEXT_EXPIRED` (value: `"CAPTURE_CONTEXT_EXPIRED"`)
24+
25+
* `SDK_XHR_ERROR` (value: `"SDK_XHR_ERROR"`)
26+
27+
* `UNIFIEDPAYMENTS_VALIDATION_PARAMS` (value: `"UNIFIEDPAYMENTS_VALIDATION_PARAMS"`)
28+
29+
* `UNIFIEDPAYMENTS_VALIDATION_FIELDS` (value: `"UNIFIEDPAYMENTS_VALIDATION_FIELDS"`)
30+
31+
* `UNIFIEDPAYMENT_PAYMENT_PARAMITERS` (value: `"UNIFIEDPAYMENT_PAYMENT_PARAMITERS"`)
32+
33+
* `CREATE_TOKEN_TIMEOUT` (value: `"CREATE_TOKEN_TIMEOUT"`)
34+
35+
* `CREATE_TOKEN_XHR_ERROR` (value: `"CREATE_TOKEN_XHR_ERROR"`)
36+
37+
* `SHOW_LOAD_CONTAINER_SELECTOR` (value: `"SHOW_LOAD_CONTAINER_SELECTOR"`)
38+
39+
* `SHOW_LOAD_INVALID_CONTAINER` (value: `"SHOW_LOAD_INVALID_CONTAINER"`)
40+
41+
* `SHOW_TOKEN_TIMEOUT` (value: `"SHOW_TOKEN_TIMEOUT"`)
42+
43+
* `SHOW_TOKEN_XHR_ERROR` (value: `"SHOW_TOKEN_XHR_ERROR"`)
44+
45+
* `SHOW_PAYMENT_TIMEOUT` (value: `"SHOW_PAYMENT_TIMEOUT"`)
46+
47+
48+
49+

docs/InlineResponse4003Details.md renamed to docs/InlineResponse4004Details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CyberSource.InlineResponse4003Details
1+
# CyberSource.InlineResponse4004Details
22

33
## Properties
44
Name | Type | Description | Notes

docs/InlineResponse500.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CyberSource.InlineResponse500
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**submitTimeUtc** | **String** | Time of request in UTC. Format: &#x60;YYYY-MM-DDThh:mm:ssZ&#x60; **Example** &#x60;2016-08-11T22:47:57Z&#x60; equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The &#x60;T&#x60; separates the date and the time. The &#x60;Z&#x60; indicates UTC. Returned by Cybersource for all services. | [optional]
7+
**status** | **String** | The status of the submitted request. Possible values: - SERVER_ERROR | [optional]
8+
**reason** | **String** | The reason of the status. Possible values: - SYSTEM_ERROR - SERVER_TIMEOUT - SERVICE_TIMEOUT | [optional]
9+
**message** | **String** | The detail message related to the status and reason listed above. | [optional]
10+
11+

docs/KeyManagementApi.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# CyberSource.KeyManagementApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**searchKeys**](KeyManagementApi.md#searchKeys) | **GET** /kms/v2/keys | Search Keys
8+
9+
10+
<a name="searchKeys"></a>
11+
# **searchKeys**
12+
> InlineResponse200 searchKeys(opts)
13+
14+
Search Keys
15+
16+
Search one or more Keys
17+
18+
### Example
19+
```javascript
20+
var CyberSource = require('CyberSource');
21+
22+
var apiInstance = new CyberSource.KeyManagementApi();
23+
24+
var opts = {
25+
'offset': 56, // Number | This allows you to specify the page offset from the resulting list resultset you want the records to be returned
26+
'limit': 56, // Number | This allows you to specify the total number of records to be returned off the resulting list resultset
27+
'sort': "sort_example", // String | This allows you to specify a comma separated list of fields in the order which the resulting list resultset must be sorted.
28+
'organizationIds': ["organizationIds_example"], // [String] | List of Orgaization Ids to search. The maximum size of the organization Ids list is 1. The maximum length of Organization Id is 30.
29+
'keyIds': ["keyIds_example"], // [String] | List of Key Ids to search. The maximum size of the Key Ids list is 1
30+
'keyTypes': ["keyTypes_example"], // [String] | Key Type, Possible values - certificate, password, pgp and scmp_api. When Key Type is provided atleast one more filter needs to be provided
31+
'expirationStartDate': new Date("2013-10-20T19:20:30+01:00"), // Date | Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided
32+
'expirationEndDate': new Date("2013-10-20T19:20:30+01:00") // Date | Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided
33+
};
34+
35+
var callback = function(error, data, response) {
36+
if (error) {
37+
console.error(error);
38+
} else {
39+
console.log('API called successfully. Returned data: ' + data);
40+
}
41+
};
42+
apiInstance.searchKeys(opts, callback);
43+
```
44+
45+
### Parameters
46+
47+
Name | Type | Description | Notes
48+
------------- | ------------- | ------------- | -------------
49+
**offset** | **Number**| This allows you to specify the page offset from the resulting list resultset you want the records to be returned | [optional]
50+
**limit** | **Number**| This allows you to specify the total number of records to be returned off the resulting list resultset | [optional]
51+
**sort** | **String**| This allows you to specify a comma separated list of fields in the order which the resulting list resultset must be sorted. | [optional]
52+
**organizationIds** | [**[String]**](String.md)| List of Orgaization Ids to search. The maximum size of the organization Ids list is 1. The maximum length of Organization Id is 30. | [optional]
53+
**keyIds** | [**[String]**](String.md)| List of Key Ids to search. The maximum size of the Key Ids list is 1 | [optional]
54+
**keyTypes** | [**[String]**](String.md)| Key Type, Possible values - certificate, password, pgp and scmp_api. When Key Type is provided atleast one more filter needs to be provided | [optional]
55+
**expirationStartDate** | **Date**| Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided | [optional]
56+
**expirationEndDate** | **Date**| Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided | [optional]
57+
58+
### Return type
59+
60+
[**InlineResponse200**](InlineResponse200.md)
61+
62+
### Authorization
63+
64+
No authorization required
65+
66+
### HTTP request headers
67+
68+
- **Content-Type**: application/json;charset=utf-8
69+
- **Accept**: application/hal+json;charset=utf-8
70+

docs/KeyManagementPasswordApi.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# CyberSource.KeyManagementPasswordApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**updatePassword**](KeyManagementPasswordApi.md#updatePassword) | **PATCH** /kms/v2/keys-password/{keyId} | Activate or De-activate Password
8+
9+
10+
<a name="updatePassword"></a>
11+
# **updatePassword**
12+
> Object updatePassword(keyId, updatePasswordKeysRequest)
13+
14+
Activate or De-activate Password
15+
16+
Activate or De-activate key of type password
17+
18+
### Example
19+
```javascript
20+
var CyberSource = require('CyberSource');
21+
22+
var apiInstance = new CyberSource.KeyManagementPasswordApi();
23+
24+
var keyId = "keyId_example"; // String | Key ID.
25+
26+
var updatePasswordKeysRequest = new CyberSource.UpdatePasswordKeysRequest(); // UpdatePasswordKeysRequest |
27+
28+
29+
var callback = function(error, data, response) {
30+
if (error) {
31+
console.error(error);
32+
} else {
33+
console.log('API called successfully. Returned data: ' + data);
34+
}
35+
};
36+
apiInstance.updatePassword(keyId, updatePasswordKeysRequest, callback);
37+
```
38+
39+
### Parameters
40+
41+
Name | Type | Description | Notes
42+
------------- | ------------- | ------------- | -------------
43+
**keyId** | **String**| Key ID. |
44+
**updatePasswordKeysRequest** | [**UpdatePasswordKeysRequest**](UpdatePasswordKeysRequest.md)| |
45+
46+
### Return type
47+
48+
**Object**
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/hal+json;charset=utf-8
58+

0 commit comments

Comments
 (0)