@simpleapps-com/augur-api/dist/cjs/services/p21-sism/resources/scheduled-import-master.d.ts

TypeScript client library for Augur microservices API endpoints

import type { BaseResponse } from '../../../core/base-client';
import type { P21SismClient } from '../client';
type ExecuteRequest = P21SismClient['executeRequest'];
/**
 * Creates the scheduledImportMaster resource methods
 * OpenAPI Path: /scheduled-import-master → scheduledImportMaster.*
 * @description Methods for scheduled import master operations
 */
export declare function createScheduledImportMasterResource(executeRequest: ExecuteRequest): {
    /**
     * Metadata operations for scheduled import master
     * @fullPath api.p21Sism.scheduledImportMaster.metadata
     * @service p21-sism
     * @domain scheduled-import-management
     * @discoverable true
     */
    metadata: {
        /**
         * SFTP operations for scheduled import master metadata
         * @fullPath api.p21Sism.scheduledImportMaster.metadata.sftp
         * @service p21-sism
         * @domain scheduled-import-management
         * @discoverable true
         */
        sftp: {
            /**
             * Create SFTP metadata for a scheduled import master configuration
             *
             * @fullPath api.p21Sism.scheduledImportMaster.metadata.sftp.create
             * @service p21-sism
             * @domain scheduled-import-management
             * @dataMethod scheduledImportMasterData.metadata.sftp.create
             * @discoverable true
             * @searchTerms ["SFTP metadata", "scheduled import", "import master", "SFTP configuration", "automated import", "file transfer"]
             * @relatedEndpoints ["api.p21Sism.import.list", "api.p21Sism.import.recent.list", "api.p21Core.company"]
             * @commonPatterns ["Configure SFTP import", "Setup automated data transfer", "Scheduled import configuration", "File transfer setup"]
             * @workflow ["sftp-configuration", "scheduled-imports", "automated-processing", "file-transfer-setup"]
             * @prerequisites ["Valid scheduled import master UID", "SFTP configuration permissions", "Scheduled import master exists"]
             * @nextSteps ["api.p21Sism.import.recent.list to monitor scheduled imports", "SFTP file monitoring systems"]
             * @businessRules ["SFTP metadata defines transfer parameters", "Scheduled import master must be configured", "File transfer validation rules apply"]
             * @functionalArea "scheduled-import-management"
             * @performance "Configuration operation, minimal processing overhead"
             *
             * @param scheduledImportMasterUid Scheduled import master UID parameter
             * @returns Promise<BaseResponse<unknown>> Complete response with SFTP metadata configuration
             */
            create: (scheduledImportMasterUid: string) => Promise<BaseResponse<unknown>>;
        };
    };
};
/**
 * Creates the scheduledImportMasterData resource methods (data-only versions)
 */
export declare function createScheduledImportMasterDataResource(scheduledImportMaster: ReturnType<typeof createScheduledImportMasterResource>): {
    metadata: {
        sftp: {
            create: (scheduledImportMasterUid: string) => Promise<unknown>;
        };
    };
};
export type ScheduledImportMasterResource = ReturnType<typeof createScheduledImportMasterResource>;
export type ScheduledImportMasterDataResource = ReturnType<typeof createScheduledImportMasterDataResource>;
export {};
//# sourceMappingURL=scheduled-import-master.d.ts.map