bcfranchise-public
Repositories Projects Packages
10

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

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

Installation

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

About this package

@bcfranchise/nexus-checkin-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-checkin-sdk --save

Next, try it out.

import {
  Configuration,
  CheckinApi,
} from '@bcfranchise/nexus-checkin-sdk';
import type { GetStoreContextRequest } from '@bcfranchise/nexus-checkin-sdk';

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

  const body = {
    // string
    version: version_example,
  } satisfies GetStoreContextRequest;

  try {
    const data = await api.getStoreContext(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
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.
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.

Models

Authorization

Authentication schemes defined for the API:

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:24 +00:00
0
OpenAPI-Generator
latest
109 KiB
Assets (1)
nexus-checkin-sdk-0.0.1-ci-add-rc-support-c7233b8d78a848cb69edae32d6b8878c4be5bb70.tgz 109 KiB
Versions (80) 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-add-public-object-storage-and-upload-signed-contract-d50b92e78d23693cbb6104caf69973d05c2df27c 2026-10-05