# Repzo TypeScript SDK Documentation

A comprehensive TypeScript SDK for the Repzo API platform.

## Installation

```bash
npm install repzo
```

## Quick Start

```typescript
import { Service } from "repzo";

// Initialize with your API configuration
const apiKey = "your-api-key";
const baseURL = "https://api.repzo.me/v1";
```

## Available APIs

This SDK provides access to the following APIs:

### Repzo API - Settings

OpenAPI specification for Repzo Settings endpoints.

**Version:** 1.0.0

- [API Reference](./api/settings.md)
- [TypeScript Examples](./api/settings-examples.md)

---

### Patch Action API

API for managing patch actions

**Version:** 1.0.0

- [API Reference](./api/patch-action.md)
- [TypeScript Examples](./api/patch-action-examples.md)

**Available endpoints:**

- Patch Action: Operations related to patch action management

---

### Repzo API - Asset Type

OpenAPI specification for Repzo Asset Type endpoints.

**Version:** 1.0.0

- [API Reference](./api/asset-type.md)
- [TypeScript Examples](./api/asset-type-examples.md)

---

### Workorder Portal API

API for managing workorder portal operations

**Version:** 1.0.0

- [API Reference](./api/workorder-portal.md)
- [TypeScript Examples](./api/workorder-portal-examples.md)

**Available endpoints:**

- Workorder Portal: Workorder portal management operations

---

### Client Channel API

API for managing client channels - distribution channels for organizing and categorizing clients

**Version:** 1.0.0

- [API Reference](./api/client-channel.md)
- [TypeScript Examples](./api/client-channel-examples.md)

**Available endpoints:**

- Channel: Client channel management operations

---

### OCR Invoice Job Group API

API for managing OCR invoice job groups

**Version:** 1.0.0

- [API Reference](./api/ocr-invoice-job-group.md)
- [TypeScript Examples](./api/ocr-invoice-job-group-examples.md)

**Available endpoints:**

- OCR Invoice Job Group: Operations related to OCR invoice job group management

---

### Asset Unit API

API for managing asset units

**Version:** 1.0.0

- [API Reference](./api/asset-unit.md)
- [TypeScript Examples](./api/asset-unit-examples.md)

**Available endpoints:**

- Asset Unit: Asset unit management operations

---

### Product Modifiers Group API

API for managing product modifier groups

**Version:** 1.0.0

- [API Reference](./api/product-modifiers-group.md)
- [TypeScript Examples](./api/product-modifiers-group-examples.md)

**Available endpoints:**

- Product Modifiers Group: Product modifier group management operations

---

### Repzo API - Proforma

OpenAPI specification for Repzo Proforma endpoints.

**Version:** 1.0.0

- [API Reference](./api/proforma.md)
- [TypeScript Examples](./api/proforma-examples.md)

---

### Repzo API - Visit

OpenAPI specification for Repzo Visit endpoints.

**Version:** 1.0.0

- [API Reference](./api/visit.md)
- [TypeScript Examples](./api/visit-examples.md)

---

### Repzo API - Measure Unit

OpenAPI specification for Repzo Measure Unit endpoints.

**Version:** 1.0.0

- [API Reference](./api/measureunit.md)
- [TypeScript Examples](./api/measureunit-examples.md)

---

### Repzo API - Full Invoices

OpenAPI specification for Repzo Full Invoices endpoints.

**Version:** 1.0.0

- [API Reference](./api/fullinvoices.md)
- [TypeScript Examples](./api/fullinvoices-examples.md)

---

### Repzo API - Custom List Item

OpenAPI specification for Repzo Custom List Item endpoints.

**Version:** 1.0.0

- [API Reference](./api/custom-list-item.md)
- [TypeScript Examples](./api/custom-list-item-examples.md)

---

### Update Integration Meta API

API for managing integration metadata updates

**Version:** 1.0.0

- [API Reference](./api/update-integration-meta.md)
- [TypeScript Examples](./api/update-integration-meta-examples.md)

**Available endpoints:**

- Update Integration Meta: Operations related to updating integration metadata

---

### Repzo API - Warehouse

OpenAPI specification for Repzo Warehouse endpoints.

