@gofynd/fdk-client-javascript 1.4.6 → 1.4.8-beta.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 (140) hide show
  1. package/README.md +1 -1
  2. package/package.json +2 -2
  3. package/sdk/application/ApplicationClient.d.ts +2 -0
  4. package/sdk/application/ApplicationClient.js +2 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +16 -3
  6. package/sdk/application/Cart/CartApplicationClient.js +118 -13
  7. package/sdk/application/Cart/CartApplicationModel.d.ts +121 -45
  8. package/sdk/application/Cart/CartApplicationModel.js +98 -26
  9. package/sdk/application/Cart/CartApplicationValidator.d.ts +45 -1
  10. package/sdk/application/Cart/CartApplicationValidator.js +26 -0
  11. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +10 -2
  12. package/sdk/application/Catalog/CatalogApplicationModel.js +10 -2
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +1 -1
  14. package/sdk/application/Content/ContentApplicationClient.js +5 -3
  15. package/sdk/application/Content/ContentApplicationModel.d.ts +7 -18
  16. package/sdk/application/Content/ContentApplicationModel.js +6 -20
  17. package/sdk/application/Content/ContentApplicationValidator.d.ts +10 -0
  18. package/sdk/application/Content/ContentApplicationValidator.js +4 -0
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +0 -27
  20. package/sdk/application/Lead/LeadApplicationClient.js +0 -167
  21. package/sdk/application/Lead/LeadApplicationModel.d.ts +1 -146
  22. package/sdk/application/Lead/LeadApplicationModel.js +0 -126
  23. package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -25
  24. package/sdk/application/Lead/LeadApplicationValidator.js +0 -24
  25. package/sdk/application/Logistic/LogisticApplicationClient.js +1 -1
  26. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +2 -0
  27. package/sdk/application/Logistic/LogisticApplicationModel.js +2 -0
  28. package/sdk/application/Order/OrderApplicationModel.d.ts +72 -9
  29. package/sdk/application/Order/OrderApplicationModel.js +45 -7
  30. package/sdk/application/Payment/PaymentApplicationModel.d.ts +27 -20
  31. package/sdk/application/Payment/PaymentApplicationModel.js +23 -20
  32. package/sdk/application/Theme/ThemeApplicationModel.d.ts +2 -0
  33. package/sdk/application/Theme/ThemeApplicationModel.js +2 -0
  34. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +22 -0
  35. package/sdk/application/Webhook/WebhookApplicationClient.js +115 -0
  36. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +37 -0
  37. package/sdk/application/Webhook/WebhookApplicationModel.js +46 -0
  38. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +16 -0
  39. package/sdk/application/Webhook/WebhookApplicationValidator.js +19 -0
  40. package/sdk/application/index.d.ts +1 -0
  41. package/sdk/application/index.js +2 -0
  42. package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -23
  43. package/sdk/partner/Lead/LeadPartnerClient.js +0 -157
  44. package/sdk/partner/Lead/LeadPartnerModel.d.ts +12 -581
  45. package/sdk/partner/Lead/LeadPartnerModel.js +14 -403
  46. package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -2
  47. package/sdk/partner/Lead/LeadPartnerValidator.js +0 -12
  48. package/sdk/partner/Logistics/LogisticsPartnerClient.js +1 -1
  49. package/sdk/partner/Logistics/LogisticsPartnerModel.js +4 -4
  50. package/sdk/partner/Theme/ThemePartnerClient.d.ts +22 -0
  51. package/sdk/partner/Theme/ThemePartnerClient.js +162 -0
  52. package/sdk/partner/Theme/ThemePartnerModel.d.ts +119 -1
  53. package/sdk/partner/Theme/ThemePartnerModel.js +142 -0
  54. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
  55. package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
  56. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
  57. package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
  58. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +23 -19
  59. package/sdk/partner/Webhook/WebhookPartnerModel.js +19 -22
  60. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +43 -0
  61. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +257 -0
  62. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +39 -0
  63. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +45 -0
  64. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +60 -0
  65. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +57 -0
  66. package/sdk/platform/Billing/BillingPlatformClient.d.ts +304 -43
  67. package/sdk/platform/Billing/BillingPlatformClient.js +2218 -118
  68. package/sdk/platform/Billing/BillingPlatformModel.d.ts +1330 -282
  69. package/sdk/platform/Billing/BillingPlatformModel.js +1808 -590
  70. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +324 -16
  71. package/sdk/platform/Billing/BillingPlatformValidator.js +340 -12
  72. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +36 -3
  73. package/sdk/platform/Cart/CartPlatformApplicationClient.js +276 -3
  74. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +93 -1
  75. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +60 -0
  76. package/sdk/platform/Cart/CartPlatformModel.d.ts +216 -40
  77. package/sdk/platform/Cart/CartPlatformModel.js +166 -24
  78. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +11 -7
  79. package/sdk/platform/Catalog/CatalogPlatformClient.js +37 -14
  80. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +122 -17
  81. package/sdk/platform/Catalog/CatalogPlatformModel.js +141 -15
  82. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -7
  83. package/sdk/platform/Catalog/CatalogPlatformValidator.js +19 -5
  84. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +1 -1
  85. package/sdk/platform/Content/ContentPlatformApplicationClient.js +18 -1
  86. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +25 -0
  87. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +10 -0
  88. package/sdk/platform/Content/ContentPlatformModel.d.ts +8 -4
  89. package/sdk/platform/Content/ContentPlatformModel.js +8 -4
  90. package/sdk/platform/Finance/FinancePlatformClient.d.ts +49 -28
  91. package/sdk/platform/Finance/FinancePlatformClient.js +181 -28
  92. package/sdk/platform/Finance/FinancePlatformModel.d.ts +350 -127
  93. package/sdk/platform/Finance/FinancePlatformModel.js +378 -108
  94. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +56 -43
  95. package/sdk/platform/Finance/FinancePlatformValidator.js +61 -42
  96. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +0 -47
  97. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +0 -321
  98. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -46
  99. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +0 -48
  100. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -25
  101. package/sdk/platform/Lead/LeadPlatformClient.js +2 -167
  102. package/sdk/platform/Lead/LeadPlatformModel.d.ts +82 -204
  103. package/sdk/platform/Lead/LeadPlatformModel.js +98 -178
  104. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -25
  105. package/sdk/platform/Lead/LeadPlatformValidator.js +0 -24
  106. package/sdk/platform/Order/OrderPlatformClient.d.ts +11 -1
  107. package/sdk/platform/Order/OrderPlatformClient.js +82 -5
  108. package/sdk/platform/Order/OrderPlatformModel.d.ts +270 -29
  109. package/sdk/platform/Order/OrderPlatformModel.js +139 -28
  110. package/sdk/platform/Order/OrderPlatformValidator.d.ts +58 -17
  111. package/sdk/platform/Order/OrderPlatformValidator.js +28 -16
  112. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +14 -2
  113. package/sdk/platform/Payment/PaymentPlatformModel.js +7 -2
  114. package/sdk/platform/PlatformApplicationClient.d.ts +2 -0
  115. package/sdk/platform/PlatformApplicationClient.js +4 -0
  116. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -4
  117. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +12 -0
  118. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +82 -0
  119. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -1
  120. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +14 -0
  121. package/sdk/platform/Theme/ThemePlatformModel.d.ts +67 -1
  122. package/sdk/platform/Theme/ThemePlatformModel.js +78 -0
  123. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +24 -40
  124. package/sdk/platform/Webhook/WebhookPlatformClient.js +78 -221
  125. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +168 -167
  126. package/sdk/platform/Webhook/WebhookPlatformModel.js +180 -178
  127. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +23 -31
  128. package/sdk/platform/Webhook/WebhookPlatformValidator.js +28 -42
  129. package/sdk/platform/index.d.ts +1 -0
  130. package/sdk/platform/index.js +2 -0
  131. package/sdk/public/Billing/BillingPublicClient.d.ts +24 -2
  132. package/sdk/public/Billing/BillingPublicClient.js +156 -3
  133. package/sdk/public/Billing/BillingPublicModel.d.ts +368 -26
  134. package/sdk/public/Billing/BillingPublicModel.js +317 -18
  135. package/sdk/public/Billing/BillingPublicValidator.d.ts +19 -3
  136. package/sdk/public/Billing/BillingPublicValidator.js +22 -3
  137. package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
  138. package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
  139. package/sdk/public/Webhook/WebhookPublicModel.d.ts +24 -22
  140. package/sdk/public/Webhook/WebhookPublicModel.js +24 -22
