Class TurbinesApi

Hierarchy (view full)

BaseAPI
- TurbinesApi

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteProjectsTurbinesWithName

deleteProjectsTurbinesWithName(requestParameters, initOverrides?): Promise<void>
Delete CWMS Turbine Delete cwmsData projects turbines with name
Parameters
- requestParameters: DeleteProjectsTurbinesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:144

deleteProjectsTurbinesWithNameRaw

deleteProjectsTurbinesWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete CWMS Turbine Delete cwmsData projects turbines with name
Parameters
- requestParameters: DeleteProjectsTurbinesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:99

deleteProjectsWithOfficeWithNameTurbineChanges

deleteProjectsWithOfficeWithNameTurbineChanges(requestParameters, initOverrides?): Promise<void>
Delete CWMS Turbine Changes Delete cwmsData projects with office with name turbineChanges
Parameters
- requestParameters: DeleteProjectsWithOfficeWithNameTurbineChangesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:215

deleteProjectsWithOfficeWithNameTurbineChangesRaw

deleteProjectsWithOfficeWithNameTurbineChangesRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete CWMS Turbine Changes Delete cwmsData projects with office with name turbineChanges
Parameters
- requestParameters: DeleteProjectsWithOfficeWithNameTurbineChangesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:152

getProjectsTurbines

getProjectsTurbines(requestParameters, initOverrides?): Promise<Turbine[]>
Returns matching CWMS Turbine Data for a Reservoir Project. Get cwmsData projects turbines
Parameters
- requestParameters: GetProjectsTurbinesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Turbine[]>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:268

getProjectsTurbinesRaw

getProjectsTurbinesRaw(requestParameters, initOverrides?): Promise<ApiResponse<Turbine[]>>
Returns matching CWMS Turbine Data for a Reservoir Project. Get cwmsData projects turbines
Parameters
- requestParameters: GetProjectsTurbinesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Turbine[]>>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:223

getProjectsTurbinesWithName

getProjectsTurbinesWithName(requestParameters, initOverrides?): Promise<Turbine>
Returns CWMS Turbine Data Get cwmsData projects turbines with name
Parameters
- requestParameters: GetProjectsTurbinesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Turbine>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:318

getProjectsTurbinesWithNameRaw

getProjectsTurbinesWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<Turbine>>
Returns CWMS Turbine Data Get cwmsData projects turbines with name
Parameters
- requestParameters: GetProjectsTurbinesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Turbine>>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:277

getProjectsWithOfficeWithNameTurbineChanges

getProjectsWithOfficeWithNameTurbineChanges(requestParameters, initOverrides?): Promise<TurbineChange[]>
Returns matching CWMS Turbine Change Data for a Reservoir Project. Get cwmsData projects with office with name turbineChanges
Parameters
- requestParameters: GetProjectsWithOfficeWithNameTurbineChangesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<TurbineChange[]>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:402

getProjectsWithOfficeWithNameTurbineChangesRaw

getProjectsWithOfficeWithNameTurbineChangesRaw(requestParameters, initOverrides?): Promise<ApiResponse<TurbineChange[]>>
Returns matching CWMS Turbine Change Data for a Reservoir Project. Get cwmsData projects with office with name turbineChanges
Parameters
- requestParameters: GetProjectsWithOfficeWithNameTurbineChangesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<TurbineChange[]>>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:327

`Protected` isJsonMime

isJsonMime(mime): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in cwmsjs/src/runtime.ts:127

patchProjectsTurbinesWithName

patchProjectsTurbinesWithName(requestParameters, initOverrides?): Promise<void>
Rename CWMS Turbine Patch cwmsData projects turbines with name
Parameters
- requestParameters: PatchProjectsTurbinesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:463

patchProjectsTurbinesWithNameRaw

patchProjectsTurbinesWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Rename CWMS Turbine Patch cwmsData projects turbines with name
Parameters
- requestParameters: PatchProjectsTurbinesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:411

postProjectsTurbines

postProjectsTurbines(requestParameters, initOverrides?): Promise<void>
Create CWMS Turbine Post cwmsData projects turbines
Parameters
- requestParameters: PostProjectsTurbinesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:508

postProjectsTurbinesRaw

postProjectsTurbinesRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create CWMS Turbine Post cwmsData projects turbines
Parameters
- requestParameters: PostProjectsTurbinesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:471

postProjectsWithOfficeWithNameTurbineChanges

postProjectsWithOfficeWithNameTurbineChanges(requestParameters, initOverrides?): Promise<void>
Create CWMS Turbine Changes Post cwmsData projects with office with name turbineChanges
Parameters
- requestParameters: PostProjectsWithOfficeWithNameTurbineChangesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:567

postProjectsWithOfficeWithNameTurbineChangesRaw

postProjectsWithOfficeWithNameTurbineChangesRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create CWMS Turbine Changes Post cwmsData projects with office with name turbineChanges
Parameters
- requestParameters: PostProjectsWithOfficeWithNameTurbineChangesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/TurbinesApi.ts:516

`Protected` request

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

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:101

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:112

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:107

Class TurbinesApi

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TurbinesApi

Properties

Protected configuration

Methods

deleteProjectsTurbinesWithName

Parameters

Returns Promise<void>

deleteProjectsTurbinesWithNameRaw

Parameters

Returns Promise<ApiResponse<void>>

deleteProjectsWithOfficeWithNameTurbineChanges

Parameters

Returns Promise<void>

deleteProjectsWithOfficeWithNameTurbineChangesRaw

Parameters

Returns Promise<ApiResponse<void>>

getProjectsTurbines

Parameters

Returns Promise<Turbine[]>

getProjectsTurbinesRaw

Parameters

Returns Promise<ApiResponse<Turbine[]>>

getProjectsTurbinesWithName

Parameters

Returns Promise<Turbine>

getProjectsTurbinesWithNameRaw

Parameters

Returns Promise<ApiResponse<Turbine>>

getProjectsWithOfficeWithNameTurbineChanges

Parameters

Returns Promise<TurbineChange[]>

getProjectsWithOfficeWithNameTurbineChangesRaw

Parameters

Returns Promise<ApiResponse<TurbineChange[]>>

Protected isJsonMime

Parameters

Returns boolean

patchProjectsTurbinesWithName

Parameters

Returns Promise<void>

patchProjectsTurbinesWithNameRaw

Parameters

Returns Promise<ApiResponse<void>>

postProjectsTurbines

Parameters

Returns Promise<void>

postProjectsTurbinesRaw

Parameters

Returns Promise<ApiResponse<void>>

postProjectsWithOfficeWithNameTurbineChanges

Parameters

Returns Promise<void>

postProjectsWithOfficeWithNameTurbineChangesRaw

Parameters

Returns Promise<ApiResponse<void>>

Protected request

Parameters

Returns Promise<Response>

withMiddleware

Type Parameters

Parameters

Returns T

withPostMiddleware

Type Parameters

Parameters

Returns T

withPreMiddleware

Type Parameters

Parameters

Returns T

Settings

`Protected` configuration

`Protected` isJsonMime

`Protected` request