@gofynd/fdk-client-javascript 1.4.7 → 1.4.8-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 (110) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +16 -3
  4. package/sdk/application/Cart/CartApplicationClient.js +118 -13
  5. package/sdk/application/Cart/CartApplicationModel.d.ts +121 -45
  6. package/sdk/application/Cart/CartApplicationModel.js +98 -26
  7. package/sdk/application/Cart/CartApplicationValidator.d.ts +45 -1
  8. package/sdk/application/Cart/CartApplicationValidator.js +26 -0
  9. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +4 -2
  10. package/sdk/application/Catalog/CatalogApplicationModel.js +4 -2
  11. package/sdk/application/Content/ContentApplicationClient.d.ts +1 -1
  12. package/sdk/application/Content/ContentApplicationClient.js +5 -3
  13. package/sdk/application/Content/ContentApplicationModel.d.ts +5 -18
  14. package/sdk/application/Content/ContentApplicationModel.js +4 -20
  15. package/sdk/application/Content/ContentApplicationValidator.d.ts +10 -0
  16. package/sdk/application/Content/ContentApplicationValidator.js +4 -0
  17. package/sdk/application/Lead/LeadApplicationClient.d.ts +0 -27
  18. package/sdk/application/Lead/LeadApplicationClient.js +0 -167
  19. package/sdk/application/Lead/LeadApplicationModel.d.ts +1 -146
  20. package/sdk/application/Lead/LeadApplicationModel.js +0 -126
  21. package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -25
  22. package/sdk/application/Lead/LeadApplicationValidator.js +0 -24
  23. package/sdk/application/Logistic/LogisticApplicationClient.js +1 -1
  24. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +2 -0
  25. package/sdk/application/Logistic/LogisticApplicationModel.js +2 -0
  26. package/sdk/application/Order/OrderApplicationModel.d.ts +2 -0
  27. package/sdk/application/Order/OrderApplicationModel.js +2 -0
  28. package/sdk/application/Payment/PaymentApplicationModel.d.ts +9 -2
  29. package/sdk/application/Payment/PaymentApplicationModel.js +5 -2
  30. package/sdk/application/Theme/ThemeApplicationModel.d.ts +2 -0
  31. package/sdk/application/Theme/ThemeApplicationModel.js +2 -0
  32. package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -23
  33. package/sdk/partner/Lead/LeadPartnerClient.js +0 -157
  34. package/sdk/partner/Lead/LeadPartnerModel.d.ts +12 -581
  35. package/sdk/partner/Lead/LeadPartnerModel.js +14 -403
  36. package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -2
  37. package/sdk/partner/Lead/LeadPartnerValidator.js +0 -12
  38. package/sdk/partner/Logistics/LogisticsPartnerClient.js +1 -1
  39. package/sdk/partner/Logistics/LogisticsPartnerModel.js +4 -4
  40. package/sdk/partner/Theme/ThemePartnerClient.d.ts +22 -0
  41. package/sdk/partner/Theme/ThemePartnerClient.js +162 -0
  42. package/sdk/partner/Theme/ThemePartnerModel.d.ts +119 -1
  43. package/sdk/partner/Theme/ThemePartnerModel.js +142 -0
  44. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
  45. package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
  46. package/sdk/platform/Billing/BillingPlatformClient.d.ts +304 -43
  47. package/sdk/platform/Billing/BillingPlatformClient.js +2218 -118
  48. package/sdk/platform/Billing/BillingPlatformModel.d.ts +1330 -282
  49. package/sdk/platform/Billing/BillingPlatformModel.js +1808 -590
  50. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +324 -16
  51. package/sdk/platform/Billing/BillingPlatformValidator.js +340 -12
  52. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +28 -5
  53. package/sdk/platform/Cart/CartPlatformApplicationClient.js +198 -5
  54. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +81 -1
  55. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +48 -0
  56. package/sdk/platform/Cart/CartPlatformModel.d.ts +214 -40
  57. package/sdk/platform/Cart/CartPlatformModel.js +164 -24
  58. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
  59. package/sdk/platform/Catalog/CatalogPlatformClient.js +18 -2
  60. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +4 -0
  61. package/sdk/platform/Catalog/CatalogPlatformModel.js +4 -0
  62. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +28 -0
  63. package/sdk/platform/Catalog/CatalogPlatformValidator.js +12 -0
  64. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +1 -1
  65. package/sdk/platform/Content/ContentPlatformApplicationClient.js +18 -1
  66. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +25 -0
  67. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +10 -0
  68. package/sdk/platform/Content/ContentPlatformModel.d.ts +6 -4
  69. package/sdk/platform/Content/ContentPlatformModel.js +6 -4
  70. package/sdk/platform/Finance/FinancePlatformClient.d.ts +49 -28
  71. package/sdk/platform/Finance/FinancePlatformClient.js +181 -28
  72. package/sdk/platform/Finance/FinancePlatformModel.d.ts +350 -127
  73. package/sdk/platform/Finance/FinancePlatformModel.js +378 -108
  74. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +56 -43
  75. package/sdk/platform/Finance/FinancePlatformValidator.js +61 -42
  76. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +0 -47
  77. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +0 -321
  78. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -46
  79. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +0 -48
  80. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -25
  81. package/sdk/platform/Lead/LeadPlatformClient.js +2 -167
  82. package/sdk/platform/Lead/LeadPlatformModel.d.ts +82 -204
  83. package/sdk/platform/Lead/LeadPlatformModel.js +98 -178
  84. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -25
  85. package/sdk/platform/Lead/LeadPlatformValidator.js +0 -24
  86. package/sdk/platform/Order/OrderPlatformModel.d.ts +108 -15
  87. package/sdk/platform/Order/OrderPlatformModel.js +47 -14
  88. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +12 -0
  89. package/sdk/platform/Payment/PaymentPlatformModel.js +5 -0
  90. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -4
  91. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +12 -0
  92. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +82 -0
  93. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -1
  94. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +14 -0
  95. package/sdk/platform/Theme/ThemePlatformModel.d.ts +67 -1
  96. package/sdk/platform/Theme/ThemePlatformModel.js +78 -0
  97. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +0 -40
  98. package/sdk/platform/Webhook/WebhookPlatformClient.js +0 -307
  99. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +112 -164
  100. package/sdk/platform/Webhook/WebhookPlatformModel.js +118 -169
  101. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +9 -35
  102. package/sdk/platform/Webhook/WebhookPlatformValidator.js +8 -46
  103. package/sdk/public/Billing/BillingPublicClient.d.ts +24 -2
  104. package/sdk/public/Billing/BillingPublicClient.js +156 -3
  105. package/sdk/public/Billing/BillingPublicModel.d.ts +368 -26
  106. package/sdk/public/Billing/BillingPublicModel.js +317 -18
  107. package/sdk/public/Billing/BillingPublicValidator.d.ts +19 -3
  108. package/sdk/public/Billing/BillingPublicValidator.js +22 -3
  109. package/sdk/public/Webhook/WebhookPublicModel.d.ts +22 -22
  110. package/sdk/public/Webhook/WebhookPublicModel.js +22 -22