**Version:** 1.0.0

- [API Reference](./api/warehouse.md)
- [TypeScript Examples](./api/warehouse-examples.md)

---

### Safe Invoice Serial Counter API

API for managing safe invoice serial counters

**Version:** 1.0.0

- [API Reference](./api/safe-invoice-serial-counter.md)
- [TypeScript Examples](./api/safe-invoice-serial-counter-examples.md)

**Available endpoints:**

- Safe Invoice Serial Counter: Safe invoice serial counter management operations

---

### Repzo API - Product Group

OpenAPI specification for Repzo Product Group endpoints.

**Version:** 1.0.0

- [API Reference](./api/product-group.md)
- [TypeScript Examples](./api/product-group-examples.md)

---

### Repzo API - Rep

OpenAPI specification for Repzo Rep (Sales Representative) endpoints.

**Version:** 1.0.0

- [API Reference](./api/rep.md)
- [TypeScript Examples](./api/rep-examples.md)

---

### Repzo API - Brand

OpenAPI specification for Repzo Brand endpoints.

**Version:** 1.0.0

- [API Reference](./api/brand.md)
- [TypeScript Examples](./api/brand-examples.md)

---

### Repzo API - Approval Request

OpenAPI specification for Repzo Approval Request endpoints.

**Version:** 1.0.0

- [API Reference](./api/approval-request.md)
- [TypeScript Examples](./api/approval-request-examples.md)

---

### Activity Feedback API

API for managing activity feedback

**Version:** 1.0.0

- [API Reference](./api/activity-feedback.md)
- [TypeScript Examples](./api/activity-feedback-examples.md)

**Available endpoints:**

- Activity Feedback: Activity feedback management operations

---

### Activity AI Sales Order API

API for managing AI-assisted sales order activities

**Version:** 1.0.0

- [API Reference](./api/activity-ai-sales-order.md)
- [TypeScript Examples](./api/activity-ai-sales-order-examples.md)

**Available endpoints:**

- Activity AI Sales Order: Operations related to AI-assisted sales order activities

---

### Asset Part API

API for managing asset parts

**Version:** 1.0.0

- [API Reference](./api/asset-part.md)
- [TypeScript Examples](./api/asset-part-examples.md)

**Available endpoints:**

- Asset Part: Operations related to asset part management

---

### Store Asset Part Unit API

API for managing asset part unit storage operations

**Version:** 1.0.0

- [API Reference](./api/store-asset-part-unit.md)
- [TypeScript Examples](./api/store-asset-part-unit-examples.md)

**Available endpoints:**

- Store Asset Part Unit: Operations related to storing asset part units

---

### Activity Storecheck API

API for managing activity storecheck records

**Version:** 1.0.0

- [API Reference](./api/activity-storecheck.md)
- [TypeScript Examples](./api/activity-storecheck-examples.md)

**Available endpoints:**

- Activity Storecheck: Operations related to activity storecheck management

---

### Repzo API - Custom List

OpenAPI specification for Repzo Custom List endpoints.

**Version:** 1.0.0

- [API Reference](./api/custom-list.md)
- [TypeScript Examples](./api/custom-list-examples.md)

---

### Return Asset Part Unit API

API for managing returns of asset part units

**Version:** 1.0.0

- [API Reference](./api/return-asset-part-unit.md)
- [TypeScript Examples](./api/return-asset-part-unit-examples.md)

**Available endpoints:**

- Return Asset Part Unit: Operations related to returning asset part units

---

### Client Location API

API for managing client locations

**Version:** 1.0.0

- [API Reference](./api/client-location.md)
- [TypeScript Examples](./api/client-location-examples.md)

**Available endpoints:**

- Client Location: Client location management operations

---

### Asset Part Type API

API for managing asset part types

**Version:** 1.0.0

- [API Reference](./api/asset-part-type.md)
- [TypeScript Examples](./api/asset-part-type-examples.md)

**Available endpoints:**

- Asset Part Type: Operations related to asset part type management

---

### Repzo API - Rep Balance Summary

OpenAPI specification for Repzo Rep Balance Summary endpoints.

**Version:** 1.0.0

