@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.6
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 +3 -2
- package/sdk/application/ApplicationClient.js +20 -0
- 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/Lead/LeadApplicationModel.js +1 -1
- 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/Share/ShareApplicationModel.d.ts +0 -4
- package/sdk/application/Share/ShareApplicationModel.js +0 -4
- 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/common/Clickstream.d.ts +1 -0
- package/sdk/common/Clickstream.js +246 -0
- package/sdk/common/Utility.js +1 -4
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- 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 +20 -56
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +20 -59
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -2
- 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 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -16
- 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/Lead/LeadPlatformModel.js +1 -1
- 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/ServiceabilityPlatformModel.d.ts +4 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5 -1
- 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/Share/SharePlatformModel.d.ts +0 -4
- package/sdk/platform/Share/SharePlatformModel.js +0 -4
- 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 +4 -4
- package/sdk/platform/User/UserPlatformModel.js +4 -4
- 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
|
@@ -9,8 +9,8 @@ declare class Configuration {
|
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
10
|
* @returns {Promise<ConfigurationPlatformModel.Domain>} - Success response
|
|
11
11
|
* @name addDomain
|
|
12
|
-
* @summary: Add
|
|
13
|
-
* @description: Add a new domain to current sales channel, including pre-defined domain (free domain) or custom domain (owned by the brand) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/addDomain/).
|
|
12
|
+
* @summary: Add domain.
|
|
13
|
+
* @description: Add a new domain. Add a new domain to current sales channel, including pre-defined domain (free domain) or custom domain (owned by the brand) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/addDomain/).
|
|
14
14
|
*/
|
|
15
15
|
addDomain({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.AddDomainParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.Domain>;
|
|
16
16
|
/**
|
|
@@ -21,8 +21,8 @@ declare class Configuration {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<ConfigurationPlatformModel.DomainsResponse>} - Success response
|
|
23
23
|
* @name changeDomainType
|
|
24
|
-
* @summary: Change
|
|
25
|
-
* @description: Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links.
|
|
24
|
+
* @summary: Change domain type.
|
|
25
|
+
* @description: Modify the type of a specific domain. Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/changeDomainType/).
|
|
26
26
|
*/
|
|
27
27
|
changeDomainType({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.ChangeDomainTypeParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainsResponse>;
|
|
28
28
|
/**
|
|
@@ -33,8 +33,8 @@ declare class Configuration {
|
|
|
33
33
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
34
34
|
* @returns {Promise<ConfigurationPlatformModel.TokenResponse>} - Success response
|
|
35
35
|
* @name getAppApiTokens
|
|
36
|
-
* @summary: Get
|
|
37
|
-
* @description:
|
|
36
|
+
* @summary: Get application API tokens.
|
|
37
|
+
* @description: Retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppApiTokens/).
|
|
38
38
|
*/
|
|
39
39
|
getAppApiTokens({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.TokenResponse>;
|
|
40
40
|
/**
|
|
@@ -45,7 +45,7 @@ declare class Configuration {
|
|
|
45
45
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
46
46
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
|
|
47
47
|
* @name getAppBasicDetails
|
|
48
|
-
* @summary: Get
|
|
48
|
+
* @summary: Get application basic details.
|
|
49
49
|
* @description: Shows basic sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppBasicDetails/).
|
|
50
50
|
*/
|
|
51
51
|
getAppBasicDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationDetail>;
|
|
@@ -57,29 +57,10 @@ declare class Configuration {
|
|
|
57
57
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
58
58
|
* @returns {Promise<ConfigurationPlatformModel.CompaniesResponse>} - Success response
|
|
59
59
|
* @name getAppCompanies
|
|
60
|
-
* @summary: Get companies
|
|
61
|
-
* @description:
|
|
60
|
+
* @summary: Get application companies.
|
|
61
|
+
* @description: Retrieve info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCompanies/).
|
|
62
62
|
*/
|
|
63
63
|
getAppCompanies({ uid, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetAppCompaniesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CompaniesResponse>;
|
|
64
|
-
/**
|
|
65
|
-
* @param {Object} arg - Arg object.
|
|
66
|
-
* @param {number} arg.companyId - Numeric ID allotted to a business account
|
|
67
|
-
* on Fynd Platform
|
|
68
|
-
* @param {string} arg.applicationId - Alphanumeric ID allotted to an
|
|
69
|
-
* application (sales channel website) created within a business account
|
|
70
|
-
* @param {number} [arg.uid] - UID of companies to be fetched
|
|
71
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
72
|
-
* page. Default value is 10.
|
|
73
|
-
* @returns {Paginator<ConfigurationPlatformModel.CompaniesResponse>}
|
|
74
|
-
* @summary: Get companies enabled in the sales channel inventory
|
|
75
|
-
* @description: Fetch info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel application
|
|
76
|
-
*/
|
|
77
|
-
getAppCompaniesPaginator({ companyId, applicationId, uid, pageSize }?: {
|
|
78
|
-
companyId: number;
|
|
79
|
-
applicationId: string;
|
|
80
|
-
uid?: number;
|
|
81
|
-
pageSize?: number;
|
|
82
|
-
}): Paginator<ConfigurationPlatformModel.CompaniesResponse>;
|
|
83
64
|
/**
|
|
84
65
|
* @param {ConfigurationPlatformApplicationValidator.GetAppContactInfoParam} arg
|
|
85
66
|
* - Arg object
|
|
@@ -89,7 +70,7 @@ declare class Configuration {
|
|
|
89
70
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
|
|
90
71
|
* Success response
|
|
91
72
|
* @name getAppContactInfo
|
|
92
|
-
* @summary: Get
|
|
73
|
+
* @summary: Get application contact information.
|
|
93
74
|
* @description: Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppContactInfo/).
|
|
94
75
|
*/
|
|
95
76
|
getAppContactInfo({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInformation>;
|
|
@@ -102,8 +83,8 @@ declare class Configuration {
|
|
|
102
83
|
* @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
|
|
103
84
|
* Success response
|
|
104
85
|
* @name getAppCurrencyConfig
|
|
105
|
-
* @summary: Get
|
|
106
|
-
* @description:
|
|
86
|
+
* @summary: Get application currency configuration.
|
|
87
|
+
* @description: Retrieve a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCurrencyConfig/).
|
|
107
88
|
*/
|
|
108
89
|
getAppCurrencyConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppSupportedCurrency>;
|
|
109
90
|
/**
|
|
@@ -115,7 +96,7 @@ declare class Configuration {
|
|
|
115
96
|
* @returns {Promise<ConfigurationPlatformModel.AppFeatureResponse>} -
|
|
116
97
|
* Success response
|
|
117
98
|
* @name getAppFeatures
|
|
118
|
-
* @summary: Get
|
|
99
|
+
* @summary: Get application features.
|
|
119
100
|
* @description: Shows feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppFeatures/).
|
|
120
101
|
*/
|
|
121
102
|
getAppFeatures({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppFeatureResponse>;
|
|
@@ -127,27 +108,10 @@ declare class Configuration {
|
|
|
127
108
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
128
109
|
* @returns {Promise<ConfigurationPlatformModel.StoresResponse>} - Success response
|
|
129
110
|
* @name getAppStores
|
|
130
|
-
* @summary: Get stores
|
|
131
|
-
* @description:
|
|
111
|
+
* @summary: Get application stores.
|
|
112
|
+
* @description: Retrieve information of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppStores/).
|
|
132
113
|
*/
|
|
133
114
|
getAppStores({ pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetAppStoresParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.StoresResponse>;
|
|
134
|
-
/**
|
|
135
|
-
* @param {Object} arg - Arg object.
|
|
136
|
-
* @param {number} arg.companyId - Numeric ID allotted to a business account
|
|
137
|
-
* on Fynd Platform
|
|
138
|
-
* @param {string} arg.applicationId - Alphanumeric ID allotted to an
|
|
139
|
-
* application (sales channel website) created within a business account
|
|
140
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
141
|
-
* page. Default value is 10.
|
|
142
|
-
* @returns {Paginator<ConfigurationPlatformModel.StoresResponse>}
|
|
143
|
-
* @summary: Get stores enabled in the sales channel inventory
|
|
144
|
-
* @description: Fetch info of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel application
|
|
145
|
-
*/
|
|
146
|
-
getAppStoresPaginator({ companyId, applicationId, pageSize }?: {
|
|
147
|
-
companyId: number;
|
|
148
|
-
applicationId: string;
|
|
149
|
-
pageSize?: number;
|
|
150
|
-
}): Paginator<ConfigurationPlatformModel.StoresResponse>;
|
|
151
115
|
/**
|
|
152
116
|
* @param {ConfigurationPlatformApplicationValidator.GetAppSupportedCurrencyParam} arg
|
|
153
117
|
* - Arg object
|
|
@@ -157,8 +121,8 @@ declare class Configuration {
|
|
|
157
121
|
* @returns {Promise<ConfigurationPlatformModel.AppCurrencyResponse>} -
|
|
158
122
|
* Success response
|
|
159
123
|
* @name getAppSupportedCurrency
|
|
160
|
-
* @summary: Get currencies
|
|
161
|
-
* @description:
|
|
124
|
+
* @summary: Get supported currencies.
|
|
125
|
+
* @description: Retrieve a list of supported currencies for the application. A list of currencies allowed in the current application. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppSupportedCurrency/).
|
|
162
126
|
*/
|
|
163
127
|
getAppSupportedCurrency({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppCurrencyResponse>;
|
|
164
128
|
/**
|
|
@@ -167,12 +131,12 @@ declare class Configuration {
|
|
|
167
131
|
*
|
|
168
132
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
169
133
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
170
|
-
* @returns {Promise<ConfigurationPlatformModel.
|
|
134
|
+
* @returns {Promise<ConfigurationPlatformModel.ApplicationById>} - Success response
|
|
171
135
|
* @name getApplicationById
|
|
172
|
-
* @summary: Get
|
|
173
|
-
* @description: Use application ID to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplicationById/).
|
|
136
|
+
* @summary: Get application by ID.
|
|
137
|
+
* @description: Retrieve detailed information about a specific application. Use application ID to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplicationById/).
|
|
174
138
|
*/
|
|
175
|
-
getApplicationById({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.
|
|
139
|
+
getApplicationById({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationById>;
|
|
176
140
|
/**
|
|
177
141
|
* @param {ConfigurationPlatformApplicationValidator.GetBuildConfigParam} arg
|
|
178
142
|
* - Arg object
|
|
@@ -182,8 +146,8 @@ declare class Configuration {
|
|
|
182
146
|
* @returns {Promise<ConfigurationPlatformModel.MobileAppConfiguration>} -
|
|
183
147
|
* Success response
|
|
184
148
|
* @name getBuildConfig
|
|
185
|
-
* @summary: Get configuration
|
|
186
|
-
* @description:
|
|
149
|
+
* @summary: Get build configuration.
|
|
150
|
+
* @description: Retrieve latest build configuration, such as app name, landing page image, splash image used in a mobile build. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBuildConfig/).
|
|
187
151
|
*/
|
|
188
152
|
getBuildConfig({ platformType, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetBuildConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.MobileAppConfiguration>;
|
|
189
153
|
/**
|
|
@@ -195,8 +159,8 @@ declare class Configuration {
|
|
|
195
159
|
* @returns {Promise<ConfigurationPlatformModel.DomainStatusResponse>} -
|
|
196
160
|
* Success response
|
|
197
161
|
* @name getDomainStatus
|
|
198
|
-
* @summary: Get
|
|
199
|
-
* @description: Shows if the A records and TXT records of the domain correctly points to appropriate IP on Fynd Servers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainStatus/).
|
|
162
|
+
* @summary: Get domain status.
|
|
163
|
+
* @description: Retrieve the status of a specific domain. Shows if the A records and TXT records of the domain correctly points to appropriate IP on Fynd Servers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainStatus/).
|
|
200
164
|
*/
|
|
201
165
|
getDomainStatus({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetDomainStatusParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainStatusResponse>;
|
|
202
166
|
/**
|
|
@@ -205,8 +169,8 @@ declare class Configuration {
|
|
|
205
169
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
206
170
|
* @returns {Promise<ConfigurationPlatformModel.DomainsResponse>} - Success response
|
|
207
171
|
* @name getDomains
|
|
208
|
-
* @summary:
|
|
209
|
-
* @description: Get list of domains
|
|
172
|
+
* @summary: Get domains.
|
|
173
|
+
* @description: Get list of domains. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomains/).
|
|
210
174
|
*/
|
|
211
175
|
getDomains({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainsResponse>;
|
|
212
176
|
/**
|
|
@@ -218,8 +182,8 @@ declare class Configuration {
|
|
|
218
182
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInventory>} -
|
|
219
183
|
* Success response
|
|
220
184
|
* @name getInventoryConfig
|
|
221
|
-
* @summary: Get
|
|
222
|
-
* @description:
|
|
185
|
+
* @summary: Get inventory configuration.
|
|
186
|
+
* @description: Retrieve configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getInventoryConfig/).
|
|
223
187
|
*/
|
|
224
188
|
getInventoryConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInventory>;
|
|
225
189
|
/**
|
|
@@ -231,8 +195,8 @@ declare class Configuration {
|
|
|
231
195
|
* @returns {Promise<ConfigurationPlatformModel.OrderingStoreConfig>} -
|
|
232
196
|
* Success response
|
|
233
197
|
* @name getOrderingStoreConfig
|
|
234
|
-
* @summary: Get ordering store
|
|
235
|
-
* @description:
|
|
198
|
+
* @summary: Get ordering store configuration.
|
|
199
|
+
* @description: Retrieve configuration settings for ordering stores. Retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreConfig/).
|
|
236
200
|
*/
|
|
237
201
|
getOrderingStoreConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStoreConfig>;
|
|
238
202
|
/**
|
|
@@ -256,29 +220,10 @@ declare class Configuration {
|
|
|
256
220
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
257
221
|
* @returns {Promise<ConfigurationPlatformModel.OrderingStores>} - Success response
|
|
258
222
|
* @name getOrderingStoresByFilter
|
|
259
|
-
* @summary: Get ordering
|
|
260
|
-
* @description:
|
|
223
|
+
* @summary: Get ordering stores by filter.
|
|
224
|
+
* @description: Retrieve ordering stores based on specified filters. Use filters and retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoresByFilter/).
|
|
261
225
|
*/
|
|
262
226
|
getOrderingStoresByFilter({ body, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetOrderingStoresByFilterParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStores>;
|
|
263
|
-
/**
|
|
264
|
-
* @param {Object} arg - Arg object.
|
|
265
|
-
* @param {number} arg.companyId - Numeric ID allotted to a business account
|
|
266
|
-
* on Fynd Platform
|
|
267
|
-
* @param {string} arg.applicationId - Alphanumeric ID allotted to an
|
|
268
|
-
* application (sales channel website) created within a business account
|
|
269
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
270
|
-
* page. Default value is 10.
|
|
271
|
-
* @param {ConfigurationPlatformModel.FilterOrderingStoreRequest} arg.body
|
|
272
|
-
* @returns {Paginator<ConfigurationPlatformModel.OrderingStores>}
|
|
273
|
-
* @summary: Get ordering store by filter
|
|
274
|
-
* @description: Use this API to use filters and retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders).
|
|
275
|
-
*/
|
|
276
|
-
getOrderingStoresByFilterPaginator({ companyId, applicationId, pageSize, body, }?: {
|
|
277
|
-
companyId: number;
|
|
278
|
-
applicationId: string;
|
|
279
|
-
pageSize?: number;
|
|
280
|
-
body: ConfigurationPlatformModel.FilterOrderingStoreRequest;
|
|
281
|
-
}): Paginator<ConfigurationPlatformModel.OrderingStores>;
|
|
282
227
|
/**
|
|
283
228
|
* @param {ConfigurationPlatformApplicationValidator.GetPreviousVersionsParam} arg
|
|
284
229
|
* - Arg object
|
|
@@ -288,8 +233,8 @@ declare class Configuration {
|
|
|
288
233
|
* @returns {Promise<ConfigurationPlatformModel.BuildVersionHistory>} -
|
|
289
234
|
* Success response
|
|
290
235
|
* @name getPreviousVersions
|
|
291
|
-
* @summary: Get
|
|
292
|
-
* @description:
|
|
236
|
+
* @summary: Get previous versions.
|
|
237
|
+
* @description: Retrieve version details of the app, this includes the build status, build date, version name, latest version, and a lot more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getPreviousVersions/).
|
|
293
238
|
*/
|
|
294
239
|
getPreviousVersions({ platformType, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetPreviousVersionsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.BuildVersionHistory>;
|
|
295
240
|
/**
|
|
@@ -301,29 +246,10 @@ declare class Configuration {
|
|
|
301
246
|
* @returns {Promise<ConfigurationPlatformModel.OrderingStoresResponse>} -
|
|
302
247
|
* Success response
|
|
303
248
|
* @name getStaffOrderingStores
|
|
304
|
-
* @summary: Get
|
|
305
|
-
* @description:
|
|
249
|
+
* @summary: Get staff ordering stores.
|
|
250
|
+
* @description: Retrieve ordering stores accessible to staff members. Retrieve the details of all stores access given to the staff member (the selling locations where the application will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStaffOrderingStores/).
|
|
306
251
|
*/
|
|
307
252
|
getStaffOrderingStores({ pageNo, pageSize, q, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetStaffOrderingStoresParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStoresResponse>;
|
|
308
|
-
/**
|
|
309
|
-
* @param {Object} arg - Arg object.
|
|
310
|
-
* @param {number} arg.companyId - Numeric ID allotted to a business account
|
|
311
|
-
* on Fynd Platform
|
|
312
|
-
* @param {string} arg.applicationId - Alphanumeric ID allotted to an
|
|
313
|
-
* application (sales channel website) created within a business account
|
|
314
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
315
|
-
* page. Default value is 10.
|
|
316
|
-
* @param {string} [arg.q] - Store code or name of the ordering store.
|
|
317
|
-
* @returns {Paginator<ConfigurationPlatformModel.OrderingStoresResponse>}
|
|
318
|
-
* @summary: Get deployment stores
|
|
319
|
-
* @description: Use this API to retrieve the details of all stores access given to the staff member (the selling locations where the application will be utilized for placing orders).
|
|
320
|
-
*/
|
|
321
|
-
getStaffOrderingStoresPaginator({ companyId, applicationId, pageSize, q, }?: {
|
|
322
|
-
companyId: number;
|
|
323
|
-
applicationId: string;
|
|
324
|
-
pageSize?: number;
|
|
325
|
-
q?: string;
|
|
326
|
-
}): Paginator<ConfigurationPlatformModel.OrderingStoresResponse>;
|
|
327
253
|
/**
|
|
328
254
|
* @param {ConfigurationPlatformApplicationValidator.ModifyAppFeaturesParam} arg
|
|
329
255
|
* - Arg object
|
|
@@ -332,7 +258,7 @@ declare class Configuration {
|
|
|
332
258
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
333
259
|
* @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
|
|
334
260
|
* @name modifyAppFeatures
|
|
335
|
-
* @summary:
|
|
261
|
+
* @summary: Modify application features.
|
|
336
262
|
* @description: Update features of application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/modifyAppFeatures/).
|
|
337
263
|
*/
|
|
338
264
|
modifyAppFeatures({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.ModifyAppFeaturesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppFeature>;
|
|
@@ -345,7 +271,7 @@ declare class Configuration {
|
|
|
345
271
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInventory>} -
|
|
346
272
|
* Success response
|
|
347
273
|
* @name partiallyUpdateInventoryConfig
|
|
348
|
-
* @summary: Partially update
|
|
274
|
+
* @summary: Partially update inventory configuration.
|
|
349
275
|
* @description: Partially update the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/partiallyUpdateInventoryConfig/).
|
|
350
276
|
*/
|
|
351
277
|
partiallyUpdateInventoryConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.PartiallyUpdateInventoryConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInventory>;
|
|
@@ -358,8 +284,8 @@ declare class Configuration {
|
|
|
358
284
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
359
285
|
* Success response
|
|
360
286
|
* @name removeDomainById
|
|
361
|
-
* @summary: Remove
|
|
362
|
-
* @description: Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeDomainById/).
|
|
287
|
+
* @summary: Remove domain by ID.
|
|
288
|
+
* @description: Delete a specific domain from the application. Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeDomainById/).
|
|
363
289
|
*/
|
|
364
290
|
removeDomainById({ id, requestHeaders }?: ConfigurationPlatformApplicationValidator.RemoveDomainByIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
|
|
365
291
|
/**
|
|
@@ -383,8 +309,8 @@ declare class Configuration {
|
|
|
383
309
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
384
310
|
* @returns {Promise<ConfigurationPlatformModel.TokenResponse>} - Success response
|
|
385
311
|
* @name updateAppApiTokens
|
|
386
|
-
* @summary:
|
|
387
|
-
* @description:
|
|
312
|
+
* @summary: Update application API tokens.
|
|
313
|
+
* @description: Add or edit the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google and Facebook auth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppApiTokens/).
|
|
388
314
|
*/
|
|
389
315
|
updateAppApiTokens({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppApiTokensParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.TokenResponse>;
|
|
390
316
|
/**
|
|
@@ -395,7 +321,7 @@ declare class Configuration {
|
|
|
395
321
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
396
322
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
|
|
397
323
|
* @name updateAppBasicDetails
|
|
398
|
-
* @summary: Update
|
|
324
|
+
* @summary: Update application basic details.
|
|
399
325
|
* @description: Modify sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppBasicDetails/).
|
|
400
326
|
*/
|
|
401
327
|
updateAppBasicDetails({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppBasicDetailsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationDetail>;
|
|
@@ -408,7 +334,7 @@ declare class Configuration {
|
|
|
408
334
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
|
|
409
335
|
* Success response
|
|
410
336
|
* @name updateAppContactInfo
|
|
411
|
-
* @summary:
|
|
337
|
+
* @summary: Update application contact information.
|
|
412
338
|
* @description: Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppContactInfo/).
|
|
413
339
|
*/
|
|
414
340
|
updateAppContactInfo({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppContactInfoParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInformation>;
|
|
@@ -421,8 +347,8 @@ declare class Configuration {
|
|
|
421
347
|
* @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
|
|
422
348
|
* Success response
|
|
423
349
|
* @name updateAppCurrencyConfig
|
|
424
|
-
* @summary: Update
|
|
425
|
-
* @description:
|
|
350
|
+
* @summary: Update application currency configuration.
|
|
351
|
+
* @description: Modify currency configuration settings for the application. Add and edit the currencies supported in the application. Initially, INR will be enabled by default. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppCurrencyConfig/).
|
|
426
352
|
*/
|
|
427
353
|
updateAppCurrencyConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppCurrencyConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppSupportedCurrency>;
|
|
428
354
|
/**
|
|
@@ -433,7 +359,7 @@ declare class Configuration {
|
|
|
433
359
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
434
360
|
* @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
|
|
435
361
|
* @name updateAppFeatures
|
|
436
|
-
* @summary: Update
|
|
362
|
+
* @summary: Update application features.
|
|
437
363
|
* @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppFeatures/).
|
|
438
364
|
*/
|
|
439
365
|
updateAppFeatures({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppFeaturesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppFeature>;
|
|
@@ -446,7 +372,7 @@ declare class Configuration {
|
|
|
446
372
|
* @returns {Promise<ConfigurationPlatformModel.MobileAppConfiguration>} -
|
|
447
373
|
* Success response
|
|
448
374
|
* @name updateBuildConfig
|
|
449
|
-
* @summary: Update
|
|
375
|
+
* @summary: Update build configuration.
|
|
450
376
|
* @description: Modify the existing build configuration, such as app name, landing page image, splash image used in a mobile build. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateBuildConfig/).
|
|
451
377
|
*/
|
|
452
378
|
updateBuildConfig({ platformType, body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateBuildConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.MobileAppConfiguration>;
|
|
@@ -459,7 +385,7 @@ declare class Configuration {
|
|
|
459
385
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInventory>} -
|
|
460
386
|
* Success response
|
|
461
387
|
* @name updateInventoryConfig
|
|
462
|
-
* @summary: Update
|
|
388
|
+
* @summary: Update inventory configuration.
|
|
463
389
|
* @description: Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateInventoryConfig/).
|
|
464
390
|
*/
|
|
465
391
|
updateInventoryConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateInventoryConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInventory>;
|
|
@@ -471,11 +397,10 @@ declare class Configuration {
|
|
|
471
397
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
472
398
|
* @returns {Promise<ConfigurationPlatformModel.DeploymentMeta>} - Success response
|
|
473
399
|
* @name updateOrderingStoreConfig
|
|
474
|
-
* @summary:
|
|
475
|
-
* @description:
|
|
400
|
+
* @summary: Update ordering store configuration.
|
|
401
|
+
* @description: Modify configuration settings for ordering stores. Edit the details of the deployment stores (the selling locations where the application will be utilised for placing orders) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateOrderingStoreConfig/).
|
|
476
402
|
*/
|
|
477
403
|
updateOrderingStoreConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateOrderingStoreConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DeploymentMeta>;
|
|
478
404
|
}
|
|
479
405
|
import ConfigurationPlatformApplicationValidator = require("./ConfigurationPlatformApplicationValidator");
|
|
480
406
|
import ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
|
|
481
|
-
import Paginator = require("../../common/Paginator");
|