IntegrationService | Kelvin SDK Client Library Reference

Hierarchy

BaseService
- IntegrationService

Index

Methods

Static createAWSRegion

createAWSRegion(__namedParameters: { region: IIntegrationAwsRegionCreateData }, options?: IKvHttpRequestOptions): Observable<IntegrationAwsRegion>

Create AWS Region Create AWS Region Permission Required: `kelvin.permission.integration.create`

Parameters
- __namedParameters: { region: IIntegrationAwsRegionCreateData }
  - region: IIntegrationAwsRegionCreateData
    
    Create region schema
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<IntegrationAwsRegion>

Static createIntegration

createIntegration(__namedParameters: { integration: IIntegrationCreateData }, options?: IKvHttpRequestOptions): Observable<Integration>

Create Integration Create Integration Permission Required: `kelvin.permission.integration.create`

Parameters
- __namedParameters: { integration: IIntegrationCreateData }
  - integration: IIntegrationCreateData
    
    Create integration schema. Supported types [`aws-sitewise`]
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<Integration>

Static deleteAWSRegion

deleteAWSRegion(__namedParameters: { name: string }, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>

Delete AWS Region Delete AWS Region Permission Required: `kelvin.permission.integration.delete`

Parameters
- __namedParameters: { name: string }
  - name: string
    
    Region name
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<IKvHttpResponse>

Static deleteIntegration

deleteIntegration(__namedParameters: { name: string }, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>

Delete Integration Delete Integration Permission Required: `kelvin.permission.integration.delete`

Parameters
- __namedParameters: { name: string }
  - name: string
    
    Integration name
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<IKvHttpResponse>

Static getAWSRegion

getAWSRegion(__namedParameters: { name: string }, options?: IKvHttpRequestOptions): Observable<IntegrationAwsRegion>

Get AWS Region Get AWS Region Permission Required: `kelvin.permission.integration.read`

Parameters
- __namedParameters: { name: string }
  - name: string
    
    Region name
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<IntegrationAwsRegion>

Static getIntegration

getIntegration(__namedParameters: { name: string }, options?: IKvHttpRequestOptions): Observable<Integration>

Get Integration Get Integration Permission Required: `kelvin.permission.integration.read`

Parameters
- __namedParameters: { name: string }
  - name: string
    
    Integration name
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<Integration>

Static getPaginator

getPaginator<T>(request: Observable<IPaginatedRequest<T>>): KvPaginator<T>

Inherited from BaseService.getPaginator

Type parameters
- T: Model
Parameters
- request: Observable<IPaginatedRequest<T>>
Returns KvPaginator<T>

Static listAWSRegions

listAWSRegions(__namedParameters?: { endingBefore: string; names: string[]; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string }, options?: IKvHttpRequestOptions): Observable<IntegrationAwsRegionList>

List AWS Regions List AWS Regions Pagination Sortable Columns: `aws_regions.name`, `aws_regions.title`, `aws_regions.created`, `aws_regions.updated` Permission Required: `kelvin.permission.integration.read`

Parameters
- Default value __namedParameters: { endingBefore: string; names: string[]; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string } = {}
  - endingBefore: string
    
    Upper bound cursor for use in pagination
  - names: string[]
    
    Filter Regions by name
  - pageSize: number
    
    Number of objects to be returned, between 1 and 1000. Default: 20
  - search: string[]
    
    Search Regions by name or title
  - 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
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<IntegrationAwsRegionList>

Static listIntegrations

listIntegrations(__namedParameters?: { enable: boolean; endingBefore: string; names: string[]; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string; types: string[] }, options?: IKvHttpRequestOptions): Observable<IntegrationList>

List Integrations List Integrations Pagination Sortable Columns: `integration.name`, `integration.title`, `integration.type`, `integration.enable`, `integration.state`, `integration.last_seen`, `integration.created`, `integration.updated` Permission Required: `kelvin.permission.integration.read`

Parameters
- Default value __namedParameters: { enable: boolean; endingBefore: string; names: string[]; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string; types: string[] } = {}
  - enable: boolean
    
    Filter by enable Integrations. Possible Values: true/false. Default: none
  - endingBefore: string
    
    Upper bound cursor for use in pagination
  - names: string[]
    
    Filter Integrations by name
  - pageSize: number
    
    Number of objects to be returned, between 1 and 1000. Default: 20
  - search: string[]
    
    Search Integrations by name or title
  - 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
  - types: string[]
    
    Filter Integrations by type
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<IntegrationList>

Static onError

onError(): Observable<IKvHttpResponse>

Inherited from BaseService.onError

Returns Observable<IKvHttpResponse>

Static request

request<T>(endpoint: string, request: IKvHttpRequest, modelClass?: IModel): Observable<T>

Inherited from BaseService.request

Type parameters
- T
Parameters
- endpoint: string
- request: IKvHttpRequest
- Optional modelClass: IModel
Returns Observable<T>

Static requestUrl

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

Inherited from BaseService.requestUrl

Type parameters
- T
Parameters
- request: IKvHttpRequest
- Optional modelClass: IModel
- Default value autenticated: boolean = false
Returns Observable<T>

Static updateAWSRegion

updateAWSRegion(__namedParameters: { name: string; region: IIntegrationAwsRegionUpdateData }, options?: IKvHttpRequestOptions): Observable<IntegrationAwsRegion>

Update AWS Region Update AWS Region Permission Required: `kelvin.permission.integration.update`

Parameters
- __namedParameters: { name: string; region: IIntegrationAwsRegionUpdateData }
  - name: string
    
    Region name
  - region: IIntegrationAwsRegionUpdateData
    
    Create region schema
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<IntegrationAwsRegion>

Static updateIntegration

updateIntegration(__namedParameters: { integration: IIntegrationUpdateData; name: string }, options?: IKvHttpRequestOptions): Observable<Integration>

Update Integration Update Integration Permission Required: `kelvin.permission.integration.update`

Parameters
- __namedParameters: { integration: IIntegrationUpdateData; name: string }
  - integration: IIntegrationUpdateData
    
    Update integration schema
  - name: string
    
    Integration name
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<Integration>

Hierarchy

Index

Methods

Methods

Static createAWSRegion

Parameters

__namedParameters: { region: IIntegrationAwsRegionCreateData }

region: IIntegrationAwsRegionCreateData

Optional options: IKvHttpRequestOptions

Returns Observable<IntegrationAwsRegion>

Static createIntegration

Parameters

__namedParameters: { integration: IIntegrationCreateData }

integration: IIntegrationCreateData

Optional options: IKvHttpRequestOptions

Returns Observable<Integration>

Static deleteAWSRegion

Parameters

__namedParameters: { name: string }

name: string

Optional options: IKvHttpRequestOptions

Returns Observable<IKvHttpResponse>

Static deleteIntegration

Parameters

__namedParameters: { name: string }

name: string

Optional options: IKvHttpRequestOptions

Returns Observable<IKvHttpResponse>

Static getAWSRegion

Parameters

__namedParameters: { name: string }

name: string

Optional options: IKvHttpRequestOptions

Returns Observable<IntegrationAwsRegion>

Static getIntegration

Parameters

__namedParameters: { name: string }

name: string

Optional options: IKvHttpRequestOptions

Returns Observable<Integration>

Static getPaginator

Type parameters

T: Model

Parameters

request: Observable<IPaginatedRequest<T>>

Returns KvPaginator<T>

Static listAWSRegions

Parameters

Default value __namedParameters: { endingBefore: string; names: string[]; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string } = {}

endingBefore: string

names: string[]

pageSize: number

search: string[]

sortAsc: boolean

sortBy: string

startingAfter: string

Optional options: IKvHttpRequestOptions

Returns Observable<IntegrationAwsRegionList>

Static listIntegrations

Parameters

Default value __namedParameters: { enable: boolean; endingBefore: string; names: string[]; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string; types: string[] } = {}

enable: boolean

endingBefore: string

names: string[]

pageSize: number

search: string[]

sortAsc: boolean

sortBy: string

startingAfter: string

types: string[]

Optional options: IKvHttpRequestOptions

Returns Observable<IntegrationList>

Static onError

Returns Observable<IKvHttpResponse>

Static request

Type parameters

T

Parameters

endpoint: string

request: IKvHttpRequest