btrz-api-client 8.30.0 → 8.31.0
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/lib/client-standalone-min.js +1 -1
- package/lib/endpoints/accounts/application-settings.js +6 -1
- package/lib/endpoints/accounts/current-shifts.js +6 -1
- package/lib/endpoints/accounts/customers.js +11 -4
- package/lib/endpoints/accounts/domains.js +1 -2
- package/lib/endpoints/accounts/dynamic-forms.js +17 -5
- package/lib/endpoints/accounts/email-settings.js +2 -4
- package/lib/endpoints/accounts/email-templates.js +10 -2
- package/lib/endpoints/accounts/exchange-rates.js +3 -3
- package/lib/endpoints/accounts/exchange-receipts.js +2 -2
- package/lib/endpoints/accounts/goal-settings.js +2 -3
- package/lib/endpoints/accounts/images.js +2 -4
- package/lib/endpoints/accounts/interline.js +5 -8
- package/lib/endpoints/accounts/journey-prices-settings.js +2 -2
- package/lib/endpoints/accounts/lexicons.js +36 -7
- package/lib/endpoints/accounts/market-pricing-settings.js +2 -2
- package/lib/endpoints/accounts/multiproduct-sales-settings.js +2 -2
- package/lib/endpoints/accounts/network.js +6 -9
- package/lib/endpoints/accounts/operation-settings.js +2 -3
- package/lib/endpoints/accounts/people-lookups.js +27 -9
- package/lib/endpoints/accounts/point-to-point-settings.js +2 -2
- package/lib/endpoints/accounts/print-settings.js +2 -3
- package/lib/endpoints/accounts/print-templates.js +40 -9
- package/lib/endpoints/accounts/printers.js +1 -2
- package/lib/endpoints/accounts/rms-settings.js +2 -2
- package/lib/endpoints/accounts/s3buckets.js +3 -3
- package/lib/endpoints/accounts/salesforce-settings.js +2 -3
- package/lib/endpoints/accounts/shift-settings.js +2 -3
- package/lib/endpoints/accounts/shifts.js +43 -8
- package/lib/endpoints/accounts/sms-templates.js +39 -10
- package/lib/endpoints/accounts/sub-print-templates.js +1 -1
- package/lib/endpoints/accounts/ticket-movement-settings.js +2 -2
- package/lib/endpoints/accounts/tokens.js +10 -3
- package/lib/endpoints/accounts/transport-regulation-settings.js +2 -2
- package/lib/endpoints/accounts/travellers.js +19 -6
- package/lib/endpoints/accounts/trusted-machines.js +11 -3
- package/lib/endpoints/accounts/twilio-settings.js +2 -3
- package/lib/endpoints/accounts/users.js +12 -8
- package/lib/endpoints/accounts/websales-config.js +10 -3
- package/lib/endpoints/btrzpay/cardpointe.js +5 -5
- package/lib/endpoints/btrzpay/customerCards.js +4 -4
- package/lib/endpoints/btrzpay/customers.js +3 -3
- package/lib/endpoints/btrzpay/datalogic.js +8 -9
- package/lib/endpoints/btrzpay/oxxo.js +5 -13
- package/lib/endpoints/btrzpay/payment-methods.js +25 -11
- package/lib/endpoints/btrzpay/payments.js +2 -2
- package/lib/endpoints/btrzpay/prismaTerminals.js +14 -21
- package/lib/endpoints/btrzpay/reference-numbers.js +1 -1
- package/lib/endpoints/btrzpay/referenced-payments.js +11 -1
- package/lib/endpoints/btrzpay/square.js +2 -2
- package/lib/endpoints/btrzpay/stripe-terminals.js +5 -5
- package/lib/endpoints/btrzpay/terminalPayments.js +15 -5
- package/lib/endpoints/coltrane/merged-fare-tables.js +1 -1
- package/lib/endpoints/coltrane/paths.js +9 -6
- package/lib/endpoints/gps/scanner-app-location.js +3 -2
- package/lib/endpoints/inventory/amenities.js +10 -7
- package/lib/endpoints/inventory/amenity-groups.js +11 -7
- package/lib/endpoints/inventory/banks.js +5 -11
- package/lib/endpoints/inventory/bare-routes.js +12 -4
- package/lib/endpoints/inventory/brands.js +10 -6
- package/lib/endpoints/inventory/bundle-fares.js +4 -2
- package/lib/endpoints/inventory/bundles.js +5 -2
- package/lib/endpoints/inventory/change-requests.js +23 -9
- package/lib/endpoints/inventory/companies.js +5 -2
- package/lib/endpoints/inventory/control-classes.js +34 -4
- package/lib/endpoints/inventory/countries.js +8 -3
- package/lib/endpoints/inventory/custom-content.js +8 -6
- package/lib/endpoints/inventory/custom-fields.js +9 -7
- package/lib/endpoints/inventory/document-types.js +8 -11
- package/lib/endpoints/inventory/external-passes.js +13 -4
- package/lib/endpoints/inventory/external-wallets.js +5 -6
- package/lib/endpoints/inventory/fallback-codes.js +11 -4
- package/lib/endpoints/inventory/fare-classes.js +6 -4
- package/lib/endpoints/inventory/fares.js +13 -7
- package/lib/endpoints/inventory/fees.js +8 -4
- package/lib/endpoints/inventory/filtered-trips-v2.js +1 -1
- package/lib/endpoints/inventory/filtered-trips.js +14 -2
- package/lib/endpoints/inventory/financing-costs.js +15 -8
- package/lib/endpoints/inventory/garages.js +7 -5
- package/lib/endpoints/inventory/getnet-terminals.js +12 -4
- package/lib/endpoints/inventory/gift-certificate-definitions.js +10 -11
- package/lib/endpoints/inventory/insurances.js +10 -7
- package/lib/endpoints/inventory/insurancesCost.js +8 -5
- package/lib/endpoints/inventory/items.js +22 -4
- package/lib/endpoints/inventory/journey-prices.js +36 -7
- package/lib/endpoints/inventory/labels.js +6 -5
- package/lib/endpoints/inventory/marital-status.js +8 -11
- package/lib/endpoints/inventory/marketplace-modifiers.js +16 -7
- package/lib/endpoints/inventory/mit-terminal-settings.js +5 -11
- package/lib/endpoints/inventory/mit-terminals.js +5 -11
- package/lib/endpoints/inventory/operating-companies.js +13 -10
- package/lib/endpoints/inventory/operation-messages.js +16 -7
- package/lib/endpoints/inventory/operation-reasons.js +11 -9
- package/lib/endpoints/inventory/parcel-zones.js +6 -5
- package/lib/endpoints/inventory/pay-on-accounts.js +9 -3
- package/lib/endpoints/inventory/payment-terminals.js +5 -11
- package/lib/endpoints/inventory/prisma-terminals.js +10 -6
- package/lib/endpoints/inventory/products.js +31 -7
- package/lib/endpoints/inventory/promos.js +29 -11
- package/lib/endpoints/inventory/routes.js +50 -31
- package/lib/endpoints/inventory/schedule-groups.js +7 -7
- package/lib/endpoints/inventory/schedules.js +24 -11
- package/lib/endpoints/inventory/seatclasses.js +5 -15
- package/lib/endpoints/inventory/seatfees.js +9 -6
- package/lib/endpoints/inventory/seatmaps.js +37 -10
- package/lib/endpoints/inventory/segments-information-tables.js +5 -4
- package/lib/endpoints/inventory/segments-information.js +4 -2
- package/lib/endpoints/inventory/service-numbers.js +9 -6
- package/lib/endpoints/inventory/service-types.js +5 -11
- package/lib/endpoints/inventory/ssrs.js +11 -3
- package/lib/endpoints/inventory/station-classes.js +12 -6
- package/lib/endpoints/inventory/station-groups.js +4 -3
- package/lib/endpoints/inventory/stations-provinces.js +1 -7
- package/lib/endpoints/inventory/stations-zones.js +3 -2
- package/lib/endpoints/inventory/stations.js +23 -5
- package/lib/endpoints/inventory/taxes.js +5 -6
- package/lib/endpoints/inventory/travel-routes.js +6 -4
- package/lib/endpoints/inventory/traveller-card-providers-types.js +1 -7
- package/lib/endpoints/inventory/traveller-card-providers.js +3 -9
- package/lib/endpoints/inventory/traveller-card-types.js +7 -6
- package/lib/endpoints/inventory/trips.js +2 -8
- package/lib/endpoints/inventory/vehicle-types.js +0 -1
- package/lib/endpoints/inventory/vehicles.js +17 -2
- package/lib/endpoints/inventory/zone-price-overages.js +4 -10
- package/lib/endpoints/inventory/zone-prices.js +12 -7
- package/lib/endpoints/invoices/dlink.js +3 -2
- package/lib/endpoints/invoices/emails.js +1 -7
- package/lib/endpoints/invoices/gti.js +2 -2
- package/lib/endpoints/invoices/infile.js +2 -2
- package/lib/endpoints/invoices/infileJson.js +2 -2
- package/lib/endpoints/invoices/invoices.js +14 -10
- package/lib/endpoints/invoices/pdfs.js +4 -3
- package/lib/endpoints/invoices/providers.js +12 -11
- package/lib/endpoints/invoices/providersSequences.js +5 -15
- package/lib/endpoints/invoices/system.js +2 -2
- package/lib/endpoints/invoices/tax-ids.js +1 -1
- package/lib/endpoints/notifications/customers.js +25 -5
- package/lib/endpoints/notifications/email.js +8 -3
- package/lib/endpoints/notifications/manifest-notifications.js +4 -3
- package/lib/endpoints/notifications/notify.js +20 -5
- package/lib/endpoints/notifications/orders-rules-validations.js +2 -8
- package/lib/endpoints/notifications/pdf-data.js +2 -1
- package/lib/endpoints/notifications/pdfs.js +2 -1
- package/lib/endpoints/notifications/printed-tickets.js +17 -6
- package/lib/endpoints/notifications/twilio.js +1 -7
- package/lib/endpoints/operations/accounting_items.js +9 -4
- package/lib/endpoints/operations/applied_insurance.js +8 -3
- package/lib/endpoints/operations/calendar_entries.js +7 -3
- package/lib/endpoints/operations/external-bookings.js +2 -8
- package/lib/endpoints/operations/flexpasses.js +1 -1
- package/lib/endpoints/operations/loans.js +10 -4
- package/lib/endpoints/operations/manifest.js +83 -33
- package/lib/endpoints/operations/manifest_leg_for_tickets.js +1 -2
- package/lib/endpoints/operations/movements.js +1 -7
- package/lib/endpoints/operations/outlook-trips.js +13 -3
- package/lib/endpoints/operations/parcels.js +20 -6
- package/lib/endpoints/operations/parcels_manifests.js +6 -16
- package/lib/endpoints/operations/passenger_check_in_info.js +3 -10
- package/lib/endpoints/operations/redemption.js +4 -4
- package/lib/endpoints/operations/rms.js +33 -6
- package/lib/endpoints/operations/scheduled_notifications.js +4 -11
- package/lib/endpoints/operations/segments.js +2 -2
- package/lib/endpoints/operations/sold-items-fulfillment.js +4 -3
- package/lib/endpoints/operations/sold-items.js +13 -4
- package/lib/endpoints/operations/tickets.js +4 -4
- package/lib/endpoints/operations/transaction.js +1 -1
- package/lib/endpoints/operations/transactions.js +6 -14
- package/lib/endpoints/operations/transport_regulations.js +1 -1
- package/lib/endpoints/operations/trip_change_info.js +13 -1
- package/lib/endpoints/operations/vehicle_assignments.js +10 -5
- package/lib/endpoints/operations/vouchers.js +2 -9
- package/lib/endpoints/operations/waitlists.js +2 -2
- package/lib/endpoints/sales/bundles.js +4 -2
- package/lib/endpoints/sales/cancellations.js +2 -2
- package/lib/endpoints/sales/cart-promo.js +2 -9
- package/lib/endpoints/sales/cart.js +30 -17
- package/lib/endpoints/sales/check-in-info.js +1 -7
- package/lib/endpoints/sales/custom-fields.js +4 -3
- package/lib/endpoints/sales/flexpasses.js +1 -7
- package/lib/endpoints/sales/gift-certificates.js +4 -2
- package/lib/endpoints/sales/order.js +6 -4
- package/lib/endpoints/sales/parcel-quotes.js +1 -1
- package/lib/endpoints/sales/payment-providers.js +6 -3
- package/lib/endpoints/sales/redeemable-items.js +16 -5
- package/lib/endpoints/sales/sync-entry.js +1 -1
- package/lib/endpoints/sales/voucher.js +1 -1
- package/package.json +1 -1
- package/src/endpoints/accounts/application-settings.js +6 -1
- package/src/endpoints/accounts/current-shifts.js +6 -1
- package/src/endpoints/accounts/customers.js +11 -4
- package/src/endpoints/accounts/domains.js +1 -2
- package/src/endpoints/accounts/dynamic-forms.js +17 -5
- package/src/endpoints/accounts/email-settings.js +2 -4
- package/src/endpoints/accounts/email-templates.js +10 -2
- package/src/endpoints/accounts/exchange-rates.js +3 -3
- package/src/endpoints/accounts/exchange-receipts.js +2 -2
- package/src/endpoints/accounts/goal-settings.js +2 -3
- package/src/endpoints/accounts/images.js +2 -4
- package/src/endpoints/accounts/interline.js +5 -8
- package/src/endpoints/accounts/journey-prices-settings.js +2 -2
- package/src/endpoints/accounts/lexicons.js +36 -7
- package/src/endpoints/accounts/market-pricing-settings.js +2 -2
- package/src/endpoints/accounts/multiproduct-sales-settings.js +2 -2
- package/src/endpoints/accounts/network.js +6 -9
- package/src/endpoints/accounts/operation-settings.js +2 -3
- package/src/endpoints/accounts/people-lookups.js +27 -9
- package/src/endpoints/accounts/point-to-point-settings.js +2 -2
- package/src/endpoints/accounts/print-settings.js +2 -3
- package/src/endpoints/accounts/print-templates.js +40 -9
- package/src/endpoints/accounts/printers.js +1 -2
- package/src/endpoints/accounts/rms-settings.js +2 -2
- package/src/endpoints/accounts/s3buckets.js +3 -3
- package/src/endpoints/accounts/salesforce-settings.js +2 -3
- package/src/endpoints/accounts/shift-settings.js +2 -3
- package/src/endpoints/accounts/shifts.js +43 -8
- package/src/endpoints/accounts/sms-templates.js +39 -10
- package/src/endpoints/accounts/sub-print-templates.js +1 -1
- package/src/endpoints/accounts/ticket-movement-settings.js +2 -2
- package/src/endpoints/accounts/tokens.js +10 -3
- package/src/endpoints/accounts/transport-regulation-settings.js +2 -2
- package/src/endpoints/accounts/travellers.js +19 -6
- package/src/endpoints/accounts/trusted-machines.js +11 -3
- package/src/endpoints/accounts/twilio-settings.js +2 -3
- package/src/endpoints/accounts/users.js +12 -8
- package/src/endpoints/accounts/websales-config.js +10 -3
- package/src/endpoints/btrzpay/cardpointe.js +5 -5
- package/src/endpoints/btrzpay/customerCards.js +4 -4
- package/src/endpoints/btrzpay/customers.js +3 -3
- package/src/endpoints/btrzpay/datalogic.js +8 -9
- package/src/endpoints/btrzpay/oxxo.js +5 -13
- package/src/endpoints/btrzpay/payment-methods.js +25 -11
- package/src/endpoints/btrzpay/payments.js +2 -2
- package/src/endpoints/btrzpay/prismaTerminals.js +14 -21
- package/src/endpoints/btrzpay/reference-numbers.js +1 -1
- package/src/endpoints/btrzpay/referenced-payments.js +10 -2
- package/src/endpoints/btrzpay/square.js +2 -2
- package/src/endpoints/btrzpay/stripe-terminals.js +5 -5
- package/src/endpoints/btrzpay/terminalPayments.js +15 -5
- package/src/endpoints/coltrane/merged-fare-tables.js +1 -1
- package/src/endpoints/coltrane/paths.js +9 -6
- package/src/endpoints/gps/scanner-app-location.js +3 -2
- package/src/endpoints/inventory/amenities.js +10 -7
- package/src/endpoints/inventory/amenity-groups.js +11 -7
- package/src/endpoints/inventory/banks.js +5 -11
- package/src/endpoints/inventory/bare-routes.js +12 -4
- package/src/endpoints/inventory/brands.js +10 -6
- package/src/endpoints/inventory/bundle-fares.js +4 -2
- package/src/endpoints/inventory/bundles.js +5 -2
- package/src/endpoints/inventory/change-requests.js +23 -9
- package/src/endpoints/inventory/companies.js +5 -2
- package/src/endpoints/inventory/control-classes.js +34 -4
- package/src/endpoints/inventory/countries.js +8 -3
- package/src/endpoints/inventory/custom-content.js +8 -6
- package/src/endpoints/inventory/custom-fields.js +9 -7
- package/src/endpoints/inventory/document-types.js +8 -11
- package/src/endpoints/inventory/external-passes.js +13 -4
- package/src/endpoints/inventory/external-wallets.js +5 -6
- package/src/endpoints/inventory/fallback-codes.js +11 -4
- package/src/endpoints/inventory/fare-classes.js +6 -4
- package/src/endpoints/inventory/fares.js +13 -7
- package/src/endpoints/inventory/fees.js +8 -4
- package/src/endpoints/inventory/filtered-trips-v2.js +1 -1
- package/src/endpoints/inventory/filtered-trips.js +14 -2
- package/src/endpoints/inventory/financing-costs.js +15 -8
- package/src/endpoints/inventory/garages.js +7 -5
- package/src/endpoints/inventory/getnet-terminals.js +12 -4
- package/src/endpoints/inventory/gift-certificate-definitions.js +10 -11
- package/src/endpoints/inventory/insurances.js +10 -7
- package/src/endpoints/inventory/insurancesCost.js +8 -5
- package/src/endpoints/inventory/items.js +22 -4
- package/src/endpoints/inventory/journey-prices.js +36 -7
- package/src/endpoints/inventory/labels.js +6 -5
- package/src/endpoints/inventory/marital-status.js +8 -11
- package/src/endpoints/inventory/marketplace-modifiers.js +16 -7
- package/src/endpoints/inventory/mit-terminal-settings.js +5 -11
- package/src/endpoints/inventory/mit-terminals.js +5 -11
- package/src/endpoints/inventory/operating-companies.js +13 -10
- package/src/endpoints/inventory/operation-messages.js +16 -7
- package/src/endpoints/inventory/operation-reasons.js +11 -9
- package/src/endpoints/inventory/parcel-zones.js +6 -5
- package/src/endpoints/inventory/pay-on-accounts.js +9 -3
- package/src/endpoints/inventory/payment-terminals.js +5 -11
- package/src/endpoints/inventory/prisma-terminals.js +10 -6
- package/src/endpoints/inventory/products.js +31 -7
- package/src/endpoints/inventory/promos.js +29 -11
- package/src/endpoints/inventory/routes.js +50 -31
- package/src/endpoints/inventory/schedule-groups.js +7 -7
- package/src/endpoints/inventory/schedules.js +24 -11
- package/src/endpoints/inventory/seatclasses.js +5 -15
- package/src/endpoints/inventory/seatfees.js +9 -6
- package/src/endpoints/inventory/seatmaps.js +37 -10
- package/src/endpoints/inventory/segments-information-tables.js +5 -4
- package/src/endpoints/inventory/segments-information.js +4 -2
- package/src/endpoints/inventory/service-numbers.js +9 -6
- package/src/endpoints/inventory/service-types.js +5 -11
- package/src/endpoints/inventory/ssrs.js +11 -3
- package/src/endpoints/inventory/station-classes.js +12 -6
- package/src/endpoints/inventory/station-groups.js +4 -3
- package/src/endpoints/inventory/stations-provinces.js +1 -7
- package/src/endpoints/inventory/stations-zones.js +3 -2
- package/src/endpoints/inventory/stations.js +23 -5
- package/src/endpoints/inventory/taxes.js +5 -6
- package/src/endpoints/inventory/travel-routes.js +6 -4
- package/src/endpoints/inventory/traveller-card-providers-types.js +1 -7
- package/src/endpoints/inventory/traveller-card-providers.js +3 -9
- package/src/endpoints/inventory/traveller-card-types.js +7 -6
- package/src/endpoints/inventory/trips.js +2 -8
- package/src/endpoints/inventory/vehicle-types.js +0 -1
- package/src/endpoints/inventory/vehicles.js +17 -2
- package/src/endpoints/inventory/zone-price-overages.js +4 -10
- package/src/endpoints/inventory/zone-prices.js +12 -7
- package/src/endpoints/invoices/dlink.js +3 -2
- package/src/endpoints/invoices/emails.js +1 -7
- package/src/endpoints/invoices/gti.js +2 -2
- package/src/endpoints/invoices/infile.js +2 -2
- package/src/endpoints/invoices/infileJson.js +2 -2
- package/src/endpoints/invoices/invoices.js +14 -10
- package/src/endpoints/invoices/pdfs.js +4 -3
- package/src/endpoints/invoices/providers.js +12 -11
- package/src/endpoints/invoices/providersSequences.js +5 -15
- package/src/endpoints/invoices/system.js +2 -2
- package/src/endpoints/invoices/tax-ids.js +1 -1
- package/src/endpoints/notifications/customers.js +25 -5
- package/src/endpoints/notifications/email.js +8 -3
- package/src/endpoints/notifications/manifest-notifications.js +4 -3
- package/src/endpoints/notifications/notify.js +20 -5
- package/src/endpoints/notifications/orders-rules-validations.js +2 -8
- package/src/endpoints/notifications/pdf-data.js +2 -1
- package/src/endpoints/notifications/pdfs.js +2 -1
- package/src/endpoints/notifications/printed-tickets.js +17 -7
- package/src/endpoints/notifications/twilio.js +1 -7
- package/src/endpoints/operations/accounting_items.js +9 -4
- package/src/endpoints/operations/applied_insurance.js +9 -2
- package/src/endpoints/operations/calendar_entries.js +7 -3
- package/src/endpoints/operations/external-bookings.js +2 -8
- package/src/endpoints/operations/flexpasses.js +1 -1
- package/src/endpoints/operations/loans.js +10 -4
- package/src/endpoints/operations/manifest.js +83 -33
- package/src/endpoints/operations/manifest_leg_for_tickets.js +1 -2
- package/src/endpoints/operations/movements.js +1 -7
- package/src/endpoints/operations/outlook-trips.js +13 -3
- package/src/endpoints/operations/parcels.js +20 -6
- package/src/endpoints/operations/parcels_manifests.js +6 -16
- package/src/endpoints/operations/passenger_check_in_info.js +3 -10
- package/src/endpoints/operations/redemption.js +4 -4
- package/src/endpoints/operations/rms.js +33 -6
- package/src/endpoints/operations/scheduled_notifications.js +4 -11
- package/src/endpoints/operations/segments.js +2 -2
- package/src/endpoints/operations/sold-items-fulfillment.js +4 -3
- package/src/endpoints/operations/sold-items.js +13 -4
- package/src/endpoints/operations/tickets.js +4 -4
- package/src/endpoints/operations/transaction.js +1 -1
- package/src/endpoints/operations/transactions.js +6 -14
- package/src/endpoints/operations/transport_regulations.js +1 -1
- package/src/endpoints/operations/trip_change_info.js +13 -1
- package/src/endpoints/operations/vehicle_assignments.js +10 -5
- package/src/endpoints/operations/vouchers.js +2 -9
- package/src/endpoints/operations/waitlists.js +2 -2
- package/src/endpoints/sales/bundles.js +4 -2
- package/src/endpoints/sales/cancellations.js +2 -2
- package/src/endpoints/sales/cart-promo.js +2 -9
- package/src/endpoints/sales/cart.js +30 -17
- package/src/endpoints/sales/check-in-info.js +1 -7
- package/src/endpoints/sales/custom-fields.js +4 -3
- package/src/endpoints/sales/flexpasses.js +1 -7
- package/src/endpoints/sales/gift-certificates.js +4 -2
- package/src/endpoints/sales/order.js +6 -4
- package/src/endpoints/sales/parcel-quotes.js +1 -1
- package/src/endpoints/sales/payment-providers.js +6 -3
- package/src/endpoints/sales/redeemable-items.js +16 -5
- package/src/endpoints/sales/sync-entry.js +1 -1
- package/src/endpoints/sales/voucher.js +1 -1
|
@@ -2,11 +2,6 @@ const {
|
|
|
2
2
|
authorizationHeaders
|
|
3
3
|
} = require("../endpoints_helpers.js");
|
|
4
4
|
|
|
5
|
-
/**
|
|
6
|
-
* Query params for POST /orders-rules-validations (btrz-api-notifications). Forwarded to API as-is.
|
|
7
|
-
* @typedef {Object} OrdersRulesValidationsPostQuery
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
5
|
/**
|
|
11
6
|
* Factory for orders-rules-validations API (btrz-api-notifications).
|
|
12
7
|
* @param {Object} deps
|
|
@@ -19,12 +14,11 @@ function ordersRulesValidations({
|
|
|
19
14
|
internalAuthTokenProvider
|
|
20
15
|
}) {
|
|
21
16
|
/**
|
|
22
|
-
* POST /orders-rules-validations -
|
|
17
|
+
* POST /orders-rules-validations - validate a rule using the data (body only). API does not accept query params.
|
|
23
18
|
* @param {Object} opts
|
|
24
19
|
* @param {string} [opts.token] - API key
|
|
25
20
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
26
|
-
* @param {
|
|
27
|
-
* @param {Object} opts.orderRulesValidation - Validation payload
|
|
21
|
+
* @param {Object} opts.orderRulesValidation - Validation payload (rule and facts)
|
|
28
22
|
* @param {Object} [opts.headers] - Optional headers
|
|
29
23
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
30
24
|
*/
|
|
@@ -4,8 +4,9 @@ const {
|
|
|
4
4
|
} = require("./../endpoints_helpers.js");
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
+
* Query params for GET pdf-templates-processing routes (btrz-api-notifications). Client uses type/family to resolve path.
|
|
7
8
|
* @typedef {Object} PdfDataGetQuery
|
|
8
|
-
* @property {string} type - Document type; determines path
|
|
9
|
+
* @property {string} type - Document type; determines path (e.g. product, giftCertificate, voucher, transaction, ssr, manifest, passengersManifest, order, order_confirmation, cancellation, change, shift, invoice, parcelManifest, startingBalance, partialShiftDeposits, bankDepositSlip, terminalVoucher, manualTickets, etc.)
|
|
9
10
|
* @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle"
|
|
10
11
|
*/
|
|
11
12
|
|
|
@@ -4,8 +4,9 @@ const {
|
|
|
4
4
|
} = require("./../endpoints_helpers.js");
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
+
* Query params for GET pdf-templates-processing binary routes (btrz-api-notifications). Client uses type/family to resolve path.
|
|
7
8
|
* @typedef {Object} PdfGetQuery
|
|
8
|
-
* @property {string} type - Document type
|
|
9
|
+
* @property {string} type - Document type (e.g. product, giftCertificate, voucher, transaction, ssr, manifest, passengersManifest, order, shift, remainderSlip, exchange, invoice, locationClosure, parcelManifest, startingBalance, partialShiftDeposits, shiftLocationClosure, bankDepositSlip, terminalVoucher, manualTickets)
|
|
9
10
|
* @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle"
|
|
10
11
|
*/
|
|
11
12
|
|
|
@@ -2,6 +2,15 @@ const {
|
|
|
2
2
|
authorizationHeaders
|
|
3
3
|
} = require("../endpoints_helpers.js");
|
|
4
4
|
|
|
5
|
+
/**
|
|
6
|
+
* Query params for GET /printed-tickets (btrz-api-notifications). See get-printed-tickets getSpec().
|
|
7
|
+
* @typedef {Object} PrintedTicketsGetQuery
|
|
8
|
+
* @property {string} trxId - Transaction id to print its tickets (required)
|
|
9
|
+
* @property {string} [channel] - Optional channel of the transaction
|
|
10
|
+
* @property {string} [lang] - Language (handler uses for PDF URL)
|
|
11
|
+
* @property {string} [date] - Date (handler uses for PDF URL)
|
|
12
|
+
*/
|
|
13
|
+
|
|
5
14
|
/**
|
|
6
15
|
* Factory for printed-tickets API (btrz-api-notifications).
|
|
7
16
|
* @param {Object} deps
|
|
@@ -13,23 +22,24 @@ function printedTicketsFactory({
|
|
|
13
22
|
client, internalAuthTokenProvider
|
|
14
23
|
}) {
|
|
15
24
|
/**
|
|
16
|
-
* GET /printed-tickets - get printed tickets (
|
|
25
|
+
* GET /printed-tickets - get printed tickets PDF (trxId required; lang, date optional).
|
|
17
26
|
* @param {Object} opts
|
|
18
27
|
* @param {string} [opts.token] - API key
|
|
19
28
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
20
|
-
* @param {string} [opts.responseType] - Response type (
|
|
21
|
-
* @param {string} opts.trxId - Transaction id
|
|
22
|
-
* @param {string} opts.lang - Language code
|
|
23
|
-
* @param {string} opts.date - Date
|
|
29
|
+
* @param {string} [opts.responseType] - Response type ("json" or "blob")
|
|
30
|
+
* @param {string} opts.trxId - Transaction id (required)
|
|
31
|
+
* @param {string} [opts.lang] - Language code
|
|
32
|
+
* @param {string} [opts.date] - Date
|
|
33
|
+
* @param {string} [opts.channel] - Optional channel of the transaction
|
|
24
34
|
* @param {Object} [opts.headers] - Optional headers
|
|
25
35
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
26
36
|
*/
|
|
27
37
|
function get({
|
|
28
|
-
token, jwtToken, responseType = "json", trxId, lang, date, headers
|
|
38
|
+
token, jwtToken, responseType = "json", trxId, lang, date, channel, headers
|
|
29
39
|
}) {
|
|
30
40
|
return client({
|
|
31
41
|
url: "/printed-tickets",
|
|
32
|
-
params: {trxId, lang, date},
|
|
42
|
+
params: {trxId, lang, date, channel},
|
|
33
43
|
responseType,
|
|
34
44
|
headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
|
|
35
45
|
});
|
|
@@ -2,11 +2,6 @@ const {
|
|
|
2
2
|
authorizationHeaders
|
|
3
3
|
} = require("../endpoints_helpers.js");
|
|
4
4
|
|
|
5
|
-
/**
|
|
6
|
-
* Query params for GET /twilio/phone-numbers/:isocode (btrz-api-notifications). Forwarded to API as-is.
|
|
7
|
-
* @typedef {Object} TwilioPhoneNumbersListQuery
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
5
|
/**
|
|
11
6
|
* Factory for twilio API (btrz-api-notifications).
|
|
12
7
|
* @param {Object} deps
|
|
@@ -20,12 +15,11 @@ function twilioFactory({
|
|
|
20
15
|
return {
|
|
21
16
|
phoneNumbers: {
|
|
22
17
|
/**
|
|
23
|
-
* GET /twilio/phone-numbers/:isocode - list Twilio phone numbers for country isocode.
|
|
18
|
+
* GET /twilio/phone-numbers/:isocode - list Twilio phone numbers for country isocode. API does not accept query params.
|
|
24
19
|
* @param {Object} opts
|
|
25
20
|
* @param {string} opts.isocode - Country ISO code
|
|
26
21
|
* @param {string} [opts.token] - API key
|
|
27
22
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
28
|
-
* @param {TwilioPhoneNumbersListQuery} [opts.query] - Optional query params (forwarded to API)
|
|
29
23
|
* @param {Object} [opts.headers] - Optional headers
|
|
30
24
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
31
25
|
*/
|
|
@@ -3,8 +3,13 @@ const {
|
|
|
3
3
|
} = require("../endpoints_helpers.js");
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
7
|
-
* @
|
|
6
|
+
* Query params for GET /accounting-items (btrz-api-operations). See accounting-items get-handler getSpec().
|
|
7
|
+
* @typedef {Object} AccountingItemsListQuery
|
|
8
|
+
* @property {number} [page] - Page number (20 records per page)
|
|
9
|
+
* @property {string} [shiftId] - Shift id (ObjectId format)
|
|
10
|
+
* @property {string} [type] - "account_payable" | "account_receivable"
|
|
11
|
+
* @property {string} [trxId] - Transaction id (ObjectId format)
|
|
12
|
+
* @property {string} [status] - Comma-separated statuses: created, paid, waiting for payment
|
|
8
13
|
*/
|
|
9
14
|
|
|
10
15
|
/**
|
|
@@ -21,7 +26,7 @@ function accountingItemsFactory({
|
|
|
21
26
|
* GET /accounting-items - list accounting items.
|
|
22
27
|
* @param {Object} opts
|
|
23
28
|
* @param {string} [opts.token] - API key
|
|
24
|
-
* @param {
|
|
29
|
+
* @param {AccountingItemsListQuery} [opts.query] - Query params (all optional)
|
|
25
30
|
* @param {Object} [opts.headers] - Optional headers
|
|
26
31
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
27
32
|
*/
|
|
@@ -41,7 +46,7 @@ function accountingItemsFactory({
|
|
|
41
46
|
}
|
|
42
47
|
|
|
43
48
|
/**
|
|
44
|
-
* GET /accounting-items/:accountingItemId - get accounting item by id.
|
|
49
|
+
* GET /accounting-items/:accountingItemId - get accounting item by id. API does not accept query params.
|
|
45
50
|
* @param {Object} opts
|
|
46
51
|
* @param {string} [opts.token] - API key
|
|
47
52
|
* @param {string} opts.accountingItemId - Accounting item id
|
|
@@ -7,13 +7,20 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
|
7
7
|
* @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
|
|
8
8
|
* @returns {Object} applied-insurance API methods
|
|
9
9
|
*/
|
|
10
|
+
/**
|
|
11
|
+
* Query params for GET /appliedInsurances (btrz-api-operations). See get-applied-insurances getSpec().
|
|
12
|
+
* Deprecated: use GET /transactions/:transactionId/applied-insurance.
|
|
13
|
+
* @typedef {Object} AppliedInsurancesListQuery
|
|
14
|
+
* @property {string} trxId - Associated transaction id (required)
|
|
15
|
+
*/
|
|
16
|
+
|
|
10
17
|
function appliedInsuranceFactory({client, internalAuthTokenProvider}) {
|
|
11
18
|
/**
|
|
12
|
-
* GET /appliedInsurances - list applied insurances
|
|
19
|
+
* GET /appliedInsurances - list applied insurances by transaction id (query: trxId).
|
|
13
20
|
* @param {Object} opts
|
|
14
21
|
* @param {string} [opts.token] - API key
|
|
15
22
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
16
|
-
* @param {string} opts.trxId - Transaction id (query param)
|
|
23
|
+
* @param {string} opts.trxId - Transaction id (required, sent as query param)
|
|
17
24
|
* @param {Object} [opts.headers] - Optional headers
|
|
18
25
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
19
26
|
*/
|
|
@@ -1,8 +1,12 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
5
|
-
* @
|
|
4
|
+
* Query params for GET /calendar-entries (btrz-api-operations). See get-calendar-entries getSpec().
|
|
5
|
+
* @typedef {Object} CalendarEntriesListQuery
|
|
6
|
+
* @property {string} from - Start travel date (required, format yyyy-mm-dd)
|
|
7
|
+
* @property {string} to - End travel date (required, format yyyy-mm-dd, max 31 days range)
|
|
8
|
+
* @property {string} [providerId] - Provider id when consuming from a non-main account
|
|
9
|
+
* @property {string} [channels] - Filter by channel (e.g. websales); must be one of allowed channels
|
|
6
10
|
*/
|
|
7
11
|
|
|
8
12
|
/**
|
|
@@ -17,7 +21,7 @@ function calendarEntriesFactory({client, internalAuthTokenProvider}) {
|
|
|
17
21
|
* GET /calendar-entries - list calendar entries.
|
|
18
22
|
* @param {Object} opts
|
|
19
23
|
* @param {string} [opts.token] - API key
|
|
20
|
-
* @param {
|
|
24
|
+
* @param {CalendarEntriesListQuery} [opts.query] - Query params (from, to required)
|
|
21
25
|
* @param {Object} [opts.headers] - Optional headers
|
|
22
26
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
23
27
|
*/
|
|
@@ -1,10 +1,5 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
|
-
/**
|
|
4
|
-
* @typedef {Object} ExternalBookingsQuery
|
|
5
|
-
* @property {string} [providerId] - Provider account ID
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
3
|
/**
|
|
9
4
|
* Factory for external-bookings API (btrz-api-operations).
|
|
10
5
|
* @param {Object} deps
|
|
@@ -14,13 +9,12 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
|
14
9
|
*/
|
|
15
10
|
function externalBookingsFactory({client, internalAuthTokenProvider}) {
|
|
16
11
|
/**
|
|
17
|
-
* POST /external-bookings - create external booking.
|
|
12
|
+
* POST /external-bookings - create external booking. API does not accept query params.
|
|
18
13
|
* @param {Object} opts
|
|
19
14
|
* @param {string} [opts.token] - API key
|
|
20
15
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
21
16
|
* @param {Object} opts.externalBooking - External booking payload
|
|
22
17
|
* @param {Object} [opts.headers] - Optional headers
|
|
23
|
-
* @param {ExternalBookingsQuery} [opts.query] - Query params
|
|
24
18
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
25
19
|
*/
|
|
26
20
|
function create({jwtToken, token, externalBooking, headers, query = {}}) {
|
|
@@ -34,7 +28,7 @@ function externalBookingsFactory({client, internalAuthTokenProvider}) {
|
|
|
34
28
|
}
|
|
35
29
|
|
|
36
30
|
/**
|
|
37
|
-
* DELETE /external-bookings/:ticketId - remove external booking.
|
|
31
|
+
* DELETE /external-bookings/:ticketId - remove external booking. API does not accept query params.
|
|
38
32
|
* @param {Object} opts
|
|
39
33
|
* @param {string} [opts.token] - API key
|
|
40
34
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -9,7 +9,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
|
9
9
|
*/
|
|
10
10
|
function flexpassesFactory({client, internalAuthTokenProvider}) {
|
|
11
11
|
/**
|
|
12
|
-
* DELETE /flexpasses/:flexpassId/scannings/:tripId - delete scan by trip id.
|
|
12
|
+
* DELETE /flexpasses/:flexpassId/scannings/:tripId - delete scan by trip id. API does not accept query params.
|
|
13
13
|
* @param {Object} opts
|
|
14
14
|
* @param {string} [opts.token] - API key
|
|
15
15
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -3,8 +3,14 @@ const {
|
|
|
3
3
|
} = require("./../endpoints_helpers.js");
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
7
|
-
* @
|
|
6
|
+
* Query params for GET /loans (btrz-api-operations). See loans get-handler getSpec().
|
|
7
|
+
* @typedef {Object} LoansListQuery
|
|
8
|
+
* @property {number} [page] - Page number (20 records per page)
|
|
9
|
+
* @property {string} [shiftId] - Shift id (ObjectId format)
|
|
10
|
+
* @property {string} [type] - "loan" | "re-payment"
|
|
11
|
+
* @property {string} [trxId] - Transaction id (ObjectId format)
|
|
12
|
+
* @property {string} [status] - Comma-separated statuses: created, paid, waiting for payment
|
|
13
|
+
* @property {string} [providerId] - Provider id (for agencies)
|
|
8
14
|
*/
|
|
9
15
|
|
|
10
16
|
/**
|
|
@@ -21,7 +27,7 @@ function loansFactory({
|
|
|
21
27
|
* GET /loans - list loans.
|
|
22
28
|
* @param {Object} opts
|
|
23
29
|
* @param {string} [opts.token] - API key
|
|
24
|
-
* @param {
|
|
30
|
+
* @param {LoansListQuery} [opts.query] - Query params (all optional)
|
|
25
31
|
* @param {Object} [opts.headers] - Optional headers
|
|
26
32
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
27
33
|
*/
|
|
@@ -41,7 +47,7 @@ function loansFactory({
|
|
|
41
47
|
}
|
|
42
48
|
|
|
43
49
|
/**
|
|
44
|
-
* GET /loans/:loanId - get loan by id.
|
|
50
|
+
* GET /loans/:loanId - get loan by id. API does not accept query params.
|
|
45
51
|
* @param {Object} opts
|
|
46
52
|
* @param {string} [opts.token] - API key
|
|
47
53
|
* @param {string} opts.loanId - Loan id
|
|
@@ -4,8 +4,75 @@ const {
|
|
|
4
4
|
} = require("./../endpoints_helpers.js");
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
8
|
-
* @
|
|
7
|
+
* Query params for GET /manifests (btrz-api-operations). See get-manifests getSpec().
|
|
8
|
+
* @typedef {Object} ManifestsListQuery
|
|
9
|
+
* @property {string} [providerIds] - Provider IDs of the manifests
|
|
10
|
+
* @property {string} [routeIds] - Route IDs
|
|
11
|
+
* @property {string} [scheduleIds] - Schedule IDs
|
|
12
|
+
* @property {string} [date] - Date (yyyy-mm-dd)
|
|
13
|
+
* @property {string} [dateFrom] - Start date range (yyyy-mm-dd)
|
|
14
|
+
* @property {string} [dateTo] - End date range (yyyy-mm-dd)
|
|
15
|
+
* @property {string} [seatmapId] - Seatmap ID
|
|
16
|
+
* @property {string} [vehicleId] - Vehicle ID
|
|
17
|
+
* @property {string} [assignedUserId] - Assigned user ID
|
|
18
|
+
* @property {boolean} [dispatched] - If manifest was dispatched
|
|
19
|
+
* @property {boolean} [reviewed] - If manifest was reviewed
|
|
20
|
+
* @property {string} [sendToSAP] - If manifest should be sent to SAP
|
|
21
|
+
* @property {string} [operatingCompanyId] - Operating company ID
|
|
22
|
+
* @property {number} [vehicleFrom] - First vehicle id (range)
|
|
23
|
+
* @property {number} [vehicleTo] - Last vehicle id (range)
|
|
24
|
+
* @property {string} [dispatchedStatus] - Filter by dispatched status
|
|
25
|
+
* @property {boolean} [manifestOnly] - If only manifest (no ticket info)
|
|
26
|
+
* @property {string} [status] - Comma-separated manifest statuses
|
|
27
|
+
*/
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Query params for PUT /manifests (btrz-api-operations). See put-manifest getSpec().
|
|
31
|
+
* @typedef {Object} ManifestSaveQuery
|
|
32
|
+
* @property {string} providerId - Provider ID (required)
|
|
33
|
+
* @property {string} [manifestId] - Manifest ID to update (omit to create)
|
|
34
|
+
* @property {boolean} [bypassBusValidation] - Bypass bus validation
|
|
35
|
+
*/
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Query params for PATCH /manifests (btrz-api-operations). See patch-manifest getSpec().
|
|
39
|
+
* @typedef {Object} ManifestPatchQuery
|
|
40
|
+
* @property {string} providerId - Provider ID (required)
|
|
41
|
+
* @property {string} [routeId] - Route ID for update_schedule
|
|
42
|
+
* @property {string} [scheduleId] - New schedule ID for update_schedule
|
|
43
|
+
* @property {string} [oldScheduleId] - Old schedule ID for update_schedule
|
|
44
|
+
* @property {string} [accommodateOnAnySeat] - "true" to assign missing seats to any available
|
|
45
|
+
* @property {string} [newdesign] - "true" when using new seatmap design
|
|
46
|
+
*/
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Query params for GET /outlook-manifests (btrz-api-operations). See get-outlook-manifests getSpec().
|
|
50
|
+
* @typedef {Object} OutlookManifestsListQuery
|
|
51
|
+
* @property {string} providerId - Provider ID (required)
|
|
52
|
+
* @property {string} productId - Product ID (required)
|
|
53
|
+
* @property {string} from - Start date (required, yyyy-mm-dd)
|
|
54
|
+
* @property {string} to - End date (required, yyyy-mm-dd, max 1 month range)
|
|
55
|
+
* @property {string} [scheduleName] - Schedule name filter
|
|
56
|
+
* @property {string} [loadFactorFrom] - Min load factor
|
|
57
|
+
* @property {string} [loadFactorTo] - Max load factor
|
|
58
|
+
* @property {string} [timeFrom] - Min time filter
|
|
59
|
+
* @property {string} [timeTo] - Max time filter
|
|
60
|
+
* @property {string} [originId] - Origin station id
|
|
61
|
+
* @property {string} [destinationId] - Destination station id
|
|
62
|
+
* @property {string} [amenityGroupId] - Amenity group id
|
|
63
|
+
* @property {string} [userId] - Only manifests with this user assigned
|
|
64
|
+
* @property {string} [withAssignedUsers] - Filter by assigned users (true/false)
|
|
65
|
+
* @property {string} [status] - Comma-separated statuses (published, paused, planned, canceled)
|
|
66
|
+
* @property {boolean} [isExtraRun] - Only extra run trips
|
|
67
|
+
* @property {boolean} [minimalPayload] - Minimal data for five day outlook
|
|
68
|
+
* @property {string} [labelId] - Label id filter
|
|
69
|
+
* @property {boolean} [dispatched] - Only dispatched manifests
|
|
70
|
+
*/
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* Query params for PUT /manifests/:manifestKey/driver-relays (btrz-api-operations). See put-driver-relays-handler getSpec().
|
|
74
|
+
* @typedef {Object} ManifestDriverRelaysQuery
|
|
75
|
+
* @property {boolean} [bypassValidations] - If true, bypass driver validations
|
|
9
76
|
*/
|
|
10
77
|
|
|
11
78
|
/**
|
|
@@ -56,14 +123,13 @@ function manifestFactory({
|
|
|
56
123
|
}
|
|
57
124
|
|
|
58
125
|
/**
|
|
59
|
-
* POST manifests/:manifestId/dispatches - dispatch manifest.
|
|
126
|
+
* POST manifests/:manifestId/dispatches - dispatch manifest. API does not accept query params.
|
|
60
127
|
* @param {Object} opts
|
|
61
128
|
* @param {string} [opts.token] - API key
|
|
62
129
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
63
130
|
* @param {Object} [opts.headers] - Optional headers
|
|
64
131
|
* @param {string} opts.manifestId - Manifest id
|
|
65
132
|
* @param {Object} opts.data - Request body
|
|
66
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
67
133
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
68
134
|
*/
|
|
69
135
|
function dispatch({token, jwtToken, headers, manifestId, data, query}) {
|
|
@@ -81,7 +147,7 @@ function manifestFactory({
|
|
|
81
147
|
* @param {Object} opts
|
|
82
148
|
* @param {string} [opts.token] - API key
|
|
83
149
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
84
|
-
* @param {
|
|
150
|
+
* @param {ManifestsListQuery} [opts.query] - Query params (all optional)
|
|
85
151
|
* @param {Object} [opts.headers] - Optional headers
|
|
86
152
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
87
153
|
*/
|
|
@@ -95,12 +161,11 @@ function manifestFactory({
|
|
|
95
161
|
}
|
|
96
162
|
|
|
97
163
|
/**
|
|
98
|
-
* GET /manifests/:manifestId - get manifest by id.
|
|
164
|
+
* GET /manifests/:manifestId - get manifest by id. API does not accept query params.
|
|
99
165
|
* @param {Object} opts
|
|
100
166
|
* @param {string} [opts.token] - API key
|
|
101
167
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
102
168
|
* @param {string} opts.manifestId - Manifest id
|
|
103
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
104
169
|
* @param {Object} [opts.headers] - Optional headers
|
|
105
170
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
106
171
|
*/
|
|
@@ -163,7 +228,7 @@ function manifestFactory({
|
|
|
163
228
|
* @param {Object} opts
|
|
164
229
|
* @param {string} [opts.token] - API key
|
|
165
230
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
166
|
-
* @param {
|
|
231
|
+
* @param {OutlookManifestsListQuery} [opts.query] - Query params (providerId, productId, from, to required)
|
|
167
232
|
* @param {Object} [opts.headers] - Optional headers
|
|
168
233
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
169
234
|
*/
|
|
@@ -185,7 +250,7 @@ function manifestFactory({
|
|
|
185
250
|
* @param {Object} opts
|
|
186
251
|
* @param {string} [opts.token] - API key
|
|
187
252
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
188
|
-
* @param {
|
|
253
|
+
* @param {ManifestPatchQuery} [opts.query] - Query params (providerId required)
|
|
189
254
|
* @param {Object} opts.operations - JSON Patch operations
|
|
190
255
|
* @param {Object} [opts.headers] - Optional headers
|
|
191
256
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
@@ -209,10 +274,10 @@ function manifestFactory({
|
|
|
209
274
|
* @param {Object} opts
|
|
210
275
|
* @param {string} [opts.token] - API key
|
|
211
276
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
212
|
-
* @param {string} [opts.providerId] - Provider id
|
|
277
|
+
* @param {string} [opts.providerId] - Provider id (required by API as query)
|
|
213
278
|
* @param {Object} opts.data - Request body
|
|
214
279
|
* @param {Object} [opts.headers] - Optional headers
|
|
215
|
-
* @param {
|
|
280
|
+
* @param {ManifestSaveQuery} [opts.query] - Query params (providerId required; manifestId, bypassBusValidation optional)
|
|
216
281
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
217
282
|
*/
|
|
218
283
|
function save({
|
|
@@ -233,8 +298,7 @@ function manifestFactory({
|
|
|
233
298
|
* @param {string} [opts.token] - API key
|
|
234
299
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
235
300
|
* @param {string} opts.manifestId - Manifest id
|
|
236
|
-
|
|
237
|
-
* @param {Object} opts.data - Request body
|
|
301
|
+
* @param {Object} opts.data - Request body
|
|
238
302
|
* @param {Object} [opts.headers] - Optional headers
|
|
239
303
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
240
304
|
*/
|
|
@@ -280,8 +344,7 @@ function manifestFactory({
|
|
|
280
344
|
* @param {string} [opts.token] - API key
|
|
281
345
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
282
346
|
* @param {string} opts.manifestId - Manifest id
|
|
283
|
-
|
|
284
|
-
* @param {Object} opts.data - Request body
|
|
347
|
+
* @param {Object} opts.data - Request body
|
|
285
348
|
* @param {Object} [opts.headers] - Optional headers
|
|
286
349
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
287
350
|
*/
|
|
@@ -328,8 +391,7 @@ function manifestFactory({
|
|
|
328
391
|
* @param {string} [opts.token] - API key
|
|
329
392
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
330
393
|
* @param {string} opts.manifestId - Manifest id
|
|
331
|
-
|
|
332
|
-
* @param {Object} opts.data - Request body
|
|
394
|
+
* @param {Object} opts.data - Request body
|
|
333
395
|
* @param {Object} [opts.headers] - Optional headers
|
|
334
396
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
335
397
|
*/
|
|
@@ -353,8 +415,7 @@ function manifestFactory({
|
|
|
353
415
|
* @param {string} [opts.token] - API key
|
|
354
416
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
355
417
|
* @param {string} opts.manifestId - Manifest id
|
|
356
|
-
|
|
357
|
-
* @param {Object} opts.data - Request body
|
|
418
|
+
* @param {Object} opts.data - Request body
|
|
358
419
|
* @param {Object} [opts.headers] - Optional headers
|
|
359
420
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
360
421
|
*/
|
|
@@ -378,7 +439,6 @@ function manifestFactory({
|
|
|
378
439
|
* @param {string} [opts.token] - API key
|
|
379
440
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
380
441
|
* @param {string} opts.manifestKey - Manifest key
|
|
381
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
382
442
|
* @param {Object} [opts.headers] - Optional headers
|
|
383
443
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
384
444
|
*/
|
|
@@ -402,7 +462,6 @@ function manifestFactory({
|
|
|
402
462
|
* @param {Object} opts
|
|
403
463
|
* @param {string} [opts.token] - API key
|
|
404
464
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
405
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
406
465
|
* @param {Object} [opts.headers] - Optional headers
|
|
407
466
|
* @param {Object} opts.data - Request body
|
|
408
467
|
* @param {string} opts.manifestId - Manifest id
|
|
@@ -425,7 +484,6 @@ function manifestFactory({
|
|
|
425
484
|
* @param {Object} opts
|
|
426
485
|
* @param {string} [opts.token] - API key
|
|
427
486
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
428
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
429
487
|
* @param {Object} [opts.headers] - Optional headers
|
|
430
488
|
* @param {string} opts.manifestId - Manifest id
|
|
431
489
|
* @param {string} opts.legFromId - Leg from id
|
|
@@ -451,7 +509,6 @@ function manifestFactory({
|
|
|
451
509
|
* @param {Object} opts
|
|
452
510
|
* @param {string} [opts.token] - API key
|
|
453
511
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
454
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
455
512
|
* @param {Object} [opts.headers] - Optional headers
|
|
456
513
|
* @param {string} opts.manifestId - Manifest id
|
|
457
514
|
* @param {string} opts.legFromId - Leg from id
|
|
@@ -482,7 +539,6 @@ function manifestFactory({
|
|
|
482
539
|
* @param {string} [opts.token] - API key
|
|
483
540
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
484
541
|
* @param {Object} opts.data - Request body
|
|
485
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
486
542
|
* @param {Object} [opts.headers] - Optional headers
|
|
487
543
|
* @param {string} opts.manifestId - Manifest id
|
|
488
544
|
* @param {string} opts.legFromId - Leg from id
|
|
@@ -504,8 +560,7 @@ function manifestFactory({
|
|
|
504
560
|
* @param {string} [opts.token] - API key
|
|
505
561
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
506
562
|
* @param {Object} opts.data - Request body
|
|
507
|
-
|
|
508
|
-
* @param {Object} [opts.headers] - Optional headers
|
|
563
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
509
564
|
* @param {string} opts.manifestId - Manifest id
|
|
510
565
|
* @param {string} opts.legFromId - Leg from id
|
|
511
566
|
* @param {string} opts.ticketId - Ticket id
|
|
@@ -525,8 +580,7 @@ function manifestFactory({
|
|
|
525
580
|
* @param {Object} opts
|
|
526
581
|
* @param {string} [opts.token] - API key
|
|
527
582
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
528
|
-
|
|
529
|
-
* @param {Object} [opts.headers] - Optional headers
|
|
583
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
530
584
|
* @param {string} opts.manifestId - Manifest id
|
|
531
585
|
* @param {string} opts.legFromId - Leg from id
|
|
532
586
|
* @param {string} opts.ticketId - Ticket id
|
|
@@ -549,7 +603,6 @@ function manifestFactory({
|
|
|
549
603
|
* @param {Object} opts
|
|
550
604
|
* @param {string} [opts.token] - API key
|
|
551
605
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
552
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
553
606
|
* @param {string} [opts.responseType] - Response type (e.g. "json")
|
|
554
607
|
* @param {string} opts.id - Manifest id
|
|
555
608
|
* @param {Object} [opts.headers] - Optional headers
|
|
@@ -573,7 +626,6 @@ function manifestFactory({
|
|
|
573
626
|
* @param {string} [opts.token] - API key
|
|
574
627
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
575
628
|
* @param {string} opts.manifestId - Manifest id
|
|
576
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
577
629
|
* @param {Object} [opts.headers] - Optional headers
|
|
578
630
|
* @param {Object} opts.data - Request body
|
|
579
631
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
@@ -613,7 +665,6 @@ function manifestFactory({
|
|
|
613
665
|
* @param {string} [opts.token] - API key
|
|
614
666
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
615
667
|
* @param {string} opts.manifestId - Manifest id
|
|
616
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
617
668
|
* @param {Object} [opts.headers] - Optional headers
|
|
618
669
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
619
670
|
*/
|
|
@@ -634,7 +685,7 @@ function manifestFactory({
|
|
|
634
685
|
* @param {string} [opts.token] - API key
|
|
635
686
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
636
687
|
* @param {string} opts.manifestId - Manifest id
|
|
637
|
-
* @param {
|
|
688
|
+
* @param {ManifestDriverRelaysQuery} [opts.query] - Query params (bypassValidations optional)
|
|
638
689
|
* @param {Object} [opts.headers] - Optional headers
|
|
639
690
|
* @param {Object} opts.data - Request body
|
|
640
691
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
@@ -659,7 +710,6 @@ function manifestFactory({
|
|
|
659
710
|
* @param {string} opts.manifestKey - Manifest key
|
|
660
711
|
* @param {Object} opts.manifestException - Manifest exception payload
|
|
661
712
|
* @param {Object} [opts.headers] - Optional headers
|
|
662
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
663
713
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
664
714
|
*/
|
|
665
715
|
update({token, jwtToken, manifestKey, manifestException, headers, query = {}}) {
|
|
@@ -9,12 +9,11 @@ const {authorizationHeaders} = require("../endpoints_helpers.js");
|
|
|
9
9
|
*/
|
|
10
10
|
function manifestLegForTicketsFactory({client, internalAuthTokenProvider}) {
|
|
11
11
|
/**
|
|
12
|
-
* GET /manifest-leg-for-tickets/:ticketId - get manifest leg for ticket.
|
|
12
|
+
* GET /manifest-leg-for-tickets/:ticketId - get manifest leg for ticket. API does not accept query params.
|
|
13
13
|
* @param {Object} opts
|
|
14
14
|
* @param {string} [opts.token] - API key
|
|
15
15
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
16
16
|
* @param {string} opts.ticketId - Ticket id
|
|
17
|
-
* @param {Object} [opts.params] - Query params (forwarded to API)
|
|
18
17
|
* @param {Object} [opts.headers] - Optional headers
|
|
19
18
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
20
19
|
*/
|
|
@@ -1,10 +1,5 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
|
-
/**
|
|
4
|
-
* @typedef {Object} MovementsQuery
|
|
5
|
-
* @property {string} [providerId] - Provider account ID
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
3
|
/**
|
|
9
4
|
* Factory for movements API (btrz-api-operations).
|
|
10
5
|
* @param {Object} deps
|
|
@@ -14,12 +9,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
|
14
9
|
*/
|
|
15
10
|
function movementsFactory({client, internalAuthTokenProvider}) {
|
|
16
11
|
/**
|
|
17
|
-
* POST /movements - create movement.
|
|
12
|
+
* POST /movements - create movement. API does not accept query params.
|
|
18
13
|
* @param {Object} opts
|
|
19
14
|
* @param {string} [opts.token] - API key
|
|
20
15
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
21
16
|
* @param {Object} opts.movement - Movement payload
|
|
22
|
-
* @param {MovementsQuery} [opts.query] - Query params
|
|
23
17
|
* @param {Object} [opts.headers] - Optional headers
|
|
24
18
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
25
19
|
*/
|
|
@@ -1,8 +1,18 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
5
|
-
* @
|
|
4
|
+
* Query params for GET /outlook-trips (btrz-api-operations). See get-outlook-trips getSpec().
|
|
5
|
+
* @typedef {Object} OutlookTripsListQuery
|
|
6
|
+
* @property {string} from - Travel start date (required, date format)
|
|
7
|
+
* @property {string} to - Travel end date (required, date format)
|
|
8
|
+
* @property {string} [fromTime] - Cutoff time for first date (HH:MM)
|
|
9
|
+
* @property {string} [toTime] - Cutoff time for last date (HH:MM)
|
|
10
|
+
* @property {string} productId - Product ID (required)
|
|
11
|
+
* @property {string} [originId] - Origin (departure) station ID
|
|
12
|
+
* @property {string} [destinationId] - Destination station ID
|
|
13
|
+
* @property {string} [routeId] - Route ID
|
|
14
|
+
* @property {string} [scheduleId] - Schedule ID
|
|
15
|
+
* @property {boolean} [isExtraRun] - Only trips marked as extra run
|
|
6
16
|
*/
|
|
7
17
|
|
|
8
18
|
/**
|
|
@@ -18,7 +28,7 @@ function outlookTripsFactory({client, internalAuthTokenProvider}) {
|
|
|
18
28
|
* @param {Object} opts
|
|
19
29
|
* @param {string} [opts.token] - API key
|
|
20
30
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
21
|
-
* @param {
|
|
31
|
+
* @param {OutlookTripsListQuery} [opts.query] - Query params (from, to, productId required)
|
|
22
32
|
* @param {Object} [opts.headers] - Optional headers
|
|
23
33
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
24
34
|
*/
|