Skip to content

Commit a0bb120

Browse files
gaubansagaubansa
authored
Merge pull request #133 from CyberSource/june-2025-release
spec update and changes to code files
2 parents a5f0341 + 2332bff commit a0bb120

File tree

142 files changed

+6439
-1177
lines changed

Some content is hidden

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

142 files changed

+6439
-1177
lines changed

‎cybersource_rest_client.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ require "cybersource_rest_client/version"
1717

1818
Gem::Specification.new do |s|
1919
s.name = "cybersource_rest_client"
20-
s.version = "0.0.73"
20+
s.version = "0.0.74"
2121
s.platform = Gem::Platform::RUBY
2222
s.authors = ["CyberSource"]
2323
s.email = ["cybersourcedev@gmail.com"]

‎docs/BatchesApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Method | HTTP request | Description
1111

1212

1313
# **get_batch_report**
14-
> InlineResponse2009 get_batch_report(batch_id)
14+
> InlineResponse20010 get_batch_report(batch_id)
1515
1616
Retrieve a Batch Report
1717

@@ -44,7 +44,7 @@ Name | Type | Description | Notes
4444

4545
### Return type
4646

47-
[**InlineResponse2009**](InlineResponse2009.md)
47+
[**InlineResponse20010**](InlineResponse20010.md)
4848

4949
### Authorization
5050

@@ -58,7 +58,7 @@ No authorization required
5858

5959

6060
# **get_batch_status**
61-
> InlineResponse2008 get_batch_status(batch_id)
61+
> InlineResponse2009 get_batch_status(batch_id)
6262
6363
Retrieve a Batch Status
6464

@@ -91,7 +91,7 @@ Name | Type | Description | Notes
9191

9292
### Return type
9393

94-
[**InlineResponse2008**](InlineResponse2008.md)
94+
[**InlineResponse2009**](InlineResponse2009.md)
9595

9696
### Authorization
9797

@@ -105,7 +105,7 @@ No authorization required
105105

106106

107107
# **get_batches_list**
108-
> InlineResponse2007 get_batches_list(opts)
108+
> InlineResponse2008 get_batches_list(opts)
109109
110110
List Batches
111111

@@ -145,7 +145,7 @@ Name | Type | Description | Notes
145145

146146
### Return type
147147

148-
[**InlineResponse2007**](InlineResponse2007.md)
148+
[**InlineResponse2008**](InlineResponse2008.md)
149149

150150
### Authorization
151151

‎docs/DeAssociationRequestBody.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CyberSource::DeAssociationRequestBody
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**device_id** | **String** | UUID of the device which needs to be de-associated | [optional]
7+
8+

