@gofynd/fdk-client-javascript 1.4.15-beta.3 → 1.4.15-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 +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +304 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +437 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +22 -1
- package/sdk/application/Communication/CommunicationApplicationClient.js +29 -0
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +157 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +30 -19
- package/sdk/application/Content/ContentApplicationClient.js +297 -28
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +50 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +74 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +159 -87
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +195 -47
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +473 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +75 -7
- package/sdk/application/Share/ShareApplicationClient.js +96 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +66 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +418 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +16 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +19 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +14 -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/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +39 -135
- package/sdk/partner/Theme/ThemePartnerModel.js +38 -114
- 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 -118
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1298 -5037
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1976
- 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 -6385
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1680 -3217
- 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 -124
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
- package/sdk/platform/Content/ContentPlatformModel.js +390 -521
- 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 +36 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +60 -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 +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +101 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +84 -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 +64 -58
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +46 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +28 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- 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 +13 -76
- package/sdk/platform/Theme/ThemePlatformModel.js +17 -57
- 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 +21 -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 +20 -791
- 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/Partner/PartnerPublicClient.js +15 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +48 -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 -105
|
@@ -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
|
/**
|
|
@@ -90,7 +85,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
90
85
|
|
|
91
86
|
/**
|
|
92
87
|
* @typedef GenerateProcessManifestParam
|
|
93
|
-
* @property {OrderPlatformModel.
|
|
88
|
+
* @property {OrderPlatformModel.ProcessManifestRequest} body
|
|
94
89
|
*/
|
|
95
90
|
|
|
96
91
|
/**
|
|
@@ -109,7 +104,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
109
104
|
|
|
110
105
|
/**
|
|
111
106
|
* @typedef GetBagByIdParam
|
|
112
|
-
* @property {string} [bagId] -
|
|
107
|
+
* @property {string} [bagId] - Id of bag
|
|
113
108
|
* @property {string} [channelBagId] - Id of application bag
|
|
114
109
|
* @property {string} [channelId] - Id of application
|
|
115
110
|
*/
|
|
@@ -133,8 +128,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
133
128
|
* @typedef GetBulkShipmentExcelFileParam
|
|
134
129
|
* @property {string} [salesChannels] - Comma separated values of sales channel ids
|
|
135
130
|
* @property {string} [dpIds] - Comma separated values of delivery partner ids
|
|
136
|
-
* @property {string} [startDate] -
|
|
137
|
-
* @property {string} [endDate] -
|
|
131
|
+
* @property {string} [startDate] - UTC start date in ISO format
|
|
132
|
+
* @property {string} [endDate] - UTC end date in ISO format
|
|
138
133
|
* @property {string} [stores] - Comma separated values of store ids
|
|
139
134
|
* @property {string} [tags] - Comma separated values of tags
|
|
140
135
|
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
@@ -145,13 +140,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
145
140
|
* @property {number} [pageSize]
|
|
146
141
|
*/
|
|
147
142
|
|
|
148
|
-
/** @typedef GetChannelConfigParam */
|
|
149
|
-
|
|
150
143
|
/**
|
|
151
144
|
* @typedef GetFileByStatusParam
|
|
152
145
|
* @property {string} batchId - Batch Id to identify the bulk operation request.
|
|
153
146
|
* @property {string} status - The status of the jobs to filter the results.
|
|
154
|
-
* @property {string} fileType
|
|
147
|
+
* @property {string} fileType - The type of file to be downloaded.
|
|
155
148
|
* @property {string} [reportType] - The type of report to be downloaded.
|
|
156
149
|
*/
|
|
157
150
|
|
|
@@ -168,27 +161,15 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
168
161
|
* @property {string} [salesChannels]
|
|
169
162
|
* @property {string} [paymentMode] - Comma separated values of payment modes
|
|
170
163
|
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
171
|
-
* @property {string} [searchType]
|
|
172
|
-
* be used as the target for the search operation
|
|
164
|
+
* @property {string} [searchType]
|
|
173
165
|
* @property {string} [searchValue]
|
|
174
166
|
* @property {string} [tags]
|
|
175
|
-
* @property {number} [timeToDispatch]
|
|
167
|
+
* @property {number} [timeToDispatch]
|
|
176
168
|
* @property {string} [paymentMethods]
|
|
177
169
|
* @property {boolean} [myOrders]
|
|
178
170
|
* @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
|
|
179
171
|
* company order
|
|
180
|
-
* @property {string} [orderType]
|
|
181
|
-
* follow based on the application's operational needs and customer
|
|
182
|
-
* preferences. This field categorizes orders into distinct types, each
|
|
183
|
-
* associated with a unique processing flow. For example:
|
|
184
|
-
*
|
|
185
|
-
* - "HomeDelivery": The order goes through all the steps needed for delivery,
|
|
186
|
-
* from being packed to arriving at the customer’s address.
|
|
187
|
-
* - "PickAtStore": The order is prepared for pickup at the store, skipping
|
|
188
|
-
* shipping steps to make it ready faster for the customer to collect in person.
|
|
189
|
-
* - "Digital": This order type likely refers to orders that involve digital goods
|
|
190
|
-
* or services, such as software, digital subscriptions, e-books, online
|
|
191
|
-
* courses, or any other item that can be delivered electronically.
|
|
172
|
+
* @property {string} [orderType]
|
|
192
173
|
*/
|
|
193
174
|
|
|
194
175
|
/**
|
|
@@ -251,44 +232,35 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
251
232
|
/**
|
|
252
233
|
* @typedef GetOrdersParam
|
|
253
234
|
* @property {string} [lane] - Lane refers to a section where orders are
|
|
254
|
-
* assigned, indicating its grouping
|
|
235
|
+
* assigned, indicating its grouping
|
|
255
236
|
* @property {string} [searchType] - Search_type refers to the field that will
|
|
256
|
-
* be used as the target for the search operation
|
|
237
|
+
* be used as the target for the search operation
|
|
257
238
|
* @property {string} [bagStatus] - Bag_status refers to status of the entity.
|
|
258
239
|
* Filters orders based on the status.
|
|
259
240
|
* @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
|
|
260
|
-
* @property {string} [paymentMethods]
|
|
261
|
-
* methods that were used to place order.
|
|
241
|
+
* @property {string} [paymentMethods]
|
|
262
242
|
* @property {string} [tags] - Tags refers to additional descriptive labels
|
|
263
243
|
* associated with the order
|
|
264
244
|
* @property {string} [searchValue] - Search_value is matched against the field
|
|
265
245
|
* specified by the search_type
|
|
266
|
-
* @property {string} [fromDate]
|
|
267
|
-
* @property {string} [toDate]
|
|
268
|
-
* @property {string} [startDate]
|
|
269
|
-
* @property {string} [endDate]
|
|
246
|
+
* @property {string} [fromDate]
|
|
247
|
+
* @property {string} [toDate]
|
|
248
|
+
* @property {string} [startDate]
|
|
249
|
+
* @property {string} [endDate]
|
|
270
250
|
* @property {string} [dpIds] - Delivery Partner IDs to which shipments are assigned.
|
|
271
|
-
* @property {string} [stores]
|
|
272
|
-
*
|
|
273
|
-
* @property {
|
|
274
|
-
*
|
|
275
|
-
* @property {number} [pageNo] - Specifies the page number for paginated results.
|
|
276
|
-
* @property {number} [pageSize] - Determines the number of results returned per page.
|
|
251
|
+
* @property {string} [stores]
|
|
252
|
+
* @property {string} [salesChannels]
|
|
253
|
+
* @property {number} [pageNo]
|
|
254
|
+
* @property {number} [pageSize]
|
|
277
255
|
* @property {boolean} [isPrioritySort]
|
|
278
256
|
* @property {string} [customMeta]
|
|
279
257
|
* @property {boolean} [myOrders]
|
|
280
258
|
* @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
|
|
281
259
|
* company order
|
|
282
|
-
* @property {string} [customerId]
|
|
283
|
-
* associated with the query, useful for filtering results to a specific customer.
|
|
260
|
+
* @property {string} [customerId]
|
|
284
261
|
* @property {string} [orderType]
|
|
285
262
|
* @property {boolean} [allowInactive] - Flag indicating whether inactive
|
|
286
263
|
* shipments are allowed
|
|
287
|
-
* @property {string} [groupEntity] - Defines the grouping criterion for
|
|
288
|
-
* retrieving shipments or orders. It specifies whether the results should be
|
|
289
|
-
* organized based on shipment groups or order groups. For example, using
|
|
290
|
-
* 'shipments' groups results by shipment, while an invalid value like 'abcd'
|
|
291
|
-
* may not be recognized, leading to errors or default behavior.
|
|
292
264
|
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
293
265
|
* orders. This is useful when fetching data for a specific date range while
|
|
294
266
|
* performing searches.
|
|
@@ -298,9 +270,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
298
270
|
|
|
299
271
|
/**
|
|
300
272
|
* @typedef GetShipmentByIdParam
|
|
301
|
-
* @property {string} [channelShipmentId] -
|
|
302
|
-
*
|
|
303
|
-
* @property {string} [shipmentId] - The unique identifier for a shipment.
|
|
273
|
+
* @property {string} [channelShipmentId] - App Shipment Id
|
|
274
|
+
* @property {string} [shipmentId] - Shipment Id
|
|
304
275
|
* @property {boolean} [fetchActiveShipment] - Flag to fetch active or
|
|
305
276
|
* deactivated shipments
|
|
306
277
|
* @property {boolean} [allowInactive] - Flag indicating whether inactive
|
|
@@ -326,61 +297,38 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
326
297
|
/**
|
|
327
298
|
* @typedef GetShipmentsParam
|
|
328
299
|
* @property {string} [lane] - Name of lane for which data is to be fetched
|
|
329
|
-
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
300
|
+
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
330
301
|
* @property {boolean} [statusOverrideLane] - Use this flag to fetch by
|
|
331
|
-
* bag_status and override lane
|
|
332
|
-
* @property {number} [timeToDispatch]
|
|
333
|
-
* @property {string} [searchType] -
|
|
334
|
-
*
|
|
335
|
-
* @property {string} [searchValue] - The value corresponding to the search
|
|
336
|
-
* type, such as a specific shipment ID or order ID.
|
|
302
|
+
* bag_status and override lane
|
|
303
|
+
* @property {number} [timeToDispatch]
|
|
304
|
+
* @property {string} [searchType] - Search type key
|
|
305
|
+
* @property {string} [searchValue] - Search type value
|
|
337
306
|
* @property {string} [fromDate] - Start Date in DD-MM-YYYY format
|
|
338
307
|
* @property {string} [toDate] - End Date in DD-MM-YYYY format
|
|
339
|
-
* @property {string} [startDate] -
|
|
340
|
-
*
|
|
341
|
-
* @property {string} [
|
|
342
|
-
*
|
|
343
|
-
* @property {string} [
|
|
344
|
-
*
|
|
345
|
-
* @property {
|
|
346
|
-
*
|
|
347
|
-
* @property {
|
|
348
|
-
*
|
|
349
|
-
* @property {
|
|
350
|
-
* @property {
|
|
351
|
-
* @property {
|
|
352
|
-
*
|
|
353
|
-
* @property {
|
|
354
|
-
*
|
|
355
|
-
* @property {boolean} [
|
|
356
|
-
*
|
|
357
|
-
* @property {string} [
|
|
358
|
-
* @property {
|
|
359
|
-
*
|
|
360
|
-
* @property {string} [
|
|
361
|
-
* @property {string} [
|
|
362
|
-
*
|
|
363
|
-
* @property {string} [orderingChannel] - The channel through which the order was placed.
|
|
364
|
-
* @property {string} [companyAffiliateTag] - A tag used to identify the
|
|
365
|
-
* company's affiliation for filtering or reporting purposes.
|
|
366
|
-
* @property {boolean} [myOrders] - A boolean flag indicating whether the query
|
|
367
|
-
* should return only the user's orders.
|
|
368
|
-
* @property {string} [platformUserId] - The unique identifier of the user on
|
|
369
|
-
* the platform, useful for filtering orders related to a specific user.
|
|
370
|
-
* @property {string} [sortType] - Determines the sorting order of the results
|
|
371
|
-
* based on specific criteria.
|
|
372
|
-
* @property {boolean} [showCrossCompanyData] - A flag indicating whether to
|
|
373
|
-
* include data from both cross-company and non-cross-company orders in the results.
|
|
374
|
-
* @property {string} [tags] - A comma-separated list of tags associated with
|
|
375
|
-
* the orders to filter results based on specific characteristics.
|
|
376
|
-
* @property {string} [customerId] - The unique identifier for the customer
|
|
377
|
-
* associated with the query, useful for filtering results to a specific customer.
|
|
378
|
-
* @property {string} [orderType] - The type of order being queried.
|
|
379
|
-
* @property {string} [groupEntity] - Defines the grouping criterion for
|
|
380
|
-
* retrieving shipments or orders. It specifies whether the results should be
|
|
381
|
-
* organized based on shipment groups or order groups. For example, using
|
|
382
|
-
* 'shipments' groups results by shipment, while an invalid value like 'abcd'
|
|
383
|
-
* may not be recognized, leading to errors or default behavior.
|
|
308
|
+
* @property {string} [startDate] - UTC Start Date in ISO format
|
|
309
|
+
* @property {string} [endDate] - UTC End Date in ISO format
|
|
310
|
+
* @property {string} [dpIds] - Comma separated values of delivery partner ids
|
|
311
|
+
* @property {string} [stores] - Comma separated values of store ids
|
|
312
|
+
* @property {string} [salesChannels] - Comma separated values of sales channel ids
|
|
313
|
+
* @property {number} [pageNo] - Page number for paginated data
|
|
314
|
+
* @property {number} [pageSize] - Page size of data received per page
|
|
315
|
+
* @property {boolean} [fetchActiveShipment] - Flag to fetch active shipments
|
|
316
|
+
* @property {boolean} [allowInactive] - Flag to allow inactive shipments
|
|
317
|
+
* @property {boolean} [excludeLockedShipments] - Flag to fetch locked shipments
|
|
318
|
+
* @property {string} [paymentMethods] - Comma separated values of payment methods
|
|
319
|
+
* @property {string} [channelShipmentId] - App Shipment Id
|
|
320
|
+
* @property {string} [channelOrderId] - App Order Id
|
|
321
|
+
* @property {string} [customMeta]
|
|
322
|
+
* @property {string} [orderingChannel]
|
|
323
|
+
* @property {string} [companyAffiliateTag]
|
|
324
|
+
* @property {boolean} [myOrders]
|
|
325
|
+
* @property {string} [platformUserId]
|
|
326
|
+
* @property {string} [sortType] - Sort the result data on basis of input
|
|
327
|
+
* @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
|
|
328
|
+
* company order
|
|
329
|
+
* @property {string} [tags] - Comma separated values of tags
|
|
330
|
+
* @property {string} [customerId]
|
|
331
|
+
* @property {string} [orderType]
|
|
384
332
|
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
385
333
|
* shipments. This is useful when fetching data for a specific date range
|
|
386
334
|
* while performing searches.
|
|
@@ -452,8 +400,18 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
452
400
|
|
|
453
401
|
/**
|
|
454
402
|
* @typedef UpdateAddressParam
|
|
455
|
-
* @property {string} shipmentId
|
|
456
|
-
* @property {
|
|
403
|
+
* @property {string} shipmentId
|
|
404
|
+
* @property {string} [name]
|
|
405
|
+
* @property {string} [address]
|
|
406
|
+
* @property {string} [addressType]
|
|
407
|
+
* @property {string} [pincode]
|
|
408
|
+
* @property {string} [phone]
|
|
409
|
+
* @property {string} [email]
|
|
410
|
+
* @property {string} [landmark]
|
|
411
|
+
* @property {string} addressCategory
|
|
412
|
+
* @property {string} [city]
|
|
413
|
+
* @property {string} [state]
|
|
414
|
+
* @property {string} [country]
|
|
457
415
|
*/
|
|
458
416
|
|
|
459
417
|
/**
|
|
@@ -461,11 +419,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
461
419
|
* @property {OrderPlatformModel.UpdatePackagingDimensionsPayload} body
|
|
462
420
|
*/
|
|
463
421
|
|
|
464
|
-
/**
|
|
465
|
-
* @typedef UpdatePaymentInfoParam
|
|
466
|
-
* @property {OrderPlatformModel.UpdateShipmentPaymentMode} body
|
|
467
|
-
*/
|
|
468
|
-
|
|
469
422
|
/**
|
|
470
423
|
* @typedef UpdateShipmentLockParam
|
|
471
424
|
* @property {OrderPlatformModel.UpdateShipmentLockPayload} body
|
|
@@ -533,13 +486,6 @@ class OrderPlatformValidator {
|
|
|
533
486
|
}).required();
|
|
534
487
|
}
|
|
535
488
|
|
|
536
|
-
/** @returns {CreateChannelConfigParam} */
|
|
537
|
-
static createChannelConfig() {
|
|
538
|
-
return Joi.object({
|
|
539
|
-
body: OrderPlatformModel.CreateChannelConfigData().required(),
|
|
540
|
-
}).required();
|
|
541
|
-
}
|
|
542
|
-
|
|
543
489
|
/** @returns {CreateOrderParam} */
|
|
544
490
|
static createOrder() {
|
|
545
491
|
return Joi.object({
|
|
@@ -564,7 +510,7 @@ class OrderPlatformValidator {
|
|
|
564
510
|
/** @returns {DownloadLanesReportParam} */
|
|
565
511
|
static downloadLanesReport() {
|
|
566
512
|
return Joi.object({
|
|
567
|
-
body: OrderPlatformModel.
|
|
513
|
+
body: OrderPlatformModel.BulkReportsDownloadRequest().required(),
|
|
568
514
|
}).required();
|
|
569
515
|
}
|
|
570
516
|
|
|
@@ -609,7 +555,7 @@ class OrderPlatformValidator {
|
|
|
609
555
|
/** @returns {GenerateProcessManifestParam} */
|
|
610
556
|
static generateProcessManifest() {
|
|
611
557
|
return Joi.object({
|
|
612
|
-
body: OrderPlatformModel.
|
|
558
|
+
body: OrderPlatformModel.ProcessManifestRequest().required(),
|
|
613
559
|
}).required();
|
|
614
560
|
}
|
|
615
561
|
|
|
@@ -680,11 +626,6 @@ class OrderPlatformValidator {
|
|
|
680
626
|
}).required();
|
|
681
627
|
}
|
|
682
628
|
|
|
683
|
-
/** @returns {GetChannelConfigParam} */
|
|
684
|
-
static getChannelConfig() {
|
|
685
|
-
return Joi.object({}).required();
|
|
686
|
-
}
|
|
687
|
-
|
|
688
629
|
/** @returns {GetFileByStatusParam} */
|
|
689
630
|
static getFileByStatus() {
|
|
690
631
|
return Joi.object({
|
|
@@ -805,7 +746,6 @@ class OrderPlatformValidator {
|
|
|
805
746
|
customerId: Joi.string().allow(""),
|
|
806
747
|
orderType: Joi.string().allow(""),
|
|
807
748
|
allowInactive: Joi.boolean(),
|
|
808
|
-
groupEntity: Joi.string().allow(""),
|
|
809
749
|
enforceDateFilter: Joi.boolean(),
|
|
810
750
|
}).required();
|
|
811
751
|
}
|
|
@@ -876,7 +816,6 @@ class OrderPlatformValidator {
|
|
|
876
816
|
tags: Joi.string().allow(""),
|
|
877
817
|
customerId: Joi.string().allow(""),
|
|
878
818
|
orderType: Joi.string().allow(""),
|
|
879
|
-
groupEntity: Joi.string().allow(""),
|
|
880
819
|
enforceDateFilter: Joi.boolean(),
|
|
881
820
|
}).required();
|
|
882
821
|
}
|
|
@@ -973,7 +912,17 @@ class OrderPlatformValidator {
|
|
|
973
912
|
static updateAddress() {
|
|
974
913
|
return Joi.object({
|
|
975
914
|
shipmentId: Joi.string().allow("").required(),
|
|
976
|
-
|
|
915
|
+
name: Joi.string().allow(""),
|
|
916
|
+
address: Joi.string().allow(""),
|
|
917
|
+
addressType: Joi.string().allow(""),
|
|
918
|
+
pincode: Joi.string().allow(""),
|
|
919
|
+
phone: Joi.string().allow(""),
|
|
920
|
+
email: Joi.string().allow(""),
|
|
921
|
+
landmark: Joi.string().allow(""),
|
|
922
|
+
addressCategory: Joi.string().allow("").required(),
|
|
923
|
+
city: Joi.string().allow(""),
|
|
924
|
+
state: Joi.string().allow(""),
|
|
925
|
+
country: Joi.string().allow(""),
|
|
977
926
|
}).required();
|
|
978
927
|
}
|
|
979
928
|
|
|
@@ -984,13 +933,6 @@ class OrderPlatformValidator {
|
|
|
984
933
|
}).required();
|
|
985
934
|
}
|
|
986
935
|
|
|
987
|
-
/** @returns {UpdatePaymentInfoParam} */
|
|
988
|
-
static updatePaymentInfo() {
|
|
989
|
-
return Joi.object({
|
|
990
|
-
body: OrderPlatformModel.UpdateShipmentPaymentMode().required(),
|
|
991
|
-
}).required();
|
|
992
|
-
}
|
|
993
|
-
|
|
994
936
|
/** @returns {UpdateShipmentLockParam} */
|
|
995
937
|
static updateShipmentLock() {
|
|
996
938
|
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
|
}
|