@gofynd/fdk-client-javascript 1.4.3 → 1.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (193) hide show
  1. package/README.md +1 -10
  2. package/application.d.ts +3 -3
  3. package/common.d.ts +3 -3
  4. package/index.d.ts +15 -15
  5. package/package.json +1 -1
  6. package/partner.d.ts +3 -3
  7. package/platform.d.ts +3 -3
  8. package/public.d.ts +2 -2
  9. package/sdk/application/ApplicationAPIClient.d.ts +1 -1
  10. package/sdk/application/ApplicationClient.d.ts +17 -17
  11. package/sdk/application/ApplicationConfig.d.ts +3 -3
  12. package/sdk/application/Cart/CartApplicationClient.d.ts +50 -50
  13. package/sdk/application/Cart/CartApplicationClient.js +48 -48
  14. package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
  15. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
  16. package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
  18. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  19. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
  20. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  21. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  22. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
  23. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
  24. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
  25. package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
  26. package/sdk/application/Content/ContentApplicationClient.js +45 -45
  27. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
  28. package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
  29. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  30. package/sdk/application/Lead/LeadApplicationClient.d.ts +11 -11
  31. package/sdk/application/Lead/LeadApplicationClient.js +9 -9
  32. package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
  33. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
  34. package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
  35. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
  36. package/sdk/application/Order/OrderApplicationClient.d.ts +16 -27
  37. package/sdk/application/Order/OrderApplicationClient.js +14 -94
  38. package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
  39. package/sdk/application/Order/OrderApplicationValidator.js +0 -13
  40. package/sdk/application/Payment/PaymentApplicationClient.d.ts +73 -73
  41. package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
  42. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +1 -1
  43. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +2 -2
  44. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
  45. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +3 -3
  46. package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
  47. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
  48. package/sdk/application/Share/ShareApplicationClient.d.ts +3 -3
  49. package/sdk/application/Share/ShareApplicationClient.js +1 -1
  50. package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
  51. package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
  52. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  53. package/sdk/application/User/UserApplicationClient.d.ts +76 -76
  54. package/sdk/application/User/UserApplicationClient.js +74 -74
  55. package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
  56. package/sdk/application/index.d.ts +18 -18
  57. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +1 -1
  58. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  59. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +1 -1
  60. package/sdk/partner/OAuthClient.d.ts +4 -4
  61. package/sdk/partner/PartnerAPIClient.d.ts +1 -1
  62. package/sdk/partner/PartnerClient.d.ts +6 -6
  63. package/sdk/partner/PartnerConfig.d.ts +4 -4
  64. package/sdk/partner/Theme/ThemePartnerClient.d.ts +1 -1
  65. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +1 -1
  66. package/sdk/partner/index.d.ts +7 -7
  67. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +7 -7
  68. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  70. package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
  71. package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
  72. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
  73. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +104 -104
  74. package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
  75. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
  76. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +135 -134
  77. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
  78. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
  79. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +133 -133
  80. package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
  81. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
  82. package/sdk/platform/Common/CommonPlatformClient.d.ts +4 -4
  83. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  84. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +120 -120
  85. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
  86. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
  87. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -3
  88. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  89. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +25 -25
  90. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
  91. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
  92. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +43 -43
  93. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
  94. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
  95. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +28 -28
  96. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
  97. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
  98. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +96 -96
  99. package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
  100. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -1
  101. package/sdk/platform/Content/ContentPlatformClient.d.ts +31 -31
  102. package/sdk/platform/Content/ContentPlatformClient.js +29 -29
  103. package/sdk/platform/Content/ContentPlatformValidator.d.ts +1 -1
  104. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +20 -20
  105. package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
  106. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
  107. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -19
  108. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
  109. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  110. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  111. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
  112. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
  113. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
  114. package/sdk/platform/Finance/FinancePlatformClient.d.ts +6 -6
  115. package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
  116. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
  117. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +14 -14
  118. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  119. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
  120. package/sdk/platform/Lead/LeadPlatformClient.d.ts +17 -17
  121. package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
  122. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
  123. package/sdk/platform/OAuthClient.d.ts +3 -3
  124. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
  125. package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
  126. package/sdk/platform/Order/OrderPlatformClient.d.ts +97 -108
  127. package/sdk/platform/Order/OrderPlatformClient.js +95 -190
  128. package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
  129. package/sdk/platform/Order/OrderPlatformModel.js +4 -0
  130. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
  131. package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
  132. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
  133. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  134. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
  135. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +79 -79
  136. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
  137. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
  138. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +4 -4
  139. package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
  140. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
  141. package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
  142. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
  143. package/sdk/platform/PlatformAPIClient.d.ts +1 -1
  144. package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
  145. package/sdk/platform/PlatformClient.d.ts +19 -21
  146. package/sdk/platform/PlatformClient.js +0 -4
  147. package/sdk/platform/PlatformConfig.d.ts +4 -4
  148. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +9 -9
  149. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
  150. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
  151. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
  152. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
  153. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
  154. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +53 -52
  155. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
  156. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
  157. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +3 -3
  158. package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
  159. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  160. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
  161. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  162. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -106
  163. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
  164. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
  165. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
  166. package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
  167. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  168. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
  169. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
  170. package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
  171. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
  172. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -8
  173. package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
  174. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
  175. package/sdk/platform/index.d.ts +24 -25
  176. package/sdk/platform/index.js +0 -2
  177. package/sdk/public/Billing/BillingPublicClient.d.ts +2 -2
  178. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  179. package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
  180. package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
  181. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
  182. package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
  183. package/sdk/public/PublicAPIClient.d.ts +1 -1
  184. package/sdk/public/PublicClient.d.ts +7 -7
  185. package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
  186. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
  187. package/sdk/public/index.d.ts +8 -8
  188. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
  189. package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
  190. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
  191. package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
  192. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
  193. package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
