@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.9
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 +26 -1
- package/package.json +2 -2
- package/sdk/application/ApplicationClient.d.ts +8 -0
- package/sdk/application/ApplicationClient.js +14 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +20 -20
- package/sdk/application/Cart/CartApplicationClient.js +20 -20
- package/sdk/application/Cart/CartApplicationModel.d.ts +2446 -664
- package/sdk/application/Cart/CartApplicationModel.js +783 -552
- package/sdk/application/Cart/CartApplicationValidator.d.ts +268 -194
- package/sdk/application/Cart/CartApplicationValidator.js +100 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +53 -53
- package/sdk/application/Catalog/CatalogApplicationClient.js +53 -53
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2012 -503
- package/sdk/application/Catalog/CatalogApplicationModel.js +603 -453
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +64 -64
- package/sdk/application/Catalog/CatalogApplicationValidator.js +32 -32
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Common/CommonApplicationModel.d.ts +170 -90
- package/sdk/application/Common/CommonApplicationModel.js +59 -58
- package/sdk/application/Common/CommonApplicationValidator.d.ts +8 -5
- package/sdk/application/Common/CommonApplicationValidator.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +170 -35
- package/sdk/application/Communication/CommunicationApplicationModel.js +54 -33
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +15 -15
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +15 -15
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +624 -443
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +259 -248
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +32 -24
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +14 -13
- package/sdk/application/Content/ContentApplicationClient.d.ts +16 -16
- package/sdk/application/Content/ContentApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationModel.d.ts +1205 -282
- package/sdk/application/Content/ContentApplicationModel.js +341 -277
- package/sdk/application/Content/ContentApplicationValidator.d.ts +28 -17
- package/sdk/application/Content/ContentApplicationValidator.js +11 -10
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +146 -37
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +38 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Lead/LeadApplicationModel.d.ts +195 -134
- package/sdk/application/Lead/LeadApplicationModel.js +110 -67
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +8 -8
- package/sdk/application/Lead/LeadApplicationValidator.js +4 -4
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -10
- package/sdk/application/Logistic/LogisticApplicationClient.js +10 -10
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +1039 -221
- package/sdk/application/Logistic/LogisticApplicationModel.js +342 -199
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +76 -82
- package/sdk/application/Logistic/LogisticApplicationValidator.js +38 -41
- package/sdk/application/Order/OrderApplicationClient.d.ts +10 -10
- package/sdk/application/Order/OrderApplicationClient.js +10 -10
- package/sdk/application/Order/OrderApplicationModel.d.ts +1400 -325
- package/sdk/application/Order/OrderApplicationModel.js +391 -317
- package/sdk/application/Order/OrderApplicationValidator.d.ts +32 -30
- package/sdk/application/Order/OrderApplicationValidator.js +15 -14
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +43 -43
- package/sdk/application/Payment/PaymentApplicationClient.js +43 -43
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +1111 -1022
- package/sdk/application/Payment/PaymentApplicationModel.js +537 -521
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +82 -49
- package/sdk/application/Payment/PaymentApplicationValidator.js +30 -30
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +28 -7
- package/sdk/application/Rewards/RewardsApplicationModel.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +178 -38
- package/sdk/application/Share/ShareApplicationModel.js +53 -37
- package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -2
- package/sdk/application/Share/ShareApplicationValidator.js +2 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +14 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +528 -287
- package/sdk/application/Theme/ThemeApplicationModel.js +208 -172
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +17 -12
- package/sdk/application/Theme/ThemeApplicationValidator.js +8 -6
- package/sdk/application/User/UserApplicationClient.d.ts +36 -36
- package/sdk/application/User/UserApplicationClient.js +36 -36
- package/sdk/application/User/UserApplicationModel.d.ts +1062 -255
- package/sdk/application/User/UserApplicationModel.js +298 -244
- package/sdk/application/User/UserApplicationValidator.d.ts +80 -80
- package/sdk/application/User/UserApplicationValidator.js +40 -40
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +20 -5
- package/sdk/application/Webhook/WebhookApplicationModel.js +5 -5
- package/sdk/common/Clickstream.js +95 -15
- package/sdk/common/Constant.d.ts +9 -0
- package/sdk/common/Constant.js +11 -0
- package/sdk/common/Utility.js +19 -0
- package/sdk/common/utils.js +8 -1
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +28 -7
- package/sdk/partner/Lead/LeadPartnerModel.js +7 -7
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +28 -7
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +7 -7
- package/sdk/partner/PartnerClient.d.ts +8 -0
- package/sdk/partner/PartnerClient.js +14 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +158 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +45 -6
- package/sdk/partner/Theme/ThemePartnerModel.js +33 -4
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +28 -7
- package/sdk/partner/Webhook/WebhookPartnerModel.js +7 -7
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +28 -7
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +7 -7
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +6 -397
- package/sdk/platform/Billing/BillingPlatformClient.js +77 -3215
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +621 -2021
- package/sdk/platform/Billing/BillingPlatformModel.js +353 -2405
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +12 -451
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -483
- package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -7
- package/sdk/platform/Cart/CartPlatformModel.js +8 -8
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +12 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +41 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +46 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +14 -11
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +17 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +28 -7
- package/sdk/platform/Communication/CommunicationPlatformModel.js +7 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +7 -7
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +0 -97
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +77 -782
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +24 -701
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +7 -539
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -183
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +0 -134
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +0 -79
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -15
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -13
- package/sdk/platform/Content/ContentPlatformModel.d.ts +58 -17
- package/sdk/platform/Content/ContentPlatformModel.js +28 -15
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +28 -7
- package/sdk/platform/Discount/DiscountPlatformModel.js +7 -7
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +127 -25
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +37 -25
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +28 -28
- package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +1583 -347
- package/sdk/platform/Finance/FinancePlatformModel.js +463 -351
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +28 -7
- package/sdk/platform/Lead/LeadPlatformModel.js +7 -7
- package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -0
- package/sdk/platform/Order/OrderPlatformClient.js +165 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +613 -39
- package/sdk/platform/Order/OrderPlatformModel.js +359 -41
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -1
- package/sdk/platform/Order/OrderPlatformValidator.js +28 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +30 -9
- package/sdk/platform/Payment/PaymentPlatformModel.js +9 -9
- package/sdk/platform/PlatformClient.d.ts +8 -0
- package/sdk/platform/PlatformClient.js +14 -0
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +28 -7
- package/sdk/platform/Rewards/RewardsPlatformModel.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +12 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +12 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +120 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +76 -21
- package/sdk/platform/Share/SharePlatformModel.d.ts +28 -7
- package/sdk/platform/Share/SharePlatformModel.js +7 -7
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +18 -5
- package/sdk/platform/Theme/ThemePlatformModel.js +7 -4
- package/sdk/platform/User/UserPlatformModel.d.ts +18 -18
- package/sdk/platform/User/UserPlatformModel.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +28 -7
- package/sdk/platform/Webhook/WebhookPlatformModel.js +7 -7
- package/sdk/public/PublicClient.d.ts +0 -4
- package/sdk/public/PublicClient.js +0 -8
- package/sdk/public/index.d.ts +0 -2
- package/sdk/public/index.js +0 -4
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -45
- package/sdk/public/Billing/BillingPublicClient.js +0 -269
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -434
- package/sdk/public/Billing/BillingPublicModel.js +0 -395
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -34
- package/sdk/public/Billing/BillingPublicValidator.js +0 -38
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +0 -87
- package/sdk/public/Inventory/InventoryPublicClient.js +0 -529
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +0 -393
- package/sdk/public/Inventory/InventoryPublicModel.js +0 -448
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +0 -91
- package/sdk/public/Inventory/InventoryPublicValidator.js +0 -85
|
@@ -495,178 +495,6 @@ export = ConfigurationPlatformModel;
|
|
|
495
495
|
* @property {boolean} [success] - Shows whether domain was deleted successfully
|
|
496
496
|
* @property {string} [message] - Success message shown to the user (in a string format)
|
|
497
497
|
*/
|
|
498
|
-
/**
|
|
499
|
-
* @typedef GetIntegrationsOptInsResponse
|
|
500
|
-
* @property {IntegrationOptIn[]} [items]
|
|
501
|
-
* @property {Page} [page]
|
|
502
|
-
*/
|
|
503
|
-
/**
|
|
504
|
-
* @typedef IntegrationOptIn
|
|
505
|
-
* @property {Validators} [validators]
|
|
506
|
-
* @property {string} [description] - Basic description about the opted integration
|
|
507
|
-
* @property {string} [description_html] - Basic HTML description about the
|
|
508
|
-
* opted integration
|
|
509
|
-
* @property {string} [constants]
|
|
510
|
-
* @property {string[]} [companies]
|
|
511
|
-
* @property {string[]} [support]
|
|
512
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
513
|
-
* of the opted integration
|
|
514
|
-
* @property {string} [name] - Nmae of the opted integration, e.g. SAP RBL Integration
|
|
515
|
-
* @property {string} [slug] - Slug of the opted integration, e.g. ginesys
|
|
516
|
-
* @property {boolean} [hidden]
|
|
517
|
-
* @property {IntegrationMeta[]} [meta]
|
|
518
|
-
* @property {string} [icon] - Hosted URL of the icon image
|
|
519
|
-
* @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
|
|
520
|
-
* of the user who created the integration
|
|
521
|
-
* @property {string} [created_at] - ISO 8601 timestamp of integration creation
|
|
522
|
-
* @property {string} [modified_at] - ISO 8601 timestamp of integration updation
|
|
523
|
-
* @property {string} [token] - Randomly generated fixed-length string for opted
|
|
524
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
525
|
-
* @property {string} [secret] - Randomly generated fixed-length string for
|
|
526
|
-
* opted integration. It is auto-generated. It would never change once it is generated.
|
|
527
|
-
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
528
|
-
*/
|
|
529
|
-
/**
|
|
530
|
-
* @typedef Validators
|
|
531
|
-
* @property {CompanyValidator} [company]
|
|
532
|
-
* @property {StoreValidator} [store]
|
|
533
|
-
* @property {InventoryValidator} [inventory]
|
|
534
|
-
* @property {OrderValidator} [order]
|
|
535
|
-
*/
|
|
536
|
-
/**
|
|
537
|
-
* @typedef CompanyValidator
|
|
538
|
-
* @property {JsonSchema[]} [json_schema]
|
|
539
|
-
* @property {string} [browser_script] - Browser script for the company validator
|
|
540
|
-
*/
|
|
541
|
-
/**
|
|
542
|
-
* @typedef JsonSchema
|
|
543
|
-
* @property {string} [display] - Display text of the validator JSON schema. It
|
|
544
|
-
* will show in the UI.
|
|
545
|
-
* @property {string} [key] - Key related to the display text of the validator JSON schema
|
|
546
|
-
* @property {string} [type] - Indicates the type of form field, e.g. Text, Dropdown.
|
|
547
|
-
* @property {string} [tooltip] - Tooltip text for the UI of the validator JSON
|
|
548
|
-
* schema. It will show in the UI.
|
|
549
|
-
*/
|
|
550
|
-
/**
|
|
551
|
-
* @typedef StoreValidator
|
|
552
|
-
* @property {JsonSchema[]} [json_schema]
|
|
553
|
-
* @property {string} [browser_script] - Browser script for the store validator
|
|
554
|
-
*/
|
|
555
|
-
/**
|
|
556
|
-
* @typedef InventoryValidator
|
|
557
|
-
* @property {JsonSchema[]} [json_schema]
|
|
558
|
-
* @property {string} [browser_script] - Browser script for the inventory validator
|
|
559
|
-
*/
|
|
560
|
-
/**
|
|
561
|
-
* @typedef OrderValidator
|
|
562
|
-
* @property {JsonSchema[]} [json_schema]
|
|
563
|
-
* @property {string} [browser_script] - Browser script for the order validator
|
|
564
|
-
*/
|
|
565
|
-
/**
|
|
566
|
-
* @typedef IntegrationMeta
|
|
567
|
-
* @property {boolean} [is_public]
|
|
568
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
569
|
-
* of the integration meta
|
|
570
|
-
* @property {string} [name] - Nmae of integration meta, e.g. price_level
|
|
571
|
-
* @property {string} [value] - Value related to integration meta name, e.g. store
|
|
572
|
-
*/
|
|
573
|
-
/**
|
|
574
|
-
* @typedef Integration
|
|
575
|
-
* @property {Validators} [validators]
|
|
576
|
-
* @property {string} [description] - Basic description about the integration
|
|
577
|
-
* @property {string} [description_html] - Basic HTML description about the integration
|
|
578
|
-
* @property {Object} [constants]
|
|
579
|
-
* @property {string[]} [companies]
|
|
580
|
-
* @property {string[]} [support]
|
|
581
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
582
|
-
* of the integration
|
|
583
|
-
* @property {string} [name] - Name of the integration, e.g. SAP RBL Integration
|
|
584
|
-
* @property {string} [slug] - Name of the integration, e.g. SAP RBL Integration
|
|
585
|
-
* @property {IntegrationMeta[]} [meta]
|
|
586
|
-
* @property {string} [icon] - Hosted URL of the icon image
|
|
587
|
-
* @property {boolean} [hidden]
|
|
588
|
-
* @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
|
|
589
|
-
* of the user who created the integration
|
|
590
|
-
* @property {string} [created_at] - ISO 8601 timestamp of integration creation
|
|
591
|
-
* @property {string} [modified_at] - ISO 8601 timestamp of integration updation
|
|
592
|
-
* @property {string} [token] - Randomly generated fixed-length string for opted
|
|
593
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
594
|
-
* @property {string} [secret] - Randomly generated fixed-length string for
|
|
595
|
-
* opted integration. It is auto-generated. It would never change once it is generated.
|
|
596
|
-
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
597
|
-
*/
|
|
598
|
-
/**
|
|
599
|
-
* @typedef IntegrationConfigResponse
|
|
600
|
-
* @property {IntegrationLevel[]} [items]
|
|
601
|
-
*/
|
|
602
|
-
/**
|
|
603
|
-
* @typedef IntegrationLevel
|
|
604
|
-
* @property {boolean} [opted] - Shows this integration is opted or not opted
|
|
605
|
-
* for the current company
|
|
606
|
-
* @property {Object[]} [permissions]
|
|
607
|
-
* @property {LastPatch[]} [last_patch]
|
|
608
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
609
|
-
* of the integration config
|
|
610
|
-
* @property {string} [integration] - Integration id. Shows which integration
|
|
611
|
-
* you are enabling.
|
|
612
|
-
* @property {string} [level] - Shows for what level the integration is set up.
|
|
613
|
-
* It can be company level or store level.
|
|
614
|
-
* @property {number} [uid] - It can be store uid or company uid. Depends on the
|
|
615
|
-
* level of integration.
|
|
616
|
-
* @property {number} [company_id] - Unique id of company.
|
|
617
|
-
* @property {IntegrationMeta[]} [meta]
|
|
618
|
-
* @property {string} [token] - Randomly generated fixed-length string for opted
|
|
619
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
620
|
-
* @property {string} [created_at] - ISO 8601 timestamp of integration config creation
|
|
621
|
-
* @property {string} [modified_at] - ISO 8601 timestamp of integration config updation
|
|
622
|
-
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
623
|
-
* @property {Object} [data] - Schema data of the integration stored in key-value pairs
|
|
624
|
-
* @property {boolean} [success]
|
|
625
|
-
* @property {string} [message]
|
|
626
|
-
*/
|
|
627
|
-
/**
|
|
628
|
-
* @typedef UpdateIntegrationLevelRequest
|
|
629
|
-
* @property {IntegrationLevel[]} [items]
|
|
630
|
-
*/
|
|
631
|
-
/**
|
|
632
|
-
* @typedef OptedStoreIntegration
|
|
633
|
-
* @property {boolean} [other_opted] - Allow user to opt same store in other integration
|
|
634
|
-
* @property {IntegrationOptIn} [other_integration]
|
|
635
|
-
* @property {OtherEntity} [other_entity]
|
|
636
|
-
*/
|
|
637
|
-
/**
|
|
638
|
-
* @typedef OtherEntity
|
|
639
|
-
* @property {boolean} [opted] - Allow other entity opted in integration
|
|
640
|
-
* @property {string[]} [permissions]
|
|
641
|
-
* @property {LastPatch[]} [last_patch]
|
|
642
|
-
* @property {string} [_id] - The unique identifier of the other entity for
|
|
643
|
-
* opted store integration
|
|
644
|
-
* @property {string} [integration] - Integration ID. Shows which integration
|
|
645
|
-
* you are enabling.
|
|
646
|
-
* @property {string} [level] - Indicates integration level. It can be company
|
|
647
|
-
* level or store level.
|
|
648
|
-
* @property {number} [uid] - It can be store uid or company uid. Depends on the
|
|
649
|
-
* level of integration.
|
|
650
|
-
* @property {OtherEntityData} [data]
|
|
651
|
-
* @property {Object[]} [meta]
|
|
652
|
-
* @property {string} [token] - Randomly generated fixed-length string for opted
|
|
653
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
654
|
-
* @property {string} [created_at] - ISO 8601 timestamp of other entity creation
|
|
655
|
-
* for opted store integration
|
|
656
|
-
* @property {string} [modified_at] - ISO 8601 timestamp of other entity
|
|
657
|
-
* updation for opted store integration
|
|
658
|
-
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
659
|
-
*/
|
|
660
|
-
/**
|
|
661
|
-
* @typedef LastPatch
|
|
662
|
-
* @property {string} [op]
|
|
663
|
-
* @property {string} [path]
|
|
664
|
-
* @property {string} [value] - It can be inventory level or order level
|
|
665
|
-
*/
|
|
666
|
-
/**
|
|
667
|
-
* @typedef OtherEntityData
|
|
668
|
-
* @property {string} [article_identifier]
|
|
669
|
-
*/
|
|
670
498
|
/**
|
|
671
499
|
* @typedef App
|
|
672
500
|
* @property {string} [company_id] - Numeric ID allotted to a business account
|
|
@@ -677,24 +505,6 @@ export = ConfigurationPlatformModel;
|
|
|
677
505
|
* @property {string} [name] - User-friendly name for sales channel, e.g. Zenz Fashion
|
|
678
506
|
* @property {string} [desc] - Detailed description about the sales channel
|
|
679
507
|
*/
|
|
680
|
-
/**
|
|
681
|
-
* @typedef InventoryConfig
|
|
682
|
-
* @property {InventoryBrandRule} [brand]
|
|
683
|
-
* @property {InventoryStoreRule} [store]
|
|
684
|
-
* @property {string[]} [image]
|
|
685
|
-
* @property {boolean} [franchise_enabled] - Allow other businesses (companies)
|
|
686
|
-
* to consume the current sales channel's inventory and sell products
|
|
687
|
-
* @property {boolean} [out_of_stock] - Indicates whether out of stock products
|
|
688
|
-
* are allowed to show up on the website.
|
|
689
|
-
* @property {boolean} [only_verified_products] - Show only verified products
|
|
690
|
-
* (the ones whose data have been verified by the admin)
|
|
691
|
-
*/
|
|
692
|
-
/**
|
|
693
|
-
* @typedef AppInventory
|
|
694
|
-
* @property {InventoryConfig} [inventory]
|
|
695
|
-
* @property {InventoryPaymentConfig} [payment]
|
|
696
|
-
* @property {InventoryArticleAssignment} [article_assignment]
|
|
697
|
-
*/
|
|
698
508
|
/**
|
|
699
509
|
* @typedef AppDomain
|
|
700
510
|
* @property {string} [name] - Domain URL of current sales channel, e.g. zenz.com
|
|
@@ -1296,56 +1106,15 @@ export = ConfigurationPlatformModel;
|
|
|
1296
1106
|
* @property {string} [message] - Error message when request body payload is improper
|
|
1297
1107
|
* @property {boolean} [success] - Flag for required not successfull.
|
|
1298
1108
|
*/
|
|
1299
|
-
/**
|
|
1300
|
-
* @typedef InventoryBrandRule
|
|
1301
|
-
* @property {string} [criteria] - Whether all brands are enabled, or explicitly
|
|
1302
|
-
* few brands in the inventory
|
|
1303
|
-
* @property {number[]} [brands]
|
|
1304
|
-
*/
|
|
1305
|
-
/**
|
|
1306
|
-
* @typedef StoreCriteriaRule
|
|
1307
|
-
* @property {number[]} [companies] - List of company UID
|
|
1308
|
-
* @property {number[]} [brands] - List of brand UID
|
|
1309
|
-
*/
|
|
1310
|
-
/**
|
|
1311
|
-
* @typedef InventoryStoreRule
|
|
1312
|
-
* @property {string} [criteria] - Whether all stores are enabled, or explicitly
|
|
1313
|
-
* few stores in the inventory, or use brands and company filter.
|
|
1314
|
-
* @property {StoreCriteriaRule[]} [rules] - List of rules with company and
|
|
1315
|
-
* brands uids. Used when critera is `filter`.
|
|
1316
|
-
* @property {number[]} [stores] - List of store uids. Used when critera is `explicit`.
|
|
1317
|
-
*/
|
|
1318
|
-
/**
|
|
1319
|
-
* @typedef InventoryPaymentConfig
|
|
1320
|
-
* @property {string} [mode_of_payment] - Mode of payment for the inventory of
|
|
1321
|
-
* sales channel. It is required and default value is null.
|
|
1322
|
-
* @property {string} [source] - Source of the payment mode for the inventory
|
|
1323
|
-
* payment of sales channel. Default value is FYND.
|
|
1324
|
-
*/
|
|
1325
|
-
/**
|
|
1326
|
-
* @typedef StorePriorityRule
|
|
1327
|
-
* @property {boolean} [enabled] - Shows store priority is enabled or not
|
|
1328
|
-
* enabled for the article assignment.
|
|
1329
|
-
* @property {string[]} [storetype_order]
|
|
1330
|
-
*/
|
|
1331
|
-
/**
|
|
1332
|
-
* @typedef ArticleAssignmentRule
|
|
1333
|
-
* @property {StorePriorityRule} [store_priority]
|
|
1334
|
-
*/
|
|
1335
|
-
/**
|
|
1336
|
-
* @typedef InventoryArticleAssignment
|
|
1337
|
-
* @property {boolean} [post_order_reassignment] - Allow post order reassigment of article
|
|
1338
|
-
* @property {ArticleAssignmentRule} [rules]
|
|
1339
|
-
*/
|
|
1340
1109
|
/**
|
|
1341
1110
|
* @typedef Page
|
|
1342
|
-
* @property {number} [item_total]
|
|
1343
|
-
* @property {string} [next_id]
|
|
1344
|
-
* @property {boolean} [has_previous]
|
|
1345
|
-
* @property {boolean} [has_next]
|
|
1346
|
-
* @property {number} [current]
|
|
1347
|
-
* @property {string} type
|
|
1348
|
-
* @property {number} [size]
|
|
1111
|
+
* @property {number} [item_total] - The total number of items on the page.
|
|
1112
|
+
* @property {string} [next_id] - The identifier for the next page.
|
|
1113
|
+
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
1114
|
+
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
1115
|
+
* @property {number} [current] - The current page number.
|
|
1116
|
+
* @property {string} type - The type of the page, such as 'PageType'.
|
|
1117
|
+
* @property {number} [size] - The number of items per page.
|
|
1349
1118
|
*/
|
|
1350
1119
|
/**
|
|
1351
1120
|
* @typedef ApplicationInformation
|
|
@@ -1571,7 +1340,7 @@ export = ConfigurationPlatformModel;
|
|
|
1571
1340
|
declare class ConfigurationPlatformModel {
|
|
1572
1341
|
}
|
|
1573
1342
|
declare namespace ConfigurationPlatformModel {
|
|
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,
|
|
1343
|
+
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, App, 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, 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 };
|
|
1575
1344
|
}
|
|
1576
1345
|
/** @returns {ApplicationInventory} */
|
|
1577
1346
|
declare function ApplicationInventory(): ApplicationInventory;
|
|
@@ -2561,366 +2330,6 @@ type SuccessMessageResponse = {
|
|
|
2561
2330
|
*/
|
|
2562
2331
|
message?: string;
|
|
2563
2332
|
};
|
|
2564
|
-
/** @returns {GetIntegrationsOptInsResponse} */
|
|
2565
|
-
declare function GetIntegrationsOptInsResponse(): GetIntegrationsOptInsResponse;
|
|
2566
|
-
type GetIntegrationsOptInsResponse = {
|
|
2567
|
-
items?: IntegrationOptIn[];
|
|
2568
|
-
page?: Page;
|
|
2569
|
-
};
|
|
2570
|
-
/** @returns {IntegrationOptIn} */
|
|
2571
|
-
declare function IntegrationOptIn(): IntegrationOptIn;
|
|
2572
|
-
type IntegrationOptIn = {
|
|
2573
|
-
validators?: Validators;
|
|
2574
|
-
/**
|
|
2575
|
-
* - Basic description about the opted integration
|
|
2576
|
-
*/
|
|
2577
|
-
description?: string;
|
|
2578
|
-
/**
|
|
2579
|
-
* - Basic HTML description about the
|
|
2580
|
-
* opted integration
|
|
2581
|
-
*/
|
|
2582
|
-
description_html?: string;
|
|
2583
|
-
constants?: string;
|
|
2584
|
-
companies?: string[];
|
|
2585
|
-
support?: string[];
|
|
2586
|
-
/**
|
|
2587
|
-
* - The unique identifier (24-digit Mongo Object ID)
|
|
2588
|
-
* of the opted integration
|
|
2589
|
-
*/
|
|
2590
|
-
_id?: string;
|
|
2591
|
-
/**
|
|
2592
|
-
* - Nmae of the opted integration, e.g. SAP RBL Integration
|
|
2593
|
-
*/
|
|
2594
|
-
name?: string;
|
|
2595
|
-
/**
|
|
2596
|
-
* - Slug of the opted integration, e.g. ginesys
|
|
2597
|
-
*/
|
|
2598
|
-
slug?: string;
|
|
2599
|
-
hidden?: boolean;
|
|
2600
|
-
meta?: IntegrationMeta[];
|
|
2601
|
-
/**
|
|
2602
|
-
* - Hosted URL of the icon image
|
|
2603
|
-
*/
|
|
2604
|
-
icon?: string;
|
|
2605
|
-
/**
|
|
2606
|
-
* - The unique identifier (24-digit Mongo Object ID)
|
|
2607
|
-
* of the user who created the integration
|
|
2608
|
-
*/
|
|
2609
|
-
owner?: string;
|
|
2610
|
-
/**
|
|
2611
|
-
* - ISO 8601 timestamp of integration creation
|
|
2612
|
-
*/
|
|
2613
|
-
created_at?: string;
|
|
2614
|
-
/**
|
|
2615
|
-
* - ISO 8601 timestamp of integration updation
|
|
2616
|
-
*/
|
|
2617
|
-
modified_at?: string;
|
|
2618
|
-
/**
|
|
2619
|
-
* - Randomly generated fixed-length string for opted
|
|
2620
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
2621
|
-
*/
|
|
2622
|
-
token?: string;
|
|
2623
|
-
/**
|
|
2624
|
-
* - Randomly generated fixed-length string for
|
|
2625
|
-
* opted integration. It is auto-generated. It would never change once it is generated.
|
|
2626
|
-
*/
|
|
2627
|
-
secret?: string;
|
|
2628
|
-
/**
|
|
2629
|
-
* - Version key for tracking revisions. Default value is zero.
|
|
2630
|
-
*/
|
|
2631
|
-
__v?: number;
|
|
2632
|
-
};
|
|
2633
|
-
/** @returns {Validators} */
|
|
2634
|
-
declare function Validators(): Validators;
|
|
2635
|
-
type Validators = {
|
|
2636
|
-
company?: CompanyValidator;
|
|
2637
|
-
store?: StoreValidator;
|
|
2638
|
-
inventory?: InventoryValidator;
|
|
2639
|
-
order?: OrderValidator;
|
|
2640
|
-
};
|
|
2641
|
-
/** @returns {CompanyValidator} */
|
|
2642
|
-
declare function CompanyValidator(): CompanyValidator;
|
|
2643
|
-
type CompanyValidator = {
|
|
2644
|
-
json_schema?: JsonSchema[];
|
|
2645
|
-
/**
|
|
2646
|
-
* - Browser script for the company validator
|
|
2647
|
-
*/
|
|
2648
|
-
browser_script?: string;
|
|
2649
|
-
};
|
|
2650
|
-
/** @returns {JsonSchema} */
|
|
2651
|
-
declare function JsonSchema(): JsonSchema;
|
|
2652
|
-
type JsonSchema = {
|
|
2653
|
-
/**
|
|
2654
|
-
* - Display text of the validator JSON schema. It
|
|
2655
|
-
* will show in the UI.
|
|
2656
|
-
*/
|
|
2657
|
-
display?: string;
|
|
2658
|
-
/**
|
|
2659
|
-
* - Key related to the display text of the validator JSON schema
|
|
2660
|
-
*/
|
|
2661
|
-
key?: string;
|
|
2662
|
-
/**
|
|
2663
|
-
* - Indicates the type of form field, e.g. Text, Dropdown.
|
|
2664
|
-
*/
|
|
2665
|
-
type?: string;
|
|
2666
|
-
/**
|
|
2667
|
-
* - Tooltip text for the UI of the validator JSON
|
|
2668
|
-
* schema. It will show in the UI.
|
|
2669
|
-
*/
|
|
2670
|
-
tooltip?: string;
|
|
2671
|
-
};
|
|
2672
|
-
/** @returns {StoreValidator} */
|
|
2673
|
-
declare function StoreValidator(): StoreValidator;
|
|
2674
|
-
type StoreValidator = {
|
|
2675
|
-
json_schema?: JsonSchema[];
|
|
2676
|
-
/**
|
|
2677
|
-
* - Browser script for the store validator
|
|
2678
|
-
*/
|
|
2679
|
-
browser_script?: string;
|
|
2680
|
-
};
|
|
2681
|
-
/** @returns {InventoryValidator} */
|
|
2682
|
-
declare function InventoryValidator(): InventoryValidator;
|
|
2683
|
-
type InventoryValidator = {
|
|
2684
|
-
json_schema?: JsonSchema[];
|
|
2685
|
-
/**
|
|
2686
|
-
* - Browser script for the inventory validator
|
|
2687
|
-
*/
|
|
2688
|
-
browser_script?: string;
|
|
2689
|
-
};
|
|
2690
|
-
/** @returns {OrderValidator} */
|
|
2691
|
-
declare function OrderValidator(): OrderValidator;
|
|
2692
|
-
type OrderValidator = {
|
|
2693
|
-
json_schema?: JsonSchema[];
|
|
2694
|
-
/**
|
|
2695
|
-
* - Browser script for the order validator
|
|
2696
|
-
*/
|
|
2697
|
-
browser_script?: string;
|
|
2698
|
-
};
|
|
2699
|
-
/** @returns {IntegrationMeta} */
|
|
2700
|
-
declare function IntegrationMeta(): IntegrationMeta;
|
|
2701
|
-
type IntegrationMeta = {
|
|
2702
|
-
is_public?: boolean;
|
|
2703
|
-
/**
|
|
2704
|
-
* - The unique identifier (24-digit Mongo Object ID)
|
|
2705
|
-
* of the integration meta
|
|
2706
|
-
*/
|
|
2707
|
-
_id?: string;
|
|
2708
|
-
/**
|
|
2709
|
-
* - Nmae of integration meta, e.g. price_level
|
|
2710
|
-
*/
|
|
2711
|
-
name?: string;
|
|
2712
|
-
/**
|
|
2713
|
-
* - Value related to integration meta name, e.g. store
|
|
2714
|
-
*/
|
|
2715
|
-
value?: string;
|
|
2716
|
-
};
|
|
2717
|
-
/** @returns {Integration} */
|
|
2718
|
-
declare function Integration(): Integration;
|
|
2719
|
-
type Integration = {
|
|
2720
|
-
validators?: Validators;
|
|
2721
|
-
/**
|
|
2722
|
-
* - Basic description about the integration
|
|
2723
|
-
*/
|
|
2724
|
-
description?: string;
|
|
2725
|
-
/**
|
|
2726
|
-
* - Basic HTML description about the integration
|
|
2727
|
-
*/
|
|
2728
|
-
description_html?: string;
|
|
2729
|
-
constants?: any;
|
|
2730
|
-
companies?: string[];
|
|
2731
|
-
support?: string[];
|
|
2732
|
-
/**
|
|
2733
|
-
* - The unique identifier (24-digit Mongo Object ID)
|
|
2734
|
-
* of the integration
|
|
2735
|
-
*/
|
|
2736
|
-
_id?: string;
|
|
2737
|
-
/**
|
|
2738
|
-
* - Name of the integration, e.g. SAP RBL Integration
|
|
2739
|
-
*/
|
|
2740
|
-
name?: string;
|
|
2741
|
-
/**
|
|
2742
|
-
* - Name of the integration, e.g. SAP RBL Integration
|
|
2743
|
-
*/
|
|
2744
|
-
slug?: string;
|
|
2745
|
-
meta?: IntegrationMeta[];
|
|
2746
|
-
/**
|
|
2747
|
-
* - Hosted URL of the icon image
|
|
2748
|
-
*/
|
|
2749
|
-
icon?: string;
|
|
2750
|
-
hidden?: boolean;
|
|
2751
|
-
/**
|
|
2752
|
-
* - The unique identifier (24-digit Mongo Object ID)
|
|
2753
|
-
* of the user who created the integration
|
|
2754
|
-
*/
|
|
2755
|
-
owner?: string;
|
|
2756
|
-
/**
|
|
2757
|
-
* - ISO 8601 timestamp of integration creation
|
|
2758
|
-
*/
|
|
2759
|
-
created_at?: string;
|
|
2760
|
-
/**
|
|
2761
|
-
* - ISO 8601 timestamp of integration updation
|
|
2762
|
-
*/
|
|
2763
|
-
modified_at?: string;
|
|
2764
|
-
/**
|
|
2765
|
-
* - Randomly generated fixed-length string for opted
|
|
2766
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
2767
|
-
*/
|
|
2768
|
-
token?: string;
|
|
2769
|
-
/**
|
|
2770
|
-
* - Randomly generated fixed-length string for
|
|
2771
|
-
* opted integration. It is auto-generated. It would never change once it is generated.
|
|
2772
|
-
*/
|
|
2773
|
-
secret?: string;
|
|
2774
|
-
/**
|
|
2775
|
-
* - Version key for tracking revisions. Default value is zero.
|
|
2776
|
-
*/
|
|
2777
|
-
__v?: number;
|
|
2778
|
-
};
|
|
2779
|
-
/** @returns {IntegrationConfigResponse} */
|
|
2780
|
-
declare function IntegrationConfigResponse(): IntegrationConfigResponse;
|
|
2781
|
-
type IntegrationConfigResponse = {
|
|
2782
|
-
items?: IntegrationLevel[];
|
|
2783
|
-
};
|
|
2784
|
-
/** @returns {IntegrationLevel} */
|
|
2785
|
-
declare function IntegrationLevel(): IntegrationLevel;
|
|
2786
|
-
type IntegrationLevel = {
|
|
2787
|
-
/**
|
|
2788
|
-
* - Shows this integration is opted or not opted
|
|
2789
|
-
* for the current company
|
|
2790
|
-
*/
|
|
2791
|
-
opted?: boolean;
|
|
2792
|
-
permissions?: any[];
|
|
2793
|
-
last_patch?: LastPatch[];
|
|
2794
|
-
/**
|
|
2795
|
-
* - The unique identifier (24-digit Mongo Object ID)
|
|
2796
|
-
* of the integration config
|
|
2797
|
-
*/
|
|
2798
|
-
_id?: string;
|
|
2799
|
-
/**
|
|
2800
|
-
* - Integration id. Shows which integration
|
|
2801
|
-
* you are enabling.
|
|
2802
|
-
*/
|
|
2803
|
-
integration?: string;
|
|
2804
|
-
/**
|
|
2805
|
-
* - Shows for what level the integration is set up.
|
|
2806
|
-
* It can be company level or store level.
|
|
2807
|
-
*/
|
|
2808
|
-
level?: string;
|
|
2809
|
-
/**
|
|
2810
|
-
* - It can be store uid or company uid. Depends on the
|
|
2811
|
-
* level of integration.
|
|
2812
|
-
*/
|
|
2813
|
-
uid?: number;
|
|
2814
|
-
/**
|
|
2815
|
-
* - Unique id of company.
|
|
2816
|
-
*/
|
|
2817
|
-
company_id?: number;
|
|
2818
|
-
meta?: IntegrationMeta[];
|
|
2819
|
-
/**
|
|
2820
|
-
* - Randomly generated fixed-length string for opted
|
|
2821
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
2822
|
-
*/
|
|
2823
|
-
token?: string;
|
|
2824
|
-
/**
|
|
2825
|
-
* - ISO 8601 timestamp of integration config creation
|
|
2826
|
-
*/
|
|
2827
|
-
created_at?: string;
|
|
2828
|
-
/**
|
|
2829
|
-
* - ISO 8601 timestamp of integration config updation
|
|
2830
|
-
*/
|
|
2831
|
-
modified_at?: string;
|
|
2832
|
-
/**
|
|
2833
|
-
* - Version key for tracking revisions. Default value is zero.
|
|
2834
|
-
*/
|
|
2835
|
-
__v?: number;
|
|
2836
|
-
/**
|
|
2837
|
-
* - Schema data of the integration stored in key-value pairs
|
|
2838
|
-
*/
|
|
2839
|
-
data?: any;
|
|
2840
|
-
success?: boolean;
|
|
2841
|
-
message?: string;
|
|
2842
|
-
};
|
|
2843
|
-
/** @returns {UpdateIntegrationLevelRequest} */
|
|
2844
|
-
declare function UpdateIntegrationLevelRequest(): UpdateIntegrationLevelRequest;
|
|
2845
|
-
type UpdateIntegrationLevelRequest = {
|
|
2846
|
-
items?: IntegrationLevel[];
|
|
2847
|
-
};
|
|
2848
|
-
/** @returns {OptedStoreIntegration} */
|
|
2849
|
-
declare function OptedStoreIntegration(): OptedStoreIntegration;
|
|
2850
|
-
type OptedStoreIntegration = {
|
|
2851
|
-
/**
|
|
2852
|
-
* - Allow user to opt same store in other integration
|
|
2853
|
-
*/
|
|
2854
|
-
other_opted?: boolean;
|
|
2855
|
-
other_integration?: IntegrationOptIn;
|
|
2856
|
-
other_entity?: OtherEntity;
|
|
2857
|
-
};
|
|
2858
|
-
/** @returns {OtherEntity} */
|
|
2859
|
-
declare function OtherEntity(): OtherEntity;
|
|
2860
|
-
type OtherEntity = {
|
|
2861
|
-
/**
|
|
2862
|
-
* - Allow other entity opted in integration
|
|
2863
|
-
*/
|
|
2864
|
-
opted?: boolean;
|
|
2865
|
-
permissions?: string[];
|
|
2866
|
-
last_patch?: LastPatch[];
|
|
2867
|
-
/**
|
|
2868
|
-
* - The unique identifier of the other entity for
|
|
2869
|
-
* opted store integration
|
|
2870
|
-
*/
|
|
2871
|
-
_id?: string;
|
|
2872
|
-
/**
|
|
2873
|
-
* - Integration ID. Shows which integration
|
|
2874
|
-
* you are enabling.
|
|
2875
|
-
*/
|
|
2876
|
-
integration?: string;
|
|
2877
|
-
/**
|
|
2878
|
-
* - Indicates integration level. It can be company
|
|
2879
|
-
* level or store level.
|
|
2880
|
-
*/
|
|
2881
|
-
level?: string;
|
|
2882
|
-
/**
|
|
2883
|
-
* - It can be store uid or company uid. Depends on the
|
|
2884
|
-
* level of integration.
|
|
2885
|
-
*/
|
|
2886
|
-
uid?: number;
|
|
2887
|
-
data?: OtherEntityData;
|
|
2888
|
-
meta?: any[];
|
|
2889
|
-
/**
|
|
2890
|
-
* - Randomly generated fixed-length string for opted
|
|
2891
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
2892
|
-
*/
|
|
2893
|
-
token?: string;
|
|
2894
|
-
/**
|
|
2895
|
-
* - ISO 8601 timestamp of other entity creation
|
|
2896
|
-
* for opted store integration
|
|
2897
|
-
*/
|
|
2898
|
-
created_at?: string;
|
|
2899
|
-
/**
|
|
2900
|
-
* - ISO 8601 timestamp of other entity
|
|
2901
|
-
* updation for opted store integration
|
|
2902
|
-
*/
|
|
2903
|
-
modified_at?: string;
|
|
2904
|
-
/**
|
|
2905
|
-
* - Version key for tracking revisions. Default value is zero.
|
|
2906
|
-
*/
|
|
2907
|
-
__v?: number;
|
|
2908
|
-
};
|
|
2909
|
-
/** @returns {LastPatch} */
|
|
2910
|
-
declare function LastPatch(): LastPatch;
|
|
2911
|
-
type LastPatch = {
|
|
2912
|
-
op?: string;
|
|
2913
|
-
path?: string;
|
|
2914
|
-
/**
|
|
2915
|
-
* - It can be inventory level or order level
|
|
2916
|
-
*/
|
|
2917
|
-
value?: string;
|
|
2918
|
-
};
|
|
2919
|
-
/** @returns {OtherEntityData} */
|
|
2920
|
-
declare function OtherEntityData(): OtherEntityData;
|
|
2921
|
-
type OtherEntityData = {
|
|
2922
|
-
article_identifier?: string;
|
|
2923
|
-
};
|
|
2924
2333
|
/** @returns {App} */
|
|
2925
2334
|
declare function App(): App;
|
|
2926
2335
|
type App = {
|
|
@@ -2944,35 +2353,6 @@ type App = {
|
|
|
2944
2353
|
*/
|
|
2945
2354
|
desc?: string;
|
|
2946
2355
|
};
|
|
2947
|
-
/** @returns {InventoryConfig} */
|
|
2948
|
-
declare function InventoryConfig(): InventoryConfig;
|
|
2949
|
-
type InventoryConfig = {
|
|
2950
|
-
brand?: InventoryBrandRule;
|
|
2951
|
-
store?: InventoryStoreRule;
|
|
2952
|
-
image?: string[];
|
|
2953
|
-
/**
|
|
2954
|
-
* - Allow other businesses (companies)
|
|
2955
|
-
* to consume the current sales channel's inventory and sell products
|
|
2956
|
-
*/
|
|
2957
|
-
franchise_enabled?: boolean;
|
|
2958
|
-
/**
|
|
2959
|
-
* - Indicates whether out of stock products
|
|
2960
|
-
* are allowed to show up on the website.
|
|
2961
|
-
*/
|
|
2962
|
-
out_of_stock?: boolean;
|
|
2963
|
-
/**
|
|
2964
|
-
* - Show only verified products
|
|
2965
|
-
* (the ones whose data have been verified by the admin)
|
|
2966
|
-
*/
|
|
2967
|
-
only_verified_products?: boolean;
|
|
2968
|
-
};
|
|
2969
|
-
/** @returns {AppInventory} */
|
|
2970
|
-
declare function AppInventory(): AppInventory;
|
|
2971
|
-
type AppInventory = {
|
|
2972
|
-
inventory?: InventoryConfig;
|
|
2973
|
-
payment?: InventoryPaymentConfig;
|
|
2974
|
-
article_assignment?: InventoryArticleAssignment;
|
|
2975
|
-
};
|
|
2976
2356
|
/** @returns {AppDomain} */
|
|
2977
2357
|
declare function AppDomain(): AppDomain;
|
|
2978
2358
|
type AppDomain = {
|
|
@@ -4154,93 +3534,36 @@ type InvalidPayloadRequest = {
|
|
|
4154
3534
|
*/
|
|
4155
3535
|
success?: boolean;
|
|
4156
3536
|
};
|
|
4157
|
-
/** @returns {
|
|
4158
|
-
declare function
|
|
4159
|
-
type
|
|
4160
|
-
/**
|
|
4161
|
-
* - Whether all brands are enabled, or explicitly
|
|
4162
|
-
* few brands in the inventory
|
|
4163
|
-
*/
|
|
4164
|
-
criteria?: string;
|
|
4165
|
-
brands?: number[];
|
|
4166
|
-
};
|
|
4167
|
-
/** @returns {StoreCriteriaRule} */
|
|
4168
|
-
declare function StoreCriteriaRule(): StoreCriteriaRule;
|
|
4169
|
-
type StoreCriteriaRule = {
|
|
4170
|
-
/**
|
|
4171
|
-
* - List of company UID
|
|
4172
|
-
*/
|
|
4173
|
-
companies?: number[];
|
|
4174
|
-
/**
|
|
4175
|
-
* - List of brand UID
|
|
4176
|
-
*/
|
|
4177
|
-
brands?: number[];
|
|
4178
|
-
};
|
|
4179
|
-
/** @returns {InventoryStoreRule} */
|
|
4180
|
-
declare function InventoryStoreRule(): InventoryStoreRule;
|
|
4181
|
-
type InventoryStoreRule = {
|
|
3537
|
+
/** @returns {Page} */
|
|
3538
|
+
declare function Page(): Page;
|
|
3539
|
+
type Page = {
|
|
4182
3540
|
/**
|
|
4183
|
-
* -
|
|
4184
|
-
* few stores in the inventory, or use brands and company filter.
|
|
3541
|
+
* - The total number of items on the page.
|
|
4185
3542
|
*/
|
|
4186
|
-
|
|
3543
|
+
item_total?: number;
|
|
4187
3544
|
/**
|
|
4188
|
-
* -
|
|
4189
|
-
* brands uids. Used when critera is `filter`.
|
|
3545
|
+
* - The identifier for the next page.
|
|
4190
3546
|
*/
|
|
4191
|
-
|
|
3547
|
+
next_id?: string;
|
|
4192
3548
|
/**
|
|
4193
|
-
* -
|
|
3549
|
+
* - Indicates whether there is a previous page.
|
|
4194
3550
|
*/
|
|
4195
|
-
|
|
4196
|
-
};
|
|
4197
|
-
/** @returns {InventoryPaymentConfig} */
|
|
4198
|
-
declare function InventoryPaymentConfig(): InventoryPaymentConfig;
|
|
4199
|
-
type InventoryPaymentConfig = {
|
|
3551
|
+
has_previous?: boolean;
|
|
4200
3552
|
/**
|
|
4201
|
-
* -
|
|
4202
|
-
* sales channel. It is required and default value is null.
|
|
3553
|
+
* - Indicates whether there is a next page.
|
|
4203
3554
|
*/
|
|
4204
|
-
|
|
3555
|
+
has_next?: boolean;
|
|
4205
3556
|
/**
|
|
4206
|
-
* -
|
|
4207
|
-
* payment of sales channel. Default value is FYND.
|
|
3557
|
+
* - The current page number.
|
|
4208
3558
|
*/
|
|
4209
|
-
|
|
4210
|
-
};
|
|
4211
|
-
/** @returns {StorePriorityRule} */
|
|
4212
|
-
declare function StorePriorityRule(): StorePriorityRule;
|
|
4213
|
-
type StorePriorityRule = {
|
|
3559
|
+
current?: number;
|
|
4214
3560
|
/**
|
|
4215
|
-
* -
|
|
4216
|
-
* enabled for the article assignment.
|
|
3561
|
+
* - The type of the page, such as 'PageType'.
|
|
4217
3562
|
*/
|
|
4218
|
-
|
|
4219
|
-
storetype_order?: string[];
|
|
4220
|
-
};
|
|
4221
|
-
/** @returns {ArticleAssignmentRule} */
|
|
4222
|
-
declare function ArticleAssignmentRule(): ArticleAssignmentRule;
|
|
4223
|
-
type ArticleAssignmentRule = {
|
|
4224
|
-
store_priority?: StorePriorityRule;
|
|
4225
|
-
};
|
|
4226
|
-
/** @returns {InventoryArticleAssignment} */
|
|
4227
|
-
declare function InventoryArticleAssignment(): InventoryArticleAssignment;
|
|
4228
|
-
type InventoryArticleAssignment = {
|
|
3563
|
+
type: string;
|
|
4229
3564
|
/**
|
|
4230
|
-
* -
|
|
3565
|
+
* - The number of items per page.
|
|
4231
3566
|
*/
|
|
4232
|
-
post_order_reassignment?: boolean;
|
|
4233
|
-
rules?: ArticleAssignmentRule;
|
|
4234
|
-
};
|
|
4235
|
-
/** @returns {Page} */
|
|
4236
|
-
declare function Page(): Page;
|
|
4237
|
-
type Page = {
|
|
4238
|
-
item_total?: number;
|
|
4239
|
-
next_id?: string;
|
|
4240
|
-
has_previous?: boolean;
|
|
4241
|
-
has_next?: boolean;
|
|
4242
|
-
current?: number;
|
|
4243
|
-
type: string;
|
|
4244
3567
|
size?: number;
|
|
4245
3568
|
};
|
|
4246
3569
|
/** @returns {ApplicationInformation} */
|