Skip to content

Commit 375e76c

Browse files
actions-useractions-user
committed
Auto-generate wrapper from updated spec
1 parent 302bb4a commit 375e76c

Some content is hidden

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

45 files changed

+7016
-1055
lines changed

‎README.md‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,18 +59,18 @@ $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Au
5959
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
6060

6161

62-
$apiInstance = new OpenAPI\Client\Api\GlobalApi(
62+
$apiInstance = new OpenAPI\Client\Api\DefaultApi(
6363
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
6464
// This is optional, `GuzzleHttp\Client` will be used as default.
6565
new GuzzleHttp\Client(),
6666
$config
6767
);
6868

6969
try {
70-
$result = $apiInstance->getV2Analytics();
70+
$result = $apiInstance->getV2Health();
7171
print_r($result);
7272
} catch (Exception $e) {
73-
echo 'Exception when calling GlobalApi->getV2Analytics: ', $e->getMessage(), PHP_EOL;
73+
echo 'Exception when calling DefaultApi->getV2Health: ', $e->getMessage(), PHP_EOL;
7474
}
7575

7676
```
@@ -81,6 +81,9 @@ All URIs are relative to *https://api.builtbybit.com*
8181

8282
Class | Method | HTTP request | Description
8383
------------ | ------------- | ------------- | -------------
84+
*DefaultApi* | [**getV2Health**](docs/Api/DefaultApi.md#getv2health) | **GET** /v2/health | Retrieve a health status
85+
*DefaultApi* | [**getV2ResourcesCreatorCoupons**](docs/Api/DefaultApi.md#getv2resourcescreatorcoupons) | **GET** /v2/resources/creator/coupons | Fetch a list of your coupons
86+
*DefaultApi* | [**getV2ResourcesCreatorStores**](docs/Api/DefaultApi.md#getv2resourcescreatorstores) | **GET** /v2/resources/creator/stores | Fetch a list of your stores
8487
*GlobalApi* | [**getV2Analytics**](docs/Api/GlobalApi.md#getv2analytics) | **GET** /v2/analytics | Fetch a list of analytics definitions
8588
*GlobalApi* | [**getV2AnalyticsGraph**](docs/Api/GlobalApi.md#getv2analyticsgraph) | **GET** /v2/analytics/graph | Fetch analytics graph data
8689
*GlobalApi* | [**getV2AnalyticsSingle**](docs/Api/GlobalApi.md#getv2analyticssingle) | **GET** /v2/analytics/single | Fetch a single analytics value
@@ -122,7 +125,7 @@ Class | Method | HTTP request | Description
122125
- [CartItemDiscountsInner](docs/Model/CartItemDiscountsInner.md)
123126
- [CartSummary](docs/Model/CartSummary.md)
124127
- [Category](docs/Model/Category.md)
125-
- [Description](docs/Model/Description.md)
128+
- [Coupon](docs/Model/Coupon.md)
126129
- [Event](docs/Model/Event.md)
127130
- [Filter](docs/Model/Filter.md)
128131
- [FilterChoice](docs/Model/FilterChoice.md)
@@ -143,12 +146,15 @@ Class | Method | HTTP request | Description
143146
- [GetV2AnalyticsSingle200ResponseDataPeriod](docs/Model/GetV2AnalyticsSingle200ResponseDataPeriod.md)
144147
- [GetV2Events200Response](docs/Model/GetV2Events200Response.md)
145148
- [GetV2Events200ResponseData](docs/Model/GetV2Events200ResponseData.md)
149+
- [GetV2Health200Response](docs/Model/GetV2Health200Response.md)
146150
- [GetV2ResourcesBuyerLatest200Response](docs/Model/GetV2ResourcesBuyerLatest200Response.md)
147151
- [GetV2ResourcesBuyerLatest200ResponseData](docs/Model/GetV2ResourcesBuyerLatest200ResponseData.md)
148152
- [GetV2ResourcesCreatorAddons200Response](docs/Model/GetV2ResourcesCreatorAddons200Response.md)
149153
- [GetV2ResourcesCreatorAddons200ResponseData](docs/Model/GetV2ResourcesCreatorAddons200ResponseData.md)
150154
- [GetV2ResourcesCreatorBundles200Response](docs/Model/GetV2ResourcesCreatorBundles200Response.md)
151155
- [GetV2ResourcesCreatorBundles200ResponseData](docs/Model/GetV2ResourcesCreatorBundles200ResponseData.md)
156+
- [GetV2ResourcesCreatorCoupons200Response](docs/Model/GetV2ResourcesCreatorCoupons200Response.md)
157+
- [GetV2ResourcesCreatorCoupons200ResponseData](docs/Model/GetV2ResourcesCreatorCoupons200ResponseData.md)
152158
- [GetV2ResourcesCreatorLicenses200Response](docs/Model/GetV2ResourcesCreatorLicenses200Response.md)
153159
- [GetV2ResourcesCreatorLicenses200ResponseData](docs/Model/GetV2ResourcesCreatorLicenses200ResponseData.md)
154160
- [GetV2ResourcesCreatorPurchases200Response](docs/Model/GetV2ResourcesCreatorPurchases200Response.md)
@@ -159,6 +165,8 @@ Class | Method | HTTP request | Description
159165
- [GetV2ResourcesCreatorReviews200ResponseData](docs/Model/GetV2ResourcesCreatorReviews200ResponseData.md)
160166
- [GetV2ResourcesCreatorSaleEvents200Response](docs/Model/GetV2ResourcesCreatorSaleEvents200Response.md)
161167
- [GetV2ResourcesCreatorSaleEvents200ResponseData](docs/Model/GetV2ResourcesCreatorSaleEvents200ResponseData.md)
168+
- [GetV2ResourcesCreatorStores200Response](docs/Model/GetV2ResourcesCreatorStores200Response.md)
169+
- [GetV2ResourcesCreatorStores200ResponseData](docs/Model/GetV2ResourcesCreatorStores200ResponseData.md)
162170
- [GetV2ResourcesCreatorUpdates200Response](docs/Model/GetV2ResourcesCreatorUpdates200Response.md)
163171
- [GetV2ResourcesCreatorUpdates200ResponseData](docs/Model/GetV2ResourcesCreatorUpdates200ResponseData.md)
164172
- [GetV2ResourcesCreatorVersions200Response](docs/Model/GetV2ResourcesCreatorVersions200Response.md)
@@ -191,8 +199,10 @@ Class | Method | HTTP request | Description
191199
- [Purchase](docs/Model/Purchase.md)
192200
- [Resource](docs/Model/Resource.md)
193201
- [Review](docs/Model/Review.md)
202+
- [RichText](docs/Model/RichText.md)
194203
- [SaleEvent](docs/Model/SaleEvent.md)
195204
- [SaleEventEntry](docs/Model/SaleEventEntry.md)
205+
- [Store](docs/Model/Store.md)
196206
- [Update](docs/Model/Update.md)
197207
- [Version](docs/Model/Version.md)
198208

‎docs/Api/DefaultApi.md‎

Lines changed: 45 additions & 152 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,18 @@ All URIs are relative to https://api.builtbybit.com, except if the operation def
44

55
| Method | HTTP request | Description |
66
| ------------- | ------------- | ------------- |
7-
| [**getV2Analytics()**](DefaultApi.md#getV2Analytics) | **GET** /v2/analytics | Fetch a list of analytics definitions |
8-
| [**getV2AnalyticsGraph()**](DefaultApi.md#getV2AnalyticsGraph) | **GET** /v2/analytics/graph | Fetch analytics graph data |
9-
| [**getV2Events()**](DefaultApi.md#getV2Events) | **GET** /v2/events | Fetch a list of pending events |
10-
| [**postV2EventsComplete()**](DefaultApi.md#postV2EventsComplete) | **POST** /v2/events/complete | Mark events as complete |
11-
| [**postV2ResourcesCreatorUpdate()**](DefaultApi.md#postV2ResourcesCreatorUpdate) | **POST** /v2/resources/creator/update | Post a resource update |
7+
| [**getV2Health()**](DefaultApi.md#getV2Health) | **GET** /v2/health | Retrieve a health status |
8+
| [**getV2ResourcesCreatorCoupons()**](DefaultApi.md#getV2ResourcesCreatorCoupons) | **GET** /v2/resources/creator/coupons | Fetch a list of your coupons |
9+
| [**getV2ResourcesCreatorStores()**](DefaultApi.md#getV2ResourcesCreatorStores) | **GET** /v2/resources/creator/stores | Fetch a list of your stores |
1210

1311

14-
## `getV2Analytics()`
12+
## `getV2Health()`
1513

1614
```php
17-
getV2Analytics(): \OpenAPI\Client\Model\GetV2Analytics200Response
15+
getV2Health(): \OpenAPI\Client\Model\GetV2Health200Response
1816
```
1917

20-
Fetch a list of analytics definitions
18+
Retrieve a health status
2119

2220
### Example
2321

@@ -26,18 +24,24 @@ Fetch a list of analytics definitions
2624
require_once(__DIR__ . '/vendor/autoload.php');
2725

2826

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+
2932

3033
$apiInstance = new OpenAPI\Client\Api\DefaultApi(
3134
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
3235
// This is optional, `GuzzleHttp\Client` will be used as default.
33-
new GuzzleHttp\Client()
36+
new GuzzleHttp\Client(),
37+
$config
3438
);
3539

3640
try {
37-
$result = $apiInstance->getV2Analytics();
41+
$result = $apiInstance->getV2Health();
3842
print_r($result);
3943
} catch (Exception $e) {
40-
echo 'Exception when calling DefaultApi->getV2Analytics: ', $e->getMessage(), PHP_EOL;
44+
echo 'Exception when calling DefaultApi->getV2Health: ', $e->getMessage(), PHP_EOL;
4145
}
4246
```
4347

@@ -47,11 +51,11 @@ This endpoint does not need any parameter.
4751

4852
### Return type
4953

50-
[**\OpenAPI\Client\Model\GetV2Analytics200Response**](../Model/GetV2Analytics200Response.md)
54+
[**\OpenAPI\Client\Model\GetV2Health200Response**](../Model/GetV2Health200Response.md)
5155

5256
### Authorization
5357

54-
No authorization required
58+
[token](../../README.md#token)
5559

5660
### HTTP request headers
5761

@@ -62,13 +66,13 @@ No authorization required
6266
[[Back to Model list]](../../README.md#models)
6367
[[Back to README]](../../README.md)
6468

65-
## `getV2AnalyticsGraph()`
69+
## `getV2ResourcesCreatorCoupons()`
6670

6771
```php
68-
getV2AnalyticsGraph($analytics, $period, $grouping, $filters, $start_date, $end_date): \OpenAPI\Client\Model\GetV2AnalyticsGraph200Response
72+
getV2ResourcesCreatorCoupons(): \OpenAPI\Client\Model\GetV2ResourcesCreatorCoupons200Response
6973
```
7074

71-
Fetch analytics graph data
75+
Fetch a list of your coupons
7276

7377
### Example
7478

@@ -77,82 +81,24 @@ Fetch analytics graph data
7781
require_once(__DIR__ . '/vendor/autoload.php');
7882

7983

80-
81-
$apiInstance = new OpenAPI\Client\Api\DefaultApi(
82-
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
83-
// This is optional, `GuzzleHttp\Client` will be used as default.
84-
new GuzzleHttp\Client()
85-
);
86-
$analytics = NULL; // array
87-
$period = 'period_example'; // string
88-
$grouping = 'grouping_example'; // string
89-
$filters = 'filters_example'; // string
90-
$start_date = 'start_date_example'; // string | Only respected when 'period' = 'custom_range'.
91-
$end_date = 'end_date_example'; // string | Only respected when 'period' = 'custom_range'.
92-
93-
try {
94-
$result = $apiInstance->getV2AnalyticsGraph($analytics, $period, $grouping, $filters, $start_date, $end_date);
95-
print_r($result);
96-
} catch (Exception $e) {
97-
echo 'Exception when calling DefaultApi->getV2AnalyticsGraph: ', $e->getMessage(), PHP_EOL;
98-
}
99-
```
100-
101-
### Parameters
102-
103-
| Name | Type | Description | Notes |
104-
| ------------- | ------------- | ------------- | ------------- |
105-
| **analytics** | [**array**](../Model/.md)| | [optional] |
106-
| **period** | **string**| | [optional] |
107-
| **grouping** | **string**| | [optional] |
108-
| **filters** | **string**| | [optional] |
109-
| **start_date** | **string**| Only respected when 'period' = 'custom_range'. | [optional] |
110-
| **end_date** | **string**| Only respected when 'period' = 'custom_range'. | [optional] |
111-
112-
### Return type
113-
114-
[**\OpenAPI\Client\Model\GetV2AnalyticsGraph200Response**](../Model/GetV2AnalyticsGraph200Response.md)
115-
116-
### Authorization
117-
118-
No authorization required
119-
120-
### HTTP request headers
121-
122-
- **Content-Type**: Not defined
123-
- **Accept**: `application/json`
124-
125-
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
126-
[[Back to Model list]](../../README.md#models)
127-
[[Back to README]](../../README.md)
128-
129-
## `getV2Events()`
130-
131-
```php
132-
getV2Events(): \OpenAPI\Client\Model\GetV2Events200Response
133-
```
134-
135-
Fetch a list of pending events
136-
137-
### Example
138-
139-
```php
140-
<?php
141-
require_once(__DIR__ . '/vendor/autoload.php');
142-
84+
// Configure API key authorization: token
85+
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
86+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
87+
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
14388

14489

14590
$apiInstance = new OpenAPI\Client\Api\DefaultApi(
14691
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14792
// This is optional, `GuzzleHttp\Client` will be used as default.
148-
new GuzzleHttp\Client()
93+
new GuzzleHttp\Client(),
94+
$config
14995
);
15096

15197
try {
152-
$result = $apiInstance->getV2Events();
98+
$result = $apiInstance->getV2ResourcesCreatorCoupons();
15399
print_r($result);
154100
} catch (Exception $e) {
155-
echo 'Exception when calling DefaultApi->getV2Events: ', $e->getMessage(), PHP_EOL;
101+
echo 'Exception when calling DefaultApi->getV2ResourcesCreatorCoupons: ', $e->getMessage(), PHP_EOL;
156102
}
157103
```
158104

@@ -162,11 +108,11 @@ This endpoint does not need any parameter.
162108

163109
### Return type
164110

165-
[**\OpenAPI\Client\Model\GetV2Events200Response**](../Model/GetV2Events200Response.md)
111+
[**\OpenAPI\Client\Model\GetV2ResourcesCreatorCoupons200Response**](../Model/GetV2ResourcesCreatorCoupons200Response.md)
166112

167113
### Authorization
168114

169-
No authorization required
115+
[token](../../README.md#token)
170116

171117
### HTTP request headers
172118

@@ -177,13 +123,13 @@ No authorization required
177123
[[Back to Model list]](../../README.md#models)
178124
[[Back to README]](../../README.md)
179125

180-
## `postV2EventsComplete()`
126+
## `getV2ResourcesCreatorStores()`
181127

182128
```php
183-
postV2EventsComplete($post_v2_events_complete_request): \OpenAPI\Client\Model\PostV2EventsComplete200Response
129+
getV2ResourcesCreatorStores(): \OpenAPI\Client\Model\GetV2ResourcesCreatorStores200Response
184130
```
185131

186-
Mark events as complete
132+
Fetch a list of your stores
187133

188134
### Example
189135

@@ -192,95 +138,42 @@ Mark events as complete
192138
require_once(__DIR__ . '/vendor/autoload.php');
193139

194140

195-
196-
$apiInstance = new OpenAPI\Client\Api\DefaultApi(
197-
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
198-
// This is optional, `GuzzleHttp\Client` will be used as default.
199-
new GuzzleHttp\Client()
200-
);
201-
$post_v2_events_complete_request = new \OpenAPI\Client\Model\PostV2EventsCompleteRequest(); // \OpenAPI\Client\Model\PostV2EventsCompleteRequest
202-
203-
try {
204-
$result = $apiInstance->postV2EventsComplete($post_v2_events_complete_request);
205-
print_r($result);
206-
} catch (Exception $e) {
207-
echo 'Exception when calling DefaultApi->postV2EventsComplete: ', $e->getMessage(), PHP_EOL;
208-
}
209-
```
210-
211-
### Parameters
212-
213-
| Name | Type | Description | Notes |
214-
| ------------- | ------------- | ------------- | ------------- |
215-
| **post_v2_events_complete_request** | [**\OpenAPI\Client\Model\PostV2EventsCompleteRequest**](../Model/PostV2EventsCompleteRequest.md)| | [optional] |
216-
217-
### Return type
218-
219-
[**\OpenAPI\Client\Model\PostV2EventsComplete200Response**](../Model/PostV2EventsComplete200Response.md)
220-
221-
### Authorization
222-
223-
No authorization required
224-
225-
### HTTP request headers
226-
227-
- **Content-Type**: `application/json`
228-
- **Accept**: `application/json`
229-
230-
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
231-
[[Back to Model list]](../../README.md#models)
232-
[[Back to README]](../../README.md)
233-
234-
## `postV2ResourcesCreatorUpdate()`
235-
236-
```php
237-
postV2ResourcesCreatorUpdate($post_v2_resources_creator_update_request): \OpenAPI\Client\Model\PostV2ResourcesCreatorUpdate200Response
238-
```
239-
240-
Post a resource update
241-
242-
Creates a new version for the resource and optionally posts a public update message. The uploaded file must be encoded using base64 as part of the JSON request body shown below. The request body (including the base64 encoded file data) cannot exceed 100MB. This roughly equates to a 67MB upload limit for the raw file when taking into account base64 encoding losses.
243-
244-
### Example
245-
246-
```php
247-
<?php
248-
require_once(__DIR__ . '/vendor/autoload.php');
249-
141+
// Configure API key authorization: token
142+
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
143+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
144+
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
250145

251146

252147
$apiInstance = new OpenAPI\Client\Api\DefaultApi(
253148
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
254149
// This is optional, `GuzzleHttp\Client` will be used as default.
255-
new GuzzleHttp\Client()
150+
new GuzzleHttp\Client(),
151+
$config
256152
);
257-
$post_v2_resources_creator_update_request = new \OpenAPI\Client\Model\PostV2ResourcesCreatorUpdateRequest(); // \OpenAPI\Client\Model\PostV2ResourcesCreatorUpdateRequest
258153

259154
try {
260-
$result = $apiInstance->postV2ResourcesCreatorUpdate($post_v2_resources_creator_update_request);
155+
$result = $apiInstance->getV2ResourcesCreatorStores();
261156
print_r($result);
262157
} catch (Exception $e) {
263-
echo 'Exception when calling DefaultApi->postV2ResourcesCreatorUpdate: ', $e->getMessage(), PHP_EOL;
158+
echo 'Exception when calling DefaultApi->getV2ResourcesCreatorStores: ', $e->getMessage(), PHP_EOL;
264159
}
265160
```
266161

267162
### Parameters
268163

269-
| Name | Type | Description | Notes |
270-
| ------------- | ------------- | ------------- | ------------- |
271-
| **post_v2_resources_creator_update_request** | [**\OpenAPI\Client\Model\PostV2ResourcesCreatorUpdateRequest**](../Model/PostV2ResourcesCreatorUpdateRequest.md)| | [optional] |
164+
This endpoint does not need any parameter.
272165

273166
### Return type
274167

275-
[**\OpenAPI\Client\Model\PostV2ResourcesCreatorUpdate200Response**](../Model/PostV2ResourcesCreatorUpdate200Response.md)
168+
[**\OpenAPI\Client\Model\GetV2ResourcesCreatorStores200Response**](../Model/GetV2ResourcesCreatorStores200Response.md)
276169

277170
### Authorization
278171

279-
No authorization required
172+
[token](../../README.md#token)
280173

281174
### HTTP request headers
282175

283-
- **Content-Type**: `application/json`
176+
- **Content-Type**: Not defined
284177
- **Accept**: `application/json`
285178

286179
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)

0 commit comments

Comments
 (0)