@@ -828,4 +828,4 @@ type GetSystemAudiencesParam = any;
828
828
  type GetSystemEmailTemplatesParam = any;
829
829
  type GetSystemSmsTemplatesParam = any;
830
830
  type UpdateOtpConfigurationParam = any;
831
- import CommunicationPlatformModel = require("./CommunicationPlatformModel");
831
+ import CommunicationPlatformModel = require("sdk/output/javascript/code/sdk/platform/Communication/CommunicationPlatformModel");
@@ -12,9 +12,9 @@ declare class Communication {
12
12
  * Success response
13
13
  * @name getSystemNotifications
14
14
  * @summary: Get system notifications
15
- * @description: Retrieve system notifications related to communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemNotifications/).
15
+ * @description: Retrieves a list of system notifications. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemNotifications/).
16
16
  */
17
17
  getSystemNotifications({ pageNo, pageSize, requestHeaders }?: CommunicationPlatformValidator.GetSystemNotificationsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemNotifications>;
18
18
  }
19
- import CommunicationPlatformValidator = require("./CommunicationPlatformValidator");
20
- import CommunicationPlatformModel = require("./CommunicationPlatformModel");
19
+ import CommunicationPlatformValidator = require("sdk/output/javascript/code/sdk/platform/Communication/CommunicationPlatformValidator");
20
+ import CommunicationPlatformModel = require("sdk/output/javascript/code/sdk/platform/Communication/CommunicationPlatformModel");
@@ -24,7 +24,7 @@ class Communication {
24
24
  * Success response
25
25
  * @name getSystemNotifications
26
26
  * @summary: Get system notifications
27
- * @description: Retrieve system notifications related to communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemNotifications/).
27
+ * @description: Retrieves a list of system notifications. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemNotifications/).
28
28
  */
