@gofynd/fdk-client-javascript 1.4.2-beta.7 → 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 (254) 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 +5 -3
  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/ApplicationAPIClient.js +0 -1
  11. package/sdk/application/ApplicationClient.d.ts +17 -17
  12. package/sdk/application/ApplicationConfig.d.ts +3 -3
  13. package/sdk/application/Cart/CartApplicationClient.d.ts +58 -58
  14. package/sdk/application/Cart/CartApplicationClient.js +56 -56
  15. package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
  16. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
  17. package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
  18. package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
  19. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  20. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
  21. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  22. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  23. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
  24. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
  25. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
  26. package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
  27. package/sdk/application/Content/ContentApplicationClient.js +45 -45
  28. package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
  29. package/sdk/application/Content/ContentApplicationModel.js +26 -26
  30. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
  31. package/sdk/application/FileStorage/FileStorageApplicationClient.js +15 -9
  32. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  33. package/sdk/application/Lead/LeadApplicationClient.d.ts +12 -12
  34. package/sdk/application/Lead/LeadApplicationClient.js +10 -10
  35. package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
  36. package/sdk/application/Lead/LeadApplicationModel.js +42 -52
  37. package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
  38. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
  39. package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
  40. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
  41. package/sdk/application/Order/OrderApplicationClient.d.ts +19 -30
  42. package/sdk/application/Order/OrderApplicationClient.js +17 -97
  43. package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
  44. package/sdk/application/Order/OrderApplicationValidator.js +0 -13
  45. package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -91
  46. package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
  47. package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
  48. package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
  49. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +6 -6
  50. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  51. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +29 -29
  52. package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
  53. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
  54. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +9 -9
  55. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  56. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
  57. package/sdk/application/Share/ShareApplicationClient.d.ts +9 -9
  58. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  59. package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
  60. package/sdk/application/Share/ShareApplicationModel.js +2 -0
  61. package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
  62. package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
  63. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  64. package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
  65. package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
  66. package/sdk/application/User/UserApplicationClient.d.ts +76 -76
  67. package/sdk/application/User/UserApplicationClient.js +74 -74
  68. package/sdk/application/User/UserApplicationModel.d.ts +44 -13
  69. package/sdk/application/User/UserApplicationModel.js +17 -13
  70. package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
  71. package/sdk/application/index.d.ts +18 -18
  72. package/sdk/common/AxiosHelper.d.ts +1 -1
  73. package/sdk/common/AxiosHelper.js +38 -17
  74. package/sdk/common/Clickstream.js +22 -16
  75. package/sdk/common/curlHelper.js +1 -3
  76. package/sdk/common/utils.d.ts +15 -0
  77. package/sdk/common/utils.js +30 -0
  78. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +3 -3
  79. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
  80. package/sdk/partner/Lead/LeadPartnerClient.d.ts +3 -3
  81. package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
  82. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +5 -5
  83. package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
  84. package/sdk/partner/OAuthClient.d.ts +4 -4
  85. package/sdk/partner/PartnerAPIClient.d.ts +1 -1
  86. package/sdk/partner/PartnerAPIClient.js +0 -1
  87. package/sdk/partner/PartnerClient.d.ts +6 -6
  88. package/sdk/partner/PartnerConfig.d.ts +4 -4
  89. package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -20
  90. package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
  91. package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
  92. package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
  93. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +3 -3
  94. package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
  95. package/sdk/partner/index.d.ts +7 -7
  96. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
  97. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +6 -6
  98. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  99. package/sdk/platform/Billing/BillingPlatformClient.d.ts +25 -25
  100. package/sdk/platform/Billing/BillingPlatformClient.js +23 -23
  101. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
  102. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +115 -115
  103. package/sdk/platform/Cart/CartPlatformApplicationClient.js +113 -113
  104. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
  105. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +147 -146
  106. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +146 -145
  107. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
  108. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +156 -156
  109. package/sdk/platform/Catalog/CatalogPlatformClient.js +153 -153
  110. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
  111. package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
  112. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
  113. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -5
  114. package/sdk/platform/Common/CommonPlatformClient.js +3 -3
  115. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +133 -133
  116. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +131 -131
  117. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
  118. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +4 -4
  119. package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -2
  120. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
  121. package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
  122. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +28 -28
  123. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +25 -25
  124. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
  125. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
  126. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
  127. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -52
  128. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +50 -50
  129. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
  130. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +31 -31
  131. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +29 -29
  132. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
  133. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +128 -128
  134. package/sdk/platform/Content/ContentPlatformApplicationClient.js +131 -131
  135. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +5 -5
  136. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  137. package/sdk/platform/Content/ContentPlatformClient.d.ts +33 -33
  138. package/sdk/platform/Content/ContentPlatformClient.js +37 -37
  139. package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
  140. package/sdk/platform/Content/ContentPlatformModel.js +26 -26
  141. package/sdk/platform/Content/ContentPlatformValidator.d.ts +5 -5
  142. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  143. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +24 -24
  144. package/sdk/platform/Discount/DiscountPlatformClient.js +22 -22
  145. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
  146. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +24 -23
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +32 -25
  148. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  149. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +15 -15
  150. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +28 -19
  151. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
  152. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +16 -2
  153. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
  154. package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
  155. package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
  156. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
  157. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +19 -19
  158. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +17 -17
  159. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
  160. package/sdk/platform/Lead/LeadPlatformClient.d.ts +20 -20
  161. package/sdk/platform/Lead/LeadPlatformClient.js +18 -18
  162. package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
  163. package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
  164. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
  165. package/sdk/platform/OAuthClient.d.ts +3 -3
  166. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
  167. package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
  168. package/sdk/platform/Order/OrderPlatformClient.d.ts +111 -122
  169. package/sdk/platform/Order/OrderPlatformClient.js +109 -204
  170. package/sdk/platform/Order/OrderPlatformModel.d.ts +18 -2
  171. package/sdk/platform/Order/OrderPlatformModel.js +12 -2
  172. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
  173. package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
  174. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
  175. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  176. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
  177. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +97 -97
  178. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +95 -95
  179. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
  180. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +13 -13
  181. package/sdk/platform/Payment/PaymentPlatformClient.js +11 -11
  182. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
  183. package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
  184. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
  185. package/sdk/platform/PlatformAPIClient.d.ts +1 -1
  186. package/sdk/platform/PlatformAPIClient.js +0 -1
  187. package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
  188. package/sdk/platform/PlatformClient.d.ts +19 -21
  189. package/sdk/platform/PlatformClient.js +0 -4
  190. package/sdk/platform/PlatformConfig.d.ts +4 -4
  191. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +14 -14
  192. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
  193. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +55 -54
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +53 -52
  199. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
  200. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
  202. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
  203. package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
  204. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  205. package/sdk/platform/Share/SharePlatformModel.d.ts +4 -0
  206. package/sdk/platform/Share/SharePlatformModel.js +4 -0
  207. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +42 -112
  208. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +40 -597
  209. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
  210. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
  211. package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
  212. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  213. package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
  214. package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
  215. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
  216. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
  217. package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
  218. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
  219. package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
  220. package/sdk/platform/User/UserPlatformModel.js +21 -13
  221. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +20 -19
  222. package/sdk/platform/Webhook/WebhookPlatformClient.js +18 -17
  223. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
  224. package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
  225. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
  226. package/sdk/platform/index.d.ts +24 -25
  227. package/sdk/platform/index.js +0 -2
  228. package/sdk/public/Billing/BillingPublicClient.d.ts +3 -3
  229. package/sdk/public/Billing/BillingPublicClient.js +4 -4
  230. package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
  231. package/sdk/public/Billing/BillingPublicValidator.js +2 -2
  232. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -3
  233. package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
  234. package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
  235. package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
  236. package/sdk/public/Content/ContentPublicValidator.js +3 -3
  237. package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
  238. package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
  239. package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
  240. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
  241. package/sdk/public/Partner/PartnerPublicClient.d.ts +3 -3
  242. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  243. package/sdk/public/PublicAPIClient.d.ts +1 -1
  244. package/sdk/public/PublicClient.d.ts +7 -7
  245. package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
  246. package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
  247. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
  248. package/sdk/public/index.d.ts +8 -8
  249. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
  250. package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
  251. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
  252. package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
  253. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
  254. package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
