@gofynd/fdk-client-javascript 1.0.0 → 1.0.1

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 (104) hide show
  1. package/documentation/application/CATALOG.md +371 -371
  2. package/documentation/application/ORDER.md +272 -272
  3. package/documentation/application/PAYMENT.md +269 -269
  4. package/documentation/platform/CATALOG.md +1678 -1664
  5. package/documentation/platform/COMPANYPROFILE.md +201 -201
  6. package/documentation/platform/ORDER.md +1442 -1323
  7. package/documentation/platform/PAYMENT.md +88 -88
  8. package/index.js +7 -1
  9. package/package.json +1 -1
  10. package/sdk/application/Cart/CartApplicationClient.js +302 -0
  11. package/sdk/application/Cart/CartApplicationValidator.js +1 -0
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +378 -0
  13. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +17 -17
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +500 -500
  15. package/sdk/application/Catalog/CatalogApplicationValidator.js +1 -0
  16. package/sdk/application/Common/CommonApplicationClient.js +22 -0
  17. package/sdk/application/Common/CommonApplicationValidator.js +1 -0
  18. package/sdk/application/Communication/CommunicationApplicationClient.js +41 -0
  19. package/sdk/application/Communication/CommunicationApplicationValidator.js +1 -0
  20. package/sdk/application/Configuration/ConfigurationApplicationClient.js +200 -0
  21. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +1 -0
  22. package/sdk/application/Content/ContentApplicationClient.js +215 -0
  23. package/sdk/application/Content/ContentApplicationValidator.js +1 -0
  24. package/sdk/application/FileStorage/FileStorageApplicationClient.js +33 -0
  25. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +1 -0
  26. package/sdk/application/Lead/LeadApplicationClient.js +81 -0
  27. package/sdk/application/Lead/LeadApplicationValidator.js +1 -0
  28. package/sdk/application/Logistic/LogisticApplicationClient.js +44 -0
  29. package/sdk/application/Logistic/LogisticApplicationValidator.js +1 -0
  30. package/sdk/application/Order/OrderApplicationClient.js +146 -0
  31. package/sdk/application/Order/OrderApplicationModel.d.ts +20 -20
  32. package/sdk/application/Order/OrderApplicationModel.js +329 -329
  33. package/sdk/application/Order/OrderApplicationValidator.js +1 -0
  34. package/sdk/application/Payment/PaymentApplicationClient.js +528 -0
  35. package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -5
  36. package/sdk/application/Payment/PaymentApplicationModel.js +391 -391
  37. package/sdk/application/Payment/PaymentApplicationValidator.js +1 -0
  38. package/sdk/application/PosCart/PosCartApplicationClient.js +329 -0
  39. package/sdk/application/PosCart/PosCartApplicationValidator.js +1 -0
  40. package/sdk/application/Rewards/RewardsApplicationClient.js +81 -0
  41. package/sdk/application/Rewards/RewardsApplicationValidator.js +1 -0
  42. package/sdk/application/Share/ShareApplicationClient.js +87 -0
  43. package/sdk/application/Share/ShareApplicationValidator.js +1 -0
  44. package/sdk/application/Theme/ThemeApplicationClient.js +44 -0
  45. package/sdk/application/Theme/ThemeApplicationValidator.js +1 -0
  46. package/sdk/application/User/UserApplicationClient.js +405 -0
  47. package/sdk/application/User/UserApplicationValidator.js +1 -0
  48. package/sdk/common/AxiosHelper.js +1 -1
  49. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +114 -0
  50. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +58 -0
  51. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +46 -0
  52. package/sdk/platform/Billing/BillingPlatformClient.js +160 -0
  53. package/sdk/platform/Cart/CartPlatformApplicationClient.js +246 -0
  54. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +29 -29
  55. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +839 -48
  56. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +3 -3
  57. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +9 -9
  58. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +54 -54
  59. package/sdk/platform/Catalog/CatalogPlatformClient.js +1149 -96
  60. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +58 -57
  61. package/sdk/platform/Catalog/CatalogPlatformModel.js +1626 -1614
  62. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +6 -6
  63. package/sdk/platform/Catalog/CatalogPlatformValidator.js +20 -20
  64. package/sdk/platform/Common/CommonPlatformClient.js +26 -0
  65. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +587 -0
  66. package/sdk/platform/Communication/CommunicationPlatformClient.js +15 -0
  67. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +179 -0
  68. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +11 -11
  69. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +269 -269
  70. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +382 -0
  71. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +282 -0
  72. package/sdk/platform/Content/ContentPlatformApplicationClient.js +866 -0
  73. package/sdk/platform/Discount/DiscountPlatformClient.js +152 -0
  74. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +54 -0
  75. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +76 -0
  76. package/sdk/platform/Inventory/InventoryPlatformClient.js +161 -0
  77. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +162 -0
  78. package/sdk/platform/Lead/LeadPlatformClient.js +140 -0
  79. package/sdk/platform/Order/OrderPlatformApplicationClient.js +55 -0
  80. package/sdk/platform/Order/OrderPlatformClient.d.ts +15 -6
  81. package/sdk/platform/Order/OrderPlatformClient.js +674 -15
  82. package/sdk/platform/Order/OrderPlatformModel.d.ts +67 -60
  83. package/sdk/platform/Order/OrderPlatformModel.js +1559 -1623
  84. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -1
  85. package/sdk/platform/Order/OrderPlatformValidator.js +10 -4
  86. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +26 -0
  87. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +165 -0
  88. package/sdk/platform/Payment/PaymentPlatformClient.js +139 -0
  89. package/sdk/platform/Payment/PaymentPlatformModel.js +137 -137
  90. package/sdk/platform/PlatformApplicationClient.d.ts +2217 -2243
  91. package/sdk/platform/PlatformApplicationClient.js +2514 -2524
  92. package/sdk/platform/PlatformClient.d.ts +2217 -2243
  93. package/sdk/platform/PlatformClient.js +2514 -2524
  94. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +169 -0
  95. package/sdk/platform/Share/SharePlatformApplicationClient.js +53 -0
  96. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +293 -0
  97. package/sdk/platform/User/UserPlatformApplicationClient.js +145 -0
  98. package/sdk/platform/Webhook/WebhookPlatformClient.js +90 -0
  99. package/sdk/public/Configuration/ConfigurationPublicClient.js +25 -0
  100. package/sdk/public/Configuration/ConfigurationPublicValidator.js +3 -1
  101. package/sdk/public/Inventory/InventoryPublicClient.js +75 -0
  102. package/sdk/public/Inventory/InventoryPublicValidator.js +3 -1
  103. package/sdk/public/Webhook/WebhookPublicClient.js +29 -0
  104. package/sdk/public/Webhook/WebhookPublicValidator.js +3 -1
