Circle V2 API Docs
Preparing search index...
@repo/db
profilesRepo
Variable profilesRepo
Const
profilesRepo
:
DbRepo
<
{
countEmrProfilesInOrganization
:
(
params
:
ListEmrProfilesParams
,
)
=>
Promise
<
number
>
;
countInOrganization
:
(
params
:
ListProfilesInOrganizationParams
,
)
=>
Promise
<
number
>
;
create
:
(
params
:
{
is_superadmin
:
boolean
;
profile_type
:
"external"
|
"user"
}
&
{
clinic_size
?:
string
|
null
;
created_at
?:
string
|
null
;
customer_id
?:
string
|
null
;
email
?:
string
|
null
;
expectations
?:
string
|
null
;
external_system
?:
|
"kipu"
|
"lightningstep"
|
"sunwave"
|
"qualifacts_insync"
|
null
;
external_system_id
?:
string
|
null
;
first_name
?:
string
|
null
;
hear_about_us
?:
string
|
null
;
id
?:
ProfileId
;
last_name
?:
string
|
null
;
last_updated
?:
string
|
null
;
price_id
?:
string
|
null
;
session_limit
?:
string
|
null
;
subscription_status
?:
|
"trial_ended"
|
"trial_running"
|
"active"
|
"inactive"
|
null
;
title
?:
string
|
null
;
user_id
?:
string
&
{
__brand
:
"UserId"
}
|
null
;
vertical
?:
string
|
null
;
}
,
)
=>
Promise
<
{
clinic_size
:
string
|
null
;
created_at
:
string
|
null
;
customer_id
:
string
|
null
;
email
:
string
|
null
;
expectations
:
string
|
null
;
external_system
:
|
"kipu"
|
"lightningstep"
|
"sunwave"
|
"qualifacts_insync"
|
null
;
external_system_id
:
string
|
null
;
first_name
:
string
|
null
;
hear_about_us
:
string
|
null
;
id
:
ProfileId
;
is_superadmin
:
boolean
;
last_name
:
string
|
null
;
last_updated
:
string
|
null
;
price_id
:
string
|
null
;
profile_type
:
"external"
|
"user"
;
session_limit
:
string
|
null
;
subscription_status
:
|
"trial_ended"
|
"trial_running"
|
"active"
|
"inactive"
|
null
;
title
:
string
|
null
;
user_id
:
string
&
{
__brand
:
"UserId"
}
|
null
;
vertical
:
string
|
null
;
}
,
>
;
getByAuthUserId
:
(
userId
:
UserId
,
)
=>
Promise
<
{
clinic_size
:
string
|
null
;
created_at
:
string
|
null
;
customer_id
:
string
|
null
;
email
:
string
|
null
;
expectations
:
string
|
null
;
external_system
:
|
"kipu"
|
"lightningstep"
|
"sunwave"
|
"qualifacts_insync"
|
null
;
external_system_id
:
string
|
null
;
first_name
:
string
|
null
;
hear_about_us
:
string
|
null
;
id
:
ProfileId
;
is_superadmin
:
boolean
;
last_name
:
string
|
null
;
last_updated
:
string
|
null
;
price_id
:
string
|
null
;
profile_type
:
"external"
|
"user"
;
session_limit
:
string
|
null
;
subscription_status
:
|
"trial_ended"
|
"trial_running"
|
"active"
|
"inactive"
|
null
;
title
:
string
|
null
;
user_id
:
string
&
{
__brand
:
"UserId"
}
|
null
;
vertical
:
string
|
null
;
}
,
>
;
getByEmail
:
(
email
:
string
,
)
=>
Promise
<
|
{
clinic_size
:
string
|
null
;
created_at
:
string
|
null
;
customer_id
:
string
|
null
;
email
:
string
|
null
;
expectations
:
string
|
null
;
external_system
:
|
"kipu"
|
"lightningstep"
|
"sunwave"
|
"qualifacts_insync"
|
null
;
external_system_id
:
string
|
null
;
first_name
:
string
|
null
;
hear_about_us
:
string
|
null
;
id
:
ProfileId
;
is_superadmin
:
boolean
;
last_name
:
string
|
null
;
last_updated
:
string
|
null
;
price_id
:
string
|
null
;
profile_type
:
"external"
|
"user"
;
session_limit
:
string
|
null
;
subscription_status
:
|
"trial_ended"
|
"trial_running"
|
"active"
|
"inactive"
|
null
;
title
:
string
|
null
;
user_id
:
string
&
{
__brand
:
"UserId"
}
|
null
;
vertical
:
string
|
null
;
}
|
undefined
,
>
;
getById
:
(
id
:
ProfileId
,
)
=>
Promise
<
{
clinic_size
:
string
|
null
;
created_at
:
string
|
null
;
customer_id
:
string
|
null
;
email
:
string
|
null
;
expectations
:
string
|
null
;
external_system
:
|
"kipu"
|
"lightningstep"
|
"sunwave"
|
"qualifacts_insync"
|
null
;
external_system_id
:
string
|
null
;
first_name
:
string
|
null
;
hear_about_us
:
string
|
null
;
id
:
ProfileId
;
is_superadmin
:
boolean
;
last_name
:
string
|
null
;
last_updated
:
string
|
null
;
price_id
:
string
|
null
;
profile_type
:
"external"
|
"user"
;
session_limit
:
string
|
null
;
subscription_status
:
|
"trial_ended"
|
"trial_running"
|
"active"
|
"inactive"
|
null
;
title
:
string
|
null
;
user_id
:
string
&
{
__brand
:
"UserId"
}
|
null
;
vertical
:
string
|
null
;
}
,
>
;
getLabelsByIds
:
(
ids
:
ProfileId
[]
,
)
=>
Promise
<
{
first_name
:
string
|
null
;
id
:
ProfileId
;
last_name
:
string
|
null
}
[]
,
>
;
listByEmails
:
(
emails
:
string
[]
,
)
=>
Promise
<
{
clinic_size
:
string
|
null
;
created_at
:
string
|
null
;
customer_id
:
string
|
null
;
email
:
string
|
null
;
expectations
:
string
|
null
;
external_system
:
|
"kipu"
|
"lightningstep"
|
"sunwave"
|
"qualifacts_insync"
|
null
;
external_system_id
:
string
|
null
;
first_name
:
string
|
null
;
hear_about_us
:
string
|
null
;
id
:
ProfileId
;
is_superadmin
:
boolean
;
last_name
:
string
|
null
;
last_updated
:
string
|
null
;
price_id
:
string
|
null
;
profile_type
:
"external"
|
"user"
;
session_limit
:
string
|
null
;
subscription_status
:
|
"trial_ended"
|
"trial_running"
|
"active"
|
"inactive"
|
null
;
title
:
string
|
null
;
user_id
:
string
&
{
__brand
:
"UserId"
}
|
null
;
vertical
:
string
|
null
;
}
[]
,
>
;
listByUserIds
:
(
userIds
:
UserId
[]
,
)
=>
Promise
<
{
id
:
ProfileId
;
user_id
:
string
&
{
__brand
:
"UserId"
}
|
null
}
[]
,
>
;
listEmrProfilesInOrganization
:
(
__namedParameters
:
ListEmrProfilesParams
,
)
=>
Promise
<
{
email
:
string
|
null
;
external_system
:
|
"kipu"
|
"lightningstep"
|
"sunwave"
|
"qualifacts_insync"
|
null
;
first_name
:
string
|
null
;
id
:
ProfileId
;
last_name
:
string
|
null
;
pending_invite_id
:
PendingInviteId
|
null
;
title
:
string
|
null
;
}
[]
,
>
;
listInOrganization
:
(
params
:
ListProfilesInOrganizationParams
,
)
=>
Promise
<
{
first_name
:
string
|
null
;
id
:
ProfileId
;
last_name
:
string
|
null
;
title
:
string
|
null
;
}
[]
,
>
;
update
:
(
id
:
ProfileId
,
params
:
{
clinic_size
?:
string
|
null
;
created_at
?:
string
|
null
;
customer_id
?:
string
|
null
;
email
?:
string
|
null
;
expectations
?:
string
|
null
;
external_system
?:
|
"kipu"
|
"lightningstep"
|
"sunwave"
|
"qualifacts_insync"
|
null
;
external_system_id
?:
string
|
null
;
first_name
?:
string
|
null
;
hear_about_us
?:
string
|
null
;
id
?:
ProfileId
;
is_superadmin
?:
boolean
;
last_name
?:
string
|
null
;
last_updated
?:
string
|
null
;
price_id
?:
string
|
null
;
profile_type
?:
"external"
|
"user"
;
session_limit
?:
string
|
null
;
subscription_status
?:
|
"trial_ended"
|
"trial_running"
|
"active"
|
"inactive"
|
null
;
title
?:
string
|
null
;
user_id
?:
string
&
{
__brand
:
"UserId"
}
|
null
;
vertical
?:
string
|
null
;
}
,
)
=>
Promise
<
{
clinic_size
:
string
|
null
;
created_at
:
string
|
null
;
customer_id
:
string
|
null
;
email
:
string
|
null
;
expectations
:
string
|
null
;
external_system
:
|
"kipu"
|
"lightningstep"
|
"sunwave"
|
"qualifacts_insync"
|
null
;
external_system_id
:
string
|
null
;
first_name
:
string
|
null
;
hear_about_us
:
string
|
null
;
id
:
ProfileId
;
is_superadmin
:
boolean
;
last_name
:
string
|
null
;
last_updated
:
string
|
null
;
price_id
:
string
|
null
;
profile_type
:
"external"
|
"user"
;
session_limit
:
string
|
null
;
subscription_status
:
|
"trial_ended"
|
"trial_running"
|
"active"
|
"inactive"
|
null
;
title
:
string
|
null
;
user_id
:
string
&
{
__brand
:
"UserId"
}
|
null
;
vertical
:
string
|
null
;
}
,
>
;
upsert
:
(
rows
:
(
{
is_superadmin
:
boolean
;
profile_type
:
"external"
|
"user"
}
&
{
clinic_size
?:
string
|
null
;
created_at
?:
string
|
null
;
customer_id
?:
string
|
null
;
email
?:
string
|
null
;
expectations
?:
string
|
null
;
external_system
?:
|
"kipu"
|
"lightningstep"
|
"sunwave"
|
"qualifacts_insync"
|
null
;
external_system_id
?:
string
|
null
;
first_name
?:
string
|
null
;
hear_about_us
?:
string
|
null
;
id
?:
ProfileId
;
last_name
?:
string
|
null
;
last_updated
?:
string
|
null
;
price_id
?:
string
|
null
;
session_limit
?:
string
|
null
;
subscription_status
?:
|
"trial_ended"
|
"trial_running"
|
"active"
|
"inactive"
|
null
;
title
?:
string
|
null
;
user_id
?:
string
&
{
__brand
:
"UserId"
}
|
null
;
vertical
?:
string
|
null
;
}
)
[]
,
)
=>
Promise
<
{
inserted
:
{
clinic_size
:
string
|
null
;
created_at
:
string
|
null
;
customer_id
:
string
|
null
;
email
:
string
|
null
;
expectations
:
string
|
null
;
external_system
:
|
"kipu"
|
"lightningstep"
|
"sunwave"
|
"qualifacts_insync"
|
null
;
external_system_id
:
string
|
null
;
first_name
:
string
|
null
;
hear_about_us
:
string
|
null
;
id
:
ProfileId
;
is_superadmin
:
boolean
;
last_name
:
string
|
null
;
last_updated
:
string
|
null
;
price_id
:
string
|
null
;
profile_type
:
"external"
|
"user"
;
session_limit
:
string
|
null
;
subscription_status
:
|
"trial_ended"
|
"trial_running"
|
"active"
|
"inactive"
|
null
;
title
:
string
|
null
;
user_id
:
string
&
{
__brand
:
"UserId"
}
|
null
;
vertical
:
string
|
null
;
}
[]
;
skipped
:
{
reason
:
string
;
row
:
{
is_superadmin
:
boolean
;
profile_type
:
"external"
|
"user"
}
&
{
clinic_size
?:
string
|
null
;
created_at
?:
string
|
null
;
customer_id
?:
string
|
null
;
email
?:
string
|
null
;
expectations
?:
string
|
null
;
external_system
?:
|
"kipu"
|
"lightningstep"
|
"sunwave"
|
"qualifacts_insync"
|
null
;
external_system_id
?:
string
|
null
;
first_name
?:
string
|
null
;
hear_about_us
?:
string
|
null
;
id
?:
ProfileId
;
last_name
?:
string
|
null
;
last_updated
?:
string
|
null
;
price_id
?:
string
|
null
;
session_limit
?:
string
|
null
;
subscription_status
?:
|
"trial_ended"
|
"trial_running"
|
"active"
|
"inactive"
|
null
;
title
?:
string
|
null
;
user_id
?:
(...)
&
(...)
|
null
;
vertical
?:
string
|
null
;
}
;
}
[]
;
}
,
>
;
}
,
>
= ...
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Circle V2 API Docs
Loading...