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

TypeScript SDK for Simply Homes SoS API v4

import type { Configuration } from '../generated';
import { UsersAPIV4Api } from '../generated';
import type { V4UsersControllerDeleteUserV4Request, V4UsersControllerGetUserColumnsV4Request, V4UsersControllerGetUserV4Request, V4UsersControllerGetUsersInViewV4Request, V4UsersControllerGetUsersV4Request, V4UsersControllerUpdateUserV4Request, V4UsersCreateUserBodyDto, V4UsersCreateUserResponseDto, V4UsersDeleteUserResponseDto, V4UsersGetUserColumnsResponseDto, V4UsersGetUserResponseDto, V4UsersGetUsersInViewResponseDto, V4UsersGetUsersResponseDto, V4UsersUpdateUserBodyDto, V4UsersUpdateUserResponseDto } from '../generated';
export declare class Users {
    readonly list: UsersList;
    readonly create: UsersCreate;
    readonly update: UsersUpdate;
    readonly delete: UsersDelete;
    constructor(config: Configuration);
}
export declare class UsersList {
    private api;
    constructor(api: UsersAPIV4Api);
    /**
     * one - get /v4/users/{userId}
     */
    one(userId: V4UsersControllerGetUserV4Request['userId'], options?: Omit<V4UsersControllerGetUserV4Request, 'userId'>): Promise<V4UsersGetUserResponseDto>;
    /**
     * oneWithColumns - get /v4/users/{userId}/{columns}
     */
    oneWithColumns(userId: V4UsersControllerGetUserColumnsV4Request['userId'], columns: V4UsersControllerGetUserColumnsV4Request['columns'], options?: Omit<V4UsersControllerGetUserColumnsV4Request, 'userId' | 'columns'>): Promise<V4UsersGetUserColumnsResponseDto>;
    /**
     * all - get /v4/users
     */
    all(options?: V4UsersControllerGetUsersV4Request): Promise<V4UsersGetUsersResponseDto>;
    /**
     * withView - get /v4/users/viewId/{viewId}
     */
    withView(viewId: V4UsersControllerGetUsersInViewV4Request['viewId'], options?: Omit<V4UsersControllerGetUsersInViewV4Request, 'viewId'>): Promise<V4UsersGetUsersInViewResponseDto>;
}
export declare class UsersCreate {
    private api;
    constructor(api: UsersAPIV4Api);
    /**
     * one - post /v4/users
     */
    one(body: V4UsersCreateUserBodyDto): Promise<V4UsersCreateUserResponseDto>;
}
export declare class UsersUpdate {
    private api;
    constructor(api: UsersAPIV4Api);
    /**
     * one - patch /v4/users/{userId}
     */
    one(userId: V4UsersControllerUpdateUserV4Request['userId'], body: V4UsersUpdateUserBodyDto): Promise<V4UsersUpdateUserResponseDto>;
}
export declare class UsersDelete {
    private api;
    constructor(api: UsersAPIV4Api);
    /**
     * one - delete /v4/users/{userId}
     */
    one(userId: V4UsersControllerDeleteUserV4Request['userId'], options?: Omit<V4UsersControllerDeleteUserV4Request, 'userId'>): Promise<V4UsersDeleteUserResponseDto>;
}
//# sourceMappingURL=users.d.ts.map