Skip to content

Commit 1e14a70

Browse files
gaubansagaubansa
committed
spec changes
1 parent ab063be commit 1e14a70

File tree

180 files changed

+117229
-116013
lines changed

Some content is hidden

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

180 files changed

+117229
-116013
lines changed

‎docs/Api/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
# **getBatchReport**
14-
> \CyberSource\Model\InlineResponse2007 getBatchReport($batchId)
14+
> \CyberSource\Model\InlineResponse2004 getBatchReport($batchId)
1515
1616
Retrieve a Batch Report
1717

@@ -42,7 +42,7 @@ Name | Type | Description | Notes
4242

4343
### Return type
4444

45-
[**\CyberSource\Model\InlineResponse2007**](../Model/InlineResponse2007.md)
45+
[**\CyberSource\Model\InlineResponse2004**](../Model/InlineResponse2004.md)
4646

4747
### Authorization
4848

@@ -56,7 +56,7 @@ No authorization required
5656
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
5757

5858
# **getBatchStatus**
59-
> \CyberSource\Model\InlineResponse2006 getBatchStatus($batchId)
59+
> \CyberSource\Model\InlineResponse2003 getBatchStatus($batchId)
6060
6161
Retrieve a Batch Status
6262

@@ -87,7 +87,7 @@ Name | Type | Description | Notes
8787

8888
### Return type
8989

90-
[**\CyberSource\Model\InlineResponse2006**](../Model/InlineResponse2006.md)
90+
[**\CyberSource\Model\InlineResponse2003**](../Model/InlineResponse2003.md)
9191

9292
### Authorization
9393

@@ -101,7 +101,7 @@ No authorization required
101101
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
102102

103103
# **getBatchesList**
104-
> \CyberSource\Model\InlineResponse2005 getBatchesList($offset, $limit, $fromDate, $toDate)
104+
> \CyberSource\Model\InlineResponse2002 getBatchesList($offset, $limit, $fromDate, $toDate)
105105
106106
List Batches
107107

@@ -138,7 +138,7 @@ Name | Type | Description | Notes
138138

139139
### Return type
140140

141-
[**\CyberSource\Model\InlineResponse2005**](../Model/InlineResponse2005.md)
141+
[**\CyberSource\Model\InlineResponse2002**](../Model/InlineResponse2002.md)
142142

143143
### Authorization
144144

‎docs/Api/CreateNewWebhooksApi.md‎

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

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

119

12-
# **createWebhookSubscription**
13-
> \CyberSource\Model\InlineResponse2014 createWebhookSubscription($createWebhookRequest)
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-
```php
21-
<?php
22-
require_once(__DIR__ . '/vendor/autoload.php');
23-
24-
$api_instance = new CyberSource\Api\CreateNewWebhooksApi();
25-
$createWebhookRequest = new \CyberSource\Model\CreateWebhookRequest(); // \CyberSource\Model\CreateWebhookRequest | The webhook payload
26-
27-
try {
28-
$result = $api_instance->createWebhookSubscription($createWebhookRequest);
29-
print_r($result);
30-
} catch (Exception $e) {
31-
echo 'Exception when calling CreateNewWebhooksApi->createWebhookSubscription: ', $e->getMessage(), PHP_EOL;
32-
}
33-
?>
34-
```
35-
36-
### Parameters
37-
38-
Name | Type | Description | Notes
39-
------------- | ------------- | ------------- | -------------
40-
**createWebhookRequest** | [**\CyberSource\Model\CreateWebhookRequest**](../Model/CreateWebhookRequest.md)| The webhook payload | [optional]
41-
42-
### Return type
43-
44-
[**\CyberSource\Model\InlineResponse2014**](../Model/InlineResponse2014.md)
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/json;charset=utf-8
54-
55-
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
56-
57-
# **findProductsToSubscribe**
58-
> \CyberSource\Model\InlineResponse2002[] findProductsToSubscribe($organizationId)
59-
60-
Find Products You Can Subscribe To
61-
62-
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.
63-
64-
### Example
65-
```php
66-
<?php
67-
require_once(__DIR__ . '/vendor/autoload.php');
68-
69-
$api_instance = new CyberSource\Api\CreateNewWebhooksApi();
70-
$organizationId = "organizationId_example"; // string | The Organization Identifier.
71-
72-
try {
73-
$result = $api_instance->findProductsToSubscribe($organizationId);
74-
print_r($result);
75-
} catch (Exception $e) {
76-
echo 'Exception when calling CreateNewWebhooksApi->findProductsToSubscribe: ', $e->getMessage(), PHP_EOL;
77-
}
78-
?>
79-
```
80-
81-
### Parameters
82-
83-
Name | Type | Description | Notes
84-
------------- | ------------- | ------------- | -------------
85-
**organizationId** | **string**| The Organization Identifier. |
86-
87-
### Return type
88-
89-
[**\CyberSource\Model\InlineResponse2002[]**](../Model/InlineResponse2002.md)
90-
91-
### Authorization
92-
93-
No authorization required
94-
95-
### HTTP request headers
96-
97-
- **Content-Type**: application/json;charset=utf-8
98-
- **Accept**: application/json;charset=utf-8
99-
100-
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
101-
10210
# **saveSymEgressKey**
10311
> \CyberSource\Model\InlineResponse2013 saveSymEgressKey($vCSenderOrganizationId, $vCPermissions, $vCCorrelationId, $saveSymEgressKey)
10412
10513
Create Webhook Security Keys
10614

