Class UserGrants

Index

Constructors

Methods

list deleteByUserId delete _getAuthorizationHeader

Properties

Constructors

constructor

new UserGrants(_options: UserGrants.Options): UserGrants
Parameters
- _options: UserGrants.Options
Returns UserGrants

Methods

list

list(
request?: Management.ListUserGrantsRequestParameters,
requestOptions?: UserGrants.RequestOptions,
): Promise<Page<UserGrant>>
Retrieve the grants associated with your account.
Parameters
- request: Management.ListUserGrantsRequestParameters = {}
- OptionalrequestOptions: UserGrants.RequestOptions
  Request-specific configuration.
Returns Promise<Page<UserGrant>>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.userGrants.list()
```

deleteByUserId

deleteByUserId(
request: Management.DeleteUserGrantByUserIdRequestParameters,
requestOptions?: UserGrants.RequestOptions,
): HttpResponsePromise<void>
Delete a grant associated with your account.
Parameters
- request: Management.DeleteUserGrantByUserIdRequestParameters
- OptionalrequestOptions: UserGrants.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.userGrants.deleteByUserId({
        user_id: "user_id"
    })
```

delete

delete(
id: string,
requestOptions?: UserGrants.RequestOptions,
): HttpResponsePromise<void>
Delete a grant associated with your account.
Parameters
- id: string
  ID of the grant to delete.
- OptionalrequestOptions: UserGrants.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.userGrants.delete("id")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: UserGrants.Options