bcfranchise-public

Repositories Projects Packages

8

@bcfranchise/hive-sdk (0.0.1-f08584825e9af24ffa1e9dd7a9cdfbaa0e8ca1f5)

Published 2026-07-09 14:49:57 +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/hive-sdk@0.0.1-f08584825e9af24ffa1e9dd7a9cdfbaa0e8ca1f5

or add it to the package.json file:

"@bcfranchise/hive-sdk": "0.0.1-f08584825e9af24ffa1e9dd7a9cdfbaa0e8ca1f5"

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

About this package

@bcfranchise/hive-sdk@0.0.1-f08584825e9af24ffa1e9dd7a9cdfbaa0e8ca1f5

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install @bcfranchise/hive-sdk --save

Next, try it out.

import {
  Configuration,
  AccountingJournalApi,
} from '@bcfranchise/hive-sdk';
import type { DownloadCsvRequest } from '@bcfranchise/hive-sdk';

async function example() {
  console.log("🚀 Testing @bcfranchise/hive-sdk SDK...");
  const api = new AccountingJournalApi();

  const body = {
    // Date (optional)
    startDate: 2013-10-20T19:20:30+01:00,
    // Date (optional)
    endDate: 2013-10-20T19:20:30+01:00,
  } satisfies DownloadCsvRequest;

  try {
    const data = await api.downloadCsv(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
AccountingJournalApi	downloadCsv	GET /accounting-journal/downloadcsv
AnnouncementApi	createAnnouncement	POST /comm-log/announcements
AnnouncementApi	deleteAnnouncement	DELETE /comm-log/announcements/{announcementId}
AnnouncementApi	getAnnouncements	GET /comm-log/announcements
AnnouncementApi	getAnnouncementsForDay	GET /comm-log/announcements/day/{day}
AnnouncementApi	updateAnnouncement	POST /comm-log/announcements/{announcementId}
BaselineApiEventApi	handleBaselineEvent	POST /baseline/events
BinApi	binNumberExists	GET /inventory/bins/{binNumber}/exists
BinApi	bulkUpdateBinLocations	POST /inventory/bins/bulk-update-locations
BinApi	createBin	POST /inventory/bins
BinApi	deleteBin	DELETE /inventory/bins/{binId}
BinApi	getBinStats	GET /inventory/bins/stats
BinApi	getBins	GET /inventory/bins
BinApi	markBinPacked	POST /inventory/bins/{binId}/mark-packed
BinApi	printBinLabel	POST /inventory/bins/{binId}/print
BinApi	updateBin	POST /inventory/bins/{binId}
ChecklistTaskApi	getChecklistTasks	GET /comm-log/checklist-tasks
ChecklistTaskApi	toggleChecklistTaskComplete	POST /comm-log/checklist-tasks/{checklistTaskId}/toggle-complete
DataSyncStateApi	getDataSyncStateByType	GET /nexus/data-sync-state/by-type/{type}
EmployeeApi	getEmployees	GET /baseline/employees
EmployeeApi	getIncompleteEmployeeTasks	GET /baseline/employees/incomplete-tasks
FeaturebaseApi	getFeaturebaseJWT	GET /integrations/featurebase/auth
FloorSweepApi	getCurrentFloorSweep	GET /comm-log/floor-sweep
FloorSweepApi	updateFloorSweep	POST /comm-log/floor-sweep/update
InvoiceApi	cancelAllInvoicePayments	POST /invoices/{invoiceId}/payments/cancel
InvoiceApi	createCardPayment	POST /invoices/{invoiceId}/payments/card
InvoiceApi	createCashPayment	POST /invoices/{invoiceId}/payments/cash
InvoiceApi	createCheckPayment	POST /invoices/{invoiceId}/payments/check
InvoiceApi	createDigitalPayment	POST /invoices/{invoiceId}/payments/digital
InvoiceApi	createGiftCardPayment	POST /invoices/{invoiceId}/payments/gift-card
InvoiceApi	createOtherPayment	POST /invoices/{invoiceId}/payments/other
InvoiceApi	createStoreCreditPayment	POST /invoices/{invoiceId}/payments/store-credit
InvoiceApi	getInvoicePayments	GET /invoices/{invoiceId}/payments
InvoiceApi	getPaymentOptions	GET /invoices/{invoiceId}/payment-options
InvoiceApi	invoicePaymentsCompletion	POST /invoices/{invoiceId}/invoice-payment-completion
ItemClassificationApi	getSeasonAttributeValues	GET /baseline/item-classifications/season-attribute-values
LocationApi	createLocation	POST /inventory/locations
LocationApi	getLocations	GET /inventory/locations
LocationApi	updateLocation	POST /inventory/locations/{locationId}
PaymentApi	cancelCardPayment	DELETE /payments/card/{paymentId}
PaymentApi	cancelPayments	DELETE /payments/batch
PaymentApi	getLatestHistory	GET /payments/{paymentId}/latest-history
PaymentApi	inquireCardPayments	POST /payments/inquire-cards
PaymentApi	syncCardPaymentStatusWithProcessor	POST /payments/{paymentId}/sync
ProjectApi	createProject	POST /comm-log/projects
ProjectApi	getProjects	GET /comm-log/projects
ProjectApi	importFromEmployeeTasks	POST /comm-log/projects/import-employee-tasks
ProjectApi	toggleProjectComplete	POST /comm-log/projects/{projectId}/toggle-complete
ProjectApi	updateProject	POST /comm-log/projects/{projectId}
RoleApi	createRole	POST /comm-log/roles
RoleApi	deleteRole	DELETE /comm-log/roles/{roleId}
RoleApi	getAllRoles	GET /comm-log/roles
RoleApi	getRoleById	GET /comm-log/roles/{roleId}
RoleApi	updateRole	POST /comm-log/roles/{roleId}
ScheduledReportApi	createScheduledReport	POST /scheduled-reports
ScheduledReportApi	deleteScheduledReport	DELETE /scheduled-reports/{scheduledReportId}
ScheduledReportApi	executeReportNow	POST /scheduled-reports/{scheduledReportId}/execute
ScheduledReportApi	getReportOptions	GET /scheduled-reports/report-options
ScheduledReportApi	getScheduledReport	GET /scheduled-reports/{scheduledReportId}
ScheduledReportApi	getScheduledReports	GET /scheduled-reports
ScheduledReportApi	updateScheduledReport	PUT /scheduled-reports/{scheduledReportId}
SectionApi	getSections	GET /inventory/sections
SectionApi	refillSectionFromBins	POST /inventory/sections/{sectionId}/refill
SectionApi	sectionReset	POST /inventory/sections/section-reset
SectionApi	updateSection	PUT /inventory/sections
SettingsApi	getAllApplicationSettings	GET /core/settings
SettingsApi	upsertCheckinSettings	POST /core/settings/checkin
SettingsApi	upsertGeneralSettings	POST /core/settings/general
SettingsApi	upsertVendorSettings	POST /core/settings/vendor
ShiftApi	createShift	POST /comm-log/shifts
ShiftApi	deleteShift	DELETE /comm-log/shifts/{shiftId}
ShiftApi	getAllShifts	GET /comm-log/shifts
ShiftApi	getShiftById	GET /comm-log/shifts/{shiftId}
ShiftApi	getShiftsByDateRange	GET /comm-log/shifts/date-range
ShiftApi	getShiftsByEmployeeId	GET /comm-log/shifts/employee/{employeeId}
ShiftApi	updateShift	POST /comm-log/shifts/{shiftId}
ShiftNoteApi	createNote	POST /comm-log/shift-notes
ShiftNoteApi	deleteShiftNote	DELETE /comm-log/shift-notes/{noteId}
ShiftNoteApi	getManagerNotes	GET /comm-log/shift-notes/manager
ShiftNoteApi	getShiftNotes	GET /comm-log/shift-notes/shift
TaskTemplateApi	createTaskTemplate	POST /comm-log/task-templates
TaskTemplateApi	deleteTaskTemplate	DELETE /comm-log/task-templates/{taskTemplateId}
TaskTemplateApi	getTaskTemplates	GET /comm-log/task-templates
TaskTemplateApi	updateTaskTemplate	POST /comm-log/task-templates/{taskTemplateId}

Models

• Announcement
• ApplicationSettings
• Attribute
• AttributeValue
• BaselineEventDto
• BaselineEventTypes
• BaselineResponseDto
• Bin
• BinResponseDto
• BinRule
• BinSortField
• BinStatDto
• BinsFilterResponseDto
• BulkUpdateBinLocationDto
• CancelPaymentsDto
• CardPaymentInquiryResponseDto
• CheckInSettings
• ChecklistTask
• CompleteChecklistTaskDto
• CompleteProjectDto
• CreateCardPaymentDto
• CreateCashPaymentDto
• CreateCheckPaymentDto
• CreateDigitalPaymentDto
• CreateGiftCardPaymentDto
• CreateOtherPaymentDto
• CreateStoreCreditPaymentDto
• DataSyncState
• Employee
• EmployeeTask
• EmployeeTimestamp
• ExecuteReportSuccessDto
• Expression
• ExpressionOfFuncOfBinAndObject
• ExpressionType
• FloorSweepDto
• GeneralSettings
• IdAndValueDto
• ImportEmployeeTasksDto
• InquireCardPaymentsDto
• InventoryLocation
• InventoryRule
• InvoicePayment
• ParameterExpression
• Payment
• PaymentHistory
• PaymentStatus
• PaymentType
• Project
• ProjectPriority
• RefillFromBinsDto
• ReportOptionDto
• RoleAssignmentDto
• RoleAssignmentResponseDto
• RoleDto
• ScheduledReport
• ScheduledReportInterval
• Section
• SectionDto
• SectionRefillDto
• SectionRule
• SectionStatus
• ShiftDto
• ShiftNote
• SortDirection
• TaskShift
• TaskTemplate
• UpdateSectionDto
• UpsertAnnouncementDto
• UpsertBinDto
• UpsertInventoryLocationDto
• UpsertProjectDto
• UpsertRoleDto
• UpsertScheduledReportDto
• UpsertShiftDto
• UpsertShiftNoteDto
• UpsertTaskTemplateDto
• VendorSettings

Authorization

Endpoints do not require authorization.

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-f08584825e9af24ffa1e9dd7a9cdfbaa0e8ca1f5
• 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-09 14:49:57 +00:00

1

OpenAPI-Generator

126 KiB

Assets (1)

hive-sdk-0.0.1-f08584825e9af24ffa1e9dd7a9cdfbaa0e8ca1f5.tgz 126 KiB

Versions (12) View all

0.0.1-e720483c85cac867eca2ee45534029b4e9841751 2026-07-21

0.0.1-v81 2026-07-20

0.0.1-22d7619abcbbfca0d26b1c58860d93ff740db424 2026-07-15

0.0.1-f08584825e9af24ffa1e9dd7a9cdfbaa0e8ca1f5 2026-07-09

0.0.1-792fd42e8f4ac3d60ca5858b25cb42efb700d398 2026-07-08