107-
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.
10816

10917
### Example
11018
```php
@@ -146,7 +54,7 @@ No authorization required
14654
### HTTP request headers
14755

14856
- **Content-Type**: application/json;charset=utf-8
149-
- **Accept**: application/json;charset=utf-8
57+
- **Accept**: application/hal+json;charset=utf-8
15058

15159
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
15260

‎docs/Api/ManageWebhooksApi.md‎

Lines changed: 12 additions & 154 deletions
Original file line numberDiff line numberDiff line change
@@ -4,124 +4,30 @@ All URIs are relative to *https://apitest.cybersource.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**deleteWebhookSubscription**](ManageWebhooksApi.md#deleteWebhookSubscription) | **DELETE** /notification-subscriptions/v1/webhooks/{webhookId} | Delete a Webhook Subscription
8-
[**getWebhookSubscriptionById**](ManageWebhooksApi.md#getWebhookSubscriptionById) | **GET** /notification-subscriptions/v1/webhooks/{webhookId} | Get Details On a Single Webhook
9-
[**getWebhookSubscriptionsByOrg**](ManageWebhooksApi.md#getWebhookSubscriptionsByOrg) | **GET** /notification-subscriptions/v1/webhooks | Get Details On All Created Webhooks
7+
[**notificationSubscriptionsV1WebhooksWebhookIdPost**](ManageWebhooksApi.md#notificationSubscriptionsV1WebhooksWebhookIdPost) | **POST** /notification-subscriptions/v1/webhooks/{webhookId} | Test a Webhook Configuration
108
[**saveAsymEgressKey**](ManageWebhooksApi.md#saveAsymEgressKey) | **POST** /kms/egress/v2/keys-asym | Message Level Encryption
11-
[**updateWebhookSubscription**](ManageWebhooksApi.md#updateWebhookSubscription) | **PATCH** /notification-subscriptions/v1/webhooks/{webhookId} | Update a Webhook Subscription
129

1310

14-
# **deleteWebhookSubscription**
15-
> deleteWebhookSubscription($webhookId)
11+
# **notificationSubscriptionsV1WebhooksWebhookIdPost**
12+
> \CyberSource\Model\InlineResponse2014 notificationSubscriptionsV1WebhooksWebhookIdPost($webhookId)
1613
17-
Delete a Webhook Subscription
14+
Test a Webhook Configuration
1815

19-
Delete the webhook. Please note that deleting a particular webhook does not delete the history of the webhook notifications.
16+
Test the webhook configuration by sending a sample webhook. Calling this endpoint sends a sample webhook to the endpoint identified in the user's subscription. It will contain sample values for the product & eventType based on values present in your subscription along with a sample message in the payload. Based on the webhook response users can make any necessary modifications or rest assured knowing their setup is configured correctly.
2017

2118
### Example
2219
```php
2320
<?php
2421
require_once(__DIR__ . '/vendor/autoload.php');
2522

2623
$api_instance = new CyberSource\Api\ManageWebhooksApi();
27-
$webhookId = "webhookId_example"; // string | The webhook identifier.
28-
29-
try {
30-
$api_instance->deleteWebhookSubscription($webhookId);
31-
} catch (Exception $e) {
32-
echo 'Exception when calling ManageWebhooksApi->deleteWebhookSubscription: ', $e->getMessage(), PHP_EOL;
33-
}
34-
?>
35-
```
36-
37-
### Parameters
38-
39-
Name | Type | Description | Notes
40-
------------- | ------------- | ------------- | -------------
41-
**webhookId** | **string**| The webhook identifier. |
42-
43-
### Return type
44-
45-
void (empty response body)
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-
56-
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
57-
58-
# **getWebhookSubscriptionById**
59-
> \CyberSource\Model\InlineResponse2004 getWebhookSubscriptionById($webhookId)
60-
61-
Get Details On a Single Webhook
62-
63-
Retrieve the details of a specific webhook by supplying the webhook ID in the path.
64-
65-
### Example
66-
```php
67-
<?php
68-
require_once(__DIR__ . '/vendor/autoload.php');
69-
70-
$api_instance = new CyberSource\Api\ManageWebhooksApi();
71-
$webhookId = "webhookId_example"; // string | The webhook Identifier
72-
73-
try {
74-
$result = $api_instance->getWebhookSubscriptionById($webhookId);
75-
print_r($result);
76-
} catch (Exception $e) {
77-
echo 'Exception when calling ManageWebhooksApi->getWebhookSubscriptionById: ', $e->getMessage(), PHP_EOL;
78-
}
79-
?>
80-
```
81-
82-
### Parameters
83-
84-
Name | Type | Description | Notes
85-
------------- | ------------- | ------------- | -------------
86-
**webhookId** | **string**| The webhook Identifier |
87-
88-
### Return type
89-
90-
[**\CyberSource\Model\InlineResponse2004**](../Model/InlineResponse2004.md)
91-
92-
### Authorization
93-
94-
No authorization required
95-
96-
### HTTP request headers
97-
98-
- **Content-Type**: application/json;charset=utf-8
99-
- **Accept**: application/json;charset=utf-8
100-
101-
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
102-
103-
# **getWebhookSubscriptionsByOrg**
104-
> \CyberSource\Model\InlineResponse2003[] getWebhookSubscriptionsByOrg($organizationId, $productId, $eventType)
105-
106-
Get Details On All Created Webhooks
107-
108-
Retrieve a list of all previously created webhooks.
109-
110-
### Example
111-
```php
112-
<?php
113-
require_once(__DIR__ . '/vendor/autoload.php');
114-
115-
$api_instance = new CyberSource\Api\ManageWebhooksApi();
116-
$organizationId = "organizationId_example"; // string | The Organization Identifier.
117-
$productId = "productId_example"; // string | The Product Identifier.
118-
$eventType = "eventType_example"; // string | The Event Type.
24+
$webhookId = "webhookId_example"; // string | The Webhook Identifier.
11925

