@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

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 (156) hide show
  1. package/documentation/application/CART.md +251 -251
  2. package/documentation/application/CATALOG.md +393 -393
  3. package/documentation/application/CONTENT.md +15 -1
  4. package/documentation/application/ORDER.md +268 -268
  5. package/documentation/application/PAYMENT.md +249 -249
  6. package/documentation/application/POSCART.md +297 -297
  7. package/documentation/platform/CART.md +499 -499
  8. package/documentation/platform/CATALOG.md +3497 -3097
  9. package/documentation/platform/COMPANYPROFILE.md +207 -207
  10. package/documentation/platform/CONTENT.md +123 -1
  11. package/documentation/platform/ORDER.md +1518 -1324
  12. package/documentation/platform/PARTNER.md +7 -7
  13. package/documentation/platform/PAYMENT.md +96 -96
  14. package/index.js +7 -1
  15. package/package.json +1 -1
  16. package/sdk/application/ApplicationConfig.js +1 -1
  17. package/sdk/application/Cart/CartApplicationClient.js +865 -52
  18. package/sdk/application/Cart/CartApplicationModel.d.ts +7 -7
  19. package/sdk/application/Cart/CartApplicationModel.js +335 -335
  20. package/sdk/application/Cart/CartApplicationValidator.js +1 -0
  21. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +1 -1
  22. package/sdk/application/Catalog/CatalogApplicationClient.js +1034 -60
  23. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +19 -19
  24. package/sdk/application/Catalog/CatalogApplicationModel.js +532 -532
  25. package/sdk/application/Catalog/CatalogApplicationValidator.js +1 -0
  26. package/sdk/application/Common/CommonApplicationClient.js +66 -4
  27. package/sdk/application/Common/CommonApplicationValidator.js +1 -0
  28. package/sdk/application/Communication/CommunicationApplicationClient.js +108 -6
  29. package/sdk/application/Communication/CommunicationApplicationValidator.js +1 -0
  30. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +1 -1
  31. package/sdk/application/Configuration/ConfigurationApplicationClient.js +558 -32
  32. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +1 -0
  33. package/sdk/application/Content/ContentApplicationClient.js +621 -38
  34. package/sdk/application/Content/ContentApplicationModel.d.ts +1 -0
  35. package/sdk/application/Content/ContentApplicationModel.js +11 -1
  36. package/sdk/application/Content/ContentApplicationValidator.js +1 -0
  37. package/sdk/application/FileStorage/FileStorageApplicationClient.js +101 -6
  38. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +1 -0
  39. package/sdk/application/Lead/LeadApplicationClient.js +229 -14
  40. package/sdk/application/Lead/LeadApplicationValidator.js +1 -0
  41. package/sdk/application/Logistic/LogisticApplicationClient.js +134 -8
  42. package/sdk/application/Logistic/LogisticApplicationValidator.js +1 -0
  43. package/sdk/application/Order/OrderApplicationClient.d.ts +1 -1
  44. package/sdk/application/Order/OrderApplicationClient.js +403 -24
  45. package/sdk/application/Order/OrderApplicationModel.d.ts +20 -20
  46. package/sdk/application/Order/OrderApplicationModel.js +334 -334
  47. package/sdk/application/Order/OrderApplicationValidator.js +1 -0
  48. package/sdk/application/Payment/PaymentApplicationClient.js +1381 -78
  49. package/sdk/application/Payment/PaymentApplicationModel.d.ts +2 -2
  50. package/sdk/application/Payment/PaymentApplicationModel.js +350 -350
  51. package/sdk/application/Payment/PaymentApplicationValidator.js +1 -0
  52. package/sdk/application/PosCart/PosCartApplicationClient.js +914 -54
  53. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +15 -15
  54. package/sdk/application/PosCart/PosCartApplicationModel.js +389 -389
  55. package/sdk/application/PosCart/PosCartApplicationValidator.js +1 -0
  56. package/sdk/application/Rewards/RewardsApplicationClient.js +235 -14
  57. package/sdk/application/Rewards/RewardsApplicationValidator.js +1 -0
  58. package/sdk/application/Share/ShareApplicationClient.js +226 -14
  59. package/sdk/application/Share/ShareApplicationValidator.js +1 -0
  60. package/sdk/application/Theme/ThemeApplicationClient.js +130 -8
  61. package/sdk/application/Theme/ThemeApplicationValidator.js +1 -0
  62. package/sdk/application/User/UserApplicationClient.js +1133 -70
  63. package/sdk/application/User/UserApplicationValidator.js +1 -0
  64. package/sdk/common/AxiosHelper.js +1 -1
  65. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +16 -8
  66. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +287 -16
  67. package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +8 -4
  68. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +153 -8
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
  70. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +141 -8
  71. package/sdk/platform/Billing/BillingPlatformClient.d.ts +24 -12
  72. package/sdk/platform/Billing/BillingPlatformClient.js +429 -24
  73. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +34 -17
  74. package/sdk/platform/Cart/CartPlatformApplicationClient.js +617 -34
  75. package/sdk/platform/Cart/CartPlatformModel.d.ts +35 -35
  76. package/sdk/platform/Cart/CartPlatformModel.js +617 -617
  77. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +191 -138
  78. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2202 -302
  79. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +11 -11
  80. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +45 -45
  81. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +344 -226
  82. package/sdk/platform/Catalog/CatalogPlatformClient.js +3282 -488
  83. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +110 -100
  84. package/sdk/platform/Catalog/CatalogPlatformModel.js +2073 -1795
  85. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +23 -21
  86. package/sdk/platform/Catalog/CatalogPlatformValidator.js +103 -84
  87. package/sdk/platform/Common/CommonPlatformClient.d.ts +4 -2
  88. package/sdk/platform/Common/CommonPlatformClient.js +73 -4
  89. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -40
  90. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1499 -80
  91. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
  92. package/sdk/platform/Communication/CommunicationPlatformClient.js +41 -2
  93. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +27 -14
  94. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +486 -26
  95. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +9 -9
  96. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +274 -274
  97. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +56 -28
  98. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1022 -56
  99. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
  100. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +693 -36
  101. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +148 -67
  102. package/sdk/platform/Content/ContentPlatformApplicationClient.js +2446 -140
  103. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -0
  104. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +7 -0
  105. package/sdk/platform/Content/ContentPlatformModel.d.ts +4 -0
  106. package/sdk/platform/Content/ContentPlatformModel.js +43 -1
  107. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +21 -10
  108. package/sdk/platform/Discount/DiscountPlatformClient.js +400 -22
  109. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +8 -4
  110. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +148 -8
  111. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +12 -6
  112. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +214 -12
  113. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +27 -14
  114. package/sdk/platform/Inventory/InventoryPlatformClient.js +449 -24
  115. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +26 -13
  116. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +447 -26
  117. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -11
  118. package/sdk/platform/Lead/LeadPlatformClient.js +384 -22
  119. package/sdk/platform/OAuthClient.js +8 -8
  120. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -3
  121. package/sdk/platform/Order/OrderPlatformApplicationClient.js +125 -6
  122. package/sdk/platform/Order/OrderPlatformClient.d.ts +108 -47
  123. package/sdk/platform/Order/OrderPlatformClient.js +1641 -100
  124. package/sdk/platform/Order/OrderPlatformModel.d.ts +69 -58
  125. package/sdk/platform/Order/OrderPlatformModel.js +1485 -1493
  126. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -1
  127. package/sdk/platform/Order/OrderPlatformValidator.js +15 -4
  128. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -2
  129. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +74 -4
  130. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
  131. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  132. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +22 -11
  133. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +418 -22
  134. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +21 -11
  135. package/sdk/platform/Payment/PaymentPlatformClient.js +374 -20
  136. package/sdk/platform/Payment/PaymentPlatformModel.js +139 -139
  137. package/sdk/platform/PlatformApplicationClient.d.ts +2973 -2827
  138. package/sdk/platform/PlatformApplicationClient.js +3461 -3263
  139. package/sdk/platform/PlatformClient.d.ts +2973 -2827
  140. package/sdk/platform/PlatformClient.js +3461 -3263
  141. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +26 -13
  142. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +449 -26
  143. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +8 -4
  144. package/sdk/platform/Share/SharePlatformApplicationClient.js +139 -8
  145. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +47 -23
  146. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +816 -48
  147. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +24 -12
  148. package/sdk/platform/User/UserPlatformApplicationClient.js +417 -24
  149. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +12 -6
  150. package/sdk/platform/Webhook/WebhookPlatformClient.js +229 -12
  151. package/sdk/public/Configuration/ConfigurationPublicClient.js +72 -4
  152. package/sdk/public/Configuration/ConfigurationPublicValidator.js +3 -1
  153. package/sdk/public/Inventory/InventoryPublicClient.js +210 -12
  154. package/sdk/public/Inventory/InventoryPublicValidator.js +3 -1
  155. package/sdk/public/Webhook/WebhookPublicClient.js +74 -4
  156. package/sdk/public/Webhook/WebhookPublicValidator.js +3 -1
