@simpleapps-com/augur-api/dist/cjs/services/items/resources/contracts.d.ts

TypeScript client library for Augur microservices API endpoints

import { ContractsItemsParams } from '../schemas';
import type { ItemsClient } from '../client';
type ExecuteRequest = ItemsClient['executeRequest'];
/**
 * Creates the contracts resource methods
 * OpenAPI Path: /contracts → contracts.*
 * @description Methods for managing contract items
 */
export declare function createContractsResource(executeRequest: ExecuteRequest): {
    /**
     * List contract item attributes
     * @description List the attributes for contract items
     * @fullPath api.items.contracts.attributes.list
     * @service items
     * @domain contract-management
     * @discoverable true
     * @dataMethod contractsData.attributes.list
     */
    attributes: {
        /**
         * Get contract item attributes
         * @description List the attributes for contract items by job number
         * @fullPath api.items.contracts.attributes.list
         * @service items
         * @domain contract-management
         * @discoverable true
         * @dataMethod contractsData.attributes.list
         * @searchTerms ["contract", "attributes", "job", "items", "properties"]
         * @relatedEndpoints ["contracts.items.list", "attributes.list", "categories.attributes.list"]
         * @commonPatterns ["Get contract item attributes for job", "List contract properties"]
         * @workflow ["contract-management", "item-configuration"]
         * @prerequisites ["Valid job number", "Bearer token", "x-site-id header"]
         * @nextSteps ["Use attributes for filtering contract items", "Configure item properties"]
         * @businessRules ["Job number must exist", "Returns all available attributes for contract items"]
         * @functionalArea "contract-management"
         * @crossSite false
         * @caching "5 minutes - attributes change infrequently"
         * @performance "Fast - simple lookup operation"
         */
        list: (jobNo: number) => Promise<{
            params: Record<string, unknown> | unknown[];
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
            data?: unknown;
        }>;
    };
    /**
     * List contract items
     * @description List contracts items for a job with filtering and search capabilities
     * @fullPath api.items.contracts.items.list
     * @service items
     * @domain contract-management
     * @discoverable true
     * @dataMethod contractsData.items.list
     */
    items: {
        /**
         * List contract items for a job
         * @description List contracts items for a job with extensive filtering options
         * @fullPath api.items.contracts.items.list
         * @service items
         * @domain contract-management
         * @discoverable true
         */
        list: (jobNo: number, params: Omit<ContractsItemsParams, "jobNo">) => Promise<{
            params: Record<string, unknown> | unknown[];
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
            data?: unknown;
        }>;
    };
};
/**
 * Creates the contractsData resource methods (data-only versions)
 */
export declare function createContractsDataResource(contracts: ReturnType<typeof createContractsResource>): {
    attributes: {
        list: (jobNo: number) => Promise<unknown>;
    };
    items: {
        list: (jobNo: number, params: Omit<ContractsItemsParams, "jobNo">) => Promise<unknown>;
    };
};
export type ContractsResource = ReturnType<typeof createContractsResource>;
export type ContractsDataResource = ReturnType<typeof createContractsDataResource>;
export {};
//# sourceMappingURL=contracts.d.ts.map