@gofynd/fdk-client-javascript 1.2.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +44 -7
- package/package.json +1 -2
- package/sdk/application/ApplicationAPIClient.d.ts +3 -3
- package/sdk/application/ApplicationAPIClient.js +6 -4
- package/sdk/application/ApplicationClient.d.ts +2 -3
- package/sdk/application/ApplicationClient.js +1 -45
- package/sdk/application/ApplicationConfig.d.ts +46 -6
- package/sdk/application/ApplicationConfig.js +15 -16
- package/sdk/application/Cart/CartApplicationClient.d.ts +61 -33
- package/sdk/application/Cart/CartApplicationClient.js +225 -134
- package/sdk/application/Cart/CartApplicationModel.d.ts +4 -4
- package/sdk/application/Cart/CartApplicationModel.js +4 -4
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +61 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +234 -146
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +115 -13
- package/sdk/application/Catalog/CatalogApplicationModel.js +77 -12
- package/sdk/application/Common/CommonApplicationClient.d.ts +5 -3
- package/sdk/application/Common/CommonApplicationClient.js +13 -11
- package/sdk/application/Common/CommonApplicationModel.d.ts +3 -83
- package/sdk/application/Common/CommonApplicationModel.js +2 -58
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +9 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +25 -13
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +1 -34
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +46 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +144 -68
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1 -219
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -226
- package/sdk/application/Content/ContentApplicationClient.d.ts +49 -21
- package/sdk/application/Content/ContentApplicationClient.js +159 -80
- package/sdk/application/Content/ContentApplicationModel.d.ts +5 -622
- package/sdk/application/Content/ContentApplicationModel.js +11 -763
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +20 -14
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +1 -152
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -180
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -7
- package/sdk/application/Lead/LeadApplicationClient.js +50 -31
- package/sdk/application/Lead/LeadApplicationModel.d.ts +22 -741
- package/sdk/application/Lead/LeadApplicationModel.js +21 -481
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -5
- package/sdk/application/Logistic/LogisticApplicationClient.js +41 -20
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -12
- package/sdk/application/Order/OrderApplicationClient.js +88 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -42
- package/sdk/application/Payment/PaymentApplicationClient.js +293 -194
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +36 -36
- package/sdk/application/Payment/PaymentApplicationModel.js +36 -36
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +59 -32
- package/sdk/application/PosCart/PosCartApplicationClient.js +214 -130
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +2 -2
- package/sdk/application/PosCart/PosCartApplicationModel.js +2 -2
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +56 -29
- package/sdk/application/Share/ShareApplicationClient.d.ts +15 -7
- package/sdk/application/Share/ShareApplicationClient.js +51 -31
- package/sdk/application/Share/ShareApplicationModel.d.ts +1 -33
- package/sdk/application/Share/ShareApplicationModel.js +0 -38
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +9 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +35 -18
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +982 -312
- package/sdk/application/Theme/ThemeApplicationModel.js +621 -284
- package/sdk/application/User/UserApplicationClient.d.ts +74 -35
- package/sdk/application/User/UserApplicationClient.js +252 -161
- package/sdk/application/User/UserApplicationModel.d.ts +3 -401
- package/sdk/application/User/UserApplicationModel.js +2 -490
- package/sdk/common/AxiosHelper.js +1 -2
- package/sdk/common/FDKError.d.ts +3 -0
- package/sdk/common/FDKError.js +8 -0
- package/sdk/common/utils.d.ts +3 -0
- package/sdk/common/utils.js +29 -0
- package/sdk/partner/PartnerAPIClient.d.ts +5 -4
- package/sdk/partner/PartnerAPIClient.js +7 -4
- package/sdk/partner/PartnerClient.d.ts +2 -0
- package/sdk/partner/PartnerClient.js +3 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
- package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
- package/sdk/partner/index.d.ts +3 -1
- package/sdk/partner/index.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +38 -16
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +1 -13
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +0 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +10 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +4 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +59 -14
- package/sdk/platform/Billing/BillingPlatformClient.js +315 -64
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +56 -196
- package/sdk/platform/Billing/BillingPlatformModel.js +63 -217
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +23 -1
- package/sdk/platform/Billing/BillingPlatformValidator.js +31 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +124 -63
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +431 -265
- package/sdk/platform/Cart/CartPlatformModel.d.ts +253 -53
- package/sdk/platform/Cart/CartPlatformModel.js +104 -54
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +120 -53
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +398 -247
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +155 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.js +561 -355
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +10 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +10 -12
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +30 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -0
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -3
- package/sdk/platform/Common/CommonPlatformClient.js +13 -11
- package/sdk/platform/Common/CommonPlatformModel.d.ts +39 -64
- package/sdk/platform/Common/CommonPlatformModel.js +23 -57
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +5 -10
- package/sdk/platform/Common/CommonPlatformValidator.js +3 -4
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +370 -120
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +2328 -888
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +143 -24
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +179 -15
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +6 -5
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +386 -308
- package/sdk/platform/Communication/CommunicationPlatformModel.js +415 -355
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +38 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +171 -57
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +53 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +54 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +5 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +96 -29
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +311 -126
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +5 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +121 -86
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +13 -180
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -113
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +162 -70
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +528 -309
- package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -198
- package/sdk/platform/Content/ContentPlatformModel.js +8 -231
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +48 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +142 -48
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +40 -1
- package/sdk/platform/Discount/DiscountPlatformModel.js +27 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +84 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +486 -53
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +71 -7
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +81 -5
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +13 -18
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +58 -65
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +198 -71
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +212 -64
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +18 -10
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +177 -40
- package/sdk/platform/Finance/FinancePlatformClient.js +1028 -132
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +670 -22
- package/sdk/platform/Finance/FinancePlatformModel.js +809 -23
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +111 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +134 -0
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +24 -12
- package/sdk/platform/Inventory/InventoryPlatformClient.js +94 -52
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +27 -13
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +101 -55
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +50 -39
- package/sdk/platform/Lead/LeadPlatformClient.js +171 -112
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +32 -390
- package/sdk/platform/Lead/LeadPlatformModel.js +31 -214
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +33 -33
- package/sdk/platform/Lead/LeadPlatformValidator.js +23 -23
- package/sdk/platform/OAuthClient.js +6 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +12 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +165 -71
- package/sdk/platform/Order/OrderPlatformClient.js +738 -205
- package/sdk/platform/Order/OrderPlatformModel.d.ts +261 -3
- package/sdk/platform/Order/OrderPlatformModel.js +225 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +104 -3
- package/sdk/platform/Order/OrderPlatformValidator.js +85 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +12 -159
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -30
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +0 -26
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -690
- package/sdk/platform/Partner/PartnerPlatformModel.js +0 -809
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +167 -32
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +793 -145
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +91 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +91 -0
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +68 -47
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +549 -7
- package/sdk/platform/Payment/PaymentPlatformModel.js +305 -6
- package/sdk/platform/PlatformAPIClient.d.ts +3 -3
- package/sdk/platform/PlatformAPIClient.js +2 -2
- package/sdk/platform/PlatformClient.d.ts +2 -2
- package/sdk/platform/PlatformClient.js +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +28 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +90 -53
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +1 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +62 -26
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +210 -93
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +20 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +23 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +36 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +142 -78
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +12 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +14 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.js +36 -67
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -4
- package/sdk/platform/Share/SharePlatformModel.js +4 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +127 -57
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +564 -189
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +63 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +62 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
- package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1167 -261
- package/sdk/platform/Theme/ThemePlatformModel.js +801 -244
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
- package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -17
- package/sdk/platform/User/UserPlatformApplicationClient.js +132 -73
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.js +3 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +1 -738
- package/sdk/platform/User/UserPlatformModel.js +3 -899
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +120 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.js +799 -41
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +476 -86
- package/sdk/platform/Webhook/WebhookPlatformModel.js +388 -89
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +96 -9
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +117 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +13 -11
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +3 -106
- package/sdk/public/Configuration/ConfigurationPublicModel.js +2 -59
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +12 -6
- package/sdk/public/Inventory/InventoryPublicClient.js +42 -27
- package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
- package/sdk/public/Partner/PartnerPublicClient.js +110 -0
- package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
- package/sdk/public/Partner/PartnerPublicModel.js +280 -0
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
- package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
- package/sdk/public/PublicAPIClient.d.ts +14 -1
- package/sdk/public/PublicAPIClient.js +7 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +15 -9
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +1 -191
- package/sdk/public/Webhook/WebhookPublicModel.js +0 -229
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/application/ApplicationModels.d.ts +0 -48
- package/sdk/application/ApplicationModels.js +0 -38
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -106
- package/sdk/platform/Partner/PartnerPlatformClient.js +0 -878
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -208
- package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -169
|
@@ -14,6 +14,7 @@ declare class Inventory {
|
|
|
14
14
|
updateUrls(urls: any): void;
|
|
15
15
|
/**
|
|
16
16
|
* @param {InventoryPublicValidator.GetApiKeyParam} arg - Arg object.
|
|
17
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
17
18
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
18
19
|
* @returns {Promise<InventoryPublicModel.ResponseEnvelopeApikeyModel>} -
|
|
19
20
|
* Success response
|
|
@@ -21,9 +22,10 @@ declare class Inventory {
|
|
|
21
22
|
* @summary: Get apikey for Company to call other Slingshot Configuration APIs
|
|
22
23
|
* @description: REST Endpoint that returns apikey by username by password - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/inventory/getApiKey/).
|
|
23
24
|
*/
|
|
24
|
-
getApiKey({ userName, password }?: InventoryPublicValidator.GetApiKeyParam, {
|
|
25
|
+
getApiKey({ userName, password, requestHeaders }?: InventoryPublicValidator.GetApiKeyParam, { responseHeaders }?: object): Promise<InventoryPublicModel.ResponseEnvelopeApikeyModel>;
|
|
25
26
|
/**
|
|
26
27
|
* @param {InventoryPublicValidator.GetConfigByApiKeyParam} arg - Arg object.
|
|
28
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
27
29
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
28
30
|
* @returns {Promise<InventoryPublicModel.ResponseEnvelopeSlingshotConfigurationDetail>}
|
|
29
31
|
* - Success response
|
|
@@ -32,9 +34,10 @@ declare class Inventory {
|
|
|
32
34
|
* @summary: Get Slingshot Configuration Of A Company using API key
|
|
33
35
|
* @description: REST Endpoint that returns all configuration detail of a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/inventory/getConfigByApiKey/).
|
|
34
36
|
*/
|
|
35
|
-
getConfigByApiKey({ apikey }?: InventoryPublicValidator.GetConfigByApiKeyParam, {
|
|
37
|
+
getConfigByApiKey({ apikey, requestHeaders }?: InventoryPublicValidator.GetConfigByApiKeyParam, { responseHeaders }?: object): Promise<InventoryPublicModel.ResponseEnvelopeSlingshotConfigurationDetail>;
|
|
36
38
|
/**
|
|
37
39
|
* @param {InventoryPublicValidator.GetJobByCodeParam} arg - Arg object.
|
|
40
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
38
41
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
39
42
|
* @returns {Promise<InventoryPublicModel.ResponseEnvelopeJobConfigDTO>} -
|
|
40
43
|
* Success response
|
|
@@ -42,20 +45,22 @@ declare class Inventory {
|
|
|
42
45
|
* @summary: Get Job Config By Code
|
|
43
46
|
* @description: REST Endpoint that returns job config by code - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/inventory/getJobByCode/).
|
|
44
47
|
*/
|
|
45
|
-
getJobByCode({ code }?: InventoryPublicValidator.GetJobByCodeParam, {
|
|
48
|
+
getJobByCode({ code, requestHeaders }?: InventoryPublicValidator.GetJobByCodeParam, { responseHeaders }?: object): Promise<InventoryPublicModel.ResponseEnvelopeJobConfigDTO>;
|
|
46
49
|
/**
|
|
47
50
|
* @param {InventoryPublicValidator.GetJobCodesMetricsParam} arg - Arg object.
|
|
51
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
48
52
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
49
53
|
* @returns {Promise<InventoryPublicModel.ResponseEnvelopeObject>} - Success response
|
|
50
54
|
* @name getJobCodesMetrics
|
|
51
55
|
* @summary: Find all the JobCodes from Metrics Collection based on the field Values
|
|
52
56
|
* @description: Endpoint to return all JobCodes present in Metrics Collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/inventory/getJobCodesMetrics/).
|
|
53
57
|
*/
|
|
54
|
-
getJobCodesMetrics({ dailyJob, jobCode }?: InventoryPublicValidator.GetJobCodesMetricsParam, {
|
|
58
|
+
getJobCodesMetrics({ dailyJob, jobCode, requestHeaders }?: InventoryPublicValidator.GetJobCodesMetricsParam, { responseHeaders }?: object): Promise<InventoryPublicModel.ResponseEnvelopeObject>;
|
|
55
59
|
/**
|
|
56
60
|
* @param {InventoryPublicValidator.GetJobConfigByIntegrationTypeParam} arg
|
|
57
61
|
* - Arg object.
|
|
58
62
|
*
|
|
63
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
59
64
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
60
65
|
* @returns {Promise<InventoryPublicModel.ResponseEnvelopeListJobConfigDTO>}
|
|
61
66
|
* - Success response
|
|
@@ -64,9 +69,10 @@ declare class Inventory {
|
|
|
64
69
|
* @summary: Get Job Configs By Integration Type
|
|
65
70
|
* @description: REST Endpoint that returns all job Configs by Integration Type - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/inventory/getJobConfigByIntegrationType/).
|
|
66
71
|
*/
|
|
67
|
-
getJobConfigByIntegrationType({ integrationType, disable }?: InventoryPublicValidator.GetJobConfigByIntegrationTypeParam, {
|
|
72
|
+
getJobConfigByIntegrationType({ integrationType, disable, requestHeaders }?: InventoryPublicValidator.GetJobConfigByIntegrationTypeParam, { responseHeaders }?: object): Promise<InventoryPublicModel.ResponseEnvelopeListJobConfigDTO>;
|
|
68
73
|
/**
|
|
69
74
|
* @param {InventoryPublicValidator.SaveJobCodesMetricsParam} arg - Arg object.
|
|
75
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
70
76
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
71
77
|
* @returns {Promise<InventoryPublicModel.ResponseEnvelopeEmailJobMetrics>}
|
|
72
78
|
* - Success response
|
|
@@ -75,7 +81,7 @@ declare class Inventory {
|
|
|
75
81
|
* @summary: Save JobCode Metrics
|
|
76
82
|
* @description: Endpoint to save JobCode Metrics - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/inventory/saveJobCodesMetrics/).
|
|
77
83
|
*/
|
|
78
|
-
saveJobCodesMetrics({ body }?: InventoryPublicValidator.SaveJobCodesMetricsParam, {
|
|
84
|
+
saveJobCodesMetrics({ body, requestHeaders }?: InventoryPublicValidator.SaveJobCodesMetricsParam, { responseHeaders }?: object): Promise<InventoryPublicModel.ResponseEnvelopeEmailJobMetrics>;
|
|
79
85
|
}
|
|
80
86
|
import InventoryPublicValidator = require("./InventoryPublicValidator");
|
|
81
87
|
import InventoryPublicModel = require("./InventoryPublicModel");
|
|
@@ -39,6 +39,7 @@ class Inventory {
|
|
|
39
39
|
|
|
40
40
|
/**
|
|
41
41
|
* @param {InventoryPublicValidator.GetApiKeyParam} arg - Arg object.
|
|
42
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
42
43
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
43
44
|
* @returns {Promise<InventoryPublicModel.ResponseEnvelopeApikeyModel>} -
|
|
44
45
|
* Success response
|
|
@@ -47,8 +48,8 @@ class Inventory {
|
|
|
47
48
|
* @description: REST Endpoint that returns apikey by username by password - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/inventory/getApiKey/).
|
|
48
49
|
*/
|
|
49
50
|
async getApiKey(
|
|
50
|
-
{ userName, password } = {},
|
|
51
|
-
{
|
|
51
|
+
{ userName, password, requestHeaders } = { requestHeaders: {} },
|
|
52
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
52
53
|
) {
|
|
53
54
|
const { error } = InventoryPublicValidator.getApiKey().validate(
|
|
54
55
|
{ userName, password },
|
|
@@ -85,12 +86,12 @@ class Inventory {
|
|
|
85
86
|
}),
|
|
86
87
|
query_params,
|
|
87
88
|
undefined,
|
|
88
|
-
xHeaders,
|
|
89
|
-
{
|
|
89
|
+
{ ...xHeaders, ...requestHeaders },
|
|
90
|
+
{ responseHeaders }
|
|
90
91
|
);
|
|
91
92
|
|
|
92
93
|
let responseData = response;
|
|
93
|
-
if (
|
|
94
|
+
if (responseHeaders) {
|
|
94
95
|
responseData = response[0];
|
|
95
96
|
}
|
|
96
97
|
|
|
@@ -113,6 +114,7 @@ class Inventory {
|
|
|
113
114
|
|
|
114
115
|
/**
|
|
115
116
|
* @param {InventoryPublicValidator.GetConfigByApiKeyParam} arg - Arg object.
|
|
117
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
116
118
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
117
119
|
* @returns {Promise<InventoryPublicModel.ResponseEnvelopeSlingshotConfigurationDetail>}
|
|
118
120
|
* - Success response
|
|
@@ -121,7 +123,10 @@ class Inventory {
|
|
|
121
123
|
* @summary: Get Slingshot Configuration Of A Company using API key
|
|
122
124
|
* @description: REST Endpoint that returns all configuration detail of a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/inventory/getConfigByApiKey/).
|
|
123
125
|
*/
|
|
124
|
-
async getConfigByApiKey(
|
|
126
|
+
async getConfigByApiKey(
|
|
127
|
+
{ apikey, requestHeaders } = { requestHeaders: {} },
|
|
128
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
129
|
+
) {
|
|
125
130
|
const { error } = InventoryPublicValidator.getConfigByApiKey().validate(
|
|
126
131
|
{ apikey },
|
|
127
132
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -158,12 +163,12 @@ class Inventory {
|
|
|
158
163
|
}),
|
|
159
164
|
query_params,
|
|
160
165
|
undefined,
|
|
161
|
-
xHeaders,
|
|
162
|
-
{
|
|
166
|
+
{ ...xHeaders, ...requestHeaders },
|
|
167
|
+
{ responseHeaders }
|
|
163
168
|
);
|
|
164
169
|
|
|
165
170
|
let responseData = response;
|
|
166
|
-
if (
|
|
171
|
+
if (responseHeaders) {
|
|
167
172
|
responseData = response[0];
|
|
168
173
|
}
|
|
169
174
|
|
|
@@ -186,6 +191,7 @@ class Inventory {
|
|
|
186
191
|
|
|
187
192
|
/**
|
|
188
193
|
* @param {InventoryPublicValidator.GetJobByCodeParam} arg - Arg object.
|
|
194
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
189
195
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
190
196
|
* @returns {Promise<InventoryPublicModel.ResponseEnvelopeJobConfigDTO>} -
|
|
191
197
|
* Success response
|
|
@@ -193,7 +199,10 @@ class Inventory {
|
|
|
193
199
|
* @summary: Get Job Config By Code
|
|
194
200
|
* @description: REST Endpoint that returns job config by code - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/inventory/getJobByCode/).
|
|
195
201
|
*/
|
|
196
|
-
async getJobByCode(
|
|
202
|
+
async getJobByCode(
|
|
203
|
+
{ code, requestHeaders } = { requestHeaders: {} },
|
|
204
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
205
|
+
) {
|
|
197
206
|
const { error } = InventoryPublicValidator.getJobByCode().validate(
|
|
198
207
|
{ code },
|
|
199
208
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -229,12 +238,12 @@ class Inventory {
|
|
|
229
238
|
}),
|
|
230
239
|
query_params,
|
|
231
240
|
undefined,
|
|
232
|
-
xHeaders,
|
|
233
|
-
{
|
|
241
|
+
{ ...xHeaders, ...requestHeaders },
|
|
242
|
+
{ responseHeaders }
|
|
234
243
|
);
|
|
235
244
|
|
|
236
245
|
let responseData = response;
|
|
237
|
-
if (
|
|
246
|
+
if (responseHeaders) {
|
|
238
247
|
responseData = response[0];
|
|
239
248
|
}
|
|
240
249
|
|
|
@@ -257,6 +266,7 @@ class Inventory {
|
|
|
257
266
|
|
|
258
267
|
/**
|
|
259
268
|
* @param {InventoryPublicValidator.GetJobCodesMetricsParam} arg - Arg object.
|
|
269
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
260
270
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
261
271
|
* @returns {Promise<InventoryPublicModel.ResponseEnvelopeObject>} - Success response
|
|
262
272
|
* @name getJobCodesMetrics
|
|
@@ -264,8 +274,8 @@ class Inventory {
|
|
|
264
274
|
* @description: Endpoint to return all JobCodes present in Metrics Collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/inventory/getJobCodesMetrics/).
|
|
265
275
|
*/
|
|
266
276
|
async getJobCodesMetrics(
|
|
267
|
-
{ dailyJob, jobCode } = {},
|
|
268
|
-
{
|
|
277
|
+
{ dailyJob, jobCode, requestHeaders } = { requestHeaders: {} },
|
|
278
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
269
279
|
) {
|
|
270
280
|
const { error } = InventoryPublicValidator.getJobCodesMetrics().validate(
|
|
271
281
|
{ dailyJob, jobCode },
|
|
@@ -304,12 +314,12 @@ class Inventory {
|
|
|
304
314
|
}),
|
|
305
315
|
query_params,
|
|
306
316
|
undefined,
|
|
307
|
-
xHeaders,
|
|
308
|
-
{
|
|
317
|
+
{ ...xHeaders, ...requestHeaders },
|
|
318
|
+
{ responseHeaders }
|
|
309
319
|
);
|
|
310
320
|
|
|
311
321
|
let responseData = response;
|
|
312
|
-
if (
|
|
322
|
+
if (responseHeaders) {
|
|
313
323
|
responseData = response[0];
|
|
314
324
|
}
|
|
315
325
|
|
|
@@ -334,6 +344,7 @@ class Inventory {
|
|
|
334
344
|
* @param {InventoryPublicValidator.GetJobConfigByIntegrationTypeParam} arg
|
|
335
345
|
* - Arg object.
|
|
336
346
|
*
|
|
347
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
337
348
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
338
349
|
* @returns {Promise<InventoryPublicModel.ResponseEnvelopeListJobConfigDTO>}
|
|
339
350
|
* - Success response
|
|
@@ -343,8 +354,8 @@ class Inventory {
|
|
|
343
354
|
* @description: REST Endpoint that returns all job Configs by Integration Type - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/inventory/getJobConfigByIntegrationType/).
|
|
344
355
|
*/
|
|
345
356
|
async getJobConfigByIntegrationType(
|
|
346
|
-
{ integrationType, disable } = {},
|
|
347
|
-
{
|
|
357
|
+
{ integrationType, disable, requestHeaders } = { requestHeaders: {} },
|
|
358
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
348
359
|
) {
|
|
349
360
|
const {
|
|
350
361
|
error,
|
|
@@ -385,12 +396,12 @@ class Inventory {
|
|
|
385
396
|
}),
|
|
386
397
|
query_params,
|
|
387
398
|
undefined,
|
|
388
|
-
xHeaders,
|
|
389
|
-
{
|
|
399
|
+
{ ...xHeaders, ...requestHeaders },
|
|
400
|
+
{ responseHeaders }
|
|
390
401
|
);
|
|
391
402
|
|
|
392
403
|
let responseData = response;
|
|
393
|
-
if (
|
|
404
|
+
if (responseHeaders) {
|
|
394
405
|
responseData = response[0];
|
|
395
406
|
}
|
|
396
407
|
|
|
@@ -413,6 +424,7 @@ class Inventory {
|
|
|
413
424
|
|
|
414
425
|
/**
|
|
415
426
|
* @param {InventoryPublicValidator.SaveJobCodesMetricsParam} arg - Arg object.
|
|
427
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
416
428
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
417
429
|
* @returns {Promise<InventoryPublicModel.ResponseEnvelopeEmailJobMetrics>}
|
|
418
430
|
* - Success response
|
|
@@ -421,7 +433,10 @@ class Inventory {
|
|
|
421
433
|
* @summary: Save JobCode Metrics
|
|
422
434
|
* @description: Endpoint to save JobCode Metrics - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/inventory/saveJobCodesMetrics/).
|
|
423
435
|
*/
|
|
424
|
-
async saveJobCodesMetrics(
|
|
436
|
+
async saveJobCodesMetrics(
|
|
437
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
438
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
439
|
+
) {
|
|
425
440
|
const { error } = InventoryPublicValidator.saveJobCodesMetrics().validate(
|
|
426
441
|
{ body },
|
|
427
442
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -457,12 +472,12 @@ class Inventory {
|
|
|
457
472
|
}),
|
|
458
473
|
query_params,
|
|
459
474
|
body,
|
|
460
|
-
xHeaders,
|
|
461
|
-
{
|
|
475
|
+
{ ...xHeaders, ...requestHeaders },
|
|
476
|
+
{ responseHeaders }
|
|
462
477
|
);
|
|
463
478
|
|
|
464
479
|
let responseData = response;
|
|
465
|
-
if (
|
|
480
|
+
if (responseHeaders) {
|
|
466
481
|
responseData = response[0];
|
|
467
482
|
}
|
|
468
483
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
export = Partner;
|
|
2
|
+
declare class Partner {
|
|
3
|
+
constructor(_conf: any);
|
|
4
|
+
_conf: any;
|
|
5
|
+
_relativeUrls: {
|
|
6
|
+
getPanelExtensionDetails: string;
|
|
7
|
+
};
|
|
8
|
+
_urls: {};
|
|
9
|
+
updateUrls(urls: any): void;
|
|
10
|
+
/**
|
|
11
|
+
* @param {PartnerPublicValidator.GetPanelExtensionDetailsParam} arg - Arg object.
|
|
12
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
13
|
+
* @param {import("../PublicAPIClient").Options} - Options
|
|
14
|
+
* @returns {Promise<PartnerPublicModel.ExtensionUsingSlug>} - Success response
|
|
15
|
+
* @name getPanelExtensionDetails
|
|
16
|
+
* @summary: Get extension details
|
|
17
|
+
* @description: Use this API to get extension details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/partner/getPanelExtensionDetails/).
|
|
18
|
+
*/
|
|
19
|
+
getPanelExtensionDetails({ slug, requestHeaders }?: PartnerPublicValidator.GetPanelExtensionDetailsParam, { responseHeaders }?: object): Promise<PartnerPublicModel.ExtensionUsingSlug>;
|
|
20
|
+
}
|
|
21
|
+
import PartnerPublicValidator = require("./PartnerPublicValidator");
|
|
22
|
+
import PartnerPublicModel = require("./PartnerPublicModel");
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
const PublicAPIClient = require("../PublicAPIClient");
|
|
2
|
+
const { FDKClientValidationError } = require("../../common/FDKError");
|
|
3
|
+
const constructUrl = require("../constructUrl");
|
|
4
|
+
const Paginator = require("../../common/Paginator");
|
|
5
|
+
const PartnerPublicValidator = require("./PartnerPublicValidator");
|
|
6
|
+
const PartnerPublicModel = require("./PartnerPublicModel");
|
|
7
|
+
const { Logger } = require("./../../common/Logger");
|
|
8
|
+
const Joi = require("joi");
|
|
9
|
+
|
|
10
|
+
class Partner {
|
|
11
|
+
constructor(_conf) {
|
|
12
|
+
this._conf = _conf;
|
|
13
|
+
this._relativeUrls = {
|
|
14
|
+
getPanelExtensionDetails:
|
|
15
|
+
"/service/panel/partners/v1.0/extensions/{slug}",
|
|
16
|
+
};
|
|
17
|
+
this._urls = Object.entries(this._relativeUrls).reduce(
|
|
18
|
+
(urls, [method, relativeUrl]) => {
|
|
19
|
+
urls[method] = `${_conf.domain}${relativeUrl}`;
|
|
20
|
+
return urls;
|
|
21
|
+
},
|
|
22
|
+
{}
|
|
23
|
+
);
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
updateUrls(urls) {
|
|
27
|
+
this._urls = {
|
|
28
|
+
...this._urls,
|
|
29
|
+
...urls,
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* @param {PartnerPublicValidator.GetPanelExtensionDetailsParam} arg - Arg object.
|
|
35
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
36
|
+
* @param {import("../PublicAPIClient").Options} - Options
|
|
37
|
+
* @returns {Promise<PartnerPublicModel.ExtensionUsingSlug>} - Success response
|
|
38
|
+
* @name getPanelExtensionDetails
|
|
39
|
+
* @summary: Get extension details
|
|
40
|
+
* @description: Use this API to get extension details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/partner/getPanelExtensionDetails/).
|
|
41
|
+
*/
|
|
42
|
+
async getPanelExtensionDetails(
|
|
43
|
+
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
44
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
45
|
+
) {
|
|
46
|
+
const {
|
|
47
|
+
error,
|
|
48
|
+
} = PartnerPublicValidator.getPanelExtensionDetails().validate(
|
|
49
|
+
{ slug },
|
|
50
|
+
{ abortEarly: false, allowUnknown: true }
|
|
51
|
+
);
|
|
52
|
+
if (error) {
|
|
53
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
// Showing warrnings if extra unknown parameters are found
|
|
57
|
+
const {
|
|
58
|
+
error: warrning,
|
|
59
|
+
} = PartnerPublicValidator.getPanelExtensionDetails().validate(
|
|
60
|
+
{ slug },
|
|
61
|
+
{ abortEarly: false, allowUnknown: false }
|
|
62
|
+
);
|
|
63
|
+
if (warrning) {
|
|
64
|
+
Logger({
|
|
65
|
+
level: "WARN",
|
|
66
|
+
message: `Parameter Validation warrnings for public > Partner > getPanelExtensionDetails \n ${warrning}`,
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
const query_params = {};
|
|
71
|
+
|
|
72
|
+
const xHeaders = {};
|
|
73
|
+
|
|
74
|
+
const response = await PublicAPIClient.execute(
|
|
75
|
+
this._conf,
|
|
76
|
+
"get",
|
|
77
|
+
constructUrl({
|
|
78
|
+
url: this._urls["getPanelExtensionDetails"],
|
|
79
|
+
params: { slug },
|
|
80
|
+
}),
|
|
81
|
+
query_params,
|
|
82
|
+
undefined,
|
|
83
|
+
{ ...xHeaders, ...requestHeaders },
|
|
84
|
+
{ responseHeaders }
|
|
85
|
+
);
|
|
86
|
+
|
|
87
|
+
let responseData = response;
|
|
88
|
+
if (responseHeaders) {
|
|
89
|
+
responseData = response[0];
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
const {
|
|
93
|
+
error: res_error,
|
|
94
|
+
} = PartnerPublicModel.ExtensionUsingSlug().validate(responseData, {
|
|
95
|
+
abortEarly: false,
|
|
96
|
+
allowUnknown: false,
|
|
97
|
+
});
|
|
98
|
+
|
|
99
|
+
if (res_error) {
|
|
100
|
+
Logger({
|
|
101
|
+
level: "WARN",
|
|
102
|
+
message: `Response Validation Warnnings for public > Partner > getPanelExtensionDetails \n ${res_error}`,
|
|
103
|
+
});
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
return response;
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
module.exports = Partner;
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
export = PartnerPublicModel;
|
|
2
|
+
/**
|
|
3
|
+
* @typedef Benefits
|
|
4
|
+
* @property {string} [description]
|
|
5
|
+
* @property {string} [title]
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* @typedef CategoryCommon
|
|
9
|
+
* @property {CategoryL1[]} [category_l1]
|
|
10
|
+
* @property {CategoryL2[]} [category_l2]
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* @typedef CategoryL1
|
|
14
|
+
* @property {string} [_id]
|
|
15
|
+
* @property {string} [description]
|
|
16
|
+
* @property {string} [display]
|
|
17
|
+
* @property {number} [level]
|
|
18
|
+
* @property {string} [logo]
|
|
19
|
+
* @property {string} [slug]
|
|
20
|
+
* @property {string} [value]
|
|
21
|
+
*/
|
|
22
|
+
/**
|
|
23
|
+
* @typedef CategoryL2
|
|
24
|
+
* @property {string} [_id]
|
|
25
|
+
* @property {string} [display]
|
|
26
|
+
* @property {number} [level]
|
|
27
|
+
* @property {string} [parent]
|
|
28
|
+
* @property {string} [slug]
|
|
29
|
+
* @property {string} [value]
|
|
30
|
+
*/
|
|
31
|
+
/**
|
|
32
|
+
* @typedef ContactInfo
|
|
33
|
+
* @property {Support} [support]
|
|
34
|
+
*/
|
|
35
|
+
/**
|
|
36
|
+
* @typedef Details
|
|
37
|
+
* @property {Benefits[]} [benefits]
|
|
38
|
+
* @property {string} [demo_url]
|
|
39
|
+
* @property {string} [description]
|
|
40
|
+
* @property {string[]} [integration]
|
|
41
|
+
* @property {Screenshots} [screenshots]
|
|
42
|
+
* @property {Object[]} [video_url]
|
|
43
|
+
* @property {string[]} [youtube]
|
|
44
|
+
*/
|
|
45
|
+
/**
|
|
46
|
+
* @typedef ExtensionUsingSlug
|
|
47
|
+
* @property {string} [_id]
|
|
48
|
+
* @property {CategoryCommon} [category]
|
|
49
|
+
* @property {ContactInfo} [contact_info]
|
|
50
|
+
* @property {string} [created_at]
|
|
51
|
+
* @property {string} [current_status]
|
|
52
|
+
* @property {Details} [details]
|
|
53
|
+
* @property {string} [extension_id]
|
|
54
|
+
* @property {boolean} [is_coming_soon]
|
|
55
|
+
* @property {ListingInfo} [listing_info]
|
|
56
|
+
* @property {string} [modified_at]
|
|
57
|
+
* @property {Organization} [organization]
|
|
58
|
+
* @property {string} [organization_id]
|
|
59
|
+
* @property {string} [plan_type]
|
|
60
|
+
* @property {Plans[]} [plans]
|
|
61
|
+
* @property {string} [plans_url]
|
|
62
|
+
* @property {string} [review_instructions]
|
|
63
|
+
* @property {string[]} [scope]
|
|
64
|
+
* @property {string} [slug]
|
|
65
|
+
*/
|
|
66
|
+
/**
|
|
67
|
+
* @typedef ListingInfo
|
|
68
|
+
* @property {string} [icon]
|
|
69
|
+
* @property {string[]} [keywords]
|
|
70
|
+
* @property {string} [name]
|
|
71
|
+
* @property {string} [tagline]
|
|
72
|
+
*/
|
|
73
|
+
/**
|
|
74
|
+
* @typedef Organization
|
|
75
|
+
* @property {string} [name]
|
|
76
|
+
* @property {string} [slug]
|
|
77
|
+
*/
|
|
78
|
+
/**
|
|
79
|
+
* @typedef Plans
|
|
80
|
+
* @property {string} [additional_charges]
|
|
81
|
+
* @property {string} [features]
|
|
82
|
+
* @property {string} [name]
|
|
83
|
+
* @property {Price} [price]
|
|
84
|
+
* @property {Recurring} [recurring]
|
|
85
|
+
* @property {number} [trial_days]
|
|
86
|
+
* @property {string} [type]
|
|
87
|
+
*/
|
|
88
|
+
/**
|
|
89
|
+
* @typedef Price
|
|
90
|
+
* @property {number} [amount]
|
|
91
|
+
* @property {string} [currency]
|
|
92
|
+
*/
|
|
93
|
+
/**
|
|
94
|
+
* @typedef Recurring
|
|
95
|
+
* @property {number} [recurring_time]
|
|
96
|
+
* @property {string} [type]
|
|
97
|
+
* @property {number} [yearly_amount]
|
|
98
|
+
*/
|
|
99
|
+
/**
|
|
100
|
+
* @typedef Screenshots
|
|
101
|
+
* @property {string[]} [desktop]
|
|
102
|
+
* @property {string[]} [mobile]
|
|
103
|
+
*/
|
|
104
|
+
/**
|
|
105
|
+
* @typedef Support
|
|
106
|
+
* @property {string} [email]
|
|
107
|
+
* @property {string} [faq_url]
|
|
108
|
+
* @property {string} [phone]
|
|
109
|
+
* @property {string} [privacy_policy_url]
|
|
110
|
+
* @property {string} [website_url]
|
|
111
|
+
*/
|
|
112
|
+
declare class PartnerPublicModel {
|
|
113
|
+
}
|
|
114
|
+
declare namespace PartnerPublicModel {
|
|
115
|
+
export { Benefits, CategoryCommon, CategoryL1, CategoryL2, ContactInfo, Details, ExtensionUsingSlug, ListingInfo, Organization, Plans, Price, Recurring, Screenshots, Support };
|
|
116
|
+
}
|
|
117
|
+
/** @returns {Benefits} */
|
|
118
|
+
declare function Benefits(): Benefits;
|
|
119
|
+
type Benefits = {
|
|
120
|
+
description?: string;
|
|
121
|
+
title?: string;
|
|
122
|
+
};
|
|
123
|
+
/** @returns {CategoryCommon} */
|
|
124
|
+
declare function CategoryCommon(): CategoryCommon;
|
|
125
|
+
type CategoryCommon = {
|
|
126
|
+
category_l1?: CategoryL1[];
|
|
127
|
+
category_l2?: CategoryL2[];
|
|
128
|
+
};
|
|
129
|
+
/** @returns {CategoryL1} */
|
|
130
|
+
declare function CategoryL1(): CategoryL1;
|
|
131
|
+
type CategoryL1 = {
|
|
132
|
+
_id?: string;
|
|
133
|
+
description?: string;
|
|
134
|
+
display?: string;
|
|
135
|
+
level?: number;
|
|
136
|
+
logo?: string;
|
|
137
|
+
slug?: string;
|
|
138
|
+
value?: string;
|
|
139
|
+
};
|
|
140
|
+
/** @returns {CategoryL2} */
|
|
141
|
+
declare function CategoryL2(): CategoryL2;
|
|
142
|
+
type CategoryL2 = {
|
|
143
|
+
_id?: string;
|
|
144
|
+
display?: string;
|
|
145
|
+
level?: number;
|
|
146
|
+
parent?: string;
|
|
147
|
+
slug?: string;
|
|
148
|
+
value?: string;
|
|
149
|
+
};
|
|
150
|
+
/** @returns {ContactInfo} */
|
|
151
|
+
declare function ContactInfo(): ContactInfo;
|
|
152
|
+
type ContactInfo = {
|
|
153
|
+
support?: Support;
|
|
154
|
+
};
|
|
155
|
+
/** @returns {Details} */
|
|
156
|
+
declare function Details(): Details;
|
|
157
|
+
type Details = {
|
|
158
|
+
benefits?: Benefits[];
|
|
159
|
+
demo_url?: string;
|
|
160
|
+
description?: string;
|
|
161
|
+
integration?: string[];
|
|
162
|
+
screenshots?: Screenshots;
|
|
163
|
+
video_url?: any[];
|
|
164
|
+
youtube?: string[];
|
|
165
|
+
};
|
|
166
|
+
/** @returns {ExtensionUsingSlug} */
|
|
167
|
+
declare function ExtensionUsingSlug(): ExtensionUsingSlug;
|
|
168
|
+
type ExtensionUsingSlug = {
|
|
169
|
+
_id?: string;
|
|
170
|
+
category?: CategoryCommon;
|
|
171
|
+
contact_info?: ContactInfo;
|
|
172
|
+
created_at?: string;
|
|
173
|
+
current_status?: string;
|
|
174
|
+
details?: Details;
|
|
175
|
+
extension_id?: string;
|
|
176
|
+
is_coming_soon?: boolean;
|
|
177
|
+
listing_info?: ListingInfo;
|
|
178
|
+
modified_at?: string;
|
|
179
|
+
organization?: Organization;
|
|
180
|
+
organization_id?: string;
|
|
181
|
+
plan_type?: string;
|
|
182
|
+
plans?: Plans[];
|
|
183
|
+
plans_url?: string;
|
|
184
|
+
review_instructions?: string;
|
|
185
|
+
scope?: string[];
|
|
186
|
+
slug?: string;
|
|
187
|
+
};
|
|
188
|
+
/** @returns {ListingInfo} */
|
|
189
|
+
declare function ListingInfo(): ListingInfo;
|
|
190
|
+
type ListingInfo = {
|
|
191
|
+
icon?: string;
|
|
192
|
+
keywords?: string[];
|
|
193
|
+
name?: string;
|
|
194
|
+
tagline?: string;
|
|
195
|
+
};
|
|
196
|
+
/** @returns {Organization} */
|
|
197
|
+
declare function Organization(): Organization;
|
|
198
|
+
type Organization = {
|
|
199
|
+
name?: string;
|
|
200
|
+
slug?: string;
|
|
201
|
+
};
|
|
202
|
+
/** @returns {Plans} */
|
|
203
|
+
declare function Plans(): Plans;
|
|
204
|
+
type Plans = {
|
|
205
|
+
additional_charges?: string;
|
|
206
|
+
features?: string;
|
|
207
|
+
name?: string;
|
|
208
|
+
price?: Price;
|
|
209
|
+
recurring?: Recurring;
|
|
210
|
+
trial_days?: number;
|
|
211
|
+
type?: string;
|
|
212
|
+
};
|
|
213
|
+
/** @returns {Price} */
|
|
214
|
+
declare function Price(): Price;
|
|
215
|
+
type Price = {
|
|
216
|
+
amount?: number;
|
|
217
|
+
currency?: string;
|
|
218
|
+
};
|
|
219
|
+
/** @returns {Recurring} */
|
|
220
|
+
declare function Recurring(): Recurring;
|
|
221
|
+
type Recurring = {
|
|
222
|
+
recurring_time?: number;
|
|
223
|
+
type?: string;
|
|
224
|
+
yearly_amount?: number;
|
|
225
|
+
};
|
|
226
|
+
/** @returns {Screenshots} */
|
|
227
|
+
declare function Screenshots(): Screenshots;
|
|
228
|
+
type Screenshots = {
|
|
229
|
+
desktop?: string[];
|
|
230
|
+
mobile?: string[];
|
|
231
|
+
};
|
|
232
|
+
/** @returns {Support} */
|
|
233
|
+
declare function Support(): Support;
|
|
234
|
+
type Support = {
|
|
235
|
+
email?: string;
|
|
236
|
+
faq_url?: string;
|
|
237
|
+
phone?: string;
|
|
238
|
+
privacy_policy_url?: string;
|
|
239
|
+
website_url?: string;
|
|
240
|
+
};
|