contentful-management 11.33.0 → 11.35.0

package/dist/typings/entities/resource.d.ts

@@ -0,0 +1,36 @@
+import type { BasicCursorPaginationOptions, CursorPaginatedCollectionProp, MakeRequest, SysLink } from '../common-types';
+export type ResourceQueryOptions = LookupQueryOptions | SearchQueryOptions;
+type LookupQueryOptions = {
+    'sys.urn[in]': string;
+} & BasicCursorPaginationOptions;
+type SearchQueryOptions = {
+    query: string;
+} & BasicCursorPaginationOptions;
+export type ResourceProps = {
+    sys: {
+        type: 'Resource';
+        urn: string;
+        resourceType: SysLink;
+        resourceProvider: SysLink;
+        appDefinition: SysLink;
+    };
+    fields: {
+        title: string;
+        subtitle?: string;
+        description?: string;
+        externalUrl?: string;
+        image?: {
+            url: string;
+            altText?: string;
+        };
+        badge?: {
+            label: string;
+            variant: 'primary' | 'negative' | 'positive' | 'warning' | 'secondary';
+        };
+    };
+};
+export declare function wrapResource(makeRequest: MakeRequest, data: ResourceProps): ResourceProps & {
+    toPlainObject(): ResourceProps;
+};
+export declare const wrapResourceCollection: (makeRequest: MakeRequest, data: CursorPaginatedCollectionProp<ResourceProps>) => CursorPaginatedCollectionProp<ResourceProps>;
+export {};

package/dist/typings/export-types.d.ts

@@ -62,3 +62,5 @@ export type { WorkflowsChangelogEntry, WorkflowsChangelogEntryProps, WorkflowsCh
 export type { ConceptProps, CreateConceptProps } from './entities/concept';
 export type { ConceptSchemeProps, CreateConceptSchemeProps } from './entities/concept-scheme';
 export type { ResourceProvider, ResourceProviderProps, UpsertResourceProviderProps, } from './entities/resource-provider';
+export type { ResourceType, ResourceTypeProps, SpaceEnvResourceTypeProps, UpsertResourceTypeProps, } from './entities/resource-type';
+export type { ResourceProps, ResourceQueryOptions } from './entities/resource';

package/dist/typings/plain/common-types.d.ts

@@ -60,6 +60,8 @@ import type { AppAccessTokenPlainClientAPI } from './entities/app-access-token';
 import type { ConceptPlainClientAPI } from './entities/concept';
 import type { ConceptSchemePlainClientAPI } from './entities/concept-scheme';
 import type { ResourceProviderPlainClientAPI } from './entities/resource-provider';
+import type { ResourceTypePlainClientAPI } from './entities/resource-type';
+import type { ResourcePlainAPI } from './entities/resource';
 export type PlainClientAPI = {
     raw: {
         getDefaultParams(): DefaultParams | undefined;
@@ -286,6 +288,9 @@ export type PlainClientAPI = {
             query?: ReleaseActionQueryOptions;
         }): Promise<CollectionProp<ReleaseActionProps>>;
     };
+    resource: ResourcePlainAPI;
+    resourceProvider: ResourceProviderPlainClientAPI;
+    resourceType: ResourceTypePlainClientAPI;
     role: RolePlainClientAPI;
     scheduledActions: {
         get(params: OptionalDefaults<GetSpaceParams> & {
@@ -326,7 +331,6 @@ export type PlainClientAPI = {
     };
     appDefinition: AppDefinitionPlainClientAPI;
     appInstallation: AppInstallationPlainClientAPI;
-    resourceProvider: ResourceProviderPlainClientAPI;
     extension: ExtensionPlainClientAPI;
     webhook: WebhookPlainClientAPI;
     snapshot: {

package/dist/typings/plain/entities/resource-type.d.ts

@@ -0,0 +1,14 @@
+import type { RawAxiosRequestHeaders } from 'axios';
+import type { OptionalDefaults } from '../wrappers/wrap';
+import type { BasicCursorPaginationOptions, CollectionProp, CursorPaginatedCollectionProp, GetResourceTypeParams, GetSpaceEnvironmentParams } from '../../common-types';
+import type { ResourceTypeProps, UpsertResourceTypeProps } from '../../export-types';
+import type { SpaceEnvResourceTypeProps } from '../../entities/resource-type';
+export type ResourceTypePlainClientAPI = {
+    get(params: OptionalDefaults<GetResourceTypeParams>): Promise<ResourceTypeProps>;
+    upsert(params: OptionalDefaults<GetResourceTypeParams>, rawData: UpsertResourceTypeProps, headers?: RawAxiosRequestHeaders): Promise<ResourceTypeProps>;
+    delete(params: OptionalDefaults<GetResourceTypeParams>): Promise<any>;
+    getForEnvironment(params: OptionalDefaults<GetSpaceEnvironmentParams> & {
+        query?: BasicCursorPaginationOptions;
+    }): Promise<CursorPaginatedCollectionProp<SpaceEnvResourceTypeProps>>;
+    getMany(params: OptionalDefaults<Omit<GetResourceTypeParams, 'resourceTypeId'>>): Promise<CollectionProp<ResourceTypeProps>>;
+};

package/dist/typings/plain/entities/resource.d.ts

@@ -0,0 +1,38 @@
+import type { OptionalDefaults } from '../wrappers/wrap';
+import type { CursorPaginatedCollectionProp, GetResourceParams } from '../../common-types';
+import type { ResourceProps, ResourceQueryOptions } from '../../entities/resource';
+export type ResourcePlainAPI = {
+    /**
+     * Fetch Resources
+     * @param params entity IDs to identify the Resources
+     * @returns the App Definition config
+     * @throws if the request fails, or the Resource Type is not found
+     * @example
+     * ```javascript
+     * // Lookup example
+     * const resourceProvider = await client.resource.getMany({
+     *   spaceId: '<space_id>',
+     *   environmentId: '<environment_id>',
+     *   resourceTypeId: '<resource_type_id>',
+     *   query: {
+     *     'sys.urn[in]': '<resource_urn1>,<resource_urn2>',
+     *     limit': <number>,
+     *   }
+     * });
+     *
+     * // Search example
+     * const resourceProvider = await client.resource.getMany({
+     *   spaceId: '<space_id>',
+     *   environmentId: '<environment_id>',
+     *   resourceTypeId: '<resource_type_id>',
+     *   query: {
+     *     'query': 'text',
+     *     'limit': <number>,
+     *   }
+     * });
+     * ```
+     */
+    getMany(params: OptionalDefaults<GetResourceParams> & {
+        query?: ResourceQueryOptions;
+    }): Promise<CursorPaginatedCollectionProp<ResourceProps>>;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-management",
-  "version": "11.33.0",
+  "version": "11.35.0",
   "description": "Client for Contentful's Content Management API",
   "homepage": "https://www.contentful.com/developers/documentation/content-management-api/",
   "main": "./dist/contentful-management.node.js",