bcfranchise-public
Repositories Projects Packages
10

@bcfranchise/nexus-sdk (0.0.1-ci-add-rc-support-c7233b8d78a848cb69edae32d6b8878c4be5bb70)

Published 2026-10-05 21:10:34 +00:00 by dev-admin

Installation

@bcfranchise:registry=
npm install @bcfranchise/nexus-sdk@0.0.1-ci-add-rc-support-c7233b8d78a848cb69edae32d6b8878c4be5bb70
"@bcfranchise/nexus-sdk": "0.0.1-ci-add-rc-support-c7233b8d78a848cb69edae32d6b8878c4be5bb70"

About this package

@bcfranchise/nexus-sdk@0.0.1-ci-add-rc-support-c7233b8d78a848cb69edae32d6b8878c4be5bb70

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install @bcfranchise/nexus-sdk --save

Next, try it out.

import {
  Configuration,
  AccountingStoresApi,
} from '@bcfranchise/nexus-sdk';
import type { StoreSalesForMonthRequest } from '@bcfranchise/nexus-sdk';

async function example() {
  console.log("🚀 Testing @bcfranchise/nexus-sdk SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: Bearer
    apiKey: "YOUR API KEY",
  });
  const api = new AccountingStoresApi(config);

  const body = {
    // StoreSalesFilter
    storeSalesFilter: ...,
  } satisfies StoreSalesForMonthRequest;

  try {
    const data = await api.storeSalesForMonth(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AccountingStoresApi storeSalesForMonth POST /accounting/stores/sales-for-month
AccountingStoresApi updateAccountingStoreDetails POST /accounting/stores/{storeId}/details
AdminApi getRoleNames GET /core/admin/roles
AdminApi getUsers GET /core/admin/users
AdminApi updateUserRoles POST /core/admin/users/{userId}/roles
BaselineAuthenticationApi getBaselineNexusAuthenticationToken GET /v{version}/store-data/baseline-authentication/baseline-auth-token Used to retrieve a JWT that can be used by Baseline web to access routes that allow the (string Roles.Baseline) role.
CheckinApi getStoreContext GET /v{version}/loyalty/checkin/store-context
CheckinApi startShopCheckin POST /v{version}/loyalty/checkin/shop-checkin
CheckinApi startVendCheckin POST /v{version}/loyalty/checkin/vend-checkin Starts a Vend Checkin and returns a StartVendCheckinResponseDto with the pre-signed URLs needed to upload the contract's text content ( contract.md ) and signature ( signature.svg )
ClientAdoptionApi adoptCheckinClient POST /v{version}/loyalty/client-adoption Use a Checkin adoption token to create a CheckinClient and return its authentication key.
CustomerApi getCustomerCount GET /core/customers/count
CustomerApi getCustomerProfile GET /core/customers/{customerId}/profile
CustomerApi queryCustomers POST /core/customers/query
DeploymentApi cancelDeployment POST /development/deployments/cancel/{id}
DeploymentApi getAvailableFleets GET /development/deployments/available-fleets
DeploymentApi getDeployment GET /development/deployments/{id}
DeploymentApi getDeployments GET /development/deployments
DeploymentApi getReleasesByTagKey GET /development/deployments/versioned-releases/{fleetId}
DeploymentApi scheduleDeployment POST /development/deployments/schedule
IdentityApi getGoogleClientId GET /core/identity/google-client-id Returns the Google ClientID needed to initiate the Google OAuth flow.
IdentityApi refreshAccessToken POST /core/identity/refresh-access-token
IdentityApi verifyGoogleAuth POST /core/identity/google-auth Verify the google authentication from the provided idToken. If successful, an access token will be issued allowing the client to communicate with the Nexus API.
JobApi getJobState GET /core/jobs/{jobId}/state
LoyaltyBaselineApi getCheckinClientAdoptionContext GET /v{version}/loyalty/baseline/checkin-client-adoption-context
LoyaltyBaselineApi getCheckinSettings GET /v{version}/loyalty/baseline/checkin-setting
LoyaltyBaselineApi getContractTemplatePreview POST /v{version}/loyalty/baseline/checkin-setting/contract-preview
LoyaltyBaselineApi getRedactedCustomerGovernmentId GET /v{version}/loyalty/baseline/customer/{customerId}/government-id
LoyaltyBaselineApi getVendCheckinContract GET /v{version}/loyalty/baseline/checkin/{vendCheckinId}/contract Generates and returns download URLs for the contract and signature of the associated vend checkin.
LoyaltyBaselineApi setCustomerGovernmentId POST /v{version}/loyalty/baseline/customer/{customerId}/government-id
LoyaltyBaselineApi upsertCheckinSettings PUT /v{version}/loyalty/baseline/checkin-setting
LoyaltyCustomerApi createCustomer POST /v{version}/loyalty/customer Creates a Customer associated with a Store (CustomerStore) as well as a Contact in Patch
LoyaltyCustomerApi getCustomerByPhoneNumber GET /v{version}/loyalty/customer Looks up a Customer by their phone number. Note: Requires their FULL phone number. Also creates a CustomerStore if one doesnt exist and includes metadata such as op-in statuses
LoyaltyCustomerApi getUpdateCustomerToken GET /v{version}/loyalty/customer/update-customer-token Gets a token that can be used to update a Customer. Requires a "Short Code" that can be sent via SMS to the Customer by using the "POST start-update-customer-verification" endpoint
LoyaltyCustomerApi setMarketingOptIns POST /v{version}/loyalty/customer/marketing-opt-ins Sets the opt-in statuses for the specified Customer
LoyaltyCustomerApi startUpdateCustomerVerification POST /v{version}/loyalty/customer/start-update-customer-verification Sends an SMS to the specified Customer containing a "Short Code" that can be used by "GET update-customer-token" to get a one-time use update token that can be used by "PUT customer" to update a Customer
LoyaltyCustomerApi updateCustomer PUT /v{version}/loyalty/customer Updates the specified Customer using a one-time use update token. Note: This endpoint CANNOT be used to update DateOnly? Customer.Birthday if it has already been set.
LoyaltySettingsApi getLoyaltySettings GET /loyalty/settings
LoyaltySettingsApi upsertLoyaltySettings PUT /loyalty/settings
LoyaltyStoreApi getRenderedVendCheckinContract GET /v{version}/loyalty/store/checkin/{vendCheckinId}/rendered-contract Gets the contract and signature for the associated vend checkin, and returns them rendered together as an HTML string.
PriceCalculationApi createPriceVariables POST /store-data/price-calculations/price-variables
PriceCalculationApi enqueuePriceCalculation POST /store-data/price-calculations
PriceCalculationApi getDefaultPriceVariables GET /store-data/price-calculations/default-price-variables
PriceCalculationApi getPriceCalculations GET /store-data/price-calculations
PriceSetApi activatePriceSets POST /store-data/price-sets/activate
PriceSetApi beginCreatePriceSetGroup POST /store-data/price-sets/begin-create-group
PriceSetApi finalizeCreatePriceSetGroup POST /store-data/price-sets/finalize-create-group/{id}
PriceSetApi getPriceSetDownloadUrl GET /store-data/price-sets/download-url/{id}
PriceSetApi getPriceSetGroups GET /store-data/price-sets/groups
PriceSetApi listPriceSets POST /store-data/price-sets/list
PriceSetApi queryPriceSets POST /store-data/price-sets/query
QuickbooksApi credentialsCheck GET /accounting/quickbooks/credentials-check
QuickbooksApi deleteInvoices POST /accounting/quickbooks/delete-invoices/{id}
QuickbooksApi getAuthorizationUrl GET /accounting/quickbooks/authorization-url
QuickbooksApi getSettings GET /accounting/quickbooks/settings
QuickbooksApi oAuthCallback POST /accounting/quickbooks/oauth-callback
QuickbooksApi publishInvoices POST /accounting/quickbooks/publish-invoices/{id}
QuickbooksApi updateInvoice POST /accounting/quickbooks/update-invoice/{id}
QuickbooksApi upsertSettings PUT /accounting/quickbooks/settings
RevCycleApi createRevCycle POST /accounting/rev-cycles
RevCycleApi generateRevCycleACH GET /accounting/rev-cycles/generate-ach/{id}
RevCycleApi getRevCycleById GET /accounting/rev-cycles/{id}
RevCycleApi getRevCycleConfig GET /accounting/rev-cycles/config
RevCycleApi getRevCycleDetailsList GET /accounting/rev-cycles/details
RevCycleApi updateRevCycle PUT /accounting/rev-cycles/{id}
RevCycleApi updateRevCycleDetails PUT /accounting/rev-cycles/details/{id}
RevCycleApi uploadACHReport POST /accounting/rev-cycles/upload-ach/{id}
RevCycleFeeApi createFee POST /accounting/rev-cycle-fees
RevCycleFeeApi getFeeById GET /accounting/rev-cycle-fees/{id}
RevCycleFeeApi getFees GET /accounting/rev-cycle-fees
RevCycleFeeApi updateFee PUT /accounting/rev-cycle-fees/{id}
StoreApi getCountries GET /core/stores/countries
StoreApi getRegions GET /core/stores/regions
StoreApi getStoreById GET /core/stores/{id}
StoreApi getStores GET /core/stores
StoreConnectionEventApi getConnectionEventsForStore GET /core/store-connection-events/{storeId}/{hours} Retrieve the StoreConnectionEvents for the specified store.
StoreConnectionEventApi getStoreConnectionStatuses GET /core/store-connection-events
StoreDataApi getCustomersByStoreRecords POST /v{version}/store-data/stores/sync-baseline-customer-ids
StoreDataApi getPriceSetDownloadUrlForStore GET /v{version}/store-data/stores/price-set-download-url/{id}
StoreDataApi getTargetSyncState GET /v{version}/store-data/stores/target-sync-state
StoreDataApi invoiceCompleted POST /v{version}/store-data/stores/invoice-completed
StoreDataApi queryCustomersByPhoneNumber GET /v{version}/store-data/stores/customers
StoreDataApi whoAmI GET /v{version}/store-data/stores/whoami
StoreDataSettingsApi getStoreDataSettings GET /store-data/settings
StoreDataSettingsApi upsertStoreDataSettings PUT /store-data/settings

Models

Authorization

Authentication schemes defined for the API:

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

StoreDataKey

  • Type: API key
  • API key parameter name: X-STORE-DATA-KEY
  • Location: HTTP header

CheckinKey

  • Type: API key
  • API key parameter name: X-CHECKIN-KEY
  • Location: HTTP header

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 0.0.1-ci-add-rc-support-c7233b8d78a848cb69edae32d6b8878c4be5bb70
  • Generator version: 7.25.0
  • Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

  • Environments
    • Node.js
    • Webpack
    • Browserify
  • Language levels
    • ES5 - you must have a Promises/A+ library installed
    • ES6
  • Module systems
    • CommonJS
    • ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

Dependencies

Development dependencies

ID Version
typescript ^4.0 || ^5.0
Details
npm
2026-10-05 21:10:34 +00:00
0
OpenAPI-Generator
latest
158 KiB
Assets (1)
nexus-sdk-0.0.1-ci-add-rc-support-c7233b8d78a848cb69edae32d6b8878c4be5bb70.tgz 158 KiB
Versions (81) View all
0.0.1-ci-add-rc-support-c7233b8d78a848cb69edae32d6b8878c4be5bb70 2026-10-05
1.0.203-rc1 2026-10-05
0.0.1-ci-add-rc-support-ed6da48738b241be8d69082534a2ad513d249570 2026-10-05
0.0.1-ci-add-rc-support-11f0b72e2a0586382f709557979d1639187ddc6d 2026-10-05
0.0.1-ci-add-rc-support-eb8dcd8dfae29d84cf2b7737d1f40bfb0597addd 2026-10-05