@@ -255,6 +255,7 @@ const Joi = require("joi");
255
255
  * @property {boolean} [lock_after_transition] - Lock Shipment After Transition
256
256
  * @property {boolean} [unlock_before_transition] - Unlock Shipment After Transition
257
257
  * @property {boolean} [task] - To Run Status Update as a background Task
258
+ * @property {boolean} [resume_tasks_after_unlock] - Resume Tasks After Unlock
258
259
  */
259
260
 
260
261
  /**
@@ -730,21 +731,24 @@ const Joi = require("joi");
730
731
 
731
732
  /**
732
733
  * @typedef Charge
733
- * @property {string} name
734
- * @property {Object} amount
734
+ * @property {string} name - The name of the charge.
735
+ * @property {Object} amount - The monetary value of the charge, including value
736
+ * and currency details.
735
737
  * @property {Tax} [tax]
736
- * @property {string} [code]
737
- * @property {string} type
738
+ * @property {string} [code] - An optional code associated with the charge for
739
+ * internal tracking.
740
+ * @property {string} type - The category or type of the charge.
738
741
  */
739
742
 
740
743
  /**
741
744
  * @typedef LineItem
742
745
  * @property {Charge[]} [charges]
743
- * @property {Object} [meta]
744
- * @property {string} [custom_message]
745
- * @property {number} [quantity]
746
- * @property {string} seller_identifier
747
- * @property {string} [external_line_id]
746
+ * @property {Object} [meta] - Meta data of the articles or line items.
747
+ * @property {string} [custom_message] - Meta data of the articles or line items.
748
+ * @property {number} [quantity] - Quantity of the articles or line items.
749
+ * @property {string} seller_identifier - Seller identifier of the articles or line items.
750
+ * @property {string} [external_line_id] - External unique identifier of the
751
+ * articles or line items.
748
752
  */
749
753
 
