bcfranchise-public
Repositories Projects Packages
10

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

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

Installation

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

About this package

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

Next, try it out.

import {
  Configuration,
  LoyaltyBaselineApi,
} from '@bcfranchise/nexus-baseline-sdk';
import type { GetCheckinClientAdoptionContextRequest } from '@bcfranchise/nexus-baseline-sdk';

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

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

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

Models

Authorization

Authentication schemes defined for the API:

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • 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:26 +00:00
0
OpenAPI-Generator
latest
103 KiB
Assets (1)
nexus-baseline-sdk-0.0.1-ci-add-rc-support-c7233b8d78a848cb69edae32d6b8878c4be5bb70.tgz 103 KiB
Versions (79) 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