@gofynd/fdk-client-javascript 1.4.16-beta.2 → 1.4.16-beta.4
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/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +27 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +29 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +30 -51
- package/sdk/application/Content/ContentApplicationClient.js +56 -161
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -9
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +8 -101
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +8 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +2 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/common/Utility.js +6 -3
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +167 -1200
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
- package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +115 -419
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -121
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1294 -5068
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1992
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
- package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6389
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1681 -3222
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +131 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -204
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +475 -1073
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -253
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -256
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +403 -1375
- package/sdk/platform/Content/ContentPlatformModel.js +394 -631
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +39 -95
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +22 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -313
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -17
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
- package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
- package/sdk/platform/Order/OrderPlatformClient.js +198 -416
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
- package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
- package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +105 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +319 -333
- package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +36 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +68 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +49 -45
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +30 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -3
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +7 -46
- package/sdk/platform/Share/SharePlatformModel.js +6 -31
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
- package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +6 -810
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -111
|
@@ -35,11 +35,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
35
35
|
* @property {OrderPlatformModel.OrderStatus} body
|
|
36
36
|
*/
|
|
37
37
|
|
|
38
|
-
/**
|
|
39
|
-
* @typedef CreateChannelConfigParam
|
|
40
|
-
* @property {OrderPlatformModel.CreateChannelConfigData} body
|
|
41
|
-
*/
|
|
42
|
-
|
|
43
38
|
/**
|
|
44
39
|
* @typedef CreateOrderParam
|
|
45
40
|
* @property {OrderPlatformModel.CreateOrderAPI} body
|
|
@@ -57,7 +52,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
57
52
|
|
|
58
53
|
/**
|
|
59
54
|
* @typedef DownloadLanesReportParam
|
|
60
|
-
* @property {OrderPlatformModel.
|
|
55
|
+
* @property {OrderPlatformModel.BulkReportsDownloadRequest} body
|
|
61
56
|
*/
|
|
62
57
|
|
|
63
58
|
/**
|
|
@@ -99,7 +94,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
99
94
|
|
|
100
95
|
/**
|
|
101
96
|
* @typedef GenerateProcessManifestParam
|
|
102
|
-
* @property {OrderPlatformModel.
|
|
97
|
+
* @property {OrderPlatformModel.ProcessManifestRequest} body
|
|
103
98
|
*/
|
|
104
99
|
|
|
105
100
|
/**
|
|
@@ -118,7 +113,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
118
113
|
|
|
119
114
|
/**
|
|
120
115
|
* @typedef GetBagByIdParam
|
|
121
|
-
* @property {string} [bagId] -
|
|
116
|
+
* @property {string} [bagId] - Id of bag
|
|
122
117
|
* @property {string} [channelBagId] - Id of application bag
|
|
123
118
|
* @property {string} [channelId] - Id of application
|
|
124
119
|
*/
|
|
@@ -142,8 +137,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
142
137
|
* @typedef GetBulkShipmentExcelFileParam
|
|
143
138
|
* @property {string} [salesChannels] - Comma separated values of sales channel ids
|
|
144
139
|
* @property {string} [dpIds] - Comma separated values of delivery partner ids
|
|
145
|
-
* @property {string} [startDate] -
|
|
146
|
-
* @property {string} [endDate] -
|
|
140
|
+
* @property {string} [startDate] - UTC start date in ISO format
|
|
141
|
+
* @property {string} [endDate] - UTC end date in ISO format
|
|
147
142
|
* @property {string} [stores] - Comma separated values of store ids
|
|
148
143
|
* @property {string} [tags] - Comma separated values of tags
|
|
149
144
|
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
@@ -154,13 +149,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
154
149
|
* @property {number} [pageSize]
|
|
155
150
|
*/
|
|
156
151
|
|
|
157
|
-
/** @typedef GetChannelConfigParam */
|
|
158
|
-
|
|
159
152
|
/**
|
|
160
153
|
* @typedef GetFileByStatusParam
|
|
161
154
|
* @property {string} batchId - Batch Id to identify the bulk operation request.
|
|
162
155
|
* @property {string} status - The status of the jobs to filter the results.
|
|
163
|
-
* @property {string} fileType
|
|
156
|
+
* @property {string} fileType - The type of file to be downloaded.
|
|
164
157
|
* @property {string} [reportType] - The type of report to be downloaded.
|
|
165
158
|
*/
|
|
166
159
|
|
|
@@ -177,27 +170,15 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
177
170
|
* @property {string} [salesChannels]
|
|
178
171
|
* @property {string} [paymentMode] - Comma separated values of payment modes
|
|
179
172
|
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
180
|
-
* @property {string} [searchType]
|
|
181
|
-
* be used as the target for the search operation
|
|
173
|
+
* @property {string} [searchType]
|
|
182
174
|
* @property {string} [searchValue]
|
|
183
175
|
* @property {string} [tags]
|
|
184
|
-
* @property {number} [timeToDispatch]
|
|
176
|
+
* @property {number} [timeToDispatch]
|
|
185
177
|
* @property {string} [paymentMethods]
|
|
186
178
|
* @property {boolean} [myOrders]
|
|
187
179
|
* @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
|
|
188
180
|
* company order
|
|
189
|
-
* @property {string} [orderType]
|
|
190
|
-
* follow based on the application's operational needs and customer
|
|
191
|
-
* preferences. This field categorizes orders into distinct types, each
|
|
192
|
-
* associated with a unique processing flow. For example:
|
|
193
|
-
*
|
|
194
|
-
* - "HomeDelivery": The order goes through all the steps needed for delivery,
|
|
195
|
-
* from being packed to arriving at the customer’s address.
|
|
196
|
-
* - "PickAtStore": The order is prepared for pickup at the store, skipping
|
|
197
|
-
* shipping steps to make it ready faster for the customer to collect in person.
|
|
198
|
-
* - "Digital": This order type likely refers to orders that involve digital goods
|
|
199
|
-
* or services, such as software, digital subscriptions, e-books, online
|
|
200
|
-
* courses, or any other item that can be delivered electronically.
|
|
181
|
+
* @property {string} [orderType]
|
|
201
182
|
*/
|
|
202
183
|
|
|
203
184
|
/**
|
|
@@ -260,44 +241,35 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
260
241
|
/**
|
|
261
242
|
* @typedef GetOrdersParam
|
|
262
243
|
* @property {string} [lane] - Lane refers to a section where orders are
|
|
263
|
-
* assigned, indicating its grouping
|
|
244
|
+
* assigned, indicating its grouping
|
|
264
245
|
* @property {string} [searchType] - Search_type refers to the field that will
|
|
265
|
-
* be used as the target for the search operation
|
|
246
|
+
* be used as the target for the search operation
|
|
266
247
|
* @property {string} [bagStatus] - Bag_status refers to status of the entity.
|
|
267
248
|
* Filters orders based on the status.
|
|
268
249
|
* @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
|
|
269
|
-
* @property {string} [paymentMethods]
|
|
270
|
-
* methods that were used to place order.
|
|
250
|
+
* @property {string} [paymentMethods]
|
|
271
251
|
* @property {string} [tags] - Tags refers to additional descriptive labels
|
|
272
252
|
* associated with the order
|
|
273
253
|
* @property {string} [searchValue] - Search_value is matched against the field
|
|
274
254
|
* specified by the search_type
|
|
275
|
-
* @property {string} [fromDate]
|
|
276
|
-
* @property {string} [toDate]
|
|
277
|
-
* @property {string} [startDate]
|
|
278
|
-
* @property {string} [endDate]
|
|
255
|
+
* @property {string} [fromDate]
|
|
256
|
+
* @property {string} [toDate]
|
|
257
|
+
* @property {string} [startDate]
|
|
258
|
+
* @property {string} [endDate]
|
|
279
259
|
* @property {string} [dpIds] - Delivery Partner IDs to which shipments are assigned.
|
|
280
|
-
* @property {string} [stores]
|
|
281
|
-
*
|
|
282
|
-
* @property {
|
|
283
|
-
*
|
|
284
|
-
* @property {number} [pageNo] - Specifies the page number for paginated results.
|
|
285
|
-
* @property {number} [pageSize] - Determines the number of results returned per page.
|
|
260
|
+
* @property {string} [stores]
|
|
261
|
+
* @property {string} [salesChannels]
|
|
262
|
+
* @property {number} [pageNo]
|
|
263
|
+
* @property {number} [pageSize]
|
|
286
264
|
* @property {boolean} [isPrioritySort]
|
|
287
265
|
* @property {string} [customMeta]
|
|
288
266
|
* @property {boolean} [myOrders]
|
|
289
267
|
* @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
|
|
290
268
|
* company order
|
|
291
|
-
* @property {string} [customerId]
|
|
292
|
-
* associated with the query, useful for filtering results to a specific customer.
|
|
269
|
+
* @property {string} [customerId]
|
|
293
270
|
* @property {string} [orderType]
|
|
294
271
|
* @property {boolean} [allowInactive] - Flag indicating whether inactive
|
|
295
272
|
* shipments are allowed
|
|
296
|
-
* @property {string} [groupEntity] - Defines the grouping criterion for
|
|
297
|
-
* retrieving shipments or orders. It specifies whether the results should be
|
|
298
|
-
* organized based on shipment groups or order groups. For example, using
|
|
299
|
-
* 'shipments' groups results by shipment, while an invalid value like 'abcd'
|
|
300
|
-
* may not be recognized, leading to errors or default behavior.
|
|
301
273
|
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
302
274
|
* orders. This is useful when fetching data for a specific date range while
|
|
303
275
|
* performing searches.
|
|
@@ -307,9 +279,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
307
279
|
|
|
308
280
|
/**
|
|
309
281
|
* @typedef GetShipmentByIdParam
|
|
310
|
-
* @property {string} [channelShipmentId] -
|
|
311
|
-
*
|
|
312
|
-
* @property {string} [shipmentId] - The unique identifier for a shipment.
|
|
282
|
+
* @property {string} [channelShipmentId] - App Shipment Id
|
|
283
|
+
* @property {string} [shipmentId] - Shipment Id
|
|
313
284
|
* @property {boolean} [fetchActiveShipment] - Flag to fetch active or
|
|
314
285
|
* deactivated shipments
|
|
315
286
|
* @property {boolean} [allowInactive] - Flag indicating whether inactive
|
|
@@ -335,61 +306,38 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
335
306
|
/**
|
|
336
307
|
* @typedef GetShipmentsParam
|
|
337
308
|
* @property {string} [lane] - Name of lane for which data is to be fetched
|
|
338
|
-
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
309
|
+
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
339
310
|
* @property {boolean} [statusOverrideLane] - Use this flag to fetch by
|
|
340
|
-
* bag_status and override lane
|
|
341
|
-
* @property {number} [timeToDispatch]
|
|
342
|
-
* @property {string} [searchType] -
|
|
343
|
-
*
|
|
344
|
-
* @property {string} [searchValue] - The value corresponding to the search
|
|
345
|
-
* type, such as a specific shipment ID or order ID.
|
|
311
|
+
* bag_status and override lane
|
|
312
|
+
* @property {number} [timeToDispatch]
|
|
313
|
+
* @property {string} [searchType] - Search type key
|
|
314
|
+
* @property {string} [searchValue] - Search type value
|
|
346
315
|
* @property {string} [fromDate] - Start Date in DD-MM-YYYY format
|
|
347
316
|
* @property {string} [toDate] - End Date in DD-MM-YYYY format
|
|
348
|
-
* @property {string} [startDate] -
|
|
349
|
-
*
|
|
350
|
-
* @property {string} [
|
|
351
|
-
*
|
|
352
|
-
* @property {string} [
|
|
353
|
-
*
|
|
354
|
-
* @property {
|
|
355
|
-
*
|
|
356
|
-
* @property {
|
|
357
|
-
*
|
|
358
|
-
* @property {
|
|
359
|
-
* @property {
|
|
360
|
-
* @property {
|
|
361
|
-
*
|
|
362
|
-
* @property {
|
|
363
|
-
*
|
|
364
|
-
* @property {boolean} [
|
|
365
|
-
*
|
|
366
|
-
* @property {string} [
|
|
367
|
-
* @property {
|
|
368
|
-
*
|
|
369
|
-
* @property {string} [
|
|
370
|
-
* @property {string} [
|
|
371
|
-
*
|
|
372
|
-
* @property {string} [orderingChannel] - The channel through which the order was placed.
|
|
373
|
-
* @property {string} [companyAffiliateTag] - A tag used to identify the
|
|
374
|
-
* company's affiliation for filtering or reporting purposes.
|
|
375
|
-
* @property {boolean} [myOrders] - A boolean flag indicating whether the query
|
|
376
|
-
* should return only the user's orders.
|
|
377
|
-
* @property {string} [platformUserId] - The unique identifier of the user on
|
|
378
|
-
* the platform, useful for filtering orders related to a specific user.
|
|
379
|
-
* @property {string} [sortType] - Determines the sorting order of the results
|
|
380
|
-
* based on specific criteria.
|
|
381
|
-
* @property {boolean} [showCrossCompanyData] - A flag indicating whether to
|
|
382
|
-
* include data from both cross-company and non-cross-company orders in the results.
|
|
383
|
-
* @property {string} [tags] - A comma-separated list of tags associated with
|
|
384
|
-
* the orders to filter results based on specific characteristics.
|
|
385
|
-
* @property {string} [customerId] - The unique identifier for the customer
|
|
386
|
-
* associated with the query, useful for filtering results to a specific customer.
|
|
387
|
-
* @property {string} [orderType] - The type of order being queried.
|
|
388
|
-
* @property {string} [groupEntity] - Defines the grouping criterion for
|
|
389
|
-
* retrieving shipments or orders. It specifies whether the results should be
|
|
390
|
-
* organized based on shipment groups or order groups. For example, using
|
|
391
|
-
* 'shipments' groups results by shipment, while an invalid value like 'abcd'
|
|
392
|
-
* may not be recognized, leading to errors or default behavior.
|
|
317
|
+
* @property {string} [startDate] - UTC Start Date in ISO format
|
|
318
|
+
* @property {string} [endDate] - UTC End Date in ISO format
|
|
319
|
+
* @property {string} [dpIds] - Comma separated values of delivery partner ids
|
|
320
|
+
* @property {string} [stores] - Comma separated values of store ids
|
|
321
|
+
* @property {string} [salesChannels] - Comma separated values of sales channel ids
|
|
322
|
+
* @property {number} [pageNo] - Page number for paginated data
|
|
323
|
+
* @property {number} [pageSize] - Page size of data received per page
|
|
324
|
+
* @property {boolean} [fetchActiveShipment] - Flag to fetch active shipments
|
|
325
|
+
* @property {boolean} [allowInactive] - Flag to allow inactive shipments
|
|
326
|
+
* @property {boolean} [excludeLockedShipments] - Flag to fetch locked shipments
|
|
327
|
+
* @property {string} [paymentMethods] - Comma separated values of payment methods
|
|
328
|
+
* @property {string} [channelShipmentId] - App Shipment Id
|
|
329
|
+
* @property {string} [channelOrderId] - App Order Id
|
|
330
|
+
* @property {string} [customMeta]
|
|
331
|
+
* @property {string} [orderingChannel]
|
|
332
|
+
* @property {string} [companyAffiliateTag]
|
|
333
|
+
* @property {boolean} [myOrders]
|
|
334
|
+
* @property {string} [platformUserId]
|
|
335
|
+
* @property {string} [sortType] - Sort the result data on basis of input
|
|
336
|
+
* @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
|
|
337
|
+
* company order
|
|
338
|
+
* @property {string} [tags] - Comma separated values of tags
|
|
339
|
+
* @property {string} [customerId]
|
|
340
|
+
* @property {string} [orderType]
|
|
393
341
|
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
394
342
|
* shipments. This is useful when fetching data for a specific date range
|
|
395
343
|
* while performing searches.
|
|
@@ -461,8 +409,18 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
461
409
|
|
|
462
410
|
/**
|
|
463
411
|
* @typedef UpdateAddressParam
|
|
464
|
-
* @property {string} shipmentId
|
|
465
|
-
* @property {
|
|
412
|
+
* @property {string} shipmentId
|
|
413
|
+
* @property {string} [name]
|
|
414
|
+
* @property {string} [address]
|
|
415
|
+
* @property {string} [addressType]
|
|
416
|
+
* @property {string} [pincode]
|
|
417
|
+
* @property {string} [phone]
|
|
418
|
+
* @property {string} [email]
|
|
419
|
+
* @property {string} [landmark]
|
|
420
|
+
* @property {string} addressCategory
|
|
421
|
+
* @property {string} [city]
|
|
422
|
+
* @property {string} [state]
|
|
423
|
+
* @property {string} [country]
|
|
466
424
|
*/
|
|
467
425
|
|
|
468
426
|
/**
|
|
@@ -470,11 +428,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
470
428
|
* @property {OrderPlatformModel.UpdatePackagingDimensionsPayload} body
|
|
471
429
|
*/
|
|
472
430
|
|
|
473
|
-
/**
|
|
474
|
-
* @typedef UpdatePaymentInfoParam
|
|
475
|
-
* @property {OrderPlatformModel.UpdateShipmentPaymentMode} body
|
|
476
|
-
*/
|
|
477
|
-
|
|
478
431
|
/**
|
|
479
432
|
* @typedef UpdateShipmentLockParam
|
|
480
433
|
* @property {OrderPlatformModel.UpdateShipmentLockPayload} body
|
|
@@ -542,13 +495,6 @@ class OrderPlatformValidator {
|
|
|
542
495
|
}).required();
|
|
543
496
|
}
|
|
544
497
|
|
|
545
|
-
/** @returns {CreateChannelConfigParam} */
|
|
546
|
-
static createChannelConfig() {
|
|
547
|
-
return Joi.object({
|
|
548
|
-
body: OrderPlatformModel.CreateChannelConfigData().required(),
|
|
549
|
-
}).required();
|
|
550
|
-
}
|
|
551
|
-
|
|
552
498
|
/** @returns {CreateOrderParam} */
|
|
553
499
|
static createOrder() {
|
|
554
500
|
return Joi.object({
|
|
@@ -573,7 +519,7 @@ class OrderPlatformValidator {
|
|
|
573
519
|
/** @returns {DownloadLanesReportParam} */
|
|
574
520
|
static downloadLanesReport() {
|
|
575
521
|
return Joi.object({
|
|
576
|
-
body: OrderPlatformModel.
|
|
522
|
+
body: OrderPlatformModel.BulkReportsDownloadRequest().required(),
|
|
577
523
|
}).required();
|
|
578
524
|
}
|
|
579
525
|
|
|
@@ -629,7 +575,7 @@ class OrderPlatformValidator {
|
|
|
629
575
|
/** @returns {GenerateProcessManifestParam} */
|
|
630
576
|
static generateProcessManifest() {
|
|
631
577
|
return Joi.object({
|
|
632
|
-
body: OrderPlatformModel.
|
|
578
|
+
body: OrderPlatformModel.ProcessManifestRequest().required(),
|
|
633
579
|
}).required();
|
|
634
580
|
}
|
|
635
581
|
|
|
@@ -700,11 +646,6 @@ class OrderPlatformValidator {
|
|
|
700
646
|
}).required();
|
|
701
647
|
}
|
|
702
648
|
|
|
703
|
-
/** @returns {GetChannelConfigParam} */
|
|
704
|
-
static getChannelConfig() {
|
|
705
|
-
return Joi.object({}).required();
|
|
706
|
-
}
|
|
707
|
-
|
|
708
649
|
/** @returns {GetFileByStatusParam} */
|
|
709
650
|
static getFileByStatus() {
|
|
710
651
|
return Joi.object({
|
|
@@ -825,7 +766,6 @@ class OrderPlatformValidator {
|
|
|
825
766
|
customerId: Joi.string().allow(""),
|
|
826
767
|
orderType: Joi.string().allow(""),
|
|
827
768
|
allowInactive: Joi.boolean(),
|
|
828
|
-
groupEntity: Joi.string().allow(""),
|
|
829
769
|
enforceDateFilter: Joi.boolean(),
|
|
830
770
|
}).required();
|
|
831
771
|
}
|
|
@@ -896,7 +836,6 @@ class OrderPlatformValidator {
|
|
|
896
836
|
tags: Joi.string().allow(""),
|
|
897
837
|
customerId: Joi.string().allow(""),
|
|
898
838
|
orderType: Joi.string().allow(""),
|
|
899
|
-
groupEntity: Joi.string().allow(""),
|
|
900
839
|
enforceDateFilter: Joi.boolean(),
|
|
901
840
|
}).required();
|
|
902
841
|
}
|
|
@@ -993,7 +932,17 @@ class OrderPlatformValidator {
|
|
|
993
932
|
static updateAddress() {
|
|
994
933
|
return Joi.object({
|
|
995
934
|
shipmentId: Joi.string().allow("").required(),
|
|
996
|
-
|
|
935
|
+
name: Joi.string().allow(""),
|
|
936
|
+
address: Joi.string().allow(""),
|
|
937
|
+
addressType: Joi.string().allow(""),
|
|
938
|
+
pincode: Joi.string().allow(""),
|
|
939
|
+
phone: Joi.string().allow(""),
|
|
940
|
+
email: Joi.string().allow(""),
|
|
941
|
+
landmark: Joi.string().allow(""),
|
|
942
|
+
addressCategory: Joi.string().allow("").required(),
|
|
943
|
+
city: Joi.string().allow(""),
|
|
944
|
+
state: Joi.string().allow(""),
|
|
945
|
+
country: Joi.string().allow(""),
|
|
997
946
|
}).required();
|
|
998
947
|
}
|
|
999
948
|
|
|
@@ -1004,13 +953,6 @@ class OrderPlatformValidator {
|
|
|
1004
953
|
}).required();
|
|
1005
954
|
}
|
|
1006
955
|
|
|
1007
|
-
/** @returns {UpdatePaymentInfoParam} */
|
|
1008
|
-
static updatePaymentInfo() {
|
|
1009
|
-
return Joi.object({
|
|
1010
|
-
body: OrderPlatformModel.UpdateShipmentPaymentMode().required(),
|
|
1011
|
-
}).required();
|
|
1012
|
-
}
|
|
1013
|
-
|
|
1014
956
|
/** @returns {UpdateShipmentLockParam} */
|
|
1015
957
|
static updateShipmentLock() {
|
|
1016
958
|
return Joi.object({
|
|
@@ -7,24 +7,22 @@ declare class Partner {
|
|
|
7
7
|
* @param {PartnerPlatformApplicationValidator.AddProxyPathParam} arg - Arg object
|
|
8
8
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
|
-
* @returns {Promise<PartnerPlatformModel.
|
|
11
|
-
* Success response
|
|
10
|
+
* @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
|
|
12
11
|
* @name addProxyPath
|
|
13
12
|
* @summary: Create extension proxy
|
|
14
13
|
* @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
|
|
15
14
|
*/
|
|
16
|
-
addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.
|
|
15
|
+
addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.AddProxyResponse>;
|
|
17
16
|
/**
|
|
18
17
|
* @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
|
|
19
18
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
20
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
|
-
* @returns {Promise<PartnerPlatformModel.
|
|
22
|
-
* Success response
|
|
20
|
+
* @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
|
|
23
21
|
* @name removeProxyPath
|
|
24
22
|
* @summary: Remove extension proxy
|
|
25
23
|
* @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
|
|
26
24
|
*/
|
|
27
|
-
removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.
|
|
25
|
+
removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.RemoveProxyResponse>;
|
|
28
26
|
}
|
|
29
27
|
import PartnerPlatformApplicationValidator = require("./PartnerPlatformApplicationValidator");
|
|
30
28
|
import PartnerPlatformModel = require("./PartnerPlatformModel");
|
|
@@ -19,8 +19,7 @@ class Partner {
|
|
|
19
19
|
* @param {PartnerPlatformApplicationValidator.AddProxyPathParam} arg - Arg object
|
|
20
20
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
|
-
* @returns {Promise<PartnerPlatformModel.
|
|
23
|
-
* Success response
|
|
22
|
+
* @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
|
|
24
23
|
* @name addProxyPath
|
|
25
24
|
* @summary: Create extension proxy
|
|
26
25
|
* @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
|
|
@@ -78,10 +77,10 @@ class Partner {
|
|
|
78
77
|
|
|
79
78
|
const {
|
|
80
79
|
error: res_error,
|
|
81
|
-
} = PartnerPlatformModel.
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
);
|
|
80
|
+
} = PartnerPlatformModel.AddProxyResponse().validate(responseData, {
|
|
81
|
+
abortEarly: false,
|
|
82
|
+
allowUnknown: true,
|
|
83
|
+
});
|
|
85
84
|
|
|
86
85
|
if (res_error) {
|
|
87
86
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -101,8 +100,7 @@ class Partner {
|
|
|
101
100
|
* @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
|
|
102
101
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
103
102
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
104
|
-
* @returns {Promise<PartnerPlatformModel.
|
|
105
|
-
* Success response
|
|
103
|
+
* @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
|
|
106
104
|
* @name removeProxyPath
|
|
107
105
|
* @summary: Remove extension proxy
|
|
108
106
|
* @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
|
|
@@ -160,7 +158,7 @@ class Partner {
|
|
|
160
158
|
|
|
161
159
|
const {
|
|
162
160
|
error: res_error,
|
|
163
|
-
} = PartnerPlatformModel.
|
|
161
|
+
} = PartnerPlatformModel.RemoveProxyResponse().validate(responseData, {
|
|
164
162
|
abortEarly: false,
|
|
165
163
|
allowUnknown: true,
|
|
166
164
|
});
|
|
@@ -6,7 +6,7 @@ export = PartnerPlatformModel;
|
|
|
6
6
|
* will be generated
|
|
7
7
|
*/
|
|
8
8
|
/**
|
|
9
|
-
* @typedef
|
|
9
|
+
* @typedef AddProxyResponse
|
|
10
10
|
* @property {string} [_id]
|
|
11
11
|
* @property {string} [attached_path]
|
|
12
12
|
* @property {string} [proxy_url]
|
|
@@ -17,7 +17,7 @@ export = PartnerPlatformModel;
|
|
|
17
17
|
* @property {string} [modified_at]
|
|
18
18
|
*/
|
|
19
19
|
/**
|
|
20
|
-
* @typedef
|
|
20
|
+
* @typedef RemoveProxyResponse
|
|
21
21
|
* @property {string} [message]
|
|
22
22
|
* @property {Object} [data]
|
|
23
23
|
*/
|
|
@@ -32,7 +32,7 @@ export = PartnerPlatformModel;
|
|
|
32
32
|
declare class PartnerPlatformModel {
|
|
33
33
|
}
|
|
34
34
|
declare namespace PartnerPlatformModel {
|
|
35
|
-
export { AddProxyReq,
|
|
35
|
+
export { AddProxyReq, AddProxyResponse, RemoveProxyResponse, APIError };
|
|
36
36
|
}
|
|
37
37
|
/** @returns {AddProxyReq} */
|
|
38
38
|
declare function AddProxyReq(): AddProxyReq;
|
|
@@ -47,9 +47,9 @@ type AddProxyReq = {
|
|
|
47
47
|
*/
|
|
48
48
|
proxy_url?: string;
|
|
49
49
|
};
|
|
50
|
-
/** @returns {
|
|
51
|
-
declare function
|
|
52
|
-
type
|
|
50
|
+
/** @returns {AddProxyResponse} */
|
|
51
|
+
declare function AddProxyResponse(): AddProxyResponse;
|
|
52
|
+
type AddProxyResponse = {
|
|
53
53
|
_id?: string;
|
|
54
54
|
attached_path?: string;
|
|
55
55
|
proxy_url?: string;
|
|
@@ -59,9 +59,9 @@ type ExtensionProxyPathCreation = {
|
|
|
59
59
|
created_at?: string;
|
|
60
60
|
modified_at?: string;
|
|
61
61
|
};
|
|
62
|
-
/** @returns {
|
|
63
|
-
declare function
|
|
64
|
-
type
|
|
62
|
+
/** @returns {RemoveProxyResponse} */
|
|
63
|
+
declare function RemoveProxyResponse(): RemoveProxyResponse;
|
|
64
|
+
type RemoveProxyResponse = {
|
|
65
65
|
message?: string;
|
|
66
66
|
data?: any;
|
|
67
67
|
};
|
|
@@ -8,7 +8,7 @@ const Joi = require("joi");
|
|
|
8
8
|
*/
|
|
9
9
|
|
|
10
10
|
/**
|
|
11
|
-
* @typedef
|
|
11
|
+
* @typedef AddProxyResponse
|
|
12
12
|
* @property {string} [_id]
|
|
13
13
|
* @property {string} [attached_path]
|
|
14
14
|
* @property {string} [proxy_url]
|
|
@@ -20,7 +20,7 @@ const Joi = require("joi");
|
|
|
20
20
|
*/
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* @typedef
|
|
23
|
+
* @typedef RemoveProxyResponse
|
|
24
24
|
* @property {string} [message]
|
|
25
25
|
* @property {Object} [data]
|
|
26
26
|
*/
|
|
@@ -43,8 +43,8 @@ class PartnerPlatformModel {
|
|
|
43
43
|
});
|
|
44
44
|
}
|
|
45
45
|
|
|
46
|
-
/** @returns {
|
|
47
|
-
static
|
|
46
|
+
/** @returns {AddProxyResponse} */
|
|
47
|
+
static AddProxyResponse() {
|
|
48
48
|
return Joi.object({
|
|
49
49
|
_id: Joi.string().allow(""),
|
|
50
50
|
attached_path: Joi.string().allow(""),
|
|
@@ -57,11 +57,11 @@ class PartnerPlatformModel {
|
|
|
57
57
|
});
|
|
58
58
|
}
|
|
59
59
|
|
|
60
|
-
/** @returns {
|
|
61
|
-
static
|
|
60
|
+
/** @returns {RemoveProxyResponse} */
|
|
61
|
+
static RemoveProxyResponse() {
|
|
62
62
|
return Joi.object({
|
|
63
63
|
message: Joi.string().allow(""),
|
|
64
|
-
data: Joi.
|
|
64
|
+
data: Joi.any(),
|
|
65
65
|
});
|
|
66
66
|
}
|
|
67
67
|
|
|
@@ -72,7 +72,7 @@ class PartnerPlatformModel {
|
|
|
72
72
|
message: Joi.string().allow(""),
|
|
73
73
|
info: Joi.string().allow(""),
|
|
74
74
|
request_id: Joi.string().allow(""),
|
|
75
|
-
meta: Joi.
|
|
75
|
+
meta: Joi.any(),
|
|
76
76
|
});
|
|
77
77
|
}
|
|
78
78
|
}
|