@@ -57,8 +57,8 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
57
57
 
58
58
  /**
59
59
  * @typedef CreateMarketplaceOptinParam
60
- * @property {string} marketplace - The marketplace for which the detail needs
61
- * to be retrieved.
60
+ * @property {string} marketplaceSlug - The marketplace for which the detail
61
+ * needs to be retrieved.
62
62
  * @property {CatalogPlatformModel.OptInPostRequest} body
63
63
  */
64
64
 
@@ -228,6 +228,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
228
228
  * set of results
229
229
  * @property {number} [pageSize] - Number of items to retrieve in each page.
230
230
  * Default is 12.
231
+ * @property {string} [search] - Search string to filter the results by batch id
231
232
  */
232
233
 
233
234
  /**
@@ -319,6 +320,10 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
319
320
  * the from_date specified to the to_date.
320
321
  * @property {string} [q] - It is a query parameter to search the export job
321
322
  * with the task ID.
323
+ * @property {number} [pageNo] - The page number to navigate through the given
324
+ * set of results
325
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
326
+ * Default is 12.
322
327
  */
323
328
 
324
329
  /**
@@ -432,6 +437,10 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
432
437
  * to from_date.
433
438
  * @property {string} [toDate] - Inventory export history filtered according to from_date.
434
439
  * @property {string} [q] - Inventory export history filtered according to task ID.
440
+ * @property {number} [pageNo] - The page number to navigate through the given
441
+ * set of results
442
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
443
+ * Default is 12.
435
444
  */
436
445
 
