wallee/dist/services/AnalyticsQueriesService.d.ts

TypeScript/JavaScript client for wallee

/**
 * Wallee AG TypeScript SDK
 *
 * This library allows to interact with the Wallee AG payment service.
 *
 * Copyright owner: Wallee AG
 * Website: https://en.wallee.com
 * Developer email: ecosystem-team@wallee.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import * as runtime from '../runtime';
import type { AnalyticsQueryExecutionRequest, AnalyticsQueryExecutionResponse, ResultPortionModel, SubmittedAnalyticsQueryExecution } from '../models/index';
export interface DeleteAnalyticsQueriesQueryExternalIdQueryExternalIdRequest {
    queryExternalId: string;
    account: number;
}
export interface DeleteAnalyticsQueriesQueryTokenQueryTokenRequest {
    queryToken: string;
    account: number;
}
export interface GetAnalyticsQueriesRequest {
    offset: number;
    limit: number;
    account: number;
}
export interface GetAnalyticsQueriesQueryExternalIdQueryExternalIdRequest {
    queryExternalId: string;
    account: number;
}
export interface GetAnalyticsQueriesQueryExternalIdQueryExternalIdResultRequest {
    queryExternalId: string;
    account: number;
}
export interface GetAnalyticsQueriesQueryTokenQueryTokenRequest {
    queryToken: string;
    account: number;
}
export interface GetAnalyticsQueriesQueryTokenQueryTokenResultRequest {
    queryToken: string;
    account: number;
}
export interface PostAnalyticsQueriesSubmitRequest {
    queryExternalId: string;
    account: number;
    analyticsQueryExecutionRequest: AnalyticsQueryExecutionRequest;
}
/**
 *
 */
export declare class AnalyticsQueriesService extends runtime.BaseAPI {
    constructor(configuration: runtime.Configuration);
    /**
     * Cancel a query execution, identifying it by its external id.
     
     */
    deleteAnalyticsQueriesQueryExternalIdQueryExternalIdRaw(requestParameters: DeleteAnalyticsQueriesQueryExternalIdQueryExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Cancel a query execution, identifying it by its external id.
     
     */
    deleteAnalyticsQueriesQueryExternalIdQueryExternalId(requestParameters: DeleteAnalyticsQueriesQueryExternalIdQueryExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Cancel a query execution, identifying it by its query token.
     
     */
    deleteAnalyticsQueriesQueryTokenQueryTokenRaw(requestParameters: DeleteAnalyticsQueriesQueryTokenQueryTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Cancel a query execution, identifying it by its query token.
     
     */
    deleteAnalyticsQueriesQueryTokenQueryToken(requestParameters: DeleteAnalyticsQueriesQueryTokenQueryTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Get portion of query executions for account
     
     */
    getAnalyticsQueriesRaw(requestParameters: GetAnalyticsQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResultPortionModel>>;
    /**
     * Get portion of query executions for account
     
     */
    getAnalyticsQueries(requestParameters: GetAnalyticsQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResultPortionModel>;
    /**
     * Queries are processed asynchronously and may take several minutes to complete. Avoid frequent requests, as they will not speed up processing.
     * Retrieve a query execution information by its external id
     
     * (The read time out for this request is 97 seconds)
     */
    getAnalyticsQueriesQueryExternalIdQueryExternalIdRaw(requestParameters: GetAnalyticsQueriesQueryExternalIdQueryExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubmittedAnalyticsQueryExecution>>;
    /**
     * Queries are processed asynchronously and may take several minutes to complete. Avoid frequent requests, as they will not speed up processing.
     * Retrieve a query execution information by its external id
     
     * (The read time out for this request is 97 seconds)
     */
    getAnalyticsQueriesQueryExternalIdQueryExternalId(requestParameters: GetAnalyticsQueriesQueryExternalIdQueryExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubmittedAnalyticsQueryExecution>;
    /**
     * Generate a short-lived (5-minute) URL for downloading the Analytics query result file. Note that each URL generation is counted as a potential download and will be billed accordingly. Do not use this endpoint for periodic checks of file availability. Instead, use the \'Retrieve a query execution\' endpoint for status checks.
     * Generate a temporary URL to download the query result. It retrieves the query by its external id
     
     */
    getAnalyticsQueriesQueryExternalIdQueryExternalIdResultRaw(requestParameters: GetAnalyticsQueriesQueryExternalIdQueryExternalIdResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Generate a short-lived (5-minute) URL for downloading the Analytics query result file. Note that each URL generation is counted as a potential download and will be billed accordingly. Do not use this endpoint for periodic checks of file availability. Instead, use the \'Retrieve a query execution\' endpoint for status checks.
     * Generate a temporary URL to download the query result. It retrieves the query by its external id
     
     */
    getAnalyticsQueriesQueryExternalIdQueryExternalIdResult(requestParameters: GetAnalyticsQueriesQueryExternalIdQueryExternalIdResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string | null | undefined>;
    /**
     * Queries are processed asynchronously and may take several minutes to complete. Avoid frequent requests, as they will not speed up processing.
     * Retrieve a query execution information by its query token
     
     * (The read time out for this request is 97 seconds)
     */
    getAnalyticsQueriesQueryTokenQueryTokenRaw(requestParameters: GetAnalyticsQueriesQueryTokenQueryTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubmittedAnalyticsQueryExecution>>;
    /**
     * Queries are processed asynchronously and may take several minutes to complete. Avoid frequent requests, as they will not speed up processing.
     * Retrieve a query execution information by its query token
     
     * (The read time out for this request is 97 seconds)
     */
    getAnalyticsQueriesQueryTokenQueryToken(requestParameters: GetAnalyticsQueriesQueryTokenQueryTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubmittedAnalyticsQueryExecution>;
    /**
     * Generate a short-lived (5-minute) URL for downloading the Analytics query result file. Note that each URL generation is counted as a potential download and will be billed accordingly. Do not use this endpoint for periodic checks of file availability. Instead, use the \'Retrieve a query execution\' endpoint for status checks.
     * Generate a temporary URL to download the query result. It retrieves the query by its query token
     
     */
    getAnalyticsQueriesQueryTokenQueryTokenResultRaw(requestParameters: GetAnalyticsQueriesQueryTokenQueryTokenResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Generate a short-lived (5-minute) URL for downloading the Analytics query result file. Note that each URL generation is counted as a potential download and will be billed accordingly. Do not use this endpoint for periodic checks of file availability. Instead, use the \'Retrieve a query execution\' endpoint for status checks.
     * Generate a temporary URL to download the query result. It retrieves the query by its query token
     
     */
    getAnalyticsQueriesQueryTokenQueryTokenResult(requestParameters: GetAnalyticsQueriesQueryTokenQueryTokenResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string | null | undefined>;
    /**
     * Submit a query execution
     
     */
    postAnalyticsQueriesSubmitRaw(requestParameters: PostAnalyticsQueriesSubmitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AnalyticsQueryExecutionResponse>>;
    /**
     * Submit a query execution
     
     */
    postAnalyticsQueriesSubmit(requestParameters: PostAnalyticsQueriesSubmitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AnalyticsQueryExecutionResponse>;
}