contentful-management 11.35.1 → 11.36.0

package/dist/es-modules/contentful-management.js

@@ -46,7 +46,7 @@ function createClient(params, opts = {}) {
   const sdkMain = opts.type === 'plain' ? 'contentful-management-plain.js' : 'contentful-management.js';
   const userAgent = getUserAgentHeader(
   // @ts-expect-error
-  `${sdkMain}/${"11.35.1"}`, params.application, params.integration, params.feature);
+  `${sdkMain}/${"11.36.0"}`, params.application, params.integration, params.feature);
   const adapter = createAdapter(_objectSpread(_objectSpread({}, params), {}, {
     userAgent
   }));

package/dist/es-modules/create-environment-api.js

@@ -1239,14 +1239,17 @@ export default function createEnvironmentApi(makeRequest) {
      * .catch(console.error)
      * ```
      */
-    getLocales() {
+    getLocales(query = {}) {
       const raw = this.toPlainObject();
       return makeRequest({
         entityType: 'Locale',
         action: 'getMany',
         params: {
           spaceId: raw.sys.space.sys.id,
-          environmentId: raw.sys.id
+          environmentId: raw.sys.id,
+          query: createRequestConfig({
+            query
+          }).params
         }
       }).then(data => wrapLocaleCollection(makeRequest, data));
     },

package/dist/typings/create-environment-api.d.ts

@@ -843,7 +843,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getLocales(): Promise<import("./common-types").Collection<import("./entities/locale").Locale, import("./entities/locale").LocaleProps>>;
+    getLocales(query?: BasicQueryOptions): Promise<import("./common-types").Collection<import("./entities/locale").Locale, import("./entities/locale").LocaleProps>>;
     /**
      * Creates a Locale
      * @param data - Object representation of the Locale to be created

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

@@ -4,10 +4,10 @@ import type { UpsertResourceProviderProps, ResourceProviderProps } from '../../e
 import type { OptionalDefaults } from '../wrappers/wrap';
 export type ResourceProviderPlainClientAPI = {
     /**
-     * Fetch a Resource Provider
+     * Fetches a Resource Provider
      * @param params entity IDs to identify the Resource Provider
-     * @returns the App Definition config
-     * @throws if the request fails, or the Resource Provider is not found
+     * @returns the Resource Provider
+     * @throws if the request fails or the Resource Provider is not found
      * @example
      * ```javascript
      * const resourceProvider = await client.resourceProvider.get({
@@ -18,15 +18,17 @@ export type ResourceProviderPlainClientAPI = {
      */
     get(params: OptionalDefaults<GetResourceProviderParams>): Promise<ResourceProviderProps>;
     /**
-     * Creates or updates a Resource Provider
+     * Creates a Resource Provider
      * @param params entity IDs to identify the Resource Provider
-     * @param rawData the ResourceProvider
-     * @returns the created or updated Resource Provider
-     * @throws if the request fails, the App Definition or Resource Provider is not found, or the payload is malformed
+     * @param rawData the Resource Provider data
+     * @returns the created Resource Provider
+     * @throws if the request fails, the App Definition is not found,
+     * a Resource Provider associated with the organization and app definition already exists,
+     * or the payload is malformed
      * @example
      * ```javascript
-     * // You need a valid AppDefinition with an activated AppBundle that has a contentful function configured
-     * const appInstallation = await client.resourceProvider.upsert(
+     * // You need a valid AppDefinition with an activated AppBundle that has a configured Contentful function
+     * const resourceProvider = await client.resourceProvider.upsert(
      *   {
      *     organizationId: '<organization_id>',
      *     appDefinitionId: '<app_definition_id>',
@@ -41,9 +43,10 @@ export type ResourceProviderPlainClientAPI = {
      */
     upsert(params: OptionalDefaults<GetResourceProviderParams>, rawData: UpsertResourceProviderProps, headers?: RawAxiosRequestHeaders): Promise<ResourceProviderProps>;
     /**
-     * Delete a ResourceProvider
+     * Deletes a ResourceProvider
      * @param params entity IDs to identify the Resource Provider
-     * @throws if the request fails, or the Resource Provider is not found
+     * @throws if the request fails, the Resource Provider is not found
+     * or the Resource Provider is associated with an existing Resource Type
      * @example
      * ```javascript
      * await client.resourceProvider.delete({

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

@@ -3,17 +3,19 @@ import type { CursorPaginatedCollectionProp, GetResourceParams } from '../../com
 import type { ResourceProps, ResourceQueryOptions } from '../../entities/resource';
 export type ResourcePlainAPI = {
     /**
-     * Fetch Resources
+     * Fetches all Resources.
+     * Supports fetching specific Resources by URNs or searching by a text query.
      * @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
+     * @params optional query params for search or lookup events
+     * @returns the Resources collection
+     * @throws if the request fails or the Resource Type is not found
      * @example
      * ```javascript
      * // Lookup example
-     * const resourceProvider = await client.resource.getMany({
+     * const resources = await client.resource.getMany({
      *   spaceId: '<space_id>',
      *   environmentId: '<environment_id>',
-     *   resourceTypeId: '<resource_type_id>',
+     *   resourceTypeId: '<resource_provider_id>:<resource_type_name>',
      *   query: {
      *     'sys.urn[in]': '<resource_urn1>,<resource_urn2>',
      *     limit': <number>,
@@ -21,10 +23,10 @@ export type ResourcePlainAPI = {
      * });
      *
      * // Search example
-     * const resourceProvider = await client.resource.getMany({
+     * const resources = await client.resource.getMany({
      *   spaceId: '<space_id>',
      *   environmentId: '<environment_id>',
-     *   resourceTypeId: '<resource_type_id>',
+     *   resourceTypeId: '<resource_provider_id>:<resource_type_name>',
      *   query: {
      *     'query': 'text',
      *     'limit': <number>,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-management",
-  "version": "11.35.1",
+  "version": "11.36.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",