@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5
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 +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +118 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- 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 +51 -30
- package/sdk/application/Content/ContentApplicationClient.js +161 -56
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +101 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +56 -8
- 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 +4 -2
- 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/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -21
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -16
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- 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 +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5070 -1296
- package/sdk/platform/Cart/CartPlatformModel.js +1992 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6512 -1770
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3228 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +204 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1076 -478
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +253 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +256 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1372 -400
- package/sdk/platform/Content/ContentPlatformModel.js +631 -394
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- 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 +95 -39
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -63
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -22
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -24
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -116
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -104
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- 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 +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7607 -1267
- package/sdk/platform/Order/OrderPlatformModel.js +3929 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- 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 +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- 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 +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -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 +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +46 -7
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- 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 +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +810 -6
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- 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/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -35,6 +35,11 @@ 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
|
+
|
|
38
43
|
/**
|
|
39
44
|
* @typedef CreateOrderParam
|
|
40
45
|
* @property {OrderPlatformModel.CreateOrderAPI} body
|
|
@@ -52,7 +57,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
52
57
|
|
|
53
58
|
/**
|
|
54
59
|
* @typedef DownloadLanesReportParam
|
|
55
|
-
* @property {OrderPlatformModel.
|
|
60
|
+
* @property {OrderPlatformModel.BulkReportsDownloadRequestSchema} body
|
|
56
61
|
*/
|
|
57
62
|
|
|
58
63
|
/**
|
|
@@ -94,7 +99,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
94
99
|
|
|
95
100
|
/**
|
|
96
101
|
* @typedef GenerateProcessManifestParam
|
|
97
|
-
* @property {OrderPlatformModel.
|
|
102
|
+
* @property {OrderPlatformModel.ProcessManifestRequestSchema} body
|
|
98
103
|
*/
|
|
99
104
|
|
|
100
105
|
/**
|
|
@@ -113,7 +118,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
113
118
|
|
|
114
119
|
/**
|
|
115
120
|
* @typedef GetBagByIdParam
|
|
116
|
-
* @property {string} [bagId] -
|
|
121
|
+
* @property {string} [bagId] - Unique identifier of a bag
|
|
117
122
|
* @property {string} [channelBagId] - Id of application bag
|
|
118
123
|
* @property {string} [channelId] - Id of application
|
|
119
124
|
*/
|
|
@@ -137,8 +142,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
137
142
|
* @typedef GetBulkShipmentExcelFileParam
|
|
138
143
|
* @property {string} [salesChannels] - Comma separated values of sales channel ids
|
|
139
144
|
* @property {string} [dpIds] - Comma separated values of delivery partner ids
|
|
140
|
-
* @property {string} [startDate] - UTC
|
|
141
|
-
* @property {string} [endDate] - UTC
|
|
145
|
+
* @property {string} [startDate] - Date time in UTC timezone as per ISO format.
|
|
146
|
+
* @property {string} [endDate] - Date time in UTC timezone as per ISO format.
|
|
142
147
|
* @property {string} [stores] - Comma separated values of store ids
|
|
143
148
|
* @property {string} [tags] - Comma separated values of tags
|
|
144
149
|
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
@@ -149,11 +154,13 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
149
154
|
* @property {number} [pageSize]
|
|
150
155
|
*/
|
|
151
156
|
|
|
157
|
+
/** @typedef GetChannelConfigParam */
|
|
158
|
+
|
|
152
159
|
/**
|
|
153
160
|
* @typedef GetFileByStatusParam
|
|
154
161
|
* @property {string} batchId - Batch Id to identify the bulk operation request.
|
|
155
162
|
* @property {string} status - The status of the jobs to filter the results.
|
|
156
|
-
* @property {string} fileType
|
|
163
|
+
* @property {string} fileType
|
|
157
164
|
* @property {string} [reportType] - The type of report to be downloaded.
|
|
158
165
|
*/
|
|
159
166
|
|
|
@@ -170,15 +177,27 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
170
177
|
* @property {string} [salesChannels]
|
|
171
178
|
* @property {string} [paymentMode] - Comma separated values of payment modes
|
|
172
179
|
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
173
|
-
* @property {string} [searchType]
|
|
180
|
+
* @property {string} [searchType] - Search_type refers to the field that will
|
|
181
|
+
* be used as the target for the search operation
|
|
174
182
|
* @property {string} [searchValue]
|
|
175
183
|
* @property {string} [tags]
|
|
176
|
-
* @property {number} [timeToDispatch]
|
|
184
|
+
* @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
|
|
177
185
|
* @property {string} [paymentMethods]
|
|
178
186
|
* @property {boolean} [myOrders]
|
|
179
187
|
* @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
|
|
180
188
|
* company order
|
|
181
|
-
* @property {string} [orderType]
|
|
189
|
+
* @property {string} [orderType] - Defines the specific journey a shipment will
|
|
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.
|
|
182
201
|
*/
|
|
183
202
|
|
|
184
203
|
/**
|
|
@@ -241,35 +260,44 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
241
260
|
/**
|
|
242
261
|
* @typedef GetOrdersParam
|
|
243
262
|
* @property {string} [lane] - Lane refers to a section where orders are
|
|
244
|
-
* assigned, indicating its grouping
|
|
263
|
+
* assigned, indicating its grouping.
|
|
245
264
|
* @property {string} [searchType] - Search_type refers to the field that will
|
|
246
|
-
* be used as the target for the search operation
|
|
265
|
+
* be used as the target for the search operation.
|
|
247
266
|
* @property {string} [bagStatus] - Bag_status refers to status of the entity.
|
|
248
267
|
* Filters orders based on the status.
|
|
249
268
|
* @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
|
|
250
|
-
* @property {string} [paymentMethods]
|
|
269
|
+
* @property {string} [paymentMethods] - Comma separated values of payment
|
|
270
|
+
* methods that were used to place order.
|
|
251
271
|
* @property {string} [tags] - Tags refers to additional descriptive labels
|
|
252
272
|
* associated with the order
|
|
253
273
|
* @property {string} [searchValue] - Search_value is matched against the field
|
|
254
274
|
* specified by the search_type
|
|
255
|
-
* @property {string} [fromDate]
|
|
256
|
-
* @property {string} [toDate]
|
|
257
|
-
* @property {string} [startDate]
|
|
258
|
-
* @property {string} [endDate]
|
|
275
|
+
* @property {string} [fromDate] - Date time in UTC timezone as per ISO format.
|
|
276
|
+
* @property {string} [toDate] - Date time in UTC timezone as per ISO format.
|
|
277
|
+
* @property {string} [startDate] - Date time in UTC timezone as per ISO format.
|
|
278
|
+
* @property {string} [endDate] - Date time in UTC timezone as per ISO format.
|
|
259
279
|
* @property {string} [dpIds] - Delivery Partner IDs to which shipments are assigned.
|
|
260
|
-
* @property {string} [stores]
|
|
261
|
-
*
|
|
262
|
-
* @property {
|
|
263
|
-
*
|
|
280
|
+
* @property {string} [stores] - A comma-separated list of store IDs used to
|
|
281
|
+
* filter results to only those related to specific stores.
|
|
282
|
+
* @property {string} [salesChannels] - A comma-separated list of sales channel
|
|
283
|
+
* IDs to filter results based on the sales channels involved.
|
|
284
|
+
* @property {number} [pageNo] - Specifies the page number for paginated results.
|
|
285
|
+
* @property {number} [pageSize] - Determines the number of results returned per page.
|
|
264
286
|
* @property {boolean} [isPrioritySort]
|
|
265
287
|
* @property {string} [customMeta]
|
|
266
288
|
* @property {boolean} [myOrders]
|
|
267
289
|
* @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
|
|
268
290
|
* company order
|
|
269
|
-
* @property {string} [customerId]
|
|
291
|
+
* @property {string} [customerId] - The unique identifier for the customer
|
|
292
|
+
* associated with the query, useful for filtering results to a specific customer.
|
|
270
293
|
* @property {string} [orderType]
|
|
271
294
|
* @property {boolean} [allowInactive] - Flag indicating whether inactive
|
|
272
295
|
* 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.
|
|
273
301
|
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
274
302
|
* orders. This is useful when fetching data for a specific date range while
|
|
275
303
|
* performing searches.
|
|
@@ -279,8 +307,9 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
279
307
|
|
|
280
308
|
/**
|
|
281
309
|
* @typedef GetShipmentByIdParam
|
|
282
|
-
* @property {string} [channelShipmentId] -
|
|
283
|
-
*
|
|
310
|
+
* @property {string} [channelShipmentId] - The shipment ID used in the
|
|
311
|
+
* application, which can be used to reference specific shipments.
|
|
312
|
+
* @property {string} [shipmentId] - The unique identifier for a shipment.
|
|
284
313
|
* @property {boolean} [fetchActiveShipment] - Flag to fetch active or
|
|
285
314
|
* deactivated shipments
|
|
286
315
|
* @property {boolean} [allowInactive] - Flag indicating whether inactive
|
|
@@ -306,38 +335,61 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
306
335
|
/**
|
|
307
336
|
* @typedef GetShipmentsParam
|
|
308
337
|
* @property {string} [lane] - Name of lane for which data is to be fetched
|
|
309
|
-
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
338
|
+
* @property {string} [bagStatus] - Comma separated values of bag statuses.
|
|
310
339
|
* @property {boolean} [statusOverrideLane] - Use this flag to fetch by
|
|
311
|
-
* bag_status and override lane
|
|
312
|
-
* @property {number} [timeToDispatch]
|
|
313
|
-
* @property {string} [searchType] -
|
|
314
|
-
*
|
|
340
|
+
* bag_status and override lane.
|
|
341
|
+
* @property {number} [timeToDispatch] - Indicates the time to dispatch.
|
|
342
|
+
* @property {string} [searchType] - Specifies the key used to determine the
|
|
343
|
+
* type of search being performed.
|
|
344
|
+
* @property {string} [searchValue] - The value corresponding to the search
|
|
345
|
+
* type, such as a specific shipment ID or order ID.
|
|
315
346
|
* @property {string} [fromDate] - Start Date in DD-MM-YYYY format
|
|
316
347
|
* @property {string} [toDate] - End Date in DD-MM-YYYY format
|
|
317
|
-
* @property {string} [startDate] - UTC
|
|
318
|
-
*
|
|
319
|
-
* @property {string} [
|
|
320
|
-
*
|
|
321
|
-
* @property {string} [
|
|
322
|
-
*
|
|
323
|
-
* @property {
|
|
324
|
-
*
|
|
325
|
-
* @property {
|
|
326
|
-
*
|
|
327
|
-
* @property {
|
|
328
|
-
* @property {
|
|
329
|
-
* @property {
|
|
330
|
-
*
|
|
331
|
-
* @property {
|
|
332
|
-
*
|
|
333
|
-
* @property {boolean} [
|
|
334
|
-
*
|
|
335
|
-
* @property {string} [
|
|
336
|
-
* @property {
|
|
337
|
-
*
|
|
338
|
-
* @property {string} [
|
|
339
|
-
* @property {string} [
|
|
340
|
-
*
|
|
348
|
+
* @property {string} [startDate] - The UTC start date in ISO format
|
|
349
|
+
* (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
|
|
350
|
+
* @property {string} [endDate] - The UTC end date in ISO format
|
|
351
|
+
* (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
|
|
352
|
+
* @property {string} [dpIds] - A comma-separated list of delivery partner IDs
|
|
353
|
+
* to filter results by specific delivery partners.
|
|
354
|
+
* @property {string} [stores] - A comma-separated list of store IDs used to
|
|
355
|
+
* filter results to only those related to specific stores.
|
|
356
|
+
* @property {string} [salesChannels] - A comma-separated list of sales channel
|
|
357
|
+
* IDs to filter results based on the sales channels involved.
|
|
358
|
+
* @property {number} [pageNo] - Specifies the page number for paginated results.
|
|
359
|
+
* @property {number} [pageSize] - Determines the number of results returned per page.
|
|
360
|
+
* @property {boolean} [fetchActiveShipment] - A boolean flag that indicates
|
|
361
|
+
* whether to include only active shipments in the results.
|
|
362
|
+
* @property {boolean} [allowInactive] - A flag indicating whether to allow the
|
|
363
|
+
* inclusion of inactive shipments in the results.
|
|
364
|
+
* @property {boolean} [excludeLockedShipments] - A flag to specify whether to
|
|
365
|
+
* exclude shipments that are locked from the results.
|
|
366
|
+
* @property {string} [paymentMethods] - A comma-separated list of payment methods.
|
|
367
|
+
* @property {string} [channelShipmentId] - The shipment ID used in the
|
|
368
|
+
* application, which can be used to reference specific shipments.
|
|
369
|
+
* @property {string} [channelOrderId] - The order ID used in the application.
|
|
370
|
+
* @property {string} [customMeta] - Custom metadata associated with the query,
|
|
371
|
+
* allowing for additional filtering or information to be passed.
|
|
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.
|
|
341
393
|
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
342
394
|
* shipments. This is useful when fetching data for a specific date range
|
|
343
395
|
* while performing searches.
|
|
@@ -409,18 +461,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
409
461
|
|
|
410
462
|
/**
|
|
411
463
|
* @typedef UpdateAddressParam
|
|
412
|
-
* @property {string} shipmentId
|
|
413
|
-
* @property {
|
|
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]
|
|
464
|
+
* @property {string} shipmentId - Unique shipment no. that is auto-generated
|
|
465
|
+
* @property {OrderPlatformModel.UpdateAddressRequestBody} body
|
|
424
466
|
*/
|
|
425
467
|
|
|
426
468
|
/**
|
|
@@ -428,6 +470,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
428
470
|
* @property {OrderPlatformModel.UpdatePackagingDimensionsPayload} body
|
|
429
471
|
*/
|
|
430
472
|
|
|
473
|
+
/**
|
|
474
|
+
* @typedef UpdatePaymentInfoParam
|
|
475
|
+
* @property {OrderPlatformModel.UpdateShipmentPaymentMode} body
|
|
476
|
+
*/
|
|
477
|
+
|
|
431
478
|
/**
|
|
432
479
|
* @typedef UpdateShipmentLockParam
|
|
433
480
|
* @property {OrderPlatformModel.UpdateShipmentLockPayload} body
|
|
@@ -495,6 +542,13 @@ class OrderPlatformValidator {
|
|
|
495
542
|
}).required();
|
|
496
543
|
}
|
|
497
544
|
|
|
545
|
+
/** @returns {CreateChannelConfigParam} */
|
|
546
|
+
static createChannelConfig() {
|
|
547
|
+
return Joi.object({
|
|
548
|
+
body: OrderPlatformModel.CreateChannelConfigData().required(),
|
|
549
|
+
}).required();
|
|
550
|
+
}
|
|
551
|
+
|
|
498
552
|
/** @returns {CreateOrderParam} */
|
|
499
553
|
static createOrder() {
|
|
500
554
|
return Joi.object({
|
|
@@ -519,7 +573,7 @@ class OrderPlatformValidator {
|
|
|
519
573
|
/** @returns {DownloadLanesReportParam} */
|
|
520
574
|
static downloadLanesReport() {
|
|
521
575
|
return Joi.object({
|
|
522
|
-
body: OrderPlatformModel.
|
|
576
|
+
body: OrderPlatformModel.BulkReportsDownloadRequestSchema().required(),
|
|
523
577
|
}).required();
|
|
524
578
|
}
|
|
525
579
|
|
|
@@ -575,7 +629,7 @@ class OrderPlatformValidator {
|
|
|
575
629
|
/** @returns {GenerateProcessManifestParam} */
|
|
576
630
|
static generateProcessManifest() {
|
|
577
631
|
return Joi.object({
|
|
578
|
-
body: OrderPlatformModel.
|
|
632
|
+
body: OrderPlatformModel.ProcessManifestRequestSchema().required(),
|
|
579
633
|
}).required();
|
|
580
634
|
}
|
|
581
635
|
|
|
@@ -646,6 +700,11 @@ class OrderPlatformValidator {
|
|
|
646
700
|
}).required();
|
|
647
701
|
}
|
|
648
702
|
|
|
703
|
+
/** @returns {GetChannelConfigParam} */
|
|
704
|
+
static getChannelConfig() {
|
|
705
|
+
return Joi.object({}).required();
|
|
706
|
+
}
|
|
707
|
+
|
|
649
708
|
/** @returns {GetFileByStatusParam} */
|
|
650
709
|
static getFileByStatus() {
|
|
651
710
|
return Joi.object({
|
|
@@ -766,6 +825,7 @@ class OrderPlatformValidator {
|
|
|
766
825
|
customerId: Joi.string().allow(""),
|
|
767
826
|
orderType: Joi.string().allow(""),
|
|
768
827
|
allowInactive: Joi.boolean(),
|
|
828
|
+
groupEntity: Joi.string().allow(""),
|
|
769
829
|
enforceDateFilter: Joi.boolean(),
|
|
770
830
|
}).required();
|
|
771
831
|
}
|
|
@@ -836,6 +896,7 @@ class OrderPlatformValidator {
|
|
|
836
896
|
tags: Joi.string().allow(""),
|
|
837
897
|
customerId: Joi.string().allow(""),
|
|
838
898
|
orderType: Joi.string().allow(""),
|
|
899
|
+
groupEntity: Joi.string().allow(""),
|
|
839
900
|
enforceDateFilter: Joi.boolean(),
|
|
840
901
|
}).required();
|
|
841
902
|
}
|
|
@@ -932,17 +993,7 @@ class OrderPlatformValidator {
|
|
|
932
993
|
static updateAddress() {
|
|
933
994
|
return Joi.object({
|
|
934
995
|
shipmentId: Joi.string().allow("").required(),
|
|
935
|
-
|
|
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(""),
|
|
996
|
+
body: OrderPlatformModel.UpdateAddressRequestBody().required(),
|
|
946
997
|
}).required();
|
|
947
998
|
}
|
|
948
999
|
|
|
@@ -953,6 +1004,13 @@ class OrderPlatformValidator {
|
|
|
953
1004
|
}).required();
|
|
954
1005
|
}
|
|
955
1006
|
|
|
1007
|
+
/** @returns {UpdatePaymentInfoParam} */
|
|
1008
|
+
static updatePaymentInfo() {
|
|
1009
|
+
return Joi.object({
|
|
1010
|
+
body: OrderPlatformModel.UpdateShipmentPaymentMode().required(),
|
|
1011
|
+
}).required();
|
|
1012
|
+
}
|
|
1013
|
+
|
|
956
1014
|
/** @returns {UpdateShipmentLockParam} */
|
|
957
1015
|
static updateShipmentLock() {
|
|
958
1016
|
return Joi.object({
|
|
@@ -7,22 +7,24 @@ 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.
|
|
10
|
+
* @returns {Promise<PartnerPlatformModel.ExtensionProxyPathCreation>} -
|
|
11
|
+
* Success response
|
|
11
12
|
* @name addProxyPath
|
|
12
13
|
* @summary: Create extension proxy
|
|
13
14
|
* @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/).
|
|
14
15
|
*/
|
|
15
|
-
addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.
|
|
16
|
+
addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathCreation>;
|
|
16
17
|
/**
|
|
17
18
|
* @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
|
|
18
19
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
19
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
|
-
* @returns {Promise<PartnerPlatformModel.
|
|
21
|
+
* @returns {Promise<PartnerPlatformModel.ExtensionProxyPathDelete>} -
|
|
22
|
+
* Success response
|
|
21
23
|
* @name removeProxyPath
|
|
22
24
|
* @summary: Remove extension proxy
|
|
23
25
|
* @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/).
|
|
24
26
|
*/
|
|
25
|
-
removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.
|
|
27
|
+
removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathDelete>;
|
|
26
28
|
}
|
|
27
29
|
import PartnerPlatformApplicationValidator = require("./PartnerPlatformApplicationValidator");
|
|
28
30
|
import PartnerPlatformModel = require("./PartnerPlatformModel");
|
|
@@ -19,7 +19,8 @@ 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.
|
|
22
|
+
* @returns {Promise<PartnerPlatformModel.ExtensionProxyPathCreation>} -
|
|
23
|
+
* Success response
|
|
23
24
|
* @name addProxyPath
|
|
24
25
|
* @summary: Create extension proxy
|
|
25
26
|
* @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/).
|
|
@@ -77,10 +78,10 @@ class Partner {
|
|
|
77
78
|
|
|
78
79
|
const {
|
|
79
80
|
error: res_error,
|
|
80
|
-
} = PartnerPlatformModel.
|
|
81
|
-
|
|
82
|
-
allowUnknown: true
|
|
83
|
-
|
|
81
|
+
} = PartnerPlatformModel.ExtensionProxyPathCreation().validate(
|
|
82
|
+
responseData,
|
|
83
|
+
{ abortEarly: false, allowUnknown: true }
|
|
84
|
+
);
|
|
84
85
|
|
|
85
86
|
if (res_error) {
|
|
86
87
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -100,7 +101,8 @@ class Partner {
|
|
|
100
101
|
* @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
|
|
101
102
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
102
103
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
103
|
-
* @returns {Promise<PartnerPlatformModel.
|
|
104
|
+
* @returns {Promise<PartnerPlatformModel.ExtensionProxyPathDelete>} -
|
|
105
|
+
* Success response
|
|
104
106
|
* @name removeProxyPath
|
|
105
107
|
* @summary: Remove extension proxy
|
|
106
108
|
* @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/).
|
|
@@ -158,7 +160,7 @@ class Partner {
|
|
|
158
160
|
|
|
159
161
|
const {
|
|
160
162
|
error: res_error,
|
|
161
|
-
} = PartnerPlatformModel.
|
|
163
|
+
} = PartnerPlatformModel.ExtensionProxyPathDelete().validate(responseData, {
|
|
162
164
|
abortEarly: false,
|
|
163
165
|
allowUnknown: true,
|
|
164
166
|
});
|
|
@@ -6,7 +6,7 @@ export = PartnerPlatformModel;
|
|
|
6
6
|
* will be generated
|
|
7
7
|
*/
|
|
8
8
|
/**
|
|
9
|
-
* @typedef
|
|
9
|
+
* @typedef ExtensionProxyPathCreation
|
|
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 ExtensionProxyPathDelete
|
|
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, ExtensionProxyPathCreation, ExtensionProxyPathDelete, 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 {ExtensionProxyPathCreation} */
|
|
51
|
+
declare function ExtensionProxyPathCreation(): ExtensionProxyPathCreation;
|
|
52
|
+
type ExtensionProxyPathCreation = {
|
|
53
53
|
_id?: string;
|
|
54
54
|
attached_path?: string;
|
|
55
55
|
proxy_url?: string;
|
|
@@ -59,9 +59,9 @@ type AddProxyResponse = {
|
|
|
59
59
|
created_at?: string;
|
|
60
60
|
modified_at?: string;
|
|
61
61
|
};
|
|
62
|
-
/** @returns {
|
|
63
|
-
declare function
|
|
64
|
-
type
|
|
62
|
+
/** @returns {ExtensionProxyPathDelete} */
|
|
63
|
+
declare function ExtensionProxyPathDelete(): ExtensionProxyPathDelete;
|
|
64
|
+
type ExtensionProxyPathDelete = {
|
|
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 ExtensionProxyPathCreation
|
|
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 ExtensionProxyPathDelete
|
|
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 {ExtensionProxyPathCreation} */
|
|
47
|
+
static ExtensionProxyPathCreation() {
|
|
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 {ExtensionProxyPathDelete} */
|
|
61
|
+
static ExtensionProxyPathDelete() {
|
|
62
62
|
return Joi.object({
|
|
63
63
|
message: Joi.string().allow(""),
|
|
64
|
-
data: Joi.any(),
|
|
64
|
+
data: Joi.object().pattern(/\S/, 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.any(),
|
|
75
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
76
76
|
});
|
|
77
77
|
}
|
|
78
78
|
}
|