@gofynd/fdk-client-javascript 3.3.5 → 3.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (166) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
  4. package/sdk/application/Cart/CartApplicationClient.js +30 -30
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +36 -33
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +54 -35
  7. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  8. package/sdk/application/Common/CommonApplicationClient.js +2 -2
  9. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
  10. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
  11. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
  12. package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
  14. package/sdk/application/Content/ContentApplicationClient.js +24 -24
  15. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  17. package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
  18. package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
  20. package/sdk/application/Lead/LeadApplicationClient.js +5 -5
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +19 -9
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +53 -9
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
  24. package/sdk/application/Order/OrderApplicationClient.js +12 -12
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
  26. package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
  32. package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
  33. package/sdk/application/User/UserApplicationClient.d.ts +47 -47
  34. package/sdk/application/User/UserApplicationClient.js +47 -47
  35. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
  36. package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
  37. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
  38. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
  39. package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
  40. package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
  41. package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
  42. package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
  43. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
  44. package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
  45. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +6 -6
  46. package/sdk/partner/Logistics/LogisticsPartnerModel.js +3 -3
  47. package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
  48. package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
  49. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
  50. package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
  51. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +7 -2
  52. package/sdk/partner/Webhook/WebhookPartnerModel.js +3 -1
  53. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
  54. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
  55. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
  56. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
  57. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
  58. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
  59. package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
  60. package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
  61. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
  62. package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
  63. package/sdk/platform/Cart/CartPlatformModel.d.ts +233 -3
  64. package/sdk/platform/Cart/CartPlatformModel.js +147 -1
  65. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
  66. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
  67. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +81 -79
  68. package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -80
  69. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +89 -5
  70. package/sdk/platform/Catalog/CatalogPlatformModel.js +57 -3
  71. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +7 -2
  72. package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -2
  73. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
  74. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  75. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
  76. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
  77. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  78. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  79. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
  80. package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
  81. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
  82. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
  83. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
  84. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
  85. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
  86. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
  87. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
  88. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
  89. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +19 -3
  90. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +16 -1
  91. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
  92. package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
  93. package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
  94. package/sdk/platform/Content/ContentPlatformClient.js +40 -40
  95. package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
  96. package/sdk/platform/Content/ContentPlatformModel.js +1 -1
  97. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
  98. package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
  99. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
  100. package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
  101. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
  102. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
  103. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
  104. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
  105. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
  106. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
  107. package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
  108. package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
  109. package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
  110. package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
  111. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
  112. package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
  113. package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
  114. package/sdk/platform/Order/OrderPlatformClient.js +58 -58
  115. package/sdk/platform/Order/OrderPlatformModel.d.ts +29 -10
  116. package/sdk/platform/Order/OrderPlatformModel.js +28 -6
  117. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
  118. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
  119. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
  120. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
  121. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
  122. package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
  123. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
  124. package/sdk/platform/Payment/PaymentPlatformModel.js +1 -1
  125. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
  126. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
  127. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
  128. package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
  129. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +162 -39
  130. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +840 -73
  131. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
  132. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
  133. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +30 -30
  134. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +36 -30
  135. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
  136. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
  137. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
  138. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
  139. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
  140. package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
  141. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
  142. package/sdk/platform/Share/SharePlatformModel.js +1 -1
  143. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
  144. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
  145. package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
  146. package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
  147. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +70 -34
  148. package/sdk/platform/User/UserPlatformApplicationClient.js +285 -34
  149. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
  150. package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
  151. package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
  152. package/sdk/platform/User/UserPlatformModel.js +276 -7
  153. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
  154. package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
  155. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +12 -2
  156. package/sdk/platform/Webhook/WebhookPlatformModel.js +5 -1
  157. package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
  158. package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
  159. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  160. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
  161. package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
  162. package/sdk/public/Content/ContentPublicClient.js +14 -14
  163. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  164. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  165. package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
  166. package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
@@ -829,7 +829,7 @@ export = CommunicationPlatformModel;
829
829
  */
