scraper-api-datachaser/types/apis/DataApi.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 {
  Data,
  ErrorResponse,
} from '../models/index';
import {
    DataFromJSON,
    DataToJSON,
    ErrorResponseFromJSON,
    ErrorResponseToJSON,
} from '../models/index';

export interface DataIdDeleteRequest {
    id: string;
}

export interface DataJobIdGetRequest {
    id: string;
}

export interface DataUserIdPostRequest {
    id: string;
}

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

    /**
     * This endpoint gets all data from logged user
     * Get all data
     */
    async dataGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Data>>> {
        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: `/data`,
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

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

    /**
     * This endpoint gets all data from logged user
     * Get all data
     */
    async dataGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Data>> {
        const response = await this.dataGetRaw(initOverrides);
        return await response.value();
    }

    /**
     * Delete data generated by job by data id
     * Delete data by id
     */
    async dataIdDeleteRaw(requestParameters: DataIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Data>> {
        if (requestParameters['id'] == null) {
            throw new runtime.RequiredError(
                'id',
                'Required parameter "id" was null or undefined when calling dataIdDelete().'
            );
        }

        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: `/data/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
            method: 'DELETE',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

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

    /**
     * Delete data generated by job by data id
     * Delete data by id
     */
    async dataIdDelete(requestParameters: DataIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Data> {
        const response = await this.dataIdDeleteRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Get data generated by a job (it receives on the url the job id)
     * Get data by job id
     */
    async dataJobIdGetRaw(requestParameters: DataJobIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Data>>> {
        if (requestParameters['id'] == null) {
            throw new runtime.RequiredError(
                'id',
                'Required parameter "id" was null or undefined when calling dataJobIdGet().'
            );
        }

        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: `/data/job/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

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

    /**
     * Get data generated by a job (it receives on the url the job id)
     * Get data by job id
     */
    async dataJobIdGet(requestParameters: DataJobIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Data>> {
        const response = await this.dataJobIdGetRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Subscribe to this webhook service to get done data related to a user id (so it\'ll watch all data status and send done when it\'s scraped)
     * WebHook to get data when done scraped by user id
     */
    async dataUserIdPostRaw(requestParameters: DataUserIdPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Data>> {
        if (requestParameters['id'] == null) {
            throw new runtime.RequiredError(
                'id',
                'Required parameter "id" was null or undefined when calling dataUserIdPost().'
            );
        }

        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: `/data/user/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

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

    /**
     * Subscribe to this webhook service to get done data related to a user id (so it\'ll watch all data status and send done when it\'s scraped)
     * WebHook to get data when done scraped by user id
     */
    async dataUserIdPost(requestParameters: DataUserIdPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Data> {
        const response = await this.dataUserIdPostRaw(requestParameters, initOverrides);
        return await response.value();
    }

}