bcfranchise-public
Repositories Projects Packages
8

@bcfranchise/nexus-checkin-sdk (0.0.1-add-checkin-type-f2fd10aa435c0714548ee1539481387959a26db6)

Published 2026-07-07 17:47:48 +00:00 by dev-admin

Installation

@bcfranchise:registry=
npm install @bcfranchise/nexus-checkin-sdk@0.0.1-add-checkin-type-f2fd10aa435c0714548ee1539481387959a26db6
"@bcfranchise/nexus-checkin-sdk": "0.0.1-add-checkin-type-f2fd10aa435c0714548ee1539481387959a26db6"

About this package

@bcfranchise/nexus-checkin-sdk@0.0.1-add-checkin-type-f2fd10aa435c0714548ee1539481387959a26db6

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,
  CheckinAppApi,
} from '@bcfranchise/nexus-checkin-sdk';
import type { CreateCustomerRequest } 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 CheckinAppApi(config);

  const body = {
    // string
    version: version_example,
    // CreateCustomerDto
    createCustomerDto: ...,
  } satisfies CreateCustomerRequest;

  try {
    const data = await api.createCustomer(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
CheckinAppApi createCustomer POST /v{version}/checkin/app/customer
CheckinAppApi getCheckinClientStoreInfo GET /v{version}/checkin/app/store
CheckinAppApi getCustomerByPhoneNumber GET /v{version}/checkin/app/customer
CheckinAppApi getUpdateCustomerToken GET /v{version}/checkin/app/update-customer-token
CheckinAppApi startCheckin POST /v{version}/checkin/app/start-checkin
CheckinAppApi startUpdateCustomerVerification POST /v{version}/checkin/app/start-update-customer-verification
CheckinAppApi updateCustomer PUT /v{version}/checkin/app/customer
ClientAdoptionApi adoptCheckinClient POST /v{version}/checkin/adopt Use a Checkin adoption token to create a CheckinClient and return its authentication key.

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-add-checkin-type-f2fd10aa435c0714548ee1539481387959a26db6
  • Generator version: 7.23.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-07 17:47:48 +00:00
0
OpenAPI-Generator
85 KiB
Assets (1)
nexus-checkin-sdk-0.0.1-add-checkin-type-f2fd10aa435c0714548ee1539481387959a26db6.tgz 85 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