btrz-api-client 8.30.0 → 8.32.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/.cursor/rules/jsdoc-endpoints.mdc +1 -1
- package/lib/client-standalone-min.js +3 -3
- package/lib/client.js +3 -0
- package/lib/endpoints/accounts/agencies.js +52 -0
- package/lib/endpoints/accounts/application-settings.js +23 -17
- package/lib/endpoints/accounts/applications.js +8 -7
- package/lib/endpoints/accounts/current-shifts.js +6 -1
- package/lib/endpoints/accounts/customers.js +31 -21
- package/lib/endpoints/accounts/domains.js +16 -12
- package/lib/endpoints/accounts/dynamic-forms.js +17 -5
- package/lib/endpoints/accounts/email-settings.js +22 -20
- package/lib/endpoints/accounts/email-templates.js +18 -6
- package/lib/endpoints/accounts/exchange-rates.js +13 -8
- package/lib/endpoints/accounts/exchange-receipts.js +10 -6
- package/lib/endpoints/accounts/external-customers.js +50 -0
- package/lib/endpoints/accounts/goal-settings.js +8 -7
- package/lib/endpoints/accounts/images.js +14 -15
- package/lib/endpoints/accounts/interline.js +35 -30
- package/lib/endpoints/accounts/journey-prices-settings.js +8 -6
- package/lib/endpoints/accounts/lexicons.js +48 -19
- package/lib/endpoints/accounts/market-pricing-settings.js +7 -6
- package/lib/endpoints/accounts/multiproduct-sales-settings.js +7 -6
- package/lib/endpoints/accounts/network.js +29 -17
- package/lib/endpoints/accounts/operation-settings.js +8 -7
- package/lib/endpoints/accounts/people-lookups.js +39 -21
- package/lib/endpoints/accounts/point-to-point-settings.js +6 -6
- package/lib/endpoints/accounts/print-settings.js +9 -7
- package/lib/endpoints/accounts/print-templates.js +71 -24
- package/lib/endpoints/accounts/printers.js +10 -5
- package/lib/endpoints/accounts/rms-settings.js +19 -11
- package/lib/endpoints/accounts/s3buckets.js +3 -3
- package/lib/endpoints/accounts/salesforce-settings.js +8 -7
- package/lib/endpoints/accounts/shift-settings.js +7 -7
- package/lib/endpoints/accounts/shifts.js +54 -15
- package/lib/endpoints/accounts/sms-templates.js +56 -18
- package/lib/endpoints/accounts/sub-print-templates.js +5 -3
- package/lib/endpoints/accounts/ticket-movement-settings.js +8 -5
- package/lib/endpoints/accounts/tokens.js +10 -3
- package/lib/endpoints/accounts/transport-regulation-settings.js +2 -2
- package/lib/endpoints/accounts/travellers.js +36 -17
- package/lib/endpoints/accounts/trusted-machines.js +19 -8
- package/lib/endpoints/accounts/twilio-settings.js +8 -6
- package/lib/endpoints/accounts/users.js +116 -70
- package/lib/endpoints/accounts/verified-emails.js +130 -0
- package/lib/endpoints/accounts/websales-config.js +15 -6
- 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/client.js +3 -0
- package/src/endpoints/accounts/agencies.js +40 -0
- package/src/endpoints/accounts/application-settings.js +23 -17
- package/src/endpoints/accounts/applications.js +8 -7
- package/src/endpoints/accounts/current-shifts.js +6 -1
- package/src/endpoints/accounts/customers.js +31 -21
- package/src/endpoints/accounts/domains.js +16 -12
- package/src/endpoints/accounts/dynamic-forms.js +17 -5
- package/src/endpoints/accounts/email-settings.js +22 -20
- package/src/endpoints/accounts/email-templates.js +18 -6
- package/src/endpoints/accounts/exchange-rates.js +13 -8
- package/src/endpoints/accounts/exchange-receipts.js +10 -6
- package/src/endpoints/accounts/external-customers.js +37 -0
- package/src/endpoints/accounts/goal-settings.js +8 -7
- package/src/endpoints/accounts/images.js +14 -15
- package/src/endpoints/accounts/interline.js +35 -31
- package/src/endpoints/accounts/journey-prices-settings.js +8 -6
- package/src/endpoints/accounts/lexicons.js +48 -19
- package/src/endpoints/accounts/market-pricing-settings.js +7 -6
- package/src/endpoints/accounts/multiproduct-sales-settings.js +7 -6
- package/src/endpoints/accounts/network.js +29 -18
- package/src/endpoints/accounts/operation-settings.js +8 -7
- package/src/endpoints/accounts/people-lookups.js +39 -21
- package/src/endpoints/accounts/point-to-point-settings.js +6 -6
- package/src/endpoints/accounts/print-settings.js +9 -8
- package/src/endpoints/accounts/print-templates.js +65 -22
- package/src/endpoints/accounts/printers.js +10 -6
- package/src/endpoints/accounts/rms-settings.js +19 -11
- package/src/endpoints/accounts/s3buckets.js +3 -3
- package/src/endpoints/accounts/salesforce-settings.js +8 -7
- package/src/endpoints/accounts/shift-settings.js +7 -7
- package/src/endpoints/accounts/shifts.js +54 -15
- package/src/endpoints/accounts/sms-templates.js +56 -18
- package/src/endpoints/accounts/sub-print-templates.js +5 -3
- package/src/endpoints/accounts/ticket-movement-settings.js +8 -5
- package/src/endpoints/accounts/tokens.js +10 -3
- package/src/endpoints/accounts/transport-regulation-settings.js +2 -2
- package/src/endpoints/accounts/travellers.js +36 -17
- package/src/endpoints/accounts/trusted-machines.js +19 -8
- package/src/endpoints/accounts/twilio-settings.js +8 -6
- package/src/endpoints/accounts/users.js +53 -12
- package/src/endpoints/accounts/verified-emails.js +100 -0
- package/src/endpoints/accounts/websales-config.js +15 -6
- 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
- package/test/endpoints/accounts/agencies.test.js +58 -0
- package/test/endpoints/accounts/external-customers.test.js +62 -0
- package/test/endpoints/accounts/users.js +10 -0
- package/test/endpoints/accounts/verified-emails.test.js +35 -0
- package/types/endpoints/accounts/users.d.ts +2 -1
- package/types/endpoints/accounts/verified-emails.d.ts +19 -0
|
@@ -3,11 +3,6 @@
|
|
|
3
3
|
var _require = require("../endpoints_helpers.js"),
|
|
4
4
|
authorizationHeaders = _require.authorizationHeaders;
|
|
5
5
|
|
|
6
|
-
/**
|
|
7
|
-
* Query params for POST /orders-rules-validations (btrz-api-notifications). Forwarded to API as-is.
|
|
8
|
-
* @typedef {Object} OrdersRulesValidationsPostQuery
|
|
9
|
-
*/
|
|
10
|
-
|
|
11
6
|
/**
|
|
12
7
|
* Factory for orders-rules-validations API (btrz-api-notifications).
|
|
13
8
|
* @param {Object} deps
|
|
@@ -22,12 +17,11 @@ function ordersRulesValidations(_ref) {
|
|
|
22
17
|
internalAuthTokenProvider = _ref.internalAuthTokenProvider;
|
|
23
18
|
|
|
24
19
|
/**
|
|
25
|
-
* POST /orders-rules-validations -
|
|
20
|
+
* POST /orders-rules-validations - validate a rule using the data (body only). API does not accept query params.
|
|
26
21
|
* @param {Object} opts
|
|
27
22
|
* @param {string} [opts.token] - API key
|
|
28
23
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
29
|
-
* @param {
|
|
30
|
-
* @param {Object} opts.orderRulesValidation - Validation payload
|
|
24
|
+
* @param {Object} opts.orderRulesValidation - Validation payload (rule and facts)
|
|
31
25
|
* @param {Object} [opts.headers] - Optional headers
|
|
32
26
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
33
27
|
*/
|
|
@@ -5,8 +5,9 @@ var _require = require("./../endpoints_helpers.js"),
|
|
|
5
5
|
authorizationHeaders = _require.authorizationHeaders;
|
|
6
6
|
|
|
7
7
|
/**
|
|
8
|
+
* Query params for GET pdf-templates-processing routes (btrz-api-notifications). Client uses type/family to resolve path.
|
|
8
9
|
* @typedef {Object} PdfDataGetQuery
|
|
9
|
-
* @property {string} type - Document type; determines path
|
|
10
|
+
* @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.)
|
|
10
11
|
* @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle"
|
|
11
12
|
*/
|
|
12
13
|
|
|
@@ -5,8 +5,9 @@ var _require = require("./../endpoints_helpers.js"),
|
|
|
5
5
|
authorizationHeaders = _require.authorizationHeaders;
|
|
6
6
|
|
|
7
7
|
/**
|
|
8
|
+
* Query params for GET pdf-templates-processing binary routes (btrz-api-notifications). Client uses type/family to resolve path.
|
|
8
9
|
* @typedef {Object} PdfGetQuery
|
|
9
|
-
* @property {string} type - Document type
|
|
10
|
+
* @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)
|
|
10
11
|
* @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle"
|
|
11
12
|
*/
|
|
12
13
|
|
|
@@ -3,6 +3,15 @@
|
|
|
3
3
|
var _require = require("../endpoints_helpers.js"),
|
|
4
4
|
authorizationHeaders = _require.authorizationHeaders;
|
|
5
5
|
|
|
6
|
+
/**
|
|
7
|
+
* Query params for GET /printed-tickets (btrz-api-notifications). See get-printed-tickets getSpec().
|
|
8
|
+
* @typedef {Object} PrintedTicketsGetQuery
|
|
9
|
+
* @property {string} trxId - Transaction id to print its tickets (required)
|
|
10
|
+
* @property {string} [channel] - Optional channel of the transaction
|
|
11
|
+
* @property {string} [lang] - Language (handler uses for PDF URL)
|
|
12
|
+
* @property {string} [date] - Date (handler uses for PDF URL)
|
|
13
|
+
*/
|
|
14
|
+
|
|
6
15
|
/**
|
|
7
16
|
* Factory for printed-tickets API (btrz-api-notifications).
|
|
8
17
|
* @param {Object} deps
|
|
@@ -17,14 +26,15 @@ function printedTicketsFactory(_ref) {
|
|
|
17
26
|
internalAuthTokenProvider = _ref.internalAuthTokenProvider;
|
|
18
27
|
|
|
19
28
|
/**
|
|
20
|
-
* GET /printed-tickets - get printed tickets (
|
|
29
|
+
* GET /printed-tickets - get printed tickets PDF (trxId required; lang, date optional).
|
|
21
30
|
* @param {Object} opts
|
|
22
31
|
* @param {string} [opts.token] - API key
|
|
23
32
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
24
|
-
* @param {string} [opts.responseType] - Response type (
|
|
25
|
-
* @param {string} opts.trxId - Transaction id
|
|
26
|
-
* @param {string} opts.lang - Language code
|
|
27
|
-
* @param {string} opts.date - Date
|
|
33
|
+
* @param {string} [opts.responseType] - Response type ("json" or "blob")
|
|
34
|
+
* @param {string} opts.trxId - Transaction id (required)
|
|
35
|
+
* @param {string} [opts.lang] - Language code
|
|
36
|
+
* @param {string} [opts.date] - Date
|
|
37
|
+
* @param {string} [opts.channel] - Optional channel of the transaction
|
|
28
38
|
* @param {Object} [opts.headers] - Optional headers
|
|
29
39
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
30
40
|
*/
|
|
@@ -36,11 +46,12 @@ function printedTicketsFactory(_ref) {
|
|
|
36
46
|
trxId = _ref2.trxId,
|
|
37
47
|
lang = _ref2.lang,
|
|
38
48
|
date = _ref2.date,
|
|
49
|
+
channel = _ref2.channel,
|
|
39
50
|
headers = _ref2.headers;
|
|
40
51
|
|
|
41
52
|
return client({
|
|
42
53
|
url: "/printed-tickets",
|
|
43
|
-
params: { trxId: trxId, lang: lang, date: date },
|
|
54
|
+
params: { trxId: trxId, lang: lang, date: date, channel: channel },
|
|
44
55
|
responseType: responseType,
|
|
45
56
|
headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
|
|
46
57
|
});
|
|
@@ -3,11 +3,6 @@
|
|
|
3
3
|
var _require = require("../endpoints_helpers.js"),
|
|
4
4
|
authorizationHeaders = _require.authorizationHeaders;
|
|
5
5
|
|
|
6
|
-
/**
|
|
7
|
-
* Query params for GET /twilio/phone-numbers/:isocode (btrz-api-notifications). Forwarded to API as-is.
|
|
8
|
-
* @typedef {Object} TwilioPhoneNumbersListQuery
|
|
9
|
-
*/
|
|
10
|
-
|
|
11
6
|
/**
|
|
12
7
|
* Factory for twilio API (btrz-api-notifications).
|
|
13
8
|
* @param {Object} deps
|
|
@@ -24,12 +19,11 @@ function twilioFactory(_ref) {
|
|
|
24
19
|
return {
|
|
25
20
|
phoneNumbers: {
|
|
26
21
|
/**
|
|
27
|
-
* GET /twilio/phone-numbers/:isocode - list Twilio phone numbers for country isocode.
|
|
22
|
+
* GET /twilio/phone-numbers/:isocode - list Twilio phone numbers for country isocode. API does not accept query params.
|
|
28
23
|
* @param {Object} opts
|
|
29
24
|
* @param {string} opts.isocode - Country ISO code
|
|
30
25
|
* @param {string} [opts.token] - API key
|
|
31
26
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
32
|
-
* @param {TwilioPhoneNumbersListQuery} [opts.query] - Optional query params (forwarded to API)
|
|
33
27
|
* @param {Object} [opts.headers] - Optional headers
|
|
34
28
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
35
29
|
*/
|
|
@@ -4,8 +4,13 @@ var _require = require("../endpoints_helpers.js"),
|
|
|
4
4
|
authorizationHeaders = _require.authorizationHeaders;
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
8
|
-
* @
|
|
7
|
+
* Query params for GET /accounting-items (btrz-api-operations). See accounting-items get-handler getSpec().
|
|
8
|
+
* @typedef {Object} AccountingItemsListQuery
|
|
9
|
+
* @property {number} [page] - Page number (20 records per page)
|
|
10
|
+
* @property {string} [shiftId] - Shift id (ObjectId format)
|
|
11
|
+
* @property {string} [type] - "account_payable" | "account_receivable"
|
|
12
|
+
* @property {string} [trxId] - Transaction id (ObjectId format)
|
|
13
|
+
* @property {string} [status] - Comma-separated statuses: created, paid, waiting for payment
|
|
9
14
|
*/
|
|
10
15
|
|
|
11
16
|
/**
|
|
@@ -25,7 +30,7 @@ function accountingItemsFactory(_ref) {
|
|
|
25
30
|
* GET /accounting-items - list accounting items.
|
|
26
31
|
* @param {Object} opts
|
|
27
32
|
* @param {string} [opts.token] - API key
|
|
28
|
-
* @param {
|
|
33
|
+
* @param {AccountingItemsListQuery} [opts.query] - Query params (all optional)
|
|
29
34
|
* @param {Object} [opts.headers] - Optional headers
|
|
30
35
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
31
36
|
*/
|
|
@@ -46,7 +51,7 @@ function accountingItemsFactory(_ref) {
|
|
|
46
51
|
}
|
|
47
52
|
|
|
48
53
|
/**
|
|
49
|
-
* GET /accounting-items/:accountingItemId - get accounting item by id.
|
|
54
|
+
* GET /accounting-items/:accountingItemId - get accounting item by id. API does not accept query params.
|
|
50
55
|
* @param {Object} opts
|
|
51
56
|
* @param {string} [opts.token] - API key
|
|
52
57
|
* @param {string} opts.accountingItemId - Accounting item id
|
|
@@ -10,18 +10,23 @@ var _require = require("./../endpoints_helpers.js"),
|
|
|
10
10
|
* @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
|
|
11
11
|
* @returns {Object} applied-insurance API methods
|
|
12
12
|
*/
|
|
13
|
-
|
|
13
|
+
/**
|
|
14
|
+
* Query params for GET /appliedInsurances (btrz-api-operations). See get-applied-insurances getSpec().
|
|
15
|
+
* Deprecated: use GET /transactions/:transactionId/applied-insurance.
|
|
16
|
+
* @typedef {Object} AppliedInsurancesListQuery
|
|
17
|
+
* @property {string} trxId - Associated transaction id (required)
|
|
18
|
+
*/
|
|
14
19
|
|
|
15
20
|
function appliedInsuranceFactory(_ref) {
|
|
16
21
|
var client = _ref.client,
|
|
17
22
|
internalAuthTokenProvider = _ref.internalAuthTokenProvider;
|
|
18
23
|
|
|
19
24
|
/**
|
|
20
|
-
* GET /appliedInsurances - list applied insurances
|
|
25
|
+
* GET /appliedInsurances - list applied insurances by transaction id (query: trxId).
|
|
21
26
|
* @param {Object} opts
|
|
22
27
|
* @param {string} [opts.token] - API key
|
|
23
28
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
24
|
-
* @param {string} opts.trxId - Transaction id (query param)
|
|
29
|
+
* @param {string} opts.trxId - Transaction id (required, sent as query param)
|
|
25
30
|
* @param {Object} [opts.headers] - Optional headers
|
|
26
31
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
27
32
|
*/
|
|
@@ -4,8 +4,12 @@ var _require = require("./../endpoints_helpers.js"),
|
|
|
4
4
|
authorizationHeaders = _require.authorizationHeaders;
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
8
|
-
* @
|
|
7
|
+
* Query params for GET /calendar-entries (btrz-api-operations). See get-calendar-entries getSpec().
|
|
8
|
+
* @typedef {Object} CalendarEntriesListQuery
|
|
9
|
+
* @property {string} from - Start travel date (required, format yyyy-mm-dd)
|
|
10
|
+
* @property {string} to - End travel date (required, format yyyy-mm-dd, max 31 days range)
|
|
11
|
+
* @property {string} [providerId] - Provider id when consuming from a non-main account
|
|
12
|
+
* @property {string} [channels] - Filter by channel (e.g. websales); must be one of allowed channels
|
|
9
13
|
*/
|
|
10
14
|
|
|
11
15
|
/**
|
|
@@ -25,7 +29,7 @@ function calendarEntriesFactory(_ref) {
|
|
|
25
29
|
* GET /calendar-entries - list calendar entries.
|
|
26
30
|
* @param {Object} opts
|
|
27
31
|
* @param {string} [opts.token] - API key
|
|
28
|
-
* @param {
|
|
32
|
+
* @param {CalendarEntriesListQuery} [opts.query] - Query params (from, to required)
|
|
29
33
|
* @param {Object} [opts.headers] - Optional headers
|
|
30
34
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
31
35
|
*/
|
|
@@ -3,11 +3,6 @@
|
|
|
3
3
|
var _require = require("./../endpoints_helpers.js"),
|
|
4
4
|
authorizationHeaders = _require.authorizationHeaders;
|
|
5
5
|
|
|
6
|
-
/**
|
|
7
|
-
* @typedef {Object} ExternalBookingsQuery
|
|
8
|
-
* @property {string} [providerId] - Provider account ID
|
|
9
|
-
*/
|
|
10
|
-
|
|
11
6
|
/**
|
|
12
7
|
* Factory for external-bookings API (btrz-api-operations).
|
|
13
8
|
* @param {Object} deps
|
|
@@ -22,13 +17,12 @@ function externalBookingsFactory(_ref) {
|
|
|
22
17
|
internalAuthTokenProvider = _ref.internalAuthTokenProvider;
|
|
23
18
|
|
|
24
19
|
/**
|
|
25
|
-
* POST /external-bookings - create external booking.
|
|
20
|
+
* POST /external-bookings - create external booking. API does not accept query params.
|
|
26
21
|
* @param {Object} opts
|
|
27
22
|
* @param {string} [opts.token] - API key
|
|
28
23
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
29
24
|
* @param {Object} opts.externalBooking - External booking payload
|
|
30
25
|
* @param {Object} [opts.headers] - Optional headers
|
|
31
|
-
* @param {ExternalBookingsQuery} [opts.query] - Query params
|
|
32
26
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
33
27
|
*/
|
|
34
28
|
function create(_ref2) {
|
|
@@ -49,7 +43,7 @@ function externalBookingsFactory(_ref) {
|
|
|
49
43
|
}
|
|
50
44
|
|
|
51
45
|
/**
|
|
52
|
-
* DELETE /external-bookings/:ticketId - remove external booking.
|
|
46
|
+
* DELETE /external-bookings/:ticketId - remove external booking. API does not accept query params.
|
|
53
47
|
* @param {Object} opts
|
|
54
48
|
* @param {string} [opts.token] - API key
|
|
55
49
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -17,7 +17,7 @@ function flexpassesFactory(_ref) {
|
|
|
17
17
|
internalAuthTokenProvider = _ref.internalAuthTokenProvider;
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
|
-
* DELETE /flexpasses/:flexpassId/scannings/:tripId - delete scan by trip id.
|
|
20
|
+
* DELETE /flexpasses/:flexpassId/scannings/:tripId - delete scan by trip id. API does not accept query params.
|
|
21
21
|
* @param {Object} opts
|
|
22
22
|
* @param {string} [opts.token] - API key
|
|
23
23
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -4,8 +4,14 @@ var _require = require("./../endpoints_helpers.js"),
|
|
|
4
4
|
authorizationHeaders = _require.authorizationHeaders;
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
8
|
-
* @
|
|
7
|
+
* Query params for GET /loans (btrz-api-operations). See loans get-handler getSpec().
|
|
8
|
+
* @typedef {Object} LoansListQuery
|
|
9
|
+
* @property {number} [page] - Page number (20 records per page)
|
|
10
|
+
* @property {string} [shiftId] - Shift id (ObjectId format)
|
|
11
|
+
* @property {string} [type] - "loan" | "re-payment"
|
|
12
|
+
* @property {string} [trxId] - Transaction id (ObjectId format)
|
|
13
|
+
* @property {string} [status] - Comma-separated statuses: created, paid, waiting for payment
|
|
14
|
+
* @property {string} [providerId] - Provider id (for agencies)
|
|
9
15
|
*/
|
|
10
16
|
|
|
11
17
|
/**
|
|
@@ -25,7 +31,7 @@ function loansFactory(_ref) {
|
|
|
25
31
|
* GET /loans - list loans.
|
|
26
32
|
* @param {Object} opts
|
|
27
33
|
* @param {string} [opts.token] - API key
|
|
28
|
-
* @param {
|
|
34
|
+
* @param {LoansListQuery} [opts.query] - Query params (all optional)
|
|
29
35
|
* @param {Object} [opts.headers] - Optional headers
|
|
30
36
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
31
37
|
*/
|
|
@@ -46,7 +52,7 @@ function loansFactory(_ref) {
|
|
|
46
52
|
}
|
|
47
53
|
|
|
48
54
|
/**
|
|
49
|
-
* GET /loans/:loanId - get loan by id.
|
|
55
|
+
* GET /loans/:loanId - get loan by id. API does not accept query params.
|
|
50
56
|
* @param {Object} opts
|
|
51
57
|
* @param {string} [opts.token] - API key
|
|
52
58
|
* @param {string} opts.loanId - Loan id
|
|
@@ -7,8 +7,75 @@ var _require = require("./../endpoints_helpers.js"),
|
|
|
7
7
|
authorizationHeaders = _require.authorizationHeaders;
|
|
8
8
|
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
11
|
-
* @
|
|
10
|
+
* Query params for GET /manifests (btrz-api-operations). See get-manifests getSpec().
|
|
11
|
+
* @typedef {Object} ManifestsListQuery
|
|
12
|
+
* @property {string} [providerIds] - Provider IDs of the manifests
|
|
13
|
+
* @property {string} [routeIds] - Route IDs
|
|
14
|
+
* @property {string} [scheduleIds] - Schedule IDs
|
|
15
|
+
* @property {string} [date] - Date (yyyy-mm-dd)
|
|
16
|
+
* @property {string} [dateFrom] - Start date range (yyyy-mm-dd)
|
|
17
|
+
* @property {string} [dateTo] - End date range (yyyy-mm-dd)
|
|
18
|
+
* @property {string} [seatmapId] - Seatmap ID
|
|
19
|
+
* @property {string} [vehicleId] - Vehicle ID
|
|
20
|
+
* @property {string} [assignedUserId] - Assigned user ID
|
|
21
|
+
* @property {boolean} [dispatched] - If manifest was dispatched
|
|
22
|
+
* @property {boolean} [reviewed] - If manifest was reviewed
|
|
23
|
+
* @property {string} [sendToSAP] - If manifest should be sent to SAP
|
|
24
|
+
* @property {string} [operatingCompanyId] - Operating company ID
|
|
25
|
+
* @property {number} [vehicleFrom] - First vehicle id (range)
|
|
26
|
+
* @property {number} [vehicleTo] - Last vehicle id (range)
|
|
27
|
+
* @property {string} [dispatchedStatus] - Filter by dispatched status
|
|
28
|
+
* @property {boolean} [manifestOnly] - If only manifest (no ticket info)
|
|
29
|
+
* @property {string} [status] - Comma-separated manifest statuses
|
|
30
|
+
*/
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Query params for PUT /manifests (btrz-api-operations). See put-manifest getSpec().
|
|
34
|
+
* @typedef {Object} ManifestSaveQuery
|
|
35
|
+
* @property {string} providerId - Provider ID (required)
|
|
36
|
+
* @property {string} [manifestId] - Manifest ID to update (omit to create)
|
|
37
|
+
* @property {boolean} [bypassBusValidation] - Bypass bus validation
|
|
38
|
+
*/
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Query params for PATCH /manifests (btrz-api-operations). See patch-manifest getSpec().
|
|
42
|
+
* @typedef {Object} ManifestPatchQuery
|
|
43
|
+
* @property {string} providerId - Provider ID (required)
|
|
44
|
+
* @property {string} [routeId] - Route ID for update_schedule
|
|
45
|
+
* @property {string} [scheduleId] - New schedule ID for update_schedule
|
|
46
|
+
* @property {string} [oldScheduleId] - Old schedule ID for update_schedule
|
|
47
|
+
* @property {string} [accommodateOnAnySeat] - "true" to assign missing seats to any available
|
|
48
|
+
* @property {string} [newdesign] - "true" when using new seatmap design
|
|
49
|
+
*/
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Query params for GET /outlook-manifests (btrz-api-operations). See get-outlook-manifests getSpec().
|
|
53
|
+
* @typedef {Object} OutlookManifestsListQuery
|
|
54
|
+
* @property {string} providerId - Provider ID (required)
|
|
55
|
+
* @property {string} productId - Product ID (required)
|
|
56
|
+
* @property {string} from - Start date (required, yyyy-mm-dd)
|
|
57
|
+
* @property {string} to - End date (required, yyyy-mm-dd, max 1 month range)
|
|
58
|
+
* @property {string} [scheduleName] - Schedule name filter
|
|
59
|
+
* @property {string} [loadFactorFrom] - Min load factor
|
|
60
|
+
* @property {string} [loadFactorTo] - Max load factor
|
|
61
|
+
* @property {string} [timeFrom] - Min time filter
|
|
62
|
+
* @property {string} [timeTo] - Max time filter
|
|
63
|
+
* @property {string} [originId] - Origin station id
|
|
64
|
+
* @property {string} [destinationId] - Destination station id
|
|
65
|
+
* @property {string} [amenityGroupId] - Amenity group id
|
|
66
|
+
* @property {string} [userId] - Only manifests with this user assigned
|
|
67
|
+
* @property {string} [withAssignedUsers] - Filter by assigned users (true/false)
|
|
68
|
+
* @property {string} [status] - Comma-separated statuses (published, paused, planned, canceled)
|
|
69
|
+
* @property {boolean} [isExtraRun] - Only extra run trips
|
|
70
|
+
* @property {boolean} [minimalPayload] - Minimal data for five day outlook
|
|
71
|
+
* @property {string} [labelId] - Label id filter
|
|
72
|
+
* @property {boolean} [dispatched] - Only dispatched manifests
|
|
73
|
+
*/
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Query params for PUT /manifests/:manifestKey/driver-relays (btrz-api-operations). See put-driver-relays-handler getSpec().
|
|
77
|
+
* @typedef {Object} ManifestDriverRelaysQuery
|
|
78
|
+
* @property {boolean} [bypassValidations] - If true, bypass driver validations
|
|
12
79
|
*/
|
|
13
80
|
|
|
14
81
|
/**
|
|
@@ -73,14 +140,13 @@ function manifestFactory(_ref) {
|
|
|
73
140
|
}
|
|
74
141
|
|
|
75
142
|
/**
|
|
76
|
-
* POST manifests/:manifestId/dispatches - dispatch manifest.
|
|
143
|
+
* POST manifests/:manifestId/dispatches - dispatch manifest. API does not accept query params.
|
|
77
144
|
* @param {Object} opts
|
|
78
145
|
* @param {string} [opts.token] - API key
|
|
79
146
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
80
147
|
* @param {Object} [opts.headers] - Optional headers
|
|
81
148
|
* @param {string} opts.manifestId - Manifest id
|
|
82
149
|
* @param {Object} opts.data - Request body
|
|
83
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
84
150
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
85
151
|
*/
|
|
86
152
|
function dispatch(_ref4) {
|
|
@@ -105,7 +171,7 @@ function manifestFactory(_ref) {
|
|
|
105
171
|
* @param {Object} opts
|
|
106
172
|
* @param {string} [opts.token] - API key
|
|
107
173
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
108
|
-
* @param {
|
|
174
|
+
* @param {ManifestsListQuery} [opts.query] - Query params (all optional)
|
|
109
175
|
* @param {Object} [opts.headers] - Optional headers
|
|
110
176
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
111
177
|
*/
|
|
@@ -125,12 +191,11 @@ function manifestFactory(_ref) {
|
|
|
125
191
|
}
|
|
126
192
|
|
|
127
193
|
/**
|
|
128
|
-
* GET /manifests/:manifestId - get manifest by id.
|
|
194
|
+
* GET /manifests/:manifestId - get manifest by id. API does not accept query params.
|
|
129
195
|
* @param {Object} opts
|
|
130
196
|
* @param {string} [opts.token] - API key
|
|
131
197
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
132
198
|
* @param {string} opts.manifestId - Manifest id
|
|
133
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
134
199
|
* @param {Object} [opts.headers] - Optional headers
|
|
135
200
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
136
201
|
*/
|
|
@@ -207,7 +272,7 @@ function manifestFactory(_ref) {
|
|
|
207
272
|
* @param {Object} opts
|
|
208
273
|
* @param {string} [opts.token] - API key
|
|
209
274
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
210
|
-
* @param {
|
|
275
|
+
* @param {OutlookManifestsListQuery} [opts.query] - Query params (providerId, productId, from, to required)
|
|
211
276
|
* @param {Object} [opts.headers] - Optional headers
|
|
212
277
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
213
278
|
*/
|
|
@@ -233,7 +298,7 @@ function manifestFactory(_ref) {
|
|
|
233
298
|
* @param {Object} opts
|
|
234
299
|
* @param {string} [opts.token] - API key
|
|
235
300
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
236
|
-
* @param {
|
|
301
|
+
* @param {ManifestPatchQuery} [opts.query] - Query params (providerId required)
|
|
237
302
|
* @param {Object} opts.operations - JSON Patch operations
|
|
238
303
|
* @param {Object} [opts.headers] - Optional headers
|
|
239
304
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
@@ -262,10 +327,10 @@ function manifestFactory(_ref) {
|
|
|
262
327
|
* @param {Object} opts
|
|
263
328
|
* @param {string} [opts.token] - API key
|
|
264
329
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
265
|
-
* @param {string} [opts.providerId] - Provider id
|
|
330
|
+
* @param {string} [opts.providerId] - Provider id (required by API as query)
|
|
266
331
|
* @param {Object} opts.data - Request body
|
|
267
332
|
* @param {Object} [opts.headers] - Optional headers
|
|
268
|
-
* @param {
|
|
333
|
+
* @param {ManifestSaveQuery} [opts.query] - Query params (providerId required; manifestId, bypassBusValidation optional)
|
|
269
334
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
270
335
|
*/
|
|
271
336
|
function save(_ref11) {
|
|
@@ -292,8 +357,7 @@ function manifestFactory(_ref) {
|
|
|
292
357
|
* @param {string} [opts.token] - API key
|
|
293
358
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
294
359
|
* @param {string} opts.manifestId - Manifest id
|
|
295
|
-
|
|
296
|
-
* @param {Object} opts.data - Request body
|
|
360
|
+
* @param {Object} opts.data - Request body
|
|
297
361
|
* @param {Object} [opts.headers] - Optional headers
|
|
298
362
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
299
363
|
*/
|
|
@@ -349,8 +413,7 @@ function manifestFactory(_ref) {
|
|
|
349
413
|
* @param {string} [opts.token] - API key
|
|
350
414
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
351
415
|
* @param {string} opts.manifestId - Manifest id
|
|
352
|
-
|
|
353
|
-
* @param {Object} opts.data - Request body
|
|
416
|
+
* @param {Object} opts.data - Request body
|
|
354
417
|
* @param {Object} [opts.headers] - Optional headers
|
|
355
418
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
356
419
|
*/
|
|
@@ -406,8 +469,7 @@ function manifestFactory(_ref) {
|
|
|
406
469
|
* @param {string} [opts.token] - API key
|
|
407
470
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
408
471
|
* @param {string} opts.manifestId - Manifest id
|
|
409
|
-
|
|
410
|
-
* @param {Object} opts.data - Request body
|
|
472
|
+
* @param {Object} opts.data - Request body
|
|
411
473
|
* @param {Object} [opts.headers] - Optional headers
|
|
412
474
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
413
475
|
*/
|
|
@@ -437,8 +499,7 @@ function manifestFactory(_ref) {
|
|
|
437
499
|
* @param {string} [opts.token] - API key
|
|
438
500
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
439
501
|
* @param {string} opts.manifestId - Manifest id
|
|
440
|
-
|
|
441
|
-
* @param {Object} opts.data - Request body
|
|
502
|
+
* @param {Object} opts.data - Request body
|
|
442
503
|
* @param {Object} [opts.headers] - Optional headers
|
|
443
504
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
444
505
|
*/
|
|
@@ -468,7 +529,6 @@ function manifestFactory(_ref) {
|
|
|
468
529
|
* @param {string} [opts.token] - API key
|
|
469
530
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
470
531
|
* @param {string} opts.manifestKey - Manifest key
|
|
471
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
472
532
|
* @param {Object} [opts.headers] - Optional headers
|
|
473
533
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
474
534
|
*/
|
|
@@ -497,7 +557,6 @@ function manifestFactory(_ref) {
|
|
|
497
557
|
* @param {Object} opts
|
|
498
558
|
* @param {string} [opts.token] - API key
|
|
499
559
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
500
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
501
560
|
* @param {Object} [opts.headers] - Optional headers
|
|
502
561
|
* @param {Object} opts.data - Request body
|
|
503
562
|
* @param {string} opts.manifestId - Manifest id
|
|
@@ -530,7 +589,6 @@ function manifestFactory(_ref) {
|
|
|
530
589
|
* @param {Object} opts
|
|
531
590
|
* @param {string} [opts.token] - API key
|
|
532
591
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
533
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
534
592
|
* @param {Object} [opts.headers] - Optional headers
|
|
535
593
|
* @param {string} opts.manifestId - Manifest id
|
|
536
594
|
* @param {string} opts.legFromId - Leg from id
|
|
@@ -565,7 +623,6 @@ function manifestFactory(_ref) {
|
|
|
565
623
|
* @param {Object} opts
|
|
566
624
|
* @param {string} [opts.token] - API key
|
|
567
625
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
568
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
569
626
|
* @param {Object} [opts.headers] - Optional headers
|
|
570
627
|
* @param {string} opts.manifestId - Manifest id
|
|
571
628
|
* @param {string} opts.legFromId - Leg from id
|
|
@@ -604,7 +661,6 @@ function manifestFactory(_ref) {
|
|
|
604
661
|
* @param {string} [opts.token] - API key
|
|
605
662
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
606
663
|
* @param {Object} opts.data - Request body
|
|
607
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
608
664
|
* @param {Object} [opts.headers] - Optional headers
|
|
609
665
|
* @param {string} opts.manifestId - Manifest id
|
|
610
666
|
* @param {string} opts.legFromId - Leg from id
|
|
@@ -636,8 +692,7 @@ function manifestFactory(_ref) {
|
|
|
636
692
|
* @param {string} [opts.token] - API key
|
|
637
693
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
638
694
|
* @param {Object} opts.data - Request body
|
|
639
|
-
|
|
640
|
-
* @param {Object} [opts.headers] - Optional headers
|
|
695
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
641
696
|
* @param {string} opts.manifestId - Manifest id
|
|
642
697
|
* @param {string} opts.legFromId - Leg from id
|
|
643
698
|
* @param {string} opts.ticketId - Ticket id
|
|
@@ -668,8 +723,7 @@ function manifestFactory(_ref) {
|
|
|
668
723
|
* @param {Object} opts
|
|
669
724
|
* @param {string} [opts.token] - API key
|
|
670
725
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
671
|
-
|
|
672
|
-
* @param {Object} [opts.headers] - Optional headers
|
|
726
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
673
727
|
* @param {string} opts.manifestId - Manifest id
|
|
674
728
|
* @param {string} opts.legFromId - Leg from id
|
|
675
729
|
* @param {string} opts.ticketId - Ticket id
|
|
@@ -701,7 +755,6 @@ function manifestFactory(_ref) {
|
|
|
701
755
|
* @param {Object} opts
|
|
702
756
|
* @param {string} [opts.token] - API key
|
|
703
757
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
704
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
705
758
|
* @param {string} [opts.responseType] - Response type (e.g. "json")
|
|
706
759
|
* @param {string} opts.id - Manifest id
|
|
707
760
|
* @param {Object} [opts.headers] - Optional headers
|
|
@@ -734,7 +787,6 @@ function manifestFactory(_ref) {
|
|
|
734
787
|
* @param {string} [opts.token] - API key
|
|
735
788
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
736
789
|
* @param {string} opts.manifestId - Manifest id
|
|
737
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
738
790
|
* @param {Object} [opts.headers] - Optional headers
|
|
739
791
|
* @param {Object} opts.data - Request body
|
|
740
792
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
@@ -789,7 +841,6 @@ function manifestFactory(_ref) {
|
|
|
789
841
|
* @param {string} [opts.token] - API key
|
|
790
842
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
791
843
|
* @param {string} opts.manifestId - Manifest id
|
|
792
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
793
844
|
* @param {Object} [opts.headers] - Optional headers
|
|
794
845
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
795
846
|
*/
|
|
@@ -817,7 +868,7 @@ function manifestFactory(_ref) {
|
|
|
817
868
|
* @param {string} [opts.token] - API key
|
|
818
869
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
819
870
|
* @param {string} opts.manifestId - Manifest id
|
|
820
|
-
* @param {
|
|
871
|
+
* @param {ManifestDriverRelaysQuery} [opts.query] - Query params (bypassValidations optional)
|
|
821
872
|
* @param {Object} [opts.headers] - Optional headers
|
|
822
873
|
* @param {Object} opts.data - Request body
|
|
823
874
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
@@ -850,7 +901,6 @@ function manifestFactory(_ref) {
|
|
|
850
901
|
* @param {string} opts.manifestKey - Manifest key
|
|
851
902
|
* @param {Object} opts.manifestException - Manifest exception payload
|
|
852
903
|
* @param {Object} [opts.headers] - Optional headers
|
|
853
|
-
* @param {ManifestQuery} [opts.query] - Query params
|
|
854
904
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
855
905
|
*/
|
|
856
906
|
update: function update(_ref30) {
|
|
@@ -17,12 +17,11 @@ function manifestLegForTicketsFactory(_ref) {
|
|
|
17
17
|
internalAuthTokenProvider = _ref.internalAuthTokenProvider;
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
|
-
* GET /manifest-leg-for-tickets/:ticketId - get manifest leg for ticket.
|
|
20
|
+
* GET /manifest-leg-for-tickets/:ticketId - get manifest leg for ticket. API does not accept query params.
|
|
21
21
|
* @param {Object} opts
|
|
22
22
|
* @param {string} [opts.token] - API key
|
|
23
23
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
24
24
|
* @param {string} opts.ticketId - Ticket id
|
|
25
|
-
* @param {Object} [opts.params] - Query params (forwarded to API)
|
|
26
25
|
* @param {Object} [opts.headers] - Optional headers
|
|
27
26
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
28
27
|
*/
|
|
@@ -3,11 +3,6 @@
|
|
|
3
3
|
var _require = require("./../endpoints_helpers.js"),
|
|
4
4
|
authorizationHeaders = _require.authorizationHeaders;
|
|
5
5
|
|
|
6
|
-
/**
|
|
7
|
-
* @typedef {Object} MovementsQuery
|
|
8
|
-
* @property {string} [providerId] - Provider account ID
|
|
9
|
-
*/
|
|
10
|
-
|
|
11
6
|
/**
|
|
12
7
|
* Factory for movements API (btrz-api-operations).
|
|
13
8
|
* @param {Object} deps
|
|
@@ -22,12 +17,11 @@ function movementsFactory(_ref) {
|
|
|
22
17
|
internalAuthTokenProvider = _ref.internalAuthTokenProvider;
|
|
23
18
|
|
|
24
19
|
/**
|
|
25
|
-
* POST /movements - create movement.
|
|
20
|
+
* POST /movements - create movement. API does not accept query params.
|
|
26
21
|
* @param {Object} opts
|
|
27
22
|
* @param {string} [opts.token] - API key
|
|
28
23
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
29
24
|
* @param {Object} opts.movement - Movement payload
|
|
30
|
-
* @param {MovementsQuery} [opts.query] - Query params
|
|
31
25
|
* @param {Object} [opts.headers] - Optional headers
|
|
32
26
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
33
27
|
*/
|
|
@@ -4,8 +4,18 @@ var _require = require("./../endpoints_helpers.js"),
|
|
|
4
4
|
authorizationHeaders = _require.authorizationHeaders;
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
8
|
-
* @
|
|
7
|
+
* Query params for GET /outlook-trips (btrz-api-operations). See get-outlook-trips getSpec().
|
|
8
|
+
* @typedef {Object} OutlookTripsListQuery
|
|
9
|
+
* @property {string} from - Travel start date (required, date format)
|
|
10
|
+
* @property {string} to - Travel end date (required, date format)
|
|
11
|
+
* @property {string} [fromTime] - Cutoff time for first date (HH:MM)
|
|
12
|
+
* @property {string} [toTime] - Cutoff time for last date (HH:MM)
|
|
13
|
+
* @property {string} productId - Product ID (required)
|
|
14
|
+
* @property {string} [originId] - Origin (departure) station ID
|
|
15
|
+
* @property {string} [destinationId] - Destination station ID
|
|
16
|
+
* @property {string} [routeId] - Route ID
|
|
17
|
+
* @property {string} [scheduleId] - Schedule ID
|
|
18
|
+
* @property {boolean} [isExtraRun] - Only trips marked as extra run
|
|
9
19
|
*/
|
|
10
20
|
|
|
11
21
|
/**
|
|
@@ -26,7 +36,7 @@ function outlookTripsFactory(_ref) {
|
|
|
26
36
|
* @param {Object} opts
|
|
27
37
|
* @param {string} [opts.token] - API key
|
|
28
38
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
29
|
-
* @param {
|
|
39
|
+
* @param {OutlookTripsListQuery} [opts.query] - Query params (from, to, productId required)
|
|
30
40
|
* @param {Object} [opts.headers] - Optional headers
|
|
31
41
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
32
42
|
*/
|