@@ -27,6 +27,7 @@ declare class ContentValidator {
27
27
  static updateFaq(): any;
28
28
  static deleteFaq(): any;
29
29
  static getFaqByIdOrSlug(): any;
30
+ static generateSEOTitle(): any;
30
31
  static getLandingPages(): any;
31
32
  static createLandingPage(): any;
32
33
  static updateLandingPage(): any;
@@ -172,6 +172,13 @@ class ContentValidator {
172
172
  }).required();
173
173
  }
174
174
 
175
+ static generateSEOTitle() {
176
+ return Joi.object({
177
+ type: ContentModel.GenerationEntityType().required(),
178
+ body: ContentModel.GenerateSEOContent().required(),
179
+ }).required();
180
+ }
181
+
175
182
  static getLandingPages() {
176
183
  return Joi.object({
177
184
  pageNo: Joi.number(),
@@ -1,8 +1,11 @@
1
1
  export = ContentModel;
2
2
  declare class ContentModel {
3
+ static GenerateSEOContent(): any;
4
+ static GeneratedSEOContent(): any;
3
5
  static ApplicationLegal(): any;
4
6
  static ApplicationLegalFAQ(): any;
5
7
  static PathMappingSchema(): any;
8
+ static PathSourceSchema(): any;
6
9
  static SeoComponent(): any;
7
10
  static SeoSchema(): any;
8
11
  static CustomMetaTag(): any;
@@ -101,5 +104,6 @@ declare class ContentModel {
101
104
  static TagsSchema(): any;
102
105
  static TagSchema(): any;
103
106
  static TagSourceSchema(): any;
107
+ static GenerationEntityType(): any;
104
108
  static PageType(): any;
105
109
  }
@@ -1,6 +1,26 @@
1
1
  const Joi = require("joi");
2
2
 
3
3
  class ContentModel {
4
+ static GenerateSEOContent() {
5
+ return Joi.object({
6
+ text: Joi.string().allow(""),
7
+
8
+ existing_text: Joi.string().allow(""),
9
+
10
+ keywords: Joi.array().items(Joi.string().allow("")),
11
+
12
+ type: Joi.string().allow(""),
13
+ });
14
+ }
15
+
16
+ static GeneratedSEOContent() {
17
+ return Joi.object({
18
+ title: Joi.string().allow(""),
19
+
20
+ description: Joi.string().allow(""),
21
+ });
22
+ }
23
+
4
24
  static ApplicationLegal() {
5
25
  return Joi.object({
6
26
  application: Joi.string().allow(""),
@@ -45,7 +65,15 @@ class ContentModel {
45
65
 
46
66
  created_at: Joi.string().allow(""),
47
67
 
48
- __source: ContentModel.TagSourceSchema(),
68
+ __source: ContentModel.PathSourceSchema(),
69
+ });
70
+ }
71
+
72
+ static PathSourceSchema() {
73
+ return Joi.object({
74
+ type: Joi.string().allow(""),
75
+
76
+ id: Joi.string().allow(""),
49
77
  });
50
78
  }
51
79
 
@@ -65,6 +93,8 @@ class ContentModel {
65
93
 
66
94
  sitemap_enabled: Joi.boolean(),
67
95
 
96
+ cannonical_enabled: Joi.boolean(),
97
+
68
98
  custom_meta_tags: Joi.array().items(Joi.any()),
69
99
 
70
100
  details: ContentModel.Detail(),
@@ -1244,6 +1274,18 @@ class ContentModel {
1244
1274
  });
1245
1275
  }
1246
1276
 
1277
+ /*
1278
+ Enum: GenerationEntityType
1279
+ Used By: Content
1280
+ */
1281
+ static GenerationEntityType() {
1282
+ return Joi.string().valid(
1283
+ "title",
1284
+
1285
+ "description"
1286
+ );
1287
+ }
1288
+
1247
1289
  /*
1248
1290
  Enum: PageType
1249
1291
  Used By: Content
@@ -14,6 +14,7 @@ declare class Discount {
14
14
  * @param {number} [arg.year] - Year. Default is current year.
15
15
  * @param {string} [arg.type] - Basic or custom.
16
16
  * @param {string[]} [arg.appIds] - Application ids.
17
+ * @returns {Promise<ListOrCalender>} - Success response
17
18
  * @summary: Fetch discount list.
18
19
  * @description: Fetch discount list.
19
20
  */
@@ -27,40 +28,44 @@ declare class Discount {
27
28
  year?: number;
28
29
  type?: string;
29
30
  appIds?: string[];
30
- }): Promise<any>;
31
+ }): Promise<ListOrCalender>;
31
32
  /**
32
33
  * @param {Object} arg - Arg object.
33
34
  * @param {CreateUpdateDiscount} arg.body
35
+ * @returns {Promise<DiscountJob>} - Success response
34
36
  * @summary: Create Discount.
35
37
  * @description: Create Discount.
36
38
  */
37
39
  createDiscount({ body }?: {
38
40
  body: CreateUpdateDiscount;
39
- }): Promise<any>;
41
+ }): Promise<DiscountJob>;
40
42
  /**
41
43
  * @param {Object} arg - Arg object.
42
44
  * @param {string} arg.id - Unique id.
45
+ * @returns {Promise<DiscountJob>} - Success response
43
46
  * @summary: Fetch discount.
44
47
  * @description: Fetch discount.
45
48
  */
