UserService | Kelvin SDK Client Library Reference

Hierarchy

BaseService
- UserService

Index

Methods

Static deleteUserSetting

deleteUserSetting(__namedParameters: { settingName: string }, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>

Delete User Setting Delete User Setting Permission Required: `kelvin.permission.users.delete`

Parameters
- __namedParameters: { settingName: string }
  - settingName: string
    
    Setting Name
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<IKvHttpResponse>

Static getCurrentUser

getCurrentUser(options?: IKvHttpRequestOptions): Observable<UserWithPermissions>

Get Current User Get Current User Permission Required: `n/a`

Parameters
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<UserWithPermissions>

Static getKelvinContactInformationUserSetting

getKelvinContactInformationUserSetting(options?: IKvHttpRequestOptions): Observable<UserSettingItem>

Get Kelvin Contact Information User Setting Get Kelvin Contact Information User Setting Permission Required: `kelvin.permission.users.read`

Parameters
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<UserSettingItem>

Static getKelvinNotificationsUserSetting

getKelvinNotificationsUserSetting(options?: IKvHttpRequestOptions): Observable<UserSettingItem>

Get Kelvin Notifications User Setting Get Kelvin Notifications User Setting Permission Required: `kelvin.permission.users.read`

Parameters
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<UserSettingItem>

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 getUser

getUser(__namedParameters: { userId: string }, options?: IKvHttpRequestOptions): Observable<User>

Get User Get User Permission Required: `kelvin.permission.user.read`

Parameters
- __namedParameters: { userId: string }
  - userId: string
    
    User ID
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<User>

Static getUserSetting

getUserSetting(__namedParameters: { settingName: string }, options?: IKvHttpRequestOptions): Observable<UserSettingItem>

Get User Setting Get User Setting Permission Required: `kelvin.permission.users.read`

Parameters
- __namedParameters: { settingName: string }
  - settingName: string
    
    Setting Name
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<UserSettingItem>

Static listUser

listUser(__namedParameters?: { email: string[]; endingBefore: string; name: string[]; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string; username: string[] }, options?: IKvHttpRequestOptions): Observable<UserListPaginated>

List User List User Pagination Sortable Columns: `user_entity.id`, `user_entity.username`, `user_entity.first_name`, `user_entity.last_name`, `user_entity.email` Permission Required: `kelvin.permission.users.read`

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

Static listUserSettings

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

List User Settings List User Settings Pagination Sortable Columns: `user_setting.setting_name, user_setting.created, user_setting.updated` Permission Required: `kelvin.permission.users.read`

Parameters
- Default value __namedParameters: { endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string } = {}
  - endingBefore: string
    
    Upper bound cursor for use in pagination
  - pageSize: number
    
    Number of objects to be returned, between 1 and 1000. Default: 20
  - search: string[]
    
    Search User Setting by setting_name
  - 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<UserSettingsListPaginated>

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 updateKelvinContactInformationUserSetting

updateKelvinContactInformationUserSetting(__namedParameters: { setting: IKelvinContactInfoUserSettingUpdateData }, options?: IKvHttpRequestOptions): Observable<UserSettingItem>

Update Kelvin Contact Information User Setting Update Kelvin Contact Information User Setting Permission Required: `kelvin.permission.users.update`

Parameters
- __namedParameters: { setting: IKelvinContactInfoUserSettingUpdateData }
  - setting: IKelvinContactInfoUserSettingUpdateData
    
    Kelvin Contact Information User Setting update schema
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<UserSettingItem>

Static updateKelvinNotificationsUserSetting

updateKelvinNotificationsUserSetting(__namedParameters: { setting: INotificationsUserSettingUpdateData }, options?: IKvHttpRequestOptions): Observable<UserSettingItem>

Update Kelvin Notifications User Setting Update Kelvin Notifications User Setting Permission Required: `kelvin.permission.users.update`

Parameters
- __namedParameters: { setting: INotificationsUserSettingUpdateData }
  - setting: INotificationsUserSettingUpdateData
    
    Kelvin Notifications User Setting update schema
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<UserSettingItem>

Static updateUserSetting

updateUserSetting(__namedParameters: { setting: IUserSettingUpdateData; settingName: string }, options?: IKvHttpRequestOptions): Observable<UserSettingItem>

Update User Setting Update User Setting Permission Required: `kelvin.permission.users.update`

Parameters
- __namedParameters: { setting: IUserSettingUpdateData; settingName: string }
  - setting: IUserSettingUpdateData
    
    User update schema
  - settingName: string
    
    Setting Name
- Optional options: IKvHttpRequestOptions
  
  Request optional parameters
Returns Observable<UserSettingItem>

Hierarchy

Index

Methods

Methods

Static deleteUserSetting

Parameters

__namedParameters: { settingName: string }

settingName: string

Optional options: IKvHttpRequestOptions

Returns Observable<IKvHttpResponse>

Static getCurrentUser

Parameters

Optional options: IKvHttpRequestOptions

Returns Observable<UserWithPermissions>

Static getKelvinContactInformationUserSetting

Parameters

Optional options: IKvHttpRequestOptions

Returns Observable<UserSettingItem>

Static getKelvinNotificationsUserSetting

Parameters

Optional options: IKvHttpRequestOptions

Returns Observable<UserSettingItem>

Static getPaginator

Type parameters

T: Model

Parameters

request: Observable<IPaginatedRequest<T>>

Returns KvPaginator<T>

Static getUser

Parameters

__namedParameters: { userId: string }

userId: string

Optional options: IKvHttpRequestOptions

Returns Observable<User>

Static getUserSetting

Parameters

__namedParameters: { settingName: string }

settingName: string

Optional options: IKvHttpRequestOptions

Returns Observable<UserSettingItem>

Static listUser

Parameters

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

email: string[]

endingBefore: string

name: string[]

pageSize: number

search: string[]

sortAsc: boolean

sortBy: string

startingAfter: string

username: string[]

Optional options: IKvHttpRequestOptions

Returns Observable<UserListPaginated>

Static listUserSettings

Parameters

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

endingBefore: string

pageSize: number

search: string[]

sortAsc: boolean

sortBy: string

startingAfter: string

Optional options: IKvHttpRequestOptions

Returns Observable<UserSettingsListPaginated>

Static onError

Returns Observable<IKvHttpResponse>

Static request

Type parameters

T

Parameters

endpoint: string

request: IKvHttpRequest

Optional modelClass: IModel

Returns Observable<T>

Static requestUrl

Type parameters

T

Parameters

request: IKvHttpRequest