@terminaldz/zrexpress-sdk / index / ZrExpressClient
Class: ZrExpressClient
Defined in: client.ts:44
Constructors
Constructor
ts
new ZrExpressClient(options): ZrExpressClient;Defined in: client.ts:72
Parameters
| Parameter | Type |
|---|---|
options | ZrExpressOptions |
Returns
ZrExpressClient
Throws
ZrExpressConfigError when options are missing or invalid (empty apiKey, non-GUID tenantId, bad URL/numbers).
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
users | readonly | object | - | client.ts:45 |
users.getProfile | public | Promise<{ id?: string | null; firstName?: string | null; lastName?: string | null; email?: string | null; phoneNumber?: string | null; memberships?: object[] | null; }> | - | resources/users.ts:26 |
users.register | public | Promise<void> | - | resources/users.ts:31 |
users.search | public | Promise<void> | - | resources/users.ts:36 |
users.toggleStatus | public | Promise<void> | - | resources/users.ts:46 |
users.getRoles | public | Promise<string[]> | - | resources/users.ts:55 |
users.assignRoles | public | Promise<void> | - | resources/users.ts:63 |
users.createApiKey | public | Promise<void> | - | resources/users.ts:72 |
users.searchApiKeys | public | Promise<void> | - | resources/users.ts:82 |
users.deleteApiKey | public | Promise<void> | - | resources/users.ts:93 |
territories | readonly | object | - | client.ts:46 |
territories.search | public | (body) => Promise<PagedList<TerritoryResponse>> | Search territories (POST /territories/search). Filter with the shared DSL, e.g. advancedFilter: { field: 'level', operator: 'eq', value: 'wilaya' }. Throws ZrExpressApiError subclasses on non-2xx responses. | resources/territories.ts:22 |
territories.searchAll | public | AsyncGenerator<TerritoryResponse, void, undefined> | - | resources/territories.ts:24 |
rates | readonly | object | - | client.ts:47 |
rates.getAll | public | Promise<{ rates?: object[] | null; }> | - | resources/rates.ts:8 |
rates.getForTerritory | public | Promise<{ toTerritoryId?: string; toTerritoryName?: string | null; toTerritoryLevel?: string | null; deliveryPrices?: object[] | null; }> | - | resources/rates.ts:19 |
rates.getPriceList | public | Promise<{ priceLists?: { id?: string; name?: string | null; type?: string | null; fromTerritory?: { id?: string; code?: number; name?: string | null; postalCode?: string | null; level?: string | null; parentId?: string | null; delivery?: { hasHomeDelivery?: boolean; hasPickupPoint?: boolean; }; }; deliveryPrices?: object[] | null; }; }> | - | resources/rates.ts:32 |
rates.getSupplierSpecificPrices | public | Promise<void> | - | resources/rates.ts:46 |
hubs | readonly | object | - | client.ts:48 |
hubs.get | public | Promise<{ id?: string; name?: string | null; type?: string | null; isPickupPoint?: boolean; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; }; openingHours?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; createdAt?: string; services?: object[] | null; }> | - | resources/hubs.ts:24 |
hubs.search | public | (body) => Promise<PagedList<{ id?: string; name?: string | null; type?: string | null; isPickupPoint?: boolean; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; }; openingHours?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; createdAt?: string; services?: object[] | null; }>> | Search hubs with the shared DSL (POST /hubs/search). | resources/hubs.ts:32 |
hubs.searchAll | public | AsyncGenerator<{ id?: string; name?: string | null; type?: string | null; isPickupPoint?: boolean; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; }; openingHours?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; createdAt?: string; services?: object[] | null; }, void, undefined> | - | resources/hubs.ts:34 |
workflows | readonly | object | - | client.ts:49 |
workflows.search | public | (body) => Promise<PagedList<{ id?: string; name?: string | null; isDefault?: boolean; states?: object[] | null; }>> | Search workflows incl. their states and situations (POST /workflows/search). | resources/workflows.ts:21 |
workflows.searchAll | public | AsyncGenerator<{ id?: string; name?: string | null; isDefault?: boolean; states?: object[] | null; }, void, undefined> | - | resources/workflows.ts:23 |
parcels | readonly | object | - | client.ts:50 |
parcels.create | public | Promise<{ id?: string; }> | - | resources/parcels.ts:82 |
parcels.createBulk | public | Promise<{ totalRequested?: number; successCount?: number; failureCount?: number; successes?: object[] | null; failures?: object[] | null; }> | - | resources/parcels.ts:91 |
parcels.createExchangeBulk | public | Promise<{ totalRequested?: number; successCount?: number; failureCount?: number; successes?: object[] | null; failures?: object[] | null; }> | - | resources/parcels.ts:104 |
parcels.createRefundBulk | public | Promise<{ totalRequested?: number; successCount?: number; failureCount?: number; successes?: object[] | null; failures?: object[] | null; }> | - | resources/parcels.ts:120 |
parcels.createExchange | public | Promise<{ newParcelId?: string; returnParcelId?: string | null; originalParcelId?: string | null; }> | - | resources/parcels.ts:134 |
parcels.createRefund | public | Promise<{ id?: string; }> | - | resources/parcels.ts:148 |
parcels.get | public | Promise<{ id?: string; customer?: { customerId?: string; name?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; supplierHubCityTerritoryId?: string; supplierHubName?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; supportPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; deliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; createdAt?: string | null; amount?: number | null; deliveryPrice?: number | null; returnPrice?: number | null; trackingNumber?: string | null; paymentMethod?: string | null; deliveryType?: string | null; weight?: { weight?: number | null; dimensionalWeight?: number | null; effectiveWeight?: number; }; bagId?: string | null; deliveryPersonId?: string | null; deliveryPerson?: { id?: string; firstName?: string | null; lastName?: string | null; assignedPriceListId?: string; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; hub?: { id?: string; name?: string | null; type?: string | null; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: ...; lng?: ...; }; }; services?: object[] | null; }; email?: string | null; status?: string | null; isUnavailable?: boolean; isAccountActivated?: boolean; penalities?: object[] | null; }; state?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; lastStateSituationId?: string | null; situation?: { id?: string; name?: string | null; description?: string | null; slug?: string | null; metadata?: | { [key: string]: unknown; } | null; }; tenantId?: string | null; lastLocationHubId?: string | null; lastStateUpdateAt?: string | null; lastSituationUpdateAt?: string | null; hubStockId?: string | null; description?: string | null; productsDescription?: string | null; productsStockType?: string | null; isReturn?: boolean | null; isControlled?: boolean | null; type?: string | null; isExchanged?: boolean | null; originalParcelId?: string | null; returnParcelId?: string | null; pickupBagId?: string | null; externalId?: string | null; hasActiveModificationRequest?: boolean | null; orderedProducts?: object[] | null; }> | - | resources/parcels.ts:157 |
parcels.getByTrackingNumber | public | Promise<{ id?: string; customer?: { customerId?: string; name?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; supplierHubCityTerritoryId?: string; supplierHubName?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; supportPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; deliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; createdAt?: string | null; amount?: number | null; deliveryPrice?: number | null; returnPrice?: number | null; trackingNumber?: string | null; paymentMethod?: string | null; deliveryType?: string | null; weight?: { weight?: number | null; dimensionalWeight?: number | null; effectiveWeight?: number; }; bagId?: string | null; deliveryPersonId?: string | null; deliveryPerson?: { id?: string; firstName?: string | null; lastName?: string | null; assignedPriceListId?: string; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; hub?: { id?: string; name?: string | null; type?: string | null; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: ...; lng?: ...; }; }; services?: object[] | null; }; email?: string | null; status?: string | null; isUnavailable?: boolean; isAccountActivated?: boolean; penalities?: object[] | null; }; state?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; lastStateSituationId?: string | null; situation?: { id?: string; name?: string | null; description?: string | null; slug?: string | null; metadata?: | { [key: string]: unknown; } | null; }; tenantId?: string | null; lastLocationHubId?: string | null; lastStateUpdateAt?: string | null; lastSituationUpdateAt?: string | null; hubStockId?: string | null; description?: string | null; productsDescription?: string | null; productsStockType?: string | null; isReturn?: boolean | null; isControlled?: boolean | null; type?: string | null; isExchanged?: boolean | null; originalParcelId?: string | null; returnParcelId?: string | null; pickupBagId?: string | null; externalId?: string | null; hasActiveModificationRequest?: boolean | null; orderedProducts?: object[] | null; }> | - | resources/parcels.ts:170 |
parcels.search | public | (body) => Promise<PagedList<{ id?: string; customer?: { customerId?: string; name?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; supplierHubCityTerritoryId?: string; supplierHubName?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; supportPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; deliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; createdAt?: string | null; amount?: number | null; returnPrice?: number | null; deliveryPrice?: number | null; trackingNumber?: string | null; paymentMethod?: string | null; deliveryType?: string | null; weight?: { weight?: number | null; dimensionalWeight?: number | null; effectiveWeight?: number; }; bagId?: string | null; deliveryPersonId?: string | null; state?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; lastStateSituationId?: string | null; hubStockId?: string | null; situation?: { id?: string; name?: string | null; description?: string | null; slug?: string | null; metadata?: | { [key: string]: unknown; } | null; }; tenantId?: string | null; lastLocationHubId?: string | null; lastStateUpdateAt?: string | null; lastSituationUpdateAt?: string | null; description?: string | null; productsDescription?: string | null; productsStockType?: string | null; isReturn?: boolean | null; isControlled?: boolean | null; type?: string | null; isExchanged?: boolean | null; originalParcelId?: string | null; returnParcelId?: string | null; pickupBagId?: string | null; externalId?: string | null; orderedProducts?: object[] | null; }>> | Search parcels with the shared DSL (POST /parcels/search). | resources/parcels.ts:181 |
parcels.searchAll | public | AsyncGenerator<{ id?: string; customer?: { customerId?: string; name?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; supplierHubCityTerritoryId?: string; supplierHubName?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; supportPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; deliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; createdAt?: string | null; amount?: number | null; returnPrice?: number | null; deliveryPrice?: number | null; trackingNumber?: string | null; paymentMethod?: string | null; deliveryType?: string | null; weight?: { weight?: number | null; dimensionalWeight?: number | null; effectiveWeight?: number; }; bagId?: string | null; deliveryPersonId?: string | null; state?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; lastStateSituationId?: string | null; hubStockId?: string | null; situation?: { id?: string; name?: string | null; description?: string | null; slug?: string | null; metadata?: | { [key: string]: unknown; } | null; }; tenantId?: string | null; lastLocationHubId?: string | null; lastStateUpdateAt?: string | null; lastSituationUpdateAt?: string | null; description?: string | null; productsDescription?: string | null; productsStockType?: string | null; isReturn?: boolean | null; isControlled?: boolean | null; type?: string | null; isExchanged?: boolean | null; originalParcelId?: string | null; returnParcelId?: string | null; pickupBagId?: string | null; externalId?: string | null; orderedProducts?: object[] | null; }, void, undefined> | - | resources/parcels.ts:183 |
parcels.delete | public | Promise<{ id?: string | null; }> | - | resources/parcels.ts:194 |
parcels.deleteBulk | public | Promise<{ totalRequested?: number; successCount?: number; failureCount?: number; successes?: object[] | null; failures?: object[] | null; }> | - | resources/parcels.ts:207 |
parcels.deleteBulkByTrackingNumber | public | Promise<{ totalRequested?: number; successCount?: number; failureCount?: number; successes?: object[] | null; failures?: object[] | null; }> | - | resources/parcels.ts:221 |
parcels.updateState | public | Promise<{ parcelId?: string; newStateId?: string; newStateName?: string | null; trackingNumber?: string | null; }> | - | resources/parcels.ts:237 |
parcels.updateRefundState | public | Promise<{ parcelId?: string; newStateId?: string; newStateName?: string | null; trackingNumber?: string | null; }> | - | resources/parcels.ts:252 |
parcels.getStateHistory | public | Promise<object[]> | - | resources/parcels.ts:268 |
parcels.createStateSituationHistory | public | Promise<{ id?: string; }> | - | resources/parcels.ts:281 |
parcels.updateProducts | public | Promise<{ parcelId?: string; }> | - | resources/parcels.ts:298 |
parcels.updateAmount | public | Promise<{ id?: string | null; }> | - | resources/parcels.ts:310 |
parcels.updateCustomer | public | Promise<{ id?: string | null; }> | - | resources/parcels.ts:319 |
parcels.updateDeliveryAddress | public | Promise<{ id?: string | null; }> | - | resources/parcels.ts:331 |
parcels.statsByState | public | Promise<object[]> | - | resources/parcels.ts:346 |
parcels.statsBySituation | public | Promise<object[]> | - | resources/parcels.ts:361 |
parcels.import | public | Promise<{ succeededs?: object[] | null; faileds?: object[] | null; }> | - | resources/parcels.ts:377 |
parcels.downloadImportTemplate | public | Promise<ArrayBuffer> | - | resources/parcels.ts:386 |
customers | readonly | object | - | client.ts:51 |
customers.createIndividual | public | Promise<{ id?: string; }> | - | resources/customers.ts:40 |
customers.updateIndividual | public | Promise<{ id?: string; }> | - | resources/customers.ts:51 |
customers.get | public | Promise<{ id?: string; name?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; dateOfBirth?: string | null; instruction?: string | null; timeSlot?: string | null; deliveryPreference?: string | null; companyId?: string | null; companyContactPerson?: string | null; addresses?: object[] | null; }> | - | resources/customers.ts:63 |
customers.search | public | (body) => Promise<PagedList<{ id?: string; name?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; dateOfBirth?: string | null; instruction?: string | null; timeSlot?: string | null; deliveryPreference?: string | null; companyId?: string | null; companyContactPerson?: string | null; addresses?: object[] | null; }>> | Search customers with the shared DSL (POST /customers/search). | resources/customers.ts:70 |
customers.searchAll | public | AsyncGenerator<{ id?: string; name?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; dateOfBirth?: string | null; instruction?: string | null; timeSlot?: string | null; deliveryPreference?: string | null; companyId?: string | null; companyContactPerson?: string | null; addresses?: object[] | null; }, void, undefined> | - | resources/customers.ts:72 |
customers.delete | public | Promise<void> | - | resources/customers.ts:80 |
customers.addAddress | public | Promise<{ id?: string; }> | - | resources/customers.ts:88 |
customers.updateAddress | public | Promise<{ id?: string; }> | - | resources/customers.ts:100 |
customers.deleteAddress | public | Promise<{ id?: string; }> | - | resources/customers.ts:113 |
customers.importIndividual | public | Promise<{ succeededs?: object[] | null; faileds?: object[] | null; }> | - | resources/customers.ts:124 |
customers.downloadImportTemplate | public | Promise<ArrayBuffer> | - | resources/customers.ts:133 |
labels | readonly | object | - | client.ts:52 |
labels.generateMultipleHtml | public | Promise<{ fileUrl?: string | null; failedTrackingNumbers?: string[] | null; }> | - | resources/labels.ts:24 |
labels.generateIndividualHtml | public | Promise<{ parcelLabelFiles?: object[] | null; failedTrackingNumbers?: string[] | null; }> | - | resources/labels.ts:35 |
labels.generateMultiplePdf | public | Promise<{ fileUrl?: string | null; failedTrackingNumbers?: string[] | null; }> | - | resources/labels.ts:46 |
labels.generateIndividualPdf | public | Promise<{ parcelLabelFiles?: object[] | null; failedTrackingNumbers?: string[] | null; }> | - | resources/labels.ts:57 |
labels.generatePickupBagPdf | public | Promise<{ trackingNumber?: string | null; fileUrl?: string | null; }> | - | resources/labels.ts:68 |
pickupBags | readonly | object | - | client.ts:53 |
pickupBags.create | public | Promise<{ id?: string | null; trackingNumber?: string | null; successes?: object[] | null; failures?: object[] | null; }> | - | resources/pickup-bags.ts:44 |
pickupBags.get | public | Promise<{ id?: string; trackingNumber?: string | null; unprocessedParcelsCount?: number | null; state?: string | null; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; }; driverId?: string | null; driver?: { id?: string; firstName?: string | null; lastName?: string | null; }; totalParcels?: number | null; createdAt?: string | null; }> | - | resources/pickup-bags.ts:49 |
pickupBags.getByTrackingNumber | public | Promise<{ id?: string; trackingNumber?: string | null; unprocessedParcelsCount?: number | null; state?: string | null; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; }; driverId?: string | null; driver?: { id?: string; firstName?: string | null; lastName?: string | null; }; totalParcels?: number | null; createdAt?: string | null; }> | - | resources/pickup-bags.ts:57 |
pickupBags.search | public | (body) => Promise<PagedList<{ id?: string; trackingNumber?: string | null; unprocessedParcelsCount?: number | null; state?: string | null; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; }; driverId?: string | null; driver?: { id?: string; firstName?: string | null; lastName?: string | null; }; totalParcels?: number | null; createdAt?: string | null; }>> | Search pickup bags with the shared DSL (POST /pickup-bags/search). | resources/pickup-bags.ts:64 |
pickupBags.searchAll | public | AsyncGenerator<{ id?: string; trackingNumber?: string | null; unprocessedParcelsCount?: number | null; state?: string | null; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; }; driverId?: string | null; driver?: { id?: string; firstName?: string | null; lastName?: string | null; }; totalParcels?: number | null; createdAt?: string | null; }, void, undefined> | - | resources/pickup-bags.ts:66 |
pickupBags.searchParcels | public | (trackingNumber, body) => Promise<PagedList<{ id?: string; trackingNumber?: string | null; pickupBagId?: string | null; description?: string | null; supplier?: { id?: string; name?: string | null; }; }>> | Search parcels inside a pickup bag (POST /pickup-bags/{trackingNumber}/parcels/search). | resources/pickup-bags.ts:73 |
pickupBags.searchParcelsAll | public | AsyncGenerator<{ id?: string; trackingNumber?: string | null; pickupBagId?: string | null; description?: string | null; supplier?: { id?: string; name?: string | null; }; }, void, undefined> | - | resources/pickup-bags.ts:75 |
pickupBags.addParcels | public | Promise<{ parcelId?: string; successes?: object[] | null; failures?: object[] | null; }> | - | resources/pickup-bags.ts:84 |
pickupBags.removeParcel | public | Promise<{ parcelId?: string; }> | - | resources/pickup-bags.ts:96 |
pickupBags.delete | public | Promise<{ id?: string; }> | - | resources/pickup-bags.ts:108 |
modificationRequests | readonly | object | - | client.ts:54 |
modificationRequests.create | public | Promise<{ id?: string; }> | - | resources/modification-requests.ts:44 |
modificationRequests.update | public | Promise<{ id?: string; }> | - | resources/modification-requests.ts:55 |
modificationRequests.get | public | Promise<{ id?: string; parcelId?: string; parcelTrackingNumber?: string | null; clientName?: string | null; parcelState?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; newPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; newAmount?: number | null; oldAmount?: number | null; newDeliveryType?: string | null; newDeliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; validatedBy?: { id?: string; fullName?: string | null; }; validatedAt?: string | null; isApproved?: boolean | null; comment?: string | null; createdAt?: string | null; }> | - | resources/modification-requests.ts:67 |
modificationRequests.delete | public | Promise<{ id?: string; }> | - | resources/modification-requests.ts:75 |
modificationRequests.search | public | (body) => Promise<PagedList<{ id?: string; parcelId?: string; parcelTrackingNumber?: string | null; clientName?: string | null; parcelState?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; newPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; newAmount?: number | null; oldAmount?: number | null; newDeliveryType?: string | null; newDeliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; validatedBy?: { id?: string; fullName?: string | null; }; validatedAt?: string | null; isApproved?: boolean | null; comment?: string | null; createdAt?: string | null; }>> | Search this supplier's modification requests (POST /parcel-modification-requests/search). | resources/modification-requests.ts:82 |
modificationRequests.searchAll | public | AsyncGenerator<{ id?: string; parcelId?: string; parcelTrackingNumber?: string | null; clientName?: string | null; parcelState?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; newPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; newAmount?: number | null; oldAmount?: number | null; newDeliveryType?: string | null; newDeliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; validatedBy?: { id?: string; fullName?: string | null; }; validatedAt?: string | null; isApproved?: boolean | null; comment?: string | null; createdAt?: string | null; }, void, undefined> | - | resources/modification-requests.ts:84 |
modificationRequests.searchByParcel | public | (parcelId, body) => Promise<PagedList<{ id?: string; parcelId?: string; parcelTrackingNumber?: string | null; clientName?: string | null; parcelState?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; newPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; newAmount?: number | null; oldAmount?: number | null; newDeliveryType?: string | null; newDeliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; validatedBy?: { id?: string; fullName?: string | null; }; validatedAt?: string | null; isApproved?: boolean | null; comment?: string | null; createdAt?: string | null; }>> | Search modification requests for one parcel (POST /parcel-modification-requests/{parcelId}). | resources/modification-requests.ts:91 |
modificationRequests.searchByParcelAll | public | AsyncGenerator<{ id?: string; parcelId?: string; parcelTrackingNumber?: string | null; clientName?: string | null; parcelState?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; newPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; newAmount?: number | null; oldAmount?: number | null; newDeliveryType?: string | null; newDeliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; validatedBy?: { id?: string; fullName?: string | null; }; validatedAt?: string | null; isApproved?: boolean | null; comment?: string | null; createdAt?: string | null; }, void, undefined> | - | resources/modification-requests.ts:93 |
products | readonly | object | - | client.ts:55 |
products.create | public | Promise<{ id?: string | null; }> | - | resources/products.ts:36 |
products.get | public | Promise<{ id?: string; name?: string | null; sku?: string | null; category?: { id?: string; name?: string | null; subCategories?: object[] | null; }; subCategory?: { id?: string; name?: string | null; }; price?: { base?: number; promotional?: number | null; promotionStart?: string | null; promotionEnd?: string | null; }; purchasePrice?: number | null; dimensions?: { length?: number | null; width?: number | null; height?: number | null; }; localStock?: number; warehouseStocks?: object[] | null; weight?: number | null; variants?: object[] | null; stockMovements?: object[] | null; }> | - | resources/products.ts:44 |
products.search | public | (body) => Promise<PagedList<{ id?: string; tenantId?: string | null; name?: string | null; sku?: string | null; localStock?: number; categoryName?: string | null; subCategoryName?: string | null; price?: { base?: number; promotional?: number | null; promotionStart?: string | null; promotionEnd?: string | null; }; purchasePrice?: number | null; dimensions?: { length?: number | null; width?: number | null; height?: number | null; }; warehouseStock?: { damageQuantity?: number; availableQuantity?: number; pendingReceptionQuantity?: number; withdrawalQuantity?: number; underDeliveryQuantity?: number; deliveredQuantity?: number; hubId?: string | null; hubName?: string | null; }; weight?: number | null; variants?: object[] | null; }>> | Search products with the shared DSL (POST /products/search). | resources/products.ts:52 |
products.searchAll | public | AsyncGenerator<{ id?: string; tenantId?: string | null; name?: string | null; sku?: string | null; localStock?: number; categoryName?: string | null; subCategoryName?: string | null; price?: { base?: number; promotional?: number | null; promotionStart?: string | null; promotionEnd?: string | null; }; purchasePrice?: number | null; dimensions?: { length?: number | null; width?: number | null; height?: number | null; }; warehouseStock?: { damageQuantity?: number; availableQuantity?: number; pendingReceptionQuantity?: number; withdrawalQuantity?: number; underDeliveryQuantity?: number; deliveredQuantity?: number; hubId?: string | null; hubName?: string | null; }; weight?: number | null; variants?: object[] | null; }, void, undefined> | - | resources/products.ts:54 |
products.update | public | Promise<{ id?: string | null; }> | - | resources/products.ts:62 |
products.delete | public | Promise<void> | - | resources/products.ts:71 |
products.updatePrice | public | Promise<{ id?: string | null; }> | - | resources/products.ts:79 |
products.updateDiscount | public | Promise<{ id?: string | null; }> | - | resources/products.ts:88 |
products.updateLocalStock | public | Promise<{ id?: string | null; }> | - | resources/products.ts:100 |
products.import | public | Promise<{ succeededs?: object[] | null; faileds?: object[] | null; }> | - | resources/products.ts:112 |
products.downloadImportTemplate | public | Promise<ArrayBuffer> | - | resources/products.ts:121 |
categories | readonly | object | - | client.ts:56 |
categories.search | public | (body) => Promise<PagedList<{ id?: string; name?: string | null; subCategories?: object[] | null; }>> | Search categories with the shared DSL (POST /categories/search). | resources/categories.ts:17 |
categories.searchAll | public | AsyncGenerator<{ id?: string; name?: string | null; subCategories?: object[] | null; }, void, undefined> | - | resources/categories.ts:19 |
receipts | readonly | object | - | client.ts:57 |
receipts.get | public | Promise<{ id?: string; referenceId?: string | null; createdAt?: string; totalProducts?: number; supplier?: { supplierId?: string; name?: string | null; }; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; type?: string | null; receivedBy?: string | null; stockMovements?: object[] | null; }> | - | resources/receipts.ts:18 |
receipts.search | public | (body) => Promise<PagedList<{ id?: string; referenceId?: string | null; createdAt?: string; totalProducts?: number; supplier?: { supplierId?: string; name?: string | null; }; type?: string | null; receivedBy?: string | null; }>> | Search receipts with the shared DSL (POST /receipts/search). | resources/receipts.ts:25 |
receipts.searchAll | public | AsyncGenerator<{ id?: string; referenceId?: string | null; createdAt?: string; totalProducts?: number; supplier?: { supplierId?: string; name?: string | null; }; type?: string | null; receivedBy?: string | null; }, void, undefined> | - | resources/receipts.ts:27 |
stockMovements | readonly | object | - | client.ts:58 |
stockMovements.createByUser | public | Promise<{ id?: string | null; }> | - | resources/stock-movements.ts:14 |
claims | readonly | object | - | client.ts:59 |
claims.create | public | Promise<{ id?: string; }> | - | resources/claims.ts:71 |
claims.get | public | Promise<{ id?: string; title?: string | null; description?: string | null; parcel?: { id?: string; city?: string | null; district?: string | null; trackingNumber?: string | null; stateName?: string | null; customerFullName?: string | null; phone?: string | null; }; state?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean; isLocked?: boolean; color?: string | null; ranking?: number; }; category?: { id?: string; name?: string | null; }; createdAt?: string; lastModifiedAt?: string; comments?: object[] | null; }> | - | resources/claims.ts:79 |
claims.updateDetails | public | Promise<{ id?: string | null; }> | - | resources/claims.ts:88 |
claims.delete | public | Promise<void> | - | resources/claims.ts:100 |
claims.getStateHistories | public | Promise<object[]> | - | resources/claims.ts:108 |
claims.addComment | public | Promise<{ id?: string | null; }> | - | resources/claims.ts:116 |
claims.search | public | (body) => Promise<PagedList<{ id?: string; title?: string | null; description?: string | null; parcel?: { id?: string; city?: string | null; district?: string | null; trackingNumber?: string | null; stateName?: string | null; customerFullName?: string | null; phone?: string | null; }; state?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean; isLocked?: boolean; color?: string | null; ranking?: number; }; category?: { id?: string; name?: string | null; }; createdAt?: string; lastModifiedAt?: string; comments?: object[] | null; }>> | Search this supplier's claims (POST /claims/search). | resources/claims.ts:127 |
claims.searchAll | public | AsyncGenerator<{ id?: string; title?: string | null; description?: string | null; parcel?: { id?: string; city?: string | null; district?: string | null; trackingNumber?: string | null; stateName?: string | null; customerFullName?: string | null; phone?: string | null; }; state?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean; isLocked?: boolean; color?: string | null; ranking?: number; }; category?: { id?: string; name?: string | null; }; createdAt?: string; lastModifiedAt?: string; comments?: object[] | null; }, void, undefined> | - | resources/claims.ts:129 |
claims.searchComments | public | (claimId, body) => Promise<PagedList<{ id?: string; claimId?: string; content?: string | null; modifiedBy?: { id?: string; fullName?: string | null; }; createdAt?: string; }>> | Search a claim's comments (POST /claim-comments/{claimId}/search). | resources/claims.ts:136 |
claims.searchCommentsAll | public | AsyncGenerator<{ id?: string; claimId?: string; content?: string | null; modifiedBy?: { id?: string; fullName?: string | null; }; createdAt?: string; }, void, undefined> | - | resources/claims.ts:138 |
claims.searchCategories | public | (body) => Promise<PagedList<{ id?: string; name?: string | null; }>> | Search claim categories (POST /claim-categories/search). | resources/claims.ts:146 |
claims.searchCategoriesAll | public | AsyncGenerator<{ id?: string; name?: string | null; }, void, undefined> | - | resources/claims.ts:148 |
claims.getCategory | public | Promise<{ id?: string; name?: string | null; }> | - | resources/claims.ts:156 |
claims.searchWorkflows | public | (body) => Promise<PagedList<{ id?: string; name?: string | null; isDefault?: boolean; states?: object[] | null; }>> | Search claim workflows (POST /claim-workflows/search). | resources/claims.ts:163 |
claims.searchWorkflowsAll | public | AsyncGenerator<{ id?: string; name?: string | null; isDefault?: boolean; states?: object[] | null; }, void, undefined> | - | resources/claims.ts:165 |
treasury | readonly | object | - | client.ts:60 |
treasury.getBalance | public | Promise<GetSupplierStatsAmountResponse> | - | resources/treasury.ts:48 |
treasury.getTransactionsStats | public | Promise<{ amount?: number; }> | - | resources/treasury.ts:56 |
treasury.getPayment | public | Promise<{ id?: string; supplier?: { id?: string; name?: string | null; tenantId?: string | null; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; }; paymentDays?: string[] | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; owner?: { firstName?: string | null; lastName?: string | null; email?: string | null; }; legalInformation?: { rc?: string | null; nif?: string | null; ai?: string | null; nis?: string | null; }; }; amount?: number; totalParcelsDelivered?: number; totalParcelsCancelled?: number; totalRefundsCredited?: number; totalRefundsDebited?: number; totalItemLabeling?: number; labelingAmount?: number; storage?: number; createdAt?: string; referenceId?: string | null; status?: string | null; }> | - | resources/treasury.ts:68 |
treasury.acceptPayment | public | Promise<{ id?: string | null; }> | - | resources/treasury.ts:84 |
treasury.searchPayments | public | (body) => Promise<PagedList<{ id?: string; supplier?: { id?: string; name?: string | null; tenantId?: string | null; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: ...; lng?: ...; }; }; paymentDays?: string[] | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; owner?: { firstName?: string | null; lastName?: string | null; email?: string | null; }; legalInformation?: { rc?: string | null; nif?: string | null; ai?: string | null; nis?: string | null; }; }; amount?: number; totalParcelsDelivered?: number; totalParcelsCancelled?: number; totalRefundsCredited?: number; totalRefundsDebited?: number; totalItemLabeling?: number; labelingAmount?: number; storage?: number; createdAt?: string; acceptedAt?: string | null; cashDrawer?: { id?: string; cashDrawerUser?: { id?: string; firstName?: string | null; lastName?: string | null; }; amount?: number; isActive?: boolean; hub?: { id?: string; name?: string | null; type?: string | null; address?: { street?: ...; city?: ...; cityTerritoryId?: ...; district?: ...; districtTerritoryId?: ...; postalCode?: ...; country?: ...; coordinates?: ...; }; }; }; referenceId?: string | null; status?: string | null; }>> | Search this supplier's payments (POST /supplier-payment/search). | resources/treasury.ts:95 |
treasury.searchPaymentsAll | public | AsyncGenerator<{ id?: string; supplier?: { id?: string; name?: string | null; tenantId?: string | null; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; }; paymentDays?: string[] | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; owner?: { firstName?: string | null; lastName?: string | null; email?: string | null; }; legalInformation?: { rc?: string | null; nif?: string | null; ai?: string | null; nis?: string | null; }; }; amount?: number; totalParcelsDelivered?: number; totalParcelsCancelled?: number; totalRefundsCredited?: number; totalRefundsDebited?: number; totalItemLabeling?: number; labelingAmount?: number; storage?: number; createdAt?: string; acceptedAt?: string | null; cashDrawer?: { id?: string; cashDrawerUser?: { id?: string; firstName?: string | null; lastName?: string | null; }; amount?: number; isActive?: boolean; hub?: { id?: string; name?: string | null; type?: string | null; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: ...; lng?: ...; }; }; }; }; referenceId?: string | null; status?: string | null; }, void, undefined> | - | resources/treasury.ts:97 |
treasury.exportPayments | public | Promise<string> | - | resources/treasury.ts:108 |
treasury.searchPaymentTransactions | public | (supplierPaymentId, body) => Promise<PagedList<{ id?: string; amount?: number; weightCost?: number; comment?: string | null; type?: string | null; supplier?: { supplierId?: string; name?: string | null; }; parcel?: { parcelId?: string; trackingNumber?: string | null; customerFullName?: string | null; deliveryType?: string | null; description?: string | null; deliveryPrice?: number; returnPrice?: number; type?: string | null; weight?: number; }; createdAt?: string; cashReceiptId?: string | null; supplierPaymentId?: string | null; supplierPaymentReference?: string | null; }>> | Search a payment's treasury transactions. | resources/treasury.ts:112 |
treasury.searchPaymentTransactionsAll | public | AsyncGenerator<{ id?: string; amount?: number; weightCost?: number; comment?: string | null; type?: string | null; supplier?: { supplierId?: string; name?: string | null; }; parcel?: { parcelId?: string; trackingNumber?: string | null; customerFullName?: string | null; deliveryType?: string | null; description?: string | null; deliveryPrice?: number; returnPrice?: number; type?: string | null; weight?: number; }; createdAt?: string; cashReceiptId?: string | null; supplierPaymentId?: string | null; supplierPaymentReference?: string | null; }, void, undefined> | - | resources/treasury.ts:114 |
reports | readonly | object | - | client.ts:61 |
reports.search | public | (body) => Promise<PagedList<{ id?: string; createdAt?: string; tenantId?: string | null; type?: string | null; frequency?: string | null; startDate?: string; endDate?: string; createdBy?: { id?: string; fullName?: string | null; }; status?: string | null; }>> | Search reports with the shared DSL (POST /reports/search). | resources/reports.ts:21 |
reports.searchAll | public | AsyncGenerator<{ id?: string; createdAt?: string; tenantId?: string | null; type?: string | null; frequency?: string | null; startDate?: string; endDate?: string; createdBy?: { id?: string; fullName?: string | null; }; status?: string | null; }, void, undefined> | - | resources/reports.ts:23 |
reports.download | public | Promise<{ sasUrl?: string | null; }> | - | resources/reports.ts:35 |
documents | readonly | object | - | client.ts:62 |
documents.search | public | (body) => Promise<PagedList<{ id?: string; title?: string | null; description?: string | null; fileId?: string; type?: string | null; category?: string | null; displayOrder?: number; createdAt?: string; sasUrl?: string | null; fileName?: string | null; mimeType?: string | null; }>> | Search documents with the shared DSL (POST /documents/search). | resources/documents.ts:23 |
documents.searchAll | public | AsyncGenerator<{ id?: string; title?: string | null; description?: string | null; fileId?: string; type?: string | null; category?: string | null; displayOrder?: number; createdAt?: string; sasUrl?: string | null; fileName?: string | null; mimeType?: string | null; }, void, undefined> | - | resources/documents.ts:25 |
documents.getUrl | public | Promise<{ id?: string; title?: string | null; sasUrl?: string | null; fileName?: string | null; fileType?: string | null; mimeType?: string | null; }> | - | resources/documents.ts:37 |
roles | readonly | object | - | client.ts:63 |
roles.list | public | Promise<object[]> | - | resources/roles.ts:8 |
notifications | readonly | object | - | client.ts:64 |
notifications.getToken | public | Promise<string> | - | resources/notifications.ts:10 |
supplier | readonly | object | - | client.ts:65 |
supplier.get | public | Promise<{ id?: string; name?: string | null; codeName?: string | null; type?: string | null; assignedPriceListId?: string | null; hubName?: string | null; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; }; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; supportPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; legalInformation?: { rc?: string | null; nif?: string | null; ai?: string | null; nis?: string | null; }; owner?: { firstName?: string | null; lastName?: string | null; email?: string | null; }; paymentDays?: string[] | null; certificationCode?: string | null; services?: object[] | null; territories?: object[] | null; }> | - | resources/supplier.ts:11 |
webhookEndpoints | readonly | object | - | client.ts:66 |
webhookEndpoints.create | public | Promise<{ id?: string | null; url?: string | null; description?: string | null; eventTypes?: string[] | null; createdAt?: string; }> | - | resources/webhook-endpoints.ts:25 |
webhookEndpoints.list | public | Promise<{ endpoints?: object[] | null; }> | - | resources/webhook-endpoints.ts:34 |
webhookEndpoints.get | public | Promise<{ id?: string | null; url?: string | null; description?: string | null; eventTypes?: string[] | null; headers?: { headers: | { [key: string]: string; } | null; sensitive: string[] | null; }; createdAt?: string; updatedAt?: string; }> | - | resources/webhook-endpoints.ts:39 |
webhookEndpoints.update | public | Promise<{ id?: string | null; url?: string | null; description?: string | null; eventTypes?: string[] | null; updatedAt?: string; }> | - | resources/webhook-endpoints.ts:47 |
webhookEndpoints.delete | public | Promise<void> | - | resources/webhook-endpoints.ts:56 |
webhookEndpoints.getHeaders | public | Promise<{ headers?: { headers: | { [key: string]: string; } | null; sensitive: string[] | null; }; }> | - | resources/webhook-endpoints.ts:64 |
webhookEndpoints.getSecret | public | Promise<{ secret?: string | null; }> | - | resources/webhook-endpoints.ts:75 |
webhookEndpoints.getPortal | public | Promise<{ url?: string | null; token?: string | null; }> | - | resources/webhook-endpoints.ts:86 |