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

TypeScript SDK for Simply Homes SoS API v4

import type { Configuration } from '../generated';
import { MessageSubscriptionsAPIV4Api } from '../generated';
import type { V4MessageSubscriptionsControllerDeleteMessageSubscriptionV4Request, V4MessageSubscriptionsControllerGetMessageSubscriptionV4Request, V4MessageSubscriptionsControllerGetMessageSubscriptionsFilteredByV4Request, V4MessageSubscriptionsControllerGetMessageSubscriptionsInViewV4Request, V4MessageSubscriptionsControllerGetMessageSubscriptionsV4Request, V4MessageSubscriptionsControllerGetUniqueValuesV4Request, V4MessageSubscriptionsControllerUpdateMessageSubscriptionV4Request, V4MessageSubscriptionsCreateMessageSubscriptionBodyDto, V4MessageSubscriptionsCreateMessageSubscriptionResponseDto, V4MessageSubscriptionsDeleteMessageSubscriptionResponseDto, V4MessageSubscriptionsGetMessageSubscriptionResponseDto, V4MessageSubscriptionsGetMessageSubscriptionsFilteredByResponseDto, V4MessageSubscriptionsGetMessageSubscriptionsInViewResponseDto, V4MessageSubscriptionsGetMessageSubscriptionsResponseDto, V4MessageSubscriptionsGetUniqueValuesResponseDto, V4MessageSubscriptionsUpdateMessageSubscriptionBodyDto, V4MessageSubscriptionsUpdateMessageSubscriptionResponseDto } from '../generated';
export declare class MessageSubscriptions {
    readonly list: MessageSubscriptionsList;
    readonly create: MessageSubscriptionsCreate;
    readonly update: MessageSubscriptionsUpdate;
    readonly delete: MessageSubscriptionsDelete;
    constructor(config: Configuration);
}
export declare class MessageSubscriptionsList {
    private api;
    constructor(api: MessageSubscriptionsAPIV4Api);
    /**
     * all - get /v4/message-subscriptions
     */
    all(options?: V4MessageSubscriptionsControllerGetMessageSubscriptionsV4Request): Promise<V4MessageSubscriptionsGetMessageSubscriptionsResponseDto>;
    /**
     * one - get /v4/message-subscriptions/subscription/{propertyId}/{entityType}/{entityId}
     */
    one(propertyId: V4MessageSubscriptionsControllerGetMessageSubscriptionV4Request['propertyId'], entityType: V4MessageSubscriptionsControllerGetMessageSubscriptionV4Request['entityType'], entityId: V4MessageSubscriptionsControllerGetMessageSubscriptionV4Request['entityId'], options?: Omit<V4MessageSubscriptionsControllerGetMessageSubscriptionV4Request, 'propertyId' | 'entityType' | 'entityId'>): Promise<V4MessageSubscriptionsGetMessageSubscriptionResponseDto>;
    /**
     * withView - get /v4/message-subscriptions/viewId/{viewId}
     */
    withView(viewId: V4MessageSubscriptionsControllerGetMessageSubscriptionsInViewV4Request['viewId'], options?: Omit<V4MessageSubscriptionsControllerGetMessageSubscriptionsInViewV4Request, 'viewId'>): Promise<V4MessageSubscriptionsGetMessageSubscriptionsInViewResponseDto>;
    /**
     * withFilters - get /v4/message-subscriptions/filteredBy/{column}/{value}
     */
    withFilters(column: V4MessageSubscriptionsControllerGetMessageSubscriptionsFilteredByV4Request['column'], value: V4MessageSubscriptionsControllerGetMessageSubscriptionsFilteredByV4Request['value'], options?: Omit<V4MessageSubscriptionsControllerGetMessageSubscriptionsFilteredByV4Request, 'column' | 'value'>): Promise<V4MessageSubscriptionsGetMessageSubscriptionsFilteredByResponseDto>;
    /**
     * uniqueValues - get /v4/message-subscriptions/unique/{column}
     */
    uniqueValues(column: V4MessageSubscriptionsControllerGetUniqueValuesV4Request['column'], options?: Omit<V4MessageSubscriptionsControllerGetUniqueValuesV4Request, 'column'>): Promise<V4MessageSubscriptionsGetUniqueValuesResponseDto>;
}
export declare class MessageSubscriptionsCreate {
    private api;
    constructor(api: MessageSubscriptionsAPIV4Api);
    /**
     * one - post /v4/message-subscriptions
     */
    one(body: V4MessageSubscriptionsCreateMessageSubscriptionBodyDto): Promise<V4MessageSubscriptionsCreateMessageSubscriptionResponseDto>;
}
export declare class MessageSubscriptionsUpdate {
    private api;
    constructor(api: MessageSubscriptionsAPIV4Api);
    /**
     * one - patch /v4/message-subscriptions/subscription/{propertyId}/{entityType}/{entityId}
     */
    one(propertyId: V4MessageSubscriptionsControllerUpdateMessageSubscriptionV4Request['propertyId'], entityType: V4MessageSubscriptionsControllerUpdateMessageSubscriptionV4Request['entityType'], entityId: V4MessageSubscriptionsControllerUpdateMessageSubscriptionV4Request['entityId'], body: V4MessageSubscriptionsUpdateMessageSubscriptionBodyDto['messageSubscription']): Promise<V4MessageSubscriptionsUpdateMessageSubscriptionResponseDto>;
}
export declare class MessageSubscriptionsDelete {
    private api;
    constructor(api: MessageSubscriptionsAPIV4Api);
    /**
     * one - delete /v4/message-subscriptions/subscription/{propertyId}/{entityType}/{entityId}
     */
    one(propertyId: V4MessageSubscriptionsControllerDeleteMessageSubscriptionV4Request['propertyId'], entityType: V4MessageSubscriptionsControllerDeleteMessageSubscriptionV4Request['entityType'], entityId: V4MessageSubscriptionsControllerDeleteMessageSubscriptionV4Request['entityId'], options?: Omit<V4MessageSubscriptionsControllerDeleteMessageSubscriptionV4Request, 'propertyId' | 'entityType' | 'entityId'>): Promise<V4MessageSubscriptionsDeleteMessageSubscriptionResponseDto>;
}
//# sourceMappingURL=messageSubscriptions.d.ts.map