@gofynd/fdk-client-javascript 3.16.3 → 3.17.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 (90) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +0 -2
  4. package/sdk/application/ApplicationClient.js +0 -2
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +40 -0
  6. package/sdk/application/Cart/CartApplicationClient.js +176 -0
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +18 -4
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +47 -4
  9. package/sdk/application/Content/ContentApplicationClient.d.ts +21 -1
  10. package/sdk/application/Content/ContentApplicationClient.js +93 -2
  11. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -21
  12. package/sdk/application/Logistic/LogisticApplicationClient.js +34 -83
  13. package/sdk/application/Order/OrderApplicationClient.d.ts +11 -0
  14. package/sdk/application/Order/OrderApplicationClient.js +50 -0
  15. package/sdk/application/Payment/PaymentApplicationClient.d.ts +5 -5
  16. package/sdk/application/Payment/PaymentApplicationClient.js +5 -4
  17. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +84 -0
  18. package/sdk/partner/Logistics/LogisticsPartnerClient.js +712 -0
  19. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +237 -1
  20. package/sdk/partner/Logistics/LogisticsPartnerModel.js +157 -0
  21. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +8 -0
  22. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +70 -0
  23. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +74 -12
  24. package/sdk/platform/Cart/CartPlatformApplicationClient.js +637 -36
  25. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +225 -1
  26. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +147 -0
  27. package/sdk/platform/Cart/CartPlatformModel.d.ts +952 -5
  28. package/sdk/platform/Cart/CartPlatformModel.js +598 -2
  29. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +125 -5
  30. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +831 -41
  31. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +205 -7
  32. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +154 -3
  33. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +5 -16
  34. package/sdk/platform/Catalog/CatalogPlatformClient.js +8 -85
  35. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1025 -159
  36. package/sdk/platform/Catalog/CatalogPlatformModel.js +840 -165
  37. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +8 -10
  38. package/sdk/platform/Catalog/CatalogPlatformValidator.js +3 -12
  39. package/sdk/platform/Common/CommonPlatformModel.d.ts +18 -1
  40. package/sdk/platform/Common/CommonPlatformModel.js +14 -0
  41. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -73
  42. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +4 -462
  43. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +7 -45
  44. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +4 -55
  45. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +10 -2
  46. package/sdk/platform/Communication/CommunicationPlatformModel.js +3 -2
  47. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +14 -0
  48. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +6 -0
  49. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +92 -1
  50. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +54 -0
  51. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +21 -0
  52. package/sdk/platform/Discount/DiscountPlatformModel.js +9 -0
  53. package/sdk/platform/Order/OrderPlatformClient.d.ts +27 -19
  54. package/sdk/platform/Order/OrderPlatformClient.js +176 -108
  55. package/sdk/platform/Order/OrderPlatformModel.d.ts +359 -45
  56. package/sdk/platform/Order/OrderPlatformModel.js +218 -44
  57. package/sdk/platform/Order/OrderPlatformValidator.d.ts +40 -43
  58. package/sdk/platform/Order/OrderPlatformValidator.js +35 -30
  59. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +14 -3
  60. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +88 -6
  61. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +28 -3
  62. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +22 -2
  63. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +376 -11
  64. package/sdk/platform/Payment/PaymentPlatformModel.js +243 -10
  65. package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
  66. package/sdk/platform/PlatformApplicationClient.js +0 -4
  67. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +0 -13
  68. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +0 -82
  69. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -10
  70. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +0 -12
  71. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +212 -28
  72. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +133 -13
  73. package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
  74. package/sdk/platform/User/UserPlatformModel.js +4 -4
  75. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +29 -0
  76. package/sdk/platform/Webhook/WebhookPlatformModel.js +13 -0
  77. package/sdk/platform/index.d.ts +0 -1
  78. package/sdk/platform/index.js +0 -2
  79. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +27 -1
  80. package/sdk/public/Configuration/ConfigurationPublicModel.js +19 -0
  81. package/sdk/public/Webhook/WebhookPublicModel.d.ts +29 -0
  82. package/sdk/public/Webhook/WebhookPublicModel.js +13 -0
  83. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
  84. package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
  85. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
  86. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
  87. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
  88. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
  89. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -387
  90. package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -410
