/** * Pipedrive API v2 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 2.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 { AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { GetActivityField200Response } from '../models'; import { GetActivityFields200Response } from '../models'; /** * ActivityFieldsApi - axios parameter creator * @export */ export declare const ActivityFieldsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns metadata about a specific activity field. * @summary Get one activity field * @param {string} field_code The unique code identifying the field * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response * @throws {RequiredError} */ getActivityField: (field_code: string, include_fields?: 'ui_visibility') => Promise; /** * Returns metadata about all activity fields in the company. * @summary Get all activity fields * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @throws {RequiredError} */ getActivityFields: (include_fields?: 'ui_visibility', limit?: number, cursor?: string) => Promise; }; /** * ActivityFieldsApi - functional programming interface * @export */ export declare const ActivityFieldsApiFp: (configuration?: Configuration) => { /** * Returns metadata about a specific activity field. * @summary Get one activity field * @param {string} field_code The unique code identifying the field * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response * @throws {RequiredError} */ getActivityField(field_code: string, include_fields?: 'ui_visibility'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Returns metadata about all activity fields in the company. * @summary Get all activity fields * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page * @throws {RequiredError} */ getActivityFields(include_fields?: 'ui_visibility', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; }; /** * ActivityFieldsApi - factory interface * @export */ export declare const ActivityFieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns metadata about a specific activity field. * @summary Get one activity field * @param {ActivityFieldsApiGetActivityFieldRequest} requestParameters Request parameters. * @throws {RequiredError} */ getActivityField(requestParameters: ActivityFieldsApiGetActivityFieldRequest): Promise; /** * Returns metadata about all activity fields in the company. * @summary Get all activity fields * @param {ActivityFieldsApiGetActivityFieldsRequest} requestParameters Request parameters. * @throws {RequiredError} */ getActivityFields(requestParameters?: ActivityFieldsApiGetActivityFieldsRequest): Promise; }; /** * Request parameters for getActivityField operation in ActivityFieldsApi. * @export * @interface ActivityFieldsApiGetActivityFieldRequest */ export interface ActivityFieldsApiGetActivityFieldRequest { /** * The unique code identifying the field * @type {string} * @memberof ActivityFieldsApiGetActivityField */ readonly field_code: string; /** * Optional comma separated string array of additional data namespaces to include in response * @type {'ui_visibility'} * @memberof ActivityFieldsApiGetActivityField */ readonly include_fields?: 'ui_visibility'; } /** * Request parameters for getActivityFields operation in ActivityFieldsApi. * @export * @interface ActivityFieldsApiGetActivityFieldsRequest */ export interface ActivityFieldsApiGetActivityFieldsRequest { /** * Optional comma separated string array of additional data namespaces to include in response * @type {'ui_visibility'} * @memberof ActivityFieldsApiGetActivityFields */ readonly include_fields?: 'ui_visibility'; /** * For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. * @type {number} * @memberof ActivityFieldsApiGetActivityFields */ readonly limit?: number; /** * For pagination, the marker (an opaque string value) representing the first item on the next page * @type {string} * @memberof ActivityFieldsApiGetActivityFields */ readonly cursor?: string; } /** * ActivityFieldsApi - object-oriented interface * @export * @class ActivityFieldsApi * @extends {BaseAPI} */ export declare class ActivityFieldsApi extends BaseAPI { /** * Returns metadata about a specific activity field. * @summary Get one activity field * @param {ActivityFieldsApiGetActivityFieldRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ActivityFieldsApi */ getActivityField(requestParameters: ActivityFieldsApiGetActivityFieldRequest): Promise; /** * Returns metadata about all activity fields in the company. * @summary Get all activity fields * @param {ActivityFieldsApiGetActivityFieldsRequest} requestParameters Request parameters. * @throws {RequiredError} * @memberof ActivityFieldsApi */ getActivityFields(requestParameters?: ActivityFieldsApiGetActivityFieldsRequest): Promise; }