btrz-api-client 8.29.0 → 8.30.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 +23 -0
- package/docs/plans/2026-03-05-btrz-api-client-jsdoc.md +110 -0
- package/lib/client-standalone-min.js +2 -2
- package/lib/client.js +90 -0
- package/lib/constants.js +4 -0
- package/lib/endpoints/accounts/accounts.js +28 -1
- package/lib/endpoints/accounts/application-settings.js +57 -1
- package/lib/endpoints/accounts/application.js +18 -1
- package/lib/endpoints/accounts/applications.js +28 -1
- package/lib/endpoints/accounts/current-shifts.js +19 -2
- package/lib/endpoints/accounts/customers.js +77 -1
- package/lib/endpoints/accounts/docs.js +10 -0
- package/lib/endpoints/accounts/domains.js +36 -1
- package/lib/endpoints/accounts/dynamic-forms.js +109 -0
- package/lib/endpoints/accounts/email-settings.js +57 -1
- package/lib/endpoints/accounts/email-templates.js +113 -0
- package/lib/endpoints/accounts/exchange-rates.js +28 -0
- package/lib/endpoints/accounts/exchange-receipts.js +26 -0
- package/lib/endpoints/accounts/goal-settings.js +27 -0
- package/lib/endpoints/accounts/images.js +48 -1
- package/lib/endpoints/accounts/interline.js +94 -0
- package/lib/endpoints/accounts/journey-prices-settings.js +26 -0
- package/lib/endpoints/accounts/lexicons.js +46 -0
- package/lib/endpoints/accounts/market-pricing-settings.js +26 -0
- package/lib/endpoints/accounts/multiproduct-sales-settings.js +26 -0
- package/lib/endpoints/accounts/network.js +71 -0
- package/lib/endpoints/accounts/operation-settings.js +27 -0
- package/lib/endpoints/accounts/people-lookups.js +60 -0
- package/lib/endpoints/accounts/point-to-point-settings.js +26 -0
- package/lib/endpoints/accounts/print-settings.js +27 -1
- package/lib/endpoints/accounts/print-templates.js +67 -1
- package/lib/endpoints/accounts/printers.js +18 -1
- package/lib/endpoints/accounts/rms-settings.js +26 -0
- package/lib/endpoints/accounts/s3buckets.js +37 -0
- package/lib/endpoints/accounts/salesforce-settings.js +27 -0
- package/lib/endpoints/accounts/shift-settings.js +27 -0
- package/lib/endpoints/accounts/shifts.js +284 -0
- package/lib/endpoints/accounts/sms-templates.js +86 -0
- package/lib/endpoints/accounts/sub-print-templates.js +19 -2
- package/lib/endpoints/accounts/ticket-movement-settings.js +26 -0
- package/lib/endpoints/accounts/tokens.js +28 -1
- package/lib/endpoints/accounts/transport-regulation-settings.js +26 -0
- package/lib/endpoints/accounts/travellers.js +60 -1
- package/lib/endpoints/accounts/trusted-machines.js +37 -1
- package/lib/endpoints/accounts/twilio-settings.js +27 -0
- package/lib/endpoints/accounts/users.js +169 -1
- package/lib/endpoints/accounts/websales-config.js +29 -1
- package/lib/endpoints/btrzpay/cardpointe.js +57 -0
- package/lib/endpoints/btrzpay/customerCards.js +53 -2
- package/lib/endpoints/btrzpay/customers.js +40 -1
- package/lib/endpoints/btrzpay/datalogic.js +64 -1
- package/lib/endpoints/btrzpay/docs.js +11 -0
- package/lib/endpoints/btrzpay/oxxo.js +70 -4
- package/lib/endpoints/btrzpay/payment-methods.js +101 -2
- package/lib/endpoints/btrzpay/payments.js +28 -2
- package/lib/endpoints/btrzpay/prismaTerminals.js +147 -0
- package/lib/endpoints/btrzpay/reference-numbers.js +19 -2
- package/lib/endpoints/btrzpay/referenced-payments.js +31 -1
- package/lib/endpoints/btrzpay/square.js +35 -1
- package/lib/endpoints/btrzpay/stripe-terminals.js +34 -0
- package/lib/endpoints/btrzpay/terminalPayments.js +46 -0
- package/lib/endpoints/coltrane/docs.js +10 -0
- package/lib/endpoints/coltrane/merged-fare-tables.js +20 -0
- package/lib/endpoints/coltrane/paths.js +27 -0
- package/lib/endpoints/endpoints_helpers.js +11 -1
- package/lib/endpoints/gps/scanner-app-location.js +24 -1
- package/lib/endpoints/inventory/amenities.js +53 -2
- package/lib/endpoints/inventory/amenity-groups.js +53 -2
- package/lib/endpoints/inventory/banks.js +60 -0
- package/lib/endpoints/inventory/bare-routes.js +34 -1
- package/lib/endpoints/inventory/brands.js +52 -2
- package/lib/endpoints/inventory/bundle-fares.js +26 -2
- package/lib/endpoints/inventory/bundles.js +33 -2
- package/lib/endpoints/inventory/change-requests.js +81 -0
- package/lib/endpoints/inventory/companies.js +24 -2
- package/lib/endpoints/inventory/control-classes.js +56 -0
- package/lib/endpoints/inventory/countries.js +28 -0
- package/lib/endpoints/inventory/custom-content.js +61 -1
- package/lib/endpoints/inventory/custom-fields.js +61 -1
- package/lib/endpoints/inventory/docs.js +10 -0
- package/lib/endpoints/inventory/document-types.js +67 -1
- package/lib/endpoints/inventory/external-passes.js +32 -0
- package/lib/endpoints/inventory/external-wallets.js +56 -0
- package/lib/endpoints/inventory/fallback-codes.js +45 -0
- package/lib/endpoints/inventory/fare-classes.js +44 -2
- package/lib/endpoints/inventory/fares.js +72 -2
- package/lib/endpoints/inventory/fees.js +51 -2
- package/lib/endpoints/inventory/filtered-trips-v2.js +19 -2
- package/lib/endpoints/inventory/filtered-trips.js +27 -0
- package/lib/endpoints/inventory/financing-costs.js +62 -0
- package/lib/endpoints/inventory/garages.js +61 -1
- package/lib/endpoints/inventory/getnet-terminals.js +55 -0
- package/lib/endpoints/inventory/gift-certificate-definitions.js +63 -0
- package/lib/endpoints/inventory/healthcheck.js +11 -5
- package/lib/endpoints/inventory/insurances.js +59 -1
- package/lib/endpoints/inventory/insurancesCost.js +25 -1
- package/lib/endpoints/inventory/items.js +59 -0
- package/lib/endpoints/inventory/journey-prices.js +62 -2
- package/lib/endpoints/inventory/labels.js +61 -0
- package/lib/endpoints/inventory/marital-status.js +65 -1
- package/lib/endpoints/inventory/marketplace-modifiers.js +58 -0
- package/lib/endpoints/inventory/mit-terminal-settings.js +60 -0
- package/lib/endpoints/inventory/mit-terminals.js +60 -0
- package/lib/endpoints/inventory/operating-companies.js +96 -2
- package/lib/endpoints/inventory/operation-messages.js +68 -3
- package/lib/endpoints/inventory/operation-reasons.js +59 -0
- package/lib/endpoints/inventory/parcel-zones.js +42 -2
- package/lib/endpoints/inventory/pay-on-accounts.js +24 -0
- package/lib/endpoints/inventory/payment-terminals.js +59 -2
- package/lib/endpoints/inventory/prisma-terminals.js +60 -0
- package/lib/endpoints/inventory/products.js +67 -0
- package/lib/endpoints/inventory/promos.js +95 -1
- package/lib/endpoints/inventory/routes.js +263 -0
- package/lib/endpoints/inventory/schedule-groups.js +52 -0
- package/lib/endpoints/inventory/schedules.js +113 -0
- package/lib/endpoints/inventory/seatclasses.js +64 -0
- package/lib/endpoints/inventory/seatfees.js +50 -2
- package/lib/endpoints/inventory/seatmaps.js +86 -1
- package/lib/endpoints/inventory/segments-information-tables.js +24 -0
- package/lib/endpoints/inventory/segments-information.js +60 -0
- package/lib/endpoints/inventory/service-numbers.js +52 -1
- package/lib/endpoints/inventory/service-types.js +59 -2
- package/lib/endpoints/inventory/ssrs.js +23 -2
- package/lib/endpoints/inventory/station-classes.js +56 -0
- package/lib/endpoints/inventory/station-groups.js +23 -0
- package/lib/endpoints/inventory/stations-provinces.js +23 -0
- package/lib/endpoints/inventory/stations-zones.js +23 -0
- package/lib/endpoints/inventory/stations.js +52 -1
- package/lib/endpoints/inventory/taxes.js +104 -2
- package/lib/endpoints/inventory/travel-routes.js +52 -1
- package/lib/endpoints/inventory/traveller-card-providers-types.js +23 -1
- package/lib/endpoints/inventory/traveller-card-providers.js +52 -1
- package/lib/endpoints/inventory/traveller-card-types.js +61 -1
- package/lib/endpoints/inventory/trips.js +32 -1
- package/lib/endpoints/inventory/vehicle-types.js +15 -6
- package/lib/endpoints/inventory/vehicles.js +85 -1
- package/lib/endpoints/inventory/zone-price-overages.js +59 -2
- package/lib/endpoints/inventory/zone-prices.js +59 -2
- package/lib/endpoints/invoices/dlink.js +37 -1
- package/lib/endpoints/invoices/docs.js +10 -0
- package/lib/endpoints/invoices/emails.js +26 -1
- package/lib/endpoints/invoices/gti.js +37 -1
- package/lib/endpoints/invoices/infile.js +37 -1
- package/lib/endpoints/invoices/infileJson.js +37 -1
- package/lib/endpoints/invoices/invoices.js +64 -1
- package/lib/endpoints/invoices/pdfs.js +26 -1
- package/lib/endpoints/invoices/providers.js +66 -1
- package/lib/endpoints/invoices/providersSequences.js +71 -1
- package/lib/endpoints/invoices/system.js +37 -1
- package/lib/endpoints/invoices/tax-ids.js +29 -1
- package/lib/endpoints/loyalty/movements.js +50 -1
- package/lib/endpoints/loyalty/programs.js +45 -2
- package/lib/endpoints/notifications/customers.js +33 -1
- package/lib/endpoints/notifications/email.js +24 -1
- package/lib/endpoints/notifications/manifest-notifications.js +33 -1
- package/lib/endpoints/notifications/notify.js +56 -0
- package/lib/endpoints/notifications/orders-rules-validations.js +25 -1
- package/lib/endpoints/notifications/pdf-data.js +56 -5
- package/lib/endpoints/notifications/pdfs.js +27 -0
- package/lib/endpoints/notifications/printed-tickets.js +22 -1
- package/lib/endpoints/notifications/salesforce.js +19 -2
- package/lib/endpoints/notifications/twilio.js +53 -2
- package/lib/endpoints/operations/accounting_items.js +30 -0
- package/lib/endpoints/operations/applied_insurance.js +19 -2
- package/lib/endpoints/operations/calendar_entries.js +23 -2
- package/lib/endpoints/operations/docs.js +13 -1
- package/lib/endpoints/operations/external-bookings.js +33 -0
- package/lib/endpoints/operations/flexpasses.js +20 -1
- package/lib/endpoints/operations/loans.js +31 -1
- package/lib/endpoints/operations/manifest.js +328 -0
- package/lib/endpoints/operations/manifest_leg_for_tickets.js +20 -2
- package/lib/endpoints/operations/movements.js +25 -1
- package/lib/endpoints/operations/outlook-trips.js +27 -2
- package/lib/endpoints/operations/parcels.js +65 -2
- package/lib/endpoints/operations/parcels_manifests.js +94 -0
- package/lib/endpoints/operations/passenger_check_in_info.js +62 -1
- package/lib/endpoints/operations/redemption.js +38 -1
- package/lib/endpoints/operations/rms.js +34 -0
- package/lib/endpoints/operations/scheduled_notifications.js +69 -1
- package/lib/endpoints/operations/segments.js +27 -2
- package/lib/endpoints/operations/sold-items-fulfillment.js +23 -0
- package/lib/endpoints/operations/sold-items.js +33 -0
- package/lib/endpoints/operations/tickets.js +74 -0
- package/lib/endpoints/operations/transaction.js +20 -2
- package/lib/endpoints/operations/transactions.js +125 -0
- package/lib/endpoints/operations/transport_regulations.js +19 -1
- package/lib/endpoints/operations/trip_change_info.js +20 -2
- package/lib/endpoints/operations/vehicle_assignments.js +54 -0
- package/lib/endpoints/operations/vouchers.js +35 -0
- package/lib/endpoints/operations/waitlists.js +56 -1
- package/lib/endpoints/ratality/auth.js +14 -0
- package/lib/endpoints/ratality/clients.js +25 -0
- package/lib/endpoints/ratality/integrations.js +33 -0
- package/lib/endpoints/reports/custom-reports.js +45 -1
- package/lib/endpoints/reports/email.js +19 -0
- package/lib/endpoints/reports/report-types.js +31 -3
- package/lib/endpoints/reports/trip-manifests.js +27 -1
- package/lib/endpoints/sales/bundles.js +24 -2
- package/lib/endpoints/sales/cart-promo.js +36 -2
- package/lib/endpoints/sales/cart.js +154 -0
- package/lib/endpoints/sales/check-in-info.js +26 -1
- package/lib/endpoints/sales/custom-fields.js +24 -2
- package/lib/endpoints/sales/docs.js +10 -0
- package/lib/endpoints/sales/flexpasses.js +26 -1
- package/lib/endpoints/sales/gift-certificates.js +25 -1
- package/lib/endpoints/sales/order.js +50 -0
- package/lib/endpoints/sales/parcel-quotes.js +19 -0
- package/lib/endpoints/sales/payment-providers.js +25 -2
- package/lib/endpoints/sales/redeemable-items.js +34 -2
- package/lib/endpoints/sales/sync-entry.js +20 -2
- package/lib/endpoints/sales/voucher.js +44 -1
- package/lib/endpoints/seatmaps/access-ticket.js +18 -2
- package/lib/endpoints/seatmaps/seat.js +19 -2
- package/lib/endpoints/uploads/files.js +20 -2
- package/lib/endpoints/uploads/images.js +20 -2
- package/lib/endpoints/webhooks/events.js +26 -2
- package/lib/endpoints/webhooks/subscriptions.js +63 -2
- package/lib/endpoints/webhooks/undelivered.js +79 -2
- package/lib/endpoints/webhooks/webhooks.js +19 -2
- package/lib/productionDefaults.js +4 -0
- package/package.json +5 -7
- package/src/client.js +90 -0
- package/src/constants.js +4 -0
- package/src/endpoints/accounts/accounts.js +26 -1
- package/src/endpoints/accounts/application-settings.js +55 -1
- package/src/endpoints/accounts/application.js +17 -2
- package/src/endpoints/accounts/applications.js +26 -1
- package/src/endpoints/accounts/current-shifts.js +19 -2
- package/src/endpoints/accounts/customers.js +76 -2
- package/src/endpoints/accounts/docs.js +10 -0
- package/src/endpoints/accounts/domains.js +34 -1
- package/src/endpoints/accounts/dynamic-forms.js +103 -0
- package/src/endpoints/accounts/email-settings.js +55 -1
- package/src/endpoints/accounts/email-templates.js +111 -0
- package/src/endpoints/accounts/exchange-rates.js +26 -0
- package/src/endpoints/accounts/exchange-receipts.js +24 -0
- package/src/endpoints/accounts/goal-settings.js +25 -0
- package/src/endpoints/accounts/images.js +46 -1
- package/src/endpoints/accounts/interline.js +88 -0
- package/src/endpoints/accounts/journey-prices-settings.js +24 -0
- package/src/endpoints/accounts/lexicons.js +44 -0
- package/src/endpoints/accounts/market-pricing-settings.js +24 -0
- package/src/endpoints/accounts/multiproduct-sales-settings.js +24 -0
- package/src/endpoints/accounts/network.js +64 -0
- package/src/endpoints/accounts/operation-settings.js +25 -0
- package/src/endpoints/accounts/people-lookups.js +58 -0
- package/src/endpoints/accounts/point-to-point-settings.js +24 -0
- package/src/endpoints/accounts/print-settings.js +25 -1
- package/src/endpoints/accounts/print-templates.js +67 -3
- package/src/endpoints/accounts/printers.js +16 -1
- package/src/endpoints/accounts/rms-settings.js +24 -0
- package/src/endpoints/accounts/s3buckets.js +35 -0
- package/src/endpoints/accounts/salesforce-settings.js +25 -0
- package/src/endpoints/accounts/shift-settings.js +25 -0
- package/src/endpoints/accounts/shifts.js +278 -0
- package/src/endpoints/accounts/sms-templates.js +84 -0
- package/src/endpoints/accounts/sub-print-templates.js +17 -2
- package/src/endpoints/accounts/ticket-movement-settings.js +24 -0
- package/src/endpoints/accounts/tokens.js +26 -1
- package/src/endpoints/accounts/transport-regulation-settings.js +24 -0
- package/src/endpoints/accounts/travellers.js +58 -1
- package/src/endpoints/accounts/trusted-machines.js +35 -1
- package/src/endpoints/accounts/twilio-settings.js +25 -0
- package/src/endpoints/accounts/users.js +163 -1
- package/src/endpoints/accounts/websales-config.js +27 -1
- package/src/endpoints/btrzpay/cardpointe.js +56 -2
- package/src/endpoints/btrzpay/customerCards.js +52 -2
- package/src/endpoints/btrzpay/customers.js +39 -1
- package/src/endpoints/btrzpay/datalogic.js +60 -1
- package/src/endpoints/btrzpay/docs.js +11 -0
- package/src/endpoints/btrzpay/oxxo.js +66 -4
- package/src/endpoints/btrzpay/payment-methods.js +106 -9
- package/src/endpoints/btrzpay/payments.js +30 -6
- package/src/endpoints/btrzpay/prismaTerminals.js +137 -0
- package/src/endpoints/btrzpay/reference-numbers.js +20 -5
- package/src/endpoints/btrzpay/referenced-payments.js +29 -1
- package/src/endpoints/btrzpay/square.js +33 -1
- package/src/endpoints/btrzpay/stripe-terminals.js +32 -0
- package/src/endpoints/btrzpay/terminalPayments.js +43 -0
- package/src/endpoints/coltrane/docs.js +10 -0
- package/src/endpoints/coltrane/merged-fare-tables.js +18 -0
- package/src/endpoints/coltrane/paths.js +25 -0
- package/src/endpoints/endpoints_helpers.js +11 -1
- package/src/endpoints/gps/scanner-app-location.js +24 -1
- package/src/endpoints/inventory/amenities.js +57 -8
- package/src/endpoints/inventory/amenity-groups.js +57 -8
- package/src/endpoints/inventory/banks.js +58 -0
- package/src/endpoints/inventory/bare-routes.js +32 -1
- package/src/endpoints/inventory/brands.js +58 -10
- package/src/endpoints/inventory/bundle-fares.js +25 -4
- package/src/endpoints/inventory/bundles.js +34 -5
- package/src/endpoints/inventory/change-requests.js +75 -0
- package/src/endpoints/inventory/companies.js +24 -4
- package/src/endpoints/inventory/control-classes.js +54 -0
- package/src/endpoints/inventory/countries.js +26 -0
- package/src/endpoints/inventory/custom-content.js +61 -3
- package/src/endpoints/inventory/custom-fields.js +59 -1
- package/src/endpoints/inventory/docs.js +10 -0
- package/src/endpoints/inventory/document-types.js +65 -1
- package/src/endpoints/inventory/external-passes.js +30 -0
- package/src/endpoints/inventory/external-wallets.js +54 -0
- package/src/endpoints/inventory/fallback-codes.js +43 -0
- package/src/endpoints/inventory/fare-classes.js +48 -8
- package/src/endpoints/inventory/fares.js +80 -15
- package/src/endpoints/inventory/fees.js +58 -12
- package/src/endpoints/inventory/filtered-trips-v2.js +17 -2
- package/src/endpoints/inventory/filtered-trips.js +25 -0
- package/src/endpoints/inventory/financing-costs.js +60 -0
- package/src/endpoints/inventory/garages.js +59 -1
- package/src/endpoints/inventory/getnet-terminals.js +53 -0
- package/src/endpoints/inventory/gift-certificate-definitions.js +61 -0
- package/src/endpoints/inventory/healthcheck.js +11 -3
- package/src/endpoints/inventory/insurances.js +58 -2
- package/src/endpoints/inventory/insurancesCost.js +23 -1
- package/src/endpoints/inventory/items.js +57 -0
- package/src/endpoints/inventory/journey-prices.js +69 -12
- package/src/endpoints/inventory/labels.js +59 -0
- package/src/endpoints/inventory/marital-status.js +63 -1
- package/src/endpoints/inventory/marketplace-modifiers.js +56 -0
- package/src/endpoints/inventory/mit-terminal-settings.js +58 -0
- package/src/endpoints/inventory/mit-terminals.js +58 -0
- package/src/endpoints/inventory/operating-companies.js +98 -9
- package/src/endpoints/inventory/operation-messages.js +72 -9
- package/src/endpoints/inventory/operation-reasons.js +57 -0
- package/src/endpoints/inventory/parcel-zones.js +49 -11
- package/src/endpoints/inventory/pay-on-accounts.js +22 -0
- package/src/endpoints/inventory/payment-terminals.js +59 -4
- package/src/endpoints/inventory/prisma-terminals.js +58 -0
- package/src/endpoints/inventory/products.js +65 -0
- package/src/endpoints/inventory/promos.js +93 -1
- package/src/endpoints/inventory/routes.js +251 -0
- package/src/endpoints/inventory/schedule-groups.js +50 -0
- package/src/endpoints/inventory/schedules.js +111 -0
- package/src/endpoints/inventory/seatclasses.js +62 -0
- package/src/endpoints/inventory/seatfees.js +49 -3
- package/src/endpoints/inventory/seatmaps.js +84 -1
- package/src/endpoints/inventory/segments-information-tables.js +22 -0
- package/src/endpoints/inventory/segments-information.js +58 -0
- package/src/endpoints/inventory/service-numbers.js +52 -3
- package/src/endpoints/inventory/service-types.js +58 -3
- package/src/endpoints/inventory/ssrs.js +25 -7
- package/src/endpoints/inventory/station-classes.js +54 -0
- package/src/endpoints/inventory/station-groups.js +21 -0
- package/src/endpoints/inventory/stations-provinces.js +21 -0
- package/src/endpoints/inventory/stations-zones.js +21 -0
- package/src/endpoints/inventory/stations.js +53 -4
- package/src/endpoints/inventory/taxes.js +98 -2
- package/src/endpoints/inventory/travel-routes.js +50 -1
- package/src/endpoints/inventory/traveller-card-providers-types.js +21 -1
- package/src/endpoints/inventory/traveller-card-providers.js +51 -2
- package/src/endpoints/inventory/traveller-card-types.js +59 -1
- package/src/endpoints/inventory/trips.js +32 -3
- package/src/endpoints/inventory/vehicle-types.js +13 -6
- package/src/endpoints/inventory/vehicles.js +82 -1
- package/src/endpoints/inventory/zone-price-overages.js +57 -2
- package/src/endpoints/inventory/zone-prices.js +57 -2
- package/src/endpoints/invoices/dlink.js +35 -1
- package/src/endpoints/invoices/docs.js +10 -0
- package/src/endpoints/invoices/emails.js +24 -1
- package/src/endpoints/invoices/gti.js +35 -1
- package/src/endpoints/invoices/infile.js +35 -1
- package/src/endpoints/invoices/infileJson.js +35 -1
- package/src/endpoints/invoices/invoices.js +62 -1
- package/src/endpoints/invoices/pdfs.js +24 -1
- package/src/endpoints/invoices/providers.js +64 -1
- package/src/endpoints/invoices/providersSequences.js +69 -1
- package/src/endpoints/invoices/system.js +35 -1
- package/src/endpoints/invoices/tax-ids.js +27 -1
- package/src/endpoints/loyalty/movements.js +52 -6
- package/src/endpoints/loyalty/programs.js +49 -9
- package/src/endpoints/notifications/customers.js +31 -1
- package/src/endpoints/notifications/email.js +22 -1
- package/src/endpoints/notifications/manifest-notifications.js +31 -1
- package/src/endpoints/notifications/notify.js +54 -0
- package/src/endpoints/notifications/orders-rules-validations.js +23 -1
- package/src/endpoints/notifications/pdf-data.js +59 -5
- package/src/endpoints/notifications/pdfs.js +25 -0
- package/src/endpoints/notifications/printed-tickets.js +20 -1
- package/src/endpoints/notifications/salesforce.js +17 -2
- package/src/endpoints/notifications/twilio.js +50 -2
- package/src/endpoints/operations/accounting_items.js +28 -0
- package/src/endpoints/operations/applied_insurance.js +22 -7
- package/src/endpoints/operations/calendar_entries.js +24 -5
- package/src/endpoints/operations/docs.js +12 -1
- package/src/endpoints/operations/external-bookings.js +31 -0
- package/src/endpoints/operations/flexpasses.js +18 -1
- package/src/endpoints/operations/loans.js +29 -1
- package/src/endpoints/operations/manifest.js +322 -0
- package/src/endpoints/operations/manifest_leg_for_tickets.js +21 -5
- package/src/endpoints/operations/movements.js +26 -5
- package/src/endpoints/operations/outlook-trips.js +24 -3
- package/src/endpoints/operations/parcels.js +68 -7
- package/src/endpoints/operations/parcels_manifests.js +91 -0
- package/src/endpoints/operations/passenger_check_in_info.js +60 -1
- package/src/endpoints/operations/redemption.js +36 -1
- package/src/endpoints/operations/rms.js +31 -0
- package/src/endpoints/operations/scheduled_notifications.js +72 -6
- package/src/endpoints/operations/segments.js +27 -4
- package/src/endpoints/operations/sold-items-fulfillment.js +21 -0
- package/src/endpoints/operations/sold-items.js +31 -0
- package/src/endpoints/operations/tickets.js +72 -0
- package/src/endpoints/operations/transaction.js +22 -6
- package/src/endpoints/operations/transactions.js +123 -0
- package/src/endpoints/operations/transport_regulations.js +17 -1
- package/src/endpoints/operations/trip_change_info.js +21 -5
- package/src/endpoints/operations/vehicle_assignments.js +49 -0
- package/src/endpoints/operations/vouchers.js +33 -0
- package/src/endpoints/operations/waitlists.js +58 -5
- package/src/endpoints/ratality/auth.js +14 -0
- package/src/endpoints/ratality/clients.js +23 -0
- package/src/endpoints/ratality/integrations.js +31 -0
- package/src/endpoints/reports/custom-reports.js +47 -5
- package/src/endpoints/reports/email.js +17 -0
- package/src/endpoints/reports/report-types.js +31 -5
- package/src/endpoints/reports/trip-manifests.js +27 -3
- package/src/endpoints/sales/bundles.js +24 -4
- package/src/endpoints/sales/cart-promo.js +39 -7
- package/src/endpoints/sales/cart.js +150 -0
- package/src/endpoints/sales/check-in-info.js +28 -5
- package/src/endpoints/sales/custom-fields.js +24 -4
- package/src/endpoints/sales/docs.js +10 -0
- package/src/endpoints/sales/flexpasses.js +24 -1
- package/src/endpoints/sales/gift-certificates.js +23 -1
- package/src/endpoints/sales/order.js +48 -0
- package/src/endpoints/sales/parcel-quotes.js +18 -1
- package/src/endpoints/sales/payment-providers.js +26 -6
- package/src/endpoints/sales/redeemable-items.js +33 -3
- package/src/endpoints/sales/sync-entry.js +20 -5
- package/src/endpoints/sales/voucher.js +42 -1
- package/src/endpoints/seatmaps/access-ticket.js +20 -6
- package/src/endpoints/seatmaps/seat.js +20 -5
- package/src/endpoints/uploads/files.js +21 -5
- package/src/endpoints/uploads/images.js +21 -7
- package/src/endpoints/webhooks/events.js +28 -6
- package/src/endpoints/webhooks/subscriptions.js +73 -15
- package/src/endpoints/webhooks/undelivered.js +92 -17
- package/src/endpoints/webhooks/webhooks.js +21 -7
- package/src/productionDefaults.js +10 -2
- package/types/client.d.ts +46 -5670
- package/types/constants.d.ts +8 -1
- package/types/endpoints/accounts/accounts.d.ts +13 -14
- package/types/endpoints/accounts/application-settings.d.ts +16 -34
- package/types/endpoints/accounts/application.d.ts +12 -7
- package/types/endpoints/accounts/applications.d.ts +13 -14
- package/types/endpoints/accounts/current-shifts.d.ts +12 -8
- package/types/endpoints/accounts/customers.d.ts +18 -48
- package/types/endpoints/accounts/docs.d.ts +8 -2
- package/types/endpoints/accounts/domains.d.ts +14 -19
- package/types/endpoints/accounts/dynamic-forms.d.ts +21 -62
- package/types/endpoints/accounts/email-settings.d.ts +16 -34
- package/types/endpoints/accounts/email-templates.d.ts +127 -54
- package/types/endpoints/accounts/exchange-rates.d.ts +13 -15
- package/types/endpoints/accounts/exchange-receipts.d.ts +13 -13
- package/types/endpoints/accounts/goal-settings.d.ts +13 -14
- package/types/endpoints/accounts/images.d.ts +15 -27
- package/types/endpoints/accounts/interline.d.ts +16 -64
- package/types/endpoints/accounts/journey-prices-settings.d.ts +13 -13
- package/types/endpoints/accounts/lexicons.d.ts +21 -136
- package/types/endpoints/accounts/market-pricing-settings.d.ts +13 -13
- package/types/endpoints/accounts/multiproduct-sales-settings.d.ts +13 -13
- package/types/endpoints/accounts/network.d.ts +17 -40
- package/types/endpoints/accounts/operation-settings.d.ts +13 -14
- package/types/endpoints/accounts/people-lookups.d.ts +16 -38
- package/types/endpoints/accounts/point-to-point-settings.d.ts +13 -13
- package/types/endpoints/accounts/print-settings.d.ts +13 -13
- package/types/endpoints/accounts/print-templates.d.ts +17 -41
- package/types/endpoints/accounts/printers.d.ts +12 -7
- package/types/endpoints/accounts/rms-settings.d.ts +13 -13
- package/types/endpoints/accounts/s3buckets.d.ts +14 -21
- package/types/endpoints/accounts/salesforce-settings.d.ts +13 -14
- package/types/endpoints/accounts/shift-settings.d.ts +13 -14
- package/types/endpoints/accounts/shifts.d.ts +34 -227
- package/types/endpoints/accounts/sms-templates.d.ts +19 -54
- package/types/endpoints/accounts/sub-print-templates.d.ts +12 -8
- package/types/endpoints/accounts/ticket-movement-settings.d.ts +13 -13
- package/types/endpoints/accounts/tokens.d.ts +13 -14
- package/types/endpoints/accounts/transport-regulation-settings.d.ts +13 -13
- package/types/endpoints/accounts/travellers.d.ts +16 -37
- package/types/endpoints/accounts/trusted-machines.d.ts +14 -20
- package/types/endpoints/accounts/twilio-settings.d.ts +13 -14
- package/types/endpoints/accounts/users.d.ts +27 -99
- package/types/endpoints/accounts/websales-config.d.ts +13 -15
- package/types/endpoints/btrzpay/cardpointe.d.ts +15 -36
- package/types/endpoints/btrzpay/customerCards.d.ts +15 -33
- package/types/endpoints/btrzpay/customers.d.ts +14 -23
- package/types/endpoints/btrzpay/datalogic.d.ts +27 -44
- package/types/endpoints/btrzpay/docs.d.ts +12 -2
- package/types/endpoints/btrzpay/oxxo.d.ts +41 -38
- package/types/endpoints/btrzpay/payment-methods.d.ts +29 -58
- package/types/endpoints/btrzpay/payments.d.ts +13 -14
- package/types/endpoints/btrzpay/prismaTerminals.d.ts +31 -98
- package/types/endpoints/btrzpay/reference-numbers.d.ts +12 -8
- package/types/endpoints/btrzpay/referenced-payments.d.ts +13 -17
- package/types/endpoints/btrzpay/square.d.ts +24 -16
- package/types/endpoints/btrzpay/stripe-terminals.d.ts +26 -16
- package/types/endpoints/btrzpay/terminalPayments.d.ts +26 -28
- package/types/endpoints/coltrane/docs.d.ts +8 -2
- package/types/endpoints/coltrane/merged-fare-tables.d.ts +12 -9
- package/types/endpoints/coltrane/paths.d.ts +44 -7
- package/types/endpoints/endpoints_helpers.d.ts +16 -9
- package/types/endpoints/gps/scanner-app-location.d.ts +44 -6
- package/types/endpoints/inventory/amenities.d.ts +28 -26
- package/types/endpoints/inventory/amenity-groups.d.ts +28 -26
- package/types/endpoints/inventory/banks.d.ts +29 -33
- package/types/endpoints/inventory/bare-routes.d.ts +26 -13
- package/types/endpoints/inventory/brands.d.ts +28 -27
- package/types/endpoints/inventory/bundle-fares.d.ts +25 -9
- package/types/endpoints/inventory/bundles.d.ts +26 -14
- package/types/endpoints/inventory/change-requests.d.ts +16 -50
- package/types/endpoints/inventory/companies.d.ts +23 -8
- package/types/endpoints/inventory/control-classes.d.ts +16 -34
- package/types/endpoints/inventory/countries.d.ts +13 -14
- package/types/endpoints/inventory/custom-content.d.ts +27 -31
- package/types/endpoints/inventory/custom-fields.d.ts +27 -33
- package/types/endpoints/inventory/docs.d.ts +8 -2
- package/types/endpoints/inventory/document-types.d.ts +29 -39
- package/types/endpoints/inventory/external-passes.d.ts +26 -14
- package/types/endpoints/inventory/external-wallets.d.ts +12 -36
- package/types/endpoints/inventory/fallback-codes.d.ts +15 -26
- package/types/endpoints/inventory/fare-classes.d.ts +25 -21
- package/types/endpoints/inventory/fares.d.ts +28 -39
- package/types/endpoints/inventory/fees.d.ts +26 -26
- package/types/endpoints/inventory/filtered-trips-v2.d.ts +12 -8
- package/types/endpoints/inventory/filtered-trips.d.ts +13 -14
- package/types/endpoints/inventory/financing-costs.d.ts +29 -35
- package/types/endpoints/inventory/garages.d.ts +29 -33
- package/types/endpoints/inventory/getnet-terminals.d.ts +16 -33
- package/types/endpoints/inventory/gift-certificate-definitions.d.ts +27 -36
- package/types/endpoints/inventory/healthcheck.d.ts +9 -4
- package/types/endpoints/inventory/insurances.d.ts +27 -31
- package/types/endpoints/inventory/insurancesCost.d.ts +23 -9
- package/types/endpoints/inventory/items.d.ts +16 -38
- package/types/endpoints/inventory/journey-prices.d.ts +27 -34
- package/types/endpoints/inventory/labels.d.ts +29 -34
- package/types/endpoints/inventory/marital-status.d.ts +27 -37
- package/types/endpoints/inventory/marketplace-modifiers.d.ts +27 -31
- package/types/endpoints/inventory/mit-terminal-settings.d.ts +29 -33
- package/types/endpoints/inventory/mit-terminals.d.ts +29 -31
- package/types/endpoints/inventory/operating-companies.d.ts +29 -57
- package/types/endpoints/inventory/operation-messages.d.ts +28 -37
- package/types/endpoints/inventory/operation-reasons.d.ts +16 -37
- package/types/endpoints/inventory/parcel-zones.d.ts +25 -20
- package/types/endpoints/inventory/pay-on-accounts.d.ts +25 -9
- package/types/endpoints/inventory/payment-terminals.d.ts +27 -31
- package/types/endpoints/inventory/prisma-terminals.d.ts +29 -33
- package/types/endpoints/inventory/products.d.ts +17 -42
- package/types/endpoints/inventory/promos.d.ts +30 -54
- package/types/endpoints/inventory/routes.d.ts +24 -174
- package/types/endpoints/inventory/schedule-groups.d.ts +28 -28
- package/types/endpoints/inventory/schedules.d.ts +18 -75
- package/types/endpoints/inventory/seatclasses.d.ts +27 -37
- package/types/endpoints/inventory/seatfees.d.ts +26 -25
- package/types/endpoints/inventory/seatmaps.d.ts +31 -49
- package/types/endpoints/inventory/segments-information-tables.d.ts +25 -9
- package/types/endpoints/inventory/segments-information.d.ts +29 -33
- package/types/endpoints/inventory/service-numbers.d.ts +26 -27
- package/types/endpoints/inventory/service-types.d.ts +27 -31
- package/types/endpoints/inventory/ssrs.d.ts +23 -7
- package/types/endpoints/inventory/station-classes.d.ts +16 -34
- package/types/endpoints/inventory/station-groups.d.ts +25 -7
- package/types/endpoints/inventory/stations-provinces.d.ts +25 -7
- package/types/endpoints/inventory/stations-zones.d.ts +25 -7
- package/types/endpoints/inventory/stations.d.ts +28 -25
- package/types/endpoints/inventory/taxes.d.ts +29 -59
- package/types/endpoints/inventory/travel-routes.d.ts +28 -27
- package/types/endpoints/inventory/traveller-card-providers-types.d.ts +23 -7
- package/types/endpoints/inventory/traveller-card-providers.d.ts +26 -27
- package/types/endpoints/inventory/traveller-card-types.d.ts +27 -33
- package/types/endpoints/inventory/trips.d.ts +24 -13
- package/types/endpoints/inventory/vehicle-types.d.ts +12 -14
- package/types/endpoints/inventory/vehicles.d.ts +30 -49
- package/types/endpoints/inventory/zone-price-overages.d.ts +27 -31
- package/types/endpoints/inventory/zone-prices.d.ts +27 -31
- package/types/endpoints/invoices/dlink.d.ts +30 -16
- package/types/endpoints/invoices/docs.d.ts +8 -2
- package/types/endpoints/invoices/emails.d.ts +23 -9
- package/types/endpoints/invoices/gti.d.ts +30 -16
- package/types/endpoints/invoices/infile.d.ts +30 -16
- package/types/endpoints/invoices/infileJson.d.ts +30 -16
- package/types/endpoints/invoices/invoices.d.ts +27 -35
- package/types/endpoints/invoices/pdfs.d.ts +23 -9
- package/types/endpoints/invoices/providers.d.ts +27 -37
- package/types/endpoints/invoices/providersSequences.d.ts +27 -42
- package/types/endpoints/invoices/system.d.ts +30 -16
- package/types/endpoints/invoices/tax-ids.d.ts +44 -8
- package/types/endpoints/loyalty/movements.d.ts +36 -27
- package/types/endpoints/loyalty/programs.d.ts +36 -21
- package/types/endpoints/notifications/customers.d.ts +24 -14
- package/types/endpoints/notifications/email.d.ts +23 -8
- package/types/endpoints/notifications/manifest-notifications.d.ts +24 -14
- package/types/endpoints/notifications/notify.d.ts +26 -31
- package/types/endpoints/notifications/orders-rules-validations.d.ts +23 -9
- package/types/endpoints/notifications/pdf-data.d.ts +30 -9
- package/types/endpoints/notifications/pdfs.d.ts +30 -10
- package/types/endpoints/notifications/printed-tickets.d.ts +12 -11
- package/types/endpoints/notifications/salesforce.d.ts +12 -8
- package/types/endpoints/notifications/twilio.d.ts +26 -27
- package/types/endpoints/operations/accounting_items.d.ts +24 -13
- package/types/endpoints/operations/applied_insurance.d.ts +12 -10
- package/types/endpoints/operations/calendar_entries.d.ts +24 -8
- package/types/endpoints/operations/docs.d.ts +13 -5
- package/types/endpoints/operations/external-bookings.d.ts +24 -16
- package/types/endpoints/operations/flexpasses.d.ts +12 -11
- package/types/endpoints/operations/loans.d.ts +24 -13
- package/types/endpoints/operations/manifest.d.ts +23 -240
- package/types/endpoints/operations/manifest_leg_for_tickets.d.ts +12 -11
- package/types/endpoints/operations/movements.d.ts +24 -10
- package/types/endpoints/operations/outlook-trips.d.ts +25 -8
- package/types/endpoints/operations/parcels.d.ts +24 -38
- package/types/endpoints/operations/parcels_manifests.d.ts +72 -48
- package/types/endpoints/operations/passenger_check_in_info.d.ts +46 -30
- package/types/endpoints/operations/redemption.d.ts +12 -23
- package/types/endpoints/operations/rms.d.ts +23 -17
- package/types/endpoints/operations/scheduled_notifications.d.ts +36 -36
- package/types/endpoints/operations/segments.d.ts +28 -11
- package/types/endpoints/operations/sold-items-fulfillment.d.ts +24 -9
- package/types/endpoints/operations/sold-items.d.ts +24 -16
- package/types/endpoints/operations/tickets.d.ts +24 -45
- package/types/endpoints/operations/transaction.d.ts +12 -11
- package/types/endpoints/operations/transactions.d.ts +23 -85
- package/types/endpoints/operations/transport_regulations.d.ts +11 -11
- package/types/endpoints/operations/trip_change_info.d.ts +12 -11
- package/types/endpoints/operations/vehicle_assignments.d.ts +24 -28
- package/types/endpoints/operations/vouchers.d.ts +23 -18
- package/types/endpoints/operations/waitlists.d.ts +43 -27
- package/types/endpoints/ratality/auth.d.ts +12 -5
- package/types/endpoints/ratality/clients.d.ts +15 -11
- package/types/endpoints/ratality/integrations.d.ts +16 -16
- package/types/endpoints/reports/custom-reports.d.ts +36 -20
- package/types/endpoints/reports/email.d.ts +12 -8
- package/types/endpoints/reports/report-types.d.ts +13 -14
- package/types/endpoints/reports/trip-manifests.d.ts +34 -8
- package/types/endpoints/sales/bundles.d.ts +25 -7
- package/types/endpoints/sales/cart-promo.d.ts +26 -16
- package/types/endpoints/sales/cart.d.ts +36 -107
- package/types/endpoints/sales/check-in-info.d.ts +25 -9
- package/types/endpoints/sales/custom-fields.d.ts +25 -7
- package/types/endpoints/sales/docs.d.ts +8 -2
- package/types/endpoints/sales/flexpasses.d.ts +25 -9
- package/types/endpoints/sales/gift-certificates.d.ts +25 -8
- package/types/endpoints/sales/order.d.ts +42 -22
- package/types/endpoints/sales/parcel-quotes.d.ts +12 -8
- package/types/endpoints/sales/payment-providers.d.ts +25 -8
- package/types/endpoints/sales/redeemable-items.d.ts +26 -14
- package/types/endpoints/sales/sync-entry.d.ts +12 -8
- package/types/endpoints/sales/voucher.d.ts +103 -7
- package/types/endpoints/seatmaps/access-ticket.d.ts +12 -7
- package/types/endpoints/seatmaps/seat.d.ts +12 -8
- package/types/endpoints/uploads/files.d.ts +12 -8
- package/types/endpoints/uploads/images.d.ts +12 -8
- package/types/endpoints/webhooks/events.d.ts +29 -9
- package/types/endpoints/webhooks/subscriptions.d.ts +33 -34
- package/types/endpoints/webhooks/undelivered.d.ts +35 -43
- package/types/endpoints/webhooks/webhooks.d.ts +12 -8
- package/types/initializedClient.d.ts +15 -5670
- package/types/productionDefaults.d.ts +9 -6
|
@@ -1,6 +1,14 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
/**
|
|
2
|
+
* Factory for healthcheck API (btrz-api-inventory).
|
|
3
|
+
* @param {Object} deps
|
|
4
|
+
* @param {import("axios").AxiosInstance} deps.client
|
|
5
|
+
* @returns {{ get: function }}
|
|
6
|
+
*/
|
|
7
|
+
function healthCheckFactory({client}) {
|
|
8
|
+
/**
|
|
9
|
+
* GET /healthcheck - health check.
|
|
10
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
11
|
+
*/
|
|
4
12
|
function get() {
|
|
5
13
|
return client({
|
|
6
14
|
url: "/healthcheck",
|
|
@@ -1,10 +1,30 @@
|
|
|
1
1
|
const {
|
|
2
2
|
authorizationHeaders
|
|
3
|
-
} = require("./../endpoints_helpers");
|
|
3
|
+
} = require("./../endpoints_helpers.js");
|
|
4
4
|
|
|
5
|
+
/**
|
|
6
|
+
* Query params for insurances endpoints (btrz-api-inventory). Forwarded to API as-is.
|
|
7
|
+
* @typedef {Object} InventoryInsurancesQuery
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Factory for insurances API (btrz-api-inventory).
|
|
12
|
+
* @param {Object} deps
|
|
13
|
+
* @param {import("axios").AxiosInstance} deps.client
|
|
14
|
+
* @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
|
|
15
|
+
* @returns {{ all: function, create: function, get: function, update: function, remove: function }}
|
|
16
|
+
*/
|
|
5
17
|
function insurancesFactory({
|
|
6
18
|
client, internalAuthTokenProvider
|
|
7
19
|
}) {
|
|
20
|
+
/**
|
|
21
|
+
* GET /insurances - list insurances.
|
|
22
|
+
* @param {Object} opts
|
|
23
|
+
* @param {string} [opts.token] - API key
|
|
24
|
+
* @param {InventoryInsurancesQuery} [opts.query] - Optional query params (forwarded to API)
|
|
25
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
26
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
27
|
+
*/
|
|
8
28
|
function all({
|
|
9
29
|
token, query = {}, headers
|
|
10
30
|
}) {
|
|
@@ -16,6 +36,14 @@ function insurancesFactory({
|
|
|
16
36
|
});
|
|
17
37
|
}
|
|
18
38
|
|
|
39
|
+
/**
|
|
40
|
+
* GET /insurances/:insuranceId - get insurance by id.
|
|
41
|
+
* @param {Object} opts
|
|
42
|
+
* @param {string} [opts.token] - API key
|
|
43
|
+
* @param {string} opts.insuranceId - Insurance id
|
|
44
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
45
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
46
|
+
*/
|
|
19
47
|
function get({
|
|
20
48
|
token, insuranceId, headers
|
|
21
49
|
}) {
|
|
@@ -26,6 +54,15 @@ function insurancesFactory({
|
|
|
26
54
|
});
|
|
27
55
|
}
|
|
28
56
|
|
|
57
|
+
/**
|
|
58
|
+
* POST /insurances - create insurance.
|
|
59
|
+
* @param {Object} opts
|
|
60
|
+
* @param {string} [opts.token] - API key
|
|
61
|
+
* @param {Object} opts.insurance - Insurance payload
|
|
62
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
63
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
64
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
65
|
+
*/
|
|
29
66
|
function create({
|
|
30
67
|
token, insurance, jwtToken, headers
|
|
31
68
|
}) {
|
|
@@ -39,6 +76,16 @@ function insurancesFactory({
|
|
|
39
76
|
});
|
|
40
77
|
}
|
|
41
78
|
|
|
79
|
+
/**
|
|
80
|
+
* PUT /insurances/:insuranceId - update insurance.
|
|
81
|
+
* @param {Object} opts
|
|
82
|
+
* @param {string} [opts.token] - API key
|
|
83
|
+
* @param {Object} opts.insurance - Insurance payload
|
|
84
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
85
|
+
* @param {string} opts.insuranceId - Insurance id
|
|
86
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
87
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
88
|
+
*/
|
|
42
89
|
function update({
|
|
43
90
|
token, insurance, jwtToken, insuranceId, headers
|
|
44
91
|
}) {
|
|
@@ -52,6 +99,15 @@ function insurancesFactory({
|
|
|
52
99
|
});
|
|
53
100
|
}
|
|
54
101
|
|
|
102
|
+
/**
|
|
103
|
+
* DELETE /insurances/:insuranceId - remove insurance.
|
|
104
|
+
* @param {Object} opts
|
|
105
|
+
* @param {string} [opts.token] - API key
|
|
106
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
107
|
+
* @param {string} opts.insuranceId - Insurance id
|
|
108
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
109
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
110
|
+
*/
|
|
55
111
|
function remove({
|
|
56
112
|
token, jwtToken, insuranceId, headers
|
|
57
113
|
}) {
|
|
@@ -73,4 +129,4 @@ function insurancesFactory({
|
|
|
73
129
|
};
|
|
74
130
|
}
|
|
75
131
|
|
|
76
|
-
module.exports = insurancesFactory;
|
|
132
|
+
module.exports = insurancesFactory;
|
|
@@ -1,10 +1,32 @@
|
|
|
1
1
|
const {
|
|
2
2
|
authorizationHeaders
|
|
3
|
-
} = require("./../endpoints_helpers");
|
|
3
|
+
} = require("./../endpoints_helpers.js");
|
|
4
4
|
|
|
5
|
+
/**
|
|
6
|
+
* Query params for insurances cost endpoints (btrz-api-inventory). Forwarded to API as-is.
|
|
7
|
+
* @typedef {Object} InventoryInsurancesCostQuery
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Factory for insurances cost API (btrz-api-inventory).
|
|
12
|
+
* @param {Object} deps
|
|
13
|
+
* @param {import("axios").AxiosInstance} deps.client
|
|
14
|
+
* @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
|
|
15
|
+
* @returns {{ get: function }}
|
|
16
|
+
*/
|
|
5
17
|
function insurancesCostFactory({
|
|
6
18
|
client, internalAuthTokenProvider
|
|
7
19
|
}) {
|
|
20
|
+
/**
|
|
21
|
+
* GET /insurances/:productId/cost - get insurance cost for product.
|
|
22
|
+
* @param {Object} opts
|
|
23
|
+
* @param {string} [opts.token] - API key
|
|
24
|
+
* @param {string} opts.productId - Product id
|
|
25
|
+
* @param {*} opts.declaredValue - Declared value (merged into query)
|
|
26
|
+
* @param {InventoryInsurancesCostQuery} [opts.query] - Optional query params (forwarded to API)
|
|
27
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
28
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
29
|
+
*/
|
|
8
30
|
function get({
|
|
9
31
|
token, productId, declaredValue, query = {}, headers
|
|
10
32
|
}) {
|
|
@@ -2,7 +2,23 @@ const {
|
|
|
2
2
|
authorizationHeaders
|
|
3
3
|
} = require("./../endpoints_helpers.js");
|
|
4
4
|
|
|
5
|
+
/**
|
|
6
|
+
* Factory for items API (btrz-api-inventory).
|
|
7
|
+
* @param {Object} deps
|
|
8
|
+
* @param {import("axios").AxiosInstance} deps.client
|
|
9
|
+
* @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
|
|
10
|
+
* @returns {{ all: function, get: function, create: function, update: function, tickets: object }}
|
|
11
|
+
*/
|
|
5
12
|
function itemsFactory({client, internalAuthTokenProvider}) {
|
|
13
|
+
/**
|
|
14
|
+
* GET /items - list items.
|
|
15
|
+
* @param {Object} opts
|
|
16
|
+
* @param {string} [opts.token] - API key
|
|
17
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
18
|
+
* @param {Object} [opts.query] - Query params
|
|
19
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
20
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
21
|
+
*/
|
|
6
22
|
function all({
|
|
7
23
|
token,
|
|
8
24
|
query = {},
|
|
@@ -16,6 +32,16 @@ function itemsFactory({client, internalAuthTokenProvider}) {
|
|
|
16
32
|
});
|
|
17
33
|
}
|
|
18
34
|
|
|
35
|
+
/**
|
|
36
|
+
* GET /items/:itemId - get item by id.
|
|
37
|
+
* @param {Object} opts
|
|
38
|
+
* @param {string} [opts.token] - API key
|
|
39
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
40
|
+
* @param {string} opts.itemId - Item id
|
|
41
|
+
* @param {Object} [opts.query] - Query params
|
|
42
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
43
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
44
|
+
*/
|
|
19
45
|
function get({itemId, token, jwtToken, query = {}, headers}) {
|
|
20
46
|
return client.get(`/items/${itemId}`, {
|
|
21
47
|
params: query,
|
|
@@ -23,6 +49,15 @@ function itemsFactory({client, internalAuthTokenProvider}) {
|
|
|
23
49
|
});
|
|
24
50
|
}
|
|
25
51
|
|
|
52
|
+
/**
|
|
53
|
+
* POST /items - create item.
|
|
54
|
+
* @param {Object} opts
|
|
55
|
+
* @param {string} [opts.token] - API key
|
|
56
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
57
|
+
* @param {Object} opts.item - Item payload
|
|
58
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
59
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
60
|
+
*/
|
|
26
61
|
function create({jwtToken, item, token, headers}) {
|
|
27
62
|
return client({
|
|
28
63
|
url: "/items",
|
|
@@ -32,6 +67,16 @@ function itemsFactory({client, internalAuthTokenProvider}) {
|
|
|
32
67
|
});
|
|
33
68
|
}
|
|
34
69
|
|
|
70
|
+
/**
|
|
71
|
+
* PUT /items/:itemId - update item.
|
|
72
|
+
* @param {Object} opts
|
|
73
|
+
* @param {string} [opts.token] - API key
|
|
74
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
75
|
+
* @param {string} opts.itemId - Item id
|
|
76
|
+
* @param {Object} opts.item - Item payload
|
|
77
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
78
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
79
|
+
*/
|
|
35
80
|
function update({jwtToken, token, itemId, item, headers}) {
|
|
36
81
|
return client({
|
|
37
82
|
url: `/items/${itemId}`,
|
|
@@ -41,7 +86,19 @@ function itemsFactory({client, internalAuthTokenProvider}) {
|
|
|
41
86
|
});
|
|
42
87
|
}
|
|
43
88
|
|
|
89
|
+
/** @type {{ update: function }} */
|
|
44
90
|
const tickets = {
|
|
91
|
+
/**
|
|
92
|
+
* PUT /items/:soldItemId/tickets/:ticketId - update ticket.
|
|
93
|
+
* @param {Object} opts
|
|
94
|
+
* @param {string} [opts.token] - API key
|
|
95
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
96
|
+
* @param {string} opts.soldItemId - Sold item id
|
|
97
|
+
* @param {string} opts.ticketId - Ticket id
|
|
98
|
+
* @param {Object} [opts.query] - Query params
|
|
99
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
100
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
101
|
+
*/
|
|
45
102
|
update({jwtToken, token, soldItemId, ticketId, headers, query}) {
|
|
46
103
|
return client({
|
|
47
104
|
url: `/items/${soldItemId}/tickets/${ticketId}`,
|
|
@@ -1,15 +1,45 @@
|
|
|
1
|
-
const {
|
|
1
|
+
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
/**
|
|
4
|
+
* Query params for journey-prices endpoints (btrz-api-inventory). Forwarded to API as-is.
|
|
5
|
+
* @typedef {Object} InventoryJourneyPricesQuery
|
|
6
|
+
*/
|
|
4
7
|
|
|
5
|
-
|
|
8
|
+
/**
|
|
9
|
+
* Factory for journey-prices API (btrz-api-inventory).
|
|
10
|
+
* @param {Object} deps
|
|
11
|
+
* @param {import("axios").AxiosInstance} deps.client
|
|
12
|
+
* @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
|
|
13
|
+
* @returns {{ all: function, deleteById: function, get: function, create: function, update: function }}
|
|
14
|
+
*/
|
|
15
|
+
function journeyPricesFactory({client, internalAuthTokenProvider}) {
|
|
16
|
+
/**
|
|
17
|
+
* GET /journey-prices - list journey prices.
|
|
18
|
+
* @param {Object} opts
|
|
19
|
+
* @param {string} [opts.token] - API key
|
|
20
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
21
|
+
* @param {InventoryJourneyPricesQuery} [opts.query] - Optional query params (forwarded to API)
|
|
22
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
23
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
24
|
+
*/
|
|
25
|
+
function all({token, jwtToken, query = {}, headers}) {
|
|
6
26
|
return client({
|
|
7
27
|
url: "/journey-prices",
|
|
8
28
|
params: query,
|
|
9
|
-
headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
|
|
29
|
+
headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
|
|
10
30
|
});
|
|
11
31
|
}
|
|
12
32
|
|
|
33
|
+
/**
|
|
34
|
+
* GET /journey-prices/:id - get journey price by id.
|
|
35
|
+
* @param {Object} opts
|
|
36
|
+
* @param {string} opts.id - Journey price id
|
|
37
|
+
* @param {string} [opts.token] - API key
|
|
38
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
39
|
+
* @param {InventoryJourneyPricesQuery} [opts.query] - Optional query params (forwarded to API)
|
|
40
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
41
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
42
|
+
*/
|
|
13
43
|
function get({id, token, jwtToken, query = {}, headers}) {
|
|
14
44
|
return client({
|
|
15
45
|
url: `/journey-prices/${id}`,
|
|
@@ -18,32 +48,59 @@ function journeyPricesFactory({ client, internalAuthTokenProvider }) {
|
|
|
18
48
|
});
|
|
19
49
|
}
|
|
20
50
|
|
|
21
|
-
|
|
22
|
-
|
|
51
|
+
/**
|
|
52
|
+
* DELETE /journey-prices/:id - delete journey price.
|
|
53
|
+
* @param {Object} opts
|
|
54
|
+
* @param {string} [opts.token] - API key
|
|
55
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
56
|
+
* @param {string} opts.id - Journey price id
|
|
57
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
58
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
59
|
+
*/
|
|
60
|
+
function deleteById({token, jwtToken, id, headers}) {
|
|
23
61
|
return client({
|
|
24
62
|
url: `/journey-prices/${id}`,
|
|
25
63
|
method: "delete",
|
|
26
|
-
headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
|
|
64
|
+
headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
|
|
27
65
|
});
|
|
28
66
|
}
|
|
29
67
|
|
|
30
|
-
|
|
68
|
+
/**
|
|
69
|
+
* POST /journey-prices - create journey price.
|
|
70
|
+
* @param {Object} opts
|
|
71
|
+
* @param {string} [opts.token] - API key
|
|
72
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
73
|
+
* @param {Object} opts.journeyPrice - Journey price payload
|
|
74
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
75
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
76
|
+
*/
|
|
77
|
+
function create({token, jwtToken, journeyPrice, headers}) {
|
|
31
78
|
return client({
|
|
32
79
|
url: "/journey-prices",
|
|
33
80
|
method: "post",
|
|
34
81
|
headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
|
|
35
|
-
data: {
|
|
82
|
+
data: {journeyPrice}
|
|
36
83
|
});
|
|
37
84
|
}
|
|
38
85
|
|
|
39
|
-
|
|
86
|
+
/**
|
|
87
|
+
* PATCH /journey-prices/:journeyPriceId - update journey price.
|
|
88
|
+
* @param {Object} opts
|
|
89
|
+
* @param {string} [opts.token] - API key
|
|
90
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
91
|
+
* @param {string} opts.journeyPriceId - Journey price id
|
|
92
|
+
* @param {Object} opts.journeyPrice - Journey price payload
|
|
93
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
94
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
95
|
+
*/
|
|
96
|
+
function update({token, jwtToken, journeyPriceId, journeyPrice, headers}) {
|
|
40
97
|
return client({
|
|
41
98
|
url: `/journey-prices/${journeyPriceId}`,
|
|
42
99
|
method: "patch",
|
|
43
100
|
headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
|
|
44
|
-
data: {
|
|
101
|
+
data: {update: journeyPrice}
|
|
45
102
|
});
|
|
46
|
-
}
|
|
103
|
+
}
|
|
47
104
|
|
|
48
105
|
return {
|
|
49
106
|
all,
|
|
@@ -1,6 +1,27 @@
|
|
|
1
1
|
const {authorizationHeaders} = require("../endpoints_helpers.js");
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* @typedef {Object} LabelsQuery
|
|
5
|
+
* @property {string} [providerId] - Provider account ID
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Factory for labels API (btrz-api-inventory).
|
|
10
|
+
* @param {Object} deps
|
|
11
|
+
* @param {import("axios").AxiosInstance} deps.client
|
|
12
|
+
* @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
|
|
13
|
+
* @returns {{ all: function, get: function, create: function, update: function, remove: function }}
|
|
14
|
+
*/
|
|
3
15
|
function labelsFactory({client, internalAuthTokenProvider}) {
|
|
16
|
+
/**
|
|
17
|
+
* GET /labels - list labels.
|
|
18
|
+
* @param {Object} opts
|
|
19
|
+
* @param {string} [opts.token] - API key
|
|
20
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
21
|
+
* @param {LabelsQuery} [opts.query] - Query params
|
|
22
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
23
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
24
|
+
*/
|
|
4
25
|
function all({token, jwtToken, query = {}, headers}) {
|
|
5
26
|
return client.get("/labels", {
|
|
6
27
|
params: query,
|
|
@@ -8,6 +29,16 @@ function labelsFactory({client, internalAuthTokenProvider}) {
|
|
|
8
29
|
});
|
|
9
30
|
}
|
|
10
31
|
|
|
32
|
+
/**
|
|
33
|
+
* GET /labels/:labelId - get label by id.
|
|
34
|
+
* @param {Object} opts
|
|
35
|
+
* @param {string} [opts.token] - API key
|
|
36
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
37
|
+
* @param {string} opts.labelId - Label id
|
|
38
|
+
* @param {LabelsQuery} [opts.query] - Query params
|
|
39
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
40
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
41
|
+
*/
|
|
11
42
|
function get({labelId, token, jwtToken, query = {}, headers}) {
|
|
12
43
|
return client.get(`/labels/${labelId}`, {
|
|
13
44
|
params: query,
|
|
@@ -15,6 +46,15 @@ function labelsFactory({client, internalAuthTokenProvider}) {
|
|
|
15
46
|
});
|
|
16
47
|
}
|
|
17
48
|
|
|
49
|
+
/**
|
|
50
|
+
* POST /labels - create label.
|
|
51
|
+
* @param {Object} opts
|
|
52
|
+
* @param {string} [opts.token] - API key
|
|
53
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
54
|
+
* @param {Object} opts.label - Label payload
|
|
55
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
56
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
57
|
+
*/
|
|
18
58
|
function create({jwtToken, label, token, headers}) {
|
|
19
59
|
return client({
|
|
20
60
|
url: "/labels",
|
|
@@ -24,6 +64,16 @@ function labelsFactory({client, internalAuthTokenProvider}) {
|
|
|
24
64
|
});
|
|
25
65
|
}
|
|
26
66
|
|
|
67
|
+
/**
|
|
68
|
+
* PUT /labels/:labelId - update label.
|
|
69
|
+
* @param {Object} opts
|
|
70
|
+
* @param {string} [opts.token] - API key
|
|
71
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
72
|
+
* @param {string} opts.labelId - Label id
|
|
73
|
+
* @param {Object} opts.label - Label payload
|
|
74
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
75
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
76
|
+
*/
|
|
27
77
|
function update({jwtToken, token, labelId, label, headers}) {
|
|
28
78
|
return client({
|
|
29
79
|
url: `/labels/${labelId}`,
|
|
@@ -34,6 +84,15 @@ function labelsFactory({client, internalAuthTokenProvider}) {
|
|
|
34
84
|
}
|
|
35
85
|
|
|
36
86
|
|
|
87
|
+
/**
|
|
88
|
+
* DELETE /labels/:labelId - remove label.
|
|
89
|
+
* @param {Object} opts
|
|
90
|
+
* @param {string} [opts.token] - API key
|
|
91
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
92
|
+
* @param {string} opts.labelId - Label id
|
|
93
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
94
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
95
|
+
*/
|
|
37
96
|
function remove({jwtToken, token, labelId, headers}) {
|
|
38
97
|
return client({
|
|
39
98
|
url: `/labels/${labelId}`,
|
|
@@ -1,6 +1,27 @@
|
|
|
1
|
-
const {authorizationHeaders} = require("./../endpoints_helpers");
|
|
1
|
+
const {authorizationHeaders} = require("./../endpoints_helpers.js");
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* Query params for marital-status endpoints (btrz-api-inventory). Forwarded to API as-is.
|
|
5
|
+
* @typedef {Object} InventoryMaritalStatusQuery
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Factory for marital-status API (btrz-api-inventory).
|
|
10
|
+
* @param {Object} deps
|
|
11
|
+
* @param {import("axios").AxiosInstance} deps.client
|
|
12
|
+
* @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
|
|
13
|
+
* @returns {{ all: function, get: function, update: function, remove: function, create: function }}
|
|
14
|
+
*/
|
|
3
15
|
function maritalStatusFactory({client, internalAuthTokenProvider}) {
|
|
16
|
+
/**
|
|
17
|
+
* GET /marital-status - list marital statuses.
|
|
18
|
+
* @param {Object} opts
|
|
19
|
+
* @param {string} [opts.token] - API key
|
|
20
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
21
|
+
* @param {InventoryMaritalStatusQuery} [opts.query] - Optional query params (forwarded to API)
|
|
22
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
23
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
24
|
+
*/
|
|
4
25
|
function all({token, jwtToken, query = {}, headers}) {
|
|
5
26
|
return client({
|
|
6
27
|
url: "/marital-status",
|
|
@@ -10,6 +31,16 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
|
|
|
10
31
|
});
|
|
11
32
|
}
|
|
12
33
|
|
|
34
|
+
/**
|
|
35
|
+
* GET /marital-status/:id - get marital status by id.
|
|
36
|
+
* @param {Object} opts
|
|
37
|
+
* @param {string} [opts.token] - API key
|
|
38
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
39
|
+
* @param {string} opts.id - Marital status id
|
|
40
|
+
* @param {InventoryMaritalStatusQuery} [opts.query] - Optional query params (forwarded to API)
|
|
41
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
42
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
43
|
+
*/
|
|
13
44
|
function get({token, jwtToken, id, query = {}, headers}) {
|
|
14
45
|
return client({
|
|
15
46
|
url: `/marital-status/${id}`,
|
|
@@ -19,6 +50,17 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
|
|
|
19
50
|
});
|
|
20
51
|
}
|
|
21
52
|
|
|
53
|
+
/**
|
|
54
|
+
* PUT /marital-status/:id - update marital status.
|
|
55
|
+
* @param {Object} opts
|
|
56
|
+
* @param {string} [opts.token] - API key
|
|
57
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
58
|
+
* @param {string} opts.id - Marital status id
|
|
59
|
+
* @param {Object} opts.data - Request body
|
|
60
|
+
* @param {InventoryMaritalStatusQuery} [opts.query] - Optional query params (forwarded to API)
|
|
61
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
62
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
63
|
+
*/
|
|
22
64
|
function update({token, jwtToken, id, data, query = {}, headers}) {
|
|
23
65
|
return client({
|
|
24
66
|
url: `/marital-status/${id}`,
|
|
@@ -29,6 +71,16 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
|
|
|
29
71
|
});
|
|
30
72
|
}
|
|
31
73
|
|
|
74
|
+
/**
|
|
75
|
+
* DELETE /marital-status/:id - remove marital status.
|
|
76
|
+
* @param {Object} opts
|
|
77
|
+
* @param {string} [opts.token] - API key
|
|
78
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
79
|
+
* @param {string} opts.id - Marital status id
|
|
80
|
+
* @param {InventoryMaritalStatusQuery} [opts.query] - Optional query params (forwarded to API)
|
|
81
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
82
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
83
|
+
*/
|
|
32
84
|
function remove({token, jwtToken, id, query = {}, headers}) {
|
|
33
85
|
return client({
|
|
34
86
|
url: `/marital-status/${id}`,
|
|
@@ -38,6 +90,16 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
|
|
|
38
90
|
});
|
|
39
91
|
}
|
|
40
92
|
|
|
93
|
+
/**
|
|
94
|
+
* POST /marital-status - create marital status.
|
|
95
|
+
* @param {Object} opts
|
|
96
|
+
* @param {string} [opts.token] - API key
|
|
97
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
98
|
+
* @param {Object} opts.data - Request body
|
|
99
|
+
* @param {InventoryMaritalStatusQuery} [opts.query] - Optional query params (forwarded to API)
|
|
100
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
101
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
102
|
+
*/
|
|
41
103
|
function create({token, jwtToken, data, query = {}, headers}) {
|
|
42
104
|
return client({
|
|
43
105
|
url: "/marital-status",
|
|
@@ -2,7 +2,27 @@ const {
|
|
|
2
2
|
authorizationHeaders
|
|
3
3
|
} = require("../endpoints_helpers.js");
|
|
4
4
|
|
|
5
|
+
/**
|
|
6
|
+
* Query params for marketplace-modifiers endpoints (btrz-api-inventory). Forwarded to API as-is.
|
|
7
|
+
* @typedef {Object} InventoryMarketplaceModifiersQuery
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Factory for marketplace-modifiers API (btrz-api-inventory).
|
|
12
|
+
* @param {Object} deps
|
|
13
|
+
* @param {import("axios").AxiosInstance} deps.client
|
|
14
|
+
* @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
|
|
15
|
+
* @returns {{ all: function, get: function, create: function, update: function, remove: function }}
|
|
16
|
+
*/
|
|
5
17
|
function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
|
|
18
|
+
/**
|
|
19
|
+
* GET /marketplace-modifiers - list marketplace modifiers.
|
|
20
|
+
* @param {Object} opts
|
|
21
|
+
* @param {string} [opts.token] - API key
|
|
22
|
+
* @param {InventoryMarketplaceModifiersQuery} [opts.query] - Optional query params (forwarded to API)
|
|
23
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
24
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
25
|
+
*/
|
|
6
26
|
function all({
|
|
7
27
|
token,
|
|
8
28
|
query = {},
|
|
@@ -14,12 +34,29 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
|
|
|
14
34
|
});
|
|
15
35
|
}
|
|
16
36
|
|
|
37
|
+
/**
|
|
38
|
+
* GET /marketplace-modifiers/:marketplaceModifierId - get marketplace modifier by id.
|
|
39
|
+
* @param {Object} opts
|
|
40
|
+
* @param {string} opts.marketplaceModifierId - Marketplace modifier id
|
|
41
|
+
* @param {string} [opts.token] - API key
|
|
42
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
43
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
44
|
+
*/
|
|
17
45
|
function get({marketplaceModifierId, token, headers}) {
|
|
18
46
|
return client.get(`/marketplace-modifiers/${marketplaceModifierId}`, {
|
|
19
47
|
headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
|
|
20
48
|
});
|
|
21
49
|
}
|
|
22
50
|
|
|
51
|
+
/**
|
|
52
|
+
* POST /marketplace-modifiers - create marketplace modifier.
|
|
53
|
+
* @param {Object} opts
|
|
54
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
55
|
+
* @param {string} [opts.token] - API key
|
|
56
|
+
* @param {Object} opts.marketplaceModifier - Marketplace modifier payload
|
|
57
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
58
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
59
|
+
*/
|
|
23
60
|
function create({jwtToken, token, marketplaceModifier, headers}) {
|
|
24
61
|
return client({
|
|
25
62
|
url: "/marketplace-modifiers",
|
|
@@ -31,6 +68,15 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
|
|
|
31
68
|
});
|
|
32
69
|
}
|
|
33
70
|
|
|
71
|
+
/**
|
|
72
|
+
* DELETE /marketplace-modifiers/:marketplaceModifierId - remove marketplace modifier.
|
|
73
|
+
* @param {Object} opts
|
|
74
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
75
|
+
* @param {string} opts.marketplaceModifierId - Marketplace modifier id
|
|
76
|
+
* @param {string} [opts.token] - API key
|
|
77
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
78
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
79
|
+
*/
|
|
34
80
|
function remove({jwtToken, marketplaceModifierId, token, headers}) {
|
|
35
81
|
return client({
|
|
36
82
|
url: `/marketplace-modifiers/${marketplaceModifierId}`,
|
|
@@ -39,6 +85,16 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
|
|
|
39
85
|
});
|
|
40
86
|
}
|
|
41
87
|
|
|
88
|
+
/**
|
|
89
|
+
* PUT /marketplace-modifiers/:marketplaceModifierId - update marketplace modifier.
|
|
90
|
+
* @param {Object} opts
|
|
91
|
+
* @param {string} [opts.jwtToken] - JWT or internal auth symbol
|
|
92
|
+
* @param {string} [opts.token] - API key
|
|
93
|
+
* @param {string} opts.marketplaceModifierId - Marketplace modifier id
|
|
94
|
+
* @param {Object} opts.marketplaceModifier - Marketplace modifier payload
|
|
95
|
+
* @param {Object} [opts.headers] - Optional headers
|
|
96
|
+
* @returns {Promise<import("axios").AxiosResponse>}
|
|
97
|
+
*/
|
|
42
98
|
function update({jwtToken, token, marketplaceModifierId, marketplaceModifier, headers}) {
|
|
43
99
|
return client({
|
|
44
100
|
url: `/marketplace-modifiers/${marketplaceModifierId}`,
|