@@ -174,8 +174,8 @@ export = ContentPlatformApplicationValidator;
174
174
  * @typedef GetAppCustomFieldDefinitionsParam
175
175
  * @property {string} pageNo
176
176
  * @property {string} pageSize
177
- * @property {string} [resources]
178
- * @property {string} [types]
177
+ * @property {string} [resource]
178
+ * @property {string} [type]
179
179
  * @property {string} [search]
180
180
  */
181
181
  /** @typedef GetAppCustomFieldTypesParam */
@@ -857,8 +857,8 @@ type GetAppCustomFieldDefinitionParam = {
857
857
  type GetAppCustomFieldDefinitionsParam = {
858
858
  pageNo: string;
859
859
  pageSize: string;
860
- resources?: string;
861
- types?: string;
860
+ resource?: string;
861
+ type?: string;
862
862
  search?: string;
863
863
  };
864
864
  type GetAppCustomFieldsParam = {
@@ -1234,4 +1234,4 @@ type GetPageMetaParam = any;
1234
1234
  type GetPageSpecParam = any;
1235
1235
  type GetSEOConfigurationParam = any;
1236
1236
  type GetSupportInformationParam = any;
1237
- import ContentPlatformModel = require("./ContentPlatformModel");
1237
+ import ContentPlatformModel = require("sdk/output/javascript/code/sdk/platform/Content/ContentPlatformModel");
@@ -216,8 +216,8 @@ const ContentPlatformModel = require("./ContentPlatformModel");
216
216
  * @typedef GetAppCustomFieldDefinitionsParam
217
217
  * @property {string} pageNo
218
218
  * @property {string} pageSize
219
- * @property {string} [resources]
220
- * @property {string} [types]
219
+ * @property {string} [resource]
220
+ * @property {string} [type]
221
221
  * @property {string} [search]
222
222
  */
223
223
 
@@ -848,8 +848,8 @@ class ContentPlatformApplicationValidator {
848
848
  return Joi.object({
849
849
  pageNo: Joi.string().allow("").required(),
850
850
  pageSize: Joi.string().allow("").required(),
851
- resources: Joi.string().allow(""),
852
- types: Joi.string().allow(""),
851
+ resource: Joi.string().allow(""),
852
+ type: Joi.string().allow(""),
853
853
  search: Joi.string().allow(""),
854
854
  }).required();
855
855
  }
@@ -13,7 +13,7 @@ declare class Content {
13
13
  *
14
14
  * @name createCustomFieldByResourceId
15
15
  * @summary: Create custom field entries for gives resource and resource_id
16
- * @description: Use this API to create the custom field entry for given resource and resource_id in param. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomFieldByResourceId/).
16
+ * @description: You can add a custom field using this endpoint to any resource by providing the resource ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomFieldByResourceId/).
17
17
  */
18
18
  createCustomFieldByResourceId({ resource, resourceId, body, requestHeaders }?: ContentPlatformValidator.CreateCustomFieldByResourceIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldsResponseByResourceIdSchema>;
19
19
  /**
@@ -25,7 +25,7 @@ declare class Content {
25
25
  *
26
26
  * @name createCustomFieldDefinition
27
27
  * @summary: Create custom field definition
28
- * @description: Use this API to create a custom field definition for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomFieldDefinition/).
28
+ * @description: You can create custom fields definition to any resource so you can extend property of resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomFieldDefinition/).
29
29
  */
30
30
  createCustomFieldDefinition({ body, requestHeaders }?: ContentPlatformValidator.CreateCustomFieldDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionDetailResSchema>;
31
31
  /**
@@ -35,7 +35,7 @@ declare class Content {
35
35
  * @returns {Promise<ContentPlatformModel.CustomObjectSchema>} - Success response
36
36
  * @name createCustomObject
37
37
  * @summary: Create custom object entries
38
- * @description: Use this API to create the custom object entry. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomObject/).
38
+ * @description: Custom object entries against the custom object definition can be added using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomObject/).
39
39
  */
40
40
  createCustomObject({ body, requestHeaders }?: ContentPlatformValidator.CreateCustomObjectParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectSchema>;
41
41
  /**
@@ -48,7 +48,7 @@ declare class Content {
48
48
  * Success response
49
49
  * @name createCustomObjectDefinition
50
50
  * @summary: Create custom object definition
51
- * @description: Use this API to create custom object defintion - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomObjectDefinition/).
51
+ * @description: Create a custom object that will have a collection of custom fields and can be used anywhere in the custom field for any resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomObjectDefinition/).
52
52
  */
53
53
  createCustomObjectDefinition({ body, requestHeaders }?: ContentPlatformValidator.CreateCustomObjectDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectDefinitionSchema>;
54
54
  /**
@@ -57,8 +57,8 @@ declare class Content {
57
57
  * @param {import("../PlatformAPIClient").Options} - Options
58
58
  * @returns {Promise<ContentPlatformModel.CustomDataDeleteSchema>} - Success response
59
59
  * @name deleteCustomFieldDefinition
60
- * @summary: Delete custom fields definition.
61
- * @description: Use this API to delete the definitions of custom fields using definition_id. This will also delete related custom fields entries related to this definition. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteCustomFieldDefinition/).
60
+ * @summary: Delete custom fields definition
61
+ * @description: Custom field definition and its assosiated custom fields value can be deleted using this api on the basis of definition id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteCustomFieldDefinition/).
62
62
  */
63
63
  deleteCustomFieldDefinition({ definitionId, requestHeaders }?: ContentPlatformValidator.DeleteCustomFieldDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomDataDeleteSchema>;
64
64
  /**
@@ -68,7 +68,7 @@ declare class Content {
68
68
  * @returns {Promise<ContentPlatformModel.CustomDataDeleteSchema>} - Success response
69
69
  * @name deleteCustomObject
70
70
  * @summary: Delete custom object
71
- * @description: Use this API to delete the custom object entry by id. This will also delete related custom fields entries related to this custom object. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteCustomObject/).
71
+ * @description: Custom object entries can be deleted by providing the delete ID using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteCustomObject/).
72
72
  */
73
73
  deleteCustomObject({ metaobjectId, requestHeaders }?: ContentPlatformValidator.DeleteCustomObjectParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomDataDeleteSchema>;
74
74
  /**
@@ -81,8 +81,8 @@ declare class Content {
81
81
  * - Success response
82
82
  *
83
83
  * @name deleteCustomObjectDefinition
84
- * @summary: delete custom object definition by id
85
- * @description: Use this API to delete a custom object definition and related data for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteCustomObjectDefinition/).
84
+ * @summary: delete custom object definition
85
+ * @description: Custom object definitions can be deleted using this endpoint by providing the definition ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteCustomObjectDefinition/).
86
86
  */
87
87
  deleteCustomObjectDefinition({ definitionId, requestHeaders }?: ContentPlatformValidator.DeleteCustomObjectDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectDefinitionDeleteResponseSchema>;
88
88
  /**
@@ -94,7 +94,7 @@ declare class Content {
94
94
  *
95
95
  * @name exportCustomObjectEntries
96
96
  * @summary: Initiate download for bulk custom object entries
97
- * @description: Use this api to initiate download of bulk entries - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/exportCustomObjectEntries/).
97
+ * @description: Custom object bulk export of bulk entries can be perform using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/exportCustomObjectEntries/).
98
98
  */
99
99
  exportCustomObjectEntries({ definitionId, requestHeaders }?: ContentPlatformValidator.ExportCustomObjectEntriesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectBulkEntryInitiateDownload>;
100
100
  /**
@@ -105,8 +105,8 @@ declare class Content {
105
105
  * - Success response
106
106
  *
107
107
  * @name getCustomFieldDefinition
108
- * @summary: Get custom fields definition by id
109
- * @description: Use this API to retrieve the definitions of custom fields using definition_id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldDefinition/).
108
+ * @summary: Get custom fields definition
109
+ * @description: Custom field definitions can be fetch using definition id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldDefinition/).
110
110
  */
111
111
  getCustomFieldDefinition({ definitionId, requestHeaders }?: ContentPlatformValidator.GetCustomFieldDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionDetailResSchema>;
112
112
  /**
@@ -117,9 +117,9 @@ declare class Content {
117
117
  * Success response
118
118
  * @name getCustomFieldDefinitions
119
119
  * @summary: Get custom fields definitions
120
- * @description: Use this API to retrieve the definitions of custom fields. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldDefinitions/).
120
+ * @description: Custom field definitions enable you to include data validation for custom fields, and enable sellers to add custom fields values for resources. With the help of this seller can retrive list of custom field definitions list. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldDefinitions/).
121
121
  */
122
- getCustomFieldDefinitions({ pageNo, pageSize, resources, types, search, requestHeaders }?: ContentPlatformValidator.GetCustomFieldDefinitionsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionsSchema>;
122
+ getCustomFieldDefinitions({ pageNo, pageSize, resource, type, search, requestHeaders }?: ContentPlatformValidator.GetCustomFieldDefinitionsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionsSchema>;
123
123
  /**
124
124
  * @param {ContentPlatformValidator.GetCustomFieldTypesParam} arg - Arg object
125
125
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -127,7 +127,7 @@ declare class Content {
127
127
  * @returns {Promise<ContentPlatformModel.CustomObjectByIdSchema>} - Success response
128
128
  * @name getCustomFieldTypes
129
129
  * @summary: Get custom field types
130
- * @description: Use this API to retrieve the custom field types - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldTypes/).
130
+ * @description: Each custom field and custom field definition has a type, which defines the type of information that it can store. The custom field types have built-in validation. This api will give list of supported custom fields types - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldTypes/).
131
131
  */
132
132
  getCustomFieldTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectByIdSchema>;
133
133
  /**
@@ -138,7 +138,7 @@ declare class Content {
138
138
  * Success response
139
139
  * @name getCustomFields
140
140
  * @summary: Get list of custom fields of given resource
141
- * @description: Use this API to retrieve the custom fields for given resource in param. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFields/).
141
+ * @description: Retrieves a list of custom fields attached to a particular resource by using the resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFields/).
142
142
  */
143
143
  getCustomFields({ resource, requestHeaders }?: ContentPlatformValidator.GetCustomFieldsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldsResponseSchema>;
144
144
  /**
@@ -150,7 +150,7 @@ declare class Content {
150
150
  *
151
151
  * @name getCustomFieldsByResourceId
152
152
  * @summary: Get list of custom fields of given resource and resource id
153
- * @description: Use this API to retrieve the custom fields for given resource in param. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldsByResourceId/).
153
+ * @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldsByResourceId/).
154
154
  */
155
155
  getCustomFieldsByResourceId({ resource, resourceId, requestHeaders }?: ContentPlatformValidator.GetCustomFieldsByResourceIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldsResponseByResourceIdSchema>;
156
156
  /**
@@ -160,7 +160,7 @@ declare class Content {
160
160
  * @returns {Promise<ContentPlatformModel.CustomObjectByIdSchema>} - Success response
161
161
  * @name getCustomObject
162
162
  * @summary: Get custom object details
163
- * @description: Use this API to retrieve the custom object details and their fields details and definitions and references. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObject/).
163
+ * @description: Details of custom objects, their field details, definitions, and references can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObject/).
164
164
  */
165
165
  getCustomObject({ metaobjectId, requestHeaders }?: ContentPlatformValidator.GetCustomObjectParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectByIdSchema>;
166
166
  /**
@@ -170,8 +170,8 @@ declare class Content {
170
170
  * @returns {Promise<ContentPlatformModel.CustomObjectDefinitionSchema>} -
171
171
  * Success response
172
172
  * @name getCustomObjectDefinition
173
- * @summary: get custom object definition by id
174
- * @description: Use this API to update a custom object definition for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObjectDefinition/).
173
+ * @summary: Get custom object definition
174
+ * @description: Custom object definitions can be fetched using their definition ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObjectDefinition/).
175
175
  */
176
176
  getCustomObjectDefinition({ definitionId, requestHeaders }?: ContentPlatformValidator.GetCustomObjectDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectDefinitionSchema>;
177
177
  /**
@@ -182,7 +182,7 @@ declare class Content {
182
182
  * Success response
183
183
  * @name getCustomObjectDefinitions
184
184
  * @summary: Get custom object definitions
185
- * @description: Use this API to retrieve the custom object definitions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObjectDefinitions/).
185
+ * @description: Custom object definition lists can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObjectDefinitions/).
186
186
  */
187
187
  getCustomObjectDefinitions({ pageNo, pageSize, search, requestHeaders }?: ContentPlatformValidator.GetCustomObjectDefinitionsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectDefinitionsSchema>;
188
188
  /**
@@ -192,7 +192,7 @@ declare class Content {
192
192
  * @returns {Promise<ContentPlatformModel.CustomObjectsSchema>} - Success response
193
193
  * @name getCustomObjects
194
194
  * @summary: Get list of custom objects
195
- * @description: Use this API to retrieve the custom objects. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObjects/).
195
+ * @description: Custom object entries can fetch using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObjects/).
196
196
  */
197
197
  getCustomObjects({ pageNo, pageSize, definitionId, requestHeaders }?: ContentPlatformValidator.GetCustomObjectsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectsSchema>;
198
198
  /**
@@ -201,8 +201,8 @@ declare class Content {
201
201
  * @param {import("../PlatformAPIClient").Options} - Options
202
202
  * @returns {Promise<ContentPlatformModel.CustomObjectBulkEntry>} - Success response
203
203
  * @name getJobs
204
- * @summary: Fetch bulk import and export job list.
205
- * @description: Use this api to get list of jobs of bulk import and exports - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getJobs/).
204
+ * @summary: Get bulk import and export job list
205
+ * @description: Custom object bulk import and export jobs status and details can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getJobs/).
206
206
  */
207
207
  getJobs({ page, pageSize, actionType, requestHeaders }?: ContentPlatformValidator.GetJobsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectBulkEntry>;
208
208
  /**
@@ -212,7 +212,7 @@ declare class Content {
212
212
  * @returns {Promise<ContentPlatformModel.ResourcesSchema>} - Success response
213
213
  * @name getResources
214
214
  * @summary: Get resources
215
- * @description: Use this API to retrieve the resources, such as products, collections, customers, selling locations, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getResources/).
215
+ * @description: Each custom fields is assosiated with a resource such as product, promotion, coupon, selling location etc, This will gives list of supported resource list. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getResources/).
216
216
  */
217
217
  getResources({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.ResourcesSchema>;
218
218
  /**
@@ -224,7 +224,7 @@ declare class Content {
224
224
  *
225
225
  * @name importCustomObjectEntries
226
226
  * @summary: Bulk custom object entries upload
227
- * @description: Use this API to upload custom object entries - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/importCustomObjectEntries/).
227
+ * @description: Custom object bulk import of bulk entries can be performed using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/importCustomObjectEntries/).
228
228
  */
229
229
  importCustomObjectEntries({ definitionId, body, requestHeaders }?: ContentPlatformValidator.ImportCustomObjectEntriesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectEntryBulkUploadResponse>;
230
230
  /**
@@ -233,8 +233,8 @@ declare class Content {
233
233
  * @param {import("../PlatformAPIClient").Options} - Options
234
234
  * @returns {Promise<string>} - Success response
235
235
  * @name sampleCustomObjectBulkEntry
236
- * @summary: download sample for custom object bulk entry
237
- * @description: Use this api to get sample csv file - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/sampleCustomObjectBulkEntry/).
236
+ * @summary: Download sample for custom object bulk entry
237
+ * @description: Sample files for custom object bulk import can be obtained from this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/sampleCustomObjectBulkEntry/).
238
238
  */
239
239
  sampleCustomObjectBulkEntry({ definitionId, requestHeaders }?: ContentPlatformValidator.SampleCustomObjectBulkEntryParam, { responseHeaders }?: object): Promise<string>;
240
240
  /**
@@ -246,7 +246,7 @@ declare class Content {
246
246
  *
247
247
  * @name updateCustomFieldDefinition
248
248
  * @summary: Update custom field definition
249
- * @description: Use this API to update a custom field definition for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateCustomFieldDefinition/).
249
+ * @description: Custom fields definition can be update using this api, You can update custom field definition name and description. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateCustomFieldDefinition/).
250
250
  */
251
251
  updateCustomFieldDefinition({ definitionId, body, requestHeaders }?: ContentPlatformValidator.UpdateCustomFieldDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionDetailResSchema>;
252
252
  /**
@@ -256,7 +256,7 @@ declare class Content {
256
256
  * @returns {Promise<ContentPlatformModel.CustomObjectByIdSchema>} - Success response
257
257
  * @name updateCustomObject
258
258
  * @summary: Update custom object details
259
- * @description: Use this API to update a custom object detail for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateCustomObject/).
259
+ * @description: Custom object entries can be updated using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateCustomObject/).
260
260
  */
261
261
  updateCustomObject({ metaobjectId, body, requestHeaders }?: ContentPlatformValidator.UpdateCustomObjectParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectByIdSchema>;
262
262
  /**
@@ -269,9 +269,9 @@ declare class Content {
269
269
  * Success response
270
270
  * @name updateCustomObjectDefinition
271
271
  * @summary: Update custom object definition
272
- * @description: Use this API to update a custom object definition for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateCustomObjectDefinition/).
272
+ * @description: Custom object definitions can be updated using this endpoint. You can update the name and description of the custom object and add more custom field definitions to the existing custom object. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateCustomObjectDefinition/).
273
273
  */
274
274
  updateCustomObjectDefinition({ definitionId, body, requestHeaders }?: ContentPlatformValidator.UpdateCustomObjectDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectDefinitionSchema>;
275
275
  }
276
- import ContentPlatformValidator = require("./ContentPlatformValidator");
277
- import ContentPlatformModel = require("./ContentPlatformModel");
276
+ import ContentPlatformValidator = require("sdk/output/javascript/code/sdk/platform/Content/ContentPlatformValidator");
277
+ import ContentPlatformModel = require("sdk/output/javascript/code/sdk/platform/Content/ContentPlatformModel");
@@ -25,7 +25,7 @@ class Content {
25
25
  *
26
26
  * @name createCustomFieldByResourceId
27
27
  * @summary: Create custom field entries for gives resource and resource_id
28
- * @description: Use this API to create the custom field entry for given resource and resource_id in param. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomFieldByResourceId/).
28
+ * @description: You can add a custom field using this endpoint to any resource by providing the resource ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomFieldByResourceId/).
29
29
  */
30
30
  async createCustomFieldByResourceId(
31
31
  { resource, resourceId, body, requestHeaders } = { requestHeaders: {} },
@@ -112,7 +112,7 @@ class Content {
112
112
  *
113
113
  * @name createCustomFieldDefinition
114
114
  * @summary: Create custom field definition
115
- * @description: Use this API to create a custom field definition for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomFieldDefinition/).
115
+ * @description: You can create custom fields definition to any resource so you can extend property of resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomFieldDefinition/).
116
116
  */
117
117
  async createCustomFieldDefinition(
118
118
  { body, requestHeaders } = { requestHeaders: {} },
@@ -193,7 +193,7 @@ class Content {
193
193
  * @returns {Promise<ContentPlatformModel.CustomObjectSchema>} - Success response
194
194
  * @name createCustomObject
195
195
  * @summary: Create custom object entries
196
- * @description: Use this API to create the custom object entry. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomObject/).
196
+ * @description: Custom object entries against the custom object definition can be added using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomObject/).
197
197
  */
198
198
  async createCustomObject(
199
199
  { body, requestHeaders } = { requestHeaders: {} },
@@ -275,7 +275,7 @@ class Content {
275
275
  * Success response
276
276
  * @name createCustomObjectDefinition
277
277
  * @summary: Create custom object definition
278
- * @description: Use this API to create custom object defintion - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomObjectDefinition/).
278
+ * @description: Create a custom object that will have a collection of custom fields and can be used anywhere in the custom field for any resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createCustomObjectDefinition/).
279
279
  */
280
280
  async createCustomObjectDefinition(
281
281
  { body, requestHeaders } = { requestHeaders: {} },
@@ -355,8 +355,8 @@ class Content {
355
355
  * @param {import("../PlatformAPIClient").Options} - Options
356
356
  * @returns {Promise<ContentPlatformModel.CustomDataDeleteSchema>} - Success response
357
357
  * @name deleteCustomFieldDefinition
358
- * @summary: Delete custom fields definition.
359
- * @description: Use this API to delete the definitions of custom fields using definition_id. This will also delete related custom fields entries related to this definition. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteCustomFieldDefinition/).
358
+ * @summary: Delete custom fields definition
359
+ * @description: Custom field definition and its assosiated custom fields value can be deleted using this api on the basis of definition id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteCustomFieldDefinition/).
360
360
  */
361
361
  async deleteCustomFieldDefinition(
362
362
  { definitionId, requestHeaders } = { requestHeaders: {} },
@@ -437,7 +437,7 @@ class Content {
437
437
  * @returns {Promise<ContentPlatformModel.CustomDataDeleteSchema>} - Success response
438
438
  * @name deleteCustomObject
439
439
  * @summary: Delete custom object
440
- * @description: Use this API to delete the custom object entry by id. This will also delete related custom fields entries related to this custom object. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteCustomObject/).
440
+ * @description: Custom object entries can be deleted by providing the delete ID using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteCustomObject/).
441
441
  */
442
442
  async deleteCustomObject(
443
443
  { metaobjectId, requestHeaders } = { requestHeaders: {} },
@@ -519,8 +519,8 @@ class Content {
519
519
  * - Success response
520
520
  *
521
521
  * @name deleteCustomObjectDefinition
522
- * @summary: delete custom object definition by id
523
- * @description: Use this API to delete a custom object definition and related data for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteCustomObjectDefinition/).
522
+ * @summary: delete custom object definition
523
+ * @description: Custom object definitions can be deleted using this endpoint by providing the definition ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteCustomObjectDefinition/).
524
524
  */
525
525
  async deleteCustomObjectDefinition(
526
526
  { definitionId, requestHeaders } = { requestHeaders: {} },
@@ -603,7 +603,7 @@ class Content {
603
603
  *
604
604
  * @name exportCustomObjectEntries
605
605
  * @summary: Initiate download for bulk custom object entries
606
- * @description: Use this api to initiate download of bulk entries - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/exportCustomObjectEntries/).
606
+ * @description: Custom object bulk export of bulk entries can be perform using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/exportCustomObjectEntries/).
607
607
  */
608
608
  async exportCustomObjectEntries(
609
609
  { definitionId, requestHeaders } = { requestHeaders: {} },
@@ -685,8 +685,8 @@ class Content {
685
685
  * - Success response
686
686
  *
687
687
  * @name getCustomFieldDefinition
688
- * @summary: Get custom fields definition by id
689
- * @description: Use this API to retrieve the definitions of custom fields using definition_id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldDefinition/).
688
+ * @summary: Get custom fields definition
689
+ * @description: Custom field definitions can be fetch using definition id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldDefinition/).
690
690
  */
691
691
  async getCustomFieldDefinition(
692
692
  { definitionId, requestHeaders } = { requestHeaders: {} },
@@ -768,10 +768,10 @@ class Content {
768
768
  * Success response
769
769
  * @name getCustomFieldDefinitions
770
770
  * @summary: Get custom fields definitions
771
- * @description: Use this API to retrieve the definitions of custom fields. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldDefinitions/).
771
+ * @description: Custom field definitions enable you to include data validation for custom fields, and enable sellers to add custom fields values for resources. With the help of this seller can retrive list of custom field definitions list. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldDefinitions/).
772
772
  */
773
773
  async getCustomFieldDefinitions(
774
- { pageNo, pageSize, resources, types, search, requestHeaders } = {
774
+ { pageNo, pageSize, resource, type, search, requestHeaders } = {
775
775
  requestHeaders: {},
776
776
  },
777
777
  { responseHeaders } = { responseHeaders: false }
@@ -782,8 +782,8 @@ class Content {
782
782
  {
783
783
  pageNo,
784
784
  pageSize,
785
- resources,
786
- types,
785
+ resource,
786
+ type,
787
787
  search,
788
788
  },
789
789
  { abortEarly: false, allowUnknown: true }
@@ -799,8 +799,8 @@ class Content {
799
799
  {
800
800
  pageNo,
801
801
  pageSize,
802
- resources,
803
- types,
802
+ resource,
803
+ type,
804
804
  search,
805
805
  },
806
806
  { abortEarly: false, allowUnknown: false }
@@ -815,8 +815,8 @@ class Content {
815
815
  const query_params = {};
816
816
  query_params["page_no"] = pageNo;
817
817
  query_params["page_size"] = pageSize;
818
- query_params["resources"] = resources;
819
- query_params["types"] = types;
818
+ query_params["resource"] = resource;
819
+ query_params["type"] = type;
820
820
  query_params["search"] = search;
821
821
 
822
822
  const xHeaders = {};
@@ -864,7 +864,7 @@ class Content {
864
864
  * @returns {Promise<ContentPlatformModel.CustomObjectByIdSchema>} - Success response
865
865
  * @name getCustomFieldTypes
866
866
  * @summary: Get custom field types
867
- * @description: Use this API to retrieve the custom field types - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldTypes/).
867
+ * @description: Each custom field and custom field definition has a type, which defines the type of information that it can store. The custom field types have built-in validation. This api will give list of supported custom fields types - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldTypes/).
868
868
  */
869
869
  async getCustomFieldTypes(
870
870
  { requestHeaders } = { requestHeaders: {} },
@@ -940,7 +940,7 @@ class Content {
940
940
  * Success response
941
941
  * @name getCustomFields
942
942
  * @summary: Get list of custom fields of given resource
943
- * @description: Use this API to retrieve the custom fields for given resource in param. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFields/).
943
+ * @description: Retrieves a list of custom fields attached to a particular resource by using the resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFields/).
944
944
  */
945
945
  async getCustomFields(
946
946
  { resource, requestHeaders } = { requestHeaders: {} },
@@ -1021,7 +1021,7 @@ class Content {
1021
1021
  *
1022
1022
  * @name getCustomFieldsByResourceId
1023
1023
  * @summary: Get list of custom fields of given resource and resource id
1024
- * @description: Use this API to retrieve the custom fields for given resource in param. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldsByResourceId/).
1024
+ * @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldsByResourceId/).
1025
1025
  */
1026
1026
  async getCustomFieldsByResourceId(
1027
1027
  { resource, resourceId, requestHeaders } = { requestHeaders: {} },
@@ -1104,7 +1104,7 @@ class Content {
1104
1104
  * @returns {Promise<ContentPlatformModel.CustomObjectByIdSchema>} - Success response
1105
1105
  * @name getCustomObject
1106
1106
  * @summary: Get custom object details
1107
- * @description: Use this API to retrieve the custom object details and their fields details and definitions and references. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObject/).
1107
+ * @description: Details of custom objects, their field details, definitions, and references can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObject/).
1108
1108
  */
1109
1109
  async getCustomObject(
1110
1110
  { metaobjectId, requestHeaders } = { requestHeaders: {} },
@@ -1183,8 +1183,8 @@ class Content {
1183
1183
  * @returns {Promise<ContentPlatformModel.CustomObjectDefinitionSchema>} -
1184
1184
  * Success response
1185
1185
  * @name getCustomObjectDefinition
1186
- * @summary: get custom object definition by id
1187
- * @description: Use this API to update a custom object definition for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObjectDefinition/).
1186
+ * @summary: Get custom object definition
1187
+ * @description: Custom object definitions can be fetched using their definition ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObjectDefinition/).
1188
1188
  */
1189
1189
  async getCustomObjectDefinition(
1190
1190
  { definitionId, requestHeaders } = { requestHeaders: {} },
@@ -1266,7 +1266,7 @@ class Content {
1266
1266
  * Success response
1267
1267
  * @name getCustomObjectDefinitions
1268
1268
  * @summary: Get custom object definitions
1269
- * @description: Use this API to retrieve the custom object definitions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObjectDefinitions/).
1269
+ * @description: Custom object definition lists can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObjectDefinitions/).
1270
1270
  */
1271
1271
  async getCustomObjectDefinitions(
1272
1272
  { pageNo, pageSize, search, requestHeaders } = { requestHeaders: {} },
@@ -1354,7 +1354,7 @@ class Content {
1354
1354
  * @returns {Promise<ContentPlatformModel.CustomObjectsSchema>} - Success response
1355
1355
  * @name getCustomObjects
1356
1356
  * @summary: Get list of custom objects
1357
- * @description: Use this API to retrieve the custom objects. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObjects/).
1357
+ * @description: Custom object entries can fetch using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomObjects/).
1358
1358
  */
1359
1359
  async getCustomObjects(
1360
1360
  { pageNo, pageSize, definitionId, requestHeaders } = { requestHeaders: {} },
@@ -1439,8 +1439,8 @@ class Content {
1439
1439
  * @param {import("../PlatformAPIClient").Options} - Options
1440
1440
  * @returns {Promise<ContentPlatformModel.CustomObjectBulkEntry>} - Success response
1441
1441
  * @name getJobs
1442
- * @summary: Fetch bulk import and export job list.
1443
- * @description: Use this api to get list of jobs of bulk import and exports - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getJobs/).
1442
+ * @summary: Get bulk import and export job list
1443
+ * @description: Custom object bulk import and export jobs status and details can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getJobs/).
1444
1444
  */
1445
1445
  async getJobs(
1446
1446
  { page, pageSize, actionType, requestHeaders } = { requestHeaders: {} },
@@ -1524,7 +1524,7 @@ class Content {
1524
1524
  * @returns {Promise<ContentPlatformModel.ResourcesSchema>} - Success response
1525
1525
  * @name getResources
1526
1526
  * @summary: Get resources
1527
- * @description: Use this API to retrieve the resources, such as products, collections, customers, selling locations, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getResources/).
1527
+ * @description: Each custom fields is assosiated with a resource such as product, promotion, coupon, selling location etc, This will gives list of supported resource list. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getResources/).
1528
1528
  */
1529
1529
  async getResources(
1530
1530
  { requestHeaders } = { requestHeaders: {} },
@@ -1601,7 +1601,7 @@ class Content {
1601
1601
  *
1602
1602
  * @name importCustomObjectEntries
1603
1603
  * @summary: Bulk custom object entries upload
1604
- * @description: Use this API to upload custom object entries - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/importCustomObjectEntries/).
1604
+ * @description: Custom object bulk import of bulk entries can be performed using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/importCustomObjectEntries/).
1605
1605
  */
1606
1606
  async importCustomObjectEntries(
1607
1607
  { definitionId, body, requestHeaders } = { requestHeaders: {} },
@@ -1683,8 +1683,8 @@ class Content {
1683
1683
  * @param {import("../PlatformAPIClient").Options} - Options
1684
1684
  * @returns {Promise<string>} - Success response
1685
1685
  * @name sampleCustomObjectBulkEntry
1686
- * @summary: download sample for custom object bulk entry
1687
- * @description: Use this api to get sample csv file - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/sampleCustomObjectBulkEntry/).
1686
+ * @summary: Download sample for custom object bulk entry
1687
+ * @description: Sample files for custom object bulk import can be obtained from this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/sampleCustomObjectBulkEntry/).
1688
1688
  */
1689
1689
  async sampleCustomObjectBulkEntry(
1690
1690
  { definitionId, requestHeaders } = { requestHeaders: {} },
@@ -1764,7 +1764,7 @@ class Content {
1764
1764
  *
1765
1765
  * @name updateCustomFieldDefinition
1766
1766
  * @summary: Update custom field definition
1767
- * @description: Use this API to update a custom field definition for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateCustomFieldDefinition/).
1767
+ * @description: Custom fields definition can be update using this api, You can update custom field definition name and description. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateCustomFieldDefinition/).
1768
1768
  */
1769
1769
  async updateCustomFieldDefinition(
1770
1770
  { definitionId, body, requestHeaders } = { requestHeaders: {} },
@@ -1847,7 +1847,7 @@ class Content {
1847
1847
  * @returns {Promise<ContentPlatformModel.CustomObjectByIdSchema>} - Success response
1848
1848
  * @name updateCustomObject
1849
1849
  * @summary: Update custom object details
1850
- * @description: Use this API to update a custom object detail for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateCustomObject/).
1850
+ * @description: Custom object entries can be updated using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateCustomObject/).
1851
1851
  */
1852
1852
  async updateCustomObject(
1853
1853
  { metaobjectId, body, requestHeaders } = { requestHeaders: {} },
@@ -1931,7 +1931,7 @@ class Content {
1931
1931
  * Success response
1932
1932
  * @name updateCustomObjectDefinition
1933
1933
  * @summary: Update custom object definition
1934
- * @description: Use this API to update a custom object definition for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateCustomObjectDefinition/).
1934
+ * @description: Custom object definitions can be updated using this endpoint. You can update the name and description of the custom object and add more custom field definitions to the existing custom object. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateCustomObjectDefinition/).
1935
1935
  */
1936
1936
  async updateCustomObjectDefinition(
1937
1937
  { definitionId, body, requestHeaders } = { requestHeaders: {} },