import { GetComponent200Response } from '../../models/base/get-component200-response/index'; import { GetFileComponents200Response } from '../../models/base/get-file-components200-response/index'; import { GetTeamComponents200Response } from '../../models/base/get-team-components200-response/index'; import { Api, ApiClient, RequestMetadata } from '@ama-sdk/core'; /** Parameters object to ComponentsApi's getComponent function */ export interface ComponentsApiGetComponentRequestData { /** The unique identifier of the component. */ 'key': string; } /** Parameters object to ComponentsApi's getFileComponents function */ export interface ComponentsApiGetFileComponentsRequestData { /** File to list components from. This must be a main file key, not a branch key, as it is not possible to publish from branches. */ 'file_key': string; } /** Parameters object to ComponentsApi's getTeamComponents function */ export interface ComponentsApiGetTeamComponentsRequestData { /** Id of the team to list components from. */ 'team_id': string; /** Number of items to return in a paged list of results. Defaults to 30. */ 'page_size'?: number; /** Cursor indicating which id after which to start retrieving components for. Exclusive with before. The cursor value is an internally tracked integer that doesn't correspond to any Ids. */ 'after'?: number; /** Cursor indicating which id before which to start retrieving components for. Exclusive with after. The cursor value is an internally tracked integer that doesn't correspond to any Ids. */ 'before'?: number; } export declare class ComponentsApi implements Api { /** API name */ static readonly apiName = "ComponentsApi"; /** @inheritDoc */ readonly apiName = "ComponentsApi"; /** Tokens of the parameters containing PII */ readonly piiParamTokens: { [key: string]: string; }; /** @inheritDoc */ client: ApiClient; /** * Initialize your interface * * @param apiClient Client used to process call to the API */ constructor(apiClient: ApiClient); /** * Get component * Get metadata on a component by key. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ getComponent(data: ComponentsApiGetComponentRequestData, metadata?: RequestMetadata): Promise; /** * Get file components * Get a list of published components within a file library. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ getFileComponents(data: ComponentsApiGetFileComponentsRequestData, metadata?: RequestMetadata): Promise; /** * Get team components * Get a paginated list of published components within a team library. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ getTeamComponents(data: ComponentsApiGetTeamComponentsRequestData, metadata?: RequestMetadata): Promise; } //# sourceMappingURL=components-api.d.ts.map