‎docs/DeviceDeAssociationApi.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# CyberSource::DeviceDeAssociationApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**delete_terminal_association**](DeviceDeAssociationApi.md#delete_terminal_association) | **PATCH** /dms/v2/devices/deassociate | De-associate a device from merchant or account V2
8+
[**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
9+
10+
11+
# **delete_terminal_association**
12+
> delete_terminal_association(de_association_request_body)
13+
14+
De-associate a device from merchant or account V2
15+
16+
The current association of the device will be removed and will be assigned back to parent in the hierarchy based on internal logic
17+
18+
### Example
19+
```ruby
20+
# load the gem
21+
require 'cybersource_rest_client'
22+
23+
api_instance = CyberSource::DeviceDeAssociationApi.new
24+
25+
de_association_request_body = CyberSource::DeAssociationRequestBody.new # DeAssociationRequestBody | de association of the deviceId in the request body.
26+
27+
28+
begin
29+
#De-associate a device from merchant or account V2
30+
api_instance.delete_terminal_association(de_association_request_body)
31+
rescue CyberSource::ApiError => e
32+
puts "Exception when calling DeviceDeAssociationApi->delete_terminal_association: #{e}"
33+
end
34+
```
35+
36+
### Parameters
37+
38+
Name | Type | Description | Notes
39+
------------- | ------------- | ------------- | -------------
40+
**de_association_request_body** | [**DeAssociationRequestBody**](DeAssociationRequestBody.md)| de association of the deviceId in the request body. |
41+
42+
### Return type
43+
44+
nil (empty response body)
45+
46+
### Authorization
47+
48+
No authorization required
49+
50+
### HTTP request headers
51+
52+
- **Content-Type**: application/json;charset=UTF-8
53+
- **Accept**: application/hal+json;charset=utf-8
54+
55+
56+
57+
# **post_de_associate_v3_terminal**
58+
> Array<InlineResponse2006> post_de_associate_v3_terminal(device_de_associate_v3_request)
59+
60+
De-associate a device from merchant to account or reseller and from account to reseller
61+
62+
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.
63+
64+
### Example
65+
```ruby
66+
# load the gem
67+
require 'cybersource_rest_client'
68+
69+
api_instance = CyberSource::DeviceDeAssociationApi.new
70+
71+
device_de_associate_v3_request = [CyberSource::DeviceDeAssociateV3Request.new] # Array<DeviceDeAssociateV3Request> | deviceId that has to be de-associated to the destination organizationId.
72+
73+
74+
begin
75+
#De-associate a device from merchant to account or reseller and from account to reseller
76+
result = api_instance.post_de_associate_v3_terminal(device_de_associate_v3_request)
77+
p result
78+
rescue CyberSource::ApiError => e
79+
puts "Exception when calling DeviceDeAssociationApi->post_de_associate_v3_terminal: #{e}"
80+
end
81+
```
82+
83+
### Parameters
84+
85+
Name | Type | Description | Notes
86+
------------- | ------------- | ------------- | -------------
87+
**device_de_associate_v3_request** | [**Array&lt;DeviceDeAssociateV3Request&gt;**](DeviceDeAssociateV3Request.md)| deviceId that has to be de-associated to the destination organizationId. |
88+
89+
### Return type
90+
91+
[**Array&lt;InlineResponse2006&gt;**](InlineResponse2006.md)
92+
93+
### Authorization
94+
95+
No authorization required
96+
97+
### HTTP request headers
98+
99+
- **Content-Type**: application/json;charset=UTF-8
100+
- **Accept**: application/json;charset=UTF-8
101+
102+
103+

‎docs/DeviceDeAssociationV3Api.md

Lines changed: 0 additions & 56 deletions
This file was deleted.

‎docs/DeviceSearchApi.md

Lines changed: 53 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,61 @@ All URIs are relative to *https://apitest.cybersource.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**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
7+
[**post_search_query**](DeviceSearchApi.md#post_search_query) | **POST** /dms/v2/devices/search | Retrieve List of Devices for a given search query V2
8+
[**post_search_query_v3**](DeviceSearchApi.md#post_search_query_v3) | **POST** /dms/v3/devices/search | Retrieve List of Devices for a given search query
9+
10+
11+
# **post_search_query**
12+
> InlineResponse2005 post_search_query(post_device_search_request)
13+
14+
Retrieve List of Devices for a given search query V2
15+
16+
Retrieves list of terminals in paginated format.
17+
18+
### Example
19+
```ruby
20+
# load the gem
21+
require 'cybersource_rest_client'
22+
23+
api_instance = CyberSource::DeviceSearchApi.new
24+
25+
post_device_search_request = CyberSource::PostDeviceSearchRequest.new # PostDeviceSearchRequest |
26+
27+
28+
begin
29+
#Retrieve List of Devices for a given search query V2
30+
result = api_instance.post_search_query(post_device_search_request)
31+
p result
32+
rescue CyberSource::ApiError => e
33+
puts "Exception when calling DeviceSearchApi->post_search_query: #{e}"
34+
end
35+
```
36+
37+
### Parameters
38+
39+
Name | Type | Description | Notes
40+
------------- | ------------- | ------------- | -------------
41+
**post_device_search_request** | [**PostDeviceSearchRequest**](PostDeviceSearchRequest.md)| |
42+
43+
### Return type
44+
45+
[**InlineResponse2005**](InlineResponse2005.md)
46+
47+
### Authorization
48+
49+
No authorization required
50+
51+
### HTTP request headers
52+
53+
- **Content-Type**: application/json;charset=UTF-8
54+
- **Accept**: application/json;charset=UTF-8
55+
856

957

1058
# **post_search_query_v3**
11-
> InlineResponse2006 post_search_query_v3(post_device_search_request_v3)
59+
> InlineResponse2007 post_search_query_v3(post_device_search_request_v3)
1260
13-
Retrieve List of Devices for a given search query V3
61+
Retrieve List of Devices for a given search query
1462

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

@@ -25,7 +73,7 @@ post_device_search_request_v3 = CyberSource::PostDeviceSearchRequestV3.new # Pos
2573

2674

2775
begin
28-
#Retrieve List of Devices for a given search query V3
76+
#Retrieve List of Devices for a given search query
2977
result = api_instance.post_search_query_v3(post_device_search_request_v3)
3078
p result
3179
rescue CyberSource::ApiError => e
@@ -41,7 +89,7 @@ Name | Type | Description | Notes
4189

4290
### Return type
4391

44-
[**InlineResponse2006**](InlineResponse2006.md)
92+
[**InlineResponse2007**](InlineResponse2007.md)
4593

4694
### Authorization
4795

‎docs/GenerateCaptureContextRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**client_version** | **String** | Specify the version of Microform that you want to use. | [optional]
77
**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]
8-
**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]
8+
**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]
99
**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]
1010
**transient_token_response_options** | [**Microformv2sessionsTransientTokenResponseOptions**](Microformv2sessionsTransientTokenResponseOptions.md) | | [optional]
1111

‎docs/GenerateUnifiedCheckoutCaptureContextRequest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**client_version** | **String** | Specify the version of Unified Checkout that you want to use. | [optional]
77
**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]
8-
**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]
9-
**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]
8+
**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]
9+
**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]
1010
**country** | **String** | Country the purchase is originating from (e.g. country of the merchant). Use the two-character ISO Standard | [optional]
1111
**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]
1212
**capture_mandate** | [**Upv1capturecontextsCaptureMandate**](Upv1capturecontextsCaptureMandate.md) | | [optional]

‎docs/GetSubscriptionResponse.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@ Name | Type | Description | Notes
1010
**subscription_information** | [**GetAllSubscriptionsResponseSubscriptionInformation**](GetAllSubscriptionsResponseSubscriptionInformation.md) | | [optional]
1111
**payment_information** | [**GetAllSubscriptionsResponsePaymentInformation**](GetAllSubscriptionsResponsePaymentInformation.md) | | [optional]
1212
**order_information** | [**GetAllSubscriptionsResponseOrderInformation**](GetAllSubscriptionsResponseOrderInformation.md) | | [optional]
13+
**reactivation_information** | [**GetSubscriptionResponseReactivationInformation**](GetSubscriptionResponseReactivationInformation.md) | | [optional]
1314

1415

0 commit comments

Comments
 (0)