@paciolan/cybersource-sdk/dist/apis/report-definitions-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 { ReportingV3ReportDefinitionsGet200Response } from '../models';
import { ReportingV3ReportDefinitionsNameGet200Response } from '../models';
/**
 * ReportDefinitionsApi - axios parameter creator
 * @export
 */
export declare const ReportDefinitionsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * View the attributes of an individual report type. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation/)
     * @summary Get Report Definition
     * @param {string} reportDefinitionName Name of the Report definition to retrieve
     * @param {string} [subscriptionType] The subscription type for which report definition is required. By default the type will be CUSTOM. Valid Values: - CLASSIC - CUSTOM - STANDARD
     * @param {string} [reportMimeType] The format for which the report definition is required. By default the value will be CSV. Valid Values: - application/xml - text/csv
     * @param {string} [organizationId] Valid Organization Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getResourceInfoByReportDefinition: (reportDefinitionName: string, subscriptionType?: string, reportMimeType?: string, organizationId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
    /**
     * View a list of supported reports and their attributes before subscribing to them.
     * @summary Get Reporting Resource Information
     * @param {string} [subscriptionType] Valid Values: - CLASSIC - CUSTOM - STANDARD
     * @param {string} [organizationId] Valid Organization Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getResourceV2Info: (subscriptionType?: string, organizationId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
};
/**
 * ReportDefinitionsApi - functional programming interface
 * @export
 */
export declare const ReportDefinitionsApiFp: (configuration?: Configuration) => {
    /**
     * View the attributes of an individual report type. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation/)
     * @summary Get Report Definition
     * @param {string} reportDefinitionName Name of the Report definition to retrieve
     * @param {string} [subscriptionType] The subscription type for which report definition is required. By default the type will be CUSTOM. Valid Values: - CLASSIC - CUSTOM - STANDARD
     * @param {string} [reportMimeType] The format for which the report definition is required. By default the value will be CSV. Valid Values: - application/xml - text/csv
     * @param {string} [organizationId] Valid Organization Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getResourceInfoByReportDefinition(reportDefinitionName: string, subscriptionType?: string, reportMimeType?: string, organizationId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ReportingV3ReportDefinitionsNameGet200Response>>>;
    /**
     * View a list of supported reports and their attributes before subscribing to them.
     * @summary Get Reporting Resource Information
     * @param {string} [subscriptionType] Valid Values: - CLASSIC - CUSTOM - STANDARD
     * @param {string} [organizationId] Valid Organization Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getResourceV2Info(subscriptionType?: string, organizationId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ReportingV3ReportDefinitionsGet200Response>>>;
};
/**
 * ReportDefinitionsApi - factory interface
 * @export
 */
export declare const ReportDefinitionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * View the attributes of an individual report type. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation/)
     * @summary Get Report Definition
     * @param {string} reportDefinitionName Name of the Report definition to retrieve
     * @param {string} [subscriptionType] The subscription type for which report definition is required. By default the type will be CUSTOM. Valid Values: - CLASSIC - CUSTOM - STANDARD
     * @param {string} [reportMimeType] The format for which the report definition is required. By default the value will be CSV. Valid Values: - application/xml - text/csv
     * @param {string} [organizationId] Valid Organization Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getResourceInfoByReportDefinition(reportDefinitionName: string, subscriptionType?: string, reportMimeType?: string, organizationId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<ReportingV3ReportDefinitionsNameGet200Response>>;
    /**
     * View a list of supported reports and their attributes before subscribing to them.
     * @summary Get Reporting Resource Information
     * @param {string} [subscriptionType] Valid Values: - CLASSIC - CUSTOM - STANDARD
     * @param {string} [organizationId] Valid Organization Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getResourceV2Info(subscriptionType?: string, organizationId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<ReportingV3ReportDefinitionsGet200Response>>;
};
/**
 * ReportDefinitionsApi - object-oriented interface
 * @export
 * @class ReportDefinitionsApi
 * @extends {BaseAPI}
 */
export declare class ReportDefinitionsApi extends BaseAPI {
    /**
     * View the attributes of an individual report type. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation/)
     * @summary Get Report Definition
     * @param {string} reportDefinitionName Name of the Report definition to retrieve
     * @param {string} [subscriptionType] The subscription type for which report definition is required. By default the type will be CUSTOM. Valid Values: - CLASSIC - CUSTOM - STANDARD
     * @param {string} [reportMimeType] The format for which the report definition is required. By default the value will be CSV. Valid Values: - application/xml - text/csv
     * @param {string} [organizationId] Valid Organization Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ReportDefinitionsApi
     */
    getResourceInfoByReportDefinition(reportDefinitionName: string, subscriptionType?: string, reportMimeType?: string, organizationId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<ReportingV3ReportDefinitionsNameGet200Response>>;
    /**
     * View a list of supported reports and their attributes before subscribing to them.
     * @summary Get Reporting Resource Information
     * @param {string} [subscriptionType] Valid Values: - CLASSIC - CUSTOM - STANDARD
     * @param {string} [organizationId] Valid Organization Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ReportDefinitionsApi
     */
    getResourceV2Info(subscriptionType?: string, organizationId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<ReportingV3ReportDefinitionsGet200Response>>;
}