ClientGrantsManager

Index

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration

Methods

create

create(bodyParameters, initOverrides?): Promise<ApiResponse<ClientGrant>>
Create a client grant. Create client grant

Throws
Parameters
- bodyParameters: ClientGrantCreate
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<ClientGrant>>
- Defined in src/management/__generated/managers/client-grants-manager.ts:139

delete

delete(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete a client grant. Delete client grant

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

getAll

getAll(requestParameters, initOverrides?): Promise<ApiResponse<GetClientGrants200ResponseOneOf>>
Retrieve client grants.

Get client grants

Throws
Parameters
- requestParameters: GetClientGrantsRequest & {
  include_totals: true;
  }
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetClientGrants200ResponseOneOf>>
- Defined in src/management/__generated/managers/client-grants-manager.ts:53
getAll(requestParameters?, initOverrides?): Promise<ApiResponse<ClientGrant[]>>
Parameters
- Optional requestParameters: GetClientGrantsRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<ClientGrant[]>>
- Defined in src/management/__generated/managers/client-grants-manager.ts:57

`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

update

update(requestParameters, bodyParameters, initOverrides?): Promise<ApiResponse<ClientGrant>>
Update a client grant. Update client grant

Throws
Parameters
- requestParameters: PatchClientGrantsByIdOperationRequest
- bodyParameters: PatchClientGrantsByIdRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<ClientGrant>>
- Defined in src/management/__generated/managers/client-grants-manager.ts:106

Class ClientGrantsManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration

Returns ClientGrantsManager

Properties

Protected configuration

Methods

create

Throws

Parameters

bodyParameters: ClientGrantCreate

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<ClientGrant>>

delete

Throws

Parameters

requestParameters: DeleteClientGrantsByIdRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<void>>

getAll

Throws

Parameters

requestParameters: GetClientGrantsRequest & { include_totals: true; }

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<GetClientGrants200ResponseOneOf>>

Parameters

Optional requestParameters: GetClientGrantsRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<ClientGrant[]>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

update

Throws

Parameters

requestParameters: PatchClientGrantsByIdOperationRequest

bodyParameters: PatchClientGrantsByIdRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<ClientGrant>>

Settings

Member Visibility

Theme

On This Page

`Protected` configuration

`Optional` initOverrides: InitOverride

`Optional` initOverrides: InitOverride

requestParameters: GetClientGrantsRequest & {
include_totals: true;
}

`Optional` initOverrides: InitOverride

`Optional` requestParameters: GetClientGrantsRequest

`Optional` initOverrides: InitOverride

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: InitOverride