46
49
  getDiscount({ id }?: {
47
50
  id: string;
48
- }): Promise<any>;
51
+ }): Promise<DiscountJob>;
49
52
  /**
50
53
  * @param {Object} arg - Arg object.
51
54
  * @param {string} arg.id - Id
52
55
  * @param {CreateUpdateDiscount} arg.body
56
+ * @returns {Promise<DiscountJob>} - Success response
53
57
  * @summary: Create Discount.
54
58
  * @description: Create Discount.
55
59
  */
56
60
  updateDiscount({ id, body }?: {
57
61
  id: string;
58
62
  body: CreateUpdateDiscount;
59
- }): Promise<any>;
63
+ }): Promise<DiscountJob>;
60
64
  /**
61
65
  * @param {Object} arg - Arg object.
62
66
  * @param {string} arg.id - Job ID of the discount.
63
67
  * @param {BulkDiscount} arg.body
68
+ * @returns {Promise<Object>} - Success response
64
69
  * @summary: Create custom discount from bulk.
65
70
  * @description: Create custom discounts through API.
66
71
  */
@@ -72,58 +77,64 @@ declare class Discount {
72
77
  * @param {Object} arg - Arg object.
73
78
  * @param {string} [arg.discount] - Discount
74
79
  * @param {DiscountJob} arg.body
80
+ * @returns {Promise<FileJobResponse>} - Success response
75
81
  * @summary: Validate File.
76
82
  * @description: Validate File.
77
83
  */
78
84
  validateDiscountFile({ body, discount }?: {
79
85
  discount?: string;
80
86
  body: DiscountJob;
81
- }): Promise<any>;
87
+ }): Promise<FileJobResponse>;
82
88
  /**
83
89
  * @param {Object} arg - Arg object.
84
90
  * @param {string} arg.type - Type
85
91
  * @param {DownloadFileJob} arg.body
92
+ * @returns {Promise<FileJobResponse>} - Success response
86
93
  * @summary: Validate File.
87
94
  * @description: Validate File.
88
95
  */
