contentful-management
Version:
Client for Contentful's Content Management API
89 lines (88 loc) • 3.83 kB
TypeScript
import type { CursorPaginatedCollectionProp, DeleteConceptSchemeParams, GetConceptSchemeParams, GetManyConceptSchemeParams, GetOrganizationParams, UpdateConceptSchemeParams } from '../../common-types';
import type { ConceptSchemeProps, CreateConceptSchemeProps } from '../../entities/concept-scheme';
import type { OpPatch } from 'json-patch';
import type { SetOptional } from 'type-fest';
export type ConceptSchemePlainClientAPI = {
/**
* Create Concept Scheme
* @returns the created Concept Scheme
* @throws if the request fails
* @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/create-a-concept-scheme}
* @example
* ```javascript
* const concept = await client.conceptScheme.create({
* organizationId: '<organization_id>',
* }, conceptSchemeProps);
* ```
*/
create(params: SetOptional<GetOrganizationParams, 'organizationId'>, payload: CreateConceptSchemeProps): Promise<ConceptSchemeProps>;
/**
* Update Concept Scheme
* @returns the updated Concept Scheme
* @throws if the request fails
* @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept-scheme}
* @example
* ```javascript
* const updatedConcept = await client.conceptScheme.update({
* organizationId: '<organization_id>',
* }, conceptSchemePatch);
* ```
*/
update(params: SetOptional<UpdateConceptSchemeParams, 'organizationId'>, payload: OpPatch[]): Promise<ConceptSchemeProps>;
/**
* Get Concept Scheme
* @returns the Concept Scheme
* @throws if the request fails
* @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept-scheme}
* @example
* ```javascript
* const concept = await client.conceptScheme.get({
* organizationId: '<organization_id>',
* conceptSchemeId: '<concept_scheme_id>',
* });
* ```
*/
get(params: SetOptional<GetConceptSchemeParams, 'organizationId'>): Promise<ConceptSchemeProps>;
/**
* Get many Concept Schemes
* @returns list of many Concept Schemes
* @throws if the request fails
* @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept-scheme-collection}
* @example
* ```javascript
* const concepts = await client.conceptScheme.getMany({
* organizationId: '<organization_id>',
* });
* ```
*/
getMany(params: SetOptional<GetManyConceptSchemeParams, 'organizationId'>): Promise<CursorPaginatedCollectionProp<ConceptSchemeProps>>;
/**
* Get number of total Concept Scheme
* @returns number of total Concept Scheme
* @throws if the request fails
* @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/total-concept-schemes}
* @example
* ```javascript
* const {total} = await client.conceptScheme.getTotal({
* organizationId: '<organization_id>',
* });
* ```
*/
getTotal(params: SetOptional<GetOrganizationParams, 'organizationId'>): Promise<{
total: number;
}>;
/**
* Delete Concept Scheme
* @returns nothing
* @throws if the request fails
* @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept-scheme}
* @example
* ```javascript
* await client.conceptScheme.update({
* organizationId: '<organization_id>',
* conceptSchemeId: '<concept_scheme_id>',
* });
* ```
*/
delete(params: SetOptional<DeleteConceptSchemeParams, 'organizationId'>): Promise<void>;
};