Class OutletsApi

Hierarchy (view full)

BaseAPI
- OutletsApi

Index

Constructors

Properties

Methods

Constructors

constructor

new OutletsApi(configuration?): OutletsApi
Parameters
- configuration: Configuration = ...
Returns OutletsApi
Inherited from BaseAPI.constructor
- Defined in cwmsjs/src/runtime.ts:27

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteProjectsOutletsWithName

deleteProjectsOutletsWithName(requestParameters, initOverrides?): Promise<void>
Delete CWMS Outlet Delete projects outlets with name
Parameters
- requestParameters: DeleteProjectsOutletsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/OutletsApi.ts:160

deleteProjectsOutletsWithNameRaw

deleteProjectsOutletsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete CWMS Outlet Delete projects outlets with name
Parameters
- requestParameters: DeleteProjectsOutletsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/OutletsApi.ts:121

deleteProjectsWithOfficeWithProjectIdGateChanges

deleteProjectsWithOfficeWithProjectIdGateChanges(requestParameters, initOverrides?): Promise<void>
Deletes matching CWMS gate change data for a Reservoir Project. Delete projects with office with projectId gateChanges
Parameters
- requestParameters: DeleteProjectsWithOfficeWithProjectIdGateChangesRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/OutletsApi.ts:219

deleteProjectsWithOfficeWithProjectIdGateChangesRaw

deleteProjectsWithOfficeWithProjectIdGateChangesRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Deletes matching CWMS gate change data for a Reservoir Project. Delete projects with office with projectId gateChanges
Parameters
- requestParameters: DeleteProjectsWithOfficeWithProjectIdGateChangesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/OutletsApi.ts:168

deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithName

deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithName(requestParameters, initOverrides?): Promise<void>
Delete CWMS Virtual Outlet Delete projects with office with projectId virtualOutlets with name
Parameters
- requestParameters: DeleteProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/OutletsApi.ts:266

deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRaw

deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete CWMS Virtual Outlet Delete projects with office with projectId virtualOutlets with name
Parameters
- requestParameters: DeleteProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/OutletsApi.ts:227

getProjectsOutlets

getProjectsOutlets(requestParameters, initOverrides?): Promise<Outlet[]>
Returns matching CWMS Outlet Data for a Reservoir Project. Get projects outlets
Parameters
- requestParameters: GetProjectsOutletsRequest
- Optional initOverrides: RequestInit
Returns Promise<Outlet[]>
- Defined in cwmsjs/src/apis/OutletsApi.ts:313

getProjectsOutletsRaw

getProjectsOutletsRaw(requestParameters, initOverrides?): Promise<ApiResponse<Outlet[]>>
Returns matching CWMS Outlet Data for a Reservoir Project. Get projects outlets
Parameters
- requestParameters: GetProjectsOutletsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Outlet[]>>
- Defined in cwmsjs/src/apis/OutletsApi.ts:274

getProjectsOutletsWithName

getProjectsOutletsWithName(requestParameters, initOverrides?): Promise<Outlet>
Returns CWMS Outlet Data Get projects outlets with name
Parameters
- requestParameters: GetProjectsOutletsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<Outlet>
- Defined in cwmsjs/src/apis/OutletsApi.ts:357

getProjectsOutletsWithNameRaw

getProjectsOutletsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<Outlet>>
Returns CWMS Outlet Data Get projects outlets with name
Parameters
- requestParameters: GetProjectsOutletsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Outlet>>
- Defined in cwmsjs/src/apis/OutletsApi.ts:322

getProjectsWithOfficeWithProjectIdGateChanges

getProjectsWithOfficeWithProjectIdGateChanges(requestParameters, initOverrides?): Promise<GateChange[]>
Returns matching CWMS gate change data for a Reservoir Project. Get projects with office with projectId gateChanges
Parameters
- requestParameters: GetProjectsWithOfficeWithProjectIdGateChangesRequest
- Optional initOverrides: RequestInit
Returns Promise<GateChange[]>
- Defined in cwmsjs/src/apis/OutletsApi.ts:429

getProjectsWithOfficeWithProjectIdGateChangesRaw

getProjectsWithOfficeWithProjectIdGateChangesRaw(requestParameters, initOverrides?): Promise<ApiResponse<GateChange[]>>
Returns matching CWMS gate change data for a Reservoir Project. Get projects with office with projectId gateChanges
Parameters
- requestParameters: GetProjectsWithOfficeWithProjectIdGateChangesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<GateChange[]>>
- Defined in cwmsjs/src/apis/OutletsApi.ts:366

getProjectsWithOfficeWithProjectIdVirtualOutlets

getProjectsWithOfficeWithProjectIdVirtualOutlets(requestParameters, initOverrides?): Promise<VirtualOutlet[]>
Returns matching CWMS Virtual Outlet Data for a Reservoir Project. Get projects with office with projectId virtualOutlets
Parameters
- requestParameters: GetProjectsWithOfficeWithProjectIdVirtualOutletsRequest
- Optional initOverrides: RequestInit
Returns Promise<VirtualOutlet[]>
- Defined in cwmsjs/src/apis/OutletsApi.ts:469

getProjectsWithOfficeWithProjectIdVirtualOutletsRaw

