btrz-api-client 8.30.0 → 8.31.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/client-standalone-min.js +1 -1
- package/lib/endpoints/accounts/application-settings.js +6 -1
- package/lib/endpoints/accounts/current-shifts.js +6 -1
- package/lib/endpoints/accounts/customers.js +11 -4
- package/lib/endpoints/accounts/domains.js +1 -2
- package/lib/endpoints/accounts/dynamic-forms.js +17 -5
- package/lib/endpoints/accounts/email-settings.js +2 -4
- package/lib/endpoints/accounts/email-templates.js +10 -2
- package/lib/endpoints/accounts/exchange-rates.js +3 -3
- package/lib/endpoints/accounts/exchange-receipts.js +2 -2
- package/lib/endpoints/accounts/goal-settings.js +2 -3
- package/lib/endpoints/accounts/images.js +2 -4
- package/lib/endpoints/accounts/interline.js +5 -8
- package/lib/endpoints/accounts/journey-prices-settings.js +2 -2
- package/lib/endpoints/accounts/lexicons.js +36 -7
- package/lib/endpoints/accounts/market-pricing-settings.js +2 -2
- package/lib/endpoints/accounts/multiproduct-sales-settings.js +2 -2
- package/lib/endpoints/accounts/network.js +6 -9
- package/lib/endpoints/accounts/operation-settings.js +2 -3
- package/lib/endpoints/accounts/people-lookups.js +27 -9
- package/lib/endpoints/accounts/point-to-point-settings.js +2 -2
- package/lib/endpoints/accounts/print-settings.js +2 -3
- package/lib/endpoints/accounts/print-templates.js +40 -9
- package/lib/endpoints/accounts/printers.js +1 -2
- package/lib/endpoints/accounts/rms-settings.js +2 -2
- package/lib/endpoints/accounts/s3buckets.js +3 -3
- package/lib/endpoints/accounts/salesforce-settings.js +2 -3
- package/lib/endpoints/accounts/shift-settings.js +2 -3
- package/lib/endpoints/accounts/shifts.js +43 -8
- package/lib/endpoints/accounts/sms-templates.js +39 -10
- package/lib/endpoints/accounts/sub-print-templates.js +1 -1
- package/lib/endpoints/accounts/ticket-movement-settings.js +2 -2
- package/lib/endpoints/accounts/tokens.js +10 -3
- package/lib/endpoints/accounts/transport-regulation-settings.js +2 -2
- package/lib/endpoints/accounts/travellers.js +19 -6
- package/lib/endpoints/accounts/trusted-machines.js +11 -3
- package/lib/endpoints/accounts/twilio-settings.js +2 -3
- package/lib/endpoints/accounts/users.js +12 -8
- package/lib/endpoints/accounts/websales-config.js +10 -3
- package/lib/endpoints/btrzpay/cardpointe.js +5 -5
- package/lib/endpoints/btrzpay/customerCards.js +4 -4
- package/lib/endpoints/btrzpay/customers.js +3 -3
- package/lib/endpoints/btrzpay/datalogic.js +8 -9
- package/lib/endpoints/btrzpay/oxxo.js +5 -13
- package/lib/endpoints/btrzpay/payment-methods.js +25 -11
- package/lib/endpoints/btrzpay/payments.js +2 -2
- package/lib/endpoints/btrzpay/prismaTerminals.js +14 -21
- package/lib/endpoints/btrzpay/reference-numbers.js +1 -1
- package/lib/endpoints/btrzpay/referenced-payments.js +11 -1
- package/lib/endpoints/btrzpay/square.js +2 -2
- package/lib/endpoints/btrzpay/stripe-terminals.js +5 -5
- package/lib/endpoints/btrzpay/terminalPayments.js +15 -5
- package/lib/endpoints/coltrane/merged-fare-tables.js +1 -1
- package/lib/endpoints/coltrane/paths.js +9 -6
- package/lib/endpoints/gps/scanner-app-location.js +3 -2
- package/lib/endpoints/inventory/amenities.js +10 -7
- package/lib/endpoints/inventory/amenity-groups.js +11 -7
- package/lib/endpoints/inventory/banks.js +5 -11
- package/lib/endpoints/inventory/bare-routes.js +12 -4
- package/lib/endpoints/inventory/brands.js +10 -6
- package/lib/endpoints/inventory/bundle-fares.js +4 -2
- package/lib/endpoints/inventory/bundles.js +5 -2
- package/lib/endpoints/inventory/change-requests.js +23 -9
- package/lib/endpoints/inventory/companies.js +5 -2
- package/lib/endpoints/inventory/control-classes.js +34 -4
- package/lib/endpoints/inventory/countries.js +8 -3
- package/lib/endpoints/inventory/custom-content.js +8 -6
- package/lib/endpoints/inventory/custom-fields.js +9 -7
- package/lib/endpoints/inventory/document-types.js +8 -11
- package/lib/endpoints/inventory/external-passes.js +13 -4
- package/lib/endpoints/inventory/external-wallets.js +5 -6
- package/lib/endpoints/inventory/fallback-codes.js +11 -4
- package/lib/endpoints/inventory/fare-classes.js +6 -4
- package/lib/endpoints/inventory/fares.js +13 -7
- package/lib/endpoints/inventory/fees.js +8 -4
- package/lib/endpoints/inventory/filtered-trips-v2.js +1 -1
- package/lib/endpoints/inventory/filtered-trips.js +14 -2
- package/lib/endpoints/inventory/financing-costs.js +15 -8
- package/lib/endpoints/inventory/garages.js +7 -5
- package/lib/endpoints/inventory/getnet-terminals.js +12 -4
- package/lib/endpoints/inventory/gift-certificate-definitions.js +10 -11
- package/lib/endpoints/inventory/insurances.js +10 -7
- package/lib/endpoints/inventory/insurancesCost.js +8 -5
- package/lib/endpoints/inventory/items.js +22 -4
- package/lib/endpoints/inventory/journey-prices.js +36 -7
- package/lib/endpoints/inventory/labels.js +6 -5
- package/lib/endpoints/inventory/marital-status.js +8 -11
- package/lib/endpoints/inventory/marketplace-modifiers.js +16 -7
- package/lib/endpoints/inventory/mit-terminal-settings.js +5 -11
- package/lib/endpoints/inventory/mit-terminals.js +5 -11
- package/lib/endpoints/inventory/operating-companies.js +13 -10
- package/lib/endpoints/inventory/operation-messages.js +16 -7
- package/lib/endpoints/inventory/operation-reasons.js +11 -9
- package/lib/endpoints/inventory/parcel-zones.js +6 -5
- package/lib/endpoints/inventory/pay-on-accounts.js +9 -3
- package/lib/endpoints/inventory/payment-terminals.js +5 -11
- package/lib/endpoints/inventory/prisma-terminals.js +10 -6
- package/lib/endpoints/inventory/products.js +31 -7
- package/lib/endpoints/inventory/promos.js +29 -11
- package/lib/endpoints/inventory/routes.js +50 -31
- package/lib/endpoints/inventory/schedule-groups.js +7 -7
- package/lib/endpoints/inventory/schedules.js +24 -11
- package/lib/endpoints/inventory/seatclasses.js +5 -15
- package/lib/endpoints/inventory/seatfees.js +9 -6
- package/lib/endpoints/inventory/seatmaps.js +37 -10
- package/lib/endpoints/inventory/segments-information-tables.js +5 -4
- package/lib/endpoints/inventory/segments-information.js +4 -2
- package/lib/endpoints/inventory/service-numbers.js +9 -6
- package/lib/endpoints/inventory/service-types.js +5 -11
- package/lib/endpoints/inventory/ssrs.js +11 -3
- package/lib/endpoints/inventory/station-classes.js +12 -6
- package/lib/endpoints/inventory/station-groups.js +4 -3
- package/lib/endpoints/inventory/stations-provinces.js +1 -7
- package/lib/endpoints/inventory/stations-zones.js +3 -2
- package/lib/endpoints/inventory/stations.js +23 -5
- package/lib/endpoints/inventory/taxes.js +5 -6
- package/lib/endpoints/inventory/travel-routes.js +6 -4
- package/lib/endpoints/inventory/traveller-card-providers-types.js +1 -7
- package/lib/endpoints/inventory/traveller-card-providers.js +3 -9
- package/lib/endpoints/inventory/traveller-card-types.js +7 -6
- package/lib/endpoints/inventory/trips.js +2 -8
- package/lib/endpoints/inventory/vehicle-types.js +0 -1
- package/lib/endpoints/inventory/vehicles.js +17 -2
- package/lib/endpoints/inventory/zone-price-overages.js +4 -10
- package/lib/endpoints/inventory/zone-prices.js +12 -7
- package/lib/endpoints/invoices/dlink.js +3 -2
- package/lib/endpoints/invoices/emails.js +1 -7
- package/lib/endpoints/invoices/gti.js +2 -2
- package/lib/endpoints/invoices/infile.js +2 -2
- package/lib/endpoints/invoices/infileJson.js +2 -2
- package/lib/endpoints/invoices/invoices.js +14 -10
- package/lib/endpoints/invoices/pdfs.js +4 -3
- package/lib/endpoints/invoices/providers.js +12 -11
- package/lib/endpoints/invoices/providersSequences.js +5 -15
- package/lib/endpoints/invoices/system.js +2 -2
- package/lib/endpoints/invoices/tax-ids.js +1 -1
- package/lib/endpoints/notifications/customers.js +25 -5
- package/lib/endpoints/notifications/email.js +8 -3
- package/lib/endpoints/notifications/manifest-notifications.js +4 -3
- package/lib/endpoints/notifications/notify.js +20 -5
- package/lib/endpoints/notifications/orders-rules-validations.js +2 -8
- package/lib/endpoints/notifications/pdf-data.js +2 -1
- package/lib/endpoints/notifications/pdfs.js +2 -1
- package/lib/endpoints/notifications/printed-tickets.js +17 -6
- package/lib/endpoints/notifications/twilio.js +1 -7
- package/lib/endpoints/operations/accounting_items.js +9 -4
- package/lib/endpoints/operations/applied_insurance.js +8 -3
- package/lib/endpoints/operations/calendar_entries.js +7 -3
- package/lib/endpoints/operations/external-bookings.js +2 -8
- package/lib/endpoints/operations/flexpasses.js +1 -1
- package/lib/endpoints/operations/loans.js +10 -4
- package/lib/endpoints/operations/manifest.js +83 -33
- package/lib/endpoints/operations/manifest_leg_for_tickets.js +1 -2
- package/lib/endpoints/operations/movements.js +1 -7
- package/lib/endpoints/operations/outlook-trips.js +13 -3
- package/lib/endpoints/operations/parcels.js +20 -6
- package/lib/endpoints/operations/parcels_manifests.js +6 -16
- package/lib/endpoints/operations/passenger_check_in_info.js +3 -10
- package/lib/endpoints/operations/redemption.js +4 -4
- package/lib/endpoints/operations/rms.js +33 -6
- package/lib/endpoints/operations/scheduled_notifications.js +4 -11
- package/lib/endpoints/operations/segments.js +2 -2
- package/lib/endpoints/operations/sold-items-fulfillment.js +4 -3
- package/lib/endpoints/operations/sold-items.js +13 -4
- package/lib/endpoints/operations/tickets.js +4 -4
- package/lib/endpoints/operations/transaction.js +1 -1
- package/lib/endpoints/operations/transactions.js +6 -14
- package/lib/endpoints/operations/transport_regulations.js +1 -1
- package/lib/endpoints/operations/trip_change_info.js +13 -1
- package/lib/endpoints/operations/vehicle_assignments.js +10 -5
- package/lib/endpoints/operations/vouchers.js +2 -9
- package/lib/endpoints/operations/waitlists.js +2 -2
- package/lib/endpoints/sales/bundles.js +4 -2
- package/lib/endpoints/sales/cancellations.js +2 -2
- package/lib/endpoints/sales/cart-promo.js +2 -9
- package/lib/endpoints/sales/cart.js +30 -17
- package/lib/endpoints/sales/check-in-info.js +1 -7
- package/lib/endpoints/sales/custom-fields.js +4 -3
- package/lib/endpoints/sales/flexpasses.js +1 -7
- package/lib/endpoints/sales/gift-certificates.js +4 -2
- package/lib/endpoints/sales/order.js +6 -4
- package/lib/endpoints/sales/parcel-quotes.js +1 -1
- package/lib/endpoints/sales/payment-providers.js +6 -3
- package/lib/endpoints/sales/redeemable-items.js +16 -5
- package/lib/endpoints/sales/sync-entry.js +1 -1
- package/lib/endpoints/sales/voucher.js +1 -1
- package/package.json +1 -1
- package/src/endpoints/accounts/application-settings.js +6 -1
- package/src/endpoints/accounts/current-shifts.js +6 -1
- package/src/endpoints/accounts/customers.js +11 -4
- package/src/endpoints/accounts/domains.js +1 -2
- package/src/endpoints/accounts/dynamic-forms.js +17 -5
- package/src/endpoints/accounts/email-settings.js +2 -4
- package/src/endpoints/accounts/email-templates.js +10 -2
- package/src/endpoints/accounts/exchange-rates.js +3 -3
- package/src/endpoints/accounts/exchange-receipts.js +2 -2
- package/src/endpoints/accounts/goal-settings.js +2 -3
- package/src/endpoints/accounts/images.js +2 -4
- package/src/endpoints/accounts/interline.js +5 -8
- package/src/endpoints/accounts/journey-prices-settings.js +2 -2
- package/src/endpoints/accounts/lexicons.js +36 -7
- package/src/endpoints/accounts/market-pricing-settings.js +2 -2
- package/src/endpoints/accounts/multiproduct-sales-settings.js +2 -2
- package/src/endpoints/accounts/network.js +6 -9
- package/src/endpoints/accounts/operation-settings.js +2 -3
- package/src/endpoints/accounts/people-lookups.js +27 -9
- package/src/endpoints/accounts/point-to-point-settings.js +2 -2
- package/src/endpoints/accounts/print-settings.js +2 -3
- package/src/endpoints/accounts/print-templates.js +40 -9
- package/src/endpoints/accounts/printers.js +1 -2
- package/src/endpoints/accounts/rms-settings.js +2 -2
- package/src/endpoints/accounts/s3buckets.js +3 -3
- package/src/endpoints/accounts/salesforce-settings.js +2 -3
- package/src/endpoints/accounts/shift-settings.js +2 -3
- package/src/endpoints/accounts/shifts.js +43 -8
- package/src/endpoints/accounts/sms-templates.js +39 -10
- package/src/endpoints/accounts/sub-print-templates.js +1 -1
- package/src/endpoints/accounts/ticket-movement-settings.js +2 -2
- package/src/endpoints/accounts/tokens.js +10 -3
- package/src/endpoints/accounts/transport-regulation-settings.js +2 -2
- package/src/endpoints/accounts/travellers.js +19 -6
- package/src/endpoints/accounts/trusted-machines.js +11 -3
- package/src/endpoints/accounts/twilio-settings.js +2 -3
- package/src/endpoints/accounts/users.js +12 -8
- package/src/endpoints/accounts/websales-config.js +10 -3
- package/src/endpoints/btrzpay/cardpointe.js +5 -5
- package/src/endpoints/btrzpay/customerCards.js +4 -4
- package/src/endpoints/btrzpay/customers.js +3 -3
- package/src/endpoints/btrzpay/datalogic.js +8 -9
- package/src/endpoints/btrzpay/oxxo.js +5 -13
- package/src/endpoints/btrzpay/payment-methods.js +25 -11
- package/src/endpoints/btrzpay/payments.js +2 -2
- package/src/endpoints/btrzpay/prismaTerminals.js +14 -21
- package/src/endpoints/btrzpay/reference-numbers.js +1 -1
- package/src/endpoints/btrzpay/referenced-payments.js +10 -2
- package/src/endpoints/btrzpay/square.js +2 -2
- package/src/endpoints/btrzpay/stripe-terminals.js +5 -5
- package/src/endpoints/btrzpay/terminalPayments.js +15 -5
- package/src/endpoints/coltrane/merged-fare-tables.js +1 -1
- package/src/endpoints/coltrane/paths.js +9 -6
- package/src/endpoints/gps/scanner-app-location.js +3 -2
- package/src/endpoints/inventory/amenities.js +10 -7
- package/src/endpoints/inventory/amenity-groups.js +11 -7
- package/src/endpoints/inventory/banks.js +5 -11
- package/src/endpoints/inventory/bare-routes.js +12 -4
- package/src/endpoints/inventory/brands.js +10 -6
- package/src/endpoints/inventory/bundle-fares.js +4 -2
- package/src/endpoints/inventory/bundles.js +5 -2
- package/src/endpoints/inventory/change-requests.js +23 -9
- package/src/endpoints/inventory/companies.js +5 -2
- package/src/endpoints/inventory/control-classes.js +34 -4
- package/src/endpoints/inventory/countries.js +8 -3
- package/src/endpoints/inventory/custom-content.js +8 -6
- package/src/endpoints/inventory/custom-fields.js +9 -7
- package/src/endpoints/inventory/document-types.js +8 -11
- package/src/endpoints/inventory/external-passes.js +13 -4
- package/src/endpoints/inventory/external-wallets.js +5 -6
- package/src/endpoints/inventory/fallback-codes.js +11 -4
- package/src/endpoints/inventory/fare-classes.js +6 -4
- package/src/endpoints/inventory/fares.js +13 -7
- package/src/endpoints/inventory/fees.js +8 -4
- package/src/endpoints/inventory/filtered-trips-v2.js +1 -1
- package/src/endpoints/inventory/filtered-trips.js +14 -2
- package/src/endpoints/inventory/financing-costs.js +15 -8
- package/src/endpoints/inventory/garages.js +7 -5
- package/src/endpoints/inventory/getnet-terminals.js +12 -4
- package/src/endpoints/inventory/gift-certificate-definitions.js +10 -11
- package/src/endpoints/inventory/insurances.js +10 -7
- package/src/endpoints/inventory/insurancesCost.js +8 -5
- package/src/endpoints/inventory/items.js +22 -4
- package/src/endpoints/inventory/journey-prices.js +36 -7
- package/src/endpoints/inventory/labels.js +6 -5
- package/src/endpoints/inventory/marital-status.js +8 -11
- package/src/endpoints/inventory/marketplace-modifiers.js +16 -7
- package/src/endpoints/inventory/mit-terminal-settings.js +5 -11
- package/src/endpoints/inventory/mit-terminals.js +5 -11
- package/src/endpoints/inventory/operating-companies.js +13 -10
- package/src/endpoints/inventory/operation-messages.js +16 -7
- package/src/endpoints/inventory/operation-reasons.js +11 -9
- package/src/endpoints/inventory/parcel-zones.js +6 -5
- package/src/endpoints/inventory/pay-on-accounts.js +9 -3
- package/src/endpoints/inventory/payment-terminals.js +5 -11
- package/src/endpoints/inventory/prisma-terminals.js +10 -6
- package/src/endpoints/inventory/products.js +31 -7
- package/src/endpoints/inventory/promos.js +29 -11
- package/src/endpoints/inventory/routes.js +50 -31
- package/src/endpoints/inventory/schedule-groups.js +7 -7
- package/src/endpoints/inventory/schedules.js +24 -11
- package/src/endpoints/inventory/seatclasses.js +5 -15
- package/src/endpoints/inventory/seatfees.js +9 -6
- package/src/endpoints/inventory/seatmaps.js +37 -10
- package/src/endpoints/inventory/segments-information-tables.js +5 -4
- package/src/endpoints/inventory/segments-information.js +4 -2
- package/src/endpoints/inventory/service-numbers.js +9 -6
- package/src/endpoints/inventory/service-types.js +5 -11
- package/src/endpoints/inventory/ssrs.js +11 -3
- package/src/endpoints/inventory/station-classes.js +12 -6
- package/src/endpoints/inventory/station-groups.js +4 -3
- package/src/endpoints/inventory/stations-provinces.js +1 -7
- package/src/endpoints/inventory/stations-zones.js +3 -2
- package/src/endpoints/inventory/stations.js +23 -5
- package/src/endpoints/inventory/taxes.js +5 -6
- package/src/endpoints/inventory/travel-routes.js +6 -4
- package/src/endpoints/inventory/traveller-card-providers-types.js +1 -7
- package/src/endpoints/inventory/traveller-card-providers.js +3 -9
- package/src/endpoints/inventory/traveller-card-types.js +7 -6
- package/src/endpoints/inventory/trips.js +2 -8
- package/src/endpoints/inventory/vehicle-types.js +0 -1
- package/src/endpoints/inventory/vehicles.js +17 -2
- package/src/endpoints/inventory/zone-price-overages.js +4 -10
- package/src/endpoints/inventory/zone-prices.js +12 -7
- package/src/endpoints/invoices/dlink.js +3 -2
- package/src/endpoints/invoices/emails.js +1 -7
- package/src/endpoints/invoices/gti.js +2 -2
- package/src/endpoints/invoices/infile.js +2 -2
- package/src/endpoints/invoices/infileJson.js +2 -2
- package/src/endpoints/invoices/invoices.js +14 -10
- package/src/endpoints/invoices/pdfs.js +4 -3
- package/src/endpoints/invoices/providers.js +12 -11
- package/src/endpoints/invoices/providersSequences.js +5 -15
- package/src/endpoints/invoices/system.js +2 -2
- package/src/endpoints/invoices/tax-ids.js +1 -1
- package/src/endpoints/notifications/customers.js +25 -5
- package/src/endpoints/notifications/email.js +8 -3
- package/src/endpoints/notifications/manifest-notifications.js +4 -3
- package/src/endpoints/notifications/notify.js +20 -5
- package/src/endpoints/notifications/orders-rules-validations.js +2 -8
- package/src/endpoints/notifications/pdf-data.js +2 -1
- package/src/endpoints/notifications/pdfs.js +2 -1
- package/src/endpoints/notifications/printed-tickets.js +17 -7
- package/src/endpoints/notifications/twilio.js +1 -7
- package/src/endpoints/operations/accounting_items.js +9 -4
- package/src/endpoints/operations/applied_insurance.js +9 -2
- package/src/endpoints/operations/calendar_entries.js +7 -3
- package/src/endpoints/operations/external-bookings.js +2 -8
- package/src/endpoints/operations/flexpasses.js +1 -1
- package/src/endpoints/operations/loans.js +10 -4
- package/src/endpoints/operations/manifest.js +83 -33
- package/src/endpoints/operations/manifest_leg_for_tickets.js +1 -2
- package/src/endpoints/operations/movements.js +1 -7
- package/src/endpoints/operations/outlook-trips.js +13 -3
- package/src/endpoints/operations/parcels.js +20 -6
- package/src/endpoints/operations/parcels_manifests.js +6 -16
- package/src/endpoints/operations/passenger_check_in_info.js +3 -10
- package/src/endpoints/operations/redemption.js +4 -4
- package/src/endpoints/operations/rms.js +33 -6
- package/src/endpoints/operations/scheduled_notifications.js +4 -11
- package/src/endpoints/operations/segments.js +2 -2
- package/src/endpoints/operations/sold-items-fulfillment.js +4 -3
- package/src/endpoints/operations/sold-items.js +13 -4
- package/src/endpoints/operations/tickets.js +4 -4
- package/src/endpoints/operations/transaction.js +1 -1
- package/src/endpoints/operations/transactions.js +6 -14
- package/src/endpoints/operations/transport_regulations.js +1 -1
- package/src/endpoints/operations/trip_change_info.js +13 -1
- package/src/endpoints/operations/vehicle_assignments.js +10 -5
- package/src/endpoints/operations/vouchers.js +2 -9
- package/src/endpoints/operations/waitlists.js +2 -2
- package/src/endpoints/sales/bundles.js +4 -2
- package/src/endpoints/sales/cancellations.js +2 -2
- package/src/endpoints/sales/cart-promo.js +2 -9
- package/src/endpoints/sales/cart.js +30 -17
- package/src/endpoints/sales/check-in-info.js +1 -7
- package/src/endpoints/sales/custom-fields.js +4 -3
- package/src/endpoints/sales/flexpasses.js +1 -7
- package/src/endpoints/sales/gift-certificates.js +4 -2
- package/src/endpoints/sales/order.js +6 -4
- package/src/endpoints/sales/parcel-quotes.js +1 -1
- package/src/endpoints/sales/payment-providers.js +6 -3
- package/src/endpoints/sales/redeemable-items.js +16 -5
- package/src/endpoints/sales/sync-entry.js +1 -1
- package/src/endpoints/sales/voucher.js +1 -1
|
@@ -1,8 +1,17 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* Query params for operation-messages
|
|
5
|
-
* @typedef {Object}
|
|
4
|
+
* Query params for GET /operation-messages (btrz-api-inventory). See get-operation-messages getSpec().
|
|
5
|
+
* @typedef {Object} OperationMessagesListQuery
|
|
6
|
+
* @property {string} [providerId] - Provider id to get operation messages for
|
|
7
|
+
* @property {number} [page] - Page number (default 1)
|
|
8
|
+
* @property {string} [name] - Full or partial name (non case sensitive)
|
|
9
|
+
* @property {string} [type] - Operation message type
|
|
10
|
+
* @property {string} [stationId] - Station id of the operation message
|
|
11
|
+
* @property {string} [avoidPagination] - Any value = true to avoid pagination
|
|
12
|
+
* @property {string} [active] - Filter active/inactive [true, false]
|
|
13
|
+
* @property {string} [effectiveDateTimeStartBefore] - ISO datetime (start before/at)
|
|
14
|
+
* @property {string} [effectiveDateTimeEndAfter] - ISO datetime (end after/at)
|
|
6
15
|
*/
|
|
7
16
|
|
|
8
17
|
/**
|
|
@@ -17,7 +26,7 @@ function operationMessagesFactory({client, internalAuthTokenProvider}) {
|
|
|
17
26
|
* GET /operation-messages - list operation messages.
|
|
18
27
|
* @param {Object} opts
|
|
19
28
|
* @param {string} [opts.token] - API key
|
|
20
|
-
* @param {
|
|
29
|
+
* @param {OperationMessagesListQuery} [opts.query] - Query params
|
|
21
30
|
* @param {Object} [opts.headers] - Optional headers
|
|
22
31
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
23
32
|
*/
|
|
@@ -31,7 +40,7 @@ function operationMessagesFactory({client, internalAuthTokenProvider}) {
|
|
|
31
40
|
}
|
|
32
41
|
|
|
33
42
|
/**
|
|
34
|
-
* POST /operation-messages - create operation message.
|
|
43
|
+
* POST /operation-messages - create operation message. API does not accept query params.
|
|
35
44
|
* @param {Object} opts
|
|
36
45
|
* @param {string} [opts.token] - API key
|
|
37
46
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -49,7 +58,7 @@ function operationMessagesFactory({client, internalAuthTokenProvider}) {
|
|
|
49
58
|
}
|
|
50
59
|
|
|
51
60
|
/**
|
|
52
|
-
* PUT /operation-messages/:operationMessageId - update operation message.
|
|
61
|
+
* PUT /operation-messages/:operationMessageId - update operation message. API does not accept query params.
|
|
53
62
|
* @param {Object} opts
|
|
54
63
|
* @param {string} [opts.token] - API key
|
|
55
64
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -68,7 +77,7 @@ function operationMessagesFactory({client, internalAuthTokenProvider}) {
|
|
|
68
77
|
}
|
|
69
78
|
|
|
70
79
|
/**
|
|
71
|
-
* GET /operation-messages/:operationMessageId - get operation message by id.
|
|
80
|
+
* GET /operation-messages/:operationMessageId - get operation message by id. API does not accept query params.
|
|
72
81
|
* @param {Object} opts
|
|
73
82
|
* @param {string} [opts.token] - API key
|
|
74
83
|
* @param {string} opts.operationMessageId - Operation message id
|
|
@@ -84,7 +93,7 @@ function operationMessagesFactory({client, internalAuthTokenProvider}) {
|
|
|
84
93
|
}
|
|
85
94
|
|
|
86
95
|
/**
|
|
87
|
-
* DELETE /operation-messages/:operationMessageId - remove operation message.
|
|
96
|
+
* DELETE /operation-messages/:operationMessageId - remove operation message. API does not accept query params.
|
|
88
97
|
* @param {Object} opts
|
|
89
98
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
90
99
|
* @param {string} opts.operationMessageId - Operation message id
|
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("../endpoints_helpers.js");
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* Query params for GET /operation-reasons (btrz-api-inventory). See get-handler getSpec().
|
|
5
|
+
* @typedef {Object} OperationReasonsListQuery
|
|
6
|
+
* @property {number} [page] - The page number to retrieve
|
|
7
|
+
*/
|
|
8
|
+
|
|
3
9
|
/**
|
|
4
10
|
* Factory for operation-reasons API (btrz-api-inventory).
|
|
5
11
|
* @param {Object} deps
|
|
@@ -13,7 +19,7 @@ function operationReasonFactory({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 {OperationReasonsListQuery} [opts.query] - Query params (page)
|
|
17
23
|
* @param {Object} [opts.headers] - Optional headers
|
|
18
24
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
19
25
|
*/
|
|
@@ -27,12 +33,11 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
|
|
|
27
33
|
}
|
|
28
34
|
|
|
29
35
|
/**
|
|
30
|
-
* GET /operation-reasons/:id - get operation reason by id.
|
|
36
|
+
* GET /operation-reasons/:id - get operation reason by id. API does not accept query params.
|
|
31
37
|
* @param {Object} opts
|
|
32
38
|
* @param {string} [opts.token] - API key
|
|
33
39
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
34
40
|
* @param {string} opts.id - Operation reason id
|
|
35
|
-
* @param {Object} [opts.query] - Query params
|
|
36
41
|
* @param {Object} [opts.headers] - Optional headers
|
|
37
42
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
38
43
|
*/
|
|
@@ -46,13 +51,12 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
|
|
|
46
51
|
}
|
|
47
52
|
|
|
48
53
|
/**
|
|
49
|
-
* PUT /operation-reasons/:id - update operation reason.
|
|
54
|
+
* PUT /operation-reasons/:id - update operation reason. API does not accept query params.
|
|
50
55
|
* @param {Object} opts
|
|
51
56
|
* @param {string} [opts.token] - API key
|
|
52
57
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
53
58
|
* @param {string} opts.id - Operation reason id
|
|
54
59
|
* @param {Object} opts.operationReason - Operation reason payload
|
|
55
|
-
* @param {Object} [opts.query] - Query params
|
|
56
60
|
* @param {Object} [opts.headers] - Optional headers
|
|
57
61
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
58
62
|
*/
|
|
@@ -67,12 +71,11 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
|
|
|
67
71
|
}
|
|
68
72
|
|
|
69
73
|
/**
|
|
70
|
-
* DELETE /operation-reasons/:id - remove operation reason.
|
|
74
|
+
* DELETE /operation-reasons/:id - remove operation reason. API does not accept query params.
|
|
71
75
|
* @param {Object} opts
|
|
72
76
|
* @param {string} [opts.token] - API key
|
|
73
77
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
74
78
|
* @param {string} opts.id - Operation reason id
|
|
75
|
-
* @param {Object} [opts.query] - Query params
|
|
76
79
|
* @param {Object} [opts.headers] - Optional headers
|
|
77
80
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
78
81
|
*/
|
|
@@ -86,12 +89,11 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
|
|
|
86
89
|
}
|
|
87
90
|
|
|
88
91
|
/**
|
|
89
|
-
* POST /operation-reasons - create operation reason.
|
|
92
|
+
* POST /operation-reasons - create operation reason. API does not accept query params.
|
|
90
93
|
* @param {Object} opts
|
|
91
94
|
* @param {string} [opts.token] - API key
|
|
92
95
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
93
96
|
* @param {Object} opts.operationReason - Operation reason payload
|
|
94
|
-
* @param {Object} [opts.query] - Query params
|
|
95
97
|
* @param {Object} [opts.headers] - Optional headers
|
|
96
98
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
97
99
|
*/
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* Query params for parcel-zones
|
|
5
|
-
* @typedef {Object}
|
|
4
|
+
* Query params for GET /parcel-zones (btrz-api-inventory). See get-parcel-zones getSpec().
|
|
5
|
+
* @typedef {Object} ParcelZonesListQuery
|
|
6
|
+
* @property {string} [providerIds] - Provider IDs to get parcel zones for
|
|
6
7
|
*/
|
|
7
8
|
|
|
8
9
|
/**
|
|
@@ -17,7 +18,7 @@ function parcelZonesFactory({client, internalAuthTokenProvider}) {
|
|
|
17
18
|
* GET /parcel-zones - list parcel zones.
|
|
18
19
|
* @param {Object} opts
|
|
19
20
|
* @param {string} [opts.token] - API key
|
|
20
|
-
* @param {
|
|
21
|
+
* @param {ParcelZonesListQuery} [opts.query] - Query params (providerIds)
|
|
21
22
|
* @param {Object} [opts.headers] - Optional headers
|
|
22
23
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
23
24
|
*/
|
|
@@ -29,7 +30,7 @@ function parcelZonesFactory({client, internalAuthTokenProvider}) {
|
|
|
29
30
|
}
|
|
30
31
|
|
|
31
32
|
/**
|
|
32
|
-
* POST /parcel-zones - create parcel zone.
|
|
33
|
+
* POST /parcel-zones - create parcel zone. API does not accept query params.
|
|
33
34
|
* @param {Object} opts
|
|
34
35
|
* @param {string} [opts.token] - API key
|
|
35
36
|
* @param {Object} opts.parcelZone - Parcel zone payload
|
|
@@ -47,7 +48,7 @@ function parcelZonesFactory({client, internalAuthTokenProvider}) {
|
|
|
47
48
|
}
|
|
48
49
|
|
|
49
50
|
/**
|
|
50
|
-
* PUT /parcel-zone/:parcelZoneId - update parcel zone.
|
|
51
|
+
* PUT /parcel-zone/:parcelZoneId - update parcel zone. API does not accept query params.
|
|
51
52
|
* @param {Object} opts
|
|
52
53
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
53
54
|
* @param {string} [opts.token] - API key
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("../endpoints_helpers.js");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
5
|
-
* @
|
|
4
|
+
* Query params for GET /pay-on-accounts (btrz-api-inventory). See get-handler getSpec().
|
|
5
|
+
* @typedef {Object} PayOnAccountsListQuery
|
|
6
|
+
* @property {number} [page] - Page number
|
|
7
|
+
* @property {string} [format] - Format to retrieve the data
|
|
8
|
+
* @property {string} [disabled] - Filter by disabled [true, false]
|
|
9
|
+
* @property {string} [term] - Search term to filter PayOnAccounts
|
|
10
|
+
* @property {string} [fareIds] - Fare ids to filter
|
|
11
|
+
* @property {string} [providerId] - Provider id to filter
|
|
6
12
|
*/
|
|
7
13
|
|
|
8
14
|
/**
|
|
@@ -18,7 +24,7 @@ function payOnAccountsFactory({client, internalAuthTokenProvider}) {
|
|
|
18
24
|
* @param {Object} opts
|
|
19
25
|
* @param {string} [opts.token] - API key
|
|
20
26
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
21
|
-
* @param {
|
|
27
|
+
* @param {PayOnAccountsListQuery} [opts.query] - Query params
|
|
22
28
|
* @param {string} [opts.responseType] - Response type (e.g. json)
|
|
23
29
|
* @param {Object} [opts.headers] - Optional headers
|
|
24
30
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
@@ -2,11 +2,6 @@ const {
|
|
|
2
2
|
authorizationHeaders
|
|
3
3
|
} = require("./../endpoints_helpers.js");
|
|
4
4
|
|
|
5
|
-
/**
|
|
6
|
-
* Query params for payment-terminals endpoints (btrz-api-inventory). Forwarded to API as-is.
|
|
7
|
-
* @typedef {Object} InventoryPaymentTerminalsQuery
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
5
|
/**
|
|
11
6
|
* Factory for payment-terminals API (btrz-api-inventory).
|
|
12
7
|
* @param {Object} deps
|
|
@@ -16,10 +11,9 @@ const {
|
|
|
16
11
|
*/
|
|
17
12
|
function paymentTerminalFactory({client, internalAuthTokenProvider}) {
|
|
18
13
|
/**
|
|
19
|
-
* GET /payment-terminals - list payment terminals.
|
|
14
|
+
* GET /payment-terminals - list payment terminals. API does not accept query params.
|
|
20
15
|
* @param {Object} opts
|
|
21
16
|
* @param {string} [opts.token] - API key
|
|
22
|
-
* @param {InventoryPaymentTerminalsQuery} [opts.query] - Optional query params (forwarded to API)
|
|
23
17
|
* @param {Object} [opts.headers] - Optional headers
|
|
24
18
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
25
19
|
*/
|
|
@@ -35,7 +29,7 @@ function paymentTerminalFactory({client, internalAuthTokenProvider}) {
|
|
|
35
29
|
}
|
|
36
30
|
|
|
37
31
|
/**
|
|
38
|
-
* GET /payment-terminals/:paymentTerminalId - get payment terminal by id.
|
|
32
|
+
* GET /payment-terminals/:paymentTerminalId - get payment terminal by id. API does not accept query params.
|
|
39
33
|
* @param {Object} opts
|
|
40
34
|
* @param {string} opts.paymentTerminalId - Payment terminal id
|
|
41
35
|
* @param {string} [opts.token] - API key
|
|
@@ -49,7 +43,7 @@ function paymentTerminalFactory({client, internalAuthTokenProvider}) {
|
|
|
49
43
|
}
|
|
50
44
|
|
|
51
45
|
/**
|
|
52
|
-
* POST /payment-terminals - create payment terminal.
|
|
46
|
+
* POST /payment-terminals - create payment terminal. API does not accept query params.
|
|
53
47
|
* @param {Object} opts
|
|
54
48
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
55
49
|
* @param {string} [opts.token] - API key
|
|
@@ -69,7 +63,7 @@ function paymentTerminalFactory({client, internalAuthTokenProvider}) {
|
|
|
69
63
|
}
|
|
70
64
|
|
|
71
65
|
/**
|
|
72
|
-
* DELETE /payment-terminals/:paymentTerminalId - remove payment terminal.
|
|
66
|
+
* DELETE /payment-terminals/:paymentTerminalId - remove payment terminal. API does not accept query params.
|
|
73
67
|
* @param {Object} opts
|
|
74
68
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
75
69
|
* @param {string} opts.paymentTerminalId - Payment terminal id
|
|
@@ -86,7 +80,7 @@ function paymentTerminalFactory({client, internalAuthTokenProvider}) {
|
|
|
86
80
|
}
|
|
87
81
|
|
|
88
82
|
/**
|
|
89
|
-
* PUT /payment-terminals/:paymentTerminalId - update payment terminal.
|
|
83
|
+
* PUT /payment-terminals/:paymentTerminalId - update payment terminal. API does not accept query params.
|
|
90
84
|
* @param {Object} opts
|
|
91
85
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
92
86
|
* @param {string} [opts.token] - API key
|
|
@@ -3,8 +3,12 @@ const {
|
|
|
3
3
|
} = require("../endpoints_helpers.js");
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
7
|
-
* @
|
|
6
|
+
* Query params for GET /prisma-terminals (btrz-api-inventory). See get-handler getSpec().
|
|
7
|
+
* @typedef {Object} PrismaTerminalsListQuery
|
|
8
|
+
* @property {number} [page] - Page number
|
|
9
|
+
* @property {string} [providerId] - Account provider (operator) ID
|
|
10
|
+
* @property {string} [name] - Filter by terminal name (exact match)
|
|
11
|
+
* @property {string} [externalId] - Filter by terminal externalId (exact match)
|
|
8
12
|
*/
|
|
9
13
|
|
|
10
14
|
/**
|
|
@@ -20,7 +24,7 @@ function prismaTerminalFactory({client, internalAuthTokenProvider}) {
|
|
|
20
24
|
* @param {Object} opts
|
|
21
25
|
* @param {string} [opts.token] - API key
|
|
22
26
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
23
|
-
* @param {
|
|
27
|
+
* @param {PrismaTerminalsListQuery} [opts.query] - Query params
|
|
24
28
|
* @param {Object} [opts.headers] - Optional headers
|
|
25
29
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
26
30
|
*/
|
|
@@ -52,7 +56,7 @@ function prismaTerminalFactory({client, internalAuthTokenProvider}) {
|
|
|
52
56
|
}
|
|
53
57
|
|
|
54
58
|
/**
|
|
55
|
-
* POST /prisma-terminals - create prisma terminal.
|
|
59
|
+
* POST /prisma-terminals - create prisma terminal. API does not accept query params.
|
|
56
60
|
* @param {Object} opts
|
|
57
61
|
* @param {string} [opts.token] - API key
|
|
58
62
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -72,7 +76,7 @@ function prismaTerminalFactory({client, internalAuthTokenProvider}) {
|
|
|
72
76
|
}
|
|
73
77
|
|
|
74
78
|
/**
|
|
75
|
-
* DELETE /prisma-terminals/:prismaTerminalId - remove prisma terminal.
|
|
79
|
+
* DELETE /prisma-terminals/:prismaTerminalId - remove prisma terminal. API does not accept query params.
|
|
76
80
|
* @param {Object} opts
|
|
77
81
|
* @param {string} [opts.token] - API key
|
|
78
82
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -89,7 +93,7 @@ function prismaTerminalFactory({client, internalAuthTokenProvider}) {
|
|
|
89
93
|
}
|
|
90
94
|
|
|
91
95
|
/**
|
|
92
|
-
* PUT /prisma-terminals/:prismaTerminalId - update prisma terminal.
|
|
96
|
+
* PUT /prisma-terminals/:prismaTerminalId - update prisma terminal. API does not accept query params.
|
|
93
97
|
* @param {Object} opts
|
|
94
98
|
* @param {string} [opts.token] - API key
|
|
95
99
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -1,5 +1,30 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* Query params for GET /products (btrz-api-inventory). See get-products getSpec().
|
|
5
|
+
* @typedef {Object} ProductsListQuery
|
|
6
|
+
* @property {string} [providerIds] - Provider IDs to get products for
|
|
7
|
+
* @property {string} [channels] - Filter by channels
|
|
8
|
+
* @property {string} [enabled] - 'true', 'false' or 'any' (default 'true')
|
|
9
|
+
* @property {string} [pricingType] - One of point-to-point, distance, journey, etc.
|
|
10
|
+
* @property {string} [hasRoutes] - 'true' or 'false' (deprecated, use family)
|
|
11
|
+
* @property {string} [hasDates] - 'true' or 'false' (deprecated)
|
|
12
|
+
* @property {string} [hasPassengerInfo] - 'true' or 'false' (deprecated)
|
|
13
|
+
* @property {string} [isParcel] - 'true' or 'false' (deprecated)
|
|
14
|
+
* @property {string} [family] - One of bundle, parcel, paid in, paid out, reservation, flexpass, ticket
|
|
15
|
+
* @property {string} [domain] - Filter by domain
|
|
16
|
+
* @property {string} [parentProductId] - Child products of this parent
|
|
17
|
+
* @property {string} [dynamicFormId] - Filter by dynamic form
|
|
18
|
+
*/
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Query params for GET /products/:productId (btrz-api-inventory). See get-products-id getSpec().
|
|
22
|
+
* @typedef {Object} ProductGetQuery
|
|
23
|
+
* @property {string} [providerIds] - Provider IDs to get product for
|
|
24
|
+
* @property {string} [channels] - Filter by channels
|
|
25
|
+
* @property {string} [enabled] - 'true', 'false' or 'any'
|
|
26
|
+
*/
|
|
27
|
+
|
|
3
28
|
/**
|
|
4
29
|
* Factory for products API (btrz-api-inventory).
|
|
5
30
|
* @param {Object} deps
|
|
@@ -13,7 +38,7 @@ function productsFactory({client, internalAuthTokenProvider}) {
|
|
|
13
38
|
* @param {Object} opts
|
|
14
39
|
* @param {string} [opts.token] - API key
|
|
15
40
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
16
|
-
* @param {
|
|
41
|
+
* @param {ProductsListQuery} [opts.query] - Query params
|
|
17
42
|
* @param {Object} [opts.headers] - Optional headers
|
|
18
43
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
19
44
|
*/
|
|
@@ -31,7 +56,7 @@ function productsFactory({client, internalAuthTokenProvider}) {
|
|
|
31
56
|
* @param {string} [opts.token] - API key
|
|
32
57
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
33
58
|
* @param {string} opts.productId - Product id
|
|
34
|
-
* @param {
|
|
59
|
+
* @param {ProductGetQuery} [opts.query] - Query params (providerIds, channels, enabled)
|
|
35
60
|
* @param {Object} [opts.headers] - Optional headers
|
|
36
61
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
37
62
|
*/
|
|
@@ -44,7 +69,7 @@ function productsFactory({client, internalAuthTokenProvider}) {
|
|
|
44
69
|
}
|
|
45
70
|
|
|
46
71
|
/**
|
|
47
|
-
* POST /products - create product.
|
|
72
|
+
* POST /products - create product. API does not accept query params.
|
|
48
73
|
* @param {Object} opts
|
|
49
74
|
* @param {string} [opts.token] - API key
|
|
50
75
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -62,7 +87,7 @@ function productsFactory({client, internalAuthTokenProvider}) {
|
|
|
62
87
|
}
|
|
63
88
|
|
|
64
89
|
/**
|
|
65
|
-
* PUT /products/:productId - update product.
|
|
90
|
+
* PUT /products/:productId - update product. API does not accept query params.
|
|
66
91
|
* @param {Object} opts
|
|
67
92
|
* @param {string} [opts.token] - API key
|
|
68
93
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -83,7 +108,7 @@ function productsFactory({client, internalAuthTokenProvider}) {
|
|
|
83
108
|
/** @type {{ remove: function }} */
|
|
84
109
|
const domains = {
|
|
85
110
|
/**
|
|
86
|
-
* DELETE /products/domains/:domain - remove product domain.
|
|
111
|
+
* DELETE /products/domains/:domain - remove product domain. API does not accept query params.
|
|
87
112
|
* @param {Object} opts
|
|
88
113
|
* @param {string} [opts.token] - API key
|
|
89
114
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -103,11 +128,10 @@ function productsFactory({client, internalAuthTokenProvider}) {
|
|
|
103
128
|
/** @type {{ all: function }} */
|
|
104
129
|
const families = {
|
|
105
130
|
/**
|
|
106
|
-
* GET /products/families - list product families.
|
|
131
|
+
* GET /products/families - list product families. API does not accept query params.
|
|
107
132
|
* @param {Object} opts
|
|
108
133
|
* @param {string} [opts.token] - API key
|
|
109
134
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
110
|
-
* @param {Object} [opts.query] - Query params
|
|
111
135
|
* @param {Object} [opts.headers] - Optional headers
|
|
112
136
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
113
137
|
*/
|
|
@@ -2,8 +2,27 @@
|
|
|
2
2
|
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
|
-
* Query params for promos
|
|
6
|
-
* @typedef {Object}
|
|
5
|
+
* Query params for GET /promos (btrz-api-inventory). See get-promos getSpec().
|
|
6
|
+
* @typedef {Object} PromosListQuery
|
|
7
|
+
* @property {string} [providerIds] - Provider IDs to get promos for
|
|
8
|
+
* @property {string} [productId] - Product id
|
|
9
|
+
* @property {string} [productIds] - Comma-separated product IDs (mutually exclusive with productId)
|
|
10
|
+
* @property {string} [promoCode] - Promo internal id
|
|
11
|
+
* @property {string} [name] - Promo name
|
|
12
|
+
* @property {string} [campaign] - Campaign the promo belongs to
|
|
13
|
+
* @property {string} [origin] - Departure station name
|
|
14
|
+
* @property {string} [destination] - Destination station name
|
|
15
|
+
* @property {string} [fareIds] - Comma-separated fare IDs
|
|
16
|
+
* @property {string} [tripType] - 'oneway' or 'roundtrip'
|
|
17
|
+
* @property {string} [channels] - Filter by channels (mandatory if promoCode not given)
|
|
18
|
+
* @property {boolean} [autoApply] - Filter only auto-applied promos
|
|
19
|
+
* @property {string} [includeExpired] - Include expired promos (deprecated)
|
|
20
|
+
* @property {string} [searchOutboundTravelDate] - Outbound travel date for validity
|
|
21
|
+
* @property {string} [searchReturnTravelDate] - Return travel date for validity
|
|
22
|
+
* @property {string} [qty] - Number of tickets
|
|
23
|
+
* @property {number} [page] - Page for pagination
|
|
24
|
+
* @property {string} [orderBy] - Field to order by
|
|
25
|
+
* @property {string} [orderDir] - 'asc' (1) or 'desc' (-1)
|
|
7
26
|
*/
|
|
8
27
|
|
|
9
28
|
/**
|
|
@@ -19,7 +38,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
|
|
|
19
38
|
* @param {Object} opts
|
|
20
39
|
* @param {string} [opts.token] - API key
|
|
21
40
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
22
|
-
* @param {
|
|
41
|
+
* @param {PromosListQuery} [opts.query] - Query params
|
|
23
42
|
* @param {Object} [opts.headers] - Optional headers
|
|
24
43
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
25
44
|
*/
|
|
@@ -31,12 +50,11 @@ function promosFactory({client, internalAuthTokenProvider}) {
|
|
|
31
50
|
}
|
|
32
51
|
|
|
33
52
|
/**
|
|
34
|
-
* GET /promos/:promoId - get promo by id.
|
|
53
|
+
* GET /promos/:promoId - get promo by id. API does not accept query params.
|
|
35
54
|
* @param {Object} opts
|
|
36
55
|
* @param {string} [opts.token] - API key
|
|
37
56
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
38
57
|
* @param {string} opts.promoId - Promo id
|
|
39
|
-
* @param {InventoryPromosQuery} [opts.query] - Optional query params (forwarded to API)
|
|
40
58
|
* @param {Object} [opts.headers] - Optional headers
|
|
41
59
|
* @returns {Promise<import("axios").AxiosResponse>}
|
|
42
60
|
*/
|
|
@@ -48,7 +66,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
|
|
|
48
66
|
}
|
|
49
67
|
|
|
50
68
|
/**
|
|
51
|
-
* POST /promos - create promo.
|
|
69
|
+
* POST /promos - create promo. API does not accept query params.
|
|
52
70
|
* @param {Object} opts
|
|
53
71
|
* @param {string} [opts.token] - API key
|
|
54
72
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -66,7 +84,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
|
|
|
66
84
|
}
|
|
67
85
|
|
|
68
86
|
/**
|
|
69
|
-
* DELETE /promos/:promoId - remove promo.
|
|
87
|
+
* DELETE /promos/:promoId - remove promo. API does not accept query params.
|
|
70
88
|
* @param {Object} opts
|
|
71
89
|
* @param {string} [opts.token] - API key
|
|
72
90
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -83,7 +101,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
|
|
|
83
101
|
}
|
|
84
102
|
|
|
85
103
|
/**
|
|
86
|
-
* PATCH /promos/:promoId - update promo.
|
|
104
|
+
* PATCH /promos/:promoId - update promo. API does not accept query params.
|
|
87
105
|
* @param {Object} opts
|
|
88
106
|
* @param {string} [opts.token] - API key
|
|
89
107
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -103,7 +121,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
|
|
|
103
121
|
}
|
|
104
122
|
|
|
105
123
|
/**
|
|
106
|
-
* PATCH /promo/:promoId - patch promo with operations.
|
|
124
|
+
* PATCH /promo/:promoId - patch promo with operations. API does not accept query params.
|
|
107
125
|
* @param {Object} opts
|
|
108
126
|
* @param {string} [opts.token] - API key
|
|
109
127
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -122,7 +140,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
|
|
|
122
140
|
}
|
|
123
141
|
|
|
124
142
|
/**
|
|
125
|
-
* POST /promos/:promoId/rules - add promo rule.
|
|
143
|
+
* POST /promos/:promoId/rules - add promo rule. API does not accept query params.
|
|
126
144
|
* @param {Object} opts
|
|
127
145
|
* @param {string} [opts.token] - API key
|
|
128
146
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
@@ -141,7 +159,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
|
|
|
141
159
|
}
|
|
142
160
|
|
|
143
161
|
/**
|
|
144
|
-
* PUT /promos/:promoId/rules/:ruleId - update promo rule.
|
|
162
|
+
* PUT /promos/:promoId/rules/:ruleId - update promo rule. API does not accept query params.
|
|
145
163
|
* @param {Object} opts
|
|
146
164
|
* @param {string} [opts.token] - API key
|
|
147
165
|
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|