@climatepartner/climatepartner-api-sdk
Version:
The ClimatePartner API provides one uniform public API to customers of ClimatePartner.
86 lines (85 loc) • 3.64 kB
TypeScript
/**
* ClimatePartner API Calculation Service
* A Unified API for all ClimatePartner products
*
* The version of the OpenAPI document: 1.6.4
*
*
* 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, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { ChoiceValuesResponse } from '../models';
/**
* CalculationServiceApi - axios parameter creator
*/
export declare const CalculationServiceApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Get possible input values for given choice
* @param {string} choiceSlug
* @param {string} [cursor] Marks the last item return in the previous page. Use this to walk through paginated choices
* @param {string} [limit] Determines number of choices to return per page
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getChoiceValues: (choiceSlug: string, cursor?: string, limit?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* CalculationServiceApi - functional programming interface
*/
export declare const CalculationServiceApiFp: (configuration?: Configuration) => {
/**
*
* @summary Get possible input values for given choice
* @param {string} choiceSlug
* @param {string} [cursor] Marks the last item return in the previous page. Use this to walk through paginated choices
* @param {string} [limit] Determines number of choices to return per page
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getChoiceValues(choiceSlug: string, cursor?: string, limit?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChoiceValuesResponse>>;
};
/**
* CalculationServiceApi - factory interface
*/
export declare const CalculationServiceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Get possible input values for given choice
* @param {CalculationServiceApiGetChoiceValuesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getChoiceValues(requestParameters: CalculationServiceApiGetChoiceValuesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ChoiceValuesResponse>;
};
/**
* Request parameters for getChoiceValues operation in CalculationServiceApi.
*/
export interface CalculationServiceApiGetChoiceValuesRequest {
readonly choiceSlug: string;
/**
* Marks the last item return in the previous page. Use this to walk through paginated choices
*/
readonly cursor?: string;
/**
* Determines number of choices to return per page
*/
readonly limit?: string;
}
/**
* CalculationServiceApi - object-oriented interface
*/
export declare class CalculationServiceApi extends BaseAPI {
/**
*
* @summary Get possible input values for given choice
* @param {CalculationServiceApiGetChoiceValuesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getChoiceValues(requestParameters: CalculationServiceApiGetChoiceValuesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChoiceValuesResponse, any, {}>>;
}