contentful-management 11.45.1 → 11.46.0

package/dist/typings/contentful-management.d.ts

@@ -17,6 +17,8 @@ export { isDraft, isPublished, isUpdated } from './plain/checks';
 export type { PlainClientAPI } from './plain/common-types';
 export { createClient };
 export { RestAdapter } from './adapters/REST/rest-adapter';
+export type { RestAdapterParams } from './adapters/REST/rest-adapter';
+export { makeRequest } from './adapters/REST/make-request';
 export { editorInterfaceDefaults };
 export type PlainClientDefaultParams = DefaultParams;
 export * from './export-types';

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

@@ -1,4 +1,4 @@
-import type { Collection, MakeRequest, PaginationQueryParams, QueryOptions, QueryParams, GetAppDefinitionParams, CursorPaginatedCollection, GetEnvironmentTemplateParams, BasicCursorPaginationOptions } from './common-types';
+import type { Collection, MakeRequest, PaginationQueryParams, QueryOptions, QueryParams, GetAppDefinitionParams, CursorPaginatedCollection, GetEnvironmentTemplateParams, BasicCursorPaginationOptions, GetOAuthApplicationParams, GetUserParams } from './common-types';
 import type { Organization, OrganizationProps } from './entities/organization';
 import type { CreatePersonalAccessTokenProps } from './entities/personal-access-token';
 import type { Space, SpaceProps } from './entities/space';
@@ -7,6 +7,7 @@ import type { UsageQuery } from './entities/usage';
 import type { UserProps } from './entities/user';
 import type { CreateEnvironmentTemplateProps, EnvironmentTemplate, EnvironmentTemplateProps } from './entities/environment-template';
 import type { RawAxiosRequestConfig } from 'axios';
