@sociate/sociate-api-sdk/dist/types/company.d.ts

Javascript client for Sociate AI APIs

import { UserDocument, UserVectorConfigModel } from "./users";
export interface CompanyDocument {
    /**
     * Id
     * @description ID from company
     */
    _id: string | null;
    /**
     * Name
     * @description Name from company
     */
    name: string;
    /**
     * @description User type
     * @default default
     */
    model?: string;
    /**
     * Domain
     * @description Domain from company
     */
    domain: string;
    /**
     * Apps
     * @description Apps from company
     */
    apps: string[];
    /**
     * Status
     * @description Status from company
     * @default true
     */
    status: boolean;
}
export interface CompanyPublic extends CompanyDocument {
    /**
     * App Secret
     * @description App secret from company
     */
    app_secret?: string | null;
    /**
     * Vector Config
     * @description Vector config from company
     */
    vector_config?: UserVectorConfigModel | null;
}
export interface GetCompanies {
    /**
     * Page
     * @description Page number
     */
    page?: number;
    /**
     * Size
     * @description Limit number of items per page
     */
    size?: number;
}
export interface GetCompaniesResponse {
    /**
     * items
     * @description List of items
     */
    items: CompanyDocument[];
    /**
     * Total
     * @description Total number of items
     */
    total: number;
    /**
     * Page
     * @description Page number
     */
    page: number;
    /**
     * Size
     * @description Limit number of items per page
     */
    size: number;
    /**
     * Total Pages
     * @description Total number of pages
     */
    pages?: number;
}
export interface CreateCompanyRequest {
    /**
     * Name
     * @description Name from company
     */
    name: string;
    /**
     * Domain
     * @description Domain from company
     */
    domain: string;
}
export interface CreateCompanyResponse extends CompanyDocument {
}
export interface DeleteCompanyRequest {
    /**
     * Id
     * @description ID from company
     */
    id: string;
}
export interface GetUsersFromCompanyRequest {
    /**
     * Id
     * @description ID from company
     */
    id: string;
    /**
     * Page
     * @description Page number
     */
    page?: number;
    /**
     * Size
     * @description Limit number of items per page
     */
    size?: number;
}
export interface GetUsersFromCompanyResponse {
    /**
     * items
     * @description List of items
     */
    items: UserDocument[];
    /**
     * Total
     * @description Total number of items
     */
    total: number;
    /**
     * Page
     * @description Page number
     */
    page: number;
    /**
     * Size
     * @description Limit number of items per page
     */
    size: number;
    /**
     * Total Pages
     * @description Total number of pages
     */
    pages?: number;
}