Skip to content

Commit 0e4cf54

Browse files
gaubansagaubansa
authored
Merge pull request #124 from CyberSource/release/april25
Release april25
2 parents 52fcc18 + dee121b commit 0e4cf54

File tree

465 files changed

+51782
-12367
lines changed

Some content is hidden

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

465 files changed

+51782
-12367
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.71"
20+
s.version = "0.0.72"
2121
s.platform = Gem::Platform::RUBY
2222
s.authors = ["CyberSource"]
2323
s.email = ["cybersourcedev@gmail.com"]

‎docs/BatchesApi.md

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

1212

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

4949
### Authorization
5050

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

5959

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

9696
### Authorization
9797

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

106106

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

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

146146
### Return type
147147

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

150150
### Authorization
151151

@@ -163,7 +163,7 @@ No authorization required
163163
164164
Create a Batch
165165

166-
**Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier. <br> The card numbers for the supplied tokens ids are then sent to the relevant card associations to check for updates.<br>The following type of batches can be submitted: - **oneOff** batch containing tokens id for Visa or MasterCard card numbers. - **amexRegistration** batch containing tokens id for Amex card numbers. A batch id will be returned on a successful response which can be used to get the batch status and the batch report.
166+
**Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier. <br> The card numbers for the supplied tokens ids are then sent to the relevant card associations to check for updates.<br>The following type of batches can be submitted: - **oneOff** batch containing tokens id for Visa or MasterCard card numbers. - **amexRegistration** batch containing tokens id for Amex card numbers. A batch id will be returned on a successful response which can be used to get the batch status and the batch report. The availability of API features for a merchant may depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.
167167

