Skip to content

Commit 8b39921

Browse files
actions-useractions-user
committed
Auto-generate wrapper from updated spec
1 parent 39c9a53 commit 8b39921

16 files changed

Lines changed: 3068 additions & 0 deletions

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ Class | Method | HTTP request | Description
8484
*AnalyticsApi* | [**getV2Analytics**](docs/Api/AnalyticsApi.md#getv2analytics) | **GET** /v2/analytics | Fetch a list of analytics definitions
8585
*AnalyticsApi* | [**getV2AnalyticsGraph**](docs/Api/AnalyticsApi.md#getv2analyticsgraph) | **GET** /v2/analytics/graph | Fetch analytics graph data
8686
*AnalyticsApi* | [**getV2AnalyticsSingle**](docs/Api/AnalyticsApi.md#getv2analyticssingle) | **GET** /v2/analytics/single | Fetch a single analytics value
87+
*DeploymentsApi* | [**postV2DeploymentsUpgrade**](docs/Api/DeploymentsApi.md#postv2deploymentsupgrade) | **POST** /v2/deployments/upgrade | Upgrade a short-lived token
8788
*EventsApi* | [**getV2Events**](docs/Api/EventsApi.md#getv2events) | **GET** /v2/events | Fetch a list of pending events
8889
*EventsApi* | [**postV2EventsComplete**](docs/Api/EventsApi.md#postv2eventscomplete) | **POST** /v2/events/complete | Mark events as complete
8990
*HealthApi* | [**getV2Health**](docs/Api/HealthApi.md#getv2health) | **GET** /v2/health | Retrieve a health status
@@ -199,6 +200,10 @@ Class | Method | HTTP request | Description
199200
- [License](docs/Model/License.md)
200201
- [ListStats](docs/Model/ListStats.md)
201202
- [Member](docs/Model/Member.md)
203+
- [PostV2DeploymentsUpgrade200Response](docs/Model/PostV2DeploymentsUpgrade200Response.md)
204+
- [PostV2DeploymentsUpgrade200ResponseData](docs/Model/PostV2DeploymentsUpgrade200ResponseData.md)
205+
- [PostV2DeploymentsUpgrade200ResponseDataPreauthorize](docs/Model/PostV2DeploymentsUpgrade200ResponseDataPreauthorize.md)
206+
- [PostV2DeploymentsUpgradeRequest](docs/Model/PostV2DeploymentsUpgradeRequest.md)
202207
- [PostV2EventsComplete200Response](docs/Model/PostV2EventsComplete200Response.md)
203208
- [PostV2EventsCompleteRequest](docs/Model/PostV2EventsCompleteRequest.md)
204209
- [PostV2ResourcesCreatorBatch200Response](docs/Model/PostV2ResourcesCreatorBatch200Response.md)

‎docs/Api/DeploymentsApi.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# OpenAPI\Client\DeploymentsApi
2+
3+
All URIs are relative to https://api.builtbybit.com, except if the operation defines another base path.
4+
5+
| Method | HTTP request | Description |
6+
| ------------- | ------------- | ------------- |
7+
| [**postV2DeploymentsUpgrade()**](DeploymentsApi.md#postV2DeploymentsUpgrade) | **POST** /v2/deployments/upgrade | Upgrade a short-lived token |
8+
9+
10+
## `postV2DeploymentsUpgrade()`
11+
12+
```php
13+
postV2DeploymentsUpgrade($post_v2_deployments_upgrade_request): \OpenAPI\Client\Model\PostV2DeploymentsUpgrade200Response
14+
```
15+
16+
Upgrade a short-lived token
17+
18+
19+
20+
### Example
21+
22+
```php
23+
<?php
24+
require_once(__DIR__ . '/vendor/autoload.php');
25+
26+
27+
// Configure API key authorization: token
28+
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
29+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
30+
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
31+
32+
33+
$apiInstance = new OpenAPI\Client\Api\DeploymentsApi(
34+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
35+
// This is optional, `GuzzleHttp\Client` will be used as default.
36+
new GuzzleHttp\Client(),
37+
$config
38+
);
39+
$post_v2_deployments_upgrade_request = new \OpenAPI\Client\Model\PostV2DeploymentsUpgradeRequest(); // \OpenAPI\Client\Model\PostV2DeploymentsUpgradeRequest
40+
41+
try {
42+
$result = $apiInstance->postV2DeploymentsUpgrade($post_v2_deployments_upgrade_request);
43+
print_r($result);
44+
} catch (Exception $e) {
45+
echo 'Exception when calling DeploymentsApi->postV2DeploymentsUpgrade: ', $e->getMessage(), PHP_EOL;
46+
}
47+
```
48+
49+
### Parameters
50+
51+
| Name | Type | Description | Notes |
52+
| ------------- | ------------- | ------------- | ------------- |
53+
| **post_v2_deployments_upgrade_request** | [**\OpenAPI\Client\Model\PostV2DeploymentsUpgradeRequest**](../Model/PostV2DeploymentsUpgradeRequest.md)| | [optional] |
54+
55+
### Return type
56+
57+
[**\OpenAPI\Client\Model\PostV2DeploymentsUpgrade200Response**](../Model/PostV2DeploymentsUpgrade200Response.md)
58+
59+
### Authorization
60+
61+
[token](../../README.md#token)
62+
63+
### HTTP request headers
64+
65+
- **Content-Type**: `application/json`
66+
- **Accept**: `application/json`
67+
68+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
69+
[[Back to Model list]](../../README.md#models)
70+
[[Back to README]](../../README.md)

‎docs/Model/PostV2DeploymentsUpgrade200Response.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# # PostV2DeploymentsUpgrade200Response
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**result** | **string** | | [optional]
8+
**data** | [**\OpenAPI\Client\Model\PostV2DeploymentsUpgrade200ResponseData**](PostV2DeploymentsUpgrade200ResponseData.md) | | [optional]
9+
10+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎docs/Model/PostV2DeploymentsUpgrade200ResponseData.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# # PostV2DeploymentsUpgrade200ResponseData
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**token** | **string** | | [optional]
8+
**oauth2_client** | **string** | | [optional]
9+
**oauth2_secret** | **string** | | [optional]
10+
**preauthorize** | [**\OpenAPI\Client\Model\PostV2DeploymentsUpgrade200ResponseDataPreauthorize**](PostV2DeploymentsUpgrade200ResponseDataPreauthorize.md) | | [optional]
11+
12+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎docs/Model/PostV2DeploymentsUpgrade200ResponseDataPreauthorize.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# # PostV2DeploymentsUpgrade200ResponseDataPreauthorize
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**access_token** | **string** | | [optional]
8+
**expires_in** | **int** | | [optional]
9+
**refresh_token** | **string** | | [optional]
10+
**scope** | **string** | | [optional]
11+
**token_type** | **string** | | [optional]
12+
13+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎docs/Model/PostV2DeploymentsUpgradeRequest.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# # PostV2DeploymentsUpgradeRequest
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**preauthorize** | **bool** | Whether or not to pre-authorize OAuth2 credentials for the deployment token owner. | [optional] [default to false]
8+
**scopes** | **string** | A space-separated list of scopes to request if pre-authorizing. | [optional]
9+
10+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

0 commit comments

Comments
 (0)