@@ -324,7 +324,7 @@ export = UserPlatformModel;
324
324
  * @property {string} [user_attribute_definition_id] - ID of the user attribute
325
325
  * definition used in the condition
326
326
  * @property {string} [type] - Type of condition to apply on the attribute value.
327
- * @property {string} [value] - Value of the condition
327
+ * @property {Object} [value] - Value of the condition
328
328
  * @property {boolean} [ignore_year] - Indicates if the year should be ignored
329
329
  * for the condition
330
330
  */
@@ -1347,7 +1347,7 @@ type ConditionsSchema = {
1347
1347
  /**
1348
1348
  * - Value of the condition
1349
1349
  */
1350
- value?: string;
1350
+ value?: any;
1351
1351
  /**
1352
1352
  * - Indicates if the year should be ignored
1353
1353
  * for the condition
@@ -364,7 +364,7 @@ const Joi = require("joi");
364
364
  * @property {string} [user_attribute_definition_id] - ID of the user attribute
365
365
  * definition used in the condition
366
366
  * @property {string} [type] - Type of condition to apply on the attribute value.
367
- * @property {string} [value] - Value of the condition
367
+ * @property {Object} [value] - Value of the condition
368
368
  * @property {boolean} [ignore_year] - Indicates if the year should be ignored
369
369
  * for the condition
370
370
  */
@@ -926,7 +926,7 @@ class UserPlatformModel {
926
926
  static BulkUserAttributeRequestBody() {
927
927
  return Joi.object({
928
928
  definition_id: Joi.string().allow("").required(),
929
- value: Joi.any().required(),
929
+ value: Joi.object().pattern(/\S/, Joi.any()).required(),
930
930
  });
931
931
  }
932
932
 
@@ -1206,7 +1206,7 @@ class UserPlatformModel {
1206
1206
  return Joi.object({
1207
1207
  user_attribute_definition_id: Joi.string().allow(""),
1208
1208
  type: Joi.string().allow(""),
1209
- value: Joi.string().allow(""),
1209
+ value: Joi.object().pattern(/\S/, Joi.any()),
1210
1210
  ignore_year: Joi.boolean(),
1211
1211
  });
1212
1212
  }
@@ -1247,7 +1247,7 @@ class UserPlatformModel {
1247
1247
  return Joi.object({
1248
1248
  definition_id: Joi.string().allow("").required(),
1249
1249
  type: Joi.string().allow("").required(),
1250
- value: Joi.any().required(),
1250
+ value: Joi.object().pattern(/\S/, Joi.any()).required(),
1251
1251
  });
1252
1252
  }
1253
1253
 
@@ -64,6 +64,16 @@ export = WebhookPlatformModel;
64
64
  * @property {SubscriberEventMapping} [subscriber_event_mapping]
65
65
  * @property {Object} [event_schema] - The schema for the event, allowing for
66
66
  * additional properties and may be null.
67
+ * @property {string} [sunset_date] - The date and time after which the event is
68
+ * considered sunset. After this timestamp, the entity should no longer be
69
+ * actively used, referenced, or offered for new operations, even if it still exists.
70
+ * @property {string} [announcement_date] - The date and time when the
71
+ * deprecation of the event is officially announced. This marks the start of
72
+ * the deprecation notice period and indicates that the entity is planned to
73
+ * be retired in the future, but may still remain available until the sunset date.
74
+ * @property {string} [support_end_date] - The date and time after which
75
+ * official support for the event ends. Beyond this point, no guarantees are
76
+ * made for maintenance, updates, fixes, or issue resolution.
67
77
  * @property {string} [group] - The group associated with the event
68
78
  * configuration, which may be null.
69
79
  * @property {string} [version] - The version of the event configuration.
@@ -479,6 +489,25 @@ type EventConfig = {
479
489
  * additional properties and may be null.
480
490
  */
481
491
  event_schema?: any;
492
+ /**
493
+ * - The date and time after which the event is
494
+ * considered sunset. After this timestamp, the entity should no longer be
495
+ * actively used, referenced, or offered for new operations, even if it still exists.
496
+ */
497
+ sunset_date?: string;
498
+ /**
499
+ * - The date and time when the
500
+ * deprecation of the event is officially announced. This marks the start of
501
+ * the deprecation notice period and indicates that the entity is planned to
502
+ * be retired in the future, but may still remain available until the sunset date.
503
+ */
504
+ announcement_date?: string;
505
+ /**
506
+ * - The date and time after which
507
+ * official support for the event ends. Beyond this point, no guarantees are
508
+ * made for maintenance, updates, fixes, or issue resolution.
509
+ */
510
+ support_end_date?: string;
482
511
  /**
483
512
  * - The group associated with the event
484
513
  * configuration, which may be null.
@@ -69,6 +69,16 @@ const Joi = require("joi");
69
69
  * @property {SubscriberEventMapping} [subscriber_event_mapping]
70
70
  * @property {Object} [event_schema] - The schema for the event, allowing for
71
71
  * additional properties and may be null.
72
+ * @property {string} [sunset_date] - The date and time after which the event is
73
+ * considered sunset. After this timestamp, the entity should no longer be
74
+ * actively used, referenced, or offered for new operations, even if it still exists.
75
+ * @property {string} [announcement_date] - The date and time when the
76
+ * deprecation of the event is officially announced. This marks the start of
77
+ * the deprecation notice period and indicates that the entity is planned to
78
+ * be retired in the future, but may still remain available until the sunset date.
79
+ * @property {string} [support_end_date] - The date and time after which
80
+ * official support for the event ends. Beyond this point, no guarantees are
81
+ * made for maintenance, updates, fixes, or issue resolution.
72
82
  * @property {string} [group] - The group associated with the event
73
83
  * configuration, which may be null.
74
84
  * @property {string} [version] - The version of the event configuration.
@@ -409,6 +419,9 @@ class WebhookPlatformModel {
409
419
  modified_by: Joi.string().allow(""),
410
420
  subscriber_event_mapping: WebhookPlatformModel.SubscriberEventMapping(),
411
421
  event_schema: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
422
+ sunset_date: Joi.string().allow("").allow(null),
423
+ announcement_date: Joi.string().allow("").allow(null),
424
+ support_end_date: Joi.string().allow("").allow(null),
412
425
  group: Joi.string().allow("").allow(null),
413
426
  version: Joi.string().allow(""),
414
427
  display_name: Joi.string().allow(""),
@@ -18,7 +18,6 @@ export namespace PlatformModel {
18
18
  const OrderPlatformModel: typeof import("./Order/OrderPlatformModel");
19
19
  const PartnerPlatformModel: typeof import("./Partner/PartnerPlatformModel");
20
20
  const PaymentPlatformModel: typeof import("./Payment/PaymentPlatformModel");
21
- const RewardsPlatformModel: typeof import("./Rewards/RewardsPlatformModel");
22
21
  const SharePlatformModel: typeof import("./Share/SharePlatformModel");
23
22
  const ThemePlatformModel: typeof import("./Theme/ThemePlatformModel");
24
23
  const UserPlatformModel: typeof import("./User/UserPlatformModel");
@@ -36,8 +36,6 @@ module.exports = {
36
36
 
37
37
  PaymentPlatformModel: require("./Payment/PaymentPlatformModel"),
38
38
 
39
- RewardsPlatformModel: require("./Rewards/RewardsPlatformModel"),
40
-
41
39
  SharePlatformModel: require("./Share/SharePlatformModel"),
42
40
 
43
41
  ThemePlatformModel: require("./Theme/ThemePlatformModel"),
@@ -37,6 +37,11 @@ export = ConfigurationPublicModel;
37
37
  * redirection is for long time period redirection, and temporary redirection
38
38
  * for a short time period.
39
39
  */
40
+ /**
41
+ * @typedef RegionDetails
42
+ * @property {string} [slug] - Region slug identifier.
43
+ * @property {string} [zone] - Zone identifier within the region.
44
+ */
40
45
  /**
41
46
  * @typedef ApplicationMeta
42
47
  * @property {string} [name] - Indicates the name of application meta
@@ -82,6 +87,9 @@ export = ConfigurationPublicModel;
82
87
  * @property {SecureUrl} [mobile_logo]
83
88
  * @property {Domain} [domain]
84
89
  * @property {string} [slug]
90
+ * @property {string} [region] - Region identifier for the sales channel. When
91
+ * zone is "default", this equals the slug. Otherwise, it is formatted as "slug/zone".
92
+ * @property {RegionDetails} [region_details]
85
93
  */
86
94
  /**
87
95
  * @typedef NotFound
@@ -129,7 +137,7 @@ export = ConfigurationPublicModel;
129
137
  declare class ConfigurationPublicModel {
130
138
  }
131
139
  declare namespace ConfigurationPublicModel {
132
- export { ApplicationResponseSchema, Domain, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, NotFound, BadRequestSchema, LocationDefaultLanguage, LocationDefaultCurrency, LocationCountry, Locations };
140
+ export { ApplicationResponseSchema, Domain, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, RegionDetails, ApplicationMeta, SecureUrl, Application, NotFound, BadRequestSchema, LocationDefaultLanguage, LocationDefaultCurrency, LocationCountry, Locations };
133
141
  }
134
142
  /** @returns {ApplicationResponseSchema} */
135
143
  declare function ApplicationResponseSchema(): ApplicationResponseSchema;
@@ -208,6 +216,18 @@ type ApplicationRedirections = {
208
216
  */
209
217
  type?: string;
210
218
  };
219
+ /** @returns {RegionDetails} */
220
+ declare function RegionDetails(): RegionDetails;
221
+ type RegionDetails = {
222
+ /**
223
+ * - Region slug identifier.
224
+ */
225
+ slug?: string;
226
+ /**
227
+ * - Zone identifier within the region.
228
+ */
229
+ zone?: string;
230
+ };
211
231
  /** @returns {ApplicationMeta} */
212
232
  declare function ApplicationMeta(): ApplicationMeta;
213
233
  type ApplicationMeta = {
@@ -307,6 +327,12 @@ type Application = {
307
327
  mobile_logo?: SecureUrl;
308
328
  domain?: Domain;
309
329
  slug?: string;
330
+ /**
331
+ * - Region identifier for the sales channel. When
332
+ * zone is "default", this equals the slug. Otherwise, it is formatted as "slug/zone".
333
+ */
334
+ region?: string;
335
+ region_details?: RegionDetails;
310
336
  };
311
337
  /** @returns {NotFound} */
312
338
  declare function NotFound(): NotFound;
@@ -44,6 +44,12 @@ const Joi = require("joi");
44
44
  * for a short time period.
45
45
  */
46
46
 
47
+ /**
48
+ * @typedef RegionDetails
49
+ * @property {string} [slug] - Region slug identifier.
50
+ * @property {string} [zone] - Zone identifier within the region.
51
+ */
52
+
47
53
  /**
48
54
  * @typedef ApplicationMeta
49
55
  * @property {string} [name] - Indicates the name of application meta
@@ -91,6 +97,9 @@ const Joi = require("joi");
91
97
  * @property {SecureUrl} [mobile_logo]
92
98
  * @property {Domain} [domain]
93
99
  * @property {string} [slug]
100
+ * @property {string} [region] - Region identifier for the sales channel. When
101
+ * zone is "default", this equals the slug. Otherwise, it is formatted as "slug/zone".
102
+ * @property {RegionDetails} [region_details]
94
103
  */
95
104
 
96
105
  /**
@@ -193,6 +202,14 @@ class ConfigurationPublicModel {
193
202
  });
194
203
  }
195
204
 
205
+ /** @returns {RegionDetails} */
206
+ static RegionDetails() {
207
+ return Joi.object({
208
+ slug: Joi.string().allow(""),
209
+ zone: Joi.string().allow(""),
210
+ });
211
+ }
212
+
196
213
  /** @returns {ApplicationMeta} */
197
214
  static ApplicationMeta() {
198
215
  return Joi.object({
@@ -239,6 +256,8 @@ class ConfigurationPublicModel {
239
256
  mobile_logo: ConfigurationPublicModel.SecureUrl(),
240
257
  domain: ConfigurationPublicModel.Domain(),
241
258
  slug: Joi.string().allow(""),
259
+ region: Joi.string().allow(""),
260
+ region_details: ConfigurationPublicModel.RegionDetails(),
242
261
  });
243
262
  }
244
263
 
@@ -14,6 +14,16 @@ export = WebhookPublicModel;
14
14
  * @property {string} [updated_on] - The timestamp when the event configuration
15
15
  * was last updated.
16
16
  * @property {string} [group] - The group to which the event belongs.
17
+ * @property {string} [sunset_date] - The date and time after which the event is
18
+ * considered sunset. After this timestamp, the entity should no longer be
19
+ * actively used, referenced, or offered for new operations, even if it still exists.
20
+ * @property {string} [announcement_date] - The date and time when the
21
+ * deprecation of the event is officially announced. This marks the start of
22
+ * the deprecation notice period and indicates that the entity is planned to
23
+ * be retired in the future, but may still remain available until the sunset date.
24
+ * @property {string} [support_end_date] - The date and time after which
25
+ * official support for the event ends. Beyond this point, no guarantees are
26
+ * made for maintenance, updates, fixes, or issue resolution.
17
27
  */
18
28
  /**
19
29
  * @typedef EventDetails
@@ -150,6 +160,25 @@ type EventConfig = {
150
160
  * - The group to which the event belongs.
151
161
  */
152
162
  group?: string;
163
+ /**
164
+ * - The date and time after which the event is
165
+ * considered sunset. After this timestamp, the entity should no longer be
166
+ * actively used, referenced, or offered for new operations, even if it still exists.
167
+ */
168
+ sunset_date?: string;
169
+ /**
170
+ * - The date and time when the
171
+ * deprecation of the event is officially announced. This marks the start of
172
+ * the deprecation notice period and indicates that the entity is planned to
173
+ * be retired in the future, but may still remain available until the sunset date.
174
+ */
175
+ announcement_date?: string;
176
+ /**
177
+ * - The date and time after which
178
+ * official support for the event ends. Beyond this point, no guarantees are
179
+ * made for maintenance, updates, fixes, or issue resolution.
180
+ */
181
+ support_end_date?: string;
153
182
  };
154
183
  /** @returns {EventDetails} */
155
184
  declare function EventDetails(): EventDetails;
@@ -15,6 +15,16 @@ const Joi = require("joi");
15
15
  * @property {string} [updated_on] - The timestamp when the event configuration
16
16
  * was last updated.
17
17
  * @property {string} [group] - The group to which the event belongs.
18
+ * @property {string} [sunset_date] - The date and time after which the event is
19
+ * considered sunset. After this timestamp, the entity should no longer be
20
+ * actively used, referenced, or offered for new operations, even if it still exists.
21
+ * @property {string} [announcement_date] - The date and time when the
22
+ * deprecation of the event is officially announced. This marks the start of
23
+ * the deprecation notice period and indicates that the entity is planned to
24
+ * be retired in the future, but may still remain available until the sunset date.
25
+ * @property {string} [support_end_date] - The date and time after which
26
+ * official support for the event ends. Beyond this point, no guarantees are
27
+ * made for maintenance, updates, fixes, or issue resolution.
18
28
  */
19
29
 
20
30
  /**
@@ -125,6 +135,9 @@ class WebhookPublicModel {
125
135
  created_on: Joi.string().allow(""),
126
136
  updated_on: Joi.string().allow(""),
127
137
  group: Joi.string().allow("").allow(null),
138
+ sunset_date: Joi.string().allow("").allow(null),
139
+ announcement_date: Joi.string().allow("").allow(null),
140
+ support_end_date: Joi.string().allow("").allow(null),
128
141
  });
129
142
  }
130
143
 
@@ -1,79 +0,0 @@
1
- export = Rewards;
2
- declare class Rewards {
3
- constructor(_conf: any);
4
- _conf: any;
5
- _relativeUrls: {
6
- catalogueOrder: string;
7
- getOfferByName: string;
8
- getOrderDiscount: string;
9
- getUserPoints: string;
10
- getUserPointsHistory: string;
11
- getUserReferralDetails: string;
12
- redeemReferralCode: string;
13
- };
14
- _urls: {};
15
- updateUrls(urls: any): void;
16
- /**
17
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
18
- * @param {import("../ApplicationAPIClient").Options} - Options
19
- * @returns {Promise<CatalogueOrderDetails>} - Success response
20
- * @name catalogueOrder
21
- * @summary: Order from catalogue
22
- * @description: Place a reward on order items available in the catalogue. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/catalogueOrder/).
23
- */
24
- catalogueOrder({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CatalogueOrderDetails>;
25
- /**
26
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
27
- * @param {import("../ApplicationAPIClient").Options} - Options
28
- * @returns {Promise<Offer>} - Success response
29
- * @name getOfferByName
30
- * @summary: Get specific offer
31
- * @description: Retrieves detailed information about an offer by its name. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getOfferByName/).
32
- */
33
- getOfferByName({ name, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<Offer>;
34
- /**
35
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
36
- * @param {import("../ApplicationAPIClient").Options} - Options
37
- * @returns {Promise<OrderDiscountDetails>} - Success response
38
- * @name getOrderDiscount
39
- * @summary: Order discount
40
- * @description: Retrieve the discount applied to a specific order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getOrderDiscount/).
41
- */
42
- getOrderDiscount({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OrderDiscountDetails>;
43
- /**
44
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
45
- * @param {import("../ApplicationAPIClient").Options} - Options
46
- * @returns {Promise<PointsDetails>} - Success response
47
- * @name getUserPoints
48
- * @summary: Current points
49
- * @description: Retrieves the current reward points balance for the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserPoints/).
50
- */
51
- getUserPoints({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PointsDetails>;
52
- /**
53
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
54
- * @param {import("../ApplicationAPIClient").Options} - Options
55
- * @returns {Promise<PointsHistoryDetails>} - Success response
56
- * @name getUserPointsHistory
57
- * @summary: Points history
58
- * @description: Gets the historical data of points earned or spent by the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserPointsHistory/).
59
- */
60
- getUserPointsHistory({ pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PointsHistoryDetails>;
61
- /**
62
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
63
- * @param {import("../ApplicationAPIClient").Options} - Options
64
- * @returns {Promise<ReferralDetails>} - Success response
65
- * @name getUserReferralDetails
66
- * @summary: Referral details
67
- * @description: Gets the details of the user’s referral status and codes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserReferralDetails/).
68
- */
69
- getUserReferralDetails({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ReferralDetails>;
70
- /**
71
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
72
- * @param {import("../ApplicationAPIClient").Options} - Options
73
- * @returns {Promise<RedeemReferralCodeDetails>} - Success response
74
- * @name redeemReferralCode
75
- * @summary: Redeem code
76
- * @description: Applies a referral code to earn or redeem rewards. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/redeemReferralCode/).
77
- */
78
- redeemReferralCode({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<RedeemReferralCodeDetails>;
79
- }