@teemill/platform 0.30.5 → 0.31.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 +10 -2
- package/api.ts +372 -2
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +276 -2
- package/dist/api.js +124 -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 +276 -2
- package/dist/esm/api.js +123 -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/AmendmentLog.md +30 -0
- package/docs/BulkCreateReviewPayload.md +20 -0
- package/docs/BulkCreatedReviews.md +20 -0
- package/docs/CreateReview201Response.md +42 -0
- package/docs/CreateReviewPayload.md +34 -0
- package/docs/CreateReviewPayloadAuthor.md +22 -0
- package/docs/CreateReviewRequest.md +36 -0
- package/docs/OrderItem.md +2 -0
- package/docs/ReviewsApi.md +81 -0
- package/index.ts +1 -1
- package/package.json +1 -1
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.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -117,6 +117,54 @@ export declare const AmendOrderRequestAmendmentsInnerActionEnum: {
|
|
|
117
117
|
readonly Exchange: "exchange";
|
|
118
118
|
};
|
|
119
119
|
export type AmendOrderRequestAmendmentsInnerActionEnum = typeof AmendOrderRequestAmendmentsInnerActionEnum[keyof typeof AmendOrderRequestAmendmentsInnerActionEnum];
|
|
120
|
+
/**
|
|
121
|
+
*
|
|
122
|
+
* @export
|
|
123
|
+
* @interface AmendmentLog
|
|
124
|
+
*/
|
|
125
|
+
export interface AmendmentLog {
|
|
126
|
+
/**
|
|
127
|
+
* Unique object identifier
|
|
128
|
+
* @type {string}
|
|
129
|
+
* @memberof AmendmentLog
|
|
130
|
+
*/
|
|
131
|
+
'id': string;
|
|
132
|
+
/**
|
|
133
|
+
* A reference to the order item that was amended.
|
|
134
|
+
* @type {string}
|
|
135
|
+
* @memberof AmendmentLog
|
|
136
|
+
*/
|
|
137
|
+
'orderItemId': string;
|
|
138
|
+
/**
|
|
139
|
+
* A reference to the top level order item that was amended, useful for finding the original item within a chain of exchanges, for example.
|
|
140
|
+
* @type {string}
|
|
141
|
+
* @memberof AmendmentLog
|
|
142
|
+
*/
|
|
143
|
+
'originalOrderItemId': string;
|
|
144
|
+
/**
|
|
145
|
+
*
|
|
146
|
+
* @type {string}
|
|
147
|
+
* @memberof AmendmentLog
|
|
148
|
+
*/
|
|
149
|
+
'amendmentType': AmendmentLogAmendmentTypeEnum;
|
|
150
|
+
/**
|
|
151
|
+
*
|
|
152
|
+
* @type {number}
|
|
153
|
+
* @memberof AmendmentLog
|
|
154
|
+
*/
|
|
155
|
+
'quantity': number;
|
|
156
|
+
/**
|
|
157
|
+
* ISO 8601 Timestamp
|
|
158
|
+
* @type {string}
|
|
159
|
+
* @memberof AmendmentLog
|
|
160
|
+
*/
|
|
161
|
+
'createdAt': string;
|
|
162
|
+
}
|
|
163
|
+
export declare const AmendmentLogAmendmentTypeEnum: {
|
|
164
|
+
readonly Refund: "refund";
|
|
165
|
+
readonly Exchange: "exchange";
|
|
166
|
+
};
|
|
167
|
+
export type AmendmentLogAmendmentTypeEnum = typeof AmendmentLogAmendmentTypeEnum[keyof typeof AmendmentLogAmendmentTypeEnum];
|
|
120
168
|
/**
|
|
121
169
|
*
|
|
122
170
|
* @export
|
|
@@ -136,6 +184,32 @@ export interface ApiError {
|
|
|
136
184
|
*/
|
|
137
185
|
'message': string;
|
|
138
186
|
}
|
|
187
|
+
/**
|
|
188
|
+
*
|
|
189
|
+
* @export
|
|
190
|
+
* @interface BulkCreateReviewPayload
|
|
191
|
+
*/
|
|
192
|
+
export interface BulkCreateReviewPayload {
|
|
193
|
+
/**
|
|
194
|
+
*
|
|
195
|
+
* @type {Array<CreateReviewPayload>}
|
|
196
|
+
* @memberof BulkCreateReviewPayload
|
|
197
|
+
*/
|
|
198
|
+
'reviews': Array<CreateReviewPayload>;
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
*
|
|
202
|
+
* @export
|
|
203
|
+
* @interface BulkCreatedReviews
|
|
204
|
+
*/
|
|
205
|
+
export interface BulkCreatedReviews {
|
|
206
|
+
/**
|
|
207
|
+
*
|
|
208
|
+
* @type {Array<Review>}
|
|
209
|
+
* @memberof BulkCreatedReviews
|
|
210
|
+
*/
|
|
211
|
+
'reviews': Array<Review>;
|
|
212
|
+
}
|
|
139
213
|
/**
|
|
140
214
|
*
|
|
141
215
|
* @export
|
|
@@ -344,6 +418,90 @@ export interface CreateOrderContactInformation {
|
|
|
344
418
|
*/
|
|
345
419
|
'phone'?: string | null;
|
|
346
420
|
}
|
|
421
|
+
/**
|
|
422
|
+
* @type CreateReview201Response
|
|
423
|
+
* @export
|
|
424
|
+
*/
|
|
425
|
+
export type CreateReview201Response = BulkCreatedReviews | Review;
|
|
426
|
+
/**
|
|
427
|
+
*
|
|
428
|
+
* @export
|
|
429
|
+
* @interface CreateReviewPayload
|
|
430
|
+
*/
|
|
431
|
+
export interface CreateReviewPayload {
|
|
432
|
+
/**
|
|
433
|
+
*
|
|
434
|
+
* @type {CreateReviewPayloadAuthor}
|
|
435
|
+
* @memberof CreateReviewPayload
|
|
436
|
+
*/
|
|
437
|
+
'author': CreateReviewPayloadAuthor;
|
|
438
|
+
/**
|
|
439
|
+
* The title of the review
|
|
440
|
+
* @type {string}
|
|
441
|
+
* @memberof CreateReviewPayload
|
|
442
|
+
*/
|
|
443
|
+
'title'?: string;
|
|
444
|
+
/**
|
|
445
|
+
* The text of the review
|
|
446
|
+
* @type {string}
|
|
447
|
+
* @memberof CreateReviewPayload
|
|
448
|
+
*/
|
|
449
|
+
'text': string;
|
|
450
|
+
/**
|
|
451
|
+
* A reference to the product being ordered
|
|
452
|
+
* @type {string}
|
|
453
|
+
* @memberof CreateReviewPayload
|
|
454
|
+
*/
|
|
455
|
+
'productRef': string;
|
|
456
|
+
/**
|
|
457
|
+
* The rating of the review
|
|
458
|
+
* @type {number}
|
|
459
|
+
* @memberof CreateReviewPayload
|
|
460
|
+
*/
|
|
461
|
+
'rating': number;
|
|
462
|
+
/**
|
|
463
|
+
*
|
|
464
|
+
* @type {Array<Image>}
|
|
465
|
+
* @memberof CreateReviewPayload
|
|
466
|
+
*/
|
|
467
|
+
'images'?: Array<Image>;
|
|
468
|
+
/**
|
|
469
|
+
* Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
|
|
470
|
+
* @type {boolean}
|
|
471
|
+
* @memberof CreateReviewPayload
|
|
472
|
+
*/
|
|
473
|
+
'enabled': boolean;
|
|
474
|
+
/**
|
|
475
|
+
* A reference to the project being ordered
|
|
476
|
+
* @type {string}
|
|
477
|
+
* @memberof CreateReviewPayload
|
|
478
|
+
*/
|
|
479
|
+
'projectRef': string;
|
|
480
|
+
}
|
|
481
|
+
/**
|
|
482
|
+
*
|
|
483
|
+
* @export
|
|
484
|
+
* @interface CreateReviewPayloadAuthor
|
|
485
|
+
*/
|
|
486
|
+
export interface CreateReviewPayloadAuthor {
|
|
487
|
+
/**
|
|
488
|
+
* The name of the author
|
|
489
|
+
* @type {string}
|
|
490
|
+
* @memberof CreateReviewPayloadAuthor
|
|
491
|
+
*/
|
|
492
|
+
'name'?: string;
|
|
493
|
+
/**
|
|
494
|
+
* The email of the author
|
|
495
|
+
* @type {string}
|
|
496
|
+
* @memberof CreateReviewPayloadAuthor
|
|
497
|
+
*/
|
|
498
|
+
'email'?: string;
|
|
499
|
+
}
|
|
500
|
+
/**
|
|
501
|
+
* @type CreateReviewRequest
|
|
502
|
+
* @export
|
|
503
|
+
*/
|
|
504
|
+
export type CreateReviewRequest = BulkCreateReviewPayload | CreateReviewPayload;
|
|
347
505
|
/**
|
|
348
506
|
* The customer that has placed an order on your platform
|
|
349
507
|
* @export
|
|
@@ -1169,6 +1327,12 @@ export interface OrderItem {
|
|
|
1169
1327
|
* @memberof OrderItem
|
|
1170
1328
|
*/
|
|
1171
1329
|
'recipientCost'?: Price;
|
|
1330
|
+
/**
|
|
1331
|
+
*
|
|
1332
|
+
* @type {Array<AmendmentLog>}
|
|
1333
|
+
* @memberof OrderItem
|
|
1334
|
+
*/
|
|
1335
|
+
'amendmentLogs'?: Array<AmendmentLog>;
|
|
1172
1336
|
}
|
|
1173
1337
|
/**
|
|
1174
1338
|
*
|
|
@@ -1581,7 +1745,7 @@ export interface Review {
|
|
|
1581
1745
|
* @type {Array<ReviewReply>}
|
|
1582
1746
|
* @memberof Review
|
|
1583
1747
|
*/
|
|
1584
|
-
'replies'?: Array<ReviewReply
|
|
1748
|
+
'replies'?: Array<ReviewReply> | null;
|
|
1585
1749
|
}
|
|
1586
1750
|
/**
|
|
1587
1751
|
*
|
|
@@ -4429,6 +4593,22 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
4429
4593
|
* @export
|
|
4430
4594
|
*/
|
|
4431
4595
|
export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4596
|
+
/**
|
|
4597
|
+
*
|
|
4598
|
+
* @summary Create a review
|
|
4599
|
+
* @param {string} project Project unique identifier
|
|
4600
|
+
* @param {string} platformId The platform identifier
|
|
4601
|
+
* @param {CreateReviewRequest} createReviewRequest
|
|
4602
|
+
* @param {number} [pageToken] Page reference token
|
|
4603
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4604
|
+
* @param {string} [search] Search term to filter results
|
|
4605
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
4606
|
+
* @param {string} [start] Start of date range to filter by
|
|
4607
|
+
* @param {string} [end] End of date range to filter by
|
|
4608
|
+
* @param {*} [options] Override http request option.
|
|
4609
|
+
* @throws {RequiredError}
|
|
4610
|
+
*/
|
|
4611
|
+
createReview: (project: string, platformId: string, createReviewRequest: CreateReviewRequest, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4432
4612
|
/**
|
|
4433
4613
|
* Export reviews as a CSV file.
|
|
4434
4614
|
* @summary Export reviews
|
|
@@ -4482,6 +4662,22 @@ export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4482
4662
|
* @export
|
|
4483
4663
|
*/
|
|
4484
4664
|
export declare const ReviewsApiFp: (configuration?: Configuration) => {
|
|
4665
|
+
/**
|
|
4666
|
+
*
|
|
4667
|
+
* @summary Create a review
|
|
4668
|
+
* @param {string} project Project unique identifier
|
|
4669
|
+
* @param {string} platformId The platform identifier
|
|
4670
|
+
* @param {CreateReviewRequest} createReviewRequest
|
|
4671
|
+
* @param {number} [pageToken] Page reference token
|
|
4672
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4673
|
+
* @param {string} [search] Search term to filter results
|
|
4674
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
4675
|
+
* @param {string} [start] Start of date range to filter by
|
|
4676
|
+
* @param {string} [end] End of date range to filter by
|
|
4677
|
+
* @param {*} [options] Override http request option.
|
|
4678
|
+
* @throws {RequiredError}
|
|
4679
|
+
*/
|
|
4680
|
+
createReview(project: string, platformId: string, createReviewRequest: CreateReviewRequest, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReview201Response>>;
|
|
4485
4681
|
/**
|
|
4486
4682
|
* Export reviews as a CSV file.
|
|
4487
4683
|
* @summary Export reviews
|
|
@@ -4535,6 +4731,14 @@ export declare const ReviewsApiFp: (configuration?: Configuration) => {
|
|
|
4535
4731
|
* @export
|
|
4536
4732
|
*/
|
|
4537
4733
|
export declare const ReviewsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4734
|
+
/**
|
|
4735
|
+
*
|
|
4736
|
+
* @summary Create a review
|
|
4737
|
+
* @param {ReviewsApiCreateReviewRequest} requestParameters Request parameters.
|
|
4738
|
+
* @param {*} [options] Override http request option.
|
|
4739
|
+
* @throws {RequiredError}
|
|
4740
|
+
*/
|
|
4741
|
+
createReview(requestParameters: ReviewsApiCreateReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateReview201Response>;
|
|
4538
4742
|
/**
|
|
4539
4743
|
* Export reviews as a CSV file.
|
|
4540
4744
|
* @summary Export reviews
|
|
@@ -4568,6 +4772,67 @@ export declare const ReviewsApiFactory: (configuration?: Configuration, basePath
|
|
|
4568
4772
|
*/
|
|
4569
4773
|
moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review>;
|
|
4570
4774
|
};
|
|
4775
|
+
/**
|
|
4776
|
+
* Request parameters for createReview operation in ReviewsApi.
|
|
4777
|
+
* @export
|
|
4778
|
+
* @interface ReviewsApiCreateReviewRequest
|
|
4779
|
+
*/
|
|
4780
|
+
export interface ReviewsApiCreateReviewRequest {
|
|
4781
|
+
/**
|
|
4782
|
+
* Project unique identifier
|
|
4783
|
+
* @type {string}
|
|
4784
|
+
* @memberof ReviewsApiCreateReview
|
|
4785
|
+
*/
|
|
4786
|
+
readonly project: string;
|
|
4787
|
+
/**
|
|
4788
|
+
* The platform identifier
|
|
4789
|
+
* @type {string}
|
|
4790
|
+
* @memberof ReviewsApiCreateReview
|
|
4791
|
+
*/
|
|
4792
|
+
readonly platformId: string;
|
|
4793
|
+
/**
|
|
4794
|
+
*
|
|
4795
|
+
* @type {CreateReviewRequest}
|
|
4796
|
+
* @memberof ReviewsApiCreateReview
|
|
4797
|
+
*/
|
|
4798
|
+
readonly createReviewRequest: CreateReviewRequest;
|
|
4799
|
+
/**
|
|
4800
|
+
* Page reference token
|
|
4801
|
+
* @type {number}
|
|
4802
|
+
* @memberof ReviewsApiCreateReview
|
|
4803
|
+
*/
|
|
4804
|
+
readonly pageToken?: number;
|
|
4805
|
+
/**
|
|
4806
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4807
|
+
* @type {number}
|
|
4808
|
+
* @memberof ReviewsApiCreateReview
|
|
4809
|
+
*/
|
|
4810
|
+
readonly pageSize?: number;
|
|
4811
|
+
/**
|
|
4812
|
+
* Search term to filter results
|
|
4813
|
+
* @type {string}
|
|
4814
|
+
* @memberof ReviewsApiCreateReview
|
|
4815
|
+
*/
|
|
4816
|
+
readonly search?: string;
|
|
4817
|
+
/**
|
|
4818
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
4819
|
+
* @type {Array<string>}
|
|
4820
|
+
* @memberof ReviewsApiCreateReview
|
|
4821
|
+
*/
|
|
4822
|
+
readonly sortBy?: Array<string>;
|
|
4823
|
+
/**
|
|
4824
|
+
* Start of date range to filter by
|
|
4825
|
+
* @type {string}
|
|
4826
|
+
* @memberof ReviewsApiCreateReview
|
|
4827
|
+
*/
|
|
4828
|
+
readonly start?: string;
|
|
4829
|
+
/**
|
|
4830
|
+
* End of date range to filter by
|
|
4831
|
+
* @type {string}
|
|
4832
|
+
* @memberof ReviewsApiCreateReview
|
|
4833
|
+
*/
|
|
4834
|
+
readonly end?: string;
|
|
4835
|
+
}
|
|
4571
4836
|
/**
|
|
4572
4837
|
* Request parameters for exportReviews operation in ReviewsApi.
|
|
4573
4838
|
* @export
|
|
@@ -4717,6 +4982,15 @@ export interface ReviewsApiModerateReviewRequest {
|
|
|
4717
4982
|
* @extends {BaseAPI}
|
|
4718
4983
|
*/
|
|
4719
4984
|
export declare class ReviewsApi extends BaseAPI {
|
|
4985
|
+
/**
|
|
4986
|
+
*
|
|
4987
|
+
* @summary Create a review
|
|
4988
|
+
* @param {ReviewsApiCreateReviewRequest} requestParameters Request parameters.
|
|
4989
|
+
* @param {*} [options] Override http request option.
|
|
4990
|
+
* @throws {RequiredError}
|
|
4991
|
+
* @memberof ReviewsApi
|
|
4992
|
+
*/
|
|
4993
|
+
createReview(requestParameters: ReviewsApiCreateReviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReview201Response, any>>;
|
|
4720
4994
|
/**
|
|
4721
4995
|
* Export reviews as a CSV file.
|
|
4722
4996
|
* @summary Export reviews
|
package/dist/esm/api.js
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.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -30,6 +30,10 @@ export const AmendOrderRequestAmendmentsInnerActionEnum = {
|
|
|
30
30
|
Refund: 'refund',
|
|
31
31
|
Exchange: 'exchange'
|
|
32
32
|
};
|
|
33
|
+
export const AmendmentLogAmendmentTypeEnum = {
|
|
34
|
+
Refund: 'refund',
|
|
35
|
+
Exchange: 'exchange'
|
|
36
|
+
};
|
|
33
37
|
export const CustomsInformationPreRegistrationTypeEnum = {
|
|
34
38
|
Ioss: 'IOSS'
|
|
35
39
|
};
|
|
@@ -3121,6 +3125,79 @@ export class PlatformApi extends BaseAPI {
|
|
|
3121
3125
|
*/
|
|
3122
3126
|
export const ReviewsApiAxiosParamCreator = function (configuration) {
|
|
3123
3127
|
return {
|
|
3128
|
+
/**
|
|
3129
|
+
*
|
|
3130
|
+
* @summary Create a review
|
|
3131
|
+
* @param {string} project Project unique identifier
|
|
3132
|
+
* @param {string} platformId The platform identifier
|
|
3133
|
+
* @param {CreateReviewRequest} createReviewRequest
|
|
3134
|
+
* @param {number} [pageToken] Page reference token
|
|
3135
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3136
|
+
* @param {string} [search] Search term to filter results
|
|
3137
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3138
|
+
* @param {string} [start] Start of date range to filter by
|
|
3139
|
+
* @param {string} [end] End of date range to filter by
|
|
3140
|
+
* @param {*} [options] Override http request option.
|
|
3141
|
+
* @throws {RequiredError}
|
|
3142
|
+
*/
|
|
3143
|
+
createReview: (project_1, platformId_1, createReviewRequest_1, pageToken_1, pageSize_1, search_1, sortBy_1, start_1, end_1, ...args_1) => __awaiter(this, [project_1, platformId_1, createReviewRequest_1, pageToken_1, pageSize_1, search_1, sortBy_1, start_1, end_1, ...args_1], void 0, function* (project, platformId, createReviewRequest, pageToken, pageSize, search, sortBy, start, end, options = {}) {
|
|
3144
|
+
// verify required parameter 'project' is not null or undefined
|
|
3145
|
+
assertParamExists('createReview', 'project', project);
|
|
3146
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
3147
|
+
assertParamExists('createReview', 'platformId', platformId);
|
|
3148
|
+
// verify required parameter 'createReviewRequest' is not null or undefined
|
|
3149
|
+
assertParamExists('createReview', 'createReviewRequest', createReviewRequest);
|
|
3150
|
+
const localVarPath = `/v1/platform/{platformId}/reviews`
|
|
3151
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
3152
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3153
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3154
|
+
let baseOptions;
|
|
3155
|
+
if (configuration) {
|
|
3156
|
+
baseOptions = configuration.baseOptions;
|
|
3157
|
+
}
|
|
3158
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
3159
|
+
const localVarHeaderParameter = {};
|
|
3160
|
+
const localVarQueryParameter = {};
|
|
3161
|
+
// authentication session-oauth required
|
|
3162
|
+
// oauth required
|
|
3163
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
3164
|
+
// authentication api-key required
|
|
3165
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
3166
|
+
if (project !== undefined) {
|
|
3167
|
+
localVarQueryParameter['project'] = project;
|
|
3168
|
+
}
|
|
3169
|
+
if (pageToken !== undefined) {
|
|
3170
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
3171
|
+
}
|
|
3172
|
+
if (pageSize !== undefined) {
|
|
3173
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
3174
|
+
}
|
|
3175
|
+
if (search !== undefined) {
|
|
3176
|
+
localVarQueryParameter['search'] = search;
|
|
3177
|
+
}
|
|
3178
|
+
if (sortBy) {
|
|
3179
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
3180
|
+
}
|
|
3181
|
+
if (start !== undefined) {
|
|
3182
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
3183
|
+
start.toISOString() :
|
|
3184
|
+
start;
|
|
3185
|
+
}
|
|
3186
|
+
if (end !== undefined) {
|
|
3187
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
3188
|
+
end.toISOString() :
|
|
3189
|
+
end;
|
|
3190
|
+
}
|
|
3191
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3192
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3193
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3194
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
3195
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createReviewRequest, localVarRequestOptions, configuration);
|
|
3196
|
+
return {
|
|
3197
|
+
url: toPathString(localVarUrlObj),
|
|
3198
|
+
options: localVarRequestOptions,
|
|
3199
|
+
};
|
|
3200
|
+
}),
|
|
3124
3201
|
/**
|
|
3125
3202
|
* Export reviews as a CSV file.
|
|
3126
3203
|
* @summary Export reviews
|
|
@@ -3343,6 +3420,30 @@ export const ReviewsApiAxiosParamCreator = function (configuration) {
|
|
|
3343
3420
|
export const ReviewsApiFp = function (configuration) {
|
|
3344
3421
|
const localVarAxiosParamCreator = ReviewsApiAxiosParamCreator(configuration);
|
|
3345
3422
|
return {
|
|
3423
|
+
/**
|
|
3424
|
+
*
|
|
3425
|
+
* @summary Create a review
|
|
3426
|
+
* @param {string} project Project unique identifier
|
|
3427
|
+
* @param {string} platformId The platform identifier
|
|
3428
|
+
* @param {CreateReviewRequest} createReviewRequest
|
|
3429
|
+
* @param {number} [pageToken] Page reference token
|
|
3430
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3431
|
+
* @param {string} [search] Search term to filter results
|
|
3432
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3433
|
+
* @param {string} [start] Start of date range to filter by
|
|
3434
|
+
* @param {string} [end] End of date range to filter by
|
|
3435
|
+
* @param {*} [options] Override http request option.
|
|
3436
|
+
* @throws {RequiredError}
|
|
3437
|
+
*/
|
|
3438
|
+
createReview(project, platformId, createReviewRequest, pageToken, pageSize, search, sortBy, start, end, options) {
|
|
3439
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3440
|
+
var _a, _b, _c;
|
|
3441
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createReview(project, platformId, createReviewRequest, pageToken, pageSize, search, sortBy, start, end, options);
|
|
3442
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3443
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReviewsApi.createReview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3444
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3445
|
+
});
|
|
3446
|
+
},
|
|
3346
3447
|
/**
|
|
3347
3448
|
* Export reviews as a CSV file.
|
|
3348
3449
|
* @summary Export reviews
|
|
@@ -3431,6 +3532,16 @@ export const ReviewsApiFp = function (configuration) {
|
|
|
3431
3532
|
export const ReviewsApiFactory = function (configuration, basePath, axios) {
|
|
3432
3533
|
const localVarFp = ReviewsApiFp(configuration);
|
|
3433
3534
|
return {
|
|
3535
|
+
/**
|
|
3536
|
+
*
|
|
3537
|
+
* @summary Create a review
|
|
3538
|
+
* @param {ReviewsApiCreateReviewRequest} requestParameters Request parameters.
|
|
3539
|
+
* @param {*} [options] Override http request option.
|
|
3540
|
+
* @throws {RequiredError}
|
|
3541
|
+
*/
|
|
3542
|
+
createReview(requestParameters, options) {
|
|
3543
|
+
return localVarFp.createReview(requestParameters.project, requestParameters.platformId, requestParameters.createReviewRequest, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
3544
|
+
},
|
|
3434
3545
|
/**
|
|
3435
3546
|
* Export reviews as a CSV file.
|
|
3436
3547
|
* @summary Export reviews
|
|
@@ -3480,6 +3591,17 @@ export const ReviewsApiFactory = function (configuration, basePath, axios) {
|
|
|
3480
3591
|
* @extends {BaseAPI}
|
|
3481
3592
|
*/
|
|
3482
3593
|
export class ReviewsApi extends BaseAPI {
|
|
3594
|
+
/**
|
|
3595
|
+
*
|
|
3596
|
+
* @summary Create a review
|
|
3597
|
+
* @param {ReviewsApiCreateReviewRequest} requestParameters Request parameters.
|
|
3598
|
+
* @param {*} [options] Override http request option.
|
|
3599
|
+
* @throws {RequiredError}
|
|
3600
|
+
* @memberof ReviewsApi
|
|
3601
|
+
*/
|
|
3602
|
+
createReview(requestParameters, options) {
|
|
3603
|
+
return ReviewsApiFp(this.configuration).createReview(requestParameters.project, requestParameters.platformId, requestParameters.createReviewRequest, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
3604
|
+
}
|
|
3483
3605
|
/**
|
|
3484
3606
|
* Export reviews as a CSV file.
|
|
3485
3607
|
* @summary Export reviews
|
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
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# AmendmentLog
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Unique object identifier | [default to undefined]
|
|
9
|
+
**orderItemId** | **string** | A reference to the order item that was amended. | [default to undefined]
|
|
10
|
+
**originalOrderItemId** | **string** | A reference to the top level order item that was amended, useful for finding the original item within a chain of exchanges, for example. | [default to undefined]
|
|
11
|
+
**amendmentType** | **string** | | [default to undefined]
|
|
12
|
+
**quantity** | **number** | | [default to undefined]
|
|
13
|
+
**createdAt** | **string** | ISO 8601 Timestamp | [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { AmendmentLog } from '@teemill/platform';
|
|
19
|
+
|
|
20
|
+
const instance: AmendmentLog = {
|
|
21
|
+
id,
|
|
22
|
+
orderItemId,
|
|
23
|
+
originalOrderItemId,
|
|
24
|
+
amendmentType,
|
|
25
|
+
quantity,
|
|
26
|
+
createdAt,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[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,20 @@
|
|
|
1
|
+
# BulkCreateReviewPayload
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**reviews** | [**Array<CreateReviewPayload>**](CreateReviewPayload.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { BulkCreateReviewPayload } from '@teemill/platform';
|
|
14
|
+
|
|
15
|
+
const instance: BulkCreateReviewPayload = {
|
|
16
|
+
reviews,
|
|
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)
|