@gofynd/fdk-client-javascript 1.4.0-beta.1 → 1.4.0-beta.2

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.
Files changed (36) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationModel.d.ts +2 -0
  4. package/sdk/application/Cart/CartApplicationModel.js +2 -0
  5. package/sdk/application/Order/OrderApplicationModel.d.ts +2 -0
  6. package/sdk/application/Order/OrderApplicationModel.js +2 -0
  7. package/sdk/partner/Theme/ThemePartnerModel.d.ts +185 -315
  8. package/sdk/partner/Theme/ThemePartnerModel.js +182 -222
  9. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -12
  10. package/sdk/platform/Catalog/CatalogPlatformClient.js +17 -87
  11. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +11 -25
  12. package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -17
  13. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -1
  14. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +4 -1
  15. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +5 -0
  16. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +2 -0
  17. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -0
  18. package/sdk/platform/Discount/DiscountPlatformModel.js +2 -0
  19. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -44
  20. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +120 -54
  21. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -12
  22. package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -85
  23. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -12
  24. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -14
  25. package/sdk/platform/Order/OrderPlatformClient.d.ts +11 -61
  26. package/sdk/platform/Order/OrderPlatformClient.js +87 -481
  27. package/sdk/platform/Order/OrderPlatformModel.d.ts +442 -171
  28. package/sdk/platform/Order/OrderPlatformModel.js +483 -169
  29. package/sdk/platform/Order/OrderPlatformValidator.d.ts +22 -69
  30. package/sdk/platform/Order/OrderPlatformValidator.js +17 -79
  31. package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -21
  32. package/sdk/platform/Theme/ThemePlatformModel.js +108 -20
  33. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +2 -2
  34. package/sdk/platform/Webhook/WebhookPlatformClient.js +4 -2
  35. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +21 -27
  36. package/sdk/platform/Webhook/WebhookPlatformModel.js +30 -27
