@paciolan/cybersource-sdk/dist/apis/secure-file-share-api.d.ts

CyberSource REST API Typescript SDK

/**
 * CyberSource Merged Spec
 * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
 *
 * OpenAPI spec version: 0.0.1
 *
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
import { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { V1FileDetailsGet200Response } from '../models';
/**
 * SecureFileShareApi - axios parameter creator
 * @export
 */
export declare const SecureFileShareApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Download a file for the given file identifier
     * @summary Download a File with File Identifier
     * @param {string} fileId Unique identifier for each file
     * @param {string} [organizationId] Valid Cybersource Organization Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFile: (fileId: string, organizationId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
    /**
     * Get list of files and it's information of them available inside the report directory
     * @summary Get List of Files
     * @param {string} startDate Valid start date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)   **Example date format:**   - yyyy-MM-dd
     * @param {string} endDate Valid end date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)   **Example date format:**   - yyyy-MM-dd
     * @param {string} [organizationId] Valid Cybersource Organization Id
     * @param {string} [name] **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFileDetail: (startDate: string, endDate: string, organizationId?: string, name?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
};
/**
 * SecureFileShareApi - functional programming interface
 * @export
 */
export declare const SecureFileShareApiFp: (configuration?: Configuration) => {
    /**
     * Download a file for the given file identifier
     * @summary Download a File with File Identifier
     * @param {string} fileId Unique identifier for each file
     * @param {string} [organizationId] Valid Cybersource Organization Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFile(fileId: string, organizationId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     * Get list of files and it's information of them available inside the report directory
     * @summary Get List of Files
     * @param {string} startDate Valid start date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)   **Example date format:**   - yyyy-MM-dd
     * @param {string} endDate Valid end date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)   **Example date format:**   - yyyy-MM-dd
     * @param {string} [organizationId] Valid Cybersource Organization Id
     * @param {string} [name] **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFileDetail(startDate: string, endDate: string, organizationId?: string, name?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<V1FileDetailsGet200Response>>>;
};
/**
 * SecureFileShareApi - factory interface
 * @export
 */
export declare const SecureFileShareApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Download a file for the given file identifier
     * @summary Download a File with File Identifier
     * @param {string} fileId Unique identifier for each file
     * @param {string} [organizationId] Valid Cybersource Organization Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFile(fileId: string, organizationId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<void>>;
    /**
     * Get list of files and it's information of them available inside the report directory
     * @summary Get List of Files
     * @param {string} startDate Valid start date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)   **Example date format:**   - yyyy-MM-dd
     * @param {string} endDate Valid end date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)   **Example date format:**   - yyyy-MM-dd
     * @param {string} [organizationId] Valid Cybersource Organization Id
     * @param {string} [name] **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFileDetail(startDate: string, endDate: string, organizationId?: string, name?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<V1FileDetailsGet200Response>>;
};
/**
 * SecureFileShareApi - object-oriented interface
 * @export
 * @class SecureFileShareApi
 * @extends {BaseAPI}
 */
export declare class SecureFileShareApi extends BaseAPI {
    /**
     * Download a file for the given file identifier
     * @summary Download a File with File Identifier
     * @param {string} fileId Unique identifier for each file
     * @param {string} [organizationId] Valid Cybersource Organization Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SecureFileShareApi
     */
    getFile(fileId: string, organizationId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<void>>;
    /**
     * Get list of files and it's information of them available inside the report directory
     * @summary Get List of Files
     * @param {string} startDate Valid start date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)   **Example date format:**   - yyyy-MM-dd
     * @param {string} endDate Valid end date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)   **Example date format:**   - yyyy-MM-dd
     * @param {string} [organizationId] Valid Cybersource Organization Id
     * @param {string} [name] **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SecureFileShareApi
     */
    getFileDetail(startDate: string, endDate: string, organizationId?: string, name?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<V1FileDetailsGet200Response>>;
}