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

TypeScript SDK for Simply Homes SoS API v4

import type { Configuration } from '../generated';
import { OrganizationsAPIV4Api } from '../generated';
import type { V4OrganizationsControllerDeleteOrganizationV4Request, V4OrganizationsControllerGetOrganizationColumnsV4Request, V4OrganizationsControllerGetOrganizationV4Request, V4OrganizationsControllerGetOrganizationsInViewV4Request, V4OrganizationsControllerGetOrganizationsV4Request, V4OrganizationsControllerUpdateOrganizationV4Request, V4OrganizationsCreateOrganizationBodyDto, V4OrganizationsCreateOrganizationResponseDto, V4OrganizationsDeleteOrganizationResponseDto, V4OrganizationsGetOrganizationColumnsResponseDto, V4OrganizationsGetOrganizationResponseDto, V4OrganizationsGetOrganizationsInViewResponseDto, V4OrganizationsGetOrganizationsResponseDto, V4OrganizationsUpdateOrganizationBodyDto, V4OrganizationsUpdateOrganizationResponseDto } from '../generated';
export declare class Organizations {
    readonly list: OrganizationsList;
    readonly create: OrganizationsCreate;
    readonly update: OrganizationsUpdate;
    readonly delete: OrganizationsDelete;
    constructor(config: Configuration);
}
export declare class OrganizationsList {
    private api;
    constructor(api: OrganizationsAPIV4Api);
    /**
     * one - get /v4/organizations/{organizationId}
     */
    one(organizationId: V4OrganizationsControllerGetOrganizationV4Request['organizationId'], options?: Omit<V4OrganizationsControllerGetOrganizationV4Request, 'organizationId'>): Promise<V4OrganizationsGetOrganizationResponseDto>;
    /**
     * oneWithColumns - get /v4/organizations/{organizationId}/{columns}
     */
    oneWithColumns(organizationId: V4OrganizationsControllerGetOrganizationColumnsV4Request['organizationId'], columns: V4OrganizationsControllerGetOrganizationColumnsV4Request['columns'], options?: Omit<V4OrganizationsControllerGetOrganizationColumnsV4Request, 'organizationId' | 'columns'>): Promise<V4OrganizationsGetOrganizationColumnsResponseDto>;
    /**
     * all - get /v4/organizations
     */
    all(options?: V4OrganizationsControllerGetOrganizationsV4Request): Promise<V4OrganizationsGetOrganizationsResponseDto>;
    /**
     * withView - get /v4/organizations/viewId/{viewId}
     */
    withView(viewId: V4OrganizationsControllerGetOrganizationsInViewV4Request['viewId'], options?: Omit<V4OrganizationsControllerGetOrganizationsInViewV4Request, 'viewId'>): Promise<V4OrganizationsGetOrganizationsInViewResponseDto>;
}
export declare class OrganizationsCreate {
    private api;
    constructor(api: OrganizationsAPIV4Api);
    /**
     * one - post /v4/organizations
     */
    one(body: V4OrganizationsCreateOrganizationBodyDto): Promise<V4OrganizationsCreateOrganizationResponseDto>;
}
export declare class OrganizationsUpdate {
    private api;
    constructor(api: OrganizationsAPIV4Api);
    /**
     * one - patch /v4/organizations/{organizationId}
     */
    one(organizationId: V4OrganizationsControllerUpdateOrganizationV4Request['organizationId'], body: V4OrganizationsUpdateOrganizationBodyDto): Promise<V4OrganizationsUpdateOrganizationResponseDto>;
}
export declare class OrganizationsDelete {
    private api;
    constructor(api: OrganizationsAPIV4Api);
    /**
     * one - delete /v4/organizations/{organizationId}
     */
    one(organizationId: V4OrganizationsControllerDeleteOrganizationV4Request['organizationId'], options?: Omit<V4OrganizationsControllerDeleteOrganizationV4Request, 'organizationId'>): Promise<V4OrganizationsDeleteOrganizationResponseDto>;
}
//# sourceMappingURL=organizations.d.ts.map