@simplyhomes/sos-sdk/dist/resources/contacts.d.ts

TypeScript SDK for Simply Homes SoS API v4

import type { Configuration } from '../generated';
import { ContactsAPIV4Api } from '../generated';
import type { V4ContactsControllerDeleteContactV4Request, V4ContactsControllerGetContactColumnsV4Request, V4ContactsControllerGetContactV4Request, V4ContactsControllerGetContactsFilteredByV4Request, V4ContactsControllerGetContactsInViewV4Request, V4ContactsControllerGetContactsV4Request, V4ContactsControllerUpdateContactV4Request, V4ContactsCreateContactBodyDto, V4ContactsCreateContactResponseDto, V4ContactsDeleteContactResponseDto, V4ContactsGetContactColumnsResponseDto, V4ContactsGetContactResponseDto, V4ContactsGetContactsFilteredByResponseDto, V4ContactsGetContactsInViewResponseDto, V4ContactsGetContactsResponseDto, V4ContactsUpdateContactBodyDto, V4ContactsUpdateContactResponseDto } from '../generated';
export declare class Contacts {
    readonly list: ContactsList;
    readonly create: ContactsCreate;
    readonly update: ContactsUpdate;
    readonly delete: ContactsDelete;
    constructor(config: Configuration);
}
export declare class ContactsList {
    private api;
    constructor(api: ContactsAPIV4Api);
    /**
     * one - get /v4/contacts/{contactId}
     */
    one(contactId: V4ContactsControllerGetContactV4Request['contactId'], options?: Omit<V4ContactsControllerGetContactV4Request, 'contactId'>): Promise<V4ContactsGetContactResponseDto>;
    /**
     * oneWithColumns - get /v4/contacts/{contactId}/{columns}
     */
    oneWithColumns(contactId: V4ContactsControllerGetContactColumnsV4Request['contactId'], columns: V4ContactsControllerGetContactColumnsV4Request['columns'], options?: Omit<V4ContactsControllerGetContactColumnsV4Request, 'contactId' | 'columns'>): Promise<V4ContactsGetContactColumnsResponseDto>;
    /**
     * all - get /v4/contacts
     */
    all(options?: V4ContactsControllerGetContactsV4Request): Promise<V4ContactsGetContactsResponseDto>;
    /**
     * withView - get /v4/contacts/viewId/{viewId}
     */
    withView(viewId: V4ContactsControllerGetContactsInViewV4Request['viewId'], options?: Omit<V4ContactsControllerGetContactsInViewV4Request, 'viewId'>): Promise<V4ContactsGetContactsInViewResponseDto>;
    /**
     * withFilters - get /v4/contacts/filteredBy/{column}/{value}
     */
    withFilters(column: V4ContactsControllerGetContactsFilteredByV4Request['column'], value: V4ContactsControllerGetContactsFilteredByV4Request['value'], options?: Omit<V4ContactsControllerGetContactsFilteredByV4Request, 'column' | 'value'>): Promise<V4ContactsGetContactsFilteredByResponseDto>;
}
export declare class ContactsCreate {
    private api;
    constructor(api: ContactsAPIV4Api);
    /**
     * one - post /v4/contacts
     */
    one(body: V4ContactsCreateContactBodyDto): Promise<V4ContactsCreateContactResponseDto>;
}
export declare class ContactsUpdate {
    private api;
    constructor(api: ContactsAPIV4Api);
    /**
     * one - patch /v4/contacts/{contactId}
     */
    one(contactId: V4ContactsControllerUpdateContactV4Request['contactId'], body: V4ContactsUpdateContactBodyDto['contact']): Promise<V4ContactsUpdateContactResponseDto>;
}
export declare class ContactsDelete {
    private api;
    constructor(api: ContactsAPIV4Api);
    /**
     * one - delete /v4/contacts/{contactId}
     */
    one(contactId: V4ContactsControllerDeleteContactV4Request['contactId'], options?: Omit<V4ContactsControllerDeleteContactV4Request, 'contactId'>): Promise<V4ContactsDeleteContactResponseDto>;
}
//# sourceMappingURL=contacts.d.ts.map