@bontabil/sdk 0.1.3

package/dist/index.d.ts

@@ -0,0 +1,966 @@
+//#region src/api/chatbot/types.d.ts
+/**
+* The roles that can be assigned to messages in a language model conversation.
+*/
+type LlmRole = "user" | "assistant" | "system";
+/**
+* The history message interface, representing a past message in the conversation.
+*/
+interface HistoryMessage {
+  /**
+  * The content of the message.
+  */
+  content: string;
+  /**
+  * The role of the message sender.
+  */
+  role: LlmRole;
+}
+/**
+* The chatbot request interface, including the current message and optional history.
+*/
+interface ChatbotRequest {
+  /**
+  * The current message from the user.
+  */
+  message: string;
+  /**
+  * The history of past messages in the conversation.
+  */
+  history?: HistoryMessage[];
+}
+/**
+* The chatbot response interface, representing the assistant's reply.
+*/
+interface ChatbotResponse {
+  /**
+  * The response message from the assistant.
+  */
+  message: string;
+}
+//#endregion
+//#region src/client/types.d.ts
+/**
+* The client options.
+*/
+interface ClientOptions {
+  /**
+  * The API endpoint. If not provided, the default endpoint will be used.
+  */
+  endpoint?: string;
+  /**
+  * The API token.
+  */
+  token: string;
+  /**
+  * The request options to use for all requests.
+  */
+  requestOptions?: RequestInit;
+}
+//#endregion
+//#region src/client/client.d.ts
+/**
+* The API client.
+*/
+declare class Client {
+  /**
+  * The client options.
+  */
+  protected options: Required<ClientOptions>;
+  /**
+  * The client constructor.
+  *
+  * @param options The client options.
+  */
+  constructor(options: ClientOptions);
+  /**
+  * Make a generic request to the API.
+  *
+  * @param path The path to request.
+  * @param options The request options.
+  * @returns The response.
+  */
+  request(path: string, options?: RequestInit): Promise<Response>;
+  /**
+  * Handle an error response.
+  *
+  * @param res The response.
+  * @param data The response data.
+  */
+  private handleError;
+  /**
+  * Builds a full URL from the given path.
+  *
+  * @param path The path to build the URL for.
+  * @returns The full URL.
+  */
+  buildUrl(path: string): URL;
+}
+//#endregion
+//#region src/client/constants.d.ts
+declare const DEFAULT_ENDPOINT = "https://api.bontabil.ro/api";
+declare const DEFAULT_OPTIONS: Omit<Required<ClientOptions>, "token">;
+//#endregion
+//#region src/api/resource.d.ts
+/**
+* The base resource class.
+*/
+declare abstract class Resource {
+  protected readonly client: Client;
+  /**
+  * The base resource constructor.
+  *
+  * @param client The API client.
+  */
+  constructor(client: Client);
+}
+//#endregion
+//#region src/api/chatbot/resource.d.ts
+/**
+* The chatbot resource.
+*/
+declare class ChatbotResource extends Resource {
+  /**
+  * Send a message to the chatbot.
+  *
+  * @param request The chatbot request.
+  * @returns The chatbot response.
+  */
+  sendMessage(request?: ChatbotRequest): Promise<ChatbotResponse>;
+}
+//#endregion
+//#region src/api/types.d.ts
+/**
+* The client or client options type.
+*/
+type ClientOrClientOptions = Client | ClientOptions;
+/**
+* The filter object type.
+*/
+type FilterObject = Record<string, string | number | boolean | Date>;
+/**
+* The filter options type.
+*/
+type FilterOptions<T extends FilterObject = FilterObject> = Partial<T>;
+/**
+* The include options type.
+*/
+type IncludeOptions<T extends string = string> = T[];
+/**
+* The sort options type.
+*/
+interface SortOptions<T extends string = string> {
+  /**
+  * The field to sort by.
+  */
+  field: T;
+  /**
+  * The sort direction.
+  */
+  direction?: "asc" | "desc";
+}
+/**
+* The pagination options type.
+*/
+interface PaginationOptions {
+  /**
+  * The page number.
+  */
+  page?: number;
+  /**
+  * The number of items per page.
+  */
+  per_page?: number;
+}
+/**
+* The filter request type.
+*/
+interface FilterRequest<T extends FilterObject = FilterObject> {
+  /**
+  * The filter options.
+  */
+  filter?: FilterOptions<T>;
+}
+/**
+* The include request type.
+*/
+interface IncludeRequest<T extends string = string> {
+  /**
+  * The include options.
+  */
+  include?: IncludeOptions<T>;
+}
+/**
+* The sort request type.
+*/
+interface SortRequest<T extends string = string> {
+  /**
+  * The sort options.
+  */
+  sort?: SortOptions<T>;
+}
+/**
+* The pagination request type.
+*/
+interface PaginationRequest {
+  /**
+  * The pagination options.
+  */
+  pagination?: PaginationOptions;
+}
+/**
+* The pagination links type.
+*/
+interface PaginationLinks {
+  /**
+  * The first page link.
+  */
+  first: string;
+  /**
+  * The last page link.
+  */
+  last: string;
+  /**
+  * The previous page link.
+  */
+  prev: string | null;
+  /**
+  * The next page link.
+  */
+  next: string | null;
+}
+/**
+* The pagination meta link type.
+*/
+interface PaginationMetaLink {
+  /**
+  * The URL of the link.
+  */
+  url: string | null;
+  /**
+  * The label of the link.
+  */
+  label: string;
+  /**
+  * The page number of the link.
+  */
+  page: number | null;
+  /**
+  * The active status of the link.
+  */
+  active: boolean;
+}
+/**
+* The pagination meta type.
+*/
+interface PaginationMeta {
+  /**
+  * The current page number.
+  */
+  current_page: number;
+  /**
+  * The pagination starting item number.
+  */
+  from: number;
+  /**
+  * The pagination ending item number.
+  */
+  to: number;
+  /**
+  * The last page number.
+  */
+  last_page: number;
+  /**
+  * The current page path.
+  */
+  path: string;
+  /**
+  * The number of items per page.
+  */
+  per_page: number;
+  /**
+  * The total number of items.
+  */
+  total: number;
+}
+/**
+* The list request type.
+*/
+interface ListRequest<TFilter extends FilterObject = FilterObject, TInclude extends string = string, TSort extends string = string> extends FilterRequest<TFilter>, IncludeRequest<TInclude>, SortRequest<TSort>, PaginationRequest {}
+/**
+* The paginated response type.
+*/
+interface PaginatedResponse<T> {
+  /**
+  * The data array.
+  */
+  data: T[];
+  /**
+  * The pagination links.
+  */
+  links: PaginationLinks;
+  /**
+  * The pagination meta information.
+  */
+  meta: PaginationMeta;
+}
+//#endregion
+//#region src/api/counties/types.d.ts
+/**
+* The interface representing a county.
+*/
+interface County {
+  /**
+  * The unique identifier of the county.
+  */
+  id: number;
+  /**
+  * The name of the county.
+  */
+  name: string;
+  /**
+  * The code of the county.
+  */
+  code: string;
+  /**
+  * The cities within the county.
+  */
+  cities?: City[];
+}
+/**
+* The interface representing the request parameters for listing counties.
+*/
+type ListCountiesRequest = ListRequest<{
+  id: number;
+  name: string;
+  code: string;
+}, "cities", "id" | "name" | "code">;
+//#endregion
+//#region src/api/counties/resource.d.ts
+/**
+* The counties resource.
+*/
+declare class CountiesResource extends Resource {
+  /**
+  * Get a paginated list of counties.
+  *
+  * @param request The counties request parameters.
+  * @returns The paginated list of counties.
+  */
+  list(request?: ListCountiesRequest): Promise<PaginatedResponse<County>>;
+}
+//#endregion
+//#region src/api/cities/types.d.ts
+/**
+* The interface representing a city.
+*/
+interface City {
+  /**
+  * The unique identifier of the city.
+  */
+  id: number;
+  /**
+  * The name of the city.
+  */
+  name: string;
+  /**
+  * The county to which the city belongs.
+  */
+  county?: County;
+  /**
+  * The stores within the city.
+  *
+  * TODO: Replace `unknown` with the actual Store interface when available.
+  */
+  stores?: unknown[];
+}
+/**
+* The interface representing the request parameters for listing cities.
+*/
+type ListCitiesRequest = ListRequest<{
+  id: number;
+  name: string;
+  county_id: number;
+}, "county" | "stores", "id" | "name" | "county_id">;
+//#endregion
+//#region src/api/cities/resource.d.ts
+/**
+* The cities resource.
+*/
+declare class CitiesResource extends Resource {
+  /**
+  * Get a paginated list of cities.
+  *
+  * @param request The cities request parameters.
+  * @returns The paginated list of cities.
+  */
+  list(request?: ListCitiesRequest): Promise<PaginatedResponse<City>>;
+}
+//#endregion
+//#region src/api/stores/types.d.ts
+/**
+* The interface representing a store.
+*/
+interface Store {
+  /**
+  * The unique identifier of the store.
+  */
+  id: number;
+  /**
+  * The street address of the store.
+  */
+  address: string;
+  /**
+  * The latitude of the store's location.
+  */
+  latitude: string;
+  /**
+  * The longitude of the store's location.
+  */
+  longitude: string;
+  /**
+  * The merchant associated with the store.
+  *
+  * TODO: Replace `unknown` with the actual Merchant interface when available.
+  */
+  merchant?: unknown;
+  /**
+  * The city where the store is located.
+  */
+  city?: City;
+  /**
+  * The receipts associated with the store.
+  *
+  * TODO: Replace `unknown` with the actual Receipt interface when available.
+  */
+  receipts?: unknown[];
+}
+/**
+* The interface representing the request parameters for listing stores.
+*/
+type ListStoresRequest = ListRequest<{
+  id: number;
+  address: string;
+  city_id: number;
+}, "city" | "merchant" | "receipts", "id" | "address" | "city_id" | "store_id">;
+//#endregion
+//#region src/api/stores/resource.d.ts
+/**
+* The stores resource.
+*/
+declare class StoresResource extends Resource {
+  /**
+  * Get a paginated list of stores.
+  *
+  * @param request The stores request parameters.
+  * @returns The paginated list of stores.
+  */
+  list(request?: ListStoresRequest): Promise<PaginatedResponse<Store>>;
+}
+//#endregion
+//#region src/api/merchants/types.d.ts
+/**
+* The interface representing a merchant.
+*/
+interface Merchant {
+  /**
+  * The unique identifier of the merchant.
+  */
+  id: number;
+  /**
+  * The name of the merchant.
+  */
+  name: string;
+  /**
+  * The merchant's registration number.
+  */
+  company_registration_number: string;
+  /**
+  * The flag indicating whether the merchant is a VAT payer.
+  */
+  is_vat_payer: boolean;
+  /**
+  * The stores associated with the merchant.
+  */
+  stores?: Store[];
+}
+/**
+* The interface representing the request parameters for listing merchants.
+*/
+type ListMerchantsRequest = ListRequest<{
+  id: number;
+  name: string;
+  company_registration_number: string;
+  is_vat_payer: boolean;
+}, "stores", "id" | "name" | "company_registration_number" | "is_vat_payer">;
+//#endregion
+//#region src/api/merchants/resource.d.ts
+/**
+* The merchants resource.
+*/
+declare class MerchantsResource extends Resource {
+  /**
+  * Get a paginated list of merchants.
+  *
+  * @param request The merchants request parameters.
+  * @returns The paginated list of merchants.
+  */
+  list(request?: ListMerchantsRequest): Promise<PaginatedResponse<Merchant>>;
+}
+//#endregion
+//#region src/api/personal-access-tokens/types.d.ts
+/**
+* The interface representing a personal access token.
+*/
+interface PersonalAccessToken {
+  /**
+  * The unique identifier of the personal access token.
+  */
+  id: number;
+  /**
+  * The name of the personal access token.
+  */
+  name: string;
+  /**
+  * The actual token string. This is only available when the token is created.
+  */
+  token: string | null;
+  /**
+  * The abilities granted to the personal access token.
+  */
+  abilities: string[];
+  /**
+  * The timestamp when the personal access token was last used.
+  */
+  last_used_at: string | null;
+  /**
+  * The timestamp when the personal access token expires. If null, the token does not expire.
+  */
+  expires_at: string | null;
+  /**
+  * The timestamp when the personal access token was created.
+  */
+  created_at: string;
+  /**
+  * The timestamp when the personal access token was last updated.
+  */
+  updated_at: string;
+}
+/**
+* The interface representing the request body for creating or updating a personal access token.
+*/
+interface PersonalAccessTokenRequest {
+  /**
+  * The name of the personal access token.
+  */
+  name: string;
+  /**
+  * The abilities to be granted to the personal access token.
+  */
+  abilities: string[];
+  /**
+  * The expiration date of the personal access token in ISO 8601 format. If null, the token does not expire.
+  */
+  expires_at?: string | null;
+}
+//#endregion
+//#region src/api/personal-access-tokens/resource.d.ts
+/**
+* The personal access tokens resource.
+*/
+declare class PersonalAccessTokensResource extends Resource {
+  /**
+  * List all personal access tokens.
+  *
+  * @returns A list of personal access tokens.
+  */
+  all(): Promise<PersonalAccessToken[]>;
+  /**
+  * Create a new personal access token.
+  *
+  * @param request The create personal access token request.
+  * @returns The created personal access token.
+  */
+  create(request: PersonalAccessTokenRequest): Promise<PersonalAccessToken>;
+  /**
+  * Update a personal access token by ID.
+  *
+  * @param id The personal access token ID.
+  * @param request The update personal access token request.
+  * @returns The updated personal access token.
+  */
+  update(id: number, request: PersonalAccessTokenRequest): Promise<PersonalAccessToken>;
+  /**
+  * Get a personal access token by ID.
+  *
+  * @param id The personal access token ID.
+  * @returns The personal access token.
+  */
+  get(id: number): Promise<PersonalAccessToken>;
+  /**
+  * Delete a personal access token by ID.
+  *
+  * @param id The personal access token ID.
+  */
+  delete(id: number): Promise<void>;
+}
+//#endregion
+//#region src/api/profile/types.d.ts
+/**
+* The interface representing a user's profile.
+*/
+interface Profile {
+  /**
+  * The user's unique identifier.
+  */
+  id: number;
+  /**
+  * The user's name.
+  */
+  name: string;
+  /**
+  * The user's email address.
+  */
+  email: string;
+  /**
+  * The user's available credits.
+  */
+  credits: number;
+  /**
+  * The user's permissions.
+  */
+  permissions: string[];
+}
+//#endregion
+//#region src/api/profile/resource.d.ts
+/**
+* The profile resource.
+*/
+declare class ProfileResource extends Resource {
+  /**
+  * Get the current user's profile.
+  *
+  * @returns The current user's profile.
+  */
+  me(): Promise<Profile>;
+}
+//#endregion
+//#region src/api/receipts/types.d.ts
+/**
+* The receipt type.
+*/
+interface Receipt {
+  /**
+  * The unique identifier of the receipt (ULID).
+  */
+  id: string;
+  /**
+  * The status of the receipt.
+  */
+  status: ReceiptStatus;
+  /**
+  * The receipt details.
+  */
+  details?: ReceiptDetails;
+  /**
+  * The receipt messages.
+  */
+  messages: ReceiptMessage[];
+}
+interface ReceiptItem {
+  /**
+  * The unique identifier of the receipt item.
+  */
+  id: number;
+  /**
+  * The name of the receipt item.
+  */
+  name: string;
+  /**
+  * The quantity of the receipt item.
+  */
+  quantity: number;
+  /**
+  * The unit of measurement for the quantity.
+  */
+  quantity_unit: QuantityUnit;
+  /**
+  * The unit price of the receipt item.
+  */
+  unit_price: number;
+  /**
+  * The total price of the receipt item.
+  */
+  total_price: number;
+  /**
+  * The VAT category of the receipt item.
+  */
+  vat_category: string;
+  /**
+  * The VAT percentage of the receipt item.
+  */
+  vat_percentage: number;
+  /**
+  * The category of the receipt item.
+  */
+  category?: ReceiptItemCategory;
+}
+/**
+* The receipt details type.
+*/
+interface ReceiptDetails {
+  /**
+  * The receipt code.
+  */
+  code: string;
+  /**
+  * The date of the receipt in ISO 8601 format.
+  */
+  date: string;
+  /**
+  * The total price of the receipt.
+  */
+  total_price: number;
+  /**
+  * The store where the receipt was issued.
+  */
+  store?: Store;
+}
+/**
+* The receipt message type.
+*/
+interface ReceiptMessage {
+  /**
+  * The type of the receipt message.
+  */
+  type: ReceiptMessageType;
+  /**
+  * The content of the receipt message.
+  */
+  message: string;
+}
+/**
+* The possible statuses of a receipt.
+*/
+type ReceiptStatus = "created" | "processing" | "processed" | "error";
+/**
+* The possible types of receipt messages.
+*/
+type ReceiptMessageType = "info" | "warning" | "error";
+/**
+* The receipt item category type.
+*/
+interface ReceiptItemCategory {
+  /**
+  * The unique identifier of the receipt item category.
+  */
+  id: number;
+  /**
+  * The name of the receipt item category.
+  */
+  name: string;
+  /**
+  * The parent category of the receipt item category.
+  */
+  parent?: ReceiptItemCategory;
+}
+/**
+* The quantity unit type.
+*/
+type QuantityUnit = "piece" | "kilogram" | "gram" | "liter" | "milliliter" | "meter" | "point" | "set" | "roll" | "box" | "package";
+/**
+* The interface representing the request parameters for listing receipts.
+*/
+type ListReceiptsRequest = ListRequest<{
+  id: number;
+  status: ReceiptStatus;
+  code: string;
+  item_name: string;
+  start_date: string;
+  end_date: string;
+  store_id: number;
+}, "store" | "store.merchant" | "items" | "items.category" | "items.category.parent" | "messages", "id" | "code" | "status" | "date">;
+/**
+* The interface representing the request to create a receipt.
+*/
+interface CreateReceiptRequest {
+  /**
+  * The file representing the receipt image or document.
+  */
+  file: File;
+}
+/**
+* The interface representing the request parameters for exporting receipts.
+*/
+type ExportReceiptsRequest = FilterRequest<{
+  /**
+  * The unique identifier of the receipt (ULID).
+  */
+  receipt_id: string;
+  /**
+  * The receipt code.
+  */
+  receipt_code: string;
+  /**
+  * The name of the receipt item.
+  */
+  item_name: string;
+  /**
+  * The start date for filtering receipts (ISO 8601 format).
+  */
+  start_date: string;
+  /**
+  * The end date for filtering receipts (ISO 8601 format).
+  */
+  end_date: string;
+  /**
+  * The unique identifier of the store.
+  */
+  store_id: number;
+}>;
+//#endregion
+//#region src/api/receipts/resource.d.ts
+/**
+* The receipts resource.
+*/
+declare class ReceiptsResource extends Resource {
+  /**
+  * Get a paginated list of receipts.
+  *
+  * @param request The receipts request parameters.
+  * @returns The paginated list of receipts.
+  */
+  list(request?: ListReceiptsRequest): Promise<PaginatedResponse<Receipt>>;
+  /**
+  * Create a receipt.
+  *
+  * @param request The create receipt request.
+  * @returns The created receipt.
+  */
+  create(request: CreateReceiptRequest): Promise<Receipt>;
+  /**
+  * Get a receipt by ID.
+  *
+  * @param id The receipt ID.
+  * @returns The receipt.
+  */
+  get(id?: string): Promise<Receipt>;
+  /**
+  * Delete a receipt by ID.
+  *
+  * @param id The receipt ID.
+  */
+  delete(id: number): Promise<void>;
+  /**
+  * Export receipts.
+  *
+  * @param request The export receipts request.
+  * @returns The exported receipts.
+  */
+  export(request?: ExportReceiptsRequest): Promise<Blob>;
+}
+//#endregion
+//#region src/api/reports/types.d.ts
+/**
+* The interface representing a spending by category.
+*/
+interface SpendingByCategory {
+  /**
+  * The name of the category.
+  */
+  name: string;
+  /**
+  * The spending category children.
+  */
+  children: SpendingByCategory[];
+  /**
+  * The total spending for the category.
+  */
+  total: number;
+}
+/**
+* The type representing the request parameters for listing spending by categories.
+*/
+type SpendingByCategoriesRequest = FilterRequest<{
+  /**
+  * The start date for filtering spendings (ISO 8601 format).
+  */
+  start_date: string;
+  /**
+  * The end date for filtering spendings (ISO 8601 format).
+  */
+  end_date: string;
+}>;
+//#endregion
+//#region src/api/reports/resource.d.ts
+/**
+* The reports resource.
+*/
+declare class ReportsResource extends Resource {
+  /**
+  * Get spending by categories report.
+  *
+  * @param request The spending by categories request parameters.
+  * @returns The list of spending by category objects.
+  */
+  spendingByCategories(request?: SpendingByCategoriesRequest): Promise<SpendingByCategory[]>;
+}
+//#endregion
+//#region src/api/api.d.ts
+/**
+* The Bontabil API.
+*/
+declare class BontabilApi {
+  /**
+  * The API client.
+  */
+  protected readonly client: Client;
+  /**
+  * The profile resource.
+  */
+  readonly profile: ProfileResource;
+  /**
+  * The personal access tokens resource.
+  */
+  readonly personalAccessTokens: PersonalAccessTokensResource;
+  /**
+  * The counties resource.
+  */
+  readonly counties: CountiesResource;
+  /**
+  * The cities resource.
+  */
+  readonly cities: CitiesResource;
+  /**
+  * The stores resource.
+  */
+  readonly stores: StoresResource;
+  /**
+  * The merchants resource.
+  */
+  readonly merchants: MerchantsResource;
+  /**
+  * The chatbot resource.
+  */
+  readonly chatbot: ChatbotResource;
+  /**
+  * The receipts resource.
+  */
+  readonly receipts: ReceiptsResource;
+  /**
+  * The reports resource.
+  */
+  readonly reports: ReportsResource;
+  /**
+  * The Bontabil API constructor.
+  *
+  * @param client The API client or client options.
+  */
+  constructor(client: ClientOrClientOptions);
+}
+//#endregion
+//#region src/api/constants.d.ts
+declare const DEFAULT_REQUEST_HEADERS: NonNullable<RequestInit["headers"]>;
+declare const DEFAULT_REQUEST_OPTIONS: RequestInit;
+//#endregion
+export { BontabilApi, ChatbotRequest, ChatbotResource, ChatbotResponse, CitiesResource, City, Client, ClientOptions, ClientOrClientOptions, CountiesResource, County, CreateReceiptRequest, DEFAULT_ENDPOINT, DEFAULT_OPTIONS, DEFAULT_REQUEST_HEADERS, DEFAULT_REQUEST_OPTIONS, ExportReceiptsRequest, FilterObject, FilterOptions, FilterRequest, HistoryMessage, IncludeOptions, IncludeRequest, ListCitiesRequest, ListCountiesRequest, ListMerchantsRequest, ListReceiptsRequest, ListRequest, ListStoresRequest, LlmRole, Merchant, MerchantsResource, PaginatedResponse, PaginationLinks, PaginationMeta, PaginationMetaLink, PaginationOptions, PaginationRequest, PersonalAccessToken, PersonalAccessTokenRequest, PersonalAccessTokensResource, Profile, ProfileResource, QuantityUnit, Receipt, ReceiptDetails, ReceiptItem, ReceiptItemCategory, ReceiptMessage, ReceiptMessageType, ReceiptStatus, ReceiptsResource, Resource, SortOptions, SortRequest, Store, StoresResource };