Skip to content

Commit 200ee35

Browse files
actions-useractions-user
committed
Auto-generate wrapper from updated spec
1 parent b91f9f4 commit 200ee35

18 files changed

Lines changed: 3420 additions & 0 deletions

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ Class | Method | HTTP request | Description
114114
*ResourcesDiscoverApi* | [**getResourcesDiscoverResources**](docs/Api/ResourcesDiscoverApi.md#getresourcesdiscoverresources) | **GET** /v2/resources/discover/resources | Fetch a list of resources
115115
*ResourcesDiscoverApi* | [**getV2ResourcesDiscoverDownloadDirectInitiate**](docs/Api/ResourcesDiscoverApi.md#getv2resourcesdiscoverdownloaddirectinitiate) | **GET** /v2/resources/discover/download/direct/initiate | Initiate a direct download request
116116
*ResourcesDiscoverApi* | [**getV2ResourcesDiscoverDownloadDirectPoll**](docs/Api/ResourcesDiscoverApi.md#getv2resourcesdiscoverdownloaddirectpoll) | **GET** /v2/resources/discover/download/direct/status | Fetch the status of a direct download request
117+
*ResourcesDiscoverApi* | [**getV2ResourcesDiscoverDownloadPlan**](docs/Api/ResourcesDiscoverApi.md#getv2resourcesdiscoverdownloadplan) | **GET** /v2/resources/discover/download/plan | Fetch a download plan
117118
*ResourcesDiscoverApi* | [**getV2ResourcesDiscoverLicenses**](docs/Api/ResourcesDiscoverApi.md#getv2resourcesdiscoverlicenses) | **GET** /v2/resources/discover/licenses | Fetch a list of the user's licenses
118119
*ResourcesDiscoverCartApi* | [**getV2ResourcesDiscoverCartView**](docs/Api/ResourcesDiscoverCartApi.md#getv2resourcesdiscovercartview) | **GET** /v2/resources/discover/cart/view | View the user's cart items
119120
*ResourcesDiscoverCartApi* | [**postV2ResourcesDiscoverCartAdd**](docs/Api/ResourcesDiscoverCartApi.md#postv2resourcesdiscovercartadd) | **POST** /v2/resources/discover/cart/add | Add items to a user's cart
@@ -141,6 +142,9 @@ Class | Method | HTTP request | Description
141142
- [Category](docs/Model/Category.md)
142143
- [Coupon](docs/Model/Coupon.md)
143144
- [CouponEntry](docs/Model/CouponEntry.md)
145+
- [DownloadPlan](docs/Model/DownloadPlan.md)
146+
- [DownloadPlanAction](docs/Model/DownloadPlanAction.md)
147+
- [DownloadPlanNotice](docs/Model/DownloadPlanNotice.md)
144148
- [DownloadRequest](docs/Model/DownloadRequest.md)
145149
- [DownloadStatus](docs/Model/DownloadStatus.md)
146150
- [Event](docs/Model/Event.md)
@@ -200,6 +204,8 @@ Class | Method | HTTP request | Description
200204
- [GetV2ResourcesDiscoverDownloadDirectInitiate200ResponseData](docs/Model/GetV2ResourcesDiscoverDownloadDirectInitiate200ResponseData.md)
201205
- [GetV2ResourcesDiscoverDownloadDirectPoll200Response](docs/Model/GetV2ResourcesDiscoverDownloadDirectPoll200Response.md)
202206
- [GetV2ResourcesDiscoverDownloadDirectPoll200ResponseData](docs/Model/GetV2ResourcesDiscoverDownloadDirectPoll200ResponseData.md)
207+
- [GetV2ResourcesDiscoverDownloadPlan200Response](docs/Model/GetV2ResourcesDiscoverDownloadPlan200Response.md)
208+
- [GetV2ResourcesDiscoverDownloadPlan200ResponseData](docs/Model/GetV2ResourcesDiscoverDownloadPlan200ResponseData.md)
203209
- [GetV2ResourcesDiscoverLicenses200Response](docs/Model/GetV2ResourcesDiscoverLicenses200Response.md)
204210
- [GetV2ResourcesDiscoverLicenses200ResponseData](docs/Model/GetV2ResourcesDiscoverLicenses200ResponseData.md)
205211
- [GetV2ResourcesEmbedDownloadInitiate200Response](docs/Model/GetV2ResourcesEmbedDownloadInitiate200Response.md)

‎docs/Api/ResourcesDiscoverApi.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ All URIs are relative to https://api.builtbybit.com, except if the operation def
88
| [**getResourcesDiscoverResources()**](ResourcesDiscoverApi.md#getResourcesDiscoverResources) | **GET** /v2/resources/discover/resources | Fetch a list of resources |
99
| [**getV2ResourcesDiscoverDownloadDirectInitiate()**](ResourcesDiscoverApi.md#getV2ResourcesDiscoverDownloadDirectInitiate) | **GET** /v2/resources/discover/download/direct/initiate | Initiate a direct download request |
1010
| [**getV2ResourcesDiscoverDownloadDirectPoll()**](ResourcesDiscoverApi.md#getV2ResourcesDiscoverDownloadDirectPoll) | **GET** /v2/resources/discover/download/direct/status | Fetch the status of a direct download request |
11+
| [**getV2ResourcesDiscoverDownloadPlan()**](ResourcesDiscoverApi.md#getV2ResourcesDiscoverDownloadPlan) | **GET** /v2/resources/discover/download/plan | Fetch a download plan |
1112
| [**getV2ResourcesDiscoverLicenses()**](ResourcesDiscoverApi.md#getV2ResourcesDiscoverLicenses) | **GET** /v2/resources/discover/licenses | Fetch a list of the user's licenses |
1213

1314

@@ -275,6 +276,74 @@ try {
275276
[[Back to Model list]](../../README.md#models)
276277
[[Back to README]](../../README.md)
277278

279+
## `getV2ResourcesDiscoverDownloadPlan()`
280+
281+
```php
282+
getV2ResourcesDiscoverDownloadPlan($content_type, $content_id, $supported, $current_server_sofware, $current_server_version): \OpenAPI\Client\Model\GetV2ResourcesDiscoverDownloadPlan200Response
283+
```
284+
285+
Fetch a download plan
286+
287+
### Example
288+
289+
```php
290+
<?php
291+
require_once(__DIR__ . '/vendor/autoload.php');
292+
293+
294+
// Configure API key authorization: token
295+
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
296+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
297+
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
298+
299+
300+
$apiInstance = new OpenAPI\Client\Api\ResourcesDiscoverApi(
301+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
302+
// This is optional, `GuzzleHttp\Client` will be used as default.
303+
new GuzzleHttp\Client(),
304+
$config
305+
);
306+
$content_type = 'content_type_example'; // string | Only 'resource' is currently supported.
307+
$content_id = 56; // int
308+
$supported = 'supported_example'; // string | A comma-separated list of supported features (like archive formats).
309+
$current_server_sofware = 'current_server_sofware_example'; // string
310+
$current_server_version = 'current_server_version_example'; // string
311+
312+
try {
313+
$result = $apiInstance->getV2ResourcesDiscoverDownloadPlan($content_type, $content_id, $supported, $current_server_sofware, $current_server_version);
314+
print_r($result);
315+
} catch (Exception $e) {
316+
echo 'Exception when calling ResourcesDiscoverApi->getV2ResourcesDiscoverDownloadPlan: ', $e->getMessage(), PHP_EOL;
317+
}
318+
```
319+
320+
### Parameters
321+
322+
| Name | Type | Description | Notes |
323+
| ------------- | ------------- | ------------- | ------------- |
324+
| **content_type** | **string**| Only &#39;resource&#39; is currently supported. | |
325+
| **content_id** | **int**| | |
326+
| **supported** | **string**| A comma-separated list of supported features (like archive formats). | [optional] |
327+
| **current_server_sofware** | **string**| | [optional] |
328+
| **current_server_version** | **string**| | [optional] |
329+
330+
### Return type
331+
332+
[**\OpenAPI\Client\Model\GetV2ResourcesDiscoverDownloadPlan200Response**](../Model/GetV2ResourcesDiscoverDownloadPlan200Response.md)
333+
334+
### Authorization
335+
336+
[token](../../README.md#token)
337+
338+
### HTTP request headers
339+
340+
- **Content-Type**: Not defined
341+
- **Accept**: `application/json`
342+
343+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
344+
[[Back to Model list]](../../README.md#models)
345+
[[Back to README]](../../README.md)
346+
278347
## `getV2ResourcesDiscoverLicenses()`
279348

280349
```php

‎docs/Model/DownloadPlan.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# # DownloadPlan
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**level** | **string** | |
8+
**actions** | [**\OpenAPI\Client\Model\DownloadPlanAction[]**](DownloadPlanAction.md) | | [optional]
9+
**notices** | [**\OpenAPI\Client\Model\DownloadPlanNotice[]**](DownloadPlanNotice.md) | | [optional]
10+
**unsupported** | **string[]** | A list of features which were unsupported (not passed into the &#39;supported&#39; query paramter) which were needed, resulting in the plan level being downgraded to &#39;manual&#39;. | [optional]
11+
**requires_empty_server** | **string** | Whether the server files must be empty before exeucting the plan steps. | [optional]
12+
13+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎docs/Model/DownloadPlanAction.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# # DownloadPlanAction
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**type** | **string** | |
8+
**src** | **string** | The source file/directory. | [optional]
9+
**dst** | **string** | A destination file/directory relative to the server root. | [optional]
10+
11+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎docs/Model/DownloadPlanNotice.md‎

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

‎docs/Model/GetV2ResourcesDiscoverDownloadPlan200Response.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# # GetV2ResourcesDiscoverDownloadPlan200Response
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**result** | **string** | | [optional]
8+
**data** | [**\OpenAPI\Client\Model\GetV2ResourcesDiscoverDownloadPlan200ResponseData**](GetV2ResourcesDiscoverDownloadPlan200ResponseData.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/GetV2ResourcesDiscoverDownloadPlan200ResponseData.md‎

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

0 commit comments

Comments
 (0)