@gofynd/fdk-client-javascript 1.3.3 → 1.3.4-beta.2
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/Catalog/CatalogApplicationModel.d.ts +18 -1
- package/sdk/application/Catalog/CatalogApplicationModel.js +20 -0
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +23 -9
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +21 -7
- package/sdk/application/User/UserApplicationClient.d.ts +56 -0
- package/sdk/application/User/UserApplicationClient.js +385 -0
- package/sdk/application/User/UserApplicationModel.d.ts +93 -1
- package/sdk/application/User/UserApplicationModel.js +110 -0
- package/sdk/application/User/UserApplicationValidator.d.ts +66 -1
- package/sdk/application/User/UserApplicationValidator.js +68 -0
- package/sdk/common/AxiosHelper.js +10 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +96 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +177 -0
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +139 -0
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +6 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +33 -0
- package/sdk/partner/PartnerClient.d.ts +2 -0
- package/sdk/partner/PartnerClient.js +3 -0
- package/sdk/partner/PartnerConfig.js +3 -5
- package/sdk/partner/index.d.ts +1 -0
- package/sdk/partner/index.js +2 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +11 -79
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +12 -8
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +7 -9
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +37 -27
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +145 -56
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +22 -11
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +24 -10
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +4 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +832 -150
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +940 -138
- package/sdk/platform/Order/OrderPlatformClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformClient.js +1 -1
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -2
- package/sdk/platform/Order/OrderPlatformModel.js +10 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformValidator.js +4 -4
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +42 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +241 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +41 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +40 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +72 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +54 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -0
- package/sdk/platform/User/UserPlatformApplicationClient.js +79 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +15 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +14 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +63 -1
- package/sdk/platform/User/UserPlatformModel.js +44 -0
|
@@ -920,79 +920,6 @@ class Content {
|
|
|
920
920
|
return response;
|
|
921
921
|
}
|
|
922
922
|
|
|
923
|
-
/**
|
|
924
|
-
* @param {ContentPlatformApplicationValidator.DeleteAllInjectableTagsParam} arg
|
|
925
|
-
* - Arg object
|
|
926
|
-
*
|
|
927
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
928
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
929
|
-
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
930
|
-
* @name deleteAllInjectableTags
|
|
931
|
-
* @summary: Delete tags in application
|
|
932
|
-
* @description: Use this API to delete all the existing tags at once. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAllInjectableTags/).
|
|
933
|
-
*/
|
|
934
|
-
async deleteAllInjectableTags(
|
|
935
|
-
{ requestHeaders } = { requestHeaders: {} },
|
|
936
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
937
|
-
) {
|
|
938
|
-
const {
|
|
939
|
-
error,
|
|
940
|
-
} = ContentPlatformApplicationValidator.deleteAllInjectableTags().validate(
|
|
941
|
-
{},
|
|
942
|
-
{ abortEarly: false, allowUnknown: true }
|
|
943
|
-
);
|
|
944
|
-
if (error) {
|
|
945
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
946
|
-
}
|
|
947
|
-
|
|
948
|
-
// Showing warrnings if extra unknown parameters are found
|
|
949
|
-
const {
|
|
950
|
-
error: warrning,
|
|
951
|
-
} = ContentPlatformApplicationValidator.deleteAllInjectableTags().validate(
|
|
952
|
-
{},
|
|
953
|
-
{ abortEarly: false, allowUnknown: false }
|
|
954
|
-
);
|
|
955
|
-
if (warrning) {
|
|
956
|
-
Logger({
|
|
957
|
-
level: "WARN",
|
|
958
|
-
message: `Parameter Validation warrnings for platform > Content > deleteAllInjectableTags \n ${warrning}`,
|
|
959
|
-
});
|
|
960
|
-
}
|
|
961
|
-
|
|
962
|
-
const query_params = {};
|
|
963
|
-
|
|
964
|
-
const response = await PlatformAPIClient.execute(
|
|
965
|
-
this.config,
|
|
966
|
-
"delete",
|
|
967
|
-
`/service/platform/content/v1.0/company/${this.config.companyId}/application/${this.applicationId}/tags`,
|
|
968
|
-
query_params,
|
|
969
|
-
undefined,
|
|
970
|
-
requestHeaders,
|
|
971
|
-
{ responseHeaders }
|
|
972
|
-
);
|
|
973
|
-
|
|
974
|
-
let responseData = response;
|
|
975
|
-
if (responseHeaders) {
|
|
976
|
-
responseData = response[0];
|
|
977
|
-
}
|
|
978
|
-
|
|
979
|
-
const {
|
|
980
|
-
error: res_error,
|
|
981
|
-
} = ContentPlatformModel.TagsSchema().validate(responseData, {
|
|
982
|
-
abortEarly: false,
|
|
983
|
-
allowUnknown: false,
|
|
984
|
-
});
|
|
985
|
-
|
|
986
|
-
if (res_error) {
|
|
987
|
-
Logger({
|
|
988
|
-
level: "WARN",
|
|
989
|
-
message: `Response Validation Warnnings for platform > Content > deleteAllInjectableTags \n ${res_error}`,
|
|
990
|
-
});
|
|
991
|
-
}
|
|
992
|
-
|
|
993
|
-
return response;
|
|
994
|
-
}
|
|
995
|
-
|
|
996
923
|
/**
|
|
997
924
|
* @param {ContentPlatformApplicationValidator.DeleteAnnouncementParam} arg
|
|
998
925
|
* - Arg object
|
|
@@ -2890,16 +2817,18 @@ class Content {
|
|
|
2890
2817
|
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
2891
2818
|
* @name getInjectableTags
|
|
2892
2819
|
* @summary: Get all the tags in an application
|
|
2893
|
-
* @description: Use this API to get
|
|
2820
|
+
* @description: Use this API to get the CSS and JS injected in the application in the form of tags. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getInjectableTags/).
|
|
2894
2821
|
*/
|
|
2895
2822
|
async getInjectableTags(
|
|
2896
|
-
{ requestHeaders } = { requestHeaders: {} },
|
|
2823
|
+
{ all, requestHeaders } = { requestHeaders: {} },
|
|
2897
2824
|
{ responseHeaders } = { responseHeaders: false }
|
|
2898
2825
|
) {
|
|
2899
2826
|
const {
|
|
2900
2827
|
error,
|
|
2901
2828
|
} = ContentPlatformApplicationValidator.getInjectableTags().validate(
|
|
2902
|
-
{
|
|
2829
|
+
{
|
|
2830
|
+
all,
|
|
2831
|
+
},
|
|
2903
2832
|
{ abortEarly: false, allowUnknown: true }
|
|
2904
2833
|
);
|
|
2905
2834
|
if (error) {
|
|
@@ -2910,7 +2839,9 @@ class Content {
|
|
|
2910
2839
|
const {
|
|
2911
2840
|
error: warrning,
|
|
2912
2841
|
} = ContentPlatformApplicationValidator.getInjectableTags().validate(
|
|
2913
|
-
{
|
|
2842
|
+
{
|
|
2843
|
+
all,
|
|
2844
|
+
},
|
|
2914
2845
|
{ abortEarly: false, allowUnknown: false }
|
|
2915
2846
|
);
|
|
2916
2847
|
if (warrning) {
|
|
@@ -2921,6 +2852,7 @@ class Content {
|
|
|
2921
2852
|
}
|
|
2922
2853
|
|
|
2923
2854
|
const query_params = {};
|
|
2855
|
+
query_params["all"] = all;
|
|
2924
2856
|
|
|
2925
2857
|
const response = await PlatformAPIClient.execute(
|
|
2926
2858
|
this.config,
|
|
@@ -4815,8 +4747,8 @@ class Content {
|
|
|
4815
4747
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4816
4748
|
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
4817
4749
|
* @name updateInjectableTag
|
|
4818
|
-
* @summary: Update
|
|
4819
|
-
* @description: Use this API to edit
|
|
4750
|
+
* @summary: Update the exisitng tags for an application by replacing with provided tags
|
|
4751
|
+
* @description: Use this API to edit and override all existing tags. All existing tags will be replaced by the new tags provided in body. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateInjectableTag/).
|
|
4820
4752
|
*/
|
|
4821
4753
|
async updateInjectableTag(
|
|
4822
4754
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -48,7 +48,6 @@ export = ContentPlatformApplicationValidator;
|
|
|
48
48
|
* @typedef CreateSlideshowParam
|
|
49
49
|
* @property {ContentPlatformModel.SlideshowRequest} body
|
|
50
50
|
*/
|
|
51
|
-
/** @typedef DeleteAllInjectableTagsParam */
|
|
52
51
|
/**
|
|
53
52
|
* @typedef DeleteAnnouncementParam
|
|
54
53
|
* @property {string} announcementId - ID allotted to the announcement.
|
|
@@ -156,7 +155,10 @@ export = ContentPlatformApplicationValidator;
|
|
|
156
155
|
* Slug is a short, human-readable, URL-friendly identifier of an object. You
|
|
157
156
|
* can get slug value of an FAQ category from `getFaqCategories` API.
|
|
158
157
|
*/
|
|
159
|
-
/**
|
|
158
|
+
/**
|
|
159
|
+
* @typedef GetInjectableTagsParam
|
|
160
|
+
* @property {boolean} [all] - Get all tags irrespective of the creator of tags
|
|
161
|
+
*/
|
|
160
162
|
/**
|
|
161
163
|
* @typedef GetLandingPagesParam
|
|
162
164
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
@@ -335,8 +337,6 @@ declare class ContentPlatformApplicationValidator {
|
|
|
335
337
|
static createPagePreview(): CreatePagePreviewParam;
|
|
336
338
|
/** @returns {CreateSlideshowParam} */
|
|
337
339
|
static createSlideshow(): CreateSlideshowParam;
|
|
338
|
-
/** @returns {DeleteAllInjectableTagsParam} */
|
|
339
|
-
static deleteAllInjectableTags(): any;
|
|
340
340
|
/** @returns {DeleteAnnouncementParam} */
|
|
341
341
|
static deleteAnnouncement(): DeleteAnnouncementParam;
|
|
342
342
|
/** @returns {DeleteBlogParam} */
|
|
@@ -386,7 +386,7 @@ declare class ContentPlatformApplicationValidator {
|
|
|
386
386
|
/** @returns {GetFaqsByCategoryIdOrSlugParam} */
|
|
387
387
|
static getFaqsByCategoryIdOrSlug(): GetFaqsByCategoryIdOrSlugParam;
|
|
388
388
|
/** @returns {GetInjectableTagsParam} */
|
|
389
|
-
static getInjectableTags():
|
|
389
|
+
static getInjectableTags(): GetInjectableTagsParam;
|
|
390
390
|
/** @returns {GetLandingPagesParam} */
|
|
391
391
|
static getLandingPages(): GetLandingPagesParam;
|
|
392
392
|
/** @returns {GetLegalInformationParam} */
|
|
@@ -453,7 +453,7 @@ declare class ContentPlatformApplicationValidator {
|
|
|
453
453
|
static updateSupportInformation(): UpdateSupportInformationParam;
|
|
454
454
|
}
|
|
455
455
|
declare namespace ContentPlatformApplicationValidator {
|
|
456
|
-
export { AddDataLoaderParam, AddFaqParam, AddInjectableTagParam, AddPathRedirectionRulesParam, CreateAnnouncementParam, CreateBlogParam, CreateFaqCategoryParam, CreateLandingPageParam, CreateNavigationParam, CreatePageParam, CreatePagePreviewParam, CreateSlideshowParam,
|
|
456
|
+
export { AddDataLoaderParam, AddFaqParam, AddInjectableTagParam, AddPathRedirectionRulesParam, CreateAnnouncementParam, CreateBlogParam, CreateFaqCategoryParam, CreateLandingPageParam, CreateNavigationParam, CreatePageParam, CreatePagePreviewParam, CreateSlideshowParam, DeleteAnnouncementParam, DeleteBlogParam, DeleteDataLoaderParam, DeleteFaqParam, DeleteFaqCategoryParam, DeleteLandingPageParam, DeleteNavigationParam, DeletePageParam, DeletePathRedirectionRulesParam, DeleteSlideshowParam, EditDataLoaderParam, EditInjectableTagParam, GenerateSEOTitleParam, GetAnnouncementByIdParam, GetAnnouncementsListParam, GetBlogBySlugParam, GetBlogsParam, GetComponentByIdParam, GetDataLoadersParam, GetDefaultNavigationsParam, GetFaqByIdOrSlugParam, GetFaqCategoriesParam, GetFaqCategoryBySlugOrIdParam, GetFaqsByCategoryIdOrSlugParam, GetInjectableTagsParam, GetLandingPagesParam, GetLegalInformationParam, GetNavigationBySlugParam, GetNavigationsParam, GetPageBySlugParam, GetPageMetaParam, GetPageSpecParam, GetPagesParam, GetPathRedirectionRuleParam, GetPathRedirectionRulesParam, GetSEOConfigurationParam, GetSlideshowBySlugParam, GetSlideshowsParam, GetSupportInformationParam, RemoveInjectableTagParam, ResetDataLoaderParam, SelectDataLoaderParam, UpdateAnnouncementParam, UpdateAnnouncementScheduleParam, UpdateBlogParam, UpdateFaqParam, UpdateFaqCategoryParam, UpdateInjectableTagParam, UpdateLandingPageParam, UpdateLegalInformationParam, UpdateNavigationParam, UpdatePageParam, UpdatePagePreviewParam, UpdatePathRedirectionRulesParam, UpdateSEOConfigurationParam, UpdateSlideshowParam, UpdateSupportInformationParam };
|
|
457
457
|
}
|
|
458
458
|
type AddDataLoaderParam = {
|
|
459
459
|
body: ContentPlatformModel.DataLoaderSchema;
|
|
@@ -650,6 +650,12 @@ type GetFaqsByCategoryIdOrSlugParam = {
|
|
|
650
650
|
*/
|
|
651
651
|
idOrSlug: string;
|
|
652
652
|
};
|
|
653
|
+
type GetInjectableTagsParam = {
|
|
654
|
+
/**
|
|
655
|
+
* - Get all tags irrespective of the creator of tags
|
|
656
|
+
*/
|
|
657
|
+
all?: boolean;
|
|
658
|
+
};
|
|
653
659
|
type GetLandingPagesParam = {
|
|
654
660
|
/**
|
|
655
661
|
* - The page number to navigate through the given
|
|
@@ -870,11 +876,9 @@ type UpdateSlideshowParam = {
|
|
|
870
876
|
type UpdateSupportInformationParam = {
|
|
871
877
|
body: ContentPlatformModel.Support;
|
|
872
878
|
};
|
|
873
|
-
type DeleteAllInjectableTagsParam = any;
|
|
874
879
|
type GetDataLoadersParam = any;
|
|
875
880
|
type GetDefaultNavigationsParam = any;
|
|
876
881
|
type GetFaqCategoriesParam = any;
|
|
877
|
-
type GetInjectableTagsParam = any;
|
|
878
882
|
type GetLegalInformationParam = any;
|
|
879
883
|
type GetPageMetaParam = any;
|
|
880
884
|
type GetPageSpecParam = any;
|
|
@@ -63,8 +63,6 @@ const ContentPlatformModel = require("./ContentPlatformModel");
|
|
|
63
63
|
* @property {ContentPlatformModel.SlideshowRequest} body
|
|
64
64
|
*/
|
|
65
65
|
|
|
66
|
-
/** @typedef DeleteAllInjectableTagsParam */
|
|
67
|
-
|
|
68
66
|
/**
|
|
69
67
|
* @typedef DeleteAnnouncementParam
|
|
70
68
|
* @property {string} announcementId - ID allotted to the announcement.
|
|
@@ -196,7 +194,10 @@ const ContentPlatformModel = require("./ContentPlatformModel");
|
|
|
196
194
|
* can get slug value of an FAQ category from `getFaqCategories` API.
|
|
197
195
|
*/
|
|
198
196
|
|
|
199
|
-
/**
|
|
197
|
+
/**
|
|
198
|
+
* @typedef GetInjectableTagsParam
|
|
199
|
+
* @property {boolean} [all] - Get all tags irrespective of the creator of tags
|
|
200
|
+
*/
|
|
200
201
|
|
|
201
202
|
/**
|
|
202
203
|
* @typedef GetLandingPagesParam
|
|
@@ -469,11 +470,6 @@ class ContentPlatformApplicationValidator {
|
|
|
469
470
|
}).required();
|
|
470
471
|
}
|
|
471
472
|
|
|
472
|
-
/** @returns {DeleteAllInjectableTagsParam} */
|
|
473
|
-
static deleteAllInjectableTags() {
|
|
474
|
-
return Joi.object({}).required();
|
|
475
|
-
}
|
|
476
|
-
|
|
477
473
|
/** @returns {DeleteAnnouncementParam} */
|
|
478
474
|
static deleteAnnouncement() {
|
|
479
475
|
return Joi.object({
|
|
@@ -644,7 +640,9 @@ class ContentPlatformApplicationValidator {
|
|
|
644
640
|
|
|
645
641
|
/** @returns {GetInjectableTagsParam} */
|
|
646
642
|
static getInjectableTags() {
|
|
647
|
-
return Joi.object({
|
|
643
|
+
return Joi.object({
|
|
644
|
+
all: Joi.boolean(),
|
|
645
|
+
}).required();
|
|
648
646
|
}
|
|
649
647
|
|
|
650
648
|
/** @returns {GetLandingPagesParam} */
|
|
@@ -37,12 +37,12 @@ declare class FileStorage {
|
|
|
37
37
|
* @param {FileStoragePlatformApplicationValidator.AppCopyFilesParam} arg - Arg object
|
|
38
38
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
39
39
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
40
|
-
* @returns {Promise<
|
|
40
|
+
* @returns {Promise<Object>} - Success response
|
|
41
41
|
* @name appCopyFiles
|
|
42
42
|
* @summary: Copy Files
|
|
43
43
|
* @description: Copy Files - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCopyFiles/).
|
|
44
44
|
*/
|
|
45
|
-
appCopyFiles({ body, sync, requestHeaders }?: FileStoragePlatformApplicationValidator.AppCopyFilesParam, { responseHeaders }?: object): Promise<
|
|
45
|
+
appCopyFiles({ body, sync, requestHeaders }?: FileStoragePlatformApplicationValidator.AppCopyFilesParam, { responseHeaders }?: object): Promise<any>;
|
|
46
46
|
/**
|
|
47
47
|
* @param {FileStoragePlatformApplicationValidator.AppStartUploadParam} arg
|
|
48
48
|
* - Arg object
|
|
@@ -77,89 +77,99 @@ declare class FileStorage {
|
|
|
77
77
|
* @param {FileStoragePlatformApplicationValidator.AppbrowseParam} arg - Arg object
|
|
78
78
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
79
79
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
80
|
-
* @returns {Promise<
|
|
80
|
+
* @returns {Promise<Object>} - Success response
|
|
81
81
|
* @name appbrowse
|
|
82
82
|
* @summary: Browse Files
|
|
83
83
|
* @description: Browse Files - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appbrowse/).
|
|
84
84
|
*/
|
|
85
|
-
appbrowse({ namespace, page, limit, requestHeaders }?: FileStoragePlatformApplicationValidator.AppbrowseParam, { responseHeaders }?: object): Promise<
|
|
85
|
+
appbrowse({ namespace, page, limit, requestHeaders }?: FileStoragePlatformApplicationValidator.AppbrowseParam, { responseHeaders }?: object): Promise<any>;
|
|
86
|
+
/**
|
|
87
|
+
* @param {FileStoragePlatformApplicationValidator.GeneratePaymentReceiptParam} arg
|
|
88
|
+
* - Arg object
|
|
89
|
+
*
|
|
90
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
91
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
92
|
+
* @returns {Promise<Object>} - Success response
|
|
93
|
+
* @name generatePaymentReceipt
|
|
94
|
+
* @summary: Generate Payment Receipt for Jiomart Digital
|
|
95
|
+
* @description: Generate Payment Receipt for Jiomart Digital - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/generatePaymentReceipt/).
|
|
96
|
+
*/
|
|
97
|
+
generatePaymentReceipt({ body, requestHeaders }?: FileStoragePlatformApplicationValidator.GeneratePaymentReceiptParam, { responseHeaders }?: object): Promise<any>;
|
|
86
98
|
/**
|
|
87
99
|
* @param {FileStoragePlatformApplicationValidator.GetDefaultHtmlTemplateParam} arg
|
|
88
100
|
* - Arg object
|
|
89
101
|
*
|
|
90
102
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
91
103
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
92
|
-
* @returns {Promise<FileStoragePlatformModel.PdfConfigSuccess
|
|
104
|
+
* @returns {Promise<FileStoragePlatformModel.PdfConfigSuccess>} - Success response
|
|
93
105
|
* @name getDefaultHtmlTemplate
|
|
94
106
|
* @summary: Get html template for sales channel
|
|
95
107
|
* @description: Get default html template for invoice or label - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultHtmlTemplate/).
|
|
96
108
|
*/
|
|
97
|
-
getDefaultHtmlTemplate({ pdfTypeId, format, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultHtmlTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfConfigSuccess
|
|
109
|
+
getDefaultHtmlTemplate({ pdfTypeId, format, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultHtmlTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfConfigSuccess>;
|
|
98
110
|
/**
|
|
99
111
|
* @param {FileStoragePlatformApplicationValidator.GetDefaultPdfDataParam} arg
|
|
100
112
|
* - Arg object
|
|
101
113
|
*
|
|
102
114
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
103
115
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
104
|
-
* @returns {Promise<FileStoragePlatformModel.DummyTemplateDataItems
|
|
116
|
+
* @returns {Promise<FileStoragePlatformModel.DummyTemplateDataItems>} -
|
|
105
117
|
* Success response
|
|
106
118
|
* @name getDefaultPdfData
|
|
107
119
|
* @summary: Get Dummy pdf data for invoice or label
|
|
108
120
|
* @description: Get Dummy pdf data for invoice or label - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfData/).
|
|
109
121
|
*/
|
|
110
|
-
getDefaultPdfData({ pdfTypeId, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultPdfDataParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.DummyTemplateDataItems
|
|
122
|
+
getDefaultPdfData({ pdfTypeId, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultPdfDataParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.DummyTemplateDataItems>;
|
|
111
123
|
/**
|
|
112
124
|
* @param {FileStoragePlatformApplicationValidator.GetDefaultPdfTemplateParam} arg
|
|
113
125
|
* - Arg object
|
|
114
126
|
*
|
|
115
127
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
116
128
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
117
|
-
* @returns {Promise<
|
|
118
|
-
*
|
|
119
|
-
* >}
|
|
120
|
-
* - Success response
|
|
121
|
-
*
|
|
129
|
+
* @returns {Promise<FileStoragePlatformModel.PdfDefaultTemplateSuccess>} -
|
|
130
|
+
* Success response
|
|
122
131
|
* @name getDefaultPdfTemplate
|
|
123
132
|
* @summary: Default html template
|
|
124
133
|
* @description: Get default html template data for invoice or label - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfTemplate/).
|
|
125
134
|
*/
|
|
126
|
-
getDefaultPdfTemplate({ pdfTypeId, format, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultPdfTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfDefaultTemplateSuccess
|
|
135
|
+
getDefaultPdfTemplate({ pdfTypeId, format, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultPdfTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfDefaultTemplateSuccess>;
|
|
127
136
|
/**
|
|
128
137
|
* @param {FileStoragePlatformApplicationValidator.GetPdfTypesParam} arg - Arg object
|
|
129
138
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
130
139
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
131
|
-
* @returns {Promise<FileStoragePlatformModel.InvoiceTypesResponse
|
|
140
|
+
* @returns {Promise<FileStoragePlatformModel.InvoiceTypesResponse>} -
|
|
132
141
|
* Success response
|
|
133
142
|
* @name getPdfTypes
|
|
134
143
|
* @summary: Get all the supported invoice pdf types
|
|
135
144
|
* @description: Get all the supported invoice pdf types such as Invoice, Label, Deliver challan - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getPdfTypes/).
|
|
136
145
|
*/
|
|
137
|
-
getPdfTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<FileStoragePlatformModel.InvoiceTypesResponse
|
|
146
|
+
getPdfTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<FileStoragePlatformModel.InvoiceTypesResponse>;
|
|
138
147
|
/**
|
|
139
|
-
* @param {FileStoragePlatformApplicationValidator.
|
|
148
|
+
* @param {FileStoragePlatformApplicationValidator.SaveHtmlTemplateParam} arg
|
|
140
149
|
* - Arg object
|
|
141
150
|
*
|
|
142
151
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
143
152
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
144
|
-
* @returns {Promise<
|
|
145
|
-
*
|
|
146
|
-
* @
|
|
147
|
-
* @
|
|
153
|
+
* @returns {Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>} -
|
|
154
|
+
* Success response
|
|
155
|
+
* @name saveHtmlTemplate
|
|
156
|
+
* @summary: Update html template for invoice or label
|
|
157
|
+
* @description: Update html template for invoice such as Invoice, Label, Deliver challan - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/saveHtmlTemplate/).
|
|
148
158
|
*/
|
|
149
|
-
|
|
159
|
+
saveHtmlTemplate({ body, requestHeaders }?: FileStoragePlatformApplicationValidator.SaveHtmlTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>;
|
|
150
160
|
/**
|
|
151
|
-
* @param {FileStoragePlatformApplicationValidator.
|
|
161
|
+
* @param {FileStoragePlatformApplicationValidator.UpdateHtmlTemplateParam} arg
|
|
152
162
|
* - Arg object
|
|
153
163
|
*
|
|
154
164
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
155
165
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
156
|
-
* @returns {Promise<FileStoragePlatformModel.PdfConfigSaveSuccess
|
|
166
|
+
* @returns {Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>} -
|
|
157
167
|
* Success response
|
|
158
|
-
* @name
|
|
168
|
+
* @name updateHtmlTemplate
|
|
159
169
|
* @summary: Update html template for invoice or label
|
|
160
|
-
* @description: Update html template for invoice such as Invoice, Label, Deliver challan - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/
|
|
170
|
+
* @description: Update html template for invoice such as Invoice, Label, Deliver challan - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/updateHtmlTemplate/).
|
|
161
171
|
*/
|
|
162
|
-
|
|
172
|
+
updateHtmlTemplate({ id, body, requestHeaders }?: FileStoragePlatformApplicationValidator.UpdateHtmlTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>;
|
|
163
173
|
/**
|
|
164
174
|
* @param data
|
|
165
175
|
* @param {string} file_name
|