Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
12 changes: 6 additions & 6 deletions docs/BatchesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Method | HTTP request | Description

<a name="getBatchReport"></a>
# **getBatchReport**
> InlineResponse2007 getBatchReport(batchId)
> InlineResponse2009 getBatchReport(batchId)

Retrieve a Batch Report

Expand Down Expand Up @@ -45,7 +45,7 @@ Name | Type | Description | Notes

### Return type

[**InlineResponse2007**](InlineResponse2007.md)
[**InlineResponse2009**](InlineResponse2009.md)

### Authorization

Expand All @@ -58,7 +58,7 @@ No authorization required

<a name="getBatchStatus"></a>
# **getBatchStatus**
> InlineResponse2006 getBatchStatus(batchId)
> InlineResponse2008 getBatchStatus(batchId)

Retrieve a Batch Status

Expand Down Expand Up @@ -91,7 +91,7 @@ Name | Type | Description | Notes

### Return type

[**InlineResponse2006**](InlineResponse2006.md)
[**InlineResponse2008**](InlineResponse2008.md)

### Authorization

Expand All @@ -104,7 +104,7 @@ No authorization required

<a name="getBatchesList"></a>
# **getBatchesList**
> InlineResponse2005 getBatchesList(opts)
> InlineResponse2007 getBatchesList(opts)

List Batches

Expand Down Expand Up @@ -144,7 +144,7 @@ Name | Type | Description | Notes

### Return type

[**InlineResponse2005**](InlineResponse2005.md)
[**InlineResponse2007**](InlineResponse2007.md)

### Authorization

Expand Down
2 changes: 1 addition & 1 deletion docs/CommerceSolutionsProductsAccountUpdater.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**subscriptionInformation** | [**PaymentsProductsPayerAuthenticationSubscriptionInformation**](PaymentsProductsPayerAuthenticationSubscriptionInformation.md) | | [optional]
**subscriptionInformation** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) | | [optional]
**configurationInformation** | [**CommerceSolutionsProductsAccountUpdaterConfigurationInformation**](CommerceSolutionsProductsAccountUpdaterConfigurationInformation.md) | | [optional]


2 changes: 1 addition & 1 deletion docs/CommerceSolutionsProductsBinLookup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**subscriptionInformation** | [**PaymentsProductsPayerAuthenticationSubscriptionInformation**](PaymentsProductsPayerAuthenticationSubscriptionInformation.md) | | [optional]
**subscriptionInformation** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) | | [optional]
**configurationInformation** | [**CommerceSolutionsProductsBinLookupConfigurationInformation**](CommerceSolutionsProductsBinLookupConfigurationInformation.md) | | [optional]


2 changes: 1 addition & 1 deletion docs/CommerceSolutionsProductsTokenManagement.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**subscriptionInformation** | [**PaymentsProductsPayerAuthenticationSubscriptionInformation**](PaymentsProductsPayerAuthenticationSubscriptionInformation.md) | | [optional]
**subscriptionInformation** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) | | [optional]
**configurationInformation** | [**CommerceSolutionsProductsTokenManagementConfigurationInformation**](CommerceSolutionsProductsTokenManagementConfigurationInformation.md) | | [optional]


9 changes: 9 additions & 0 deletions docs/DeviceDeAssociateV3Request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CyberSource.DeviceDeAssociateV3Request

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deviceId** | **String** | ID of the device to be de-associated. |
**organizationId** | **String** | A field representing value of either account id or portfolio id. | [optional]


55 changes: 55 additions & 0 deletions docs/DeviceDeAssociationV3Api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# CyberSource.DeviceDeAssociationV3Api

All URIs are relative to *https://apitest.cybersource.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**postDeAssociateV3Terminal**](DeviceDeAssociationV3Api.md#postDeAssociateV3Terminal) | **POST** /dms/v3/devices/deassociate | De-associate a device from merchant to account or reseller and from account to reseller V3


<a name="postDeAssociateV3Terminal"></a>
# **postDeAssociateV3Terminal**
> [InlineResponse2005] postDeAssociateV3Terminal(deviceDeAssociateV3Request)

De-associate a device from merchant to account or reseller and from account to reseller V3

A device will be de-associated from its current organization and moved up in the hierarchy. The device's new position will be determined by a specified destination, either an account or a portfolio. If no destination is provided, the device will default to the currently logged-in user.