89
96
  downloadDiscountFile({ type, body }?: {
90
97
  type: string;
91
98
  body: DownloadFileJob;
92
- }): Promise<any>;
99
+ }): Promise<FileJobResponse>;
93
100
  /**
94
101
  * @param {Object} arg - Arg object.
95
102
  * @param {string} arg.id - Id
103
+ * @returns {Promise<FileJobResponse>} - Success response
96
104
  * @summary: Validate File Job.
97
105
  * @description: Validate File Job.
98
106
  */
99
107
  getValidationJob({ id }?: {
100
108
  id: string;
101
- }): Promise<any>;
109
+ }): Promise<FileJobResponse>;
102
110
  /**
103
111
  * @param {Object} arg - Arg object.
104
112
  * @param {string} arg.id - Id
113
+ * @returns {Promise<CancelJobResponse>} - Success response
105
114
  * @summary: Cancel Validation Job.
106
115
  * @description: Cancel Validation Job.
107
116
  */
108
117
  cancelValidationJob({ id }?: {
109
118
  id: string;
110
- }): Promise<any>;
119
+ }): Promise<CancelJobResponse>;
111
120
  /**
112
121
  * @param {Object} arg - Arg object.
113
122
  * @param {string} arg.id - Id
123
+ * @returns {Promise<FileJobResponse>} - Success response
114
124
  * @summary: Download File Job.
115
125
  * @description: Download File Job.
116
126
  */
117
127
  getDownloadJob({ id }?: {
118
128
  id: string;
119
- }): Promise<any>;
129
+ }): Promise<FileJobResponse>;
120
130
  /**
121
131
  * @param {Object} arg - Arg object.
122
132
  * @param {string} arg.id - Id
133
+ * @returns {Promise<CancelJobResponse>} - Success response
123
134
  * @summary: Cancel Download Job.
124
135
  * @description: Cancel Download Job.
125
136
  */
126
137
  cancelDownloadJob({ id }?: {
127
138
  id: string;
128
- }): Promise<any>;
139
+ }): Promise<CancelJobResponse>;
129
140
  }