@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.3
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 +5 -3
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +25 -25
- package/sdk/application/Cart/CartApplicationClient.js +25 -25
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +40 -40
- package/sdk/application/Catalog/CatalogApplicationClient.js +40 -40
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +10 -10
- package/sdk/application/Content/ContentApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +12 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +7 -7
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +47 -47
- package/sdk/application/Payment/PaymentApplicationClient.js +52 -52
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -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 +27 -27
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +28 -28
- package/sdk/application/User/UserApplicationClient.js +28 -28
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +22 -16
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +2 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +1 -1
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +4 -4
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +3 -3
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +19 -19
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +4 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +17 -17
- package/sdk/platform/Billing/BillingPlatformClient.js +17 -17
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +49 -49
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +49 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +60 -60
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +62 -62
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +87 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.js +87 -87
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +58 -58
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +58 -58
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +18 -18
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +63 -63
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +3 -3
- package/sdk/platform/Content/ContentPlatformClient.js +9 -9
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +23 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +27 -27
- package/sdk/platform/Finance/FinancePlatformClient.js +27 -27
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +2 -2
- package/sdk/platform/Order/OrderPlatformClient.d.ts +41 -41
- package/sdk/platform/Order/OrderPlatformClient.js +41 -41
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
- package/sdk/platform/Order/OrderPlatformModel.js +8 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +38 -38
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +28 -28
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +28 -28
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/User/UserPlatformApplicationClient.js +16 -16
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +16 -16
- package/sdk/platform/Webhook/WebhookPlatformClient.js +16 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Billing/BillingPublicClient.d.ts +1 -1
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
|
@@ -49,16 +49,9 @@ export = ThemePartnerModel;
|
|
|
49
49
|
*/
|
|
50
50
|
/**
|
|
51
51
|
* @typedef Action
|
|
52
|
+
* @property {string} [type]
|
|
52
53
|
* @property {ActionPage} [page]
|
|
53
54
|
* @property {ActionPage} [popup]
|
|
54
|
-
* @property {string} [type]
|
|
55
|
-
*/
|
|
56
|
-
/**
|
|
57
|
-
* @typedef ActionPage
|
|
58
|
-
* @property {Object} [params]
|
|
59
|
-
* @property {Object} [query]
|
|
60
|
-
* @property {string} [url]
|
|
61
|
-
* @property {PageType} type
|
|
62
55
|
*/
|
|
63
56
|
/**
|
|
64
57
|
* @typedef AvailablePageSchemaSections
|
|
@@ -442,13 +435,8 @@ export = ThemePartnerModel;
|
|
|
442
435
|
*/
|
|
443
436
|
/**
|
|
444
437
|
* @typedef Page
|
|
445
|
-
* @property {
|
|
446
|
-
* @property {string} [
|
|
447
|
-
* @property {boolean} [has_previous]
|
|
448
|
-
* @property {boolean} [has_next]
|
|
449
|
-
* @property {number} [current]
|
|
450
|
-
* @property {string} type
|
|
451
|
-
* @property {number} [size]
|
|
438
|
+
* @property {Section[]} [sections]
|
|
439
|
+
* @property {string} [value] - The value of the page.
|
|
452
440
|
*/
|
|
453
441
|
/**
|
|
454
442
|
* @typedef SectionProps
|
|
@@ -544,6 +532,13 @@ export = ThemePartnerModel;
|
|
|
544
532
|
* @property {string} [current] - The current configuration
|
|
545
533
|
* @property {Page[]} [pages]
|
|
546
534
|
*/
|
|
535
|
+
/**
|
|
536
|
+
* @typedef ActionPage
|
|
537
|
+
* @property {Object} [params]
|
|
538
|
+
* @property {Object} [query]
|
|
539
|
+
* @property {string} [url]
|
|
540
|
+
* @property {PageType} type
|
|
541
|
+
*/
|
|
547
542
|
/**
|
|
548
543
|
* @typedef {| "about-us"
|
|
549
544
|
* | "addresses"
|
|
@@ -595,7 +590,7 @@ export = ThemePartnerModel;
|
|
|
595
590
|
declare class ThemePartnerModel {
|
|
596
591
|
}
|
|
597
592
|
declare namespace ThemePartnerModel {
|
|
598
|
-
export { AvailablePageSchema, AvailablePageSectionMetaAttributes, AvailablePageSeo, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action,
|
|
593
|
+
export { AvailablePageSchema, AvailablePageSectionMetaAttributes, AvailablePageSeo, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSchemaSections, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AvailablePagePredicate, MarketplaceThemeSchema, MarketplaceTheme, PaymentInfo, ContactInfo, CatalogSize, MarketplaceThemeImages, CarouselItem, ExploreInfo, Feature, FeatureItem, Highlight, Variation, Documentation, Comments, ThemeRejectionReasons, AllAvailablePageSchema, PaginationSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, ThemesSchema, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, CustomProps, ThemeMeta, ThemePayment, Release, Images, Assets, UMDJs, CommonJS, CSS, SectionItem, GlobalSchema, Prop, Preset, Page, SectionProps, SectionPreset, ImagePickerProp, UrlProp, BlockProps, TextProp, CheckboxProp, RangeProp, Section, Block, Predicate, Screen, ThemeUserSchema, Route, UpdateThemeRequestBody, CreateNewTheme, ActionPage, PageType };
|
|
599
594
|
}
|
|
600
595
|
/** @returns {AvailablePageSchema} */
|
|
601
596
|
declare function AvailablePageSchema(): AvailablePageSchema;
|
|
@@ -661,17 +656,9 @@ type SEObreadcrumb = {
|
|
|
661
656
|
/** @returns {Action} */
|
|
662
657
|
declare function Action(): Action;
|
|
663
658
|
type Action = {
|
|
659
|
+
type?: string;
|
|
664
660
|
page?: ActionPage;
|
|
665
661
|
popup?: ActionPage;
|
|
666
|
-
type?: string;
|
|
667
|
-
};
|
|
668
|
-
/** @returns {ActionPage} */
|
|
669
|
-
declare function ActionPage(): ActionPage;
|
|
670
|
-
type ActionPage = {
|
|
671
|
-
params?: any;
|
|
672
|
-
query?: any;
|
|
673
|
-
url?: string;
|
|
674
|
-
type: PageType;
|
|
675
662
|
};
|
|
676
663
|
/** @returns {AvailablePageSchemaSections} */
|
|
677
664
|
declare function AvailablePageSchemaSections(): AvailablePageSchemaSections;
|
|
@@ -1483,13 +1470,11 @@ type Preset = {
|
|
|
1483
1470
|
/** @returns {Page} */
|
|
1484
1471
|
declare function Page(): Page;
|
|
1485
1472
|
type Page = {
|
|
1486
|
-
|
|
1487
|
-
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
type: string;
|
|
1492
|
-
size?: number;
|
|
1473
|
+
sections?: Section[];
|
|
1474
|
+
/**
|
|
1475
|
+
* - The value of the page.
|
|
1476
|
+
*/
|
|
1477
|
+
value?: string;
|
|
1493
1478
|
};
|
|
1494
1479
|
/** @returns {SectionProps} */
|
|
1495
1480
|
declare function SectionProps(): SectionProps;
|
|
@@ -1679,6 +1664,14 @@ type CreateNewTheme = {
|
|
|
1679
1664
|
current?: string;
|
|
1680
1665
|
pages?: Page[];
|
|
1681
1666
|
};
|
|
1667
|
+
/** @returns {ActionPage} */
|
|
1668
|
+
declare function ActionPage(): ActionPage;
|
|
1669
|
+
type ActionPage = {
|
|
1670
|
+
params?: any;
|
|
1671
|
+
query?: any;
|
|
1672
|
+
url?: string;
|
|
1673
|
+
type: PageType;
|
|
1674
|
+
};
|
|
1682
1675
|
/**
|
|
1683
1676
|
* Enum: PageType Used By: Theme
|
|
1684
1677
|
*
|
|
@@ -57,17 +57,9 @@ const Joi = require("joi");
|
|
|
57
57
|
|
|
58
58
|
/**
|
|
59
59
|
* @typedef Action
|
|
60
|
+
* @property {string} [type]
|
|
60
61
|
* @property {ActionPage} [page]
|
|
61
62
|
* @property {ActionPage} [popup]
|
|
62
|
-
* @property {string} [type]
|
|
63
|
-
*/
|
|
64
|
-
|
|
65
|
-
/**
|
|
66
|
-
* @typedef ActionPage
|
|
67
|
-
* @property {Object} [params]
|
|
68
|
-
* @property {Object} [query]
|
|
69
|
-
* @property {string} [url]
|
|
70
|
-
* @property {PageType} type
|
|
71
63
|
*/
|
|
72
64
|
|
|
73
65
|
/**
|
|
@@ -504,13 +496,8 @@ const Joi = require("joi");
|
|
|
504
496
|
|
|
505
497
|
/**
|
|
506
498
|
* @typedef Page
|
|
507
|
-
* @property {
|
|
508
|
-
* @property {string} [
|
|
509
|
-
* @property {boolean} [has_previous]
|
|
510
|
-
* @property {boolean} [has_next]
|
|
511
|
-
* @property {number} [current]
|
|
512
|
-
* @property {string} type
|
|
513
|
-
* @property {number} [size]
|
|
499
|
+
* @property {Section[]} [sections]
|
|
500
|
+
* @property {string} [value] - The value of the page.
|
|
514
501
|
*/
|
|
515
502
|
|
|
516
503
|
/**
|
|
@@ -623,6 +610,14 @@ const Joi = require("joi");
|
|
|
623
610
|
* @property {Page[]} [pages]
|
|
624
611
|
*/
|
|
625
612
|
|
|
613
|
+
/**
|
|
614
|
+
* @typedef ActionPage
|
|
615
|
+
* @property {Object} [params]
|
|
616
|
+
* @property {Object} [query]
|
|
617
|
+
* @property {string} [url]
|
|
618
|
+
* @property {PageType} type
|
|
619
|
+
*/
|
|
620
|
+
|
|
626
621
|
/**
|
|
627
622
|
* @typedef {| "about-us"
|
|
628
623
|
* | "addresses"
|
|
@@ -749,25 +744,9 @@ class ThemePartnerModel {
|
|
|
749
744
|
/** @returns {Action} */
|
|
750
745
|
static Action() {
|
|
751
746
|
return Joi.object({
|
|
747
|
+
type: Joi.string().allow(""),
|
|
752
748
|
page: ThemePartnerModel.ActionPage(),
|
|
753
749
|
popup: ThemePartnerModel.ActionPage(),
|
|
754
|
-
type: Joi.string().allow(""),
|
|
755
|
-
});
|
|
756
|
-
}
|
|
757
|
-
|
|
758
|
-
/** @returns {ActionPage} */
|
|
759
|
-
static ActionPage() {
|
|
760
|
-
return Joi.object({
|
|
761
|
-
params: Joi.object().pattern(
|
|
762
|
-
/\S/,
|
|
763
|
-
Joi.array().items(Joi.string().allow(""))
|
|
764
|
-
),
|
|
765
|
-
query: Joi.object().pattern(
|
|
766
|
-
/\S/,
|
|
767
|
-
Joi.array().items(Joi.string().allow(""))
|
|
768
|
-
),
|
|
769
|
-
url: Joi.string().allow(""),
|
|
770
|
-
type: ThemePartnerModel.PageType().required(),
|
|
771
750
|
});
|
|
772
751
|
}
|
|
773
752
|
|
|
@@ -1305,13 +1284,8 @@ class ThemePartnerModel {
|
|
|
1305
1284
|
/** @returns {Page} */
|
|
1306
1285
|
static Page() {
|
|
1307
1286
|
return Joi.object({
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
has_previous: Joi.boolean(),
|
|
1311
|
-
has_next: Joi.boolean(),
|
|
1312
|
-
current: Joi.number(),
|
|
1313
|
-
type: Joi.string().allow("").required(),
|
|
1314
|
-
size: Joi.number(),
|
|
1287
|
+
sections: Joi.array().items(ThemePartnerModel.Section()),
|
|
1288
|
+
value: Joi.string().allow(""),
|
|
1315
1289
|
});
|
|
1316
1290
|
}
|
|
1317
1291
|
|
|
@@ -1459,6 +1433,22 @@ class ThemePartnerModel {
|
|
|
1459
1433
|
});
|
|
1460
1434
|
}
|
|
1461
1435
|
|
|
1436
|
+
/** @returns {ActionPage} */
|
|
1437
|
+
static ActionPage() {
|
|
1438
|
+
return Joi.object({
|
|
1439
|
+
params: Joi.object().pattern(
|
|
1440
|
+
/\S/,
|
|
1441
|
+
Joi.array().items(Joi.string().allow(""))
|
|
1442
|
+
),
|
|
1443
|
+
query: Joi.object().pattern(
|
|
1444
|
+
/\S/,
|
|
1445
|
+
Joi.array().items(Joi.string().allow(""))
|
|
1446
|
+
),
|
|
1447
|
+
url: Joi.string().allow(""),
|
|
1448
|
+
type: ThemePartnerModel.PageType().required(),
|
|
1449
|
+
});
|
|
1450
|
+
}
|
|
1451
|
+
|
|
1462
1452
|
/**
|
|
1463
1453
|
* Enum: PageType Used By: Theme
|
|
1464
1454
|
*
|
|
@@ -58,7 +58,7 @@ declare class Webhook {
|
|
|
58
58
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
59
59
|
* @returns {Promise<WebhookPartnerModel.HistoryResponse>} - Success response
|
|
60
60
|
* @name getHistoricalReports
|
|
61
|
-
* @summary: Get report download history
|
|
61
|
+
* @summary: Get report download history
|
|
62
62
|
* @description: Retrieve history reports for a specific company based on the provided filters.
|
|
63
63
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/webhook/getHistoricalReports/).
|
|
64
64
|
*/
|
|
@@ -90,7 +90,7 @@ declare class Webhook {
|
|
|
90
90
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
91
91
|
* @returns {Promise<WebhookPartnerModel.UpdateSubscriberResponse>} - Success response
|
|
92
92
|
* @name updateSubscriber
|
|
93
|
-
* @summary: Update subscriber status by id
|
|
93
|
+
* @summary: Update subscriber status by id
|
|
94
94
|
* @description: Update subscriber status by id.
|
|
95
95
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/webhook/updateSubscriber/).
|
|
96
96
|
*/
|
|
@@ -438,7 +438,7 @@ class Webhook {
|
|
|
438
438
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
439
439
|
* @returns {Promise<WebhookPartnerModel.HistoryResponse>} - Success response
|
|
440
440
|
* @name getHistoricalReports
|
|
441
|
-
* @summary: Get report download history
|
|
441
|
+
* @summary: Get report download history
|
|
442
442
|
* @description: Retrieve history reports for a specific company based on the provided filters.
|
|
443
443
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/webhook/getHistoricalReports/).
|
|
444
444
|
*/
|
|
@@ -672,7 +672,7 @@ class Webhook {
|
|
|
672
672
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
673
673
|
* @returns {Promise<WebhookPartnerModel.UpdateSubscriberResponse>} - Success response
|
|
674
674
|
* @name updateSubscriber
|
|
675
|
-
* @summary: Update subscriber status by id
|
|
675
|
+
* @summary: Update subscriber status by id
|
|
676
676
|
* @description: Update subscriber status by id.
|
|
677
677
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/webhook/updateSubscriber/).
|
|
678
678
|
*/
|
|
@@ -8,7 +8,7 @@ declare class AuditTrail {
|
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<AuditTrailPlatformModel.CreateLogResponse>} - Success response
|
|
10
10
|
* @name createAuditLog
|
|
11
|
-
* @summary: Create an audit log
|
|
11
|
+
* @summary: Create an audit log
|
|
12
12
|
* @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/createAuditLog/).
|
|
13
13
|
*/
|
|
14
14
|
createAuditLog({ body, requestHeaders }?: AuditTrailPlatformValidator.CreateAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.CreateLogResponse>;
|
|
@@ -18,7 +18,7 @@ declare class AuditTrail {
|
|
|
18
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
19
|
* @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
|
|
20
20
|
* @name getAuditLog
|
|
21
|
-
* @summary: Get an audit log entry
|
|
21
|
+
* @summary: Get an audit log entry
|
|
22
22
|
* @description: Retrieve a specific audit log entry - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
|
|
23
23
|
*/
|
|
24
24
|
getAuditLog({ id, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
|
|
@@ -28,7 +28,7 @@ declare class AuditTrail {
|
|
|
28
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
29
|
* @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
|
|
30
30
|
* @name getAuditLogs
|
|
31
|
-
* @summary: Retrieve audit logs
|
|
31
|
+
* @summary: Retrieve audit logs
|
|
32
32
|
* @description: Retrieve audit logs for system events and actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
|
|
33
33
|
*/
|
|
34
34
|
getAuditLogs({ qs, limit, sort, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogsParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
|
|
@@ -38,7 +38,7 @@ declare class AuditTrail {
|
|
|
38
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
39
|
* @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
|
|
40
40
|
* @name getEntityTypes
|
|
41
|
-
* @summary: Obtain entity types for auditing
|
|
41
|
+
* @summary: Obtain entity types for auditing
|
|
42
42
|
* @description: List of entity types that can be audited within the platform's - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
|
|
43
43
|
*/
|
|
44
44
|
getEntityTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.EntityTypesResponse>;
|
|
@@ -20,7 +20,7 @@ class AuditTrail {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<AuditTrailPlatformModel.CreateLogResponse>} - Success response
|
|
22
22
|
* @name createAuditLog
|
|
23
|
-
* @summary: Create an audit log
|
|
23
|
+
* @summary: Create an audit log
|
|
24
24
|
* @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/createAuditLog/).
|
|
25
25
|
*/
|
|
26
26
|
async createAuditLog(
|
|
@@ -99,7 +99,7 @@ class AuditTrail {
|
|
|
99
99
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
100
|
* @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
|
|
101
101
|
* @name getAuditLog
|
|
102
|
-
* @summary: Get an audit log entry
|
|
102
|
+
* @summary: Get an audit log entry
|
|
103
103
|
* @description: Retrieve a specific audit log entry - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
|
|
104
104
|
*/
|
|
105
105
|
async getAuditLog(
|
|
@@ -178,7 +178,7 @@ class AuditTrail {
|
|
|
178
178
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
179
179
|
* @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
|
|
180
180
|
* @name getAuditLogs
|
|
181
|
-
* @summary: Retrieve audit logs
|
|
181
|
+
* @summary: Retrieve audit logs
|
|
182
182
|
* @description: Retrieve audit logs for system events and actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
|
|
183
183
|
*/
|
|
184
184
|
async getAuditLogs(
|
|
@@ -264,7 +264,7 @@ class AuditTrail {
|
|
|
264
264
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
265
265
|
* @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
|
|
266
266
|
* @name getEntityTypes
|
|
267
|
-
* @summary: Obtain entity types for auditing
|
|
267
|
+
* @summary: Obtain entity types for auditing
|
|
268
268
|
* @description: List of entity types that can be audited within the platform's - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
|
|
269
269
|
*/
|
|
270
270
|
async getEntityTypes(
|
|
@@ -8,7 +8,7 @@ declare class Billing {
|
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<BillingPlatformModel.SubscriptionActivateRes>} - Success response
|
|
10
10
|
* @name activateSubscriptionPlan
|
|
11
|
-
* @summary: Activate a subscription plan
|
|
11
|
+
* @summary: Activate a subscription plan
|
|
12
12
|
* @description: Activate a specific subscription plan for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/activateSubscriptionPlan/).
|
|
13
13
|
*/
|
|
14
14
|
activateSubscriptionPlan({ body, requestHeaders }?: BillingPlatformValidator.ActivateSubscriptionPlanParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionActivateRes>;
|
|
@@ -18,7 +18,7 @@ declare class Billing {
|
|
|
18
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
19
|
* @returns {Promise<BillingPlatformModel.EntitySubscription>} - Success response
|
|
20
20
|
* @name cancelSubscriptionCharge
|
|
21
|
-
* @summary: Cancel a subscription charge
|
|
21
|
+
* @summary: Cancel a subscription charge
|
|
22
22
|
* @description: Cancel an ongoing subscription charge for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
|
|
23
23
|
*/
|
|
24
24
|
cancelSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.CancelSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.EntitySubscription>;
|
|
@@ -28,7 +28,7 @@ declare class Billing {
|
|
|
28
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
29
|
* @returns {Promise<BillingPlatformModel.CancelSubscriptionRes>} - Success response
|
|
30
30
|
* @name cancelSubscriptionPlan
|
|
31
|
-
* @summary: Cancel a subscription plan
|
|
31
|
+
* @summary: Cancel a subscription plan
|
|
32
32
|
* @description: Cancel an active subscription plan for a customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionPlan/).
|
|
33
33
|
*/
|
|
34
34
|
cancelSubscriptionPlan({ body, requestHeaders }?: BillingPlatformValidator.CancelSubscriptionPlanParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CancelSubscriptionRes>;
|
|
@@ -38,7 +38,7 @@ declare class Billing {
|
|
|
38
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
39
|
* @returns {Promise<BillingPlatformModel.CheckValidityResponse>} - Success response
|
|
40
40
|
* @name checkCouponValidity
|
|
41
|
-
* @summary: Verify coupon validity
|
|
41
|
+
* @summary: Verify coupon validity
|
|
42
42
|
* @description: Checks whether a coupon code is valid for discounts while billing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/checkCouponValidity/).
|
|
43
43
|
*/
|
|
44
44
|
checkCouponValidity({ plan, couponCode, requestHeaders }?: BillingPlatformValidator.CheckCouponValidityParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CheckValidityResponse>;
|
|
@@ -49,7 +49,7 @@ declare class Billing {
|
|
|
49
49
|
* @returns {Promise<BillingPlatformModel.CreateOneTimeChargeResponse>} -
|
|
50
50
|
* Success response
|
|
51
51
|
* @name createOneTimeCharge
|
|
52
|
-
* @summary: Generate a one-time charge
|
|
52
|
+
* @summary: Generate a one-time charge
|
|
53
53
|
* @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createOneTimeCharge/).
|
|
54
54
|
*/
|
|
55
55
|
createOneTimeCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateOneTimeChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateOneTimeChargeResponse>;
|
|
@@ -60,7 +60,7 @@ declare class Billing {
|
|
|
60
60
|
* @returns {Promise<BillingPlatformModel.CreateSubscriptionResponse>} -
|
|
61
61
|
* Success response
|
|
62
62
|
* @name createSubscriptionCharge
|
|
63
|
-
* @summary: Initiate subscription billing
|
|
63
|
+
* @summary: Initiate subscription billing
|
|
64
64
|
* @description: Register a subscription charge for a seller using your extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createSubscriptionCharge/).
|
|
65
65
|
*/
|
|
66
66
|
createSubscriptionCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateSubscriptionResponse>;
|
|
@@ -70,7 +70,7 @@ declare class Billing {
|
|
|
70
70
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
71
71
|
* @returns {Promise<BillingPlatformModel.OneTimeChargeEntity>} - Success response
|
|
72
72
|
* @name getChargeDetails
|
|
73
|
-
* @summary: Obtain charge details
|
|
73
|
+
* @summary: Obtain charge details
|
|
74
74
|
* @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
|
|
75
75
|
*/
|
|
76
76
|
getChargeDetails({ extensionId, chargeId, requestHeaders }?: BillingPlatformValidator.GetChargeDetailsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.OneTimeChargeEntity>;
|
|
@@ -80,7 +80,7 @@ declare class Billing {
|
|
|
80
80
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
81
81
|
* @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
|
|
82
82
|
* @name getCustomerDetail
|
|
83
|
-
* @summary: Fetch customer details
|
|
83
|
+
* @summary: Fetch customer details
|
|
84
84
|
* @description: Obtain customer-related billing information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getCustomerDetail/).
|
|
85
85
|
*/
|
|
86
86
|
getCustomerDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionCustomer>;
|
|
@@ -90,7 +90,7 @@ declare class Billing {
|
|
|
90
90
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
91
91
|
* @returns {Promise<BillingPlatformModel.Plan[]>} - Success response
|
|
92
92
|
* @name getEnterprisePlans
|
|
93
|
-
* @summary: Retrieve enterprise-level plans
|
|
93
|
+
* @summary: Retrieve enterprise-level plans
|
|
94
94
|
* @description: Retrieve available enterprise-level subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getEnterprisePlans/).
|
|
95
95
|
*/
|
|
96
96
|
getEnterprisePlans({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.Plan[]>;
|
|
@@ -100,7 +100,7 @@ declare class Billing {
|
|
|
100
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
101
|
* @returns {Promise<BillingPlatformModel.SubscriptionLimit>} - Success response
|
|
102
102
|
* @name getFeatureLimitConfig
|
|
103
|
-
* @summary: Obtain feature limit configurations
|
|
103
|
+
* @summary: Obtain feature limit configurations
|
|
104
104
|
* @description: Retrieve configuration settings for feature limits in subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getFeatureLimitConfig/).
|
|
105
105
|
*/
|
|
106
106
|
getFeatureLimitConfig({ productSuite, type, requestHeaders }?: BillingPlatformValidator.GetFeatureLimitConfigParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionLimit>;
|
|
@@ -110,7 +110,7 @@ declare class Billing {
|
|
|
110
110
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
111
111
|
* @returns {Promise<BillingPlatformModel.Invoice>} - Success response
|
|
112
112
|
* @name getInvoiceById
|
|
113
|
-
* @summary: Get a specific invoice
|
|
113
|
+
* @summary: Get a specific invoice
|
|
114
114
|
* @description: Retrieve a particular invoice's details by providing its unique ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoiceById/).
|
|
115
115
|
*/
|
|
116
116
|
getInvoiceById({ invoiceId, requestHeaders }?: BillingPlatformValidator.GetInvoiceByIdParam, { responseHeaders }?: object): Promise<BillingPlatformModel.Invoice>;
|
|
@@ -120,7 +120,7 @@ declare class Billing {
|
|
|
120
120
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
121
121
|
* @returns {Promise<BillingPlatformModel.Invoices>} - Success response
|
|
122
122
|
* @name getInvoices
|
|
123
|
-
* @summary: Retrieve invoices
|
|
123
|
+
* @summary: Retrieve invoices
|
|
124
124
|
* @description: Retrieve invoices for billing and payment tracking. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoices/).
|
|
125
125
|
*/
|
|
126
126
|
getInvoices({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.Invoices>;
|
|
@@ -130,7 +130,7 @@ declare class Billing {
|
|
|
130
130
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
131
131
|
* @returns {Promise<BillingPlatformModel.SubscriptionStatus>} - Success response
|
|
132
132
|
* @name getSubscription
|
|
133
|
-
* @summary: Retrieve subscription details
|
|
133
|
+
* @summary: Retrieve subscription details
|
|
134
134
|
* @description: Retrieve details of a customer's subscription information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscription/).
|
|
135
135
|
*/
|
|
136
136
|
getSubscription({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionStatus>;
|
|
@@ -140,7 +140,7 @@ declare class Billing {
|
|
|
140
140
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
141
141
|
* @returns {Promise<BillingPlatformModel.EntitySubscription>} - Success response
|
|
142
142
|
* @name getSubscriptionCharge
|
|
143
|
-
* @summary: Retrieve subscription charge details
|
|
143
|
+
* @summary: Retrieve subscription charge details
|
|
144
144
|
* @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscriptionCharge/).
|
|
145
145
|
*/
|
|
146
146
|
getSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.GetSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.EntitySubscription>;
|
|
@@ -160,7 +160,7 @@ declare class Billing {
|
|
|
160
160
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
161
161
|
* @returns {Promise<BillingPlatformModel.Plan>} - Success response
|
|
162
162
|
* @name planStatusUpdate
|
|
163
|
-
* @summary: Update subscription plan status
|
|
163
|
+
* @summary: Update subscription plan status
|
|
164
164
|
* @description: Modify the status of a subscription plan. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/planStatusUpdate/).
|
|
165
165
|
*/
|
|
166
166
|
planStatusUpdate({ body, requestHeaders }?: BillingPlatformValidator.PlanStatusUpdateParam, { responseHeaders }?: object): Promise<BillingPlatformModel.Plan>;
|
|
@@ -170,7 +170,7 @@ declare class Billing {
|
|
|
170
170
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
171
171
|
* @returns {Promise<BillingPlatformModel.SubscribePlanRes>} - Success response
|
|
172
172
|
* @name subscripePlan
|
|
173
|
-
* @summary: Subscribe to a plan
|
|
173
|
+
* @summary: Subscribe to a plan
|
|
174
174
|
* @description: Subscribe to a specific billing plan. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscripePlan/).
|
|
175
175
|
*/
|
|
176
176
|
subscripePlan({ body, requestHeaders }?: BillingPlatformValidator.SubscripePlanParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscribePlanRes>;
|
|
@@ -180,7 +180,7 @@ declare class Billing {
|
|
|
180
180
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
181
181
|
* @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
|
|
182
182
|
* @name upsertCustomerDetail
|
|
183
|
-
* @summary: Update or insert customer details
|
|
183
|
+
* @summary: Update or insert customer details
|
|
184
184
|
* @description: Allows you to modify or insert customer information in the billing system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/upsertCustomerDetail/).
|
|
185
185
|
*/
|
|
186
186
|
upsertCustomerDetail({ body, requestHeaders }?: BillingPlatformValidator.UpsertCustomerDetailParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionCustomer>;
|
|
@@ -20,7 +20,7 @@ class Billing {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<BillingPlatformModel.SubscriptionActivateRes>} - Success response
|
|
22
22
|
* @name activateSubscriptionPlan
|
|
23
|
-
* @summary: Activate a subscription plan
|
|
23
|
+
* @summary: Activate a subscription plan
|
|
24
24
|
* @description: Activate a specific subscription plan for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/activateSubscriptionPlan/).
|
|
25
25
|
*/
|
|
26
26
|
async activateSubscriptionPlan(
|
|
@@ -101,7 +101,7 @@ class Billing {
|
|
|
101
101
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
102
102
|
* @returns {Promise<BillingPlatformModel.EntitySubscription>} - Success response
|
|
103
103
|
* @name cancelSubscriptionCharge
|
|
104
|
-
* @summary: Cancel a subscription charge
|
|
104
|
+
* @summary: Cancel a subscription charge
|
|
105
105
|
* @description: Cancel an ongoing subscription charge for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
|
|
106
106
|
*/
|
|
107
107
|
async cancelSubscriptionCharge(
|
|
@@ -184,7 +184,7 @@ class Billing {
|
|
|
184
184
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
185
185
|
* @returns {Promise<BillingPlatformModel.CancelSubscriptionRes>} - Success response
|
|
186
186
|
* @name cancelSubscriptionPlan
|
|
187
|
-
* @summary: Cancel a subscription plan
|
|
187
|
+
* @summary: Cancel a subscription plan
|
|
188
188
|
* @description: Cancel an active subscription plan for a customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionPlan/).
|
|
189
189
|
*/
|
|
190
190
|
async cancelSubscriptionPlan(
|
|
@@ -265,7 +265,7 @@ class Billing {
|
|
|
265
265
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
266
266
|
* @returns {Promise<BillingPlatformModel.CheckValidityResponse>} - Success response
|
|
267
267
|
* @name checkCouponValidity
|
|
268
|
-
* @summary: Verify coupon validity
|
|
268
|
+
* @summary: Verify coupon validity
|
|
269
269
|
* @description: Checks whether a coupon code is valid for discounts while billing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/checkCouponValidity/).
|
|
270
270
|
*/
|
|
271
271
|
async checkCouponValidity(
|
|
@@ -349,7 +349,7 @@ class Billing {
|
|
|
349
349
|
* @returns {Promise<BillingPlatformModel.CreateOneTimeChargeResponse>} -
|
|
350
350
|
* Success response
|
|
351
351
|
* @name createOneTimeCharge
|
|
352
|
-
* @summary: Generate a one-time charge
|
|
352
|
+
* @summary: Generate a one-time charge
|
|
353
353
|
* @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createOneTimeCharge/).
|
|
354
354
|
*/
|
|
355
355
|
async createOneTimeCharge(
|
|
@@ -431,7 +431,7 @@ class Billing {
|
|
|
431
431
|
* @returns {Promise<BillingPlatformModel.CreateSubscriptionResponse>} -
|
|
432
432
|
* Success response
|
|
433
433
|
* @name createSubscriptionCharge
|
|
434
|
-
* @summary: Initiate subscription billing
|
|
434
|
+
* @summary: Initiate subscription billing
|
|
435
435
|
* @description: Register a subscription charge for a seller using your extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createSubscriptionCharge/).
|
|
436
436
|
*/
|
|
437
437
|
async createSubscriptionCharge(
|
|
@@ -514,7 +514,7 @@ class Billing {
|
|
|
514
514
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
515
515
|
* @returns {Promise<BillingPlatformModel.OneTimeChargeEntity>} - Success response
|
|
516
516
|
* @name getChargeDetails
|
|
517
|
-
* @summary: Obtain charge details
|
|
517
|
+
* @summary: Obtain charge details
|
|
518
518
|
* @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
|
|
519
519
|
*/
|
|
520
520
|
async getChargeDetails(
|
|
@@ -595,7 +595,7 @@ class Billing {
|
|
|
595
595
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
596
596
|
* @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
|
|
597
597
|
* @name getCustomerDetail
|
|
598
|
-
* @summary: Fetch customer details
|
|
598
|
+
* @summary: Fetch customer details
|
|
599
599
|
* @description: Obtain customer-related billing information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getCustomerDetail/).
|
|
600
600
|
*/
|
|
601
601
|
async getCustomerDetail(
|
|
@@ -670,7 +670,7 @@ class Billing {
|
|
|
670
670
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
671
671
|
* @returns {Promise<BillingPlatformModel.Plan[]>} - Success response
|
|
672
672
|
* @name getEnterprisePlans
|
|
673
|
-
* @summary: Retrieve enterprise-level plans
|
|
673
|
+
* @summary: Retrieve enterprise-level plans
|
|
674
674
|
* @description: Retrieve available enterprise-level subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getEnterprisePlans/).
|
|
675
675
|
*/
|
|
676
676
|
async getEnterprisePlans(
|
|
@@ -742,7 +742,7 @@ class Billing {
|
|
|
742
742
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
743
743
|
* @returns {Promise<BillingPlatformModel.SubscriptionLimit>} - Success response
|
|
744
744
|
* @name getFeatureLimitConfig
|
|
745
|
-
* @summary: Obtain feature limit configurations
|
|
745
|
+
* @summary: Obtain feature limit configurations
|
|
746
746
|
* @description: Retrieve configuration settings for feature limits in subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getFeatureLimitConfig/).
|
|
747
747
|
*/
|
|
748
748
|
async getFeatureLimitConfig(
|
|
@@ -825,7 +825,7 @@ class Billing {
|
|
|
825
825
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
826
826
|
* @returns {Promise<BillingPlatformModel.Invoice>} - Success response
|
|
827
827
|
* @name getInvoiceById
|
|
828
|
-
* @summary: Get a specific invoice
|
|
828
|
+
* @summary: Get a specific invoice
|
|
829
829
|
* @description: Retrieve a particular invoice's details by providing its unique ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoiceById/).
|
|
830
830
|
*/
|
|
831
831
|
async getInvoiceById(
|
|
@@ -904,7 +904,7 @@ class Billing {
|
|
|
904
904
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
905
905
|
* @returns {Promise<BillingPlatformModel.Invoices>} - Success response
|
|
906
906
|
* @name getInvoices
|
|
907
|
-
* @summary: Retrieve invoices
|
|
907
|
+
* @summary: Retrieve invoices
|
|
908
908
|
* @description: Retrieve invoices for billing and payment tracking. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoices/).
|
|
909
909
|
*/
|
|
910
910
|
async getInvoices(
|
|
@@ -977,7 +977,7 @@ class Billing {
|
|
|
977
977
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
978
978
|
* @returns {Promise<BillingPlatformModel.SubscriptionStatus>} - Success response
|
|
979
979
|
* @name getSubscription
|
|
980
|
-
* @summary: Retrieve subscription details
|
|
980
|
+
* @summary: Retrieve subscription details
|
|
981
981
|
* @description: Retrieve details of a customer's subscription information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscription/).
|
|
982
982
|
*/
|
|
983
983
|
async getSubscription(
|
|
@@ -1052,7 +1052,7 @@ class Billing {
|
|
|
1052
1052
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1053
1053
|
* @returns {Promise<BillingPlatformModel.EntitySubscription>} - Success response
|
|
1054
1054
|
* @name getSubscriptionCharge
|
|
1055
|
-
* @summary: Retrieve subscription charge details
|
|
1055
|
+
* @summary: Retrieve subscription charge details
|
|
1056
1056
|
* @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscriptionCharge/).
|
|
1057
1057
|
*/
|
|
1058
1058
|
async getSubscriptionCharge(
|
|
@@ -1232,7 +1232,7 @@ class Billing {
|
|
|
1232
1232
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1233
1233
|
* @returns {Promise<BillingPlatformModel.Plan>} - Success response
|
|
1234
1234
|
* @name planStatusUpdate
|
|
1235
|
-
* @summary: Update subscription plan status
|
|
1235
|
+
* @summary: Update subscription plan status
|
|
1236
1236
|
* @description: Modify the status of a subscription plan. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/planStatusUpdate/).
|
|
1237
1237
|
*/
|
|
1238
1238
|
async planStatusUpdate(
|
|
@@ -1311,7 +1311,7 @@ class Billing {
|
|
|
1311
1311
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1312
1312
|
* @returns {Promise<BillingPlatformModel.SubscribePlanRes>} - Success response
|
|
1313
1313
|
* @name subscripePlan
|
|
1314
|
-
* @summary: Subscribe to a plan
|
|
1314
|
+
* @summary: Subscribe to a plan
|
|
1315
1315
|
* @description: Subscribe to a specific billing plan. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscripePlan/).
|
|
1316
1316
|
*/
|
|
1317
1317
|
async subscripePlan(
|
|
@@ -1390,7 +1390,7 @@ class Billing {
|
|
|
1390
1390
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1391
1391
|
* @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
|
|
1392
1392
|
* @name upsertCustomerDetail
|
|
1393
|
-
* @summary: Update or insert customer details
|
|
1393
|
+
* @summary: Update or insert customer details
|
|
1394
1394
|
* @description: Allows you to modify or insert customer information in the billing system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/upsertCustomerDetail/).
|
|
1395
1395
|
*/
|
|
1396
1396
|
async upsertCustomerDetail(
|