@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
|
@@ -11,21 +11,10 @@ declare class Communication {
|
|
|
11
11
|
* @returns {Promise<CommunicationPlatformModel.SystemNotifications>} -
|
|
12
12
|
* Success response
|
|
13
13
|
* @name getSystemNotifications
|
|
14
|
-
* @summary: Get system notifications
|
|
15
|
-
* @description:
|
|
14
|
+
* @summary: Get system notifications.
|
|
15
|
+
* @description: Retrieve system notifications related to communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemNotifications/).
|
|
16
16
|
*/
|
|
17
17
|
getSystemNotifications({ pageNo, pageSize, requestHeaders }?: CommunicationPlatformValidator.GetSystemNotificationsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemNotifications>;
|
|
18
|
-
/**
|
|
19
|
-
* @param {Object} arg - Arg object.
|
|
20
|
-
* @param {number} [arg.pageSize] -
|
|
21
|
-
* @returns {Paginator<CommunicationPlatformModel.SystemNotifications>}
|
|
22
|
-
* @summary: Get system notifications
|
|
23
|
-
* @description: Get system notifications
|
|
24
|
-
*/
|
|
25
|
-
getSystemNotificationsPaginator({ pageSize }?: {
|
|
26
|
-
pageSize?: number;
|
|
27
|
-
}): Paginator<CommunicationPlatformModel.SystemNotifications>;
|
|
28
18
|
}
|
|
29
19
|
import CommunicationPlatformValidator = require("./CommunicationPlatformValidator");
|
|
30
20
|
import CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
31
|
-
import Paginator = require("../../common/Paginator");
|
|
@@ -23,8 +23,8 @@ class Communication {
|
|
|
23
23
|
* @returns {Promise<CommunicationPlatformModel.SystemNotifications>} -
|
|
24
24
|
* Success response
|
|
25
25
|
* @name getSystemNotifications
|
|
26
|
-
* @summary: Get system notifications
|
|
27
|
-
* @description:
|
|
26
|
+
* @summary: Get system notifications.
|
|
27
|
+
* @description: Retrieve system notifications related to communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemNotifications/).
|
|
28
28
|
*/
|
|
29
29
|
async getSystemNotifications(
|
|
30
30
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -101,33 +101,6 @@ class Communication {
|
|
|
101
101
|
|
|
102
102
|
return response;
|
|
103
103
|
}
|
|
104
|
-
|
|
105
|
-
/**
|
|
106
|
-
* @param {Object} arg - Arg object.
|
|
107
|
-
* @param {number} [arg.pageSize] -
|
|
108
|
-
* @returns {Paginator<CommunicationPlatformModel.SystemNotifications>}
|
|
109
|
-
* @summary: Get system notifications
|
|
110
|
-
* @description: Get system notifications
|
|
111
|
-
*/
|
|
112
|
-
getSystemNotificationsPaginator({ pageSize } = {}) {
|
|
113
|
-
const paginator = new Paginator();
|
|
114
|
-
const callback = async () => {
|
|
115
|
-
const pageId = paginator.nextId;
|
|
116
|
-
const pageNo = paginator.pageNo;
|
|
117
|
-
const pageType = "number";
|
|
118
|
-
const data = await this.getSystemNotifications({
|
|
119
|
-
pageNo: pageNo,
|
|
120
|
-
pageSize: pageSize,
|
|
121
|
-
});
|
|
122
|
-
paginator.setPaginator({
|
|
123
|
-
hasNext: data.page.has_next ? true : false,
|
|
124
|
-
nextId: data.page.next_id,
|
|
125
|
-
});
|
|
126
|
-
return data;
|
|
127
|
-
};
|
|
128
|
-
paginator.setCallback(callback.bind(this));
|
|
129
|
-
return paginator;
|
|
130
|
-
}
|
|
131
104
|
}
|
|
132
105
|
|
|
133
106
|
module.exports = Communication;
|
|
@@ -10,8 +10,8 @@ declare class CompanyProfile {
|
|
|
10
10
|
* - Success response
|
|
11
11
|
*
|
|
12
12
|
* @name cbsOnboardGet
|
|
13
|
-
* @summary: Get company
|
|
14
|
-
* @description:
|
|
13
|
+
* @summary: Get company onboard data.
|
|
14
|
+
* @description: View the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/cbsOnboardGet/).
|
|
15
15
|
*/
|
|
16
16
|
cbsOnboardGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponse>;
|
|
17
17
|
/**
|
|
@@ -21,8 +21,8 @@ declare class CompanyProfile {
|
|
|
21
21
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
22
22
|
* Success response
|
|
23
23
|
* @name createBrand
|
|
24
|
-
* @summary: Create
|
|
25
|
-
* @description:
|
|
24
|
+
* @summary: Create brand.
|
|
25
|
+
* @description: Allows to create a brand associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createBrand/).
|
|
26
26
|
*/
|
|
27
27
|
createBrand({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
|
|
28
28
|
/**
|
|
@@ -34,8 +34,8 @@ declare class CompanyProfile {
|
|
|
34
34
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
35
35
|
* Success response
|
|
36
36
|
* @name createCompanyBrandMapping
|
|
37
|
-
* @summary: Create
|
|
38
|
-
* @description:
|
|
37
|
+
* @summary: Create company-brand mapping.
|
|
38
|
+
* @description: Establish a mapping between a company and a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createCompanyBrandMapping/).
|
|
39
39
|
*/
|
|
40
40
|
createCompanyBrandMapping({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateCompanyBrandMappingParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
|
|
41
41
|
/**
|
|
@@ -45,8 +45,8 @@ declare class CompanyProfile {
|
|
|
45
45
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
46
46
|
* Success response
|
|
47
47
|
* @name createLocation
|
|
48
|
-
* @summary: Create
|
|
49
|
-
* @description:
|
|
48
|
+
* @summary: Create location.
|
|
49
|
+
* @description: Create a new location. Allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocation/).
|
|
50
50
|
*/
|
|
51
51
|
createLocation({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
|
|
52
52
|
/**
|
|
@@ -56,8 +56,8 @@ declare class CompanyProfile {
|
|
|
56
56
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
57
57
|
* Success response
|
|
58
58
|
* @name createLocationBulk
|
|
59
|
-
* @summary: Create
|
|
60
|
-
* @description:
|
|
59
|
+
* @summary: Create locations in bulk.
|
|
60
|
+
* @description: Allows to create a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocationBulk/).
|
|
61
61
|
*/
|
|
62
62
|
createLocationBulk({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationBulkParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
|
|
63
63
|
/**
|
|
@@ -67,8 +67,8 @@ declare class CompanyProfile {
|
|
|
67
67
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
68
68
|
* Success response
|
|
69
69
|
* @name editBrand
|
|
70
|
-
* @summary: Edit
|
|
71
|
-
* @description:
|
|
70
|
+
* @summary: Edit brand details.
|
|
71
|
+
* @description: Modify details and settings of a specific brand. Allows to edit meta of a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/editBrand/).
|
|
72
72
|
*/
|
|
73
73
|
editBrand({ brandId, body, requestHeaders }?: CompanyProfilePlatformValidator.EditBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
|
|
74
74
|
/**
|
|
@@ -79,8 +79,8 @@ declare class CompanyProfile {
|
|
|
79
79
|
* - Success response
|
|
80
80
|
*
|
|
81
81
|
* @name getBrand
|
|
82
|
-
* @summary: Get
|
|
83
|
-
* @description:
|
|
82
|
+
* @summary: Get brand details.
|
|
83
|
+
* @description: Retrieve detailed information about a specific brand. Get data associated to a particular company brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrand/).
|
|
84
84
|
*/
|
|
85
85
|
getBrand({ brandId, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetBrandResponseSerializer>;
|
|
86
86
|
/**
|
|
@@ -91,8 +91,8 @@ declare class CompanyProfile {
|
|
|
91
91
|
* - Success response
|
|
92
92
|
*
|
|
93
93
|
* @name getBrands
|
|
94
|
-
* @summary: Get brands
|
|
95
|
-
* @description:
|
|
94
|
+
* @summary: Get brands.
|
|
95
|
+
* @description: Retrieve a list of available brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrands/).
|
|
96
96
|
*/
|
|
97
97
|
getBrands({ pageNo, pageSize, q, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.CompanyBrandListSerializer>;
|
|
98
98
|
/**
|
|
@@ -101,8 +101,8 @@ declare class CompanyProfile {
|
|
|
101
101
|
* page. Default is 10.
|
|
102
102
|
* @param {string} [arg.q] - Search term for name.
|
|
103
103
|
* @returns {Paginator<CompanyProfilePlatformModel.CompanyBrandListSerializer>}
|
|
104
|
-
* @summary: Get brands
|
|
105
|
-
* @description:
|
|
104
|
+
* @summary: Get brands.
|
|
105
|
+
* @description: Retrieve a list of available brands.
|
|
106
106
|
*/
|
|
107
107
|
getBrandsPaginator({ pageSize, q }?: {
|
|
108
108
|
pageSize?: number;
|
|
@@ -115,8 +115,8 @@ declare class CompanyProfile {
|
|
|
115
115
|
* @returns {Promise<CompanyProfilePlatformModel.MetricsSerializer>} -
|
|
116
116
|
* Success response
|
|
117
117
|
* @name getCompanyMetrics
|
|
118
|
-
* @summary: Get company metrics
|
|
119
|
-
* @description:
|
|
118
|
+
* @summary: Get company metrics.
|
|
119
|
+
* @description: Allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getCompanyMetrics/).
|
|
120
120
|
*/
|
|
121
121
|
getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.MetricsSerializer>;
|
|
122
122
|
/**
|
|
@@ -126,8 +126,8 @@ declare class CompanyProfile {
|
|
|
126
126
|
* @returns {Promise<CompanyProfilePlatformModel.GetLocationSerializer>} -
|
|
127
127
|
* Success response
|
|
128
128
|
* @name getLocationDetail
|
|
129
|
-
* @summary: Get
|
|
130
|
-
* @description:
|
|
129
|
+
* @summary: Get location detail.
|
|
130
|
+
* @description: Retrieve detailed information about a specific location. Get data associated to a specific location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationDetail/).
|
|
131
131
|
*/
|
|
132
132
|
getLocationDetail({ locationId, requestHeaders }?: CompanyProfilePlatformValidator.GetLocationDetailParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetLocationSerializer>;
|
|
133
133
|
/**
|
|
@@ -138,8 +138,8 @@ declare class CompanyProfile {
|
|
|
138
138
|
* - Success response
|
|
139
139
|
*
|
|
140
140
|
* @name getLocationTags
|
|
141
|
-
* @summary: Get tags
|
|
142
|
-
* @description:
|
|
141
|
+
* @summary: Get location tags.
|
|
142
|
+
* @description: Retrieve all the tags associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationTags/).
|
|
143
143
|
*/
|
|
144
144
|
getLocationTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.StoreTagsResponseSchema>;
|
|
145
145
|
/**
|
|
@@ -149,8 +149,8 @@ declare class CompanyProfile {
|
|
|
149
149
|
* @returns {Promise<CompanyProfilePlatformModel.LocationListSerializer>} -
|
|
150
150
|
* Success response
|
|
151
151
|
* @name getLocations
|
|
152
|
-
* @summary: Get
|
|
153
|
-
* @description:
|
|
152
|
+
* @summary: Get company locations.
|
|
153
|
+
* @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocations/).
|
|
154
154
|
*/
|
|
155
155
|
getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, types, tags, requestHeaders, }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.LocationListSerializer>;
|
|
156
156
|
/**
|
|
@@ -168,8 +168,8 @@ declare class CompanyProfile {
|
|
|
168
168
|
* @param {string[]} [arg.tags] - Helps to get the location list on the
|
|
169
169
|
* basis of multiple location tag.
|
|
170
170
|
* @returns {Paginator<CompanyProfilePlatformModel.LocationListSerializer>}
|
|
171
|
-
* @summary: Get
|
|
172
|
-
* @description:
|
|
171
|
+
* @summary: Get company locations.
|
|
172
|
+
* @description: Retrieve a list of locations associated with the company.
|
|
173
173
|
*/
|
|
174
174
|
getLocationsPaginator({ storeType, q, stage, pageSize, locationIds, types, tags, }?: {
|
|
175
175
|
storeType?: string;
|
|
@@ -187,8 +187,8 @@ declare class CompanyProfile {
|
|
|
187
187
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
188
188
|
* Success response
|
|
189
189
|
* @name updateCompany
|
|
190
|
-
* @summary:
|
|
191
|
-
* @description:
|
|
190
|
+
* @summary: Update company information.
|
|
191
|
+
* @description: Allows to edit the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateCompany/).
|
|
192
192
|
*/
|
|
193
193
|
updateCompany({ body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateCompanyParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
|
|
194
194
|
/**
|
|
@@ -198,8 +198,8 @@ declare class CompanyProfile {
|
|
|
198
198
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
199
199
|
* Success response
|
|
200
200
|
* @name updateLocation
|
|
201
|
-
* @summary:
|
|
202
|
-
* @description:
|
|
201
|
+
* @summary: Update location.
|
|
202
|
+
* @description: Allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateLocation/).
|
|
203
203
|
*/
|
|
204
204
|
updateLocation({ locationId, body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
|
|
205
205
|
}
|
|
@@ -22,8 +22,8 @@ class CompanyProfile {
|
|
|
22
22
|
* - Success response
|
|
23
23
|
*
|
|
24
24
|
* @name cbsOnboardGet
|
|
25
|
-
* @summary: Get company
|
|
26
|
-
* @description:
|
|
25
|
+
* @summary: Get company onboard data.
|
|
26
|
+
* @description: View the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/cbsOnboardGet/).
|
|
27
27
|
*/
|
|
28
28
|
async cbsOnboardGet(
|
|
29
29
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -98,8 +98,8 @@ class CompanyProfile {
|
|
|
98
98
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
99
99
|
* Success response
|
|
100
100
|
* @name createBrand
|
|
101
|
-
* @summary: Create
|
|
102
|
-
* @description:
|
|
101
|
+
* @summary: Create brand.
|
|
102
|
+
* @description: Allows to create a brand associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createBrand/).
|
|
103
103
|
*/
|
|
104
104
|
async createBrand(
|
|
105
105
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -180,8 +180,8 @@ class CompanyProfile {
|
|
|
180
180
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
181
181
|
* Success response
|
|
182
182
|
* @name createCompanyBrandMapping
|
|
183
|
-
* @summary: Create
|
|
184
|
-
* @description:
|
|
183
|
+
* @summary: Create company-brand mapping.
|
|
184
|
+
* @description: Establish a mapping between a company and a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createCompanyBrandMapping/).
|
|
185
185
|
*/
|
|
186
186
|
async createCompanyBrandMapping(
|
|
187
187
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -262,8 +262,8 @@ class CompanyProfile {
|
|
|
262
262
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
263
263
|
* Success response
|
|
264
264
|
* @name createLocation
|
|
265
|
-
* @summary: Create
|
|
266
|
-
* @description:
|
|
265
|
+
* @summary: Create location.
|
|
266
|
+
* @description: Create a new location. Allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocation/).
|
|
267
267
|
*/
|
|
268
268
|
async createLocation(
|
|
269
269
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -342,8 +342,8 @@ class CompanyProfile {
|
|
|
342
342
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
343
343
|
* Success response
|
|
344
344
|
* @name createLocationBulk
|
|
345
|
-
* @summary: Create
|
|
346
|
-
* @description:
|
|
345
|
+
* @summary: Create locations in bulk.
|
|
346
|
+
* @description: Allows to create a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocationBulk/).
|
|
347
347
|
*/
|
|
348
348
|
async createLocationBulk(
|
|
349
349
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -424,8 +424,8 @@ class CompanyProfile {
|
|
|
424
424
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
425
425
|
* Success response
|
|
426
426
|
* @name editBrand
|
|
427
|
-
* @summary: Edit
|
|
428
|
-
* @description:
|
|
427
|
+
* @summary: Edit brand details.
|
|
428
|
+
* @description: Modify details and settings of a specific brand. Allows to edit meta of a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/editBrand/).
|
|
429
429
|
*/
|
|
430
430
|
async editBrand(
|
|
431
431
|
{ brandId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -507,8 +507,8 @@ class CompanyProfile {
|
|
|
507
507
|
* - Success response
|
|
508
508
|
*
|
|
509
509
|
* @name getBrand
|
|
510
|
-
* @summary: Get
|
|
511
|
-
* @description:
|
|
510
|
+
* @summary: Get brand details.
|
|
511
|
+
* @description: Retrieve detailed information about a specific brand. Get data associated to a particular company brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrand/).
|
|
512
512
|
*/
|
|
513
513
|
async getBrand(
|
|
514
514
|
{ brandId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -588,8 +588,8 @@ class CompanyProfile {
|
|
|
588
588
|
* - Success response
|
|
589
589
|
*
|
|
590
590
|
* @name getBrands
|
|
591
|
-
* @summary: Get brands
|
|
592
|
-
* @description:
|
|
591
|
+
* @summary: Get brands.
|
|
592
|
+
* @description: Retrieve a list of available brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrands/).
|
|
593
593
|
*/
|
|
594
594
|
async getBrands(
|
|
595
595
|
{ pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -674,8 +674,8 @@ class CompanyProfile {
|
|
|
674
674
|
* page. Default is 10.
|
|
675
675
|
* @param {string} [arg.q] - Search term for name.
|
|
676
676
|
* @returns {Paginator<CompanyProfilePlatformModel.CompanyBrandListSerializer>}
|
|
677
|
-
* @summary: Get brands
|
|
678
|
-
* @description:
|
|
677
|
+
* @summary: Get brands.
|
|
678
|
+
* @description: Retrieve a list of available brands.
|
|
679
679
|
*/
|
|
680
680
|
getBrandsPaginator({ pageSize, q } = {}) {
|
|
681
681
|
const paginator = new Paginator();
|
|
@@ -705,8 +705,8 @@ class CompanyProfile {
|
|
|
705
705
|
* @returns {Promise<CompanyProfilePlatformModel.MetricsSerializer>} -
|
|
706
706
|
* Success response
|
|
707
707
|
* @name getCompanyMetrics
|
|
708
|
-
* @summary: Get company metrics
|
|
709
|
-
* @description:
|
|
708
|
+
* @summary: Get company metrics.
|
|
709
|
+
* @description: Allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getCompanyMetrics/).
|
|
710
710
|
*/
|
|
711
711
|
async getCompanyMetrics(
|
|
712
712
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -783,8 +783,8 @@ class CompanyProfile {
|
|
|
783
783
|
* @returns {Promise<CompanyProfilePlatformModel.GetLocationSerializer>} -
|
|
784
784
|
* Success response
|
|
785
785
|
* @name getLocationDetail
|
|
786
|
-
* @summary: Get
|
|
787
|
-
* @description:
|
|
786
|
+
* @summary: Get location detail.
|
|
787
|
+
* @description: Retrieve detailed information about a specific location. Get data associated to a specific location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationDetail/).
|
|
788
788
|
*/
|
|
789
789
|
async getLocationDetail(
|
|
790
790
|
{ locationId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -866,8 +866,8 @@ class CompanyProfile {
|
|
|
866
866
|
* - Success response
|
|
867
867
|
*
|
|
868
868
|
* @name getLocationTags
|
|
869
|
-
* @summary: Get tags
|
|
870
|
-
* @description:
|
|
869
|
+
* @summary: Get location tags.
|
|
870
|
+
* @description: Retrieve all the tags associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationTags/).
|
|
871
871
|
*/
|
|
872
872
|
async getLocationTags(
|
|
873
873
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -944,8 +944,8 @@ class CompanyProfile {
|
|
|
944
944
|
* @returns {Promise<CompanyProfilePlatformModel.LocationListSerializer>} -
|
|
945
945
|
* Success response
|
|
946
946
|
* @name getLocations
|
|
947
|
-
* @summary: Get
|
|
948
|
-
* @description:
|
|
947
|
+
* @summary: Get company locations.
|
|
948
|
+
* @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocations/).
|
|
949
949
|
*/
|
|
950
950
|
async getLocations(
|
|
951
951
|
{
|
|
@@ -1064,8 +1064,8 @@ class CompanyProfile {
|
|
|
1064
1064
|
* @param {string[]} [arg.tags] - Helps to get the location list on the
|
|
1065
1065
|
* basis of multiple location tag.
|
|
1066
1066
|
* @returns {Paginator<CompanyProfilePlatformModel.LocationListSerializer>}
|
|
1067
|
-
* @summary: Get
|
|
1068
|
-
* @description:
|
|
1067
|
+
* @summary: Get company locations.
|
|
1068
|
+
* @description: Retrieve a list of locations associated with the company.
|
|
1069
1069
|
*/
|
|
1070
1070
|
getLocationsPaginator({
|
|
1071
1071
|
storeType,
|
|
@@ -1108,8 +1108,8 @@ class CompanyProfile {
|
|
|
1108
1108
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
1109
1109
|
* Success response
|
|
1110
1110
|
* @name updateCompany
|
|
1111
|
-
* @summary:
|
|
1112
|
-
* @description:
|
|
1111
|
+
* @summary: Update company information.
|
|
1112
|
+
* @description: Allows to edit the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateCompany/).
|
|
1113
1113
|
*/
|
|
1114
1114
|
async updateCompany(
|
|
1115
1115
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1188,8 +1188,8 @@ class CompanyProfile {
|
|
|
1188
1188
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
1189
1189
|
* Success response
|
|
1190
1190
|
* @name updateLocation
|
|
1191
|
-
* @summary:
|
|
1192
|
-
* @description:
|
|
1191
|
+
* @summary: Update location.
|
|
1192
|
+
* @description: Allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateLocation/).
|
|
1193
1193
|
*/
|
|
1194
1194
|
async updateLocation(
|
|
1195
1195
|
{ locationId, body, requestHeaders } = { requestHeaders: {} },
|