Skip to content

Commit 39a98a1

Browse files
committed
spec changes
1 parent d463a2a commit 39a98a1

File tree

187 files changed

+229967
-217802
lines changed

Some content is hidden

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

187 files changed

+229967
-217802
lines changed

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-
> InlineResponse2007 get_batch_report(batch_id)
14+
> InlineResponse2004 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-
[**InlineResponse2007**](InlineResponse2007.md)
47+
[**InlineResponse2004**](InlineResponse2004.md)
4848

4949
### Authorization
5050

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

5959

6060
# **get_batch_status**
61-
> InlineResponse2006 get_batch_status(batch_id)
61+
> InlineResponse2003 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-
[**InlineResponse2006**](InlineResponse2006.md)
94+
[**InlineResponse2003**](InlineResponse2003.md)
9595

9696
### Authorization
9797

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

106106

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

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

146146
### Return type
147147

148-
[**InlineResponse2005**](InlineResponse2005.md)
148+
[**InlineResponse2002**](InlineResponse2002.md)
149149

150150
### Authorization
151151

docs/CreateNewWebhooksApi.md

Lines changed: 2 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -4,112 +4,15 @@ All URIs are relative to *https://apitest.cybersource.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**create_webhook_subscription**](CreateNewWebhooksApi.md#create_webhook_subscription) | **POST** /notification-subscriptions/v1/webhooks | Create a Webhook
8-
[**find_products_to_subscribe**](CreateNewWebhooksApi.md#find_products_to_subscribe) | **GET** /notification-subscriptions/v1/products/{organizationId} | Find Products You Can Subscribe To
97
[**save_sym_egress_key**](CreateNewWebhooksApi.md#save_sym_egress_key) | **POST** /kms/egress/v2/keys-sym | Create Webhook Security Keys
108

119

12-
# **create_webhook_subscription**
13-
> InlineResponse2014 create_webhook_subscription(opts)
14-
15-
Create a Webhook
16-
17-
Create a new webhook subscription. Before creating a webhook, ensure that a security key has been created at the top of this developer center section. You will not need to pass us back the key during the creation of the webhook, but you will receive an error if you did not already create a key or store one on file.
18-
19-
### Example
20-
```ruby
21-
# load the gem
22-
require 'cybersource_rest_client'
23-
24-
api_instance = CyberSource::CreateNewWebhooksApi.new
25-
26-
opts = {
27-
create_webhook_request: CyberSource::CreateWebhookRequest.new # CreateWebhookRequest | The webhook payload
28-
}
29-
30-
begin
31-
#Create a Webhook
32-
result = api_instance.create_webhook_subscription(opts)
33-
p result
34-
rescue CyberSource::ApiError => e
35-
puts "Exception when calling CreateNewWebhooksApi->create_webhook_subscription: #{e}"
36-
end
37-
```
38-
39-
### Parameters
40-
41-
Name | Type | Description | Notes
42-
------------- | ------------- | ------------- | -------------
43-
**create_webhook_request** | [**CreateWebhookRequest**](CreateWebhookRequest.md)| The webhook payload | [optional]
44-
45-
### Return type
46-
47-
[**InlineResponse2014**](InlineResponse2014.md)
48-
49-
### Authorization
50-
51-
No authorization required
52-
53-
### HTTP request headers
54-
55-
- **Content-Type**: application/json;charset=utf-8
56-
- **Accept**: application/json;charset=utf-8
57-
58-
59-
60-
# **find_products_to_subscribe**
61-
> Array<InlineResponse2002> find_products_to_subscribe(organization_id)
62-
63-
Find Products You Can Subscribe To
64-
65-
Retrieve a list of products and event types that your account is eligible for. These products and events are the ones that you may subscribe to in the next step of creating webhooks.
66-
67-
### Example
68-
```ruby
69-
# load the gem
70-
require 'cybersource_rest_client'
71-
72-
api_instance = CyberSource::CreateNewWebhooksApi.new
73-
74-
organization_id = 'organization_id_example' # String | The Organization Identifier.
75-
76-
77-
begin
78-
#Find Products You Can Subscribe To
79-
result = api_instance.find_products_to_subscribe(organization_id)
80-
p result
81-
rescue CyberSource::ApiError => e
82-
puts "Exception when calling CreateNewWebhooksApi->find_products_to_subscribe: #{e}"
83-
end
84-
```
85-
86-
### Parameters
87-
88-
Name | Type | Description | Notes
89-
------------- | ------------- | ------------- | -------------
90-
**organization_id** | **String**| The Organization Identifier. |
91-
92-
### Return type
93-
94-
[**Array<InlineResponse2002>**](InlineResponse2002.md)
95-
96-
### Authorization
97-
98-
No authorization required
99-
100-
### HTTP request headers
101-
102-
- **Content-Type**: application/json;charset=utf-8
103-
- **Accept**: application/json;charset=utf-8
104-
105-
106-
10710
# **save_sym_egress_key**
10811
> InlineResponse2013 save_sym_egress_key(v_c_sender_organization_id, v_c_permissions, opts)
10912
11013
Create Webhook Security Keys
11114

112-
Create security keys that CyberSource will use internally to connect to your servers and validate messages using a digital signature. Select the CREATE example for CyberSource to generate the key on our server and maintain it for you as well. Remeber to save the key in the API response, so that you can use it to validate messages later.
15+
Create security keys that CyberSource will use internally to connect to your servers and validate messages using a digital signature. Select the CREATE example for CyberSource to generate the key on our server and maintain it for you as well. Remember to save the key in the API response, so that you can use it to validate messages later.
11316

11417
### Example
11518
```ruby
@@ -156,7 +59,7 @@ No authorization required
15659
### HTTP request headers
15760

15861
- **Content-Type**: application/json;charset=utf-8
159-
- **Accept**: application/json;charset=utf-8
62+
- **Accept**: application/hal+json;charset=utf-8
16063

16164

16265

docs/CreateWebhookRequest.md

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

docs/GenerateUnifiedCheckoutCaptureContextRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
**client_version** | **String** | Specify the version of Unified Checkout that you want to use. | [optional]
77
**target_origins** | **Array<String>** | 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<br><br> If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example: targetOrigins: [ \"https://example.com\", \"https://basket.example.com\", \"https://ecom.example.com\" ] | [optional]
88
**allowed_card_networks** | **Array<String>** | 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<String>** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY <br><br> **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's existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field. | [optional]
9+
**allowed_payment_types** | **Array<String>** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY <br><br> **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's existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.<br><br> **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]
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/InlineResponse2002.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**product_id** | **String** | Product ID. | [optional]
7-
**product_name** | **String** | Product Name. | [optional]
8-
**event_types** | [**Array<Notificationsubscriptionsv1productsorganizationIdEventTypes>**](Notificationsubscriptionsv1productsorganizationIdEventTypes.md) | | [optional]
6+
**_links** | [**Array<InlineResponse2002Links>**](InlineResponse2002Links.md) | | [optional]
7+
**object** | **String** | | [optional]
8+
**offset** | **Integer** | | [optional]
9+
**limit** | **Integer** | | [optional]
10+
**count** | **Integer** | | [optional]
11+
**total** | **Integer** | | [optional]
12+
**_embedded** | [**InlineResponse2002Embedded**](InlineResponse2002Embedded.md) | | [optional]
913

1014

docs/InlineResponse2002Embedded.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CyberSource::InlineResponse2002Embedded
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**batches** | [**Array<InlineResponse2002EmbeddedBatches>**](InlineResponse2002EmbeddedBatches.md) | | [optional]
7+
8+
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# CyberSource::InlineResponse2005EmbeddedBatches
1+
# CyberSource::InlineResponse2002EmbeddedBatches
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**_links** | [**InlineResponse2005EmbeddedLinks**](InlineResponse2005EmbeddedLinks.md) | | [optional]
6+
**_links** | [**InlineResponse2002EmbeddedLinks**](InlineResponse2002EmbeddedLinks.md) | | [optional]
77
**batch_id** | **String** | Unique identification number assigned to the submitted request. | [optional]
88
**batch_created_date** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional]
99
**batch_modified_date** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional]
@@ -12,6 +12,6 @@ Name | Type | Description | Notes
1212
**merchant_reference** | **String** | Reference used by merchant to identify batch. | [optional]
1313
**batch_ca_endpoints** | **Array<String>** | Valid Values: * VISA * MASTERCARD * AMEX | [optional]
1414
**status** | **String** | Valid Values: * REJECTED * RECEIVED * VALIDATED * DECLINED * PROCESSING * COMPLETE | [optional]
15-
**totals** | [**InlineResponse2005EmbeddedTotals**](InlineResponse2005EmbeddedTotals.md) | | [optional]
15+
**totals** | [**InlineResponse2002EmbeddedTotals**](InlineResponse2002EmbeddedTotals.md) | | [optional]
1616

1717

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CyberSource::InlineResponse2002EmbeddedLinks
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**reports** | [**Array<InlineResponse2002EmbeddedLinksReports>**](InlineResponse2002EmbeddedLinksReports.md) | | [optional]
7+
8+

docs/InlineResponse2005EmbeddedLinksReports.md renamed to docs/InlineResponse2002EmbeddedLinksReports.md

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

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

docs/InlineResponse2005EmbeddedTotals.md renamed to docs/InlineResponse2002EmbeddedTotals.md

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

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

0 commit comments

Comments
 (0)