Class ProfileService

Users service

Hierarchy

ProfileService

Constructors

constructor

new ProfileService(httpClient): ProfileService
Parameters
- httpClient: HttpClient
Returns ProfileService

Properties

`Private` crm_req_namespace

crm_req_namespace: string = '/crm/v1/requisites'

`Private` fields_namespace

fields_namespace: string = '/company/v1/custom_fields/users'

`Private` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/company/v1/users/me'

Methods

createProfileField

createProfileField(data): Promise<AxiosResponse<IField, any>>
Create profile field
Parameters
- data: Partial<IField>
  
  field data
Returns Promise<AxiosResponse<IField, any>>
profile field

createTemplate

createTemplate(body): Promise<AxiosResponse<IRequisite, any>>
create template
Parameters
- body: ITemplate
  
  new template
Returns Promise<AxiosResponse<IRequisite, any>>
new template

deleteProfileField

deleteProfileField(fieldCode): Promise<AxiosResponse<any, any>>
Delete profile field
Parameters
- fieldCode: string
  
  profile field code
Returns Promise<AxiosResponse<any, any>>

deleteProfileListValues

deleteProfileListValues(fieldCode, value): Promise<AxiosResponse<any, any>>
Delete profile list values
Parameters
- fieldCode: string
  
  profile field code
- value: string
  
  profile list value
Returns Promise<AxiosResponse<any, any>>

disable2Fa

disable2Fa(): Promise<AxiosResponse<IResponseWithMessage, any>>
Disable 2fa

Returns Promise<AxiosResponse<IResponseWithMessage, any>>
user portal settings

enable2Fa

enable2Fa(): Promise<AxiosResponse<I2FaEnable, any>>
Enable 2fa

Returns Promise<AxiosResponse<I2FaEnable, any>>
user portal settings

get2FaStatus

get2FaStatus(): Promise<AxiosResponse<I2FaStatus, any>>
Get 2fa

Returns Promise<AxiosResponse<I2FaStatus, any>>
user portal settings

getBankRequisitesById

getBankRequisitesById(id): Promise<AxiosResponse<IRequisitesResponse, any>>
get all bank requisites for current requisite
Parameters
- id: number
  
  requisite id
Returns Promise<AxiosResponse<IRequisitesResponse, any>>
all attached bank requisites

getBasicTemplates

getBasicTemplates(): Promise<AxiosResponse<ITemplateResponse, any>>
get basic templates

Returns Promise<AxiosResponse<ITemplateResponse, any>>
basic templates

getPortalSettings

getPortalSettings(): Promise<AxiosResponse<IPortalSettings, any>>
update portal ettings by user id

Returns Promise<AxiosResponse<IPortalSettings, any>>
user portal settings

getProfile

getProfile(): Promise<AxiosResponse<IUser, any>>
Get self profile

Returns Promise<AxiosResponse<IUser, any>>
user profile data

getProfileFields

getProfileFields(): Promise<AxiosResponse<IField[], any>>
Get profile fields

Returns Promise<AxiosResponse<IField[], any>>
profile fields

getRequisites

getRequisites(): Promise<AxiosResponse<IRequisitesResponse, any>>
get all requisites

Returns Promise<AxiosResponse<IRequisitesResponse, any>>
all requisites

getTemplates

getTemplates(page?, list?): Promise<AxiosResponse<ITemplateResponse, any>>
get templates
Parameters
- Optional page: number
  
  count of page
- Optional list: number
  
  count of elements on page
Returns Promise<AxiosResponse<ITemplateResponse, any>>
templates

removeRequisite

removeRequisite(id): Promise<AxiosResponse<any, any>>
remove requisite by id
Parameters
- id: number
Returns Promise<AxiosResponse<any, any>>

removeTemplate

removeTemplate(id): Promise<AxiosResponse<any, any>>
remove template by id
Parameters
- id: number
Returns Promise<AxiosResponse<any, any>>

updatePortalSettings

updatePortalSettings(settings): Promise<AxiosResponse<IPortalSettings, any>>
update portal ettings by user id
Parameters
- settings: IPortalSettings
Returns Promise<AxiosResponse<IPortalSettings, any>>
user portal settings

updateProfileField

updateProfileField(fieldCode, data): Promise<AxiosResponse<IField, any>>
Update profile field
Parameters
- fieldCode: string
  
  field code
- data: IField
  
  field data
Returns Promise<AxiosResponse<IField, any>>
entity field

updateProfileListValues

updateProfileListValues(data): Promise<AxiosResponse<IFieldValue[], any>>
Update profile list values
Parameters
- data: IField
  
  field values data
Returns Promise<AxiosResponse<IFieldValue[], any>>
values of profile field

updateRequisite

updateRequisite(body): Promise<AxiosResponse<IRequisite, any>>
update requisite by id
Parameters
- body: IRequisiteUpdate
Returns Promise<AxiosResponse<IRequisite, any>>

updateTemplate

updateTemplate(body): Promise<AxiosResponse<IRequisite, any>>
update template
Parameters
- body: ITemplateUpdate
  
  updated fields in template
Returns Promise<AxiosResponse<IRequisite, any>>
updated template

Generated using TypeDoc