getProjectsWithOfficeWithProjectIdVirtualOutletsRaw(requestParameters, initOverrides?): Promise<ApiResponse<VirtualOutlet[]>>
Returns matching CWMS Virtual Outlet Data for a Reservoir Project. Get projects with office with projectId virtualOutlets
Parameters
- requestParameters: GetProjectsWithOfficeWithProjectIdVirtualOutletsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<VirtualOutlet[]>>
- Defined in cwmsjs/src/apis/OutletsApi.ts:438

getProjectsWithOfficeWithProjectIdVirtualOutletsWithName

getProjectsWithOfficeWithProjectIdVirtualOutletsWithName(requestParameters, initOverrides?): Promise<VirtualOutlet>
Returns CWMS Virtual Outlet Data Get projects with office with projectId virtualOutlets with name
Parameters
- requestParameters: GetProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<VirtualOutlet>
- Defined in cwmsjs/src/apis/OutletsApi.ts:513

getProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRaw

getProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<VirtualOutlet>>
Returns CWMS Virtual Outlet Data Get projects with office with projectId virtualOutlets with name
Parameters
- requestParameters: GetProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<VirtualOutlet>>
- Defined in cwmsjs/src/apis/OutletsApi.ts:478

patchProjectsOutletsWithName

patchProjectsOutletsWithName(requestParameters, initOverrides?): Promise<void>
Rename CWMS Outlet Patch projects outlets with name
Parameters
- requestParameters: PatchProjectsOutletsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/OutletsApi.ts:565

patchProjectsOutletsWithNameRaw

patchProjectsOutletsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Rename CWMS Outlet Patch projects outlets with name
Parameters
- requestParameters: PatchProjectsOutletsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/OutletsApi.ts:522

postProjectsGateChanges

postProjectsGateChanges(requestParameters, initOverrides?): Promise<void>
Create CWMS Gate Changes Post projects gateChanges
Parameters
- requestParameters: PostProjectsGateChangesRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/OutletsApi.ts:607

postProjectsGateChangesRaw

postProjectsGateChangesRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create CWMS Gate Changes Post projects gateChanges
Parameters
- requestParameters: PostProjectsGateChangesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/OutletsApi.ts:573

postProjectsOutlets

postProjectsOutlets(requestParameters, initOverrides?): Promise<void>
Create CWMS Outlet Post projects outlets
Parameters
- requestParameters: PostProjectsOutletsRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/OutletsApi.ts:649

postProjectsOutletsRaw

postProjectsOutletsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create CWMS Outlet Post projects outlets
Parameters
- requestParameters: PostProjectsOutletsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/OutletsApi.ts:615

postProjectsVirtualOutlets

postProjectsVirtualOutlets(requestParameters, initOverrides?): Promise<void>
Create CWMS Virtual Outlet Post projects virtualOutlets
Parameters
- requestParameters: PostProjectsVirtualOutletsRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/OutletsApi.ts:691

postProjectsVirtualOutletsRaw

postProjectsVirtualOutletsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create CWMS Virtual Outlet Post projects virtualOutlets
Parameters
- requestParameters: PostProjectsVirtualOutletsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/OutletsApi.ts:657

`Protected` request

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

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in cwmsjs/src/runtime.ts:31

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in cwmsjs/src/runtime.ts:42

withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in cwmsjs/src/runtime.ts:37

Class OutletsApi

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OutletsApi

Properties

Protected configuration

Methods

deleteProjectsOutletsWithName

Parameters

Returns Promise<void>

deleteProjectsOutletsWithNameRaw

Parameters

Returns Promise<ApiResponse<void>>

deleteProjectsWithOfficeWithProjectIdGateChanges

Parameters

Returns Promise<void>

deleteProjectsWithOfficeWithProjectIdGateChangesRaw

Parameters

Returns Promise<ApiResponse<void>>

deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithName

Parameters

Returns Promise<void>

deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRaw

Parameters

Returns Promise<ApiResponse<void>>

getProjectsOutlets

Parameters

Returns Promise<Outlet[]>

getProjectsOutletsRaw

Parameters

Returns Promise<ApiResponse<Outlet[]>>

getProjectsOutletsWithName

Parameters

Returns Promise<Outlet>

getProjectsOutletsWithNameRaw

Parameters

Returns Promise<ApiResponse<Outlet>>

getProjectsWithOfficeWithProjectIdGateChanges

Parameters

Returns Promise<GateChange[]>

getProjectsWithOfficeWithProjectIdGateChangesRaw

Parameters

Returns Promise<ApiResponse<GateChange[]>>

getProjectsWithOfficeWithProjectIdVirtualOutlets

Parameters

Returns Promise<VirtualOutlet[]>

getProjectsWithOfficeWithProjectIdVirtualOutletsRaw

Parameters

Returns Promise<ApiResponse<VirtualOutlet[]>>

getProjectsWithOfficeWithProjectIdVirtualOutletsWithName

Parameters

Returns Promise<VirtualOutlet>

getProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRaw

Parameters

Returns Promise<ApiResponse<VirtualOutlet>>

patchProjectsOutletsWithName

Parameters

Returns Promise<void>

patchProjectsOutletsWithNameRaw

Parameters

Returns Promise<ApiResponse<void>>

postProjectsGateChanges

Parameters

Returns Promise<void>

postProjectsGateChangesRaw

Parameters

Returns Promise<ApiResponse<void>>

postProjectsOutlets

Parameters

Returns Promise<void>

postProjectsOutletsRaw

Parameters

Returns Promise<ApiResponse<void>>

postProjectsVirtualOutlets

`Protected` configuration

`Protected` request