168168
### Example
169169
```ruby

‎docs/CreateInvoiceRequest.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6+
**client_reference_information** | [**Invoicingv2invoicesClientReferenceInformation**](Invoicingv2invoicesClientReferenceInformation.md) | | [optional]
67
**customer_information** | [**Invoicingv2invoicesCustomerInformation**](Invoicingv2invoicesCustomerInformation.md) | | [optional]
7-
**invoice_information** | [**Invoicingv2invoicesInvoiceInformation**](Invoicingv2invoicesInvoiceInformation.md) | | [optional]
8-
**order_information** | [**Invoicingv2invoicesOrderInformation**](Invoicingv2invoicesOrderInformation.md) | | [optional]
8+
**processing_information** | [**Invoicingv2invoicesProcessingInformation**](Invoicingv2invoicesProcessingInformation.md) | | [optional]
9+
**invoice_information** | [**Invoicingv2invoicesInvoiceInformation**](Invoicingv2invoicesInvoiceInformation.md) | |
10+
**order_information** | [**Invoicingv2invoicesOrderInformation**](Invoicingv2invoicesOrderInformation.md) | |
911

1012

‎docs/CreateNewWebhooksApi.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,106 @@ All URIs are relative to *https://apitest.cybersource.com*
44

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

911

12+
# **find_products_to_subscribe**
13+
> Array&lt;InlineResponse2003&gt; find_products_to_subscribe(organization_id)
14+
15+
Find Products You Can Subscribe To
16+
17+
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.
18+
19+
### Example
20+
```ruby
21+
# load the gem
22+
require 'cybersource_rest_client'
23+
24+
api_instance = CyberSource::CreateNewWebhooksApi.new
25+
26+
organization_id = 'organization_id_example' # String | The Organization Identifier.
27+
28+
29+
begin
30+
#Find Products You Can Subscribe To
31+
result = api_instance.find_products_to_subscribe(organization_id)
32+
p result
33+
rescue CyberSource::ApiError => e
34+
puts "Exception when calling CreateNewWebhooksApi->find_products_to_subscribe: #{e}"
35+
end
36+
```
37+
38+
### Parameters
39+
40+
Name | Type | Description | Notes
41+
------------- | ------------- | ------------- | -------------
42+
**organization_id** | **String**| The Organization Identifier. |
43+
44+
### Return type
45+
46+
[**Array&lt;InlineResponse2003&gt;**](InlineResponse2003.md)
47+
48+
### Authorization
49+
50+
No authorization required
51+
52+
### HTTP request headers
53+
54+
- **Content-Type**: application/json;charset=utf-8
55+
- **Accept**: application/hal+json;charset=utf-8
56+
57+
58+
59+
# **notification_subscriptions_v2_webhooks_post**
60+
> InlineResponse2014 notification_subscriptions_v2_webhooks_post(opts)
61+
62+
Create a New Webhook Subscription
63+
64+
Create a new webhook subscription. Before creating a webhook, ensure that a signature key has been created. For the example \"Create Webhook using oAuth with Client Credentials\" - for clients who have more than one oAuth Provider and have different client secrets that they would like to config for a given webhook, they may do so by overriding the keyId inside security config of webhook subscription. See the Developer Center examples section titled \"Webhook Security - Create or Store Egress Symmetric Key - Store oAuth Credentials For Symmetric Key\" to store these oAuth credentials that CYBS will need for oAuth. For JWT authentication, attach your oAuth details to the webhook subscription. See the example \"Create Webhook using oAuth with JWT\"
65+
66+
### Example
67+
```ruby
68+
# load the gem
69+
require 'cybersource_rest_client'
70+
71+
api_instance = CyberSource::CreateNewWebhooksApi.new
72+
73+
opts = {
74+
create_webhook: CyberSource::CreateWebhook.new # CreateWebhook | The webhook payload
75+
}
76+
77+
begin
78+
#Create a New Webhook Subscription
79+
result = api_instance.notification_subscriptions_v2_webhooks_post(opts)
80+
p result
81+
rescue CyberSource::ApiError => e
82+
puts "Exception when calling CreateNewWebhooksApi->notification_subscriptions_v2_webhooks_post: #{e}"
83+
end
84+
```
85+
86+
### Parameters
87+
88+
Name | Type | Description | Notes
89+
------------- | ------------- | ------------- | -------------
90+
**create_webhook** | [**CreateWebhook**](CreateWebhook.md)| The webhook payload | [optional]
91+
92+
### Return type
93+
94+
[**InlineResponse2014**](InlineResponse2014.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/hal+json;charset=utf-8
104+
105+
106+
10107
# **save_sym_egress_key**
11108
> InlineResponse2013 save_sym_egress_key(v_c_sender_organization_id, v_c_permissions, opts)
12109

‎docs/CreatePaymentLinkRequest.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CyberSource::CreatePaymentLinkRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**client_reference_information** | [**Invoicingv2invoicesClientReferenceInformation**](Invoicingv2invoicesClientReferenceInformation.md) | | [optional]
7+
**processing_information** | [**Iplv2paymentlinksProcessingInformation**](Iplv2paymentlinksProcessingInformation.md) | |
8+
**purchase_information** | [**Iplv2paymentlinksPurchaseInformation**](Iplv2paymentlinksPurchaseInformation.md) | |
9+
**order_information** | [**Iplv2paymentlinksOrderInformation**](Iplv2paymentlinksOrderInformation.md) | |
10+
11+

‎docs/CreateSubscriptionRequest1.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# CyberSource::CreateSubscriptionRequest1
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**client_reference_information** | [**Rbsv1subscriptionsClientReferenceInformation**](Rbsv1subscriptionsClientReferenceInformation.md) | | [optional]
7+
**processing_information** | [**Rbsv1subscriptionsProcessingInformation**](Rbsv1subscriptionsProcessingInformation.md) | | [optional]
8+
**plan_information** | [**Rbsv1subscriptionsPlanInformation**](Rbsv1subscriptionsPlanInformation.md) | | [optional]
9+
**subscription_information** | [**Rbsv1subscriptionsSubscriptionInformation**](Rbsv1subscriptionsSubscriptionInformation.md) | | [optional]
10+
**order_information** | [**GetAllPlansResponseOrderInformation**](GetAllPlansResponseOrderInformation.md) | | [optional]
11+
12+

‎docs/CreateWebhook.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# CyberSource::CreateWebhook
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **String** | Client friendly webhook name. | [optional]
7+
**description** | **String** | Client friendly webhook description. | [optional]
8+
**organization_id** | **String** | Organization Identifier (OrgId) or Merchant Identifier (MID). | [optional]
9+
**products** | [**Array&lt;Notificationsubscriptionsv2webhooksProducts1&gt;**](Notificationsubscriptionsv2webhooksProducts1.md) | To see the valid productId and eventTypes, call the \&quot;Create and Manage Webhooks - Retrieve a list of event types\&quot; endpoint. | [optional]
10+
**webhook_url** | **String** | The client&#39;s endpoint (URL) to receive webhooks. | [optional]
11+
**health_check_url** | **String** | The client&#39;s health check endpoint (URL). This should be as close as possible to the actual webhookUrl. If the user does not provide the health check URL, it is the user&#39;s responsibility to re-activate the webhook if it is deactivated by calling the test endpoint. | [optional]
12+
**retry_policy** | [**Notificationsubscriptionsv2webhooksRetryPolicy**](Notificationsubscriptionsv2webhooksRetryPolicy.md) | | [optional]
13+
**security_policy** | [**Notificationsubscriptionsv2webhooksSecurityPolicy1**](Notificationsubscriptionsv2webhooksSecurityPolicy1.md) | | [optional]
14+
15+

‎docs/CustomerApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ No authorization required
172172
173173
Create a Customer
174174

175-
| | | | | --- | --- | --- | |**Customers**<br>A Customer represents your tokenized customer information.<br>You should associate the Customer Id with the customer account on your systems.<br>A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.<br><br>**Creating a Customer**<br>It is recommended you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), this can be for a zero amount.<br>The Customer will be created with a Payment Instrument and Shipping Address.<br>You can also [add additional Payment Instruments to a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).<br>In Europe: You should perform Payer Authentication alongside the Authorization.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Customers**<br>To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body).<br>To perform a payment with a particular Payment Instrument or Shipping Address <br>specify the [Payment Instrument or Shipping Address Ids in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).
175+
| | | | | --- | --- | --- | |**Customers**<br>A Customer represents your tokenized customer information.<br>You should associate the Customer Id with the customer account on your systems.<br>A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.<br><br>**Creating a Customer**<br>It is recommended you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), this can be for a zero amount.<br>The Customer will be created with a Payment Instrument and Shipping Address.<br>You can also [add additional Payment Instruments to a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).<br>In Europe: You should perform Payer Authentication alongside the Authorization.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Customers**<br>To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body).<br>To perform a payment with a particular Payment Instrument or Shipping Address <br>specify the [Payment Instrument or Shipping Address Ids in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body). The availability of API features for a merchant may depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.
176176

177177
### Example
178178
```ruby

‎docs/DecisionManagerApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Method | HTTP request | Description
1212

1313

1414
# **action_decision_manager_case**
15-
> InlineResponse200 action_decision_manager_case(id, case_management_actions_request)
15+
> InlineResponse2001 action_decision_manager_case(id, case_management_actions_request)
1616
1717
Take action on a DM post-transactional case
1818

@@ -48,7 +48,7 @@ Name | Type | Description | Notes
4848

4949
### Return type
5050

51-
[**InlineResponse200**](InlineResponse200.md)
51+
[**InlineResponse2001**](InlineResponse2001.md)
5252

5353
### Authorization
5454

0 commit comments

Comments
 (0)