Skip to content

Commit 436b1e0

Browse files
gnongsiegnongsie
authored
Merge pull request #51 from CyberSource/july-2020
July 2020 Release
2 parents 35cb62d + fa2b2df commit 436b1e0

File tree

1,139 files changed

+92135
-25820
lines changed

Some content is hidden

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

1,139 files changed

+92135
-25820
lines changed

‎docs/Api/AsymmetricKeyManagementApi.md‎

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
# CyberSource\AsymmetricKeyManagementApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**createP12Keys**](AsymmetricKeyManagementApi.md#createP12Keys) | **POST** /kms/v2/keys-asym | Create one or more PKCS#12 keys
8+
[**deleteBulkP12Keys**](AsymmetricKeyManagementApi.md#deleteBulkP12Keys) | **POST** /kms/v2/keys-asym/deletes | Delete one or more PKCS#12 keys
9+
[**getP12KeyDetails**](AsymmetricKeyManagementApi.md#getP12KeyDetails) | **GET** /kms/v2/keys-asym/{keyId} | Retrieves PKCS#12 key details
10+
11+
12+
# **createP12Keys**
13+
> \CyberSource\Model\InlineResponse2011 createP12Keys($createP12KeysRequest)
14+
15+
Create one or more PKCS#12 keys
16+
17+
'Create one or more PKCS#12 keys'
18+
19+
### Example
20+
```php
21+
<?php
22+
require_once(__DIR__ . '/vendor/autoload.php');
23+
24+
$api_instance = new CyberSource\Api\AsymmetricKeyManagementApi();
25+
$createP12KeysRequest = new \CyberSource\Model\CreateP12KeysRequest(); // \CyberSource\Model\CreateP12KeysRequest |
26+
27+
try {
28+
$result = $api_instance->createP12Keys($createP12KeysRequest);
29+
print_r($result);
30+
} catch (Exception $e) {
31+
echo 'Exception when calling AsymmetricKeyManagementApi->createP12Keys: ', $e->getMessage(), PHP_EOL;
32+
}
33+
?>
34+
```
35+
36+
### Parameters
37+
38+
Name | Type | Description | Notes
39+
------------- | ------------- | ------------- | -------------
40+
**createP12KeysRequest** | [**\CyberSource\Model\CreateP12KeysRequest**](../Model/CreateP12KeysRequest.md)| |
41+
42+
### Return type
43+
44+
[**\CyberSource\Model\InlineResponse2011**](../Model/InlineResponse2011.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/hal+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+
# **deleteBulkP12Keys**
58+
> \CyberSource\Model\InlineResponse2003 deleteBulkP12Keys($deleteBulkP12KeysRequest)
59+
60+
Delete one or more PKCS#12 keys
61+
62+
'Delete one or more PKCS#12 keys'
63+
64+
### Example
65+
```php
66+
<?php
67+
require_once(__DIR__ . '/vendor/autoload.php');
68+
69+
$api_instance = new CyberSource\Api\AsymmetricKeyManagementApi();
70+
$deleteBulkP12KeysRequest = new \CyberSource\Model\DeleteBulkP12KeysRequest(); // \CyberSource\Model\DeleteBulkP12KeysRequest |
71+
72+
try {
73+
$result = $api_instance->deleteBulkP12Keys($deleteBulkP12KeysRequest);
74+
print_r($result);
75+
} catch (Exception $e) {
76+
echo 'Exception when calling AsymmetricKeyManagementApi->deleteBulkP12Keys: ', $e->getMessage(), PHP_EOL;
77+
}
78+
?>
79+
```
80+
81+
### Parameters
82+
83+
Name | Type | Description | Notes
84+
------------- | ------------- | ------------- | -------------
85+
**deleteBulkP12KeysRequest** | [**\CyberSource\Model\DeleteBulkP12KeysRequest**](../Model/DeleteBulkP12KeysRequest.md)| |
86+
87+
### Return type
88+
89+
[**\CyberSource\Model\InlineResponse2003**](../Model/InlineResponse2003.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/hal+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+
102+
# **getP12KeyDetails**
103+
> \CyberSource\Model\InlineResponse2002 getP12KeyDetails($keyId)
104+
105+
Retrieves PKCS#12 key details
106+
107+
Retrieves keys details by providing the key id.
108+
109+
### Example
110+
```php
111+
<?php
112+
require_once(__DIR__ . '/vendor/autoload.php');
113+
114+
$api_instance = new CyberSource\Api\AsymmetricKeyManagementApi();
115+
$keyId = "keyId_example"; // string | Key ID.
116+
117+
try {
118+
$result = $api_instance->getP12KeyDetails($keyId);
119+
print_r($result);
120+
} catch (Exception $e) {
121+
echo 'Exception when calling AsymmetricKeyManagementApi->getP12KeyDetails: ', $e->getMessage(), PHP_EOL;
122+
}
123+
?>
124+
```
125+
126+
### Parameters
127+
128+
Name | Type | Description | Notes
129+
------------- | ------------- | ------------- | -------------
130+
**keyId** | **string**| Key ID. |
131+
132+
### Return type
133+
134+
[**\CyberSource\Model\InlineResponse2002**](../Model/InlineResponse2002.md)
135+
136+
### Authorization
137+
138+
No authorization required
139+
140+
### HTTP request headers
141+
142+
- **Content-Type**: application/json;charset=utf-8
143+
- **Accept**: application/hal+json;charset=utf-8
144+
145+
[[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)
146+

‎docs/Api/CustomerApi.md‎

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
# CyberSource\CustomerApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**deleteCustomer**](CustomerApi.md#deleteCustomer) | **DELETE** /tms/v2/customers/{customerTokenId} | Delete a Customer
8+
[**getCustomer**](CustomerApi.md#getCustomer) | **GET** /tms/v2/customers/{customerTokenId} | Retrieve a Customer
9+
[**patchCustomer**](CustomerApi.md#patchCustomer) | **PATCH** /tms/v2/customers/{customerTokenId} | Update a Customer
10+
[**postCustomer**](CustomerApi.md#postCustomer) | **POST** /tms/v2/customers | Create a Customer
11+
12+
13+
# **deleteCustomer**
14+
> deleteCustomer($customerTokenId, $profileId)
15+
16+
Delete a Customer
17+
18+
### Example
19+
```php
20+
<?php
21+
require_once(__DIR__ . '/vendor/autoload.php');
22+
23+
$api_instance = new CyberSource\Api\CustomerApi();
24+
$customerTokenId = "customerTokenId_example"; // string | The TokenId of a customer.
25+
$profileId = "profileId_example"; // string | The id of a profile containing user specific TMS configuration.
26+
27+
try {
28+
$api_instance->deleteCustomer($customerTokenId, $profileId);
29+
} catch (Exception $e) {
30+
echo 'Exception when calling CustomerApi->deleteCustomer: ', $e->getMessage(), PHP_EOL;
31+
}
32+
?>
33+
```
34+
35+
### Parameters
36+
37+
Name | Type | Description | Notes
38+
------------- | ------------- | ------------- | -------------
39+
**customerTokenId** | **string**| The TokenId of a customer. |
40+
**profileId** | **string**| The id of a profile containing user specific TMS configuration. | [optional]
41+
42+
### Return type
43+
44+
void (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/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+
# **getCustomer**
58+
> \CyberSource\Model\TmsV2CustomersResponse getCustomer($customerTokenId, $profileId)
59+
60+
Retrieve a Customer
61+
62+
### Example
63+
```php
64+
<?php
65+
require_once(__DIR__ . '/vendor/autoload.php');
66+
67+
$api_instance = new CyberSource\Api\CustomerApi();
68+
$customerTokenId = "customerTokenId_example"; // string | The TokenId of a customer.
69+
$profileId = "profileId_example"; // string | The id of a profile containing user specific TMS configuration.
70+
71+
try {
72+
$result = $api_instance->getCustomer($customerTokenId, $profileId);
73+
print_r($result);
74+
} catch (Exception $e) {
75+
echo 'Exception when calling CustomerApi->getCustomer: ', $e->getMessage(), PHP_EOL;
76+
}
77+
?>
78+
```
79+
80+
### Parameters
81+
82+
Name | Type | Description | Notes
83+
------------- | ------------- | ------------- | -------------
84+
**customerTokenId** | **string**| The TokenId of a customer. |
85+
**profileId** | **string**| The id of a profile containing user specific TMS configuration. | [optional]
86+
87+
### Return type
88+
89+
[**\CyberSource\Model\TmsV2CustomersResponse**](../Model/TmsV2CustomersResponse.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+
102+
# **patchCustomer**
103+
> \CyberSource\Model\TmsV2CustomersResponse patchCustomer($customerTokenId, $patchCustomerRequest, $profileId, $ifMatch)
104+
105+
Update a Customer
106+
107+
### Example
108+
```php
109+
<?php
110+
require_once(__DIR__ . '/vendor/autoload.php');
111+
112+
$api_instance = new CyberSource\Api\CustomerApi();
113+
$customerTokenId = "customerTokenId_example"; // string | The TokenId of a customer.
114+
$patchCustomerRequest = new \CyberSource\Model\PatchCustomerRequest(); // \CyberSource\Model\PatchCustomerRequest |
115+
$profileId = "profileId_example"; // string | The id of a profile containing user specific TMS configuration.
116+
$ifMatch = "ifMatch_example"; // string | Contains an ETag value from a GET request to make the request conditional.
117+
118+
try {
119+
$result = $api_instance->patchCustomer($customerTokenId, $patchCustomerRequest, $profileId, $ifMatch);
120+
print_r($result);
121+
} catch (Exception $e) {
122+
echo 'Exception when calling CustomerApi->patchCustomer: ', $e->getMessage(), PHP_EOL;
123+
}
124+
?>
125+
```
126+
127+
### Parameters
128+
129+
Name | Type | Description | Notes
130+
------------- | ------------- | ------------- | -------------
131+
**customerTokenId** | **string**| The TokenId of a customer. |
132+
**patchCustomerRequest** | [**\CyberSource\Model\PatchCustomerRequest**](../Model/PatchCustomerRequest.md)| |
133+
**profileId** | **string**| The id of a profile containing user specific TMS configuration. | [optional]
134+
**ifMatch** | **string**| Contains an ETag value from a GET request to make the request conditional. | [optional]
135+
136+
### Return type
137+
138+
[**\CyberSource\Model\TmsV2CustomersResponse**](../Model/TmsV2CustomersResponse.md)
139+
140+
### Authorization
141+
142+
No authorization required
143+
144+
### HTTP request headers
145+
146+
- **Content-Type**: application/json;charset=utf-8
147+
- **Accept**: application/json;charset=utf-8
148+
149+
[[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)
150+
151+
# **postCustomer**
152+
> \CyberSource\Model\TmsV2CustomersResponse postCustomer($postCustomerRequest, $profileId)
153+
154+
Create a Customer
155+
156+
### Example
157+
```php
158+
<?php
159+
require_once(__DIR__ . '/vendor/autoload.php');
160+
161+
$api_instance = new CyberSource\Api\CustomerApi();
162+
$postCustomerRequest = new \CyberSource\Model\PostCustomerRequest(); // \CyberSource\Model\PostCustomerRequest |
163+
$profileId = "profileId_example"; // string | The id of a profile containing user specific TMS configuration.
164+
165+
try {
166+
$result = $api_instance->postCustomer($postCustomerRequest, $profileId);
167+
print_r($result);
168+
} catch (Exception $e) {
169+
echo 'Exception when calling CustomerApi->postCustomer: ', $e->getMessage(), PHP_EOL;
170+
}
171+
?>
172+
```
173+
174+
### Parameters
175+
176+
Name | Type | Description | Notes
177+
------------- | ------------- | ------------- | -------------
178+
**postCustomerRequest** | [**\CyberSource\Model\PostCustomerRequest**](../Model/PostCustomerRequest.md)| |
179+
**profileId** | **string**| The id of a profile containing user specific TMS configuration. | [optional]
180+
181+
### Return type
182+
183+
[**\CyberSource\Model\TmsV2CustomersResponse**](../Model/TmsV2CustomersResponse.md)
184+
185+
### Authorization
186+
187+
No authorization required
188+
189+
### HTTP request headers
190+
191+
- **Content-Type**: application/json;charset=utf-8
192+
- **Accept**: application/json;charset=utf-8
193+
194+
[[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)
195+

0 commit comments

Comments
 (0)