hytorc-inventory-client v1.1.1

hytorc-inventory-client

Hytorc inventory management API client.

Installation

npm install hytorc-inventory-client

Usage

import { InventoryClient } from 'hytorc-inventory-client';

// Initialize client
const client = new InventoryClient('http://your-api-url', 'optional-api-key');

// Products
const product = await client.createProduct({
  serialId: 'ABC123',
  modelName: 'Model-X',
  companyId: 'company-id',
  endTime: new Date('2024-12-31'),
});

const products = await client.findProducts({
  companyId: 'company-id',
  modelName: 'Model-X',
});

// Companies
const company = await client.createCompany({
  name: 'ACME Corp',
  location: 'Istanbul',
});

const companies = await client.findCompanies();

// Repairs
const repair = await client.createRepair({
  reason: 'Device not working',
  status: 'PENDING',
  startDate: new Date(),
  productId: 'product-id',
  companyId: 'company-id',
});

const repairs = await client.findRepairs({
  status: 'PENDING',
});

// Inventory
const checkIn = await client.checkIn({
  productId: 'product-id',
  date: new Date(),
  addedBy: 'John Doe',
});

const checkOut = await client.checkOut({
  productId: 'product-id',
  date: new Date(),
  addedBy: 'Jane Doe',
});

// File Operations
await client.uploadFile('product-id', file);
const fileBlob = await client.downloadFile('product-id', 'document-id');
const { shortUrl } = await client.generateShortUrl('product-id', 'document-id');

API Reference

Products

createProduct(data: CreateProductDto): Promise<Product>

Yeni ürün oluşturur.

findProducts(query?: FindProductsDto): Promise<Product[]>

Ürünleri listeler.

findProduct(query: FindProductDto): Promise<Product>

Belirli bir ürünü getirir.

updateProduct(id: string, data: UpdateProductDto): Promise<Product>

Ürün bilgilerini günceller.

deleteProduct(query: FindProductDto): Promise<Product>

Ürünü siler.

Companies

createCompany(data: CreateCompanyDto): Promise<Company>

Yeni şirket oluşturur.

findCompanies(): Promise<Company[]>

Tüm şirketleri listeler.

findCompany(query: FindCompanyDto): Promise<Company>

Belirli bir şirketi getirir.

updateCompany(query: FindCompanyDto, data: UpdateCompanyDto): Promise<Company>

Şirket bilgilerini günceller.

deleteCompany(query: FindCompanyDto): Promise<Company>

Şirketi siler.

Repairs

createRepair(data: CreateRepairDto): Promise<Repair>

Yeni tamir/servis kaydı oluşturur.

findRepairs(query?: FindRepairDto): Promise<Repair[]>

Tamir/servis kayıtlarını listeler.

findRepair(id: string): Promise<Repair>

Belirli bir tamir/servis kaydını getirir.

updateRepair(id: string, data: UpdateRepairDto): Promise<Repair>

Tamir/servis kaydını günceller.

deleteRepair(id: string): Promise<Repair>

Tamir/servis kaydını siler.

Inventory

checkIn(data: CheckInHistoryDto): Promise<CheckInHistoryRecord | BatchResponse>

Tekil veya toplu ürün giriş kaydı oluşturur.

checkOut(data: CheckOutHistoryDto): Promise<CheckOutHistoryRecord | BatchResponse>

Tekil veya toplu ürün çıkış kaydı oluşturur.

getCheckInHistory(productId: string): Promise<CheckInHistoryRecord[]>

Ürünün giriş geçmişini listeler.

getCheckOutHistory(productId: string): Promise<CheckOutHistoryRecord[]>

Ürünün çıkış geçmişini listeler.

File Operations

uploadFile(productId: string, file: File): Promise<void>

Ürüne döküman yükler.

downloadFile(productId: string, documentId: string): Promise<Blob>

Ürün dökümanını indirir.

generateShortUrl(productId: string, documentId: string): Promise<{ shortUrl: string }>

Döküman için kısa URL oluşturur.