@teemill/platform 0.33.1 → 0.34.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/api.ts +229 -14
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +138 -9
- package/dist/api.js +124 -11
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +138 -9
- package/dist/esm/api.js +124 -11
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/CustomersApi.md +81 -0
- package/docs/InlineObject1.md +4 -2
- package/docs/InlineObject2.md +20 -0
- package/docs/PaymentApi.md +2 -2
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
package/docs/CustomersApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**exportCustomers**](#exportcustomers) | **GET** /v1/platform/{platformId}/customers/export | Export customers|
|
|
8
8
|
|[**getCustomer**](#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer|
|
|
9
|
+
|[**listCustomerTags**](#listcustomertags) | **GET** /v1/platform/{platformId}/customers/tags | List customer tags|
|
|
9
10
|
|[**listCustomers**](#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers|
|
|
10
11
|
|
|
11
12
|
# **exportCustomers**
|
|
@@ -31,6 +32,8 @@ let countries: Array<string>; //Filter customers by country code (optional) (def
|
|
|
31
32
|
let projects: Array<string>; //Filter customers by project. In the absence of this field, all projects will be included in the export. (optional) (default to undefined)
|
|
32
33
|
let gender: 'male' | 'female'; //Filter customers by gender equal to the value provided (optional) (default to undefined)
|
|
33
34
|
let productTypes: Array<number>; //Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
35
|
+
let demographics: Array<string>; //Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
36
|
+
let tags: Array<string>; //Filter customers by purchase tags. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
34
37
|
let usedDiscount: boolean; //Filter customers by whether they have used a discount (optional) (default to undefined)
|
|
35
38
|
let minimumTotalOrderCount: number; //Filter customers by total order count greater than or equal to the value provided (optional) (default to undefined)
|
|
36
39
|
let maximumTotalOrderCount: number; //Filter customers by total order count less than or equal to the value provided (optional) (default to undefined)
|
|
@@ -49,6 +52,8 @@ const { status, data } = await apiInstance.exportCustomers(
|
|
|
49
52
|
projects,
|
|
50
53
|
gender,
|
|
51
54
|
productTypes,
|
|
55
|
+
demographics,
|
|
56
|
+
tags,
|
|
52
57
|
usedDiscount,
|
|
53
58
|
minimumTotalOrderCount,
|
|
54
59
|
maximumTotalOrderCount,
|
|
@@ -72,6 +77,8 @@ const { status, data } = await apiInstance.exportCustomers(
|
|
|
72
77
|
| **projects** | **Array<string>** | Filter customers by project. In the absence of this field, all projects will be included in the export. | (optional) defaults to undefined|
|
|
73
78
|
| **gender** | [**'male' | 'female'**]**Array<'male' | 'female'>** | Filter customers by gender equal to the value provided | (optional) defaults to undefined|
|
|
74
79
|
| **productTypes** | **Array<number>** | Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
80
|
+
| **demographics** | **Array<string>** | Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
81
|
+
| **tags** | **Array<string>** | Filter customers by purchase tags. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
75
82
|
| **usedDiscount** | [**boolean**] | Filter customers by whether they have used a discount | (optional) defaults to undefined|
|
|
76
83
|
| **minimumTotalOrderCount** | [**number**] | Filter customers by total order count greater than or equal to the value provided | (optional) defaults to undefined|
|
|
77
84
|
| **maximumTotalOrderCount** | [**number**] | Filter customers by total order count less than or equal to the value provided | (optional) defaults to undefined|
|
|
@@ -171,6 +178,74 @@ const { status, data } = await apiInstance.getCustomer(
|
|
|
171
178
|
|
|
172
179
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
173
180
|
|
|
181
|
+
# **listCustomerTags**
|
|
182
|
+
> InlineObject1 listCustomerTags()
|
|
183
|
+
|
|
184
|
+
List customer tags
|
|
185
|
+
|
|
186
|
+
### Example
|
|
187
|
+
|
|
188
|
+
```typescript
|
|
189
|
+
import {
|
|
190
|
+
CustomersApi,
|
|
191
|
+
Configuration
|
|
192
|
+
} from '@teemill/platform';
|
|
193
|
+
|
|
194
|
+
const configuration = new Configuration();
|
|
195
|
+
const apiInstance = new CustomersApi(configuration);
|
|
196
|
+
|
|
197
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
198
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
199
|
+
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
200
|
+
let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
|
|
201
|
+
let search: string; //Search term to filter results (optional) (default to undefined)
|
|
202
|
+
|
|
203
|
+
const { status, data } = await apiInstance.listCustomerTags(
|
|
204
|
+
project,
|
|
205
|
+
platformId,
|
|
206
|
+
pageToken,
|
|
207
|
+
pageSize,
|
|
208
|
+
search
|
|
209
|
+
);
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Parameters
|
|
213
|
+
|
|
214
|
+
|Name | Type | Description | Notes|
|
|
215
|
+
|------------- | ------------- | ------------- | -------------|
|
|
216
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
217
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
218
|
+
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
219
|
+
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
220
|
+
| **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
### Return type
|
|
224
|
+
|
|
225
|
+
**InlineObject1**
|
|
226
|
+
|
|
227
|
+
### Authorization
|
|
228
|
+
|
|
229
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
230
|
+
|
|
231
|
+
### HTTP request headers
|
|
232
|
+
|
|
233
|
+
- **Content-Type**: Not defined
|
|
234
|
+
- **Accept**: application/json
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
### HTTP response details
|
|
238
|
+
| Status code | Description | Response headers |
|
|
239
|
+
|-------------|-------------|------------------|
|
|
240
|
+
|**200** | Customer tags response | - |
|
|
241
|
+
|**400** | Failed validation | - |
|
|
242
|
+
|**401** | Not authorised to access this resource | - |
|
|
243
|
+
|**403** | Refuse to authorize | - |
|
|
244
|
+
|**404** | Resource not found | - |
|
|
245
|
+
|**500** | Unknown server error | - |
|
|
246
|
+
|
|
247
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
248
|
+
|
|
174
249
|
# **listCustomers**
|
|
175
250
|
> CustomersResponse listCustomers()
|
|
176
251
|
|
|
@@ -197,6 +272,8 @@ let countries: Array<string>; //Filter customers by country code (optional) (def
|
|
|
197
272
|
let projects: Array<string>; //Filter customers by project. In the absence of this field, all projects will be included in the export. (optional) (default to undefined)
|
|
198
273
|
let gender: 'male' | 'female'; //Filter customers by gender equal to the value provided (optional) (default to undefined)
|
|
199
274
|
let productTypes: Array<number>; //Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
275
|
+
let demographics: Array<string>; //Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
276
|
+
let tags: Array<string>; //Filter customers by purchase tags. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
200
277
|
let usedDiscount: boolean; //Filter customers by whether they have used a discount (optional) (default to undefined)
|
|
201
278
|
let minimumTotalOrderCount: number; //Filter customers by total order count greater than or equal to the value provided (optional) (default to undefined)
|
|
202
279
|
let maximumTotalOrderCount: number; //Filter customers by total order count less than or equal to the value provided (optional) (default to undefined)
|
|
@@ -218,6 +295,8 @@ const { status, data } = await apiInstance.listCustomers(
|
|
|
218
295
|
projects,
|
|
219
296
|
gender,
|
|
220
297
|
productTypes,
|
|
298
|
+
demographics,
|
|
299
|
+
tags,
|
|
221
300
|
usedDiscount,
|
|
222
301
|
minimumTotalOrderCount,
|
|
223
302
|
maximumTotalOrderCount,
|
|
@@ -244,6 +323,8 @@ const { status, data } = await apiInstance.listCustomers(
|
|
|
244
323
|
| **projects** | **Array<string>** | Filter customers by project. In the absence of this field, all projects will be included in the export. | (optional) defaults to undefined|
|
|
245
324
|
| **gender** | [**'male' | 'female'**]**Array<'male' | 'female'>** | Filter customers by gender equal to the value provided | (optional) defaults to undefined|
|
|
246
325
|
| **productTypes** | **Array<number>** | Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
326
|
+
| **demographics** | **Array<string>** | Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
327
|
+
| **tags** | **Array<string>** | Filter customers by purchase tags. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
247
328
|
| **usedDiscount** | [**boolean**] | Filter customers by whether they have used a discount | (optional) defaults to undefined|
|
|
248
329
|
| **minimumTotalOrderCount** | [**number**] | Filter customers by total order count greater than or equal to the value provided | (optional) defaults to undefined|
|
|
249
330
|
| **maximumTotalOrderCount** | [**number**] | Filter customers by total order count less than or equal to the value provided | (optional) defaults to undefined|
|
package/docs/InlineObject1.md
CHANGED
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
8
|
+
**tags** | **Array<string>** | | [default to undefined]
|
|
9
|
+
**nextPageToken** | **number** | | [optional] [default to undefined]
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
|
|
|
13
14
|
import { InlineObject1 } from '@teemill/platform';
|
|
14
15
|
|
|
15
16
|
const instance: InlineObject1 = {
|
|
16
|
-
|
|
17
|
+
tags,
|
|
18
|
+
nextPageToken,
|
|
17
19
|
};
|
|
18
20
|
```
|
|
19
21
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# InlineObject2
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**redirect_url** | **string** | The URL to redirect to | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { InlineObject2 } from '@teemill/platform';
|
|
14
|
+
|
|
15
|
+
const instance: InlineObject2 = {
|
|
16
|
+
redirect_url,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/PaymentApi.md
CHANGED
|
@@ -9,7 +9,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
9
9
|
|[**getStripePaymentAccount**](#getstripepaymentaccount) | **GET** /v1/platform/payment/stripe | Get Stripe Payment Account|
|
|
10
10
|
|
|
11
11
|
# **authorizeStripe**
|
|
12
|
-
>
|
|
12
|
+
> InlineObject2 authorizeStripe()
|
|
13
13
|
|
|
14
14
|
Authorize a Stripe payment account
|
|
15
15
|
|
|
@@ -40,7 +40,7 @@ const { status, data } = await apiInstance.authorizeStripe(
|
|
|
40
40
|
|
|
41
41
|
### Return type
|
|
42
42
|
|
|
43
|
-
**
|
|
43
|
+
**InlineObject2**
|
|
44
44
|
|
|
45
45
|
### Authorization
|
|
46
46
|
|
package/index.ts
CHANGED