- [API Reference](./api/rep-balance-summary.md)
- [TypeScript Examples](./api/rep-balance-summary-examples.md)

---

### Activity Feedback V2 API

API for managing activity feedback (version 2)

**Version:** 2.0.0

- [API Reference](./api/activity-feedback-v2.md)
- [TypeScript Examples](./api/activity-feedback-v2-examples.md)

**Available endpoints:**

- Activity Feedback V2: Activity feedback v2 management operations

---

### Repzo API - Workorder Request

OpenAPI specification for Repzo Workorder Request endpoints.

**Version:** 1.0.0

- [API Reference](./api/workorder-request.md)
- [TypeScript Examples](./api/workorder-request-examples.md)

---

### OCR Invoice Job API

API for managing individual OCR invoice jobs

**Version:** 1.0.0

- [API Reference](./api/ocr-invoice-job.md)
- [TypeScript Examples](./api/ocr-invoice-job-examples.md)

**Available endpoints:**

- OCR Invoice Job: Operations related to individual OCR invoice job management

---

### Integration Command Log API

API for managing integration command logs

**Version:** 1.0.0

- [API Reference](./api/integration-command-log.md)
- [TypeScript Examples](./api/integration-command-log-examples.md)

**Available endpoints:**

- Integration Command Log: Operations related to integration command log management

---

### Repzo API - Transfer

OpenAPI specification for Repzo Transfer endpoints.

**Version:** 1.0.0

- [API Reference](./api/transfer.md)
- [TypeScript Examples](./api/transfer-examples.md)

---

### Feedback Options API

API for managing feedback options and templates

**Version:** 1.0.0

- [API Reference](./api/feedback-options.md)
- [TypeScript Examples](./api/feedback-options-examples.md)

**Available endpoints:**

- Feedback Options: Feedback options management operations

---

### Workorder Portal Link API

API for managing workorder portal links

**Version:** 1.0.0

- [API Reference](./api/workorder-portal-link.md)
- [TypeScript Examples](./api/workorder-portal-link-examples.md)

**Available endpoints:**

- Workorder Portal Link: Workorder portal link management operations

---

### Asset Part Unit API

API for managing asset part units (individual instances of parts)

**Version:** 1.0.0

- [API Reference](./api/asset-part-unit.md)
- [TypeScript Examples](./api/asset-part-unit-examples.md)

**Available endpoints:**

- Asset Part Unit: Operations related to asset part unit management

---

### Asset Part Transfer API

API for managing asset part transfers between locations

**Version:** 1.0.0

- [API Reference](./api/asset-part-transfer.md)
- [TypeScript Examples](./api/asset-part-transfer-examples.md)

**Available endpoints:**

- Asset Part Transfer: Operations related to asset part transfer management

---

### Repzo API - Day

OpenAPI specification for Repzo Day endpoints.

**Version:** 1.0.0

- [API Reference](./api/day.md)
- [TypeScript Examples](./api/day-examples.md)

---

### Contract Installment API

API for managing contract installments

**Version:** 1.0.0

- [API Reference](./api/contract-installment.md)
- [TypeScript Examples](./api/contract-installment-examples.md)

**Available endpoints:**

- Contract Installment: Contract installment management operations

---

### Repzo API - Category

OpenAPI specification for Repzo Category endpoints.

**Version:** 1.0.0

- [API Reference](./api/category.md)
- [TypeScript Examples](./api/category-examples.md)

---

### Repzo API - Quick Convert to PDF

OpenAPI specification for Repzo Quick Convert to PDF endpoints.

**Version:** 1.0.0

- [API Reference](./api/quick-convert-to-pdf.md)
- [TypeScript Examples](./api/quick-convert-to-pdf-examples.md)

---

### Repzo API - Route

OpenAPI specification for Repzo Route endpoints.

**Version:** 1.0.0

- [API Reference](./api/route.md)
- [TypeScript Examples](./api/route-examples.md)

---

### Repzo API - Payments

OpenAPI specification for Repzo Payments endpoints.

**Version:** 1.0.0

- [API Reference](./api/payments.md)
- [TypeScript Examples](./api/payments-examples.md)

---

### Repzo API - Tag