437
446
  /**
@@ -514,7 +523,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
514
523
  * @property {string} department - Department of the product to be uploaded.
515
524
  * @property {string} productType - Product type of the product to be uploaded
516
525
  * i.e. set, standard , digital.
517
- * @property {CatalogPlatformModel.BulkJob} body
526
+ * @property {CatalogPlatformModel.BulkProductJob} body
518
527
  */
519
528
 
520
529
  /**
@@ -611,7 +620,7 @@ class CatalogPlatformValidator {
611
620
  /** @returns {CreateMarketplaceOptinParam} */
612
621
  static createMarketplaceOptin() {
613
622
  return Joi.object({
614
- marketplace: Joi.string().allow("").required(),
623
+ marketplaceSlug: Joi.string().allow("").required(),
615
624
  body: CatalogPlatformModel.OptInPostRequest().required(),
616
625
  }).required();
617
626
  }
@@ -815,6 +824,7 @@ class CatalogPlatformValidator {
815
824
  return Joi.object({
816
825
  pageNo: Joi.number(),
817
826
  pageSize: Joi.number(),
827
+ search: Joi.string().allow(""),
818
828
  }).required();
819
829
  }
820
830
 
@@ -920,6 +930,8 @@ class CatalogPlatformValidator {
920
930
  fromDate: Joi.string().allow(""),
921
931
  toDate: Joi.string().allow(""),
922
932
  q: Joi.string().allow(""),
933
+ pageNo: Joi.number(),
934
+ pageSize: Joi.number(),
923
935
  }).required();
924
936
  }
925
937
 
@@ -1048,6 +1060,8 @@ class CatalogPlatformValidator {
1048
1060
  fromDate: Joi.string().allow(""),
1049
1061
  toDate: Joi.string().allow(""),
1050
1062
  q: Joi.string().allow(""),
1063
+ pageNo: Joi.number(),
1064
+ pageSize: Joi.number(),
1051
1065
  }).required();
1052
1066
  }
1053
1067
 
@@ -1149,7 +1163,7 @@ class CatalogPlatformValidator {
1149
1163
  return Joi.object({
1150
1164
  department: Joi.string().allow("").required(),
1151
1165
  productType: Joi.string().allow("").required(),
1152
- body: CatalogPlatformModel.BulkJob().required(),
1166
+ body: CatalogPlatformModel.BulkProductJob().required(),
1153
1167
  }).required();
1154
1168
  }
1155
1169
 
@@ -599,7 +599,7 @@ declare class Content {
599
599
  * @summary: List blogs
600
600
  * @description: List all blogs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getBlogs/).
601
601
  */
