boldsign/dist/api/customFieldApi.d.ts

NodeJS client for boldsign

import { Authentication, Interceptor, ApiKeyAuth, BrandCustomFieldDetails, CustomFieldCollection, CustomFieldMessage, DeleteCustomFieldReply, EmbeddedCustomFieldCreated } from '../model';
import { optionsI } from './';
export declare class CustomFieldApi {
    protected _basePath: string;
    protected _defaultHeaders: any;
    protected _useQuerystring: boolean;
    protected authentications: {
        default: Authentication;
        Bearer: ApiKeyAuth;
        'X-API-KEY': ApiKeyAuth;
    };
    protected interceptors: Interceptor[];
    constructor(basePath?: string);
    set useQuerystring(value: boolean);
    set basePath(basePath: string);
    set defaultHeaders(defaultHeaders: any);
    get defaultHeaders(): any;
    get basePath(): string;
    setDefaultAuthentication(auth: Authentication): void;
    setApiKey(apikey: string): void;
    setAccessToken(accessToken: string): void;
    addInterceptor(interceptor: Interceptor): void;
    createCustomField(brandCustomFieldDetails: BrandCustomFieldDetails, options?: optionsI): Promise<CustomFieldMessage>;
    customFieldsList(brandId: string, options?: optionsI): Promise<CustomFieldCollection>;
    deleteCustomField(customFieldId: string, options?: optionsI): Promise<DeleteCustomFieldReply>;
    editCustomField(customFieldId: string, brandCustomFieldDetails: BrandCustomFieldDetails, options?: optionsI): Promise<CustomFieldMessage>;
    embedCustomField(brandId: string, linkValidTill?: Date, options?: optionsI): Promise<EmbeddedCustomFieldCreated>;
}