### Example
```javascript
var CyberSource = require('CyberSource');

var apiInstance = new CyberSource.DeviceDeAssociationV3Api();

var deviceDeAssociateV3Request = [new CyberSource.DeviceDeAssociateV3Request()]; // [DeviceDeAssociateV3Request] | deviceId that has to be de-associated to the destination organizationId.


var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.postDeAssociateV3Terminal(deviceDeAssociateV3Request, callback);
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**deviceDeAssociateV3Request** | [**[DeviceDeAssociateV3Request]**](DeviceDeAssociateV3Request.md)| deviceId that has to be de-associated to the destination organizationId. |

### Return type

[**[InlineResponse2005]**](InlineResponse2005.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json;charset=UTF-8
- **Accept**: application/json;charset=UTF-8

55 changes: 55 additions & 0 deletions docs/DeviceSearchApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# CyberSource.DeviceSearchApi

All URIs are relative to *https://apitest.cybersource.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**postSearchQueryV3**](DeviceSearchApi.md#postSearchQueryV3) | **POST** /dms/v3/devices/search | Retrieve List of Devices for a given search query V3


<a name="postSearchQueryV3"></a>
# **postSearchQueryV3**
> InlineResponse2006 postSearchQueryV3(postDeviceSearchRequestV3)

Retrieve List of Devices for a given search query V3

Search for devices matching a given search query. The search query supports serialNumber, readerId, terminalId, status, statusChangeReason or organizationId Matching results are paginated.

### Example
```javascript
var CyberSource = require('CyberSource');

var apiInstance = new CyberSource.DeviceSearchApi();

var postDeviceSearchRequestV3 = new CyberSource.PostDeviceSearchRequestV3(); // PostDeviceSearchRequestV3 |


var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.postSearchQueryV3(postDeviceSearchRequestV3, callback);
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**postDeviceSearchRequestV3** | [**PostDeviceSearchRequestV3**](PostDeviceSearchRequestV3.md)| |

### Return type

[**InlineResponse2006**](InlineResponse2006.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json;charset=UTF-8
- **Accept**: application/json;charset=UTF-8

10 changes: 10 additions & 0 deletions docs/Dmsv3devicesdeassociateDevices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CyberSource.Dmsv3devicesdeassociateDevices

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deviceId** | **String** | | [optional]
**reason** | **String** | | [optional]
**code** | **String** | | [optional]


9 changes: 2 additions & 7 deletions docs/InlineResponse2005.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**[InlineResponse2005Links]**](InlineResponse2005Links.md) | | [optional]
**_object** | **String** | | [optional]
**offset** | **Number** | | [optional]
**limit** | **Number** | | [optional]
**count** | **Number** | | [optional]
**total** | **Number** | | [optional]
**embedded** | [**InlineResponse2005Embedded**](InlineResponse2005Embedded.md) | | [optional]
**status** | **String** | Possible values: - OK | [optional]
**devices** | [**[Dmsv3devicesdeassociateDevices]**](Dmsv3devicesdeassociateDevices.md) | | [optional]


8 changes: 0 additions & 8 deletions docs/InlineResponse2005Embedded.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/InlineResponse2005EmbeddedLinks.md

This file was deleted.

16 changes: 6 additions & 10 deletions docs/InlineResponse2006.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,11 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**InlineResponse2006Links**](InlineResponse2006Links.md) | | [optional]
**batchId** | **String** | Unique identification number assigned to the submitted request. | [optional]
**batchCreatedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional]
**batchSource** | **String** | Valid Values: * SCHEDULER * TOKEN_API * CREDIT_CARD_FILE_UPLOAD * AMEX_REGSITRY * AMEX_REGISTRY_API * AMEX_MAINTENANCE | [optional]
**merchantReference** | **String** | Reference used by merchant to identify batch. | [optional]
**batchCaEndpoints** | **String** | | [optional]
**status** | **String** | Valid Values: * REJECTED * RECEIVED * VALIDATED * DECLINED * PROCESSING * COMPLETED | [optional]
**totals** | [**InlineResponse2005EmbeddedTotals**](InlineResponse2005EmbeddedTotals.md) | | [optional]
**billing** | [**InlineResponse2006Billing**](InlineResponse2006Billing.md) | | [optional]
**description** | **String** | | [optional]
**totalCount** | **Number** | Total number of results. | [optional]
**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=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: `offset=0` `offset=5` `offset=10` **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned. | [optional]
**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]
**sort** | **String** | A comma separated list of the following form: `terminalCreationDate:desc or serialNumber or terminalUpdationDate` | [optional]
**count** | **Number** | Results for this page, this could be below the limit. | [optional]
**devices** | [**[InlineResponse2006Devices]**](InlineResponse2006Devices.md) | A collection of devices | [optional]


