@kohost/api-client 7.25.1 → 7.27.0

package/dist/schemas/order.d.ts

@@ -1,186 +0,0 @@
-import defs from "./definitions.js";
-import type { FromSchema } from "json-schema-to-ts";
-export declare const orderSchema: {
-    readonly $schema: "http://json-schema.org/draft-07/schema";
-    readonly $id: "order.json";
-    readonly title: "Order";
-    readonly description: "A purchase order for products or services.";
-    readonly type: "object";
-    readonly required: readonly ["type", "status"];
-    readonly additionalProperties: false;
-    readonly properties: {
-        readonly id: {
-            readonly $ref: "definitions.json#/definitions/id";
-        };
-        readonly propertyId: {
-            readonly type: "string";
-            readonly description: "ID of the property this entity belongs to. Optional — used as a per-document filter inside the org-scoped database.";
-        };
-        readonly type: {
-            readonly type: "string";
-            readonly default: "order";
-            readonly enum: readonly ["order"];
-        };
-        readonly orderNumber: {
-            readonly type: "string";
-        };
-        readonly status: {
-            readonly type: "string";
-            readonly enum: readonly ["draft", "pendingPayment", "processing", "outForDelivery", "completed", "paymentFailed", "cancelled", "refunded"];
-        };
-        readonly userId: {
-            readonly $ref: "definitions.json#/definitions/id";
-            readonly description: "User id of purchaser";
-        };
-        readonly reservationId: {
-            readonly $ref: "definitions.json#/definitions/id";
-            readonly description: "Reservation id if the order is for a reservation";
-        };
-        readonly date: {
-            readonly $ref: "definitions.json#/definitions/date";
-        };
-        readonly items: {
-            readonly type: "array";
-            readonly default: readonly [];
-            readonly items: {
-                readonly type: "object";
-                readonly required: readonly ["name", "price"];
-                readonly properties: {
-                    readonly additionalProperties: false;
-                    readonly name: {
-                        readonly type: "string";
-                    };
-                    readonly sku: {
-                        readonly type: "string";
-                    };
-                    readonly quantity: {
-                        readonly type: "number";
-                        readonly default: 1;
-                    };
-                    readonly price: {
-                        readonly type: "number";
-                    };
-                    readonly taxClass: {
-                        readonly type: "string";
-                    };
-                    readonly deliveryClass: {
-                        readonly type: "string";
-                    };
-                    readonly productId: {
-                        readonly type: "string";
-                    };
-                };
-            };
-        };
-        readonly taxes: {
-            readonly type: "array";
-            readonly default: readonly [];
-            readonly items: {
-                readonly type: "object";
-                readonly required: readonly ["name", "rate"];
-                readonly properties: {
-                    readonly additionalProperties: false;
-                    readonly name: {
-                        readonly type: "string";
-                    };
-                    readonly class: {
-                        readonly type: "string";
-                    };
-                    readonly rateType: {
-                        readonly type: "string";
-                        readonly enum: readonly ["percentage", "flat"];
-                        readonly default: "percentage";
-                    };
-                    readonly rate: {
-                        readonly type: "number";
-                    };
-                    readonly total: {
-                        readonly type: "number";
-                    };
-                };
-            };
-        };
-        readonly fees: {
-            readonly type: "array";
-            readonly default: readonly [];
-            readonly items: {
-                readonly type: "object";
-                readonly required: readonly ["name", "price"];
-                readonly properties: {
-                    readonly additionalProperties: false;
-                    readonly name: {
-                        readonly type: "string";
-                    };
-                    readonly price: {
-                        readonly type: "number";
-                    };
-                };
-            };
-        };
-        readonly delivery: {
-            readonly type: "array";
-            readonly default: readonly [];
-            readonly items: {
-                readonly type: "object";
-                readonly required: readonly ["name", "rate"];
-                readonly properties: {
-                    readonly additionalProperties: false;
-                    readonly name: {
-                        readonly type: "string";
-                    };
-                    readonly class: {
-                        readonly type: "string";
-                    };
-                    readonly rateType: {
-                        readonly type: "string";
-                        readonly enum: readonly ["percentage", "flat"];
-                        readonly default: "percentage";
-                    };
-                    readonly rate: {
-                        readonly type: "number";
-                    };
-                    readonly total: {
-                        readonly type: "number";
-                    };
-                };
-            };
-        };
-        readonly payments: {
-            readonly type: "array";
-            readonly default: readonly [];
-            readonly items: {
-                readonly type: "object";
-                readonly properties: {
-                    readonly method: {
-                        readonly type: "string";
-                        readonly enum: readonly ["folio", "invoice", "amex", "visa", "masterCard", "maestro", "discover", "diners", "jcb", "applePay", "alipay", "chinaUnionPay", "vpay"];
-                    };
-                    readonly name: {
-                        readonly type: "string";
-                    };
-                    readonly date: {
-                        readonly $ref: "definitions.json#/definitions/date";
-                    };
-                    readonly amount: {
-                        readonly type: "number";
-                    };
-                    readonly transactionReference: {
-                        readonly type: "string";
-                    };
-                };
-            };
-        };
-        readonly createdAt: {
-            readonly $ref: "definitions.json#/definitions/date";
-        };
-        readonly updatedAt: {
-            readonly $ref: "definitions.json#/definitions/date";
-        };
-        readonly deletedAt: {
-            readonly $ref: "definitions.json#/definitions/date";
-        };
-    };
-};
-export type OrderSchema = FromSchema<typeof orderSchema, {
-    references: [typeof defs];
-}>;