750
754
  /**
@@ -760,12 +764,16 @@ const Joi = require("joi");
760
764
  /**
761
765
  * @typedef Shipment
762
766
  * @property {LineItem[]} line_items
763
- * @property {string} [external_shipment_id]
767
+ * @property {string} [external_shipment_id] - External shipment identifier or
768
+ * marketplace's unique shipment identifier.
764
769
  * @property {ProcessingDates} [processing_dates]
765
- * @property {Object} [meta]
766
- * @property {number} [priority]
767
- * @property {number} location_id
768
- * @property {string} [order_type]
770
+ * @property {Object} [meta] - Meta data of the shipment.
771
+ * @property {number} [priority] - Integer value indicating high and low priority.
772
+ * @property {number} location_id - Location Identifier or Store/Fulfillment
773
+ * Identifier of the shipment.
774
+ * @property {string} [order_type] - The order type of shipment HomeDelivery -
775
+ * If the customer wants the order home-delivered PickAtStore - If the
776
+ * customer wants the handover of an order at the store itself.
769
777
  * @property {string} [parent_type]
770
778
  * @property {string} [store_invoice_id]
771
779
  * @property {string} [lock_status]
@@ -795,6 +803,17 @@ const Joi = require("joi");
795
803
  * @property {ShipmentGstDetails} [gst]
796
804
  */
797
805
 
806
+ /**
807
+ * @typedef ShipmentRequestData
808
+ * @property {LineItem[]} line_items
809
+ * @property {ProcessingDates} [processing_dates]
810
+ * @property {Object} [meta] - Meta data of the shipment.
811
+ * @property {number} [priority] - Integer value indicating high and low priority.
812
+ * @property {string} [order_type] - The order type of shipment HomeDelivery -
813
+ * If the customer wants the order home-delivered PickAtStore - If the
814
+ * customer wants the handover of an order at the store itself.
815
+ */
816
+
798
817
  /**
799
818
  * @typedef ShippingInfo
800
819
  * @property {string} [alternate_mobile_number]
@@ -895,6 +914,7 @@ const Joi = require("joi");
895
914
  /**
896
915
  * @typedef CreateOrderAPI
897
916
  * @property {Shipment[]} shipments
917
+ * @property {ShipmentRequestData} [shipment_request_data]
898
918
  * @property {ShippingInfo} shipping_info
899
919
  * @property {BillingInfo} billing_info
900
920
  * @property {Object} [currency_info]
@@ -3488,6 +3508,7 @@ class OrderPlatformModel {
3488
3508
  lock_after_transition: Joi.boolean(),
3489
3509
  unlock_before_transition: Joi.boolean(),
3490
3510
  task: Joi.boolean(),
3511
+ resume_tasks_after_unlock: Joi.boolean(),
3491
3512
  });
3492
3513
  }
3493
3514
 
@@ -4148,6 +4169,17 @@ class OrderPlatformModel {
4148
4169
  });
4149
4170
  }
4150
4171
 
4172
+ /** @returns {ShipmentRequestData} */
4173
+ static ShipmentRequestData() {
4174
+ return Joi.object({
4175
+ line_items: Joi.array().items(OrderPlatformModel.LineItem()).required(),
4176
+ processing_dates: OrderPlatformModel.ProcessingDates(),
4177
+ meta: Joi.any(),
4178
+ priority: Joi.number(),
4179
+ order_type: Joi.string().allow(""),
4180
+ });
4181
+ }
4182
+
4151
4183
  /** @returns {ShippingInfo} */
