Skip to content

Commit 079128b

Browse files
actions-useractions-user
committed
Auto-generate wrapper from updated spec
1 parent 56caf50 commit 079128b

15 files changed

Lines changed: 1093 additions & 134 deletions

‎README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,13 @@ Class | Method | HTTP request | Description
156156
*BuiltByBitApi.ResourcesCreatorApi* | [**postV2ResourcesCreatorBatch**](docs/ResourcesCreatorApi.md#postV2ResourcesCreatorBatch) | **POST** /v2/resources/creator/batch | Submit a new batch edit
157157
*BuiltByBitApi.ResourcesCreatorApi* | [**postV2ResourcesCreatorCoupons**](docs/ResourcesCreatorApi.md#postV2ResourcesCreatorCoupons) | **POST** /v2/resources/creator/coupons | Create a new coupon
158158
*BuiltByBitApi.ResourcesCreatorApi* | [**postV2ResourcesCreatorUpdate**](docs/ResourcesCreatorApi.md#postV2ResourcesCreatorUpdate) | **POST** /v2/resources/creator/update | Post a resource update
159+
*BuiltByBitApi.ResourcesCreatorBundlesApi* | [**getV2ResourcesCreatorBundles**](docs/ResourcesCreatorBundlesApi.md#getV2ResourcesCreatorBundles) | **GET** /v2/resources/creator/bundles | Fetch a list of your bundles
160+
*BuiltByBitApi.ResourcesCreatorBundlesApi* | [**getV2ResourcesCreatorBundlesEntries**](docs/ResourcesCreatorBundlesApi.md#getV2ResourcesCreatorBundlesEntries) | **GET** /v2/resources/creator/bundles/entries | Fetch a list of your bundle entries
161+
*BuiltByBitApi.ResourcesCreatorCouponsApi* | [**getV2ResourcesCreatorCoupons**](docs/ResourcesCreatorCouponsApi.md#getV2ResourcesCreatorCoupons) | **GET** /v2/resources/creator/coupons | Fetch a list of your coupons
162+
*BuiltByBitApi.ResourcesCreatorCouponsApi* | [**getV2ResourcesCreatorCouponsEntries**](docs/ResourcesCreatorCouponsApi.md#getV2ResourcesCreatorCouponsEntries) | **GET** /v2/resources/creator/coupons/entries | Fetch a list of your coupon entries
163+
*BuiltByBitApi.ResourcesCreatorCouponsApi* | [**postV2ResourcesCreatorCoupons**](docs/ResourcesCreatorCouponsApi.md#postV2ResourcesCreatorCoupons) | **POST** /v2/resources/creator/coupons | Create a new coupon
164+
*BuiltByBitApi.ResourcesCreatorSaleEventsApi* | [**getV2ResourcesCreatorSaleEvents**](docs/ResourcesCreatorSaleEventsApi.md#getV2ResourcesCreatorSaleEvents) | **GET** /v2/resources/creator/sale-events | Fetch a list of your sale events
165+
*BuiltByBitApi.ResourcesCreatorSaleEventsApi* | [**getV2ResourcesCreatorSaleEventsEntries**](docs/ResourcesCreatorSaleEventsApi.md#getV2ResourcesCreatorSaleEventsEntries) | **GET** /v2/resources/creator/sale-events/entries | Fetch a list of your sale event entries
159166
*BuiltByBitApi.ResourcesDiscoveryApi* | [**getResourcesDiscoverCategories**](docs/ResourcesDiscoveryApi.md#getResourcesDiscoverCategories) | **GET** /v2/resources/discover/categories | Fetch a list of categories
160167
*BuiltByBitApi.ResourcesDiscoveryApi* | [**getResourcesDiscoverResources**](docs/ResourcesDiscoveryApi.md#getResourcesDiscoverResources) | **GET** /v2/resources/discover/resources | Fetch a list of resources
161168
*BuiltByBitApi.ResourcesDiscoveryApi* | [**getV2ResourcesDiscoverCartView**](docs/ResourcesDiscoveryApi.md#getV2ResourcesDiscoverCartView) | **GET** /v2/resources/discover/cart/view | View the user's cart items
@@ -179,7 +186,6 @@ Class | Method | HTTP request | Description
179186
- [BuiltByBitApi.Bundle](docs/Bundle.md)
180187
- [BuiltByBitApi.BundleEntry](docs/BundleEntry.md)
181188
- [BuiltByBitApi.CartItem](docs/CartItem.md)
182-
- [BuiltByBitApi.CartItemDiscountsInner](docs/CartItemDiscountsInner.md)
183189
- [BuiltByBitApi.CartSummary](docs/CartSummary.md)
184190
- [BuiltByBitApi.Category](docs/Category.md)
185191
- [BuiltByBitApi.Coupon](docs/Coupon.md)

‎docs/CartItem.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,8 @@ Name | Type | Description | Notes
1010
**contentTitle** | **String** | | [optional]
1111
**contentSummary** | **String** | | [optional]
1212
**contentCoverImageUrl** | **String** | | [optional]
13-
**listPrice** | **Number** | | [optional]
14-
**listPriceFormatted** | **String** | | [optional]
15-
**finalPrice** | **Number** | | [optional]
16-
**finalPriceFormatted** | **String** | | [optional]
17-
**discounts** | [**[CartItemDiscountsInner]**](CartItemDiscountsInner.md) | | [optional]
13+
**listPrice** | [**Price**](Price.md) | | [optional]
14+
**finalPrice** | [**Price**](Price.md) | | [optional]
15+
**discounts** | [**{String: Price}**](Price.md) | | [optional]
1816

1917

‎docs/CartSummary.md‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,8 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**listPrice** | **Number** | The combined listed price of all items in the cart (ie. the original prices without any discounts applied). |
8-
**listPriceFormatted** | **String** | The list price formatted as a string using the given currency. A list price of 5 would be formatted as `$5.00`. |
9-
**finalPrice** | **Number** | The combined final price of all items in the cart (ie. with discounts applied). This is the subtotal the user would pay upon checkout initiation, minus any applicable sales tax. |
10-
**finalPriceFormatted** | **String** | The final price formatted as a string using the given currency. A final price of 5 would be formatted as `$5.00`. |
11-
**currency** | **String** | The currency code (ISO 4217) of the prices in this summary. Will be USD for all transactions through BuiltByBit. |
127
**notice** | **String** | A message to display to the user as a notice regarding their current cart items. We may use this to inform the user that they have a previous pending checkout which is yet to be fulfilled (either because the payment is still pending or because they closed out of the checkout). | [optional]
8+
**listPrice** | [**Price**](Price.md) | | [optional]
9+
**finalPrice** | [**Price**](Price.md) | | [optional]
1310

1411

‎docs/ResourcesCreatorBundlesApi.md‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# BuiltByBitApi.ResourcesCreatorBundlesApi
2+
3+
All URIs are relative to *https://api.builtbybit.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**getV2ResourcesCreatorBundles**](ResourcesCreatorBundlesApi.md#getV2ResourcesCreatorBundles) | **GET** /v2/resources/creator/bundles | Fetch a list of your bundles
8+
[**getV2ResourcesCreatorBundlesEntries**](ResourcesCreatorBundlesApi.md#getV2ResourcesCreatorBundlesEntries) | **GET** /v2/resources/creator/bundles/entries | Fetch a list of your bundle entries
9+
10+
11+
12+
## getV2ResourcesCreatorBundles
13+
14+
> GetV2ResourcesCreatorBundles200Response getV2ResourcesCreatorBundles(opts)
15+
16+
Fetch a list of your bundles
17+
18+
### Example
19+
20+
```javascript
21+
import BuiltByBitApi from 'built_by_bit_api';
22+
let defaultClient = BuiltByBitApi.ApiClient.instance;
23+
// Configure API key authorization: token
24+
let token = defaultClient.authentications['token'];
25+
token.apiKey = 'YOUR API KEY';
26+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
27+
//token.apiKeyPrefix = 'Token';
28+
29+
let apiInstance = new BuiltByBitApi.ResourcesCreatorBundlesApi();
30+
let opts = {
31+
'bundleIds': null // Array | A comma-separated list of bundle IDs to filter on. No filter is applied if empty.
32+
};
33+
apiInstance.getV2ResourcesCreatorBundles(opts, (error, data, response) => {
34+
if (error) {
35+
console.error(error);
36+
} else {
37+
console.log('API called successfully. Returned data: ' + data);
38+
}
39+
});
40+
```
41+
42+
### Parameters
43+
44+
45+
Name | Type | Description | Notes
46+
------------- | ------------- | ------------- | -------------
47+
**bundleIds** | [**Array**](.md)| A comma-separated list of bundle IDs to filter on. No filter is applied if empty. | [optional]
48+
49+
### Return type
50+
51+
[**GetV2ResourcesCreatorBundles200Response**](GetV2ResourcesCreatorBundles200Response.md)
52+
53+
### Authorization
54+
55+
[token](../README.md#token)
56+
57+
### HTTP request headers
58+
59+
- **Content-Type**: Not defined
60+
- **Accept**: application/json
61+
62+
63+
## getV2ResourcesCreatorBundlesEntries
64+
65+
> GetV2ResourcesCreatorBundlesEntries200Response getV2ResourcesCreatorBundlesEntries(opts)
66+
67+
Fetch a list of your bundle entries
68+
69+
### Example
70+
71+
```javascript
72+
import BuiltByBitApi from 'built_by_bit_api';
73+
let defaultClient = BuiltByBitApi.ApiClient.instance;
74+
// Configure API key authorization: token
75+
let token = defaultClient.authentications['token'];
76+
token.apiKey = 'YOUR API KEY';
77+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
78+
//token.apiKeyPrefix = 'Token';
79+
80+
let apiInstance = new BuiltByBitApi.ResourcesCreatorBundlesApi();
81+
let opts = {
82+
'bundleIds': null // Array | A comma-separated list of bundle IDs to filter on. No filter is applied if empty.
83+
};
84+
apiInstance.getV2ResourcesCreatorBundlesEntries(opts, (error, data, response) => {
85+
if (error) {
86+
console.error(error);
87+
} else {
88+
console.log('API called successfully. Returned data: ' + data);
89+
}
90+
});
91+
```
92+
93+
### Parameters
94+
95+
96+
Name | Type | Description | Notes
97+
------------- | ------------- | ------------- | -------------
98+
**bundleIds** | [**Array**](.md)| A comma-separated list of bundle IDs to filter on. No filter is applied if empty. | [optional]
99+
100+
### Return type
101+
102+
[**GetV2ResourcesCreatorBundlesEntries200Response**](GetV2ResourcesCreatorBundlesEntries200Response.md)
103+
104+
### Authorization
105+
106+
[token](../README.md#token)
107+
108+
### HTTP request headers
109+
110+
- **Content-Type**: Not defined
111+
- **Accept**: application/json
112+

‎docs/ResourcesCreatorCouponsApi.md‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
# BuiltByBitApi.ResourcesCreatorCouponsApi
2+
3+
All URIs are relative to *https://api.builtbybit.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**getV2ResourcesCreatorCoupons**](ResourcesCreatorCouponsApi.md#getV2ResourcesCreatorCoupons) | **GET** /v2/resources/creator/coupons | Fetch a list of your coupons
8+
[**getV2ResourcesCreatorCouponsEntries**](ResourcesCreatorCouponsApi.md#getV2ResourcesCreatorCouponsEntries) | **GET** /v2/resources/creator/coupons/entries | Fetch a list of your coupon entries
9+
[**postV2ResourcesCreatorCoupons**](ResourcesCreatorCouponsApi.md#postV2ResourcesCreatorCoupons) | **POST** /v2/resources/creator/coupons | Create a new coupon
10+
11+
12+
13+
## getV2ResourcesCreatorCoupons
14+
15+
> GetV2ResourcesCreatorCoupons200Response getV2ResourcesCreatorCoupons(opts)
16+
17+
Fetch a list of your coupons
18+
19+
### Example
20+
21+
```javascript
22+
import BuiltByBitApi from 'built_by_bit_api';
23+
let defaultClient = BuiltByBitApi.ApiClient.instance;
24+
// Configure API key authorization: token
25+
let token = defaultClient.authentications['token'];
26+
token.apiKey = 'YOUR API KEY';
27+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
28+
//token.apiKeyPrefix = 'Token';
29+
30+
let apiInstance = new BuiltByBitApi.ResourcesCreatorCouponsApi();
31+
let opts = {
32+
'couponIds': null // Array | A comma-separated list of coupon IDs to filter on. No filter is applied if empty.
33+
};
34+
apiInstance.getV2ResourcesCreatorCoupons(opts, (error, data, response) => {
35+
if (error) {
36+
console.error(error);
37+
} else {
38+
console.log('API called successfully. Returned data: ' + data);
39+
}
40+
});
41+
```
42+
43+
### Parameters
44+
45+
46+
Name | Type | Description | Notes
47+
------------- | ------------- | ------------- | -------------
48+
**couponIds** | [**Array**](.md)| A comma-separated list of coupon IDs to filter on. No filter is applied if empty. | [optional]
49+
50+
### Return type
51+
52+
[**GetV2ResourcesCreatorCoupons200Response**](GetV2ResourcesCreatorCoupons200Response.md)
53+
54+
### Authorization
55+
56+
[token](../README.md#token)
57+
58+
### HTTP request headers
59+
60+
- **Content-Type**: Not defined
61+
- **Accept**: application/json
62+
63+
64+
## getV2ResourcesCreatorCouponsEntries
65+
66+
> GetV2ResourcesCreatorCouponsEntries200Response getV2ResourcesCreatorCouponsEntries(opts)
67+
68+
Fetch a list of your coupon entries
69+
70+
### Example
71+
72+
```javascript
73+
import BuiltByBitApi from 'built_by_bit_api';
74+
let defaultClient = BuiltByBitApi.ApiClient.instance;
75+
// Configure API key authorization: token
76+
let token = defaultClient.authentications['token'];
77+
token.apiKey = 'YOUR API KEY';
78+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
79+
//token.apiKeyPrefix = 'Token';
80+
81+
let apiInstance = new BuiltByBitApi.ResourcesCreatorCouponsApi();
82+
let opts = {
83+
'couponIds': null // Array | A comma-separated list of coupon IDs to filter on. No filter is applied if empty.
84+
};
85+
apiInstance.getV2ResourcesCreatorCouponsEntries(opts, (error, data, response) => {
86+
if (error) {
87+
console.error(error);
88+
} else {
89+
console.log('API called successfully. Returned data: ' + data);
90+
}
91+
});
92+
```
93+
94+
### Parameters
95+
96+
97+
Name | Type | Description | Notes
98+
------------- | ------------- | ------------- | -------------
99+
**couponIds** | [**Array**](.md)| A comma-separated list of coupon IDs to filter on. No filter is applied if empty. | [optional]
100+
101+
### Return type
102+
103+
[**GetV2ResourcesCreatorCouponsEntries200Response**](GetV2ResourcesCreatorCouponsEntries200Response.md)
104+
105+
### Authorization
106+
107+
[token](../README.md#token)
108+
109+
### HTTP request headers
110+
111+
- **Content-Type**: Not defined
112+
- **Accept**: application/json
113+
114+
115+
## postV2ResourcesCreatorCoupons
116+
117+
> PostV2ResourcesCreatorCoupons200Response postV2ResourcesCreatorCoupons(opts)
118+
119+
Create a new coupon
120+
121+
This endpoint is currently limited to percent-based coupons with a maximum discount of 50%.
122+
123+
### Example
124+
125+
```javascript
126+
import BuiltByBitApi from 'built_by_bit_api';
127+
let defaultClient = BuiltByBitApi.ApiClient.instance;
128+
// Configure API key authorization: token
129+
let token = defaultClient.authentications['token'];
130+
token.apiKey = 'YOUR API KEY';
131+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
132+
//token.apiKeyPrefix = 'Token';
133+
134+
let apiInstance = new BuiltByBitApi.ResourcesCreatorCouponsApi();
135+
let opts = {
136+
'postV2ResourcesCreatorCouponsRequest': new BuiltByBitApi.PostV2ResourcesCreatorCouponsRequest() // PostV2ResourcesCreatorCouponsRequest |
137+
};
138+
apiInstance.postV2ResourcesCreatorCoupons(opts, (error, data, response) => {
139+
if (error) {
140+
console.error(error);
141+
} else {
142+
console.log('API called successfully. Returned data: ' + data);
143+
}
144+
});
145+
```
146+
147+
### Parameters
148+
149+
150+
Name | Type | Description | Notes
151+
------------- | ------------- | ------------- | -------------
152+
**postV2ResourcesCreatorCouponsRequest** | [**PostV2ResourcesCreatorCouponsRequest**](PostV2ResourcesCreatorCouponsRequest.md)| | [optional]
153+
154+
### Return type
155+
156+
[**PostV2ResourcesCreatorCoupons200Response**](PostV2ResourcesCreatorCoupons200Response.md)
157+
158+
### Authorization
159+
160+
[token](../README.md#token)
161+
162+
### HTTP request headers
163+
164+
- **Content-Type**: application/json
165+
- **Accept**: application/json
166+

0 commit comments

Comments
 (0)