830
830
  /**
831
831
  * @typedef Page
832
- * @property {number} [item_total] - The total number of items on the page.
832
+ * @property {number} [item_total] - The total number of all items across all pages.
833
833
  * @property {string} [next_id] - The identifier for the next page.
834
834
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
835
835
  * @property {boolean} [has_next] - Indicates whether there is a next page.
@@ -1896,7 +1896,7 @@ type SystemNotifications = {
1896
1896
  declare function Page(): Page;
1897
1897
  type Page = {
1898
1898
  /**
1899
- * - The total number of items on the page.
1899
+ * - The total number of all items across all pages.
1900
1900
  */
1901
1901
  item_total?: number;
1902
1902
  /**
@@ -941,7 +941,7 @@ const Joi = require("joi");
941
941
 
942
942
  /**
943
943
  * @typedef Page
944
- * @property {number} [item_total] - The total number of items on the page.
944
+ * @property {number} [item_total] - The total number of all items across all pages.
945
945
  * @property {string} [next_id] - The identifier for the next page.
946
946
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
947
947
  * @property {boolean} [has_next] - Indicates whether there is a next page.
@@ -11,7 +11,7 @@ declare class CompanyProfile {
11
11
  *
12
12
  * @name cbsOnboardGet
13
13
  * @summary: Get company profile
14
- * @description: View the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/cbsOnboardGet/).
14
+ * @description: View the company profile of the seller account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/cbsOnboardGet/).
15
15
  */
16
16
  cbsOnboardGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponseSchema>;
17
17
  /**
@@ -23,7 +23,7 @@ declare class CompanyProfile {
23
23
  *
24
24
  * @name createBrand
25
25
  * @summary: Create brand
26
- * @description: Allows to create a brand associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createBrand/).
26
+ * @description: Allows to create a brand associated to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/createBrand/).
27
27
  */