4152
4184
  static ShippingInfo() {
4153
4185
  return Joi.object({
@@ -4261,6 +4293,7 @@ class OrderPlatformModel {
4261
4293
  static CreateOrderAPI() {
4262
4294
  return Joi.object({
4263
4295
  shipments: Joi.array().items(OrderPlatformModel.Shipment()).required(),
4296
+ shipment_request_data: OrderPlatformModel.ShipmentRequestData(),
4264
4297
  shipping_info: OrderPlatformModel.ShippingInfo().required(),
4265
4298
  billing_info: OrderPlatformModel.BillingInfo().required(),
4266
4299
  currency_info: Joi.any(),
@@ -425,6 +425,7 @@ export = PaymentPlatformModel;
425
425
  */
426
426
  /**
427
427
  * @typedef SetCODForUserRequest
428
+ * @property {string} [business_unit] - Business unit
428
429
  * @property {string} mobileno - Mobile No. of User
429
430
  * @property {boolean} is_active - Either true or false
430
431
  * @property {string} merchant_user_id - Merchant User id
@@ -591,6 +592,8 @@ export = PaymentPlatformModel;
591
592
  * @typedef LinkStatus
592
593
  * @property {string} status - Link action status
593
594
  * @property {string} message - Message
595
+ * @property {boolean} [is_payment_done] - This key specifies payment done
596
+ * status of payment link.
594
597
  */
595
598
  /**
596
599
  * @typedef ResendOrCancelPaymentResponse
@@ -2270,6 +2273,10 @@ type GetUserCODLimitResponse = {
2270
2273
  /** @returns {SetCODForUserRequest} */
2271
2274
  declare function SetCODForUserRequest(): SetCODForUserRequest;
2272
2275
  type SetCODForUserRequest = {
2276
+ /**
2277
+ * - Business unit
2278
+ */
2279
+ business_unit?: string;
2273
2280
  /**
2274
2281
  * - Mobile No. of User
2275
2282
  */
@@ -2740,6 +2747,11 @@ type LinkStatus = {
2740
2747
  * - Message
2741
2748
  */
2742
2749
  message: string;
2750
+ /**
2751
+ * - This key specifies payment done
2752
+ * status of payment link.
2753
+ */
2754
+ is_payment_done?: boolean;
2743
2755
  };
2744
2756
  /** @returns {ResendOrCancelPaymentResponse} */
2745
2757
  declare function ResendOrCancelPaymentResponse(): ResendOrCancelPaymentResponse;
@@ -479,6 +479,7 @@ const Joi = require("joi");
479
479
 
480
480
  /**
481
481
  * @typedef SetCODForUserRequest
482
+ * @property {string} [business_unit] - Business unit
482
483
  * @property {string} mobileno - Mobile No. of User
483
484
  * @property {boolean} is_active - Either true or false
484
485
  * @property {string} merchant_user_id - Merchant User id
@@ -664,6 +665,8 @@ const Joi = require("joi");
664
665
  * @typedef LinkStatus
665
666
  * @property {string} status - Link action status
666
667
  * @property {string} message - Message
668
+ * @property {boolean} [is_payment_done] - This key specifies payment done
669
+ * status of payment link.
667
670
  */
668
671
 
669
672
  /**
@@ -1919,6 +1922,7 @@ class PaymentPlatformModel {
1919
1922
  /** @returns {SetCODForUserRequest} */
1920
1923
  static SetCODForUserRequest() {
1921
1924
  return Joi.object({
1925
+ business_unit: Joi.string().allow(""),
1922
1926
  mobileno: Joi.string().allow("").required(),
1923
1927
  is_active: Joi.boolean().required(),
1924
1928
  merchant_user_id: Joi.string().allow("").required(),
@@ -2139,6 +2143,7 @@ class PaymentPlatformModel {
2139
2143
  return Joi.object({
2140
2144
  status: Joi.string().allow("").required(),
2141
2145
  message: Joi.string().allow("").required(),
2146
+ is_payment_done: Joi.boolean(),
2142
2147
  });
2143
2148
  }
2144
2149
 
@@ -1865,10 +1865,10 @@ class ServiceabilityPlatformModel {
1865
1865
  /** @returns {ArithmeticOperations} */
1866
1866
  static ArithmeticOperations() {
1867
1867
  return Joi.object({
1868
- lt: Joi.number(),
1869
- gt: Joi.number(),
1870
- lte: Joi.number(),
1871
- gte: Joi.number(),
1868
+ lt: Joi.number().allow(null),
1869
+ gt: Joi.number().allow(null),
1870
+ lte: Joi.number().allow(null),
1871
+ gte: Joi.number().allow(null),
1872
1872
  });
1873
1873
  }
1874
1874
 
@@ -109,6 +109,18 @@ declare class Theme {
109
109
  * @description: Retrieve the currently applied theme of a sales channel using application Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getAppliedTheme/).
110
110
  */
111
111
  getAppliedTheme({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
112
+ /**
113
+ * @param {ThemePlatformApplicationValidator.GetExtensionSectionsParam} arg
114
+ * - Arg object
115
+ *
116
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
117
+ * @param {import("../PlatformAPIClient").Options} - Options
118
+ * @returns {Promise<ThemePlatformModel.GetExtensionSectionRes[]>} - Success response
119
+ * @name getExtensionSections
120
+ * @summary: Get extension sections
121
+ * @description: Retrieve the list of extension sections for a given application in the specified company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getExtensionSections/).
122
+ */
123
+ getExtensionSections({ type, companyMode, requestHeaders }?: ThemePlatformApplicationValidator.GetExtensionSectionsParam, { responseHeaders }?: object): Promise<ThemePlatformModel.GetExtensionSectionRes[]>;
112
124
  /**
113
125
  * @param {ThemePlatformApplicationValidator.GetFontsParam} arg - Arg object
114
126
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -788,6 +788,88 @@ class Theme {
788
788
  return response;
789
789
  }
790
790
 
791
+ /**
792
+ * @param {ThemePlatformApplicationValidator.GetExtensionSectionsParam} arg
793
+ * - Arg object
794
+ *
795
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
796
+ * @param {import("../PlatformAPIClient").Options} - Options
797
+ * @returns {Promise<ThemePlatformModel.GetExtensionSectionRes[]>} - Success response
798
+ * @name getExtensionSections
799
+ * @summary: Get extension sections
800
+ * @description: Retrieve the list of extension sections for a given application in the specified company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getExtensionSections/).
801
+ */
802
+ async getExtensionSections(
803
+ { type, companyMode, requestHeaders } = { requestHeaders: {} },
804
+ { responseHeaders } = { responseHeaders: false }
805
+ ) {
806
+ const {
807
+ error,
808
+ } = ThemePlatformApplicationValidator.getExtensionSections().validate(
809
+ {
810
+ type,
811
+ companyMode,
812
+ },
813
+ { abortEarly: false, allowUnknown: true }
814
+ );
815
+ if (error) {
816
+ return Promise.reject(new FDKClientValidationError(error));
817
+ }
818
+
819
+ // Showing warrnings if extra unknown parameters are found
820
+ const {
821
+ error: warrning,
822
+ } = ThemePlatformApplicationValidator.getExtensionSections().validate(
823
+ {
824
+ type,
825
+ companyMode,
826
+ },
827
+ { abortEarly: false, allowUnknown: false }
828
+ );
829
+ if (warrning) {
830
+ Logger({
831
+ level: "WARN",
832
+ message: `Parameter Validation warrnings for platform > Theme > getExtensionSections \n ${warrning}`,
833
+ });
834
+ }
835
+
836
+ const query_params = {};
837
+ query_params["type"] = type;
838
+ query_params["company_mode"] = companyMode;
839
+
840
+ const response = await PlatformAPIClient.execute(
841
+ this.config,
842
+ "get",
843
+ `/service/platform/theme/v1.0/company/${this.config.companyId}/application/${this.applicationId}/extension-section`,
844
+ query_params,
845
+ undefined,
846
+ requestHeaders,
847
+ { responseHeaders }
848
+ );
849
+
850
+ let responseData = response;
851
+ if (responseHeaders) {
852
+ responseData = response[0];
853
+ }
854
+
855
+ const { error: res_error } = Joi.array()
856
+ .items(ThemePlatformModel.GetExtensionSectionRes())
857
+ .validate(responseData, { abortEarly: false, allowUnknown: true });
858
+
859
+ if (res_error) {
860
+ if (this.config.options.strictResponseCheck === true) {
861
+ return Promise.reject(new FDKResponseValidationError(res_error));
862
+ } else {
863
+ Logger({
864
+ level: "WARN",
865
+ message: `Response Validation Warnings for platform > Theme > getExtensionSections \n ${res_error}`,
866
+ });
867
+ }
868
+ }
869
+
870
+ return response;
871
+ }
872
+
791
873
  /**
792
874
  * @param {ThemePlatformApplicationValidator.GetFontsParam} arg - Arg object
793
875
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -32,6 +32,11 @@ export = ThemePlatformApplicationValidator;
32
32
  /** @typedef GetApplicationThemesParam */
33
33
  /** @typedef GetApplicationThemesCountParam */
34
34
  /** @typedef GetAppliedThemeParam */
35
+ /**
36
+ * @typedef GetExtensionSectionsParam
37
+ * @property {string} [type] - The type of the theme
38
+ * @property {string} [companyMode] - The mode of the company
39
+ */
35
40
  /** @typedef GetFontsParam */
36
41
  /**
37
42
  * @typedef GetPageParam
@@ -100,6 +105,8 @@ declare class ThemePlatformApplicationValidator {
100
105
  static getApplicationThemesCount(): any;
101
106
  /** @returns {GetAppliedThemeParam} */
102
107
  static getAppliedTheme(): any;
108
+ /** @returns {GetExtensionSectionsParam} */
109
+ static getExtensionSections(): GetExtensionSectionsParam;
103
110
  /** @returns {GetFontsParam} */
104
111
  static getFonts(): any;
105
112
  /** @returns {GetPageParam} */
@@ -124,7 +131,7 @@ declare class ThemePlatformApplicationValidator {
124
131
  static upgradeTheme(): UpgradeThemeParam;
125
132
  }
126
133
  declare namespace ThemePlatformApplicationValidator {
127
- export { AddThemeToApplicationParam, ApplyThemeParam, CreatePageParam, DeletePageParam, DeleteThemeParam, DuplicateThemeParam, GetAllPagesParam, GetApplicationThemesParam, GetApplicationThemesCountParam, GetAppliedThemeParam, GetFontsParam, GetPageParam, GetThemeByIdParam, GetThemeForPreviewParam, GetThemeLastModifiedParam, IsUpgradableParam, UpdateMultiplePagesParam, UpdatePageParam, UpdateThemeParam, UpdateThemeNameParam, UpgradeThemeParam };
134
+ export { AddThemeToApplicationParam, ApplyThemeParam, CreatePageParam, DeletePageParam, DeleteThemeParam, DuplicateThemeParam, GetAllPagesParam, GetApplicationThemesParam, GetApplicationThemesCountParam, GetAppliedThemeParam, GetExtensionSectionsParam, GetFontsParam, GetPageParam, GetThemeByIdParam, GetThemeForPreviewParam, GetThemeLastModifiedParam, IsUpgradableParam, UpdateMultiplePagesParam, UpdatePageParam, UpdateThemeParam, UpdateThemeNameParam, UpgradeThemeParam };
128
135
  }
129
136
  type AddThemeToApplicationParam = {
130
137
  body: ThemePlatformModel.ThemeReq;
@@ -170,6 +177,16 @@ type GetAllPagesParam = {
170
177
  */
171
178
  themeId: string;
172
179
  };
180
+ type GetExtensionSectionsParam = {
181
+ /**
182
+ * - The type of the theme
183
+ */
184
+ type?: string;
185
+ /**
186
+ * - The mode of the company
187
+ */
188
+ companyMode?: string;
189
+ };
173
190
  type GetPageParam = {
174
191
  /**
175
192
  * - ID of the theme to be retrieved
@@ -45,6 +45,12 @@ const ThemePlatformModel = require("./ThemePlatformModel");
45
45
 
46
46
  /** @typedef GetAppliedThemeParam */
47
47
 
48
+ /**
49
+ * @typedef GetExtensionSectionsParam
50
+ * @property {string} [type] - The type of the theme
51
+ * @property {string} [companyMode] - The mode of the company
52
+ */
53
+
48
54
  /** @typedef GetFontsParam */
49
55
 
50
56
  /**
@@ -170,6 +176,14 @@ class ThemePlatformApplicationValidator {
170
176
  return Joi.object({}).required();
171
177
  }
172
178
 
179
+ /** @returns {GetExtensionSectionsParam} */
180
+ static getExtensionSections() {
181
+ return Joi.object({
182
+ type: Joi.string().allow(""),
183
+ companyMode: Joi.string().allow(""),
184
+ }).required();
185
+ }
186
+
173
187
  /** @returns {GetFontsParam} */
174
188
  static getFonts() {
175
189
  return Joi.object({}).required();
@@ -1,4 +1,35 @@
1
1
  export = ThemePlatformModel;
2
+ /**
3
+ * @typedef GetExtensionSectionRes
4
+ * @property {string} [extension_id]
5
+ * @property {string} [bundle_name]
6
+ * @property {string} [organization_id]
7
+ * @property {ExtensionSection[]} [sections]
8
+ * @property {AssetsExtension} [assets]
9
+ * @property {string} [status]
10
+ * @property {string} [type]
11
+ * @property {string} [created_at]
12
+ * @property {string} [updated_at]
13
+ */
14
+ /**
15
+ * @typedef ExtensionSection
16
+ * @property {string} [label]
17
+ * @property {string} [name]
18
+ * @property {PropExtension[]} [props]
19
+ * @property {Object[]} [blocks]
20
+ */
21
+ /**
22
+ * @typedef PropExtension
23
+ * @property {string} [id]
24
+ * @property {string} [label]
25
+ * @property {string} [type]
26
+ * @property {string} [info]
27
+ */
28
+ /**
29
+ * @typedef AssetsExtension
30
+ * @property {string} [js]
31
+ * @property {string} [css]
32
+ */
2
33
  /**
3
34
  * @typedef ThemeReq
4
35
  * @property {string} [marketplace_theme_id] - The ID of the marketplace theme
@@ -557,8 +588,43 @@ export = ThemePlatformModel;
557
588
  declare class ThemePlatformModel {
558
589
  }
559
590
  declare namespace ThemePlatformModel {
560
- export { ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradableResponse, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema, Prop, Assets, UMDJs, CommonJS, CSS, SectionItem, Preset, Page, Section, Block, Predicate, Screen, ThemeUserSchema, Route, SectionProps, SectionPreset, BlockProps, TextProp, CheckboxProp, RangeProp, ImagePickerProp, UrlProp, ThemeVersions, DummyResponse, AppliedThemes, CompanyPrivateTheme, ActionPage, PageType };
591
+ export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradableResponse, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema, Prop, Assets, UMDJs, CommonJS, CSS, SectionItem, Preset, Page, Section, Block, Predicate, Screen, ThemeUserSchema, Route, SectionProps, SectionPreset, BlockProps, TextProp, CheckboxProp, RangeProp, ImagePickerProp, UrlProp, ThemeVersions, DummyResponse, AppliedThemes, CompanyPrivateTheme, ActionPage, PageType };
561
592
  }
593
+ /** @returns {GetExtensionSectionRes} */
594
+ declare function GetExtensionSectionRes(): GetExtensionSectionRes;
595
+ type GetExtensionSectionRes = {
596
+ extension_id?: string;
597
+ bundle_name?: string;
598
+ organization_id?: string;
599
+ sections?: ExtensionSection[];
600
+ assets?: AssetsExtension;
601
+ status?: string;
602
+ type?: string;
603
+ created_at?: string;
604
+ updated_at?: string;
605
+ };
606
+ /** @returns {ExtensionSection} */
607
+ declare function ExtensionSection(): ExtensionSection;
608
+ type ExtensionSection = {
609
+ label?: string;
610
+ name?: string;
611
+ props?: PropExtension[];
612
+ blocks?: any[];
613
+ };
614
+ /** @returns {PropExtension} */
615
+ declare function PropExtension(): PropExtension;
616
+ type PropExtension = {
617
+ id?: string;
618
+ label?: string;
619
+ type?: string;
620
+ info?: string;
621
+ };
622
+ /** @returns {AssetsExtension} */
623
+ declare function AssetsExtension(): AssetsExtension;
624
+ type AssetsExtension = {
625
+ js?: string;
626
+ css?: string;
627
+ };
562
628
  /** @returns {ThemeReq} */
563
629
  declare function ThemeReq(): ThemeReq;
564
630
  type ThemeReq = {
@@ -1,5 +1,40 @@
1
1
  const Joi = require("joi");
2
2
 
3
+ /**
4
+ * @typedef GetExtensionSectionRes
5
+ * @property {string} [extension_id]
6
+ * @property {string} [bundle_name]
7
+ * @property {string} [organization_id]
8
+ * @property {ExtensionSection[]} [sections]
9
+ * @property {AssetsExtension} [assets]
10
+ * @property {string} [status]
11
+ * @property {string} [type]
12
+ * @property {string} [created_at]
13
+ * @property {string} [updated_at]
14
+ */
15
+
16
+ /**
17
+ * @typedef ExtensionSection
18
+ * @property {string} [label]
19
+ * @property {string} [name]
20
+ * @property {PropExtension[]} [props]
21
+ * @property {Object[]} [blocks]
22
+ */
23
+
24
+ /**
25
+ * @typedef PropExtension
26
+ * @property {string} [id]
27
+ * @property {string} [label]
28
+ * @property {string} [type]
29
+ * @property {string} [info]
30
+ */
31
+
32
+ /**
33
+ * @typedef AssetsExtension
34
+ * @property {string} [js]
35
+ * @property {string} [css]
36
+ */
37
+
3
38
  /**
4
39
  * @typedef ThemeReq
5
40
  * @property {string} [marketplace_theme_id] - The ID of the marketplace theme
@@ -633,6 +668,49 @@ const Joi = require("joi");
633
668
  */
634
669
 
635
670
  class ThemePlatformModel {
671
+ /** @returns {GetExtensionSectionRes} */
672
+ static GetExtensionSectionRes() {
673
+ return Joi.object({
674
+ extension_id: Joi.string().allow(""),
675
+ bundle_name: Joi.string().allow(""),
676
+ organization_id: Joi.string().allow(""),
677
+ sections: Joi.array().items(ThemePlatformModel.ExtensionSection()),
678
+ assets: ThemePlatformModel.AssetsExtension(),
679
+ status: Joi.string().allow(""),
680
+ type: Joi.string().allow(""),
681
+ created_at: Joi.string().allow(""),
682
+ updated_at: Joi.string().allow(""),
683
+ });
684
+ }
685
+
686
+ /** @returns {ExtensionSection} */
687
+ static ExtensionSection() {
688
+ return Joi.object({
689
+ label: Joi.string().allow(""),
690
+ name: Joi.string().allow(""),
691
+ props: Joi.array().items(ThemePlatformModel.PropExtension()),
692
+ blocks: Joi.array().items(Joi.any()),
693
+ });
694
+ }
695
+
696
+ /** @returns {PropExtension} */
697
+ static PropExtension() {
698
+ return Joi.object({
699
+ id: Joi.string().allow(""),
700
+ label: Joi.string().allow(""),
701
+ type: Joi.string().allow(""),
702
+ info: Joi.string().allow(""),
703
+ });
704
+ }
705
+
706
+ /** @returns {AssetsExtension} */
707
+ static AssetsExtension() {
708
+ return Joi.object({
709
+ js: Joi.string().allow(""),
710
+ css: Joi.string().allow(""),
711
+ });
712
+ }
713
+
636
714
  /** @returns {ThemeReq} */
637
715
  static ThemeReq() {
638
716
  return Joi.object({
@@ -43,16 +43,6 @@ declare class Webhook {
43
43
  * @description: Retrieve reports on the delivery status of events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
44
44
  */
45
45
  getDeliveryReports({ body, requestHeaders }?: WebhookPlatformValidator.GetDeliveryReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventProcessReports>;
46
- /**
47
- * @param {WebhookPlatformValidator.GetEventCountsParam} arg - Arg object
48
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
49
- * @param {import("../PlatformAPIClient").Options} - Options
50
- * @returns {Promise<WebhookPlatformModel.RetryCountResponse>} - Success response
51
- * @name getEventCounts
52
- * @summary: Get event counts
53
- * @description: Retrieve the counts of events based on their status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getEventCounts/).
54
- */
55
- getEventCounts({ body, requestHeaders }?: WebhookPlatformValidator.GetEventCountsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetryCountResponse>;
56
46
  /**
57
47
  * @param {WebhookPlatformValidator.GetHistoricalReportsParam} arg - Arg object
58
48
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -63,16 +53,6 @@ declare class Webhook {
63
53
  * @description: Retrieve historical reports of webhook events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
64
54
  */
65
55
  getHistoricalReports({ body, requestHeaders }?: WebhookPlatformValidator.GetHistoricalReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.HistoryResponse>;
66
- /**
67
- * @param {WebhookPlatformValidator.GetManualRetryStatusParam} arg - Arg object
68
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
69
- * @param {import("../PlatformAPIClient").Options} - Options
70
- * @returns {Promise<WebhookPlatformModel.RetryStatusResponse>} - Success response
71
- * @name getManualRetryStatus
72
- * @summary: Get manual retry status
73
- * @description: Check the status of a manual retry operation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getManualRetryStatus/).
74
- */
75
- getManualRetryStatus({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetryStatusResponse>;
76
56
  /**
77
57
  * @param {WebhookPlatformValidator.GetReportFiltersParam} arg - Arg object
78
58
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -113,26 +93,6 @@ declare class Webhook {
113
93
  * @description: Retrieve subscribers associated with a specific extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
114
94
  */
115
95
  getSubscribersByExtensionId({ extensionId, pageNo, pageSize, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByExtensionIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigList>;
116
- /**
117
- * @param {WebhookPlatformValidator.ManualRetryCancelParam} arg - Arg object
118
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
119
- * @param {import("../PlatformAPIClient").Options} - Options
120
- * @returns {Promise<string>} - Success response
121
- * @name manualRetryCancel
122
- * @summary: Manual retry cancellation
123
- * @description: Cancel a manual retry operation for a failed event. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryCancel/).
124
- */
125
- manualRetryCancel({ requestHeaders }?: any, { responseHeaders }?: object): Promise<string>;
126
- /**
127
- * @param {WebhookPlatformValidator.ManualRetryOfFailedEventParam} arg - Arg object
128
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
129
- * @param {import("../PlatformAPIClient").Options} - Options
130
- * @returns {Promise<WebhookPlatformModel.RetrySuccessResponse>} - Success response
131
- * @name manualRetryOfFailedEvent
132
- * @summary: Manual retry of failed event
133
- * @description: Trigger a manual retry for an event that failed to deliver. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryOfFailedEvent/).
134
- */
135
- manualRetryOfFailedEvent({ body, requestHeaders }?: WebhookPlatformValidator.ManualRetryOfFailedEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetrySuccessResponse>;
136
96
  /**
137
97
  * @param {WebhookPlatformValidator.PingWebhookParam} arg - Arg object
138
98
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`