@crowdin/crowdin-api-client/out/vendors/index.d.ts

JavaScript library for Crowdin API

import { CrowdinApi, PaginationOptions, ResponseList } from '../core';
/**
 * Vendors are the organizations that provide professional translation services.
 * To assign a Vendor to a project workflow you should invite an existing Organization to be a Vendor for you.
 *
 * Use API to get the list of the Vendors you already invited to your organization.
 */
export declare class Vendors extends CrowdinApi {
    /**
     * @param options optional pagination parameters for the request
     * @see https://support.crowdin.com/enterprise/api/#operation/api.vendors.getMany
     */
    listVendors(options?: PaginationOptions): Promise<ResponseList<VendorsModel.Vendor>>;
    /**
     * @param limit maximum number of items to retrieve (default 25)
     * @param offset starting offset in the collection (default 0)
     * @deprecated optional parameters should be passed through an object
     * @see https://support.crowdin.com/enterprise/api/#operation/api.vendors.getMany
     */
    listVendors(limit?: number, offset?: number): Promise<ResponseList<VendorsModel.Vendor>>;
}
export declare namespace VendorsModel {
    interface Vendor {
        id: number;
        name: string;
        description: string;
        status: 'pending' | 'confirmed' | 'rejected';
        webUrl: string;
    }
}