602
- getBlogs({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetBlogsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogGetResponse>;
602
+ getBlogs({ pageNo, pageSize, tags, q, slug, title, status, requestHeaders }?: ContentPlatformApplicationValidator.GetBlogsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogGetResponse>;
603
603
  /**
604
604
  * @param {ContentPlatformApplicationValidator.GetComponentByIdParam} arg - Arg object
605
605
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -4096,13 +4096,20 @@ class Content {
4096
4096
  * @description: List all blogs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getBlogs/).
4097
4097
  */
4098
4098
  async getBlogs(
4099
- { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
4099
+ { pageNo, pageSize, tags, q, slug, title, status, requestHeaders } = {
4100
+ requestHeaders: {},
4101
+ },
4100
4102
  { responseHeaders } = { responseHeaders: false }
4101
4103
  ) {
4102
4104
  const { error } = ContentPlatformApplicationValidator.getBlogs().validate(
4103
4105
  {
4104
4106
  pageNo,
4105
4107
  pageSize,
4108
+ tags,
4109
+ q,
4110
+ slug,
4111
+ title,
4112
+ status,
4106
4113
  },
4107
4114
  { abortEarly: false, allowUnknown: true }
4108
4115
  );
@@ -4117,6 +4124,11 @@ class Content {
4117
4124
  {
4118
4125
  pageNo,
4119
4126
  pageSize,
4127
+ tags,
4128
+ q,
4129
+ slug,
4130
+ title,
4131
+ status,
4120
4132
  },
4121
4133
  { abortEarly: false, allowUnknown: false }
4122
4134
  );
@@ -4130,6 +4142,11 @@ class Content {
4130
4142
  const query_params = {};
4131
4143
  query_params["page_no"] = pageNo;
4132
4144
  query_params["page_size"] = pageSize;
4145
+ query_params["tags"] = tags;
4146
+ query_params["q"] = q;
4147
+ query_params["slug"] = slug;
4148
+ query_params["title"] = title;
4149
+ query_params["status"] = status;
4133
4150
 
4134
4151
  const response = await PlatformAPIClient.execute(
4135
4152
  this.config,
@@ -226,6 +226,11 @@ export = ContentPlatformApplicationValidator;
226
226
  * set of results. Default value is 1.
227
227
  * @property {number} [pageSize] - The number of items to retrieve in each page.
228
228
  * Default value is 10.
229
+ * @property {string} [tags] - Blogs retrieve based on the list of tags passed.
230
+ * @property {string} [q] - Blogs retrieve based on the title or slug passed.
231
+ * @property {string} [slug] - Blogs retrieve based on the slug passed.
232
+ * @property {string} [title] - Blogs retrieve based on the title passed.
233
+ * @property {string} [status] - Blogs retrieve based on the status passed.
229
234
  */
230
235
  /**
231
236
  * @typedef GetComponentByIdParam
@@ -907,6 +912,26 @@ type GetBlogsParam = {
907
912
  * Default value is 10.
908
913
  */
909
914
  pageSize?: number;
915
+ /**
916
+ * - Blogs retrieve based on the list of tags passed.
917
+ */
918
+ tags?: string;
919
+ /**
920
+ * - Blogs retrieve based on the title or slug passed.
921
+ */
922
+ q?: string;
923
+ /**
924
+ * - Blogs retrieve based on the slug passed.
925
+ */
926
+ slug?: string;
927
+ /**
928
+ * - Blogs retrieve based on the title passed.
929
+ */
930
+ title?: string;
931
+ /**
932
+ * - Blogs retrieve based on the status passed.
933
+ */
934
+ status?: string;
910
935
  };
911
936
  type GetComponentByIdParam = {
912
937
  /**
@@ -279,6 +279,11 @@ const ContentPlatformModel = require("./ContentPlatformModel");
279
279
  * set of results. Default value is 1.
280
280
  * @property {number} [pageSize] - The number of items to retrieve in each page.
281
281
  * Default value is 10.
282
+ * @property {string} [tags] - Blogs retrieve based on the list of tags passed.
283
+ * @property {string} [q] - Blogs retrieve based on the title or slug passed.
284
+ * @property {string} [slug] - Blogs retrieve based on the slug passed.
285
+ * @property {string} [title] - Blogs retrieve based on the title passed.
286
+ * @property {string} [status] - Blogs retrieve based on the status passed.
282
287
  */
283
288
 
284
289
  /**
@@ -932,6 +937,11 @@ class ContentPlatformApplicationValidator {
932
937
  return Joi.object({
933
938
  pageNo: Joi.number(),
934
939
  pageSize: Joi.number(),
940
+ tags: Joi.string().allow(""),
941
+ q: Joi.string().allow(""),
942
+ slug: Joi.string().allow(""),
943
+ title: Joi.string().allow(""),
944
+ status: Joi.string().allow(""),
935
945
  }).required();
936
946
  }
937
947
 
@@ -159,6 +159,7 @@ export = ContentPlatformModel;
159
159
  * @typedef BlogGetResponse
160
160
  * @property {BlogSchema[]} [items]
161
161
  * @property {Page} [page]
162
+ * @property {string[]} [filters]
162
163
  */
163
164
  /**
164
165
  * @typedef ResourceContent
@@ -189,11 +190,12 @@ export = ContentPlatformModel;
189
190
  * @property {boolean} [published]
190
191
  * @property {string} [reading_time]
191
192
  * @property {string} [slug]
193
+ * @property {string} [publish_date]
192
194
  * @property {string[]} [tags]
193
195
  * @property {SEO} [seo]
194
- * @property {CronSchedule} [_schedule]
195
196
  * @property {string} [title]
196
197
  * @property {DateMeta} [date_meta]
198
+ * @property {string} [summary]
197
199
  */
198
200
  /**
199
201
  * @typedef SEO
@@ -247,7 +249,7 @@ export = ContentPlatformModel;
247
249
  * @property {string[]} [tags]
248
250
  * @property {string} [title]
249
251
  * @property {SEO} [seo]
250
- * @property {CronSchedule} [_schedule]
252
+ * @property {string} [summary]
251
253
  */
252
254
  /**
253
255
  * @typedef GetAnnouncementListSchema
@@ -1412,6 +1414,7 @@ declare function BlogGetResponse(): BlogGetResponse;
1412
1414
  type BlogGetResponse = {
1413
1415
  items?: BlogSchema[];
1414
1416
  page?: Page;
1417
+ filters?: string[];
1415
1418
  };
1416
1419
  /** @returns {ResourceContent} */
1417
1420
  declare function ResourceContent(): ResourceContent;
@@ -1446,11 +1449,12 @@ type BlogSchema = {
1446
1449
  published?: boolean;
1447
1450
  reading_time?: string;
1448
1451
  slug?: string;
1452
+ publish_date?: string;
1449
1453
  tags?: string[];
1450
1454
  seo?: SEO;
1451
- _schedule?: CronSchedule;
1452
1455
  title?: string;
1453
1456
  date_meta?: DateMeta;
1457
+ summary?: string;
1454
1458
  };
1455
1459
  /** @returns {SEO} */
1456
1460
  declare function SEO(): SEO;
@@ -1512,7 +1516,7 @@ type BlogRequest = {
1512
1516
  tags?: string[];
1513
1517
  title?: string;
1514
1518
  seo?: SEO;
1515
- _schedule?: CronSchedule;
1519
+ summary?: string;
1516
1520
  };
1517
1521
  /** @returns {GetAnnouncementListSchema} */
1518
1522
  declare function GetAnnouncementListSchema(): GetAnnouncementListSchema;
@@ -181,6 +181,7 @@ const Joi = require("joi");
181
181
  * @typedef BlogGetResponse
182
182
  * @property {BlogSchema[]} [items]
183
183
  * @property {Page} [page]
184
+ * @property {string[]} [filters]
184
185
  */
185
186
 
186
187
  /**
@@ -215,11 +216,12 @@ const Joi = require("joi");
215
216
  * @property {boolean} [published]
216
217
  * @property {string} [reading_time]
217
218
  * @property {string} [slug]
219
+ * @property {string} [publish_date]
218
220
  * @property {string[]} [tags]
219
221
  * @property {SEO} [seo]
220
- * @property {CronSchedule} [_schedule]
221
222
  * @property {string} [title]
222
223
  * @property {DateMeta} [date_meta]
224
+ * @property {string} [summary]
223
225
  */
224
226
 
225
227
  /**
@@ -281,7 +283,7 @@ const Joi = require("joi");
281
283
  * @property {string[]} [tags]
282
284
  * @property {string} [title]
283
285
  * @property {SEO} [seo]
284
- * @property {CronSchedule} [_schedule]
286
+ * @property {string} [summary]
285
287
  */
286
288
 
287
289
  /**
@@ -1609,6 +1611,7 @@ class ContentPlatformModel {
1609
1611
  return Joi.object({
1610
1612
  items: Joi.array().items(ContentPlatformModel.BlogSchema()),
1611
1613
  page: ContentPlatformModel.Page(),
1614
+ filters: Joi.array().items(Joi.string().allow("")),
1612
1615
  });
1613
1616
  }
1614
1617
 
@@ -1651,11 +1654,12 @@ class ContentPlatformModel {
1651
1654
  published: Joi.boolean(),
1652
1655
  reading_time: Joi.string().allow(""),
1653
1656
  slug: Joi.string().allow(""),
1657
+ publish_date: Joi.string().allow(""),
1654
1658
  tags: Joi.array().items(Joi.string().allow("")),
1655
1659
  seo: ContentPlatformModel.SEO(),
1656
- _schedule: ContentPlatformModel.CronSchedule(),
1657
1660
  title: Joi.string().allow(""),
1658
1661
  date_meta: ContentPlatformModel.DateMeta(),
1662
+ summary: Joi.string().allow(""),
1659
1663
  });
1660
1664
  }
1661
1665
 
@@ -1733,7 +1737,7 @@ class ContentPlatformModel {
1733
1737
  tags: Joi.array().items(Joi.string().allow("")),
1734
1738
  title: Joi.string().allow(""),
1735
1739
  seo: ContentPlatformModel.SEO(),
1736
- _schedule: ContentPlatformModel.CronSchedule(),
1740
+ summary: Joi.string().allow(""),
1737
1741
  });
1738
1742
  }
1739
1743
 
@@ -9,7 +9,7 @@ declare class Finance {
9
9
  * @returns {Promise<FinancePlatformModel.ChannelDisplayNameResponse>} -
10
10
  * Success response
11
11
  * @name channelDisplayName
12
- * @summary: Get channel display name
12
+ * @summary: Get channel display name.
13
13
  * @description: Retrieve the display name for a channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/channelDisplayName/).
14
14
  */
15
15
  channelDisplayName({ filterKey, requestHeaders }?: FinancePlatformValidator.ChannelDisplayNameParam, { responseHeaders }?: object): Promise<FinancePlatformModel.ChannelDisplayNameResponse>;
@@ -23,7 +23,7 @@ declare class Finance {
23
23
  * - Success response
24
24
  *
25
25
  * @name createSellerCreditNoteConfig
26
- * @summary: Create seller credit note config
26
+ * @summary: Create seller credit note config.
27
27
  * @description: Set up configuration for seller credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/createSellerCreditNoteConfig/).
28
28
  */
29
29
  createSellerCreditNoteConfig({ body, requestHeaders }?: FinancePlatformValidator.CreateSellerCreditNoteConfigParam, { responseHeaders }?: object): Promise<FinancePlatformModel.CreateSellerCreditNoteConfigResponse>;
@@ -34,7 +34,7 @@ declare class Finance {
34
34
  * @returns {Promise<FinancePlatformModel.CreditNoteDetailsResponse>} -
35
35
  * Success response
36
36
  * @name creditNoteDetails
37
- * @summary: Get credit note details
37
+ * @summary: Get credit note details.
38
38
  * @description: Retrieve detailed information about a credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/creditNoteDetails/).
39
39
  */
40
40
  creditNoteDetails({ body, requestHeaders }?: FinancePlatformValidator.CreditNoteDetailsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.CreditNoteDetailsResponse>;
@@ -46,7 +46,7 @@ declare class Finance {
46
46
  * - Success response
47
47
  *
48
48
  * @name creditlineDataplatform
49
- * @summary: Access credit line data platform
49
+ * @summary: Access credit line data platform.
50
50
  * @description: Connect to the credit line data platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/creditlineDataplatform/).
51
51
  */
52
52
  creditlineDataplatform({ body, requestHeaders }?: FinancePlatformValidator.CreditlineDataplatformParam, { responseHeaders }?: object): Promise<FinancePlatformModel.CreditlineDataPlatformResponse>;
@@ -56,7 +56,7 @@ declare class Finance {
56
56
  * @param {import("../PlatformAPIClient").Options} - Options
57
57
  * @returns {Promise<FinancePlatformModel.DeleteConfigResponse>} - Success response
58
58
  * @name deleteConfig
59
- * @summary: Deletes credit note config
59
+ * @summary: Deletes credit note config.
60
60
  * @description: Deletes credit note config. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/deleteConfig/).
61
61
  */
62
62
  deleteConfig({ body, requestHeaders }?: FinancePlatformValidator.DeleteConfigParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DeleteConfigResponse>;
@@ -68,7 +68,7 @@ declare class Finance {
68
68
  * - Success response
69
69
  *
70
70
  * @name downloadCreditDebitNote
71
- * @summary: Download credit/debit note
71
+ * @summary: Download credit/debit note.
72
72
  * @description: Retrieve and save credit/debit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadCreditDebitNote/).
73
73
  */
74
74
  downloadCreditDebitNote({ body, requestHeaders }?: FinancePlatformValidator.DownloadCreditDebitNoteParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DownloadCreditDebitNoteResponse>;
@@ -78,7 +78,7 @@ declare class Finance {
78
78
  * @param {import("../PlatformAPIClient").Options} - Options
79
79
  * @returns {Promise<FinancePlatformModel.DownloadReportList>} - Success response
80
80
  * @name downloadReport
81
- * @summary: Download financial report
81
+ * @summary: Download financial report.
82
82
  * @description: Retrieve and save a financial report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadReport/).
83
83
  */
84
84
  downloadReport({ body, requestHeaders }?: FinancePlatformValidator.DownloadReportParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DownloadReportList>;
@@ -90,7 +90,7 @@ declare class Finance {
90
90
  * - Success response
91
91
  *
92
92
  * @name downloadReportCustomerCn
93
- * @summary: Download customer credit note report
93
+ * @summary: Download customer credit note report.
94
94
  * @description: Retrieve and save a report for customer credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadReportCustomerCn/).
95
95
  */
96
96
  downloadReportCustomerCn({ body, requestHeaders }?: FinancePlatformValidator.DownloadReportCustomerCnParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DownloadReportCustomerCnResponse>;
@@ -100,7 +100,7 @@ declare class Finance {
100
100
  * @param {import("../PlatformAPIClient").Options} - Options
101
101
  * @returns {Promise<FinancePlatformModel.GenerateReportJson>} - Success response
102
102
  * @name generateReport
103
- * @summary: Generate financial report
103
+ * @summary: Generate financial report.
104
104
  * @description: Create a financial report with relevant data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/generateReport/).
105
105
  */
106
106
  generateReport({ body, requestHeaders }?: FinancePlatformValidator.GenerateReportParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GenerateReportJson>;
@@ -112,7 +112,7 @@ declare class Finance {
112
112
  * - Success response
113
113
  *
114
114
  * @name generateReportCustomerCn
115
- * @summary: Generate customer credit note report
115
+ * @summary: Generate customer credit note report.
116
116
  * @description: Create a report specifically for customer credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/generateReportCustomerCn/).
117
117
  */
118
118
  generateReportCustomerCn({ body, requestHeaders }?: FinancePlatformValidator.GenerateReportCustomerCnParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GenerateReportCustomerCnResponse>;
@@ -122,7 +122,7 @@ declare class Finance {
122
122
  * @param {import("../PlatformAPIClient").Options} - Options
123
123
  * @returns {Promise<FinancePlatformModel.GetAffiliateResponse>} - Success response
124
124
  * @name getAffiliate
125
- * @summary: Get affiliate details
125
+ * @summary: Get affiliate details.
126
126
  * @description: Retrieve information about an affiliate. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getAffiliate/).
127
127
  */
128
128
  getAffiliate({ body, requestHeaders }?: FinancePlatformValidator.GetAffiliateParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetAffiliateResponse>;
@@ -132,7 +132,7 @@ declare class Finance {
132
132
  * @param {import("../PlatformAPIClient").Options} - Options
133
133
  * @returns {Promise<FinancePlatformModel.GetCnConfigResponse>} - Success response
134
134
  * @name getCnConfig
135
- * @summary: Get credit note configuration
135
+ * @summary: Get credit note configuration.
136
136
  * @description: Retrieve configuration settings for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getCnConfig/).
137
137
  */
138
138
  getCnConfig({ body, requestHeaders }?: FinancePlatformValidator.GetCnConfigParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetCnConfigResponse>;
@@ -144,7 +144,7 @@ declare class Finance {
144
144
  * - Success response
145
145
  *
146
146
  * @name getCustomerCreditBalance
147
- * @summary: Get customer credit balance
147
+ * @summary: Get customer credit balance.
148
148
  * @description: Retrieve the credit balance of a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getCustomerCreditBalance/).
149
149
  */
150
150
  getCustomerCreditBalance({ body, requestHeaders }?: FinancePlatformValidator.GetCustomerCreditBalanceParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetCustomerCreditBalanceResponse>;
@@ -154,7 +154,7 @@ declare class Finance {
154
154
  * @param {import("../PlatformAPIClient").Options} - Options
155
155
  * @returns {Promise<FinancePlatformModel.GetEngineResponse>} - Success response
156
156
  * @name getData
157
- * @summary: Get financial data
157
+ * @summary: Get financial data.
158
158
  * @description: Retrieve financial data for analysis. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getData/).
159
159
  */
160
160
  getData({ body, requestHeaders }?: FinancePlatformValidator.GetDataParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetEngineResponse>;
@@ -164,7 +164,7 @@ declare class Finance {
164
164
  * @param {import("../PlatformAPIClient").Options} - Options
165
165
  * @returns {Promise<FinancePlatformModel.GetPdfUrlViewResponse>} - Success response
166
166
  * @name getPdfUrlView
167
- * @summary: Get PDF URL view
167
+ * @summary: Get PDF URL view.
168
168
  * @description: Retrieve a URL to view a PDF document. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getPdfUrlView/).
169
169
  */
170
170
  getPdfUrlView({ body, requestHeaders }?: FinancePlatformValidator.GetPdfUrlViewParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetPdfUrlViewResponse>;
@@ -174,7 +174,7 @@ declare class Finance {
174
174
  * @param {import("../PlatformAPIClient").Options} - Options
175
175
  * @returns {Promise<FinancePlatformModel.GetReasonResponse>} - Success response
176
176
  * @name getReason
177
- * @summary: Get transaction reason
177
+ * @summary: Get transaction reason.
178
178
  * @description: Retrieve the reason behind a transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReason/).
179
179
  */
180
180
  getReason({ body, requestHeaders }?: FinancePlatformValidator.GetReasonParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReasonResponse>;
@@ -184,7 +184,7 @@ declare class Finance {
184
184
  * @param {import("../PlatformAPIClient").Options} - Options
185
185
  * @returns {Promise<FinancePlatformModel.GetReportListResponse>} - Success response
186
186
  * @name getReportList
187
- * @summary: Get report list
187
+ * @summary: Get report list.
188
188
  * @description: Retrieve a list of available financial reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReportList/).
189
189
  */
190
190
  getReportList({ body, requestHeaders }?: FinancePlatformValidator.GetReportListParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReportListResponse>;
@@ -195,7 +195,7 @@ declare class Finance {
195
195
  * @returns {Promise<FinancePlatformModel.GetReportingFiltersResponse>} -
196
196
  * Success response
197
197
  * @name getReportingFilters
198
- * @summary: Get reporting filters
198
+ * @summary: Get reporting filters.
199
199
  * @description: Retrieve available filters for financial reporting. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReportingFilters/).
200
200
  */
201
201
  getReportingFilters({ filterKey, affiliateId, requestHeaders }?: FinancePlatformValidator.GetReportingFiltersParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReportingFiltersResponse>;
@@ -206,7 +206,7 @@ declare class Finance {
206
206
  * @returns {Promise<FinancePlatformModel.InvoiceActivityLogsResponse>} -
207
207
  * Success response
208
208
  * @name invoiceActivityLogs
209
- * @summary: Display activity log details of an invoice
209
+ * @summary: Display activity log details of an invoice.
210
210
  * @description: Display activity log details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceActivityLogs/).
211
211
  */
212
212
  invoiceActivityLogs({ invoiceNumber, requestHeaders }?: FinancePlatformValidator.InvoiceActivityLogsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceActivityLogsResponse>;
@@ -216,8 +216,8 @@ declare class Finance {
216
216
  * @param {import("../PlatformAPIClient").Options} - Options
217
217
  * @returns {Promise<FinancePlatformModel.InvoiceListingResponse>} - Success response
218
218
  * @name invoiceListing
219
- * @summary: List invoices
220
- * @description: Provides list of invoices generated for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceListing/).
219
+ * @summary: Gives list of invoices.
220
+ * @description: Gives list of invoices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceListing/).
221
221
  */
222
222
  invoiceListing({ body, requestHeaders }?: FinancePlatformValidator.InvoiceListingParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceListingResponse>;
223
223
  /**
@@ -226,7 +226,7 @@ declare class Finance {
226
226
  * @param {import("../PlatformAPIClient").Options} - Options
227
227
  * @returns {Promise<FinancePlatformModel.InvoicePdfResponse>} - Success response
228
228
  * @name invoicePDF
229
- * @summary: Get invoice PDF
229
+ * @summary: Get invoice PDF.
230
230
  * @description: Retrieve the PDF version of an invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePDF/).
231
231
  */
232
232
  invoicePDF({ body, requestHeaders }?: FinancePlatformValidator.InvoicePDFParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePdfResponse>;
@@ -237,17 +237,28 @@ declare class Finance {
237
237
  * @returns {Promise<FinancePlatformModel.InvoicePaymentDetailsResponse>} -
238
238
  * Success response
239
239
  * @name invoicePaymentDetails
240
- * @summary: Display payment details of an invoice
240
+ * @summary: Display payment details of an invoice.
241
241
  * @description: Display payment details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePaymentDetails/).
242
242
  */
243
243
  invoicePaymentDetails({ invoiceNumber, requestHeaders }?: FinancePlatformValidator.InvoicePaymentDetailsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePaymentDetailsResponse>;
244
+ /**
245
+ * @param {FinancePlatformValidator.InvoicePaymentOptionsParam} arg - Arg object
246
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
247
+ * @param {import("../PlatformAPIClient").Options} - Options
248
+ * @returns {Promise<FinancePlatformModel.InvoicePaymentOptionsResponse>} -
249
+ * Success response
250
+ * @name invoicePaymentOptions
251
+ * @summary: Display all payment options for an invoice.
252
+ * @description: Display all payment options for an invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePaymentOptions/).
253
+ */
254
+ invoicePaymentOptions({ body, requestHeaders }?: FinancePlatformValidator.InvoicePaymentOptionsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePaymentOptionsResponse>;
244
255
  /**
245
256
  * @param {FinancePlatformValidator.InvoiceTypeParam} arg - Arg object
246
257
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
247
258
  * @param {import("../PlatformAPIClient").Options} - Options
248
259
  * @returns {Promise<FinancePlatformModel.InvoiceTypeResponse>} - Success response
249
260
  * @name invoiceType
250
- * @summary: Get invoice types
261
+ * @summary: Get invoice types.
251
262
  * @description: Retrieve a list of available invoice types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceType/).
252
263
  */
253
264
  invoiceType({ body, requestHeaders }?: FinancePlatformValidator.InvoiceTypeParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceTypeResponse>;
@@ -258,7 +269,7 @@ declare class Finance {
258
269
  * @returns {Promise<FinancePlatformModel.IsCnRefundMethodResponse>} -
259
270
  * Success response
260
271
  * @name isCnRefundMethod
261
- * @summary: Check refund method
272
+ * @summary: Check CN refund method.
262
273
  * @description: Verify the refund method for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCnRefundMethod/).
263
274
  */
264
275
  isCnRefundMethod({ body, requestHeaders }?: FinancePlatformValidator.IsCnRefundMethodParam, { responseHeaders }?: object): Promise<FinancePlatformModel.IsCnRefundMethodResponse>;
@@ -269,17 +280,27 @@ declare class Finance {
269
280
  * @returns {Promise<FinancePlatformModel.IsCreditlinePlatformResponse>} -
270
281
  * Success response
271
282
  * @name isCreditlinePlatform
272
- * @summary: Check credit line platform status
283
+ * @summary: Check credit line platform status.
273
284
  * @description: Determine if the credit line platform is operational. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCreditlinePlatform/).
274
285
  */
275
286
  isCreditlinePlatform({ body, requestHeaders }?: FinancePlatformValidator.IsCreditlinePlatformParam, { responseHeaders }?: object): Promise<FinancePlatformModel.IsCreditlinePlatformResponse>;
287
+ /**
288
+ * @param {FinancePlatformValidator.OrderFreezeParam} arg - Arg object
289
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
290
+ * @param {import("../PlatformAPIClient").Options} - Options
291
+ * @returns {Promise<FinancePlatformModel.OrederFreezeResponse>} - Success response
292
+ * @name orderFreeze
293
+ * @summary: Get status of oms freeze.
294
+ * @description: Used to get status of oms freeze. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/orderFreeze/).
295
+ */
296
+ orderFreeze({ requestHeaders }?: any, { responseHeaders }?: object): Promise<FinancePlatformModel.OrederFreezeResponse>;
276
297
  /**
277
298
  * @param {FinancePlatformValidator.PaymentProcessParam} arg - Arg object
278
299
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
279
300
  * @param {import("../PlatformAPIClient").Options} - Options
280
301
  * @returns {Promise<FinancePlatformModel.PaymentProcessResponse>} - Success response
281
302
  * @name paymentProcess
282
- * @summary: Process payments
303
+ * @summary: Process payments.
283
304
  * @description: Initiate and manage payment processes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/paymentProcess/).
284
305
  */
285
306
  paymentProcess({ body, requestHeaders }?: FinancePlatformValidator.PaymentProcessParam, { responseHeaders }?: object): Promise<FinancePlatformModel.PaymentProcessResponse>;
@@ -290,7 +311,7 @@ declare class Finance {
290
311
  * @returns {Promise<FinancePlatformModel.UnlockCreditNoteResponse>} -
291
312
  * Success response
292
313
  * @name unlockCreditNote
293
- * @summary: Unlock credit notes
314
+ * @summary: Unlocks credit notes.
294
315
  * @description: Used to unlock all request credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/unlockCreditNote/).
295
316
  */
296
317
  unlockCreditNote({ body, requestHeaders }?: FinancePlatformValidator.UnlockCreditNoteParam, { responseHeaders }?: object): Promise<FinancePlatformModel.UnlockCreditNoteResponse>;