28
28
  createBrand({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
29
29
  /**
@@ -37,7 +37,7 @@ declare class CompanyProfile {
37
37
  *
38
38
  * @name createCompanyBrandMapping
39
39
  * @summary: Create company-brand mapping
40
- * @description: Establish a mapping between a company and a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createCompanyBrandMapping/).
40
+ * @description: Establish a mapping between a company and a brand. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/createCompanyBrandMapping/).
41
41
  */
42
42
  createCompanyBrandMapping({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateCompanyBrandMappingParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
43
43
  /**
@@ -49,7 +49,7 @@ declare class CompanyProfile {
49
49
  *
50
50
  * @name createLocation
51
51
  * @summary: Create company stores
52
- * @description: Create a new location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocation/).
52
+ * @description: Create a new location associated to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/createLocation/).
53
53
  */
54
54
  createLocation({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
55
55
  /**
@@ -61,7 +61,7 @@ declare class CompanyProfile {
61
61
  *
62
62
  * @name createLocationBulk
63
63
  * @summary: Bulk create company stores
64
- * @description: Allows to create locations in bulk at once associated to a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocationBulk/).
64
+ * @description: Allows to create locations in bulk at once associated to a company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/createLocationBulk/).
65
65
  */
66
66
  createLocationBulk({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationBulkParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
67
67
  /**
@@ -73,7 +73,7 @@ declare class CompanyProfile {
73
73
  *
74
74
  * @name editBrand
75
75
  * @summary: update brand
76
- * @description: Modify brand details and meta of a specific brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/editBrand/).
76
+ * @description: Modify brand details and meta of a specific brand. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/editBrand/).
77
77
  */
78
78
  editBrand({ brandId, body, requestHeaders }?: CompanyProfilePlatformValidator.EditBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
79
79
  /**
@@ -84,7 +84,7 @@ declare class CompanyProfile {
84
84
  * Success response
85
85
  * @name getBrand
86
86
  * @summary: Get a brand
87
- * @description: Retrieve detailed information about a specific brand associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrand/).
87
+ * @description: Retrieve detailed information about a specific brand associated to a particular company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getBrand/).
88
88
  */
89
89
  getBrand({ brandId, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetBrandResponseSchema>;
90
90
  /**
@@ -95,7 +95,7 @@ declare class CompanyProfile {
95
95
  * Success response
96
96
  * @name getBrands
97
97
  * @summary: list company brands
98
- * @description: Retrieve a list of available brands associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrands/).
98
+ * @description: Retrieve a list of available brands associated to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getBrands/).
99
99
  */
100
100
  getBrands({ pageNo, pageSize, q, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.CompanyBrandListSchema>;
101
101
  /**
@@ -118,7 +118,7 @@ declare class CompanyProfile {
118
118
  * @returns {Promise<CompanyProfilePlatformModel.MetricsSchema>} - Success response
119
119
  * @name getCompanyMetrics
120
120
  * @summary: Get company metrics
121
- * @description: Allows viewing company metrics, including brand and store status, as well as the number of verified and unverified products, company documents, and store documents. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getCompanyMetrics/).
121
+ * @description: Allows viewing company metrics, including brand and store status, as well as the number of verified and unverified products, company documents, and store documents. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getCompanyMetrics/).
122
122
  */
123
123
  getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.MetricsSchema>;
124
124
  /**
@@ -129,7 +129,7 @@ declare class CompanyProfile {
129
129
  * Success response
130
130
  * @name getLocationDetail
131
131
  * @summary: Get company stores
132
- * @description: Retrive detailed information about a specific location associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationDetail/).
132
+ * @description: Retrive detailed information about a specific location associated to a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getLocationDetail/).
133
133
  */
134
134
  getLocationDetail({ locationId, requestHeaders }?: CompanyProfilePlatformValidator.GetLocationDetailParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetLocationSchema>;
135
135
  /**
@@ -141,7 +141,7 @@ declare class CompanyProfile {
141
141
  *
142
142
  * @name getLocationTags
143
143
  * @summary: Get company store tags
144
- * @description: Retrieve all the distinct tags associated to a company location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationTags/).
144
+ * @description: Retrieve all the distinct tags associated to a company location. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getLocationTags/).
145
145
  */
146
146
  getLocationTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.StoreTagsResponseSchema>;
147
147
  /**
@@ -152,7 +152,7 @@ declare class CompanyProfile {
152
152
  * Success response
153
153
  * @name getLocations
154
154
  * @summary: Get company specific stores
155
- * @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocations/).
155
+ * @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getLocations/).
156
156
  */
157
157
  getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, types, tags, requestHeaders, }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.LocationListSchema>;
158
158
  /**
@@ -164,7 +164,7 @@ declare class CompanyProfile {
164
164
  *
165
165
  * @name updateCompany
166
166
  * @summary: Update company profile
167
- * @description: Allows to edit the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateCompany/).
167
+ * @description: Allows to edit the company profile of the seller account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/updateCompany/).
168
168
  */
169
169
  updateCompany({ body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateCompanyParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
170
170
  /**
@@ -176,7 +176,7 @@ declare class CompanyProfile {
176
176
  *
177
177
  * @name updateLocation
178
178
  * @summary: Update company stores
179
- * @description: Allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateLocation/).
179
+ * @description: Allows to edit a location associated to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/updateLocation/).
180
180
  */
181
181
  updateLocation({ locationId, body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
182
182
  }
@@ -23,7 +23,7 @@ class CompanyProfile {
23
23
  *
24
24
  * @name cbsOnboardGet
25
25
  * @summary: Get company profile
26
- * @description: View the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/cbsOnboardGet/).
26
+ * @description: View the company profile of the seller account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/cbsOnboardGet/).
27
27
  */
28
28
  async cbsOnboardGet(
29
29
  { requestHeaders } = { requestHeaders: {} },
@@ -100,7 +100,7 @@ class CompanyProfile {
100
100
  *
101
101
  * @name createBrand
102
102
  * @summary: Create brand
103
- * @description: Allows to create a brand associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createBrand/).
103
+ * @description: Allows to create a brand associated to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/createBrand/).
104
104
  */
105
105
  async createBrand(
106
106
  { body, requestHeaders } = { requestHeaders: {} },
@@ -183,7 +183,7 @@ class CompanyProfile {
183
183
  *
184
184
  * @name createCompanyBrandMapping
185
185
  * @summary: Create company-brand mapping
186
- * @description: Establish a mapping between a company and a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createCompanyBrandMapping/).
186
+ * @description: Establish a mapping between a company and a brand. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/createCompanyBrandMapping/).
187
187
  */
188
188
  async createCompanyBrandMapping(
189
189
  { body, requestHeaders } = { requestHeaders: {} },
@@ -266,7 +266,7 @@ class CompanyProfile {
266
266
  *
267
267
  * @name createLocation
268
268
  * @summary: Create company stores
269
- * @description: Create a new location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocation/).
269
+ * @description: Create a new location associated to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/createLocation/).
270
270
  */
271
271
  async createLocation(
272
272
  { body, requestHeaders } = { requestHeaders: {} },
@@ -347,7 +347,7 @@ class CompanyProfile {
347
347
  *
348
348
  * @name createLocationBulk
349
349
  * @summary: Bulk create company stores
350
- * @description: Allows to create locations in bulk at once associated to a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocationBulk/).
350
+ * @description: Allows to create locations in bulk at once associated to a company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/createLocationBulk/).
351
351
  */
352
352
  async createLocationBulk(
353
353
  { body, requestHeaders } = { requestHeaders: {} },
@@ -430,7 +430,7 @@ class CompanyProfile {
430
430
  *
431
431
  * @name editBrand
432
432
  * @summary: update brand
433
- * @description: Modify brand details and meta of a specific brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/editBrand/).
433
+ * @description: Modify brand details and meta of a specific brand. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/editBrand/).
434
434
  */
435
435
  async editBrand(
436
436
  { brandId, body, requestHeaders } = { requestHeaders: {} },
@@ -512,7 +512,7 @@ class CompanyProfile {
512
512
  * Success response
513
513
  * @name getBrand
514
514
  * @summary: Get a brand
515
- * @description: Retrieve detailed information about a specific brand associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrand/).
515
+ * @description: Retrieve detailed information about a specific brand associated to a particular company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getBrand/).
516
516
  */
517
517
  async getBrand(
518
518
  { brandId, requestHeaders } = { requestHeaders: {} },
@@ -592,7 +592,7 @@ class CompanyProfile {
592
592
  * Success response
593
593
  * @name getBrands
594
594
  * @summary: list company brands
595
- * @description: Retrieve a list of available brands associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrands/).
595
+ * @description: Retrieve a list of available brands associated to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getBrands/).
596
596
  */
597
597
  async getBrands(
598
598
  { pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
@@ -708,7 +708,7 @@ class CompanyProfile {
708
708
  * @returns {Promise<CompanyProfilePlatformModel.MetricsSchema>} - Success response
709
709
  * @name getCompanyMetrics
710
710
  * @summary: Get company metrics
711
- * @description: Allows viewing company metrics, including brand and store status, as well as the number of verified and unverified products, company documents, and store documents. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getCompanyMetrics/).
711
+ * @description: Allows viewing company metrics, including brand and store status, as well as the number of verified and unverified products, company documents, and store documents. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getCompanyMetrics/).
712
712
  */
713
713
  async getCompanyMetrics(
714
714
  { requestHeaders } = { requestHeaders: {} },
@@ -786,7 +786,7 @@ class CompanyProfile {
786
786
  * Success response
787
787
  * @name getLocationDetail
788
788
  * @summary: Get company stores
789
- * @description: Retrive detailed information about a specific location associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationDetail/).
789
+ * @description: Retrive detailed information about a specific location associated to a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getLocationDetail/).
790
790
  */
791
791
  async getLocationDetail(
792
792
  { locationId, requestHeaders } = { requestHeaders: {} },
@@ -869,7 +869,7 @@ class CompanyProfile {
869
869
  *
870
870
  * @name getLocationTags
871
871
  * @summary: Get company store tags
872
- * @description: Retrieve all the distinct tags associated to a company location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationTags/).
872
+ * @description: Retrieve all the distinct tags associated to a company location. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getLocationTags/).
873
873
  */
874
874
  async getLocationTags(
875
875
  { requestHeaders } = { requestHeaders: {} },
@@ -947,7 +947,7 @@ class CompanyProfile {
947
947
  * Success response
948
948
  * @name getLocations
949
949
  * @summary: Get company specific stores
950
- * @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocations/).
950
+ * @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getLocations/).
951
951
  */
952
952
  async getLocations(
953
953
  {
@@ -1060,7 +1060,7 @@ class CompanyProfile {
1060
1060
  *
1061
1061
  * @name updateCompany
1062
1062
  * @summary: Update company profile
1063
- * @description: Allows to edit the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateCompany/).
1063
+ * @description: Allows to edit the company profile of the seller account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/updateCompany/).
1064
1064
  */
1065
1065
  async updateCompany(
1066
1066
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1141,7 +1141,7 @@ class CompanyProfile {
1141
1141
  *
1142
1142
  * @name updateLocation
1143
1143
  * @summary: Update company stores
1144
- * @description: Allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateLocation/).
1144
+ * @description: Allows to edit a location associated to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/updateLocation/).
1145
1145
  */
1146
1146
  async updateLocation(
1147
1147
  { locationId, body, requestHeaders } = { requestHeaders: {} },
@@ -259,7 +259,7 @@ export = CompanyProfilePlatformModel;
259
259
  */
260
260
  /**
261
261
  * @typedef Page
262
- * @property {number} [item_total] - The total number of items on the page.
262
+ * @property {number} [item_total] - The total number of all items across all pages.
263
263
  * @property {string} [next_id] - The identifier for the next page.
264
264
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
265
265
  * @property {boolean} [has_next] - Indicates whether there is a next page.
@@ -741,7 +741,7 @@ type CompanyBrandSchema = {
741
741
  declare function Page(): Page;
742
742
  type Page = {
743
743
  /**
744
- * - The total number of items on the page.
744
+ * - The total number of all items across all pages.
745
745
  */
746
746
  item_total?: number;
747
747
  /**
@@ -286,7 +286,7 @@ const Joi = require("joi");
286
286
 
287
287
  /**
288
288
  * @typedef Page
289
- * @property {number} [item_total] - The total number of items on the page.
289
+ * @property {number} [item_total] - The total number of all items across all pages.
290
290
  * @property {string} [next_id] - The identifier for the next page.
291
291
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
292
292
  * @property {boolean} [has_next] - Indicates whether there is a next page.
@@ -10,7 +10,7 @@ declare class Configuration {
10
10
  * @returns {Promise<ConfigurationPlatformModel.Domain>} - Success response
11
11
  * @name addDomain
12
12
  * @summary: Create domain
13
- * @description: Creates a domain for an sales channel. Note - Only 15 domains can be added to the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/addDomain/).
13
+ * @description: Creates a domain for an sales channel. Note - Only 15 domains can be added to the sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/addDomain/).
14
14
  */
15
15
  addDomain({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.AddDomainParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.Domain>;
16
16
  /**
@@ -23,7 +23,7 @@ declare class Configuration {
23
23
  * Success response
24
24
  * @name changeDomainType
25
25
  * @summary: Update domain
26
- * @description: Modify the type of a specific domain. Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/changeDomainType/).
26
+ * @description: Modify the type of a specific domain. Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/changeDomainType/).
27
27
  */
28
28
  changeDomainType({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.ChangeDomainTypeParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainsResponseSchema>;
29
29
  /**
@@ -36,7 +36,7 @@ declare class Configuration {
36
36
  * Success response
37
37
  * @name getAppApiTokens
38
38
  * @summary: Get sales channel API tokens
39
- * @description: Retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppApiTokens/).
39
+ * @description: Retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppApiTokens/).
40
40
  */
41
41
  getAppApiTokens({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.TokenResponseSchema>;
42
42
  /**
@@ -48,7 +48,7 @@ declare class Configuration {
48
48
  * @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
49
49
  * @name getAppBasicDetails
50
50
  * @summary: Get sales channel
51
- * @description: Shows basic sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppBasicDetails/).
51
+ * @description: Shows basic sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppBasicDetails/).
52
52
  */
53
53
  getAppBasicDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationDetail>;
54
54
  /**
@@ -61,7 +61,7 @@ declare class Configuration {
61
61
  * Success response
62
62
  * @name getAppCompanies
63
63
  * @summary: List sales channel companies
64
- * @description: Retrieve info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCompanies/).
64
+ * @description: Retrieve info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppCompanies/).
65
65
  */
66
66
  getAppCompanies({ uid, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetAppCompaniesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CompaniesResponseSchema>;
67
67
  /**
@@ -74,7 +74,7 @@ declare class Configuration {
74
74
  * Success response
75
75
  * @name getAppContactInfo
76
76
  * @summary: Get sales channel contact
77
- * @description: Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppContactInfo/).
77
+ * @description: Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppContactInfo/).
78
78
  */
79
79
  getAppContactInfo({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInformation>;
80
80
  /**
@@ -87,7 +87,7 @@ declare class Configuration {
87
87
  * Success response
88
88
  * @name getAppCurrencyConfig
89
89
  * @summary: Get sales channel currency configuration
90
- * @description: Retrieve a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCurrencyConfig/).
90
+ * @description: Retrieve a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppCurrencyConfig/).
91
91
  */
92
92
  getAppCurrencyConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppSupportedCurrency>;
93
93
  /**
@@ -101,7 +101,7 @@ declare class Configuration {
101
101
  *
102
102
  * @name getAppFeatures
103
103
  * @summary: Get sales channel
104
- * @description: Shows feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppFeatures/).
104
+ * @description: Shows feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppFeatures/).
105
105
  */
106
106
  getAppFeatures({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppFeatureResponseSchema>;
107
107
  /**
@@ -114,7 +114,7 @@ declare class Configuration {
114
114
  * Success response
115
115
  * @name getAppStores
116
116
  * @summary: list sales channel stores
117
- * @description: Retrieve information of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppStores/).
117
+ * @description: Retrieve information of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppStores/).
118
118
  */
119
119
  getAppStores({ pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetAppStoresParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.StoresResponseSchema>;
120
120
  /**
@@ -128,7 +128,7 @@ declare class Configuration {
128
128
  *
129
129
  * @name getAppSupportedCurrency
130
130
  * @summary: List supported currencies
131
- * @description: Retrieve a list of supported currencies for the sales channel. A list of currencies allowed in the current sales channel. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppSupportedCurrency/).
131
+ * @description: Retrieve a list of supported currencies for the sales channel. A list of currencies allowed in the current sales channel. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppSupportedCurrency/).
132
132
  */
133
133
  getAppSupportedCurrency({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppCurrencyResponseSchema>;
134
134
  /**
@@ -140,7 +140,7 @@ declare class Configuration {
140
140
  * @returns {Promise<ConfigurationPlatformModel.ApplicationById>} - Success response
141
141
  * @name getApplicationById
142
142
  * @summary: Get sales channel by id
143
- * @description: Retrieve detailed information about a specific sales channel. Use sales channel ID to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplicationById/).
143
+ * @description: Retrieve detailed information about a specific sales channel. Use sales channel ID to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getApplicationById/).
144
144
  */
145
145
  getApplicationById({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationById>;
146
146
  /**
@@ -153,7 +153,7 @@ declare class Configuration {
153
153
  * Success response
154
154
  * @name getBuildConfig
155
155
  * @summary: Get Build Configuration
156
- * @description: Retrieve latest build configuration, such as app name, landing page image, splash image used in a mobile build. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBuildConfig/).
156
+ * @description: Retrieve latest build configuration, such as app name, landing page image, splash image used in a mobile build. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getBuildConfig/).
157
157
  */
158
158
  getBuildConfig({ platformType, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetBuildConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.MobileAppConfiguration>;
159
159
  /**
@@ -167,7 +167,7 @@ declare class Configuration {
167
167
  *
168
168
  * @name getDomainStatus
169
169
  * @summary: Get domain status
170
- * @description: Retrieve the status of a specific domain. Shows if the A records and TXT records of the domain correctly points to appropriate IP on Fynd Servers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainStatus/).
170
+ * @description: Retrieve the status of a specific domain. Shows if the A records and TXT records of the domain correctly points to appropriate IP on Fynd Servers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getDomainStatus/).
171
171
  */
172
172
  getDomainStatus({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetDomainStatusParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainStatusResponseSchema>;
173
173
  /**
@@ -178,7 +178,7 @@ declare class Configuration {
178
178
  * Success response
179
179
  * @name getDomains
180
180
  * @summary: List domains
181
- * @description: Retrieve a list of existing domains by its sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomains/).
181
+ * @description: Retrieve a list of existing domains by its sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getDomains/).
182
182
  */
183
183
  getDomains({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainsResponseSchema>;
184
184
  /**
@@ -191,7 +191,7 @@ declare class Configuration {
191
191
  * Success response
192
192
  * @name getInventoryConfig
193
193
  * @summary: Get inventory configuration
194
- * @description: Retrieve configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getInventoryConfig/).
194
+ * @description: Retrieve configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getInventoryConfig/).
195
195
  */
196
196
  getInventoryConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInventory>;
197
197
  /**
@@ -204,7 +204,7 @@ declare class Configuration {
204
204
  * Success response
205
205
  * @name getOrderingStoreConfig
206
206
  * @summary: Get ordering store configuration
207
- * @description: Retrieve configuration settings for ordering stores. Retrieve the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreConfig/).
207
+ * @description: Retrieve configuration settings for ordering stores. Retrieve the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getOrderingStoreConfig/).
208
208
  */
209
209
  getOrderingStoreConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStoreConfig>;
210
210
  /**
@@ -218,7 +218,7 @@ declare class Configuration {
218
218
  *
219
219
  * @name getOrderingStoreCookie
220
220
  * @summary: Get ordering store signed cookie
221
- * @description: Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreCookie/).
221
+ * @description: Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getOrderingStoreCookie/).
222
222
  */
223
223
  getOrderingStoreCookie({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetOrderingStoreCookieParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponseSchema>;
224
224
  /**
@@ -230,7 +230,7 @@ declare class Configuration {
230
230
  * @returns {Promise<ConfigurationPlatformModel.OrderingStores>} - Success response
231
231
  * @name getOrderingStoresByFilter
232
232
  * @summary: List ordering stores
233
- * @description: Retrieve ordering stores based on specified filters. Use filters and retrieve the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoresByFilter/).
233
+ * @description: Retrieve ordering stores based on specified filters. Use filters and retrieve the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getOrderingStoresByFilter/).
234
234
  */
235
235
  getOrderingStoresByFilter({ body, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetOrderingStoresByFilterParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStores>;
236
236
  /**
@@ -243,7 +243,7 @@ declare class Configuration {
243
243
  * Success response
244
244
  * @name getPreviousVersions
245
245
  * @summary: Get previous versions
246
- * @description: Retrieve version details of the app, this includes the build status, build date, version name, latest version, and a lot more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getPreviousVersions/).
246
+ * @description: Retrieve version details of the app, this includes the build status, build date, version name, latest version, and a lot more. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getPreviousVersions/).
247
247
  */
248
248
  getPreviousVersions({ platformType, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetPreviousVersionsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.BuildVersionHistory>;
249
249
  /**
@@ -257,7 +257,7 @@ declare class Configuration {
257
257
  *
258
258
  * @name getStaffOrderingStores
259
259
  * @summary: Get staff ordering stores
260
- * @description: Retrieve ordering stores accessible to staff members. Retrieve the details of all stores access given to the staff member (the selling locations where the sales channel will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStaffOrderingStores/).
260
+ * @description: Retrieve ordering stores accessible to staff members. Retrieve the details of all stores access given to the staff member (the selling locations where the sales channel will be utilized for placing orders). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getStaffOrderingStores/).
261
261
  */
262
262
  getStaffOrderingStores({ pageNo, pageSize, q, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetStaffOrderingStoresParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStoresResponseSchema>;
263
263
  /**
@@ -269,7 +269,7 @@ declare class Configuration {
269
269
  * @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
270
270
  * @name modifyAppFeatures
271
271
  * @summary: update sales channel features
272
- * @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/modifyAppFeatures/).
272
+ * @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/modifyAppFeatures/).
273
273
  */
274
274
  modifyAppFeatures({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.ModifyAppFeaturesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppFeature>;
275
275
  /**
@@ -282,7 +282,7 @@ declare class Configuration {
282
282
  * Success response
283
283
  * @name partiallyUpdateInventoryConfig
284
284
  * @summary: Partially update inventory configuration
285
- * @description: Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/partiallyUpdateInventoryConfig/).
285
+ * @description: Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/partiallyUpdateInventoryConfig/).
286
286
  */
287
287
  partiallyUpdateInventoryConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.PartiallyUpdateInventoryConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInventory>;
288
288
  /**
@@ -296,7 +296,7 @@ declare class Configuration {
296
296
  *
297
297
  * @name removeDomainById
298
298
  * @summary: Remove domain
299
- * @description: Delete a specific domain from the sales channel. Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeDomainById/).
299
+ * @description: Delete a specific domain from the sales channel. Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/removeDomainById/).
300
300
  */
301
301
  removeDomainById({ id, requestHeaders }?: ConfigurationPlatformApplicationValidator.RemoveDomainByIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponseSchema>;
302
302
  /**
@@ -310,7 +310,7 @@ declare class Configuration {
310
310
  *
311
311
  * @name removeOrderingStoreCookie
312
312
  * @summary: Delete Ordering Store signed cookie
313
- * @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeOrderingStoreCookie/).
313
+ * @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/removeOrderingStoreCookie/).
314
314
  */
315
315
  removeOrderingStoreCookie({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponseSchema>;
316
316
  /**
@@ -323,7 +323,7 @@ declare class Configuration {
323
323
  * Success response
324
324
  * @name updateAppApiTokens
325
325
  * @summary: Update sales channel API tokens
326
- * @description: Add and edit the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google and Facebook auth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppApiTokens/).
326
+ * @description: Add and edit the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google and Facebook auth. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateAppApiTokens/).
327
327
  */
328
328
  updateAppApiTokens({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppApiTokensParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.TokenResponseSchema>;
329
329
  /**
@@ -335,7 +335,7 @@ declare class Configuration {
335
335
  * @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
336
336
  * @name updateAppBasicDetails
337
337
  * @summary: Update sales channel basic details
338
- * @description: Modify sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppBasicDetails/).
338
+ * @description: Modify sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateAppBasicDetails/).
339
339
  */
340
340
  updateAppBasicDetails({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppBasicDetailsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationDetail>;
341
341
  /**
@@ -348,7 +348,7 @@ declare class Configuration {
348
348
  * Success response
349
349
  * @name updateAppContactInfo
350
350
  * @summary: Update sales channel contact
351
- * @description: Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppContactInfo/).
351
+ * @description: Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateAppContactInfo/).
352
352
  */
353
353
  updateAppContactInfo({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppContactInfoParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInformation>;
354
354
  /**
@@ -361,7 +361,7 @@ declare class Configuration {
361
361
  * Success response
362
362
  * @name updateAppCurrencyConfig
363
363
  * @summary: Update sales channel currency configuration
364
- * @description: Modify currency configuration settings for the sales channel. Add and edit the currencies supported in the sales channel. Initially, INR will be enabled by default. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppCurrencyConfig/).
364
+ * @description: Modify currency configuration settings for the sales channel. Add and edit the currencies supported in the sales channel. Initially, INR will be enabled by default. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateAppCurrencyConfig/).
365
365
  */
366
366
  updateAppCurrencyConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppCurrencyConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppSupportedCurrency>;
367
367
  /**
@@ -373,7 +373,7 @@ declare class Configuration {
373
373
  * @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
374
374
  * @name updateAppFeatures
375
375
  * @summary: Update sales channel
376
- * @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppFeatures/).
376
+ * @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateAppFeatures/).
377
377
  */
378
378
  updateAppFeatures({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppFeaturesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppFeature>;
379
379
  /**
@@ -386,7 +386,7 @@ declare class Configuration {
386
386
  * Success response
387
387
  * @name updateBuildConfig
388
388
  * @summary: Update build configuration
389
- * @description: Modify the existing build configuration, such as app name, landing page image, splash image used in a mobile build. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateBuildConfig/).
389
+ * @description: Modify the existing build configuration, such as app name, landing page image, splash image used in a mobile build. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateBuildConfig/).
390
390
  */
391
391
  updateBuildConfig({ platformType, body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateBuildConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.MobileAppConfiguration>;
392
392
  /**
@@ -399,7 +399,7 @@ declare class Configuration {
399
399
  * Success response
400
400
  * @name updateInventoryConfig
401
401
  * @summary: Update inventory configuration
402
- * @description: Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateInventoryConfig/).
402
+ * @description: Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateInventoryConfig/).
403
403
  */
404
404
  updateInventoryConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateInventoryConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInventory>;
405
405
  /**
@@ -411,7 +411,7 @@ declare class Configuration {
411
411
  * @returns {Promise<ConfigurationPlatformModel.DeploymentMeta>} - Success response
412
412
  * @name updateOrderingStoreConfig
413
413
  * @summary: Update ordering store configuration
414
- * @description: Modify configuration settings for ordering stores. Edit the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateOrderingStoreConfig/).
414
+ * @description: Modify configuration settings for ordering stores. Edit the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders) - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateOrderingStoreConfig/).
415
415
  */
416
416
  updateOrderingStoreConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateOrderingStoreConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DeploymentMeta>;
417
417
  }