@gofynd/fdk-client-javascript 1.4.2-beta.6 → 1.4.3
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 +5 -3
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +25 -25
- package/sdk/application/Cart/CartApplicationClient.js +25 -25
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +40 -40
- package/sdk/application/Catalog/CatalogApplicationClient.js +40 -40
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +10 -10
- package/sdk/application/Content/ContentApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +12 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +7 -7
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +13 -13
- package/sdk/application/Order/OrderApplicationClient.js +16 -12
- package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -0
- package/sdk/application/Order/OrderApplicationValidator.js +3 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +47 -47
- package/sdk/application/Payment/PaymentApplicationClient.js +52 -52
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -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 +27 -27
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +28 -28
- package/sdk/application/User/UserApplicationClient.js +28 -28
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +33 -19
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +2 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +1 -1
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +4 -4
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +3 -3
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +19 -19
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +4 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +17 -17
- package/sdk/platform/Billing/BillingPlatformClient.js +17 -17
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +49 -49
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +49 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +60 -60
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +62 -62
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +87 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.js +87 -87
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +58 -58
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +58 -58
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +18 -18
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +63 -63
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +3 -3
- package/sdk/platform/Content/ContentPlatformClient.js +9 -9
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +23 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +27 -27
- package/sdk/platform/Finance/FinancePlatformClient.js +27 -27
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +2 -2
- package/sdk/platform/Order/OrderPlatformClient.d.ts +43 -43
- package/sdk/platform/Order/OrderPlatformClient.js +55 -44
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
- package/sdk/platform/Order/OrderPlatformModel.js +8 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +14 -0
- package/sdk/platform/Order/OrderPlatformValidator.js +6 -0
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +38 -38
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +28 -28
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +28 -28
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/User/UserPlatformApplicationClient.js +16 -16
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +16 -16
- package/sdk/platform/Webhook/WebhookPlatformClient.js +16 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +5 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -50
- package/sdk/public/Billing/BillingPublicClient.d.ts +1 -1
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
|
@@ -10,7 +10,7 @@ declare class CompanyProfile {
|
|
|
10
10
|
* - Success response
|
|
11
11
|
*
|
|
12
12
|
* @name cbsOnboardGet
|
|
13
|
-
* @summary: Get company onboard data
|
|
13
|
+
* @summary: Get company onboard data
|
|
14
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>;
|
|
@@ -21,7 +21,7 @@ declare class CompanyProfile {
|
|
|
21
21
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
22
22
|
* Success response
|
|
23
23
|
* @name createBrand
|
|
24
|
-
* @summary: Create brand
|
|
24
|
+
* @summary: Create brand
|
|
25
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>;
|
|
@@ -34,7 +34,7 @@ declare class CompanyProfile {
|
|
|
34
34
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
35
35
|
* Success response
|
|
36
36
|
* @name createCompanyBrandMapping
|
|
37
|
-
* @summary: Create company-brand mapping
|
|
37
|
+
* @summary: Create company-brand mapping
|
|
38
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>;
|
|
@@ -45,7 +45,7 @@ declare class CompanyProfile {
|
|
|
45
45
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
46
46
|
* Success response
|
|
47
47
|
* @name createLocation
|
|
48
|
-
* @summary: Create location
|
|
48
|
+
* @summary: Create location
|
|
49
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>;
|
|
@@ -56,7 +56,7 @@ declare class CompanyProfile {
|
|
|
56
56
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
57
57
|
* Success response
|
|
58
58
|
* @name createLocationBulk
|
|
59
|
-
* @summary: Create locations in bulk
|
|
59
|
+
* @summary: Create locations in bulk
|
|
60
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>;
|
|
@@ -67,7 +67,7 @@ declare class CompanyProfile {
|
|
|
67
67
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
68
68
|
* Success response
|
|
69
69
|
* @name editBrand
|
|
70
|
-
* @summary: Edit brand details
|
|
70
|
+
* @summary: Edit brand details
|
|
71
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>;
|
|
@@ -79,7 +79,7 @@ declare class CompanyProfile {
|
|
|
79
79
|
* - Success response
|
|
80
80
|
*
|
|
81
81
|
* @name getBrand
|
|
82
|
-
* @summary: Get brand details
|
|
82
|
+
* @summary: Get brand details
|
|
83
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>;
|
|
@@ -91,7 +91,7 @@ declare class CompanyProfile {
|
|
|
91
91
|
* - Success response
|
|
92
92
|
*
|
|
93
93
|
* @name getBrands
|
|
94
|
-
* @summary: Get brands
|
|
94
|
+
* @summary: Get brands
|
|
95
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>;
|
|
@@ -101,7 +101,7 @@ 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
|
|
104
|
+
* @summary: Get brands
|
|
105
105
|
* @description: Retrieve a list of available brands.
|
|
106
106
|
*/
|
|
107
107
|
getBrandsPaginator({ pageSize, q }?: {
|
|
@@ -115,7 +115,7 @@ declare class CompanyProfile {
|
|
|
115
115
|
* @returns {Promise<CompanyProfilePlatformModel.MetricsSerializer>} -
|
|
116
116
|
* Success response
|
|
117
117
|
* @name getCompanyMetrics
|
|
118
|
-
* @summary: Get company metrics
|
|
118
|
+
* @summary: Get company metrics
|
|
119
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>;
|
|
@@ -126,7 +126,7 @@ declare class CompanyProfile {
|
|
|
126
126
|
* @returns {Promise<CompanyProfilePlatformModel.GetLocationSerializer>} -
|
|
127
127
|
* Success response
|
|
128
128
|
* @name getLocationDetail
|
|
129
|
-
* @summary: Get location detail
|
|
129
|
+
* @summary: Get location detail
|
|
130
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>;
|
|
@@ -138,7 +138,7 @@ declare class CompanyProfile {
|
|
|
138
138
|
* - Success response
|
|
139
139
|
*
|
|
140
140
|
* @name getLocationTags
|
|
141
|
-
* @summary: Get location tags
|
|
141
|
+
* @summary: Get location tags
|
|
142
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>;
|
|
@@ -149,7 +149,7 @@ declare class CompanyProfile {
|
|
|
149
149
|
* @returns {Promise<CompanyProfilePlatformModel.LocationListSerializer>} -
|
|
150
150
|
* Success response
|
|
151
151
|
* @name getLocations
|
|
152
|
-
* @summary: Get company locations
|
|
152
|
+
* @summary: Get company locations
|
|
153
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>;
|
|
@@ -168,7 +168,7 @@ 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 company locations
|
|
171
|
+
* @summary: Get company locations
|
|
172
172
|
* @description: Retrieve a list of locations associated with the company.
|
|
173
173
|
*/
|
|
174
174
|
getLocationsPaginator({ storeType, q, stage, pageSize, locationIds, types, tags, }?: {
|
|
@@ -187,7 +187,7 @@ declare class CompanyProfile {
|
|
|
187
187
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
188
188
|
* Success response
|
|
189
189
|
* @name updateCompany
|
|
190
|
-
* @summary: Update company information
|
|
190
|
+
* @summary: Update company information
|
|
191
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>;
|
|
@@ -198,7 +198,7 @@ declare class CompanyProfile {
|
|
|
198
198
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
199
199
|
* Success response
|
|
200
200
|
* @name updateLocation
|
|
201
|
-
* @summary: Update location
|
|
201
|
+
* @summary: Update location
|
|
202
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>;
|
|
@@ -22,7 +22,7 @@ class CompanyProfile {
|
|
|
22
22
|
* - Success response
|
|
23
23
|
*
|
|
24
24
|
* @name cbsOnboardGet
|
|
25
|
-
* @summary: Get company onboard data
|
|
25
|
+
* @summary: Get company onboard data
|
|
26
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(
|
|
@@ -98,7 +98,7 @@ class CompanyProfile {
|
|
|
98
98
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
99
99
|
* Success response
|
|
100
100
|
* @name createBrand
|
|
101
|
-
* @summary: Create brand
|
|
101
|
+
* @summary: Create brand
|
|
102
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(
|
|
@@ -180,7 +180,7 @@ class CompanyProfile {
|
|
|
180
180
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
181
181
|
* Success response
|
|
182
182
|
* @name createCompanyBrandMapping
|
|
183
|
-
* @summary: Create company-brand mapping
|
|
183
|
+
* @summary: Create company-brand mapping
|
|
184
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(
|
|
@@ -262,7 +262,7 @@ class CompanyProfile {
|
|
|
262
262
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
263
263
|
* Success response
|
|
264
264
|
* @name createLocation
|
|
265
|
-
* @summary: Create location
|
|
265
|
+
* @summary: Create location
|
|
266
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(
|
|
@@ -342,7 +342,7 @@ class CompanyProfile {
|
|
|
342
342
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
343
343
|
* Success response
|
|
344
344
|
* @name createLocationBulk
|
|
345
|
-
* @summary: Create locations in bulk
|
|
345
|
+
* @summary: Create locations in bulk
|
|
346
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(
|
|
@@ -424,7 +424,7 @@ class CompanyProfile {
|
|
|
424
424
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
425
425
|
* Success response
|
|
426
426
|
* @name editBrand
|
|
427
|
-
* @summary: Edit brand details
|
|
427
|
+
* @summary: Edit brand details
|
|
428
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(
|
|
@@ -507,7 +507,7 @@ class CompanyProfile {
|
|
|
507
507
|
* - Success response
|
|
508
508
|
*
|
|
509
509
|
* @name getBrand
|
|
510
|
-
* @summary: Get brand details
|
|
510
|
+
* @summary: Get brand details
|
|
511
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(
|
|
@@ -588,7 +588,7 @@ class CompanyProfile {
|
|
|
588
588
|
* - Success response
|
|
589
589
|
*
|
|
590
590
|
* @name getBrands
|
|
591
|
-
* @summary: Get brands
|
|
591
|
+
* @summary: Get brands
|
|
592
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(
|
|
@@ -674,7 +674,7 @@ 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
|
|
677
|
+
* @summary: Get brands
|
|
678
678
|
* @description: Retrieve a list of available brands.
|
|
679
679
|
*/
|
|
680
680
|
getBrandsPaginator({ pageSize, q } = {}) {
|
|
@@ -705,7 +705,7 @@ class CompanyProfile {
|
|
|
705
705
|
* @returns {Promise<CompanyProfilePlatformModel.MetricsSerializer>} -
|
|
706
706
|
* Success response
|
|
707
707
|
* @name getCompanyMetrics
|
|
708
|
-
* @summary: Get company metrics
|
|
708
|
+
* @summary: Get company metrics
|
|
709
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(
|
|
@@ -783,7 +783,7 @@ class CompanyProfile {
|
|
|
783
783
|
* @returns {Promise<CompanyProfilePlatformModel.GetLocationSerializer>} -
|
|
784
784
|
* Success response
|
|
785
785
|
* @name getLocationDetail
|
|
786
|
-
* @summary: Get location detail
|
|
786
|
+
* @summary: Get location detail
|
|
787
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(
|
|
@@ -866,7 +866,7 @@ class CompanyProfile {
|
|
|
866
866
|
* - Success response
|
|
867
867
|
*
|
|
868
868
|
* @name getLocationTags
|
|
869
|
-
* @summary: Get location tags
|
|
869
|
+
* @summary: Get location tags
|
|
870
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(
|
|
@@ -944,7 +944,7 @@ class CompanyProfile {
|
|
|
944
944
|
* @returns {Promise<CompanyProfilePlatformModel.LocationListSerializer>} -
|
|
945
945
|
* Success response
|
|
946
946
|
* @name getLocations
|
|
947
|
-
* @summary: Get company locations
|
|
947
|
+
* @summary: Get company locations
|
|
948
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(
|
|
@@ -1064,7 +1064,7 @@ 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 company locations
|
|
1067
|
+
* @summary: Get company locations
|
|
1068
1068
|
* @description: Retrieve a list of locations associated with the company.
|
|
1069
1069
|
*/
|
|
1070
1070
|
getLocationsPaginator({
|
|
@@ -1108,7 +1108,7 @@ class CompanyProfile {
|
|
|
1108
1108
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
1109
1109
|
* Success response
|
|
1110
1110
|
* @name updateCompany
|
|
1111
|
-
* @summary: Update company information
|
|
1111
|
+
* @summary: Update company information
|
|
1112
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(
|
|
@@ -1188,7 +1188,7 @@ class CompanyProfile {
|
|
|
1188
1188
|
* @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
|
|
1189
1189
|
* Success response
|
|
1190
1190
|
* @name updateLocation
|
|
1191
|
-
* @summary: Update location
|
|
1191
|
+
* @summary: Update location
|
|
1192
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(
|
|
@@ -196,6 +196,7 @@ export = CompanyProfilePlatformModel;
|
|
|
196
196
|
* @property {number} [uid]
|
|
197
197
|
* @property {BrandBannerSerializer} banner
|
|
198
198
|
* @property {string} name
|
|
199
|
+
* @property {string} [slug]
|
|
199
200
|
*/
|
|
200
201
|
/**
|
|
201
202
|
* @typedef CompanySocialAccounts
|
|
@@ -650,6 +651,7 @@ type CreateUpdateBrandRequestSerializer = {
|
|
|
650
651
|
uid?: number;
|
|
651
652
|
banner: BrandBannerSerializer;
|
|
652
653
|
name: string;
|
|
654
|
+
slug?: string;
|
|
653
655
|
};
|
|
654
656
|
/** @returns {CompanySocialAccounts} */
|
|
655
657
|
declare function CompanySocialAccounts(): CompanySocialAccounts;
|
|
@@ -217,6 +217,7 @@ const Joi = require("joi");
|
|
|
217
217
|
* @property {number} [uid]
|
|
218
218
|
* @property {BrandBannerSerializer} banner
|
|
219
219
|
* @property {string} name
|
|
220
|
+
* @property {string} [slug]
|
|
220
221
|
*/
|
|
221
222
|
|
|
222
223
|
/**
|
|
@@ -739,6 +740,7 @@ class CompanyProfilePlatformModel {
|
|
|
739
740
|
uid: Joi.number(),
|
|
740
741
|
banner: CompanyProfilePlatformModel.BrandBannerSerializer().required(),
|
|
741
742
|
name: Joi.string().allow("").required(),
|
|
743
|
+
slug: Joi.string().allow(""),
|
|
742
744
|
});
|
|
743
745
|
}
|
|
744
746
|
|
|
@@ -9,7 +9,7 @@ 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 domain
|
|
12
|
+
* @summary: Add domain
|
|
13
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>;
|
|
@@ -21,7 +21,7 @@ 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 domain type
|
|
24
|
+
* @summary: Change domain type
|
|
25
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>;
|
|
@@ -33,7 +33,7 @@ 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 application API tokens
|
|
36
|
+
* @summary: Get application API tokens
|
|
37
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>;
|
|
@@ -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 application basic details
|
|
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,7 +57,7 @@ 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 application companies
|
|
60
|
+
* @summary: Get application companies
|
|
61
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>;
|
|
@@ -70,7 +70,7 @@ declare class Configuration {
|
|
|
70
70
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
|
|
71
71
|
* Success response
|
|
72
72
|
* @name getAppContactInfo
|
|
73
|
-
* @summary: Get application contact information
|
|
73
|
+
* @summary: Get application contact information
|
|
74
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/).
|
|
75
75
|
*/
|
|
76
76
|
getAppContactInfo({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInformation>;
|
|
@@ -83,7 +83,7 @@ declare class Configuration {
|
|
|
83
83
|
* @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
|
|
84
84
|
* Success response
|
|
85
85
|
* @name getAppCurrencyConfig
|
|
86
|
-
* @summary: Get application currency configuration
|
|
86
|
+
* @summary: Get application currency configuration
|
|
87
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/).
|
|
88
88
|
*/
|
|
89
89
|
getAppCurrencyConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppSupportedCurrency>;
|
|
@@ -96,7 +96,7 @@ declare class Configuration {
|
|
|
96
96
|
* @returns {Promise<ConfigurationPlatformModel.AppFeatureResponse>} -
|
|
97
97
|
* Success response
|
|
98
98
|
* @name getAppFeatures
|
|
99
|
-
* @summary: Get application features
|
|
99
|
+
* @summary: Get application features
|
|
100
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/).
|
|
101
101
|
*/
|
|
102
102
|
getAppFeatures({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppFeatureResponse>;
|
|
@@ -108,7 +108,7 @@ declare class Configuration {
|
|
|
108
108
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
109
109
|
* @returns {Promise<ConfigurationPlatformModel.StoresResponse>} - Success response
|
|
110
110
|
* @name getAppStores
|
|
111
|
-
* @summary: Get application stores
|
|
111
|
+
* @summary: Get application stores
|
|
112
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/).
|
|
113
113
|
*/
|
|
114
114
|
getAppStores({ pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetAppStoresParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.StoresResponse>;
|
|
@@ -121,7 +121,7 @@ declare class Configuration {
|
|
|
121
121
|
* @returns {Promise<ConfigurationPlatformModel.AppCurrencyResponse>} -
|
|
122
122
|
* Success response
|
|
123
123
|
* @name getAppSupportedCurrency
|
|
124
|
-
* @summary: Get supported currencies
|
|
124
|
+
* @summary: Get supported currencies
|
|
125
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/).
|
|
126
126
|
*/
|
|
127
127
|
getAppSupportedCurrency({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppCurrencyResponse>;
|
|
@@ -133,7 +133,7 @@ declare class Configuration {
|
|
|
133
133
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
134
134
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationById>} - Success response
|
|
135
135
|
* @name getApplicationById
|
|
136
|
-
* @summary: Get application by ID
|
|
136
|
+
* @summary: Get application by ID
|
|
137
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/).
|
|
138
138
|
*/
|
|
139
139
|
getApplicationById({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationById>;
|
|
@@ -146,7 +146,7 @@ declare class Configuration {
|
|
|
146
146
|
* @returns {Promise<ConfigurationPlatformModel.MobileAppConfiguration>} -
|
|
147
147
|
* Success response
|
|
148
148
|
* @name getBuildConfig
|
|
149
|
-
* @summary: Get build configuration
|
|
149
|
+
* @summary: Get build configuration
|
|
150
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/).
|
|
151
151
|
*/
|
|
152
152
|
getBuildConfig({ platformType, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetBuildConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.MobileAppConfiguration>;
|
|
@@ -159,7 +159,7 @@ declare class Configuration {
|
|
|
159
159
|
* @returns {Promise<ConfigurationPlatformModel.DomainStatusResponse>} -
|
|
160
160
|
* Success response
|
|
161
161
|
* @name getDomainStatus
|
|
162
|
-
* @summary: Get domain status
|
|
162
|
+
* @summary: Get domain status
|
|
163
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/).
|
|
164
164
|
*/
|
|
165
165
|
getDomainStatus({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetDomainStatusParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainStatusResponse>;
|
|
@@ -169,7 +169,7 @@ declare class Configuration {
|
|
|
169
169
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
170
170
|
* @returns {Promise<ConfigurationPlatformModel.DomainsResponse>} - Success response
|
|
171
171
|
* @name getDomains
|
|
172
|
-
* @summary: Get domains
|
|
172
|
+
* @summary: Get domains
|
|
173
173
|
* @description: Get list of domains. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomains/).
|
|
174
174
|
*/
|
|
175
175
|
getDomains({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainsResponse>;
|
|
@@ -182,7 +182,7 @@ declare class Configuration {
|
|
|
182
182
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInventory>} -
|
|
183
183
|
* Success response
|
|
184
184
|
* @name getInventoryConfig
|
|
185
|
-
* @summary: Get inventory configuration
|
|
185
|
+
* @summary: Get inventory configuration
|
|
186
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/).
|
|
187
187
|
*/
|
|
188
188
|
getInventoryConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInventory>;
|
|
@@ -195,7 +195,7 @@ declare class Configuration {
|
|
|
195
195
|
* @returns {Promise<ConfigurationPlatformModel.OrderingStoreConfig>} -
|
|
196
196
|
* Success response
|
|
197
197
|
* @name getOrderingStoreConfig
|
|
198
|
-
* @summary: Get ordering store configuration
|
|
198
|
+
* @summary: Get ordering store configuration
|
|
199
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/).
|
|
200
200
|
*/
|
|
201
201
|
getOrderingStoreConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStoreConfig>;
|
|
@@ -208,7 +208,7 @@ declare class Configuration {
|
|
|
208
208
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
209
209
|
* Success response
|
|
210
210
|
* @name getOrderingStoreCookie
|
|
211
|
-
* @summary: Get an Ordering Store signed cookie on selection of ordering store
|
|
211
|
+
* @summary: Get an Ordering Store signed cookie on selection of ordering store
|
|
212
212
|
* @description: Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreCookie/).
|
|
213
213
|
*/
|
|
214
214
|
getOrderingStoreCookie({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetOrderingStoreCookieParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
|
|
@@ -220,7 +220,7 @@ declare class Configuration {
|
|
|
220
220
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
221
221
|
* @returns {Promise<ConfigurationPlatformModel.OrderingStores>} - Success response
|
|
222
222
|
* @name getOrderingStoresByFilter
|
|
223
|
-
* @summary: Get ordering stores by filter
|
|
223
|
+
* @summary: Get ordering stores by filter
|
|
224
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/).
|
|
225
225
|
*/
|
|
226
226
|
getOrderingStoresByFilter({ body, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetOrderingStoresByFilterParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStores>;
|
|
@@ -233,7 +233,7 @@ declare class Configuration {
|
|
|
233
233
|
* @returns {Promise<ConfigurationPlatformModel.BuildVersionHistory>} -
|
|
234
234
|
* Success response
|
|
235
235
|
* @name getPreviousVersions
|
|
236
|
-
* @summary: Get previous versions
|
|
236
|
+
* @summary: Get previous versions
|
|
237
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/).
|
|
238
238
|
*/
|
|
239
239
|
getPreviousVersions({ platformType, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetPreviousVersionsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.BuildVersionHistory>;
|
|
@@ -246,7 +246,7 @@ declare class Configuration {
|
|
|
246
246
|
* @returns {Promise<ConfigurationPlatformModel.OrderingStoresResponse>} -
|
|
247
247
|
* Success response
|
|
248
248
|
* @name getStaffOrderingStores
|
|
249
|
-
* @summary: Get staff ordering stores
|
|
249
|
+
* @summary: Get staff ordering stores
|
|
250
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/).
|
|
251
251
|
*/
|
|
252
252
|
getStaffOrderingStores({ pageNo, pageSize, q, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetStaffOrderingStoresParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStoresResponse>;
|
|
@@ -258,7 +258,7 @@ declare class Configuration {
|
|
|
258
258
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
259
259
|
* @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
|
|
260
260
|
* @name modifyAppFeatures
|
|
261
|
-
* @summary: Modify application features
|
|
261
|
+
* @summary: Modify application features
|
|
262
262
|
* @description: Update features of application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/modifyAppFeatures/).
|
|
263
263
|
*/
|
|
264
264
|
modifyAppFeatures({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.ModifyAppFeaturesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppFeature>;
|
|
@@ -271,7 +271,7 @@ declare class Configuration {
|
|
|
271
271
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInventory>} -
|
|
272
272
|
* Success response
|
|
273
273
|
* @name partiallyUpdateInventoryConfig
|
|
274
|
-
* @summary: Partially update inventory configuration
|
|
274
|
+
* @summary: Partially update inventory configuration
|
|
275
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/).
|
|
276
276
|
*/
|
|
277
277
|
partiallyUpdateInventoryConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.PartiallyUpdateInventoryConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInventory>;
|
|
@@ -284,7 +284,7 @@ declare class Configuration {
|
|
|
284
284
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
285
285
|
* Success response
|
|
286
286
|
* @name removeDomainById
|
|
287
|
-
* @summary: Remove domain by ID
|
|
287
|
+
* @summary: Remove domain by ID
|
|
288
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/).
|
|
289
289
|
*/
|
|
290
290
|
removeDomainById({ id, requestHeaders }?: ConfigurationPlatformApplicationValidator.RemoveDomainByIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
|
|
@@ -297,7 +297,7 @@ declare class Configuration {
|
|
|
297
297
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
298
298
|
* Success response
|
|
299
299
|
* @name removeOrderingStoreCookie
|
|
300
|
-
* @summary: Unset the Ordering Store signed cookie
|
|
300
|
+
* @summary: Unset the Ordering Store signed cookie
|
|
301
301
|
* @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeOrderingStoreCookie/).
|
|
302
302
|
*/
|
|
303
303
|
removeOrderingStoreCookie({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
|
|
@@ -309,7 +309,7 @@ declare class Configuration {
|
|
|
309
309
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
310
310
|
* @returns {Promise<ConfigurationPlatformModel.TokenResponse>} - Success response
|
|
311
311
|
* @name updateAppApiTokens
|
|
312
|
-
* @summary: Update application API tokens
|
|
312
|
+
* @summary: Update application API tokens
|
|
313
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/).
|
|
314
314
|
*/
|
|
315
315
|
updateAppApiTokens({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppApiTokensParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.TokenResponse>;
|
|
@@ -321,7 +321,7 @@ declare class Configuration {
|
|
|
321
321
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
322
322
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
|
|
323
323
|
* @name updateAppBasicDetails
|
|
324
|
-
* @summary: Update application basic details
|
|
324
|
+
* @summary: Update application basic details
|
|
325
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/).
|
|
326
326
|
*/
|
|
327
327
|
updateAppBasicDetails({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppBasicDetailsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationDetail>;
|
|
@@ -334,7 +334,7 @@ declare class Configuration {
|
|
|
334
334
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
|
|
335
335
|
* Success response
|
|
336
336
|
* @name updateAppContactInfo
|
|
337
|
-
* @summary: Update application contact information
|
|
337
|
+
* @summary: Update application contact information
|
|
338
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/).
|
|
339
339
|
*/
|
|
340
340
|
updateAppContactInfo({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppContactInfoParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInformation>;
|
|
@@ -347,7 +347,7 @@ declare class Configuration {
|
|
|
347
347
|
* @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
|
|
348
348
|
* Success response
|
|
349
349
|
* @name updateAppCurrencyConfig
|
|
350
|
-
* @summary: Update application currency configuration
|
|
350
|
+
* @summary: Update application currency configuration
|
|
351
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/).
|
|
352
352
|
*/
|
|
353
353
|
updateAppCurrencyConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppCurrencyConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppSupportedCurrency>;
|
|
@@ -359,7 +359,7 @@ declare class Configuration {
|
|
|
359
359
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
360
360
|
* @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
|
|
361
361
|
* @name updateAppFeatures
|
|
362
|
-
* @summary: Update application features
|
|
362
|
+
* @summary: Update application features
|
|
363
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/).
|
|
364
364
|
*/
|
|
365
365
|
updateAppFeatures({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppFeaturesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppFeature>;
|
|
@@ -372,7 +372,7 @@ declare class Configuration {
|
|
|
372
372
|
* @returns {Promise<ConfigurationPlatformModel.MobileAppConfiguration>} -
|
|
373
373
|
* Success response
|
|
374
374
|
* @name updateBuildConfig
|
|
375
|
-
* @summary: Update build configuration
|
|
375
|
+
* @summary: Update build configuration
|
|
376
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/).
|
|
377
377
|
*/
|
|
378
378
|
updateBuildConfig({ platformType, body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateBuildConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.MobileAppConfiguration>;
|
|
@@ -385,7 +385,7 @@ declare class Configuration {
|
|
|
385
385
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInventory>} -
|
|
386
386
|
* Success response
|
|
387
387
|
* @name updateInventoryConfig
|
|
388
|
-
* @summary: Update inventory configuration
|
|
388
|
+
* @summary: Update inventory configuration
|
|
389
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/).
|
|
390
390
|
*/
|
|
391
391
|
updateInventoryConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateInventoryConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInventory>;
|
|
@@ -397,7 +397,7 @@ declare class Configuration {
|
|
|
397
397
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
398
398
|
* @returns {Promise<ConfigurationPlatformModel.DeploymentMeta>} - Success response
|
|
399
399
|
* @name updateOrderingStoreConfig
|
|
400
|
-
* @summary: Update ordering store configuration
|
|
400
|
+
* @summary: Update ordering store configuration
|
|
401
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/).
|
|
402
402
|
*/
|
|
403
403
|
updateOrderingStoreConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateOrderingStoreConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DeploymentMeta>;
|