@@ -1,17 +1,17 @@
1
1
  export = CatalogValidator;
2
2
  declare class CatalogValidator {
3
- static updateSearchKeywords(): any;
4
3
  static getSearchKeywords(): any;
4
+ static updateSearchKeywords(): any;
5
5
  static deleteSearchKeywords(): any;
6
6
  static getAllSearchKeyword(): any;
7
7
  static createCustomKeyword(): any;
8
- static updateAutocompleteKeyword(): any;
9
8
  static getAutocompleteKeywordDetail(): any;
9
+ static updateAutocompleteKeyword(): any;
10
10
  static deleteAutocompleteKeyword(): any;
11
11
  static getAutocompleteConfig(): any;
12
12
  static createCustomAutocompleteRule(): any;
13
- static updateAppProduct(): any;
14
13
  static getAppProduct(): any;
14
+ static updateAppProduct(): any;
15
15
  static getConfigurationMetadata(): any;
16
16
  static getGroupConfigurations(): any;
17
17
  static createGroupConfiguration(): any;
@@ -2,16 +2,16 @@ const Joi = require("joi");
2
2
  const CatalogModel = require("./CatalogPlatformModel");
3
3
 
4
4
  class CatalogValidator {
5
- static updateSearchKeywords() {
5
+ static getSearchKeywords() {
6
6
  return Joi.object({
7
7
  id: Joi.string().allow("").required(),
8
- body: CatalogModel.CreateSearchKeyword().required(),
9
8
  }).required();
10
9
  }
11
10
 
12
- static getSearchKeywords() {
11
+ static updateSearchKeywords() {
13
12
  return Joi.object({
14
13
  id: Joi.string().allow("").required(),
14
+ body: CatalogModel.CreateSearchKeyword().required(),
15
15
  }).required();
16
16
  }
17
17
 
@@ -31,16 +31,16 @@ class CatalogValidator {
31
31
  }).required();
32
32
  }
33
33
 
34
- static updateAutocompleteKeyword() {
34
+ static getAutocompleteKeywordDetail() {
35
35
  return Joi.object({
36
36
  id: Joi.string().allow("").required(),
37
- body: CatalogModel.CreateAutocompleteKeyword().required(),
38
37
  }).required();
39
38
  }
40
39
 
41
- static getAutocompleteKeywordDetail() {
40
+ static updateAutocompleteKeyword() {
42
41
  return Joi.object({
43
42
  id: Joi.string().allow("").required(),
43
+ body: CatalogModel.CreateAutocompleteKeyword().required(),
44
44
  }).required();
45
45
  }
46
46
 
@@ -60,16 +60,16 @@ class CatalogValidator {
60
60
  }).required();
61
61
  }
62
62
 
63
- static updateAppProduct() {
63
+ static getAppProduct() {
64
64
  return Joi.object({
65
65
  itemId: Joi.string().allow("").required(),
66
- body: CatalogModel.ApplicationItemMeta().required(),
67
66
  }).required();
68
67
  }
69
68
 
70
- static getAppProduct() {
69
+ static updateAppProduct() {
71
70
  return Joi.object({
72
71
  itemId: Joi.string().allow("").required(),
72
+ body: CatalogModel.ApplicationItemMeta().required(),
73
73
  }).required();
74
74
  }
75
75
 
@@ -26,24 +26,24 @@ declare class Catalog {
26
26
  /**
27
27
  * @param {Object} arg - Arg object.
28
28
  * @param {string} arg.id - A `id` is a unique identifier for a particular
29
- * detail. Pass the `id` of the keywords which you want to delete.
30
- * @param {ProductBundleUpdateRequest} arg.body
31
- * @summary: Update a Product Bundle
32
- * @description: Update a Product Bundle by its id. On successful request, returns the updated product bundle
29
+ * detail. Pass the `id` of the keywords which you want to retrieve.
30
+ * @summary: Get a particular Product Bundle details
31
+ * @description: Get a particular Bundle details by its `id`. If successful, returns a Product bundle resource in the response body specified in `GetProductBundleResponse`
33
32
  */
34
- updateProductBundle({ id, body }?: {
33
+ getProductBundleDetail({ id }?: {
35
34
  id: string;
36
- body: ProductBundleUpdateRequest;
37
35
  }): Promise<any>;
38
36
  /**
39
37
  * @param {Object} arg - Arg object.
40
38
  * @param {string} arg.id - A `id` is a unique identifier for a particular
41
- * detail. Pass the `id` of the keywords which you want to retrieve.
42
- * @summary: Get a particular Product Bundle details
43
- * @description: Get a particular Bundle details by its `id`. If successful, returns a Product bundle resource in the response body specified in `GetProductBundleResponse`
39
+ * detail. Pass the `id` of the keywords which you want to delete.
40
+ * @param {ProductBundleUpdateRequest} arg.body
41
+ * @summary: Update a Product Bundle
42
+ * @description: Update a Product Bundle by its id. On successful request, returns the updated product bundle
44
43
  */
45
- getProductBundleDetail({ id }?: {
44
+ updateProductBundle({ id, body }?: {
46
45
  id: string;
46
+ body: ProductBundleUpdateRequest;
47
47
  }): Promise<any>;
48
48
  /**
49
49
  * @param {Object} arg - Arg object.
@@ -73,6 +73,15 @@ declare class Catalog {
73
73
  createSizeGuide({ body }?: {
74
74
  body: ValidateSizeGuide;
75
75
  }): Promise<any>;
76
+ /**
77
+ * @param {Object} arg - Arg object.
78
+ * @param {string} arg.id - Id of the size guide to be viewed.
79
+ * @summary: Get a single size guide.
80
+ * @description: This API helps to get data associated to a size guide.
81
+ */
82
+ getSizeGuide({ id }?: {
83
+ id: string;
84
+ }): Promise<any>;
76
85
  /**
77
86
  * @param {Object} arg - Arg object.
78
87
  * @param {string} arg.id - Mongo id of the size guide to be edited
@@ -84,15 +93,6 @@ declare class Catalog {
84
93
  id: string;
85
94
  body: ValidateSizeGuide;
86
95
  }): Promise<any>;
87
- /**
88
- * @param {Object} arg - Arg object.
89
- * @param {string} arg.id - Id of the size guide to be viewed.
90
- * @summary: Get a single size guide.
91
- * @description: This API helps to get data associated to a size guide.
92
- */
93
- getSizeGuide({ id }?: {
94
- id: string;
95
- }): Promise<any>;
96
96
  /**
97
97
  * @param {Object} arg - Arg object.
98
98
  * @param {string} arg.sellerAppId - Id of the seller application which is
@@ -222,22 +222,22 @@ declare class Catalog {
222
222
  /**
223
223
  * @param {Object} arg - Arg object.
224
224
  * @param {string} arg.uid - A `uid` is a unique identifier of a department.
225
- * @param {DepartmentCreateUpdate} arg.body
226
- * @summary: Update the department by their uid.
227
- * @description: Update the department by their uid using this API.
225
+ * @summary: Get specific departments details by passing in unique id of the department.
226
+ * @description: Allows you to get department data, by uid.
228
227
  */
229
- updateDepartment({ uid, body }?: {
228
+ getDepartmentData({ uid }?: {
230
229
  uid: string;
231
- body: DepartmentCreateUpdate;
232
230
  }): Promise<any>;
233
231
  /**
234
232
  * @param {Object} arg - Arg object.
235
233
  * @param {string} arg.uid - A `uid` is a unique identifier of a department.
236
- * @summary: Get specific departments details by passing in unique id of the department.
237
- * @description: Allows you to get department data, by uid.
234
+ * @param {DepartmentCreateUpdate} arg.body
235
+ * @summary: Update the department by their uid.
236
+ * @description: Update the department by their uid using this API.
238
237
  */
239
- getDepartmentData({ uid }?: {
238
+ updateDepartment({ uid, body }?: {
240
239
  uid: string;
240
+ body: DepartmentCreateUpdate;
241
241
  }): Promise<any>;
242
242
  /**
243
243
  * @param {Object} arg - Arg object.
@@ -341,22 +341,22 @@ declare class Catalog {
341
341
  /**
342
342
  * @param {Object} arg - Arg object.
343
343
  * @param {string} arg.uid - Category unique id
344
- * @param {CategoryRequestBody} arg.body
345
- * @summary: Update product categories
346
- * @description: Update a product category using this apu
344
+ * @summary: Get product category by uid
345
+ * @description: This API gets meta associated to product categories.
347
346
  */
348
- updateCategory({ uid, body }?: {
347
+ getCategoryData({ uid }?: {
349
348
  uid: string;
350
- body: CategoryRequestBody;
351
349
  }): Promise<any>;
352
350
  /**
353
351
  * @param {Object} arg - Arg object.
354
352
  * @param {string} arg.uid - Category unique id
355
- * @summary: Get product category by uid
356
- * @description: This API gets meta associated to product categories.
353
+ * @param {CategoryRequestBody} arg.body
354
+ * @summary: Update product categories
355
+ * @description: Update a product category using this apu
357
356
  */
358
- getCategoryData({ uid }?: {
357
+ updateCategory({ uid, body }?: {
359
358
  uid: string;
359
+ body: CategoryRequestBody;
360
360
  }): Promise<any>;
361
361
  /**
362
362
  * @param {Object} arg - Arg object.
@@ -425,17 +425,6 @@ declare class Catalog {
425
425
  category: string;
426
426
  filter?: boolean;
427
427
  }): Promise<any>;
428
- /**
429
- * @param {Object} arg - Arg object.
430
- * @param {number} arg.itemId - Id of the product to be updated.
431
- * @param {ProductCreateUpdateSchemaV2} arg.body
432
- * @summary: Edit a product.
433
- * @description: This API allows to edit product.
434
- */
435
- editProduct({ itemId, body }?: {
436
- itemId: number;
437
- body: ProductCreateUpdateSchemaV2;
438
- }): Promise<any>;
439
428
  /**
440
429
  * @param {Object} arg - Arg object.
441
430
  * @param {number} arg.itemId - Item Id of the product.
@@ -449,6 +438,17 @@ declare class Catalog {
449
438
  brandUid?: number;
450
439
  itemCode?: string;
451
440
  }): Promise<any>;
441
+ /**
442
+ * @param {Object} arg - Arg object.
443
+ * @param {number} arg.itemId - Id of the product to be updated.
444
+ * @param {ProductCreateUpdateSchemaV2} arg.body
445
+ * @summary: Edit a product.
446
+ * @description: This API allows to edit product.
447
+ */
448
+ editProduct({ itemId, body }?: {
449
+ itemId: number;
450
+ body: ProductCreateUpdateSchemaV2;
451
+ }): Promise<any>;
452
452
  /**
453
453
  * @param {Object} arg - Arg object.
454
454
  * @param {number} arg.itemId - Id of the product to be updated.
@@ -812,22 +812,22 @@ declare class Catalog {
812
812
  /**
813
813
  * @param {Object} arg - Arg object.
814
814
  * @param {string} arg.id - Unique id
815
- * @param {HsnUpsert} arg.body
816
- * @summary: Update Hsn Code.
817
- * @description: Update Hsn Code.
815
+ * @summary: Fetch Hsn Code.
816
+ * @description: Fetch Hsn Code.
818
817
  */
819
- updateHsnCode({ id, body }?: {
818
+ getHsnCode({ id }?: {
820
819
  id: string;
821
- body: HsnUpsert;
822
820
  }): Promise<any>;
823
821
  /**
824
822
  * @param {Object} arg - Arg object.
825
823
  * @param {string} arg.id - Unique id
826
- * @summary: Fetch Hsn Code.
827
- * @description: Fetch Hsn Code.
824
+ * @param {HsnUpsert} arg.body
825
+ * @summary: Update Hsn Code.
826
+ * @description: Update Hsn Code.
828
827
  */
829
- getHsnCode({ id }?: {
828
+ updateHsnCode({ id, body }?: {
830
829
  id: string;
830
+ body: HsnUpsert;
831
831
  }): Promise<any>;
832
832
  /**
833
833
  * @param {Object} arg - Arg object.