OpenAPI specification for Repzo Tag endpoints.

**Version:** 1.0.0

- [API Reference](./api/tag.md)
- [TypeScript Examples](./api/tag-examples.md)

---

### Repzo API - Bank Lists

OpenAPI specification for Repzo Bank Lists endpoints.

**Version:** 1.0.0

- [API Reference](./api/bankslists.md)
- [TypeScript Examples](./api/bankslists-examples.md)

---

### Repzo API - Inventory Adjustment Reason

OpenAPI specification for Repzo Inventory Adjustment Reason endpoints.

**Version:** 1.0.0

- [API Reference](./api/inventory-adjustment-reason.md)
- [TypeScript Examples](./api/inventory-adjustment-reason-examples.md)

---

### Repzo API - SubCategory

OpenAPI specification for Repzo SubCategory endpoints.

**Version:** 1.0.0

- [API Reference](./api/subcategory.md)
- [TypeScript Examples](./api/subcategory-examples.md)

---

### Repzo API - Supplier

OpenAPI specification for Repzo Supplier endpoints.

**Version:** 1.0.0

- [API Reference](./api/supplier.md)
- [TypeScript Examples](./api/supplier-examples.md)

---

### Repzo API - Banks

OpenAPI specification for Repzo Banks endpoints.

**Version:** 1.0.0

- [API Reference](./api/banks.md)
- [TypeScript Examples](./api/banks-examples.md)

---

### Repzo API - Custom Status

OpenAPI specification for Repzo Custom Status endpoints.

**Version:** 1.0.0

- [API Reference](./api/custom-status.md)
- [TypeScript Examples](./api/custom-status-examples.md)

---

### Mail Unsubscribe API

API for managing email unsubscription

**Version:** 1.0.0

- [API Reference](./api/mail-unsubscribe.md)
- [TypeScript Examples](./api/mail-unsubscribe-examples.md)

**Available endpoints:**

- Mail Unsubscribe: Email unsubscription management operations

---

### Repzo API - Storecheck Template

OpenAPI specification for Repzo Storecheck Template endpoints.

**Version:** 1.0.0

- [API Reference](./api/storecheck-template.md)
- [TypeScript Examples](./api/storecheck-template-examples.md)

---

### Repzo API - Receiving Material

OpenAPI specification for Repzo Receiving Material endpoints.

**Version:** 1.0.0

- [API Reference](./api/receiving-material.md)
- [TypeScript Examples](./api/receiving-material-examples.md)

---

### Repzo API - Checks

OpenAPI specification for Repzo Checks endpoints.

**Version:** 1.0.0

- [API Reference](./api/checks.md)
- [TypeScript Examples](./api/checks-examples.md)

---

### Repzo API - Media Storage

OpenAPI specification for Repzo Media Storage endpoints.

**Version:** 1.0.0

- [API Reference](./api/media-storage.md)
- [TypeScript Examples](./api/media-storage-examples.md)

---

### Repzo API - Media

OpenAPI specification for Repzo Media endpoints.

**Version:** 1.0.0

- [API Reference](./api/media.md)
- [TypeScript Examples](./api/media-examples.md)

---

### Asset Part Receival API

API for managing asset part receivals (receiving inventory)

**Version:** 1.0.0

- [API Reference](./api/asset-part-receival.md)
- [TypeScript Examples](./api/asset-part-receival-examples.md)

**Available endpoints:**

- Asset Part Receival: Operations related to asset part receival management

---

### Repzo API - Refund

OpenAPI specification for Repzo Refund endpoints.

**Version:** 1.0.0

- [API Reference](./api/refund.md)
- [TypeScript Examples](./api/refund-examples.md)

---

### Client Contact API

API for managing client contacts - individual contact persons associated with clients

**Version:** 1.0.0

- [API Reference](./api/client-contact.md)
- [TypeScript Examples](./api/client-contact-examples.md)

**Available endpoints:**

- Client Contact: Client contact management operations

---

### Speciality API

API for managing specialities

**Version:** 1.0.0

- [API Reference](./api/speciality.md)
- [TypeScript Examples](./api/speciality-examples.md)

**Available endpoints:**

- Speciality: Speciality management operations

