Skip to content

Commit f8d25b8

Browse files
committed
Auto-generate wrapper from updated spec
1 parent 8523b87 commit f8d25b8

155 files changed

Lines changed: 2575 additions & 136 deletions

File tree

Some content is hidden

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

‎README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
BuiltByBit API
44
- API version: v2
5-
- Build date: 2026-08-01T20:29:13.832214Z[Etc/UTC]
5+
- Build date: 2026-09-07T15:23:13.439118Z[Etc/UTC]
66

77
All operations not tagged 'free' require an active [Ultimate](https://builtbybit.com/account/ultimate) subscription or invite-only permissions.
88

@@ -157,6 +157,7 @@ Class | Method | HTTP request | Description
157157
*ResourcesDiscoverApi* | [**getResourcesDiscoverResources**](docs/ResourcesDiscoverApi.md#getResourcesDiscoverResources) | **GET** /v2/resources/discover/resources | Fetch a list of resources
158158
*ResourcesDiscoverApi* | [**getV2ResourcesDiscoverDownloadDirectInitiate**](docs/ResourcesDiscoverApi.md#getV2ResourcesDiscoverDownloadDirectInitiate) | **GET** /v2/resources/discover/download/direct/initiate | Initiate a direct download request
159159
*ResourcesDiscoverApi* | [**getV2ResourcesDiscoverDownloadDirectPoll**](docs/ResourcesDiscoverApi.md#getV2ResourcesDiscoverDownloadDirectPoll) | **GET** /v2/resources/discover/download/direct/status | Fetch the status of a direct download request
160+
*ResourcesDiscoverApi* | [**getV2ResourcesDiscoverDownloadPlan**](docs/ResourcesDiscoverApi.md#getV2ResourcesDiscoverDownloadPlan) | **GET** /v2/resources/discover/download/plan | Fetch a download plan
160161
*ResourcesDiscoverApi* | [**getV2ResourcesDiscoverLicenses**](docs/ResourcesDiscoverApi.md#getV2ResourcesDiscoverLicenses) | **GET** /v2/resources/discover/licenses | Fetch a list of the user's licenses
161162
*ResourcesDiscoverCartApi* | [**getV2ResourcesDiscoverCartView**](docs/ResourcesDiscoverCartApi.md#getV2ResourcesDiscoverCartView) | **GET** /v2/resources/discover/cart/view | View the user's cart items
162163
*ResourcesDiscoverCartApi* | [**postV2ResourcesDiscoverCartAdd**](docs/ResourcesDiscoverCartApi.md#postV2ResourcesDiscoverCartAdd) | **POST** /v2/resources/discover/cart/add | Add items to a user's cart
@@ -185,6 +186,9 @@ Class | Method | HTTP request | Description
185186
- [Category](docs/Category.md)
186187
- [Coupon](docs/Coupon.md)
187188
- [CouponEntry](docs/CouponEntry.md)
189+
- [DownloadPlan](docs/DownloadPlan.md)
190+
- [DownloadPlanAction](docs/DownloadPlanAction.md)
191+
- [DownloadPlanNotice](docs/DownloadPlanNotice.md)
188192
- [DownloadRequest](docs/DownloadRequest.md)
189193
- [DownloadStatus](docs/DownloadStatus.md)
190194
- [Event](docs/Event.md)
@@ -244,6 +248,8 @@ Class | Method | HTTP request | Description
244248
- [GetV2ResourcesDiscoverDownloadDirectInitiate200ResponseData](docs/GetV2ResourcesDiscoverDownloadDirectInitiate200ResponseData.md)
245249
- [GetV2ResourcesDiscoverDownloadDirectPoll200Response](docs/GetV2ResourcesDiscoverDownloadDirectPoll200Response.md)
246250
- [GetV2ResourcesDiscoverDownloadDirectPoll200ResponseData](docs/GetV2ResourcesDiscoverDownloadDirectPoll200ResponseData.md)
251+
- [GetV2ResourcesDiscoverDownloadPlan200Response](docs/GetV2ResourcesDiscoverDownloadPlan200Response.md)
252+
- [GetV2ResourcesDiscoverDownloadPlan200ResponseData](docs/GetV2ResourcesDiscoverDownloadPlan200ResponseData.md)
247253
- [GetV2ResourcesDiscoverLicenses200Response](docs/GetV2ResourcesDiscoverLicenses200Response.md)
248254
- [GetV2ResourcesDiscoverLicenses200ResponseData](docs/GetV2ResourcesDiscoverLicenses200ResponseData.md)
249255
- [GetV2ResourcesEmbedDownloadInitiate200Response](docs/GetV2ResourcesEmbedDownloadInitiate200Response.md)

‎api/openapi.yaml‎

Lines changed: 244 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1435,6 +1435,62 @@ paths:
14351435
id: a3oq9ufnxt653
14361436
x-content-type: application/json
14371437
x-accepts: application/json
1438+
/v2/resources/discover/download/plan:
1439+
get:
1440+
operationId: get-v2-resources-discover-download-plan
1441+
parameters:
1442+
- description: Only 'resource' is currently supported.
1443+
explode: true
1444+
in: query
1445+
name: content_type
1446+
required: true
1447+
schema:
1448+
type: string
1449+
style: form
1450+
- explode: true
1451+
in: query
1452+
name: content_id
1453+
required: true
1454+
schema:
1455+
type: integer
1456+
style: form
1457+
- description: A comma-separated list of supported features (like archive formats).
1458+
explode: true
1459+
in: query
1460+
name: supported
1461+
required: false
1462+
schema:
1463+
type: string
1464+
style: form
1465+
- explode: true
1466+
in: query
1467+
name: current_server_sofware
1468+
required: false
1469+
schema:
1470+
type: string
1471+
style: form
1472+
- explode: true
1473+
in: query
1474+
name: current_server_version
1475+
required: false
1476+
schema:
1477+
type: string
1478+
style: form
1479+
responses:
1480+
"200":
1481+
content:
1482+
application/json:
1483+
schema:
1484+
$ref: '#/components/schemas/get_v2_resources_discover_download_plan_200_response'
1485+
description: OK
1486+
security:
1487+
- token: []
1488+
summary: Fetch a download plan
1489+
tags:
1490+
- resources/discover
1491+
x-stoplight:
1492+
id: l2n9hkp59ez8a
1493+
x-accepts: application/json
14381494
components:
14391495
examples: {}
14401496
parameters:
@@ -4143,6 +4199,128 @@ components:
41434199
type: object
41444200
x-stoplight:
41454201
id: qc3ai0naipzva
4202+
DownloadPlan:
4203+
example:
4204+
notices:
4205+
- text: text
4206+
- text: text
4207+
unsupported:
4208+
- unsupported
4209+
- unsupported
4210+
requires_empty_server: requires_empty_server
4211+
level: full
4212+
actions:
4213+
- dst: dst
4214+
src: src
4215+
type: copy
4216+
actions:
4217+
- null
4218+
- null
4219+
- dst: dst
4220+
src: src
4221+
type: copy
4222+
actions:
4223+
- null
4224+
- null
4225+
properties:
4226+
level:
4227+
enum:
4228+
- full
4229+
- partial
4230+
- manual
4231+
type: string
4232+
x-stoplight:
4233+
id: 37cu2v7lxk4p3
4234+
actions:
4235+
items:
4236+
$ref: '#/components/schemas/DownloadPlanAction'
4237+
type: array
4238+
x-stoplight:
4239+
id: t7n5sf2r2bkmn
4240+
notices:
4241+
items:
4242+
$ref: '#/components/schemas/DownloadPlanNotice'
4243+
type: array
4244+
x-stoplight:
4245+
id: t3fjvjkc5p6to
4246+
unsupported:
4247+
description: "A list of features which were unsupported (not passed into\
4248+
\ the 'supported' query paramter) which were needed, resulting in the\
4249+
\ plan level being downgraded to 'manual'."
4250+
items:
4251+
type: string
4252+
x-stoplight:
4253+
id: j2dq6vu86j175
4254+
type: array
4255+
x-stoplight:
4256+
id: 7x1664z1kvmol
4257+
requires_empty_server:
4258+
description: Whether the server files must be empty before exeucting the
4259+
plan steps.
4260+
type: string
4261+
x-stoplight:
4262+
id: 7pifmmlvmdhef
4263+
required:
4264+
- level
4265+
title: DownloadPlan
4266+
type: object
4267+
x-stoplight:
4268+
id: 7giuqnr10mgsh
4269+
DownloadPlanAction:
4270+
example:
4271+
dst: dst
4272+
src: src
4273+
type: copy
4274+
actions:
4275+
- null
4276+
- null
4277+
properties:
4278+
type:
4279+
enum:
4280+
- copy
4281+
- copy_dir
4282+
- open_zip
4283+
- server_restart
4284+
type: string
4285+
x-stoplight:
4286+
id: l7tau0e28hzs6
4287+
src:
4288+
description: The source file/directory.
4289+
type: string
4290+
x-stoplight:
4291+
id: wk4u2tuep42o9
4292+
dst:
4293+
description: A destination file/directory relative to the server root.
4294+
type: string
4295+
x-stoplight:
4296+
id: srmj1ev4o7ezv
4297+
actions:
4298+
description: A set of subactions to execute in the context of this action.
4299+
items:
4300+
$ref: '#/components/schemas/DownloadPlanAction'
4301+
type: array
4302+
x-stoplight:
4303+
id: ti95r5527xvdk
4304+
required:
4305+
- type
4306+
title: DownloadPlanAction
4307+
type: object
4308+
x-stoplight:
4309+
id: havbrhcd79uct
4310+
DownloadPlanNotice:
4311+
example:
4312+
text: text
4313+
properties:
4314+
text:
4315+
type: string
4316+
x-stoplight:
4317+
id: nx2h224oy1tzl
4318+
required:
4319+
- text
4320+
title: DownloadPlanNotice
4321+
type: object
4322+
x-stoplight:
4323+
id: kdsrcoxgjvyyt
41464324
get_oauth2_token_request:
41474325
properties:
41484326
grant_type:
@@ -13014,6 +13192,72 @@ components:
1301413192
- api_asset_id
1301513193
- file
1301613194
type: object
13195+
get_v2_resources_discover_download_plan_200_response_data:
13196+
example:
13197+
plan:
13198+
notices:
13199+
- text: text
13200+
- text: text
13201+
unsupported:
13202+
- unsupported
13203+
- unsupported
13204+
requires_empty_server: requires_empty_server
13205+
level: full
13206+
actions:
13207+
- dst: dst
13208+
src: src
13209+
type: copy
13210+
actions:
13211+
- null
13212+
- null
13213+
- dst: dst
13214+
src: src
13215+
type: copy
13216+
actions:
13217+
- null
13218+
- null
13219+
properties:
13220+
plan:
13221+
$ref: '#/components/schemas/DownloadPlan'
13222+
type: object
13223+
x-stoplight:
13224+
id: bmykdensz0kww
13225+
get_v2_resources_discover_download_plan_200_response:
13226+
example:
13227+
result: success
13228+
data:
13229+
plan:
13230+
notices:
13231+
- text: text
13232+
- text: text
13233+
unsupported:
13234+
- unsupported
13235+
- unsupported
13236+
requires_empty_server: requires_empty_server
13237+
level: full
13238+
actions:
13239+
- dst: dst
13240+
src: src
13241+
type: copy
13242+
actions:
13243+
- null
13244+
- null
13245+
- dst: dst
13246+
src: src
13247+
type: copy
13248+
actions:
13249+
- null
13250+
- null
13251+
properties:
13252+
result:
13253+
enum:
13254+
- success
13255+
type: string
13256+
x-stoplight:
13257+
id: 21hfwvzfexvq4
13258+
data:
13259+
$ref: '#/components/schemas/get_v2_resources_discover_download_plan_200_response_data'
13260+
type: object
1301713261
Analytic_filters_value:
1301813262
example:
1301913263
type: type

‎docs/DownloadPlan.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
3+
# DownloadPlan
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**level** | [**LevelEnum**](#LevelEnum) | | |
11+
|**actions** | [**List<DownloadPlanAction>**](DownloadPlanAction.md) | | [optional] |
12+
|**notices** | [**List<DownloadPlanNotice>**](DownloadPlanNotice.md) | | [optional] |
13+
|**unsupported** | **List<String>** | A list of features which were unsupported (not passed into the 'supported' query paramter) which were needed, resulting in the plan level being downgraded to 'manual'. | [optional] |
14+
|**requiresEmptyServer** | **String** | Whether the server files must be empty before exeucting the plan steps. | [optional] |
15+
16+
17+
18+
## Enum: LevelEnum
19+
20+
| Name | Value |
21+
|---- | -----|
22+
| FULL | "full" |
23+
| PARTIAL | "partial" |
24+
| MANUAL | "manual" |
25+
26+
27+

‎docs/DownloadPlanAction.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
3+
# DownloadPlanAction
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**type** | [**TypeEnum**](#TypeEnum) | | |
11+
|**src** | **String** | The source file/directory. | [optional] |
12+
|**dst** | **String** | A destination file/directory relative to the server root. | [optional] |
13+
|**actions** | [**List<DownloadPlanAction>**](DownloadPlanAction.md) | A set of subactions to execute in the context of this action. | [optional] |
14+
15+
16+
17+
## Enum: TypeEnum
18+
19+
| Name | Value |
20+
|---- | -----|
21+
| COPY | "copy" |
22+
| COPY_DIR | "copy_dir" |
23+
| OPEN_ZIP | "open_zip" |
24+
| SERVER_RESTART | "server_restart" |
25+
26+
27+

‎docs/DownloadPlanNotice.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
3+
# DownloadPlanNotice
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**text** | **String** | | |
11+
12+
13+
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
3+
# GetV2ResourcesDiscoverDownloadPlan200Response
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**result** | [**ResultEnum**](#ResultEnum) | | [optional] |
11+
|**data** | [**GetV2ResourcesDiscoverDownloadPlan200ResponseData**](GetV2ResourcesDiscoverDownloadPlan200ResponseData.md) | | [optional] |
12+
13+
14+
15+
## Enum: ResultEnum
16+
17+
| Name | Value |
18+
|---- | -----|
19+
| SUCCESS | "success" |
20+
21+
22+

0 commit comments

Comments
 (0)