@gofynd/fdk-client-javascript 1.4.8-beta.2 → 1.4.8

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 (198) hide show
  1. package/README.md +26 -1
  2. package/package.json +2 -2
  3. package/sdk/application/ApplicationClient.d.ts +8 -0
  4. package/sdk/application/ApplicationClient.js +14 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +20 -20
  6. package/sdk/application/Cart/CartApplicationClient.js +20 -20
  7. package/sdk/application/Cart/CartApplicationModel.d.ts +2446 -664
  8. package/sdk/application/Cart/CartApplicationModel.js +783 -552
  9. package/sdk/application/Cart/CartApplicationValidator.d.ts +268 -194
  10. package/sdk/application/Cart/CartApplicationValidator.js +100 -114
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +53 -53
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +53 -53
  13. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2012 -503
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +603 -453
  15. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +64 -64
  16. package/sdk/application/Catalog/CatalogApplicationValidator.js +32 -32
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  18. package/sdk/application/Common/CommonApplicationClient.js +2 -2
  19. package/sdk/application/Common/CommonApplicationModel.d.ts +170 -90
  20. package/sdk/application/Common/CommonApplicationModel.js +59 -58
  21. package/sdk/application/Common/CommonApplicationValidator.d.ts +8 -5
  22. package/sdk/application/Common/CommonApplicationValidator.js +3 -3
  23. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +2 -2
  24. package/sdk/application/Communication/CommunicationApplicationClient.js +2 -2
  25. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +170 -35
  26. package/sdk/application/Communication/CommunicationApplicationModel.js +54 -33
  27. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +15 -15
  28. package/sdk/application/Configuration/ConfigurationApplicationClient.js +15 -15
  29. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +624 -443
  30. package/sdk/application/Configuration/ConfigurationApplicationModel.js +259 -248
  31. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +32 -24
  32. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +14 -13
  33. package/sdk/application/Content/ContentApplicationClient.d.ts +16 -16
  34. package/sdk/application/Content/ContentApplicationClient.js +16 -16
  35. package/sdk/application/Content/ContentApplicationModel.d.ts +1206 -281
  36. package/sdk/application/Content/ContentApplicationModel.js +342 -276
  37. package/sdk/application/Content/ContentApplicationValidator.d.ts +28 -17
  38. package/sdk/application/Content/ContentApplicationValidator.js +11 -10
  39. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
  40. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  41. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +146 -37
  42. package/sdk/application/FileStorage/FileStorageApplicationModel.js +38 -36
  43. package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
  44. package/sdk/application/Lead/LeadApplicationClient.js +3 -3
  45. package/sdk/application/Lead/LeadApplicationModel.d.ts +195 -134
  46. package/sdk/application/Lead/LeadApplicationModel.js +110 -67
  47. package/sdk/application/Lead/LeadApplicationValidator.d.ts +8 -8
  48. package/sdk/application/Lead/LeadApplicationValidator.js +4 -4
  49. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -10
  50. package/sdk/application/Logistic/LogisticApplicationClient.js +10 -10
  51. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +1039 -221
  52. package/sdk/application/Logistic/LogisticApplicationModel.js +342 -199
  53. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +76 -82
  54. package/sdk/application/Logistic/LogisticApplicationValidator.js +38 -41
  55. package/sdk/application/Order/OrderApplicationClient.d.ts +10 -10
  56. package/sdk/application/Order/OrderApplicationClient.js +10 -10
  57. package/sdk/application/Order/OrderApplicationModel.d.ts +1401 -324
  58. package/sdk/application/Order/OrderApplicationModel.js +392 -316
  59. package/sdk/application/Order/OrderApplicationValidator.d.ts +32 -30
  60. package/sdk/application/Order/OrderApplicationValidator.js +15 -14
  61. package/sdk/application/Payment/PaymentApplicationClient.d.ts +43 -43
  62. package/sdk/application/Payment/PaymentApplicationClient.js +43 -43
  63. package/sdk/application/Payment/PaymentApplicationModel.d.ts +1111 -1022
  64. package/sdk/application/Payment/PaymentApplicationModel.js +537 -521
  65. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +82 -49
  66. package/sdk/application/Payment/PaymentApplicationValidator.js +30 -30
  67. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +28 -7
  68. package/sdk/application/Rewards/RewardsApplicationModel.js +7 -7
  69. package/sdk/application/Share/ShareApplicationModel.d.ts +178 -38
  70. package/sdk/application/Share/ShareApplicationModel.js +53 -37
  71. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -2
  72. package/sdk/application/Share/ShareApplicationValidator.js +2 -1
  73. package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
  74. package/sdk/application/Theme/ThemeApplicationClient.js +14 -8
  75. package/sdk/application/Theme/ThemeApplicationModel.d.ts +528 -287
  76. package/sdk/application/Theme/ThemeApplicationModel.js +208 -172
  77. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +17 -12
  78. package/sdk/application/Theme/ThemeApplicationValidator.js +8 -6
  79. package/sdk/application/User/UserApplicationClient.d.ts +36 -36
  80. package/sdk/application/User/UserApplicationClient.js +36 -36
  81. package/sdk/application/User/UserApplicationModel.d.ts +1062 -255
  82. package/sdk/application/User/UserApplicationModel.js +298 -244
  83. package/sdk/application/User/UserApplicationValidator.d.ts +80 -80
  84. package/sdk/application/User/UserApplicationValidator.js +40 -40
  85. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
  86. package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
  87. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +20 -5
  88. package/sdk/application/Webhook/WebhookApplicationModel.js +5 -5
  89. package/sdk/common/Clickstream.js +95 -15
  90. package/sdk/common/Constant.d.ts +9 -0
  91. package/sdk/common/Constant.js +11 -0
  92. package/sdk/common/Utility.js +19 -0
  93. package/sdk/common/utils.js +8 -1
  94. package/sdk/partner/Lead/LeadPartnerModel.d.ts +28 -7
  95. package/sdk/partner/Lead/LeadPartnerModel.js +7 -7
  96. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +75 -8
  97. package/sdk/partner/Logistics/LogisticsPartnerModel.js +59 -7
  98. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +2 -2
  99. package/sdk/partner/PartnerClient.d.ts +8 -0
  100. package/sdk/partner/PartnerClient.js +14 -0
  101. package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -0
  102. package/sdk/partner/Theme/ThemePartnerClient.js +158 -0
  103. package/sdk/partner/Theme/ThemePartnerModel.d.ts +45 -6
  104. package/sdk/partner/Theme/ThemePartnerModel.js +33 -4
  105. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
  106. package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
  107. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +28 -7
  108. package/sdk/partner/Webhook/WebhookPartnerModel.js +7 -7
  109. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +28 -7
  110. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +7 -7
  111. package/sdk/platform/Billing/BillingPlatformClient.d.ts +21 -10
  112. package/sdk/platform/Billing/BillingPlatformClient.js +167 -83
  113. package/sdk/platform/Billing/BillingPlatformModel.d.ts +2849 -565
  114. package/sdk/platform/Billing/BillingPlatformModel.js +935 -556
  115. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +30 -14
  116. package/sdk/platform/Billing/BillingPlatformValidator.js +31 -16
  117. package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -7
  118. package/sdk/platform/Cart/CartPlatformModel.js +8 -8
  119. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
  120. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +20 -0
  121. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +37 -0
  122. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +16 -0
  123. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +12 -2
  124. package/sdk/platform/Catalog/CatalogPlatformClient.js +41 -1
  125. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +46 -12
  126. package/sdk/platform/Catalog/CatalogPlatformModel.js +14 -11
  127. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -0
  128. package/sdk/platform/Catalog/CatalogPlatformValidator.js +17 -0
  129. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +28 -7
  130. package/sdk/platform/Communication/CommunicationPlatformModel.js +7 -7
  131. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -7
  132. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +7 -7
  133. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +0 -97
  134. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +77 -782
  135. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +24 -701
  136. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +7 -539
  137. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -183
  138. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +0 -134
  139. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
  140. package/sdk/platform/Content/ContentPlatformApplicationClient.js +0 -79
  141. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -15
  142. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -13
  143. package/sdk/platform/Content/ContentPlatformModel.d.ts +60 -17
  144. package/sdk/platform/Content/ContentPlatformModel.js +30 -15
  145. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +28 -7
  146. package/sdk/platform/Discount/DiscountPlatformModel.js +7 -7
  147. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +127 -25
  148. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +37 -25
  149. package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
  150. package/sdk/platform/Finance/FinancePlatformClient.js +30 -30
  151. package/sdk/platform/Finance/FinancePlatformModel.d.ts +1601 -348
  152. package/sdk/platform/Finance/FinancePlatformModel.js +488 -352
  153. package/sdk/platform/Lead/LeadPlatformModel.d.ts +28 -7
  154. package/sdk/platform/Lead/LeadPlatformModel.js +7 -7
  155. package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -0
  156. package/sdk/platform/Order/OrderPlatformClient.js +165 -0
  157. package/sdk/platform/Order/OrderPlatformModel.d.ts +631 -39
  158. package/sdk/platform/Order/OrderPlatformModel.js +367 -41
  159. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -1
  160. package/sdk/platform/Order/OrderPlatformValidator.js +28 -0
  161. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +30 -9
  162. package/sdk/platform/Payment/PaymentPlatformModel.js +9 -9
  163. package/sdk/platform/PlatformClient.d.ts +8 -0
  164. package/sdk/platform/PlatformClient.js +14 -0
  165. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +28 -7
  166. package/sdk/platform/Rewards/RewardsPlatformModel.js +7 -7
  167. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +12 -9
  168. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +12 -9
  169. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
  170. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
  171. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +139 -22
  172. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +98 -21
  173. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
  174. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
  175. package/sdk/platform/Share/SharePlatformModel.d.ts +28 -7
  176. package/sdk/platform/Share/SharePlatformModel.js +7 -7
  177. package/sdk/platform/Theme/ThemePlatformModel.d.ts +18 -5
  178. package/sdk/platform/Theme/ThemePlatformModel.js +7 -4
  179. package/sdk/platform/User/UserPlatformModel.d.ts +18 -20
  180. package/sdk/platform/User/UserPlatformModel.js +9 -11
  181. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +54 -33
  182. package/sdk/platform/Webhook/WebhookPlatformModel.js +33 -33
  183. package/sdk/public/Billing/BillingPublicClient.d.ts +11 -0
  184. package/sdk/public/Billing/BillingPublicClient.js +80 -0
  185. package/sdk/public/Billing/BillingPublicModel.d.ts +584 -99
  186. package/sdk/public/Billing/BillingPublicModel.js +252 -87
  187. package/sdk/public/Billing/BillingPublicValidator.d.ts +10 -1
  188. package/sdk/public/Billing/BillingPublicValidator.js +12 -0
  189. package/sdk/public/PublicClient.d.ts +0 -2
  190. package/sdk/public/PublicClient.js +0 -4
  191. package/sdk/public/index.d.ts +0 -1
  192. package/sdk/public/index.js +0 -2
  193. package/sdk/public/Inventory/InventoryPublicClient.d.ts +0 -87
  194. package/sdk/public/Inventory/InventoryPublicClient.js +0 -529
  195. package/sdk/public/Inventory/InventoryPublicModel.d.ts +0 -393
  196. package/sdk/public/Inventory/InventoryPublicModel.js +0 -448
  197. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +0 -91
  198. package/sdk/public/Inventory/InventoryPublicValidator.js +0 -85
