@gofynd/fdk-client-javascript 1.4.2-beta.3 → 1.4.2-beta.4

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 (42) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Order/OrderApplicationModel.d.ts +6 -0
  4. package/sdk/application/Order/OrderApplicationModel.js +6 -0
  5. package/sdk/application/Payment/PaymentApplicationModel.d.ts +27 -1
  6. package/sdk/application/Payment/PaymentApplicationModel.js +19 -0
  7. package/sdk/application/User/UserApplicationClient.d.ts +2 -2
  8. package/sdk/application/User/UserApplicationClient.js +4 -7
  9. package/sdk/application/User/UserApplicationModel.d.ts +32 -27
  10. package/sdk/application/User/UserApplicationModel.js +22 -32
  11. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +26 -0
  12. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +182 -0
  13. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +70 -1
  14. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +44 -0
  15. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +34 -1
  16. package/sdk/platform/Catalog/CatalogPlatformModel.js +44 -0
  17. package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -1
  18. package/sdk/platform/Content/ContentPlatformModel.js +20 -0
  19. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +1 -1
  20. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1
  21. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +2 -0
  22. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -0
  23. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +2 -2
  24. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +7 -4
  25. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +14 -1
  26. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +16 -0
  27. package/sdk/platform/Order/OrderPlatformModel.d.ts +12 -0
  28. package/sdk/platform/Order/OrderPlatformModel.js +12 -0
  29. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -1
  30. package/sdk/platform/Payment/PaymentPlatformModel.js +19 -0
  31. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +7 -6
  32. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +11 -10
  33. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +170 -33
  34. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +171 -38
  35. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
  36. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
  37. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
  38. package/sdk/platform/Share/SharePlatformApplicationClient.js +19 -6
  39. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +13 -3
  40. package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -2
  41. package/sdk/platform/User/UserPlatformModel.d.ts +83 -13
  42. package/sdk/platform/User/UserPlatformModel.js +82 -12
@@ -77,6 +77,7 @@ const FileStoragePlatformModel = require("./FileStoragePlatformModel");
77
77
  /**
78
78
  * @typedef GetPdfTypesParam
79
79
  * @property {string} [countryCode]
80
+ * @property {boolean} storeOs
80
81
  */
81
82
 
82
83
  /**
@@ -178,6 +179,7 @@ class FileStoragePlatformApplicationValidator {
178
179
  static getPdfTypes() {
179
180
  return Joi.object({
180
181
  countryCode: Joi.string().allow(""),
182
+ storeOs: Joi.boolean().required(),
181
183
  }).required();
182
184
  }
183
185
 
@@ -64,12 +64,12 @@ declare class FileStorage {
64
64
  * @param {FileStoragePlatformValidator.ProxyParam} arg - Arg object
65
65
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
66
66
  * @param {import("../PlatformAPIClient").Options} - Options
67
- * @returns {Promise<string>} - Success response
67
+ * @returns {Promise<FileStoragePlatformModel.ProxyResponse>} - Success response
68
68
  * @name proxy
69
69
  * @summary: Proxy
70
70
  * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/proxy/).
71
71
  */
