import { Type } from '@angular/core';
import { ResourceActionHttpMethod } from './resource-action-http-method';
import { ResourceInstance } from './resource-instance';
import { ResourceParamDefault } from './resource-param-default';
import { ResourceHeaderDefault } from './resource-header-default';
import { HeaderBuilder } from './header-builder/header-builder';
import { UrlBuilder } from './url-builder/url-builder';
/**
 * Interface that defines the configuration options of a rest resource action.
 */
export interface ResourceActionOptions {
    /**
     * HTTP method to use.
     */
    method?: ResourceActionHttpMethod;
    /**
     * Expect a list or a object from the server.
     */
    isList?: boolean;
    /**
     * The response only primitive data (e.g. string, number, ...) and not
     * a (list of) objects.
     */
    isPrimitive?: boolean;
    /**
     * Use the cache for the request or bypass it.
     */
    useCache?: boolean;
    /**
     * Invalidates the cache if the action was executed successfully. Mind that the action
     * only invalidates the cache if `useCache` is set to `true`.
     */
    invalidateCache?: boolean;
    /**
     * Report progress on requests.
     */
    reportProgress?: boolean;
    /**
     * Strip trailing slashes from request URLs.
     */
    stripTrailingSlashes?: boolean;
    /**
     * Include credentials in CORS calls.
     */
    withCredentials?: boolean;
    /**
     * Determines how to interpret the response.
     */
    responseType?: 'arraybuffer' | 'blob' | 'json' | 'text';
    /**
     * URL to the resource.
     */
    url?: string;
    /**
     * Append given string to the URL pattern.
     */
    urlSuffix?: string;
    /**
     * Class to use to instantiate resource instances.
     */
    instanceClass?: Type<ResourceInstance>;
    /**
     * Class to use to build the headers.
     */
    headerBuilderClass?: Type<HeaderBuilder>;
    /**
     * Class to use to build the url.
     */
    urlBuilderClass?: Type<UrlBuilder>;
    /**
     * Default values for url parameters.
     */
    paramDefaults?: ResourceParamDefault[];
    /**
     * Default values for http headers.
     */
    headerDefaults?: ResourceHeaderDefault[];
    /**
     * Attribute name where to find the data on results.
     */
    dataAttr?: string;
    /**
     * Attribute name where to find the URL of objects.
     */
    urlAttr?: string;
    /**
     * Attribute name where to find the total amount of items on the query call (resource list calls).
     */
    totalAttr?: string;
    /**
     * Pattern for private attribute names.
     */
    privatePattern?: RegExp;
}