@gofynd/fdk-client-javascript 1.4.3 → 1.4.5

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 (125) hide show
  1. package/README.md +1 -10
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +48 -48
  4. package/sdk/application/Cart/CartApplicationClient.js +48 -48
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +69 -69
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
  7. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  8. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  9. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
  10. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  11. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -32
  12. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +45 -45
  14. package/sdk/application/Content/ContentApplicationClient.js +45 -45
  15. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +5 -5
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
  17. package/sdk/application/Lead/LeadApplicationClient.d.ts +9 -9
  18. package/sdk/application/Lead/LeadApplicationClient.js +9 -9
  19. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -22
  20. package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
  21. package/sdk/application/Order/OrderApplicationClient.d.ts +14 -25
  22. package/sdk/application/Order/OrderApplicationClient.js +14 -94
  23. package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -15
  24. package/sdk/application/Order/OrderApplicationValidator.js +0 -13
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +71 -71
  26. package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +1 -1
  30. package/sdk/application/Share/ShareApplicationClient.js +1 -1
  31. package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
  32. package/sdk/application/Share/ShareApplicationModel.js +2 -0
  33. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  34. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  35. package/sdk/application/User/UserApplicationClient.d.ts +74 -74
  36. package/sdk/application/User/UserApplicationClient.js +74 -74
  37. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +5 -5
  38. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
  39. package/sdk/platform/Billing/BillingPlatformClient.d.ts +13 -13
  40. package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
  41. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +102 -102
  42. package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
  43. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +132 -131
  44. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
  45. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +130 -130
  46. package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
  47. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
  48. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  49. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +118 -118
  50. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
  51. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  52. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  53. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +22 -22
  54. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
  55. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +34 -7
  56. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +35 -5
  57. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +4 -4
  58. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +4 -4
  59. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +41 -41
  60. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
  61. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +26 -26
  62. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
  63. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +93 -93
  64. package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
  65. package/sdk/platform/Content/ContentPlatformClient.d.ts +29 -29
  66. package/sdk/platform/Content/ContentPlatformClient.js +29 -29
  67. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +18 -18
  68. package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
  69. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -17
  70. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
  71. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
  72. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
  73. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
  74. package/sdk/platform/Finance/FinancePlatformClient.d.ts +4 -4
  75. package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
  76. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
  77. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  78. package/sdk/platform/Lead/LeadPlatformClient.d.ts +15 -15
  79. package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
  80. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
  81. package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
  82. package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -106
  83. package/sdk/platform/Order/OrderPlatformClient.js +95 -190
  84. package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
  85. package/sdk/platform/Order/OrderPlatformModel.js +4 -0
  86. package/sdk/platform/Order/OrderPlatformValidator.d.ts +1 -33
  87. package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
  88. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
  89. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  90. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +77 -77
  91. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
  92. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +2 -2
  93. package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
  94. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
  95. package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
  96. package/sdk/platform/PlatformClient.d.ts +0 -2
  97. package/sdk/platform/PlatformClient.js +0 -4
  98. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +7 -7
  99. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
  100. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +40 -40
  101. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
  102. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +51 -50
  103. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
  104. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
  105. package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
  106. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
  107. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  108. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +34 -104
  109. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
  110. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +1 -100
  111. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
  112. package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
  113. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  114. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -35
  115. package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
  116. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +7 -6
  117. package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
  118. package/sdk/platform/index.d.ts +0 -1
  119. package/sdk/platform/index.js +0 -2
  120. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
  121. package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
  122. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
  123. package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
  124. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
  125. package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
@@ -12,7 +12,7 @@ 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
  }
