@gofynd/fdk-client-javascript 1.2.0 → 1.3.1-beta.1
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 +6 -4
- package/sdk/application/Cart/CartApplicationModel.js +6 -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 +90 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +113 -3
- 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
|
@@ -13,6 +13,7 @@ class Inventory {
|
|
|
13
13
|
|
|
14
14
|
/**
|
|
15
15
|
* @param {InventoryPlatformValidator.CreateJobParam} arg - Arg object
|
|
16
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
16
17
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
17
18
|
* @returns {Promise<InventoryPlatformModel.ResponseEnvelopeString>} -
|
|
18
19
|
* Success response
|
|
@@ -20,7 +21,10 @@ class Inventory {
|
|
|
20
21
|
* @summary: Creates A New Job Config
|
|
21
22
|
* @description: REST Endpoint that creates a new job config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/createJob/).
|
|
22
23
|
*/
|
|
23
|
-
async createJob(
|
|
24
|
+
async createJob(
|
|
25
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
26
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
27
|
+
) {
|
|
24
28
|
const { error } = InventoryPlatformValidator.createJob().validate(
|
|
25
29
|
{
|
|
26
30
|
body,
|
|
@@ -55,12 +59,12 @@ class Inventory {
|
|
|
55
59
|
`/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs`,
|
|
56
60
|
query_params,
|
|
57
61
|
body,
|
|
58
|
-
xHeaders,
|
|
59
|
-
{
|
|
62
|
+
{ ...xHeaders, ...requestHeaders },
|
|
63
|
+
{ responseHeaders }
|
|
60
64
|
);
|
|
61
65
|
|
|
62
66
|
let responseData = response;
|
|
63
|
-
if (
|
|
67
|
+
if (responseHeaders) {
|
|
64
68
|
responseData = response[0];
|
|
65
69
|
}
|
|
66
70
|
|
|
@@ -83,6 +87,7 @@ class Inventory {
|
|
|
83
87
|
|
|
84
88
|
/**
|
|
85
89
|
* @param {InventoryPlatformValidator.DisableParam} arg - Arg object
|
|
90
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
86
91
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
87
92
|
* @returns {Promise<InventoryPlatformModel.ResponseEnvelopeString>} -
|
|
88
93
|
* Success response
|
|
@@ -90,7 +95,10 @@ class Inventory {
|
|
|
90
95
|
* @summary: Disable Job Config
|
|
91
96
|
* @description: REST Endpoint that disables Inventory Job Config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/disable/).
|
|
92
97
|
*/
|
|
93
|
-
async disable(
|
|
98
|
+
async disable(
|
|
99
|
+
{ integrationId, requestHeaders } = { requestHeaders: {} },
|
|
100
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
101
|
+
) {
|
|
94
102
|
const { error } = InventoryPlatformValidator.disable().validate(
|
|
95
103
|
{
|
|
96
104
|
integrationId,
|
|
@@ -125,12 +133,12 @@ class Inventory {
|
|
|
125
133
|
`/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/disable/integration/${integrationId}`,
|
|
126
134
|
query_params,
|
|
127
135
|
undefined,
|
|
128
|
-
xHeaders,
|
|
129
|
-
{
|
|
136
|
+
{ ...xHeaders, ...requestHeaders },
|
|
137
|
+
{ responseHeaders }
|
|
130
138
|
);
|
|
131
139
|
|
|
132
140
|
let responseData = response;
|
|
133
|
-
if (
|
|
141
|
+
if (responseHeaders) {
|
|
134
142
|
responseData = response[0];
|
|
135
143
|
}
|
|
136
144
|
|
|
@@ -153,6 +161,7 @@ class Inventory {
|
|
|
153
161
|
|
|
154
162
|
/**
|
|
155
163
|
* @param {InventoryPlatformValidator.GetConfigByCompanyParam} arg - Arg object
|
|
164
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
156
165
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
157
166
|
* @returns {Promise<InventoryPlatformModel.ResponseEnvelopeListSlingshotConfigurationDetail>}
|
|
158
167
|
* - Success response
|
|
@@ -161,7 +170,10 @@ class Inventory {
|
|
|
161
170
|
* @summary: Get Slingshot Configuration Of A Company
|
|
162
171
|
* @description: REST Endpoint that returns all configuration detail of a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getConfigByCompany/).
|
|
163
172
|
*/
|
|
164
|
-
async getConfigByCompany(
|
|
173
|
+
async getConfigByCompany(
|
|
174
|
+
{ requestHeaders } = { requestHeaders: {} },
|
|
175
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
176
|
+
) {
|
|
165
177
|
const { error } = InventoryPlatformValidator.getConfigByCompany().validate(
|
|
166
178
|
{},
|
|
167
179
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -194,12 +206,12 @@ class Inventory {
|
|
|
194
206
|
`/service/platform/inventory/v1.0/company/${this.config.companyId}/slingshot`,
|
|
195
207
|
query_params,
|
|
196
208
|
undefined,
|
|
197
|
-
xHeaders,
|
|
198
|
-
{
|
|
209
|
+
{ ...xHeaders, ...requestHeaders },
|
|
210
|
+
{ responseHeaders }
|
|
199
211
|
);
|
|
200
212
|
|
|
201
213
|
let responseData = response;
|
|
202
|
-
if (
|
|
214
|
+
if (responseHeaders) {
|
|
203
215
|
responseData = response[0];
|
|
204
216
|
}
|
|
205
217
|
|
|
@@ -222,6 +234,7 @@ class Inventory {
|
|
|
222
234
|
|
|
223
235
|
/**
|
|
224
236
|
* @param {InventoryPlatformValidator.GetJobByCodeParam} arg - Arg object
|
|
237
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
225
238
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
226
239
|
* @returns {Promise<InventoryPlatformModel.ResponseEnvelopeJobConfigDTO>}
|
|
227
240
|
* - Success response
|
|
@@ -230,7 +243,10 @@ class Inventory {
|
|
|
230
243
|
* @summary: Get Job Config By Code
|
|
231
244
|
* @description: REST Endpoint that returns job config by code - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobByCode/).
|
|
232
245
|
*/
|
|
233
|
-
async getJobByCode(
|
|
246
|
+
async getJobByCode(
|
|
247
|
+
{ code, requestHeaders } = { requestHeaders: {} },
|
|
248
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
249
|
+
) {
|
|
234
250
|
const { error } = InventoryPlatformValidator.getJobByCode().validate(
|
|
235
251
|
{
|
|
236
252
|
code,
|
|
@@ -267,12 +283,12 @@ class Inventory {
|
|
|
267
283
|
`/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/code/${code}`,
|
|
268
284
|
query_params,
|
|
269
285
|
undefined,
|
|
270
|
-
xHeaders,
|
|
271
|
-
{
|
|
286
|
+
{ ...xHeaders, ...requestHeaders },
|
|
287
|
+
{ responseHeaders }
|
|
272
288
|
);
|
|
273
289
|
|
|
274
290
|
let responseData = response;
|
|
275
|
-
if (
|
|
291
|
+
if (responseHeaders) {
|
|
276
292
|
responseData = response[0];
|
|
277
293
|
}
|
|
278
294
|
|
|
@@ -297,6 +313,7 @@ class Inventory {
|
|
|
297
313
|
* @param {InventoryPlatformValidator.GetJobByCompanyAndIntegrationParam} arg
|
|
298
314
|
* - Arg object
|
|
299
315
|
*
|
|
316
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
300
317
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
301
318
|
* @returns {Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigDTO>}
|
|
302
319
|
* - Success response
|
|
@@ -306,8 +323,10 @@ class Inventory {
|
|
|
306
323
|
* @description: REST Endpoint that returns all job configs by company And integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobByCompanyAndIntegration/).
|
|
307
324
|
*/
|
|
308
325
|
async getJobByCompanyAndIntegration(
|
|
309
|
-
{ integrationId, pageNo, pageSize } = {
|
|
310
|
-
|
|
326
|
+
{ integrationId, pageNo, pageSize, requestHeaders } = {
|
|
327
|
+
requestHeaders: {},
|
|
328
|
+
},
|
|
329
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
311
330
|
) {
|
|
312
331
|
const {
|
|
313
332
|
error,
|
|
@@ -353,12 +372,12 @@ class Inventory {
|
|
|
353
372
|
`/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/integration/${integrationId}`,
|
|
354
373
|
query_params,
|
|
355
374
|
undefined,
|
|
356
|
-
xHeaders,
|
|
357
|
-
{
|
|
375
|
+
{ ...xHeaders, ...requestHeaders },
|
|
376
|
+
{ responseHeaders }
|
|
358
377
|
);
|
|
359
378
|
|
|
360
379
|
let responseData = response;
|
|
361
|
-
if (
|
|
380
|
+
if (responseHeaders) {
|
|
362
381
|
responseData = response[0];
|
|
363
382
|
}
|
|
364
383
|
|
|
@@ -381,6 +400,7 @@ class Inventory {
|
|
|
381
400
|
|
|
382
401
|
/**
|
|
383
402
|
* @param {InventoryPlatformValidator.GetJobCodeMetricsParam} arg - Arg object
|
|
403
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
384
404
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
385
405
|
* @returns {Promise<InventoryPlatformModel.ResponseEnvelopeJobMetricsDto>}
|
|
386
406
|
* - Success response
|
|
@@ -390,8 +410,10 @@ class Inventory {
|
|
|
390
410
|
* @description: REST Endpoint that returns Inventory Run History For A Job Code - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobCodeMetrics/).
|
|
391
411
|
*/
|
|
392
412
|
async getJobCodeMetrics(
|
|
393
|
-
{ code, pageNo, pageSize, status, date } = {
|
|
394
|
-
|
|
413
|
+
{ code, pageNo, pageSize, status, date, requestHeaders } = {
|
|
414
|
+
requestHeaders: {},
|
|
415
|
+
},
|
|
416
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
395
417
|
) {
|
|
396
418
|
const { error } = InventoryPlatformValidator.getJobCodeMetrics().validate(
|
|
397
419
|
{
|
|
@@ -441,12 +463,12 @@ class Inventory {
|
|
|
441
463
|
`/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/code/${code}/metrics`,
|
|
442
464
|
query_params,
|
|
443
465
|
undefined,
|
|
444
|
-
xHeaders,
|
|
445
|
-
{
|
|
466
|
+
{ ...xHeaders, ...requestHeaders },
|
|
467
|
+
{ responseHeaders }
|
|
446
468
|
);
|
|
447
469
|
|
|
448
470
|
let responseData = response;
|
|
449
|
-
if (
|
|
471
|
+
if (responseHeaders) {
|
|
450
472
|
responseData = response[0];
|
|
451
473
|
}
|
|
452
474
|
|
|
@@ -471,6 +493,7 @@ class Inventory {
|
|
|
471
493
|
* @param {InventoryPlatformValidator.GetJobCodesByCompanyAndIntegrationParam} arg
|
|
472
494
|
* - Arg object
|
|
473
495
|
*
|
|
496
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
474
497
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
475
498
|
* @returns {Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigListDTO>}
|
|
476
499
|
* - Success response
|
|
@@ -480,8 +503,10 @@ class Inventory {
|
|
|
480
503
|
* @description: REST Endpoint that returns all job codes by company And integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobCodesByCompanyAndIntegration/).
|
|
481
504
|
*/
|
|
482
505
|
async getJobCodesByCompanyAndIntegration(
|
|
483
|
-
{ integrationId, pageNo, pageSize } = {
|
|
484
|
-
|
|
506
|
+
{ integrationId, pageNo, pageSize, requestHeaders } = {
|
|
507
|
+
requestHeaders: {},
|
|
508
|
+
},
|
|
509
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
485
510
|
) {
|
|
486
511
|
const {
|
|
487
512
|
error,
|
|
@@ -527,12 +552,12 @@ class Inventory {
|
|
|
527
552
|
`/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/code/integration/${integrationId}`,
|
|
528
553
|
query_params,
|
|
529
554
|
undefined,
|
|
530
|
-
xHeaders,
|
|
531
|
-
{
|
|
555
|
+
{ ...xHeaders, ...requestHeaders },
|
|
556
|
+
{ responseHeaders }
|
|
532
557
|
);
|
|
533
558
|
|
|
534
559
|
let responseData = response;
|
|
535
|
-
if (
|
|
560
|
+
if (responseHeaders) {
|
|
536
561
|
responseData = response[0];
|
|
537
562
|
}
|
|
538
563
|
|
|
@@ -555,6 +580,7 @@ class Inventory {
|
|
|
555
580
|
|
|
556
581
|
/**
|
|
557
582
|
* @param {InventoryPlatformValidator.GetJobConfigDefaultsParam} arg - Arg object
|
|
583
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
558
584
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
559
585
|
* @returns {Promise<InventoryPlatformModel.ResponseEnvelopeJobConfigDTO>}
|
|
560
586
|
* - Success response
|
|
@@ -563,7 +589,10 @@ class Inventory {
|
|
|
563
589
|
* @summary: Get Job Configs Defaults
|
|
564
590
|
* @description: REST Endpoint that returns default fields job configs by company And integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobConfigDefaults/).
|
|
565
591
|
*/
|
|
566
|
-
async getJobConfigDefaults(
|
|
592
|
+
async getJobConfigDefaults(
|
|
593
|
+
{ requestHeaders } = { requestHeaders: {} },
|
|
594
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
595
|
+
) {
|
|
567
596
|
const {
|
|
568
597
|
error,
|
|
569
598
|
} = InventoryPlatformValidator.getJobConfigDefaults().validate(
|
|
@@ -598,12 +627,12 @@ class Inventory {
|
|
|
598
627
|
`/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/defaults`,
|
|
599
628
|
query_params,
|
|
600
629
|
undefined,
|
|
601
|
-
xHeaders,
|
|
602
|
-
{
|
|
630
|
+
{ ...xHeaders, ...requestHeaders },
|
|
631
|
+
{ responseHeaders }
|
|
603
632
|
);
|
|
604
633
|
|
|
605
634
|
let responseData = response;
|
|
606
|
-
if (
|
|
635
|
+
if (responseHeaders) {
|
|
607
636
|
responseData = response[0];
|
|
608
637
|
}
|
|
609
638
|
|
|
@@ -626,6 +655,7 @@ class Inventory {
|
|
|
626
655
|
|
|
627
656
|
/**
|
|
628
657
|
* @param {InventoryPlatformValidator.GetJobStepsParam} arg - Arg object
|
|
658
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
629
659
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
630
660
|
* @returns {Promise<InventoryPlatformModel.ResponseEnvelopeListJobStepsDTO>}
|
|
631
661
|
* - Success response
|
|
@@ -634,7 +664,10 @@ class Inventory {
|
|
|
634
664
|
* @summary: Get Job Code Steps
|
|
635
665
|
* @description: REST Endpoint that returns Inventory Job Steps - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobSteps/).
|
|
636
666
|
*/
|
|
637
|
-
async getJobSteps(
|
|
667
|
+
async getJobSteps(
|
|
668
|
+
{ jobId, requestHeaders } = { requestHeaders: {} },
|
|
669
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
670
|
+
) {
|
|
638
671
|
const { error } = InventoryPlatformValidator.getJobSteps().validate(
|
|
639
672
|
{
|
|
640
673
|
jobId,
|
|
@@ -671,12 +704,12 @@ class Inventory {
|
|
|
671
704
|
`/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/steps/${jobId}`,
|
|
672
705
|
query_params,
|
|
673
706
|
undefined,
|
|
674
|
-
xHeaders,
|
|
675
|
-
{
|
|
707
|
+
{ ...xHeaders, ...requestHeaders },
|
|
708
|
+
{ responseHeaders }
|
|
676
709
|
);
|
|
677
710
|
|
|
678
711
|
let responseData = response;
|
|
679
|
-
if (
|
|
712
|
+
if (responseHeaders) {
|
|
680
713
|
responseData = response[0];
|
|
681
714
|
}
|
|
682
715
|
|
|
@@ -699,6 +732,7 @@ class Inventory {
|
|
|
699
732
|
|
|
700
733
|
/**
|
|
701
734
|
* @param {InventoryPlatformValidator.GetJobsByCompanyParam} arg - Arg object
|
|
735
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
702
736
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
703
737
|
* @returns {Promise<InventoryPlatformModel.ResponseEnvelopeListJobConfigRawDTO>}
|
|
704
738
|
* - Success response
|
|
@@ -708,8 +742,8 @@ class Inventory {
|
|
|
708
742
|
* @description: REST Endpoint that returns all job configs for a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/getJobsByCompany/).
|
|
709
743
|
*/
|
|
710
744
|
async getJobsByCompany(
|
|
711
|
-
{ pageNo, pageSize } = {},
|
|
712
|
-
{
|
|
745
|
+
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
746
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
713
747
|
) {
|
|
714
748
|
const { error } = InventoryPlatformValidator.getJobsByCompany().validate(
|
|
715
749
|
{
|
|
@@ -751,12 +785,12 @@ class Inventory {
|
|
|
751
785
|
`/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs`,
|
|
752
786
|
query_params,
|
|
753
787
|
undefined,
|
|
754
|
-
xHeaders,
|
|
755
|
-
{
|
|
788
|
+
{ ...xHeaders, ...requestHeaders },
|
|
789
|
+
{ responseHeaders }
|
|
756
790
|
);
|
|
757
791
|
|
|
758
792
|
let responseData = response;
|
|
759
|
-
if (
|
|
793
|
+
if (responseHeaders) {
|
|
760
794
|
responseData = response[0];
|
|
761
795
|
}
|
|
762
796
|
|
|
@@ -779,6 +813,7 @@ class Inventory {
|
|
|
779
813
|
|
|
780
814
|
/**
|
|
781
815
|
* @param {InventoryPlatformValidator.SuppressStoresParam} arg - Arg object
|
|
816
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
782
817
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
783
818
|
* @returns {Promise<InventoryPlatformModel.ResponseEnvelopeKafkaResponse>}
|
|
784
819
|
* - Success response
|
|
@@ -787,7 +822,10 @@ class Inventory {
|
|
|
787
822
|
* @summary: Get Slingshot Configuration Of A Company
|
|
788
823
|
* @description: REST Endpoint that returns all configuration detail of a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/suppressStores/).
|
|
789
824
|
*/
|
|
790
|
-
async suppressStores(
|
|
825
|
+
async suppressStores(
|
|
826
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
827
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
828
|
+
) {
|
|
791
829
|
const { error } = InventoryPlatformValidator.suppressStores().validate(
|
|
792
830
|
{
|
|
793
831
|
body,
|
|
@@ -824,12 +862,12 @@ class Inventory {
|
|
|
824
862
|
`/service/platform/inventory/v1.0/company/${this.config.companyId}/kafka/suppressStore`,
|
|
825
863
|
query_params,
|
|
826
864
|
body,
|
|
827
|
-
xHeaders,
|
|
828
|
-
{
|
|
865
|
+
{ ...xHeaders, ...requestHeaders },
|
|
866
|
+
{ responseHeaders }
|
|
829
867
|
);
|
|
830
868
|
|
|
831
869
|
let responseData = response;
|
|
832
|
-
if (
|
|
870
|
+
if (responseHeaders) {
|
|
833
871
|
responseData = response[0];
|
|
834
872
|
}
|
|
835
873
|
|
|
@@ -852,6 +890,7 @@ class Inventory {
|
|
|
852
890
|
|
|
853
891
|
/**
|
|
854
892
|
* @param {InventoryPlatformValidator.UpdateJobParam} arg - Arg object
|
|
893
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
855
894
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
856
895
|
* @returns {Promise<InventoryPlatformModel.ResponseEnvelopeString>} -
|
|
857
896
|
* Success response
|
|
@@ -859,7 +898,10 @@ class Inventory {
|
|
|
859
898
|
* @summary: Updates An Existing Job Config
|
|
860
899
|
* @description: REST Endpoint that updates a job config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/inventory/updateJob/).
|
|
861
900
|
*/
|
|
862
|
-
async updateJob(
|
|
901
|
+
async updateJob(
|
|
902
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
903
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
904
|
+
) {
|
|
863
905
|
const { error } = InventoryPlatformValidator.updateJob().validate(
|
|
864
906
|
{
|
|
865
907
|
body,
|
|
@@ -894,12 +936,12 @@ class Inventory {
|
|
|
894
936
|
`/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs`,
|
|
895
937
|
query_params,
|
|
896
938
|
body,
|
|
897
|
-
xHeaders,
|
|
898
|
-
{
|
|
939
|
+
{ ...xHeaders, ...requestHeaders },
|
|
940
|
+
{ responseHeaders }
|
|
899
941
|
);
|
|
900
942
|
|
|
901
943
|
let responseData = response;
|
|
902
|
-
if (
|
|
944
|
+
if (responseHeaders) {
|
|
903
945
|
responseData = response[0];
|
|
904
946
|
}
|
|
905
947
|
|
|
@@ -5,97 +5,109 @@ declare class Lead {
|
|
|
5
5
|
applicationId: any;
|
|
6
6
|
/**
|
|
7
7
|
* @param {LeadPlatformApplicationValidator.CloseVideoRoomParam} arg - Arg object
|
|
8
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
10
|
* @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
|
|
10
11
|
* @name closeVideoRoom
|
|
11
12
|
* @summary: Close the video room and force all participants to leave.
|
|
12
13
|
* @description: Close the video room and force all participants to leave. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/closeVideoRoom/).
|
|
13
14
|
*/
|
|
14
|
-
closeVideoRoom({ uniqueName }?: LeadPlatformApplicationValidator.CloseVideoRoomParam, {
|
|
15
|
+
closeVideoRoom({ uniqueName, requestHeaders }?: LeadPlatformApplicationValidator.CloseVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CloseVideoRoomResponse>;
|
|
15
16
|
/**
|
|
16
17
|
* @param {LeadPlatformApplicationValidator.CreateCustomFormParam} arg - Arg object
|
|
18
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
17
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
18
20
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
19
21
|
* @name createCustomForm
|
|
20
22
|
* @summary: Creates a new custom form
|
|
21
23
|
* @description: Creates a new custom form for given application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createCustomForm/).
|
|
22
24
|
*/
|
|
23
|
-
createCustomForm({ body }?: LeadPlatformApplicationValidator.CreateCustomFormParam, {
|
|
25
|
+
createCustomForm({ body, requestHeaders }?: LeadPlatformApplicationValidator.CreateCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
|
|
24
26
|
/**
|
|
25
27
|
* @param {LeadPlatformApplicationValidator.CreateHistoryParam} arg - Arg object
|
|
28
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
26
29
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
27
30
|
* @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
|
|
28
31
|
* @name createHistory
|
|
29
32
|
* @summary: Create history for specific application level ticket
|
|
30
33
|
* @description: Create history for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createHistory/).
|
|
31
34
|
*/
|
|
32
|
-
createHistory({ id, body }?: LeadPlatformApplicationValidator.CreateHistoryParam, {
|
|
35
|
+
createHistory({ id, body, requestHeaders }?: LeadPlatformApplicationValidator.CreateHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistory>;
|
|
33
36
|
/**
|
|
34
37
|
* @param {LeadPlatformApplicationValidator.EditCustomFormParam} arg - Arg object
|
|
38
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
35
39
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
36
40
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
37
41
|
* @name editCustomForm
|
|
38
42
|
* @summary: Edit the given custom form
|
|
39
43
|
* @description: Edit the given custom form field such as adding or deleting input, assignee, title, decription, notification and polling information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editCustomForm/).
|
|
40
44
|
*/
|
|
41
|
-
editCustomForm({ slug, body }?: LeadPlatformApplicationValidator.EditCustomFormParam, {
|
|
45
|
+
editCustomForm({ slug, body, requestHeaders }?: LeadPlatformApplicationValidator.EditCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
|
|
42
46
|
/**
|
|
43
47
|
* @param {LeadPlatformApplicationValidator.EditTicketParam} arg - Arg object
|
|
48
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
44
49
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
45
50
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
46
51
|
* @name editTicket
|
|
47
52
|
* @summary: Edits ticket details of a application level ticket
|
|
48
53
|
* @description: Edits ticket details of a application level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editTicket/).
|
|
49
54
|
*/
|
|
50
|
-
editTicket({ id, body }?: LeadPlatformApplicationValidator.EditTicketParam, {
|
|
55
|
+
editTicket({ id, body, requestHeaders }?: LeadPlatformApplicationValidator.EditTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
51
56
|
/**
|
|
52
57
|
* @param {LeadPlatformApplicationValidator.GetCustomFormParam} arg - Arg object
|
|
58
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
53
59
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
54
60
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
55
61
|
* @name getCustomForm
|
|
56
62
|
* @summary: Get specific custom form using it's slug
|
|
57
63
|
* @description: Get specific custom form using it's slug, this is used to view the form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForm/).
|
|
58
64
|
*/
|
|
59
|
-
getCustomForm({ slug }?: LeadPlatformApplicationValidator.GetCustomFormParam, {
|
|
65
|
+
getCustomForm({ slug, requestHeaders }?: LeadPlatformApplicationValidator.GetCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
|
|
60
66
|
/**
|
|
67
|
+
* @param {LeadPlatformApplicationValidator.GetCustomFormsParam} arg - Arg object
|
|
68
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
61
69
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
62
70
|
* @returns {Promise<LeadPlatformModel.CustomFormList>} - Success response
|
|
63
71
|
* @name getCustomForms
|
|
64
72
|
* @summary: Get list of custom form
|
|
65
73
|
* @description: Get list of custom form for given application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForms/).
|
|
66
74
|
*/
|
|
67
|
-
getCustomForms({
|
|
75
|
+
getCustomForms({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomFormList>;
|
|
68
76
|
/**
|
|
69
77
|
* @param {LeadPlatformApplicationValidator.GetTicketParam} arg - Arg object
|
|
78
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
70
79
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
71
80
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
72
81
|
* @name getTicket
|
|
73
82
|
* @summary: Retreives ticket details of a application level ticket
|
|
74
83
|
* @description: Retreives ticket details of a application level ticket with ticket ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTicket/).
|
|
75
84
|
*/
|
|
76
|
-
getTicket({ id }?: LeadPlatformApplicationValidator.GetTicketParam, {
|
|
85
|
+
getTicket({ id, requestHeaders }?: LeadPlatformApplicationValidator.GetTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
77
86
|
/**
|
|
78
87
|
* @param {LeadPlatformApplicationValidator.GetTicketHistoryParam} arg - Arg object
|
|
88
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
79
89
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
80
90
|
* @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
|
|
81
91
|
* @name getTicketHistory
|
|
82
92
|
* @summary: Gets history list for specific application level ticket
|
|
83
93
|
* @description: Gets history list for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTicketHistory/).
|
|
84
94
|
*/
|
|
85
|
-
getTicketHistory({ id }?: LeadPlatformApplicationValidator.GetTicketHistoryParam, {
|
|
95
|
+
getTicketHistory({ id, requestHeaders }?: LeadPlatformApplicationValidator.GetTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistoryList>;
|
|
86
96
|
/**
|
|
87
97
|
* @param {LeadPlatformApplicationValidator.GetTicketsParam} arg - Arg object
|
|
98
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
88
99
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
89
100
|
* @returns {Promise<LeadPlatformModel.TicketList>} - Success response
|
|
90
101
|
* @name getTickets
|
|
91
102
|
* @summary: Gets the list of Application level Tickets and/or ticket filters depending on query params
|
|
92
103
|
* @description: Gets the list of Application level Tickets and/or ticket filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTickets/).
|
|
93
104
|
*/
|
|
94
|
-
getTickets({ items, filters, q, status, priority, category }?: LeadPlatformApplicationValidator.GetTicketsParam, {
|
|
105
|
+
getTickets({ items, filters, q, status, priority, category, requestHeaders }?: LeadPlatformApplicationValidator.GetTicketsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketList>;
|
|
95
106
|
/**
|
|
96
107
|
* @param {LeadPlatformApplicationValidator.GetTokenForVideoRoomParam} arg
|
|
97
108
|
* - Arg object
|
|
98
109
|
*
|
|
110
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
99
111
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
112
|
* @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
|
|
101
113
|
* Success response
|
|
@@ -103,11 +115,12 @@ declare class Lead {
|
|
|
103
115
|
* @summary: Get Token to join a specific Video Room using it's unqiue name
|
|
104
116
|
* @description: Get Token to join a specific Video Room using it's unqiue name, this Token is your ticket to Room and also creates your identity there. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTokenForVideoRoom/).
|
|
105
117
|
*/
|
|
106
|
-
getTokenForVideoRoom({ uniqueName }?: LeadPlatformApplicationValidator.GetTokenForVideoRoomParam, {
|
|
118
|
+
getTokenForVideoRoom({ uniqueName, requestHeaders }?: LeadPlatformApplicationValidator.GetTokenForVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>;
|
|
107
119
|
/**
|
|
108
120
|
* @param {LeadPlatformApplicationValidator.GetVideoParticipantsParam} arg
|
|
109
121
|
* - Arg object
|
|
110
122
|
*
|
|
123
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
111
124
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
112
125
|
* @returns {Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>}
|
|
113
126
|
* - Success response
|
|
@@ -116,16 +129,17 @@ declare class Lead {
|
|
|
116
129
|
* @summary: Get participants of a specific Video Room using it's unique name
|
|
117
130
|
* @description: Get participants of a specific Video Room using it's unique name, this can be used to check if people are already there in the room and also to show their names. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getVideoParticipants/).
|
|
118
131
|
*/
|
|
119
|
-
getVideoParticipants({ uniqueName }?: LeadPlatformApplicationValidator.GetVideoParticipantsParam, {
|
|
132
|
+
getVideoParticipants({ uniqueName, requestHeaders }?: LeadPlatformApplicationValidator.GetVideoParticipantsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>;
|
|
120
133
|
/**
|
|
121
134
|
* @param {LeadPlatformApplicationValidator.OpenVideoRoomParam} arg - Arg object
|
|
135
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
122
136
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
123
137
|
* @returns {Promise<LeadPlatformModel.CreateVideoRoomResponse>} - Success response
|
|
124
138
|
* @name openVideoRoom
|
|
125
139
|
* @summary: Open a video room.
|
|
126
140
|
* @description: Open a video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/openVideoRoom/).
|
|
127
141
|
*/
|
|
128
|
-
openVideoRoom({ body }?: LeadPlatformApplicationValidator.OpenVideoRoomParam, {
|
|
142
|
+
openVideoRoom({ body, requestHeaders }?: LeadPlatformApplicationValidator.OpenVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CreateVideoRoomResponse>;
|
|
129
143
|
}
|
|
130
144
|
import LeadPlatformApplicationValidator = require("./LeadPlatformApplicationValidator");
|
|
131
145
|
import LeadPlatformModel = require("./LeadPlatformModel");
|