72
- proxy({ url, requestHeaders }?: FileStoragePlatformValidator.ProxyParam, { responseHeaders }?: object): Promise<string>;
72
+ proxy({ url, requestHeaders }?: FileStoragePlatformValidator.ProxyParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.ProxyResponse>;
73
73
  /**
74
74
  * @param {FileStoragePlatformValidator.StartUploadParam} arg - Arg object
75
75
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -363,7 +363,7 @@ class FileStorage {
363
363
  * @param {FileStoragePlatformValidator.ProxyParam} arg - Arg object
364
364
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
365
365
  * @param {import("../PlatformAPIClient").Options} - Options
366
- * @returns {Promise<string>} - Success response
366
+ * @returns {Promise<FileStoragePlatformModel.ProxyResponse>} - Success response
367
367
  * @name proxy
368
368
  * @summary: Proxy
369
369
  * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/proxy/).
@@ -416,9 +416,12 @@ class FileStorage {
416
416
  responseData = response[0];
417
417
  }
418
418
 
419
- const { error: res_error } = Joi.string()
420
- .allow("")
421
- .validate(responseData, { abortEarly: false, allowUnknown: true });
419
+ const {
420
+ error: res_error,
421
+ } = FileStoragePlatformModel.ProxyResponse().validate(responseData, {
422
+ abortEarly: false,
423
+ allowUnknown: true,
424
+ });
422
425
 
423
426
  if (res_error) {
424
427
  if (this.config.options.strictResponseCheck === true) {
@@ -57,6 +57,11 @@ export = FileStoragePlatformModel;
57
57
  * @property {string} modified_on
58
58
  * @property {CreatedBy} [created_by]
59
59
  */
60
+ /**
61
+ * @typedef ProxyResponse
62
+ * @property {Object} [data]
63
+ * @property {Object} [support]
64
+ */
60
65
  /**
61
66
  * @typedef DestinationNamespace
62
67
  * @property {string} [namespace]
@@ -90,6 +95,7 @@ export = FileStoragePlatformModel;
90
95
  * @property {string[]} format
91
96
  * @property {number} __v
92
97
  * @property {boolean} visibility
98
+ * @property {boolean} store_os
93
99
  * @property {string} country_code
94
100
  */
95
101
  /**
@@ -552,7 +558,7 @@ export = FileStoragePlatformModel;
552
558
  declare class FileStoragePlatformModel {
553
559
  }
554
560
  declare namespace FileStoragePlatformModel {
555
- export { FailedResponse, CDN, Upload, StartResponse, StartRequest, CreatedBy, CompleteResponse, DestinationNamespace, CopyFiles, Urls, SignUrlResponse, SignUrlRequest, InvoiceTypesDataResponse, InvoiceTypesResponse, ConversionRate, DeliveryPartnerDetail, Image, PaymentData, InvoiceDetail, CompanyDetail, StoreDetail, CustomerBillingDetail, CustomerShippingDetail, ReturnDetail, Brand, Cgst, Sgst, Igst, Tax, ItemsProductTable, ProductTable, Taxes, TaxTable, RegisteredCompanyDetail, Kwargs, ShipmentIdBarcodeGenerator, SignedQrcodeGenerator, KwargsUpiQrcode, UpiQrcodeGenerator, DigitalsignatureGenerator, KwargsAwbNumber, AwbNumberLabelBarcodeGenerator, AwbNumberBarcodeGenerator, MetaProperty, Meta, DummyTemplateDataPayload, DummyTemplateData, DummyTemplateDataItems, PdfConfig, PdfConfigSuccessData, PdfConfigSuccess, PdfConfigSaveSuccessData, PdfConfigSaveSuccess, PdfDefaultTemplateSuccess, Document, PaymentReceiptRequestBody, PaymentReceiptOrderDetails, PaymentReceiptCustomerDetails, PaymentReceiptPayments, PaymentReceiptFormat, PaymentReceiptService, PaymentReceiptTaxes, PaymentReceiptPayload, PaymentReceiptMeta, ExtensionSlug };
561
+ export { FailedResponse, CDN, Upload, StartResponse, StartRequest, CreatedBy, CompleteResponse, ProxyResponse, DestinationNamespace, CopyFiles, Urls, SignUrlResponse, SignUrlRequest, InvoiceTypesDataResponse, InvoiceTypesResponse, ConversionRate, DeliveryPartnerDetail, Image, PaymentData, InvoiceDetail, CompanyDetail, StoreDetail, CustomerBillingDetail, CustomerShippingDetail, ReturnDetail, Brand, Cgst, Sgst, Igst, Tax, ItemsProductTable, ProductTable, Taxes, TaxTable, RegisteredCompanyDetail, Kwargs, ShipmentIdBarcodeGenerator, SignedQrcodeGenerator, KwargsUpiQrcode, UpiQrcodeGenerator, DigitalsignatureGenerator, KwargsAwbNumber, AwbNumberLabelBarcodeGenerator, AwbNumberBarcodeGenerator, MetaProperty, Meta, DummyTemplateDataPayload, DummyTemplateData, DummyTemplateDataItems, PdfConfig, PdfConfigSuccessData, PdfConfigSuccess, PdfConfigSaveSuccessData, PdfConfigSaveSuccess, PdfDefaultTemplateSuccess, Document, PaymentReceiptRequestBody, PaymentReceiptOrderDetails, PaymentReceiptCustomerDetails, PaymentReceiptPayments, PaymentReceiptFormat, PaymentReceiptService, PaymentReceiptTaxes, PaymentReceiptPayload, PaymentReceiptMeta, ExtensionSlug };
556
562
  }
557
563
  /** @returns {FailedResponse} */
558
564
  declare function FailedResponse(): FailedResponse;
@@ -619,6 +625,12 @@ type CompleteResponse = {
619
625
  modified_on: string;
620
626
  created_by?: CreatedBy;
621
627
  };
628
+ /** @returns {ProxyResponse} */
629
+ declare function ProxyResponse(): ProxyResponse;
630
+ type ProxyResponse = {
631
+ data?: any;
632
+ support?: any;
633
+ };
622
634
  /** @returns {DestinationNamespace} */
623
635
  declare function DestinationNamespace(): DestinationNamespace;
624
636
  type DestinationNamespace = {
@@ -658,6 +670,7 @@ type InvoiceTypesDataResponse = {
658
670
  format: string[];
659
671
  __v: number;
660
672
  visibility: boolean;
673
+ store_os: boolean;
661
674
  country_code: string;
662
675
  };
663
676
  /** @returns {InvoiceTypesResponse} */
@@ -65,6 +65,12 @@ const Joi = require("joi");
65
65
  * @property {CreatedBy} [created_by]
66
66
  */
67
67
 
68
+ /**
69
+ * @typedef ProxyResponse
70
+ * @property {Object} [data]
71
+ * @property {Object} [support]
72
+ */
73
+
68
74
  /**
69
75
  * @typedef DestinationNamespace
70
76
  * @property {string} [namespace]
@@ -103,6 +109,7 @@ const Joi = require("joi");
103
109
  * @property {string[]} format
104
110
  * @property {number} __v
105
111
  * @property {boolean} visibility
112
+ * @property {boolean} store_os
106
113
  * @property {string} country_code
107
114
  */
108
115
 
@@ -695,6 +702,14 @@ class FileStoragePlatformModel {
695
702
  });
696
703
  }
