contentful-management 11.34.0 → 11.35.1

package/dist/typings/entities/access-token.d.ts

@@ -10,7 +10,7 @@ type AccessTokenSysProps = BasicMetaSysProps & {
     lastUsedAt: string | null;
     redactedValue: string;
 };
-export type AccessTokenProp = {
+export type AccessTokenProps = {
     sys: AccessTokenSysProps;
     name: string;
     scopes: 'content_management_manage'[];
@@ -20,7 +20,7 @@ export type AccessTokenProp = {
 export type CreatePersonalAccessTokenProps = Pick<AccessToken, 'name' | 'scopes'> & {
     expiresIn: number;
 };
-export interface AccessToken extends AccessTokenProp, DefaultElements<AccessTokenProp> {
+export interface AccessToken extends AccessTokenProps, DefaultElements<AccessTokenProps> {
     /**
      * Revokes access token
      * @return Object the revoked access token
@@ -46,12 +46,12 @@ export interface AccessToken extends AccessTokenProp, DefaultElements<AccessToke
  * @param data - Raw  access token data
  * @return Wrapped access token
  */
-export declare function wrapAccessToken(makeRequest: MakeRequest, data: AccessTokenProp): AccessToken;
+export declare function wrapAccessToken(makeRequest: MakeRequest, data: AccessTokenProps): AccessToken;
 /**
  * @private
  * @param makeRequest - function to make requests via an adapter
  * @param data - Raw access collection data
  * @return Wrapped access token collection data
  */
-export declare const wrapAccessTokenCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AccessTokenProp>) => import("../common-types").Collection<AccessToken, AccessTokenProp>;
+export declare const wrapAccessTokenCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AccessTokenProps>) => import("../common-types").Collection<AccessToken, AccessTokenProps>;
 export {};

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

@@ -54,6 +54,7 @@ import * as concept from './concept';
 import * as conceptScheme from './concept-scheme';
 import * as resourceProvider from './resource-provider';
 import * as resourceType from './resource-type';
+import * as resource from './resource';
 declare const _default: {
     accessToken: typeof accessToken;
     appAction: typeof appAction;
@@ -93,6 +94,7 @@ declare const _default: {
     releaseAction: typeof releaseAction;
     resourceProvider: typeof resourceProvider;
     resourceType: typeof resourceType;
+    resource: typeof resource;
     role: typeof role;
     scheduledAction: typeof scheduledAction;
     snapshot: typeof snapshot;

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

@@ -1,7 +1,7 @@
 import type { ContentfulOrganizationAPI } from '../create-organization-api';
 import type { MetaSysProps, DefaultElements, MakeRequest } from '../common-types';
-export type Organization = DefaultElements<OrganizationProp> & OrganizationProp & ContentfulOrganizationAPI;
-export type OrganizationProp = {
+export type Organization = DefaultElements<OrganizationProps> & OrganizationProps & ContentfulOrganizationAPI;
+export type OrganizationProps = {
     /**
      * System metadata
      */
@@ -21,9 +21,9 @@ export type OrganizationProp = {
  * @param data - API response for an Organization
  * @return {Organization}
  */
-export declare function wrapOrganization(makeRequest: MakeRequest, data: OrganizationProp): Organization;
+export declare function wrapOrganization(makeRequest: MakeRequest, data: OrganizationProps): Organization;
 /**
  * This method normalizes each organization in a collection.
  * @private
  */
-export declare const wrapOrganizationCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<OrganizationProp>) => import("../common-types").Collection<Organization, OrganizationProp>;
+export declare const wrapOrganizationCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<OrganizationProps>) => import("../common-types").Collection<Organization, OrganizationProps>;

package/dist/typings/entities/personal-access-token.d.ts

@@ -1,5 +1,5 @@
 import type { MetaSysProps, DefaultElements, MakeRequest } from '../common-types';
-export type PersonalAccessTokenProp = {
+export type PersonalAccessTokenProps = {
     sys: MetaSysProps & {
         expiresAt?: string;
     };
@@ -11,7 +11,7 @@ export type PersonalAccessTokenProp = {
 export type CreatePersonalAccessTokenProps = Pick<PersonalAccessToken, 'name' | 'scopes'> & {
     expiresIn?: number;
 };
-export interface PersonalAccessToken extends PersonalAccessTokenProp, DefaultElements<PersonalAccessTokenProp> {
+export interface PersonalAccessToken extends PersonalAccessTokenProps, DefaultElements<PersonalAccessTokenProps> {
     /**
      * Revokes a personal access token
      * @return Object the revoked personal access token
@@ -37,11 +37,11 @@ export interface PersonalAccessToken extends PersonalAccessTokenProp, DefaultEle
  * @param data - Raw  personal access token data
  * @return Wrapped personal access token
  */
-export declare function wrapPersonalAccessToken(makeRequest: MakeRequest, data: PersonalAccessTokenProp): PersonalAccessToken;
+export declare function wrapPersonalAccessToken(makeRequest: MakeRequest, data: PersonalAccessTokenProps): PersonalAccessToken;
 /**
  * @private
  * @param makeRequest - function to make requests via an adapter
  * @param data - Raw personal access collection data
  * @return Wrapped personal access token collection data
  */
-export declare const wrapPersonalAccessTokenCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<PersonalAccessTokenProp>) => import("../common-types").Collection<PersonalAccessToken, PersonalAccessTokenProp>;
+export declare const wrapPersonalAccessTokenCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<PersonalAccessTokenProps>) => import("../common-types").Collection<PersonalAccessToken, PersonalAccessTokenProps>;

package/dist/typings/entities/release-action.d.ts

@@ -11,6 +11,7 @@ export type ReleaseActionSysProps = {
     status: ReleaseActionStatuses;
     createdBy: Link<'User'>;
     createdAt: ISO8601Timestamp;
+    updatedBy: Link<'User'>;
     updatedAt: ISO8601Timestamp;
 };
 /** The object returned by the Releases API */

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

@@ -1,12 +1,12 @@
-import type { BasicMetaSysProps, DefaultElements, MakeRequest, SysLink } from '../common-types';
+import type { BasicMetaSysProps, CursorPaginatedCollectionProp, DefaultElements, MakeRequest, SysLink } from '../common-types';
 export type ResourceTypeProps = {
     /**
      * System metadata
      */
     sys: Omit<BasicMetaSysProps, 'version'> & {
         appDefinition: SysLink;
-        organization: SysLink;
         resourceProvider: SysLink;
+        organization: SysLink;
     };
     /**
      * Resource Type name
@@ -30,6 +30,11 @@ export type ResourceTypeProps = {
         };
     };
 };
+declare const publicResourceTypeFields: readonly ["name"];
+type OptionalSysFields = 'createdAt' | 'createdBy' | 'updatedAt' | 'updatedBy' | 'appDefinition' | 'organization';
+export type SpaceEnvResourceTypeProps = Pick<ResourceTypeProps, typeof publicResourceTypeFields[number]> & {
+    sys: Partial<Pick<ResourceTypeProps['sys'], OptionalSysFields>> & Omit<ResourceTypeProps['sys'], OptionalSysFields>;
+};
 export type UpsertResourceTypeProps = Omit<ResourceTypeProps, 'sys'>;
 export interface ResourceType extends ResourceTypeProps, DefaultElements<ResourceTypeProps> {
     upsert(): Promise<ResourceType>;
@@ -42,3 +47,6 @@ export interface ResourceType extends ResourceTypeProps, DefaultElements<Resourc
  * @return Wrapped Resource Type data
  */
 export declare function wrapResourceType(makeRequest: MakeRequest, data: ResourceTypeProps): ResourceType;
+export declare function wrapResourceTypeforEnvironment(makeRequest: MakeRequest, data: SpaceEnvResourceTypeProps): SpaceEnvResourceTypeProps;
+export declare const wrapResourceTypesForEnvironmentCollection: (makeRequest: MakeRequest, data: CursorPaginatedCollectionProp<SpaceEnvResourceTypeProps>) => CursorPaginatedCollectionProp<SpaceEnvResourceTypeProps>;
+export {};

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/entities/scheduled-action.d.ts

@@ -2,7 +2,7 @@ import type { DefaultElements, ISO8601Timestamp, MetaLinkProps, Link, MakeReques
 /**
  * Represents that state of the scheduled action
  */
-declare enum ScheduledActionStatus {
+export declare enum ScheduledActionStatus {
     /** action is pending execution */
     scheduled = "scheduled",
     /** action has been started and pending completion */

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

@@ -29,11 +29,11 @@ export type { CreateEnvironmentTemplateInstallationProps, EnvironmentTemplateIns
 export type { CreateExtensionProps as CreateUIExtensionProps, Extension as UIExtension, ExtensionProps as UIExtensionProps, } from './entities/extension';
 export type { FieldType } from './entities/field-type';
 export type { CreateLocaleProps, Locale, LocaleProps } from './entities/locale';
-export type { Organization, OrganizationProp } from './entities/organization';
+export type { Organization, OrganizationProps } from './entities/organization';
 export type { CreateOrganizationInvitationProps, OrganizationInvitation, OrganizationInvitationProps, } from './entities/organization-invitation';
 export type { OrganizationMembership, OrganizationMembershipProps, } from './entities/organization-membership';
-export type { CreatePersonalAccessTokenProps, PersonalAccessToken, PersonalAccessTokenProp, } from './entities/personal-access-token';
-export type { CreatePersonalAccessTokenProps as CreatePATProps, AccessToken, AccessTokenProp, } from './entities/access-token';
+export type { CreatePersonalAccessTokenProps, PersonalAccessToken, PersonalAccessTokenProps as PersonalAccessTokenProp, } from './entities/personal-access-token';
+export type { CreatePersonalAccessTokenProps as CreatePATProps, AccessToken, AccessTokenProps as AccessTokenProp, } from './entities/access-token';
 export type { PreviewApiKey, PreviewApiKeyProps } from './entities/preview-api-key';
 export type { Release, ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseSysProps, ReleaseValidateOptions, ReleaseMetadata, ReleaseReferenceFilters, } from './entities/release';
 export type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions, ReleaseActionSysProps, ReleaseActionTypes, } from './entities/release-action';
@@ -62,4 +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, UpsertResourceTypeProps, } from './entities/resource-type';
+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

@@ -7,8 +7,8 @@ import type { ContentTypeProps, CreateContentTypeProps } from '../entities/conte
 import type { CreateEntryProps, EntryProps, EntryReferenceProps } from '../entities/entry';
 import type { CreateOrganizationInvitationProps, OrganizationInvitationProps } from '../entities/organization-invitation';
 import type { OrganizationMembershipProps } from '../entities/organization-membership';
-import type { CreatePersonalAccessTokenProps, PersonalAccessTokenProp } from '../entities/personal-access-token';
-import type { AccessTokenProp, CreatePersonalAccessTokenProps as CreatePATProps } from '../entities/access-token';
+import type { CreatePersonalAccessTokenProps, PersonalAccessTokenProps } from '../entities/personal-access-token';
+import type { AccessTokenProps, CreatePersonalAccessTokenProps as CreatePATProps } from '../entities/access-token';
 import type { PreviewApiKeyProps } from '../entities/preview-api-key';
 import type { CreateUpdateScheduledActionProps, ScheduledActionProps } from '../entities/scheduled-action';
 import type { SnapshotProps } from '../entities/snapshot';
@@ -61,6 +61,7 @@ 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;
@@ -233,23 +234,23 @@ export type PlainClientAPI = {
     personalAccessToken: {
         get(params: OptionalDefaults<{
             tokenId: string;
-        }>): Promise<PersonalAccessTokenProp>;
-        getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<PersonalAccessTokenProp>>;
-        create(rawData: CreatePersonalAccessTokenProps, headers?: RawAxiosRequestHeaders): Promise<PersonalAccessTokenProp>;
+        }>): Promise<PersonalAccessTokenProps>;
+        getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<PersonalAccessTokenProps>>;
+        create(rawData: CreatePersonalAccessTokenProps, headers?: RawAxiosRequestHeaders): Promise<PersonalAccessTokenProps>;
         revoke(params: OptionalDefaults<{
             tokenId: string;
-        }>): Promise<PersonalAccessTokenProp>;
+        }>): Promise<PersonalAccessTokenProps>;
     };
     accessToken: {
         get(params: OptionalDefaults<{
             tokenId: string;
-        }>): Promise<AccessTokenProp>;
-        getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
-        createPersonalAccessToken(rawData: CreatePATProps, headers?: RawAxiosRequestHeaders): Promise<AccessTokenProp>;
+        }>): Promise<AccessTokenProps>;
+        getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<AccessTokenProps>>;
+        createPersonalAccessToken(rawData: CreatePATProps, headers?: RawAxiosRequestHeaders): Promise<AccessTokenProps>;
         revoke(params: OptionalDefaults<{
             tokenId: string;
-        }>): Promise<AccessTokenProp>;
-        getManyForOrganization(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
+        }>): Promise<AccessTokenProps>;
+        getManyForOrganization(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<AccessTokenProps>>;
     };
     usage: UsagePlainClientAPI;
     release: {
@@ -287,6 +288,9 @@ export type PlainClientAPI = {
             query?: ReleaseActionQueryOptions;
         }): Promise<CollectionProp<ReleaseActionProps>>;
     };
+    resource: ResourcePlainAPI;
+    resourceProvider: ResourceProviderPlainClientAPI;
+    resourceType: ResourceTypePlainClientAPI;
     role: RolePlainClientAPI;
     scheduledActions: {
         get(params: OptionalDefaults<GetSpaceParams> & {
@@ -327,8 +331,6 @@ export type PlainClientAPI = {
     };
     appDefinition: AppDefinitionPlainClientAPI;
     appInstallation: AppInstallationPlainClientAPI;
-    resourceProvider: ResourceProviderPlainClientAPI;
-    resourceType: ResourceTypePlainClientAPI;
     extension: ExtensionPlainClientAPI;
     webhook: WebhookPlainClientAPI;
     snapshot: {

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

@@ -1,5 +1,5 @@
 import type { PaginationQueryParams, CollectionProp, GetOrganizationParams } from '../../common-types';
-import type { OrganizationProp } from '../../entities/organization';
+import type { OrganizationProps } from '../../entities/organization';
 import type { OptionalDefaults } from '../wrappers/wrap';
 export type OrganizationPlainClientAPI = {
     /**
@@ -16,7 +16,7 @@ export type OrganizationPlainClientAPI = {
      * })
      * ```
      */
-    getAll(params?: OptionalDefaults<PaginationQueryParams>): Promise<CollectionProp<OrganizationProp>>;
+    getAll(params?: OptionalDefaults<PaginationQueryParams>): Promise<CollectionProp<OrganizationProps>>;
     /**
      * Fetch a single organization by its ID
      * @param params the organization ID
@@ -29,5 +29,5 @@ export type OrganizationPlainClientAPI = {
      * })
      * ```
      */
-    get(params: OptionalDefaults<GetOrganizationParams>): Promise<OrganizationProp>;
+    get(params: OptionalDefaults<GetOrganizationParams>): Promise<OrganizationProps>;
 };

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

@@ -1,10 +1,14 @@
 import type { RawAxiosRequestHeaders } from 'axios';
 import type { OptionalDefaults } from '../wrappers/wrap';
-import type { CollectionProp, GetResourceTypeParams } from '../../common-types';
+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.34.0",
+  "version": "11.35.1",
   "description": "Client for Contentful's Content Management API",
   "homepage": "https://www.contentful.com/developers/documentation/content-management-api/",
   "main": "./dist/contentful-management.node.js",