@gofynd/fdk-client-javascript 1.3.5 → 1.3.6-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/CartApplicationModel.d.ts +33 -3
- package/sdk/application/Cart/CartApplicationModel.js +38 -2
- package/sdk/common/BaseOAuthClient.js +1 -1
- package/sdk/partner/OAuthClient.d.ts +5 -4
- package/sdk/partner/OAuthClient.js +78 -9
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +86 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +533 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +54 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +74 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +212 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +166 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -6
- package/sdk/platform/Order/OrderPlatformModel.js +8 -6
package/README.md
CHANGED
|
@@ -214,7 +214,7 @@ console.log("Active Theme: ", response.information.name);
|
|
|
214
214
|
The above code will log the curl command in the console
|
|
215
215
|
|
|
216
216
|
```bash
|
|
217
|
-
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.3.
|
|
217
|
+
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.3.6-beta.1' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
|
|
218
218
|
Active Theme: Emerge
|
|
219
219
|
```
|
|
220
220
|
|
package/package.json
CHANGED
|
@@ -284,7 +284,7 @@ export = CartApplicationModel;
|
|
|
284
284
|
* @property {Object} [moq]
|
|
285
285
|
* @property {Object} [parent_item_identifiers]
|
|
286
286
|
* @property {ProductPriceInfo} [price]
|
|
287
|
-
* @property {
|
|
287
|
+
* @property {ProductPricePerUnitInfo} [price_per_unit]
|
|
288
288
|
* @property {CartProduct} [product]
|
|
289
289
|
* @property {PromoMeta} [promo_meta]
|
|
290
290
|
* @property {AppliedPromotion[]} [promotions_applied]
|
|
@@ -660,6 +660,20 @@ export = CartApplicationModel;
|
|
|
660
660
|
* @property {ProductPrice} [base]
|
|
661
661
|
* @property {ProductPrice} [converted]
|
|
662
662
|
*/
|
|
663
|
+
/**
|
|
664
|
+
* @typedef ProductPricePerUnit
|
|
665
|
+
* @property {number} [add_on]
|
|
666
|
+
* @property {string} [currency_code]
|
|
667
|
+
* @property {string} [currency_symbol]
|
|
668
|
+
* @property {number} [effective]
|
|
669
|
+
* @property {number} [marked]
|
|
670
|
+
* @property {number} [selling_price]
|
|
671
|
+
*/
|
|
672
|
+
/**
|
|
673
|
+
* @typedef ProductPricePerUnitInfo
|
|
674
|
+
* @property {ProductPricePerUnit} [base]
|
|
675
|
+
* @property {ProductPricePerUnit} [converted]
|
|
676
|
+
*/
|
|
663
677
|
/**
|
|
664
678
|
* @typedef PromiseFormatted
|
|
665
679
|
* @property {string} [max]
|
|
@@ -837,7 +851,7 @@ export = CartApplicationModel;
|
|
|
837
851
|
declare class CartApplicationModel {
|
|
838
852
|
}
|
|
839
853
|
declare namespace CartApplicationModel {
|
|
840
|
-
export { ActionQuery, AddCartDetailResponse, AddCartRequest, AddProductCart, Address, AppliedFreeArticles, AppliedPromotion, ApplyCouponRequest, ArticleGiftDetail, ArticlePriceInfo, BaseInfo, BasePrice, BulkPriceOffer, BulkPriceResponse, BuyRules, CartBreakup, CartCheckoutCustomMeta, CartCheckoutDetailRequest, CartCheckoutDetailV2Request, CartCheckoutResponse, CartCurrency, CartDetailResponse, CartItemCountResponse, CartMetaMissingResponse, CartMetaRequest, CartMetaResponse, CartProduct, CartProductIdentifer, CartProductInfo, CartShipmentsResponse, CategoryInfo, CheckCart, Coupon, CouponBreakup, CouponDetails, CouponValidity, CurrencyInfo, CustomerDetails, DeleteAddressResponse, DeleteCartDetailResponse, DiscountRulesApp, DisplayBreakup, FreeGiftItem, FreeGiftItems, GeoLocation, GetAddressesResponse, GetCouponResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, GiftDetail, LadderOfferItem, LadderPrice, LadderPriceOffer, LadderPriceOffers, LoyaltyPoints, OfferItem, OfferPrice, OfferSeller, OperationErrorResponse, Ownership, PageCoupon, PaymentCouponValidate, PaymentMeta, PaymentMethod, PaymentSelectionLock, ProductAction, ProductArticle, ProductAvailability, ProductAvailabilitySize, ProductImage, ProductPrice, ProductPriceInfo, PromiseFormatted, PromiseTimestamp, PromoMeta, PromotionOffer, PromotionOffersResponse, RawBreakup, RewardPointRequest, SaveAddressResponse, SelectCartAddressRequest, SharedCart, SharedCartDetails, SharedCartResponse, ShipmentPromise, ShipmentResponse, StaffCheckout, StoreInfo, Tags, UpdateAddressResponse, UpdateCartDetailResponse, UpdateCartPaymentRequest, UpdateCartRequest, UpdateProductCart };
|
|
854
|
+
export { ActionQuery, AddCartDetailResponse, AddCartRequest, AddProductCart, Address, AppliedFreeArticles, AppliedPromotion, ApplyCouponRequest, ArticleGiftDetail, ArticlePriceInfo, BaseInfo, BasePrice, BulkPriceOffer, BulkPriceResponse, BuyRules, CartBreakup, CartCheckoutCustomMeta, CartCheckoutDetailRequest, CartCheckoutDetailV2Request, CartCheckoutResponse, CartCurrency, CartDetailResponse, CartItemCountResponse, CartMetaMissingResponse, CartMetaRequest, CartMetaResponse, CartProduct, CartProductIdentifer, CartProductInfo, CartShipmentsResponse, CategoryInfo, CheckCart, Coupon, CouponBreakup, CouponDetails, CouponValidity, CurrencyInfo, CustomerDetails, DeleteAddressResponse, DeleteCartDetailResponse, DiscountRulesApp, DisplayBreakup, FreeGiftItem, FreeGiftItems, GeoLocation, GetAddressesResponse, GetCouponResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, GiftDetail, LadderOfferItem, LadderPrice, LadderPriceOffer, LadderPriceOffers, LoyaltyPoints, OfferItem, OfferPrice, OfferSeller, OperationErrorResponse, Ownership, PageCoupon, PaymentCouponValidate, PaymentMeta, PaymentMethod, PaymentSelectionLock, ProductAction, ProductArticle, ProductAvailability, ProductAvailabilitySize, ProductImage, ProductPrice, ProductPriceInfo, ProductPricePerUnit, ProductPricePerUnitInfo, PromiseFormatted, PromiseTimestamp, PromoMeta, PromotionOffer, PromotionOffersResponse, RawBreakup, RewardPointRequest, SaveAddressResponse, SelectCartAddressRequest, SharedCart, SharedCartDetails, SharedCartResponse, ShipmentPromise, ShipmentResponse, StaffCheckout, StoreInfo, Tags, UpdateAddressResponse, UpdateCartDetailResponse, UpdateCartPaymentRequest, UpdateCartRequest, UpdateProductCart };
|
|
841
855
|
}
|
|
842
856
|
/** @returns {ActionQuery} */
|
|
843
857
|
declare function ActionQuery(): ActionQuery;
|
|
@@ -1243,7 +1257,7 @@ type CartProductInfo = {
|
|
|
1243
1257
|
moq?: any;
|
|
1244
1258
|
parent_item_identifiers?: any;
|
|
1245
1259
|
price?: ProductPriceInfo;
|
|
1246
|
-
price_per_unit?:
|
|
1260
|
+
price_per_unit?: ProductPricePerUnitInfo;
|
|
1247
1261
|
product?: CartProduct;
|
|
1248
1262
|
promo_meta?: PromoMeta;
|
|
1249
1263
|
promotions_applied?: AppliedPromotion[];
|
|
@@ -1824,6 +1838,22 @@ type ProductPriceInfo = {
|
|
|
1824
1838
|
base?: ProductPrice;
|
|
1825
1839
|
converted?: ProductPrice;
|
|
1826
1840
|
};
|
|
1841
|
+
/** @returns {ProductPricePerUnit} */
|
|
1842
|
+
declare function ProductPricePerUnit(): ProductPricePerUnit;
|
|
1843
|
+
type ProductPricePerUnit = {
|
|
1844
|
+
add_on?: number;
|
|
1845
|
+
currency_code?: string;
|
|
1846
|
+
currency_symbol?: string;
|
|
1847
|
+
effective?: number;
|
|
1848
|
+
marked?: number;
|
|
1849
|
+
selling_price?: number;
|
|
1850
|
+
};
|
|
1851
|
+
/** @returns {ProductPricePerUnitInfo} */
|
|
1852
|
+
declare function ProductPricePerUnitInfo(): ProductPricePerUnitInfo;
|
|
1853
|
+
type ProductPricePerUnitInfo = {
|
|
1854
|
+
base?: ProductPricePerUnit;
|
|
1855
|
+
converted?: ProductPricePerUnit;
|
|
1856
|
+
};
|
|
1827
1857
|
/** @returns {PromiseFormatted} */
|
|
1828
1858
|
declare function PromiseFormatted(): PromiseFormatted;
|
|
1829
1859
|
type PromiseFormatted = {
|
|
@@ -313,7 +313,7 @@ const Joi = require("joi");
|
|
|
313
313
|
* @property {Object} [moq]
|
|
314
314
|
* @property {Object} [parent_item_identifiers]
|
|
315
315
|
* @property {ProductPriceInfo} [price]
|
|
316
|
-
* @property {
|
|
316
|
+
* @property {ProductPricePerUnitInfo} [price_per_unit]
|
|
317
317
|
* @property {CartProduct} [product]
|
|
318
318
|
* @property {PromoMeta} [promo_meta]
|
|
319
319
|
* @property {AppliedPromotion[]} [promotions_applied]
|
|
@@ -733,6 +733,22 @@ const Joi = require("joi");
|
|
|
733
733
|
* @property {ProductPrice} [converted]
|
|
734
734
|
*/
|
|
735
735
|
|
|
736
|
+
/**
|
|
737
|
+
* @typedef ProductPricePerUnit
|
|
738
|
+
* @property {number} [add_on]
|
|
739
|
+
* @property {string} [currency_code]
|
|
740
|
+
* @property {string} [currency_symbol]
|
|
741
|
+
* @property {number} [effective]
|
|
742
|
+
* @property {number} [marked]
|
|
743
|
+
* @property {number} [selling_price]
|
|
744
|
+
*/
|
|
745
|
+
|
|
746
|
+
/**
|
|
747
|
+
* @typedef ProductPricePerUnitInfo
|
|
748
|
+
* @property {ProductPricePerUnit} [base]
|
|
749
|
+
* @property {ProductPricePerUnit} [converted]
|
|
750
|
+
*/
|
|
751
|
+
|
|
736
752
|
/**
|
|
737
753
|
* @typedef PromiseFormatted
|
|
738
754
|
* @property {string} [max]
|
|
@@ -1305,7 +1321,7 @@ class CartApplicationModel {
|
|
|
1305
1321
|
moq: Joi.any(),
|
|
1306
1322
|
parent_item_identifiers: Joi.any(),
|
|
1307
1323
|
price: CartApplicationModel.ProductPriceInfo(),
|
|
1308
|
-
price_per_unit: CartApplicationModel.
|
|
1324
|
+
price_per_unit: CartApplicationModel.ProductPricePerUnitInfo(),
|
|
1309
1325
|
product: CartApplicationModel.CartProduct(),
|
|
1310
1326
|
promo_meta: CartApplicationModel.PromoMeta(),
|
|
1311
1327
|
promotions_applied: Joi.array().items(
|
|
@@ -1810,6 +1826,26 @@ class CartApplicationModel {
|
|
|
1810
1826
|
});
|
|
1811
1827
|
}
|
|
1812
1828
|
|
|
1829
|
+
/** @returns {ProductPricePerUnit} */
|
|
1830
|
+
static ProductPricePerUnit() {
|
|
1831
|
+
return Joi.object({
|
|
1832
|
+
add_on: Joi.number(),
|
|
1833
|
+
currency_code: Joi.string().allow(""),
|
|
1834
|
+
currency_symbol: Joi.string().allow(""),
|
|
1835
|
+
effective: Joi.number(),
|
|
1836
|
+
marked: Joi.number(),
|
|
1837
|
+
selling_price: Joi.number(),
|
|
1838
|
+
});
|
|
1839
|
+
}
|
|
1840
|
+
|
|
1841
|
+
/** @returns {ProductPricePerUnitInfo} */
|
|
1842
|
+
static ProductPricePerUnitInfo() {
|
|
1843
|
+
return Joi.object({
|
|
1844
|
+
base: CartApplicationModel.ProductPricePerUnit(),
|
|
1845
|
+
converted: CartApplicationModel.ProductPricePerUnit(),
|
|
1846
|
+
});
|
|
1847
|
+
}
|
|
1848
|
+
|
|
1813
1849
|
/** @returns {PromiseFormatted} */
|
|
1814
1850
|
static PromiseFormatted() {
|
|
1815
1851
|
return Joi.object({
|
|
@@ -40,11 +40,11 @@ class BaseOAuthClient {
|
|
|
40
40
|
this.raw_token = token;
|
|
41
41
|
this.token_expires_in = token.expires_in;
|
|
42
42
|
this.token = token.access_token;
|
|
43
|
-
this.token_expires_at = token.expires_at || this.token_expires_at;
|
|
44
43
|
this.refreshToken = token.refresh_token ? token.refresh_token : null;
|
|
45
44
|
if (this.refreshToken && this.useAutoRenewTimer) {
|
|
46
45
|
this.retryOAuthToken(token.expires_in);
|
|
47
46
|
}
|
|
47
|
+
Logger({ level: "INFO", message: "Partner token set." });
|
|
48
48
|
}
|
|
49
49
|
|
|
50
50
|
retryOAuthToken(expires_in) {
|
|
@@ -4,11 +4,12 @@ declare class OAuthClient extends BaseOAuthClient {
|
|
|
4
4
|
verifyCallback(query: any): Promise<void>;
|
|
5
5
|
renewAccessToken(isOfflineToken?: boolean): Promise<any>;
|
|
6
6
|
getNewAccessToken(): Promise<any>;
|
|
7
|
-
getAccesstokenObj({ grant_type,
|
|
7
|
+
getAccesstokenObj({ grant_type, refresh_token, code }: {
|
|
8
8
|
grant_type: any;
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
scope: any;
|
|
9
|
+
refresh_token: any;
|
|
10
|
+
code: any;
|
|
12
11
|
}): Promise<any>;
|
|
12
|
+
getOfflineAccessToken(scopes: any, code: any): Promise<any>;
|
|
13
|
+
getOfflineAccessTokenObj(scopes: any, code: any): Promise<any>;
|
|
13
14
|
}
|
|
14
15
|
import BaseOAuthClient = require("../common/BaseOAuthClient");
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
const { fdkAxios } = require("../common/AxiosHelper");
|
|
2
|
-
const { FDKTokenIssueError } = require("../common/FDKError");
|
|
2
|
+
const { FDKTokenIssueError, FDKOAuthCodeError } = require("../common/FDKError");
|
|
3
3
|
const { Logger } = require("../common/Logger");
|
|
4
4
|
const BaseOAuthClient = require("../common/BaseOAuthClient");
|
|
5
5
|
const querystring = require("query-string");
|
|
6
6
|
const { sign } = require("@gofynd/fp-signature");
|
|
7
|
+
const { convertStringToBase64 } = require("../common/utils");
|
|
7
8
|
|
|
8
9
|
class OAuthClient extends BaseOAuthClient {
|
|
9
10
|
constructor(config) {
|
|
@@ -50,9 +51,10 @@ class OAuthClient extends BaseOAuthClient {
|
|
|
50
51
|
grant_type: "authorization_code",
|
|
51
52
|
code: query.code,
|
|
52
53
|
});
|
|
53
|
-
|
|
54
|
-
res.expires_at || new Date().getTime() + res.expires_in * 1000;
|
|
54
|
+
|
|
55
55
|
this.setToken(res);
|
|
56
|
+
this.token_expires_at =
|
|
57
|
+
new Date().getTime() + this.token_expires_in * 1000;
|
|
56
58
|
} catch (error) {
|
|
57
59
|
if (error.isAxiosError) {
|
|
58
60
|
throw new FDKTokenIssueError(error.message);
|
|
@@ -96,16 +98,83 @@ class OAuthClient extends BaseOAuthClient {
|
|
|
96
98
|
}
|
|
97
99
|
}
|
|
98
100
|
|
|
99
|
-
async getAccesstokenObj({ grant_type,
|
|
100
|
-
Logger({
|
|
101
|
+
async getAccesstokenObj({ grant_type, refresh_token, code }) {
|
|
102
|
+
Logger({
|
|
103
|
+
type: "DEBUG",
|
|
104
|
+
message: "Processing partner access token object...",
|
|
105
|
+
});
|
|
106
|
+
|
|
101
107
|
let reqData = {
|
|
102
108
|
grant_type: grant_type,
|
|
103
|
-
client_id,
|
|
104
|
-
client_secret,
|
|
105
|
-
scope,
|
|
106
109
|
};
|
|
110
|
+
|
|
111
|
+
if (grant_type === "refresh_token") {
|
|
112
|
+
reqData = { ...reqData, refresh_token };
|
|
113
|
+
} else if (grant_type === "authorization_code") {
|
|
114
|
+
reqData = { ...reqData, code };
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
const token = convertStringToBase64(
|
|
118
|
+
`${this.config.apiKey}:${this.config.apiSecret}`
|
|
119
|
+
);
|
|
120
|
+
|
|
107
121
|
let url = `${this.config.domain}/service/panel/authentication/v1.0/organization/${this.config.organizationId}/oauth/token`;
|
|
108
|
-
|
|
122
|
+
const rawRequest = {
|
|
123
|
+
method: "POST",
|
|
124
|
+
url: url,
|
|
125
|
+
data: querystring.stringify(reqData),
|
|
126
|
+
headers: {
|
|
127
|
+
Authorization: `Basic ${token}`,
|
|
128
|
+
"Content-Type": "application/x-www-form-urlencoded",
|
|
129
|
+
},
|
|
130
|
+
};
|
|
131
|
+
|
|
132
|
+
Logger({ level: "INFO", message: "Done." });
|
|
133
|
+
return fdkAxios.request(rawRequest);
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
async getOfflineAccessToken(scopes, code) {
|
|
137
|
+
try {
|
|
138
|
+
let res = await this.getOfflineAccessTokenObj(scopes, code);
|
|
139
|
+
this.setToken(res);
|
|
140
|
+
this.token_expires_at =
|
|
141
|
+
new Date().getTime() + this.token_expires_in * 1000;
|
|
142
|
+
return res;
|
|
143
|
+
} catch (error) {
|
|
144
|
+
if (error.isAxiosError) {
|
|
145
|
+
throw new FDKTokenIssueError(error.message);
|
|
146
|
+
}
|
|
147
|
+
throw error;
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
async getOfflineAccessTokenObj(scopes, code) {
|
|
152
|
+
Logger({ type: "DEBUG", message: "Fetching partner offline token" });
|
|
153
|
+
|
|
154
|
+
let url = `${this.config.domain}/service/panel/authentication/v1.0/organization/${this.config.organizationId}/oauth/offline-token`;
|
|
155
|
+
|
|
156
|
+
let data = {
|
|
157
|
+
client_id: this.config.apiKey,
|
|
158
|
+
client_secret: this.config.apiSecret,
|
|
159
|
+
grant_type: "authorization_code",
|
|
160
|
+
scope: scopes,
|
|
161
|
+
code: code,
|
|
162
|
+
};
|
|
163
|
+
|
|
164
|
+
const token = convertStringToBase64(
|
|
165
|
+
`${this.config.apiKey}:${this.config.apiSecret}`
|
|
166
|
+
);
|
|
167
|
+
|
|
168
|
+
const rawRequest = {
|
|
169
|
+
method: "POST",
|
|
170
|
+
url: url,
|
|
171
|
+
data: data,
|
|
172
|
+
headers: {
|
|
173
|
+
Authorization: `Basic ${token}`,
|
|
174
|
+
"Content-Type": "application/json",
|
|
175
|
+
},
|
|
176
|
+
};
|
|
177
|
+
return fdkAxios.request(rawRequest);
|
|
109
178
|
}
|
|
110
179
|
}
|
|
111
180
|
|
|
@@ -15,6 +15,30 @@ declare class Catalog {
|
|
|
15
15
|
* @description: Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addCollectionItems/).
|
|
16
16
|
*/
|
|
17
17
|
addCollectionItems({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.AddCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdatedResponse>;
|
|
18
|
+
/**
|
|
19
|
+
* @param {CatalogPlatformApplicationValidator.CreateAppCategoryReturnConfigurationParam} arg
|
|
20
|
+
* - Arg object
|
|
21
|
+
*
|
|
22
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
23
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
24
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
25
|
+
* @name createAppCategoryReturnConfiguration
|
|
26
|
+
* @summary: Create Category level Application Return Configuration setttings
|
|
27
|
+
* @description: Create Category level Application Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppCategoryReturnConfiguration/).
|
|
28
|
+
*/
|
|
29
|
+
createAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
30
|
+
/**
|
|
31
|
+
* @param {CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam} arg
|
|
32
|
+
* - Arg object
|
|
33
|
+
*
|
|
34
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
35
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
36
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
37
|
+
* @name createAppReturnConfiguration
|
|
38
|
+
* @summary: Create Return configuration level set for an application
|
|
39
|
+
* @description: Create Return configuration level set for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppReturnConfiguration/).
|
|
40
|
+
*/
|
|
41
|
+
createAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
18
42
|
/**
|
|
19
43
|
* @param {CatalogPlatformApplicationValidator.CreateCollectionParam} arg - Arg object
|
|
20
44
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -116,6 +140,18 @@ declare class Catalog {
|
|
|
116
140
|
* @description: This view allows you to modify searchable attributes for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSearchConfiguration/).
|
|
117
141
|
*/
|
|
118
142
|
createSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateSearchConfigurationResponse>;
|
|
143
|
+
/**
|
|
144
|
+
* @param {CatalogPlatformApplicationValidator.DeleteAppCategoryReturnConfigurationParam} arg
|
|
145
|
+
* - Arg object
|
|
146
|
+
*
|
|
147
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
148
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
149
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
150
|
+
* @name deleteAppCategoryReturnConfiguration
|
|
151
|
+
* @summary: Delete Category level Application Return Configuration setttings
|
|
152
|
+
* @description: Delete Category level Application Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAppCategoryReturnConfiguration/).
|
|
153
|
+
*/
|
|
154
|
+
deleteAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
119
155
|
/**
|
|
120
156
|
* @param {CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam} arg
|
|
121
157
|
* - Arg object
|
|
@@ -213,6 +249,20 @@ declare class Catalog {
|
|
|
213
249
|
* @description: Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllSearchKeyword/).
|
|
214
250
|
*/
|
|
215
251
|
getAllSearchKeyword({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsResponse>;
|
|
252
|
+
/**
|
|
253
|
+
* @param {CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam} arg
|
|
254
|
+
* - Arg object
|
|
255
|
+
*
|
|
256
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
257
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
258
|
+
* @returns {Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponse>}
|
|
259
|
+
* - Success response
|
|
260
|
+
*
|
|
261
|
+
* @name getAppCategoryReturnConfig
|
|
262
|
+
* @summary: Get all category level configuration level set for an application
|
|
263
|
+
* @description: Get all category level configuration level set for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppCategoryReturnConfig/).
|
|
264
|
+
*/
|
|
265
|
+
getAppCategoryReturnConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponse>;
|
|
216
266
|
/**
|
|
217
267
|
* @param {CatalogPlatformApplicationValidator.GetAppInventoryParam} arg - Arg object
|
|
218
268
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -281,6 +331,18 @@ declare class Catalog {
|
|
|
281
331
|
* @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. If successful, returns a Product resource in the response body specified in `ApplicationProductListingResponseDatabasePowered` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProducts/).
|
|
282
332
|
*/
|
|
283
333
|
getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.RawProductListingResponse>;
|
|
334
|
+
/**
|
|
335
|
+
* @param {CatalogPlatformApplicationValidator.GetAppReturnConfigurationParam} arg
|
|
336
|
+
* - Arg object
|
|
337
|
+
*
|
|
338
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
339
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
340
|
+
* @returns {Promise<CatalogPlatformModel.AppReturnConfigResponse>} - Success response
|
|
341
|
+
* @name getAppReturnConfiguration
|
|
342
|
+
* @summary: Get Return configuration level set for an application
|
|
343
|
+
* @description: Get Product Return configuration set at an application level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppReturnConfiguration/).
|
|
344
|
+
*/
|
|
345
|
+
getAppReturnConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppReturnConfigResponse>;
|
|
284
346
|
/**
|
|
285
347
|
* @param {CatalogPlatformApplicationValidator.GetAppicationProductsParam} arg
|
|
286
348
|
* - Arg object
|
|
@@ -739,6 +801,18 @@ declare class Catalog {
|
|
|
739
801
|
* @description: This API helps to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategory/).
|
|
740
802
|
*/
|
|
741
803
|
updateAppCategory({ categoryUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
804
|
+
/**
|
|
805
|
+
* @param {CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam} arg
|
|
806
|
+
* - Arg object
|
|
807
|
+
*
|
|
808
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
809
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
810
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
811
|
+
* @name updateAppCategoryReturnConfiguration
|
|
812
|
+
* @summary: Update Category level Application Return Configuration setttings
|
|
813
|
+
* @description: Update Category level Application Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategoryReturnConfiguration/).
|
|
814
|
+
*/
|
|
815
|
+
updateAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
742
816
|
/**
|
|
743
817
|
* @param {CatalogPlatformApplicationValidator.UpdateAppDepartmentParam} arg
|
|
744
818
|
* - Arg object
|
|
@@ -773,6 +847,18 @@ declare class Catalog {
|
|
|
773
847
|
* @description: This API helps to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppProduct/).
|
|
774
848
|
*/
|
|
775
849
|
updateAppProduct({ itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
850
|
+
/**
|
|
851
|
+
* @param {CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam} arg
|
|
852
|
+
* - Arg object
|
|
853
|
+
*
|
|
854
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
855
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
856
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
857
|
+
* @name updateAppReturnConfiguration
|
|
858
|
+
* @summary: Update Return configuration level set for an application
|
|
859
|
+
* @description: Update Return configuration level set for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppReturnConfiguration/).
|
|
860
|
+
*/
|
|
861
|
+
updateAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
776
862
|
/**
|
|
777
863
|
* @param {CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam} arg
|
|
778
864
|
* - Arg object
|