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
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
+
* Query params for GET /bundles (btrz-api-inventory). See get-bundles getSpec().
|
|
4
5
|
* @typedef {Object} InventoryBundlesQuery
|
|
5
6
|
* @property {string} [providerId] - Provider account ID
|
|
7
|
+
* @property {string} [type] - Bundle type filter
|
|
8
|
+
* @property {string} [disabled] - Filter by disabled status
|
|
6
9
|
*/
|
|
7
10
|
|
|
8
11
|
/**
|
|
@@ -18,7 +21,7 @@ function bundlesFactory({client, internalAuthTokenProvider}) {
|
|
|
18
21
|
* @param {Object} opts
|
|
19
22
|
* @param {string} [opts.token] - API key
|
|
20
23
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
21
|
-
* @param {InventoryBundlesQuery} [opts.query] - Query params
|
|
24
|
+
* @param {InventoryBundlesQuery} [opts.query] - Query params (providerId, type, disabled)
|
|
22
25
|
* @param {Object} [opts.headers] - Optional headers
|
|
23
26
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
24
27
|
*/
|
|
@@ -31,7 +34,7 @@ function bundlesFactory({client, internalAuthTokenProvider}) {
|
|
|
31
34
|
}
|
|
32
35
|
|
|
33
36
|
/**
|
|
34
|
-
* GET /bundles/:bundleId - get bundle by id.
|
|
37
|
+
* GET /bundles/:bundleId - get bundle by id. API does not accept query params.
|
|
35
38
|
* @param {Object} opts
|
|
36
39
|
* @param {string} [opts.token] - API key
|
|
37
40
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* Query params for GET /change-requests (btrz-api-inventory). See get-change-requests getSpec().
|
|
5
|
+
* @typedef {Object} ChangeRequestsListQuery
|
|
6
|
+
* @property {string} [type] - Filter by change request type
|
|
7
|
+
* @property {string} [status] - Filter by status
|
|
8
|
+
* @property {string} [createdBy] - Filter by user id
|
|
9
|
+
* @property {string} [from] - Filter by creation date from (YYYY-MM-DD)
|
|
10
|
+
* @property {string} [to] - Filter by creation date to (YYYY-MM-DD)
|
|
11
|
+
* @property {string} [operationId] - Filter by operation ID
|
|
12
|
+
* @property {string} [operationType] - Filter by operation type
|
|
13
|
+
* @property {number} [page] - Page number
|
|
14
|
+
* @property {string} [orderBy] - Field to order by
|
|
15
|
+
* @property {string} [orderDir] - asc (1) or desc (-1)
|
|
16
|
+
* @property {number} [pageSize] - Results per page
|
|
17
|
+
*/
|
|
18
|
+
|
|
3
19
|
/**
|
|
4
20
|
* Factory for change-requests API (btrz-api-inventory).
|
|
5
21
|
* @param {Object} deps
|
|
@@ -13,7 +29,7 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
|
|
|
13
29
|
* @param {Object} opts
|
|
14
30
|
* @param {string} [opts.token] - API key
|
|
15
31
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
16
|
-
* @param {
|
|
32
|
+
* @param {ChangeRequestsListQuery} [opts.query] - Query params
|
|
17
33
|
* @param {Object} [opts.headers] - Optional headers
|
|
18
34
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
19
35
|
*/
|
|
@@ -25,12 +41,11 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
|
|
|
25
41
|
}
|
|
26
42
|
|
|
27
43
|
/**
|
|
28
|
-
* GET /change-requests/:changerequestId/manifests - get change request manifests.
|
|
44
|
+
* GET /change-requests/:changerequestId/manifests - get change request manifests. API does not accept query params.
|
|
29
45
|
* @param {Object} opts
|
|
30
46
|
* @param {string} [opts.token] - API key
|
|
31
47
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
32
48
|
* @param {string} opts.changerequestId - Change request id
|
|
33
|
-
* @param {Object} [opts.query] - Query params
|
|
34
49
|
* @param {Object} [opts.headers] - Optional headers
|
|
35
50
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
36
51
|
*/
|
|
@@ -43,7 +58,7 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
|
|
|
43
58
|
}
|
|
44
59
|
|
|
45
60
|
/**
|
|
46
|
-
* POST /change-requests/manifests - create change request manifest.
|
|
61
|
+
* POST /change-requests/manifests - create change request manifest. API does not accept query params.
|
|
47
62
|
* @param {Object} opts
|
|
48
63
|
* @param {string} [opts.token] - API key
|
|
49
64
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -61,7 +76,7 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
|
|
|
61
76
|
}
|
|
62
77
|
|
|
63
78
|
/**
|
|
64
|
-
* PUT /change-requests/:changerequestId/manifests - update change request manifest.
|
|
79
|
+
* PUT /change-requests/:changerequestId/manifests - update change request manifest. API does not accept query params.
|
|
65
80
|
* @param {Object} opts
|
|
66
81
|
* @param {string} [opts.token] - API key
|
|
67
82
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -82,12 +97,11 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
|
|
|
82
97
|
/** @type {{ get: function, create: function, update: function }} */
|
|
83
98
|
const schedules = {
|
|
84
99
|
/**
|
|
85
|
-
* GET /change-requests/:changeRequestId/schedules - get change request schedules.
|
|
100
|
+
* GET /change-requests/:changeRequestId/schedules - get change request schedules. API does not accept query params.
|
|
86
101
|
* @param {Object} opts
|
|
87
102
|
* @param {string} [opts.token] - API key
|
|
88
103
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
89
104
|
* @param {string} opts.changeRequestId - Change request id
|
|
90
|
-
* @param {Object} [opts.query] - Query params
|
|
91
105
|
* @param {Object} [opts.headers] - Optional headers
|
|
92
106
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
93
107
|
*/
|
|
@@ -100,7 +114,7 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
|
|
|
100
114
|
},
|
|
101
115
|
|
|
102
116
|
/**
|
|
103
|
-
* POST /change-requests/schedules - create change request schedule.
|
|
117
|
+
* POST /change-requests/schedules - create change request schedule. API does not accept query params.
|
|
104
118
|
* @param {Object} opts
|
|
105
119
|
* @param {string} [opts.token] - API key
|
|
106
120
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -118,7 +132,7 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
|
|
|
118
132
|
},
|
|
119
133
|
|
|
120
134
|
/**
|
|
121
|
-
* PUT /change-requests/:changeRequestId/schedules - update change request schedule.
|
|
135
|
+
* PUT /change-requests/:changeRequestId/schedules - update change request schedule. API does not accept query params.
|
|
122
136
|
* @param {Object} opts
|
|
123
137
|
* @param {string} [opts.token] - API key
|
|
124
138
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* Query params for companies
|
|
4
|
+
* Query params for GET /companies (btrz-api-inventory). See get-companies getSpec().
|
|
5
5
|
* @typedef {Object} InventoryCompaniesQuery
|
|
6
|
+
* @property {string} [search] - Term to find companies (required by API for getBySearch)
|
|
7
|
+
* @property {string} [disabled] - Filter by disabled [true, false]
|
|
8
|
+
* @property {string} [providerId] - Get items from the provider
|
|
6
9
|
*/
|
|
7
10
|
|
|
8
11
|
/**
|
|
@@ -18,7 +21,7 @@ function companiesFactory({client, internalAuthTokenProvider}) {
|
|
|
18
21
|
* @param {Object} opts
|
|
19
22
|
* @param {string} [opts.token] - API key
|
|
20
23
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
21
|
-
* @param {InventoryCompaniesQuery} [opts.query] -
|
|
24
|
+
* @param {InventoryCompaniesQuery} [opts.query] - Query params (search, disabled, providerId)
|
|
22
25
|
* @param {Object} [opts.headers] - Optional headers
|
|
23
26
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
24
27
|
*/
|
|
@@ -2,6 +2,36 @@ const {
|
|
|
2
2
|
authorizationHeaders
|
|
3
3
|
} = require("./../endpoints_helpers.js");
|
|
4
4
|
|
|
5
|
+
/**
|
|
6
|
+
* Query params for GET /control-classes (btrz-api-inventory). See get-control-classes getSpec().
|
|
7
|
+
* @typedef {Object} ControlClassesListQuery
|
|
8
|
+
* @property {number} [page] - Page number
|
|
9
|
+
* @property {boolean} [root] - Filter roots only
|
|
10
|
+
* @property {string} [productId] - Filter by product ID
|
|
11
|
+
* @property {string} [name] - Filter by name
|
|
12
|
+
* @property {string} [scheduleId] - Only roots that could apply to this schedule (UUID)
|
|
13
|
+
* @property {string} [assignedScheduleId] - Only roots assigned to this schedule (UUID)
|
|
14
|
+
* @property {string} [amenityGroupId] - Filter by amenity group ID(s), comma-separated
|
|
15
|
+
* @property {string} [brandId] - Filter by brand ID(s), comma-separated
|
|
16
|
+
* @property {string} [fareId] - Filter by fare ID(s), comma-separated
|
|
17
|
+
* @property {string} [fareClassId] - Filter by fare class ID(s), comma-separated
|
|
18
|
+
* @property {string} [seatClassId] - Filter by seat class ID(s), comma-separated
|
|
19
|
+
* @property {string} [operatingCompanyId] - Filter by operating company ID(s), comma-separated
|
|
20
|
+
* @property {string} [channel] - Filter by channel(s), comma-separated
|
|
21
|
+
* @property {number} [advancePurchaseFrom] - Filter by advance purchase from (hours)
|
|
22
|
+
* @property {number} [advancePurchaseTo] - Filter by advance purchase to (hours)
|
|
23
|
+
*/
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Query params for GET /control-classes/:controlClassId (btrz-api-inventory). See get-control-class-by-id getSpec().
|
|
27
|
+
* @typedef {Object} ControlClassGetQuery
|
|
28
|
+
* @property {boolean} [tree] - Include the full tree
|
|
29
|
+
* @property {string} [scheduleId] - When tree requested, filter by schedule
|
|
30
|
+
* @property {string} [scheduleBrandId] - When tree requested, filter by schedule brand
|
|
31
|
+
* @property {string} [scheduleOperatingCompanyId] - When tree requested, filter by operating company
|
|
32
|
+
* @property {string} [scheduleAmenityGroupId] - When tree requested, filter by amenity group
|
|
33
|
+
*/
|
|
34
|
+
|
|
5
35
|
/**
|
|
6
36
|
* Factory for control-classes API (btrz-api-inventory).
|
|
7
37
|
* @param {Object} deps
|
|
@@ -15,7 +45,7 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
|
|
|
15
45
|
* @param {Object} opts
|
|
16
46
|
* @param {string} [opts.token] - API key
|
|
17
47
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
18
|
-
* @param {
|
|
48
|
+
* @param {ControlClassesListQuery} [opts.query] - Query params
|
|
19
49
|
* @param {Object} [opts.headers] - Optional headers
|
|
20
50
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
21
51
|
*/
|
|
@@ -37,7 +67,7 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
|
|
|
37
67
|
* @param {string} [opts.token] - API key
|
|
38
68
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
39
69
|
* @param {string} opts.controlClassId - Control class id
|
|
40
|
-
* @param {
|
|
70
|
+
* @param {ControlClassGetQuery} [opts.query] - Query params (tree, scheduleId, etc.)
|
|
41
71
|
* @param {Object} [opts.headers] - Optional headers
|
|
42
72
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
43
73
|
*/
|
|
@@ -49,7 +79,7 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
|
|
|
49
79
|
}
|
|
50
80
|
|
|
51
81
|
/**
|
|
52
|
-
* POST /control-classes - create control class.
|
|
82
|
+
* POST /control-classes - create control class. API does not accept query params.
|
|
53
83
|
* @param {Object} opts
|
|
54
84
|
* @param {string} [opts.token] - API key
|
|
55
85
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -86,7 +116,7 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
|
|
|
86
116
|
}
|
|
87
117
|
|
|
88
118
|
/**
|
|
89
|
-
* PUT /control-classes/:controlClassId - update control class.
|
|
119
|
+
* PUT /control-classes/:controlClassId - update control class. API does not accept query params.
|
|
90
120
|
* @param {Object} opts
|
|
91
121
|
* @param {string} [opts.token] - API key
|
|
92
122
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* Query params for GET /countries (btrz-api-inventory). See get-countries getSpec().
|
|
5
|
+
* @typedef {Object} CountriesListQuery
|
|
6
|
+
* @property {string} [isoCode] - Country 2 or 3 letter ISO code
|
|
7
|
+
*/
|
|
8
|
+
|
|
3
9
|
/**
|
|
4
10
|
* Factory for countries API (btrz-api-inventory).
|
|
5
11
|
* @param {Object} deps
|
|
@@ -13,7 +19,7 @@ function countriesFactory({client, internalAuthTokenProvider}) {
|
|
|
13
19
|
* @param {Object} opts
|
|
14
20
|
* @param {string} [opts.token] - API key
|
|
15
21
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
16
|
-
* @param {
|
|
22
|
+
* @param {CountriesListQuery} [opts.query] - Query params (isoCode)
|
|
17
23
|
* @param {Object} [opts.headers] - Optional headers
|
|
18
24
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
19
25
|
*/
|
|
@@ -26,12 +32,11 @@ function countriesFactory({client, internalAuthTokenProvider}) {
|
|
|
26
32
|
}
|
|
27
33
|
|
|
28
34
|
/**
|
|
29
|
-
* GET /countries/:id - get country by id.
|
|
35
|
+
* GET /countries/:id - get country by id. API does not accept query params.
|
|
30
36
|
* @param {Object} opts
|
|
31
37
|
* @param {string} [opts.token] - API key
|
|
32
38
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
33
39
|
* @param {string} opts.id - Country id
|
|
34
|
-
* @param {Object} [opts.query] - Query params
|
|
35
40
|
* @param {Object} [opts.headers] - Optional headers
|
|
36
41
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
37
42
|
*/
|
|
@@ -3,8 +3,10 @@ const {
|
|
|
3
3
|
} = require("./../endpoints_helpers.js");
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
* Query params for custom-content
|
|
6
|
+
* Query params for GET /custom-content (btrz-api-inventory). See get-custom-contents getSpec().
|
|
7
7
|
* @typedef {Object} InventoryCustomContentQuery
|
|
8
|
+
* @property {string} [enabled] - Filter by enabled (true, false)
|
|
9
|
+
* @property {string} [pageId] - The page for the content
|
|
8
10
|
*/
|
|
9
11
|
|
|
10
12
|
/**
|
|
@@ -20,7 +22,7 @@ function customContentFactory({client, internalAuthTokenProvider}) {
|
|
|
20
22
|
* @param {Object} opts
|
|
21
23
|
* @param {string} [opts.token] - API key
|
|
22
24
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
23
|
-
* @param {InventoryCustomContentQuery} [opts.query] -
|
|
25
|
+
* @param {InventoryCustomContentQuery} [opts.query] - Query params (enabled, pageId)
|
|
24
26
|
* @param {Object} [opts.headers] - Optional headers
|
|
25
27
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
26
28
|
*/
|
|
@@ -36,7 +38,7 @@ function customContentFactory({client, internalAuthTokenProvider}) {
|
|
|
36
38
|
}
|
|
37
39
|
|
|
38
40
|
/**
|
|
39
|
-
* GET /custom-content/:customContentId - get custom content by id.
|
|
41
|
+
* GET /custom-content/:customContentId - get custom content by id. API does not accept query params.
|
|
40
42
|
* @param {Object} opts
|
|
41
43
|
* @param {string} [opts.token] - API key
|
|
42
44
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -51,7 +53,7 @@ function customContentFactory({client, internalAuthTokenProvider}) {
|
|
|
51
53
|
}
|
|
52
54
|
|
|
53
55
|
/**
|
|
54
|
-
* POST /custom-content - create custom content.
|
|
56
|
+
* POST /custom-content - create custom content. API does not accept query params.
|
|
55
57
|
* @param {Object} opts
|
|
56
58
|
* @param {string} [opts.token] - API key
|
|
57
59
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -71,7 +73,7 @@ function customContentFactory({client, internalAuthTokenProvider}) {
|
|
|
71
73
|
}
|
|
72
74
|
|
|
73
75
|
/**
|
|
74
|
-
* DELETE /custom-content/:customContentId - remove custom content.
|
|
76
|
+
* DELETE /custom-content/:customContentId - remove custom content. API does not accept query params.
|
|
75
77
|
* @param {Object} opts
|
|
76
78
|
* @param {string} [opts.token] - API key
|
|
77
79
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -88,7 +90,7 @@ function customContentFactory({client, internalAuthTokenProvider}) {
|
|
|
88
90
|
}
|
|
89
91
|
|
|
90
92
|
/**
|
|
91
|
-
* PUT /custom-content/:customContentId - update custom content.
|
|
93
|
+
* PUT /custom-content/:customContentId - update custom content. API does not accept query params.
|
|
92
94
|
* @param {Object} opts
|
|
93
95
|
* @param {string} [opts.token] - API key
|
|
94
96
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* Query params for custom-fields
|
|
4
|
+
* Query params for GET /custom-fields (btrz-api-inventory). See get-custom-fields getSpec().
|
|
5
5
|
* @typedef {Object} InventoryCustomFieldsQuery
|
|
6
|
+
* @property {string} [enabled] - Required value of the disabled field
|
|
7
|
+
* @property {string} [required] - Required value of the required field
|
|
8
|
+
* @property {string} [modelName] - Filter by model (Transactions, Stations)
|
|
6
9
|
*/
|
|
7
10
|
|
|
8
11
|
/**
|
|
@@ -18,7 +21,7 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
|
|
|
18
21
|
* @param {Object} opts
|
|
19
22
|
* @param {string} [opts.token] - API key
|
|
20
23
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
21
|
-
* @param {InventoryCustomFieldsQuery} [opts.query] -
|
|
24
|
+
* @param {InventoryCustomFieldsQuery} [opts.query] - Query params (enabled, required, modelName)
|
|
22
25
|
* @param {Object} [opts.headers] - Optional headers
|
|
23
26
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
24
27
|
*/
|
|
@@ -31,12 +34,11 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
|
|
|
31
34
|
}
|
|
32
35
|
|
|
33
36
|
/**
|
|
34
|
-
* GET /custom-fields/:fieldId - get custom field by id.
|
|
37
|
+
* GET /custom-fields/:fieldId - get custom field by id. API does not accept query params.
|
|
35
38
|
* @param {Object} opts
|
|
36
39
|
* @param {string} [opts.token] - API key
|
|
37
40
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
38
41
|
* @param {string} opts.fieldId - Field id
|
|
39
|
-
* @param {InventoryCustomFieldsQuery} [opts.query] - Optional query params (forwarded to API)
|
|
40
42
|
* @param {Object} [opts.headers] - Optional headers
|
|
41
43
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
42
44
|
*/
|
|
@@ -49,7 +51,7 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
|
|
|
49
51
|
}
|
|
50
52
|
|
|
51
53
|
/**
|
|
52
|
-
* POST /custom-fields - create custom field.
|
|
54
|
+
* POST /custom-fields - create custom field. API does not accept query params.
|
|
53
55
|
* @param {Object} opts
|
|
54
56
|
* @param {string} [opts.token] - API key
|
|
55
57
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -67,7 +69,7 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
|
|
|
67
69
|
}
|
|
68
70
|
|
|
69
71
|
/**
|
|
70
|
-
* PUT /custom-fields/:fieldId - update custom field.
|
|
72
|
+
* PUT /custom-fields/:fieldId - update custom field. API does not accept query params.
|
|
71
73
|
* @param {Object} opts
|
|
72
74
|
* @param {string} [opts.token] - API key
|
|
73
75
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -88,7 +90,7 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
|
|
|
88
90
|
/** @type {{ all: function }} */
|
|
89
91
|
const types = {
|
|
90
92
|
/**
|
|
91
|
-
* GET /custom-fields/types - list custom field types.
|
|
93
|
+
* GET /custom-fields/types - list custom field types. API does not accept query params.
|
|
92
94
|
* @param {Object} opts
|
|
93
95
|
* @param {string} [opts.token] - API key
|
|
94
96
|
* @param {Object} [opts.headers] - Optional headers
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
5
|
-
* @
|
|
4
|
+
* Query params for GET /document-types (btrz-api-inventory). See get-document-types getSpec().
|
|
5
|
+
* @typedef {Object} DocumentTypesListQuery
|
|
6
|
+
* @property {string} [providerIds] - Comma-separated provider IDs to get document types for
|
|
6
7
|
*/
|
|
7
8
|
|
|
8
9
|
/**
|
|
@@ -18,7 +19,7 @@ function documentTypesFactory({client, internalAuthTokenProvider}) {
|
|
|
18
19
|
* @param {Object} opts
|
|
19
20
|
* @param {string} [opts.token] - API key
|
|
20
21
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
21
|
-
* @param {
|
|
22
|
+
* @param {DocumentTypesListQuery} [opts.query] - Query params (providerIds); opts.providerId merged into query if set
|
|
22
23
|
* @param {string} [opts.providerId] - Provider id (added to query if set)
|
|
23
24
|
* @param {Object} [opts.headers] - Optional headers
|
|
24
25
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
@@ -34,12 +35,11 @@ function documentTypesFactory({client, internalAuthTokenProvider}) {
|
|
|
34
35
|
}
|
|
35
36
|
|
|
36
37
|
/**
|
|
37
|
-
* GET /document-types/:id - get document type by id.
|
|
38
|
+
* GET /document-types/:id - get document type by id. API does not accept query params.
|
|
38
39
|
* @param {Object} opts
|
|
39
40
|
* @param {string} [opts.token] - API key
|
|
40
41
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
41
42
|
* @param {string} opts.id - Document type id
|
|
42
|
-
* @param {DocumentTypesQuery} [opts.query] - Query params
|
|
43
43
|
* @param {string} [opts.providerId] - Provider id (added to query if set)
|
|
44
44
|
* @param {Object} [opts.headers] - Optional headers
|
|
45
45
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
@@ -55,13 +55,12 @@ function documentTypesFactory({client, internalAuthTokenProvider}) {
|
|
|
55
55
|
}
|
|
56
56
|
|
|
57
57
|
/**
|
|
58
|
-
* PUT /document-types/:id - update document type.
|
|
58
|
+
* PUT /document-types/:id - update document type. API does not accept query params.
|
|
59
59
|
* @param {Object} opts
|
|
60
60
|
* @param {string} [opts.token] - API key
|
|
61
61
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
62
62
|
* @param {string} opts.id - Document type id
|
|
63
63
|
* @param {Object} opts.data - Document type payload
|
|
64
|
-
* @param {DocumentTypesQuery} [opts.query] - Query params
|
|
65
64
|
* @param {Object} [opts.headers] - Optional headers
|
|
66
65
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
67
66
|
*/
|
|
@@ -76,12 +75,11 @@ function documentTypesFactory({client, internalAuthTokenProvider}) {
|
|
|
76
75
|
}
|
|
77
76
|
|
|
78
77
|
/**
|
|
79
|
-
* DELETE /document-types/:id - remove document type.
|
|
78
|
+
* DELETE /document-types/:id - remove document type. API does not accept query params.
|
|
80
79
|
* @param {Object} opts
|
|
81
80
|
* @param {string} [opts.token] - API key
|
|
82
81
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
83
82
|
* @param {string} opts.id - Document type id
|
|
84
|
-
* @param {DocumentTypesQuery} [opts.query] - Query params
|
|
85
83
|
* @param {Object} [opts.headers] - Optional headers
|
|
86
84
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
87
85
|
*/
|
|
@@ -95,12 +93,11 @@ function documentTypesFactory({client, internalAuthTokenProvider}) {
|
|
|
95
93
|
}
|
|
96
94
|
|
|
97
95
|
/**
|
|
98
|
-
* POST /document-types - create document type.
|
|
96
|
+
* POST /document-types - create document type. API does not accept query params.
|
|
99
97
|
* @param {Object} opts
|
|
100
98
|
* @param {string} [opts.token] - API key
|
|
101
99
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
102
100
|
* @param {Object} opts.data - Document type payload
|
|
103
|
-
* @param {DocumentTypesQuery} [opts.query] - Query params
|
|
104
101
|
* @param {Object} [opts.headers] - Optional headers
|
|
105
102
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
106
103
|
*/
|
|
@@ -3,8 +3,17 @@ const {
|
|
|
3
3
|
} = require("../endpoints_helpers.js");
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
7
|
-
* @
|
|
6
|
+
* Query params for GET /external-passes (btrz-api-inventory). See get-external-passes getSpec().
|
|
7
|
+
* @typedef {Object} ExternalPassesListQuery
|
|
8
|
+
* @property {string} [passNumber] - Filter by pass number
|
|
9
|
+
* @property {string} [accountDisplayName] - Filter by Pay On Account name
|
|
10
|
+
* @property {string} [expirationDateFrom] - Filter by expiration date >= (yyyy-mm-dd)
|
|
11
|
+
* @property {string} [expirationDateTo] - Filter by expiration date <= (yyyy-mm-dd)
|
|
12
|
+
* @property {string} [lastUpdatedAt] - Filter by last updated (ISO format)
|
|
13
|
+
* @property {number} [page] - Page for pagination
|
|
14
|
+
* @property {string} [orderBy] - Field to order by
|
|
15
|
+
* @property {string} [orderDir] - asc (1) or desc (-1)
|
|
16
|
+
* @property {number} [pageSize] - Results per page
|
|
8
17
|
*/
|
|
9
18
|
|
|
10
19
|
/**
|
|
@@ -20,7 +29,7 @@ function externalPassesFactory({client, internalAuthTokenProvider}) {
|
|
|
20
29
|
* @param {Object} opts
|
|
21
30
|
* @param {string} [opts.token] - API key
|
|
22
31
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
23
|
-
* @param {
|
|
32
|
+
* @param {ExternalPassesListQuery} [opts.query] - Query params
|
|
24
33
|
* @param {Object} [opts.headers] - Optional headers
|
|
25
34
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
26
35
|
*/
|
|
@@ -37,7 +46,7 @@ function externalPassesFactory({client, internalAuthTokenProvider}) {
|
|
|
37
46
|
}
|
|
38
47
|
|
|
39
48
|
/**
|
|
40
|
-
* GET /external-passes/:externalPassId - get external pass by id.
|
|
49
|
+
* GET /external-passes/:externalPassId - get external pass by id. API does not accept query params.
|
|
41
50
|
* @param {Object} opts
|
|
42
51
|
* @param {string} [opts.token] - API key
|
|
43
52
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -13,11 +13,10 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
|
|
|
13
13
|
/** @type {{ all: function, create: function, get: function, update: function, movements: object }} */
|
|
14
14
|
const saldoMax = {
|
|
15
15
|
/**
|
|
16
|
-
* GET /external-wallets/saldo-max - list saldo max wallets.
|
|
16
|
+
* GET /external-wallets/saldo-max - list saldo max wallets. API does not accept query params.
|
|
17
17
|
* @param {Object} opts
|
|
18
18
|
* @param {string} [opts.token] - API key
|
|
19
19
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
20
|
-
* @param {Object} [opts.query] - Query params
|
|
21
20
|
* @param {Object} [opts.headers] - Optional headers
|
|
22
21
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
23
22
|
*/
|
|
@@ -28,7 +27,7 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
|
|
|
28
27
|
});
|
|
29
28
|
},
|
|
30
29
|
/**
|
|
31
|
-
* POST /external-wallets/saldo-max - create saldo max wallet.
|
|
30
|
+
* POST /external-wallets/saldo-max - create saldo max wallet. API does not accept query params.
|
|
32
31
|
* @param {Object} opts
|
|
33
32
|
* @param {string} [opts.token] - API key
|
|
34
33
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -45,7 +44,7 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
|
|
|
45
44
|
});
|
|
46
45
|
},
|
|
47
46
|
/**
|
|
48
|
-
* GET /external-wallets/saldo-max/:walletId - get saldo max wallet.
|
|
47
|
+
* GET /external-wallets/saldo-max/:walletId - get saldo max wallet. API does not accept query params.
|
|
49
48
|
* @param {Object} opts
|
|
50
49
|
* @param {string} [opts.token] - API key
|
|
51
50
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -59,7 +58,7 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
|
|
|
59
58
|
});
|
|
60
59
|
},
|
|
61
60
|
/**
|
|
62
|
-
* PUT /external-wallets/saldo-max/:externalWallet._id - update saldo max wallet.
|
|
61
|
+
* PUT /external-wallets/saldo-max/:externalWallet._id - update saldo max wallet. API does not accept query params.
|
|
63
62
|
* @param {Object} opts
|
|
64
63
|
* @param {string} [opts.token] - API key
|
|
65
64
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -86,7 +85,7 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
|
|
|
86
85
|
/** @type {{ create: function }} */
|
|
87
86
|
movements: {
|
|
88
87
|
/**
|
|
89
|
-
* PUT /external-wallets/saldo-max/:walletId/movements - create movement.
|
|
88
|
+
* PUT /external-wallets/saldo-max/:walletId/movements - create movement. API does not accept query params.
|
|
90
89
|
* @param {Object} opts
|
|
91
90
|
* @param {string} [opts.token] - API key
|
|
92
91
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* Query params for GET /fallback-codes (btrz-api-inventory). See get-fallback-codes getSpec().
|
|
5
|
+
* @typedef {Object} FallbackCodesListQuery
|
|
6
|
+
* @property {string} [enabled] - Filter by enabled [true, false]
|
|
7
|
+
* @property {string} [lastUpdatedAt] - Filter by last updated (yyyy-mm-ddTHH:mm:ss.SSSZ)
|
|
8
|
+
*/
|
|
9
|
+
|
|
3
10
|
/**
|
|
4
11
|
* Factory for fallback-codes API (btrz-api-inventory).
|
|
5
12
|
* @param {Object} deps
|
|
@@ -13,7 +20,7 @@ function fallbackCodesFactory({client, internalAuthTokenProvider}) {
|
|
|
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 {
|
|
23
|
+
* @param {FallbackCodesListQuery} [opts.query] - Query params (enabled, lastUpdatedAt)
|
|
17
24
|
* @param {Object} [opts.headers] - Optional headers
|
|
18
25
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
19
26
|
*/
|
|
@@ -25,7 +32,7 @@ function fallbackCodesFactory({client, internalAuthTokenProvider}) {
|
|
|
25
32
|
}
|
|
26
33
|
|
|
27
34
|
/**
|
|
28
|
-
* GET /fallback-code/:id - get fallback code by id.
|
|
35
|
+
* GET /fallback-code/:id - get fallback code by id. API does not accept query params.
|
|
29
36
|
* @param {Object} opts
|
|
30
37
|
* @param {string} [opts.token] - API key
|
|
31
38
|
* @param {string} opts.id - Fallback code id
|
|
@@ -39,7 +46,7 @@ function fallbackCodesFactory({client, internalAuthTokenProvider}) {
|
|
|
39
46
|
}
|
|
40
47
|
|
|
41
48
|
/**
|
|
42
|
-
* POST /fallback-codes - create fallback code.
|
|
49
|
+
* POST /fallback-codes - create fallback code. API does not accept query params.
|
|
43
50
|
* @param {Object} opts
|
|
44
51
|
* @param {string} [opts.token] - API key
|
|
45
52
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -57,7 +64,7 @@ function fallbackCodesFactory({client, internalAuthTokenProvider}) {
|
|
|
57
64
|
}
|
|
58
65
|
|
|
59
66
|
/**
|
|
60
|
-
* PUT /fallback-code/:fallbackCodeId - update fallback code.
|
|
67
|
+
* PUT /fallback-code/:fallbackCodeId - update fallback code. API does not accept query params.
|
|
61
68
|
* @param {Object} opts
|
|
62
69
|
* @param {string} [opts.token] - API key
|
|
63
70
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* Query params for fare-classes
|
|
4
|
+
* Query params for GET /fare-classes (btrz-api-inventory). See get-fare-classes getSpec().
|
|
5
5
|
* @typedef {Object} InventoryFareClassesQuery
|
|
6
|
+
* @property {string} [providerId] - Provider whose fare classes to return
|
|
7
|
+
* @property {string} [productIds] - Comma-separated product IDs to get fare classes for
|
|
6
8
|
*/
|
|
7
9
|
|
|
8
10
|
/**
|
|
@@ -18,7 +20,7 @@ function fareClassesFactory({client, internalAuthTokenProvider}) {
|
|
|
18
20
|
* @param {Object} opts
|
|
19
21
|
* @param {string} [opts.token] - API key
|
|
20
22
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
21
|
-
* @param {InventoryFareClassesQuery} [opts.query] -
|
|
23
|
+
* @param {InventoryFareClassesQuery} [opts.query] - Query params (providerId, productIds)
|
|
22
24
|
* @param {Object} [opts.headers] - Optional headers
|
|
23
25
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
24
26
|
*/
|
|
@@ -31,7 +33,7 @@ function fareClassesFactory({client, internalAuthTokenProvider}) {
|
|
|
31
33
|
}
|
|
32
34
|
|
|
33
35
|
/**
|
|
34
|
-
* POST /fare-classes - create fare class.
|
|
36
|
+
* POST /fare-classes - create fare class. API does not accept query params.
|
|
35
37
|
* @param {Object} opts
|
|
36
38
|
* @param {string} [opts.token] - API key
|
|
37
39
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -49,7 +51,7 @@ function fareClassesFactory({client, internalAuthTokenProvider}) {
|
|
|
49
51
|
}
|
|
50
52
|
|
|
51
53
|
/**
|
|
52
|
-
* PATCH /fare-classes/:fareClassId - update fare class.
|
|
54
|
+
* PATCH /fare-classes/:fareClassId - update fare class. API does not accept query params.
|
|
53
55
|
* @param {Object} opts
|
|
54
56
|
* @param {string} [opts.token] - API key
|
|
55
57
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|