Kelvin SDK Client Library Reference

Hierarchy

Index

Methods

Methods

Static getPaginator

Static getSchema

  • Get Schema Get Schema Permission Required: `kelvin.permission.parameter.read`

    Parameters

    • __namedParameters: { appName: string; version: string }
      • appName: string

        App name

      • version: string

        App version

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<ParameterGetSchema>

Static listAppVersionParameters

  • List App Version Parameters List App Version Parameters lists the app version asset parameters. Pagination Sortable Columns: `asset_app_parameter.app_name`, `asset_app_parameter.app_version_name`, `asset_app_parameter.asset_name`, `asset_app_parameter.parameter`, `asset_app_parameter.created`, `asset_app_parameter.updated` Permission Required: `kelvin.permission.parameter.read`

    Parameters

    • __namedParameters: { appName: string; assetName: string; endingBefore: string; pageSize: number; sortAsc: boolean; sortBy: string; startingAfter: string; version: string }
      • appName: string

        App name

      • assetName: string

        Asset name

      • endingBefore: string

        Upper bound cursor for use in pagination

      • pageSize: number

        Number of objects to be returned, between 1 and 1000. Default: 20

      • sortAsc: boolean

        Order of sorting is Ascending. Possible Values: true/false. Default: true

      • sortBy: string

        Parameter to sort by. Must be one of the sortable columns

      • startingAfter: string

        Lower bound cursor for use in pagination

      • version: string

        App version

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<ParameterAppVersionAssetListPaginated>

Static onError

Static request

Static requestUrl

  • requestUrl<T>(request: IKvHttpRequest, modelClass?: IModel, autenticated?: boolean): Observable<T>

Static updateParameters

  • Update Parameters Update Parameters for given app Version asset. Permission Required: `kelvin.permission.parameter.update`

    Parameters

    • __namedParameters: { appName: string; assetName: string; parameter: IParameterUpdateData; version: string }
      • appName: string

        App name

      • assetName: string

        Asset name

      • parameter: IParameterUpdateData

        ParameterUpdate schema

      • version: string

        App version

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>