@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.5
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 +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
- package/sdk/application/Cart/CartApplicationClient.js +82 -71
- package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
- package/sdk/application/Cart/CartApplicationValidator.js +59 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
- package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
- package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
- package/sdk/application/Content/ContentApplicationClient.js +34 -115
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
- package/sdk/application/Lead/LeadApplicationClient.js +14 -14
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
- package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
- package/sdk/application/Order/OrderApplicationClient.js +24 -24
- package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
- package/sdk/application/Order/OrderApplicationModel.js +28 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
- package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
- package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +64 -64
- package/sdk/application/User/UserApplicationClient.js +64 -64
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
- package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
- package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
- package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
- package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +7 -7
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +19 -55
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -55
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -12
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -14
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
- package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
- package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
- package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
- package/sdk/platform/Order/OrderPlatformClient.js +79 -294
- package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
- package/sdk/platform/Order/OrderPlatformModel.js +34 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
- package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
- package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
- package/sdk/platform/User/UserPlatformModel.js +2 -2
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
|
@@ -20,8 +20,8 @@ class Configuration {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<ConfigurationPlatformModel.CreateAppResponse>} - Success response
|
|
22
22
|
* @name createApplication
|
|
23
|
-
* @summary: Create
|
|
24
|
-
* @description: Applications are sales channel websites which can be configured, personalized and customized. Use this API to create a new application in the current company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/createApplication/).
|
|
23
|
+
* @summary: Create application.
|
|
24
|
+
* @description: Generate and add a new application. Applications are sales channel websites which can be configured, personalized and customized. Use this API to create a new application in the current company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/createApplication/).
|
|
25
25
|
*/
|
|
26
26
|
async createApplication(
|
|
27
27
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -102,8 +102,8 @@ class Configuration {
|
|
|
102
102
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationsResponse>} -
|
|
103
103
|
* Success response
|
|
104
104
|
* @name getApplications
|
|
105
|
-
* @summary: Get
|
|
106
|
-
* @description: Applications are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of applications created within a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplications/).
|
|
105
|
+
* @summary: Get applications.
|
|
106
|
+
* @description: Retrieve a list of available applications. Applications are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of applications created within a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplications/).
|
|
107
107
|
*/
|
|
108
108
|
async getApplications(
|
|
109
109
|
{ pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -182,35 +182,6 @@ class Configuration {
|
|
|
182
182
|
return response;
|
|
183
183
|
}
|
|
184
184
|
|
|
185
|
-
/**
|
|
186
|
-
* @param {Object} arg - Arg object.
|
|
187
|
-
* @param {number} [arg.pageSize] -
|
|
188
|
-
* @param {string} [arg.q] - Search param by name or domain
|
|
189
|
-
* @returns {Paginator<ConfigurationPlatformModel.ApplicationsResponse>}
|
|
190
|
-
* @summary: Get list of registered sales channels under company
|
|
191
|
-
* @description: Applications are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of applications created within a company.
|
|
192
|
-
*/
|
|
193
|
-
getApplicationsPaginator({ pageSize, q } = {}) {
|
|
194
|
-
const paginator = new Paginator();
|
|
195
|
-
const callback = async () => {
|
|
196
|
-
const pageId = paginator.nextId;
|
|
197
|
-
const pageNo = paginator.pageNo;
|
|
198
|
-
const pageType = "number";
|
|
199
|
-
const data = await this.getApplications({
|
|
200
|
-
pageNo: pageNo,
|
|
201
|
-
pageSize: pageSize,
|
|
202
|
-
q: q,
|
|
203
|
-
});
|
|
204
|
-
paginator.setPaginator({
|
|
205
|
-
hasNext: data.page.has_next ? true : false,
|
|
206
|
-
nextId: data.page.next_id,
|
|
207
|
-
});
|
|
208
|
-
return data;
|
|
209
|
-
};
|
|
210
|
-
paginator.setCallback(callback.bind(this));
|
|
211
|
-
return paginator;
|
|
212
|
-
}
|
|
213
|
-
|
|
214
185
|
/**
|
|
215
186
|
* @param {ConfigurationPlatformValidator.GetAvailableOptInsParam} arg - Arg object
|
|
216
187
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -219,8 +190,8 @@ class Configuration {
|
|
|
219
190
|
* - Success response
|
|
220
191
|
*
|
|
221
192
|
* @name getAvailableOptIns
|
|
222
|
-
* @summary: Get
|
|
223
|
-
* @description:
|
|
193
|
+
* @summary: Get available opt-ins.
|
|
194
|
+
* @description: Retrieve a list of available opt-ins. Retrieve a list of all available integrations in a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAvailableOptIns/).
|
|
224
195
|
*/
|
|
225
196
|
async getAvailableOptIns(
|
|
226
197
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -298,34 +269,6 @@ class Configuration {
|
|
|
298
269
|
return response;
|
|
299
270
|
}
|
|
300
271
|
|
|
301
|
-
/**
|
|
302
|
-
* @param {Object} arg - Arg object.
|
|
303
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
304
|
-
* page. Default value is 10.
|
|
305
|
-
* @returns {Paginator<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>}
|
|
306
|
-
* @summary: Get all available integration opt-ins
|
|
307
|
-
* @description: Use this API to get a list of all available integrations in a company
|
|
308
|
-
*/
|
|
309
|
-
getAvailableOptInsPaginator({ pageSize } = {}) {
|
|
310
|
-
const paginator = new Paginator();
|
|
311
|
-
const callback = async () => {
|
|
312
|
-
const pageId = paginator.nextId;
|
|
313
|
-
const pageNo = paginator.pageNo;
|
|
314
|
-
const pageType = "number";
|
|
315
|
-
const data = await this.getAvailableOptIns({
|
|
316
|
-
pageNo: pageNo,
|
|
317
|
-
pageSize: pageSize,
|
|
318
|
-
});
|
|
319
|
-
paginator.setPaginator({
|
|
320
|
-
hasNext: data.page.has_next ? true : false,
|
|
321
|
-
nextId: data.page.next_id,
|
|
322
|
-
});
|
|
323
|
-
return data;
|
|
324
|
-
};
|
|
325
|
-
paginator.setCallback(callback.bind(this));
|
|
326
|
-
return paginator;
|
|
327
|
-
}
|
|
328
|
-
|
|
329
272
|
/**
|
|
330
273
|
* @param {ConfigurationPlatformValidator.GetBrandsByCompanyParam} arg - Arg object
|
|
331
274
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -334,7 +277,7 @@ class Configuration {
|
|
|
334
277
|
* Success response
|
|
335
278
|
* @name getBrandsByCompany
|
|
336
279
|
* @summary: Get brands by company.
|
|
337
|
-
* @description:
|
|
280
|
+
* @description: Retrieve all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBrandsByCompany/).
|
|
338
281
|
*/
|
|
339
282
|
async getBrandsByCompany(
|
|
340
283
|
{ q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -416,8 +359,8 @@ class Configuration {
|
|
|
416
359
|
* @returns {Promise<ConfigurationPlatformModel.CompanyByBrandsResponse>} -
|
|
417
360
|
* Success response
|
|
418
361
|
* @name getCompanyByBrands
|
|
419
|
-
* @summary: Get company by
|
|
420
|
-
* @description:
|
|
362
|
+
* @summary: Get company by brands.
|
|
363
|
+
* @description: Retrieve companies associated with specific brands. Retrieve a list of companies by the brands they deal. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCompanyByBrands/).
|
|
421
364
|
*/
|
|
422
365
|
async getCompanyByBrands(
|
|
423
366
|
{ body, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -497,36 +440,6 @@ class Configuration {
|
|
|
497
440
|
return response;
|
|
498
441
|
}
|
|
499
442
|
|
|
500
|
-
/**
|
|
501
|
-
* @param {Object} arg - Arg object.
|
|
502
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
503
|
-
* page. Default value is 10.
|
|
504
|
-
* @param {ConfigurationPlatformModel.CompanyByBrandsRequest} arg.body
|
|
505
|
-
* @returns {Paginator<ConfigurationPlatformModel.CompanyByBrandsResponse>}
|
|
506
|
-
* @summary: Get company by brand uids
|
|
507
|
-
* @description: Use this API to get a list of companies by the brands they deal
|
|
508
|
-
*/
|
|
509
|
-
getCompanyByBrandsPaginator({ pageSize, body } = {}) {
|
|
510
|
-
const paginator = new Paginator();
|
|
511
|
-
const callback = async () => {
|
|
512
|
-
const pageId = paginator.nextId;
|
|
513
|
-
const pageNo = paginator.pageNo;
|
|
514
|
-
const pageType = "number";
|
|
515
|
-
const data = await this.getCompanyByBrands({
|
|
516
|
-
body: body,
|
|
517
|
-
pageNo: pageNo,
|
|
518
|
-
pageSize: pageSize,
|
|
519
|
-
});
|
|
520
|
-
paginator.setPaginator({
|
|
521
|
-
hasNext: data.page.has_next ? true : false,
|
|
522
|
-
nextId: data.page.next_id,
|
|
523
|
-
});
|
|
524
|
-
return data;
|
|
525
|
-
};
|
|
526
|
-
paginator.setCallback(callback.bind(this));
|
|
527
|
-
return paginator;
|
|
528
|
-
}
|
|
529
|
-
|
|
530
443
|
/**
|
|
531
444
|
* @param {ConfigurationPlatformValidator.GetCurrenciesParam} arg - Arg object
|
|
532
445
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -534,8 +447,8 @@ class Configuration {
|
|
|
534
447
|
* @returns {Promise<ConfigurationPlatformModel.CurrenciesResponse>} -
|
|
535
448
|
* Success response
|
|
536
449
|
* @name getCurrencies
|
|
537
|
-
* @summary: Get
|
|
538
|
-
* @description: Use this API to get a list of currencies allowed in the company. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCurrencies/).
|
|
450
|
+
* @summary: Get currencies.
|
|
451
|
+
* @description: Retrieve a list of available currencies. Use this API to get a list of currencies allowed in the company. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCurrencies/).
|
|
539
452
|
*/
|
|
540
453
|
async getCurrencies(
|
|
541
454
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -611,8 +524,8 @@ class Configuration {
|
|
|
611
524
|
* - Success response
|
|
612
525
|
*
|
|
613
526
|
* @name getDomainAvailibility
|
|
614
|
-
* @summary:
|
|
615
|
-
* @description: Use this API to check the domain availability before linking it to application. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainAvailibility/).
|
|
527
|
+
* @summary: Get domain availability.
|
|
528
|
+
* @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to application. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainAvailibility/).
|
|
616
529
|
*/
|
|
617
530
|
async getDomainAvailibility(
|
|
618
531
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -692,8 +605,8 @@ class Configuration {
|
|
|
692
605
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
693
606
|
* @returns {Promise<ConfigurationPlatformModel.Integration>} - Success response
|
|
694
607
|
* @name getIntegrationById
|
|
695
|
-
* @summary: Get integration
|
|
696
|
-
* @description:
|
|
608
|
+
* @summary: Get integration by ID.
|
|
609
|
+
* @description: Retrieve detailed information about a specific integration. Retrieve the details of an integration (such as Ginesys, SAP, etc.) using its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationById/).
|
|
697
610
|
*/
|
|
698
611
|
async getIntegrationById(
|
|
699
612
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -775,8 +688,8 @@ class Configuration {
|
|
|
775
688
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
776
689
|
* @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
|
|
777
690
|
* @name getIntegrationByLevelId
|
|
778
|
-
* @summary: Get integration
|
|
779
|
-
* @description:
|
|
691
|
+
* @summary: Get integration by level ID.
|
|
692
|
+
* @description: Retrieve integration details for a specific level. Retrieve the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationByLevelId/).
|
|
780
693
|
*/
|
|
781
694
|
async getIntegrationByLevelId(
|
|
782
695
|
{ id, level, uid, requestHeaders } = { requestHeaders: {} },
|
|
@@ -864,8 +777,8 @@ class Configuration {
|
|
|
864
777
|
* - Success response
|
|
865
778
|
*
|
|
866
779
|
* @name getIntegrationLevelConfig
|
|
867
|
-
* @summary: Get integration level
|
|
868
|
-
* @description:
|
|
780
|
+
* @summary: Get integration level configuration.
|
|
781
|
+
* @description: Retrieve configuration settings for integration levels. Retrieve the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationLevelConfig/).
|
|
869
782
|
*/
|
|
870
783
|
async getIntegrationLevelConfig(
|
|
871
784
|
{ id, level, opted, checkPermission, requestHeaders } = {
|
|
@@ -958,8 +871,8 @@ class Configuration {
|
|
|
958
871
|
* @returns {Promise<ConfigurationPlatformModel.OptedStoreIntegration>} -
|
|
959
872
|
* Success response
|
|
960
873
|
* @name getLevelActiveIntegrations
|
|
961
|
-
* @summary:
|
|
962
|
-
* @description:
|
|
874
|
+
* @summary: Get active integrations for a level.
|
|
875
|
+
* @description: Check if a store is already opted-in for any integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getLevelActiveIntegrations/).
|
|
963
876
|
*/
|
|
964
877
|
async getLevelActiveIntegrations(
|
|
965
878
|
{ id, level, uid, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1047,8 +960,8 @@ class Configuration {
|
|
|
1047
960
|
* - Success response
|
|
1048
961
|
*
|
|
1049
962
|
* @name getOtherSellerApplicationById
|
|
1050
|
-
* @summary: Get other seller
|
|
1051
|
-
* @description:
|
|
963
|
+
* @summary: Get other seller application by ID.
|
|
964
|
+
* @description: Retrieve details of a seller application that was not created within the current company. but has opted for the current company's inventory - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplicationById/).
|
|
1052
965
|
*/
|
|
1053
966
|
async getOtherSellerApplicationById(
|
|
1054
967
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1131,8 +1044,8 @@ class Configuration {
|
|
|
1131
1044
|
* @returns {Promise<ConfigurationPlatformModel.OtherSellerApplications>} -
|
|
1132
1045
|
* Success response
|
|
1133
1046
|
* @name getOtherSellerApplications
|
|
1134
|
-
* @summary: Get other seller
|
|
1135
|
-
* @description:
|
|
1047
|
+
* @summary: Get other seller applications.
|
|
1048
|
+
* @description: Retrieve applications from other sellers. Retrieve all other seller applications that were not created within the current company. but have opted for the current company's inventory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplications/).
|
|
1136
1049
|
*/
|
|
1137
1050
|
async getOtherSellerApplications(
|
|
1138
1051
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1210,34 +1123,6 @@ class Configuration {
|
|
|
1210
1123
|
return response;
|
|
1211
1124
|
}
|
|
1212
1125
|
|
|
1213
|
-
/**
|
|
1214
|
-
* @param {Object} arg - Arg object.
|
|
1215
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
1216
|
-
* page. Default value is 10.
|
|
1217
|
-
* @returns {Paginator<ConfigurationPlatformModel.OtherSellerApplications>}
|
|
1218
|
-
* @summary: Get other seller sales channels
|
|
1219
|
-
* @description: Use this API to fetch all other seller applications that were not created within the current company. but have opted for the current company's inventory
|
|
1220
|
-
*/
|
|
1221
|
-
getOtherSellerApplicationsPaginator({ pageSize } = {}) {
|
|
1222
|
-
const paginator = new Paginator();
|
|
1223
|
-
const callback = async () => {
|
|
1224
|
-
const pageId = paginator.nextId;
|
|
1225
|
-
const pageNo = paginator.pageNo;
|
|
1226
|
-
const pageType = "number";
|
|
1227
|
-
const data = await this.getOtherSellerApplications({
|
|
1228
|
-
pageNo: pageNo,
|
|
1229
|
-
pageSize: pageSize,
|
|
1230
|
-
});
|
|
1231
|
-
paginator.setPaginator({
|
|
1232
|
-
hasNext: data.page.has_next ? true : false,
|
|
1233
|
-
nextId: data.page.next_id,
|
|
1234
|
-
});
|
|
1235
|
-
return data;
|
|
1236
|
-
};
|
|
1237
|
-
paginator.setCallback(callback.bind(this));
|
|
1238
|
-
return paginator;
|
|
1239
|
-
}
|
|
1240
|
-
|
|
1241
1126
|
/**
|
|
1242
1127
|
* @param {ConfigurationPlatformValidator.GetSelectedOptInsParam} arg - Arg object
|
|
1243
1128
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1246,8 +1131,8 @@ class Configuration {
|
|
|
1246
1131
|
* - Success response
|
|
1247
1132
|
*
|
|
1248
1133
|
* @name getSelectedOptIns
|
|
1249
|
-
* @summary: Get
|
|
1250
|
-
* @description:
|
|
1134
|
+
* @summary: Get selected opt-ins.
|
|
1135
|
+
* @description: Retrieve a list of selected opt-ins. Retrieve the store-level/company-level integrations configured in a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getSelectedOptIns/).
|
|
1251
1136
|
*/
|
|
1252
1137
|
async getSelectedOptIns(
|
|
1253
1138
|
{ level, uid, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1329,38 +1214,6 @@ class Configuration {
|
|
|
1329
1214
|
return response;
|
|
1330
1215
|
}
|
|
1331
1216
|
|
|
1332
|
-
/**
|
|
1333
|
-
* @param {Object} arg - Arg object.
|
|
1334
|
-
* @param {string} arg.level - Store or company
|
|
1335
|
-
* @param {number} arg.uid - Unique identifier of the selected integration level.
|
|
1336
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
1337
|
-
* page. Default value is 10.
|
|
1338
|
-
* @returns {Paginator<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>}
|
|
1339
|
-
* @summary: Get company/store level integration opt-ins
|
|
1340
|
-
* @description: Use this API to get the store-level/company-level integrations configured in a company
|
|
1341
|
-
*/
|
|
1342
|
-
getSelectedOptInsPaginator({ level, uid, pageSize } = {}) {
|
|
1343
|
-
const paginator = new Paginator();
|
|
1344
|
-
const callback = async () => {
|
|
1345
|
-
const pageId = paginator.nextId;
|
|
1346
|
-
const pageNo = paginator.pageNo;
|
|
1347
|
-
const pageType = "number";
|
|
1348
|
-
const data = await this.getSelectedOptIns({
|
|
1349
|
-
level: level,
|
|
1350
|
-
uid: uid,
|
|
1351
|
-
pageNo: pageNo,
|
|
1352
|
-
pageSize: pageSize,
|
|
1353
|
-
});
|
|
1354
|
-
paginator.setPaginator({
|
|
1355
|
-
hasNext: data.page.has_next ? true : false,
|
|
1356
|
-
nextId: data.page.next_id,
|
|
1357
|
-
});
|
|
1358
|
-
return data;
|
|
1359
|
-
};
|
|
1360
|
-
paginator.setCallback(callback.bind(this));
|
|
1361
|
-
return paginator;
|
|
1362
|
-
}
|
|
1363
|
-
|
|
1364
1217
|
/**
|
|
1365
1218
|
* @param {ConfigurationPlatformValidator.GetStoreByBrandsParam} arg - Arg object
|
|
1366
1219
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1368,8 +1221,8 @@ class Configuration {
|
|
|
1368
1221
|
* @returns {Promise<ConfigurationPlatformModel.StoreByBrandsResponse>} -
|
|
1369
1222
|
* Success response
|
|
1370
1223
|
* @name getStoreByBrands
|
|
1371
|
-
* @summary: Get
|
|
1372
|
-
* @description:
|
|
1224
|
+
* @summary: Get store by brands.
|
|
1225
|
+
* @description: Retrieve stores associated with specific brands. Retrieve a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStoreByBrands/).
|
|
1373
1226
|
*/
|
|
1374
1227
|
async getStoreByBrands(
|
|
1375
1228
|
{ body, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1449,36 +1302,6 @@ class Configuration {
|
|
|
1449
1302
|
return response;
|
|
1450
1303
|
}
|
|
1451
1304
|
|
|
1452
|
-
/**
|
|
1453
|
-
* @param {Object} arg - Arg object.
|
|
1454
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
1455
|
-
* page. Default value is 10.
|
|
1456
|
-
* @param {ConfigurationPlatformModel.StoreByBrandsRequest} arg.body
|
|
1457
|
-
* @returns {Paginator<ConfigurationPlatformModel.StoreByBrandsResponse>}
|
|
1458
|
-
* @summary: Get stores by brand uids for the current company
|
|
1459
|
-
* @description: Use this API to get a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail.
|
|
1460
|
-
*/
|
|
1461
|
-
getStoreByBrandsPaginator({ pageSize, body } = {}) {
|
|
1462
|
-
const paginator = new Paginator();
|
|
1463
|
-
const callback = async () => {
|
|
1464
|
-
const pageId = paginator.nextId;
|
|
1465
|
-
const pageNo = paginator.pageNo;
|
|
1466
|
-
const pageType = "number";
|
|
1467
|
-
const data = await this.getStoreByBrands({
|
|
1468
|
-
body: body,
|
|
1469
|
-
pageNo: pageNo,
|
|
1470
|
-
pageSize: pageSize,
|
|
1471
|
-
});
|
|
1472
|
-
paginator.setPaginator({
|
|
1473
|
-
hasNext: data.page.has_next ? true : false,
|
|
1474
|
-
nextId: data.page.next_id,
|
|
1475
|
-
});
|
|
1476
|
-
return data;
|
|
1477
|
-
};
|
|
1478
|
-
paginator.setCallback(callback.bind(this));
|
|
1479
|
-
return paginator;
|
|
1480
|
-
}
|
|
1481
|
-
|
|
1482
1305
|
/**
|
|
1483
1306
|
* @param {ConfigurationPlatformValidator.OptOutFromApplicationParam} arg - Arg object
|
|
1484
1307
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1486,8 +1309,8 @@ class Configuration {
|
|
|
1486
1309
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
1487
1310
|
* Success response
|
|
1488
1311
|
* @name optOutFromApplication
|
|
1489
|
-
* @summary: Opt
|
|
1490
|
-
* @description:
|
|
1312
|
+
* @summary: Opt out from an application.
|
|
1313
|
+
* @description: Choose to opt-out your company or store from other seller application. The specific seller application will no longer fetch inventory from your company or store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/optOutFromApplication/).
|
|
1491
1314
|
*/
|
|
1492
1315
|
async optOutFromApplication(
|
|
1493
1316
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1571,8 +1394,8 @@ class Configuration {
|
|
|
1571
1394
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1572
1395
|
* @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
|
|
1573
1396
|
* @name updateLevelIntegration
|
|
1574
|
-
* @summary: Update
|
|
1575
|
-
* @description:
|
|
1397
|
+
* @summary: Update level integration.
|
|
1398
|
+
* @description: Modify level integration. Update the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateLevelIntegration/).
|
|
1576
1399
|
*/
|
|
1577
1400
|
async updateLevelIntegration(
|
|
1578
1401
|
{ id, level, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1658,8 +1481,8 @@ class Configuration {
|
|
|
1658
1481
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1659
1482
|
* @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
|
|
1660
1483
|
* @name updateLevelUidIntegration
|
|
1661
|
-
* @summary: Update
|
|
1662
|
-
* @description: Update the level of integration by store UID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateLevelUidIntegration/).
|
|
1484
|
+
* @summary: Update level UID integration.
|
|
1485
|
+
* @description: Modify UID-based integration. Update the level of integration by store UID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateLevelUidIntegration/).
|
|
1663
1486
|
*/
|
|
1664
1487
|
async updateLevelUidIntegration(
|
|
1665
1488
|
{ id, level, uid, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1238,6 +1238,53 @@ export = ConfigurationPlatformModel;
|
|
|
1238
1238
|
* @property {TokenSchema[]} [tokens]
|
|
1239
1239
|
* @property {string} [secret]
|
|
1240
1240
|
*/
|
|
1241
|
+
/**
|
|
1242
|
+
* @typedef ApplicationById
|
|
1243
|
+
* @property {ApplicationWebsite} [website]
|
|
1244
|
+
* @property {ApplicationCors} [cors]
|
|
1245
|
+
* @property {ApplicationAuth} [auth]
|
|
1246
|
+
* @property {string} [description] - It contains detailed information about the
|
|
1247
|
+
* sales channel.
|
|
1248
|
+
* @property {string} [channel_type] - It indicates different types of channels,
|
|
1249
|
+
* such as store, website, and mobile apps, with 'store' being the default value.
|
|
1250
|
+
* @property {number} [cache_ttl] - An integer value that specifies the number
|
|
1251
|
+
* of seconds until the key expires
|
|
1252
|
+
* @property {boolean} [is_internal] - Indicates whether a sales channel is
|
|
1253
|
+
* internal or not
|
|
1254
|
+
* @property {boolean} [is_active] - Indicates sales channel is active or not active
|
|
1255
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
1256
|
+
* of the sales channel
|
|
1257
|
+
* @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
|
|
1258
|
+
* @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
|
|
1259
|
+
* of owner who owns the application
|
|
1260
|
+
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
1261
|
+
* where the sales channel exists
|
|
1262
|
+
* @property {string} [token] - Random generated fix length string for sales
|
|
1263
|
+
* channel. It is required and auto-generated.
|
|
1264
|
+
* @property {ApplicationRedirections[]} [redirections]
|
|
1265
|
+
* @property {ApplicationMeta[]} [meta]
|
|
1266
|
+
* @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
|
|
1267
|
+
* @property {string} [modified_at] - ISO 8601 timestamp of sales channel updation
|
|
1268
|
+
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
1269
|
+
* @property {SecureUrl} [banner]
|
|
1270
|
+
* @property {SecureUrl} [logo]
|
|
1271
|
+
* @property {SecureUrl} [favicon]
|
|
1272
|
+
* @property {Domain[]} [domains]
|
|
1273
|
+
* @property {string} [app_type] - It shows application is live or in development mode.
|
|
1274
|
+
* @property {SecureUrl} [mobile_logo]
|
|
1275
|
+
* @property {Domain} [domain]
|
|
1276
|
+
* @property {string} [slug]
|
|
1277
|
+
* @property {string} [mode]
|
|
1278
|
+
* @property {string} [status]
|
|
1279
|
+
* @property {TokenSchemaID[]} [tokens]
|
|
1280
|
+
* @property {string} [secret]
|
|
1281
|
+
*/
|
|
1282
|
+
/**
|
|
1283
|
+
* @typedef TokenSchemaID
|
|
1284
|
+
* @property {string} [token]
|
|
1285
|
+
* @property {string} [created_by]
|
|
1286
|
+
* @property {string} [created_at] - ISO 8601 timestamp of when token created
|
|
1287
|
+
*/
|
|
1241
1288
|
/**
|
|
1242
1289
|
* @typedef TokenSchema
|
|
1243
1290
|
* @property {string} [token]
|
|
@@ -1524,7 +1571,7 @@ export = ConfigurationPlatformModel;
|
|
|
1524
1571
|
declare class ConfigurationPlatformModel {
|
|
1525
1572
|
}
|
|
1526
1573
|
declare namespace ConfigurationPlatformModel {
|
|
1527
|
-
export { ApplicationInventory, PiiMasking, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequest, CompanyByBrandsResponse, StoreByBrandsRequest, StoreByBrandsResponse, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponse, ValidationFailedResponse, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequest, CreateAppResponse, ApplicationsResponse, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequest, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequest, Domain, DomainsResponse, UpdateDomain, UpdateDomainTypeRequest, DomainStatusRequest, DomainStatus, DomainStatusResponse, DomainSuggestionsRequest, DomainSuggestion, DomainSuggestionsResponse, SuccessMessageResponse, GetIntegrationsOptInsResponse, IntegrationOptIn, Validators, CompanyValidator, JsonSchema, StoreValidator, InventoryValidator, OrderValidator, IntegrationMeta, Integration, IntegrationConfigResponse, IntegrationLevel, UpdateIntegrationLevelRequest, OptedStoreIntegration, OtherEntity, LastPatch, OtherEntityData, App, InventoryConfig, AppInventory, AppDomain, CompaniesResponse, AppInventoryCompanies, StoresResponse, AppInventoryStores, FilterOrderingStoreRequest, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequest, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponse, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponse, Tokens, Firebase, Credentials, Ios, Android, Moengage, MoengageCredentials, Segment, SegmentCredentials, Gtm, GtmCredentials, Freshchat, FreshchatCredentials, Safetynet, SafetynetCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, RewardPointsConfig, Credit, Debit, ProductDetailFeature, LaunchPage, LandingPageFeature, ListingPageFeature, RegistrationPageFeature, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, AppFeatureRequest, AppFeatureResponse, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, TokenSchema, InvalidPayloadRequest, InventoryBrandRule, StoreCriteriaRule, InventoryStoreRule, InventoryPaymentConfig, StorePriorityRule, ArticleAssignmentRule, InventoryArticleAssignment, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponse, AppCurrencyResponse, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponse };
|
|
1574
|
+
export { ApplicationInventory, PiiMasking, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequest, CompanyByBrandsResponse, StoreByBrandsRequest, StoreByBrandsResponse, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponse, ValidationFailedResponse, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequest, CreateAppResponse, ApplicationsResponse, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequest, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequest, Domain, DomainsResponse, UpdateDomain, UpdateDomainTypeRequest, DomainStatusRequest, DomainStatus, DomainStatusResponse, DomainSuggestionsRequest, DomainSuggestion, DomainSuggestionsResponse, SuccessMessageResponse, GetIntegrationsOptInsResponse, IntegrationOptIn, Validators, CompanyValidator, JsonSchema, StoreValidator, InventoryValidator, OrderValidator, IntegrationMeta, Integration, IntegrationConfigResponse, IntegrationLevel, UpdateIntegrationLevelRequest, OptedStoreIntegration, OtherEntity, LastPatch, OtherEntityData, App, InventoryConfig, AppInventory, AppDomain, CompaniesResponse, AppInventoryCompanies, StoresResponse, AppInventoryStores, FilterOrderingStoreRequest, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequest, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponse, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponse, Tokens, Firebase, Credentials, Ios, Android, Moengage, MoengageCredentials, Segment, SegmentCredentials, Gtm, GtmCredentials, Freshchat, FreshchatCredentials, Safetynet, SafetynetCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, RewardPointsConfig, Credit, Debit, ProductDetailFeature, LaunchPage, LandingPageFeature, ListingPageFeature, RegistrationPageFeature, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, AppFeatureRequest, AppFeatureResponse, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, ApplicationById, TokenSchemaID, TokenSchema, InvalidPayloadRequest, InventoryBrandRule, StoreCriteriaRule, InventoryStoreRule, InventoryPaymentConfig, StorePriorityRule, ArticleAssignmentRule, InventoryArticleAssignment, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponse, AppCurrencyResponse, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponse };
|
|
1528
1575
|
}
|
|
1529
1576
|
/** @returns {ApplicationInventory} */
|
|
1530
1577
|
declare function ApplicationInventory(): ApplicationInventory;
|
|
@@ -3991,6 +4038,100 @@ type Application = {
|
|
|
3991
4038
|
tokens?: TokenSchema[];
|
|
3992
4039
|
secret?: string;
|
|
3993
4040
|
};
|
|
4041
|
+
/** @returns {ApplicationById} */
|
|
4042
|
+
declare function ApplicationById(): ApplicationById;
|
|
4043
|
+
type ApplicationById = {
|
|
4044
|
+
website?: ApplicationWebsite;
|
|
4045
|
+
cors?: ApplicationCors;
|
|
4046
|
+
auth?: ApplicationAuth;
|
|
4047
|
+
/**
|
|
4048
|
+
* - It contains detailed information about the
|
|
4049
|
+
* sales channel.
|
|
4050
|
+
*/
|
|
4051
|
+
description?: string;
|
|
4052
|
+
/**
|
|
4053
|
+
* - It indicates different types of channels,
|
|
4054
|
+
* such as store, website, and mobile apps, with 'store' being the default value.
|
|
4055
|
+
*/
|
|
4056
|
+
channel_type?: string;
|
|
4057
|
+
/**
|
|
4058
|
+
* - An integer value that specifies the number
|
|
4059
|
+
* of seconds until the key expires
|
|
4060
|
+
*/
|
|
4061
|
+
cache_ttl?: number;
|
|
4062
|
+
/**
|
|
4063
|
+
* - Indicates whether a sales channel is
|
|
4064
|
+
* internal or not
|
|
4065
|
+
*/
|
|
4066
|
+
is_internal?: boolean;
|
|
4067
|
+
/**
|
|
4068
|
+
* - Indicates sales channel is active or not active
|
|
4069
|
+
*/
|
|
4070
|
+
is_active?: boolean;
|
|
4071
|
+
/**
|
|
4072
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
4073
|
+
* of the sales channel
|
|
4074
|
+
*/
|
|
4075
|
+
_id?: string;
|
|
4076
|
+
/**
|
|
4077
|
+
* - Name of the sales channel, e.g. Zenz Fashion
|
|
4078
|
+
*/
|
|
4079
|
+
name?: string;
|
|
4080
|
+
/**
|
|
4081
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
4082
|
+
* of owner who owns the application
|
|
4083
|
+
*/
|
|
4084
|
+
owner?: string;
|
|
4085
|
+
/**
|
|
4086
|
+
* - Numeric ID allotted to a business account
|
|
4087
|
+
* where the sales channel exists
|
|
4088
|
+
*/
|
|
4089
|
+
company_id?: number;
|
|
4090
|
+
/**
|
|
4091
|
+
* - Random generated fix length string for sales
|
|
4092
|
+
* channel. It is required and auto-generated.
|
|
4093
|
+
*/
|
|
4094
|
+
token?: string;
|
|
4095
|
+
redirections?: ApplicationRedirections[];
|
|
4096
|
+
meta?: ApplicationMeta[];
|
|
4097
|
+
/**
|
|
4098
|
+
* - ISO 8601 timestamp of sales channel creation
|
|
4099
|
+
*/
|
|
4100
|
+
created_at?: string;
|
|
4101
|
+
/**
|
|
4102
|
+
* - ISO 8601 timestamp of sales channel updation
|
|
4103
|
+
*/
|
|
4104
|
+
modified_at?: string;
|
|
4105
|
+
/**
|
|
4106
|
+
* - Version key for tracking revisions. Default value is zero.
|
|
4107
|
+
*/
|
|
4108
|
+
__v?: number;
|
|
4109
|
+
banner?: SecureUrl;
|
|
4110
|
+
logo?: SecureUrl;
|
|
4111
|
+
favicon?: SecureUrl;
|
|
4112
|
+
domains?: Domain[];
|
|
4113
|
+
/**
|
|
4114
|
+
* - It shows application is live or in development mode.
|
|
4115
|
+
*/
|
|
4116
|
+
app_type?: string;
|
|
4117
|
+
mobile_logo?: SecureUrl;
|
|
4118
|
+
domain?: Domain;
|
|
4119
|
+
slug?: string;
|
|
4120
|
+
mode?: string;
|
|
4121
|
+
status?: string;
|
|
4122
|
+
tokens?: TokenSchemaID[];
|
|
4123
|
+
secret?: string;
|
|
4124
|
+
};
|
|
4125
|
+
/** @returns {TokenSchemaID} */
|
|
4126
|
+
declare function TokenSchemaID(): TokenSchemaID;
|
|
4127
|
+
type TokenSchemaID = {
|
|
4128
|
+
token?: string;
|
|
4129
|
+
created_by?: string;
|
|
4130
|
+
/**
|
|
4131
|
+
* - ISO 8601 timestamp of when token created
|
|
4132
|
+
*/
|
|
4133
|
+
created_at?: string;
|
|
4134
|
+
};
|
|
3994
4135
|
/** @returns {TokenSchema} */
|
|
3995
4136
|
declare function TokenSchema(): TokenSchema;
|
|
3996
4137
|
type TokenSchema = {
|