697
704
 
705
+ /** @returns {ProxyResponse} */
706
+ static ProxyResponse() {
707
+ return Joi.object({
708
+ data: Joi.object().pattern(/\S/, Joi.any()),
709
+ support: Joi.object().pattern(/\S/, Joi.any()),
710
+ });
711
+ }
712
+
698
713
  /** @returns {DestinationNamespace} */
699
714
  static DestinationNamespace() {
700
715
  return Joi.object({
@@ -744,6 +759,7 @@ class FileStoragePlatformModel {
744
759
  format: Joi.array().items(Joi.string().allow("")).required(),
745
760
  __v: Joi.number().required(),
746
761
  visibility: Joi.boolean().required(),
762
+ store_os: Joi.boolean().required(),
747
763
  country_code: Joi.string().allow("").required(),
748
764
  });
749
765
  }
@@ -1549,6 +1549,7 @@ export = OrderPlatformModel;
1549
1549
  * @property {number} [discount]
1550
1550
  * @property {number} [fynd_credits]
1551
1551
  * @property {number} [gift_price]
1552
+ * @property {number} [amount_to_be_collected]
1552
1553
  */
1553
1554
  /**
1554
1555
  * @typedef Identifier
@@ -1584,6 +1585,7 @@ export = OrderPlatformModel;
1584
1585
  * @property {number} discount
1585
1586
  * @property {number} fynd_credits
1586
1587
  * @property {number} gst_tax_percentage
1588
+ * @property {number} [amount_to_be_collected]
1587
1589
  * @property {Identifier} identifiers
1588
1590
  * @property {number} total_units
1589
1591
  * @property {boolean} added_to_fynd_cash
@@ -1841,6 +1843,7 @@ export = OrderPlatformModel;
1841
1843
  * @property {boolean} [lock_status]
1842
1844
  * @property {string} [invoice_id]
1843
1845
  * @property {Object} [payment_methods]
1846
+ * @property {Object[]} [payment_info]
1844
1847
  * @property {string} [status_created_at]
1845
1848
  * @property {string} [status_created_ts]
1846
1849
  * @property {string} [display_name]
@@ -2182,6 +2185,7 @@ export = OrderPlatformModel;
2182
2185
  * @property {AffiliateBagsDetails} [affiliate_bag_details]
2183
2186
  * @property {PlatformItem} [item]
2184
2187
  * @property {BagPaymentMethods[]} [payment_methods]
2188
+ * @property {BagPaymentMethods[]} [payment_info]
2185
2189
  * @property {number} [quantity]
2186
2190
  * @property {string} [identifier]
2187
2191
  * @property {boolean} [can_return]
@@ -2269,6 +2273,7 @@ export = OrderPlatformModel;
2269
2273
  * @property {DPDetailsData} [dp_details]
2270
2274
  * @property {string} [invoice_id]
2271
2275
  * @property {Object} [payment_methods]
2276
+ * @property {Object[]} [payment_info]
2272
2277
  * @property {Object} [coupon]
2273
2278
  * @property {AffiliateDetails} [affiliate_details]
2274
2279
  * @property {string} [priority_text]
@@ -2321,6 +2326,7 @@ export = OrderPlatformModel;
2321
2326
  * @property {string} fynd_order_id
2322
2327
  * @property {Prices} [prices]
2323
2328
  * @property {Object} [payment_methods]
2329
+ * @property {Object[]} [payment_info]
2324
2330
  */
2325
2331
  /**
2326
2332
  * @typedef OrderDetailsResponse
@@ -4849,6 +4855,7 @@ type Prices = {
4849
4855
  discount?: number;
4850
4856
  fynd_credits?: number;
4851
4857
  gift_price?: number;
4858
+ amount_to_be_collected?: number;
4852
4859
  };
4853
4860
  /** @returns {Identifier} */
4854
4861
  declare function Identifier(): Identifier;
@@ -4886,6 +4893,7 @@ type FinancialBreakup = {
4886
4893
  discount: number;
4887
4894
  fynd_credits: number;
4888
4895
  gst_tax_percentage: number;
4896
+ amount_to_be_collected?: number;
4889
4897
  identifiers: Identifier;
4890
4898
  total_units: number;
4891
4899
  added_to_fynd_cash: boolean;
@@ -5165,6 +5173,7 @@ type ShipmentItem = {
5165
5173
  lock_status?: boolean;
5166
5174
  invoice_id?: string;
5167
5175
  payment_methods?: any;
5176
+ payment_info?: any[];
5168
5177
  status_created_at?: string;
5169
5178
  status_created_ts?: string;
5170
5179
  display_name?: string;
@@ -5537,6 +5546,7 @@ type OrderBags = {
5537
5546
  affiliate_bag_details?: AffiliateBagsDetails;
5538
5547
  item?: PlatformItem;
5539
5548
  payment_methods?: BagPaymentMethods[];
5549
+ payment_info?: BagPaymentMethods[];
5540
5550
  quantity?: number;
5541
5551
  identifier?: string;
5542
5552
  can_return?: boolean;
@@ -5629,6 +5639,7 @@ type PlatformShipment = {
5629
5639
  dp_details?: DPDetailsData;
5630
5640
  invoice_id?: string;
5631
5641
  payment_methods?: any;
5642
+ payment_info?: any[];
5632
5643
  coupon?: any;
5633
5644
  affiliate_details?: AffiliateDetails;
5634
5645
  priority_text?: string;
@@ -5684,6 +5695,7 @@ type OrderData = {
5684
5695
  fynd_order_id: string;
5685
5696
  prices?: Prices;
5686
5697
  payment_methods?: any;
5698
+ payment_info?: any[];
5687
5699
  };
5688
5700
  /** @returns {OrderDetailsResponse} */
5689
5701
  declare function OrderDetailsResponse(): OrderDetailsResponse;
@@ -1742,6 +1742,7 @@ const Joi = require("joi");
1742
1742
  * @property {number} [discount]
1743
1743
  * @property {number} [fynd_credits]
1744
1744
  * @property {number} [gift_price]
1745
+ * @property {number} [amount_to_be_collected]
1745
1746
  */
1746
1747
 
1747
1748
  /**
@@ -1779,6 +1780,7 @@ const Joi = require("joi");
1779
1780
  * @property {number} discount
1780
1781
  * @property {number} fynd_credits
1781
1782
  * @property {number} gst_tax_percentage
1783
+ * @property {number} [amount_to_be_collected]
1782
1784
  * @property {Identifier} identifiers
1783
1785
  * @property {number} total_units
1784
1786
  * @property {boolean} added_to_fynd_cash
@@ -2058,6 +2060,7 @@ const Joi = require("joi");
2058
2060
  * @property {boolean} [lock_status]
2059
2061
  * @property {string} [invoice_id]
2060
2062
  * @property {Object} [payment_methods]
2063
+ * @property {Object[]} [payment_info]
2061
2064
  * @property {string} [status_created_at]
2062
2065
  * @property {string} [status_created_ts]
2063
2066
  * @property {string} [display_name]
@@ -2430,6 +2433,7 @@ const Joi = require("joi");
2430
2433
  * @property {AffiliateBagsDetails} [affiliate_bag_details]
2431
2434
  * @property {PlatformItem} [item]
2432
2435
  * @property {BagPaymentMethods[]} [payment_methods]
2436
+ * @property {BagPaymentMethods[]} [payment_info]
2433
2437
  * @property {number} [quantity]
2434
2438
  * @property {string} [identifier]
2435
2439
  * @property {boolean} [can_return]
@@ -2522,6 +2526,7 @@ const Joi = require("joi");
2522
2526
  * @property {DPDetailsData} [dp_details]
2523
2527
  * @property {string} [invoice_id]
2524
2528
  * @property {Object} [payment_methods]
2529
+ * @property {Object[]} [payment_info]
2525
2530
  * @property {Object} [coupon]
2526
2531
  * @property {AffiliateDetails} [affiliate_details]
2527
2532
  * @property {string} [priority_text]
@@ -2577,6 +2582,7 @@ const Joi = require("joi");
2577
2582
  * @property {string} fynd_order_id
2578
2583
  * @property {Prices} [prices]
2579
2584
  * @property {Object} [payment_methods]
2585
+ * @property {Object[]} [payment_info]
2580
2586
  */
2581
2587
 
2582
2588
  /**
@@ -5265,6 +5271,7 @@ class OrderPlatformModel {
5265
5271
  discount: Joi.number().allow(null),
5266
5272
  fynd_credits: Joi.number().allow(null),
5267
5273
  gift_price: Joi.number().allow(null),
5274
+ amount_to_be_collected: Joi.number().allow(null),
5268
5275
  });
5269
5276
  }
5270
5277
 
@@ -5306,6 +5313,7 @@ class OrderPlatformModel {
5306
5313
  discount: Joi.number().required(),
5307
5314
  fynd_credits: Joi.number().required(),
5308
5315
  gst_tax_percentage: Joi.number().required(),
5316
+ amount_to_be_collected: Joi.number(),
5309
5317
  identifiers: OrderPlatformModel.Identifier().required(),
5310
5318
  total_units: Joi.number().required(),
5311
5319
  added_to_fynd_cash: Joi.boolean().required(),
@@ -5631,6 +5639,7 @@ class OrderPlatformModel {
5631
5639
  lock_status: Joi.boolean().allow(null),
5632
5640
  invoice_id: Joi.string().allow("").allow(null),
5633
5641
  payment_methods: Joi.any().allow(null),
5642
+ payment_info: Joi.array().items(Joi.any()),
5634
5643
  status_created_at: Joi.string().allow(""),
5635
5644
  status_created_ts: Joi.string().allow(""),
5636
5645
  display_name: Joi.string().allow("").allow(null),
@@ -6067,6 +6076,7 @@ class OrderPlatformModel {
6067
6076
  payment_methods: Joi.array().items(
6068
6077
  OrderPlatformModel.BagPaymentMethods()
6069
6078
  ),
6079
+ payment_info: Joi.array().items(OrderPlatformModel.BagPaymentMethods()),
6070
6080
  quantity: Joi.number().allow(null),
6071
6081
  identifier: Joi.string().allow("").allow(null),
6072
6082
  can_return: Joi.boolean().allow(null),
@@ -6169,6 +6179,7 @@ class OrderPlatformModel {
6169
6179
  dp_details: OrderPlatformModel.DPDetailsData(),
6170
6180
  invoice_id: Joi.string().allow("").allow(null),
6171
6181
  payment_methods: Joi.any().allow(null),
6182
+ payment_info: Joi.array().items(Joi.any()),
6172
6183
  coupon: Joi.any().allow(null),
6173
6184
  affiliate_details: OrderPlatformModel.AffiliateDetails(),
6174
6185
  priority_text: Joi.string().allow("").allow(null),
@@ -6232,6 +6243,7 @@ class OrderPlatformModel {
6232
6243
  fynd_order_id: Joi.string().allow("").required(),
6233
6244
  prices: OrderPlatformModel.Prices(),
6234
6245
  payment_methods: Joi.any().allow(null),
6246
+ payment_info: Joi.array().items(Joi.any()),
6235
6247
  });
6236
6248
  }
6237
6249
 
@@ -136,6 +136,13 @@ export = PaymentPlatformModel;
136
136
  * @property {string} [payment_flow] - Payment_flow
137
137
  * @property {string} [api_link] - Api_link
138
138
  */
139
+ /**
140
+ * @typedef PaymentDefaultSelection
141
+ * @property {string} [mode] - Default Selection Payment Mode
142
+ * @property {string} [identifier] - Identifier for Payment Mode
143
+ * @property {boolean} [skip] - Decide if the default payment mode will skip the
144
+ * payment options page altogether or just be preferred on the Frontend
145
+ */
139
146
  /**
140
147
  * @typedef PaymentFlow
141
148
  * @property {AggregatorRoute} [bqr_razorpay]
@@ -156,6 +163,7 @@ export = PaymentPlatformModel;
156
163
  * @typedef PaymentOptionAndFlow
157
164
  * @property {RootPaymentMode[]} payment_option - Payment options
158
165
  * @property {PaymentFlow} payment_flows
166
+ * @property {PaymentDefaultSelection} [payment_default_selection]
159
167
  */
160
168
  /**
161
169
  * @typedef AdvanceObject
@@ -1169,7 +1177,7 @@ export = PaymentPlatformModel;
1169
1177
  declare class PaymentPlatformModel {
1170
1178
  }
1171
1179
  declare namespace PaymentPlatformModel {
1172
- export { PaymentGatewayConfigResponse, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigRequest, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorCodeAndResponse, IntentAppErrorList, ProductCODData, CODChargesLimitsResponse, PaymentModeLogo, IntentApp, PaymentModeList, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteResponse, PaymentOptionsResponse, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsResponse, PayoutBankDetails, PayoutRequest, PayoutResponse, UpdatePayoutResponse, UpdatePayoutRequest, DeletePayoutResponse, SubscriptionPaymentMethodResponse, DeleteSubscriptionPaymentMethodResponse, SubscriptionConfigResponse, SaveSubscriptionSetupIntentRequest, SaveSubscriptionSetupIntentResponse, RefundAccountResponse, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPRequest, IfscCodeResponse, OrderBeneficiaryDetails, OrderBeneficiaryResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationRequest, PaymentConfirmationResponse, CODdata, GetUserCODLimitResponse, SetCODForUserRequest, SetCODOptionResponse, EdcModelData, EdcAggregatorAndModelListResponse, StatisticsData, EdcDeviceStatsResponse, EdcAddRequest, EdcDevice, EdcDeviceAddResponse, EdcDeviceDetailsResponse, EdcUpdateRequest, EdcDeviceUpdateResponse, Page, EdcDeviceListResponse, PaymentInitializationRequest, PaymentInitializationResponse, PaymentStatusUpdateRequest, PaymentStatusUpdateResponse, ResendOrCancelPaymentRequest, LinkStatus, ResendOrCancelPaymentResponse, PaymentStatusBulkHandlerRequest, PaymentObjectListSerializer, PaymentStatusObject, PaymentStatusBulkHandlerResponse, GetOauthUrlResponse, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentResponse, MerchantOnBoardingRequest, MerchantOnBoardingResponse, ValidateCustomerRequest, ValidateCustomerResponse, GetPaymentLinkResponse, ErrorDescription, ErrorResponse, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, PollingPaymentLinkResponse, CancelOrResendPaymentLinkRequest, ResendPaymentLinkResponse, CancelPaymentLinkResponse, Code, PaymentCode, GetPaymentCode, GetPaymentCodeResponse, PlatformPaymentModeResponse, MerchnatPaymentModeRequest, OrderDetail, AddressDetail, PaymentSessionDetail, PaymentSessionRequestSerializer, PaymentSessionResponseSerializer, RefundSessionDetail, RefundSessionRequestSerializer, RefundSessionResponseSerializer, PaymentDetailsSerializer, CartDetailsSerializer, RefundDetailsSerializer, PaymentSessionSerializer, RefundSourcesPriority, RefundPriorityResponseSerializer, RefundPriorityRequestSerializer, MerchantPaymentModeRequest, FromConfig, ToConfig, PlatformPaymentModeCopyConfigRequest, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderRequest, PaymentOrderData, PaymentOrderResponse, AggregatorVersionItemSchema, AggregatorVersionResponse, AggregatorVersionRequestSchema, AggregatorControlRequest, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema };
1180
+ export { PaymentGatewayConfigResponse, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigRequest, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorCodeAndResponse, IntentAppErrorList, ProductCODData, CODChargesLimitsResponse, PaymentModeLogo, IntentApp, PaymentModeList, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteResponse, PaymentOptionsResponse, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsResponse, PayoutBankDetails, PayoutRequest, PayoutResponse, UpdatePayoutResponse, UpdatePayoutRequest, DeletePayoutResponse, SubscriptionPaymentMethodResponse, DeleteSubscriptionPaymentMethodResponse, SubscriptionConfigResponse, SaveSubscriptionSetupIntentRequest, SaveSubscriptionSetupIntentResponse, RefundAccountResponse, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPRequest, IfscCodeResponse, OrderBeneficiaryDetails, OrderBeneficiaryResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationRequest, PaymentConfirmationResponse, CODdata, GetUserCODLimitResponse, SetCODForUserRequest, SetCODOptionResponse, EdcModelData, EdcAggregatorAndModelListResponse, StatisticsData, EdcDeviceStatsResponse, EdcAddRequest, EdcDevice, EdcDeviceAddResponse, EdcDeviceDetailsResponse, EdcUpdateRequest, EdcDeviceUpdateResponse, Page, EdcDeviceListResponse, PaymentInitializationRequest, PaymentInitializationResponse, PaymentStatusUpdateRequest, PaymentStatusUpdateResponse, ResendOrCancelPaymentRequest, LinkStatus, ResendOrCancelPaymentResponse, PaymentStatusBulkHandlerRequest, PaymentObjectListSerializer, PaymentStatusObject, PaymentStatusBulkHandlerResponse, GetOauthUrlResponse, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentResponse, MerchantOnBoardingRequest, MerchantOnBoardingResponse, ValidateCustomerRequest, ValidateCustomerResponse, GetPaymentLinkResponse, ErrorDescription, ErrorResponse, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, PollingPaymentLinkResponse, CancelOrResendPaymentLinkRequest, ResendPaymentLinkResponse, CancelPaymentLinkResponse, Code, PaymentCode, GetPaymentCode, GetPaymentCodeResponse, PlatformPaymentModeResponse, MerchnatPaymentModeRequest, OrderDetail, AddressDetail, PaymentSessionDetail, PaymentSessionRequestSerializer, PaymentSessionResponseSerializer, RefundSessionDetail, RefundSessionRequestSerializer, RefundSessionResponseSerializer, PaymentDetailsSerializer, CartDetailsSerializer, RefundDetailsSerializer, PaymentSessionSerializer, RefundSourcesPriority, RefundPriorityResponseSerializer, RefundPriorityRequestSerializer, MerchantPaymentModeRequest, FromConfig, ToConfig, PlatformPaymentModeCopyConfigRequest, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderRequest, PaymentOrderData, PaymentOrderResponse, AggregatorVersionItemSchema, AggregatorVersionResponse, AggregatorVersionRequestSchema, AggregatorControlRequest, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema };
1173
1181
  }
1174
1182
  /** @returns {PaymentGatewayConfigResponse} */
1175
1183
  declare function PaymentGatewayConfigResponse(): PaymentGatewayConfigResponse;
@@ -1561,6 +1569,23 @@ type AggregatorRoute = {
1561
1569
  */
1562
1570
  api_link?: string;
1563
1571
  };
1572
+ /** @returns {PaymentDefaultSelection} */
1573
+ declare function PaymentDefaultSelection(): PaymentDefaultSelection;
1574
+ type PaymentDefaultSelection = {
1575
+ /**
1576
+ * - Default Selection Payment Mode
1577
+ */
1578
+ mode?: string;
1579
+ /**
1580
+ * - Identifier for Payment Mode
1581
+ */
1582
+ identifier?: string;
1583
+ /**
1584
+ * - Decide if the default payment mode will skip the
1585
+ * payment options page altogether or just be preferred on the Frontend
1586
+ */
1587
+ skip?: boolean;
1588
+ };
1564
1589
  /** @returns {PaymentFlow} */
1565
1590
  declare function PaymentFlow(): PaymentFlow;
1566
1591
  type PaymentFlow = {
@@ -1586,6 +1611,7 @@ type PaymentOptionAndFlow = {
1586
1611
  */
1587
1612
  payment_option: RootPaymentMode[];
1588
1613
  payment_flows: PaymentFlow;
1614
+ payment_default_selection?: PaymentDefaultSelection;
1589
1615
  };
1590
1616
  /** @returns {AdvanceObject} */
1591
1617
  declare function AdvanceObject(): AdvanceObject;
@@ -153,6 +153,14 @@ const Joi = require("joi");
153
153
  * @property {string} [api_link] - Api_link
154
154
  */
155
155
 
156
+ /**
157
+ * @typedef PaymentDefaultSelection
158
+ * @property {string} [mode] - Default Selection Payment Mode
159
+ * @property {string} [identifier] - Identifier for Payment Mode
160
+ * @property {boolean} [skip] - Decide if the default payment mode will skip the
161
+ * payment options page altogether or just be preferred on the Frontend
162
+ */
163
+
156
164
  /**
157
165
  * @typedef PaymentFlow
158
166
  * @property {AggregatorRoute} [bqr_razorpay]
@@ -174,6 +182,7 @@ const Joi = require("joi");
174
182
  * @typedef PaymentOptionAndFlow
175
183
  * @property {RootPaymentMode[]} payment_option - Payment options
176
184
  * @property {PaymentFlow} payment_flows
185
+ * @property {PaymentDefaultSelection} [payment_default_selection]
177
186
  */
178
187
 
179
188
  /**
@@ -1491,6 +1500,15 @@ class PaymentPlatformModel {
1491
1500
  });
1492
1501
  }
1493
1502
 
1503
+ /** @returns {PaymentDefaultSelection} */
1504
+ static PaymentDefaultSelection() {
1505
+ return Joi.object({
1506
+ mode: Joi.string().allow("").allow(null),
1507
+ identifier: Joi.string().allow("").allow(null),
1508
+ skip: Joi.boolean().allow(null),
1509
+ });
1510
+ }
1511
+
1494
1512
  /** @returns {PaymentFlow} */
1495
1513
  static PaymentFlow() {
1496
1514
  return Joi.object({
@@ -1517,6 +1535,7 @@ class PaymentPlatformModel {
1517
1535
  .items(PaymentPlatformModel.RootPaymentMode())
1518
1536
  .required(),
1519
1537
  payment_flows: PaymentPlatformModel.PaymentFlow().required(),
1538
+ payment_default_selection: PaymentPlatformModel.PaymentDefaultSelection(),
1520
1539
  });
1521
1540
  }
1522
1541
 
@@ -153,13 +153,14 @@ declare class Serviceability {
153
153
  * @param {ServiceabilityPlatformValidator.GetOptimalLocationsParam} arg - Arg object
154
154
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
155
155
  * @param {import("../PlatformAPIClient").Options} - Options
156
- * @returns {Promise<ServiceabilityPlatformModel.ReAssignStoreResponse>} -
157
- * Success response
156
+ * @returns {Promise<ServiceabilityPlatformModel.OptimalLocationsResponse>}
157
+ * - Success response
158
+ *
158
159
  * @name getOptimalLocations
159
- * @summary: Get serviceable store of the item
160
- * @description: This API returns serviceable store of the item. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getOptimalLocations/).
160
+ * @summary: Retrieve optimal locations
161
+ * @description: Retrieve optimal locations based on the specific criteria - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getOptimalLocations/).
161
162
  */
162
- getOptimalLocations({ body, requestHeaders }?: ServiceabilityPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ReAssignStoreResponse>;
163
+ getOptimalLocations({ body, requestHeaders }?: ServiceabilityPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.OptimalLocationsResponse>;
163
164
  /**
164
165
  * @param {ServiceabilityPlatformValidator.GetPackageMaterialListParam} arg
165
166
  * - Arg object
@@ -243,7 +244,7 @@ declare class Serviceability {
243
244
  * @summary: Shows zones defined at the company level
244
245
  * @description: Return the list of zones that are defined at the company level. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
245
246
  */
246
- getZones({ pageNo, pageSize, isActive, channelId, q, country, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponse>;
247
+ getZones({ pageNo, pageSize, isActive, channelId, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponse>;
247
248
  /**
248
249
  * @param {ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam} arg
249
250
  * - Arg object
@@ -1108,11 +1108,12 @@ class Serviceability {
1108
1108
  * @param {ServiceabilityPlatformValidator.GetOptimalLocationsParam} arg - Arg object
1109
1109
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1110
1110
  * @param {import("../PlatformAPIClient").Options} - Options
1111
- * @returns {Promise<ServiceabilityPlatformModel.ReAssignStoreResponse>} -
1112
- * Success response
1111
+ * @returns {Promise<ServiceabilityPlatformModel.OptimalLocationsResponse>}
1112
+ * - Success response
1113
+ *
1113
1114
  * @name getOptimalLocations
1114
- * @summary: Get serviceable store of the item
1115
- * @description: This API returns serviceable store of the item. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getOptimalLocations/).
1115
+ * @summary: Retrieve optimal locations
1116
+ * @description: Retrieve optimal locations based on the specific criteria - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getOptimalLocations/).
1116
1117
  */
1117
1118
  async getOptimalLocations(
1118
1119
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1153,7 +1154,7 @@ class Serviceability {
1153
1154
  const response = await PlatformAPIClient.execute(
1154
1155
  this.config,
1155
1156
  "post",
1156
- `/service/platform/logistics/v1.0/company/${this.config.companyId}/reassign`,
1157
+ `/service/platform/logistics/v1.0/company/${this.config.companyId}/optimal-locations`,
1157
1158
  query_params,
1158
1159
  body,
1159
1160
  { ...xHeaders, ...requestHeaders },
@@ -1167,7 +1168,7 @@ class Serviceability {
1167
1168
 
1168
1169
  const {
1169
1170
  error: res_error,
1170
- } = ServiceabilityPlatformModel.ReAssignStoreResponse().validate(
1171
+ } = ServiceabilityPlatformModel.OptimalLocationsResponse().validate(
1171
1172
  responseData,
1172
1173
  { abortEarly: false, allowUnknown: true }
1173
1174
  );
@@ -1728,7 +1729,7 @@ class Serviceability {
1728
1729
  isActive,
1729
1730
  channelId,
1730
1731
  q,
1731
- country,
1732
+ countryIsoCode,
1732
1733
  state,
1733
1734
  city,
1734
1735
  pincode,
@@ -1744,7 +1745,7 @@ class Serviceability {
1744
1745
  isActive,
1745
1746
  channelId,
1746
1747
  q,
1747
- country,
1748
+ countryIsoCode,
1748
1749
  state,
1749
1750
  city,
1750
1751
  pincode,
@@ -1766,7 +1767,7 @@ class Serviceability {
1766
1767
  isActive,
1767
1768
  channelId,
1768
1769
  q,
1769
- country,
1770
+ countryIsoCode,
1770
1771
  state,
1771
1772
  city,
1772
1773
  pincode,
@@ -1787,7 +1788,7 @@ class Serviceability {
1787
1788
  query_params["is_active"] = isActive;
1788
1789
  query_params["channel_id"] = channelId;
1789
1790
  query_params["q"] = q;
1790
- query_params["country"] = country;
1791
+ query_params["country_iso_code"] = countryIsoCode;
1791
1792
  query_params["state"] = state;
1792
1793
  query_params["city"] = city;
1793
1794
  query_params["pincode"] = pincode;