Class LocationGroupsApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

deleteLocationGroupWithGroupId deleteLocationGroupWithGroupIdRaw getLocationGroup getLocationGroupRaw getLocationGroupWithGroupId getLocationGroupWithGroupIdRaw isJsonMime patchLocationGroupWithGroupId patchLocationGroupWithGroupIdRaw postLocationGroup postLocationGroupRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = DefaultConfig

Methods

deleteLocationGroupWithGroupId

  • deleteLocationGroupWithGroupId(requestParameters, initOverrides?): Promise<void>

  • Deletes requested location group Delete cwmsData location group with groupId

    Parameters

    Returns Promise<void>

deleteLocationGroupWithGroupIdRaw

getLocationGroup

getLocationGroupRaw

getLocationGroupWithGroupId

getLocationGroupWithGroupIdRaw

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.

patchLocationGroupWithGroupId

  • patchLocationGroupWithGroupId(requestParameters, initOverrides?): Promise<void>

  • Update existing LocationGroup. Allows for renaming group, assigning new locations, and unassigning all locations from the group. Patch cwmsData location group with groupId

    Parameters

    Returns Promise<void>

patchLocationGroupWithGroupIdRaw

  • patchLocationGroupWithGroupIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

  • Update existing LocationGroup. Allows for renaming group, assigning new locations, and unassigning all locations from the group. Patch cwmsData location group with groupId

    Parameters

    Returns Promise<ApiResponse<void>>

postLocationGroup

  • postLocationGroup(requestParameters, initOverrides?): Promise<void>

  • Create new LocationGroup Post cwmsData location group

    Parameters

    Returns Promise<void>

postLocationGroupRaw

  • postLocationGroupRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

  • Create new LocationGroup Post cwmsData location group

    Parameters

    Returns Promise<ApiResponse<void>>

Protected request

  • request(context, initOverrides?): Promise<Response>

  • Parameters

    Returns Promise<Response>

withMiddleware

withPostMiddleware

  • withPostMiddleware<T>(this, ...postMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]

    Returns T

withPreMiddleware

  • withPreMiddleware<T>(this, ...preMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]

    Returns T

Settings

Member Visibility

Theme

On This Page

constructorconfigurationdeleteLocationGroupWithGroupIddeleteLocationGroupWithGroupIdRawgetLocationGroupgetLocationGroupRawgetLocationGroupWithGroupIdgetLocationGroupWithGroupIdRawisJsonMimepatchLocationGroupWithGroupIdpatchLocationGroupWithGroupIdRawpostLocationGrouppostLocationGroupRawrequestwithMiddlewarewithPostMiddlewarewithPreMiddleware