@gofynd/fdk-client-javascript 1.6.4 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +5 -5
- package/sdk/application/Cart/CartApplicationClient.js +26 -268
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +20 -20
- package/sdk/application/Catalog/CatalogApplicationClient.js +98 -347
- package/sdk/application/Common/CommonApplicationClient.js +1 -16
- package/sdk/application/Communication/CommunicationApplicationClient.js +1 -24
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +24 -2
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +58 -137
- package/sdk/application/Content/ContentApplicationClient.d.ts +47 -7
- package/sdk/application/Content/ContentApplicationClient.js +222 -191
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.js +1 -16
- package/sdk/application/Lead/LeadApplicationClient.d.ts +4 -4
- package/sdk/application/Lead/LeadApplicationClient.js +21 -52
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +16 -56
- package/sdk/application/Logistic/LogisticApplicationClient.js +57 -332
- package/sdk/application/Order/OrderApplicationClient.d.ts +11 -11
- package/sdk/application/Order/OrderApplicationClient.js +68 -153
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -12
- package/sdk/application/Payment/PaymentApplicationClient.js +7 -487
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -59
- package/sdk/application/Share/ShareApplicationClient.d.ts +4 -4
- package/sdk/application/Share/ShareApplicationClient.js +21 -75
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +3 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +19 -47
- package/sdk/application/User/UserApplicationClient.js +1 -407
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -8
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +4 -4
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +1 -55
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +1 -408
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -37
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -0
- package/sdk/partner/Lead/LeadPartnerModel.js +2 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +29 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +65 -42
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1008 -794
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +573 -460
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +10 -5
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +2 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +67 -9
- package/sdk/platform/Cart/CartPlatformModel.js +38 -5
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.js +4 -4
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +47 -13
- package/sdk/platform/Catalog/CatalogPlatformModel.js +29 -7
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +7 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +71 -7
- package/sdk/platform/Communication/CommunicationPlatformModel.js +70 -6
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +0 -27
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +8 -60
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +31 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +3 -3
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +13 -0
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +68 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +49 -7
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +169 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1279 -132
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +156 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +180 -0
- package/sdk/platform/Content/ContentPlatformClient.d.ts +162 -0
- package/sdk/platform/Content/ContentPlatformClient.js +1697 -497
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1053 -35
- package/sdk/platform/Content/ContentPlatformModel.js +717 -34
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +127 -1
- package/sdk/platform/Content/ContentPlatformValidator.js +171 -0
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +34 -0
- package/sdk/platform/Discount/DiscountPlatformClient.js +59 -0
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +365 -93
- package/sdk/platform/Discount/DiscountPlatformModel.js +98 -93
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +54 -34
- package/sdk/platform/Discount/DiscountPlatformValidator.js +27 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +0 -156
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +0 -1072
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -137
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -173
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +1 -1105
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +0 -1125
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -0
- package/sdk/platform/Lead/LeadPlatformModel.js +2 -0
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -92
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
- package/sdk/platform/Order/OrderPlatformClient.d.ts +212 -0
- package/sdk/platform/Order/OrderPlatformClient.js +397 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +41 -9
- package/sdk/platform/Order/OrderPlatformModel.js +20 -7
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -1
- package/sdk/platform/Order/OrderPlatformValidator.js +20 -0
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +58 -10
- package/sdk/platform/Partner/PartnerPlatformModel.js +19 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +12 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +8 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +5 -0
- package/sdk/platform/Rewards/RewardsPlatformModel.js +2 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +240 -24
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +1753 -277
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +320 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +269 -19
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +53 -104
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +201 -629
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +5720 -2891
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3414 -2181
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +138 -216
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +81 -148
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +10 -0
- package/sdk/platform/User/UserPlatformApplicationClient.js +79 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +13 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +12 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +52 -1
- package/sdk/platform/User/UserPlatformModel.js +36 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +5 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.js +2 -0
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +6 -11
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -16
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -3
- package/sdk/public/Content/ContentPublicClient.js +261 -104
- package/sdk/public/Content/ContentPublicModel.d.ts +155 -1
- package/sdk/public/Content/ContentPublicModel.js +102 -0
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -1
- package/sdk/public/Content/ContentPublicValidator.js +26 -0
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.js +1 -40
|
@@ -155,33 +155,6 @@ declare class CompanyProfile {
|
|
|
155
155
|
* @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocations/).
|
|
156
156
|
*/
|
|
157
157
|
getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, types, tags, requestHeaders, }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.LocationListSchema>;
|
|
158
|
-
/**
|
|
159
|
-
* @param {Object} arg - Arg object.
|
|
160
|
-
* @param {string} [arg.storeType] - Helps to sort the location list on the
|
|
161
|
-
* basis of location type.
|
|
162
|
-
* @param {string} [arg.q] - Query that is to be searched.
|
|
163
|
-
* @param {string} [arg.stage] - To filter companies on basis of verified or
|
|
164
|
-
* unverified companies.
|
|
165
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
166
|
-
* page. Default is 10.
|
|
167
|
-
* @param {number[]} [arg.locationIds] - Helps to filter stores on the basis of uids.
|
|
168
|
-
* @param {string[]} [arg.types] - Helps to get the location list on the
|
|
169
|
-
* basis of multiple location type.
|
|
170
|
-
* @param {string[]} [arg.tags] - Helps to get the location list on the
|
|
171
|
-
* basis of multiple location tag.
|
|
172
|
-
* @returns {Paginator<CompanyProfilePlatformModel.LocationListSchema>}
|
|
173
|
-
* @summary: Get company specific stores
|
|
174
|
-
* @description: Retrieve a list of locations associated with the company.
|
|
175
|
-
*/
|
|
176
|
-
getLocationsPaginator({ storeType, q, stage, pageSize, locationIds, types, tags, }?: {
|
|
177
|
-
storeType?: string;
|
|
178
|
-
q?: string;
|
|
179
|
-
stage?: string;
|
|
180
|
-
pageSize?: number;
|
|
181
|
-
locationIds?: number[];
|
|
182
|
-
types?: string[];
|
|
183
|
-
tags?: string[];
|
|
184
|
-
}): Paginator<CompanyProfilePlatformModel.LocationListSchema>;
|
|
185
158
|
/**
|
|
186
159
|
* @param {CompanyProfilePlatformValidator.UpdateCompanyParam} arg - Arg object
|
|
187
160
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -58,7 +58,7 @@ class CompanyProfile {
|
|
|
58
58
|
const response = await PlatformAPIClient.execute(
|
|
59
59
|
this.config,
|
|
60
60
|
"get",
|
|
61
|
-
`/service/platform/company-profile/
|
|
61
|
+
`/service/platform/company-profile/v2.0/company/${this.config.companyId}`,
|
|
62
62
|
query_params,
|
|
63
63
|
undefined,
|
|
64
64
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -224,7 +224,7 @@ class CompanyProfile {
|
|
|
224
224
|
const response = await PlatformAPIClient.execute(
|
|
225
225
|
this.config,
|
|
226
226
|
"post",
|
|
227
|
-
`/service/platform/company-profile/
|
|
227
|
+
`/service/platform/company-profile/v2.0/company/${this.config.companyId}/company-brand`,
|
|
228
228
|
query_params,
|
|
229
229
|
body,
|
|
230
230
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -305,7 +305,7 @@ class CompanyProfile {
|
|
|
305
305
|
const response = await PlatformAPIClient.execute(
|
|
306
306
|
this.config,
|
|
307
307
|
"post",
|
|
308
|
-
`/service/platform/company-profile/
|
|
308
|
+
`/service/platform/company-profile/v2.0/company/${this.config.companyId}/location`,
|
|
309
309
|
query_params,
|
|
310
310
|
body,
|
|
311
311
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -638,7 +638,7 @@ class CompanyProfile {
|
|
|
638
638
|
const response = await PlatformAPIClient.execute(
|
|
639
639
|
this.config,
|
|
640
640
|
"get",
|
|
641
|
-
`/service/platform/company-profile/
|
|
641
|
+
`/service/platform/company-profile/v2.0/company/${this.config.companyId}/company-brand`,
|
|
642
642
|
query_params,
|
|
643
643
|
undefined,
|
|
644
644
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -827,7 +827,7 @@ class CompanyProfile {
|
|
|
827
827
|
const response = await PlatformAPIClient.execute(
|
|
828
828
|
this.config,
|
|
829
829
|
"get",
|
|
830
|
-
`/service/platform/company-profile/
|
|
830
|
+
`/service/platform/company-profile/v2.0/company/${this.config.companyId}/location/${locationId}`,
|
|
831
831
|
query_params,
|
|
832
832
|
undefined,
|
|
833
833
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -1018,7 +1018,7 @@ class CompanyProfile {
|
|
|
1018
1018
|
const response = await PlatformAPIClient.execute(
|
|
1019
1019
|
this.config,
|
|
1020
1020
|
"get",
|
|
1021
|
-
`/service/platform/company-profile/
|
|
1021
|
+
`/service/platform/company-profile/v2.0/company/${this.config.companyId}/location`,
|
|
1022
1022
|
query_params,
|
|
1023
1023
|
undefined,
|
|
1024
1024
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -1051,58 +1051,6 @@ class CompanyProfile {
|
|
|
1051
1051
|
return response;
|
|
1052
1052
|
}
|
|
1053
1053
|
|
|
1054
|
-
/**
|
|
1055
|
-
* @param {Object} arg - Arg object.
|
|
1056
|
-
* @param {string} [arg.storeType] - Helps to sort the location list on the
|
|
1057
|
-
* basis of location type.
|
|
1058
|
-
* @param {string} [arg.q] - Query that is to be searched.
|
|
1059
|
-
* @param {string} [arg.stage] - To filter companies on basis of verified or
|
|
1060
|
-
* unverified companies.
|
|
1061
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
1062
|
-
* page. Default is 10.
|
|
1063
|
-
* @param {number[]} [arg.locationIds] - Helps to filter stores on the basis of uids.
|
|
1064
|
-
* @param {string[]} [arg.types] - Helps to get the location list on the
|
|
1065
|
-
* basis of multiple location type.
|
|
1066
|
-
* @param {string[]} [arg.tags] - Helps to get the location list on the
|
|
1067
|
-
* basis of multiple location tag.
|
|
1068
|
-
* @returns {Paginator<CompanyProfilePlatformModel.LocationListSchema>}
|
|
1069
|
-
* @summary: Get company specific stores
|
|
1070
|
-
* @description: Retrieve a list of locations associated with the company.
|
|
1071
|
-
*/
|
|
1072
|
-
getLocationsPaginator({
|
|
1073
|
-
storeType,
|
|
1074
|
-
q,
|
|
1075
|
-
stage,
|
|
1076
|
-
pageSize,
|
|
1077
|
-
locationIds,
|
|
1078
|
-
types,
|
|
1079
|
-
tags,
|
|
1080
|
-
} = {}) {
|
|
1081
|
-
const paginator = new Paginator();
|
|
1082
|
-
const callback = async () => {
|
|
1083
|
-
const pageId = paginator.nextId;
|
|
1084
|
-
const pageNo = paginator.pageNo;
|
|
1085
|
-
const pageType = "number";
|
|
1086
|
-
const data = await this.getLocations({
|
|
1087
|
-
storeType: storeType,
|
|
1088
|
-
q: q,
|
|
1089
|
-
stage: stage,
|
|
1090
|
-
pageNo: pageNo,
|
|
1091
|
-
pageSize: pageSize,
|
|
1092
|
-
locationIds: locationIds,
|
|
1093
|
-
types: types,
|
|
1094
|
-
tags: tags,
|
|
1095
|
-
});
|
|
1096
|
-
paginator.setPaginator({
|
|
1097
|
-
hasNext: data.page.has_next ? true : false,
|
|
1098
|
-
nextId: data.page.next_id,
|
|
1099
|
-
});
|
|
1100
|
-
return data;
|
|
1101
|
-
};
|
|
1102
|
-
paginator.setCallback(callback.bind(this));
|
|
1103
|
-
return paginator;
|
|
1104
|
-
}
|
|
1105
|
-
|
|
1106
1054
|
/**
|
|
1107
1055
|
* @param {CompanyProfilePlatformValidator.UpdateCompanyParam} arg - Arg object
|
|
1108
1056
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1151,7 +1099,7 @@ class CompanyProfile {
|
|
|
1151
1099
|
const response = await PlatformAPIClient.execute(
|
|
1152
1100
|
this.config,
|
|
1153
1101
|
"patch",
|
|
1154
|
-
`/service/platform/company-profile/
|
|
1102
|
+
`/service/platform/company-profile/v2.0/company/${this.config.companyId}`,
|
|
1155
1103
|
query_params,
|
|
1156
1104
|
body,
|
|
1157
1105
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -1234,7 +1182,7 @@ class CompanyProfile {
|
|
|
1234
1182
|
const response = await PlatformAPIClient.execute(
|
|
1235
1183
|
this.config,
|
|
1236
1184
|
"put",
|
|
1237
|
-
`/service/platform/company-profile/
|
|
1185
|
+
`/service/platform/company-profile/v2.0/company/${this.config.companyId}/location/${locationId}`,
|
|
1238
1186
|
query_params,
|
|
1239
1187
|
body,
|
|
1240
1188
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -54,7 +54,7 @@ export = CompanyProfilePlatformModel;
|
|
|
54
54
|
* @typedef GetAddressSchema
|
|
55
55
|
* @property {string} [landmark]
|
|
56
56
|
* @property {string} [country_code]
|
|
57
|
-
* @property {
|
|
57
|
+
* @property {string} [pincode]
|
|
58
58
|
* @property {string} [address_type]
|
|
59
59
|
* @property {number} longitude
|
|
60
60
|
* @property {string} [country]
|
|
@@ -94,13 +94,13 @@ export = CompanyProfilePlatformModel;
|
|
|
94
94
|
*/
|
|
95
95
|
/**
|
|
96
96
|
* @typedef ErrorResponseSchema
|
|
97
|
-
* @property {string} [message]
|
|
98
|
-
*
|
|
99
|
-
* @property {
|
|
100
|
-
*
|
|
97
|
+
* @property {string} [message] - A descriptive message providing details about
|
|
98
|
+
* the error, intended to convey the nature and context of the issue.
|
|
99
|
+
* @property {Object} [error] - An object containing additional error details,
|
|
100
|
+
* which may vary depending on the error type.
|
|
101
101
|
*/
|
|
102
102
|
/**
|
|
103
|
-
* @typedef
|
|
103
|
+
* @typedef CompanyRequestTaxesSchema
|
|
104
104
|
* @property {string} [effective_date]
|
|
105
105
|
* @property {number} [rate]
|
|
106
106
|
* @property {boolean} [enable]
|
|
@@ -109,7 +109,7 @@ export = CompanyProfilePlatformModel;
|
|
|
109
109
|
* @typedef CreateUpdateAddressSchema
|
|
110
110
|
* @property {string} [landmark]
|
|
111
111
|
* @property {string} [country_code]
|
|
112
|
-
* @property {
|
|
112
|
+
* @property {string} pincode
|
|
113
113
|
* @property {string} address_type
|
|
114
114
|
* @property {number} longitude
|
|
115
115
|
* @property {string} country
|
|
@@ -126,7 +126,7 @@ export = CompanyProfilePlatformModel;
|
|
|
126
126
|
* @property {Object} [warnings]
|
|
127
127
|
* @property {string} [company_type]
|
|
128
128
|
* @property {Object} [_custom_json]
|
|
129
|
-
* @property {
|
|
129
|
+
* @property {CompanyRequestTaxesSchema[]} [taxes]
|
|
130
130
|
* @property {BusinessDetails} [business_details]
|
|
131
131
|
* @property {Document[]} [documents]
|
|
132
132
|
* @property {string} [business_type]
|
|
@@ -266,6 +266,7 @@ export = CompanyProfilePlatformModel;
|
|
|
266
266
|
* @property {number} [current] - The current page number.
|
|
267
267
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
268
268
|
* @property {number} [size] - The number of items per page.
|
|
269
|
+
* @property {number} [page_size] - The number of items per page.
|
|
269
270
|
*/
|
|
270
271
|
/**
|
|
271
272
|
* @typedef CompanyBrandListSchema
|
|
@@ -384,7 +385,7 @@ export = CompanyProfilePlatformModel;
|
|
|
384
385
|
* @typedef AddressSchema
|
|
385
386
|
* @property {string} [landmark]
|
|
386
387
|
* @property {string} country_code
|
|
387
|
-
* @property {
|
|
388
|
+
* @property {string} [pincode]
|
|
388
389
|
* @property {string} [address_type]
|
|
389
390
|
* @property {number} longitude
|
|
390
391
|
* @property {string} [country]
|
|
@@ -444,7 +445,7 @@ export = CompanyProfilePlatformModel;
|
|
|
444
445
|
declare class CompanyProfilePlatformModel {
|
|
445
446
|
}
|
|
446
447
|
declare namespace CompanyProfilePlatformModel {
|
|
447
|
-
export { CompanyTaxesSchema, UserSchema, Website, BusinessDetails, SellerPhoneNumber, ContactDetails, CountryCurrencyInfo, BusinessCountryInfo, Document, GetAddressSchema, GetCompanyProfileSerializerResponseSchema, ErrorResponseSchema,
|
|
448
|
+
export { CompanyTaxesSchema, UserSchema, Website, BusinessDetails, SellerPhoneNumber, ContactDetails, CountryCurrencyInfo, BusinessCountryInfo, Document, GetAddressSchema, GetCompanyProfileSerializerResponseSchema, ErrorResponseSchema, CompanyRequestTaxesSchema, CreateUpdateAddressSchema, UpdateCompany, ProfileSuccessResponseSchema, DocumentsObj, MetricsSchema, BrandBannerSchema, GetBrandResponseSchema, CreateBrandRequestSchema, UpdateBrandRequestSchema, CompanySocialAccounts, CompanyDetails, CompanySchema, CompanyBrandSchema, Page, CompanyBrandListSchema, CompanyBrandPostRequestSchema, InvoiceCredSchema, InvoiceDetailsSchema, GetCompanySchema, LocationManagerSchema, LocationTimingSchema, LocationDayWiseSchema, HolidayDateSchema, HolidaySchemaSchema, ProductReturnConfigSchema, GetLocationSchema, LocationListSchema, AddressSchema, LocationSchema, BulkLocationSchema, AverageOrderProcessingTime, StoreTagsResponseSchema };
|
|
448
449
|
}
|
|
449
450
|
/** @returns {CompanyTaxesSchema} */
|
|
450
451
|
declare function CompanyTaxesSchema(): CompanyTaxesSchema;
|
|
@@ -511,7 +512,7 @@ declare function GetAddressSchema(): GetAddressSchema;
|
|
|
511
512
|
type GetAddressSchema = {
|
|
512
513
|
landmark?: string;
|
|
513
514
|
country_code?: string;
|
|
514
|
-
pincode?:
|
|
515
|
+
pincode?: string;
|
|
515
516
|
address_type?: string;
|
|
516
517
|
longitude: number;
|
|
517
518
|
country?: string;
|
|
@@ -553,14 +554,20 @@ type GetCompanyProfileSerializerResponseSchema = {
|
|
|
553
554
|
/** @returns {ErrorResponseSchema} */
|
|
554
555
|
declare function ErrorResponseSchema(): ErrorResponseSchema;
|
|
555
556
|
type ErrorResponseSchema = {
|
|
557
|
+
/**
|
|
558
|
+
* - A descriptive message providing details about
|
|
559
|
+
* the error, intended to convey the nature and context of the issue.
|
|
560
|
+
*/
|
|
556
561
|
message?: string;
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
562
|
+
/**
|
|
563
|
+
* - An object containing additional error details,
|
|
564
|
+
* which may vary depending on the error type.
|
|
565
|
+
*/
|
|
566
|
+
error?: any;
|
|
560
567
|
};
|
|
561
|
-
/** @returns {
|
|
562
|
-
declare function
|
|
563
|
-
type
|
|
568
|
+
/** @returns {CompanyRequestTaxesSchema} */
|
|
569
|
+
declare function CompanyRequestTaxesSchema(): CompanyRequestTaxesSchema;
|
|
570
|
+
type CompanyRequestTaxesSchema = {
|
|
564
571
|
effective_date?: string;
|
|
565
572
|
rate?: number;
|
|
566
573
|
enable?: boolean;
|
|
@@ -570,7 +577,7 @@ declare function CreateUpdateAddressSchema(): CreateUpdateAddressSchema;
|
|
|
570
577
|
type CreateUpdateAddressSchema = {
|
|
571
578
|
landmark?: string;
|
|
572
579
|
country_code?: string;
|
|
573
|
-
pincode:
|
|
580
|
+
pincode: string;
|
|
574
581
|
address_type: string;
|
|
575
582
|
longitude: number;
|
|
576
583
|
country: string;
|
|
@@ -588,7 +595,7 @@ type UpdateCompany = {
|
|
|
588
595
|
warnings?: any;
|
|
589
596
|
company_type?: string;
|
|
590
597
|
_custom_json?: any;
|
|
591
|
-
taxes?:
|
|
598
|
+
taxes?: CompanyRequestTaxesSchema[];
|
|
592
599
|
business_details?: BusinessDetails;
|
|
593
600
|
documents?: Document[];
|
|
594
601
|
business_type?: string;
|
|
@@ -761,6 +768,10 @@ type Page = {
|
|
|
761
768
|
* - The number of items per page.
|
|
762
769
|
*/
|
|
763
770
|
size?: number;
|
|
771
|
+
/**
|
|
772
|
+
* - The number of items per page.
|
|
773
|
+
*/
|
|
774
|
+
page_size?: number;
|
|
764
775
|
};
|
|
765
776
|
/** @returns {CompanyBrandListSchema} */
|
|
766
777
|
declare function CompanyBrandListSchema(): CompanyBrandListSchema;
|
|
@@ -893,7 +904,7 @@ declare function AddressSchema(): AddressSchema;
|
|
|
893
904
|
type AddressSchema = {
|
|
894
905
|
landmark?: string;
|
|
895
906
|
country_code: string;
|
|
896
|
-
pincode?:
|
|
907
|
+
pincode?: string;
|
|
897
908
|
address_type?: string;
|
|
898
909
|
longitude: number;
|
|
899
910
|
country?: string;
|
|
@@ -64,7 +64,7 @@ const Joi = require("joi");
|
|
|
64
64
|
* @typedef GetAddressSchema
|
|
65
65
|
* @property {string} [landmark]
|
|
66
66
|
* @property {string} [country_code]
|
|
67
|
-
* @property {
|
|
67
|
+
* @property {string} [pincode]
|
|
68
68
|
* @property {string} [address_type]
|
|
69
69
|
* @property {number} longitude
|
|
70
70
|
* @property {string} [country]
|
|
@@ -106,14 +106,14 @@ const Joi = require("joi");
|
|
|
106
106
|
|
|
107
107
|
/**
|
|
108
108
|
* @typedef ErrorResponseSchema
|
|
109
|
-
* @property {string} [message]
|
|
110
|
-
*
|
|
111
|
-
* @property {
|
|
112
|
-
*
|
|
109
|
+
* @property {string} [message] - A descriptive message providing details about
|
|
110
|
+
* the error, intended to convey the nature and context of the issue.
|
|
111
|
+
* @property {Object} [error] - An object containing additional error details,
|
|
112
|
+
* which may vary depending on the error type.
|
|
113
113
|
*/
|
|
114
114
|
|
|
115
115
|
/**
|
|
116
|
-
* @typedef
|
|
116
|
+
* @typedef CompanyRequestTaxesSchema
|
|
117
117
|
* @property {string} [effective_date]
|
|
118
118
|
* @property {number} [rate]
|
|
119
119
|
* @property {boolean} [enable]
|
|
@@ -123,7 +123,7 @@ const Joi = require("joi");
|
|
|
123
123
|
* @typedef CreateUpdateAddressSchema
|
|
124
124
|
* @property {string} [landmark]
|
|
125
125
|
* @property {string} [country_code]
|
|
126
|
-
* @property {
|
|
126
|
+
* @property {string} pincode
|
|
127
127
|
* @property {string} address_type
|
|
128
128
|
* @property {number} longitude
|
|
129
129
|
* @property {string} country
|
|
@@ -141,7 +141,7 @@ const Joi = require("joi");
|
|
|
141
141
|
* @property {Object} [warnings]
|
|
142
142
|
* @property {string} [company_type]
|
|
143
143
|
* @property {Object} [_custom_json]
|
|
144
|
-
* @property {
|
|
144
|
+
* @property {CompanyRequestTaxesSchema[]} [taxes]
|
|
145
145
|
* @property {BusinessDetails} [business_details]
|
|
146
146
|
* @property {Document[]} [documents]
|
|
147
147
|
* @property {string} [business_type]
|
|
@@ -293,6 +293,7 @@ const Joi = require("joi");
|
|
|
293
293
|
* @property {number} [current] - The current page number.
|
|
294
294
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
295
295
|
* @property {number} [size] - The number of items per page.
|
|
296
|
+
* @property {number} [page_size] - The number of items per page.
|
|
296
297
|
*/
|
|
297
298
|
|
|
298
299
|
/**
|
|
@@ -425,7 +426,7 @@ const Joi = require("joi");
|
|
|
425
426
|
* @typedef AddressSchema
|
|
426
427
|
* @property {string} [landmark]
|
|
427
428
|
* @property {string} country_code
|
|
428
|
-
* @property {
|
|
429
|
+
* @property {string} [pincode]
|
|
429
430
|
* @property {string} [address_type]
|
|
430
431
|
* @property {number} longitude
|
|
431
432
|
* @property {string} [country]
|
|
@@ -571,7 +572,7 @@ class CompanyProfilePlatformModel {
|
|
|
571
572
|
return Joi.object({
|
|
572
573
|
landmark: Joi.string().allow(""),
|
|
573
574
|
country_code: Joi.string().allow(""),
|
|
574
|
-
pincode: Joi.
|
|
575
|
+
pincode: Joi.string().allow(""),
|
|
575
576
|
address_type: Joi.string().allow(""),
|
|
576
577
|
longitude: Joi.number().required(),
|
|
577
578
|
country: Joi.string().allow(""),
|
|
@@ -622,14 +623,12 @@ class CompanyProfilePlatformModel {
|
|
|
622
623
|
static ErrorResponseSchema() {
|
|
623
624
|
return Joi.object({
|
|
624
625
|
message: Joi.string().allow(""),
|
|
625
|
-
|
|
626
|
-
status: Joi.number(),
|
|
627
|
-
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
626
|
+
error: Joi.object().pattern(/\S/, Joi.any()),
|
|
628
627
|
});
|
|
629
628
|
}
|
|
630
629
|
|
|
631
|
-
/** @returns {
|
|
632
|
-
static
|
|
630
|
+
/** @returns {CompanyRequestTaxesSchema} */
|
|
631
|
+
static CompanyRequestTaxesSchema() {
|
|
633
632
|
return Joi.object({
|
|
634
633
|
effective_date: Joi.string().allow(""),
|
|
635
634
|
rate: Joi.number(),
|
|
@@ -642,7 +641,7 @@ class CompanyProfilePlatformModel {
|
|
|
642
641
|
return Joi.object({
|
|
643
642
|
landmark: Joi.string().allow(""),
|
|
644
643
|
country_code: Joi.string().allow(""),
|
|
645
|
-
pincode: Joi.
|
|
644
|
+
pincode: Joi.string().allow("").required(),
|
|
646
645
|
address_type: Joi.string().allow("").required(),
|
|
647
646
|
longitude: Joi.number().required(),
|
|
648
647
|
country: Joi.string().allow("").required(),
|
|
@@ -663,7 +662,7 @@ class CompanyProfilePlatformModel {
|
|
|
663
662
|
company_type: Joi.string().allow(""),
|
|
664
663
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
665
664
|
taxes: Joi.array().items(
|
|
666
|
-
CompanyProfilePlatformModel.
|
|
665
|
+
CompanyProfilePlatformModel.CompanyRequestTaxesSchema()
|
|
667
666
|
),
|
|
668
667
|
business_details: CompanyProfilePlatformModel.BusinessDetails(),
|
|
669
668
|
documents: Joi.array().items(CompanyProfilePlatformModel.Document()),
|
|
@@ -846,6 +845,7 @@ class CompanyProfilePlatformModel {
|
|
|
846
845
|
current: Joi.number(),
|
|
847
846
|
type: Joi.string().allow("").required(),
|
|
848
847
|
size: Joi.number(),
|
|
848
|
+
page_size: Joi.number(),
|
|
849
849
|
});
|
|
850
850
|
}
|
|
851
851
|
|
|
@@ -1018,7 +1018,7 @@ class CompanyProfilePlatformModel {
|
|
|
1018
1018
|
return Joi.object({
|
|
1019
1019
|
landmark: Joi.string().allow(""),
|
|
1020
1020
|
country_code: Joi.string().allow("").required(),
|
|
1021
|
-
pincode: Joi.
|
|
1021
|
+
pincode: Joi.string().allow(""),
|
|
1022
1022
|
address_type: Joi.string().allow(""),
|
|
1023
1023
|
longitude: Joi.number().required(),
|
|
1024
1024
|
country: Joi.string().allow(""),
|
|
@@ -178,7 +178,7 @@ declare class Configuration {
|
|
|
178
178
|
* Success response
|
|
179
179
|
* @name getDomains
|
|
180
180
|
* @summary: List domains
|
|
181
|
-
* @description: Retrieve a list of existing domains by its sales channel
|
|
181
|
+
* @description: Retrieve a list of existing domains by its sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomains/).
|
|
182
182
|
*/
|
|
183
183
|
getDomains({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainsResponseSchema>;
|
|
184
184
|
/**
|
|
@@ -1070,7 +1070,7 @@ class Configuration {
|
|
|
1070
1070
|
* Success response
|
|
1071
1071
|
* @name getDomains
|
|
1072
1072
|
* @summary: List domains
|
|
1073
|
-
* @description: Retrieve a list of existing domains by its sales channel
|
|
1073
|
+
* @description: Retrieve a list of existing domains by its sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomains/).
|
|
1074
1074
|
*/
|
|
1075
1075
|
async getDomains(
|
|
1076
1076
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1431,7 +1431,7 @@ class Configuration {
|
|
|
1431
1431
|
const response = await PlatformAPIClient.execute(
|
|
1432
1432
|
this.config,
|
|
1433
1433
|
"post",
|
|
1434
|
-
`/service/platform/configuration/
|
|
1434
|
+
`/service/platform/configuration/v2.0/company/${this.config.companyId}/application/${this.applicationId}/ordering-store/stores/filter`,
|
|
1435
1435
|
query_params,
|
|
1436
1436
|
body,
|
|
1437
1437
|
requestHeaders,
|
|
@@ -1603,7 +1603,7 @@ class Configuration {
|
|
|
1603
1603
|
const response = await PlatformAPIClient.execute(
|
|
1604
1604
|
this.config,
|
|
1605
1605
|
"get",
|
|
1606
|
-
`/service/platform/configuration/
|
|
1606
|
+
`/service/platform/configuration/v2.0/company/${this.config.companyId}/application/${this.applicationId}/ordering-store/staff-stores`,
|
|
1607
1607
|
query_params,
|
|
1608
1608
|
undefined,
|
|
1609
1609
|
requestHeaders,
|
|
@@ -25,6 +25,18 @@ declare class Configuration {
|
|
|
25
25
|
* @description: Retrieve a list of available sales channels. sales channels are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of sales channels created within a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplications/).
|
|
26
26
|
*/
|
|
27
27
|
getApplications({ pageNo, pageSize, q, requestHeaders }?: ConfigurationPlatformValidator.GetApplicationsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationsResponseSchema>;
|
|
28
|
+
/**
|
|
29
|
+
* @param {Object} arg - Arg object.
|
|
30
|
+
* @param {number} [arg.pageSize] -
|
|
31
|
+
* @param {string} [arg.q] - Search param by name or domain
|
|
32
|
+
* @returns {Paginator<ConfigurationPlatformModel.ApplicationsResponseSchema>}
|
|
33
|
+
* @summary: List sales channel stores
|
|
34
|
+
* @description: Retrieve a list of available sales channels. sales channels are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of sales channels created within a company.
|
|
35
|
+
*/
|
|
36
|
+
getApplicationsPaginator({ pageSize, q }?: {
|
|
37
|
+
pageSize?: number;
|
|
38
|
+
q?: string;
|
|
39
|
+
}): Paginator<ConfigurationPlatformModel.ApplicationsResponseSchema>;
|
|
28
40
|
/**
|
|
29
41
|
* @param {ConfigurationPlatformValidator.GetBrandsByCompanyParam} arg - Arg object
|
|
30
42
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -141,3 +153,4 @@ declare class Configuration {
|
|
|
141
153
|
}
|
|
142
154
|
import ConfigurationPlatformValidator = require("./ConfigurationPlatformValidator");
|
|
143
155
|
import ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
|
|
156
|
+
import Paginator = require("../../common/Paginator");
|
|
@@ -184,6 +184,35 @@ class Configuration {
|
|
|
184
184
|
return response;
|
|
185
185
|
}
|
|
186
186
|
|
|
187
|
+
/**
|
|
188
|
+
* @param {Object} arg - Arg object.
|
|
189
|
+
* @param {number} [arg.pageSize] -
|
|
190
|
+
* @param {string} [arg.q] - Search param by name or domain
|
|
191
|
+
* @returns {Paginator<ConfigurationPlatformModel.ApplicationsResponseSchema>}
|
|
192
|
+
* @summary: List sales channel stores
|
|
193
|
+
* @description: Retrieve a list of available sales channels. sales channels are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of sales channels created within a company.
|
|
194
|
+
*/
|
|
195
|
+
getApplicationsPaginator({ pageSize, q } = {}) {
|
|
196
|
+
const paginator = new Paginator();
|
|
197
|
+
const callback = async () => {
|
|
198
|
+
const pageId = paginator.nextId;
|
|
199
|
+
const pageNo = paginator.pageNo;
|
|
200
|
+
const pageType = "number";
|
|
201
|
+
const data = await this.getApplications({
|
|
202
|
+
pageNo: pageNo,
|
|
203
|
+
pageSize: pageSize,
|
|
204
|
+
q: q,
|
|
205
|
+
});
|
|
206
|
+
paginator.setPaginator({
|
|
207
|
+
hasNext: data.page.has_next ? true : false,
|
|
208
|
+
nextId: data.page.next_id,
|
|
209
|
+
});
|
|
210
|
+
return data;
|
|
211
|
+
};
|
|
212
|
+
paginator.setCallback(callback.bind(this));
|
|
213
|
+
return paginator;
|
|
214
|
+
}
|
|
215
|
+
|
|
187
216
|
/**
|
|
188
217
|
* @param {ConfigurationPlatformValidator.GetBrandsByCompanyParam} arg - Arg object
|
|
189
218
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -843,7 +872,7 @@ class Configuration {
|
|
|
843
872
|
const response = await PlatformAPIClient.execute(
|
|
844
873
|
this.config,
|
|
845
874
|
"post",
|
|
846
|
-
`/service/platform/configuration/
|
|
875
|
+
`/service/platform/configuration/v2.0/company/${this.config.companyId}/inventory/stores-by-brands`,
|
|
847
876
|
query_params,
|
|
848
877
|
body,
|
|
849
878
|
{ ...xHeaders, ...requestHeaders },
|