---

### Repzo API - Settlement

OpenAPI specification for Repzo Settlement endpoints.

**Version:** 1.0.0

- [API Reference](./api/settlement.md)
- [TypeScript Examples](./api/settlement-examples.md)

---

### Repzo API - Asset

OpenAPI specification for Repzo Asset endpoints.

**Version:** 1.0.0

- [API Reference](./api/asset.md)
- [TypeScript Examples](./api/asset-examples.md)

---

### Repzo API - Measureunit Family

OpenAPI specification for Repzo Measureunit Family endpoints.

**Version:** 1.0.0

- [API Reference](./api/measureunit-family.md)
- [TypeScript Examples](./api/measureunit-family-examples.md)

---

### Repzo API - Client

OpenAPI specification for Repzo Client endpoints.

**Version:** 1.0.0

- [API Reference](./api/client.md)
- [TypeScript Examples](./api/client-examples.md)

---

### Repzo API - Price List

OpenAPI specification for Repzo Price List endpoints.

**Version:** 1.0.0

- [API Reference](./api/pricelist.md)
- [TypeScript Examples](./api/pricelist-examples.md)

---

### Repzo API - Price List Item

OpenAPI specification for Repzo Price List Item endpoints.

**Version:** 1.0.0

- [API Reference](./api/pricelist-item.md)
- [TypeScript Examples](./api/pricelist-item-examples.md)

---

### Repzo API - Adjust Account

OpenAPI specification for Repzo Adjust Account endpoints.

**Version:** 1.0.0

- [API Reference](./api/adjust-account.md)
- [TypeScript Examples](./api/adjust-account-examples.md)

---

### Repzo API - Integration App

OpenAPI specification for Repzo Integration App endpoints.

**Version:** 1.0.0

- [API Reference](./api/integration-app.md)
- [TypeScript Examples](./api/integration-app-examples.md)

---

### Repzo API - Payment Terms

OpenAPI specification for Repzo Payment Terms endpoints.

**Version:** 1.0.0

- [API Reference](./api/payment-terms.md)
- [TypeScript Examples](./api/payment-terms-examples.md)

---

### Repzo API - Team

OpenAPI specification for Repzo Team endpoints.

**Version:** 1.0.0

- [API Reference](./api/team.md)
- [TypeScript Examples](./api/team-examples.md)

---

### Repzo API - Workorder

OpenAPI specification for Repzo Workorder endpoints.

**Version:** 1.0.0

- [API Reference](./api/workorder.md)
- [TypeScript Examples](./api/workorder-examples.md)

---

### Repzo API - Adjust Inventory

OpenAPI specification for Repzo Adjust Inventory endpoints.

**Version:** 1.0.0

- [API Reference](./api/adjust-inventory.md)
- [TypeScript Examples](./api/adjust-inventory-examples.md)

---

### Svix Integration API

API for managing Svix webhook integrations

**Version:** 1.0.0

- [API Reference](./api/svix-integration.md)
- [TypeScript Examples](./api/svix-integration-examples.md)

**Available endpoints:**

- Svix Integration: Operations related to Svix webhook integration management

---

### OCR Invoice Job Page API

API for managing individual pages within OCR invoice jobs

**Version:** 1.0.0

- [API Reference](./api/ocr-invoice-job-page.md)
- [TypeScript Examples](./api/ocr-invoice-job-page-examples.md)

**Available endpoints:**

- OCR Invoice Job Page: Operations related to individual pages within OCR invoice jobs

---

### OCR Invoice Job Template API

API for managing OCR invoice job templates

**Version:** 1.0.0

- [API Reference](./api/ocr-invoice-job-template.md)
- [TypeScript Examples](./api/ocr-invoice-job-template-examples.md)

**Available endpoints:**

- OCR Invoice Job Template: Operations related to OCR invoice job template management

---

### Repzo API - Contract

OpenAPI specification for Repzo Contract endpoints.

**Version:** 1.0.0

- [API Reference](./api/contract.md)
- [TypeScript Examples](./api/contract-examples.md)

---

### Repzo API - Tax

OpenAPI specification for Repzo Tax endpoints.

**Version:** 1.0.0