19 changes: 19 additions & 0 deletions docs/InlineResponse2006Devices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# CyberSource.InlineResponse2006Devices

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**readerId** | **String** | | [optional]
**serialNumber** | **String** | | [optional]
**model** | **String** | | [optional]
**make** | **String** | | [optional]
**hardwareRevision** | **String** | | [optional]
**status** | **String** | Status of the device. Possible Values: - 'ACTIVE' - 'INACTIVE' | [optional]
**statusChangeReason** | **String** | Reason for change in status. | [optional]
**merchantId** | **String** | ID of the merchant to whom this device is assigned. | [optional]
**accountId** | **String** | ID of the account to whom the device assigned. | [optional]
**terminalCreationDate** | **Date** | Timestamp in which the device was created. | [optional]
**terminalUpdationDate** | **Date** | Timestamp in which the device was updated/modified. | [optional]
**paymentProcessorToTerminalMap** | [**InlineResponse2006PaymentProcessorToTerminalMap**](InlineResponse2006PaymentProcessorToTerminalMap.md) | | [optional]


9 changes: 9 additions & 0 deletions docs/InlineResponse2006PaymentProcessorToTerminalMap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CyberSource.InlineResponse2006PaymentProcessorToTerminalMap

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**processor** | **String** | | [optional]
**terminalId** | **String** | | [optional]


17 changes: 7 additions & 10 deletions docs/InlineResponse2007.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,12 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**version** | **String** | | [optional]
**reportCreatedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional]
**batchId** | **String** | Unique identification number assigned to the submitted request. | [optional]
**batchSource** | **String** | Valid Values: * SCHEDULER * TOKEN_API * CREDIT_CARD_FILE_UPLOAD * AMEX_REGSITRY * AMEX_REGISTRY_API * AMEX_MAINTENANCE | [optional]
**batchCaEndpoints** | **String** | | [optional]
**batchCreatedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional]
**merchantReference** | **String** | Reference used by merchant to identify batch. | [optional]
**totals** | [**InlineResponse2005EmbeddedTotals**](InlineResponse2005EmbeddedTotals.md) | | [optional]
**billing** | [**InlineResponse2006Billing**](InlineResponse2006Billing.md) | | [optional]
**records** | [**[InlineResponse2007Records]**](InlineResponse2007Records.md) | | [optional]
**links** | [**[InlineResponse2007Links]**](InlineResponse2007Links.md) | | [optional]
**_object** | **String** | | [optional]
**offset** | **Number** | | [optional]
**limit** | **Number** | | [optional]
**count** | **Number** | | [optional]
**total** | **Number** | | [optional]
**embedded** | [**InlineResponse2007Embedded**](InlineResponse2007Embedded.md) | | [optional]


8 changes: 8 additions & 0 deletions docs/InlineResponse2007Embedded.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# CyberSource.InlineResponse2007Embedded

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**batches** | [**[InlineResponse2007EmbeddedBatches]**](InlineResponse2007EmbeddedBatches.md) | | [optional]


Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# CyberSource.InlineResponse2005EmbeddedBatches
# CyberSource.InlineResponse2007EmbeddedBatches

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**InlineResponse2005EmbeddedLinks**](InlineResponse2005EmbeddedLinks.md) | | [optional]
**links** | [**InlineResponse2007EmbeddedLinks**](InlineResponse2007EmbeddedLinks.md) | | [optional]
**batchId** | **String** | Unique identification number assigned to the submitted request. | [optional]
**batchCreatedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional]
**batchModifiedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional]
Expand All @@ -12,6 +12,6 @@ Name | Type | Description | Notes
**merchantReference** | **String** | Reference used by merchant to identify batch. | [optional]
**batchCaEndpoints** | **[String]** | Valid Values: * VISA * MASTERCARD * AMEX | [optional]
**status** | **String** | Valid Values: * REJECTED * RECEIVED * VALIDATED * DECLINED * PROCESSING * COMPLETE | [optional]
**totals** | [**InlineResponse2005EmbeddedTotals**](InlineResponse2005EmbeddedTotals.md) | | [optional]
**totals** | [**InlineResponse2007EmbeddedTotals**](InlineResponse2007EmbeddedTotals.md) | | [optional]


8 changes: 8 additions & 0 deletions docs/InlineResponse2007EmbeddedLinks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# CyberSource.InlineResponse2007EmbeddedLinks

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**reports** | [**[InlineResponse2007EmbeddedLinksReports]**](InlineResponse2007EmbeddedLinksReports.md) | | [optional]


Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CyberSource.InlineResponse2005EmbeddedLinksReports
# CyberSource.InlineResponse2007EmbeddedLinksReports

## Properties
Name | Type | Description | Notes
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CyberSource.InlineResponse2005EmbeddedTotals
# CyberSource.InlineResponse2007EmbeddedTotals

## Properties
Name | Type | Description | Notes
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CyberSource.InlineResponse2005Links
# CyberSource.InlineResponse2007Links

## Properties
Name | Type | Description | Notes
Expand Down
10 changes: 0 additions & 10 deletions docs/InlineResponse2007Records.md

This file was deleted.

Loading