GrantsManager

Index

Constructors

constructor

new GrantsManager(configuration): GrantsManager
Parameters
- configuration: Configuration
Returns GrantsManager
Inherited from BaseAPI.constructor
- Defined in src/lib/runtime.ts:24

Properties

`Protected` configuration

configuration: Configuration

Methods

delete

delete(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete a grant associated with your account. Delete a grant by id

Throws
Parameters
- requestParameters: DeleteGrantsByIdRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<void>>
- Defined in src/management/__generated/managers/grants-manager.ts:24

deleteByUserId

deleteByUserId(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete a grant associated with your account. Delete a grant by user_id

Throws
Parameters
- requestParameters: DeleteGrantsByUserIdRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<void>>
- Defined in src/management/__generated/managers/grants-manager.ts:47

getAll

getAll(requestParameters, initOverrides?): Promise<ApiResponse<GetGrants200ResponseOneOf>>
Retrieve the grants associated with your account. Get grants

Throws
Parameters
- requestParameters: GetGrantsRequest & {
  include_totals: true;
  }
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetGrants200ResponseOneOf>>
- Defined in src/management/__generated/managers/grants-manager.ts:78
getAll(requestParameters?, initOverrides?): Promise<ApiResponse<UserGrant[]>>
Parameters
- Optional requestParameters: GetGrantsRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<UserGrant[]>>
- Defined in src/management/__generated/managers/grants-manager.ts:82

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in src/lib/runtime.ts:40

Class GrantsManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration

Returns GrantsManager

Properties

Protected configuration

Methods

delete

Throws

Parameters

requestParameters: DeleteGrantsByIdRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<void>>

deleteByUserId

Throws

Parameters

requestParameters: DeleteGrantsByUserIdRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<void>>

getAll

Throws

Parameters

requestParameters: GetGrantsRequest & { include_totals: true; }

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<GetGrants200ResponseOneOf>>

Parameters

Optional requestParameters: GetGrantsRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<UserGrant[]>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

Settings

Member Visibility

Theme

On This Page

`Protected` configuration

`Optional` initOverrides: InitOverride

`Optional` initOverrides: InitOverride

requestParameters: GetGrantsRequest & {
include_totals: true;
}

`Optional` initOverrides: InitOverride

`Optional` requestParameters: GetGrantsRequest

`Optional` initOverrides: InitOverride

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction