@teemill/platform 0.14.4 → 0.16.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 +94 -2
- package/api.ts +571 -893
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +460 -903
- package/dist/api.js +296 -164
- 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 +460 -903
- package/dist/esm/api.js +291 -155
- 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/Address.md +35 -0
- package/docs/ApiError.md +22 -0
- package/docs/AuthorizeStripe200Response.md +20 -0
- package/docs/ContactInformation.md +23 -0
- package/docs/Customer.md +33 -0
- package/docs/CustomersApi.md +229 -0
- package/docs/CustomersResponse.md +22 -0
- package/docs/DeliveryEstimates.md +22 -0
- package/docs/ExportOrders202Response.md +20 -0
- package/docs/Fulfiller.md +23 -0
- package/docs/FulfillerLocation.md +22 -0
- package/docs/FulfillersResponse.md +22 -0
- package/docs/Fulfillment.md +34 -0
- package/docs/FulfillmentItem.md +24 -0
- package/docs/Image.md +27 -0
- package/docs/ModerateReviewRequest.md +20 -0
- package/docs/Option.md +22 -0
- package/docs/Order.md +54 -0
- package/docs/OrderItem.md +42 -0
- package/docs/OrderStatus.md +16 -0
- package/docs/OrderTracking.md +24 -0
- package/docs/OrdersApi.md +410 -0
- package/docs/OrdersResponse.md +22 -0
- package/docs/Origin.md +22 -0
- package/docs/PaymentAccount.md +24 -0
- package/docs/PaymentApi.md +178 -0
- package/docs/Platform.md +38 -0
- package/docs/PlatformApi.md +122 -0
- package/docs/PlatformLogo.md +22 -0
- package/docs/Price.md +23 -0
- package/docs/Project.md +22 -0
- package/docs/Review.md +40 -0
- package/docs/ReviewAuthor.md +22 -0
- package/docs/ReviewImagesInner.md +22 -0
- package/docs/ReviewProduct.md +23 -0
- package/docs/ReviewReply.md +26 -0
- package/docs/ReviewReplyAuthor.md +20 -0
- package/docs/ReviewsApi.md +278 -0
- package/docs/ReviewsResponse.md +22 -0
- package/docs/ShippingMethod.md +34 -0
- package/docs/Statistics.md +24 -0
- package/docs/StatusHistoryItem.md +22 -0
- package/docs/UpdateFulfillmentRequest.md +20 -0
- package/docs/UpdatePlatformRequest.md +32 -0
- package/docs/ValidationError.md +20 -0
- package/docs/Variant.md +24 -0
- package/index.ts +1 -1
- package/package.json +1 -1
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.16.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -97,62 +97,6 @@ export interface ApiError {
|
|
|
97
97
|
*/
|
|
98
98
|
'message': string;
|
|
99
99
|
}
|
|
100
|
-
/**
|
|
101
|
-
* Application of a variant
|
|
102
|
-
* @export
|
|
103
|
-
* @interface Application
|
|
104
|
-
*/
|
|
105
|
-
export interface Application {
|
|
106
|
-
/**
|
|
107
|
-
* Placement of the application
|
|
108
|
-
* @type {string}
|
|
109
|
-
* @memberof Application
|
|
110
|
-
*/
|
|
111
|
-
'placement': string;
|
|
112
|
-
/**
|
|
113
|
-
*
|
|
114
|
-
* @type {ApplicationTechnology}
|
|
115
|
-
* @memberof Application
|
|
116
|
-
*/
|
|
117
|
-
'technology'?: ApplicationTechnology | null;
|
|
118
|
-
/**
|
|
119
|
-
*
|
|
120
|
-
* @type {Mockup}
|
|
121
|
-
* @memberof Application
|
|
122
|
-
*/
|
|
123
|
-
'mockup': Mockup;
|
|
124
|
-
/**
|
|
125
|
-
*
|
|
126
|
-
* @type {Output}
|
|
127
|
-
* @memberof Application
|
|
128
|
-
*/
|
|
129
|
-
'output'?: Output;
|
|
130
|
-
/**
|
|
131
|
-
* Whether the application requires pretreatment
|
|
132
|
-
* @type {boolean}
|
|
133
|
-
* @memberof Application
|
|
134
|
-
*/
|
|
135
|
-
'requiresPretreat'?: boolean;
|
|
136
|
-
}
|
|
137
|
-
/**
|
|
138
|
-
* Technology to be used for the application
|
|
139
|
-
* @export
|
|
140
|
-
* @interface ApplicationTechnology
|
|
141
|
-
*/
|
|
142
|
-
export interface ApplicationTechnology {
|
|
143
|
-
/**
|
|
144
|
-
* Unique object identifier
|
|
145
|
-
* @type {string}
|
|
146
|
-
* @memberof ApplicationTechnology
|
|
147
|
-
*/
|
|
148
|
-
'id'?: string;
|
|
149
|
-
/**
|
|
150
|
-
* A reference to the resource location
|
|
151
|
-
* @type {string}
|
|
152
|
-
* @memberof ApplicationTechnology
|
|
153
|
-
*/
|
|
154
|
-
'ref'?: string;
|
|
155
|
-
}
|
|
156
100
|
/**
|
|
157
101
|
*
|
|
158
102
|
* @export
|
|
@@ -458,83 +402,15 @@ export interface Image {
|
|
|
458
402
|
/**
|
|
459
403
|
*
|
|
460
404
|
* @export
|
|
461
|
-
* @interface
|
|
462
|
-
*/
|
|
463
|
-
export interface Metafield {
|
|
464
|
-
/**
|
|
465
|
-
* The unique identifier for a meta field
|
|
466
|
-
* @type {string}
|
|
467
|
-
* @memberof Metafield
|
|
468
|
-
*/
|
|
469
|
-
'key': string;
|
|
470
|
-
/**
|
|
471
|
-
* The data stored in the meta field. Always stored as a string, regardless of the meta field\'s type.
|
|
472
|
-
* @type {string}
|
|
473
|
-
* @memberof Metafield
|
|
474
|
-
*/
|
|
475
|
-
'value': string;
|
|
476
|
-
}
|
|
477
|
-
/**
|
|
478
|
-
* Configuration of the product mockup
|
|
479
|
-
* @export
|
|
480
|
-
* @interface Mockup
|
|
481
|
-
*/
|
|
482
|
-
export interface Mockup {
|
|
483
|
-
/**
|
|
484
|
-
* Base image of the mockup
|
|
485
|
-
* @type {string}
|
|
486
|
-
* @memberof Mockup
|
|
487
|
-
*/
|
|
488
|
-
'baseImage': string;
|
|
489
|
-
/**
|
|
490
|
-
*
|
|
491
|
-
* @type {MockupDesignPlacement}
|
|
492
|
-
* @memberof Mockup
|
|
493
|
-
*/
|
|
494
|
-
'designPlacement'?: MockupDesignPlacement | null;
|
|
495
|
-
/**
|
|
496
|
-
* Optional mask applied to the design. Used for products with non-rectangular print areas
|
|
497
|
-
* @type {string}
|
|
498
|
-
* @memberof Mockup
|
|
499
|
-
*/
|
|
500
|
-
'designMask'?: string | null;
|
|
501
|
-
/**
|
|
502
|
-
* Optional image to be overlaid on top of the design. This can be used to give the impression of texture, shading, depth or other effects.
|
|
503
|
-
* @type {string}
|
|
504
|
-
* @memberof Mockup
|
|
505
|
-
*/
|
|
506
|
-
'overlayImage'?: string | null;
|
|
507
|
-
}
|
|
508
|
-
/**
|
|
509
|
-
* Design placement
|
|
510
|
-
* @export
|
|
511
|
-
* @interface MockupDesignPlacement
|
|
405
|
+
* @interface ModerateReviewRequest
|
|
512
406
|
*/
|
|
513
|
-
export interface
|
|
514
|
-
/**
|
|
515
|
-
* X coordinate in pixels
|
|
516
|
-
* @type {number}
|
|
517
|
-
* @memberof MockupDesignPlacement
|
|
518
|
-
*/
|
|
519
|
-
'x': number;
|
|
520
|
-
/**
|
|
521
|
-
* Y coordinate in pixels
|
|
522
|
-
* @type {number}
|
|
523
|
-
* @memberof MockupDesignPlacement
|
|
524
|
-
*/
|
|
525
|
-
'y': number;
|
|
526
|
-
/**
|
|
527
|
-
* Width in pixels
|
|
528
|
-
* @type {number}
|
|
529
|
-
* @memberof MockupDesignPlacement
|
|
530
|
-
*/
|
|
531
|
-
'width': number;
|
|
407
|
+
export interface ModerateReviewRequest {
|
|
532
408
|
/**
|
|
533
|
-
*
|
|
534
|
-
* @type {
|
|
535
|
-
* @memberof
|
|
409
|
+
* Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
|
|
410
|
+
* @type {boolean}
|
|
411
|
+
* @memberof ModerateReviewRequest
|
|
536
412
|
*/
|
|
537
|
-
'
|
|
413
|
+
'enabled'?: boolean;
|
|
538
414
|
}
|
|
539
415
|
/**
|
|
540
416
|
*
|
|
@@ -693,10 +569,10 @@ export interface OrderItem {
|
|
|
693
569
|
'variantRef': string;
|
|
694
570
|
/**
|
|
695
571
|
*
|
|
696
|
-
* @type {
|
|
572
|
+
* @type {Variant}
|
|
697
573
|
* @memberof OrderItem
|
|
698
574
|
*/
|
|
699
|
-
'variant':
|
|
575
|
+
'variant': Variant;
|
|
700
576
|
/**
|
|
701
577
|
* Options associated to an order item\'s variant, such as color and size.
|
|
702
578
|
* @type {Array<Option>}
|
|
@@ -832,178 +708,6 @@ export interface Origin {
|
|
|
832
708
|
*/
|
|
833
709
|
'isPaid'?: boolean;
|
|
834
710
|
}
|
|
835
|
-
/**
|
|
836
|
-
* Configuration of the files output for this application
|
|
837
|
-
* @export
|
|
838
|
-
* @interface Output
|
|
839
|
-
*/
|
|
840
|
-
export interface Output {
|
|
841
|
-
/**
|
|
842
|
-
* Width of the print file in pixels
|
|
843
|
-
* @type {number}
|
|
844
|
-
* @memberof Output
|
|
845
|
-
*/
|
|
846
|
-
'width': number;
|
|
847
|
-
/**
|
|
848
|
-
* Height of the print file in pixels
|
|
849
|
-
* @type {number}
|
|
850
|
-
* @memberof Output
|
|
851
|
-
*/
|
|
852
|
-
'height': number;
|
|
853
|
-
/**
|
|
854
|
-
* DPI of the print file in pixels
|
|
855
|
-
* @type {number}
|
|
856
|
-
* @memberof Output
|
|
857
|
-
*/
|
|
858
|
-
'dpi': number;
|
|
859
|
-
/**
|
|
860
|
-
*
|
|
861
|
-
* @type {OutputPadding}
|
|
862
|
-
* @memberof Output
|
|
863
|
-
*/
|
|
864
|
-
'padding'?: OutputPadding;
|
|
865
|
-
/**
|
|
866
|
-
* Position of the print
|
|
867
|
-
* @type {string}
|
|
868
|
-
* @memberof Output
|
|
869
|
-
*/
|
|
870
|
-
'position': OutputPositionEnum;
|
|
871
|
-
/**
|
|
872
|
-
* Whether the print should be mirrored horizontally
|
|
873
|
-
* @type {boolean}
|
|
874
|
-
* @memberof Output
|
|
875
|
-
*/
|
|
876
|
-
'mirrorX'?: boolean;
|
|
877
|
-
/**
|
|
878
|
-
* Whether the print should be mirrored vertically
|
|
879
|
-
* @type {boolean}
|
|
880
|
-
* @memberof Output
|
|
881
|
-
*/
|
|
882
|
-
'mirrorY'?: boolean;
|
|
883
|
-
/**
|
|
884
|
-
* Amount of reflection in pixels
|
|
885
|
-
* @type {number}
|
|
886
|
-
* @memberof Output
|
|
887
|
-
*/
|
|
888
|
-
'reflect'?: number;
|
|
889
|
-
/**
|
|
890
|
-
* Amount to extend the print in pixels
|
|
891
|
-
* @type {number}
|
|
892
|
-
* @memberof Output
|
|
893
|
-
*/
|
|
894
|
-
'extend'?: number;
|
|
895
|
-
/**
|
|
896
|
-
* Rotation in degrees
|
|
897
|
-
* @type {number}
|
|
898
|
-
* @memberof Output
|
|
899
|
-
*/
|
|
900
|
-
'rotate'?: number;
|
|
901
|
-
/**
|
|
902
|
-
* Format of the print file
|
|
903
|
-
* @type {string}
|
|
904
|
-
* @memberof Output
|
|
905
|
-
*/
|
|
906
|
-
'fileFormat': OutputFileFormatEnum;
|
|
907
|
-
/**
|
|
908
|
-
*
|
|
909
|
-
* @type {Array<OutputDeviceConfigsInner>}
|
|
910
|
-
* @memberof Output
|
|
911
|
-
*/
|
|
912
|
-
'deviceConfigs'?: Array<OutputDeviceConfigsInner>;
|
|
913
|
-
}
|
|
914
|
-
|
|
915
|
-
export const OutputPositionEnum = {
|
|
916
|
-
Center: 'center',
|
|
917
|
-
Top: 'top',
|
|
918
|
-
Left: 'left',
|
|
919
|
-
Bottom: 'bottom',
|
|
920
|
-
Right: 'right',
|
|
921
|
-
RightTop: 'right-top',
|
|
922
|
-
RightBottom: 'right-bottom',
|
|
923
|
-
LeftTop: 'left-top',
|
|
924
|
-
LeftBottom: 'left-bottom'
|
|
925
|
-
} as const;
|
|
926
|
-
|
|
927
|
-
export type OutputPositionEnum = typeof OutputPositionEnum[keyof typeof OutputPositionEnum];
|
|
928
|
-
export const OutputFileFormatEnum = {
|
|
929
|
-
Png: 'png',
|
|
930
|
-
Jpg: 'jpg',
|
|
931
|
-
Jpeg: 'jpeg',
|
|
932
|
-
Webp: 'webp',
|
|
933
|
-
Pdf: 'pdf'
|
|
934
|
-
} as const;
|
|
935
|
-
|
|
936
|
-
export type OutputFileFormatEnum = typeof OutputFileFormatEnum[keyof typeof OutputFileFormatEnum];
|
|
937
|
-
|
|
938
|
-
/**
|
|
939
|
-
*
|
|
940
|
-
* @export
|
|
941
|
-
* @interface OutputDeviceConfigsInner
|
|
942
|
-
*/
|
|
943
|
-
export interface OutputDeviceConfigsInner {
|
|
944
|
-
/**
|
|
945
|
-
* Unique object identifier
|
|
946
|
-
* @type {string}
|
|
947
|
-
* @memberof OutputDeviceConfigsInner
|
|
948
|
-
*/
|
|
949
|
-
'modelId'?: string;
|
|
950
|
-
/**
|
|
951
|
-
*
|
|
952
|
-
* @type {Array<OutputDeviceConfigsInnerPropertiesInner>}
|
|
953
|
-
* @memberof OutputDeviceConfigsInner
|
|
954
|
-
*/
|
|
955
|
-
'properties'?: Array<OutputDeviceConfigsInnerPropertiesInner>;
|
|
956
|
-
}
|
|
957
|
-
/**
|
|
958
|
-
*
|
|
959
|
-
* @export
|
|
960
|
-
* @interface OutputDeviceConfigsInnerPropertiesInner
|
|
961
|
-
*/
|
|
962
|
-
export interface OutputDeviceConfigsInnerPropertiesInner {
|
|
963
|
-
/**
|
|
964
|
-
*
|
|
965
|
-
* @type {string}
|
|
966
|
-
* @memberof OutputDeviceConfigsInnerPropertiesInner
|
|
967
|
-
*/
|
|
968
|
-
'name'?: string;
|
|
969
|
-
/**
|
|
970
|
-
*
|
|
971
|
-
* @type {string}
|
|
972
|
-
* @memberof OutputDeviceConfigsInnerPropertiesInner
|
|
973
|
-
*/
|
|
974
|
-
'option'?: string;
|
|
975
|
-
}
|
|
976
|
-
/**
|
|
977
|
-
* Padding to be applied to the print file
|
|
978
|
-
* @export
|
|
979
|
-
* @interface OutputPadding
|
|
980
|
-
*/
|
|
981
|
-
export interface OutputPadding {
|
|
982
|
-
/**
|
|
983
|
-
* Top padding in pixels
|
|
984
|
-
* @type {number}
|
|
985
|
-
* @memberof OutputPadding
|
|
986
|
-
*/
|
|
987
|
-
'top': number;
|
|
988
|
-
/**
|
|
989
|
-
* Right padding in pixels
|
|
990
|
-
* @type {number}
|
|
991
|
-
* @memberof OutputPadding
|
|
992
|
-
*/
|
|
993
|
-
'right': number;
|
|
994
|
-
/**
|
|
995
|
-
* Bottom padding in pixels
|
|
996
|
-
* @type {number}
|
|
997
|
-
* @memberof OutputPadding
|
|
998
|
-
*/
|
|
999
|
-
'bottom': number;
|
|
1000
|
-
/**
|
|
1001
|
-
* Left padding in pixels
|
|
1002
|
-
* @type {number}
|
|
1003
|
-
* @memberof OutputPadding
|
|
1004
|
-
*/
|
|
1005
|
-
'left': number;
|
|
1006
|
-
}
|
|
1007
711
|
/**
|
|
1008
712
|
*
|
|
1009
713
|
* @export
|
|
@@ -1144,258 +848,214 @@ export interface Price {
|
|
|
1144
848
|
/**
|
|
1145
849
|
*
|
|
1146
850
|
* @export
|
|
1147
|
-
* @interface
|
|
851
|
+
* @interface Project
|
|
1148
852
|
*/
|
|
1149
|
-
export interface
|
|
853
|
+
export interface Project {
|
|
1150
854
|
/**
|
|
1151
|
-
*
|
|
855
|
+
*
|
|
1152
856
|
* @type {string}
|
|
1153
|
-
* @memberof
|
|
857
|
+
* @memberof Project
|
|
1154
858
|
*/
|
|
1155
859
|
'id': string;
|
|
1156
860
|
/**
|
|
1157
|
-
*
|
|
861
|
+
* The name of the project
|
|
1158
862
|
* @type {string}
|
|
1159
|
-
* @memberof
|
|
863
|
+
* @memberof Project
|
|
1160
864
|
*/
|
|
1161
|
-
'
|
|
865
|
+
'name': string;
|
|
866
|
+
}
|
|
867
|
+
/**
|
|
868
|
+
*
|
|
869
|
+
* @export
|
|
870
|
+
* @interface Review
|
|
871
|
+
*/
|
|
872
|
+
export interface Review {
|
|
1162
873
|
/**
|
|
1163
|
-
*
|
|
874
|
+
* Unique object identifier
|
|
1164
875
|
* @type {string}
|
|
1165
|
-
* @memberof
|
|
1166
|
-
*/
|
|
1167
|
-
'title': string;
|
|
1168
|
-
/**
|
|
1169
|
-
* Whether the product is enabled
|
|
1170
|
-
* @type {boolean}
|
|
1171
|
-
* @memberof Product
|
|
876
|
+
* @memberof Review
|
|
1172
877
|
*/
|
|
1173
|
-
'
|
|
878
|
+
'id': string;
|
|
1174
879
|
/**
|
|
1175
|
-
*
|
|
1176
|
-
* @type {
|
|
1177
|
-
* @memberof
|
|
880
|
+
* Text content of the review
|
|
881
|
+
* @type {string}
|
|
882
|
+
* @memberof Review
|
|
1178
883
|
*/
|
|
1179
|
-
'
|
|
884
|
+
'text': string;
|
|
1180
885
|
/**
|
|
1181
|
-
*
|
|
1182
|
-
* @type {
|
|
1183
|
-
* @memberof
|
|
886
|
+
*
|
|
887
|
+
* @type {ReviewProduct}
|
|
888
|
+
* @memberof Review
|
|
1184
889
|
*/
|
|
1185
|
-
'
|
|
890
|
+
'product'?: ReviewProduct;
|
|
1186
891
|
/**
|
|
1187
892
|
*
|
|
1188
|
-
* @type {
|
|
1189
|
-
* @memberof
|
|
893
|
+
* @type {ReviewAuthor}
|
|
894
|
+
* @memberof Review
|
|
1190
895
|
*/
|
|
1191
|
-
'
|
|
896
|
+
'author'?: ReviewAuthor;
|
|
1192
897
|
/**
|
|
1193
|
-
*
|
|
898
|
+
* Rating of the review
|
|
1194
899
|
* @type {number}
|
|
1195
|
-
* @memberof
|
|
1196
|
-
*/
|
|
1197
|
-
'tariffCode'?: number;
|
|
1198
|
-
/**
|
|
1199
|
-
* Brand of the product
|
|
1200
|
-
* @type {string}
|
|
1201
|
-
* @memberof Product
|
|
900
|
+
* @memberof Review
|
|
1202
901
|
*/
|
|
1203
|
-
'
|
|
902
|
+
'rating'?: number;
|
|
1204
903
|
/**
|
|
1205
|
-
*
|
|
1206
|
-
* @type {
|
|
1207
|
-
* @memberof
|
|
904
|
+
* Google\'s sentiment analysis score
|
|
905
|
+
* @type {number}
|
|
906
|
+
* @memberof Review
|
|
1208
907
|
*/
|
|
1209
|
-
'
|
|
908
|
+
'sentiment'?: number;
|
|
1210
909
|
/**
|
|
1211
|
-
*
|
|
1212
|
-
* @type {
|
|
1213
|
-
* @memberof
|
|
910
|
+
* Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
|
|
911
|
+
* @type {boolean}
|
|
912
|
+
* @memberof Review
|
|
1214
913
|
*/
|
|
1215
|
-
'
|
|
914
|
+
'enabled': boolean;
|
|
1216
915
|
/**
|
|
1217
|
-
*
|
|
916
|
+
*
|
|
1218
917
|
* @type {string}
|
|
1219
|
-
* @memberof
|
|
918
|
+
* @memberof Review
|
|
1220
919
|
*/
|
|
1221
|
-
'
|
|
920
|
+
'createdAt'?: string;
|
|
1222
921
|
/**
|
|
1223
922
|
*
|
|
1224
|
-
* @type {
|
|
1225
|
-
* @memberof
|
|
1226
|
-
*/
|
|
1227
|
-
'productType': ProductType;
|
|
1228
|
-
/**
|
|
1229
|
-
* Attributes associated to a product such as Colour and Size.
|
|
1230
|
-
* @type {Array<ProductAttribute>}
|
|
1231
|
-
* @memberof Product
|
|
923
|
+
* @type {Project}
|
|
924
|
+
* @memberof Review
|
|
1232
925
|
*/
|
|
1233
|
-
'
|
|
926
|
+
'project': Project;
|
|
1234
927
|
/**
|
|
1235
|
-
*
|
|
1236
|
-
* @type {Array<
|
|
1237
|
-
* @memberof
|
|
928
|
+
*
|
|
929
|
+
* @type {Array<ReviewImagesInner>}
|
|
930
|
+
* @memberof Review
|
|
1238
931
|
*/
|
|
1239
|
-
'
|
|
932
|
+
'images'?: Array<ReviewImagesInner>;
|
|
1240
933
|
/**
|
|
1241
|
-
*
|
|
1242
|
-
* @type {Array<
|
|
1243
|
-
* @memberof
|
|
934
|
+
*
|
|
935
|
+
* @type {Array<ReviewReply>}
|
|
936
|
+
* @memberof Review
|
|
1244
937
|
*/
|
|
1245
|
-
'
|
|
938
|
+
'replies'?: Array<ReviewReply>;
|
|
939
|
+
}
|
|
940
|
+
/**
|
|
941
|
+
*
|
|
942
|
+
* @export
|
|
943
|
+
* @interface ReviewAuthor
|
|
944
|
+
*/
|
|
945
|
+
export interface ReviewAuthor {
|
|
1246
946
|
/**
|
|
1247
|
-
*
|
|
947
|
+
* Name of the review\'s author
|
|
1248
948
|
* @type {string}
|
|
1249
|
-
* @memberof
|
|
949
|
+
* @memberof ReviewAuthor
|
|
1250
950
|
*/
|
|
1251
|
-
'
|
|
951
|
+
'name'?: string;
|
|
1252
952
|
/**
|
|
1253
|
-
*
|
|
953
|
+
* Email of the review\'s author
|
|
1254
954
|
* @type {string}
|
|
1255
|
-
* @memberof
|
|
1256
|
-
*/
|
|
1257
|
-
'updatedAt'?: string;
|
|
1258
|
-
/**
|
|
1259
|
-
* Images
|
|
1260
|
-
* @type {Array<Image>}
|
|
1261
|
-
* @memberof Product
|
|
955
|
+
* @memberof ReviewAuthor
|
|
1262
956
|
*/
|
|
1263
|
-
'
|
|
957
|
+
'email'?: string;
|
|
1264
958
|
}
|
|
1265
959
|
/**
|
|
1266
960
|
*
|
|
1267
961
|
* @export
|
|
1268
|
-
* @interface
|
|
962
|
+
* @interface ReviewImagesInner
|
|
1269
963
|
*/
|
|
1270
|
-
export interface
|
|
964
|
+
export interface ReviewImagesInner {
|
|
1271
965
|
/**
|
|
1272
|
-
*
|
|
966
|
+
* URL of the image
|
|
1273
967
|
* @type {string}
|
|
1274
|
-
* @memberof
|
|
1275
|
-
*/
|
|
1276
|
-
'name': string;
|
|
1277
|
-
/**
|
|
1278
|
-
* Position of the attribute when ordered
|
|
1279
|
-
* @type {number}
|
|
1280
|
-
* @memberof ProductAttribute
|
|
968
|
+
* @memberof ReviewImagesInner
|
|
1281
969
|
*/
|
|
1282
|
-
'
|
|
970
|
+
'src'?: string;
|
|
1283
971
|
/**
|
|
1284
|
-
*
|
|
1285
|
-
* @type {
|
|
1286
|
-
* @memberof
|
|
972
|
+
* Alternative text for the image
|
|
973
|
+
* @type {string}
|
|
974
|
+
* @memberof ReviewImagesInner
|
|
1287
975
|
*/
|
|
1288
|
-
'
|
|
976
|
+
'alt'?: string;
|
|
1289
977
|
}
|
|
1290
978
|
/**
|
|
1291
|
-
*
|
|
979
|
+
* The product that the review is for
|
|
1292
980
|
* @export
|
|
1293
|
-
* @interface
|
|
981
|
+
* @interface ReviewProduct
|
|
1294
982
|
*/
|
|
1295
|
-
export interface
|
|
1296
|
-
/**
|
|
1297
|
-
* Position of the attribute value when ordered
|
|
1298
|
-
* @type {number}
|
|
1299
|
-
* @memberof ProductAttributeValuesInner
|
|
1300
|
-
*/
|
|
1301
|
-
'sortOrder': number;
|
|
983
|
+
export interface ReviewProduct {
|
|
1302
984
|
/**
|
|
1303
|
-
*
|
|
985
|
+
* Unique object identifier
|
|
1304
986
|
* @type {string}
|
|
1305
|
-
* @memberof
|
|
987
|
+
* @memberof ReviewProduct
|
|
1306
988
|
*/
|
|
1307
|
-
'
|
|
989
|
+
'id'?: string;
|
|
1308
990
|
/**
|
|
1309
|
-
*
|
|
1310
|
-
* @type {
|
|
1311
|
-
* @memberof
|
|
991
|
+
* The title of the product
|
|
992
|
+
* @type {string}
|
|
993
|
+
* @memberof ReviewProduct
|
|
1312
994
|
*/
|
|
1313
|
-
'
|
|
995
|
+
'title'?: string;
|
|
1314
996
|
}
|
|
1315
997
|
/**
|
|
1316
998
|
*
|
|
1317
999
|
* @export
|
|
1318
|
-
* @interface
|
|
1000
|
+
* @interface ReviewReply
|
|
1319
1001
|
*/
|
|
1320
|
-
export interface
|
|
1002
|
+
export interface ReviewReply {
|
|
1321
1003
|
/**
|
|
1322
|
-
*
|
|
1004
|
+
* Unique object identifier
|
|
1005
|
+
* @type {string}
|
|
1006
|
+
* @memberof ReviewReply
|
|
1007
|
+
*/
|
|
1008
|
+
'id': string;
|
|
1009
|
+
/**
|
|
1010
|
+
* Text content of the reply
|
|
1323
1011
|
* @type {string}
|
|
1324
|
-
* @memberof
|
|
1012
|
+
* @memberof ReviewReply
|
|
1325
1013
|
*/
|
|
1326
|
-
'
|
|
1014
|
+
'text': string;
|
|
1015
|
+
/**
|
|
1016
|
+
*
|
|
1017
|
+
* @type {ReviewReplyAuthor}
|
|
1018
|
+
* @memberof ReviewReply
|
|
1019
|
+
*/
|
|
1020
|
+
'author'?: ReviewReplyAuthor;
|
|
1327
1021
|
/**
|
|
1328
1022
|
*
|
|
1329
1023
|
* @type {string}
|
|
1330
|
-
* @memberof
|
|
1024
|
+
* @memberof ReviewReply
|
|
1331
1025
|
*/
|
|
1332
|
-
'
|
|
1026
|
+
'createdAt'?: string;
|
|
1333
1027
|
}
|
|
1334
|
-
|
|
1335
|
-
export const ProductAttributeValuesInnerThumbnailTypeEnum = {
|
|
1336
|
-
Text: 'text',
|
|
1337
|
-
Color: 'color',
|
|
1338
|
-
Image: 'image'
|
|
1339
|
-
} as const;
|
|
1340
|
-
|
|
1341
|
-
export type ProductAttributeValuesInnerThumbnailTypeEnum = typeof ProductAttributeValuesInnerThumbnailTypeEnum[keyof typeof ProductAttributeValuesInnerThumbnailTypeEnum];
|
|
1342
|
-
|
|
1343
1028
|
/**
|
|
1344
1029
|
*
|
|
1345
1030
|
* @export
|
|
1346
|
-
* @interface
|
|
1031
|
+
* @interface ReviewReplyAuthor
|
|
1347
1032
|
*/
|
|
1348
|
-
export interface
|
|
1033
|
+
export interface ReviewReplyAuthor {
|
|
1349
1034
|
/**
|
|
1350
|
-
*
|
|
1351
|
-
* @type {number}
|
|
1352
|
-
* @memberof ProductType
|
|
1353
|
-
*/
|
|
1354
|
-
'id'?: number;
|
|
1355
|
-
/**
|
|
1356
|
-
* Name of the product type
|
|
1035
|
+
* Name of the reply\'s author
|
|
1357
1036
|
* @type {string}
|
|
1358
|
-
* @memberof
|
|
1037
|
+
* @memberof ReviewReplyAuthor
|
|
1359
1038
|
*/
|
|
1360
1039
|
'name'?: string;
|
|
1361
1040
|
}
|
|
1362
1041
|
/**
|
|
1363
1042
|
*
|
|
1364
1043
|
* @export
|
|
1365
|
-
* @interface
|
|
1044
|
+
* @interface ReviewsResponse
|
|
1366
1045
|
*/
|
|
1367
|
-
export interface
|
|
1046
|
+
export interface ReviewsResponse {
|
|
1368
1047
|
/**
|
|
1369
|
-
*
|
|
1370
|
-
* @type {
|
|
1371
|
-
* @memberof
|
|
1048
|
+
*
|
|
1049
|
+
* @type {Array<Review>}
|
|
1050
|
+
* @memberof ReviewsResponse
|
|
1372
1051
|
*/
|
|
1373
|
-
'
|
|
1052
|
+
'reviews'?: Array<Review>;
|
|
1374
1053
|
/**
|
|
1375
|
-
*
|
|
1376
|
-
* @type {
|
|
1377
|
-
* @memberof
|
|
1378
|
-
*/
|
|
1379
|
-
'ref'?: string;
|
|
1380
|
-
}
|
|
1381
|
-
/**
|
|
1382
|
-
*
|
|
1383
|
-
* @export
|
|
1384
|
-
* @interface Project
|
|
1385
|
-
*/
|
|
1386
|
-
export interface Project {
|
|
1387
|
-
/**
|
|
1388
|
-
*
|
|
1389
|
-
* @type {string}
|
|
1390
|
-
* @memberof Project
|
|
1391
|
-
*/
|
|
1392
|
-
'id': string;
|
|
1393
|
-
/**
|
|
1394
|
-
* The name of the project
|
|
1395
|
-
* @type {string}
|
|
1396
|
-
* @memberof Project
|
|
1054
|
+
* The token referencing the next page number
|
|
1055
|
+
* @type {number}
|
|
1056
|
+
* @memberof ReviewsResponse
|
|
1397
1057
|
*/
|
|
1398
|
-
'
|
|
1058
|
+
'nextPageToken'?: number | null;
|
|
1399
1059
|
}
|
|
1400
1060
|
/**
|
|
1401
1061
|
*
|
|
@@ -1560,57 +1220,6 @@ export interface UpdatePlatformRequest {
|
|
|
1560
1220
|
*/
|
|
1561
1221
|
'chargeClients'?: boolean;
|
|
1562
1222
|
}
|
|
1563
|
-
/**
|
|
1564
|
-
*
|
|
1565
|
-
* @export
|
|
1566
|
-
* @interface UpdateProductRequest
|
|
1567
|
-
*/
|
|
1568
|
-
export interface UpdateProductRequest {
|
|
1569
|
-
/**
|
|
1570
|
-
* The warehouse variants of the product to update
|
|
1571
|
-
* @type {Array<UpdateProductRequestVariantsInner>}
|
|
1572
|
-
* @memberof UpdateProductRequest
|
|
1573
|
-
*/
|
|
1574
|
-
'variants'?: Array<UpdateProductRequestVariantsInner>;
|
|
1575
|
-
/**
|
|
1576
|
-
* Whether the platform warehouse product should be enabled or not
|
|
1577
|
-
* @type {boolean}
|
|
1578
|
-
* @memberof UpdateProductRequest
|
|
1579
|
-
*/
|
|
1580
|
-
'enabled'?: boolean;
|
|
1581
|
-
}
|
|
1582
|
-
/**
|
|
1583
|
-
*
|
|
1584
|
-
* @export
|
|
1585
|
-
* @interface UpdateProductRequestVariantsInner
|
|
1586
|
-
*/
|
|
1587
|
-
export interface UpdateProductRequestVariantsInner {
|
|
1588
|
-
/**
|
|
1589
|
-
* The ID of the variant to update
|
|
1590
|
-
* @type {string}
|
|
1591
|
-
* @memberof UpdateProductRequestVariantsInner
|
|
1592
|
-
*/
|
|
1593
|
-
'id': string;
|
|
1594
|
-
/**
|
|
1595
|
-
* Whether the warehouse variant should be enabled or not
|
|
1596
|
-
* @type {boolean}
|
|
1597
|
-
* @memberof UpdateProductRequestVariantsInner
|
|
1598
|
-
*/
|
|
1599
|
-
'enabled'?: boolean;
|
|
1600
|
-
}
|
|
1601
|
-
/**
|
|
1602
|
-
*
|
|
1603
|
-
* @export
|
|
1604
|
-
* @interface UpdateVariantRequest
|
|
1605
|
-
*/
|
|
1606
|
-
export interface UpdateVariantRequest {
|
|
1607
|
-
/**
|
|
1608
|
-
* Whether the platform warehouse variant is enabled or not
|
|
1609
|
-
* @type {boolean}
|
|
1610
|
-
* @memberof UpdateVariantRequest
|
|
1611
|
-
*/
|
|
1612
|
-
'enabled'?: boolean;
|
|
1613
|
-
}
|
|
1614
1223
|
/**
|
|
1615
1224
|
*
|
|
1616
1225
|
* @export
|
|
@@ -1642,213 +1251,13 @@ export interface Variant {
|
|
|
1642
1251
|
* @memberof Variant
|
|
1643
1252
|
*/
|
|
1644
1253
|
'ref': string;
|
|
1645
|
-
/**
|
|
1646
|
-
*
|
|
1647
|
-
* @type {ProductVariantsInner}
|
|
1648
|
-
* @memberof Variant
|
|
1649
|
-
*/
|
|
1650
|
-
'product'?: ProductVariantsInner;
|
|
1651
|
-
/**
|
|
1652
|
-
*
|
|
1653
|
-
* @type {string}
|
|
1654
|
-
* @memberof Variant
|
|
1655
|
-
*/
|
|
1656
|
-
'sku': string;
|
|
1657
|
-
/**
|
|
1658
|
-
* ISO 8601 Timestamp
|
|
1659
|
-
* @type {string}
|
|
1660
|
-
* @memberof Variant
|
|
1661
|
-
*/
|
|
1662
|
-
'createdAt'?: string;
|
|
1663
|
-
/**
|
|
1664
|
-
* ISO 8601 Timestamp
|
|
1665
|
-
* @type {string}
|
|
1666
|
-
* @memberof Variant
|
|
1667
|
-
*/
|
|
1668
|
-
'updatedAt'?: string;
|
|
1669
|
-
/**
|
|
1670
|
-
* Images
|
|
1671
|
-
* @type {Array<Image>}
|
|
1672
|
-
* @memberof Variant
|
|
1673
|
-
*/
|
|
1674
|
-
'images'?: Array<Image>;
|
|
1675
|
-
/**
|
|
1676
|
-
* Weight in kg
|
|
1677
|
-
* @type {number}
|
|
1678
|
-
* @memberof Variant
|
|
1679
|
-
*/
|
|
1680
|
-
'weight'?: number;
|
|
1681
|
-
/**
|
|
1682
|
-
* The number of units that can be packed in a single pickface
|
|
1683
|
-
* @type {number}
|
|
1684
|
-
* @memberof Variant
|
|
1685
|
-
*/
|
|
1686
|
-
'packVolume'?: number;
|
|
1687
|
-
/**
|
|
1688
|
-
*
|
|
1689
|
-
* @type {VariantPackedDimensions}
|
|
1690
|
-
* @memberof Variant
|
|
1691
|
-
*/
|
|
1692
|
-
'packedDimensions'?: VariantPackedDimensions;
|
|
1693
|
-
/**
|
|
1694
|
-
* Whether the variant can be pre-ordered
|
|
1695
|
-
* @type {boolean}
|
|
1696
|
-
* @memberof Variant
|
|
1697
|
-
*/
|
|
1698
|
-
'preOrderable'?: boolean;
|
|
1699
|
-
/**
|
|
1700
|
-
* Whether the variant is enabled
|
|
1701
|
-
* @type {boolean}
|
|
1702
|
-
* @memberof Variant
|
|
1703
|
-
*/
|
|
1704
|
-
'enabled'?: boolean;
|
|
1705
|
-
/**
|
|
1706
|
-
* Whether the variant is discontinued
|
|
1707
|
-
* @type {boolean}
|
|
1708
|
-
* @memberof Variant
|
|
1709
|
-
*/
|
|
1710
|
-
'discontinued'?: boolean;
|
|
1711
|
-
/**
|
|
1712
|
-
*
|
|
1713
|
-
* @type {VariantManufacturerOrigin}
|
|
1714
|
-
* @memberof Variant
|
|
1715
|
-
*/
|
|
1716
|
-
'manufacturerOrigin'?: VariantManufacturerOrigin;
|
|
1717
|
-
/**
|
|
1718
|
-
* Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`. Attribute tags are intended for grouping and filtering, e.g. by a group of colours.
|
|
1719
|
-
* @type {Array<VariantAttribute>}
|
|
1720
|
-
* @memberof Variant
|
|
1721
|
-
*/
|
|
1722
|
-
'attributes': Array<VariantAttribute>;
|
|
1723
|
-
/**
|
|
1724
|
-
* Applications of the variant
|
|
1725
|
-
* @type {Array<Application>}
|
|
1726
|
-
* @memberof Variant
|
|
1727
|
-
*/
|
|
1728
|
-
'applications'?: Array<Application>;
|
|
1729
|
-
}
|
|
1730
|
-
/**
|
|
1731
|
-
*
|
|
1732
|
-
* @export
|
|
1733
|
-
* @interface Variant1
|
|
1734
|
-
*/
|
|
1735
|
-
export interface Variant1 {
|
|
1736
|
-
/**
|
|
1737
|
-
* Unique object identifier
|
|
1738
|
-
* @type {string}
|
|
1739
|
-
* @memberof Variant1
|
|
1740
|
-
*/
|
|
1741
|
-
'id': string;
|
|
1742
|
-
/**
|
|
1743
|
-
* A reference to the resource location
|
|
1744
|
-
* @type {string}
|
|
1745
|
-
* @memberof Variant1
|
|
1746
|
-
*/
|
|
1747
|
-
'ref': string;
|
|
1748
1254
|
/**
|
|
1749
1255
|
* A reference to the resource location
|
|
1750
1256
|
* @type {string}
|
|
1751
|
-
* @memberof
|
|
1257
|
+
* @memberof Variant
|
|
1752
1258
|
*/
|
|
1753
1259
|
'warehouseVariantRef': string;
|
|
1754
1260
|
}
|
|
1755
|
-
/**
|
|
1756
|
-
*
|
|
1757
|
-
* @export
|
|
1758
|
-
* @interface VariantAttribute
|
|
1759
|
-
*/
|
|
1760
|
-
export interface VariantAttribute {
|
|
1761
|
-
/**
|
|
1762
|
-
* Attribute name
|
|
1763
|
-
* @type {string}
|
|
1764
|
-
* @memberof VariantAttribute
|
|
1765
|
-
*/
|
|
1766
|
-
'name': string;
|
|
1767
|
-
/**
|
|
1768
|
-
* Attribute value
|
|
1769
|
-
* @type {string}
|
|
1770
|
-
* @memberof VariantAttribute
|
|
1771
|
-
*/
|
|
1772
|
-
'value': string;
|
|
1773
|
-
/**
|
|
1774
|
-
*
|
|
1775
|
-
* @type {VariantAttributeThumbnail}
|
|
1776
|
-
* @memberof VariantAttribute
|
|
1777
|
-
*/
|
|
1778
|
-
'thumbnail'?: VariantAttributeThumbnail;
|
|
1779
|
-
/**
|
|
1780
|
-
* Attribute tags
|
|
1781
|
-
* @type {Array<string>}
|
|
1782
|
-
* @memberof VariantAttribute
|
|
1783
|
-
*/
|
|
1784
|
-
'tags'?: Array<string>;
|
|
1785
|
-
}
|
|
1786
|
-
/**
|
|
1787
|
-
* Attribute thumbnail
|
|
1788
|
-
* @export
|
|
1789
|
-
* @interface VariantAttributeThumbnail
|
|
1790
|
-
*/
|
|
1791
|
-
export interface VariantAttributeThumbnail {
|
|
1792
|
-
/**
|
|
1793
|
-
*
|
|
1794
|
-
* @type {string}
|
|
1795
|
-
* @memberof VariantAttributeThumbnail
|
|
1796
|
-
*/
|
|
1797
|
-
'type'?: VariantAttributeThumbnailTypeEnum;
|
|
1798
|
-
/**
|
|
1799
|
-
*
|
|
1800
|
-
* @type {string}
|
|
1801
|
-
* @memberof VariantAttributeThumbnail
|
|
1802
|
-
*/
|
|
1803
|
-
'value'?: string;
|
|
1804
|
-
}
|
|
1805
|
-
|
|
1806
|
-
export const VariantAttributeThumbnailTypeEnum = {
|
|
1807
|
-
Text: 'text',
|
|
1808
|
-
Color: 'color',
|
|
1809
|
-
Image: 'image'
|
|
1810
|
-
} as const;
|
|
1811
|
-
|
|
1812
|
-
export type VariantAttributeThumbnailTypeEnum = typeof VariantAttributeThumbnailTypeEnum[keyof typeof VariantAttributeThumbnailTypeEnum];
|
|
1813
|
-
|
|
1814
|
-
/**
|
|
1815
|
-
* Where the product was originally produced or manufactured
|
|
1816
|
-
* @export
|
|
1817
|
-
* @interface VariantManufacturerOrigin
|
|
1818
|
-
*/
|
|
1819
|
-
export interface VariantManufacturerOrigin {
|
|
1820
|
-
/**
|
|
1821
|
-
* Country of origin (ISO 3166-1 alpha-2).
|
|
1822
|
-
* @type {string}
|
|
1823
|
-
* @memberof VariantManufacturerOrigin
|
|
1824
|
-
*/
|
|
1825
|
-
'country'?: string;
|
|
1826
|
-
}
|
|
1827
|
-
/**
|
|
1828
|
-
*
|
|
1829
|
-
* @export
|
|
1830
|
-
* @interface VariantPackedDimensions
|
|
1831
|
-
*/
|
|
1832
|
-
export interface VariantPackedDimensions {
|
|
1833
|
-
/**
|
|
1834
|
-
* Length in mm
|
|
1835
|
-
* @type {number}
|
|
1836
|
-
* @memberof VariantPackedDimensions
|
|
1837
|
-
*/
|
|
1838
|
-
'length'?: number;
|
|
1839
|
-
/**
|
|
1840
|
-
* Width in mm
|
|
1841
|
-
* @type {number}
|
|
1842
|
-
* @memberof VariantPackedDimensions
|
|
1843
|
-
*/
|
|
1844
|
-
'width'?: number;
|
|
1845
|
-
/**
|
|
1846
|
-
* Depth in mm
|
|
1847
|
-
* @type {number}
|
|
1848
|
-
* @memberof VariantPackedDimensions
|
|
1849
|
-
*/
|
|
1850
|
-
'depth'?: number;
|
|
1851
|
-
}
|
|
1852
1261
|
|
|
1853
1262
|
/**
|
|
1854
1263
|
* CustomersApi - axios parameter creator
|
|
@@ -1990,7 +1399,7 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1990
1399
|
* @param {string} platformId The platform identifier
|
|
1991
1400
|
* @param {number} [pageToken] Page reference token
|
|
1992
1401
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1993
|
-
* @param {string} [search] Search term to filter
|
|
1402
|
+
* @param {string} [search] Search term to filter results
|
|
1994
1403
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1995
1404
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
1996
1405
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
@@ -2124,7 +1533,7 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
2124
1533
|
* @param {string} platformId The platform identifier
|
|
2125
1534
|
* @param {number} [pageToken] Page reference token
|
|
2126
1535
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2127
|
-
* @param {string} [search] Search term to filter
|
|
1536
|
+
* @param {string} [search] Search term to filter results
|
|
2128
1537
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2129
1538
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
2130
1539
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
@@ -2301,7 +1710,7 @@ export interface CustomersApiListCustomersRequest {
|
|
|
2301
1710
|
readonly pageSize?: number
|
|
2302
1711
|
|
|
2303
1712
|
/**
|
|
2304
|
-
* Search term to filter
|
|
1713
|
+
* Search term to filter results
|
|
2305
1714
|
* @type {string}
|
|
2306
1715
|
* @memberof CustomersApiListCustomers
|
|
2307
1716
|
*/
|
|
@@ -3838,33 +3247,30 @@ export class PlatformApi extends BaseAPI {
|
|
|
3838
3247
|
|
|
3839
3248
|
|
|
3840
3249
|
/**
|
|
3841
|
-
*
|
|
3250
|
+
* ReviewsApi - axios parameter creator
|
|
3842
3251
|
* @export
|
|
3843
3252
|
*/
|
|
3844
|
-
export const
|
|
3253
|
+
export const ReviewsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
3845
3254
|
return {
|
|
3846
3255
|
/**
|
|
3847
|
-
*
|
|
3848
|
-
* @summary
|
|
3256
|
+
* Export reviews as a CSV file.
|
|
3257
|
+
* @summary Export reviews
|
|
3849
3258
|
* @param {string} project Project unique identifier
|
|
3850
3259
|
* @param {string} platformId The platform identifier
|
|
3851
|
-
* @param {string}
|
|
3852
|
-
* @param {
|
|
3260
|
+
* @param {string} start Start of date range to filter by
|
|
3261
|
+
* @param {string} [end] End of date range to filter by
|
|
3853
3262
|
* @param {*} [options] Override http request option.
|
|
3854
3263
|
* @throws {RequiredError}
|
|
3855
3264
|
*/
|
|
3856
|
-
|
|
3265
|
+
exportReviews: async (project: string, platformId: string, start: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3857
3266
|
// verify required parameter 'project' is not null or undefined
|
|
3858
|
-
assertParamExists('
|
|
3267
|
+
assertParamExists('exportReviews', 'project', project)
|
|
3859
3268
|
// verify required parameter 'platformId' is not null or undefined
|
|
3860
|
-
assertParamExists('
|
|
3861
|
-
// verify required parameter '
|
|
3862
|
-
assertParamExists('
|
|
3863
|
-
|
|
3864
|
-
|
|
3865
|
-
const localVarPath = `/v1/platform/{platformId}/warehouse/products/{productId}`
|
|
3866
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
3867
|
-
.replace(`{${"productId"}}`, encodeURIComponent(String(productId)));
|
|
3269
|
+
assertParamExists('exportReviews', 'platformId', platformId)
|
|
3270
|
+
// verify required parameter 'start' is not null or undefined
|
|
3271
|
+
assertParamExists('exportReviews', 'start', start)
|
|
3272
|
+
const localVarPath = `/v1/platform/{platformId}/reviews/export`
|
|
3273
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
3868
3274
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3869
3275
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3870
3276
|
let baseOptions;
|
|
@@ -3872,7 +3278,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
3872
3278
|
baseOptions = configuration.baseOptions;
|
|
3873
3279
|
}
|
|
3874
3280
|
|
|
3875
|
-
const localVarRequestOptions = { method: '
|
|
3281
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3876
3282
|
const localVarHeaderParameter = {} as any;
|
|
3877
3283
|
const localVarQueryParameter = {} as any;
|
|
3878
3284
|
|
|
@@ -3887,154 +3293,183 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
3887
3293
|
localVarQueryParameter['project'] = project;
|
|
3888
3294
|
}
|
|
3889
3295
|
|
|
3296
|
+
if (start !== undefined) {
|
|
3297
|
+
localVarQueryParameter['start'] = (start as any instanceof Date) ?
|
|
3298
|
+
(start as any).toISOString() :
|
|
3299
|
+
start;
|
|
3300
|
+
}
|
|
3890
3301
|
|
|
3891
|
-
|
|
3892
|
-
|
|
3302
|
+
if (end !== undefined) {
|
|
3303
|
+
localVarQueryParameter['end'] = (end as any instanceof Date) ?
|
|
3304
|
+
(end as any).toISOString() :
|
|
3305
|
+
end;
|
|
3306
|
+
}
|
|
3893
3307
|
|
|
3308
|
+
|
|
3309
|
+
|
|
3894
3310
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3895
3311
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3896
3312
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3897
|
-
localVarRequestOptions.data = serializeDataIfNeeded(updateProductRequest, localVarRequestOptions, configuration)
|
|
3898
3313
|
|
|
3899
3314
|
return {
|
|
3900
3315
|
url: toPathString(localVarUrlObj),
|
|
3901
3316
|
options: localVarRequestOptions,
|
|
3902
3317
|
};
|
|
3903
3318
|
},
|
|
3904
|
-
}
|
|
3905
|
-
};
|
|
3906
|
-
|
|
3907
|
-
/**
|
|
3908
|
-
* ProductsApi - functional programming interface
|
|
3909
|
-
* @export
|
|
3910
|
-
*/
|
|
3911
|
-
export const ProductsApiFp = function(configuration?: Configuration) {
|
|
3912
|
-
const localVarAxiosParamCreator = ProductsApiAxiosParamCreator(configuration)
|
|
3913
|
-
return {
|
|
3914
3319
|
/**
|
|
3915
|
-
*
|
|
3916
|
-
* @summary
|
|
3320
|
+
* Get a review left on a platform by a given review ID.
|
|
3321
|
+
* @summary Get review
|
|
3917
3322
|
* @param {string} project Project unique identifier
|
|
3918
3323
|
* @param {string} platformId The platform identifier
|
|
3919
|
-
* @param {string}
|
|
3920
|
-
* @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
|
|
3921
|
-
* @param {*} [options] Override http request option.
|
|
3922
|
-
* @throws {RequiredError}
|
|
3923
|
-
*/
|
|
3924
|
-
async updateProduct(project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>> {
|
|
3925
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updateProduct(project, platformId, productId, updateProductRequest, options);
|
|
3926
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3927
|
-
const localVarOperationServerBasePath = operationServerMap['ProductsApi.updateProduct']?.[localVarOperationServerIndex]?.url;
|
|
3928
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3929
|
-
},
|
|
3930
|
-
}
|
|
3931
|
-
};
|
|
3932
|
-
|
|
3933
|
-
/**
|
|
3934
|
-
* ProductsApi - factory interface
|
|
3935
|
-
* @export
|
|
3936
|
-
*/
|
|
3937
|
-
export const ProductsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3938
|
-
const localVarFp = ProductsApiFp(configuration)
|
|
3939
|
-
return {
|
|
3940
|
-
/**
|
|
3941
|
-
* Updates the warehouse product and its variants
|
|
3942
|
-
* @summary Update warehouse product
|
|
3943
|
-
* @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
|
|
3324
|
+
* @param {string} reviewId The review identifier
|
|
3944
3325
|
* @param {*} [options] Override http request option.
|
|
3945
3326
|
* @throws {RequiredError}
|
|
3946
3327
|
*/
|
|
3947
|
-
|
|
3948
|
-
|
|
3949
|
-
|
|
3950
|
-
|
|
3951
|
-
|
|
3328
|
+
getReview: async (project: string, platformId: string, reviewId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3329
|
+
// verify required parameter 'project' is not null or undefined
|
|
3330
|
+
assertParamExists('getReview', 'project', project)
|
|
3331
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
3332
|
+
assertParamExists('getReview', 'platformId', platformId)
|
|
3333
|
+
// verify required parameter 'reviewId' is not null or undefined
|
|
3334
|
+
assertParamExists('getReview', 'reviewId', reviewId)
|
|
3335
|
+
const localVarPath = `/v1/platform/{platformId}/reviews/{reviewId}`
|
|
3336
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
3337
|
+
.replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
|
|
3338
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3339
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3340
|
+
let baseOptions;
|
|
3341
|
+
if (configuration) {
|
|
3342
|
+
baseOptions = configuration.baseOptions;
|
|
3343
|
+
}
|
|
3952
3344
|
|
|
3953
|
-
|
|
3954
|
-
|
|
3955
|
-
|
|
3956
|
-
* @interface ProductsApiUpdateProductRequest
|
|
3957
|
-
*/
|
|
3958
|
-
export interface ProductsApiUpdateProductRequest {
|
|
3959
|
-
/**
|
|
3960
|
-
* Project unique identifier
|
|
3961
|
-
* @type {string}
|
|
3962
|
-
* @memberof ProductsApiUpdateProduct
|
|
3963
|
-
*/
|
|
3964
|
-
readonly project: string
|
|
3345
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3346
|
+
const localVarHeaderParameter = {} as any;
|
|
3347
|
+
const localVarQueryParameter = {} as any;
|
|
3965
3348
|
|
|
3966
|
-
|
|
3967
|
-
|
|
3968
|
-
|
|
3969
|
-
* @memberof ProductsApiUpdateProduct
|
|
3970
|
-
*/
|
|
3971
|
-
readonly platformId: string
|
|
3349
|
+
// authentication session-oauth required
|
|
3350
|
+
// oauth required
|
|
3351
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3972
3352
|
|
|
3973
|
-
|
|
3974
|
-
|
|
3975
|
-
* @type {string}
|
|
3976
|
-
* @memberof ProductsApiUpdateProduct
|
|
3977
|
-
*/
|
|
3978
|
-
readonly productId: string
|
|
3353
|
+
// authentication api-key required
|
|
3354
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3979
3355
|
|
|
3980
|
-
|
|
3981
|
-
|
|
3982
|
-
|
|
3983
|
-
* @memberof ProductsApiUpdateProduct
|
|
3984
|
-
*/
|
|
3985
|
-
readonly updateProductRequest: UpdateProductRequest
|
|
3986
|
-
}
|
|
3356
|
+
if (project !== undefined) {
|
|
3357
|
+
localVarQueryParameter['project'] = project;
|
|
3358
|
+
}
|
|
3987
3359
|
|
|
3988
|
-
/**
|
|
3989
|
-
* ProductsApi - object-oriented interface
|
|
3990
|
-
* @export
|
|
3991
|
-
* @class ProductsApi
|
|
3992
|
-
* @extends {BaseAPI}
|
|
3993
|
-
*/
|
|
3994
|
-
export class ProductsApi extends BaseAPI {
|
|
3995
|
-
/**
|
|
3996
|
-
* Updates the warehouse product and its variants
|
|
3997
|
-
* @summary Update warehouse product
|
|
3998
|
-
* @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
|
|
3999
|
-
* @param {*} [options] Override http request option.
|
|
4000
|
-
* @throws {RequiredError}
|
|
4001
|
-
* @memberof ProductsApi
|
|
4002
|
-
*/
|
|
4003
|
-
public updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig) {
|
|
4004
|
-
return ProductsApiFp(this.configuration).updateProduct(requestParameters.project, requestParameters.platformId, requestParameters.productId, requestParameters.updateProductRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4005
|
-
}
|
|
4006
|
-
}
|
|
4007
3360
|
|
|
3361
|
+
|
|
3362
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3363
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3364
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3365
|
+
|
|
3366
|
+
return {
|
|
3367
|
+
url: toPathString(localVarUrlObj),
|
|
3368
|
+
options: localVarRequestOptions,
|
|
3369
|
+
};
|
|
3370
|
+
},
|
|
3371
|
+
/**
|
|
3372
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
3373
|
+
* @summary List reviews
|
|
3374
|
+
* @param {string} project Project unique identifier
|
|
3375
|
+
* @param {string} platformId The platform identifier
|
|
3376
|
+
* @param {number} [pageToken] Page reference token
|
|
3377
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3378
|
+
* @param {string} [search] Search term to filter results
|
|
3379
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3380
|
+
* @param {string} [start] Start of date range to filter by
|
|
3381
|
+
* @param {string} [end] End of date range to filter by
|
|
3382
|
+
* @param {*} [options] Override http request option.
|
|
3383
|
+
* @throws {RequiredError}
|
|
3384
|
+
*/
|
|
3385
|
+
listReviews: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3386
|
+
// verify required parameter 'project' is not null or undefined
|
|
3387
|
+
assertParamExists('listReviews', 'project', project)
|
|
3388
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
3389
|
+
assertParamExists('listReviews', 'platformId', platformId)
|
|
3390
|
+
const localVarPath = `/v1/platform/{platformId}/reviews`
|
|
3391
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
3392
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3393
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3394
|
+
let baseOptions;
|
|
3395
|
+
if (configuration) {
|
|
3396
|
+
baseOptions = configuration.baseOptions;
|
|
3397
|
+
}
|
|
4008
3398
|
|
|
3399
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3400
|
+
const localVarHeaderParameter = {} as any;
|
|
3401
|
+
const localVarQueryParameter = {} as any;
|
|
4009
3402
|
|
|
4010
|
-
|
|
4011
|
-
|
|
4012
|
-
|
|
4013
|
-
|
|
4014
|
-
|
|
4015
|
-
|
|
3403
|
+
// authentication session-oauth required
|
|
3404
|
+
// oauth required
|
|
3405
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3406
|
+
|
|
3407
|
+
// authentication api-key required
|
|
3408
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3409
|
+
|
|
3410
|
+
if (project !== undefined) {
|
|
3411
|
+
localVarQueryParameter['project'] = project;
|
|
3412
|
+
}
|
|
3413
|
+
|
|
3414
|
+
if (pageToken !== undefined) {
|
|
3415
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
3416
|
+
}
|
|
3417
|
+
|
|
3418
|
+
if (pageSize !== undefined) {
|
|
3419
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
3420
|
+
}
|
|
3421
|
+
|
|
3422
|
+
if (search !== undefined) {
|
|
3423
|
+
localVarQueryParameter['search'] = search;
|
|
3424
|
+
}
|
|
3425
|
+
|
|
3426
|
+
if (sortBy) {
|
|
3427
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
3428
|
+
}
|
|
3429
|
+
|
|
3430
|
+
if (start !== undefined) {
|
|
3431
|
+
localVarQueryParameter['start'] = (start as any instanceof Date) ?
|
|
3432
|
+
(start as any).toISOString() :
|
|
3433
|
+
start;
|
|
3434
|
+
}
|
|
3435
|
+
|
|
3436
|
+
if (end !== undefined) {
|
|
3437
|
+
localVarQueryParameter['end'] = (end as any instanceof Date) ?
|
|
3438
|
+
(end as any).toISOString() :
|
|
3439
|
+
end;
|
|
3440
|
+
}
|
|
3441
|
+
|
|
3442
|
+
|
|
3443
|
+
|
|
3444
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3445
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3446
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3447
|
+
|
|
3448
|
+
return {
|
|
3449
|
+
url: toPathString(localVarUrlObj),
|
|
3450
|
+
options: localVarRequestOptions,
|
|
3451
|
+
};
|
|
3452
|
+
},
|
|
4016
3453
|
/**
|
|
4017
|
-
*
|
|
4018
|
-
* @summary
|
|
3454
|
+
* Moderate a review left on a platform.
|
|
3455
|
+
* @summary Moderate review
|
|
4019
3456
|
* @param {string} project Project unique identifier
|
|
4020
3457
|
* @param {string} platformId The platform identifier
|
|
4021
|
-
* @param {string}
|
|
4022
|
-
* @param {
|
|
3458
|
+
* @param {string} reviewId The review identifier
|
|
3459
|
+
* @param {ModerateReviewRequest} [moderateReviewRequest]
|
|
4023
3460
|
* @param {*} [options] Override http request option.
|
|
4024
3461
|
* @throws {RequiredError}
|
|
4025
3462
|
*/
|
|
4026
|
-
|
|
3463
|
+
moderateReview: async (project: string, platformId: string, reviewId: string, moderateReviewRequest?: ModerateReviewRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4027
3464
|
// verify required parameter 'project' is not null or undefined
|
|
4028
|
-
assertParamExists('
|
|
3465
|
+
assertParamExists('moderateReview', 'project', project)
|
|
4029
3466
|
// verify required parameter 'platformId' is not null or undefined
|
|
4030
|
-
assertParamExists('
|
|
4031
|
-
// verify required parameter '
|
|
4032
|
-
assertParamExists('
|
|
4033
|
-
|
|
4034
|
-
assertParamExists('updateVariant', 'updateVariantRequest', updateVariantRequest)
|
|
4035
|
-
const localVarPath = `/v1/platform/{platformId}/warehouse/variants/{variantId}`
|
|
3467
|
+
assertParamExists('moderateReview', 'platformId', platformId)
|
|
3468
|
+
// verify required parameter 'reviewId' is not null or undefined
|
|
3469
|
+
assertParamExists('moderateReview', 'reviewId', reviewId)
|
|
3470
|
+
const localVarPath = `/v1/platform/{platformId}/reviews/{reviewId}/moderate`
|
|
4036
3471
|
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
4037
|
-
.replace(`{${"
|
|
3472
|
+
.replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
|
|
4038
3473
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4039
3474
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4040
3475
|
let baseOptions;
|
|
@@ -4064,7 +3499,7 @@ export const VariantsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
4064
3499
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4065
3500
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4066
3501
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
4067
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
3502
|
+
localVarRequestOptions.data = serializeDataIfNeeded(moderateReviewRequest, localVarRequestOptions, configuration)
|
|
4068
3503
|
|
|
4069
3504
|
return {
|
|
4070
3505
|
url: toPathString(localVarUrlObj),
|
|
@@ -4075,103 +3510,346 @@ export const VariantsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
4075
3510
|
};
|
|
4076
3511
|
|
|
4077
3512
|
/**
|
|
4078
|
-
*
|
|
3513
|
+
* ReviewsApi - functional programming interface
|
|
4079
3514
|
* @export
|
|
4080
3515
|
*/
|
|
4081
|
-
export const
|
|
4082
|
-
const localVarAxiosParamCreator =
|
|
3516
|
+
export const ReviewsApiFp = function(configuration?: Configuration) {
|
|
3517
|
+
const localVarAxiosParamCreator = ReviewsApiAxiosParamCreator(configuration)
|
|
4083
3518
|
return {
|
|
4084
3519
|
/**
|
|
4085
|
-
*
|
|
4086
|
-
* @summary
|
|
3520
|
+
* Export reviews as a CSV file.
|
|
3521
|
+
* @summary Export reviews
|
|
3522
|
+
* @param {string} project Project unique identifier
|
|
3523
|
+
* @param {string} platformId The platform identifier
|
|
3524
|
+
* @param {string} start Start of date range to filter by
|
|
3525
|
+
* @param {string} [end] End of date range to filter by
|
|
3526
|
+
* @param {*} [options] Override http request option.
|
|
3527
|
+
* @throws {RequiredError}
|
|
3528
|
+
*/
|
|
3529
|
+
async exportReviews(project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
3530
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportReviews(project, platformId, start, end, options);
|
|
3531
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3532
|
+
const localVarOperationServerBasePath = operationServerMap['ReviewsApi.exportReviews']?.[localVarOperationServerIndex]?.url;
|
|
3533
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3534
|
+
},
|
|
3535
|
+
/**
|
|
3536
|
+
* Get a review left on a platform by a given review ID.
|
|
3537
|
+
* @summary Get review
|
|
3538
|
+
* @param {string} project Project unique identifier
|
|
3539
|
+
* @param {string} platformId The platform identifier
|
|
3540
|
+
* @param {string} reviewId The review identifier
|
|
3541
|
+
* @param {*} [options] Override http request option.
|
|
3542
|
+
* @throws {RequiredError}
|
|
3543
|
+
*/
|
|
3544
|
+
async getReview(project: string, platformId: string, reviewId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Review>> {
|
|
3545
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getReview(project, platformId, reviewId, options);
|
|
3546
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3547
|
+
const localVarOperationServerBasePath = operationServerMap['ReviewsApi.getReview']?.[localVarOperationServerIndex]?.url;
|
|
3548
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3549
|
+
},
|
|
3550
|
+
/**
|
|
3551
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
3552
|
+
* @summary List reviews
|
|
3553
|
+
* @param {string} project Project unique identifier
|
|
3554
|
+
* @param {string} platformId The platform identifier
|
|
3555
|
+
* @param {number} [pageToken] Page reference token
|
|
3556
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3557
|
+
* @param {string} [search] Search term to filter results
|
|
3558
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3559
|
+
* @param {string} [start] Start of date range to filter by
|
|
3560
|
+
* @param {string} [end] End of date range to filter by
|
|
3561
|
+
* @param {*} [options] Override http request option.
|
|
3562
|
+
* @throws {RequiredError}
|
|
3563
|
+
*/
|
|
3564
|
+
async listReviews(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReviewsResponse>> {
|
|
3565
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listReviews(project, platformId, pageToken, pageSize, search, sortBy, start, end, options);
|
|
3566
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3567
|
+
const localVarOperationServerBasePath = operationServerMap['ReviewsApi.listReviews']?.[localVarOperationServerIndex]?.url;
|
|
3568
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3569
|
+
},
|
|
3570
|
+
/**
|
|
3571
|
+
* Moderate a review left on a platform.
|
|
3572
|
+
* @summary Moderate review
|
|
4087
3573
|
* @param {string} project Project unique identifier
|
|
4088
3574
|
* @param {string} platformId The platform identifier
|
|
4089
|
-
* @param {string}
|
|
4090
|
-
* @param {
|
|
3575
|
+
* @param {string} reviewId The review identifier
|
|
3576
|
+
* @param {ModerateReviewRequest} [moderateReviewRequest]
|
|
4091
3577
|
* @param {*} [options] Override http request option.
|
|
4092
3578
|
* @throws {RequiredError}
|
|
4093
3579
|
*/
|
|
4094
|
-
async
|
|
4095
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
3580
|
+
async moderateReview(project: string, platformId: string, reviewId: string, moderateReviewRequest?: ModerateReviewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Review>> {
|
|
3581
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.moderateReview(project, platformId, reviewId, moderateReviewRequest, options);
|
|
4096
3582
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4097
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
3583
|
+
const localVarOperationServerBasePath = operationServerMap['ReviewsApi.moderateReview']?.[localVarOperationServerIndex]?.url;
|
|
4098
3584
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4099
3585
|
},
|
|
4100
3586
|
}
|
|
4101
3587
|
};
|
|
4102
3588
|
|
|
4103
3589
|
/**
|
|
4104
|
-
*
|
|
3590
|
+
* ReviewsApi - factory interface
|
|
4105
3591
|
* @export
|
|
4106
3592
|
*/
|
|
4107
|
-
export const
|
|
4108
|
-
const localVarFp =
|
|
3593
|
+
export const ReviewsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3594
|
+
const localVarFp = ReviewsApiFp(configuration)
|
|
4109
3595
|
return {
|
|
4110
3596
|
/**
|
|
4111
|
-
*
|
|
4112
|
-
* @summary
|
|
4113
|
-
* @param {
|
|
3597
|
+
* Export reviews as a CSV file.
|
|
3598
|
+
* @summary Export reviews
|
|
3599
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
3600
|
+
* @param {*} [options] Override http request option.
|
|
3601
|
+
* @throws {RequiredError}
|
|
3602
|
+
*/
|
|
3603
|
+
exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
3604
|
+
return localVarFp.exportReviews(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
3605
|
+
},
|
|
3606
|
+
/**
|
|
3607
|
+
* Get a review left on a platform by a given review ID.
|
|
3608
|
+
* @summary Get review
|
|
3609
|
+
* @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
|
|
3610
|
+
* @param {*} [options] Override http request option.
|
|
3611
|
+
* @throws {RequiredError}
|
|
3612
|
+
*/
|
|
3613
|
+
getReview(requestParameters: ReviewsApiGetReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review> {
|
|
3614
|
+
return localVarFp.getReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, options).then((request) => request(axios, basePath));
|
|
3615
|
+
},
|
|
3616
|
+
/**
|
|
3617
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
3618
|
+
* @summary List reviews
|
|
3619
|
+
* @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
|
|
4114
3620
|
* @param {*} [options] Override http request option.
|
|
4115
3621
|
* @throws {RequiredError}
|
|
4116
3622
|
*/
|
|
4117
|
-
|
|
4118
|
-
return localVarFp.
|
|
3623
|
+
listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReviewsResponse> {
|
|
3624
|
+
return localVarFp.listReviews(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
3625
|
+
},
|
|
3626
|
+
/**
|
|
3627
|
+
* Moderate a review left on a platform.
|
|
3628
|
+
* @summary Moderate review
|
|
3629
|
+
* @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
|
|
3630
|
+
* @param {*} [options] Override http request option.
|
|
3631
|
+
* @throws {RequiredError}
|
|
3632
|
+
*/
|
|
3633
|
+
moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review> {
|
|
3634
|
+
return localVarFp.moderateReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(axios, basePath));
|
|
4119
3635
|
},
|
|
4120
3636
|
};
|
|
4121
3637
|
};
|
|
4122
3638
|
|
|
4123
3639
|
/**
|
|
4124
|
-
* Request parameters for
|
|
3640
|
+
* Request parameters for exportReviews operation in ReviewsApi.
|
|
4125
3641
|
* @export
|
|
4126
|
-
* @interface
|
|
3642
|
+
* @interface ReviewsApiExportReviewsRequest
|
|
4127
3643
|
*/
|
|
4128
|
-
export interface
|
|
3644
|
+
export interface ReviewsApiExportReviewsRequest {
|
|
4129
3645
|
/**
|
|
4130
3646
|
* Project unique identifier
|
|
4131
3647
|
* @type {string}
|
|
4132
|
-
* @memberof
|
|
3648
|
+
* @memberof ReviewsApiExportReviews
|
|
4133
3649
|
*/
|
|
4134
3650
|
readonly project: string
|
|
4135
3651
|
|
|
4136
3652
|
/**
|
|
4137
3653
|
* The platform identifier
|
|
4138
3654
|
* @type {string}
|
|
4139
|
-
* @memberof
|
|
3655
|
+
* @memberof ReviewsApiExportReviews
|
|
4140
3656
|
*/
|
|
4141
3657
|
readonly platformId: string
|
|
4142
3658
|
|
|
4143
3659
|
/**
|
|
4144
|
-
*
|
|
3660
|
+
* Start of date range to filter by
|
|
3661
|
+
* @type {string}
|
|
3662
|
+
* @memberof ReviewsApiExportReviews
|
|
3663
|
+
*/
|
|
3664
|
+
readonly start: string
|
|
3665
|
+
|
|
3666
|
+
/**
|
|
3667
|
+
* End of date range to filter by
|
|
3668
|
+
* @type {string}
|
|
3669
|
+
* @memberof ReviewsApiExportReviews
|
|
3670
|
+
*/
|
|
3671
|
+
readonly end?: string
|
|
3672
|
+
}
|
|
3673
|
+
|
|
3674
|
+
/**
|
|
3675
|
+
* Request parameters for getReview operation in ReviewsApi.
|
|
3676
|
+
* @export
|
|
3677
|
+
* @interface ReviewsApiGetReviewRequest
|
|
3678
|
+
*/
|
|
3679
|
+
export interface ReviewsApiGetReviewRequest {
|
|
3680
|
+
/**
|
|
3681
|
+
* Project unique identifier
|
|
3682
|
+
* @type {string}
|
|
3683
|
+
* @memberof ReviewsApiGetReview
|
|
3684
|
+
*/
|
|
3685
|
+
readonly project: string
|
|
3686
|
+
|
|
3687
|
+
/**
|
|
3688
|
+
* The platform identifier
|
|
4145
3689
|
* @type {string}
|
|
4146
|
-
* @memberof
|
|
3690
|
+
* @memberof ReviewsApiGetReview
|
|
4147
3691
|
*/
|
|
4148
|
-
readonly
|
|
3692
|
+
readonly platformId: string
|
|
4149
3693
|
|
|
4150
3694
|
/**
|
|
4151
|
-
*
|
|
4152
|
-
* @type {
|
|
4153
|
-
* @memberof
|
|
3695
|
+
* The review identifier
|
|
3696
|
+
* @type {string}
|
|
3697
|
+
* @memberof ReviewsApiGetReview
|
|
4154
3698
|
*/
|
|
4155
|
-
readonly
|
|
3699
|
+
readonly reviewId: string
|
|
4156
3700
|
}
|
|
4157
3701
|
|
|
4158
3702
|
/**
|
|
4159
|
-
*
|
|
3703
|
+
* Request parameters for listReviews operation in ReviewsApi.
|
|
4160
3704
|
* @export
|
|
4161
|
-
* @
|
|
3705
|
+
* @interface ReviewsApiListReviewsRequest
|
|
3706
|
+
*/
|
|
3707
|
+
export interface ReviewsApiListReviewsRequest {
|
|
3708
|
+
/**
|
|
3709
|
+
* Project unique identifier
|
|
3710
|
+
* @type {string}
|
|
3711
|
+
* @memberof ReviewsApiListReviews
|
|
3712
|
+
*/
|
|
3713
|
+
readonly project: string
|
|
3714
|
+
|
|
3715
|
+
/**
|
|
3716
|
+
* The platform identifier
|
|
3717
|
+
* @type {string}
|
|
3718
|
+
* @memberof ReviewsApiListReviews
|
|
3719
|
+
*/
|
|
3720
|
+
readonly platformId: string
|
|
3721
|
+
|
|
3722
|
+
/**
|
|
3723
|
+
* Page reference token
|
|
3724
|
+
* @type {number}
|
|
3725
|
+
* @memberof ReviewsApiListReviews
|
|
3726
|
+
*/
|
|
3727
|
+
readonly pageToken?: number
|
|
3728
|
+
|
|
3729
|
+
/**
|
|
3730
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3731
|
+
* @type {number}
|
|
3732
|
+
* @memberof ReviewsApiListReviews
|
|
3733
|
+
*/
|
|
3734
|
+
readonly pageSize?: number
|
|
3735
|
+
|
|
3736
|
+
/**
|
|
3737
|
+
* Search term to filter results
|
|
3738
|
+
* @type {string}
|
|
3739
|
+
* @memberof ReviewsApiListReviews
|
|
3740
|
+
*/
|
|
3741
|
+
readonly search?: string
|
|
3742
|
+
|
|
3743
|
+
/**
|
|
3744
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3745
|
+
* @type {Array<string>}
|
|
3746
|
+
* @memberof ReviewsApiListReviews
|
|
3747
|
+
*/
|
|
3748
|
+
readonly sortBy?: Array<string>
|
|
3749
|
+
|
|
3750
|
+
/**
|
|
3751
|
+
* Start of date range to filter by
|
|
3752
|
+
* @type {string}
|
|
3753
|
+
* @memberof ReviewsApiListReviews
|
|
3754
|
+
*/
|
|
3755
|
+
readonly start?: string
|
|
3756
|
+
|
|
3757
|
+
/**
|
|
3758
|
+
* End of date range to filter by
|
|
3759
|
+
* @type {string}
|
|
3760
|
+
* @memberof ReviewsApiListReviews
|
|
3761
|
+
*/
|
|
3762
|
+
readonly end?: string
|
|
3763
|
+
}
|
|
3764
|
+
|
|
3765
|
+
/**
|
|
3766
|
+
* Request parameters for moderateReview operation in ReviewsApi.
|
|
3767
|
+
* @export
|
|
3768
|
+
* @interface ReviewsApiModerateReviewRequest
|
|
3769
|
+
*/
|
|
3770
|
+
export interface ReviewsApiModerateReviewRequest {
|
|
3771
|
+
/**
|
|
3772
|
+
* Project unique identifier
|
|
3773
|
+
* @type {string}
|
|
3774
|
+
* @memberof ReviewsApiModerateReview
|
|
3775
|
+
*/
|
|
3776
|
+
readonly project: string
|
|
3777
|
+
|
|
3778
|
+
/**
|
|
3779
|
+
* The platform identifier
|
|
3780
|
+
* @type {string}
|
|
3781
|
+
* @memberof ReviewsApiModerateReview
|
|
3782
|
+
*/
|
|
3783
|
+
readonly platformId: string
|
|
3784
|
+
|
|
3785
|
+
/**
|
|
3786
|
+
* The review identifier
|
|
3787
|
+
* @type {string}
|
|
3788
|
+
* @memberof ReviewsApiModerateReview
|
|
3789
|
+
*/
|
|
3790
|
+
readonly reviewId: string
|
|
3791
|
+
|
|
3792
|
+
/**
|
|
3793
|
+
*
|
|
3794
|
+
* @type {ModerateReviewRequest}
|
|
3795
|
+
* @memberof ReviewsApiModerateReview
|
|
3796
|
+
*/
|
|
3797
|
+
readonly moderateReviewRequest?: ModerateReviewRequest
|
|
3798
|
+
}
|
|
3799
|
+
|
|
3800
|
+
/**
|
|
3801
|
+
* ReviewsApi - object-oriented interface
|
|
3802
|
+
* @export
|
|
3803
|
+
* @class ReviewsApi
|
|
4162
3804
|
* @extends {BaseAPI}
|
|
4163
3805
|
*/
|
|
4164
|
-
export class
|
|
3806
|
+
export class ReviewsApi extends BaseAPI {
|
|
3807
|
+
/**
|
|
3808
|
+
* Export reviews as a CSV file.
|
|
3809
|
+
* @summary Export reviews
|
|
3810
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
3811
|
+
* @param {*} [options] Override http request option.
|
|
3812
|
+
* @throws {RequiredError}
|
|
3813
|
+
* @memberof ReviewsApi
|
|
3814
|
+
*/
|
|
3815
|
+
public exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig) {
|
|
3816
|
+
return ReviewsApiFp(this.configuration).exportReviews(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
3817
|
+
}
|
|
3818
|
+
|
|
3819
|
+
/**
|
|
3820
|
+
* Get a review left on a platform by a given review ID.
|
|
3821
|
+
* @summary Get review
|
|
3822
|
+
* @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
|
|
3823
|
+
* @param {*} [options] Override http request option.
|
|
3824
|
+
* @throws {RequiredError}
|
|
3825
|
+
* @memberof ReviewsApi
|
|
3826
|
+
*/
|
|
3827
|
+
public getReview(requestParameters: ReviewsApiGetReviewRequest, options?: RawAxiosRequestConfig) {
|
|
3828
|
+
return ReviewsApiFp(this.configuration).getReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, options).then((request) => request(this.axios, this.basePath));
|
|
3829
|
+
}
|
|
3830
|
+
|
|
3831
|
+
/**
|
|
3832
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
3833
|
+
* @summary List reviews
|
|
3834
|
+
* @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
|
|
3835
|
+
* @param {*} [options] Override http request option.
|
|
3836
|
+
* @throws {RequiredError}
|
|
3837
|
+
* @memberof ReviewsApi
|
|
3838
|
+
*/
|
|
3839
|
+
public listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig) {
|
|
3840
|
+
return ReviewsApiFp(this.configuration).listReviews(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
3841
|
+
}
|
|
3842
|
+
|
|
4165
3843
|
/**
|
|
4166
|
-
*
|
|
4167
|
-
* @summary
|
|
4168
|
-
* @param {
|
|
3844
|
+
* Moderate a review left on a platform.
|
|
3845
|
+
* @summary Moderate review
|
|
3846
|
+
* @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
|
|
4169
3847
|
* @param {*} [options] Override http request option.
|
|
4170
3848
|
* @throws {RequiredError}
|
|
4171
|
-
* @memberof
|
|
3849
|
+
* @memberof ReviewsApi
|
|
4172
3850
|
*/
|
|
4173
|
-
public
|
|
4174
|
-
return
|
|
3851
|
+
public moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig) {
|
|
3852
|
+
return ReviewsApiFp(this.configuration).moderateReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4175
3853
|
}
|
|
4176
3854
|
}
|
|
4177
3855
|
|