lead-fields-api.ts

/* tslint:disable */
/* eslint-disable */
/**
 * Pipedrive API v1
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * 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 type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
// @ts-ignore
import { GetFieldsResponse } from '../models';
/**
 * LeadFieldsApi - axios parameter creator
 * @export
 */
export const LeadFieldsApiAxiosParamCreator = function (configuration?: Configuration) {
    return {
        /**
         * Returns data about all lead fields.
         * @summary Get all lead fields
         * @param {number} [start] Pagination start
         * @param {number} [limit] Items shown per page

         * @throws {RequiredError}
         */
        getLeadFields: async (start?: number, limit?: number, ): Promise<RequestArgs> => {
            const localVarPath = `/leadFields`;
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }

            const localVarRequestOptions = { method: 'GET', ...baseOptions };
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication api_key required
            await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration)

            // authentication oauth2 required
            // oauth required
            await setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full", "admin"], configuration)

            if (start !== undefined) {
                localVarQueryParameter['start'] = start;
            }

            if (limit !== undefined) {
                localVarQueryParameter['limit'] = limit;
            }


    
            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, };

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
    }
};


/**
 * LeadFieldsApi - functional programming interface
 * @export
 */
export const LeadFieldsApiFp = function(configuration?: Configuration) {
    const localVarAxiosParamCreator = LeadFieldsApiAxiosParamCreator(configuration)
    return {
        /**
         * Returns data about all lead fields.
         * @summary Get all lead fields
         * @param {number} [start] Pagination start
         * @param {number} [limit] Items shown per page

         * @throws {RequiredError}
         */
        async getLeadFields(start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFieldsResponse>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.getLeadFields(start, limit, );
            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
        },
    }
};

/**
 * LeadFieldsApi - factory interface
 * @export
 */
export const LeadFieldsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
    const localVarFp = LeadFieldsApiFp(configuration)
    return {
        /**
         * Returns data about all lead fields.
         * @summary Get all lead fields
         * @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.

         * @throws {RequiredError}
         */
        getLeadFields(requestParameters: LeadFieldsApiGetLeadFieldsRequest = {}, ): Promise<GetFieldsResponse> {
            return localVarFp.getLeadFields(requestParameters.start, requestParameters.limit, ).then((request) => request(axios, basePath));
        },
    };
};

/**
 * Request parameters for getLeadFields operation in LeadFieldsApi.
 * @export
 * @interface LeadFieldsApiGetLeadFieldsRequest
 */
export interface LeadFieldsApiGetLeadFieldsRequest {
    /**
     * Pagination start
     * @type {number}
     * @memberof LeadFieldsApiGetLeadFields
     */
    readonly start?: number

    /**
     * Items shown per page
     * @type {number}
     * @memberof LeadFieldsApiGetLeadFields
     */
    readonly limit?: number
}

/**
 * LeadFieldsApi - object-oriented interface
 * @export
 * @class LeadFieldsApi
 * @extends {BaseAPI}
 */
export class LeadFieldsApi extends BaseAPI {
    /**
     * Returns data about all lead fields.
     * @summary Get all lead fields
     * @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.

     * @throws {RequiredError}
     * @memberof LeadFieldsApi
     */
    public getLeadFields(requestParameters: LeadFieldsApiGetLeadFieldsRequest = {}, ) {
        return LeadFieldsApiFp(this.configuration).getLeadFields(requestParameters.start, requestParameters.limit, ).then((request) => request(this.axios, this.basePath));
    }
}