- [API Reference](./api/tax.md)
- [TypeScript Examples](./api/tax-examples.md)

---

### Repzo API - MSL Products

OpenAPI specification for Repzo MSL Products endpoints.

**Version:** 1.0.0

- [API Reference](./api/msl-products.md)
- [TypeScript Examples](./api/msl-products-examples.md)

---

### Repzo API - Approvals

OpenAPI specification for Repzo Approvals endpoints.

**Version:** 1.0.0

- [API Reference](./api/approvals.md)
- [TypeScript Examples](./api/approvals-examples.md)

---

### Repzo API - MSL

OpenAPI specification for Repzo MSL (Most Sold List) endpoints.

**Version:** 1.0.0

- [API Reference](./api/msl.md)
- [TypeScript Examples](./api/msl-examples.md)

---

### Repzo API - Inventory

OpenAPI specification for Repzo Inventory endpoints.

**Version:** 1.0.0

- [API Reference](./api/inventory.md)
- [TypeScript Examples](./api/inventory-examples.md)

---

### Repzo API - Variant

OpenAPI specification for Repzo Variant endpoints.

**Version:** 1.0.0

- [API Reference](./api/variant.md)
- [TypeScript Examples](./api/variant-examples.md)

---

### Repzo API - Return Reason

OpenAPI specification for Repzo Return Reason endpoints.

**Version:** 1.0.0

- [API Reference](./api/return-reason.md)
- [TypeScript Examples](./api/return-reason-examples.md)

---

### Integration Action Log API

API for managing integration action logs

**Version:** 1.0.0

- [API Reference](./api/integration-action-log.md)
- [TypeScript Examples](./api/integration-action-log-examples.md)

**Available endpoints:**

- Integration Action Log: Operations related to integration action log management

---

### Workorder Category API

API for managing workorder categories

**Version:** 1.0.0

- [API Reference](./api/workorder-category.md)
- [TypeScript Examples](./api/workorder-category-examples.md)

**Available endpoints:**

- Workorder Category: Workorder category management operations

---

### Repzo API - Product

OpenAPI specification for Repzo Product endpoints.

**Version:** 1.0.0

- [API Reference](./api/product.md)
- [TypeScript Examples](./api/product-examples.md)

---

## Authentication

All APIs use Bearer token authentication. Include your API key in the Authorization header:

```typescript
const headers = {
  Authorization: `Bearer ${your_api_key}`,
  "Content-Type": "application/json",
};
```

## TypeScript Support

This SDK is written in TypeScript and provides full type definitions for all API endpoints, request/response models, and configuration options.

### Type Definitions

```typescript
import { Service } from "repzo";

// Access type definitions for any service
type ClientSchema = Service.Client.ClientSchema;
type ProductSchema = Service.Product.ProductSchema;
// ... and many more
```

### Example Usage with Types

```typescript
import { Service } from "repzo";

async function getClients(): Promise<Service.Client.Find.Result> {
  const params: Service.Client.Find.Params = {
    page: 1,
    per_page: 25,
    active: true,
  };

  // Your API call implementation here
  return result;
}
```

## Error Handling

All API calls should include proper error handling:

```typescript
try {
  const result = await apiCall();
  if (result.success) {
    console.log("Data:", result.data);
  } else {
    console.error("API Error:", result.error);
  }
} catch (error) {
  console.error("Request failed:", error);
}
```

## Pagination

Most list endpoints support pagination:

```typescript
const params = {
  page: 1, // Page number (1-based)
  per_page: 25, // Items per page (max 100)
  sort: "name", // Sort field
  // ... other filters
};
```

Response includes pagination information:

```typescript
{
  "success": true,
  "data": [...],
  "paging": {
    "total": 150,
    "page": 1,
    "per_page": 25,
    "pages": 6
  }
}
```

## Contributing

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## License

This project is licensed under the ISC License - see the LICENSE file for details.

## Support

For support and questions:

- GitHub Issues: [Report a bug or request a feature](https://github.com/Repzo/repzo-ts/issues)
- Documentation: [Full API Documentation](./api/)

## Changelog

See [CHANGELOG.md](../changelog.md) for a detailed history of changes.