Skip to content

spec update and changes to code files #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
12 changes: 6 additions & 6 deletions docs/BatchesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Method | HTTP request | Description


# **get_batch_report**
> InlineResponse2009 get_batch_report(batch_id)
> InlineResponse20010 get_batch_report(batch_id)

Retrieve a Batch Report

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

### Return type

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

### Authorization

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


# **get_batch_status**
> InlineResponse2008 get_batch_status(batch_id)
> InlineResponse2009 get_batch_status(batch_id)

Retrieve a Batch Status

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

### Return type

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

### Authorization

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


# **get_batches_list**
> InlineResponse2007 get_batches_list(opts)
> InlineResponse2008 get_batches_list(opts)

List Batches

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

### Return type

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

### Authorization

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

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


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

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

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


# **delete_terminal_association**
> delete_terminal_association(de_association_request_body)

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
```ruby
# load the gem
require 'cybersource_rest_client'

api_instance = CyberSource::DeviceDeAssociationApi.new

de_association_request_body = CyberSource::DeAssociationRequestBody.new # DeAssociationRequestBody | de association of the deviceId in the request body.


begin
#De-associate a device from merchant or account V2
api_instance.delete_terminal_association(de_association_request_body)
rescue CyberSource::ApiError => e
puts "Exception when calling DeviceDeAssociationApi->delete_terminal_association: #{e}"
end
```

### Parameters

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

### Return type

nil (empty response body)

### Authorization

No authorization required

### HTTP request headers

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



# **post_de_associate_v3_terminal**
> Array<InlineResponse2006> post_de_associate_v3_terminal(device_de_associate_v3_request)

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'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
```ruby
# load the gem
require 'cybersource_rest_client'

api_instance = CyberSource::DeviceDeAssociationApi.new

device_de_associate_v3_request = [CyberSource::DeviceDeAssociateV3Request.new] # Array<DeviceDeAssociateV3Request> | deviceId that has to be de-associated to the destination organizationId.


begin
#De-associate a device from merchant to account or reseller and from account to reseller
result = api_instance.post_de_associate_v3_terminal(device_de_associate_v3_request)
p result
rescue CyberSource::ApiError => e
puts "Exception when calling DeviceDeAssociationApi->post_de_associate_v3_terminal: #{e}"
end
```

### Parameters

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

### Return type

[**Array&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



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

This file was deleted.

58 changes: 53 additions & 5 deletions docs/DeviceSearchApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,61 @@ All URIs are relative to *https://apitest.cybersource.com*

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


# **post_search_query**
> InlineResponse2005 post_search_query(post_device_search_request)

Retrieve List of Devices for a given search query V2

Retrieves list of terminals in paginated format.

### Example
```ruby
# load the gem
require 'cybersource_rest_client'

api_instance = CyberSource::DeviceSearchApi.new

post_device_search_request = CyberSource::PostDeviceSearchRequest.new # PostDeviceSearchRequest |


begin
#Retrieve List of Devices for a given search query V2
result = api_instance.post_search_query(post_device_search_request)
p result
rescue CyberSource::ApiError => e
puts "Exception when calling DeviceSearchApi->post_search_query: #{e}"
end
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**post_device_search_request** | [**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



# **post_search_query_v3**
> InlineResponse2006 post_search_query_v3(post_device_search_request_v3)
> InlineResponse2007 post_search_query_v3(post_device_search_request_v3)

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 +73,7 @@ post_device_search_request_v3 = CyberSource::PostDeviceSearchRequestV3.new # Pos


begin
#Retrieve List of Devices for a given search query V3
#Retrieve List of Devices for a given search query
result = api_instance.post_search_query_v3(post_device_search_request_v3)
p result
rescue CyberSource::ApiError => e
Expand All @@ -41,7 +89,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 @@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**client_version** | **String** | Specify the version of Microform that you want to use. | [optional]
**target_origins** | **Array&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]
**allowed_card_networks** | **Array&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]
**allowed_card_networks** | **Array&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]
**allowed_payment_types** | **Array&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]
**transient_token_response_options** | [**Microformv2sessionsTransientTokenResponseOptions**](Microformv2sessionsTransientTokenResponseOptions.md) | | [optional]

Expand Down
4 changes: 2 additions & 2 deletions docs/GenerateUnifiedCheckoutCaptureContextRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**client_version** | **String** | Specify the version of Unified Checkout that you want to use. | [optional]
**target_origins** | **Array&lt;String&gt;** | The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Unified Checkout 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; ] | [optional]
**allowed_card_networks** | **Array&lt;String&gt;** | The list of card networks you want to use for this Unified Checkout transaction. Unified Checkout currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA | [optional]
**allowed_payment_types** | **Array&lt;String&gt;** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE &lt;br&gt;&lt;br&gt; Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY &lt;br&gt;&lt;br&gt; **Important:** - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards. - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant&#39;s existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.&lt;br&gt;&lt;br&gt; **Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay. | [optional]
**allowed_card_networks** | **Array&lt;String&gt;** | The list of card networks you want to use for this Unified Checkout transaction. Unified Checkout currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA - PAYPAK | [optional]
**allowed_payment_types** | **Array&lt;String&gt;** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE &lt;br&gt;&lt;br&gt; Unified Checkout also supports the following Alternative Payments: - AFTERPAY&lt;br&gt;&lt;br&gt; Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY &lt;br&gt;&lt;br&gt; **Important:** - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards. - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant&#39;s existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.&lt;br&gt;&lt;br&gt; **Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.&lt;br&gt;&lt;br&gt; **Managing Google Pay Authentication Types** Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \&quot;true\&quot;. This is only available where the merchant and cardholder are based in the following countries and the billing type is set to \&quot;FULL\&quot; or \&quot;PARTIAL\&quot;. - UAE - Argentina - Brazil - Chile - Colombia - Kuwait - Mexico - Peru - Qatar - Saudi Arabia - Ukraine - South Africa&lt;br&gt;&lt;br&gt; If false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry. | [optional]
**country** | **String** | Country the purchase is originating from (e.g. country of the merchant). Use the two-character ISO Standard | [optional]
**locale** | **String** | Localization of the User experience conforming to the ISO 639-1 language standards and two-character ISO Standard Country Code. Please refer to list of [supported locales through Unified Checkout](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-appendix-languages.html) | [optional]
**capture_mandate** | [**Upv1capturecontextsCaptureMandate**](Upv1capturecontextsCaptureMandate.md) | | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/GetSubscriptionResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ Name | Type | Description | Notes
**subscription_information** | [**GetAllSubscriptionsResponseSubscriptionInformation**](GetAllSubscriptionsResponseSubscriptionInformation.md) | | [optional]
**payment_information** | [**GetAllSubscriptionsResponsePaymentInformation**](GetAllSubscriptionsResponsePaymentInformation.md) | | [optional]
**order_information** | [**GetAllSubscriptionsResponseOrderInformation**](GetAllSubscriptionsResponseOrderInformation.md) | | [optional]
**reactivation_information** | [**GetSubscriptionResponseReactivationInformation**](GetSubscriptionResponseReactivationInformation.md) | | [optional]


Loading