12026
try {
121-
$result = $api_instance->getWebhookSubscriptionsByOrg($organizationId, $productId, $eventType);
27+
$result = $api_instance->notificationSubscriptionsV1WebhooksWebhookIdPost($webhookId);
12228
print_r($result);
12329
} catch (Exception $e) {
124-
echo 'Exception when calling ManageWebhooksApi->getWebhookSubscriptionsByOrg: ', $e->getMessage(), PHP_EOL;
30+
echo 'Exception when calling ManageWebhooksApi->notificationSubscriptionsV1WebhooksWebhookIdPost: ', $e->getMessage(), PHP_EOL;
12531
}
12632
?>
12733
```
@@ -130,13 +36,11 @@ try {
13036

13137
Name | Type | Description | Notes
13238
------------- | ------------- | ------------- | -------------
133-
**organizationId** | **string**| The Organization Identifier. |
134-
**productId** | **string**| The Product Identifier. |
135-
**eventType** | **string**| The Event Type. |
39+
**webhookId** | **string**| The Webhook Identifier. |
13640

13741
### Return type
13842

139-
[**\CyberSource\Model\InlineResponse2003[]**](../Model/InlineResponse2003.md)
43+
[**\CyberSource\Model\InlineResponse2014**](../Model/InlineResponse2014.md)
14044

14145
### Authorization
14246

@@ -145,7 +49,7 @@ No authorization required
14549
### HTTP request headers
14650

14751
- **Content-Type**: application/json;charset=utf-8
148-
- **Accept**: application/json;charset=utf-8
52+
- **Accept**: application/hal+json;charset=utf-8
14953

15054
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
15155

@@ -196,53 +100,7 @@ No authorization required
196100
### HTTP request headers
197101

198102
- **Content-Type**: application/json;charset=utf-8
199-
- **Accept**: application/json;charset=utf-8
200-
201-
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
202-
203-
# **updateWebhookSubscription**
204-
> updateWebhookSubscription($webhookId, $updateWebhookRequest)
205-
206-
Update a Webhook Subscription
207-
208-
Update the webhook subscription using PATCH.
209-
210-
### Example
211-
```php
212-
<?php
213-
require_once(__DIR__ . '/vendor/autoload.php');
214-
215-
$api_instance = new CyberSource\Api\ManageWebhooksApi();
216-
$webhookId = "webhookId_example"; // string | The Webhook Identifier.
217-
$updateWebhookRequest = new \CyberSource\Model\UpdateWebhookRequest(); // \CyberSource\Model\UpdateWebhookRequest | The webhook payload or changes to apply.
218-
219-
try {
220-
$api_instance->updateWebhookSubscription($webhookId, $updateWebhookRequest);
221-
} catch (Exception $e) {
222-
echo 'Exception when calling ManageWebhooksApi->updateWebhookSubscription: ', $e->getMessage(), PHP_EOL;
223-
}
224-
?>
225-
```
226-
227-
### Parameters
228-
229-
Name | Type | Description | Notes
230-
------------- | ------------- | ------------- | -------------
231-
**webhookId** | **string**| The Webhook Identifier. |
232-
**updateWebhookRequest** | [**\CyberSource\Model\UpdateWebhookRequest**](../Model/UpdateWebhookRequest.md)| The webhook payload or changes to apply. | [optional]
233-
234-
### Return type
235-
236-
void (empty response body)
237-
238-
### Authorization
239-
240-
No authorization required
241-
242-
### HTTP request headers
243-
244-
- **Content-Type**: application/json;charset=utf-8
245-
- **Accept**: application/json;charset=utf-8
103+
- **Accept**: application/hal+json;charset=utf-8
246104

247105
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
248106

0 commit comments

Comments
 (0)