Skip to content

Commit 7664373

Browse files
actions-useractions-user
committed
Auto-generate wrapper from updated spec
1 parent 8ce281b commit 7664373

11 files changed

Lines changed: 1338 additions & 437 deletions

‎README.md‎

Lines changed: 3 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+
*DefaultApi* | [**getV2MembersSelf**](docs/Api/DefaultApi.md#getv2membersself) | **GET** /v2/members/self | Fetch self member information
8788
*DeploymentsApi* | [**postV2DeploymentsUpgrade**](docs/Api/DeploymentsApi.md#postv2deploymentsupgrade) | **POST** /v2/deployments/upgrade | Upgrade a short-lived token
8889
*EventsApi* | [**getV2Events**](docs/Api/EventsApi.md#getv2events) | **GET** /v2/events | Fetch a list of pending events
8990
*EventsApi* | [**postV2EventsComplete**](docs/Api/EventsApi.md#postv2eventscomplete) | **POST** /v2/events/complete | Mark events as complete
@@ -169,6 +170,8 @@ Class | Method | HTTP request | Description
169170
- [GetV2Events200Response](docs/Model/GetV2Events200Response.md)
170171
- [GetV2Events200ResponseData](docs/Model/GetV2Events200ResponseData.md)
171172
- [GetV2Health200Response](docs/Model/GetV2Health200Response.md)
173+
- [GetV2MembersSelf200Response](docs/Model/GetV2MembersSelf200Response.md)
174+
- [GetV2MembersSelf200ResponseData](docs/Model/GetV2MembersSelf200ResponseData.md)
172175
- [GetV2ResourcesCreatorAddons200Response](docs/Model/GetV2ResourcesCreatorAddons200Response.md)
173176
- [GetV2ResourcesCreatorAddons200ResponseData](docs/Model/GetV2ResourcesCreatorAddons200ResponseData.md)
174177
- [GetV2ResourcesCreatorBatch200Response](docs/Model/GetV2ResourcesCreatorBatch200Response.md)

‎docs/Api/DefaultApi.md‎

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

55
| Method | HTTP request | Description |
66
| ------------- | ------------- | ------------- |
7-
| [**getV2ResourcesCreatorBatch()**](DefaultApi.md#getV2ResourcesCreatorBatch) | **GET** /v2/resources/creator/batch | Fetch a list of your batches edits |
8-
| [**postV2ResourcesCreatorBatch()**](DefaultApi.md#postV2ResourcesCreatorBatch) | **POST** /v2/resources/creator/batch | Submit a new batch edit |
7+
| [**getV2MembersSelf()**](DefaultApi.md#getV2MembersSelf) | **GET** /v2/members/self | Fetch self member information |
98

109

11-
## `getV2ResourcesCreatorBatch()`
10+
## `getV2MembersSelf()`
1211

1312
```php
14-
getV2ResourcesCreatorBatch($batch_ids): \OpenAPI\Client\Model\GetV2ResourcesCreatorBatch200Response
13+
getV2MembersSelf(): \OpenAPI\Client\Model\GetV2MembersSelf200Response
1514
```
1615

17-
Fetch a list of your batches edits
16+
Fetch self member information
17+
18+
See: https://builtbybit.com/help/developers/global-apis/members/
1819

1920
### Example
2021

@@ -23,6 +24,9 @@ Fetch a list of your batches edits
2324
require_once(__DIR__ . '/vendor/autoload.php');
2425

2526

27+
// Configure OAuth2 access token for authorization: oauth2
28+
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
29+
2630
// Configure API key authorization: token
2731
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
2832
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
@@ -35,29 +39,26 @@ $apiInstance = new OpenAPI\Client\Api\DefaultApi(
3539
new GuzzleHttp\Client(),
3640
$config
3741
);
38-
$batch_ids = NULL; // array | A comma-separated list of batch IDs to filter on. No filter is applied if empty.
3942

4043
try {
41-
$result = $apiInstance->getV2ResourcesCreatorBatch($batch_ids);
44+
$result = $apiInstance->getV2MembersSelf();
4245
print_r($result);
4346
} catch (Exception $e) {
44-
echo 'Exception when calling DefaultApi->getV2ResourcesCreatorBatch: ', $e->getMessage(), PHP_EOL;
47+
echo 'Exception when calling DefaultApi->getV2MembersSelf: ', $e->getMessage(), PHP_EOL;
4548
}
4649
```
4750

4851
### Parameters
4952

50-
| Name | Type | Description | Notes |
51-
| ------------- | ------------- | ------------- | ------------- |
52-
| **batch_ids** | [**array**](../Model/.md)| A comma-separated list of batch IDs to filter on. No filter is applied if empty. | [optional] |
53+
This endpoint does not need any parameter.
5354

5455
### Return type
5556

56-
[**\OpenAPI\Client\Model\GetV2ResourcesCreatorBatch200Response**](../Model/GetV2ResourcesCreatorBatch200Response.md)
57+
[**\OpenAPI\Client\Model\GetV2MembersSelf200Response**](../Model/GetV2MembersSelf200Response.md)
5758

5859
### Authorization
5960

60-
[token](../../README.md#token)
61+
[oauth2](../../README.md#oauth2), [token](../../README.md#token)
6162

6263
### HTTP request headers
6364

@@ -67,59 +68,3 @@ try {
6768
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
6869
[[Back to Model list]](../../README.md#models)
6970
[[Back to README]](../../README.md)
70-
71-
## `postV2ResourcesCreatorBatch()`
72-
73-
```php
74-
postV2ResourcesCreatorBatch($post_v2_resources_creator_batch_request): \OpenAPI\Client\Model\PostV2ResourcesCreatorBatch200Response
75-
```
76-
77-
Submit a new batch edit
78-
79-
Batch edits will be processed in the background meaning a successful call to this endpoint does not guarantee that the edits have been completed. You will instead receive an identifier to a batch edit which you can then use to fetch the status of via the below endpoint. This is not an atomic operation meaning some resources may be edited successfully and others may not be due to an error. You may only batch edit resources you own currently.
80-
81-
### Example
82-
83-
```php
84-
<?php
85-
require_once(__DIR__ . '/vendor/autoload.php');
86-
87-
88-
89-
$apiInstance = new OpenAPI\Client\Api\DefaultApi(
90-
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
91-
// This is optional, `GuzzleHttp\Client` will be used as default.
92-
new GuzzleHttp\Client()
93-
);
94-
$post_v2_resources_creator_batch_request = new \OpenAPI\Client\Model\PostV2ResourcesCreatorBatchRequest(); // \OpenAPI\Client\Model\PostV2ResourcesCreatorBatchRequest
95-
96-
try {
97-
$result = $apiInstance->postV2ResourcesCreatorBatch($post_v2_resources_creator_batch_request);
98-
print_r($result);
99-
} catch (Exception $e) {
100-
echo 'Exception when calling DefaultApi->postV2ResourcesCreatorBatch: ', $e->getMessage(), PHP_EOL;
101-
}
102-
```
103-
104-
### Parameters
105-
106-
| Name | Type | Description | Notes |
107-
| ------------- | ------------- | ------------- | ------------- |
108-
| **post_v2_resources_creator_batch_request** | [**\OpenAPI\Client\Model\PostV2ResourcesCreatorBatchRequest**](../Model/PostV2ResourcesCreatorBatchRequest.md)| | [optional] |
109-
110-
### Return type
111-
112-
[**\OpenAPI\Client\Model\PostV2ResourcesCreatorBatch200Response**](../Model/PostV2ResourcesCreatorBatch200Response.md)
113-
114-
### Authorization
115-
116-
No authorization required
117-
118-
### HTTP request headers
119-
120-
- **Content-Type**: `application/json`
121-
- **Accept**: `application/json`
122-
123-
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
124-
[[Back to Model list]](../../README.md#models)
125-
[[Back to README]](../../README.md)

‎docs/Model/GetV2MembersSelf200Response.md‎

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

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

‎docs/Model/Member.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,13 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**user_id** | **string** | | [optional]
8+
**user_url** | **string** | | [optional]
89
**username** | **string** | | [optional]
910
**registered_at** | **string** | | [optional]
10-
**avatar_url** | **string** | | [optional]
11+
**avatar_url_large** | **string** | | [optional]
12+
**avatar_url_medium** | **string** | | [optional]
13+
**avatar_url_small** | **string** | | [optional]
14+
**banned** | **bool** | | [optional]
15+
**discord_id** | **string** | | [optional]
1116

1217
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

0 commit comments

Comments
 (0)