UNPKG

1.83 kBTypeScriptView Raw
1import type { MetaSysProps, DefaultElements, MakeRequest } from '../common-types';
2export type PersonalAccessTokenProp = {
3 sys: MetaSysProps & {
4 expiresAt?: string;
5 };
6 name: string;
7 scopes: 'content_management_manage'[];
8 revokedAt: null | string;
9 token?: string;
10};
11export type CreatePersonalAccessTokenProps = Pick<PersonalAccessToken, 'name' | 'scopes'> & {
12 expiresIn?: number;
13};
14export interface PersonalAccessToken extends PersonalAccessTokenProp, DefaultElements<PersonalAccessTokenProp> {
15 /**
16 * Revokes a personal access token
17 * @return Object the revoked personal access token
18 * @example ```javascript
19 * const contentful = require('contentful-management')
20 *
21 * const client = contentful.createClient({
22 * accessToken: <content_management_api_key>
23 * })
24 *
25 * client.getPersonalAccessToken('<token-id>')
26 * .then((personalAccessToken) => {
27 * return personalAccessToken.revoke()
28 * })
29 * .catch(console.error)
30 * ```
31 */
32 revoke(): Promise<PersonalAccessToken>;
33}
34/**
35 * @private
36 * @param makeRequest - function to make requests via an adapter
37 * @param data - Raw personal access token data
38 * @return Wrapped personal access token
39 */
40export declare function wrapPersonalAccessToken(makeRequest: MakeRequest, data: PersonalAccessTokenProp): PersonalAccessToken;
41/**
42 * @private
43 * @param makeRequest - function to make requests via an adapter
44 * @param data - Raw personal access collection data
45 * @return Wrapped personal access token collection data
46 */
47export declare const wrapPersonalAccessTokenCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<PersonalAccessTokenProp>) => import("../common-types").Collection<PersonalAccessToken, PersonalAccessTokenProp>;