@zeplin/sdk/dist/apis/variable-collections-api.d.ts

Zeplin API client for JavaScript

/**
 * Zeplin API
 * Access your resources in Zeplin
 *
 * Contact: support@zeplin.io
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { AxiosPromise, AxiosInstance, AxiosResponse } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { VariableCollection } from '../models';
/**
 * VariableCollectionsApi - axios parameter creator
 * @export
 */
export declare const VariableCollectionsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
    /**
     * This endpoint returns all of the color variables in a project  You need to be a member of the project or a member of the organization that owns the project. Returns `Not Found` response otherwise.
     * @summary Get project variable collections
     * @param {string} projectId Project id
     * @param {number} [limit] Pagination limit
     * @param {number} [offset] Pagination offset
     * @param {boolean} [includeLinkedStyleguides] Whether to include linked styleguides or not
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getProjectVariableCollections: (projectId: string, limit?: number | undefined, offset?: number | undefined, includeLinkedStyleguides?: boolean | undefined, options?: any) => Promise<RequestArgs>;
    /**
     * This endpoint returns all of the color variables in a styleguide  You need to be a member of the styleguide or a member of the organization that owns the styleguide. Returns `Not Found` response otherwise.
     * @summary Get styleguide variable collections
     * @param {string} styleguideId Styleguide id
     * @param {number} [limit] Pagination limit
     * @param {number} [offset] Pagination offset
     * @param {boolean} [includeLinkedStyleguides] Whether to include linked styleguides or not
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStyleguideVariableCollections: (styleguideId: string, limit?: number | undefined, offset?: number | undefined, includeLinkedStyleguides?: boolean | undefined, options?: any) => Promise<RequestArgs>;
};
/**
 * VariableCollectionsApi - functional programming interface
 * @export
 */
export declare const VariableCollectionsApiFp: (configuration?: Configuration | undefined) => {
    /**
     * This endpoint returns all of the color variables in a project  You need to be a member of the project or a member of the organization that owns the project. Returns `Not Found` response otherwise.
     * @summary Get project variable collections
     * @param {string} projectId Project id
     * @param {number} [limit] Pagination limit
     * @param {number} [offset] Pagination offset
     * @param {boolean} [includeLinkedStyleguides] Whether to include linked styleguides or not
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getProjectVariableCollections(projectId: string, limit?: number | undefined, offset?: number | undefined, includeLinkedStyleguides?: boolean | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<any>>;
    /**
     * This endpoint returns all of the color variables in a styleguide  You need to be a member of the styleguide or a member of the organization that owns the styleguide. Returns `Not Found` response otherwise.
     * @summary Get styleguide variable collections
     * @param {string} styleguideId Styleguide id
     * @param {number} [limit] Pagination limit
     * @param {number} [offset] Pagination offset
     * @param {boolean} [includeLinkedStyleguides] Whether to include linked styleguides or not
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStyleguideVariableCollections(styleguideId: string, limit?: number | undefined, offset?: number | undefined, includeLinkedStyleguides?: boolean | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<any>>;
};
/**
 * Search parameters for getProjectVariableCollections operation in VariableCollectionsApi.
 * @export
 * @interface VariableCollectionsApiGetProjectVariableCollectionsSearchParams
 */
export interface VariableCollectionsApiGetProjectVariableCollectionsSearchParams {
    /**
     * Pagination limit
     * @type {number}
     * @memberof VariableCollectionsApiGetProjectVariableCollectionsSearchParams
     */
    readonly limit?: number;
    /**
     * Pagination offset
     * @type {number}
     * @memberof VariableCollectionsApiGetProjectVariableCollectionsSearchParams
     */
    readonly offset?: number;
    /**
     * Whether to include linked styleguides or not
     * @type {boolean}
     * @memberof VariableCollectionsApiGetProjectVariableCollectionsSearchParams
     */
    readonly includeLinkedStyleguides?: boolean;
}
/**
 * Search parameters for getStyleguideVariableCollections operation in VariableCollectionsApi.
 * @export
 * @interface VariableCollectionsApiGetStyleguideVariableCollectionsSearchParams
 */
export interface VariableCollectionsApiGetStyleguideVariableCollectionsSearchParams {
    /**
     * Pagination limit
     * @type {number}
     * @memberof VariableCollectionsApiGetStyleguideVariableCollectionsSearchParams
     */
    readonly limit?: number;
    /**
     * Pagination offset
     * @type {number}
     * @memberof VariableCollectionsApiGetStyleguideVariableCollectionsSearchParams
     */
    readonly offset?: number;
    /**
     * Whether to include linked styleguides or not
     * @type {boolean}
     * @memberof VariableCollectionsApiGetStyleguideVariableCollectionsSearchParams
     */
    readonly includeLinkedStyleguides?: boolean;
}
/**
 * VariableCollectionsApi - object-oriented interface
 * @export
 * @class VariableCollectionsApi
 * @extends {BaseAPI}
 */
export declare class VariableCollectionsApi extends BaseAPI {
    /**
     * This endpoint returns all of the color variables in a project  You need to be a member of the project or a member of the organization that owns the project. Returns `Not Found` response otherwise.
     * @summary Get project variable collections
     * @param {string} projectId Project id
     * @param {VariableCollectionsApiGetProjectVariableCollectionsSearchParams} [searchParams] Search parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof VariableCollectionsApi
     */
    getProjectVariableCollections(projectId: string, searchParams?: VariableCollectionsApiGetProjectVariableCollectionsSearchParams, options?: any): Promise<AxiosResponse<Array<VariableCollection>>>;
    /**
     * This endpoint returns all of the color variables in a styleguide  You need to be a member of the styleguide or a member of the organization that owns the styleguide. Returns `Not Found` response otherwise.
     * @summary Get styleguide variable collections
     * @param {string} styleguideId Styleguide id
     * @param {VariableCollectionsApiGetStyleguideVariableCollectionsSearchParams} [searchParams] Search parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof VariableCollectionsApi
     */
    getStyleguideVariableCollections(styleguideId: string, searchParams?: VariableCollectionsApiGetStyleguideVariableCollectionsSearchParams, options?: any): Promise<AxiosResponse<Array<VariableCollection>>>;
}