@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
|
@@ -11,6 +11,7 @@ declare class FileStorage {
|
|
|
11
11
|
updateUrls(urls: any): void;
|
|
12
12
|
/**
|
|
13
13
|
* @param {FileStorageApplicationValidator.CompleteUploadParam} arg - Arg object.
|
|
14
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
14
15
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
15
16
|
* @returns {Promise<FileStorageApplicationModel.CompleteResponse>} - Success response
|
|
16
17
|
* @name completeUpload
|
|
@@ -35,18 +36,20 @@ declare class FileStorage {
|
|
|
35
36
|
* This operation will return the URL of the uploaded file.
|
|
36
37
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
|
|
37
38
|
*/
|
|
38
|
-
completeUpload({ namespace, body }?: FileStorageApplicationValidator.CompleteUploadParam, {
|
|
39
|
+
completeUpload({ namespace, body, requestHeaders }?: FileStorageApplicationValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStorageApplicationModel.CompleteResponse>;
|
|
39
40
|
/**
|
|
40
41
|
* @param {FileStorageApplicationValidator.SignUrlsParam} arg - Arg object.
|
|
42
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
41
43
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
42
44
|
* @returns {Promise<FileStorageApplicationModel.SignUrlResponse>} - Success response
|
|
43
45
|
* @name signUrls
|
|
44
46
|
* @summary: Explain here
|
|
45
47
|
* @description: Describe here - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/signUrls/).
|
|
46
48
|
*/
|
|
47
|
-
signUrls({ body }?: FileStorageApplicationValidator.SignUrlsParam, {
|
|
49
|
+
signUrls({ body, requestHeaders }?: FileStorageApplicationValidator.SignUrlsParam, { responseHeaders }?: object): Promise<FileStorageApplicationModel.SignUrlResponse>;
|
|
48
50
|
/**
|
|
49
51
|
* @param {FileStorageApplicationValidator.StartUploadParam} arg - Arg object.
|
|
52
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
50
53
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
51
54
|
* @returns {Promise<FileStorageApplicationModel.StartResponse>} - Success response
|
|
52
55
|
* @name startUpload
|
|
@@ -71,7 +74,7 @@ declare class FileStorage {
|
|
|
71
74
|
* This operation will return the URL of the uploaded file.
|
|
72
75
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
|
|
73
76
|
*/
|
|
74
|
-
startUpload({ namespace, body }?: FileStorageApplicationValidator.StartUploadParam, {
|
|
77
|
+
startUpload({ namespace, body, requestHeaders }?: FileStorageApplicationValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStorageApplicationModel.StartResponse>;
|
|
75
78
|
/**
|
|
76
79
|
* @param data
|
|
77
80
|
* @param {string} file_name
|
|
@@ -36,6 +36,7 @@ class FileStorage {
|
|
|
36
36
|
|
|
37
37
|
/**
|
|
38
38
|
* @param {FileStorageApplicationValidator.CompleteUploadParam} arg - Arg object.
|
|
39
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
39
40
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
40
41
|
* @returns {Promise<FileStorageApplicationModel.CompleteResponse>} - Success response
|
|
41
42
|
* @name completeUpload
|
|
@@ -61,8 +62,8 @@ class FileStorage {
|
|
|
61
62
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
|
|
62
63
|
*/
|
|
63
64
|
async completeUpload(
|
|
64
|
-
{ namespace, body } = {},
|
|
65
|
-
{
|
|
65
|
+
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
66
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
66
67
|
) {
|
|
67
68
|
const { error } = FileStorageApplicationValidator.completeUpload().validate(
|
|
68
69
|
{ namespace, body },
|
|
@@ -99,12 +100,12 @@ class FileStorage {
|
|
|
99
100
|
}),
|
|
100
101
|
query_params,
|
|
101
102
|
body,
|
|
102
|
-
xHeaders,
|
|
103
|
-
{
|
|
103
|
+
{ ...xHeaders, ...requestHeaders },
|
|
104
|
+
{ responseHeaders }
|
|
104
105
|
);
|
|
105
106
|
|
|
106
107
|
let responseData = response;
|
|
107
|
-
if (
|
|
108
|
+
if (responseHeaders) {
|
|
108
109
|
responseData = response[0];
|
|
109
110
|
}
|
|
110
111
|
|
|
@@ -127,13 +128,17 @@ class FileStorage {
|
|
|
127
128
|
|
|
128
129
|
/**
|
|
129
130
|
* @param {FileStorageApplicationValidator.SignUrlsParam} arg - Arg object.
|
|
131
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
130
132
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
131
133
|
* @returns {Promise<FileStorageApplicationModel.SignUrlResponse>} - Success response
|
|
132
134
|
* @name signUrls
|
|
133
135
|
* @summary: Explain here
|
|
134
136
|
* @description: Describe here - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/signUrls/).
|
|
135
137
|
*/
|
|
136
|
-
async signUrls(
|
|
138
|
+
async signUrls(
|
|
139
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
140
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
141
|
+
) {
|
|
137
142
|
const { error } = FileStorageApplicationValidator.signUrls().validate(
|
|
138
143
|
{ body },
|
|
139
144
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -169,12 +174,12 @@ class FileStorage {
|
|
|
169
174
|
}),
|
|
170
175
|
query_params,
|
|
171
176
|
body,
|
|
172
|
-
xHeaders,
|
|
173
|
-
{
|
|
177
|
+
{ ...xHeaders, ...requestHeaders },
|
|
178
|
+
{ responseHeaders }
|
|
174
179
|
);
|
|
175
180
|
|
|
176
181
|
let responseData = response;
|
|
177
|
-
if (
|
|
182
|
+
if (responseHeaders) {
|
|
178
183
|
responseData = response[0];
|
|
179
184
|
}
|
|
180
185
|
|
|
@@ -197,6 +202,7 @@ class FileStorage {
|
|
|
197
202
|
|
|
198
203
|
/**
|
|
199
204
|
* @param {FileStorageApplicationValidator.StartUploadParam} arg - Arg object.
|
|
205
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
200
206
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
201
207
|
* @returns {Promise<FileStorageApplicationModel.StartResponse>} - Success response
|
|
202
208
|
* @name startUpload
|
|
@@ -222,8 +228,8 @@ class FileStorage {
|
|
|
222
228
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
|
|
223
229
|
*/
|
|
224
230
|
async startUpload(
|
|
225
|
-
{ namespace, body } = {},
|
|
226
|
-
{
|
|
231
|
+
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
232
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
227
233
|
) {
|
|
228
234
|
const { error } = FileStorageApplicationValidator.startUpload().validate(
|
|
229
235
|
{ namespace, body },
|
|
@@ -260,12 +266,12 @@ class FileStorage {
|
|
|
260
266
|
}),
|
|
261
267
|
query_params,
|
|
262
268
|
body,
|
|
263
|
-
xHeaders,
|
|
264
|
-
{
|
|
269
|
+
{ ...xHeaders, ...requestHeaders },
|
|
270
|
+
{ responseHeaders }
|
|
265
271
|
);
|
|
266
272
|
|
|
267
273
|
let responseData = response;
|
|
268
|
-
if (
|
|
274
|
+
if (responseHeaders) {
|
|
269
275
|
responseData = response[0];
|
|
270
276
|
}
|
|
271
277
|
|
|
@@ -1,20 +1,4 @@
|
|
|
1
1
|
export = FileStorageApplicationModel;
|
|
2
|
-
/**
|
|
3
|
-
* @typedef BrowseResponse
|
|
4
|
-
* @property {DbRecord[]} items
|
|
5
|
-
* @property {Page} page
|
|
6
|
-
*/
|
|
7
|
-
/**
|
|
8
|
-
* @typedef BulkRequest
|
|
9
|
-
* @property {ReqConfiguration} [configuration]
|
|
10
|
-
* @property {Destination} destination
|
|
11
|
-
* @property {string[]} urls
|
|
12
|
-
*/
|
|
13
|
-
/**
|
|
14
|
-
* @typedef BulkUploadResponse
|
|
15
|
-
* @property {CopyFileTask} task
|
|
16
|
-
* @property {string} tracking_url
|
|
17
|
-
*/
|
|
18
2
|
/**
|
|
19
3
|
* @typedef CDN
|
|
20
4
|
* @property {string} absolute_url
|
|
@@ -37,65 +21,10 @@ export = FileStorageApplicationModel;
|
|
|
37
21
|
* @property {string[]} [tags]
|
|
38
22
|
* @property {Upload} upload
|
|
39
23
|
*/
|
|
40
|
-
/**
|
|
41
|
-
* @typedef CopyFileTask
|
|
42
|
-
* @property {number} attempts_made
|
|
43
|
-
* @property {BulkRequest} data
|
|
44
|
-
* @property {number} delay
|
|
45
|
-
* @property {number} finished_on
|
|
46
|
-
* @property {string} id
|
|
47
|
-
* @property {string} name
|
|
48
|
-
* @property {Opts} opts
|
|
49
|
-
* @property {number} processed_on
|
|
50
|
-
* @property {number} progress
|
|
51
|
-
* @property {string[]} [stacktrace]
|
|
52
|
-
* @property {number} timestamp
|
|
53
|
-
*/
|
|
54
|
-
/**
|
|
55
|
-
* @typedef DbRecord
|
|
56
|
-
* @property {string} _id
|
|
57
|
-
* @property {CDN} cdn
|
|
58
|
-
* @property {string} content_type
|
|
59
|
-
* @property {string} created_on
|
|
60
|
-
* @property {string} file_name
|
|
61
|
-
* @property {string} file_path
|
|
62
|
-
* @property {string} modified_on
|
|
63
|
-
* @property {string} namespace
|
|
64
|
-
* @property {string} [operation]
|
|
65
|
-
* @property {boolean} success
|
|
66
|
-
* @property {string[]} tags
|
|
67
|
-
* @property {Upload} upload
|
|
68
|
-
*/
|
|
69
|
-
/**
|
|
70
|
-
* @typedef Destination
|
|
71
|
-
* @property {string} [basepath]
|
|
72
|
-
* @property {string} namespace
|
|
73
|
-
* @property {string} rewrite
|
|
74
|
-
*/
|
|
75
24
|
/**
|
|
76
25
|
* @typedef FailedResponse
|
|
77
26
|
* @property {string} message
|
|
78
27
|
*/
|
|
79
|
-
/**
|
|
80
|
-
* @typedef Opts
|
|
81
|
-
* @property {number} [attempts]
|
|
82
|
-
* @property {number} [delay]
|
|
83
|
-
* @property {number} [timestamp]
|
|
84
|
-
*/
|
|
85
|
-
/**
|
|
86
|
-
* @typedef Page
|
|
87
|
-
* @property {number} [current]
|
|
88
|
-
* @property {boolean} [has_next]
|
|
89
|
-
* @property {boolean} [has_previous]
|
|
90
|
-
* @property {number} [item_total]
|
|
91
|
-
* @property {string} [next_id]
|
|
92
|
-
* @property {number} [size]
|
|
93
|
-
* @property {string} type
|
|
94
|
-
*/
|
|
95
|
-
/**
|
|
96
|
-
* @typedef ReqConfiguration
|
|
97
|
-
* @property {number} [concurrency]
|
|
98
|
-
*/
|
|
99
28
|
/**
|
|
100
29
|
* @typedef SignUrlRequest
|
|
101
30
|
* @property {number} expiry
|
|
@@ -140,27 +69,8 @@ export = FileStorageApplicationModel;
|
|
|
140
69
|
declare class FileStorageApplicationModel {
|
|
141
70
|
}
|
|
142
71
|
declare namespace FileStorageApplicationModel {
|
|
143
|
-
export {
|
|
72
|
+
export { CDN, CompleteResponse, FailedResponse, SignUrlRequest, SignUrlResponse, StartRequest, StartResponse, Upload, Urls };
|
|
144
73
|
}
|
|
145
|
-
/** @returns {BrowseResponse} */
|
|
146
|
-
declare function BrowseResponse(): BrowseResponse;
|
|
147
|
-
type BrowseResponse = {
|
|
148
|
-
items: DbRecord[];
|
|
149
|
-
page: Page;
|
|
150
|
-
};
|
|
151
|
-
/** @returns {BulkRequest} */
|
|
152
|
-
declare function BulkRequest(): BulkRequest;
|
|
153
|
-
type BulkRequest = {
|
|
154
|
-
configuration?: ReqConfiguration;
|
|
155
|
-
destination: Destination;
|
|
156
|
-
urls: string[];
|
|
157
|
-
};
|
|
158
|
-
/** @returns {BulkUploadResponse} */
|
|
159
|
-
declare function BulkUploadResponse(): BulkUploadResponse;
|
|
160
|
-
type BulkUploadResponse = {
|
|
161
|
-
task: CopyFileTask;
|
|
162
|
-
tracking_url: string;
|
|
163
|
-
};
|
|
164
74
|
/** @returns {CDN} */
|
|
165
75
|
declare function CDN(): CDN;
|
|
166
76
|
type CDN = {
|
|
@@ -185,72 +95,11 @@ type CompleteResponse = {
|
|
|
185
95
|
tags?: string[];
|
|
186
96
|
upload: Upload;
|
|
187
97
|
};
|
|
188
|
-
/** @returns {CopyFileTask} */
|
|
189
|
-
declare function CopyFileTask(): CopyFileTask;
|
|
190
|
-
type CopyFileTask = {
|
|
191
|
-
attempts_made: number;
|
|
192
|
-
data: BulkRequest;
|
|
193
|
-
delay: number;
|
|
194
|
-
finished_on: number;
|
|
195
|
-
id: string;
|
|
196
|
-
name: string;
|
|
197
|
-
opts: Opts;
|
|
198
|
-
processed_on: number;
|
|
199
|
-
progress: number;
|
|
200
|
-
stacktrace?: string[];
|
|
201
|
-
timestamp: number;
|
|
202
|
-
};
|
|
203
|
-
/** @returns {DbRecord} */
|
|
204
|
-
declare function DbRecord(): DbRecord;
|
|
205
|
-
type DbRecord = {
|
|
206
|
-
_id: string;
|
|
207
|
-
cdn: CDN;
|
|
208
|
-
content_type: string;
|
|
209
|
-
created_on: string;
|
|
210
|
-
file_name: string;
|
|
211
|
-
file_path: string;
|
|
212
|
-
modified_on: string;
|
|
213
|
-
namespace: string;
|
|
214
|
-
operation?: string;
|
|
215
|
-
success: boolean;
|
|
216
|
-
tags: string[];
|
|
217
|
-
upload: Upload;
|
|
218
|
-
};
|
|
219
|
-
/** @returns {Destination} */
|
|
220
|
-
declare function Destination(): Destination;
|
|
221
|
-
type Destination = {
|
|
222
|
-
basepath?: string;
|
|
223
|
-
namespace: string;
|
|
224
|
-
rewrite: string;
|
|
225
|
-
};
|
|
226
98
|
/** @returns {FailedResponse} */
|
|
227
99
|
declare function FailedResponse(): FailedResponse;
|
|
228
100
|
type FailedResponse = {
|
|
229
101
|
message: string;
|
|
230
102
|
};
|
|
231
|
-
/** @returns {Opts} */
|
|
232
|
-
declare function Opts(): Opts;
|
|
233
|
-
type Opts = {
|
|
234
|
-
attempts?: number;
|
|
235
|
-
delay?: number;
|
|
236
|
-
timestamp?: number;
|
|
237
|
-
};
|
|
238
|
-
/** @returns {Page} */
|
|
239
|
-
declare function Page(): Page;
|
|
240
|
-
type Page = {
|
|
241
|
-
current?: number;
|
|
242
|
-
has_next?: boolean;
|
|
243
|
-
has_previous?: boolean;
|
|
244
|
-
item_total?: number;
|
|
245
|
-
next_id?: string;
|
|
246
|
-
size?: number;
|
|
247
|
-
type: string;
|
|
248
|
-
};
|
|
249
|
-
/** @returns {ReqConfiguration} */
|
|
250
|
-
declare function ReqConfiguration(): ReqConfiguration;
|
|
251
|
-
type ReqConfiguration = {
|
|
252
|
-
concurrency?: number;
|
|
253
|
-
};
|
|
254
103
|
/** @returns {SignUrlRequest} */
|
|
255
104
|
declare function SignUrlRequest(): SignUrlRequest;
|
|
256
105
|
type SignUrlRequest = {
|
|
@@ -1,24 +1,5 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
|
-
/**
|
|
4
|
-
* @typedef BrowseResponse
|
|
5
|
-
* @property {DbRecord[]} items
|
|
6
|
-
* @property {Page} page
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* @typedef BulkRequest
|
|
11
|
-
* @property {ReqConfiguration} [configuration]
|
|
12
|
-
* @property {Destination} destination
|
|
13
|
-
* @property {string[]} urls
|
|
14
|
-
*/
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* @typedef BulkUploadResponse
|
|
18
|
-
* @property {CopyFileTask} task
|
|
19
|
-
* @property {string} tracking_url
|
|
20
|
-
*/
|
|
21
|
-
|
|
22
3
|
/**
|
|
23
4
|
* @typedef CDN
|
|
24
5
|
* @property {string} absolute_url
|
|
@@ -43,72 +24,11 @@ const Joi = require("joi");
|
|
|
43
24
|
* @property {Upload} upload
|
|
44
25
|
*/
|
|
45
26
|
|
|
46
|
-
/**
|
|
47
|
-
* @typedef CopyFileTask
|
|
48
|
-
* @property {number} attempts_made
|
|
49
|
-
* @property {BulkRequest} data
|
|
50
|
-
* @property {number} delay
|
|
51
|
-
* @property {number} finished_on
|
|
52
|
-
* @property {string} id
|
|
53
|
-
* @property {string} name
|
|
54
|
-
* @property {Opts} opts
|
|
55
|
-
* @property {number} processed_on
|
|
56
|
-
* @property {number} progress
|
|
57
|
-
* @property {string[]} [stacktrace]
|
|
58
|
-
* @property {number} timestamp
|
|
59
|
-
*/
|
|
60
|
-
|
|
61
|
-
/**
|
|
62
|
-
* @typedef DbRecord
|
|
63
|
-
* @property {string} _id
|
|
64
|
-
* @property {CDN} cdn
|
|
65
|
-
* @property {string} content_type
|
|
66
|
-
* @property {string} created_on
|
|
67
|
-
* @property {string} file_name
|
|
68
|
-
* @property {string} file_path
|
|
69
|
-
* @property {string} modified_on
|
|
70
|
-
* @property {string} namespace
|
|
71
|
-
* @property {string} [operation]
|
|
72
|
-
* @property {boolean} success
|
|
73
|
-
* @property {string[]} tags
|
|
74
|
-
* @property {Upload} upload
|
|
75
|
-
*/
|
|
76
|
-
|
|
77
|
-
/**
|
|
78
|
-
* @typedef Destination
|
|
79
|
-
* @property {string} [basepath]
|
|
80
|
-
* @property {string} namespace
|
|
81
|
-
* @property {string} rewrite
|
|
82
|
-
*/
|
|
83
|
-
|
|
84
27
|
/**
|
|
85
28
|
* @typedef FailedResponse
|
|
86
29
|
* @property {string} message
|
|
87
30
|
*/
|
|
88
31
|
|
|
89
|
-
/**
|
|
90
|
-
* @typedef Opts
|
|
91
|
-
* @property {number} [attempts]
|
|
92
|
-
* @property {number} [delay]
|
|
93
|
-
* @property {number} [timestamp]
|
|
94
|
-
*/
|
|
95
|
-
|
|
96
|
-
/**
|
|
97
|
-
* @typedef Page
|
|
98
|
-
* @property {number} [current]
|
|
99
|
-
* @property {boolean} [has_next]
|
|
100
|
-
* @property {boolean} [has_previous]
|
|
101
|
-
* @property {number} [item_total]
|
|
102
|
-
* @property {string} [next_id]
|
|
103
|
-
* @property {number} [size]
|
|
104
|
-
* @property {string} type
|
|
105
|
-
*/
|
|
106
|
-
|
|
107
|
-
/**
|
|
108
|
-
* @typedef ReqConfiguration
|
|
109
|
-
* @property {number} [concurrency]
|
|
110
|
-
*/
|
|
111
|
-
|
|
112
32
|
/**
|
|
113
33
|
* @typedef SignUrlRequest
|
|
114
34
|
* @property {number} expiry
|
|
@@ -157,33 +77,6 @@ const Joi = require("joi");
|
|
|
157
77
|
*/
|
|
158
78
|
|
|
159
79
|
class FileStorageApplicationModel {
|
|
160
|
-
/** @returns {BrowseResponse} */
|
|
161
|
-
static BrowseResponse() {
|
|
162
|
-
return Joi.object({
|
|
163
|
-
items: Joi.array()
|
|
164
|
-
.items(FileStorageApplicationModel.DbRecord())
|
|
165
|
-
.required(),
|
|
166
|
-
page: FileStorageApplicationModel.Page().required(),
|
|
167
|
-
});
|
|
168
|
-
}
|
|
169
|
-
|
|
170
|
-
/** @returns {BulkRequest} */
|
|
171
|
-
static BulkRequest() {
|
|
172
|
-
return Joi.object({
|
|
173
|
-
configuration: FileStorageApplicationModel.ReqConfiguration(),
|
|
174
|
-
destination: FileStorageApplicationModel.Destination().required(),
|
|
175
|
-
urls: Joi.array().items(Joi.string().allow("")).required(),
|
|
176
|
-
});
|
|
177
|
-
}
|
|
178
|
-
|
|
179
|
-
/** @returns {BulkUploadResponse} */
|
|
180
|
-
static BulkUploadResponse() {
|
|
181
|
-
return Joi.object({
|
|
182
|
-
task: FileStorageApplicationModel.CopyFileTask().required(),
|
|
183
|
-
tracking_url: Joi.string().allow("").required(),
|
|
184
|
-
});
|
|
185
|
-
}
|
|
186
|
-
|
|
187
80
|
/** @returns {CDN} */
|
|
188
81
|
static CDN() {
|
|
189
82
|
return Joi.object({
|
|
@@ -212,50 +105,6 @@ class FileStorageApplicationModel {
|
|
|
212
105
|
});
|
|
213
106
|
}
|
|
214
107
|
|
|
215
|
-
/** @returns {CopyFileTask} */
|
|
216
|
-
static CopyFileTask() {
|
|
217
|
-
return Joi.object({
|
|
218
|
-
attempts_made: Joi.number().required(),
|
|
219
|
-
data: FileStorageApplicationModel.BulkRequest().required(),
|
|
220
|
-
delay: Joi.number().required(),
|
|
221
|
-
finished_on: Joi.number().required(),
|
|
222
|
-
id: Joi.string().allow("").required(),
|
|
223
|
-
name: Joi.string().allow("").required(),
|
|
224
|
-
opts: FileStorageApplicationModel.Opts().required(),
|
|
225
|
-
processed_on: Joi.number().required(),
|
|
226
|
-
progress: Joi.number().required(),
|
|
227
|
-
stacktrace: Joi.array().items(Joi.string().allow("")),
|
|
228
|
-
timestamp: Joi.number().required(),
|
|
229
|
-
});
|
|
230
|
-
}
|
|
231
|
-
|
|
232
|
-
/** @returns {DbRecord} */
|
|
233
|
-
static DbRecord() {
|
|
234
|
-
return Joi.object({
|
|
235
|
-
_id: Joi.string().allow("").required(),
|
|
236
|
-
cdn: FileStorageApplicationModel.CDN().required(),
|
|
237
|
-
content_type: Joi.string().allow("").required(),
|
|
238
|
-
created_on: Joi.string().allow("").required(),
|
|
239
|
-
file_name: Joi.string().allow("").required(),
|
|
240
|
-
file_path: Joi.string().allow("").required(),
|
|
241
|
-
modified_on: Joi.string().allow("").required(),
|
|
242
|
-
namespace: Joi.string().allow("").required(),
|
|
243
|
-
operation: Joi.string().allow(""),
|
|
244
|
-
success: Joi.boolean().required(),
|
|
245
|
-
tags: Joi.array().items(Joi.string().allow("")).required(),
|
|
246
|
-
upload: FileStorageApplicationModel.Upload().required(),
|
|
247
|
-
});
|
|
248
|
-
}
|
|
249
|
-
|
|
250
|
-
/** @returns {Destination} */
|
|
251
|
-
static Destination() {
|
|
252
|
-
return Joi.object({
|
|
253
|
-
basepath: Joi.string().allow(""),
|
|
254
|
-
namespace: Joi.string().allow("").required(),
|
|
255
|
-
rewrite: Joi.string().allow("").required(),
|
|
256
|
-
});
|
|
257
|
-
}
|
|
258
|
-
|
|
259
108
|
/** @returns {FailedResponse} */
|
|
260
109
|
static FailedResponse() {
|
|
261
110
|
return Joi.object({
|
|
@@ -263,35 +112,6 @@ class FileStorageApplicationModel {
|
|
|
263
112
|
});
|
|
264
113
|
}
|
|
265
114
|
|
|
266
|
-
/** @returns {Opts} */
|
|
267
|
-
static Opts() {
|
|
268
|
-
return Joi.object({
|
|
269
|
-
attempts: Joi.number(),
|
|
270
|
-
delay: Joi.number(),
|
|
271
|
-
timestamp: Joi.number(),
|
|
272
|
-
});
|
|
273
|
-
}
|
|
274
|
-
|
|
275
|
-
/** @returns {Page} */
|
|
276
|
-
static Page() {
|
|
277
|
-
return Joi.object({
|
|
278
|
-
current: Joi.number(),
|
|
279
|
-
has_next: Joi.boolean(),
|
|
280
|
-
has_previous: Joi.boolean(),
|
|
281
|
-
item_total: Joi.number(),
|
|
282
|
-
next_id: Joi.string().allow(""),
|
|
283
|
-
size: Joi.number(),
|
|
284
|
-
type: Joi.string().allow("").required(),
|
|
285
|
-
});
|
|
286
|
-
}
|
|
287
|
-
|
|
288
|
-
/** @returns {ReqConfiguration} */
|
|
289
|
-
static ReqConfiguration() {
|
|
290
|
-
return Joi.object({
|
|
291
|
-
concurrency: Joi.number(),
|
|
292
|
-
});
|
|
293
|
-
}
|
|
294
|
-
|
|
295
115
|
/** @returns {SignUrlRequest} */
|
|
296
116
|
static SignUrlRequest() {
|
|
297
117
|
return Joi.object({
|
|
@@ -15,35 +15,39 @@ declare class Lead {
|
|
|
15
15
|
updateUrls(urls: any): void;
|
|
16
16
|
/**
|
|
17
17
|
* @param {LeadApplicationValidator.CreateHistoryParam} arg - Arg object.
|
|
18
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
18
19
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
19
20
|
* @returns {Promise<LeadApplicationModel.TicketHistory>} - Success response
|
|
20
21
|
* @name createHistory
|
|
21
22
|
* @summary: Create history for specific Ticket
|
|
22
23
|
* @description: Create history for specific 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/application/lead/createHistory/).
|
|
23
24
|
*/
|
|
24
|
-
createHistory({ id, body }?: LeadApplicationValidator.CreateHistoryParam, {
|
|
25
|
+
createHistory({ id, body, requestHeaders }?: LeadApplicationValidator.CreateHistoryParam, { responseHeaders }?: object): Promise<LeadApplicationModel.TicketHistory>;
|
|
25
26
|
/**
|
|
26
27
|
* @param {LeadApplicationValidator.CreateTicketParam} arg - Arg object.
|
|
28
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
27
29
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
28
30
|
* @returns {Promise<LeadApplicationModel.Ticket>} - Success response
|
|
29
31
|
* @name createTicket
|
|
30
32
|
* @summary: Create Ticket
|
|
31
33
|
* @description: This is used to Create Ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createTicket/).
|
|
32
34
|
*/
|
|
33
|
-
createTicket({ body }?: LeadApplicationValidator.CreateTicketParam, {
|
|
35
|
+
createTicket({ body, requestHeaders }?: LeadApplicationValidator.CreateTicketParam, { responseHeaders }?: object): Promise<LeadApplicationModel.Ticket>;
|
|
34
36
|
/**
|
|
35
37
|
* @param {LeadApplicationValidator.GetCustomFormParam} arg - Arg object.
|
|
38
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
36
39
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
37
40
|
* @returns {Promise<LeadApplicationModel.CustomForm>} - Success response
|
|
38
41
|
* @name getCustomForm
|
|
39
42
|
* @summary: Get specific Custom Form using it's slug
|
|
40
43
|
* @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/application/lead/getCustomForm/).
|
|
41
44
|
*/
|
|
42
|
-
getCustomForm({ slug }?: LeadApplicationValidator.GetCustomFormParam, {
|
|
45
|
+
getCustomForm({ slug, requestHeaders }?: LeadApplicationValidator.GetCustomFormParam, { responseHeaders }?: object): Promise<LeadApplicationModel.CustomForm>;
|
|
43
46
|
/**
|
|
44
47
|
* @param {LeadApplicationValidator.GetParticipantsInsideVideoRoomParam} arg
|
|
45
48
|
* - Arg object.
|
|
46
49
|
*
|
|
50
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
47
51
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
48
52
|
* @returns {Promise<LeadApplicationModel.GetParticipantsInsideVideoRoomResponse>}
|
|
49
53
|
* - Success response
|
|
@@ -52,18 +56,20 @@ declare class Lead {
|
|
|
52
56
|
* @summary: Get participants of a specific Video Room using it's unique name
|
|
53
57
|
* @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/application/lead/getParticipantsInsideVideoRoom/).
|
|
54
58
|
*/
|
|
55
|
-
getParticipantsInsideVideoRoom({ uniqueName }?: LeadApplicationValidator.GetParticipantsInsideVideoRoomParam, {
|
|
59
|
+
getParticipantsInsideVideoRoom({ uniqueName, requestHeaders }?: LeadApplicationValidator.GetParticipantsInsideVideoRoomParam, { responseHeaders }?: object): Promise<LeadApplicationModel.GetParticipantsInsideVideoRoomResponse>;
|
|
56
60
|
/**
|
|
57
61
|
* @param {LeadApplicationValidator.GetTicketParam} arg - Arg object.
|
|
62
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
58
63
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
59
64
|
* @returns {Promise<LeadApplicationModel.Ticket>} - Success response
|
|
60
65
|
* @name getTicket
|
|
61
66
|
* @summary: Get Ticket with the specific id
|
|
62
67
|
* @description: Get Ticket with the specific id, this is used to view the ticket details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTicket/).
|
|
63
68
|
*/
|
|
64
|
-
getTicket({ id }?: LeadApplicationValidator.GetTicketParam, {
|
|
69
|
+
getTicket({ id, requestHeaders }?: LeadApplicationValidator.GetTicketParam, { responseHeaders }?: object): Promise<LeadApplicationModel.Ticket>;
|
|
65
70
|
/**
|
|
66
71
|
* @param {LeadApplicationValidator.GetTokenForVideoRoomParam} arg - Arg object.
|
|
72
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
67
73
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
68
74
|
* @returns {Promise<LeadApplicationModel.GetTokenForVideoRoomResponse>} -
|
|
69
75
|
* Success response
|
|
@@ -71,9 +77,10 @@ declare class Lead {
|
|
|
71
77
|
* @summary: Get Token to join a specific Video Room using it's unqiue name
|
|
72
78
|
* @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/application/lead/getTokenForVideoRoom/).
|
|
73
79
|
*/
|
|
74
|
-
getTokenForVideoRoom({ uniqueName }?: LeadApplicationValidator.GetTokenForVideoRoomParam, {
|
|
80
|
+
getTokenForVideoRoom({ uniqueName, requestHeaders }?: LeadApplicationValidator.GetTokenForVideoRoomParam, { responseHeaders }?: object): Promise<LeadApplicationModel.GetTokenForVideoRoomResponse>;
|
|
75
81
|
/**
|
|
76
82
|
* @param {LeadApplicationValidator.SubmitCustomFormParam} arg - Arg object.
|
|
83
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
77
84
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
78
85
|
* @returns {Promise<LeadApplicationModel.SubmitCustomFormResponse>} -
|
|
79
86
|
* Success response
|
|
@@ -81,7 +88,7 @@ declare class Lead {
|
|
|
81
88
|
* @summary: Submit Response for a specific Custom Form using it's slug
|
|
82
89
|
* @description: Submit Response for a specific Custom Form using it's slug, this response is then used to create a ticket on behalf of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
|
|
83
90
|
*/
|
|
84
|
-
submitCustomForm({ slug, body }?: LeadApplicationValidator.SubmitCustomFormParam, {
|
|
91
|
+
submitCustomForm({ slug, body, requestHeaders }?: LeadApplicationValidator.SubmitCustomFormParam, { responseHeaders }?: object): Promise<LeadApplicationModel.SubmitCustomFormResponse>;
|
|
85
92
|
}
|
|
86
93
|
import LeadApplicationValidator = require("./LeadApplicationValidator");
|
|
87
94
|
import LeadApplicationModel = require("./LeadApplicationModel");
|