@@ -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,7 +198,7 @@ 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>;
@@ -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(
@@ -185,7 +185,21 @@ export = CompanyProfilePlatformModel;
185
185
  * @property {string} [description]
186
186
  */
187
187
  /**
188
- * @typedef CreateUpdateBrandRequestSerializer
188
+ * @typedef CreateBrandRequestSerializer
189
+ * @property {Object} [_custom_json]
190
+ * @property {Object} [_locale_language]
191
+ * @property {string[]} [synonyms]
192
+ * @property {number} [company_id]
193
+ * @property {string} [description]
194
+ * @property {string} logo
195
+ * @property {string} [brand_tier]
196
+ * @property {number} [uid]
197
+ * @property {BrandBannerSerializer} banner
198
+ * @property {string} name
199
+ * @property {string} [slug_key]
200
+ */
201
+ /**
202
+ * @typedef UpdateBrandRequestSerializer
189
203
  * @property {Object} [_custom_json]
190
204
  * @property {Object} [_locale_language]
191
205
  * @property {string[]} [synonyms]
@@ -196,7 +210,6 @@ export = CompanyProfilePlatformModel;
196
210
  * @property {number} [uid]
197
211
  * @property {BrandBannerSerializer} banner
198
212
  * @property {string} name
199
- * @property {string} [slug]
200
213
  */
201
214
  /**
202
215
  * @typedef CompanySocialAccounts
@@ -431,7 +444,7 @@ export = CompanyProfilePlatformModel;
431
444
  declare class CompanyProfilePlatformModel {
432
445
  }
433
446
  declare namespace CompanyProfilePlatformModel {
434
- export { CompanyTaxesSerializer, UserSerializer, Website, BusinessDetails, SellerPhoneNumber, ContactDetails, CountryCurrencyInfo, BusinessCountryInfo, Document, GetAddressSerializer, GetCompanyProfileSerializerResponse, ErrorResponse, CompanyTaxesSerializer1, CreateUpdateAddressSerializer, UpdateCompany, ProfileSuccessResponse, DocumentsObj, MetricsSerializer, BrandBannerSerializer, GetBrandResponseSerializer, CreateUpdateBrandRequestSerializer, CompanySocialAccounts, CompanyDetails, CompanySerializer, CompanyBrandSerializer, Page, CompanyBrandListSerializer, CompanyBrandPostRequestSerializer, InvoiceCredSerializer, InvoiceDetailsSerializer, GetCompanySerializer, LocationManagerSerializer, LocationTimingSerializer, LocationDayWiseSerializer, HolidayDateSerializer, HolidaySchemaSerializer, ProductReturnConfigSerializer, GetLocationSerializer, LocationListSerializer, AddressSerializer, LocationSerializer, BulkLocationSerializer, AverageOrderProcessingTime, StoreTagsResponseSchema };
447
+ export { CompanyTaxesSerializer, UserSerializer, Website, BusinessDetails, SellerPhoneNumber, ContactDetails, CountryCurrencyInfo, BusinessCountryInfo, Document, GetAddressSerializer, GetCompanyProfileSerializerResponse, ErrorResponse, CompanyTaxesSerializer1, CreateUpdateAddressSerializer, UpdateCompany, ProfileSuccessResponse, DocumentsObj, MetricsSerializer, BrandBannerSerializer, GetBrandResponseSerializer, CreateBrandRequestSerializer, UpdateBrandRequestSerializer, CompanySocialAccounts, CompanyDetails, CompanySerializer, CompanyBrandSerializer, Page, CompanyBrandListSerializer, CompanyBrandPostRequestSerializer, InvoiceCredSerializer, InvoiceDetailsSerializer, GetCompanySerializer, LocationManagerSerializer, LocationTimingSerializer, LocationDayWiseSerializer, HolidayDateSerializer, HolidaySchemaSerializer, ProductReturnConfigSerializer, GetLocationSerializer, LocationListSerializer, AddressSerializer, LocationSerializer, BulkLocationSerializer, AverageOrderProcessingTime, StoreTagsResponseSchema };
435
448
  }
436
449
  /** @returns {CompanyTaxesSerializer} */
437
450
  declare function CompanyTaxesSerializer(): CompanyTaxesSerializer;
@@ -638,9 +651,24 @@ type GetBrandResponseSerializer = {
638
651
  logo?: string;
639
652
  description?: string;
640
653
  };
641
- /** @returns {CreateUpdateBrandRequestSerializer} */
642
- declare function CreateUpdateBrandRequestSerializer(): CreateUpdateBrandRequestSerializer;
643
- type CreateUpdateBrandRequestSerializer = {
654
+ /** @returns {CreateBrandRequestSerializer} */
655
+ declare function CreateBrandRequestSerializer(): CreateBrandRequestSerializer;
656
+ type CreateBrandRequestSerializer = {
657
+ _custom_json?: any;
658
+ _locale_language?: any;
659
+ synonyms?: string[];
660
+ company_id?: number;
661
+ description?: string;
662
+ logo: string;
663
+ brand_tier?: string;
664
+ uid?: number;
665
+ banner: BrandBannerSerializer;
666
+ name: string;
667
+ slug_key?: string;
668
+ };
669
+ /** @returns {UpdateBrandRequestSerializer} */
670
+ declare function UpdateBrandRequestSerializer(): UpdateBrandRequestSerializer;
671
+ type UpdateBrandRequestSerializer = {
644
672
  _custom_json?: any;
645
673
  _locale_language?: any;
646
674
  synonyms?: string[];
@@ -651,7 +679,6 @@ type CreateUpdateBrandRequestSerializer = {
651
679
  uid?: number;
652
680
  banner: BrandBannerSerializer;
653
681
  name: string;
654
- slug?: string;
655
682
  };
656
683
  /** @returns {CompanySocialAccounts} */
657
684
  declare function CompanySocialAccounts(): CompanySocialAccounts;
@@ -206,7 +206,22 @@ const Joi = require("joi");
206
206
  */
207
207
 
208
208
  /**
209
- * @typedef CreateUpdateBrandRequestSerializer
209
+ * @typedef CreateBrandRequestSerializer
210
+ * @property {Object} [_custom_json]
211
+ * @property {Object} [_locale_language]
212
+ * @property {string[]} [synonyms]
213
+ * @property {number} [company_id]
214
+ * @property {string} [description]
215
+ * @property {string} logo
216
+ * @property {string} [brand_tier]
217
+ * @property {number} [uid]
218
+ * @property {BrandBannerSerializer} banner
219
+ * @property {string} name
220
+ * @property {string} [slug_key]
221
+ */
222
+
223
+ /**
224
+ * @typedef UpdateBrandRequestSerializer
210
225
  * @property {Object} [_custom_json]
211
226
  * @property {Object} [_locale_language]
212
227
  * @property {string[]} [synonyms]
@@ -217,7 +232,6 @@ const Joi = require("joi");
217
232
  * @property {number} [uid]
218
233
  * @property {BrandBannerSerializer} banner
219
234
  * @property {string} name
220
- * @property {string} [slug]
221
235
  */
222
236
 
223
237
  /**
@@ -727,8 +741,25 @@ class CompanyProfilePlatformModel {
727
741
  });
728
742
  }
729
743
 
730
- /** @returns {CreateUpdateBrandRequestSerializer} */
731
- static CreateUpdateBrandRequestSerializer() {
744
+ /** @returns {CreateBrandRequestSerializer} */
745
+ static CreateBrandRequestSerializer() {
746
+ return Joi.object({
747
+ _custom_json: Joi.any(),
748
+ _locale_language: Joi.any(),
749
+ synonyms: Joi.array().items(Joi.string().allow("")),
750
+ company_id: Joi.number(),
751
+ description: Joi.string().allow(""),
752
+ logo: Joi.string().allow("").required(),
753
+ brand_tier: Joi.string().allow(""),
754
+ uid: Joi.number(),
755
+ banner: CompanyProfilePlatformModel.BrandBannerSerializer().required(),
756
+ name: Joi.string().allow("").required(),
757
+ slug_key: Joi.string().allow(""),
758
+ });
759
+ }
760
+
761
+ /** @returns {UpdateBrandRequestSerializer} */
762
+ static UpdateBrandRequestSerializer() {
732
763
  return Joi.object({
733
764
  _custom_json: Joi.any(),
734
765
  _locale_language: Joi.any(),
@@ -740,7 +771,6 @@ class CompanyProfilePlatformModel {
740
771
  uid: Joi.number(),
741
772
  banner: CompanyProfilePlatformModel.BrandBannerSerializer().required(),
742
773
  name: Joi.string().allow("").required(),
743
- slug: Joi.string().allow(""),
744
774
  });
745
775
  }
746
776
 
@@ -2,7 +2,7 @@ export = CompanyProfilePlatformValidator;
2
2
  /** @typedef CbsOnboardGetParam */
3
3
  /**
4
4
  * @typedef CreateBrandParam
5
- * @property {CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer} body
5
+ * @property {CompanyProfilePlatformModel.CreateBrandRequestSerializer} body
6
6
  */
7
7
  /**
8
8
  * @typedef CreateCompanyBrandMappingParam
@@ -19,7 +19,7 @@ export = CompanyProfilePlatformValidator;
19
19
  /**
20
20
  * @typedef EditBrandParam
21
21
  * @property {string} brandId - Id of the brand to be viewed.
22
- * @property {CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer} body
22
+ * @property {CompanyProfilePlatformModel.UpdateBrandRequestSerializer} body
23
23
  */
24
24
  /**
25
25
  * @typedef GetBrandParam
@@ -99,7 +99,7 @@ declare namespace CompanyProfilePlatformValidator {
99
99
  export { CbsOnboardGetParam, CreateBrandParam, CreateCompanyBrandMappingParam, CreateLocationParam, CreateLocationBulkParam, EditBrandParam, GetBrandParam, GetBrandsParam, GetCompanyMetricsParam, GetLocationDetailParam, GetLocationTagsParam, GetLocationsParam, UpdateCompanyParam, UpdateLocationParam };
100
100
  }
101
101
  type CreateBrandParam = {
102
- body: CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer;
102
+ body: CompanyProfilePlatformModel.CreateBrandRequestSerializer;
103
103
  };
104
104
  type CreateCompanyBrandMappingParam = {
105
105
  body: CompanyProfilePlatformModel.CompanyBrandPostRequestSerializer;
@@ -115,7 +115,7 @@ type EditBrandParam = {
115
115
  * - Id of the brand to be viewed.
116
116
  */
117
117
  brandId: string;
118
- body: CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer;
118
+ body: CompanyProfilePlatformModel.UpdateBrandRequestSerializer;
119
119
  };
120
120
  type GetBrandParam = {
121
121
  /**
@@ -6,7 +6,7 @@ const CompanyProfilePlatformModel = require("./CompanyProfilePlatformModel");
6
6
 
7
7
  /**
8
8
  * @typedef CreateBrandParam
9
- * @property {CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer} body
9
+ * @property {CompanyProfilePlatformModel.CreateBrandRequestSerializer} body
10
10
  */
11
11
 
12
12
  /**
@@ -27,7 +27,7 @@ const CompanyProfilePlatformModel = require("./CompanyProfilePlatformModel");
27
27
  /**
28
28
  * @typedef EditBrandParam
29
29
  * @property {string} brandId - Id of the brand to be viewed.
30
- * @property {CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer} body
30
+ * @property {CompanyProfilePlatformModel.UpdateBrandRequestSerializer} body
31
31
  */
32
32
 
33
33
  /**
@@ -91,7 +91,7 @@ class CompanyProfilePlatformValidator {
91
91
  /** @returns {CreateBrandParam} */
92
92
  static createBrand() {
93
93
  return Joi.object({
94
- body: CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer().required(),
94
+ body: CompanyProfilePlatformModel.CreateBrandRequestSerializer().required(),
95
95
  }).required();
96
96
  }
97
97
 
@@ -120,7 +120,7 @@ class CompanyProfilePlatformValidator {
120
120
  static editBrand() {
121
121
  return Joi.object({
122
122
  brandId: Joi.string().allow("").required(),
123
- body: CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer().required(),
123
+ body: CompanyProfilePlatformModel.UpdateBrandRequestSerializer().required(),
124
124
  }).required();
125
125
  }
126
126