@teemill/platform 0.69.0 → 0.71.0
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/.openapi-generator/FILES +2 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +5 -2
- package/api.ts +217 -85
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +3 -3
- package/dist/api.d.ts +80 -4
- package/dist/api.js +167 -84
- 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 +3 -3
- package/dist/esm/api.d.ts +80 -4
- package/dist/esm/api.js +167 -84
- 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 +3 -3
- 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/ConciergeCandidatesApi.md +63 -0
- package/docs/ExcludeEmailDomainRequest.md +20 -0
- package/docs/ExcludedEmailDomain.md +26 -0
- package/docs/Fulfillment.md +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/base.d.ts
CHANGED
package/dist/esm/base.js
CHANGED
package/dist/esm/common.d.ts
CHANGED
package/dist/esm/common.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Platform
|
|
4
4
|
* Manage Your podOS platform
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 0.
|
|
6
|
+
* The version of the OpenAPI document: 0.71.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -34,7 +34,7 @@ export class Configuration {
|
|
|
34
34
|
* @return True if the given MIME is JSON, false otherwise.
|
|
35
35
|
*/
|
|
36
36
|
isJsonMime(mime) {
|
|
37
|
-
const jsonMime =
|
|
38
|
-
return mime !== null &&
|
|
37
|
+
const jsonMime = /^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$/i;
|
|
38
|
+
return mime !== null && jsonMime.test(mime);
|
|
39
39
|
}
|
|
40
40
|
}
|
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**approveConciergeCandidate**](#approveconciergecandidate) | **POST** /v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId}/approve | Approve concierge candidate|
|
|
8
8
|
|[**deleteConciergeCandidate**](#deleteconciergecandidate) | **DELETE** /v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId} | Delete concierge candidate|
|
|
9
|
+
|[**excludeEmailDomain**](#excludeemaildomain) | **POST** /v1/platform/{platformId}/concierge-candidates/exclude-email-domains | Exclude an email domain from concierge candidates|
|
|
9
10
|
|[**getConciergeCandidate**](#getconciergecandidate) | **GET** /v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId} | Get concierge candidate|
|
|
10
11
|
|[**listConciergeCandidates**](#listconciergecandidates) | **GET** /v1/platform/{platformId}/concierge-candidates | List concierge candidates|
|
|
11
12
|
|
|
@@ -133,6 +134,68 @@ void (empty response body)
|
|
|
133
134
|
|
|
134
135
|
[[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)
|
|
135
136
|
|
|
137
|
+
# **excludeEmailDomain**
|
|
138
|
+
> ExcludedEmailDomain excludeEmailDomain(excludeEmailDomainRequest)
|
|
139
|
+
|
|
140
|
+
Exclude an email domain from concierge candidates. This will prevent new concierge candidates being created if they have an email address that contains this domain.
|
|
141
|
+
|
|
142
|
+
### Example
|
|
143
|
+
|
|
144
|
+
```typescript
|
|
145
|
+
import {
|
|
146
|
+
ConciergeCandidatesApi,
|
|
147
|
+
Configuration,
|
|
148
|
+
ExcludeEmailDomainRequest
|
|
149
|
+
} from '@teemill/platform';
|
|
150
|
+
|
|
151
|
+
const configuration = new Configuration();
|
|
152
|
+
const apiInstance = new ConciergeCandidatesApi(configuration);
|
|
153
|
+
|
|
154
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
155
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
156
|
+
let excludeEmailDomainRequest: ExcludeEmailDomainRequest; //Create an excluded email domain
|
|
157
|
+
|
|
158
|
+
const { status, data } = await apiInstance.excludeEmailDomain(
|
|
159
|
+
project,
|
|
160
|
+
platformId,
|
|
161
|
+
excludeEmailDomainRequest
|
|
162
|
+
);
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### Parameters
|
|
166
|
+
|
|
167
|
+
|Name | Type | Description | Notes|
|
|
168
|
+
|------------- | ------------- | ------------- | -------------|
|
|
169
|
+
| **excludeEmailDomainRequest** | **ExcludeEmailDomainRequest**| Create an excluded email domain | |
|
|
170
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
171
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
### Return type
|
|
175
|
+
|
|
176
|
+
**ExcludedEmailDomain**
|
|
177
|
+
|
|
178
|
+
### Authorization
|
|
179
|
+
|
|
180
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
181
|
+
|
|
182
|
+
### HTTP request headers
|
|
183
|
+
|
|
184
|
+
- **Content-Type**: application/json
|
|
185
|
+
- **Accept**: application/json
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
### HTTP response details
|
|
189
|
+
| Status code | Description | Response headers |
|
|
190
|
+
|-------------|-------------|------------------|
|
|
191
|
+
|**201** | Excluded email domain | - |
|
|
192
|
+
|**400** | Failed validation | - |
|
|
193
|
+
|**401** | Not authorised to access this resource | - |
|
|
194
|
+
|**403** | Refuse to authorize | - |
|
|
195
|
+
|**500** | Unknown server error | - |
|
|
196
|
+
|
|
197
|
+
[[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)
|
|
198
|
+
|
|
136
199
|
# **getConciergeCandidate**
|
|
137
200
|
> ConciergeCandidate getConciergeCandidate()
|
|
138
201
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ExcludeEmailDomainRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**domain** | **string** | The email domain to exclude | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ExcludeEmailDomainRequest } from '@teemill/platform';
|
|
14
|
+
|
|
15
|
+
const instance: ExcludeEmailDomainRequest = {
|
|
16
|
+
domain,
|
|
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)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ExcludedEmailDomain
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Unique object identifier | [default to undefined]
|
|
9
|
+
**domain** | **string** | The email domain to exclude | [default to undefined]
|
|
10
|
+
**userRef** | **string** | Reference to the user resource | [default to undefined]
|
|
11
|
+
**createdAt** | **string** | ISO 8601 Timestamp | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ExcludedEmailDomain } from '@teemill/platform';
|
|
17
|
+
|
|
18
|
+
const instance: ExcludedEmailDomain = {
|
|
19
|
+
id,
|
|
20
|
+
domain,
|
|
21
|
+
userRef,
|
|
22
|
+
createdAt,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[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/Fulfillment.md
CHANGED
|
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**packageWeight** | **number** | Weight of the package being shipped in grams | [optional] [default to undefined]
|
|
17
17
|
**platformRef** | **string** | A reference to the resource location | [optional] [default to undefined]
|
|
18
18
|
**frozen** | **boolean** | Whether the fulfillment is frozen. This will prevent the fulfillment from being picked. | [optional] [readonly] [default to undefined]
|
|
19
|
-
**frozenReasons** | **Array<string>** | List of reason codes why this fulfillment is frozen. - `moderation` - Held for content moderation review. - `internal_screen_print` - Awaiting internal screen print processing. - `manual` - Manually frozen by a user. - `
|
|
19
|
+
**frozenReasons** | **Array<string>** | List of reason codes why this fulfillment is frozen. - `moderation` - Held for content moderation review. - `internal_screen_print` - Awaiting internal screen print processing. - `manual` - Manually frozen by a user. - `credit_control` - Client is under credit control. - `billing_failed` - Payment for this order failed. - `pickface_flagged` - Flagged on the pickface for review. - `flow_frozen` - Frozen by internal production flow handling. - `fraud` - Frozen due to fraud checks. | [optional] [readonly] [default to undefined]
|
|
20
20
|
|
|
21
21
|
## Example
|
|
22
22
|
|
package/index.ts
CHANGED