@gofynd/fdk-client-javascript 3.3.3 → 3.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -30
- 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 +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- 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 +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +57 -3
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +40 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +62 -3
- package/sdk/platform/Cart/CartPlatformModel.js +33 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +89 -82
- package/sdk/platform/Catalog/CatalogPlatformClient.js +121 -85
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +61 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +42 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +46 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +21 -4
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9 -9
- package/sdk/platform/Order/OrderPlatformModel.js +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +85 -3
- package/sdk/platform/Payment/PaymentPlatformModel.js +49 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +59 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +42 -1
- 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 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +34 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +34 -34
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -9,7 +9,7 @@ declare class Webhook {
|
|
|
9
9
|
* @returns {Promise<WebhookPartnerModel.ResponseTimeTs>} - Success response
|
|
10
10
|
* @name responseTimeSummary
|
|
11
11
|
* @summary: Response time summary
|
|
12
|
-
* @description: Response time summary - Check out [method documentation](https://
|
|
12
|
+
* @description: Response time summary - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/responseTimeSummary/).
|
|
13
13
|
*/
|
|
14
14
|
responseTimeSummary({ extensionId, startDate, endDate, requestHeaders }?: WebhookPartnerValidator.ResponseTimeSummaryParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.ResponseTimeTs>;
|
|
15
15
|
/**
|
|
@@ -19,7 +19,7 @@ declare class Webhook {
|
|
|
19
19
|
* @returns {Promise<WebhookPartnerModel.DeliverySummaryResult>} - Success response
|
|
20
20
|
* @name fetchDeliverySummary
|
|
21
21
|
* @summary: Webhook delivery summary
|
|
22
|
-
* @description: Webhook delivery summary - Check out [method documentation](https://
|
|
22
|
+
* @description: Webhook delivery summary - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/fetchDeliverySummary/).
|
|
23
23
|
*/
|
|
24
24
|
fetchDeliverySummary({ extensionId, startDate, endDate, requestHeaders }?: WebhookPartnerValidator.FetchDeliverySummaryParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.DeliverySummaryResult>;
|
|
25
25
|
/**
|
|
@@ -29,7 +29,7 @@ declare class Webhook {
|
|
|
29
29
|
* @returns {Promise<WebhookPartnerModel.DeliveryDetailsResult>} - Success response
|
|
30
30
|
* @name getDeliveryDetailInsights
|
|
31
31
|
* @summary: Get the insights of delivery details of the events that was pushed to subscribers
|
|
32
|
-
* @description: Get the delivery details insights - Check out [method documentation](https://
|
|
32
|
+
* @description: Get the delivery details insights - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/getDeliveryDetailInsights/).
|
|
33
33
|
*/
|
|
34
34
|
getDeliveryDetailInsights({ extensionId, body, requestHeaders }?: WebhookPartnerValidator.GetDeliveryDetailInsightsParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.DeliveryDetailsResult>;
|
|
35
35
|
/**
|
|
@@ -39,7 +39,7 @@ declare class Webhook {
|
|
|
39
39
|
* @returns {Promise<WebhookPartnerModel.DeliveryTsResult>} - Success response
|
|
40
40
|
* @name fetchDeliveryTs
|
|
41
41
|
* @summary: Webhook delivery ts
|
|
42
|
-
* @description: Webhook delivery ts - Check out [method documentation](https://
|
|
42
|
+
* @description: Webhook delivery ts - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/fetchDeliveryTs/).
|
|
43
43
|
*/
|
|
44
44
|
fetchDeliveryTs({ extensionId, startDate, endDate, requestHeaders }?: WebhookPartnerValidator.FetchDeliveryTsParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.DeliveryTsResult>;
|
|
45
45
|
/**
|
|
@@ -49,7 +49,7 @@ declare class Webhook {
|
|
|
49
49
|
* @returns {Promise<WebhookPartnerModel.FilterReportResult[]>} - Success response
|
|
50
50
|
* @name fetchReportFilters
|
|
51
51
|
* @summary: Fetch webhook report filters
|
|
52
|
-
* @description: Fetch webhook report filters - Check out [method documentation](https://
|
|
52
|
+
* @description: Fetch webhook report filters - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/fetchReportFilters/).
|
|
53
53
|
*/
|
|
54
54
|
fetchReportFilters({ extensionId, startDate, endDate, pageNo, pageSize, requestHeaders }?: WebhookPartnerValidator.FetchReportFiltersParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.FilterReportResult[]>;
|
|
55
55
|
/**
|
|
@@ -59,7 +59,7 @@ declare class Webhook {
|
|
|
59
59
|
* @returns {Promise<WebhookPartnerModel.CancelDownloadResult>} - Success response
|
|
60
60
|
* @name cancelReportDownload
|
|
61
61
|
* @summary: Cancel report download job
|
|
62
|
-
* @description: Cancel report download job - Check out [method documentation](https://
|
|
62
|
+
* @description: Cancel report download job - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/cancelReportDownload/).
|
|
63
63
|
*/
|
|
64
64
|
cancelReportDownload({ extensionId, filename, requestHeaders }?: WebhookPartnerValidator.CancelReportDownloadParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.CancelDownloadResult>;
|
|
65
65
|
/**
|
|
@@ -70,7 +70,7 @@ declare class Webhook {
|
|
|
70
70
|
* @name getHistoricalReports
|
|
71
71
|
* @summary: Get report download history.
|
|
72
72
|
* @description: Retrieve history reports for a specific company based on the provided filters.
|
|
73
|
-
* - Check out [method documentation](https://
|
|
73
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/getHistoricalReports/).
|
|
74
74
|
*/
|
|
75
75
|
getHistoricalReports({ extensionId, body, requestHeaders }?: WebhookPartnerValidator.GetHistoricalReportsParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.HistoryResult>;
|
|
76
76
|
/**
|
|
@@ -81,7 +81,7 @@ declare class Webhook {
|
|
|
81
81
|
* @name getInvalidEventList
|
|
82
82
|
* @summary: Get invalid event list
|
|
83
83
|
* @description: Get invalid event list.
|
|
84
|
-
* - Check out [method documentation](https://
|
|
84
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/getInvalidEventList/).
|
|
85
85
|
*/
|
|
86
86
|
getInvalidEventList({ extensionId, body, requestHeaders }?: WebhookPartnerValidator.GetInvalidEventListParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.InvalidEventsResult[]>;
|
|
87
87
|
/**
|
|
@@ -91,7 +91,7 @@ declare class Webhook {
|
|
|
91
91
|
* @returns {Promise<WebhookPartnerModel.SubscriberConfigDetails>} - Success response
|
|
92
92
|
* @name fetchSubscribers
|
|
93
93
|
* @summary: Fetch subscriber by filters
|
|
94
|
-
* @description: Fetch subscriber by filters - Check out [method documentation](https://
|
|
94
|
+
* @description: Fetch subscriber by filters - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/fetchSubscribers/).
|
|
95
95
|
*/
|
|
96
96
|
fetchSubscribers({ extensionId, requestHeaders }?: WebhookPartnerValidator.FetchSubscribersParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.SubscriberConfigDetails>;
|
|
97
97
|
/**
|
|
@@ -102,7 +102,7 @@ declare class Webhook {
|
|
|
102
102
|
* @name updateSubscriber
|
|
103
103
|
* @summary: Update subscriber status by id.
|
|
104
104
|
* @description: Update subscriber status by id.
|
|
105
|
-
* - Check out [method documentation](https://
|
|
105
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/updateSubscriber/).
|
|
106
106
|
*/
|
|
107
107
|
updateSubscriber({ extensionId, subscriberId, body, requestHeaders }?: WebhookPartnerValidator.UpdateSubscriberParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.SubscriberUpdateResult>;
|
|
108
108
|
}
|
|
@@ -21,7 +21,7 @@ class Webhook {
|
|
|
21
21
|
* @returns {Promise<WebhookPartnerModel.ResponseTimeTs>} - Success response
|
|
22
22
|
* @name responseTimeSummary
|
|
23
23
|
* @summary: Response time summary
|
|
24
|
-
* @description: Response time summary - Check out [method documentation](https://
|
|
24
|
+
* @description: Response time summary - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/responseTimeSummary/).
|
|
25
25
|
*/
|
|
26
26
|
async responseTimeSummary(
|
|
27
27
|
{ extensionId, startDate, endDate, requestHeaders } = {
|
|
@@ -106,7 +106,7 @@ class Webhook {
|
|
|
106
106
|
* @returns {Promise<WebhookPartnerModel.DeliverySummaryResult>} - Success response
|
|
107
107
|
* @name fetchDeliverySummary
|
|
108
108
|
* @summary: Webhook delivery summary
|
|
109
|
-
* @description: Webhook delivery summary - Check out [method documentation](https://
|
|
109
|
+
* @description: Webhook delivery summary - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/fetchDeliverySummary/).
|
|
110
110
|
*/
|
|
111
111
|
async fetchDeliverySummary(
|
|
112
112
|
{ extensionId, startDate, endDate, requestHeaders } = {
|
|
@@ -191,7 +191,7 @@ class Webhook {
|
|
|
191
191
|
* @returns {Promise<WebhookPartnerModel.DeliveryDetailsResult>} - Success response
|
|
192
192
|
* @name getDeliveryDetailInsights
|
|
193
193
|
* @summary: Get the insights of delivery details of the events that was pushed to subscribers
|
|
194
|
-
* @description: Get the delivery details insights - Check out [method documentation](https://
|
|
194
|
+
* @description: Get the delivery details insights - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/getDeliveryDetailInsights/).
|
|
195
195
|
*/
|
|
196
196
|
async getDeliveryDetailInsights(
|
|
197
197
|
{ extensionId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -272,7 +272,7 @@ class Webhook {
|
|
|
272
272
|
* @returns {Promise<WebhookPartnerModel.DeliveryTsResult>} - Success response
|
|
273
273
|
* @name fetchDeliveryTs
|
|
274
274
|
* @summary: Webhook delivery ts
|
|
275
|
-
* @description: Webhook delivery ts - Check out [method documentation](https://
|
|
275
|
+
* @description: Webhook delivery ts - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/fetchDeliveryTs/).
|
|
276
276
|
*/
|
|
277
277
|
async fetchDeliveryTs(
|
|
278
278
|
{ extensionId, startDate, endDate, requestHeaders } = {
|
|
@@ -357,7 +357,7 @@ class Webhook {
|
|
|
357
357
|
* @returns {Promise<WebhookPartnerModel.FilterReportResult[]>} - Success response
|
|
358
358
|
* @name fetchReportFilters
|
|
359
359
|
* @summary: Fetch webhook report filters
|
|
360
|
-
* @description: Fetch webhook report filters - Check out [method documentation](https://
|
|
360
|
+
* @description: Fetch webhook report filters - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/fetchReportFilters/).
|
|
361
361
|
*/
|
|
362
362
|
async fetchReportFilters(
|
|
363
363
|
{ extensionId, startDate, endDate, pageNo, pageSize, requestHeaders } = {
|
|
@@ -445,7 +445,7 @@ class Webhook {
|
|
|
445
445
|
* @returns {Promise<WebhookPartnerModel.CancelDownloadResult>} - Success response
|
|
446
446
|
* @name cancelReportDownload
|
|
447
447
|
* @summary: Cancel report download job
|
|
448
|
-
* @description: Cancel report download job - Check out [method documentation](https://
|
|
448
|
+
* @description: Cancel report download job - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/cancelReportDownload/).
|
|
449
449
|
*/
|
|
450
450
|
async cancelReportDownload(
|
|
451
451
|
{ extensionId, filename, requestHeaders } = { requestHeaders: {} },
|
|
@@ -525,7 +525,7 @@ class Webhook {
|
|
|
525
525
|
* @name getHistoricalReports
|
|
526
526
|
* @summary: Get report download history.
|
|
527
527
|
* @description: Retrieve history reports for a specific company based on the provided filters.
|
|
528
|
-
* - Check out [method documentation](https://
|
|
528
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/getHistoricalReports/).
|
|
529
529
|
*/
|
|
530
530
|
async getHistoricalReports(
|
|
531
531
|
{ extensionId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -605,7 +605,7 @@ class Webhook {
|
|
|
605
605
|
* @name getInvalidEventList
|
|
606
606
|
* @summary: Get invalid event list
|
|
607
607
|
* @description: Get invalid event list.
|
|
608
|
-
* - Check out [method documentation](https://
|
|
608
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/getInvalidEventList/).
|
|
609
609
|
*/
|
|
610
610
|
async getInvalidEventList(
|
|
611
611
|
{ extensionId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -681,7 +681,7 @@ class Webhook {
|
|
|
681
681
|
* @returns {Promise<WebhookPartnerModel.SubscriberConfigDetails>} - Success response
|
|
682
682
|
* @name fetchSubscribers
|
|
683
683
|
* @summary: Fetch subscriber by filters
|
|
684
|
-
* @description: Fetch subscriber by filters - Check out [method documentation](https://
|
|
684
|
+
* @description: Fetch subscriber by filters - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/fetchSubscribers/).
|
|
685
685
|
*/
|
|
686
686
|
async fetchSubscribers(
|
|
687
687
|
{ extensionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -759,7 +759,7 @@ class Webhook {
|
|
|
759
759
|
* @name updateSubscriber
|
|
760
760
|
* @summary: Update subscriber status by id.
|
|
761
761
|
* @description: Update subscriber status by id.
|
|
762
|
-
* - Check out [method documentation](https://
|
|
762
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/updateSubscriber/).
|
|
763
763
|
*/
|
|
764
764
|
async updateSubscriber(
|
|
765
765
|
{ extensionId, subscriberId, body, requestHeaders } = {
|
|
@@ -249,7 +249,7 @@ export = WebhookPartnerModel;
|
|
|
249
249
|
*/
|
|
250
250
|
/**
|
|
251
251
|
* @typedef Page
|
|
252
|
-
* @property {number} [item_total] - The total number of items
|
|
252
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
253
253
|
* @property {string} [next_id] - The identifier for the next page.
|
|
254
254
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
255
255
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -906,7 +906,7 @@ type EventProcessReportObject = {
|
|
|
906
906
|
declare function Page(): Page;
|
|
907
907
|
type Page = {
|
|
908
908
|
/**
|
|
909
|
-
* - The total number of items
|
|
909
|
+
* - The total number of all items across all pages.
|
|
910
910
|
*/
|
|
911
911
|
item_total?: number;
|
|
912
912
|
/**
|
|
@@ -277,7 +277,7 @@ const Joi = require("joi");
|
|
|
277
277
|
|
|
278
278
|
/**
|
|
279
279
|
* @typedef Page
|
|
280
|
-
* @property {number} [item_total] - The total number of items
|
|
280
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
281
281
|
* @property {string} [next_id] - The identifier for the next page.
|
|
282
282
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
283
283
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -12,7 +12,7 @@ declare class Analytics {
|
|
|
12
12
|
* @returns {Promise<AnalyticsPlatformModel.JobStatus>} - Success response
|
|
13
13
|
* @name checkJobStatusByNameV2
|
|
14
14
|
* @summary: Checks download job status
|
|
15
|
-
* @description: Takes job name in path param to check the status of job Returns file URL if downloading is done else returns status of job - Check out [method documentation](https://
|
|
15
|
+
* @description: Takes job name in path param to check the status of job Returns file URL if downloading is done else returns status of job - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/checkJobStatusByNameV2/).
|
|
16
16
|
*/
|
|
17
17
|
checkJobStatusByNameV2({ fileName, requestHeaders }?: AnalyticsPlatformApplicationValidator.CheckJobStatusByNameV2Param, { responseHeaders }?: object): Promise<AnalyticsPlatformModel.JobStatus>;
|
|
18
18
|
/**
|
|
@@ -24,7 +24,7 @@ declare class Analytics {
|
|
|
24
24
|
* @returns {Promise<AnalyticsPlatformModel.JobExecutionResult>} - Success response
|
|
25
25
|
* @name executeJobForProvidedParametersV2
|
|
26
26
|
* @summary: Executes given sql(Base64 Encoded) query
|
|
27
|
-
* @description: Query click events data - Check out [method documentation](https://
|
|
27
|
+
* @description: Query click events data - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/executeJobForProvidedParametersV2/).
|
|
28
28
|
*/
|
|
29
29
|
executeJobForProvidedParametersV2({ body, requestHeaders }?: AnalyticsPlatformApplicationValidator.ExecuteJobForProvidedParametersV2Param, { responseHeaders }?: object): Promise<AnalyticsPlatformModel.JobExecutionResult>;
|
|
30
30
|
/**
|
|
@@ -36,7 +36,7 @@ declare class Analytics {
|
|
|
36
36
|
* @returns {Promise<Object>} - Success response
|
|
37
37
|
* @name startDownloadForQueryV2
|
|
38
38
|
* @summary: Initiates download job
|
|
39
|
-
* @description: Initiates download job and returns job name - Check out [method documentation](https://
|
|
39
|
+
* @description: Initiates download job and returns job name - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/startDownloadForQueryV2/).
|
|
40
40
|
*/
|
|
41
41
|
startDownloadForQueryV2({ exportType, body, requestHeaders }?: AnalyticsPlatformApplicationValidator.StartDownloadForQueryV2Param, { responseHeaders }?: object): Promise<any>;
|
|
42
42
|
}
|
|
@@ -24,7 +24,7 @@ class Analytics {
|
|
|
24
24
|
* @returns {Promise<AnalyticsPlatformModel.JobStatus>} - Success response
|
|
25
25
|
* @name checkJobStatusByNameV2
|
|
26
26
|
* @summary: Checks download job status
|
|
27
|
-
* @description: Takes job name in path param to check the status of job Returns file URL if downloading is done else returns status of job - Check out [method documentation](https://
|
|
27
|
+
* @description: Takes job name in path param to check the status of job Returns file URL if downloading is done else returns status of job - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/checkJobStatusByNameV2/).
|
|
28
28
|
*/
|
|
29
29
|
async checkJobStatusByNameV2(
|
|
30
30
|
{ fileName, requestHeaders } = { requestHeaders: {} },
|
|
@@ -105,7 +105,7 @@ class Analytics {
|
|
|
105
105
|
* @returns {Promise<AnalyticsPlatformModel.JobExecutionResult>} - Success response
|
|
106
106
|
* @name executeJobForProvidedParametersV2
|
|
107
107
|
* @summary: Executes given sql(Base64 Encoded) query
|
|
108
|
-
* @description: Query click events data - Check out [method documentation](https://
|
|
108
|
+
* @description: Query click events data - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/executeJobForProvidedParametersV2/).
|
|
109
109
|
*/
|
|
110
110
|
async executeJobForProvidedParametersV2(
|
|
111
111
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -186,7 +186,7 @@ class Analytics {
|
|
|
186
186
|
* @returns {Promise<Object>} - Success response
|
|
187
187
|
* @name startDownloadForQueryV2
|
|
188
188
|
* @summary: Initiates download job
|
|
189
|
-
* @description: Initiates download job and returns job name - Check out [method documentation](https://
|
|
189
|
+
* @description: Initiates download job and returns job name - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/startDownloadForQueryV2/).
|
|
190
190
|
*/
|
|
191
191
|
async startDownloadForQueryV2(
|
|
192
192
|
{ exportType, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export = AnalyticsPlatformModel;
|
|
2
2
|
/**
|
|
3
3
|
* @typedef Page
|
|
4
|
-
* @property {number} [item_total] - The total number of items
|
|
4
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
5
5
|
* @property {string} [next_id] - The identifier for the next page.
|
|
6
6
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
7
7
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -45,7 +45,7 @@ declare namespace AnalyticsPlatformModel {
|
|
|
45
45
|
declare function Page(): Page;
|
|
46
46
|
type Page = {
|
|
47
47
|
/**
|
|
48
|
-
* - The total number of items
|
|
48
|
+
* - The total number of all items across all pages.
|
|
49
49
|
*/
|
|
50
50
|
item_total?: number;
|
|
51
51
|
/**
|
|
@@ -2,7 +2,7 @@ const Joi = require("joi");
|
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* @typedef Page
|
|
5
|
-
* @property {number} [item_total] - The total number of items
|
|
5
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
6
6
|
* @property {string} [next_id] - The identifier for the next page.
|
|
7
7
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
8
8
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -9,7 +9,7 @@ declare class AuditTrail {
|
|
|
9
9
|
* @returns {Promise<AuditTrailPlatformModel.CreateLogResp>} - Success response
|
|
10
10
|
* @name createAuditLog
|
|
11
11
|
* @summary: Create an audit log
|
|
12
|
-
* @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://
|
|
12
|
+
* @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/audittrail/createAuditLog/).
|
|
13
13
|
*/
|
|
14
14
|
createAuditLog({ body, requestHeaders }?: AuditTrailPlatformValidator.CreateAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.CreateLogResp>;
|
|
15
15
|
}
|
|
@@ -21,7 +21,7 @@ class AuditTrail {
|
|
|
21
21
|
* @returns {Promise<AuditTrailPlatformModel.CreateLogResp>} - Success response
|
|
22
22
|
* @name createAuditLog
|
|
23
23
|
* @summary: Create an audit log
|
|
24
|
-
* @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://
|
|
24
|
+
* @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/audittrail/createAuditLog/).
|
|
25
25
|
*/
|
|
26
26
|
async createAuditLog(
|
|
27
27
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -9,7 +9,7 @@ declare class Billing {
|
|
|
9
9
|
* @returns {Promise<BillingPlatformModel.SubscriptionChargeRes>} - Success response
|
|
10
10
|
* @name cancelSubscriptionCharge
|
|
11
11
|
* @summary: Cancel the extension subscription
|
|
12
|
-
* @description: Cancel an ongoing extension subscription for the company. - Check out [method documentation](https://
|
|
12
|
+
* @description: Cancel an ongoing extension subscription for the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/cancelSubscriptionCharge/).
|
|
13
13
|
*/
|
|
14
14
|
cancelSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.CancelSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionChargeRes>;
|
|
15
15
|
/**
|
|
@@ -21,7 +21,7 @@ declare class Billing {
|
|
|
21
21
|
*
|
|
22
22
|
* @name createOneTimeCharge
|
|
23
23
|
* @summary: Generate a one-time charge
|
|
24
|
-
* @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://
|
|
24
|
+
* @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/createOneTimeCharge/).
|
|
25
25
|
*/
|
|
26
26
|
createOneTimeCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateOneTimeChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateOneTimeChargeResponseSchemas>;
|
|
27
27
|
/**
|
|
@@ -31,7 +31,7 @@ declare class Billing {
|
|
|
31
31
|
* @returns {Promise<BillingPlatformModel.CreateSubscription>} - Success response
|
|
32
32
|
* @name createSubscriptionCharge
|
|
33
33
|
* @summary: Initiate subscription billing
|
|
34
|
-
* @description: Initiates and registers a subscription charge for a specific extension for a given company. - Check out [method documentation](https://
|
|
34
|
+
* @description: Initiates and registers a subscription charge for a specific extension for a given company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/createSubscriptionCharge/).
|
|
35
35
|
*/
|
|
36
36
|
createSubscriptionCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateSubscription>;
|
|
37
37
|
/**
|
|
@@ -41,7 +41,7 @@ declare class Billing {
|
|
|
41
41
|
* @returns {Promise<BillingPlatformModel.ChargeDetails>} - Success response
|
|
42
42
|
* @name getChargeDetails
|
|
43
43
|
* @summary: Obtain charge details
|
|
44
|
-
* @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://
|
|
44
|
+
* @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/getChargeDetails/).
|
|
45
45
|
*/
|
|
46
46
|
getChargeDetails({ extensionId, chargeId, requestHeaders }?: BillingPlatformValidator.GetChargeDetailsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.ChargeDetails>;
|
|
47
47
|
/**
|
|
@@ -51,7 +51,7 @@ declare class Billing {
|
|
|
51
51
|
* @returns {Promise<BillingPlatformModel.SubscriptionChargeRes>} - Success response
|
|
52
52
|
* @name getSubscriptionCharge
|
|
53
53
|
* @summary: Retrieve subscription charge details
|
|
54
|
-
* @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://
|
|
54
|
+
* @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/getSubscriptionCharge/).
|
|
55
55
|
*/
|
|
56
56
|
getSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.GetSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionChargeRes>;
|
|
57
57
|
}
|
|
@@ -21,7 +21,7 @@ class Billing {
|
|
|
21
21
|
* @returns {Promise<BillingPlatformModel.SubscriptionChargeRes>} - Success response
|
|
22
22
|
* @name cancelSubscriptionCharge
|
|
23
23
|
* @summary: Cancel the extension subscription
|
|
24
|
-
* @description: Cancel an ongoing extension subscription for the company. - Check out [method documentation](https://
|
|
24
|
+
* @description: Cancel an ongoing extension subscription for the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/cancelSubscriptionCharge/).
|
|
25
25
|
*/
|
|
26
26
|
async cancelSubscriptionCharge(
|
|
27
27
|
{ extensionId, subscriptionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -106,7 +106,7 @@ class Billing {
|
|
|
106
106
|
*
|
|
107
107
|
* @name createOneTimeCharge
|
|
108
108
|
* @summary: Generate a one-time charge
|
|
109
|
-
* @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://
|
|
109
|
+
* @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/createOneTimeCharge/).
|
|
110
110
|
*/
|
|
111
111
|
async createOneTimeCharge(
|
|
112
112
|
{ extensionId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -187,7 +187,7 @@ class Billing {
|
|
|
187
187
|
* @returns {Promise<BillingPlatformModel.CreateSubscription>} - Success response
|
|
188
188
|
* @name createSubscriptionCharge
|
|
189
189
|
* @summary: Initiate subscription billing
|
|
190
|
-
* @description: Initiates and registers a subscription charge for a specific extension for a given company. - Check out [method documentation](https://
|
|
190
|
+
* @description: Initiates and registers a subscription charge for a specific extension for a given company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/createSubscriptionCharge/).
|
|
191
191
|
*/
|
|
192
192
|
async createSubscriptionCharge(
|
|
193
193
|
{ extensionId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -270,7 +270,7 @@ class Billing {
|
|
|
270
270
|
* @returns {Promise<BillingPlatformModel.ChargeDetails>} - Success response
|
|
271
271
|
* @name getChargeDetails
|
|
272
272
|
* @summary: Obtain charge details
|
|
273
|
-
* @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://
|
|
273
|
+
* @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/getChargeDetails/).
|
|
274
274
|
*/
|
|
275
275
|
async getChargeDetails(
|
|
276
276
|
{ extensionId, chargeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -351,7 +351,7 @@ class Billing {
|
|
|
351
351
|
* @returns {Promise<BillingPlatformModel.SubscriptionChargeRes>} - Success response
|
|
352
352
|
* @name getSubscriptionCharge
|
|
353
353
|
* @summary: Retrieve subscription charge details
|
|
354
|
-
* @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://
|
|
354
|
+
* @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/getSubscriptionCharge/).
|
|
355
355
|
*/
|
|
356
356
|
async getSubscriptionCharge(
|
|
357
357
|
{ extensionId, subscriptionId, requestHeaders } = { requestHeaders: {} },
|