UNPKG

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