29
29
  async getSystemNotifications(
30
30
  { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -10,7 +10,7 @@ declare class CompanyProfile {
10
10
  * - Success response
11
11
  *
12
12
  * @name cbsOnboardGet
13
- * @summary: Get company onboard data
13
+ * @summary: Get company profile
14
14
  * @description: View the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/cbsOnboardGet/).
15
15
  */
16
16
  cbsOnboardGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponse>;
@@ -45,8 +45,8 @@ declare class CompanyProfile {
45
45
  * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
46
46
  * Success response
47
47
  * @name createLocation
48
- * @summary: Create location
49
- * @description: Create a new location. Allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocation/).
48
+ * @summary: Create company stores
49
+ * @description: Create a new location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocation/).
50
50
  */
51
51
  createLocation({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
52
52
  /**
@@ -56,8 +56,8 @@ declare class CompanyProfile {
56
56
  * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
57
57
  * Success response
58
58
  * @name createLocationBulk
59
- * @summary: Create locations in bulk
60
- * @description: Allows to create a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocationBulk/).
59
+ * @summary: Bulk create company stores
60
+ * @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/).
61
61
  */
62
62
  createLocationBulk({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationBulkParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
63
63
  /**
@@ -67,8 +67,8 @@ declare class CompanyProfile {
67
67
  * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
68
68
  * Success response
69
69
  * @name editBrand
70
- * @summary: Edit brand details
71
- * @description: Modify details and settings of a specific brand. Allows to edit meta of a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/editBrand/).
70
+ * @summary: update brand
71
+ * @description: Modify brand details and meta of a specific brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/editBrand/).
72
72
  */
73
73
  editBrand({ brandId, body, requestHeaders }?: CompanyProfilePlatformValidator.EditBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
74
74
  /**
@@ -79,8 +79,8 @@ declare class CompanyProfile {
79
79
  * - Success response
80
80
  *
81
81
  * @name getBrand
82
- * @summary: Get brand details
83
- * @description: Retrieve detailed information about a specific brand. Get data associated to a particular company brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrand/).
82
+ * @summary: Get a brand
83
+ * @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/).
84
84
  */
85
85
  getBrand({ brandId, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetBrandResponseSerializer>;
86
86
  /**
@@ -91,8 +91,8 @@ declare class CompanyProfile {
91
91
  * - Success response
92
92
  *
93
93
  * @name getBrands
94
- * @summary: Get brands
95
- * @description: Retrieve a list of available brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrands/).
94
+ * @summary: list company brands
95
+ * @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/).
96
96
  */
97
97
  getBrands({ pageNo, pageSize, q, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.CompanyBrandListSerializer>;
98
98
  /**
@@ -101,8 +101,8 @@ declare class CompanyProfile {
101
101
  * page. Default is 10.
102
102
  * @param {string} [arg.q] - Search term for name.
103
103
  * @returns {Paginator<CompanyProfilePlatformModel.CompanyBrandListSerializer>}
104
- * @summary: Get brands
105
- * @description: Retrieve a list of available brands.
104
+ * @summary: list company brands
105
+ * @description: Retrieve a list of available brands associated to a company.
106
106
  */
107
107
  getBrandsPaginator({ pageSize, q }?: {
108
108
  pageSize?: number;
@@ -116,7 +116,7 @@ declare class CompanyProfile {
116
116
  * Success response
117
117
  * @name getCompanyMetrics
118
118
  * @summary: Get company metrics
119
- * @description: Allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getCompanyMetrics/).
119
+ * @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/).
120
120
  */
121
121
  getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.MetricsSerializer>;
122
122
  /**
@@ -126,8 +126,8 @@ declare class CompanyProfile {
126
126
  * @returns {Promise<CompanyProfilePlatformModel.GetLocationSerializer>} -
127
127
  * Success response
128
128
  * @name getLocationDetail
129
- * @summary: Get location detail
130
- * @description: Retrieve detailed information about a specific location. Get data associated to a specific location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationDetail/).
129
+ * @summary: Get company stores
130
+ * @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/).
131
131
  */
132
132
  getLocationDetail({ locationId, requestHeaders }?: CompanyProfilePlatformValidator.GetLocationDetailParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetLocationSerializer>;
133
133
  /**
@@ -138,8 +138,8 @@ declare class CompanyProfile {
138
138
  * - Success response
139
139
  *
140
140
  * @name getLocationTags
141
- * @summary: Get location tags
142
- * @description: Retrieve all the tags associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationTags/).
141
+ * @summary: Get company store tags
142
+ * @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/).
143
143
  */
144
144
  getLocationTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.StoreTagsResponseSchema>;
145
145
  /**
@@ -149,7 +149,7 @@ declare class CompanyProfile {
149
149
  * @returns {Promise<CompanyProfilePlatformModel.LocationListSerializer>} -
150
150
  * Success response
151
151
  * @name getLocations
152
- * @summary: Get company locations
152
+ * @summary: Get company specific stores
153
153
  * @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocations/).
154
154
  */
155
155
  getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, types, tags, requestHeaders, }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.LocationListSerializer>;
@@ -168,7 +168,7 @@ declare class CompanyProfile {
168
168
  * @param {string[]} [arg.tags] - Helps to get the location list on the
169
169
  * basis of multiple location tag.
170
170
  * @returns {Paginator<CompanyProfilePlatformModel.LocationListSerializer>}
171
- * @summary: Get company locations
171
+ * @summary: Get company specific stores
172
172
  * @description: Retrieve a list of locations associated with the company.
173
173
  */
174
174
  getLocationsPaginator({ storeType, q, stage, pageSize, locationIds, types, tags, }?: {
@@ -187,7 +187,7 @@ declare class CompanyProfile {
187
187
  * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
188
188
  * Success response
189
189
  * @name updateCompany
190
- * @summary: Update company information
190
+ * @summary: Update company profile
191
191
  * @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/).
192
192
  */
193
193
  updateCompany({ body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateCompanyParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
@@ -198,11 +198,11 @@ declare class CompanyProfile {
198
198
  * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
199
199
  * Success response
200
200
  * @name updateLocation
201
- * @summary: Update location
201
+ * @summary: Update company stores
202
202
  * @description: Allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateLocation/).
203
203
  */
204
204
  updateLocation({ locationId, body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
205
205
  }
206
- import CompanyProfilePlatformModel = require("./CompanyProfilePlatformModel");
207
- import CompanyProfilePlatformValidator = require("./CompanyProfilePlatformValidator");
208
- import Paginator = require("../../common/Paginator");
206
+ import CompanyProfilePlatformModel = require("sdk/output/javascript/code/sdk/platform/CompanyProfile/CompanyProfilePlatformModel");
207
+ import CompanyProfilePlatformValidator = require("sdk/output/javascript/code/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator");
208
+ import Paginator = require("sdk/output/javascript/code/sdk/common/Paginator");
@@ -22,7 +22,7 @@ class CompanyProfile {
22
22
  * - Success response
23
23
  *
24
24
  * @name cbsOnboardGet
25
- * @summary: Get company onboard data
25
+ * @summary: Get company profile
26
26
  * @description: View the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/cbsOnboardGet/).
27
27
  */
28
28
  async cbsOnboardGet(
@@ -262,8 +262,8 @@ class CompanyProfile {
262
262
  * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
263
263
  * Success response
264
264
  * @name createLocation
265
- * @summary: Create location
266
- * @description: Create a new location. Allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocation/).
265
+ * @summary: Create company stores
266
+ * @description: Create a new location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocation/).
267
267
  */
268
268
  async createLocation(
269
269
  { body, requestHeaders } = { requestHeaders: {} },
@@ -342,8 +342,8 @@ class CompanyProfile {
342
342
  * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
343
343
  * Success response
344
344
  * @name createLocationBulk
345
- * @summary: Create locations in bulk
346
- * @description: Allows to create a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocationBulk/).
345
+ * @summary: Bulk create company stores
346
+ * @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/).
347
347
  */
348
348
  async createLocationBulk(
349
349
  { body, requestHeaders } = { requestHeaders: {} },
@@ -424,8 +424,8 @@ class CompanyProfile {
424
424
  * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
425
425
  * Success response
426
426
  * @name editBrand
427
- * @summary: Edit brand details
428
- * @description: Modify details and settings of a specific brand. Allows to edit meta of a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/editBrand/).
427
+ * @summary: update brand
428
+ * @description: Modify brand details and meta of a specific brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/editBrand/).
429
429
  */
430
430
  async editBrand(
431
431
  { brandId, body, requestHeaders } = { requestHeaders: {} },
@@ -507,8 +507,8 @@ class CompanyProfile {
507
507
  * - Success response
508
508
  *
509
509
  * @name getBrand
510
- * @summary: Get brand details
511
- * @description: Retrieve detailed information about a specific brand. Get data associated to a particular company brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrand/).
510
+ * @summary: Get a brand
511
+ * @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/).
512
512
  */
513
513
  async getBrand(
514
514
  { brandId, requestHeaders } = { requestHeaders: {} },
@@ -588,8 +588,8 @@ class CompanyProfile {
588
588
  * - Success response
589
589
  *
590
590
  * @name getBrands
591
- * @summary: Get brands
592
- * @description: Retrieve a list of available brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrands/).
591
+ * @summary: list company brands
592
+ * @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/).
593
593
  */
594
594
  async getBrands(
595
595
  { pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
@@ -674,8 +674,8 @@ class CompanyProfile {
674
674
  * page. Default is 10.
675
675
  * @param {string} [arg.q] - Search term for name.
676
676
  * @returns {Paginator<CompanyProfilePlatformModel.CompanyBrandListSerializer>}
677
- * @summary: Get brands
678
- * @description: Retrieve a list of available brands.
677
+ * @summary: list company brands
678
+ * @description: Retrieve a list of available brands associated to a company.
679
679
  */
680
680
  getBrandsPaginator({ pageSize, q } = {}) {
681
681
  const paginator = new Paginator();
@@ -706,7 +706,7 @@ class CompanyProfile {
706
706
  * Success response
707
707
  * @name getCompanyMetrics
708
708
  * @summary: Get company metrics
709
- * @description: Allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getCompanyMetrics/).
709
+ * @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/).
710
710
  */
711
711
  async getCompanyMetrics(
712
712
  { requestHeaders } = { requestHeaders: {} },
@@ -783,8 +783,8 @@ class CompanyProfile {
783
783
  * @returns {Promise<CompanyProfilePlatformModel.GetLocationSerializer>} -
784
784
  * Success response
785
785
  * @name getLocationDetail
786
- * @summary: Get location detail
787
- * @description: Retrieve detailed information about a specific location. Get data associated to a specific location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationDetail/).
786
+ * @summary: Get company stores
787
+ * @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/).
788
788
  */
789
789
  async getLocationDetail(
790
790
  { locationId, requestHeaders } = { requestHeaders: {} },
@@ -866,8 +866,8 @@ class CompanyProfile {
866
866
  * - Success response
867
867
  *
868
868
  * @name getLocationTags
869
- * @summary: Get location tags
870
- * @description: Retrieve all the tags associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationTags/).
869
+ * @summary: Get company store tags
870
+ * @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/).
871
871
  */
872
872
  async getLocationTags(
873
873
  { requestHeaders } = { requestHeaders: {} },
@@ -944,7 +944,7 @@ class CompanyProfile {
944
944
  * @returns {Promise<CompanyProfilePlatformModel.LocationListSerializer>} -
945
945
  * Success response
946
946
  * @name getLocations
947
- * @summary: Get company locations
947
+ * @summary: Get company specific stores
948
948
  * @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocations/).
949
949
  */
950
950
  async getLocations(
@@ -1064,7 +1064,7 @@ class CompanyProfile {
1064
1064
  * @param {string[]} [arg.tags] - Helps to get the location list on the
1065
1065
  * basis of multiple location tag.
1066
1066
  * @returns {Paginator<CompanyProfilePlatformModel.LocationListSerializer>}
1067
- * @summary: Get company locations
1067
+ * @summary: Get company specific stores
1068
1068
  * @description: Retrieve a list of locations associated with the company.
1069
1069
  */
1070
1070
  getLocationsPaginator({
@@ -1108,7 +1108,7 @@ class CompanyProfile {
1108
1108
  * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
1109
1109
  * Success response
1110
1110
  * @name updateCompany
1111
- * @summary: Update company information
1111
+ * @summary: Update company profile
1112
1112
  * @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/).
1113
1113
  */
1114
1114
  async updateCompany(
@@ -1188,7 +1188,7 @@ class CompanyProfile {
1188
1188
  * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
1189
1189
  * Success response
1190
1190
  * @name updateLocation
1191
- * @summary: Update location
1191
+ * @summary: Update company stores
1192
1192
  * @description: Allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateLocation/).
1193
1193
  */
1194
1194
  async updateLocation(
@@ -198,4 +198,4 @@ type UpdateLocationParam = {
198
198
  type CbsOnboardGetParam = any;
199
199
  type GetCompanyMetricsParam = any;
200
200
  type GetLocationTagsParam = any;
201
- import CompanyProfilePlatformModel = require("./CompanyProfilePlatformModel");
201
+ import CompanyProfilePlatformModel = require("sdk/output/javascript/code/sdk/platform/CompanyProfile/CompanyProfilePlatformModel");
@@ -9,8 +9,8 @@ declare class Configuration {
9
9
  * @param {import("../PlatformAPIClient").Options} - Options
10
10
  * @returns {Promise<ConfigurationPlatformModel.Domain>} - Success response
11
11
  * @name addDomain
12
- * @summary: Add domain
13
- * @description: Add a new domain. Add a new domain to current sales channel, including pre-defined domain (free domain) or custom domain (owned by the brand) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/addDomain/).
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/).
14
14
  */
15
15
  addDomain({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.AddDomainParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.Domain>;
16
16
  /**
@@ -21,7 +21,7 @@ declare class Configuration {
21
21
  * @param {import("../PlatformAPIClient").Options} - Options
22
22
  * @returns {Promise<ConfigurationPlatformModel.DomainsResponse>} - Success response
23
23
  * @name changeDomainType
24
- * @summary: Change domain type
24
+ * @summary: Update domain
25
25
  * @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
26
  */
27
27
  changeDomainType({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.ChangeDomainTypeParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainsResponse>;
@@ -33,7 +33,7 @@ declare class Configuration {
33
33
  * @param {import("../PlatformAPIClient").Options} - Options
34
34
  * @returns {Promise<ConfigurationPlatformModel.TokenResponse>} - Success response
35
35
  * @name getAppApiTokens
36
- * @summary: Get application API tokens
36
+ * @summary: Get sales channel API tokens
37
37
  * @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/).
38
38
  */
39
39
  getAppApiTokens({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.TokenResponse>;
@@ -45,7 +45,7 @@ declare class Configuration {
45
45
  * @param {import("../PlatformAPIClient").Options} - Options
46
46
  * @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
47
47
  * @name getAppBasicDetails
48
- * @summary: Get application basic details
48
+ * @summary: Get sales channel
49
49
  * @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/).
50
50
  */
51
51
  getAppBasicDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationDetail>;
@@ -57,8 +57,8 @@ declare class Configuration {
57
57
  * @param {import("../PlatformAPIClient").Options} - Options
58
58
  * @returns {Promise<ConfigurationPlatformModel.CompaniesResponse>} - Success response
59
59
  * @name getAppCompanies
60
- * @summary: Get application companies
61
- * @description: Retrieve info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCompanies/).
60
+ * @summary: List sales channel companies
61
+ * @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/).
62
62
  */
63
63
  getAppCompanies({ uid, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetAppCompaniesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CompaniesResponse>;
64
64
  /**
@@ -70,8 +70,8 @@ declare class Configuration {
70
70
  * @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
71
71
  * Success response
72
72
  * @name getAppContactInfo
73
- * @summary: Get application contact information
74
- * @description: Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppContactInfo/).
73
+ * @summary: Get sales channel contact
74
+ * @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/).
75
75
  */
76
76
  getAppContactInfo({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInformation>;
77
77
  /**
@@ -83,8 +83,8 @@ declare class Configuration {
83
83
  * @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
84
84
  * Success response
85
85
  * @name getAppCurrencyConfig
86
- * @summary: Get application currency configuration
87
- * @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 application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCurrencyConfig/).
86
+ * @summary: Get sales channel currency configuration
87
+ * @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/).
88
88
  */
89
89
  getAppCurrencyConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppSupportedCurrency>;
90
90
  /**
@@ -96,7 +96,7 @@ declare class Configuration {
96
96
  * @returns {Promise<ConfigurationPlatformModel.AppFeatureResponse>} -
97
97
  * Success response
98
98
  * @name getAppFeatures
99
- * @summary: Get application features
99
+ * @summary: Get sales channel
100
100
  * @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/).
101
101
  */
102
102
  getAppFeatures({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppFeatureResponse>;
@@ -108,8 +108,8 @@ declare class Configuration {
108
108
  * @param {import("../PlatformAPIClient").Options} - Options
109
109
  * @returns {Promise<ConfigurationPlatformModel.StoresResponse>} - Success response
110
110
  * @name getAppStores
111
- * @summary: Get application stores
112
- * @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 application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppStores/).
111
+ * @summary: list sales channel stores
112
+ * @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/).
113
113
  */
114
114
  getAppStores({ pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetAppStoresParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.StoresResponse>;
115
115
  /**
@@ -121,8 +121,8 @@ declare class Configuration {
121
121
  * @returns {Promise<ConfigurationPlatformModel.AppCurrencyResponse>} -
122
122
  * Success response
123
123
  * @name getAppSupportedCurrency
124
- * @summary: Get supported currencies
125
- * @description: Retrieve a list of supported currencies for the application. A list of currencies allowed in the current application. 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/).
124
+ * @summary: List supported currencies
125
+ * @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/).
126
126
  */
127
127
  getAppSupportedCurrency({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppCurrencyResponse>;
128
128
  /**
@@ -133,8 +133,8 @@ declare class Configuration {
133
133
  * @param {import("../PlatformAPIClient").Options} - Options
134
134
  * @returns {Promise<ConfigurationPlatformModel.ApplicationById>} - Success response
135
135
  * @name getApplicationById
136
- * @summary: Get application by ID
137
- * @description: Retrieve detailed information about a specific application. Use application 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/).
136
+ * @summary: Get sales channel by id
137
+ * @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/).
138
138
  */
139
139
  getApplicationById({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationById>;
140
140
  /**
@@ -146,7 +146,7 @@ declare class Configuration {
146
146
  * @returns {Promise<ConfigurationPlatformModel.MobileAppConfiguration>} -
147
147
  * Success response
148
148
  * @name getBuildConfig
149
- * @summary: Get build configuration
149
+ * @summary: Get Build Configuration
150
150
  * @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/).
151
151
  */
152
152
  getBuildConfig({ platformType, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetBuildConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.MobileAppConfiguration>;
@@ -169,8 +169,8 @@ declare class Configuration {
169
169
  * @param {import("../PlatformAPIClient").Options} - Options
170
170
  * @returns {Promise<ConfigurationPlatformModel.DomainsResponse>} - Success response
171
171
  * @name getDomains
172
- * @summary: Get domains
173
- * @description: Get list of domains. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomains/).
172
+ * @summary: List domains
173
+ * @description: Retrieve a list of existing domains by its sales channel id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomains/).
174
174
  */
175
175
  getDomains({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainsResponse>;
176
176
  /**
@@ -196,7 +196,7 @@ declare class Configuration {
196
196
  * Success response
197
197
  * @name getOrderingStoreConfig
198
198
  * @summary: Get ordering store configuration
199
- * @description: Retrieve configuration settings for ordering stores. Retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreConfig/).
199
+ * @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/).
200
200
  */
201
201
  getOrderingStoreConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStoreConfig>;
202
202
  /**
@@ -208,7 +208,7 @@ declare class Configuration {
208
208
  * @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
209
209
  * Success response
210
210
  * @name getOrderingStoreCookie
211
- * @summary: Get an Ordering Store signed cookie on selection of ordering store
211
+ * @summary: Get ordering store signed cookie
212
212
  * @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/).
213
213
  */
214
214
  getOrderingStoreCookie({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetOrderingStoreCookieParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
@@ -220,8 +220,8 @@ declare class Configuration {
220
220
  * @param {import("../PlatformAPIClient").Options} - Options
221
221
  * @returns {Promise<ConfigurationPlatformModel.OrderingStores>} - Success response
222
222
  * @name getOrderingStoresByFilter
223
- * @summary: Get ordering stores by filter
224
- * @description: Retrieve ordering stores based on specified filters. Use filters and retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoresByFilter/).
223
+ * @summary: List ordering stores
224
+ * @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/).
225
225
  */
226
226
  getOrderingStoresByFilter({ body, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetOrderingStoresByFilterParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStores>;
227
227
  /**
@@ -247,7 +247,7 @@ declare class Configuration {
247
247
  * Success response
248
248
  * @name getStaffOrderingStores
249
249
  * @summary: Get staff ordering stores
250
- * @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 application will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStaffOrderingStores/).
250
+ * @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/).
251
251
  */
252
252
  getStaffOrderingStores({ pageNo, pageSize, q, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetStaffOrderingStoresParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStoresResponse>;
253
253
  /**
@@ -258,8 +258,8 @@ declare class Configuration {
258
258
  * @param {import("../PlatformAPIClient").Options} - Options
259
259
  * @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
260
260
  * @name modifyAppFeatures
261
- * @summary: Modify application features
262
- * @description: Update features of application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/modifyAppFeatures/).
261
+ * @summary: update sales channel features
262
+ * @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/).
263
263
  */
264
264
  modifyAppFeatures({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.ModifyAppFeaturesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppFeature>;
265
265
  /**
@@ -272,7 +272,7 @@ declare class Configuration {
272
272
  * Success response
273
273
  * @name partiallyUpdateInventoryConfig
274
274
  * @summary: Partially update inventory configuration
275
- * @description: Partially update 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/).
275
+ * @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/).
276
276
  */
277
277
  partiallyUpdateInventoryConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.PartiallyUpdateInventoryConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInventory>;
278
278
  /**
@@ -284,8 +284,8 @@ declare class Configuration {
284
284
  * @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
285
285
  * Success response
286
286
  * @name removeDomainById
287
- * @summary: Remove domain by ID
288
- * @description: Delete a specific domain from the application. 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/).
287
+ * @summary: Remove domain
288
+ * @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/).
289
289
  */
290
290
  removeDomainById({ id, requestHeaders }?: ConfigurationPlatformApplicationValidator.RemoveDomainByIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
291
291
  /**
@@ -297,7 +297,7 @@ declare class Configuration {
297
297
  * @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
298
298
  * Success response
299
299
  * @name removeOrderingStoreCookie
300
- * @summary: Unset the Ordering Store signed cookie
300
+ * @summary: Delete Ordering Store signed cookie
301
301
  * @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/).
302
302
  */
303
303
  removeOrderingStoreCookie({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
@@ -309,8 +309,8 @@ declare class Configuration {
309
309
  * @param {import("../PlatformAPIClient").Options} - Options
310
310
  * @returns {Promise<ConfigurationPlatformModel.TokenResponse>} - Success response
311
311
  * @name updateAppApiTokens
312
- * @summary: Update application API tokens
313
- * @description: Add or 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/).
312
+ * @summary: Update sales channel API tokens
313
+ * @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/).
314
314
  */
315
315
  updateAppApiTokens({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppApiTokensParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.TokenResponse>;
316
316
  /**
@@ -321,7 +321,7 @@ declare class Configuration {
321
321
  * @param {import("../PlatformAPIClient").Options} - Options
322
322
  * @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
323
323
  * @name updateAppBasicDetails
324
- * @summary: Update application basic details
324
+ * @summary: Update sales channel basic details
325
325
  * @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/).
326
326
  */
327
327
  updateAppBasicDetails({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppBasicDetailsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationDetail>;
@@ -334,8 +334,8 @@ declare class Configuration {
334
334
  * @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
335
335
  * Success response
336
336
  * @name updateAppContactInfo
337
- * @summary: Update application contact information
338
- * @description: Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppContactInfo/).
337
+ * @summary: Update sales channel contact
338
+ * @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/).
339
339
  */
340
340
  updateAppContactInfo({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppContactInfoParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInformation>;
341
341
  /**
@@ -347,8 +347,8 @@ declare class Configuration {
347
347
  * @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
348
348
  * Success response
349
349
  * @name updateAppCurrencyConfig
350
- * @summary: Update application currency configuration
351
- * @description: Modify currency configuration settings for the application. Add and edit the currencies supported in the application. Initially, INR will be enabled by default. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppCurrencyConfig/).
350
+ * @summary: Update sales channel currency configuration
351
+ * @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/).
352
352
  */
353
353
  updateAppCurrencyConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppCurrencyConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppSupportedCurrency>;
354
354
  /**
@@ -359,7 +359,7 @@ declare class Configuration {
359
359
  * @param {import("../PlatformAPIClient").Options} - Options
360
360
  * @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
361
361
  * @name updateAppFeatures
362
- * @summary: Update application features
362
+ * @summary: Update sales channel
363
363
  * @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/).
364
364
  */
365
365
  updateAppFeatures({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppFeaturesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppFeature>;
@@ -398,9 +398,9 @@ declare class Configuration {
398
398
  * @returns {Promise<ConfigurationPlatformModel.DeploymentMeta>} - Success response
399
399
  * @name updateOrderingStoreConfig
400
400
  * @summary: Update ordering store configuration
401
- * @description: Modify configuration settings for ordering stores. Edit the details of the deployment stores (the selling locations where the application will be utilised for placing orders) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateOrderingStoreConfig/).
401
+ * @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/).
402
402
  */
403
403
  updateOrderingStoreConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateOrderingStoreConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DeploymentMeta>;
404
404
  }
405
- import ConfigurationPlatformApplicationValidator = require("./ConfigurationPlatformApplicationValidator");
406
- import ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
405
+ import ConfigurationPlatformApplicationValidator = require("sdk/output/javascript/code/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator");
406
+ import ConfigurationPlatformModel = require("sdk/output/javascript/code/sdk/platform/Configuration/ConfigurationPlatformModel");