@teemill/platform 0.67.1 → 0.68.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 +3 -1
- package/README.md +5 -3
- package/api.ts +34 -15
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +33 -15
- package/dist/api.js +3 -2
- 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 +33 -15
- package/dist/esm/api.js +3 -2
- 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/ConciergeCandidate.md +1 -1
- package/docs/ConfirmOrderFulfillment.md +4 -3
- package/docs/ConfirmOrderFulfillmentWithShipment.md +23 -0
- package/docs/ConfirmOrderFulfillmentWithShippingMethod.md +23 -0
- package/docs/Fulfillment.md +1 -1
- package/docs/Shipment.md +21 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -21,7 +21,8 @@ docs/ConciergeCandidate.md
|
|
|
21
21
|
docs/ConciergeCandidateSource.md
|
|
22
22
|
docs/ConciergeCandidatesApi.md
|
|
23
23
|
docs/ConfirmOrderFulfillment.md
|
|
24
|
-
docs/
|
|
24
|
+
docs/ConfirmOrderFulfillmentWithShipment.md
|
|
25
|
+
docs/ConfirmOrderFulfillmentWithShippingMethod.md
|
|
25
26
|
docs/ConfirmOrderRequest.md
|
|
26
27
|
docs/ContactInformation.md
|
|
27
28
|
docs/Coupon.md
|
|
@@ -108,6 +109,7 @@ docs/ReviewsApi.md
|
|
|
108
109
|
docs/ReviewsResponse.md
|
|
109
110
|
docs/SaveDashboardRequest.md
|
|
110
111
|
docs/SaveTermsRequest.md
|
|
112
|
+
docs/Shipment.md
|
|
111
113
|
docs/ShippingMethod.md
|
|
112
114
|
docs/Statistics.md
|
|
113
115
|
docs/StatusHistoryItem.md
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/platform@0.
|
|
1
|
+
## @teemill/platform@0.68.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/platform@0.
|
|
39
|
+
npm install @teemill/platform@0.68.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -129,7 +129,8 @@ Class | Method | HTTP request | Description
|
|
|
129
129
|
- [ConciergeCandidate](docs/ConciergeCandidate.md)
|
|
130
130
|
- [ConciergeCandidateSource](docs/ConciergeCandidateSource.md)
|
|
131
131
|
- [ConfirmOrderFulfillment](docs/ConfirmOrderFulfillment.md)
|
|
132
|
-
- [
|
|
132
|
+
- [ConfirmOrderFulfillmentWithShipment](docs/ConfirmOrderFulfillmentWithShipment.md)
|
|
133
|
+
- [ConfirmOrderFulfillmentWithShippingMethod](docs/ConfirmOrderFulfillmentWithShippingMethod.md)
|
|
133
134
|
- [ConfirmOrderRequest](docs/ConfirmOrderRequest.md)
|
|
134
135
|
- [ContactInformation](docs/ContactInformation.md)
|
|
135
136
|
- [Coupon](docs/Coupon.md)
|
|
@@ -207,6 +208,7 @@ Class | Method | HTTP request | Description
|
|
|
207
208
|
- [ReviewsResponse](docs/ReviewsResponse.md)
|
|
208
209
|
- [SaveDashboardRequest](docs/SaveDashboardRequest.md)
|
|
209
210
|
- [SaveTermsRequest](docs/SaveTermsRequest.md)
|
|
211
|
+
- [Shipment](docs/Shipment.md)
|
|
210
212
|
- [ShippingMethod](docs/ShippingMethod.md)
|
|
211
213
|
- [Statistics](docs/Statistics.md)
|
|
212
214
|
- [StatusHistoryItem](docs/StatusHistoryItem.md)
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.68.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -216,7 +216,7 @@ export interface ConciergeCandidate {
|
|
|
216
216
|
*/
|
|
217
217
|
'completedAt': string | null;
|
|
218
218
|
/**
|
|
219
|
-
* A reference to the
|
|
219
|
+
* A reference to the client being ordered
|
|
220
220
|
*/
|
|
221
221
|
'clientRef': string;
|
|
222
222
|
/**
|
|
@@ -255,25 +255,34 @@ export const ConciergeCandidateSourceTypeEnum = {
|
|
|
255
255
|
|
|
256
256
|
export type ConciergeCandidateSourceTypeEnum = typeof ConciergeCandidateSourceTypeEnum[keyof typeof ConciergeCandidateSourceTypeEnum];
|
|
257
257
|
|
|
258
|
-
|
|
258
|
+
/**
|
|
259
|
+
* @type ConfirmOrderFulfillment
|
|
260
|
+
* Confirmation details for a single fulfillment. Provide either a `shippingMethodId` to use a PodOS shipping method, or a `shipment` object with your own shipping label.
|
|
261
|
+
*/
|
|
262
|
+
export type ConfirmOrderFulfillment = ConfirmOrderFulfillmentWithShipment | ConfirmOrderFulfillmentWithShippingMethod;
|
|
263
|
+
|
|
264
|
+
/**
|
|
265
|
+
* Confirm a fulfillment using your own shipping label. Use this when you generate shipping labels outside of PodOS.
|
|
266
|
+
*/
|
|
267
|
+
export interface ConfirmOrderFulfillmentWithShipment {
|
|
259
268
|
/**
|
|
260
|
-
*
|
|
269
|
+
* The ID of the fulfillment to confirm.
|
|
261
270
|
*/
|
|
262
271
|
'fulfillmentId': string;
|
|
263
|
-
|
|
264
|
-
* Unique object identifier
|
|
265
|
-
*/
|
|
266
|
-
'shippingMethodId'?: string;
|
|
267
|
-
'shipment'?: ConfirmOrderFulfillmentShipment;
|
|
272
|
+
'shipment': Shipment;
|
|
268
273
|
}
|
|
269
274
|
/**
|
|
270
|
-
*
|
|
275
|
+
* Confirm a fulfillment using a PodOS shipping method. Choose from the `availableShippingMethods` returned on the fulfillment.
|
|
271
276
|
*/
|
|
272
|
-
export interface
|
|
277
|
+
export interface ConfirmOrderFulfillmentWithShippingMethod {
|
|
273
278
|
/**
|
|
274
|
-
*
|
|
279
|
+
* The ID of the fulfillment to confirm.
|
|
275
280
|
*/
|
|
276
|
-
'
|
|
281
|
+
'fulfillmentId': string;
|
|
282
|
+
/**
|
|
283
|
+
* The ID of the shipping method to use, from the fulfillment\'s `availableShippingMethods`.
|
|
284
|
+
*/
|
|
285
|
+
'shippingMethodId': string;
|
|
277
286
|
}
|
|
278
287
|
export interface ConfirmOrderRequest {
|
|
279
288
|
'fulfillments': Array<ConfirmOrderFulfillment>;
|
|
@@ -629,7 +638,7 @@ export interface Fulfillment {
|
|
|
629
638
|
*/
|
|
630
639
|
'frozen'?: boolean;
|
|
631
640
|
/**
|
|
632
|
-
* 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. - `
|
|
641
|
+
* 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. - `client_credit_control` - The client is under credit control. - `factory_credit_control` - The factory fulfilling the order 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.
|
|
633
642
|
*/
|
|
634
643
|
'frozenReasons'?: Array<FulfillmentFrozenReasonsEnum>;
|
|
635
644
|
}
|
|
@@ -638,7 +647,8 @@ export const FulfillmentFrozenReasonsEnum = {
|
|
|
638
647
|
Moderation: 'moderation',
|
|
639
648
|
InternalScreenPrint: 'internal_screen_print',
|
|
640
649
|
Manual: 'manual',
|
|
641
|
-
|
|
650
|
+
ClientCreditControl: 'client_credit_control',
|
|
651
|
+
FactoryCreditControl: 'factory_credit_control',
|
|
642
652
|
BillingFailed: 'billing_failed',
|
|
643
653
|
PickfaceFlagged: 'pickface_flagged',
|
|
644
654
|
FlowFrozen: 'flow_frozen',
|
|
@@ -1215,6 +1225,15 @@ export interface SaveTermsRequest {
|
|
|
1215
1225
|
'enabled': boolean;
|
|
1216
1226
|
'updateVersion': boolean;
|
|
1217
1227
|
}
|
|
1228
|
+
/**
|
|
1229
|
+
* Your own shipping label details.
|
|
1230
|
+
*/
|
|
1231
|
+
export interface Shipment {
|
|
1232
|
+
/**
|
|
1233
|
+
* A URL to the shipping label image or PDF.
|
|
1234
|
+
*/
|
|
1235
|
+
'image': string;
|
|
1236
|
+
}
|
|
1218
1237
|
export interface ShippingMethod {
|
|
1219
1238
|
/**
|
|
1220
1239
|
* Unique object identifier
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Platform
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.68.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -197,7 +197,7 @@ export interface ConciergeCandidate {
|
|
|
197
197
|
*/
|
|
198
198
|
'completedAt': string | null;
|
|
199
199
|
/**
|
|
200
|
-
* A reference to the
|
|
200
|
+
* A reference to the client being ordered
|
|
201
201
|
*/
|
|
202
202
|
'clientRef': string;
|
|
203
203
|
/**
|
|
@@ -233,25 +233,33 @@ export declare const ConciergeCandidateSourceTypeEnum: {
|
|
|
233
233
|
readonly QuoteForm: "quote_form";
|
|
234
234
|
};
|
|
235
235
|
export type ConciergeCandidateSourceTypeEnum = typeof ConciergeCandidateSourceTypeEnum[keyof typeof ConciergeCandidateSourceTypeEnum];
|
|
236
|
-
|
|
236
|
+
/**
|
|
237
|
+
* @type ConfirmOrderFulfillment
|
|
238
|
+
* Confirmation details for a single fulfillment. Provide either a `shippingMethodId` to use a PodOS shipping method, or a `shipment` object with your own shipping label.
|
|
239
|
+
*/
|
|
240
|
+
export type ConfirmOrderFulfillment = ConfirmOrderFulfillmentWithShipment | ConfirmOrderFulfillmentWithShippingMethod;
|
|
241
|
+
/**
|
|
242
|
+
* Confirm a fulfillment using your own shipping label. Use this when you generate shipping labels outside of PodOS.
|
|
243
|
+
*/
|
|
244
|
+
export interface ConfirmOrderFulfillmentWithShipment {
|
|
237
245
|
/**
|
|
238
|
-
*
|
|
246
|
+
* The ID of the fulfillment to confirm.
|
|
239
247
|
*/
|
|
240
248
|
'fulfillmentId': string;
|
|
241
|
-
|
|
242
|
-
* Unique object identifier
|
|
243
|
-
*/
|
|
244
|
-
'shippingMethodId'?: string;
|
|
245
|
-
'shipment'?: ConfirmOrderFulfillmentShipment;
|
|
249
|
+
'shipment': Shipment;
|
|
246
250
|
}
|
|
247
251
|
/**
|
|
248
|
-
*
|
|
252
|
+
* Confirm a fulfillment using a PodOS shipping method. Choose from the `availableShippingMethods` returned on the fulfillment.
|
|
249
253
|
*/
|
|
250
|
-
export interface
|
|
254
|
+
export interface ConfirmOrderFulfillmentWithShippingMethod {
|
|
251
255
|
/**
|
|
252
|
-
*
|
|
256
|
+
* The ID of the fulfillment to confirm.
|
|
253
257
|
*/
|
|
254
|
-
'
|
|
258
|
+
'fulfillmentId': string;
|
|
259
|
+
/**
|
|
260
|
+
* The ID of the shipping method to use, from the fulfillment\'s `availableShippingMethods`.
|
|
261
|
+
*/
|
|
262
|
+
'shippingMethodId': string;
|
|
255
263
|
}
|
|
256
264
|
export interface ConfirmOrderRequest {
|
|
257
265
|
'fulfillments': Array<ConfirmOrderFulfillment>;
|
|
@@ -597,7 +605,7 @@ export interface Fulfillment {
|
|
|
597
605
|
*/
|
|
598
606
|
'frozen'?: boolean;
|
|
599
607
|
/**
|
|
600
|
-
* 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. - `
|
|
608
|
+
* 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. - `client_credit_control` - The client is under credit control. - `factory_credit_control` - The factory fulfilling the order 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.
|
|
601
609
|
*/
|
|
602
610
|
'frozenReasons'?: Array<FulfillmentFrozenReasonsEnum>;
|
|
603
611
|
}
|
|
@@ -605,7 +613,8 @@ export declare const FulfillmentFrozenReasonsEnum: {
|
|
|
605
613
|
readonly Moderation: "moderation";
|
|
606
614
|
readonly InternalScreenPrint: "internal_screen_print";
|
|
607
615
|
readonly Manual: "manual";
|
|
608
|
-
readonly
|
|
616
|
+
readonly ClientCreditControl: "client_credit_control";
|
|
617
|
+
readonly FactoryCreditControl: "factory_credit_control";
|
|
609
618
|
readonly BillingFailed: "billing_failed";
|
|
610
619
|
readonly PickfaceFlagged: "pickface_flagged";
|
|
611
620
|
readonly FlowFrozen: "flow_frozen";
|
|
@@ -1164,6 +1173,15 @@ export interface SaveTermsRequest {
|
|
|
1164
1173
|
'enabled': boolean;
|
|
1165
1174
|
'updateVersion': boolean;
|
|
1166
1175
|
}
|
|
1176
|
+
/**
|
|
1177
|
+
* Your own shipping label details.
|
|
1178
|
+
*/
|
|
1179
|
+
export interface Shipment {
|
|
1180
|
+
/**
|
|
1181
|
+
* A URL to the shipping label image or PDF.
|
|
1182
|
+
*/
|
|
1183
|
+
'image': string;
|
|
1184
|
+
}
|
|
1167
1185
|
export interface ShippingMethod {
|
|
1168
1186
|
/**
|
|
1169
1187
|
* Unique object identifier
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Platform
|
|
6
6
|
* Manage Your podOS platform
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.
|
|
8
|
+
* The version of the OpenAPI document: 0.68.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -66,7 +66,8 @@ exports.FulfillmentFrozenReasonsEnum = {
|
|
|
66
66
|
Moderation: 'moderation',
|
|
67
67
|
InternalScreenPrint: 'internal_screen_print',
|
|
68
68
|
Manual: 'manual',
|
|
69
|
-
|
|
69
|
+
ClientCreditControl: 'client_credit_control',
|
|
70
|
+
FactoryCreditControl: 'factory_credit_control',
|
|
70
71
|
BillingFailed: 'billing_failed',
|
|
71
72
|
PickfaceFlagged: 'pickface_flagged',
|
|
72
73
|
FlowFrozen: 'flow_frozen',
|
package/dist/base.d.ts
CHANGED
package/dist/base.js
CHANGED
package/dist/common.d.ts
CHANGED
package/dist/common.js
CHANGED
package/dist/configuration.d.ts
CHANGED
package/dist/configuration.js
CHANGED
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Platform
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.68.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -197,7 +197,7 @@ export interface ConciergeCandidate {
|
|
|
197
197
|
*/
|
|
198
198
|
'completedAt': string | null;
|
|
199
199
|
/**
|
|
200
|
-
* A reference to the
|
|
200
|
+
* A reference to the client being ordered
|
|
201
201
|
*/
|
|
202
202
|
'clientRef': string;
|
|
203
203
|
/**
|
|
@@ -233,25 +233,33 @@ export declare const ConciergeCandidateSourceTypeEnum: {
|
|
|
233
233
|
readonly QuoteForm: "quote_form";
|
|
234
234
|
};
|
|
235
235
|
export type ConciergeCandidateSourceTypeEnum = typeof ConciergeCandidateSourceTypeEnum[keyof typeof ConciergeCandidateSourceTypeEnum];
|
|
236
|
-
|
|
236
|
+
/**
|
|
237
|
+
* @type ConfirmOrderFulfillment
|
|
238
|
+
* Confirmation details for a single fulfillment. Provide either a `shippingMethodId` to use a PodOS shipping method, or a `shipment` object with your own shipping label.
|
|
239
|
+
*/
|
|
240
|
+
export type ConfirmOrderFulfillment = ConfirmOrderFulfillmentWithShipment | ConfirmOrderFulfillmentWithShippingMethod;
|
|
241
|
+
/**
|
|
242
|
+
* Confirm a fulfillment using your own shipping label. Use this when you generate shipping labels outside of PodOS.
|
|
243
|
+
*/
|
|
244
|
+
export interface ConfirmOrderFulfillmentWithShipment {
|
|
237
245
|
/**
|
|
238
|
-
*
|
|
246
|
+
* The ID of the fulfillment to confirm.
|
|
239
247
|
*/
|
|
240
248
|
'fulfillmentId': string;
|
|
241
|
-
|
|
242
|
-
* Unique object identifier
|
|
243
|
-
*/
|
|
244
|
-
'shippingMethodId'?: string;
|
|
245
|
-
'shipment'?: ConfirmOrderFulfillmentShipment;
|
|
249
|
+
'shipment': Shipment;
|
|
246
250
|
}
|
|
247
251
|
/**
|
|
248
|
-
*
|
|
252
|
+
* Confirm a fulfillment using a PodOS shipping method. Choose from the `availableShippingMethods` returned on the fulfillment.
|
|
249
253
|
*/
|
|
250
|
-
export interface
|
|
254
|
+
export interface ConfirmOrderFulfillmentWithShippingMethod {
|
|
251
255
|
/**
|
|
252
|
-
*
|
|
256
|
+
* The ID of the fulfillment to confirm.
|
|
253
257
|
*/
|
|
254
|
-
'
|
|
258
|
+
'fulfillmentId': string;
|
|
259
|
+
/**
|
|
260
|
+
* The ID of the shipping method to use, from the fulfillment\'s `availableShippingMethods`.
|
|
261
|
+
*/
|
|
262
|
+
'shippingMethodId': string;
|
|
255
263
|
}
|
|
256
264
|
export interface ConfirmOrderRequest {
|
|
257
265
|
'fulfillments': Array<ConfirmOrderFulfillment>;
|
|
@@ -597,7 +605,7 @@ export interface Fulfillment {
|
|
|
597
605
|
*/
|
|
598
606
|
'frozen'?: boolean;
|
|
599
607
|
/**
|
|
600
|
-
* 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. - `
|
|
608
|
+
* 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. - `client_credit_control` - The client is under credit control. - `factory_credit_control` - The factory fulfilling the order 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.
|
|
601
609
|
*/
|
|
602
610
|
'frozenReasons'?: Array<FulfillmentFrozenReasonsEnum>;
|
|
603
611
|
}
|
|
@@ -605,7 +613,8 @@ export declare const FulfillmentFrozenReasonsEnum: {
|
|
|
605
613
|
readonly Moderation: "moderation";
|
|
606
614
|
readonly InternalScreenPrint: "internal_screen_print";
|
|
607
615
|
readonly Manual: "manual";
|
|
608
|
-
readonly
|
|
616
|
+
readonly ClientCreditControl: "client_credit_control";
|
|
617
|
+
readonly FactoryCreditControl: "factory_credit_control";
|
|
609
618
|
readonly BillingFailed: "billing_failed";
|
|
610
619
|
readonly PickfaceFlagged: "pickface_flagged";
|
|
611
620
|
readonly FlowFrozen: "flow_frozen";
|
|
@@ -1164,6 +1173,15 @@ export interface SaveTermsRequest {
|
|
|
1164
1173
|
'enabled': boolean;
|
|
1165
1174
|
'updateVersion': boolean;
|
|
1166
1175
|
}
|
|
1176
|
+
/**
|
|
1177
|
+
* Your own shipping label details.
|
|
1178
|
+
*/
|
|
1179
|
+
export interface Shipment {
|
|
1180
|
+
/**
|
|
1181
|
+
* A URL to the shipping label image or PDF.
|
|
1182
|
+
*/
|
|
1183
|
+
'image': string;
|
|
1184
|
+
}
|
|
1167
1185
|
export interface ShippingMethod {
|
|
1168
1186
|
/**
|
|
1169
1187
|
* Unique object identifier
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.68.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -62,7 +62,8 @@ export const FulfillmentFrozenReasonsEnum = {
|
|
|
62
62
|
Moderation: 'moderation',
|
|
63
63
|
InternalScreenPrint: 'internal_screen_print',
|
|
64
64
|
Manual: 'manual',
|
|
65
|
-
|
|
65
|
+
ClientCreditControl: 'client_credit_control',
|
|
66
|
+
FactoryCreditControl: 'factory_credit_control',
|
|
66
67
|
BillingFailed: 'billing_failed',
|
|
67
68
|
PickfaceFlagged: 'pickface_flagged',
|
|
68
69
|
FlowFrozen: 'flow_frozen',
|
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
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**createdAt** | **string** | ISO 8601 Timestamp | [default to undefined]
|
|
15
15
|
**approvedAt** | **string** | ISO 8601 Timestamp | [default to undefined]
|
|
16
16
|
**completedAt** | **string** | ISO 8601 Timestamp | [default to undefined]
|
|
17
|
-
**clientRef** | **string** | A reference to the
|
|
17
|
+
**clientRef** | **string** | A reference to the client being ordered | [default to undefined]
|
|
18
18
|
**originRef** | **string** | A reference to the origin of the concierge candidate. The structure of the origin ref can be inferred from the concierge candidate source. | [default to undefined]
|
|
19
19
|
**taskRef** | **string** | Reference to the task resource | [optional] [default to undefined]
|
|
20
20
|
|
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
# ConfirmOrderFulfillment
|
|
2
2
|
|
|
3
|
+
Confirmation details for a single fulfillment. Provide either a `shippingMethodId` to use a PodOS shipping method, or a `shipment` object with your own shipping label.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
6
7
|
Name | Type | Description | Notes
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**fulfillmentId** | **string** |
|
|
9
|
-
**shippingMethodId** | **string** |
|
|
10
|
-
**shipment** | [**
|
|
9
|
+
**fulfillmentId** | **string** | The ID of the fulfillment to confirm. | [default to undefined]
|
|
10
|
+
**shippingMethodId** | **string** | The ID of the shipping method to use, from the fulfillment\'s `availableShippingMethods`. | [default to undefined]
|
|
11
|
+
**shipment** | [**Shipment**](Shipment.md) | | [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ConfirmOrderFulfillmentWithShipment
|
|
2
|
+
|
|
3
|
+
Confirm a fulfillment using your own shipping label. Use this when you generate shipping labels outside of PodOS.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**fulfillmentId** | **string** | The ID of the fulfillment to confirm. | [default to undefined]
|
|
10
|
+
**shipment** | [**Shipment**](Shipment.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ConfirmOrderFulfillmentWithShipment } from '@teemill/platform';
|
|
16
|
+
|
|
17
|
+
const instance: ConfirmOrderFulfillmentWithShipment = {
|
|
18
|
+
fulfillmentId,
|
|
19
|
+
shipment,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[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,23 @@
|
|
|
1
|
+
# ConfirmOrderFulfillmentWithShippingMethod
|
|
2
|
+
|
|
3
|
+
Confirm a fulfillment using a PodOS shipping method. Choose from the `availableShippingMethods` returned on the fulfillment.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**fulfillmentId** | **string** | The ID of the fulfillment to confirm. | [default to undefined]
|
|
10
|
+
**shippingMethodId** | **string** | The ID of the shipping method to use, from the fulfillment\'s `availableShippingMethods`. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ConfirmOrderFulfillmentWithShippingMethod } from '@teemill/platform';
|
|
16
|
+
|
|
17
|
+
const instance: ConfirmOrderFulfillmentWithShippingMethod = {
|
|
18
|
+
fulfillmentId,
|
|
19
|
+
shippingMethodId,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[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. - `client_credit_control` - The client is under credit control. - `factory_credit_control` - The factory fulfilling the order 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/docs/Shipment.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Shipment
|
|
2
|
+
|
|
3
|
+
Your own shipping label details.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**image** | **string** | A URL to the shipping label image or PDF. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { Shipment } from '@teemill/platform';
|
|
15
|
+
|
|
16
|
+
const instance: Shipment = {
|
|
17
|
+
image,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[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/index.ts
CHANGED