@gofynd/fdk-client-javascript 3.1.0 → 3.3.0

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.
package/README.md CHANGED
@@ -237,7 +237,7 @@ console.log("Active Theme: ", response.information.name);
237
237
  The above code will log the curl command in the console
238
238
 
239
239
  ```bash
240
- curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.1.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
240
+ curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.3.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
241
241
  Active Theme: Emerge
242
242
  ```
243
243
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gofynd/fdk-client-javascript",
3
- "version": "3.1.0",
3
+ "version": "3.3.0",
4
4
  "description": "",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -10,7 +10,7 @@
10
10
  "build": "webpack",
11
11
  "prettier": "npx prettier -w ./sdk ./tests && npx tsc"
12
12
  },
13
- "author": "Jigar Dafda<jigar.dafda@gmail.com>",
13
+ "author": "Jigar Dafda",
14
14
  "license": "ISC",
15
15
  "dependencies": {
16
16
  "axios": "^1.6.4",
@@ -87,7 +87,7 @@ declare class Cart {
87
87
  * @returns {Promise<CartCheckoutResult>} - Success response
88
88
  * @name checkoutCartV2
89
89
  * @summary: Checkout cart
90
- * @description: The checkout cart initiates the order creation process based on the items in the users cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/checkoutCartV2/).
90
+ * @description: The checkout cart initiates the order creation process based on the items in the user's cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/checkoutCartV2/).
91
91
  */
92
92
  checkoutCartV2({ body, xOrderingSource, buyNow, cartType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CartCheckoutResult>;
93
93
  /**
@@ -291,7 +291,7 @@ class Cart {
291
291
  * @returns {Promise<CartCheckoutResult>} - Success response
292
292
  * @name checkoutCartV2
293
293
  * @summary: Checkout cart
294
- * @description: The checkout cart initiates the order creation process based on the items in the users cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/checkoutCartV2/).
294
+ * @description: The checkout cart initiates the order creation process based on the items in the user's cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/checkoutCartV2/).
295
295
  */
296
296
  async checkoutCartV2(
297
297
  { body, xOrderingSource, buyNow, cartType, requestHeaders } = {
@@ -5,13 +5,11 @@ export = FileStoragePartnerModel;
5
5
  */
6
6
  /**
7
7
  * @typedef SaveProxy
8
- * @property {number} [id]
9
- * @property {string} [token]
8
+ * @property {boolean} [success]
10
9
  */
11
10
  /**
12
11
  * @typedef ProxyFileData
13
- * @property {string} [email]
14
- * @property {string} [password]
12
+ * @property {string} [name]
15
13
  */
16
14
  /**
17
15
  * @typedef ProxyFile
@@ -24,8 +22,7 @@ export = FileStoragePartnerModel;
24
22
  */
25
23
  /**
26
24
  * @typedef FetchProxyDetails
27
- * @property {Object} [data]
28
- * @property {Object} [support]
25
+ * @property {boolean} [success]
29
26
  */
30
27
  /**
31
28
  * @typedef NamespaceDetails
@@ -127,14 +124,12 @@ type SizeConstraints = {
127
124
  /** @returns {SaveProxy} */
128
125
  declare function SaveProxy(): SaveProxy;
129
126
  type SaveProxy = {
130
- id?: number;
131
- token?: string;
127
+ success?: boolean;
132
128
  };
133
129
  /** @returns {ProxyFileData} */
134
130
  declare function ProxyFileData(): ProxyFileData;
135
131
  type ProxyFileData = {
136
- email?: string;
137
- password?: string;
132
+ name?: string;
138
133
  };
139
134
  /** @returns {ProxyFile} */
140
135
  declare function ProxyFile(): ProxyFile;
@@ -149,8 +144,7 @@ type ProxyFile = {
149
144
  /** @returns {FetchProxyDetails} */
150
145
  declare function FetchProxyDetails(): FetchProxyDetails;
151
146
  type FetchProxyDetails = {
152
- data?: any;
153
- support?: any;
147
+ success?: boolean;
154
148
  };
155
149
  /** @returns {NamespaceDetails} */
156
150
  declare function NamespaceDetails(): NamespaceDetails;
@@ -7,14 +7,12 @@ const Joi = require("joi");
7
7
 
8
8
  /**
9
9
  * @typedef SaveProxy
10
- * @property {number} [id]
11
- * @property {string} [token]
10
+ * @property {boolean} [success]
12
11
  */
13
12
 
14
13
  /**
15
14
  * @typedef ProxyFileData
16
- * @property {string} [email]
17
- * @property {string} [password]
15
+ * @property {string} [name]
18
16
  */
19
17
 
20
18
  /**
@@ -29,8 +27,7 @@ const Joi = require("joi");
29
27
 
30
28
  /**
31
29
  * @typedef FetchProxyDetails
32
- * @property {Object} [data]
33
- * @property {Object} [support]
30
+ * @property {boolean} [success]
34
31
  */
35
32
 
36
33
  /**
@@ -140,16 +137,14 @@ class FileStoragePartnerModel {
140
137
  /** @returns {SaveProxy} */
141
138
  static SaveProxy() {
142
139
  return Joi.object({
143
- id: Joi.number(),
144
- token: Joi.string().allow(""),
140
+ success: Joi.boolean(),
145
141
  });
146
142
  }
147
143
 
148
144
  /** @returns {ProxyFileData} */
149
145
  static ProxyFileData() {
150
146
  return Joi.object({
151
- email: Joi.string().allow(""),
152
- password: Joi.string().allow(""),
147
+ name: Joi.string().allow(""),
153
148
  });
154
149
  }
155
150
 
@@ -168,8 +163,7 @@ class FileStoragePartnerModel {
168
163
  /** @returns {FetchProxyDetails} */
169
164
  static FetchProxyDetails() {
170
165
  return Joi.object({
171
- data: Joi.object().pattern(/\S/, Joi.any()),
172
- support: Joi.object().pattern(/\S/, Joi.any()),
166
+ success: Joi.boolean(),
173
167
  });
174
168
  }
175
169
 
@@ -36,7 +36,7 @@ declare class Configuration {
36
36
  * Success response
37
37
  * @name getAppApiTokens
38
38
  * @summary: Get sales channel API tokens
39
- * @description: Retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppApiTokens/).
39
+ * @description: Retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppApiTokens/).
40
40
  */
41
41
  getAppApiTokens({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.TokenResponseSchema>;
42
42
  /**
@@ -186,7 +186,7 @@ class Configuration {
186
186
  * Success response
187
187
  * @name getAppApiTokens
188
188
  * @summary: Get sales channel API tokens
189
- * @description: Retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppApiTokens/).
189
+ * @description: Retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppApiTokens/).
190
190
  */
191
191
  async getAppApiTokens(
192
192
  { requestHeaders } = { requestHeaders: {} },
@@ -3926,7 +3926,9 @@ export = OrderPlatformModel;
3926
3926
  * a discount when buying in a bundle. - custom- A custom promotion not
3927
3927
  * covered by other types. - free_gift_items- Free gift items are included
3928
3928
  * with the purchase. - free_non_sellable_items- Free items that are not for
3929
- * sale are included with the purchase.
3929
+ * sale are included with the purchase. - item_based_discount- Specific
3930
+ * percentage discounts on selected items based on their position after
3931
+ * sorting by price in descending order.
3930
3932
  * @property {string} [promotion_name] - The name of the promotional campaign or offer.
3931
3933
  * @property {DiscountRules[]} [discount_rules] - A list of rules that define
3932
3934
  * the conditions under which discounts are applied.
@@ -13084,7 +13086,9 @@ type AppliedPromos = {
13084
13086
  * a discount when buying in a bundle. - custom- A custom promotion not
13085
13087
  * covered by other types. - free_gift_items- Free gift items are included
13086
13088
  * with the purchase. - free_non_sellable_items- Free items that are not for
13087
- * sale are included with the purchase.
13089
+ * sale are included with the purchase. - item_based_discount- Specific
13090
+ * percentage discounts on selected items based on their position after
13091
+ * sorting by price in descending order.
13088
13092
  */
13089
13093
  promotion_type?: string;
13090
13094
  /**
@@ -4231,7 +4231,9 @@ const Joi = require("joi");
4231
4231
  * a discount when buying in a bundle. - custom- A custom promotion not
4232
4232
  * covered by other types. - free_gift_items- Free gift items are included
4233
4233
  * with the purchase. - free_non_sellable_items- Free items that are not for
4234
- * sale are included with the purchase.
4234
+ * sale are included with the purchase. - item_based_discount- Specific
4235
+ * percentage discounts on selected items based on their position after
4236
+ * sorting by price in descending order.
4235
4237
  * @property {string} [promotion_name] - The name of the promotional campaign or offer.
4236
4238
  * @property {DiscountRules[]} [discount_rules] - A list of rules that define
4237
4239
  * the conditions under which discounts are applied.
@@ -507,6 +507,7 @@ export = UserPlatformModel;
507
507
  * @property {string} [updated_at]
508
508
  * @property {string} [external_id]
509
509
  * @property {string} [rr_id]
510
+ * @property {UserConsent} [consent]
510
511
  */
511
512
  /**
512
513
  * @typedef UserSearchSchema
@@ -531,6 +532,7 @@ export = UserPlatformModel;
531
532
  * @property {boolean} [archive]
532
533
  * @property {string} [status]
533
534
  * @property {string} [deleted_on]
535
+ * @property {UserConsent} [consent]
534
536
  */
535
537
  /**
536
538
  * @typedef PhoneNumber
@@ -547,10 +549,19 @@ export = UserPlatformModel;
547
549
  * @property {boolean} [primary] - Is it a primary email.
548
550
  * @property {boolean} [verified] - Is the email verified.
549
551
  */
552
+ /**
553
+ * @typedef UserConsent
554
+ * @property {PrivacyPolicyConsentSchema} [privacy_policy]
555
+ */
556
+ /**
557
+ * @typedef PrivacyPolicyConsentSchema
558
+ * @property {boolean} [value] - Whether the user has consented to the privacy policy
559
+ * @property {string} [updated_at] - When the consent was last updated
560
+ */
550
561
  declare class UserPlatformModel {
551
562
  }
552
563
  declare namespace UserPlatformModel {
553
- export { SuccessMessage, UserAttributeDefinition, UserAttributeDefinitionDetails, UserAttributeDefinitionValidation, UserAttribute, CreateUserAttribute, CreateUserAttributeDefinition, CreateStoreFrontUsersPayload, BulkUserExportSchema, BulkActionModel, CreatedBySchema, BulkActionLinkSchema, FileLinks, BulkActionCountSchema, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, BulkActionPaginationSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, GetUserTimeline, UserTimeline, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email };
564
+ export { SuccessMessage, UserAttributeDefinition, UserAttributeDefinitionDetails, UserAttributeDefinitionValidation, UserAttribute, CreateUserAttribute, CreateUserAttributeDefinition, CreateStoreFrontUsersPayload, BulkUserExportSchema, BulkActionModel, CreatedBySchema, BulkActionLinkSchema, FileLinks, BulkActionCountSchema, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, BulkActionPaginationSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, GetUserTimeline, UserTimeline, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email, UserConsent, PrivacyPolicyConsentSchema };
554
565
  }
555
566
  /** @returns {SuccessMessage} */
556
567
  declare function SuccessMessage(): SuccessMessage;
@@ -1364,6 +1375,7 @@ type UserSchema = {
1364
1375
  updated_at?: string;
1365
1376
  external_id?: string;
1366
1377
  rr_id?: string;
1378
+ consent?: UserConsent;
1367
1379
  };
1368
1380
  /** @returns {UserSearchSchema} */
1369
1381
  declare function UserSearchSchema(): UserSearchSchema;
@@ -1389,6 +1401,7 @@ type UserSearchSchema = {
1389
1401
  archive?: boolean;
1390
1402
  status?: string;
1391
1403
  deleted_on?: string;
1404
+ consent?: UserConsent;
1392
1405
  };
1393
1406
  /** @returns {PhoneNumber} */
1394
1407
  declare function PhoneNumber(): PhoneNumber;
@@ -1434,3 +1447,20 @@ type Email = {
1434
1447
  */
1435
1448
  verified?: boolean;
1436
1449
  };
1450
+ /** @returns {UserConsent} */
1451
+ declare function UserConsent(): UserConsent;
1452
+ type UserConsent = {
1453
+ privacy_policy?: PrivacyPolicyConsentSchema;
1454
+ };
1455
+ /** @returns {PrivacyPolicyConsentSchema} */
1456
+ declare function PrivacyPolicyConsentSchema(): PrivacyPolicyConsentSchema;
1457
+ type PrivacyPolicyConsentSchema = {
1458
+ /**
1459
+ * - Whether the user has consented to the privacy policy
1460
+ */
1461
+ value?: boolean;
1462
+ /**
1463
+ * - When the consent was last updated
1464
+ */
1465
+ updated_at?: string;
1466
+ };
@@ -574,6 +574,7 @@ const Joi = require("joi");
574
574
  * @property {string} [updated_at]
575
575
  * @property {string} [external_id]
576
576
  * @property {string} [rr_id]
577
+ * @property {UserConsent} [consent]
577
578
  */
578
579
 
579
580
  /**
@@ -599,6 +600,7 @@ const Joi = require("joi");
599
600
  * @property {boolean} [archive]
600
601
  * @property {string} [status]
601
602
  * @property {string} [deleted_on]
603
+ * @property {UserConsent} [consent]
602
604
  */
603
605
 
604
606
  /**
@@ -618,6 +620,17 @@ const Joi = require("joi");
618
620
  * @property {boolean} [verified] - Is the email verified.
619
621
  */
620
622
 
623
+ /**
624
+ * @typedef UserConsent
625
+ * @property {PrivacyPolicyConsentSchema} [privacy_policy]
626
+ */
627
+
628
+ /**
629
+ * @typedef PrivacyPolicyConsentSchema
630
+ * @property {boolean} [value] - Whether the user has consented to the privacy policy
631
+ * @property {string} [updated_at] - When the consent was last updated
632
+ */
633
+
621
634
  class UserPlatformModel {
622
635
  /** @returns {SuccessMessage} */
623
636
  static SuccessMessage() {
@@ -1311,6 +1324,7 @@ class UserPlatformModel {
1311
1324
  updated_at: Joi.string().allow(""),
1312
1325
  external_id: Joi.string().allow(""),
1313
1326
  rr_id: Joi.string().allow(""),
1327
+ consent: UserPlatformModel.UserConsent(),
1314
1328
  });
1315
1329
  }
1316
1330
 
@@ -1338,6 +1352,7 @@ class UserPlatformModel {
1338
1352
  archive: Joi.boolean(),
1339
1353
  status: Joi.string().allow(""),
1340
1354
  deleted_on: Joi.string().allow(""),
1355
+ consent: UserPlatformModel.UserConsent(),
1341
1356
  });
1342
1357
  }
1343
1358
 
@@ -1361,5 +1376,20 @@ class UserPlatformModel {
1361
1376
  verified: Joi.boolean(),
1362
1377
  });
1363
1378
  }
1379
+
1380
+ /** @returns {UserConsent} */
1381
+ static UserConsent() {
1382
+ return Joi.object({
1383
+ privacy_policy: UserPlatformModel.PrivacyPolicyConsentSchema(),
1384
+ });
1385
+ }
1386
+
1387
+ /** @returns {PrivacyPolicyConsentSchema} */
1388
+ static PrivacyPolicyConsentSchema() {
1389
+ return Joi.object({
1390
+ value: Joi.boolean(),
1391
+ updated_at: Joi.string().allow(""),
1392
+ });
1393
+ }
1364
1394
  }
1365
1395
  module.exports = UserPlatformModel;