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

TypeScript SDK for Simply Homes SoS API v4

import type { Configuration } from '../generated';
import { MessagesAPIV4Api } from '../generated';
import type { V4MessagesControllerDeleteMessageV4Request, V4MessagesControllerGetMessageV4Request, V4MessagesControllerGetMessagesFilteredByV4Request, V4MessagesControllerGetMessagesInViewV4Request, V4MessagesControllerGetMessagesV4Request, V4MessagesControllerGetUniqueValuesV4Request, V4MessagesControllerUpdateMessageV4Request, V4MessagesCreateMessageBodyDto, V4MessagesCreateMessageResponseDto, V4MessagesDeleteMessageResponseDto, V4MessagesGetMessageResponseDto, V4MessagesGetMessagesFilteredByResponseDto, V4MessagesGetMessagesInViewResponseDto, V4MessagesGetMessagesResponseDto, V4MessagesGetUniqueValuesResponseDto, V4MessagesUpdateMessageBodyDto, V4MessagesUpdateMessageResponseDto } from '../generated';
export declare class Messages {
    readonly list: MessagesList;
    readonly create: MessagesCreate;
    readonly update: MessagesUpdate;
    readonly delete: MessagesDelete;
    constructor(config: Configuration);
}
export declare class MessagesList {
    private api;
    constructor(api: MessagesAPIV4Api);
    /**
     * all - get /v4/messages
     */
    all(options?: V4MessagesControllerGetMessagesV4Request): Promise<V4MessagesGetMessagesResponseDto>;
    /**
     * one - get /v4/messages/{messageId}
     */
    one(messageId: V4MessagesControllerGetMessageV4Request['messageId'], options?: Omit<V4MessagesControllerGetMessageV4Request, 'messageId'>): Promise<V4MessagesGetMessageResponseDto>;
    /**
     * withView - get /v4/messages/viewId/{viewId}
     */
    withView(viewId: V4MessagesControllerGetMessagesInViewV4Request['viewId'], options?: Omit<V4MessagesControllerGetMessagesInViewV4Request, 'viewId'>): Promise<V4MessagesGetMessagesInViewResponseDto>;
    /**
     * withFilters - get /v4/messages/filteredBy/{column}/{value}
     */
    withFilters(column: V4MessagesControllerGetMessagesFilteredByV4Request['column'], value: V4MessagesControllerGetMessagesFilteredByV4Request['value'], options?: Omit<V4MessagesControllerGetMessagesFilteredByV4Request, 'column' | 'value'>): Promise<V4MessagesGetMessagesFilteredByResponseDto>;
    /**
     * uniqueValues - get /v4/messages/unique/{column}
     */
    uniqueValues(column: V4MessagesControllerGetUniqueValuesV4Request['column'], options?: Omit<V4MessagesControllerGetUniqueValuesV4Request, 'column'>): Promise<V4MessagesGetUniqueValuesResponseDto>;
}
export declare class MessagesCreate {
    private api;
    constructor(api: MessagesAPIV4Api);
    /**
     * one - post /v4/messages
     */
    one(body: V4MessagesCreateMessageBodyDto): Promise<V4MessagesCreateMessageResponseDto>;
}
export declare class MessagesUpdate {
    private api;
    constructor(api: MessagesAPIV4Api);
    /**
     * one - patch /v4/messages/{messageId}
     */
    one(messageId: V4MessagesControllerUpdateMessageV4Request['messageId'], body: V4MessagesUpdateMessageBodyDto['message']): Promise<V4MessagesUpdateMessageResponseDto>;
}
export declare class MessagesDelete {
    private api;
    constructor(api: MessagesAPIV4Api);
    /**
     * one - delete /v4/messages/{messageId}
     */
    one(messageId: V4MessagesControllerDeleteMessageV4Request['messageId'], options?: Omit<V4MessagesControllerDeleteMessageV4Request, 'messageId'>): Promise<V4MessagesDeleteMessageResponseDto>;
}
//# sourceMappingURL=messages.d.ts.map