bcfranchise-public

Repositories Projects Packages

8

@bcfranchise/nexus-sdk (0.0.1-fix-route-paths-ba85c3860321703497dfd2a132d9813c6f6a66f3)

Published 2026-07-21 18:55:52 +00:00 by dev-admin

Installation

Setup this registry in your project .npmrc file:

@bcfranchise:registry=

To install the package using npm, run the following command:

npm install @bcfranchise/nexus-sdk@0.0.1-fix-route-paths-ba85c3860321703497dfd2a132d9813c6f6a66f3

or add it to the package.json file:

"@bcfranchise/nexus-sdk": "0.0.1-fix-route-paths-ba85c3860321703497dfd2a132d9813c6f6a66f3"

For more information on the npm registry, see the documentation.

About this package

@bcfranchise/nexus-sdk@0.0.1-fix-route-paths-ba85c3860321703497dfd2a132d9813c6f6a66f3

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
CheckinAppApi	createCustomer	POST /v{version}/loyalty/checkin-app/customer
CheckinAppApi	getCheckinClientStoreInfo	GET /v{version}/loyalty/checkin-app/store
CheckinAppApi	getCustomerByPhoneNumber	GET /v{version}/loyalty/checkin-app/customer
CheckinAppApi	getUpdateCustomerToken	GET /v{version}/loyalty/checkin-app/update-customer-token
CheckinAppApi	startShopCheckin	POST /v{version}/loyalty/checkin-app/shop-checkin
CheckinAppApi	startUpdateCustomerVerification	POST /v{version}/loyalty/checkin-app/start-update-customer-verification
CheckinAppApi	startVendCheckin	POST /v{version}/loyalty/checkin-app/vend-checkin
CheckinAppApi	updateCustomer	PUT /v{version}/loyalty/checkin-app/customer
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
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	issueCheckinClientAdoptionToken	POST /v{version}/store-data/stores/issue-checkin-client-adoption-token
StoreDataApi	queryCustomersByPhoneNumber	GET /v{version}/store-data/stores/customers
StoreDataApi	whoAmI	GET /v{version}/store-data/stores/whoami

Models

• AccountType
• ActivatePriceSetsDto
• AdoptCheckinClientDto
• ApplicationRole
• BalenaFleet
• BalenaRelease
• BalenaTag
• BeginCreatePriceSetGroupDto
• BeginCreatePriceSetGroupResponseDto
• ConceptId
• ConnectStoreDto
• ConnectionEventType
• CreateCustomerDto
• CreateDeploymentDto
• CustomerFilter
• CustomerProfileDto
• CustomerResponseDto
• CustomerSortField
• CustomerStore
• Deployment
• DeploymentAttempt
• DeploymentStatus
• EnqueuePriceCalculationDto
• GoogleAuthPayload
• LineItemStatus
• ListPriceSetsDto
• LoyaltyRtmMethods
• PriceCalculation
• PriceCalculationAttempt
• PriceCalculationStatus
• PriceSet
• PriceSetCategoryDto
• PriceSetFilter
• PriceSetGroup
• PriceSetGroupStatus
• PriceSetPriceModifierDto
• PriceVariables
• PriceVariablesDto
• ProblemDetails
• QBAuthPayload
• QBCustomer
• QBItem
• QBOSettings
• QBSetting
• QBSettingDropdown
• RealTimeGroup
• RevCycle
• RevCycleConfig
• RevCycleDetails
• RevCycleDetailsListResponse
• RevCycleFee
• RevCycleFeeClass
• RevCycleInvoice
• RevCycleInvoiceLineItem
• RevCycleStoreFee
• SerializablePriceSetDto
• SerializablePriceSetDtoCategoriesInner
• SerializablePriceSetDtoPriceModifiersInner
• SortDirection
• StartShopCheckinDto
• Store
• StoreConcept
• StoreConnectionEvent
• StoreConnectionResponseDto
• StoreSalesDto
• StoreSalesFilter
• StoreShopCheckinDto
• StoreStatus
• StoreSyncStateDto
• StoreVendCheckinDto
• SyncBaselineCustomerRequestDto
• SyncBaselineCustomerResponseDto
• Tag
• UpdateAccountingStoreDetailsDto
• UpdateAccountingStoreDetailsResponseDto
• UpdateCustomerDto
• UpdateUserRolesDto
• UpsertRevCycleDetails
• UpsertRevCycleDto
• UpsertRevCycleFeeClassDto
• UpsertRevCycleFeeDto
• UpsertRevCycleInvoiceDto
• UpsertRevCycleInvoiceLineItemDto
• UpsertRevCycleStoreFeeDto
• UpsertStoreAccountingDto
• UserDto
• WellsFargoExportResponseDto

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-fix-route-paths-ba85c3860321703497dfd2a132d9813c6f6a66f3
• Generator version: 7.24.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-07-21 18:55:52 +00:00

0

OpenAPI-Generator

127 KiB

Assets (1)

nexus-sdk-0.0.1-fix-route-paths-ba85c3860321703497dfd2a132d9813c6f6a66f3.tgz 127 KiB

Versions (68) View all

0.0.1-emergency-soci-integration-1438992f0c4fce0d1ebf3226affa7b21be1fd581 2026-07-23

0.0.1-emergency-soci-integration-782b6c5b3d6683c926690999506c681544708824 2026-07-23

0.0.1-emergency-soci-integration-2ea6d14d7b14907be87388e784aea9bd416fe52a 2026-07-23

0.0.1-main-fb7980058d85f64abf4e5cca3b6d577553eca4c8 2026-07-23

0.0.1-authentication-tweak-bbf94c11d21868a74b5f4ea3e73e6b6c828e33b0 2026-07-23