package/dist/schemas/vendorProfile.d.ts

@@ -1,188 +0,0 @@
-import defs, { ISODateString } from "./definitions.js";
-import type { FromSchema } from "json-schema-to-ts";
-import { mediaFileSchema } from "./mediaFile.js";
-/**
- * One Organization's relationship with a contractor. Either linked to a
- * catalog Vendor (`vendorId` set — the business's identity is read from the
- * catalog and never stored here) or custom (`vendorId` null — the Organization
- * typed the contractor in and holds the identity itself). Which fields are
- * required on which path is the use case's rule, not the schema's: the schema
- * requires only `id`.
- */
-export declare const vendorProfileSchema: {
-    readonly $schema: "http://json-schema.org/draft-07/schema";
-    readonly $id: "vendorProfile.json";
-    readonly title: "VendorProfile";
-    readonly type: "object";
-    readonly required: readonly ["id"];
-    readonly additionalProperties: false;
-    readonly properties: {
-        readonly id: {
-            readonly $ref: "definitions.json#/definitions/id";
-        };
-        readonly type: {
-            readonly type: "string";
-            readonly default: "vendorProfile";
-            readonly enum: readonly ["vendorProfile"];
-        };
-        readonly vendorId: {
-            readonly type: readonly ["string", "null"];
-            readonly description: "The catalog Vendor this profile is linked to. Null means custom: the Organization holds the identity fields itself.";
-        };
-        readonly name: {
-            readonly type: readonly ["string", "null"];
-        };
-        readonly address: {
-            readonly anyOf: readonly [{
-                readonly $ref: "definitions.json#/definitions/address";
-            }, {
-                readonly type: "null";
-            }];
-        };
-        readonly latitude: {
-            readonly type: readonly ["number", "null"];
-        };
-        readonly longitude: {
-            readonly type: readonly ["number", "null"];
-        };
-        readonly placeId: {
-            readonly type: readonly ["string", "null"];
-            readonly description: "Google Places id the address was prefilled from.";
-        };
-        readonly photo: {
-            readonly anyOf: readonly [{
-                readonly $ref: "mediaFile.json#";
-            }, {
-                readonly type: "null";
-            }];
-        };
-        readonly email: {
-            readonly type: readonly ["string", "null"];
-            readonly format: "email";
-        };
-        readonly phone: {
-            readonly type: readonly ["string", "null"];
-            readonly pattern: "^\\+[0-9]{1,14}$";
-        };
-        readonly notes: {
-            readonly type: readonly ["string", "null"];
-            readonly maxLength: 1000;
-        };
-        readonly properties: {
-            readonly type: "array";
-            readonly description: "List of propertyIds where this vendor is enabled. Profiles are org-scoped; an empty list means every property.";
-            readonly default: readonly [];
-            readonly items: {
-                readonly type: "string";
-            };
-        };
-        readonly vendor: {
-            readonly type: readonly ["object", "null"];
-            readonly readOnly: true;
-            readonly description: "The linked catalog Vendor's listing state, filled in on every read and never stored. Null on a custom profile.";
-            readonly additionalProperties: false;
-            readonly required: readonly ["id", "kohostVerified", "status"];
-            readonly properties: {
-                readonly id: {
-                    readonly type: "string";
-                };
-                readonly kohostVerified: {
-                    readonly type: "boolean";
-                };
-                readonly status: {
-                    readonly type: "string";
-                    readonly enum: readonly ["unlisted", "listed"];
-                };
-            };
-        };
-        readonly private: {
-            readonly type: "object";
-            readonly description: "Private Details: the Organization's own account and compliance record for this contractor. Visible only to that Organization.";
-            readonly additionalProperties: false;
-            readonly properties: {
-                readonly accountNumber: {
-                    readonly type: readonly ["string", "null"];
-                    readonly maxLength: 100;
-                };
-                readonly paymentTerms: {
-                    readonly type: readonly ["string", "null"];
-                    readonly maxLength: 200;
-                };
-                readonly insuranceCarrier: {
-                    readonly type: readonly ["string", "null"];
-                    readonly maxLength: 200;
-                };
-                readonly policyNumber: {
-                    readonly type: readonly ["string", "null"];
-                    readonly maxLength: 100;
-                };
-                readonly coverageExpiresOn: {
-                    readonly anyOf: readonly [{
-                        readonly $ref: "definitions.json#/definitions/date";
-                    }, {
-                        readonly type: "null";
-                    }];
-                    readonly description: "When this campus's coverage for the vendor lapses. Null once an operator clears it.";
-                };
-                readonly documents: {
-                    readonly type: "array";
-                    readonly default: readonly [];
-                    readonly items: {
-                        readonly type: "object";
-                        readonly additionalProperties: false;
-                        readonly required: readonly ["id", "url", "label", "mimeType", "size", "uploadedAt"];
-                        readonly properties: {
-                            readonly id: {
-                                readonly type: "string";
-                            };
-                            readonly url: {
-                                readonly type: "string";
-                                readonly format: "uri";
-                            };
-                            readonly label: {
-                                readonly type: "string";
-                                readonly maxLength: 200;
-                            };
-                            readonly expiresAt: {
-                                readonly $ref: "definitions.json#/definitions/date";
-                            };
-                            readonly mimeType: {
-                                readonly type: "string";
-                            };
-                            readonly size: {
-                                readonly type: "integer";
-                                readonly minimum: 0;
-                            };
-                            readonly uploadedAt: {
-                                readonly $ref: "definitions.json#/definitions/date";
-                            };
-                            readonly uploadedBy: {
-                                readonly type: readonly ["string", "null"];
-                            };
-                        };
-                    };
-                };
-            };
-        };
-        readonly createdAt: {
-            readonly $ref: "definitions.json#/definitions/date";
-        };
-        readonly updatedAt: {
-            readonly $ref: "definitions.json#/definitions/date";
-        };
-        readonly deletedAt: {
-            readonly $ref: "definitions.json#/definitions/date";
-        };
-    };
-};
-export type VendorProfileSchema = FromSchema<typeof vendorProfileSchema, {
-    references: [typeof defs, typeof mediaFileSchema];
-    deserialize: [
-        {
-            pattern: {
-                format: "date-time";
-            };
-            output: Date | ISODateString;
-        }
-    ];
-}>;

