@getgreenspark/reports

/** * Reporting * Here you can find documentation and examples for Greenspark Reporting API * * OpenAPI spec version: v1 * * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ import { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { InlineResponse200 } from '../models'; import { InlineResponse2001 } from '../models'; import { InlineResponse2002 } from '../models'; import { InlineResponse2003 } from '../models'; import { InlineResponse2004 } from '../models'; import { InlineResponse2005 } from '../models'; import { InlineResponse2006 } from '../models'; import { InlineResponse2007 } from '../models'; import { InlineResponse2008 } from '../models'; import { RawReport } from '../models'; import { RawReportV2 } from '../models'; /** * ReportsApi - axios parameter creator * @export */ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Fetch your impacts page in a raw format. * @summary Fetch a Report Page * @param {string} reportId The id of a previously generated report. * @param {string} cursor The cursor identifies the next page within a report. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchAReportPage: (reportId: string, cursor: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Fetch the Array of average spending on impacts per currency. * @summary Fetch Average Spend Per Impact * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchAverageSpendPerImpact: (sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Fetch the Array of spending on impacts of carbon per month. * @summary Fetch Carbon By Interval * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchCarbonByInterval: (sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Fetch the Array of spending on impacts on a single type and source. * @summary Fetch Impact Amount By Type Per Source Report * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchImpactAmountByTypePerSourceReport: (sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Fetch the Array of spending on impacts on a single type and trigger. * @summary Fetch Impact Amount By Type Per Trigger Report * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchImpactAmountByTypePerTriggerReport: (sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Fetch the Array of spending on impacts per month. * @summary Fetch Impacts By Interval * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchImpactsByInterval: (sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Fetch the Array of spending on impacts of plastic per month. * @summary Fetch Plastic By Interval * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchPlasticByInterval: (sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Fetch your impacts in a raw format. * @summary Fetch Raw Report * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {string} [impactType] Type can be trees, plastic or carbon. As a result only the impacts containing the provided impact type will be returned. If they contain other impact types as well, those won't be filtered out. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchRawReport: (sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, impactType?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Fetch your impacts in a raw format. * @summary Fetch Raw Report v2 * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {string} [impactType] Type can be trees, plastic or carbon. As a result only the impacts containing the provided impact type will be returned. If they contain other impact types as well, those won't be filtered out. * @param {string} [cursor] The cursor identifies the next page within a report. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchRawReportV2: (sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, impactType?: string, cursor?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Fetch the Array of impacts amount per source. * @summary Fetch Total Impact By Sources * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTotalImpactBySources: (sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Fetch the Array of impacts amount per trigger. * @summary Fetch Total Impact By Triggers * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTotalImpactByTriggers: (sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Fetch the Array of spending on impacts on a single type. * @summary Fetch Total Impact By Type Report * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTotalImpactByTypeReport: (sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Fetch the total number of impacts. * @summary Fetch Total Impacts Count * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTotalImpactsCount: (sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Fetch the Array of total spending on impacts per currency. * @summary Fetch Total Spend On Impacts * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTotalSpendOnImpacts: (sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Fetch the Array of spending on impacts of trees per month. * @summary Fetch Trees By Interval * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTreesByInterval: (sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; }; /** * ReportsApi - functional programming interface * @export */ export declare const ReportsApiFp: (configuration?: Configuration) => { /** * Fetch your impacts page in a raw format. * @summary Fetch a Report Page * @param {string} reportId The id of a previously generated report. * @param {string} cursor The cursor identifies the next page within a report. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchAReportPage(reportId: string, cursor: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<RawReport>>>; /** * Fetch the Array of average spending on impacts per currency. * @summary Fetch Average Spend Per Impact * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchAverageSpendPerImpact(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<InlineResponse2007>>>>; /** * Fetch the Array of spending on impacts of carbon per month. * @summary Fetch Carbon By Interval * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchCarbonByInterval(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<InlineResponse2003>>>>; /** * Fetch the Array of spending on impacts on a single type and source. * @summary Fetch Impact Amount By Type Per Source Report * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchImpactAmountByTypePerSourceReport(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<InlineResponse2001>>>>; /** * Fetch the Array of spending on impacts on a single type and trigger. * @summary Fetch Impact Amount By Type Per Trigger Report * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchImpactAmountByTypePerTriggerReport(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<InlineResponse2002>>>>; /** * Fetch the Array of spending on impacts per month. * @summary Fetch Impacts By Interval * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchImpactsByInterval(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<InlineResponse2004>>>>; /** * Fetch the Array of spending on impacts of plastic per month. * @summary Fetch Plastic By Interval * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchPlasticByInterval(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<InlineResponse2003>>>>; /** * Fetch your impacts in a raw format. * @summary Fetch Raw Report * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {string} [impactType] Type can be trees, plastic or carbon. As a result only the impacts containing the provided impact type will be returned. If they contain other impact types as well, those won't be filtered out. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchRawReport(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, impactType?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<RawReport>>>; /** * Fetch your impacts in a raw format. * @summary Fetch Raw Report v2 * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {string} [impactType] Type can be trees, plastic or carbon. As a result only the impacts containing the provided impact type will be returned. If they contain other impact types as well, those won't be filtered out. * @param {string} [cursor] The cursor identifies the next page within a report. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchRawReportV2(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, impactType?: string, cursor?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<RawReportV2>>>; /** * Fetch the Array of impacts amount per source. * @summary Fetch Total Impact By Sources * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTotalImpactBySources(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<InlineResponse2005>>>>; /** * Fetch the Array of impacts amount per trigger. * @summary Fetch Total Impact By Triggers * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTotalImpactByTriggers(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<InlineResponse2006>>>>; /** * Fetch the Array of spending on impacts on a single type. * @summary Fetch Total Impact By Type Report * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTotalImpactByTypeReport(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<InlineResponse200>>>>; /** * Fetch the total number of impacts. * @summary Fetch Total Impacts Count * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTotalImpactsCount(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2008>>>; /** * Fetch the Array of total spending on impacts per currency. * @summary Fetch Total Spend On Impacts * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTotalSpendOnImpacts(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<InlineResponse2007>>>>; /** * Fetch the Array of spending on impacts of trees per month. * @summary Fetch Trees By Interval * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTreesByInterval(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<InlineResponse2003>>>>; }; /** * ReportsApi - factory interface * @export */ export declare const ReportsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Fetch your impacts page in a raw format. * @summary Fetch a Report Page * @param {string} reportId The id of a previously generated report. * @param {string} cursor The cursor identifies the next page within a report. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchAReportPage(reportId: string, cursor: string, options?: AxiosRequestConfig): Promise<AxiosResponse<RawReport>>; /** * Fetch the Array of average spending on impacts per currency. * @summary Fetch Average Spend Per Impact * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchAverageSpendPerImpact(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2007>>>; /** * Fetch the Array of spending on impacts of carbon per month. * @summary Fetch Carbon By Interval * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchCarbonByInterval(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2003>>>; /** * Fetch the Array of spending on impacts on a single type and source. * @summary Fetch Impact Amount By Type Per Source Report * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchImpactAmountByTypePerSourceReport(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2001>>>; /** * Fetch the Array of spending on impacts on a single type and trigger. * @summary Fetch Impact Amount By Type Per Trigger Report * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchImpactAmountByTypePerTriggerReport(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2002>>>; /** * Fetch the Array of spending on impacts per month. * @summary Fetch Impacts By Interval * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchImpactsByInterval(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2004>>>; /** * Fetch the Array of spending on impacts of plastic per month. * @summary Fetch Plastic By Interval * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchPlasticByInterval(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2003>>>; /** * Fetch your impacts in a raw format. * @summary Fetch Raw Report * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {string} [impactType] Type can be trees, plastic or carbon. As a result only the impacts containing the provided impact type will be returned. If they contain other impact types as well, those won't be filtered out. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchRawReport(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, impactType?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<RawReport>>; /** * Fetch your impacts in a raw format. * @summary Fetch Raw Report v2 * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {string} [impactType] Type can be trees, plastic or carbon. As a result only the impacts containing the provided impact type will be returned. If they contain other impact types as well, those won't be filtered out. * @param {string} [cursor] The cursor identifies the next page within a report. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchRawReportV2(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, impactType?: string, cursor?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<RawReportV2>>; /** * Fetch the Array of impacts amount per source. * @summary Fetch Total Impact By Sources * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTotalImpactBySources(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2005>>>; /** * Fetch the Array of impacts amount per trigger. * @summary Fetch Total Impact By Triggers * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTotalImpactByTriggers(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2006>>>; /** * Fetch the Array of spending on impacts on a single type. * @summary Fetch Total Impact By Type Report * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTotalImpactByTypeReport(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse200>>>; /** * Fetch the total number of impacts. * @summary Fetch Total Impacts Count * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTotalImpactsCount(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2008>>; /** * Fetch the Array of total spending on impacts per currency. * @summary Fetch Total Spend On Impacts * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTotalSpendOnImpacts(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2007>>>; /** * Fetch the Array of spending on impacts of trees per month. * @summary Fetch Trees By Interval * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchTreesByInterval(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2003>>>; }; /** * ReportsApi - object-oriented interface * @export * @class ReportsApi * @extends {BaseAPI} */ export declare class ReportsApi extends BaseAPI { /** * Fetch your impacts page in a raw format. * @summary Fetch a Report Page * @param {string} reportId The id of a previously generated report. * @param {string} cursor The cursor identifies the next page within a report. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ fetchAReportPage(reportId: string, cursor: string, options?: AxiosRequestConfig): Promise<AxiosResponse<RawReport>>; /** * Fetch the Array of average spending on impacts per currency. * @summary Fetch Average Spend Per Impact * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ fetchAverageSpendPerImpact(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2007>>>; /** * Fetch the Array of spending on impacts of carbon per month. * @summary Fetch Carbon By Interval * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ fetchCarbonByInterval(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2003>>>; /** * Fetch the Array of spending on impacts on a single type and source. * @summary Fetch Impact Amount By Type Per Source Report * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ fetchImpactAmountByTypePerSourceReport(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2001>>>; /** * Fetch the Array of spending on impacts on a single type and trigger. * @summary Fetch Impact Amount By Type Per Trigger Report * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ fetchImpactAmountByTypePerTriggerReport(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2002>>>; /** * Fetch the Array of spending on impacts per month. * @summary Fetch Impacts By Interval * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ fetchImpactsByInterval(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2004>>>; /** * Fetch the Array of spending on impacts of plastic per month. * @summary Fetch Plastic By Interval * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ fetchPlasticByInterval(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2003>>>; /** * Fetch your impacts in a raw format. * @summary Fetch Raw Report * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {string} [impactType] Type can be trees, plastic or carbon. As a result only the impacts containing the provided impact type will be returned. If they contain other impact types as well, those won't be filtered out. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ fetchRawReport(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, impactType?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<RawReport>>; /** * Fetch your impacts in a raw format. * @summary Fetch Raw Report v2 * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {string} [impactType] Type can be trees, plastic or carbon. As a result only the impacts containing the provided impact type will be returned. If they contain other impact types as well, those won't be filtered out. * @param {string} [cursor] The cursor identifies the next page within a report. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ fetchRawReportV2(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, impactType?: string, cursor?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<RawReportV2>>; /** * Fetch the Array of impacts amount per source. * @summary Fetch Total Impact By Sources * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ fetchTotalImpactBySources(sourceId?: string, triggerId?: string, startDate?: string, endDate?: string, metadata?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2005>>>; /** * Fetch the Array of impacts amount per trigger. * @summary Fetch Total Impact By Triggers * @param {string} [sourceId] The id of the source associated with the impact. * @param {string} [triggerId] The id of the trigger associated with the impact. * @param {string} [startDate] The beginning of the date filter interval. * @param {string} [endDate] The end of the date filter interval. * @param {string} [metadata] You can filter the data by the provided key-value pairs as Metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ fetchTotalImpactByTriggers(sourceId?: string, triggerId?: string, startDa