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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 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**
> InlineResponse2009 getBatchReport(batchId)
> InlineResponse20010 getBatchReport(batchId)

Retrieve a Batch Report

Expand All @@ -28,7 +28,7 @@ Retrieve a Batch Report
BatchesApi apiInstance = new BatchesApi();
String batchId = "batchId_example"; // String | Unique identification number assigned to the submitted request.
try {
InlineResponse2009 result = apiInstance.getBatchReport(batchId);
InlineResponse20010 result = apiInstance.getBatchReport(batchId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BatchesApi#getBatchReport");
Expand All @@ -44,7 +44,7 @@ Name | Type | Description | Notes

### Return type

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

### Authorization

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

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

Retrieve a Batch Status

Expand All @@ -73,7 +73,7 @@ Retrieve a Batch Status
BatchesApi apiInstance = new BatchesApi();
String batchId = "batchId_example"; // String | Unique identification number assigned to the submitted request.
try {
InlineResponse2008 result = apiInstance.getBatchStatus(batchId);
InlineResponse2009 result = apiInstance.getBatchStatus(batchId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BatchesApi#getBatchStatus");
Expand All @@ -89,7 +89,7 @@ Name | Type | Description | Notes

### Return type

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

### Authorization

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

<a name="getBatchesList"></a>
# **getBatchesList**
> InlineResponse2007 getBatchesList(offset, limit, fromDate, toDate)
> InlineResponse2008 getBatchesList(offset, limit, fromDate, toDate)

List Batches

Expand All @@ -121,7 +121,7 @@ Long limit = 20L; // Long | The maximum number that can be returned in the array
String fromDate = "fromDate_example"; // String | ISO-8601 format: yyyyMMddTHHmmssZ
String toDate = "toDate_example"; // String | ISO-8601 format: yyyyMMddTHHmmssZ
try {
InlineResponse2007 result = apiInstance.getBatchesList(offset, limit, fromDate, toDate);
InlineResponse2008 result = apiInstance.getBatchesList(offset, limit, fromDate, toDate);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BatchesApi#getBatchesList");
Expand All @@ -140,7 +140,7 @@ Name | Type | Description | Notes

### Return type

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

### Authorization

Expand Down
10 changes: 10 additions & 0 deletions docs/DeAssociationRequestBody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

# DeAssociationRequestBody

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deviceId** | **String** | UUID of the device which needs to be de-associated | [optional]



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

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

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


<a name="deleteTerminalAssociation"></a>
# **deleteTerminalAssociation**
> deleteTerminalAssociation(deAssociationRequestBody)

De-associate a device from merchant or account V2

The current association of the device will be removed and will be assigned back to parent in the hierarchy based on internal logic

### Example
```java
// Import classes:
//import Invokers.ApiException;
//import Api.DeviceDeAssociationApi;


DeviceDeAssociationApi apiInstance = new DeviceDeAssociationApi();
DeAssociationRequestBody deAssociationRequestBody = new DeAssociationRequestBody(); // DeAssociationRequestBody | de association of the deviceId in the request body.
try {
apiInstance.deleteTerminalAssociation(deAssociationRequestBody);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceDeAssociationApi#deleteTerminalAssociation");
e.printStackTrace();
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**deAssociationRequestBody** | [**DeAssociationRequestBody**](DeAssociationRequestBody.md)| de association of the deviceId in the request body. |

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="postDeAssociateV3Terminal"></a>
# **postDeAssociateV3Terminal**
> List&lt;InlineResponse2006&gt; postDeAssociateV3Terminal(deviceDeAssociateV3Request)

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

A device will be de-associated from its current organization and moved up in the hierarchy. The device&#39;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
```java
// Import classes:
//import Invokers.ApiException;
//import Api.DeviceDeAssociationApi;


DeviceDeAssociationApi apiInstance = new DeviceDeAssociationApi();
List<DeviceDeAssociateV3Request> deviceDeAssociateV3Request = Arrays.asList(new DeviceDeAssociateV3Request()); // List<DeviceDeAssociateV3Request> | deviceId that has to be de-associated to the destination organizationId.
try {
List<InlineResponse2006> result = apiInstance.postDeAssociateV3Terminal(deviceDeAssociateV3Request);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceDeAssociationApi#postDeAssociateV3Terminal");
e.printStackTrace();
}
```

### Parameters

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

### Return type

[**List&lt;InlineResponse2006&gt;**](InlineResponse2006.md)

### Authorization

No authorization required

### HTTP request headers

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

54 changes: 0 additions & 54 deletions docs/DeviceDeAssociationV3Api.md

This file was deleted.

56 changes: 51 additions & 5 deletions docs/DeviceSearchApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,60 @@ 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
[**postSearchQuery**](DeviceSearchApi.md#postSearchQuery) | **POST** /dms/v2/devices/search | Retrieve List of Devices for a given search query V2
[**postSearchQueryV3**](DeviceSearchApi.md#postSearchQueryV3) | **POST** /dms/v3/devices/search | Retrieve List of Devices for a given search query


<a name="postSearchQuery"></a>
# **postSearchQuery**
> InlineResponse2005 postSearchQuery(postDeviceSearchRequest)

Retrieve List of Devices for a given search query V2

Retrieves list of terminals in paginated format.

### Example
```java
// Import classes:
//import Invokers.ApiException;
//import Api.DeviceSearchApi;


DeviceSearchApi apiInstance = new DeviceSearchApi();
PostDeviceSearchRequest postDeviceSearchRequest = new PostDeviceSearchRequest(); // PostDeviceSearchRequest |
try {
InlineResponse2005 result = apiInstance.postSearchQuery(postDeviceSearchRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSearchApi#postSearchQuery");
e.printStackTrace();
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**postDeviceSearchRequest** | [**PostDeviceSearchRequest**](PostDeviceSearchRequest.md)| |

### 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

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

Retrieve List of Devices for a given search query V3
Retrieve List of Devices for a given search query

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

Expand All @@ -25,7 +71,7 @@ Search for devices matching a given search query. The search query supports ser
DeviceSearchApi apiInstance = new DeviceSearchApi();
PostDeviceSearchRequestV3 postDeviceSearchRequestV3 = new PostDeviceSearchRequestV3(); // PostDeviceSearchRequestV3 |
try {
InlineResponse2006 result = apiInstance.postSearchQueryV3(postDeviceSearchRequestV3);
InlineResponse2007 result = apiInstance.postSearchQueryV3(postDeviceSearchRequestV3);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSearchApi#postSearchQueryV3");
Expand All @@ -41,7 +87,7 @@ Name | Type | Description | Notes

### Return type

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

### Authorization

Expand Down
2 changes: 1 addition & 1 deletion docs/GenerateCaptureContextRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**clientVersion** | **String** | Specify the version of Microform that you want to use. | [optional]
**targetOrigins** | **List&lt;String&gt;** | The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Microform is defined by the scheme (protocol), hostname (domain) and port number (if used). You must use https://hostname (unless you use http://localhost) Wildcards are NOT supported. Ensure that subdomains are included. Any valid top-level domain is supported (e.g. .com, .co.uk, .gov.br etc) Examples: - https://example.com - https://subdomain.example.com - https://example.com:8080&lt;br&gt;&lt;br&gt; If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example: targetOrigins: [ \&quot;https://example.com\&quot;, \&quot;https://basket.example.com\&quot;, \&quot;https://ecom.example.com\&quot; ]&lt;br&gt;&lt;br&gt; You can supply up to nine origins within the targetOrigins field for nested iframes. If the list of origins exceeds five ensure that you: - Compare the list of origins in the v2/sessions targetOrigins field against the location.ancestorOrigins of the browser. - Ensure that the count of origins and their content matches in both. If any origins are absent or mismatched, the system will prevent Microform from loading and display a client-side error message. | [optional]
**allowedCardNetworks** | **List&lt;String&gt;** | The list of card networks you want to use for this Microform transaction. Microform currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA **Important:** - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request. | [optional]
**allowedCardNetworks** | **List&lt;String&gt;** | The list of card networks you want to use for this Microform transaction. Microform currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA - PAYPAK **Important:** - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request. | [optional]
**allowedPaymentTypes** | **List&lt;String&gt;** | The payment types that are allowed for the merchant. Possible values when launching Microform: - CARD - CHECK &lt;br&gt;&lt;br&gt; | [optional]
**transientTokenResponseOptions** | [**Microformv2sessionsTransientTokenResponseOptions**](Microformv2sessionsTransientTokenResponseOptions.md) | | [optional]

Expand Down
Loading