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

TypeScript SDK for Simply Homes SoS API v4

import type { Configuration } from '../generated';
import { TransactionsAPIV4Api } from '../generated';
import type { V4TransactionsControllerDeleteTransactionV4Request, V4TransactionsControllerGetTransactionColumnsV4Request, V4TransactionsControllerGetTransactionV4Request, V4TransactionsControllerGetTransactionsFilteredByV4Request, V4TransactionsControllerGetTransactionsInViewV4Request, V4TransactionsControllerGetTransactionsV4Request, V4TransactionsControllerGetUniqueValuesV4Request, V4TransactionsControllerUpdateTransactionV4Request, V4TransactionsCreateTransactionBodyDto, V4TransactionsCreateTransactionResponseDto, V4TransactionsDeleteTransactionResponseDto, V4TransactionsGetTransactionColumnsResponseDto, V4TransactionsGetTransactionResponseDto, V4TransactionsGetTransactionsFilteredByResponseDto, V4TransactionsGetTransactionsInViewResponseDto, V4TransactionsGetTransactionsResponseDto, V4TransactionsGetUniqueValuesResponseDto, V4TransactionsUpdateTransactionBodyDto, V4TransactionsUpdateTransactionResponseDto } from '../generated';
export declare class Transactions {
    readonly list: TransactionsList;
    readonly create: TransactionsCreate;
    readonly update: TransactionsUpdate;
    readonly delete: TransactionsDelete;
    constructor(config: Configuration);
}
export declare class TransactionsList {
    private api;
    constructor(api: TransactionsAPIV4Api);
    /**
     * uniqueValues - get /v4/transactions/unique/{column}
     */
    uniqueValues(column: V4TransactionsControllerGetUniqueValuesV4Request['column'], options?: Omit<V4TransactionsControllerGetUniqueValuesV4Request, 'column'>): Promise<V4TransactionsGetUniqueValuesResponseDto>;
    /**
     * one - get /v4/transactions/{transactionId}
     */
    one(transactionId: V4TransactionsControllerGetTransactionV4Request['transactionId'], options?: Omit<V4TransactionsControllerGetTransactionV4Request, 'transactionId'>): Promise<V4TransactionsGetTransactionResponseDto>;
    /**
     * oneWithColumns - get /v4/transactions/{transactionId}/{columns}
     */
    oneWithColumns(transactionId: V4TransactionsControllerGetTransactionColumnsV4Request['transactionId'], columns: V4TransactionsControllerGetTransactionColumnsV4Request['columns'], options?: Omit<V4TransactionsControllerGetTransactionColumnsV4Request, 'transactionId' | 'columns'>): Promise<V4TransactionsGetTransactionColumnsResponseDto>;
    /**
     * all - get /v4/transactions
     */
    all(options?: V4TransactionsControllerGetTransactionsV4Request): Promise<V4TransactionsGetTransactionsResponseDto>;
    /**
     * withView - get /v4/transactions/viewId/{viewId}
     */
    withView(viewId: V4TransactionsControllerGetTransactionsInViewV4Request['viewId'], options?: Omit<V4TransactionsControllerGetTransactionsInViewV4Request, 'viewId'>): Promise<V4TransactionsGetTransactionsInViewResponseDto>;
    /**
     * withFilters - get /v4/transactions/filteredBy/{column}/{value}
     */
    withFilters(column: V4TransactionsControllerGetTransactionsFilteredByV4Request['column'], value: V4TransactionsControllerGetTransactionsFilteredByV4Request['value'], options?: Omit<V4TransactionsControllerGetTransactionsFilteredByV4Request, 'column' | 'value'>): Promise<V4TransactionsGetTransactionsFilteredByResponseDto>;
}
export declare class TransactionsCreate {
    private api;
    constructor(api: TransactionsAPIV4Api);
    /**
     * one - post /v4/transactions
     */
    one(body: V4TransactionsCreateTransactionBodyDto): Promise<V4TransactionsCreateTransactionResponseDto>;
}
export declare class TransactionsUpdate {
    private api;
    constructor(api: TransactionsAPIV4Api);
    /**
     * one - patch /v4/transactions/{transactionId}
     */
    one(transactionId: V4TransactionsControllerUpdateTransactionV4Request['transactionId'], body: V4TransactionsUpdateTransactionBodyDto['transaction']): Promise<V4TransactionsUpdateTransactionResponseDto>;
}
export declare class TransactionsDelete {
    private api;
    constructor(api: TransactionsAPIV4Api);
    /**
     * one - delete /v4/transactions/{transactionId}
     */
    one(transactionId: V4TransactionsControllerDeleteTransactionV4Request['transactionId'], options?: Omit<V4TransactionsControllerDeleteTransactionV4Request, 'transactionId'>): Promise<V4TransactionsDeleteTransactionResponseDto>;
}
//# sourceMappingURL=transactions.d.ts.map