@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
- package/sdk/application/Cart/CartApplicationClient.js +82 -71
- package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
- package/sdk/application/Cart/CartApplicationValidator.js +59 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
- package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
- package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
- package/sdk/application/Content/ContentApplicationClient.js +34 -115
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
- package/sdk/application/Lead/LeadApplicationClient.js +14 -14
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
- package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
- package/sdk/application/Order/OrderApplicationClient.js +24 -24
- package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
- package/sdk/application/Order/OrderApplicationModel.js +28 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
- package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
- package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +64 -64
- package/sdk/application/User/UserApplicationClient.js +64 -64
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
- package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
- package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
- package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
- package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +7 -7
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +19 -55
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -55
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -12
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -14
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
- package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
- package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
- package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
- package/sdk/platform/Order/OrderPlatformClient.js +79 -294
- package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
- package/sdk/platform/Order/OrderPlatformModel.js +34 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
- package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
- package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
- package/sdk/platform/User/UserPlatformModel.js +2 -2
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
|
@@ -174,8 +174,8 @@ export = ContentPlatformApplicationValidator;
|
|
|
174
174
|
* @typedef GetAppCustomFieldDefinitionsParam
|
|
175
175
|
* @property {string} pageNo
|
|
176
176
|
* @property {string} pageSize
|
|
177
|
-
* @property {string} [
|
|
178
|
-
* @property {string} [
|
|
177
|
+
* @property {string} [resources]
|
|
178
|
+
* @property {string} [types]
|
|
179
179
|
* @property {string} [search]
|
|
180
180
|
*/
|
|
181
181
|
/** @typedef GetAppCustomFieldTypesParam */
|
|
@@ -857,8 +857,8 @@ type GetAppCustomFieldDefinitionParam = {
|
|
|
857
857
|
type GetAppCustomFieldDefinitionsParam = {
|
|
858
858
|
pageNo: string;
|
|
859
859
|
pageSize: string;
|
|
860
|
-
|
|
861
|
-
|
|
860
|
+
resources?: string;
|
|
861
|
+
types?: string;
|
|
862
862
|
search?: string;
|
|
863
863
|
};
|
|
864
864
|
type GetAppCustomFieldsParam = {
|
|
@@ -216,8 +216,8 @@ const ContentPlatformModel = require("./ContentPlatformModel");
|
|
|
216
216
|
* @typedef GetAppCustomFieldDefinitionsParam
|
|
217
217
|
* @property {string} pageNo
|
|
218
218
|
* @property {string} pageSize
|
|
219
|
-
* @property {string} [
|
|
220
|
-
* @property {string} [
|
|
219
|
+
* @property {string} [resources]
|
|
220
|
+
* @property {string} [types]
|
|
221
221
|
* @property {string} [search]
|
|
222
222
|
*/
|
|
223
223
|
|
|
@@ -848,8 +848,8 @@ class ContentPlatformApplicationValidator {
|
|
|
848
848
|
return Joi.object({
|
|
849
849
|
pageNo: Joi.string().allow("").required(),
|
|
850
850
|
pageSize: Joi.string().allow("").required(),
|
|
851
|
-
|
|
852
|
-
|
|
851
|
+
resources: Joi.string().allow(""),
|
|
852
|
+
types: Joi.string().allow(""),
|
|
853
853
|
search: Joi.string().allow(""),
|
|
854
854
|
}).required();
|
|
855
855
|
}
|
|
@@ -119,7 +119,7 @@ declare class Content {
|
|
|
119
119
|
* @summary: Get custom fields definitions
|
|
120
120
|
* @description: Use this API to retrieve the definitions of custom fields. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldDefinitions/).
|
|
121
121
|
*/
|
|
122
|
-
getCustomFieldDefinitions({ pageNo, pageSize,
|
|
122
|
+
getCustomFieldDefinitions({ pageNo, pageSize, resources, types, search, requestHeaders }?: ContentPlatformValidator.GetCustomFieldDefinitionsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionsSchema>;
|
|
123
123
|
/**
|
|
124
124
|
* @param {ContentPlatformValidator.GetCustomFieldTypesParam} arg - Arg object
|
|
125
125
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -771,7 +771,7 @@ class Content {
|
|
|
771
771
|
* @description: Use this API to retrieve the definitions of custom fields. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getCustomFieldDefinitions/).
|
|
772
772
|
*/
|
|
773
773
|
async getCustomFieldDefinitions(
|
|
774
|
-
{ pageNo, pageSize,
|
|
774
|
+
{ pageNo, pageSize, resources, types, search, requestHeaders } = {
|
|
775
775
|
requestHeaders: {},
|
|
776
776
|
},
|
|
777
777
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -782,8 +782,8 @@ class Content {
|
|
|
782
782
|
{
|
|
783
783
|
pageNo,
|
|
784
784
|
pageSize,
|
|
785
|
-
|
|
786
|
-
|
|
785
|
+
resources,
|
|
786
|
+
types,
|
|
787
787
|
search,
|
|
788
788
|
},
|
|
789
789
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -799,8 +799,8 @@ class Content {
|
|
|
799
799
|
{
|
|
800
800
|
pageNo,
|
|
801
801
|
pageSize,
|
|
802
|
-
|
|
803
|
-
|
|
802
|
+
resources,
|
|
803
|
+
types,
|
|
804
804
|
search,
|
|
805
805
|
},
|
|
806
806
|
{ abortEarly: false, allowUnknown: false }
|
|
@@ -815,8 +815,8 @@ class Content {
|
|
|
815
815
|
const query_params = {};
|
|
816
816
|
query_params["page_no"] = pageNo;
|
|
817
817
|
query_params["page_size"] = pageSize;
|
|
818
|
-
query_params["
|
|
819
|
-
query_params["
|
|
818
|
+
query_params["resources"] = resources;
|
|
819
|
+
query_params["types"] = types;
|
|
820
820
|
query_params["search"] = search;
|
|
821
821
|
|
|
822
822
|
const xHeaders = {};
|
|
@@ -41,8 +41,8 @@ export = ContentPlatformValidator;
|
|
|
41
41
|
* @typedef GetCustomFieldDefinitionsParam
|
|
42
42
|
* @property {string} pageNo
|
|
43
43
|
* @property {string} pageSize
|
|
44
|
-
* @property {string} [
|
|
45
|
-
* @property {string} [
|
|
44
|
+
* @property {string} [resources]
|
|
45
|
+
* @property {string} [types]
|
|
46
46
|
* @property {string} [search]
|
|
47
47
|
*/
|
|
48
48
|
/** @typedef GetCustomFieldTypesParam */
|
|
@@ -191,8 +191,8 @@ type GetCustomFieldDefinitionParam = {
|
|
|
191
191
|
type GetCustomFieldDefinitionsParam = {
|
|
192
192
|
pageNo: string;
|
|
193
193
|
pageSize: string;
|
|
194
|
-
|
|
195
|
-
|
|
194
|
+
resources?: string;
|
|
195
|
+
types?: string;
|
|
196
196
|
search?: string;
|
|
197
197
|
};
|
|
198
198
|
type GetCustomFieldsParam = {
|
|
@@ -53,8 +53,8 @@ const ContentPlatformModel = require("./ContentPlatformModel");
|
|
|
53
53
|
* @typedef GetCustomFieldDefinitionsParam
|
|
54
54
|
* @property {string} pageNo
|
|
55
55
|
* @property {string} pageSize
|
|
56
|
-
* @property {string} [
|
|
57
|
-
* @property {string} [
|
|
56
|
+
* @property {string} [resources]
|
|
57
|
+
* @property {string} [types]
|
|
58
58
|
* @property {string} [search]
|
|
59
59
|
*/
|
|
60
60
|
|
|
@@ -204,8 +204,8 @@ class ContentPlatformValidator {
|
|
|
204
204
|
return Joi.object({
|
|
205
205
|
pageNo: Joi.string().allow("").required(),
|
|
206
206
|
pageSize: Joi.string().allow("").required(),
|
|
207
|
-
|
|
208
|
-
|
|
207
|
+
resources: Joi.string().allow(""),
|
|
208
|
+
types: Joi.string().allow(""),
|
|
209
209
|
search: Joi.string().allow(""),
|
|
210
210
|
}).required();
|
|
211
211
|
}
|
|
@@ -8,8 +8,8 @@ declare class Discount {
|
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<DiscountPlatformModel.CancelJobResponse>} - Success response
|
|
10
10
|
* @name cancelDownloadJob
|
|
11
|
-
* @summary: Cancel
|
|
12
|
-
* @description: Cancel
|
|
11
|
+
* @summary: Cancel download job.
|
|
12
|
+
* @description: Cancel download Job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelDownloadJob/).
|
|
13
13
|
*/
|
|
14
14
|
cancelDownloadJob({ id, requestHeaders }?: DiscountPlatformValidator.CancelDownloadJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.CancelJobResponse>;
|
|
15
15
|
/**
|
|
@@ -18,8 +18,8 @@ declare class Discount {
|
|
|
18
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
19
|
* @returns {Promise<DiscountPlatformModel.CancelJobResponse>} - Success response
|
|
20
20
|
* @name cancelValidationJob
|
|
21
|
-
* @summary: Cancel
|
|
22
|
-
* @description:
|
|
21
|
+
* @summary: Cancel validation job.
|
|
22
|
+
* @description: Validate file. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelValidationJob/).
|
|
23
23
|
*/
|
|
24
24
|
cancelValidationJob({ id, requestHeaders }?: DiscountPlatformValidator.CancelValidationJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.CancelJobResponse>;
|
|
25
25
|
/**
|
|
@@ -28,8 +28,8 @@ declare class Discount {
|
|
|
28
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
29
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
30
30
|
* @name createDiscount
|
|
31
|
-
* @summary: Create
|
|
32
|
-
* @description: Create
|
|
31
|
+
* @summary: Create discount.
|
|
32
|
+
* @description: Create discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/createDiscount/).
|
|
33
33
|
*/
|
|
34
34
|
createDiscount({ body, requestHeaders }?: DiscountPlatformValidator.CreateDiscountParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.DiscountJob>;
|
|
35
35
|
/**
|
|
@@ -38,8 +38,8 @@ declare class Discount {
|
|
|
38
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
39
|
* @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
|
|
40
40
|
* @name downloadDiscountFile
|
|
41
|
-
* @summary:
|
|
42
|
-
* @description: Validate
|
|
41
|
+
* @summary: Download discount file.
|
|
42
|
+
* @description: Validate file. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/downloadDiscountFile/).
|
|
43
43
|
*/
|
|
44
44
|
downloadDiscountFile({ type, body, requestHeaders }?: DiscountPlatformValidator.DownloadDiscountFileParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponse>;
|
|
45
45
|
/**
|
|
@@ -48,8 +48,8 @@ declare class Discount {
|
|
|
48
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
49
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
50
50
|
* @name getDiscount
|
|
51
|
-
* @summary:
|
|
52
|
-
* @description:
|
|
51
|
+
* @summary: Get discount by ID.
|
|
52
|
+
* @description: Retrieve detailed information about a specific discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscount/).
|
|
53
53
|
*/
|
|
54
54
|
getDiscount({ id, requestHeaders }?: DiscountPlatformValidator.GetDiscountParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.DiscountJob>;
|
|
55
55
|
/**
|
|
@@ -58,43 +58,18 @@ declare class Discount {
|
|
|
58
58
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
59
|
* @returns {Promise<DiscountPlatformModel.ListOrCalender>} - Success response
|
|
60
60
|
* @name getDiscounts
|
|
61
|
-
* @summary:
|
|
62
|
-
* @description:
|
|
61
|
+
* @summary: Get discounts.
|
|
62
|
+
* @description: Retrieve a list of available discounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscounts/).
|
|
63
63
|
*/
|
|
64
64
|
getDiscounts({ view, q, pageNo, pageSize, archived, month, year, type, appIds, requestHeaders, }?: DiscountPlatformValidator.GetDiscountsParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.ListOrCalender>;
|
|
65
|
-
/**
|
|
66
|
-
* @param {Object} arg - Arg object.
|
|
67
|
-
* @param {string} [arg.view] - Listing or calender. Default is listing.
|
|
68
|
-
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
69
|
-
* complete name of a discount.
|
|
70
|
-
* @param {number} [arg.pageSize] - Page size. Default is 12.
|
|
71
|
-
* @param {boolean} [arg.archived] - Archived. Default is false.
|
|
72
|
-
* @param {number} [arg.month] - Month. Default is current month.
|
|
73
|
-
* @param {number} [arg.year] - Year. Default is current year.
|
|
74
|
-
* @param {string} [arg.type] - Basic or custom.
|
|
75
|
-
* @param {string[]} [arg.appIds] - Application ids.
|
|
76
|
-
* @returns {Paginator<DiscountPlatformModel.ListOrCalender>}
|
|
77
|
-
* @summary: Fetch discount list.
|
|
78
|
-
* @description: Fetch discount list.
|
|
79
|
-
*/
|
|
80
|
-
getDiscountsPaginator({ view, q, pageSize, archived, month, year, type, appIds, }?: {
|
|
81
|
-
view?: string;
|
|
82
|
-
q?: string;
|
|
83
|
-
pageSize?: number;
|
|
84
|
-
archived?: boolean;
|
|
85
|
-
month?: number;
|
|
86
|
-
year?: number;
|
|
87
|
-
type?: string;
|
|
88
|
-
appIds?: string[];
|
|
89
|
-
}): Paginator<DiscountPlatformModel.ListOrCalender>;
|
|
90
65
|
/**
|
|
91
66
|
* @param {DiscountPlatformValidator.GetDownloadJobParam} arg - Arg object
|
|
92
67
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
93
68
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
94
69
|
* @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
|
|
95
70
|
* @name getDownloadJob
|
|
96
|
-
* @summary:
|
|
97
|
-
* @description: Download
|
|
71
|
+
* @summary: Get download job.
|
|
72
|
+
* @description: Download file Job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDownloadJob/).
|
|
98
73
|
*/
|
|
99
74
|
getDownloadJob({ id, requestHeaders }?: DiscountPlatformValidator.GetDownloadJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponse>;
|
|
100
75
|
/**
|
|
@@ -103,8 +78,8 @@ declare class Discount {
|
|
|
103
78
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
104
79
|
* @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
|
|
105
80
|
* @name getValidationJob
|
|
106
|
-
* @summary:
|
|
107
|
-
* @description: Validate
|
|
81
|
+
* @summary: Get validation job.
|
|
82
|
+
* @description: Validate file. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getValidationJob/).
|
|
108
83
|
*/
|
|
109
84
|
getValidationJob({ id, requestHeaders }?: DiscountPlatformValidator.GetValidationJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponse>;
|
|
110
85
|
/**
|
|
@@ -113,8 +88,8 @@ declare class Discount {
|
|
|
113
88
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
114
89
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
115
90
|
* @name updateDiscount
|
|
116
|
-
* @summary: Update
|
|
117
|
-
* @description:
|
|
91
|
+
* @summary: Update discount.
|
|
92
|
+
* @description: Create discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/updateDiscount/).
|
|
118
93
|
*/
|
|
119
94
|
updateDiscount({ id, body, requestHeaders }?: DiscountPlatformValidator.UpdateDiscountParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.DiscountJob>;
|
|
120
95
|
/**
|
|
@@ -123,8 +98,8 @@ declare class Discount {
|
|
|
123
98
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
124
99
|
* @returns {Promise<Object>} - Success response
|
|
125
100
|
* @name upsertDiscountItems
|
|
126
|
-
* @summary:
|
|
127
|
-
* @description: Create custom discounts
|
|
101
|
+
* @summary: Upsert discount items.
|
|
102
|
+
* @description: Create custom discounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/upsertDiscountItems/).
|
|
128
103
|
*/
|
|
129
104
|
upsertDiscountItems({ id, body, requestHeaders }?: DiscountPlatformValidator.UpsertDiscountItemsParam, { responseHeaders }?: object): Promise<any>;
|
|
130
105
|
/**
|
|
@@ -133,11 +108,10 @@ declare class Discount {
|
|
|
133
108
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
134
109
|
* @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
|
|
135
110
|
* @name validateDiscountFile
|
|
136
|
-
* @summary: Validate
|
|
137
|
-
* @description: Validate
|
|
111
|
+
* @summary: Validate discount file.
|
|
112
|
+
* @description: Validate file. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/validateDiscountFile/).
|
|
138
113
|
*/
|
|
139
114
|
validateDiscountFile({ body, discount, requestHeaders }?: DiscountPlatformValidator.ValidateDiscountFileParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponse>;
|
|
140
115
|
}
|
|
141
116
|
import DiscountPlatformValidator = require("./DiscountPlatformValidator");
|
|
142
117
|
import DiscountPlatformModel = require("./DiscountPlatformModel");
|
|
143
|
-
import Paginator = require("../../common/Paginator");
|
|
@@ -20,8 +20,8 @@ class Discount {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<DiscountPlatformModel.CancelJobResponse>} - Success response
|
|
22
22
|
* @name cancelDownloadJob
|
|
23
|
-
* @summary: Cancel
|
|
24
|
-
* @description: Cancel
|
|
23
|
+
* @summary: Cancel download job.
|
|
24
|
+
* @description: Cancel download Job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelDownloadJob/).
|
|
25
25
|
*/
|
|
26
26
|
async cancelDownloadJob(
|
|
27
27
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -99,8 +99,8 @@ class Discount {
|
|
|
99
99
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
100
|
* @returns {Promise<DiscountPlatformModel.CancelJobResponse>} - Success response
|
|
101
101
|
* @name cancelValidationJob
|
|
102
|
-
* @summary: Cancel
|
|
103
|
-
* @description:
|
|
102
|
+
* @summary: Cancel validation job.
|
|
103
|
+
* @description: Validate file. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelValidationJob/).
|
|
104
104
|
*/
|
|
105
105
|
async cancelValidationJob(
|
|
106
106
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -178,8 +178,8 @@ class Discount {
|
|
|
178
178
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
179
179
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
180
180
|
* @name createDiscount
|
|
181
|
-
* @summary: Create
|
|
182
|
-
* @description: Create
|
|
181
|
+
* @summary: Create discount.
|
|
182
|
+
* @description: Create discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/createDiscount/).
|
|
183
183
|
*/
|
|
184
184
|
async createDiscount(
|
|
185
185
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -257,8 +257,8 @@ class Discount {
|
|
|
257
257
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
258
258
|
* @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
|
|
259
259
|
* @name downloadDiscountFile
|
|
260
|
-
* @summary:
|
|
261
|
-
* @description: Validate
|
|
260
|
+
* @summary: Download discount file.
|
|
261
|
+
* @description: Validate file. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/downloadDiscountFile/).
|
|
262
262
|
*/
|
|
263
263
|
async downloadDiscountFile(
|
|
264
264
|
{ type, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -338,8 +338,8 @@ class Discount {
|
|
|
338
338
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
339
339
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
340
340
|
* @name getDiscount
|
|
341
|
-
* @summary:
|
|
342
|
-
* @description:
|
|
341
|
+
* @summary: Get discount by ID.
|
|
342
|
+
* @description: Retrieve detailed information about a specific discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscount/).
|
|
343
343
|
*/
|
|
344
344
|
async getDiscount(
|
|
345
345
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -417,8 +417,8 @@ class Discount {
|
|
|
417
417
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
418
418
|
* @returns {Promise<DiscountPlatformModel.ListOrCalender>} - Success response
|
|
419
419
|
* @name getDiscounts
|
|
420
|
-
* @summary:
|
|
421
|
-
* @description:
|
|
420
|
+
* @summary: Get discounts.
|
|
421
|
+
* @description: Retrieve a list of available discounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscounts/).
|
|
422
422
|
*/
|
|
423
423
|
async getDiscounts(
|
|
424
424
|
{
|
|
@@ -526,65 +526,14 @@ class Discount {
|
|
|
526
526
|
return response;
|
|
527
527
|
}
|
|
528
528
|
|
|
529
|
-
/**
|
|
530
|
-
* @param {Object} arg - Arg object.
|
|
531
|
-
* @param {string} [arg.view] - Listing or calender. Default is listing.
|
|
532
|
-
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
533
|
-
* complete name of a discount.
|
|
534
|
-
* @param {number} [arg.pageSize] - Page size. Default is 12.
|
|
535
|
-
* @param {boolean} [arg.archived] - Archived. Default is false.
|
|
536
|
-
* @param {number} [arg.month] - Month. Default is current month.
|
|
537
|
-
* @param {number} [arg.year] - Year. Default is current year.
|
|
538
|
-
* @param {string} [arg.type] - Basic or custom.
|
|
539
|
-
* @param {string[]} [arg.appIds] - Application ids.
|
|
540
|
-
* @returns {Paginator<DiscountPlatformModel.ListOrCalender>}
|
|
541
|
-
* @summary: Fetch discount list.
|
|
542
|
-
* @description: Fetch discount list.
|
|
543
|
-
*/
|
|
544
|
-
getDiscountsPaginator({
|
|
545
|
-
view,
|
|
546
|
-
q,
|
|
547
|
-
pageSize,
|
|
548
|
-
archived,
|
|
549
|
-
month,
|
|
550
|
-
year,
|
|
551
|
-
type,
|
|
552
|
-
appIds,
|
|
553
|
-
} = {}) {
|
|
554
|
-
const paginator = new Paginator();
|
|
555
|
-
const callback = async () => {
|
|
556
|
-
const pageId = paginator.nextId;
|
|
557
|
-
const pageNo = paginator.pageNo;
|
|
558
|
-
const pageType = "number";
|
|
559
|
-
const data = await this.getDiscounts({
|
|
560
|
-
view: view,
|
|
561
|
-
q: q,
|
|
562
|
-
pageNo: pageNo,
|
|
563
|
-
pageSize: pageSize,
|
|
564
|
-
archived: archived,
|
|
565
|
-
month: month,
|
|
566
|
-
year: year,
|
|
567
|
-
type: type,
|
|
568
|
-
appIds: appIds,
|
|
569
|
-
});
|
|
570
|
-
paginator.setPaginator({
|
|
571
|
-
hasNext: data.page.has_next ? true : false,
|
|
572
|
-
nextId: data.page.next_id,
|
|
573
|
-
});
|
|
574
|
-
return data;
|
|
575
|
-
};
|
|
576
|
-
paginator.setCallback(callback.bind(this));
|
|
577
|
-
return paginator;
|
|
578
|
-
}
|
|
579
|
-
|
|
580
529
|
/**
|
|
581
530
|
* @param {DiscountPlatformValidator.GetDownloadJobParam} arg - Arg object
|
|
582
531
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
583
532
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
584
533
|
* @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
|
|
585
534
|
* @name getDownloadJob
|
|
586
|
-
* @summary:
|
|
587
|
-
* @description: Download
|
|
535
|
+
* @summary: Get download job.
|
|
536
|
+
* @description: Download file Job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDownloadJob/).
|
|
588
537
|
*/
|
|
589
538
|
async getDownloadJob(
|
|
590
539
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -662,8 +611,8 @@ class Discount {
|
|
|
662
611
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
663
612
|
* @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
|
|
664
613
|
* @name getValidationJob
|
|
665
|
-
* @summary:
|
|
666
|
-
* @description: Validate
|
|
614
|
+
* @summary: Get validation job.
|
|
615
|
+
* @description: Validate file. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getValidationJob/).
|
|
667
616
|
*/
|
|
668
617
|
async getValidationJob(
|
|
669
618
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -741,8 +690,8 @@ class Discount {
|
|
|
741
690
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
742
691
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
743
692
|
* @name updateDiscount
|
|
744
|
-
* @summary: Update
|
|
745
|
-
* @description:
|
|
693
|
+
* @summary: Update discount.
|
|
694
|
+
* @description: Create discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/updateDiscount/).
|
|
746
695
|
*/
|
|
747
696
|
async updateDiscount(
|
|
748
697
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -822,8 +771,8 @@ class Discount {
|
|
|
822
771
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
823
772
|
* @returns {Promise<Object>} - Success response
|
|
824
773
|
* @name upsertDiscountItems
|
|
825
|
-
* @summary:
|
|
826
|
-
* @description: Create custom discounts
|
|
774
|
+
* @summary: Upsert discount items.
|
|
775
|
+
* @description: Create custom discounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/upsertDiscountItems/).
|
|
827
776
|
*/
|
|
828
777
|
async upsertDiscountItems(
|
|
829
778
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -901,8 +850,8 @@ class Discount {
|
|
|
901
850
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
902
851
|
* @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
|
|
903
852
|
* @name validateDiscountFile
|
|
904
|
-
* @summary: Validate
|
|
905
|
-
* @description: Validate
|
|
853
|
+
* @summary: Validate discount file.
|
|
854
|
+
* @description: Validate file. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/validateDiscountFile/).
|
|
906
855
|
*/
|
|
907
856
|
async validateDiscountFile(
|
|
908
857
|
{ body, discount, requestHeaders } = { requestHeaders: {} },
|
|
@@ -11,26 +11,8 @@ declare class FileStorage {
|
|
|
11
11
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
12
12
|
* @returns {Promise<FileStoragePlatformModel.CompleteResponse>} - Success response
|
|
13
13
|
* @name appCompleteUpload
|
|
14
|
-
* @summary:
|
|
15
|
-
* @description:
|
|
16
|
-
*
|
|
17
|
-
* It has three Major Steps:
|
|
18
|
-
* Start
|
|
19
|
-
* Upload
|
|
20
|
-
* Complete
|
|
21
|
-
*
|
|
22
|
-
* ### Start
|
|
23
|
-
* Initiates the assets upload using `appStartUpload`.
|
|
24
|
-
* It returns the storage link in response.
|
|
25
|
-
*
|
|
26
|
-
* ### Upload
|
|
27
|
-
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
28
|
-
* Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
|
|
29
|
-
*
|
|
30
|
-
* ### Complete
|
|
31
|
-
* After successfully upload, call `appCompleteUpload` api to complete the upload process.
|
|
32
|
-
* This operation will return the url for the uploaded file.
|
|
33
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCompleteUpload/).
|
|
14
|
+
* @summary: Application complete upload.
|
|
15
|
+
* @description: Finish uploading a file from an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCompleteUpload/).
|
|
34
16
|
*/
|
|
35
17
|
appCompleteUpload({ namespace, body, requestHeaders }?: FileStoragePlatformApplicationValidator.AppCompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.CompleteResponse>;
|
|
36
18
|
/**
|
|
@@ -39,8 +21,8 @@ declare class FileStorage {
|
|
|
39
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
40
22
|
* @returns {Promise<Object>} - Success response
|
|
41
23
|
* @name appCopyFiles
|
|
42
|
-
* @summary:
|
|
43
|
-
* @description: Copy
|
|
24
|
+
* @summary: Application copy files.
|
|
25
|
+
* @description: Copy files from an application to another location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCopyFiles/).
|
|
44
26
|
*/
|
|
45
27
|
appCopyFiles({ body, sync, requestHeaders }?: FileStoragePlatformApplicationValidator.AppCopyFilesParam, { responseHeaders }?: object): Promise<any>;
|
|
46
28
|
/**
|
|
@@ -51,26 +33,8 @@ declare class FileStorage {
|
|
|
51
33
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
52
34
|
* @returns {Promise<FileStoragePlatformModel.StartResponse>} - Success response
|
|
53
35
|
* @name appStartUpload
|
|
54
|
-
* @summary:
|
|
55
|
-
* @description:
|
|
56
|
-
*
|
|
57
|
-
* It has three Major Steps:
|
|
58
|
-
* Start
|
|
59
|
-
* Upload
|
|
60
|
-
* Complete
|
|
61
|
-
*
|
|
62
|
-
* ### Start
|
|
63
|
-
* Initiates the assets upload using `appStartUpload`.
|
|
64
|
-
* It returns the storage link in response.
|
|
65
|
-
*
|
|
66
|
-
* ### Upload
|
|
67
|
-
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
68
|
-
* Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
|
|
69
|
-
*
|
|
70
|
-
* ### Complete
|
|
71
|
-
* After successfully upload, call `appCompleteUpload` api to complete the upload process.
|
|
72
|
-
* This operation will return the url for the uploaded file.
|
|
73
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appStartUpload/).
|
|
36
|
+
* @summary: Application start upload.
|
|
37
|
+
* @description: Start uploading a file from an application and returns a storage link in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appStartUpload/).
|
|
74
38
|
*/
|
|
75
39
|
appStartUpload({ namespace, body, requestHeaders }?: FileStoragePlatformApplicationValidator.AppStartUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.StartResponse>;
|
|
76
40
|
/**
|
|
@@ -79,8 +43,8 @@ declare class FileStorage {
|
|
|
79
43
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
80
44
|
* @returns {Promise<Object>} - Success response
|
|
81
45
|
* @name appbrowse
|
|
82
|
-
* @summary:
|
|
83
|
-
* @description: Browse
|
|
46
|
+
* @summary: Application browse files.
|
|
47
|
+
* @description: Browse files within an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appbrowse/).
|
|
84
48
|
*/
|
|
85
49
|
appbrowse({ namespace, page, limit, search, requestHeaders }?: FileStoragePlatformApplicationValidator.AppbrowseParam, { responseHeaders }?: object): Promise<any>;
|
|
86
50
|
/**
|
|
@@ -101,7 +65,7 @@ declare class FileStorage {
|
|
|
101
65
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
102
66
|
* @returns {Promise<Object>} - Success response
|
|
103
67
|
* @name generatePaymentReceipt
|
|
104
|
-
* @summary: Generate
|
|
68
|
+
* @summary: Generate payment receipt.
|
|
105
69
|
* @description: Generate Payment Receipt for Jiomart Digital - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/generatePaymentReceipt/).
|
|
106
70
|
*/
|
|
107
71
|
generatePaymentReceipt({ body, requestHeaders }?: FileStoragePlatformApplicationValidator.GeneratePaymentReceiptParam, { responseHeaders }?: object): Promise<any>;
|
|
@@ -126,8 +90,8 @@ declare class FileStorage {
|
|
|
126
90
|
* @returns {Promise<FileStoragePlatformModel.DummyTemplateDataItems>} -
|
|
127
91
|
* Success response
|
|
128
92
|
* @name getDefaultPdfData
|
|
129
|
-
* @summary: Get
|
|
130
|
-
* @description:
|
|
93
|
+
* @summary: Get default PDF data.
|
|
94
|
+
* @description: Retrieve default data for PDF generation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfData/).
|
|
131
95
|
*/
|
|
132
96
|
getDefaultPdfData({ pdfTypeId, countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultPdfDataParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.DummyTemplateDataItems>;
|
|
133
97
|
/**
|
|
@@ -139,8 +103,8 @@ declare class FileStorage {
|
|
|
139
103
|
* @returns {Promise<FileStoragePlatformModel.PdfDefaultTemplateSuccess>} -
|
|
140
104
|
* Success response
|
|
141
105
|
* @name getDefaultPdfTemplate
|
|
142
|
-
* @summary:
|
|
143
|
-
* @description:
|
|
106
|
+
* @summary: Get default PDF template.
|
|
107
|
+
* @description: Retrieve the default PDF template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfTemplate/).
|
|
144
108
|
*/
|
|
145
109
|
getDefaultPdfTemplate({ pdfTypeId, format, countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultPdfTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfDefaultTemplateSuccess>;
|
|
146
110
|
/**
|
|
@@ -150,8 +114,8 @@ declare class FileStorage {
|
|
|
150
114
|
* @returns {Promise<FileStoragePlatformModel.InvoiceTypesResponse>} -
|
|
151
115
|
* Success response
|
|
152
116
|
* @name getPdfTypes
|
|
153
|
-
* @summary: Get
|
|
154
|
-
* @description:
|
|
117
|
+
* @summary: Get PDF types.
|
|
118
|
+
* @description: Retrieve a list of available PDF types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getPdfTypes/).
|
|
155
119
|
*/
|
|
156
120
|
getPdfTypes({ storeOs, countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetPdfTypesParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.InvoiceTypesResponse>;
|
|
157
121
|
/**
|
|
@@ -163,8 +127,8 @@ declare class FileStorage {
|
|
|
163
127
|
* @returns {Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>} -
|
|
164
128
|
* Success response
|
|
165
129
|
* @name saveHtmlTemplate
|
|
166
|
-
* @summary:
|
|
167
|
-
* @description:
|
|
130
|
+
* @summary: Save HTML template.
|
|
131
|
+
* @description: Store an HTML template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/saveHtmlTemplate/).
|
|
168
132
|
*/
|
|
169
133
|
saveHtmlTemplate({ body, requestHeaders }?: FileStoragePlatformApplicationValidator.SaveHtmlTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>;
|
|
170
134
|
/**
|
|
@@ -176,8 +140,8 @@ declare class FileStorage {
|
|
|
176
140
|
* @returns {Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>} -
|
|
177
141
|
* Success response
|
|
178
142
|
* @name updateHtmlTemplate
|
|
179
|
-
* @summary: Update
|
|
180
|
-
* @description: Update
|
|
143
|
+
* @summary: Update HTML Template
|
|
144
|
+
* @description: Update the HTML Template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/updateHtmlTemplate/).
|
|
181
145
|
*/
|
|
182
146
|
updateHtmlTemplate({ id, body, requestHeaders }?: FileStoragePlatformApplicationValidator.UpdateHtmlTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>;
|
|
183
147
|
/**
|