@@ -1,7 +1,7 @@
1
1
  export = CatalogPlatformModel;
2
2
  /**
3
3
  * @typedef Action
4
- * @property {string} [type]
4
+ * @property {string} [type] - Type of action to be taken e.g, page.
5
5
  * @property {ActionPage} [page]
6
6
  * @property {ActionPage} [popup]
7
7
  */
@@ -2171,13 +2171,13 @@ export = CatalogPlatformModel;
2171
2171
  */
2172
2172
  /**
2173
2173
  * @typedef Page
2174
- * @property {number} [item_total]
2175
- * @property {string} [next_id]
2176
- * @property {boolean} [has_previous]
2177
- * @property {boolean} [has_next]
2178
- * @property {number} [current]
2179
- * @property {string} type
2180
- * @property {number} [size]
2174
+ * @property {number} [item_total] - The total number of items on the page.
2175
+ * @property {string} [next_id] - The identifier for the next page.
2176
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
2177
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
2178
+ * @property {number} [current] - The current page number.
2179
+ * @property {string} type - The type of the page, such as 'PageType'.
2180
+ * @property {number} [size] - The number of items per page.
2181
2181
  */
2182
2182
  /**
2183
2183
  * @typedef PageResponse
@@ -3285,9 +3285,9 @@ export = CatalogPlatformModel;
3285
3285
  */