package/dist/useCases/addVendorDocument.d.ts

@@ -1,36 +0,0 @@
-export interface AddVendorDocumentCommandConfig {
-    data?: {
-        id: string;
-        [key: string]: unknown;
-    } | null;
-    headers?: Record<string, string> | null;
-    query?: Record<string, unknown> | null;
-}
-export interface AddVendorDocumentCommandRequestConfig {
-    method: "post";
-    url: string;
-    data: {
-        id: string;
-        [key: string]: unknown;
-    } | null;
-    params: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    [key: string]: unknown;
-}
-/**
- *
- */
-export declare class AddVendorDocumentCommand {
-    url: string;
-    data: {
-        id: string;
-        [key: string]: unknown;
-    } | null;
-    query: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    config: AddVendorDocumentCommandRequestConfig;
-    static params: readonly ["id"];
-    static url: string;
-    static method: "post";
-    constructor(commandConfig: AddVendorDocumentCommandConfig, options?: Record<string, unknown>);
-}

package/dist/useCases/addVendorProfileDocument.d.ts

@@ -1,36 +0,0 @@
-export interface AddVendorProfileDocumentCommandConfig {
-    data?: {
-        id: string;
-        [key: string]: unknown;
-    } | null;
-    headers?: Record<string, string> | null;
-    query?: Record<string, unknown> | null;
-}
-export interface AddVendorProfileDocumentCommandRequestConfig {
-    method: "post";
-    url: string;
-    data: {
-        id: string;
-        [key: string]: unknown;
-    } | null;
-    params: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    [key: string]: unknown;
-}
-/**
- *
- */
-export declare class AddVendorProfileDocumentCommand {
-    url: string;
-    data: {
-        id: string;
-        [key: string]: unknown;
-    } | null;
-    query: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    config: AddVendorProfileDocumentCommandRequestConfig;
-    static params: readonly ["id"];
-    static url: string;
-    static method: "post";
-    constructor(commandConfig: AddVendorProfileDocumentCommandConfig, options?: Record<string, unknown>);
-}

