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

Javascript client for Sociate AI APIs

import { CreateCompanyRequest, DeleteCompanyRequest, GetCompanies, GetCompaniesResponse, GetUsersFromCompanyRequest, GetUsersFromCompanyResponse } from 'types/company';
import { HttpClient } from '../lib/core/http';
export declare class CompanyAPI {
    private httpClient;
    constructor(httpClient: HttpClient);
    /**
     * Get All Companies
     * @description Get a list of all the companies
     * @param params - The parameters for the request
     * @returns The response indicating the success of the operation
     */
    get(params: GetCompanies): Promise<GetCompaniesResponse>;
    /**
     * Create Company
     * @description Create a company
     * @param params - The parameters for the request
     * @returns The response indicating the success of the operation
     */
    create(params: CreateCompanyRequest): Promise<unknown>;
    /**
     * Delete Company
     * @description Delete a company
     * @param id - The company ID
     */
    delete(params: DeleteCompanyRequest): Promise<string>;
    /**
     * Get Users
     * @description Get a list of users from a company
     * @param params - The parameters for the request
     * @returns The list of users from the company
     */
    getUsers(params: GetUsersFromCompanyRequest): Promise<GetUsersFromCompanyResponse>;
}