@gofynd/fdk-client-javascript 1.4.8-beta.2 → 1.4.8-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Content/ContentApplicationModel.d.ts +2 -0
- package/sdk/application/Content/ContentApplicationModel.js +2 -0
- package/sdk/application/Order/OrderApplicationModel.d.ts +2 -0
- package/sdk/application/Order/OrderApplicationModel.js +2 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +47 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +52 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +20 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +37 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +16 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -0
- package/sdk/platform/Content/ContentPlatformModel.js +2 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +2 -2
- package/sdk/platform/Finance/FinancePlatformClient.js +2 -2
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +26 -9
- package/sdk/platform/Finance/FinancePlatformModel.js +32 -8
- package/sdk/platform/Order/OrderPlatformModel.d.ts +18 -0
- package/sdk/platform/Order/OrderPlatformModel.js +8 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +20 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +22 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
- package/sdk/platform/User/UserPlatformModel.d.ts +0 -2
- package/sdk/platform/User/UserPlatformModel.js +0 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +26 -26
- package/sdk/platform/Webhook/WebhookPlatformModel.js +26 -26
|
@@ -241,6 +241,12 @@ const Joi = require("joi");
|
|
|
241
241
|
* @property {DownloadCreditDebitNoteResponseData[]} [data]
|
|
242
242
|
*/
|
|
243
243
|
|
|
244
|
+
/**
|
|
245
|
+
* @typedef InvoiceBillingItem
|
|
246
|
+
* @property {string} [invoice_number]
|
|
247
|
+
* @property {number} [amount]
|
|
248
|
+
*/
|
|
249
|
+
|
|
244
250
|
/**
|
|
245
251
|
* @typedef PaymentProcessPayload
|
|
246
252
|
* @property {string} [platform]
|
|
@@ -252,7 +258,7 @@ const Joi = require("joi");
|
|
|
252
258
|
* @property {string} [currency]
|
|
253
259
|
* @property {string} [seller_id]
|
|
254
260
|
* @property {string} [mode_of_payment]
|
|
255
|
-
* @property {
|
|
261
|
+
* @property {InvoiceBillingItem[]} [invoice_billing_items]
|
|
256
262
|
*/
|
|
257
263
|
|
|
258
264
|
/**
|
|
@@ -761,7 +767,7 @@ const Joi = require("joi");
|
|
|
761
767
|
|
|
762
768
|
/**
|
|
763
769
|
* @typedef InvoicePaymentOptionsPayloadData
|
|
764
|
-
* @property {string} [
|
|
770
|
+
* @property {string[]} [invoice_numbers]
|
|
765
771
|
*/
|
|
766
772
|
|
|
767
773
|
/**
|
|
@@ -787,18 +793,21 @@ const Joi = require("joi");
|
|
|
787
793
|
|
|
788
794
|
/**
|
|
789
795
|
* @typedef InvoicePaymentOptionsResponseData
|
|
790
|
-
* @property {
|
|
796
|
+
* @property {string} [invoice_number]
|
|
791
797
|
* @property {string} [invoice_type]
|
|
792
798
|
* @property {InvoicePaymentOptionsResponsePayableAmounts[]} [display_amounts]
|
|
793
799
|
* @property {Object} [total_amount]
|
|
794
800
|
* @property {Object} [deducted_amounts]
|
|
795
801
|
* @property {InvoicePaymentOptionsResponsePayableAmounts[]} [payable_amounts]
|
|
802
|
+
* @property {Currency} [currency]
|
|
796
803
|
*/
|
|
797
804
|
|
|
798
805
|
/**
|
|
799
806
|
* @typedef InvoicePaymentOptionsResponse
|
|
800
807
|
* @property {string} [reason]
|
|
801
|
-
* @property {InvoicePaymentOptionsResponseData} [data]
|
|
808
|
+
* @property {InvoicePaymentOptionsResponseData[]} [data]
|
|
809
|
+
* @property {number} [total_payable_amount]
|
|
810
|
+
* @property {number} [invoice_count]
|
|
802
811
|
* @property {boolean} [success]
|
|
803
812
|
*/
|
|
804
813
|
|
|
@@ -1184,6 +1193,14 @@ class FinancePlatformModel {
|
|
|
1184
1193
|
});
|
|
1185
1194
|
}
|
|
1186
1195
|
|
|
1196
|
+
/** @returns {InvoiceBillingItem} */
|
|
1197
|
+
static InvoiceBillingItem() {
|
|
1198
|
+
return Joi.object({
|
|
1199
|
+
invoice_number: Joi.string().allow(""),
|
|
1200
|
+
amount: Joi.number(),
|
|
1201
|
+
});
|
|
1202
|
+
}
|
|
1203
|
+
|
|
1187
1204
|
/** @returns {PaymentProcessPayload} */
|
|
1188
1205
|
static PaymentProcessPayload() {
|
|
1189
1206
|
return Joi.object({
|
|
@@ -1196,7 +1213,9 @@ class FinancePlatformModel {
|
|
|
1196
1213
|
currency: Joi.string().allow(""),
|
|
1197
1214
|
seller_id: Joi.string().allow(""),
|
|
1198
1215
|
mode_of_payment: Joi.string().allow(""),
|
|
1199
|
-
|
|
1216
|
+
invoice_billing_items: Joi.array().items(
|
|
1217
|
+
FinancePlatformModel.InvoiceBillingItem()
|
|
1218
|
+
),
|
|
1200
1219
|
});
|
|
1201
1220
|
}
|
|
1202
1221
|
|
|
@@ -1855,7 +1874,7 @@ class FinancePlatformModel {
|
|
|
1855
1874
|
/** @returns {InvoicePaymentOptionsPayloadData} */
|
|
1856
1875
|
static InvoicePaymentOptionsPayloadData() {
|
|
1857
1876
|
return Joi.object({
|
|
1858
|
-
|
|
1877
|
+
invoice_numbers: Joi.array().items(Joi.string().allow("")),
|
|
1859
1878
|
});
|
|
1860
1879
|
}
|
|
1861
1880
|
|
|
@@ -1889,7 +1908,7 @@ class FinancePlatformModel {
|
|
|
1889
1908
|
/** @returns {InvoicePaymentOptionsResponseData} */
|
|
1890
1909
|
static InvoicePaymentOptionsResponseData() {
|
|
1891
1910
|
return Joi.object({
|
|
1892
|
-
|
|
1911
|
+
invoice_number: Joi.string().allow(""),
|
|
1893
1912
|
invoice_type: Joi.string().allow(""),
|
|
1894
1913
|
display_amounts: Joi.array().items(
|
|
1895
1914
|
FinancePlatformModel.InvoicePaymentOptionsResponsePayableAmounts()
|
|
@@ -1899,6 +1918,7 @@ class FinancePlatformModel {
|
|
|
1899
1918
|
payable_amounts: Joi.array().items(
|
|
1900
1919
|
FinancePlatformModel.InvoicePaymentOptionsResponsePayableAmounts()
|
|
1901
1920
|
),
|
|
1921
|
+
currency: FinancePlatformModel.Currency(),
|
|
1902
1922
|
});
|
|
1903
1923
|
}
|
|
1904
1924
|
|
|
@@ -1906,7 +1926,11 @@ class FinancePlatformModel {
|
|
|
1906
1926
|
static InvoicePaymentOptionsResponse() {
|
|
1907
1927
|
return Joi.object({
|
|
1908
1928
|
reason: Joi.string().allow(""),
|
|
1909
|
-
data:
|
|
1929
|
+
data: Joi.array().items(
|
|
1930
|
+
FinancePlatformModel.InvoicePaymentOptionsResponseData()
|
|
1931
|
+
),
|
|
1932
|
+
total_payable_amount: Joi.number(),
|
|
1933
|
+
invoice_count: Joi.number(),
|
|
1910
1934
|
success: Joi.boolean(),
|
|
1911
1935
|
});
|
|
1912
1936
|
}
|
|
@@ -1920,6 +1920,9 @@ export = OrderPlatformModel;
|
|
|
1920
1920
|
* @property {string} [shipment_created_ts]
|
|
1921
1921
|
* @property {Currency} [currency]
|
|
1922
1922
|
* @property {CurrencyInfo} [currency_info]
|
|
1923
|
+
* @property {boolean} [is_lapa_enabled] - Flag to show NDR actions based on
|
|
1924
|
+
* LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true,
|
|
1925
|
+
* else false.
|
|
1923
1926
|
*/
|
|
1924
1927
|
/**
|
|
1925
1928
|
* @typedef ShipmentInternalPlatformViewResponse
|
|
@@ -2364,6 +2367,9 @@ export = OrderPlatformModel;
|
|
|
2364
2367
|
* @property {string} [credit_note_id]
|
|
2365
2368
|
* @property {boolean} [is_self_ship]
|
|
2366
2369
|
* @property {string} [mode_of_payment]
|
|
2370
|
+
* @property {boolean} [is_lapa_enabled] - Flag to show NDR actions based on
|
|
2371
|
+
* LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true,
|
|
2372
|
+
* else false.
|
|
2367
2373
|
*/
|
|
2368
2374
|
/**
|
|
2369
2375
|
* @typedef ShipmentInfoResponse
|
|
@@ -5464,6 +5470,12 @@ type ShipmentItem = {
|
|
|
5464
5470
|
shipment_created_ts?: string;
|
|
5465
5471
|
currency?: Currency;
|
|
5466
5472
|
currency_info?: CurrencyInfo;
|
|
5473
|
+
/**
|
|
5474
|
+
* - Flag to show NDR actions based on
|
|
5475
|
+
* LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true,
|
|
5476
|
+
* else false.
|
|
5477
|
+
*/
|
|
5478
|
+
is_lapa_enabled?: boolean;
|
|
5467
5479
|
};
|
|
5468
5480
|
/** @returns {ShipmentInternalPlatformViewResponse} */
|
|
5469
5481
|
declare function ShipmentInternalPlatformViewResponse(): ShipmentInternalPlatformViewResponse;
|
|
@@ -5944,6 +5956,12 @@ type PlatformShipment = {
|
|
|
5944
5956
|
credit_note_id?: string;
|
|
5945
5957
|
is_self_ship?: boolean;
|
|
5946
5958
|
mode_of_payment?: string;
|
|
5959
|
+
/**
|
|
5960
|
+
* - Flag to show NDR actions based on
|
|
5961
|
+
* LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true,
|
|
5962
|
+
* else false.
|
|
5963
|
+
*/
|
|
5964
|
+
is_lapa_enabled?: boolean;
|
|
5947
5965
|
};
|
|
5948
5966
|
/** @returns {ShipmentInfoResponse} */
|
|
5949
5967
|
declare function ShipmentInfoResponse(): ShipmentInfoResponse;
|
|
@@ -2142,6 +2142,9 @@ const Joi = require("joi");
|
|
|
2142
2142
|
* @property {string} [shipment_created_ts]
|
|
2143
2143
|
* @property {Currency} [currency]
|
|
2144
2144
|
* @property {CurrencyInfo} [currency_info]
|
|
2145
|
+
* @property {boolean} [is_lapa_enabled] - Flag to show NDR actions based on
|
|
2146
|
+
* LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true,
|
|
2147
|
+
* else false.
|
|
2145
2148
|
*/
|
|
2146
2149
|
|
|
2147
2150
|
/**
|
|
@@ -2622,6 +2625,9 @@ const Joi = require("joi");
|
|
|
2622
2625
|
* @property {string} [credit_note_id]
|
|
2623
2626
|
* @property {boolean} [is_self_ship]
|
|
2624
2627
|
* @property {string} [mode_of_payment]
|
|
2628
|
+
* @property {boolean} [is_lapa_enabled] - Flag to show NDR actions based on
|
|
2629
|
+
* LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true,
|
|
2630
|
+
* else false.
|
|
2625
2631
|
*/
|
|
2626
2632
|
|
|
2627
2633
|
/**
|
|
@@ -5799,6 +5805,7 @@ class OrderPlatformModel {
|
|
|
5799
5805
|
shipment_created_ts: Joi.string().allow(""),
|
|
5800
5806
|
currency: OrderPlatformModel.Currency(),
|
|
5801
5807
|
currency_info: OrderPlatformModel.CurrencyInfo(),
|
|
5808
|
+
is_lapa_enabled: Joi.boolean(),
|
|
5802
5809
|
});
|
|
5803
5810
|
}
|
|
5804
5811
|
|
|
@@ -6359,6 +6366,7 @@ class OrderPlatformModel {
|
|
|
6359
6366
|
credit_note_id: Joi.string().allow("").allow(null),
|
|
6360
6367
|
is_self_ship: Joi.boolean().allow(null),
|
|
6361
6368
|
mode_of_payment: Joi.string().allow("").allow(null),
|
|
6369
|
+
is_lapa_enabled: Joi.boolean(),
|
|
6362
6370
|
});
|
|
6363
6371
|
}
|
|
6364
6372
|
|
|
@@ -245,7 +245,7 @@ declare class Serviceability {
|
|
|
245
245
|
* @summary: Get zones
|
|
246
246
|
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
|
|
247
247
|
*/
|
|
248
|
-
getZones({ pageNo, pageSize, isActive, channelId, q,
|
|
248
|
+
getZones({ pageNo, pageSize, isActive, channelId, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponse>;
|
|
249
249
|
/**
|
|
250
250
|
* @param {ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam} arg
|
|
251
251
|
* - Arg object
|
|
@@ -1730,7 +1730,7 @@ class Serviceability {
|
|
|
1730
1730
|
isActive,
|
|
1731
1731
|
channelId,
|
|
1732
1732
|
q,
|
|
1733
|
-
|
|
1733
|
+
countryIsoCode,
|
|
1734
1734
|
state,
|
|
1735
1735
|
city,
|
|
1736
1736
|
pincode,
|
|
@@ -1746,7 +1746,7 @@ class Serviceability {
|
|
|
1746
1746
|
isActive,
|
|
1747
1747
|
channelId,
|
|
1748
1748
|
q,
|
|
1749
|
-
|
|
1749
|
+
countryIsoCode,
|
|
1750
1750
|
state,
|
|
1751
1751
|
city,
|
|
1752
1752
|
pincode,
|
|
@@ -1768,7 +1768,7 @@ class Serviceability {
|
|
|
1768
1768
|
isActive,
|
|
1769
1769
|
channelId,
|
|
1770
1770
|
q,
|
|
1771
|
-
|
|
1771
|
+
countryIsoCode,
|
|
1772
1772
|
state,
|
|
1773
1773
|
city,
|
|
1774
1774
|
pincode,
|
|
@@ -1789,7 +1789,7 @@ class Serviceability {
|
|
|
1789
1789
|
query_params["is_active"] = isActive;
|
|
1790
1790
|
query_params["channel_id"] = channelId;
|
|
1791
1791
|
query_params["q"] = q;
|
|
1792
|
-
query_params["
|
|
1792
|
+
query_params["country_iso_code"] = countryIsoCode;
|
|
1793
1793
|
query_params["state"] = state;
|
|
1794
1794
|
query_params["city"] = city;
|
|
1795
1795
|
query_params["pincode"] = pincode;
|
|
@@ -521,6 +521,15 @@ export = ServiceabilityPlatformModel;
|
|
|
521
521
|
* @property {string} stage
|
|
522
522
|
* @property {boolean} is_own_account
|
|
523
523
|
*/
|
|
524
|
+
/**
|
|
525
|
+
* @typedef CourierAccountRequestBody
|
|
526
|
+
* @property {string} extension_id
|
|
527
|
+
* @property {string} [account_id]
|
|
528
|
+
* @property {string} scheme_id
|
|
529
|
+
* @property {boolean} is_self_ship
|
|
530
|
+
* @property {string} stage
|
|
531
|
+
* @property {boolean} is_own_account
|
|
532
|
+
*/
|
|
524
533
|
/**
|
|
525
534
|
* @typedef ErrorResponse
|
|
526
535
|
* @property {string} value
|
|
@@ -994,7 +1003,7 @@ export = ServiceabilityPlatformModel;
|
|
|
994
1003
|
declare class ServiceabilityPlatformModel {
|
|
995
1004
|
}
|
|
996
1005
|
declare namespace ServiceabilityPlatformModel {
|
|
997
|
-
export { UpdateZoneConfigRequest, ServiceabilityErrorResponse, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResponse, EntityRegionView_Request, EntityRegionView_Error, EntityRegionView_page, getAppRegionZonesResponse, PageSchema, EntityRegionView_Items, EntityRegionView_Response, ListViewSummary, ZoneDataItem, ListViewProduct, ListViewChannels, ListViewItems, ListViewResponse, CompanyStoreView_PageItems, CompanyStoreView_Response, GetZoneDataViewChannels, ZoneProductTypes, ZoneMappingType, UpdateZoneData, ZoneUpdateRequest, ZoneSuccessResponse, GetZoneDataViewItems, GetSingleZoneDataViewResponse, GetZoneByIdSchema, CreateZoneData, ZoneResponse, GetZoneFromPincodeViewRequest, Zone, GetZoneFromPincodeViewResponse, GetZoneFromApplicationIdViewResponse, ServiceabilityPageResponse, MobileNo, ManagerResponse, ModifiedByResponse, IntegrationTypeResponse, ProductReturnConfigResponse, ContactNumberResponse, AddressResponse, CreatedByResponse, EwayBillResponse, EinvoiceResponse, GstCredentialsResponse, WarningsResponse, OpeningClosing, TimmingResponse, DocumentsResponse, Dp, LogisticsResponse, ItemResponse, GetStoresViewResponse, PincodeMopData, PincodeMopUpdateResponse, PincodeMOPresponse, CommonError, PincodeMopBulkData, PincodeBulkViewResponse, PincodeCodStatusListingRequest, PincodeCodStatusListingResponse, Error, PincodeCodStatusListingPage, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryRequest, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResponse, PincodeMopUpdateAuditHistoryResponseData, ArithmeticOperations, SchemeRulesFeatures, SchemeRules, CourierAccount, ErrorResponse, CourierPartnerAccountFailureResponse, Page, CourierPartnerList, LocationRuleValues, LocationRule, StringComparisonOperations, IntComparisonOperations, CourierPartnerRuleConditions, CourierPartnerRule, FailureResponse, CourierPartnerRulesListResponse, CompanyConfig, ZoneConfig, ApplicationConfig, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, SelfShipResponse, ApplicationSelfShipConfig, ApplicationSelfShipConfigResponse, StoreRuleConfigData, CustomerRadiusSchema, StoreRuleConditionSchema, StoreRuleDataSchema, StorePrioritySchema, GetStoreRulesApiResponse, CreateStoreRuleRequestSchema, StoreRuleResponseSchema, StoreRuleUpdateResponseSchema, ServiceabilityModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeModel, CourierAccountResponse, CompanyCourierPartnerAccountListResponse, PackageMaterial, PackageMaterialResponse, PackageMaterialRule, PackageRule, PackageRuleResponse, Channel, PackageMaterialRuleList, PackageMaterialList, PackageRuleProduct, PackageRuleProductTag, PackageRuleCategory, PackageMaterialRuleQuantity, RulePriorityRequest, RulePriorityResponse, ArticleAssignment, ServiceabilityLocation, LocationDetailsServiceability, OptimalLocationsArticles, OptimlLocationsRequestSchema, OptimalLocationArticlesResponse, OptimalLocationAssignedStoresResponse, OptimalLocationsResponse };
|
|
1006
|
+
export { UpdateZoneConfigRequest, ServiceabilityErrorResponse, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResponse, EntityRegionView_Request, EntityRegionView_Error, EntityRegionView_page, getAppRegionZonesResponse, PageSchema, EntityRegionView_Items, EntityRegionView_Response, ListViewSummary, ZoneDataItem, ListViewProduct, ListViewChannels, ListViewItems, ListViewResponse, CompanyStoreView_PageItems, CompanyStoreView_Response, GetZoneDataViewChannels, ZoneProductTypes, ZoneMappingType, UpdateZoneData, ZoneUpdateRequest, ZoneSuccessResponse, GetZoneDataViewItems, GetSingleZoneDataViewResponse, GetZoneByIdSchema, CreateZoneData, ZoneResponse, GetZoneFromPincodeViewRequest, Zone, GetZoneFromPincodeViewResponse, GetZoneFromApplicationIdViewResponse, ServiceabilityPageResponse, MobileNo, ManagerResponse, ModifiedByResponse, IntegrationTypeResponse, ProductReturnConfigResponse, ContactNumberResponse, AddressResponse, CreatedByResponse, EwayBillResponse, EinvoiceResponse, GstCredentialsResponse, WarningsResponse, OpeningClosing, TimmingResponse, DocumentsResponse, Dp, LogisticsResponse, ItemResponse, GetStoresViewResponse, PincodeMopData, PincodeMopUpdateResponse, PincodeMOPresponse, CommonError, PincodeMopBulkData, PincodeBulkViewResponse, PincodeCodStatusListingRequest, PincodeCodStatusListingResponse, Error, PincodeCodStatusListingPage, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryRequest, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResponse, PincodeMopUpdateAuditHistoryResponseData, ArithmeticOperations, SchemeRulesFeatures, SchemeRules, CourierAccount, CourierAccountRequestBody, ErrorResponse, CourierPartnerAccountFailureResponse, Page, CourierPartnerList, LocationRuleValues, LocationRule, StringComparisonOperations, IntComparisonOperations, CourierPartnerRuleConditions, CourierPartnerRule, FailureResponse, CourierPartnerRulesListResponse, CompanyConfig, ZoneConfig, ApplicationConfig, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, SelfShipResponse, ApplicationSelfShipConfig, ApplicationSelfShipConfigResponse, StoreRuleConfigData, CustomerRadiusSchema, StoreRuleConditionSchema, StoreRuleDataSchema, StorePrioritySchema, GetStoreRulesApiResponse, CreateStoreRuleRequestSchema, StoreRuleResponseSchema, StoreRuleUpdateResponseSchema, ServiceabilityModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeModel, CourierAccountResponse, CompanyCourierPartnerAccountListResponse, PackageMaterial, PackageMaterialResponse, PackageMaterialRule, PackageRule, PackageRuleResponse, Channel, PackageMaterialRuleList, PackageMaterialList, PackageRuleProduct, PackageRuleProductTag, PackageRuleCategory, PackageMaterialRuleQuantity, RulePriorityRequest, RulePriorityResponse, ArticleAssignment, ServiceabilityLocation, LocationDetailsServiceability, OptimalLocationsArticles, OptimlLocationsRequestSchema, OptimalLocationArticlesResponse, OptimalLocationAssignedStoresResponse, OptimalLocationsResponse };
|
|
998
1007
|
}
|
|
999
1008
|
/** @returns {UpdateZoneConfigRequest} */
|
|
1000
1009
|
declare function UpdateZoneConfigRequest(): UpdateZoneConfigRequest;
|
|
@@ -1591,6 +1600,16 @@ type CourierAccount = {
|
|
|
1591
1600
|
stage: string;
|
|
1592
1601
|
is_own_account: boolean;
|
|
1593
1602
|
};
|
|
1603
|
+
/** @returns {CourierAccountRequestBody} */
|
|
1604
|
+
declare function CourierAccountRequestBody(): CourierAccountRequestBody;
|
|
1605
|
+
type CourierAccountRequestBody = {
|
|
1606
|
+
extension_id: string;
|
|
1607
|
+
account_id?: string;
|
|
1608
|
+
scheme_id: string;
|
|
1609
|
+
is_self_ship: boolean;
|
|
1610
|
+
stage: string;
|
|
1611
|
+
is_own_account: boolean;
|
|
1612
|
+
};
|
|
1594
1613
|
/** @returns {ErrorResponse} */
|
|
1595
1614
|
declare function ErrorResponse(): ErrorResponse;
|
|
1596
1615
|
type ErrorResponse = {
|
|
@@ -595,6 +595,16 @@ const Joi = require("joi");
|
|
|
595
595
|
* @property {boolean} is_own_account
|
|
596
596
|
*/
|
|
597
597
|
|
|
598
|
+
/**
|
|
599
|
+
* @typedef CourierAccountRequestBody
|
|
600
|
+
* @property {string} extension_id
|
|
601
|
+
* @property {string} [account_id]
|
|
602
|
+
* @property {string} scheme_id
|
|
603
|
+
* @property {boolean} is_self_ship
|
|
604
|
+
* @property {string} stage
|
|
605
|
+
* @property {boolean} is_own_account
|
|
606
|
+
*/
|
|
607
|
+
|
|
598
608
|
/**
|
|
599
609
|
* @typedef ErrorResponse
|
|
600
610
|
* @property {string} value
|
|
@@ -1908,6 +1918,18 @@ class ServiceabilityPlatformModel {
|
|
|
1908
1918
|
});
|
|
1909
1919
|
}
|
|
1910
1920
|
|
|
1921
|
+
/** @returns {CourierAccountRequestBody} */
|
|
1922
|
+
static CourierAccountRequestBody() {
|
|
1923
|
+
return Joi.object({
|
|
1924
|
+
extension_id: Joi.string().allow("").required(),
|
|
1925
|
+
account_id: Joi.string().allow(""),
|
|
1926
|
+
scheme_id: Joi.string().allow("").required(),
|
|
1927
|
+
is_self_ship: Joi.boolean().required(),
|
|
1928
|
+
stage: Joi.string().allow("").required(),
|
|
1929
|
+
is_own_account: Joi.boolean().required(),
|
|
1930
|
+
});
|
|
1931
|
+
}
|
|
1932
|
+
|
|
1911
1933
|
/** @returns {ErrorResponse} */
|
|
1912
1934
|
static ErrorResponse() {
|
|
1913
1935
|
return Joi.object({
|
|
@@ -13,7 +13,7 @@ export = ServiceabilityPlatformValidator;
|
|
|
13
13
|
*/
|
|
14
14
|
/**
|
|
15
15
|
* @typedef CreateCourierPartnerAccountParam
|
|
16
|
-
* @property {ServiceabilityPlatformModel.
|
|
16
|
+
* @property {ServiceabilityPlatformModel.CourierAccountRequestBody} body
|
|
17
17
|
*/
|
|
18
18
|
/**
|
|
19
19
|
* @typedef CreatePackageMaterialParam
|
|
@@ -114,7 +114,7 @@ export = ServiceabilityPlatformValidator;
|
|
|
114
114
|
* @property {boolean} [isActive] - Status of Zone (either active or inactive)
|
|
115
115
|
* @property {string} [channelId] - Zones filtered by an application
|
|
116
116
|
* @property {string} [q] - Search with name as a free text
|
|
117
|
-
* @property {string} [
|
|
117
|
+
* @property {string} [countryIsoCode] - ISO2 code of the country
|
|
118
118
|
* @property {string} [state] - State name
|
|
119
119
|
* @property {string} [city] - City name
|
|
120
120
|
* @property {string} [pincode] - Pincode value to search zones
|
|
@@ -233,7 +233,7 @@ type BulkTatParam = {
|
|
|
233
233
|
body: ServiceabilityPlatformModel.BulkRegionJobSerializer;
|
|
234
234
|
};
|
|
235
235
|
type CreateCourierPartnerAccountParam = {
|
|
236
|
-
body: ServiceabilityPlatformModel.
|
|
236
|
+
body: ServiceabilityPlatformModel.CourierAccountRequestBody;
|
|
237
237
|
};
|
|
238
238
|
type CreatePackageMaterialParam = {
|
|
239
239
|
body: ServiceabilityPlatformModel.PackageMaterial;
|
|
@@ -461,7 +461,7 @@ type GetZonesParam = {
|
|
|
461
461
|
/**
|
|
462
462
|
* - ISO2 code of the country
|
|
463
463
|
*/
|
|
464
|
-
|
|
464
|
+
countryIsoCode?: string;
|
|
465
465
|
/**
|
|
466
466
|
* - State name
|
|
467
467
|
*/
|
|
@@ -18,7 +18,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
20
|
* @typedef CreateCourierPartnerAccountParam
|
|
21
|
-
* @property {ServiceabilityPlatformModel.
|
|
21
|
+
* @property {ServiceabilityPlatformModel.CourierAccountRequestBody} body
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
24
|
/**
|
|
@@ -136,7 +136,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
136
136
|
* @property {boolean} [isActive] - Status of Zone (either active or inactive)
|
|
137
137
|
* @property {string} [channelId] - Zones filtered by an application
|
|
138
138
|
* @property {string} [q] - Search with name as a free text
|
|
139
|
-
* @property {string} [
|
|
139
|
+
* @property {string} [countryIsoCode] - ISO2 code of the country
|
|
140
140
|
* @property {string} [state] - State name
|
|
141
141
|
* @property {string} [city] - City name
|
|
142
142
|
* @property {string} [pincode] - Pincode value to search zones
|
|
@@ -204,7 +204,7 @@ class ServiceabilityPlatformValidator {
|
|
|
204
204
|
/** @returns {CreateCourierPartnerAccountParam} */
|
|
205
205
|
static createCourierPartnerAccount() {
|
|
206
206
|
return Joi.object({
|
|
207
|
-
body: ServiceabilityPlatformModel.
|
|
207
|
+
body: ServiceabilityPlatformModel.CourierAccountRequestBody().required(),
|
|
208
208
|
}).required();
|
|
209
209
|
}
|
|
210
210
|
|
|
@@ -356,7 +356,7 @@ class ServiceabilityPlatformValidator {
|
|
|
356
356
|
isActive: Joi.boolean(),
|
|
357
357
|
channelId: Joi.string().allow(""),
|
|
358
358
|
q: Joi.string().allow(""),
|
|
359
|
-
|
|
359
|
+
countryIsoCode: Joi.string().allow(""),
|
|
360
360
|
state: Joi.string().allow(""),
|
|
361
361
|
city: Joi.string().allow(""),
|
|
362
362
|
pincode: Joi.string().allow(""),
|
|
@@ -223,7 +223,6 @@ export = UserPlatformModel;
|
|
|
223
223
|
/**
|
|
224
224
|
* @typedef CreateUserSessionRequestSchema
|
|
225
225
|
* @property {string} [domain]
|
|
226
|
-
* @property {number} [max_age]
|
|
227
226
|
* @property {string} [user_id]
|
|
228
227
|
*/
|
|
229
228
|
/**
|
|
@@ -850,7 +849,6 @@ type CreateUserResponseSchema = {
|
|
|
850
849
|
declare function CreateUserSessionRequestSchema(): CreateUserSessionRequestSchema;
|
|
851
850
|
type CreateUserSessionRequestSchema = {
|
|
852
851
|
domain?: string;
|
|
853
|
-
max_age?: number;
|
|
854
852
|
user_id?: string;
|
|
855
853
|
};
|
|
856
854
|
/** @returns {CreateUserSessionResponseSchema} */
|
|
@@ -253,7 +253,6 @@ const Joi = require("joi");
|
|
|
253
253
|
/**
|
|
254
254
|
* @typedef CreateUserSessionRequestSchema
|
|
255
255
|
* @property {string} [domain]
|
|
256
|
-
* @property {number} [max_age]
|
|
257
256
|
* @property {string} [user_id]
|
|
258
257
|
*/
|
|
259
258
|
|
|
@@ -846,7 +845,6 @@ class UserPlatformModel {
|
|
|
846
845
|
static CreateUserSessionRequestSchema() {
|
|
847
846
|
return Joi.object({
|
|
848
847
|
domain: Joi.string().allow(""),
|
|
849
|
-
max_age: Joi.number(),
|
|
850
848
|
user_id: Joi.string().allow(""),
|
|
851
849
|
});
|
|
852
850
|
}
|
|
@@ -8,12 +8,12 @@ export = WebhookPlatformModel;
|
|
|
8
8
|
*/
|
|
9
9
|
/**
|
|
10
10
|
* @typedef EventProcessRequest
|
|
11
|
-
* @property {string} search_text
|
|
11
|
+
* @property {string} [search_text]
|
|
12
12
|
* @property {string} end_date
|
|
13
13
|
* @property {string} start_date
|
|
14
|
-
* @property {number[]} subscriber_ids
|
|
15
|
-
* @property {string} status
|
|
16
|
-
* @property {Event[]} event
|
|
14
|
+
* @property {number[]} [subscriber_ids]
|
|
15
|
+
* @property {string} [status]
|
|
16
|
+
* @property {Event[]} [event]
|
|
17
17
|
*/
|
|
18
18
|
/**
|
|
19
19
|
* @typedef DownloadReportResponse
|
|
@@ -200,7 +200,7 @@ export = WebhookPlatformModel;
|
|
|
200
200
|
*/
|
|
201
201
|
/**
|
|
202
202
|
* @typedef SubscriberConfigPostRequestV2
|
|
203
|
-
* @property {string}
|
|
203
|
+
* @property {string} name
|
|
204
204
|
* @property {string} [webhook_url]
|
|
205
205
|
* @property {string} provider
|
|
206
206
|
* @property {Association} association
|
|
@@ -208,7 +208,7 @@ export = WebhookPlatformModel;
|
|
|
208
208
|
* @property {SubscriberStatus} status
|
|
209
209
|
* @property {string} email_id
|
|
210
210
|
* @property {AuthMeta} [auth_meta]
|
|
211
|
-
* @property {Events[]}
|
|
211
|
+
* @property {Events[]} events
|
|
212
212
|
*/
|
|
213
213
|
/**
|
|
214
214
|
* @typedef SubscriberConfigUpdateRequestV2
|
|
@@ -216,16 +216,16 @@ export = WebhookPlatformModel;
|
|
|
216
216
|
* @property {string} [name]
|
|
217
217
|
* @property {string} [webhook_url]
|
|
218
218
|
* @property {string} provider
|
|
219
|
-
* @property {Association} association
|
|
219
|
+
* @property {Association} [association]
|
|
220
220
|
* @property {Object} [custom_headers]
|
|
221
221
|
* @property {SubscriberStatus} status
|
|
222
|
-
* @property {string} email_id
|
|
222
|
+
* @property {string} [email_id]
|
|
223
223
|
* @property {AuthMeta} [auth_meta]
|
|
224
224
|
* @property {Events[]} [events]
|
|
225
225
|
*/
|
|
226
226
|
/**
|
|
227
227
|
* @typedef SubscriberConfigPost
|
|
228
|
-
* @property {string}
|
|
228
|
+
* @property {string} name
|
|
229
229
|
* @property {string} webhook_url
|
|
230
230
|
* @property {Association} association
|
|
231
231
|
* @property {Object} [custom_headers]
|
|
@@ -238,11 +238,11 @@ export = WebhookPlatformModel;
|
|
|
238
238
|
* @typedef SubscriberConfigUpdate
|
|
239
239
|
* @property {number} id
|
|
240
240
|
* @property {string} [name]
|
|
241
|
-
* @property {string} webhook_url
|
|
242
|
-
* @property {Association} association
|
|
241
|
+
* @property {string} [webhook_url]
|
|
242
|
+
* @property {Association} [association]
|
|
243
243
|
* @property {Object} [custom_headers]
|
|
244
|
-
* @property {SubscriberStatus} status
|
|
245
|
-
* @property {string} email_id
|
|
244
|
+
* @property {SubscriberStatus} [status]
|
|
245
|
+
* @property {string} [email_id]
|
|
246
246
|
* @property {AuthMeta} [auth_meta]
|
|
247
247
|
* @property {number[]} event_id
|
|
248
248
|
*/
|
|
@@ -285,12 +285,12 @@ type Event = {
|
|
|
285
285
|
/** @returns {EventProcessRequest} */
|
|
286
286
|
declare function EventProcessRequest(): EventProcessRequest;
|
|
287
287
|
type EventProcessRequest = {
|
|
288
|
-
search_text
|
|
288
|
+
search_text?: string;
|
|
289
289
|
end_date: string;
|
|
290
290
|
start_date: string;
|
|
291
|
-
subscriber_ids
|
|
292
|
-
status
|
|
293
|
-
event
|
|
291
|
+
subscriber_ids?: number[];
|
|
292
|
+
status?: string;
|
|
293
|
+
event?: Event[];
|
|
294
294
|
};
|
|
295
295
|
/** @returns {DownloadReportResponse} */
|
|
296
296
|
declare function DownloadReportResponse(): DownloadReportResponse;
|
|
@@ -608,7 +608,7 @@ type Events = {
|
|
|
608
608
|
/** @returns {SubscriberConfigPostRequestV2} */
|
|
609
609
|
declare function SubscriberConfigPostRequestV2(): SubscriberConfigPostRequestV2;
|
|
610
610
|
type SubscriberConfigPostRequestV2 = {
|
|
611
|
-
name
|
|
611
|
+
name: string;
|
|
612
612
|
webhook_url?: string;
|
|
613
613
|
provider: string;
|
|
614
614
|
association: Association;
|
|
@@ -616,7 +616,7 @@ type SubscriberConfigPostRequestV2 = {
|
|
|
616
616
|
status: SubscriberStatus;
|
|
617
617
|
email_id: string;
|
|
618
618
|
auth_meta?: AuthMeta;
|
|
619
|
-
events
|
|
619
|
+
events: Events[];
|
|
620
620
|
};
|
|
621
621
|
/** @returns {SubscriberConfigUpdateRequestV2} */
|
|
622
622
|
declare function SubscriberConfigUpdateRequestV2(): SubscriberConfigUpdateRequestV2;
|
|
@@ -625,17 +625,17 @@ type SubscriberConfigUpdateRequestV2 = {
|
|
|
625
625
|
name?: string;
|
|
626
626
|
webhook_url?: string;
|
|
627
627
|
provider: string;
|
|
628
|
-
association
|
|
628
|
+
association?: Association;
|
|
629
629
|
custom_headers?: any;
|
|
630
630
|
status: SubscriberStatus;
|
|
631
|
-
email_id
|
|
631
|
+
email_id?: string;
|
|
632
632
|
auth_meta?: AuthMeta;
|
|
633
633
|
events?: Events[];
|
|
634
634
|
};
|
|
635
635
|
/** @returns {SubscriberConfigPost} */
|
|
636
636
|
declare function SubscriberConfigPost(): SubscriberConfigPost;
|
|
637
637
|
type SubscriberConfigPost = {
|
|
638
|
-
name
|
|
638
|
+
name: string;
|
|
639
639
|
webhook_url: string;
|
|
640
640
|
association: Association;
|
|
641
641
|
custom_headers?: any;
|
|
@@ -649,11 +649,11 @@ declare function SubscriberConfigUpdate(): SubscriberConfigUpdate;
|
|
|
649
649
|
type SubscriberConfigUpdate = {
|
|
650
650
|
id: number;
|
|
651
651
|
name?: string;
|
|
652
|
-
webhook_url
|
|
653
|
-
association
|
|
652
|
+
webhook_url?: string;
|
|
653
|
+
association?: Association;
|
|
654
654
|
custom_headers?: any;
|
|
655
|
-
status
|
|
656
|
-
email_id
|
|
655
|
+
status?: SubscriberStatus;
|
|
656
|
+
email_id?: string;
|
|
657
657
|
auth_meta?: AuthMeta;
|
|
658
658
|
event_id: number[];
|
|
659
659
|
};
|