scraper-api-datachaser/types/apis/APIKeysApi.ts

The scraping SaaS platform provides a RESTful API for developers to perform web scraping tasks. Users can submit scraping tasks, monitor task status, retrieve scraped data, and manage their account through the API.

/* tslint:disable */
/* eslint-disable */
/**
 * Scraper API
 * The scraping SaaS platform provides a RESTful API for developers to perform web scraping tasks. Users can submit scraping tasks, monitor task status, retrieve scraped data, and manage their account through the API.
 *
 * The version of the OpenAPI document: 1.0.0
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


import * as runtime from '../runtime';
import type {
  DeleteApiKeyRequest,
  ErrorResponse,
  Key,
  KeyCreateRequest,
} from '../models/index';
import {
    DeleteApiKeyRequestFromJSON,
    DeleteApiKeyRequestToJSON,
    ErrorResponseFromJSON,
    ErrorResponseToJSON,
    KeyFromJSON,
    KeyToJSON,
    KeyCreateRequestFromJSON,
    KeyCreateRequestToJSON,
} from '../models/index';

export interface KeysDeleteRequest {
    body: DeleteApiKeyRequest;
}

export interface KeysPostRequest {
    body: KeyCreateRequest;
}

/**
 * 
 */
export class APIKeysApi extends runtime.BaseAPI {

    /**
     * Delete API key with given api key id
     * Delete API key by id
     */
    async keysDeleteRaw(requestParameters: KeysDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Key>> {
        if (requestParameters['body'] == null) {
            throw new runtime.RequiredError(
                'body',
                'Required parameter "body" was null or undefined when calling keysDelete().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        headerParameters['Content-Type'] = 'application/json';

        if (this.configuration && this.configuration.apiKey) {
            headerParameters["Key"] = await this.configuration.apiKey("Key"); // key authentication
        }

        const response = await this.request({
            path: `/keys`,
            method: 'DELETE',
            headers: headerParameters,
            query: queryParameters,
            body: DeleteApiKeyRequestToJSON(requestParameters['body']),
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => KeyFromJSON(jsonValue));
    }

    /**
     * Delete API key with given api key id
     * Delete API key by id
     */
    async keysDelete(requestParameters: KeysDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Key> {
        const response = await this.keysDeleteRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Retrieve API keys list from authenticated user
     * Retrieve API keys list
     */
    async keysGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Key>>> {
        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.apiKey) {
            headerParameters["Key"] = await this.configuration.apiKey("Key"); // key authentication
        }

        const response = await this.request({
            path: `/keys`,
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(KeyFromJSON));
    }

    /**
     * Retrieve API keys list from authenticated user
     * Retrieve API keys list
     */
    async keysGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Key>> {
        const response = await this.keysGetRaw(initOverrides);
        return await response.value();
    }

    /**
     * Create new API Key
     * Create new API Key
     */
    async keysPostRaw(requestParameters: KeysPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Key>> {
        if (requestParameters['body'] == null) {
            throw new runtime.RequiredError(
                'body',
                'Required parameter "body" was null or undefined when calling keysPost().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        headerParameters['Content-Type'] = 'application/json';

        if (this.configuration && this.configuration.apiKey) {
            headerParameters["Key"] = await this.configuration.apiKey("Key"); // key authentication
        }

        const response = await this.request({
            path: `/keys`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: KeyCreateRequestToJSON(requestParameters['body']),
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => KeyFromJSON(jsonValue));
    }

    /**
     * Create new API Key
     * Create new API Key
     */
    async keysPost(requestParameters: KeysPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Key> {
        const response = await this.keysPostRaw(requestParameters, initOverrides);
        return await response.value();
    }

}