@teemill/platform 0.35.0 → 0.37.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/README.md +3 -2
- package/api.ts +15 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +15 -1
- package/dist/api.js +1 -1
- 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 +15 -1
- package/dist/esm/api.js +1 -1
- 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/CreateOrder.md +4 -0
- package/docs/Enquiry.md +2 -0
- package/docs/EnquiryTracking.md +28 -0
- package/docs/Order.md +2 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/platform@0.
|
|
1
|
+
## @teemill/platform@0.37.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.37.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -136,6 +136,7 @@ Class | Method | HTTP request | Description
|
|
|
136
136
|
- [Enquiry](docs/Enquiry.md)
|
|
137
137
|
- [EnquiryExtraInputsInner](docs/EnquiryExtraInputsInner.md)
|
|
138
138
|
- [EnquiryExtraInputsInnerValue](docs/EnquiryExtraInputsInnerValue.md)
|
|
139
|
+
- [EnquiryTracking](docs/EnquiryTracking.md)
|
|
139
140
|
- [ExportOrders202Response](docs/ExportOrders202Response.md)
|
|
140
141
|
- [Fulfiller](docs/Fulfiller.md)
|
|
141
142
|
- [FulfillerLocation](docs/FulfillerLocation.md)
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform API
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.37.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -199,6 +199,7 @@ export interface CreateOrder {
|
|
|
199
199
|
'merchantReference'?: string | null;
|
|
200
200
|
'contactInformation': CreateOrderContactInformation;
|
|
201
201
|
'shippingAddress': Address;
|
|
202
|
+
'billingAddress'?: Address;
|
|
202
203
|
'customsInformation'?: CustomsInformation;
|
|
203
204
|
/**
|
|
204
205
|
* Items to be ordered
|
|
@@ -209,6 +210,10 @@ export interface CreateOrder {
|
|
|
209
210
|
* A reference to the resource location
|
|
210
211
|
*/
|
|
211
212
|
'originalOrderRef'?: string;
|
|
213
|
+
/**
|
|
214
|
+
* The project code of a client you want to order on the behalf of. If provided, the order will be created for the client\'s project.
|
|
215
|
+
*/
|
|
216
|
+
'client'?: string;
|
|
212
217
|
}
|
|
213
218
|
/**
|
|
214
219
|
* Contact information for the order
|
|
@@ -370,6 +375,7 @@ export interface Enquiry {
|
|
|
370
375
|
* The unique id of the user who owns the enquiry
|
|
371
376
|
*/
|
|
372
377
|
'owner': string | null;
|
|
378
|
+
'tracking': EnquiryTracking;
|
|
373
379
|
}
|
|
374
380
|
|
|
375
381
|
export const EnquiryStatusEnum = {
|
|
@@ -390,6 +396,13 @@ export interface EnquiryExtraInputsInner {
|
|
|
390
396
|
*/
|
|
391
397
|
export type EnquiryExtraInputsInnerValue = Array<string | null> | string;
|
|
392
398
|
|
|
399
|
+
export interface EnquiryTracking {
|
|
400
|
+
'utmSource': string | null;
|
|
401
|
+
'utmMedium': string | null;
|
|
402
|
+
'utmCampaign': string | null;
|
|
403
|
+
'utmTerm': string | null;
|
|
404
|
+
'utmContent': string | null;
|
|
405
|
+
}
|
|
393
406
|
export interface ExportOrders202Response {
|
|
394
407
|
/**
|
|
395
408
|
* A message describing the export status
|
|
@@ -524,6 +537,7 @@ export interface Order {
|
|
|
524
537
|
'status'?: OrderStatus;
|
|
525
538
|
'contactInformation': ContactInformation;
|
|
526
539
|
'shippingAddress': Address;
|
|
540
|
+
'billingAddress'?: Address;
|
|
527
541
|
/**
|
|
528
542
|
* ISO 8601 Timestamp
|
|
529
543
|
*/
|
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 API
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.37.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -183,6 +183,7 @@ export interface CreateOrder {
|
|
|
183
183
|
'merchantReference'?: string | null;
|
|
184
184
|
'contactInformation': CreateOrderContactInformation;
|
|
185
185
|
'shippingAddress': Address;
|
|
186
|
+
'billingAddress'?: Address;
|
|
186
187
|
'customsInformation'?: CustomsInformation;
|
|
187
188
|
/**
|
|
188
189
|
* Items to be ordered
|
|
@@ -193,6 +194,10 @@ export interface CreateOrder {
|
|
|
193
194
|
* A reference to the resource location
|
|
194
195
|
*/
|
|
195
196
|
'originalOrderRef'?: string;
|
|
197
|
+
/**
|
|
198
|
+
* The project code of a client you want to order on the behalf of. If provided, the order will be created for the client\'s project.
|
|
199
|
+
*/
|
|
200
|
+
'client'?: string;
|
|
196
201
|
}
|
|
197
202
|
/**
|
|
198
203
|
* Contact information for the order
|
|
@@ -351,6 +356,7 @@ export interface Enquiry {
|
|
|
351
356
|
* The unique id of the user who owns the enquiry
|
|
352
357
|
*/
|
|
353
358
|
'owner': string | null;
|
|
359
|
+
'tracking': EnquiryTracking;
|
|
354
360
|
}
|
|
355
361
|
export declare const EnquiryStatusEnum: {
|
|
356
362
|
readonly New: "New";
|
|
@@ -367,6 +373,13 @@ export interface EnquiryExtraInputsInner {
|
|
|
367
373
|
* @type EnquiryExtraInputsInnerValue
|
|
368
374
|
*/
|
|
369
375
|
export type EnquiryExtraInputsInnerValue = Array<string | null> | string;
|
|
376
|
+
export interface EnquiryTracking {
|
|
377
|
+
'utmSource': string | null;
|
|
378
|
+
'utmMedium': string | null;
|
|
379
|
+
'utmCampaign': string | null;
|
|
380
|
+
'utmTerm': string | null;
|
|
381
|
+
'utmContent': string | null;
|
|
382
|
+
}
|
|
370
383
|
export interface ExportOrders202Response {
|
|
371
384
|
/**
|
|
372
385
|
* A message describing the export status
|
|
@@ -499,6 +512,7 @@ export interface Order {
|
|
|
499
512
|
'status'?: OrderStatus;
|
|
500
513
|
'contactInformation': ContactInformation;
|
|
501
514
|
'shippingAddress': Address;
|
|
515
|
+
'billingAddress'?: Address;
|
|
502
516
|
/**
|
|
503
517
|
* ISO 8601 Timestamp
|
|
504
518
|
*/
|
package/dist/api.js
CHANGED
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 API
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.37.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -183,6 +183,7 @@ export interface CreateOrder {
|
|
|
183
183
|
'merchantReference'?: string | null;
|
|
184
184
|
'contactInformation': CreateOrderContactInformation;
|
|
185
185
|
'shippingAddress': Address;
|
|
186
|
+
'billingAddress'?: Address;
|
|
186
187
|
'customsInformation'?: CustomsInformation;
|
|
187
188
|
/**
|
|
188
189
|
* Items to be ordered
|
|
@@ -193,6 +194,10 @@ export interface CreateOrder {
|
|
|
193
194
|
* A reference to the resource location
|
|
194
195
|
*/
|
|
195
196
|
'originalOrderRef'?: string;
|
|
197
|
+
/**
|
|
198
|
+
* The project code of a client you want to order on the behalf of. If provided, the order will be created for the client\'s project.
|
|
199
|
+
*/
|
|
200
|
+
'client'?: string;
|
|
196
201
|
}
|
|
197
202
|
/**
|
|
198
203
|
* Contact information for the order
|
|
@@ -351,6 +356,7 @@ export interface Enquiry {
|
|
|
351
356
|
* The unique id of the user who owns the enquiry
|
|
352
357
|
*/
|
|
353
358
|
'owner': string | null;
|
|
359
|
+
'tracking': EnquiryTracking;
|
|
354
360
|
}
|
|
355
361
|
export declare const EnquiryStatusEnum: {
|
|
356
362
|
readonly New: "New";
|
|
@@ -367,6 +373,13 @@ export interface EnquiryExtraInputsInner {
|
|
|
367
373
|
* @type EnquiryExtraInputsInnerValue
|
|
368
374
|
*/
|
|
369
375
|
export type EnquiryExtraInputsInnerValue = Array<string | null> | string;
|
|
376
|
+
export interface EnquiryTracking {
|
|
377
|
+
'utmSource': string | null;
|
|
378
|
+
'utmMedium': string | null;
|
|
379
|
+
'utmCampaign': string | null;
|
|
380
|
+
'utmTerm': string | null;
|
|
381
|
+
'utmContent': string | null;
|
|
382
|
+
}
|
|
370
383
|
export interface ExportOrders202Response {
|
|
371
384
|
/**
|
|
372
385
|
* A message describing the export status
|
|
@@ -499,6 +512,7 @@ export interface Order {
|
|
|
499
512
|
'status'?: OrderStatus;
|
|
500
513
|
'contactInformation': ContactInformation;
|
|
501
514
|
'shippingAddress': Address;
|
|
515
|
+
'billingAddress'?: Address;
|
|
502
516
|
/**
|
|
503
517
|
* ISO 8601 Timestamp
|
|
504
518
|
*/
|
package/dist/esm/api.js
CHANGED
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
package/docs/CreateOrder.md
CHANGED
|
@@ -9,10 +9,12 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**merchantReference** | **string** | A custom reference to the merchant\'s order. | [optional] [default to undefined]
|
|
10
10
|
**contactInformation** | [**CreateOrderContactInformation**](CreateOrderContactInformation.md) | | [default to undefined]
|
|
11
11
|
**shippingAddress** | [**Address**](Address.md) | | [default to undefined]
|
|
12
|
+
**billingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
12
13
|
**customsInformation** | [**CustomsInformation**](CustomsInformation.md) | | [optional] [default to undefined]
|
|
13
14
|
**items** | [**Array<OrderItem1>**](OrderItem1.md) | Items to be ordered | [default to undefined]
|
|
14
15
|
**preferredFulfillers** | **Array<string>** | | [optional] [default to undefined]
|
|
15
16
|
**originalOrderRef** | **string** | A reference to the resource location | [optional] [default to undefined]
|
|
17
|
+
**client** | **string** | The project code of a client you want to order on the behalf of. If provided, the order will be created for the client\'s project. | [optional] [default to undefined]
|
|
16
18
|
|
|
17
19
|
## Example
|
|
18
20
|
|
|
@@ -23,10 +25,12 @@ const instance: CreateOrder = {
|
|
|
23
25
|
merchantReference,
|
|
24
26
|
contactInformation,
|
|
25
27
|
shippingAddress,
|
|
28
|
+
billingAddress,
|
|
26
29
|
customsInformation,
|
|
27
30
|
items,
|
|
28
31
|
preferredFulfillers,
|
|
29
32
|
originalOrderRef,
|
|
33
|
+
client,
|
|
30
34
|
};
|
|
31
35
|
```
|
|
32
36
|
|
package/docs/Enquiry.md
CHANGED
|
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**extraInputs** | [**Array<EnquiryExtraInputsInner>**](EnquiryExtraInputsInner.md) | | [default to undefined]
|
|
20
20
|
**chatChannelRef** | **string** | Reference to the chat channel resource | [optional] [default to undefined]
|
|
21
21
|
**owner** | **string** | The unique id of the user who owns the enquiry | [default to undefined]
|
|
22
|
+
**tracking** | [**EnquiryTracking**](EnquiryTracking.md) | | [default to undefined]
|
|
22
23
|
|
|
23
24
|
## Example
|
|
24
25
|
|
|
@@ -40,6 +41,7 @@ const instance: Enquiry = {
|
|
|
40
41
|
extraInputs,
|
|
41
42
|
chatChannelRef,
|
|
42
43
|
owner,
|
|
44
|
+
tracking,
|
|
43
45
|
};
|
|
44
46
|
```
|
|
45
47
|
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# EnquiryTracking
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**utmSource** | **string** | | [default to undefined]
|
|
9
|
+
**utmMedium** | **string** | | [default to undefined]
|
|
10
|
+
**utmCampaign** | **string** | | [default to undefined]
|
|
11
|
+
**utmTerm** | **string** | | [default to undefined]
|
|
12
|
+
**utmContent** | **string** | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { EnquiryTracking } from '@teemill/platform';
|
|
18
|
+
|
|
19
|
+
const instance: EnquiryTracking = {
|
|
20
|
+
utmSource,
|
|
21
|
+
utmMedium,
|
|
22
|
+
utmCampaign,
|
|
23
|
+
utmTerm,
|
|
24
|
+
utmContent,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[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/Order.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**status** | [**OrderStatus**](OrderStatus.md) | | [optional] [default to undefined]
|
|
11
11
|
**contactInformation** | [**ContactInformation**](ContactInformation.md) | | [default to undefined]
|
|
12
12
|
**shippingAddress** | [**Address**](Address.md) | | [default to undefined]
|
|
13
|
+
**billingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
13
14
|
**createdAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
|
|
14
15
|
**updatedAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
|
|
15
16
|
**merchantReference** | **string** | A custom reference to the merchant\'s order that will be displayed on the shipping label. | [optional] [default to undefined]
|
|
@@ -38,6 +39,7 @@ const instance: Order = {
|
|
|
38
39
|
status,
|
|
39
40
|
contactInformation,
|
|
40
41
|
shippingAddress,
|
|
42
|
+
billingAddress,
|
|
41
43
|
createdAt,
|
|
42
44
|
updatedAt,
|
|
43
45
|
merchantReference,
|
package/index.ts
CHANGED