package/dist/useCases/createImageUploadEndpoint.d.ts

@@ -1,27 +0,0 @@
-export interface CreateImageUploadEndpointCommandConfig {
-    data?: Record<string, unknown> | null;
-    headers?: Record<string, string> | null;
-    query?: Record<string, unknown> | null;
-}
-export interface CreateImageUploadEndpointCommandRequestConfig {
-    method: "post";
-    url: string;
-    data: Record<string, unknown> | null;
-    params: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    [key: string]: unknown;
-}
-/**
- *
- */
-export declare class CreateImageUploadEndpointCommand {
-    url: string;
-    data: Record<string, unknown> | null;
-    query: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    config: CreateImageUploadEndpointCommandRequestConfig;
-    static params: readonly [];
-    static url: string;
-    static method: "post";
-    constructor(commandConfig: CreateImageUploadEndpointCommandConfig, options?: Record<string, unknown>);
-}

package/dist/useCases/createVendorProfile.d.ts

@@ -1,27 +0,0 @@
-export interface CreateVendorProfileCommandConfig {
-    data?: Record<string, unknown> | unknown[] | null;
-    headers?: Record<string, string> | null;
-    query?: Record<string, unknown> | null;
-}
-export interface CreateVendorProfileCommandRequestConfig {
-    method: "post";
-    url: string;
-    data: Record<string, unknown> | unknown[] | null;
-    params: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    [key: string]: unknown;
-}
-/**
- *
- */
-export declare class CreateVendorProfileCommand {
-    url: string;
-    data: Record<string, unknown> | unknown[] | null;
-    query: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    config: CreateVendorProfileCommandRequestConfig;
-    static params: readonly [];
-    static url: string;
-    static method: "post";
-    constructor(commandConfig: CreateVendorProfileCommandConfig, options?: Record<string, unknown>);
-}

package/dist/useCases/deleteVendorProfile.d.ts

@@ -1,36 +0,0 @@
-export interface DeleteVendorProfileCommandConfig {
-    data?: {
-        id: string;
-        [key: string]: unknown;
-    } | null;
-    headers?: Record<string, string> | null;
-    query?: Record<string, unknown> | null;
-}
-export interface DeleteVendorProfileCommandRequestConfig {
-    method: "delete";
-    url: string;
-    data: {
-        id: string;
-        [key: string]: unknown;
-    } | null;
-    params: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    [key: string]: unknown;
-}
-/**
- *
- */
-export declare class DeleteVendorProfileCommand {
-    url: string;
-    data: {
-        id: string;
-        [key: string]: unknown;
-    } | null;
-    query: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    config: DeleteVendorProfileCommandRequestConfig;
-    static params: readonly ["id"];
-    static url: string;
-    static method: "delete";
-    constructor(commandConfig: DeleteVendorProfileCommandConfig, options?: Record<string, unknown>);
-}

package/dist/useCases/describeConciergeBillsSummary.d.ts

