@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.1.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +14 -14
- package/sdk/application/Cart/CartApplicationClient.js +14 -14
- package/sdk/application/Content/ContentApplicationClient.d.ts +10 -0
- package/sdk/application/Content/ContentApplicationClient.js +53 -0
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +136 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -12
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +46 -33
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +41 -25
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +6 -397
- package/sdk/platform/Billing/BillingPlatformClient.js +77 -3215
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +417 -3811
- package/sdk/platform/Billing/BillingPlatformModel.js +292 -2544
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +12 -451
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -483
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +34 -34
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +34 -34
- package/sdk/platform/Cart/CartPlatformModel.d.ts +363 -29
- package/sdk/platform/Cart/CartPlatformModel.js +203 -31
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +220 -200
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +121 -91
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +58 -46
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +10 -51
- package/sdk/platform/Catalog/CatalogPlatformClient.js +79 -400
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +22 -228
- package/sdk/platform/Catalog/CatalogPlatformModel.js +12 -163
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -61
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -65
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +4 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +10 -14
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +94 -30
- package/sdk/platform/Communication/CommunicationPlatformModel.js +110 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +33 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +62 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +11 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +5 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +12 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +12 -10
- package/sdk/platform/Content/ContentPlatformModel.d.ts +42 -12
- package/sdk/platform/Content/ContentPlatformModel.js +43 -13
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +28 -28
- package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
- package/sdk/platform/Order/OrderPlatformClient.d.ts +21 -21
- package/sdk/platform/Order/OrderPlatformClient.js +21 -21
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1010 -80
- package/sdk/platform/Order/OrderPlatformModel.js +665 -70
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +31 -4
- package/sdk/platform/Payment/PaymentPlatformModel.js +11 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +14 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +6 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +24 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +119 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +194 -23
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +116 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +23 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +16 -0
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +10 -12
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +45 -49
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +10 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +12 -12
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -56
- package/sdk/public/Billing/BillingPublicClient.js +0 -397
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -919
- package/sdk/public/Billing/BillingPublicModel.js +0 -560
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -43
- package/sdk/public/Billing/BillingPublicValidator.js +0 -50
|
@@ -57,6 +57,10 @@ const CompanyProfilePlatformModel = require("./CompanyProfilePlatformModel");
|
|
|
57
57
|
* @typedef GetLocationsParam
|
|
58
58
|
* @property {string} [storeType] - Helps to sort the location list on the basis
|
|
59
59
|
* of location type.
|
|
60
|
+
* @property {string[]} [storeCodes] - List of up to 50 store codes to fetch.
|
|
61
|
+
* Specify multiple values by repeating the query parameter (e.g.,
|
|
62
|
+
* `?store_codes=high_street&store_codes=main_avenue`). Comma-separated values
|
|
63
|
+
* are not supported.
|
|
60
64
|
* @property {string} [q] - Query that is to be searched.
|
|
61
65
|
* @property {string} [stage] - To filter companies on basis of verified or
|
|
62
66
|
* unverified companies.
|
|
@@ -161,6 +165,7 @@ class CompanyProfilePlatformValidator {
|
|
|
161
165
|
static getLocations() {
|
|
162
166
|
return Joi.object({
|
|
163
167
|
storeType: Joi.string().allow(""),
|
|
168
|
+
storeCodes: Joi.array().items(Joi.string().allow("")),
|
|
164
169
|
q: Joi.string().allow(""),
|
|
165
170
|
stage: Joi.string().allow(""),
|
|
166
171
|
pageNo: Joi.number(),
|
|
@@ -984,6 +984,7 @@ export = ConfigurationPlatformModel;
|
|
|
984
984
|
*/
|
|
985
985
|
/**
|
|
986
986
|
* @typedef GoogleMap
|
|
987
|
+
* @property {boolean} [enabled] - Shows whether Google map integration is enabled or not.
|
|
987
988
|
* @property {GoogleMapCredentials} [credentials]
|
|
988
989
|
*/
|
|
989
990
|
/**
|
|
@@ -1193,7 +1194,7 @@ export = ConfigurationPlatformModel;
|
|
|
1193
1194
|
* @property {number} [decimal_digits] - Acceptable decimal limits for a given
|
|
1194
1195
|
* currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
|
|
1195
1196
|
* value of a currency.
|
|
1196
|
-
* @property {string} [symbol] - Unique symbol for identifying the currency, e.g.
|
|
1197
|
+
* @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹
|
|
1197
1198
|
* @property {string} [country_name]
|
|
1198
1199
|
* @property {string} [country_code]
|
|
1199
1200
|
*/
|
|
@@ -1523,6 +1524,7 @@ export = ConfigurationPlatformModel;
|
|
|
1523
1524
|
* @property {string} [sector] - Sector for the opted store.
|
|
1524
1525
|
* @property {string} [country_code] - Country code of the selected country
|
|
1525
1526
|
* @property {string} [state_code] - Selected state code
|
|
1527
|
+
* @property {string} [landmark] - Landmark of the address
|
|
1526
1528
|
*/
|
|
1527
1529
|
/**
|
|
1528
1530
|
* @typedef OrderingStore
|
|
@@ -3631,6 +3633,10 @@ type FyndRewardsCredentials = {
|
|
|
3631
3633
|
/** @returns {GoogleMap} */
|
|
3632
3634
|
declare function GoogleMap(): GoogleMap;
|
|
3633
3635
|
type GoogleMap = {
|
|
3636
|
+
/**
|
|
3637
|
+
* - Shows whether Google map integration is enabled or not.
|
|
3638
|
+
*/
|
|
3639
|
+
enabled?: boolean;
|
|
3634
3640
|
credentials?: GoogleMapCredentials;
|
|
3635
3641
|
};
|
|
3636
3642
|
/** @returns {GoogleMapCredentials} */
|
|
@@ -4034,7 +4040,7 @@ type Currency = {
|
|
|
4034
4040
|
*/
|
|
4035
4041
|
decimal_digits?: number;
|
|
4036
4042
|
/**
|
|
4037
|
-
* - Unique symbol for identifying the currency, e.g.
|
|
4043
|
+
* - Unique symbol for identifying the currency, e.g. ₹
|
|
4038
4044
|
*/
|
|
4039
4045
|
symbol?: string;
|
|
4040
4046
|
country_name?: string;
|
|
@@ -4750,6 +4756,10 @@ type OptedStoreAddress = {
|
|
|
4750
4756
|
* - Selected state code
|
|
4751
4757
|
*/
|
|
4752
4758
|
state_code?: string;
|
|
4759
|
+
/**
|
|
4760
|
+
* - Landmark of the address
|
|
4761
|
+
*/
|
|
4762
|
+
landmark?: string;
|
|
4753
4763
|
};
|
|
4754
4764
|
/** @returns {OrderingStore} */
|
|
4755
4765
|
declare function OrderingStore(): OrderingStore;
|
|
@@ -1109,6 +1109,7 @@ const Joi = require("joi");
|
|
|
1109
1109
|
|
|
1110
1110
|
/**
|
|
1111
1111
|
* @typedef GoogleMap
|
|
1112
|
+
* @property {boolean} [enabled] - Shows whether Google map integration is enabled or not.
|
|
1112
1113
|
* @property {GoogleMapCredentials} [credentials]
|
|
1113
1114
|
*/
|
|
1114
1115
|
|
|
@@ -1346,7 +1347,7 @@ const Joi = require("joi");
|
|
|
1346
1347
|
* @property {number} [decimal_digits] - Acceptable decimal limits for a given
|
|
1347
1348
|
* currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
|
|
1348
1349
|
* value of a currency.
|
|
1349
|
-
* @property {string} [symbol] - Unique symbol for identifying the currency, e.g.
|
|
1350
|
+
* @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹
|
|
1350
1351
|
* @property {string} [country_name]
|
|
1351
1352
|
* @property {string} [country_code]
|
|
1352
1353
|
*/
|
|
@@ -1718,6 +1719,7 @@ const Joi = require("joi");
|
|
|
1718
1719
|
* @property {string} [sector] - Sector for the opted store.
|
|
1719
1720
|
* @property {string} [country_code] - Country code of the selected country
|
|
1720
1721
|
* @property {string} [state_code] - Selected state code
|
|
1722
|
+
* @property {string} [landmark] - Landmark of the address
|
|
1721
1723
|
*/
|
|
1722
1724
|
|
|
1723
1725
|
/**
|
|
@@ -3102,6 +3104,7 @@ class ConfigurationPlatformModel {
|
|
|
3102
3104
|
/** @returns {GoogleMap} */
|
|
3103
3105
|
static GoogleMap() {
|
|
3104
3106
|
return Joi.object({
|
|
3107
|
+
enabled: Joi.boolean(),
|
|
3105
3108
|
credentials: ConfigurationPlatformModel.GoogleMapCredentials(),
|
|
3106
3109
|
});
|
|
3107
3110
|
}
|
|
@@ -3788,6 +3791,7 @@ class ConfigurationPlatformModel {
|
|
|
3788
3791
|
sector: Joi.string().allow(""),
|
|
3789
3792
|
country_code: Joi.string().allow(""),
|
|
3790
3793
|
state_code: Joi.string().allow(""),
|
|
3794
|
+
landmark: Joi.string().allow(""),
|
|
3791
3795
|
});
|
|
3792
3796
|
}
|
|
3793
3797
|
|
|
@@ -93,12 +93,13 @@ declare class Content {
|
|
|
93
93
|
*
|
|
94
94
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
95
95
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
|
-
* @returns {Promise<ContentPlatformModel.
|
|
96
|
+
* @returns {Promise<ContentPlatformModel.CustomObjectApplicationSchema>} -
|
|
97
|
+
* Success response
|
|
97
98
|
* @name createAppCustomObject
|
|
98
99
|
* @summary: Create custom object entries
|
|
99
100
|
* @description: Custom object entries against the custom object definition can be added using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAppCustomObject/).
|
|
100
101
|
*/
|
|
101
|
-
createAppCustomObject({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAppCustomObjectParam, { responseHeaders }?: object): Promise<ContentPlatformModel.
|
|
102
|
+
createAppCustomObject({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAppCustomObjectParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectApplicationSchema>;
|
|
102
103
|
/**
|
|
103
104
|
* @param {ContentPlatformApplicationValidator.CreateAppCustomObjectDefinitionParam} arg
|
|
104
105
|
* - Arg object
|
|
@@ -1052,12 +1053,13 @@ declare class Content {
|
|
|
1052
1053
|
*
|
|
1053
1054
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1054
1055
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1055
|
-
* @returns {Promise<ContentPlatformModel.
|
|
1056
|
+
* @returns {Promise<ContentPlatformModel.CustomObjectApplicationSchema>} -
|
|
1057
|
+
* Success response
|
|
1056
1058
|
* @name updateAppCustomObject
|
|
1057
1059
|
* @summary: Update custom object details
|
|
1058
1060
|
* @description: Custom object entries can be updated using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAppCustomObject/).
|
|
1059
1061
|
*/
|
|
1060
|
-
updateAppCustomObject({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAppCustomObjectParam, { responseHeaders }?: object): Promise<ContentPlatformModel.
|
|
1062
|
+
updateAppCustomObject({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAppCustomObjectParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectApplicationSchema>;
|
|
1061
1063
|
/**
|
|
1062
1064
|
* @param {ContentPlatformApplicationValidator.UpdateAppCustomObjectDefinitionParam} arg
|
|
1063
1065
|
* - Arg object
|
|
@@ -592,7 +592,8 @@ class Content {
|
|
|
592
592
|
*
|
|
593
593
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
594
594
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
595
|
-
* @returns {Promise<ContentPlatformModel.
|
|
595
|
+
* @returns {Promise<ContentPlatformModel.CustomObjectApplicationSchema>} -
|
|
596
|
+
* Success response
|
|
596
597
|
* @name createAppCustomObject
|
|
597
598
|
* @summary: Create custom object entries
|
|
598
599
|
* @description: Custom object entries against the custom object definition can be added using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAppCustomObject/).
|
|
@@ -648,10 +649,10 @@ class Content {
|
|
|
648
649
|
|
|
649
650
|
const {
|
|
650
651
|
error: res_error,
|
|
651
|
-
} = ContentPlatformModel.
|
|
652
|
-
|
|
653
|
-
allowUnknown: true
|
|
654
|
-
|
|
652
|
+
} = ContentPlatformModel.CustomObjectApplicationSchema().validate(
|
|
653
|
+
responseData,
|
|
654
|
+
{ abortEarly: false, allowUnknown: true }
|
|
655
|
+
);
|
|
655
656
|
|
|
656
657
|
if (res_error) {
|
|
657
658
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -7161,7 +7162,8 @@ class Content {
|
|
|
7161
7162
|
*
|
|
7162
7163
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
7163
7164
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
7164
|
-
* @returns {Promise<ContentPlatformModel.
|
|
7165
|
+
* @returns {Promise<ContentPlatformModel.CustomObjectApplicationSchema>} -
|
|
7166
|
+
* Success response
|
|
7165
7167
|
* @name updateAppCustomObject
|
|
7166
7168
|
* @summary: Update custom object details
|
|
7167
7169
|
* @description: Custom object entries can be updated using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAppCustomObject/).
|
|
@@ -7219,10 +7221,10 @@ class Content {
|
|
|
7219
7221
|
|
|
7220
7222
|
const {
|
|
7221
7223
|
error: res_error,
|
|
7222
|
-
} = ContentPlatformModel.
|
|
7223
|
-
|
|
7224
|
-
allowUnknown: true
|
|
7225
|
-
|
|
7224
|
+
} = ContentPlatformModel.CustomObjectApplicationSchema().validate(
|
|
7225
|
+
responseData,
|
|
7226
|
+
{ abortEarly: false, allowUnknown: true }
|
|
7227
|
+
);
|
|
7226
7228
|
|
|
7227
7229
|
if (res_error) {
|
|
7228
7230
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -966,17 +966,32 @@ export = ContentPlatformModel;
|
|
|
966
966
|
* @typedef CustomFieldsResponseByResourceIdSchema
|
|
967
967
|
* @property {CustomFieldSchema[]} [items]
|
|
968
968
|
*/
|
|
969
|
-
/**
|
|
970
|
-
* @typedef CustomField
|
|
971
|
-
* @property {string} [definition_id]
|
|
972
|
-
*/
|
|
973
969
|
/**
|
|
974
970
|
* @typedef CustomFieldRequestSchema
|
|
975
|
-
* @property {
|
|
971
|
+
* @property {Object[]} [fields]
|
|
976
972
|
*/
|
|
977
973
|
/**
|
|
978
974
|
* @typedef CustomObjectSchema
|
|
979
975
|
* @property {string} [_id]
|
|
976
|
+
* @property {string} [name]
|
|
977
|
+
* @property {string} [creator]
|
|
978
|
+
* @property {string} [company_id]
|
|
979
|
+
* @property {string} [created_by]
|
|
980
|
+
* @property {string} [updated_by]
|
|
981
|
+
* @property {string} [status]
|
|
982
|
+
* @property {string} [slug]
|
|
983
|
+
* @property {string} [type]
|
|
984
|
+
* @property {string} [display_name]
|
|
985
|
+
* @property {string} [definition_id]
|
|
986
|
+
* @property {boolean} [is_deleted]
|
|
987
|
+
* @property {string} [created_at]
|
|
988
|
+
* @property {string} [updated_at]
|
|
989
|
+
* @property {CustomFieldSchema[]} [fields]
|
|
990
|
+
*/
|
|
991
|
+
/**
|
|
992
|
+
* @typedef CustomObjectApplicationSchema
|
|
993
|
+
* @property {string} [_id]
|
|
994
|
+
* @property {string} [name]
|
|
980
995
|
* @property {string} [creator]
|
|
981
996
|
* @property {string} [company_id]
|
|
982
997
|
* @property {string} [application_id]
|
|
@@ -1370,7 +1385,7 @@ export = ContentPlatformModel;
|
|
|
1370
1385
|
declare class ContentPlatformModel {
|
|
1371
1386
|
}
|
|
1372
1387
|
declare namespace ContentPlatformModel {
|
|
1373
|
-
export { GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, DeletPathMappingSchema, CreatePathMappingSchema, GetAllPathMappingSchema, GetPathSchema, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetResponse, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogRequest, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderItemsResponseSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, AssignmentReference, CronBasedScheduleSchema, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, TagSpecSchema, ServerSchema, DataLoadersApiSpecSchema, DataLoadersSchema, TagDeleteSuccessResponse, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetResponse, LandingPageSchema, DefaultNavigationResponse, NavigationGetResponse, Orientation, NavigationSchema, NavigationRequest, NavigationAssignment, PageGetResponse, PageSpec, PageSpecParam, PageSpecItem, PageResponseError, PageSchema, SanitizedContent, PageMeta, PageContent, CreatedBySchema, PageRequestVisibility, PageRequest, CronSchedule, PagePublishRequest, PageMetaSchema, CustomePages, SystemPagesActionPage, SystemPagesAction, SystemPages, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, ApplicationFieldDefinitionSchema, FieldDefinitionSchema, ApplicationCustomFieldDefinitionsSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema,
|
|
1388
|
+
export { GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, DeletPathMappingSchema, CreatePathMappingSchema, GetAllPathMappingSchema, GetPathSchema, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetResponse, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogRequest, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderItemsResponseSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, AssignmentReference, CronBasedScheduleSchema, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, TagSpecSchema, ServerSchema, DataLoadersApiSpecSchema, DataLoadersSchema, TagDeleteSuccessResponse, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetResponse, LandingPageSchema, DefaultNavigationResponse, NavigationGetResponse, Orientation, NavigationSchema, NavigationRequest, NavigationAssignment, PageGetResponse, PageSpec, PageSpecParam, PageSpecItem, PageResponseError, PageSchema, SanitizedContent, PageMeta, PageContent, CreatedBySchema, PageRequestVisibility, PageRequest, CronSchedule, PagePublishRequest, PageMetaSchema, CustomePages, SystemPagesActionPage, SystemPagesAction, SystemPages, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, ApplicationFieldDefinitionSchema, FieldDefinitionSchema, ApplicationCustomFieldDefinitionsSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectApplicationSchema, CustomObjectDefinitionRequestSchema, CustomObjectCustomFieldDefinitionResSchema, CustomObjectDefinitionSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadResponse, CustomObjectListItemDefinationSchema, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldSchema, MetafieldTypesSchema, CustomObjectByIdSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, CustomFieldTypeSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectRequestSchema, CustomObjectBulkSchema, ActionPage, PageType };
|
|
1374
1389
|
}
|
|
1375
1390
|
/** @returns {GenerateSEOContent} */
|
|
1376
1391
|
declare function GenerateSEOContent(): GenerateSEOContent;
|
|
@@ -2509,20 +2524,35 @@ declare function CustomFieldsResponseByResourceIdSchema(): CustomFieldsResponseB
|
|
|
2509
2524
|
type CustomFieldsResponseByResourceIdSchema = {
|
|
2510
2525
|
items?: CustomFieldSchema[];
|
|
2511
2526
|
};
|
|
2512
|
-
/** @returns {CustomField} */
|
|
2513
|
-
declare function CustomField(): CustomField;
|
|
2514
|
-
type CustomField = {
|
|
2515
|
-
definition_id?: string;
|
|
2516
|
-
};
|
|
2517
2527
|
/** @returns {CustomFieldRequestSchema} */
|
|
2518
2528
|
declare function CustomFieldRequestSchema(): CustomFieldRequestSchema;
|
|
2519
2529
|
type CustomFieldRequestSchema = {
|
|
2520
|
-
fields?:
|
|
2530
|
+
fields?: any[];
|
|
2521
2531
|
};
|
|
2522
2532
|
/** @returns {CustomObjectSchema} */
|
|
2523
2533
|
declare function CustomObjectSchema(): CustomObjectSchema;
|
|
2524
2534
|
type CustomObjectSchema = {
|
|
2525
2535
|
_id?: string;
|
|
2536
|
+
name?: string;
|
|
2537
|
+
creator?: string;
|
|
2538
|
+
company_id?: string;
|
|
2539
|
+
created_by?: string;
|
|
2540
|
+
updated_by?: string;
|
|
2541
|
+
status?: string;
|
|
2542
|
+
slug?: string;
|
|
2543
|
+
type?: string;
|
|
2544
|
+
display_name?: string;
|
|
2545
|
+
definition_id?: string;
|
|
2546
|
+
is_deleted?: boolean;
|
|
2547
|
+
created_at?: string;
|
|
2548
|
+
updated_at?: string;
|
|
2549
|
+
fields?: CustomFieldSchema[];
|
|
2550
|
+
};
|
|
2551
|
+
/** @returns {CustomObjectApplicationSchema} */
|
|
2552
|
+
declare function CustomObjectApplicationSchema(): CustomObjectApplicationSchema;
|
|
2553
|
+
type CustomObjectApplicationSchema = {
|
|
2554
|
+
_id?: string;
|
|
2555
|
+
name?: string;
|
|
2526
2556
|
creator?: string;
|
|
2527
2557
|
company_id?: string;
|
|
2528
2558
|
application_id?: string;
|
|
@@ -1099,18 +1099,33 @@ const Joi = require("joi");
|
|
|
1099
1099
|
*/
|
|
1100
1100
|
|
|
1101
1101
|
/**
|
|
1102
|
-
* @typedef
|
|
1103
|
-
* @property {
|
|
1102
|
+
* @typedef CustomFieldRequestSchema
|
|
1103
|
+
* @property {Object[]} [fields]
|
|
1104
1104
|
*/
|
|
1105
1105
|
|
|
1106
1106
|
/**
|
|
1107
|
-
* @typedef
|
|
1108
|
-
* @property {
|
|
1107
|
+
* @typedef CustomObjectSchema
|
|
1108
|
+
* @property {string} [_id]
|
|
1109
|
+
* @property {string} [name]
|
|
1110
|
+
* @property {string} [creator]
|
|
1111
|
+
* @property {string} [company_id]
|
|
1112
|
+
* @property {string} [created_by]
|
|
1113
|
+
* @property {string} [updated_by]
|
|
1114
|
+
* @property {string} [status]
|
|
1115
|
+
* @property {string} [slug]
|
|
1116
|
+
* @property {string} [type]
|
|
1117
|
+
* @property {string} [display_name]
|
|
1118
|
+
* @property {string} [definition_id]
|
|
1119
|
+
* @property {boolean} [is_deleted]
|
|
1120
|
+
* @property {string} [created_at]
|
|
1121
|
+
* @property {string} [updated_at]
|
|
1122
|
+
* @property {CustomFieldSchema[]} [fields]
|
|
1109
1123
|
*/
|
|
1110
1124
|
|
|
1111
1125
|
/**
|
|
1112
|
-
* @typedef
|
|
1126
|
+
* @typedef CustomObjectApplicationSchema
|
|
1113
1127
|
* @property {string} [_id]
|
|
1128
|
+
* @property {string} [name]
|
|
1114
1129
|
* @property {string} [creator]
|
|
1115
1130
|
* @property {string} [company_id]
|
|
1116
1131
|
* @property {string} [application_id]
|
|
@@ -2915,17 +2930,10 @@ class ContentPlatformModel {
|
|
|
2915
2930
|
});
|
|
2916
2931
|
}
|
|
2917
2932
|
|
|
2918
|
-
/** @returns {CustomField} */
|
|
2919
|
-
static CustomField() {
|
|
2920
|
-
return Joi.object({
|
|
2921
|
-
definition_id: Joi.string().allow(""),
|
|
2922
|
-
});
|
|
2923
|
-
}
|
|
2924
|
-
|
|
2925
2933
|
/** @returns {CustomFieldRequestSchema} */
|
|
2926
2934
|
static CustomFieldRequestSchema() {
|
|
2927
2935
|
return Joi.object({
|
|
2928
|
-
fields: Joi.array().items(
|
|
2936
|
+
fields: Joi.array().items(Joi.any()),
|
|
2929
2937
|
});
|
|
2930
2938
|
}
|
|
2931
2939
|
|
|
@@ -2933,6 +2941,28 @@ class ContentPlatformModel {
|
|
|
2933
2941
|
static CustomObjectSchema() {
|
|
2934
2942
|
return Joi.object({
|
|
2935
2943
|
_id: Joi.string().allow(""),
|
|
2944
|
+
name: Joi.string().allow(""),
|
|
2945
|
+
creator: Joi.string().allow(""),
|
|
2946
|
+
company_id: Joi.string().allow(""),
|
|
2947
|
+
created_by: Joi.string().allow(""),
|
|
2948
|
+
updated_by: Joi.string().allow(""),
|
|
2949
|
+
status: Joi.string().allow(""),
|
|
2950
|
+
slug: Joi.string().allow(""),
|
|
2951
|
+
type: Joi.string().allow(""),
|
|
2952
|
+
display_name: Joi.string().allow(""),
|
|
2953
|
+
definition_id: Joi.string().allow(""),
|
|
2954
|
+
is_deleted: Joi.boolean(),
|
|
2955
|
+
created_at: Joi.string().allow(""),
|
|
2956
|
+
updated_at: Joi.string().allow(""),
|
|
2957
|
+
fields: Joi.array().items(ContentPlatformModel.CustomFieldSchema()),
|
|
2958
|
+
});
|
|
2959
|
+
}
|
|
2960
|
+
|
|
2961
|
+
/** @returns {CustomObjectApplicationSchema} */
|
|
2962
|
+
static CustomObjectApplicationSchema() {
|
|
2963
|
+
return Joi.object({
|
|
2964
|
+
_id: Joi.string().allow(""),
|
|
2965
|
+
name: Joi.string().allow(""),
|
|
2936
2966
|
creator: Joi.string().allow(""),
|
|
2937
2967
|
company_id: Joi.string().allow(""),
|
|
2938
2968
|
application_id: Joi.string().allow(""),
|
|
@@ -9,7 +9,7 @@ declare class Finance {
|
|
|
9
9
|
* @returns {Promise<FinancePlatformModel.ChannelDisplayNameResponse>} -
|
|
10
10
|
* Success response
|
|
11
11
|
* @name channelDisplayName
|
|
12
|
-
* @summary: Get channel display name
|
|
12
|
+
* @summary: Get channel display name
|
|
13
13
|
* @description: Retrieve the display name for a channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/channelDisplayName/).
|
|
14
14
|
*/
|
|
15
15
|
channelDisplayName({ filterKey, requestHeaders }?: FinancePlatformValidator.ChannelDisplayNameParam, { responseHeaders }?: object): Promise<FinancePlatformModel.ChannelDisplayNameResponse>;
|
|
@@ -23,7 +23,7 @@ declare class Finance {
|
|
|
23
23
|
* - Success response
|
|
24
24
|
*
|
|
25
25
|
* @name createSellerCreditNoteConfig
|
|
26
|
-
* @summary: Create seller credit note config
|
|
26
|
+
* @summary: Create seller credit note config
|
|
27
27
|
* @description: Set up configuration for seller credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/createSellerCreditNoteConfig/).
|
|
28
28
|
*/
|
|
29
29
|
createSellerCreditNoteConfig({ body, requestHeaders }?: FinancePlatformValidator.CreateSellerCreditNoteConfigParam, { responseHeaders }?: object): Promise<FinancePlatformModel.CreateSellerCreditNoteConfigResponse>;
|
|
@@ -34,7 +34,7 @@ declare class Finance {
|
|
|
34
34
|
* @returns {Promise<FinancePlatformModel.CreditNoteDetailsResponse>} -
|
|
35
35
|
* Success response
|
|
36
36
|
* @name creditNoteDetails
|
|
37
|
-
* @summary: Get credit note details
|
|
37
|
+
* @summary: Get credit note details
|
|
38
38
|
* @description: Retrieve detailed information about a credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/creditNoteDetails/).
|
|
39
39
|
*/
|
|
40
40
|
creditNoteDetails({ body, requestHeaders }?: FinancePlatformValidator.CreditNoteDetailsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.CreditNoteDetailsResponse>;
|
|
@@ -46,7 +46,7 @@ declare class Finance {
|
|
|
46
46
|
* - Success response
|
|
47
47
|
*
|
|
48
48
|
* @name creditlineDataplatform
|
|
49
|
-
* @summary: Access credit line data platform
|
|
49
|
+
* @summary: Access credit line data platform
|
|
50
50
|
* @description: Connect to the credit line data platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/creditlineDataplatform/).
|
|
51
51
|
*/
|
|
52
52
|
creditlineDataplatform({ body, requestHeaders }?: FinancePlatformValidator.CreditlineDataplatformParam, { responseHeaders }?: object): Promise<FinancePlatformModel.CreditlineDataPlatformResponse>;
|
|
@@ -56,7 +56,7 @@ declare class Finance {
|
|
|
56
56
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
57
57
|
* @returns {Promise<FinancePlatformModel.DeleteConfigResponse>} - Success response
|
|
58
58
|
* @name deleteConfig
|
|
59
|
-
* @summary: Deletes credit note config
|
|
59
|
+
* @summary: Deletes credit note config
|
|
60
60
|
* @description: Deletes credit note config. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/deleteConfig/).
|
|
61
61
|
*/
|
|
62
62
|
deleteConfig({ body, requestHeaders }?: FinancePlatformValidator.DeleteConfigParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DeleteConfigResponse>;
|
|
@@ -68,7 +68,7 @@ declare class Finance {
|
|
|
68
68
|
* - Success response
|
|
69
69
|
*
|
|
70
70
|
* @name downloadCreditDebitNote
|
|
71
|
-
* @summary: Download credit/debit note
|
|
71
|
+
* @summary: Download credit/debit note
|
|
72
72
|
* @description: Retrieve and save credit/debit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadCreditDebitNote/).
|
|
73
73
|
*/
|
|
74
74
|
downloadCreditDebitNote({ body, requestHeaders }?: FinancePlatformValidator.DownloadCreditDebitNoteParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DownloadCreditDebitNoteResponse>;
|
|
@@ -78,7 +78,7 @@ declare class Finance {
|
|
|
78
78
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
79
79
|
* @returns {Promise<FinancePlatformModel.DownloadReportList>} - Success response
|
|
80
80
|
* @name downloadReport
|
|
81
|
-
* @summary: Download financial report
|
|
81
|
+
* @summary: Download financial report
|
|
82
82
|
* @description: Retrieve and save a financial report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadReport/).
|
|
83
83
|
*/
|
|
84
84
|
downloadReport({ body, requestHeaders }?: FinancePlatformValidator.DownloadReportParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DownloadReportList>;
|
|
@@ -90,7 +90,7 @@ declare class Finance {
|
|
|
90
90
|
* - Success response
|
|
91
91
|
*
|
|
92
92
|
* @name downloadReportCustomerCn
|
|
93
|
-
* @summary: Download customer credit note report
|
|
93
|
+
* @summary: Download customer credit note report
|
|
94
94
|
* @description: Retrieve and save a report for customer credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadReportCustomerCn/).
|
|
95
95
|
*/
|
|
96
96
|
downloadReportCustomerCn({ body, requestHeaders }?: FinancePlatformValidator.DownloadReportCustomerCnParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DownloadReportCustomerCnResponse>;
|
|
@@ -100,7 +100,7 @@ declare class Finance {
|
|
|
100
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
101
|
* @returns {Promise<FinancePlatformModel.GenerateReportJson>} - Success response
|
|
102
102
|
* @name generateReport
|
|
103
|
-
* @summary: Generate financial report
|
|
103
|
+
* @summary: Generate financial report
|
|
104
104
|
* @description: Create a financial report with relevant data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/generateReport/).
|
|
105
105
|
*/
|
|
106
106
|
generateReport({ body, requestHeaders }?: FinancePlatformValidator.GenerateReportParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GenerateReportJson>;
|
|
@@ -112,7 +112,7 @@ declare class Finance {
|
|
|
112
112
|
* - Success response
|
|
113
113
|
*
|
|
114
114
|
* @name generateReportCustomerCn
|
|
115
|
-
* @summary: Generate customer credit note report
|
|
115
|
+
* @summary: Generate customer credit note report
|
|
116
116
|
* @description: Create a report specifically for customer credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/generateReportCustomerCn/).
|
|
117
117
|
*/
|
|
118
118
|
generateReportCustomerCn({ body, requestHeaders }?: FinancePlatformValidator.GenerateReportCustomerCnParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GenerateReportCustomerCnResponse>;
|
|
@@ -122,7 +122,7 @@ declare class Finance {
|
|
|
122
122
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
123
123
|
* @returns {Promise<FinancePlatformModel.GetAffiliateResponse>} - Success response
|
|
124
124
|
* @name getAffiliate
|
|
125
|
-
* @summary: Get affiliate details
|
|
125
|
+
* @summary: Get affiliate details
|
|
126
126
|
* @description: Retrieve information about an affiliate. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getAffiliate/).
|
|
127
127
|
*/
|
|
128
128
|
getAffiliate({ body, requestHeaders }?: FinancePlatformValidator.GetAffiliateParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetAffiliateResponse>;
|
|
@@ -132,7 +132,7 @@ declare class Finance {
|
|
|
132
132
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
133
133
|
* @returns {Promise<FinancePlatformModel.GetCnConfigResponse>} - Success response
|
|
134
134
|
* @name getCnConfig
|
|
135
|
-
* @summary: Get credit note configuration
|
|
135
|
+
* @summary: Get credit note configuration
|
|
136
136
|
* @description: Retrieve configuration settings for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getCnConfig/).
|
|
137
137
|
*/
|
|
138
138
|
getCnConfig({ body, requestHeaders }?: FinancePlatformValidator.GetCnConfigParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetCnConfigResponse>;
|
|
@@ -144,7 +144,7 @@ declare class Finance {
|
|
|
144
144
|
* - Success response
|
|
145
145
|
*
|
|
146
146
|
* @name getCustomerCreditBalance
|
|
147
|
-
* @summary: Get customer credit balance
|
|
147
|
+
* @summary: Get customer credit balance
|
|
148
148
|
* @description: Retrieve the credit balance of a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getCustomerCreditBalance/).
|
|
149
149
|
*/
|
|
150
150
|
getCustomerCreditBalance({ body, requestHeaders }?: FinancePlatformValidator.GetCustomerCreditBalanceParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetCustomerCreditBalanceResponse>;
|
|
@@ -154,7 +154,7 @@ declare class Finance {
|
|
|
154
154
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
155
155
|
* @returns {Promise<FinancePlatformModel.GetEngineResponse>} - Success response
|
|
156
156
|
* @name getData
|
|
157
|
-
* @summary: Get financial data
|
|
157
|
+
* @summary: Get financial data
|
|
158
158
|
* @description: Retrieve financial data for analysis. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getData/).
|
|
159
159
|
*/
|
|
160
160
|
getData({ body, requestHeaders }?: FinancePlatformValidator.GetDataParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetEngineResponse>;
|
|
@@ -164,7 +164,7 @@ declare class Finance {
|
|
|
164
164
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
165
165
|
* @returns {Promise<FinancePlatformModel.GetPdfUrlViewResponse>} - Success response
|
|
166
166
|
* @name getPdfUrlView
|
|
167
|
-
* @summary: Get PDF URL view
|
|
167
|
+
* @summary: Get PDF URL view
|
|
168
168
|
* @description: Retrieve a URL to view a PDF document. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getPdfUrlView/).
|
|
169
169
|
*/
|
|
170
170
|
getPdfUrlView({ body, requestHeaders }?: FinancePlatformValidator.GetPdfUrlViewParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetPdfUrlViewResponse>;
|
|
@@ -174,7 +174,7 @@ declare class Finance {
|
|
|
174
174
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
175
175
|
* @returns {Promise<FinancePlatformModel.GetReasonResponse>} - Success response
|
|
176
176
|
* @name getReason
|
|
177
|
-
* @summary: Get transaction reason
|
|
177
|
+
* @summary: Get transaction reason
|
|
178
178
|
* @description: Retrieve the reason behind a transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReason/).
|
|
179
179
|
*/
|
|
180
180
|
getReason({ body, requestHeaders }?: FinancePlatformValidator.GetReasonParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReasonResponse>;
|
|
@@ -184,7 +184,7 @@ declare class Finance {
|
|
|
184
184
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
185
185
|
* @returns {Promise<FinancePlatformModel.GetReportListResponse>} - Success response
|
|
186
186
|
* @name getReportList
|
|
187
|
-
* @summary: Get report list
|
|
187
|
+
* @summary: Get report list
|
|
188
188
|
* @description: Retrieve a list of available financial reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReportList/).
|
|
189
189
|
*/
|
|
190
190
|
getReportList({ body, requestHeaders }?: FinancePlatformValidator.GetReportListParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReportListResponse>;
|
|
@@ -195,7 +195,7 @@ declare class Finance {
|
|
|
195
195
|
* @returns {Promise<FinancePlatformModel.GetReportingFiltersResponse>} -
|
|
196
196
|
* Success response
|
|
197
197
|
* @name getReportingFilters
|
|
198
|
-
* @summary: Get reporting filters
|
|
198
|
+
* @summary: Get reporting filters
|
|
199
199
|
* @description: Retrieve available filters for financial reporting. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReportingFilters/).
|
|
200
200
|
*/
|
|
201
201
|
getReportingFilters({ filterKey, affiliateId, requestHeaders }?: FinancePlatformValidator.GetReportingFiltersParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReportingFiltersResponse>;
|
|
@@ -206,7 +206,7 @@ declare class Finance {
|
|
|
206
206
|
* @returns {Promise<FinancePlatformModel.InvoiceActivityLogsResponse>} -
|
|
207
207
|
* Success response
|
|
208
208
|
* @name invoiceActivityLogs
|
|
209
|
-
* @summary: Display activity log details of an invoice
|
|
209
|
+
* @summary: Display activity log details of an invoice
|
|
210
210
|
* @description: Display activity log details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceActivityLogs/).
|
|
211
211
|
*/
|
|
212
212
|
invoiceActivityLogs({ invoiceNumber, requestHeaders }?: FinancePlatformValidator.InvoiceActivityLogsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceActivityLogsResponse>;
|
|
@@ -216,8 +216,8 @@ declare class Finance {
|
|
|
216
216
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
217
217
|
* @returns {Promise<FinancePlatformModel.InvoiceListingResponse>} - Success response
|
|
218
218
|
* @name invoiceListing
|
|
219
|
-
* @summary:
|
|
220
|
-
* @description:
|
|
219
|
+
* @summary: List invoices
|
|
220
|
+
* @description: Provides list of invoices generated for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceListing/).
|
|
221
221
|
*/
|
|
222
222
|
invoiceListing({ body, requestHeaders }?: FinancePlatformValidator.InvoiceListingParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceListingResponse>;
|
|
223
223
|
/**
|
|
@@ -226,7 +226,7 @@ declare class Finance {
|
|
|
226
226
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
227
227
|
* @returns {Promise<FinancePlatformModel.InvoicePdfResponse>} - Success response
|
|
228
228
|
* @name invoicePDF
|
|
229
|
-
* @summary: Get invoice PDF
|
|
229
|
+
* @summary: Get invoice PDF
|
|
230
230
|
* @description: Retrieve the PDF version of an invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePDF/).
|
|
231
231
|
*/
|
|
232
232
|
invoicePDF({ body, requestHeaders }?: FinancePlatformValidator.InvoicePDFParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePdfResponse>;
|
|
@@ -237,7 +237,7 @@ declare class Finance {
|
|
|
237
237
|
* @returns {Promise<FinancePlatformModel.InvoicePaymentDetailsResponse>} -
|
|
238
238
|
* Success response
|
|
239
239
|
* @name invoicePaymentDetails
|
|
240
|
-
* @summary: Display payment details of an invoice
|
|
240
|
+
* @summary: Display payment details of an invoice
|
|
241
241
|
* @description: Display payment details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePaymentDetails/).
|
|
242
242
|
*/
|
|
243
243
|
invoicePaymentDetails({ invoiceNumber, requestHeaders }?: FinancePlatformValidator.InvoicePaymentDetailsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePaymentDetailsResponse>;
|
|
@@ -258,7 +258,7 @@ declare class Finance {
|
|
|
258
258
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
259
259
|
* @returns {Promise<FinancePlatformModel.InvoiceTypeResponse>} - Success response
|
|
260
260
|
* @name invoiceType
|
|
261
|
-
* @summary: Get invoice types
|
|
261
|
+
* @summary: Get invoice types
|
|
262
262
|
* @description: Retrieve a list of available invoice types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceType/).
|
|
263
263
|
*/
|
|
264
264
|
invoiceType({ body, requestHeaders }?: FinancePlatformValidator.InvoiceTypeParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceTypeResponse>;
|
|
@@ -269,7 +269,7 @@ declare class Finance {
|
|
|
269
269
|
* @returns {Promise<FinancePlatformModel.IsCnRefundMethodResponse>} -
|
|
270
270
|
* Success response
|
|
271
271
|
* @name isCnRefundMethod
|
|
272
|
-
* @summary: Check
|
|
272
|
+
* @summary: Check refund method
|
|
273
273
|
* @description: Verify the refund method for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCnRefundMethod/).
|
|
274
274
|
*/
|
|
275
275
|
isCnRefundMethod({ body, requestHeaders }?: FinancePlatformValidator.IsCnRefundMethodParam, { responseHeaders }?: object): Promise<FinancePlatformModel.IsCnRefundMethodResponse>;
|
|
@@ -280,7 +280,7 @@ declare class Finance {
|
|
|
280
280
|
* @returns {Promise<FinancePlatformModel.IsCreditlinePlatformResponse>} -
|
|
281
281
|
* Success response
|
|
282
282
|
* @name isCreditlinePlatform
|
|
283
|
-
* @summary: Check credit line platform status
|
|
283
|
+
* @summary: Check credit line platform status
|
|
284
284
|
* @description: Determine if the credit line platform is operational. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCreditlinePlatform/).
|
|
285
285
|
*/
|
|
286
286
|
isCreditlinePlatform({ body, requestHeaders }?: FinancePlatformValidator.IsCreditlinePlatformParam, { responseHeaders }?: object): Promise<FinancePlatformModel.IsCreditlinePlatformResponse>;
|
|
@@ -300,7 +300,7 @@ declare class Finance {
|
|
|
300
300
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
301
301
|
* @returns {Promise<FinancePlatformModel.PaymentProcessResponse>} - Success response
|
|
302
302
|
* @name paymentProcess
|
|
303
|
-
* @summary: Process payments
|
|
303
|
+
* @summary: Process payments
|
|
304
304
|
* @description: Initiate and manage payment processes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/paymentProcess/).
|
|
305
305
|
*/
|
|
306
306
|
paymentProcess({ body, requestHeaders }?: FinancePlatformValidator.PaymentProcessParam, { responseHeaders }?: object): Promise<FinancePlatformModel.PaymentProcessResponse>;
|
|
@@ -311,7 +311,7 @@ declare class Finance {
|
|
|
311
311
|
* @returns {Promise<FinancePlatformModel.UnlockCreditNoteResponse>} -
|
|
312
312
|
* Success response
|
|
313
313
|
* @name unlockCreditNote
|
|
314
|
-
* @summary:
|
|
314
|
+
* @summary: Unlock credit notes
|
|
315
315
|
* @description: Used to unlock all request credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/unlockCreditNote/).
|
|
316
316
|
*/
|
|
317
317
|
unlockCreditNote({ body, requestHeaders }?: FinancePlatformValidator.UnlockCreditNoteParam, { responseHeaders }?: object): Promise<FinancePlatformModel.UnlockCreditNoteResponse>;
|