@planet-a/affinity-node/types/v1/index.d.ts

API wrapper for the affinity.co API

import { type AxiosInstance } from 'axios';
import { Auth } from './auth.js';
import { RateLimit } from './rate_limit.js';
import { Lists } from './lists.js';
import { Fields } from './fields.js';
import { FieldValues } from './field_values.js';
import { FieldValueChanges } from './field_value_changes.js';
import { Organizations } from './organizations.js';
import { Persons } from './persons.js';
import { EntityFiles } from './entity_files.js';
import { Notes } from './notes.js';
export type * as ListEntries from './list_entries.js';
export type * as Lists from './lists.js';
export type * as Fields from './fields.js';
export type * as RateLimit from './rate_limit.js';
export type * as WhoAmI from './auth.js';
export type * as FieldValues from './field_values.js';
export type * as FieldValueChanges from './field_value_changes.js';
export type * as Organizations from './organizations.js';
export type * as Persons from './persons.js';
export type * as EntityFiles from './entity_files.js';
export type * as Notes from './notes.js';
export type * as PagedRequest from './paged_request.js';
export type * as PagedResponse from './paged_response.js';
export type * as Types from './types.js';
export type * as CreateSearchIteratorFn from './create_search_iterator_fn.js';
export { EntityType, FieldValueType, RoleId } from './lists.js';
export { AffinityApiError } from './errors.js';
export { ActionType } from './field_value_changes.js';
export type { Brand, Branded } from './brand.js';
export { PersonType } from './persons.js';
/**
 * @module
 */
export declare class Affinity {
    protected readonly axios: AxiosInstance;
    /**
     * @param apiKey The Affinity API key. [How to get yours](https://support.affinity.co/hc/en-us/articles/360032633992-How-to-obtain-your-API-Key).
     * @param axiosInstance An axios instance. You can use the default axios instance or bring your own. If you bring your own, it won't be reconfigured.
     */
    constructor(apiKey: string, axiosInstance?: AxiosInstance);
    readonly auth: Auth;
    readonly rateLimit: RateLimit;
    readonly lists: Lists;
    readonly fields: Fields;
    readonly fieldValues: FieldValues;
    readonly fieldValueChanges: FieldValueChanges;
    readonly organizations: Organizations;
    readonly persons: Persons;
    readonly entityFiles: EntityFiles;
    readonly notes: Notes;
}