contentful-management
Version:
Client for Contentful's Content Management API
31 lines (30 loc) • 1.39 kB
TypeScript
import type { GetSpaceEnvironmentParams, CollectionProp } from '../../common-types';
import type { ComponentTypeQueryOptions, ComponentTypeProps } from '../../entities/component-type';
import type { OptionalDefaults } from '../wrappers/wrap';
export type ComponentTypePlainClientAPI = {
/**
* Fetches all component types for a space and environment
* @param params the space and environment IDs and query parameters
* @param params.query.experienceCtId the experience component type ID
* @param params.query.limit the maximum number of component types to return
* @param params.query.skip the number of component types to skip
* @returns a collection of component types
* @throws if the request fails, or the space, environment, or experience component type is not found
* @internal - Experimental endpoint, subject to breaking changes without notice
* @example
* ```javascript
* const componentTypes = await client.componentType.getMany({
* spaceId: '<space_id>',
* environmentId: '<environment_id>',
* query: {
* _experienceCtId: '<experience_ct_id>',
* limit: 10,
* skip: 0,
* },
* });
* ```
*/
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & {
query: ComponentTypeQueryOptions;
}>): Promise<CollectionProp<ComponentTypeProps>>;
};