@@ -149,6 +149,16 @@ declare class Order {
149
149
  * @description: Fetch Refund Mode Config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
150
150
  */
151
151
  fetchRefundModeConfig({ body, requestHeaders }?: OrderPlatformValidator.FetchRefundModeConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundModeConfigResponsePayload>;
152
+ /**
153
+ * @param {OrderPlatformValidator.GenerateInvoiceIDParam} arg - Arg object
154
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
155
+ * @param {import("../PlatformAPIClient").Options} - Options
156
+ * @returns {Promise<OrderPlatformModel.GenerateInvoiceIDResponse>} - Success response
157
+ * @name generateInvoiceID
158
+ * @summary:
159
+ * @description: This API is used to manually generate Invoice ID against shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateInvoiceID/).
160
+ */
161
+ generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GenerateInvoiceIDResponse>;
152
162
  /**
153
163
  * @param {OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam} arg - Arg object
154
164
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -400,7 +410,7 @@ declare class Order {
400
410
  * @summary:
401
411
  * @description: Get shipment details for the given shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
402
412
  */
403
- getShipmentById({ channelShipmentId, shipmentId, requestHeaders }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponse>;
413
+ getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, requestHeaders }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponse>;
404
414
  /**
405
415
  * @param {OrderPlatformValidator.GetShipmentHistoryParam} arg - Arg object
406
416
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -504,66 +514,6 @@ declare class Order {
504
514
  customerId?: string;
505
515
  orderType?: string;
506
516
  }): Paginator<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
507
- /**
508
- * @param {OrderPlatformValidator.GetStateManagerTaskByIdParam} arg - Arg object
509
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
510
- * @param {import("../PlatformAPIClient").Options} - Options
511
- * @returns {Promise<Object>} - Success response
512
- * @name getStateManagerTaskById
513
- * @summary: Fetch a specific State Transition task
514
- * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateManagerTaskById/).
515
- */
516
- getStateManagerTaskById({ taskId, requestHeaders }?: OrderPlatformValidator.GetStateManagerTaskByIdParam, { responseHeaders }?: object): Promise<any>;
517
- /**
518
- * @param {OrderPlatformValidator.GetStateManagerTasksParam} arg - Arg object
519
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
520
- * @param {import("../PlatformAPIClient").Options} - Options
521
- * @returns {Promise<Object>} - Success response
522
- * @name getStateManagerTasks
523
- * @summary: Fetch all State Transition tasks
524
- * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateManagerTasks/).
525
- */
526
- getStateManagerTasks({ pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.GetStateManagerTasksParam, { responseHeaders }?: object): Promise<any>;
527
- /**
528
- * @param {OrderPlatformValidator.GetStateTransitionFiltersParam} arg - Arg object
529
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
530
- * @param {import("../PlatformAPIClient").Options} - Options
531
- * @returns {Promise<Object>} - Success response
532
- * @name getStateTransitionFilters
533
- * @summary: Fetch all State Transition filters
534
- * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionFilters/).
535
- */
536
- getStateTransitionFilters({ pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.GetStateTransitionFiltersParam, { responseHeaders }?: object): Promise<any>;
537
- /**
538
- * @param {OrderPlatformValidator.GetStateTransitionFiltersByIdParam} arg - Arg object
539
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
540
- * @param {import("../PlatformAPIClient").Options} - Options
541
- * @returns {Promise<Object>} - Success response
542
- * @name getStateTransitionFiltersById
543
- * @summary: Fetch a specific State Transition filter
544
- * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionFiltersById/).
545
- */
546
- getStateTransitionFiltersById({ filterId, requestHeaders }?: OrderPlatformValidator.GetStateTransitionFiltersByIdParam, { responseHeaders }?: object): Promise<any>;
547
- /**
548
- * @param {OrderPlatformValidator.GetStateTransitionFlagsParam} arg - Arg object
549
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
550
- * @param {import("../PlatformAPIClient").Options} - Options
551
- * @returns {Promise<Object>} - Success response
552
- * @name getStateTransitionFlags
553
- * @summary:
554
- * @description: Fetch all state transition flags for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionFlags/).
555
- */
556
- getStateTransitionFlags({ pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.GetStateTransitionFlagsParam, { responseHeaders }?: object): Promise<any>;
557
- /**
558
- * @param {OrderPlatformValidator.GetStateTransitionFlagsByIdParam} arg - Arg object
559
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
560
- * @param {import("../PlatformAPIClient").Options} - Options
561
- * @returns {Promise<Object>} - Success response
562
- * @name getStateTransitionFlagsById
563
- * @summary:
564
- * @description: Fetch a specific state transition flag for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionFlagsById/).
565
- */
566
- getStateTransitionFlagsById({ flagId, requestHeaders }?: OrderPlatformValidator.GetStateTransitionFlagsByIdParam, { responseHeaders }?: object): Promise<any>;
567
517
  /**
568
518
  * @param {OrderPlatformValidator.GetStateTransitionMapParam} arg - Arg object
569
519
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1171,6 +1171,87 @@ class Order {
1171
1171
  return response;
1172
1172
  }
1173
1173
 
1174
+ /**
1175
+ * @param {OrderPlatformValidator.GenerateInvoiceIDParam} arg - Arg object
1176
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1177
+ * @param {import("../PlatformAPIClient").Options} - Options
1178
+ * @returns {Promise<OrderPlatformModel.GenerateInvoiceIDResponse>} - Success response
1179
+ * @name generateInvoiceID
1180
+ * @summary:
1181
+ * @description: This API is used to manually generate Invoice ID against shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateInvoiceID/).
1182
+ */
1183
+ async generateInvoiceID(
1184
+ { invoiceType, body, requestHeaders } = { requestHeaders: {} },
1185
+ { responseHeaders } = { responseHeaders: false }
1186
+ ) {
1187
+ const { error } = OrderPlatformValidator.generateInvoiceID().validate(
1188
+ {
1189
+ invoiceType,
1190
+ body,
1191
+ },
1192
+ { abortEarly: false, allowUnknown: true }
1193
+ );
1194
+ if (error) {
1195
+ return Promise.reject(new FDKClientValidationError(error));
1196
+ }
1197
+
1198
+ // Showing warrnings if extra unknown parameters are found
1199
+ const {
1200
+ error: warrning,
1201
+ } = OrderPlatformValidator.generateInvoiceID().validate(
1202
+ {
1203
+ invoiceType,
1204
+ body,
1205
+ },
1206
+ { abortEarly: false, allowUnknown: false }
1207
+ );
1208
+ if (warrning) {
1209
+ Logger({
1210
+ level: "WARN",
1211
+ message: `Parameter Validation warrnings for platform > Order > generateInvoiceID \n ${warrning}`,
1212
+ });
1213
+ }
1214
+
1215
+ const query_params = {};
1216
+
1217
+ const xHeaders = {};
1218
+
1219
+ const response = await PlatformAPIClient.execute(
1220
+ this.config,
1221
+ "post",
1222
+ `/service/platform/order-manage/v1.0/company/${this.config.companyId}/${invoiceType}/id/generate`,
1223
+ query_params,
1224
+ body,
1225
+ { ...xHeaders, ...requestHeaders },
1226
+ { responseHeaders }
1227
+ );
1228
+
1229
+ let responseData = response;
1230
+ if (responseHeaders) {
1231
+ responseData = response[0];
1232
+ }
1233
+
1234
+ const {
1235
+ error: res_error,
1236
+ } = OrderPlatformModel.GenerateInvoiceIDResponse().validate(responseData, {
1237
+ abortEarly: false,
1238
+ allowUnknown: true,
1239
+ });
1240
+
1241
+ if (res_error) {
1242
+ if (this.config.options.strictResponseCheck === true) {
1243
+ return Promise.reject(new FDKResponseValidationError(res_error));
1244
+ } else {
1245
+ Logger({
1246
+ level: "WARN",
1247
+ message: `Response Validation Warnings for platform > Order > generateInvoiceID \n ${res_error}`,
1248
+ });
1249
+ }
1250
+ }
1251
+
1252
+ return response;
1253
+ }
1254
+
1174
1255
  /**
1175
1256
  * @param {OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam} arg - Arg object
1176
1257
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -3049,13 +3130,16 @@ class Order {
3049
3130
  * @description: Get shipment details for the given shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
3050
3131
  */
3051
3132
  async getShipmentById(
3052
- { channelShipmentId, shipmentId, requestHeaders } = { requestHeaders: {} },
3133
+ { channelShipmentId, shipmentId, fetchActiveShipment, requestHeaders } = {
3134
+ requestHeaders: {},
3135
+ },
3053
3136
  { responseHeaders } = { responseHeaders: false }
3054
3137
  ) {
3055
3138
  const { error } = OrderPlatformValidator.getShipmentById().validate(
3056
3139
  {
3057
3140
  channelShipmentId,
3058
3141
  shipmentId,
3142
+ fetchActiveShipment,
3059
3143
  },
3060
3144
  { abortEarly: false, allowUnknown: true }
3061
3145
  );
@@ -3070,6 +3154,7 @@ class Order {
3070
3154
  {
3071
3155
  channelShipmentId,
3072
3156
  shipmentId,
3157
+ fetchActiveShipment,
3073
3158
  },
3074
3159
  { abortEarly: false, allowUnknown: false }
3075
3160
  );
@@ -3083,6 +3168,7 @@ class Order {
3083
3168
  const query_params = {};
3084
3169
  query_params["channel_shipment_id"] = channelShipmentId;
3085
3170
  query_params["shipment_id"] = shipmentId;
3171
+ query_params["fetch_active_shipment"] = fetchActiveShipment;
3086
3172
 
3087
3173
  const xHeaders = {};
3088
3174
 
@@ -3610,486 +3696,6 @@ class Order {
3610
3696
  return paginator;
3611
3697
  }
3612
3698
 
3613
- /**
3614
- * @param {OrderPlatformValidator.GetStateManagerTaskByIdParam} arg - Arg object
3615
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
3616
- * @param {import("../PlatformAPIClient").Options} - Options
3617
- * @returns {Promise<Object>} - Success response
3618
- * @name getStateManagerTaskById
3619
- * @summary: Fetch a specific State Transition task
3620
- * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateManagerTaskById/).
3621
- */
3622
- async getStateManagerTaskById(
3623
- { taskId, requestHeaders } = { requestHeaders: {} },
3624
- { responseHeaders } = { responseHeaders: false }
3625
- ) {
3626
- const { error } = OrderPlatformValidator.getStateManagerTaskById().validate(
3627
- {
3628
- taskId,
3629
- },
3630
- { abortEarly: false, allowUnknown: true }
3631
- );
3632
- if (error) {
3633
- return Promise.reject(new FDKClientValidationError(error));
3634
- }
3635
-
3636
- // Showing warrnings if extra unknown parameters are found
3637
- const {
3638
- error: warrning,
3639
- } = OrderPlatformValidator.getStateManagerTaskById().validate(
3640
- {
3641
- taskId,
3642
- },
3643
- { abortEarly: false, allowUnknown: false }
3644
- );
3645
- if (warrning) {
3646
- Logger({
3647
- level: "WARN",
3648
- message: `Parameter Validation warrnings for platform > Order > getStateManagerTaskById \n ${warrning}`,
3649
- });
3650
- }
3651
-
3652
- const query_params = {};
3653
-
3654
- const xHeaders = {};
3655
-
3656
- const response = await PlatformAPIClient.execute(
3657
- this.config,
3658
- "get",
3659
- `/service/platform/order-manage/v1.0/company/${this.config.companyId}/state/transition/tasks/${taskId}`,
3660
- query_params,
3661
- undefined,
3662
- { ...xHeaders, ...requestHeaders },
3663
- { responseHeaders }
3664
- );
3665
-
3666
- let responseData = response;
3667
- if (responseHeaders) {
3668
- responseData = response[0];
3669
- }
3670
-
3671
- const { error: res_error } = Joi.any().validate(responseData, {
3672
- abortEarly: false,
3673
- allowUnknown: true,
3674
- });
3675
-
3676
- if (res_error) {
3677
- if (this.config.options.strictResponseCheck === true) {
3678
- return Promise.reject(new FDKResponseValidationError(res_error));
3679
- } else {
3680
- Logger({
3681
- level: "WARN",
3682
- message: `Response Validation Warnings for platform > Order > getStateManagerTaskById \n ${res_error}`,
3683
- });
3684
- }
3685
- }
3686
-
3687
- return response;
3688
- }
3689
-
3690
- /**
3691
- * @param {OrderPlatformValidator.GetStateManagerTasksParam} arg - Arg object
3692
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
3693
- * @param {import("../PlatformAPIClient").Options} - Options
3694
- * @returns {Promise<Object>} - Success response
3695
- * @name getStateManagerTasks
3696
- * @summary: Fetch all State Transition tasks
3697
- * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateManagerTasks/).
3698
- */
3699
- async getStateManagerTasks(
3700
- { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
3701
- { responseHeaders } = { responseHeaders: false }
3702
- ) {
3703
- const { error } = OrderPlatformValidator.getStateManagerTasks().validate(
3704
- {
3705
- pageNo,
3706
- pageSize,
3707
- },
3708
- { abortEarly: false, allowUnknown: true }
3709
- );
3710
- if (error) {
3711
- return Promise.reject(new FDKClientValidationError(error));
3712
- }
3713
-
3714
- // Showing warrnings if extra unknown parameters are found
3715
- const {
3716
- error: warrning,
3717
- } = OrderPlatformValidator.getStateManagerTasks().validate(
3718
- {
3719
- pageNo,
3720
- pageSize,
3721
- },
3722
- { abortEarly: false, allowUnknown: false }
3723
- );
3724
- if (warrning) {
3725
- Logger({
3726
- level: "WARN",
3727
- message: `Parameter Validation warrnings for platform > Order > getStateManagerTasks \n ${warrning}`,
3728
- });
3729
- }
3730
-
3731
- const query_params = {};
3732
- query_params["page_no"] = pageNo;
3733
- query_params["page_size"] = pageSize;
3734
-
3735
- const xHeaders = {};
3736
-
3737
- const response = await PlatformAPIClient.execute(
3738
- this.config,
3739
- "get",
3740
- `/service/platform/order-manage/v1.0/company/${this.config.companyId}/state/transition/tasks`,
3741
- query_params,
3742
- undefined,
3743
- { ...xHeaders, ...requestHeaders },
3744
- { responseHeaders }
3745
- );
3746
-
3747
- let responseData = response;
3748
- if (responseHeaders) {
3749
- responseData = response[0];
3750
- }
3751
-
3752
- const { error: res_error } = Joi.any().validate(responseData, {
3753
- abortEarly: false,
3754
- allowUnknown: true,
3755
- });
3756
-
3757
- if (res_error) {
3758
- if (this.config.options.strictResponseCheck === true) {
3759
- return Promise.reject(new FDKResponseValidationError(res_error));
3760
- } else {
3761
- Logger({
3762
- level: "WARN",
3763
- message: `Response Validation Warnings for platform > Order > getStateManagerTasks \n ${res_error}`,
3764
- });
3765
- }
3766
- }
3767
-
3768
- return response;
3769
- }
3770
-
3771
- /**
3772
- * @param {OrderPlatformValidator.GetStateTransitionFiltersParam} arg - Arg object
3773
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
3774
- * @param {import("../PlatformAPIClient").Options} - Options
3775
- * @returns {Promise<Object>} - Success response
3776
- * @name getStateTransitionFilters
3777
- * @summary: Fetch all State Transition filters
3778
- * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionFilters/).
3779
- */
3780
- async getStateTransitionFilters(
3781
- { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
3782
- { responseHeaders } = { responseHeaders: false }
3783
- ) {
3784
- const {
3785
- error,
3786
- } = OrderPlatformValidator.getStateTransitionFilters().validate(
3787
- {
3788
- pageNo,
3789
- pageSize,
3790
- },
3791
- { abortEarly: false, allowUnknown: true }
3792
- );
3793
- if (error) {
3794
- return Promise.reject(new FDKClientValidationError(error));
3795
- }
3796
-
3797
- // Showing warrnings if extra unknown parameters are found
3798
- const {
3799
- error: warrning,
3800
- } = OrderPlatformValidator.getStateTransitionFilters().validate(
3801
- {
3802
- pageNo,
3803
- pageSize,
3804
- },
3805
- { abortEarly: false, allowUnknown: false }
3806
- );
3807
- if (warrning) {
3808
- Logger({
3809
- level: "WARN",
3810
- message: `Parameter Validation warrnings for platform > Order > getStateTransitionFilters \n ${warrning}`,
3811
- });
3812
- }
3813
-
3814
- const query_params = {};
3815
- query_params["page_no"] = pageNo;
3816
- query_params["page_size"] = pageSize;
3817
-
3818
- const xHeaders = {};
3819
-
3820
- const response = await PlatformAPIClient.execute(
3821
- this.config,
3822
- "get",
3823
- `/service/platform/order-manage/v1.0/company/${this.config.companyId}/state/transition/filters`,
3824
- query_params,
3825
- undefined,
3826
- { ...xHeaders, ...requestHeaders },
3827
- { responseHeaders }
3828
- );
3829
-
3830
- let responseData = response;
3831
- if (responseHeaders) {
3832
- responseData = response[0];
3833
- }
3834
-
3835
- const { error: res_error } = Joi.any().validate(responseData, {
3836
- abortEarly: false,
3837
- allowUnknown: true,
3838
- });
3839
-
3840
- if (res_error) {
3841
- if (this.config.options.strictResponseCheck === true) {
3842
- return Promise.reject(new FDKResponseValidationError(res_error));
3843
- } else {
3844
- Logger({
3845
- level: "WARN",
3846
- message: `Response Validation Warnings for platform > Order > getStateTransitionFilters \n ${res_error}`,
3847
- });
3848
- }
3849
- }
3850
-
3851
- return response;
3852
- }
3853
-
3854
- /**
3855
- * @param {OrderPlatformValidator.GetStateTransitionFiltersByIdParam} arg - Arg object
3856
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
3857
- * @param {import("../PlatformAPIClient").Options} - Options
3858
- * @returns {Promise<Object>} - Success response
3859
- * @name getStateTransitionFiltersById
3860
- * @summary: Fetch a specific State Transition filter
3861
- * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionFiltersById/).
3862
- */
3863
- async getStateTransitionFiltersById(
3864
- { filterId, requestHeaders } = { requestHeaders: {} },
3865
- { responseHeaders } = { responseHeaders: false }
3866
- ) {
3867
- const {
3868
- error,
3869
- } = OrderPlatformValidator.getStateTransitionFiltersById().validate(
3870
- {
3871
- filterId,
3872
- },
3873
- { abortEarly: false, allowUnknown: true }
3874
- );
3875
- if (error) {
3876
- return Promise.reject(new FDKClientValidationError(error));
3877
- }
3878
-
3879
- // Showing warrnings if extra unknown parameters are found
3880
- const {
3881
- error: warrning,
3882
- } = OrderPlatformValidator.getStateTransitionFiltersById().validate(
3883
- {
3884
- filterId,
3885
- },
3886
- { abortEarly: false, allowUnknown: false }
3887
- );
3888
- if (warrning) {
3889
- Logger({
3890
- level: "WARN",
3891
- message: `Parameter Validation warrnings for platform > Order > getStateTransitionFiltersById \n ${warrning}`,
3892
- });
3893
- }
3894
-
3895
- const query_params = {};
3896
-
3897
- const xHeaders = {};
3898
-
3899
- const response = await PlatformAPIClient.execute(
3900
- this.config,
3901
- "get",
3902
- `/service/platform/order-manage/v1.0/company/${this.config.companyId}/state/transition/filters/${filterId}`,
3903
- query_params,
3904
- undefined,
3905
- { ...xHeaders, ...requestHeaders },
3906
- { responseHeaders }
3907
- );
3908
-
3909
- let responseData = response;
3910
- if (responseHeaders) {
3911
- responseData = response[0];
3912
- }
3913
-
3914
- const { error: res_error } = Joi.any().validate(responseData, {
3915
- abortEarly: false,
3916
- allowUnknown: true,
3917
- });
3918
-
3919
- if (res_error) {
3920
- if (this.config.options.strictResponseCheck === true) {
3921
- return Promise.reject(new FDKResponseValidationError(res_error));
3922
- } else {
3923
- Logger({
3924
- level: "WARN",
3925
- message: `Response Validation Warnings for platform > Order > getStateTransitionFiltersById \n ${res_error}`,
3926
- });
3927
- }
3928
- }
3929
-
3930
- return response;
3931
- }
3932
-
3933
- /**
3934
- * @param {OrderPlatformValidator.GetStateTransitionFlagsParam} arg - Arg object
3935
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
3936
- * @param {import("../PlatformAPIClient").Options} - Options
3937
- * @returns {Promise<Object>} - Success response
3938
- * @name getStateTransitionFlags
3939
- * @summary:
3940
- * @description: Fetch all state transition flags for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionFlags/).
3941
- */
3942
- async getStateTransitionFlags(
3943
- { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
3944
- { responseHeaders } = { responseHeaders: false }
3945
- ) {
3946
- const { error } = OrderPlatformValidator.getStateTransitionFlags().validate(
3947
- {
3948
- pageNo,
3949
- pageSize,
3950
- },
3951
- { abortEarly: false, allowUnknown: true }
3952
- );
3953
- if (error) {
3954
- return Promise.reject(new FDKClientValidationError(error));
3955
- }
3956
-
3957
- // Showing warrnings if extra unknown parameters are found
3958
- const {
3959
- error: warrning,
3960
- } = OrderPlatformValidator.getStateTransitionFlags().validate(
3961
- {
3962
- pageNo,
3963
- pageSize,
3964
- },
3965
- { abortEarly: false, allowUnknown: false }
3966
- );
3967
- if (warrning) {
3968
- Logger({
3969
- level: "WARN",
3970
- message: `Parameter Validation warrnings for platform > Order > getStateTransitionFlags \n ${warrning}`,
3971
- });
3972
- }
3973
-
3974
- const query_params = {};
3975
- query_params["page_no"] = pageNo;
3976
- query_params["page_size"] = pageSize;
3977
-
3978
- const xHeaders = {};
3979
-
3980
- const response = await PlatformAPIClient.execute(
3981
- this.config,
3982
- "get",
3983
- `/service/platform/order-manage/v1.0/company/${this.config.companyId}/state/transition/flags`,
3984
- query_params,
3985
- undefined,
3986
- { ...xHeaders, ...requestHeaders },
3987
- { responseHeaders }
3988
- );
3989
-
3990
- let responseData = response;
3991
- if (responseHeaders) {
3992
- responseData = response[0];
3993
- }
3994
-
3995
- const { error: res_error } = Joi.any().validate(responseData, {
3996
- abortEarly: false,
3997
- allowUnknown: true,
3998
- });
3999
-
4000
- if (res_error) {
4001
- if (this.config.options.strictResponseCheck === true) {
4002
- return Promise.reject(new FDKResponseValidationError(res_error));
4003
- } else {
4004
- Logger({
4005
- level: "WARN",
4006
- message: `Response Validation Warnings for platform > Order > getStateTransitionFlags \n ${res_error}`,
4007
- });
4008
- }
4009
- }
4010
-
4011
- return response;
4012
- }
4013
-
4014
- /**
4015
- * @param {OrderPlatformValidator.GetStateTransitionFlagsByIdParam} arg - Arg object
4016
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
4017
- * @param {import("../PlatformAPIClient").Options} - Options
4018
- * @returns {Promise<Object>} - Success response
4019
- * @name getStateTransitionFlagsById
4020
- * @summary:
4021
- * @description: Fetch a specific state transition flag for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionFlagsById/).
4022
- */
4023
- async getStateTransitionFlagsById(
4024
- { flagId, requestHeaders } = { requestHeaders: {} },
4025
- { responseHeaders } = { responseHeaders: false }
4026
- ) {
4027
- const {
4028
- error,
4029
- } = OrderPlatformValidator.getStateTransitionFlagsById().validate(
4030
- {
4031
- flagId,
4032
- },
4033
- { abortEarly: false, allowUnknown: true }
4034
- );
4035
- if (error) {
4036
- return Promise.reject(new FDKClientValidationError(error));
4037
- }
4038
-
4039
- // Showing warrnings if extra unknown parameters are found
4040
- const {
4041
- error: warrning,
4042
- } = OrderPlatformValidator.getStateTransitionFlagsById().validate(
4043
- {
4044
- flagId,
4045
- },
4046
- { abortEarly: false, allowUnknown: false }
4047
- );
4048
- if (warrning) {
4049
- Logger({
4050
- level: "WARN",
4051
- message: `Parameter Validation warrnings for platform > Order > getStateTransitionFlagsById \n ${warrning}`,
4052
- });
4053
- }
4054
-
4055
- const query_params = {};
4056
-
4057
- const xHeaders = {};
4058
-
4059
- const response = await PlatformAPIClient.execute(
4060
- this.config,
4061
- "get",
4062
- `/service/platform/order-manage/v1.0/company/${this.config.companyId}/state/transition/flags/${flagId}`,
4063
- query_params,
4064
- undefined,
4065
- { ...xHeaders, ...requestHeaders },
4066
- { responseHeaders }
4067
- );
4068
-
4069
- let responseData = response;
4070
- if (responseHeaders) {
4071
- responseData = response[0];
4072
- }
4073
-
4074
- const { error: res_error } = Joi.any().validate(responseData, {
4075
- abortEarly: false,
4076
- allowUnknown: true,
4077
- });
4078
-
4079
- if (res_error) {
4080
- if (this.config.options.strictResponseCheck === true) {
4081
- return Promise.reject(new FDKResponseValidationError(res_error));
4082
- } else {
4083
- Logger({
4084
- level: "WARN",
4085
- message: `Response Validation Warnings for platform > Order > getStateTransitionFlagsById \n ${res_error}`,
4086
- });
4087
- }
4088
- }
4089
-
4090
- return response;
4091
- }
4092
-
4093
3699
  /**
4094
3700
  * @param {OrderPlatformValidator.GetStateTransitionMapParam} arg - Arg object
4095
3701
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`