+import type { CreateOAuthApplicationProps, OAuthApplication, OAuthApplicationProps } from './export-types';
 export type ClientAPI = ReturnType<typeof createClientApi>;
 type CreateSpaceProps = Omit<SpaceProps, 'sys'> & {
     defaultLocale?: string;
@@ -182,6 +183,61 @@ export default function createClientApi(makeRequest: MakeRequest): {
      * ```
      */
     getCurrentUser: <T = UserProps>(params?: QueryParams) => Promise<T>;
+    /**
+     *
+     * @param params
+     * @returns Promise of a OAuthApplication
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *  accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getOAuthApplication({
+     * userId: '<user_id>'
+     * oauthApplicationId: '<oauth_application_id>'
+     * }).then(oauthApplication => console.log(oauthApplication))
+     * .catch(console.error)
+     */
+    getOAuthApplication: (params: GetOAuthApplicationParams) => Promise<OAuthApplicationProps>;
+    /**
+     *
+     * @param params
+     * @returns Promise of list of user's OAuthApplications
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *  accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getOAuthApplications({
+     * userId: '<user_id>'}).then(oauthApplications => console.log(oauthApplications))
+     * .catch(console.error)
+     */
+    getOAuthApplications: (params: GetUserParams & QueryParams) => Promise<CursorPaginatedCollection<OAuthApplication, OAuthApplicationProps>>;
+    /**
+     *
+     * @param params
+     * @returns Promise of a new OAuth application.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *  accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.createOAuthApplication({
+     * userId: '<user_id>'},
+     * { name: '<name>',
+     *   description: '<description>',
+     *   scopes: ['scope'],
+     *   redirectUri: '<redirectUri>',
+     *   confidential: '<true/false>'}).then(oauthApplications => console.log(oauthApplications))
+     * .catch(console.error)
+     */
+    createOAuthApplication: (params: GetUserParams, rawData: CreateOAuthApplicationProps) => Promise<OAuthApplicationProps>;
     /**
      * Gets App Definition
      * @return Promise for App Definition
@@ -223,7 +279,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    createPersonalAccessToken: (data: CreatePersonalAccessTokenProps) => Promise<import("./entities/personal-access-token").PersonalAccessToken>;
+    createPersonalAccessToken: (data: CreatePersonalAccessTokenProps) => Promise<import("./export-types").PersonalAccessToken>;
     /**
      * @deprecated - use getAccessToken instead
      *
@@ -242,7 +298,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getPersonalAccessToken: (tokenId: string) => Promise<import("./entities/personal-access-token").PersonalAccessToken>;
+    getPersonalAccessToken: (tokenId: string) => Promise<import("./export-types").PersonalAccessToken>;
     /**
      * @deprecated - use getAccessTokens instead
      *
@@ -260,7 +316,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getPersonalAccessTokens: () => Promise<Collection<import("./entities/personal-access-token").PersonalAccessToken, import("./entities/personal-access-token").PersonalAccessTokenProps>>;
+    getPersonalAccessTokens: () => Promise<Collection<import("./export-types").PersonalAccessToken, import("./export-types").PersonalAccessTokenProps>>;
     /**
      * Gets a users access token
      * @param data - users access token config
@@ -335,7 +391,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getOrganizationUsage: (organizationId: string, query?: QueryOptions) => Promise<Collection<import("./entities/usage").Usage, import("./entities/usage").UsageProps>>;
+    getOrganizationUsage: (organizationId: string, query?: QueryOptions) => Promise<Collection<import("./export-types").Usage, import("./export-types").UsageProps>>;
     /**
      * Get organization usage grouped by space and metric
      *
@@ -361,7 +417,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getSpaceUsage: (organizationId: string, query?: UsageQuery) => Promise<Collection<import("./entities/usage").Usage, import("./entities/usage").UsageProps>>;
+    getSpaceUsage: (organizationId: string, query?: UsageQuery) => Promise<Collection<import("./export-types").Usage, import("./export-types").UsageProps>>;
     /**
      * Make a custom request to the Contentful management API's /spaces endpoint
      * @param opts - axios request options (https://github.com/mzabriskie/axios)

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

@@ -26,6 +26,7 @@ import * as extension from './extension';
 import * as func from './function';
 import * as functionLog from './function-log';
 import * as locale from './locale';
+import * as oauthApplication from './oauth-application';
 import * as organization from './organization';
 import * as organizationInvitation from './organization-invitation';
 import * as organizationMembership from './organization-membership';
@@ -89,6 +90,7 @@ declare const _default: {
     func: typeof func;
     functionLog: typeof functionLog;
     locale: typeof locale;
+    oauthApplication: typeof oauthApplication;
     organization: typeof organization;
     organizationInvitation: typeof organizationInvitation;
     organizationMembership: typeof organizationMembership;

package/dist/typings/entities/oauth-application.d.ts

@@ -0,0 +1,56 @@
+import type { BasicMetaSysProps, DefaultElements, MakeRequest } from '../common-types';
+type OAuthApplicationSysProps = BasicMetaSysProps & {
+    lastUsedAt: string | null;
+};
+export declare enum ScopeValues {
+    Read = "content_management_read",
+    Manage = "content_management_manage"
+}
+export type OAuthApplicationProps = {
+    name: string;
+    description: string;
+    clientId: string;
+    clientSecret: string;
+    redirectUri: string;
+    scopes: ScopeValues[];
+    confidential: boolean;
+    sys: OAuthApplicationSysProps;
+};
+export type CreateOAuthApplicationProps = {
+    name: string;
+    description: string;
+    redirectUri: string;
+    scopes: ScopeValues[];
+    confidential: boolean;
+};
+export type UpdateOAuthApplicationProps = {
+    name?: string;
+    description?: string;
+    redirectUri?: string;
+    scopes?: ScopeValues[];
+    confidential?: boolean;
+};
+export interface OAuthApplication extends OAuthApplicationProps, DefaultElements<OAuthApplicationProps> {
+    /**
+     * Deletes an OAuth application
+     * @return Promise for the deleted OAuth application
+     */
+    delete(): Promise<void>;
+    /**
+     * Updates an OAuth application
+     * @return Promise for the updated OAuth application
+     */
+    update(): Promise<OAuthApplicationProps>;
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw OAuth application data
+ * @return Wrapped OAuth application data
+ */
+export declare function wrapOAuthApplication(makeRequest: MakeRequest, data: OAuthApplicationProps, userId: string): OAuthApplication;
+/**
+ * @private
+ */
+export declare const wrapOAuthApplicationCollection: (makeRequest: MakeRequest, data: import("../common-types").CursorPaginatedCollectionProp<OAuthApplicationProps>, userId: string) => import("../common-types").CursorPaginatedCollection<OAuthApplication, OAuthApplicationProps>;
+export {};

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

@@ -30,6 +30,7 @@ export type { FieldType } from './entities/field-type';
 export type { FunctionProps } from './entities/function';
 export type { CreateLocaleProps, Locale, LocaleProps } from './entities/locale';
 export type { Organization, OrganizationProp, OrganizationProps } from './entities/organization';
+export type { OAuthApplication, OAuthApplicationProps, CreateOAuthApplicationProps, } from './entities/oauth-application';
 export type { CreateOrganizationInvitationProps, OrganizationInvitation, OrganizationInvitationProps, } from './entities/organization-invitation';
 export type { OrganizationMembership, OrganizationMembershipProps, } from './entities/organization-membership';
 export type { CreatePersonalAccessTokenProps, PersonalAccessToken, PersonalAccessTokenProp, PersonalAccessTokenProps, } from './entities/personal-access-token';

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

@@ -63,6 +63,7 @@ import type { WorkflowPlainClientAPI } from './entities/workflow';
 import type { WorkflowDefinitionPlainClientAPI } from './entities/workflow-definition';
 import type { WorkflowsChangelogPlainClientAPI } from './entities/workflows-changelog';
 import type { DefaultParams, OptionalDefaults } from './wrappers/wrap';
+import type { OAuthApplicationPlainClientAPI } from './entities/oauth-application';
 import type { FunctionLogPlainClientAPI } from './entities/function-log';
 export type PlainClientAPI = {
     raw: {
@@ -377,4 +378,5 @@ export type PlainClientAPI = {
     workflowDefinition: WorkflowDefinitionPlainClientAPI;
     workflow: WorkflowPlainClientAPI;
     workflowsChangelog: WorkflowsChangelogPlainClientAPI;
+    oauthApplication: OAuthApplicationPlainClientAPI;
 };

package/dist/typings/plain/entities/oauth-application.d.ts

@@ -0,0 +1,90 @@
+import type { RawAxiosRequestHeaders } from 'axios';
+import type { GetOAuthApplicationParams, QueryParams, CursorPaginatedCollectionProp, GetUserParams } from '../../common-types';
+import type { OptionalDefaults } from '../wrappers/wrap';
+import type { CreateOAuthApplicationProps, OAuthApplicationProps, UpdateOAuthApplicationProps } from '../../entities/oauth-application';
+export type OAuthApplicationPlainClientAPI = {
+    /**
+     * Retrieves a list of OAuth applications associated with the current user.
+     * @param userId the user ID
+     * @returns A collection of oauth applications
+     * @throws if the request fails, or the user is not found
+     * @example
+     * ```javascript
+     * const oauthApplication = await client.oauthApplication.getManyForUser({
+     *  userId: '<user_id>',
+     *   query: {
+     *     limit: 10,
+     *   }
+     * })
+     * ```
+     */
+    getManyForUser(params: OptionalDefaults<GetUserParams & QueryParams>): Promise<CursorPaginatedCollectionProp<OAuthApplicationProps>>;
+    /**
+     * Retrieves details of a specific OAuth application.
+     * @param userId the user ID
+     * @param oauthApplicationId the OAuth application ID
+     * @returns the requested OAuth Application
+     * @throws if the request fails, or the OAuth Application or user are not found
+     * @example
+     * ```javascript
+     * const oauthApplication = await client.oauthApplication.get({
+     *   userId: '<user_id>',
+     *   oauthApplicationId: '<oauth_application_id>'
+     * })
+     * ```
+     */
+    get(params: OptionalDefaults<GetOAuthApplicationParams>): Promise<OAuthApplicationProps>;
+    /**
+     * Creates a new OAuth application.
+     * @param userId the user ID
+     * @param rawData the oauth application payload
+     * @returns the created OAuth Application
+     * @throws if the request fails, or the user is not found
+     * @example
+     * ```javascript
+     * const oauthApplication = await client.oauthApplication.create({
+     *   userId: '<user_id>',
+     * }, {
+     *   name: 'Test-Name',
+     *   description: 'Test-Desc',
+     *   scopes: ['content_management_manage'],
+     *   redirectUri: 'https://redirect.uri.com',
+     *   confidential: true
+     * }
+     * ```
+     */
+    create(params: OptionalDefaults<GetUserParams>, rawData: CreateOAuthApplicationProps, headers?: RawAxiosRequestHeaders): Promise<OAuthApplicationProps>;
+    /**
+     * Updates details of a specific OAuth application.
+     * @param params the user and oauth application IDs
+     * @param rawData the oauth application payload
+     * @returns the updated oauth application
+     * @throws if the request fails, or the user or oauth application are not found
+     * @example
+     * ```javascript
+     *
+     * const oauthApplication = await client.oauthApplication.update({
+     *   userId: '<user_id>',
+     *   oauthApplicationId: '<oauth_application_id>'
+     * }, {
+     *   ...oauthApplication,
+     *   name: 'Update Test-Name',
+     *   description: 'Update Test-Desc',
+     * })
+     * ```
+     */
+    update(params: OptionalDefaults<GetOAuthApplicationParams>, rawData: UpdateOAuthApplicationProps, headers?: RawAxiosRequestHeaders): Promise<OAuthApplicationProps>;
+    /**
+     * Deletes a specific OAuth application.
+     * @param params the user and oauth application IDs
+     * @throws if the request fails, or the user or oauth application are not found
+     * @example
+     * ```javascript
+     * await client.oauthApplication.delete({
+     *   userId: '<user_id>',
+     *   oauthApplicationId: '<oauth_application_id>'
+     * })
+     * ```
+     */
+    delete(params: OptionalDefaults<GetOAuthApplicationParams>): Promise<void>;
+};

package/package.json

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