3286
3286
  /**
3287
3287
  * @typedef ActionPage
3288
- * @property {Object} [params]
3289
- * @property {Object} [query]
3290
- * @property {string} [url]
3288
+ * @property {Object} [params] - Parameters that should be considered in path.
3289
+ * @property {Object} [query] - Query parameter if any to be added to the action.
3290
+ * @property {string} [url] - The URL for the action.
3291
3291
  * @property {PageType} type
3292
3292
  */
3293
3293
  /**
@@ -3302,6 +3302,7 @@ export = CatalogPlatformModel;
3302
3302
  * | "category"
3303
3303
  * | "collection"
3304
3304
  * | "collections"
3305
+ * | "custom"
3305
3306
  * | "contact-us"
3306
3307
  * | "external"
3307
3308
  * | "faq"
@@ -3346,6 +3347,9 @@ declare namespace CatalogPlatformModel {
3346
3347
  /** @returns {Action} */
3347
3348
  declare function Action(): Action;
3348
3349
  type Action = {
3350
+ /**
3351
+ * - Type of action to be taken e.g, page.
3352
+ */
3349
3353
  type?: string;
3350
3354
  page?: ActionPage;
3351
3355
  popup?: ActionPage;
@@ -6644,12 +6648,33 @@ type PTErrorResponse = {
6644
6648
  /** @returns {Page} */
6645
6649
  declare function Page(): Page;
6646
6650
  type Page = {
6651
+ /**
6652
+ * - The total number of items on the page.
6653
+ */
6647
6654
  item_total?: number;
6655
+ /**
6656
+ * - The identifier for the next page.
6657
+ */
6648
6658
  next_id?: string;
6659
+ /**
6660
+ * - Indicates whether there is a previous page.
6661
+ */
6649
6662
  has_previous?: boolean;
6663
+ /**
6664
+ * - Indicates whether there is a next page.
6665
+ */
6650
6666
  has_next?: boolean;
6667
+ /**
6668
+ * - The current page number.
6669
+ */
6651
6670
  current?: number;
6671
+ /**
6672
+ * - The type of the page, such as 'PageType'.
6673
+ */
6652
6674
  type: string;
6675
+ /**
6676
+ * - The number of items per page.
6677
+ */
6653
6678
  size?: number;
6654
6679
  };
6655
6680
  /** @returns {PageResponse} */
@@ -8065,8 +8090,17 @@ type UpdateMarketplaceOptinResponse = {
8065
8090
  /** @returns {ActionPage} */
8066
8091
  declare function ActionPage(): ActionPage;
8067
8092
  type ActionPage = {
8093
+ /**
8094
+ * - Parameters that should be considered in path.
8095
+ */
8068
8096
  params?: any;
8097
+ /**
8098
+ * - Query parameter if any to be added to the action.
8099
+ */
8069
8100
  query?: any;
8101
+ /**
8102
+ * - The URL for the action.
8103
+ */
8070
8104
  url?: string;
8071
8105
  type: PageType;
8072
8106
  };
@@ -8076,4 +8110,4 @@ type ActionPage = {
8076
8110
  * @returns {PageType}
8077
8111
  */
8078
8112
  declare function PageType(): PageType;
8079
- type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status";
8113
+ type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status";
@@ -2,7 +2,7 @@ const Joi = require("joi");
2
2
 
3
3
  /**
4
4
  * @typedef Action
5
- * @property {string} [type]
5
+ * @property {string} [type] - Type of action to be taken e.g, page.
6
6
  * @property {ActionPage} [page]
7
7
  * @property {ActionPage} [popup]
8
8
  */
@@ -2427,13 +2427,13 @@ const Joi = require("joi");
2427
2427
 
2428
2428
  /**
2429
2429
  * @typedef Page
2430
- * @property {number} [item_total]
2431
- * @property {string} [next_id]
2432
- * @property {boolean} [has_previous]
2433
- * @property {boolean} [has_next]
2434
- * @property {number} [current]
2435
- * @property {string} type
2436
- * @property {number} [size]
2430
+ * @property {number} [item_total] - The total number of items on the page.
2431
+ * @property {string} [next_id] - The identifier for the next page.
2432
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
2433
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
2434
+ * @property {number} [current] - The current page number.
2435
+ * @property {string} type - The type of the page, such as 'PageType'.
2436
+ * @property {number} [size] - The number of items per page.
2437
2437
  */
2438
2438
 
2439
2439
  /**
@@ -3659,9 +3659,9 @@ const Joi = require("joi");
3659
3659
 
3660
3660
  /**
3661
3661
  * @typedef ActionPage
3662
- * @property {Object} [params]
3663
- * @property {Object} [query]
3664
- * @property {string} [url]
3662
+ * @property {Object} [params] - Parameters that should be considered in path.
3663
+ * @property {Object} [query] - Query parameter if any to be added to the action.
3664
+ * @property {string} [url] - The URL for the action.
3665
3665
  * @property {PageType} type
3666
3666
  */
3667
3667
 
@@ -3677,6 +3677,7 @@ const Joi = require("joi");
3677
3677
  * | "category"
3678
3678
  * | "collection"
3679
3679
  * | "collections"
3680
+ * | "custom"
3680
3681
  * | "contact-us"
3681
3682
  * | "external"
3682
3683
  * | "faq"
@@ -8150,6 +8151,8 @@ class CatalogPlatformModel {
8150
8151
 
8151
8152
  "collections",
8152
8153
 
8154
+ "custom",
8155
+
8153
8156
  "contact-us",
8154
8157
 
8155
8158
  "external",
@@ -290,12 +290,23 @@ export = CatalogPlatformValidator;
290
290
  * @property {number[]} [itemIds] - Get multiple products filtered by Item Ids
291
291
  * @property {number[]} [departmentIds] - Get multiple products filtered by Department Ids
292
292
  * @property {string[]} [itemCode] - Get multiple products filtered by Item Code
293
+ * @property {string} [name] - Get multiple products filtered by Name (Pattern Match)
294
+ * @property {string} [slug] - Get multiple products filtered by Slug
295
+ * @property {string[]} [allIdentifiers] - Get multiple products filtered by All
296
+ * Identifiers
293
297
  * @property {string} [q] - Get multiple products filtered by q string
294
298
  * @property {string[]} [tags] - Get multiple products filtered by tags
295
299
  * @property {number} [pageNo] - The page number to navigate through the given
296
300
  * set of results
297
301
  * @property {number} [pageSize] - Number of items to retrieve in each page.
298
302
  * Default is 10.
303
+ * @property {string} [pageType] - For pagination type value can be cursor or
304
+ * number. Default is number.
305
+ * @property {string} [sortOn] - Field which is to be used for sorting, default
306
+ * is latest. Value can be latest (modified_on) or created (record id)
307
+ * @property {string} [pageId] - If page_type is cursor, each response will
308
+ * contain **next_id** param (datetime or id depending upon sort_on), which
309
+ * should be sent back as page_id to make cursor pagination work.
299
310
  */
300
311
  /**
301
312
  * @typedef GetSellerInsightsParam
@@ -1137,6 +1148,19 @@ type GetProductsParam = {
1137
1148
  * - Get multiple products filtered by Item Code
1138
1149
  */
1139
1150
  itemCode?: string[];
1151
+ /**
1152
+ * - Get multiple products filtered by Name (Pattern Match)
1153
+ */
1154
+ name?: string;
1155
+ /**
1156
+ * - Get multiple products filtered by Slug
1157
+ */
1158
+ slug?: string;
1159
+ /**
1160
+ * - Get multiple products filtered by All
1161
+ * Identifiers
1162
+ */
1163
+ allIdentifiers?: string[];
1140
1164
  /**
1141
1165
  * - Get multiple products filtered by q string
1142
1166
  */
@@ -1155,6 +1179,22 @@ type GetProductsParam = {
1155
1179
  * Default is 10.
1156
1180
  */
1157
1181
  pageSize?: number;
1182
+ /**
1183
+ * - For pagination type value can be cursor or
1184
+ * number. Default is number.
1185
+ */
1186
+ pageType?: string;
1187
+ /**
1188
+ * - Field which is to be used for sorting, default
1189
+ * is latest. Value can be latest (modified_on) or created (record id)
1190
+ */
1191
+ sortOn?: string;
1192
+ /**
1193
+ * - If page_type is cursor, each response will
1194
+ * contain **next_id** param (datetime or id depending upon sort_on), which
1195
+ * should be sent back as page_id to make cursor pagination work.
1196
+ */
1197
+ pageId?: string;
1158
1198
  };
1159
1199
  type GetSellerInsightsParam = {
1160
1200
  /**
@@ -345,12 +345,23 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
345
345
  * @property {number[]} [itemIds] - Get multiple products filtered by Item Ids
346
346
  * @property {number[]} [departmentIds] - Get multiple products filtered by Department Ids
347
347
  * @property {string[]} [itemCode] - Get multiple products filtered by Item Code
348
+ * @property {string} [name] - Get multiple products filtered by Name (Pattern Match)
349
+ * @property {string} [slug] - Get multiple products filtered by Slug
350
+ * @property {string[]} [allIdentifiers] - Get multiple products filtered by All
351
+ * Identifiers
348
352
  * @property {string} [q] - Get multiple products filtered by q string
349
353
  * @property {string[]} [tags] - Get multiple products filtered by tags
350
354
  * @property {number} [pageNo] - The page number to navigate through the given
351
355
  * set of results
352
356
  * @property {number} [pageSize] - Number of items to retrieve in each page.
353
357
  * Default is 10.
358
+ * @property {string} [pageType] - For pagination type value can be cursor or
359
+ * number. Default is number.
360
+ * @property {string} [sortOn] - Field which is to be used for sorting, default
361
+ * is latest. Value can be latest (modified_on) or created (record id)
362
+ * @property {string} [pageId] - If page_type is cursor, each response will
363
+ * contain **next_id** param (datetime or id depending upon sort_on), which
364
+ * should be sent back as page_id to make cursor pagination work.
354
365
  */
355
366
 
356
367
  /**
@@ -963,10 +974,16 @@ class CatalogPlatformValidator {
963
974
  itemIds: Joi.array().items(Joi.number()),
964
975
  departmentIds: Joi.array().items(Joi.number()),
965
976
  itemCode: Joi.array().items(Joi.string().allow("")),
977
+ name: Joi.string().allow(""),
978
+ slug: Joi.string().allow(""),
979
+ allIdentifiers: Joi.array().items(Joi.string().allow("")),
966
980
  q: Joi.string().allow(""),
967
981
  tags: Joi.array().items(Joi.string().allow("")),
968
982
  pageNo: Joi.number(),
969
983
  pageSize: Joi.number(),
984
+ pageType: Joi.string().allow(""),
985
+ sortOn: Joi.string().allow(""),
986
+ pageId: Joi.string().allow(""),
970
987
  }).required();
971
988
  }
972
989
 
@@ -804,13 +804,13 @@ export = CommunicationPlatformModel;
804
804
  */
805
805
  /**
806
806
  * @typedef Page
807
- * @property {number} [item_total]
808
- * @property {string} [next_id]
809
- * @property {boolean} [has_previous]
810
- * @property {boolean} [has_next]
811
- * @property {number} [current]
812
- * @property {string} type
813
- * @property {number} [size]
807
+ * @property {number} [item_total] - The total number of items on the page.
808
+ * @property {string} [next_id] - The identifier for the next page.
809
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
810
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
811
+ * @property {number} [current] - The current page number.
812
+ * @property {string} type - The type of the page, such as 'PageType'.
813
+ * @property {number} [size] - The number of items per page.
814
814
  */
815
815
  /**
816
816
  * @typedef GenericError
@@ -1825,12 +1825,33 @@ type SystemNotifications = {
1825
1825
  /** @returns {Page} */
1826
1826
  declare function Page(): Page;
1827
1827
  type Page = {
1828
+ /**
1829
+ * - The total number of items on the page.
1830
+ */
1828
1831
  item_total?: number;
1832
+ /**
1833
+ * - The identifier for the next page.
1834
+ */
1829
1835
  next_id?: string;
1836
+ /**
1837
+ * - Indicates whether there is a previous page.
1838
+ */
1830
1839
  has_previous?: boolean;
1840
+ /**
1841
+ * - Indicates whether there is a next page.
1842
+ */
1831
1843
  has_next?: boolean;
1844
+ /**
1845
+ * - The current page number.
1846
+ */
1832
1847
  current?: number;
1848
+ /**
1849
+ * - The type of the page, such as 'PageType'.
1850
+ */
1833
1851
  type: string;
1852
+ /**
1853
+ * - The number of items per page.
1854
+ */
1834
1855
  size?: number;
1835
1856
  };
1836
1857
  /** @returns {GenericError} */
@@ -912,13 +912,13 @@ const Joi = require("joi");
912
912
 
913
913
  /**
914
914
  * @typedef Page
915
- * @property {number} [item_total]
916
- * @property {string} [next_id]
917
- * @property {boolean} [has_previous]
918
- * @property {boolean} [has_next]
919
- * @property {number} [current]
920
- * @property {string} type
921
- * @property {number} [size]
915
+ * @property {number} [item_total] - The total number of items on the page.
916
+ * @property {string} [next_id] - The identifier for the next page.
917
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
918
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
919
+ * @property {number} [current] - The current page number.
920
+ * @property {string} type - The type of the page, such as 'PageType'.
921
+ * @property {number} [size] - The number of items per page.
922
922
  */
923
923
 
924
924
  /**
@@ -259,13 +259,13 @@ export = CompanyProfilePlatformModel;
259
259
  */
260
260
  /**
261
261
  * @typedef Page
262
- * @property {number} [item_total]
263
- * @property {string} [next_id]
264
- * @property {boolean} [has_previous]
265
- * @property {boolean} [has_next]
266
- * @property {number} [current]
267
- * @property {string} type
268
- * @property {number} [size]
262
+ * @property {number} [item_total] - The total number of items on the page.
263
+ * @property {string} [next_id] - The identifier for the next page.
264
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
265
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
266
+ * @property {number} [current] - The current page number.
267
+ * @property {string} type - The type of the page, such as 'PageType'.
268
+ * @property {number} [size] - The number of items per page.
269
269
  */
270
270
  /**
271
271
  * @typedef CompanyBrandListSerializer
@@ -733,12 +733,33 @@ type CompanyBrandSerializer = {
733
733
  /** @returns {Page} */
734
734
  declare function Page(): Page;
735
735
  type Page = {
736
+ /**
737
+ * - The total number of items on the page.
738
+ */
736
739
  item_total?: number;
740
+ /**
741
+ * - The identifier for the next page.
742
+ */
737
743
  next_id?: string;
744
+ /**
745
+ * - Indicates whether there is a previous page.
746
+ */
738
747
  has_previous?: boolean;
748
+ /**
749
+ * - Indicates whether there is a next page.
750
+ */
739
751
  has_next?: boolean;
752
+ /**
753
+ * - The current page number.
754
+ */
740
755
  current?: number;
756
+ /**
757
+ * - The type of the page, such as 'PageType'.
758
+ */
741
759
  type: string;
760
+ /**
761
+ * - The number of items per page.
762
+ */
742
763
  size?: number;
743
764
  };
744
765
  /** @returns {CompanyBrandListSerializer} */
@@ -286,13 +286,13 @@ const Joi = require("joi");
286
286
 
287
287
  /**
288
288
  * @typedef Page
289
- * @property {number} [item_total]
290
- * @property {string} [next_id]
291
- * @property {boolean} [has_previous]
292
- * @property {boolean} [has_next]
293
- * @property {number} [current]
294
- * @property {string} type
295
- * @property {number} [size]
289
+ * @property {number} [item_total] - The total number of items on the page.
290
+ * @property {string} [next_id] - The identifier for the next page.
291
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
292
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
293
+ * @property {number} [current] - The current page number.
294
+ * @property {string} type - The type of the page, such as 'PageType'.
295
+ * @property {number} [size] - The number of items per page.
296
296
  */
297
297
 
298
298
  /**
@@ -23,18 +23,6 @@ declare class Configuration {
23
23
  * @description: Retrieve a list of available sales channels. sales channels are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of sales channels created within a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplications/).
24
24
  */
25
25
  getApplications({ pageNo, pageSize, q, requestHeaders }?: ConfigurationPlatformValidator.GetApplicationsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationsResponse>;
26
- /**
27
- * @param {ConfigurationPlatformValidator.GetAvailableOptInsParam} arg - Arg object
28
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
29
- * @param {import("../PlatformAPIClient").Options} - Options
30
- * @returns {Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>}
31
- * - Success response
32
- *
33
- * @name getAvailableOptIns
34
- * @summary: List available opt-ins
35
- * @description: Retrieve a list of available opt-ins. Retrieve a list of all available integrations in a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAvailableOptIns/).
36
- */
37
- getAvailableOptIns({ pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetAvailableOptInsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>;
38
26
  /**
39
27
  * @param {ConfigurationPlatformValidator.GetBrandsByCompanyParam} arg - Arg object
40
28
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -80,55 +68,6 @@ declare class Configuration {
80
68
  * @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to sales channel. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainAvailibility/).
81
69
  */
82
70
  getDomainAvailibility({ body, requestHeaders }?: ConfigurationPlatformValidator.GetDomainAvailibilityParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainSuggestionsResponse>;
83
- /**
84
- * @param {ConfigurationPlatformValidator.GetIntegrationByIdParam} arg - Arg object
85
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
86
- * @param {import("../PlatformAPIClient").Options} - Options
87
- * @returns {Promise<ConfigurationPlatformModel.Integration>} - Success response
88
- * @name getIntegrationById
89
- * @summary: Get integration by Id
90
- * @description: Retrieve detailed information about a specific integration. Retrieve the details of an integration (such as Ginesys, SAP, etc.) using its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationById/).
91
- */
92
- getIntegrationById({ id, requestHeaders }?: ConfigurationPlatformValidator.GetIntegrationByIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.Integration>;
93
- /**
94
- * @param {ConfigurationPlatformValidator.GetIntegrationByLevelIdParam} arg
95
- * - Arg object
96
- *
97
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
98
- * @param {import("../PlatformAPIClient").Options} - Options
99
- * @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
100
- * @name getIntegrationByLevelId
101
- * @summary: Get integration Id
102
- * @description: Retrieve integration details for a specific level. Retrieve the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationByLevelId/).
103
- */
104
- getIntegrationByLevelId({ id, level, uid, requestHeaders }?: ConfigurationPlatformValidator.GetIntegrationByLevelIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationLevel>;
105
- /**
106
- * @param {ConfigurationPlatformValidator.GetIntegrationLevelConfigParam} arg
107
- * - Arg object
108
- *
109
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
110
- * @param {import("../PlatformAPIClient").Options} - Options
111
- * @returns {Promise<ConfigurationPlatformModel.IntegrationConfigResponse>}
112
- * - Success response
113
- *
114
- * @name getIntegrationLevelConfig
115
- * @summary: Get level configuration
116
- * @description: Retrieve configuration settings for integration levels. Retrieve the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationLevelConfig/).
117
- */
118
- getIntegrationLevelConfig({ id, level, opted, checkPermission, requestHeaders }?: ConfigurationPlatformValidator.GetIntegrationLevelConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationConfigResponse>;
119
- /**
120
- * @param {ConfigurationPlatformValidator.GetLevelActiveIntegrationsParam} arg
121
- * - Arg object
122
- *
123
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
124
- * @param {import("../PlatformAPIClient").Options} - Options
125
- * @returns {Promise<ConfigurationPlatformModel.OptedStoreIntegration>} -
126
- * Success response
127
- * @name getLevelActiveIntegrations
128
- * @summary: Get active integrations
129
- * @description: Check if a store is already opted-in for any integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getLevelActiveIntegrations/).
130
- */
131
- getLevelActiveIntegrations({ id, level, uid, requestHeaders }?: ConfigurationPlatformValidator.GetLevelActiveIntegrationsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OptedStoreIntegration>;
132
71
  /**
133
72
  * @param {ConfigurationPlatformValidator.GetOtherSellerApplicationByIdParam} arg
134
73
  * - Arg object
@@ -156,18 +95,6 @@ declare class Configuration {
156
95
  * @description: Retrieve sales channels of other sellers. Retrieve all other seller sales channels that were not created within the current company. but have opted for the current company's inventory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplications/).
157
96
  */
158
97
  getOtherSellerApplications({ pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetOtherSellerApplicationsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OtherSellerApplications>;
159
- /**
160
- * @param {ConfigurationPlatformValidator.GetSelectedOptInsParam} arg - Arg object
161
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
162
- * @param {import("../PlatformAPIClient").Options} - Options
163
- * @returns {Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>}
164
- * - Success response
165
- *
166
- * @name getSelectedOptIns
167
- * @summary: List selected opt-in
168
- * @description: Retrieve a list of selected opt-ins. Retrieve the store-level/company-level integrations configured in a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getSelectedOptIns/).
169
- */
170
- getSelectedOptIns({ level, uid, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetSelectedOptInsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>;
171
98
  /**
172
99
  * @param {ConfigurationPlatformValidator.GetStoreByBrandsParam} arg - Arg object
173
100
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -190,30 +117,6 @@ declare class Configuration {
190
117
  * @description: This API allows businesses to opt out of sharing their inventory with external seller sales channels. By using this API, companies or stores can prevent specific seller sales channels from fetching their inventory data. This feature is useful for businesses that want to control who can access their product listings and other inventory information. It helps maintain privacy and control over data distribution, ensuring that sensitive information is only shared with authorized partners. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/optOutFromApplication/).
191
118
  */
192
119
  optOutFromApplication({ id, body, requestHeaders }?: ConfigurationPlatformValidator.OptOutFromApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
193
- /**
194
- * @param {ConfigurationPlatformValidator.UpdateLevelIntegrationParam} arg
195
- * - Arg object
196
- *
197
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
198
- * @param {import("../PlatformAPIClient").Options} - Options
199
- * @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
200
- * @name updateLevelIntegration
201
- * @summary: Update level integration
202
- * @description: Modify level integration. Update the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateLevelIntegration/).
203
- */
204
- updateLevelIntegration({ id, level, body, requestHeaders }?: ConfigurationPlatformValidator.UpdateLevelIntegrationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationLevel>;
205
- /**
206
- * @param {ConfigurationPlatformValidator.UpdateLevelUidIntegrationParam} arg
207
- * - Arg object
208
- *
209
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
210
- * @param {import("../PlatformAPIClient").Options} - Options
211
- * @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
212
- * @name updateLevelUidIntegration
213
- * @summary: Update level UID integration
214
- * @description: Modify UID-based integration. Update the level of integration by store UID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateLevelUidIntegration/).
215
- */
216
- updateLevelUidIntegration({ id, level, uid, body, requestHeaders }?: ConfigurationPlatformValidator.UpdateLevelUidIntegrationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationLevel>;
217
120
  }
218
121
  import ConfigurationPlatformValidator = require("./ConfigurationPlatformValidator");
219
122
  import ConfigurationPlatformModel = require("./ConfigurationPlatformModel");