@@ -1,27 +0,0 @@
-export interface DescribeConciergeBillsSummaryCommandConfig {
-    data?: Record<string, unknown> | unknown[] | null;
-    headers?: Record<string, string> | null;
-    query?: Record<string, unknown> | null;
-}
-export interface DescribeConciergeBillsSummaryCommandRequestConfig {
-    method: "get";
-    url: string;
-    data: Record<string, unknown> | unknown[] | null;
-    params: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    [key: string]: unknown;
-}
-/**
- * Revenue, vendor cost, profit and margin billed through OneBill over a sentAt window, across the KFC-enabled organizations or one of them.
- */
-export declare class DescribeConciergeBillsSummaryCommand {
-    url: string;
-    data: Record<string, unknown> | unknown[] | null;
-    query: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    config: DescribeConciergeBillsSummaryCommandRequestConfig;
-    static params: readonly [];
-    static url: string;
-    static method: "get";
-    constructor(commandConfig: DescribeConciergeBillsSummaryCommandConfig, options?: Record<string, unknown>);
-}

package/dist/useCases/describeVendorProfile.d.ts

@@ -1,36 +0,0 @@
-export interface DescribeVendorProfileCommandConfig {
-    data?: {
-        id: string;
-        [key: string]: unknown;
-    } | null;
-    headers?: Record<string, string> | null;
-    query?: Record<string, unknown> | null;
-}
-export interface DescribeVendorProfileCommandRequestConfig {
-    method: "get";
-    url: string;
-    data: {
-        id: string;
-        [key: string]: unknown;
-    } | null;
-    params: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    [key: string]: unknown;
-}
-/**
- *
- */
-export declare class DescribeVendorProfileCommand {
-    url: string;
-    data: {
-        id: string;
-        [key: string]: unknown;
-    } | null;
-    query: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    config: DescribeVendorProfileCommandRequestConfig;
-    static params: readonly ["id"];
-    static url: string;
-    static method: "get";
-    constructor(commandConfig: DescribeVendorProfileCommandConfig, options?: Record<string, unknown>);
-}

package/dist/useCases/listConciergeWorkspaceBillLines.d.ts

@@ -1,27 +0,0 @@
-export interface ListConciergeWorkspaceBillLinesCommandConfig {
-    data?: Record<string, unknown> | unknown[] | null;
-    headers?: Record<string, string> | null;
-    query?: Record<string, unknown> | null;
-}
-export interface ListConciergeWorkspaceBillLinesCommandRequestConfig {
-    method: "get";
-    url: string;
-    data: Record<string, unknown> | unknown[] | null;
-    params: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    [key: string]: unknown;
-}
-/**
- * OneBill transactions view: every line on a sent or paid bill across every KFC-enabled organization, newest send first, paged and searchable, with the vendor-cost snapshot and resolved organization and vendor names.
- */
-export declare class ListConciergeWorkspaceBillLinesCommand {
-    url: string;
-    data: Record<string, unknown> | unknown[] | null;
-    query: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    config: ListConciergeWorkspaceBillLinesCommandRequestConfig;
-    static params: readonly [];
-    static url: string;
-    static method: "get";
-    constructor(commandConfig: ListConciergeWorkspaceBillLinesCommandConfig, options?: Record<string, unknown>);
-}

package/dist/useCases/listVendorDirectory.d.ts

@@ -1,27 +0,0 @@
-export interface ListVendorDirectoryCommandConfig {
-    data?: Record<string, unknown> | unknown[] | null;
-    headers?: Record<string, string> | null;
-    query?: Record<string, unknown> | null;
-}
-export interface ListVendorDirectoryCommandRequestConfig {
-    method: "get";
-    url: string;
-    data: Record<string, unknown> | unknown[] | null;
-    params: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    [key: string]: unknown;
-}
-/**
- * The org-facing Vendor directory: listed catalog Vendors with Private Details stripped, filtered by name.
- */
-export declare class ListVendorDirectoryCommand {
-    url: string;
-    data: Record<string, unknown> | unknown[] | null;
-    query: Record<string, unknown> | null;
-    headers: Record<string, string> | null;
-    config: ListVendorDirectoryCommandRequestConfig;
-    static params: readonly [];
-    static url: string;
-    static method: "get";
-    constructor(commandConfig: ListVendorDirectoryCommandConfig, options?: Record<string, unknown>);
-}