Circle V2 API Docs
Preparing search index...
@repo/legacy
LegacyApiClient
Class LegacyApiClient
Index
Constructors
constructor
Methods
fetch
Kipu
Locations
fetch
Lightning
Step
Locations
fetch
Sunwave
Locations
modify
Ai
Note
sync
Admissions
sync
Patients
Constructors
constructor
new
LegacyApiClient
(
options
:
LegacyApiClientOptions
)
:
LegacyApiClient
Parameters
options
:
LegacyApiClientOptions
Returns
LegacyApiClient
Methods
fetch
Kipu
Locations
fetchKipuLocations
(
input
:
{
app_id
:
string
}
,
)
:
Promise
<
{
locations
:
{
location_id
:
number
;
location_name
:
string
}
[]
}
>
Parameters
input
:
{
app_id
:
string
}
Returns
Promise
<
{
locations
:
{
location_id
:
number
;
location_name
:
string
}
[]
}
>
fetch
Lightning
Step
Locations
fetchLightningStepLocations
(
input
:
{
bearer_token
:
string
}
,
)
:
Promise
<
{
locations
:
{
id
:
number
;
name
:
string
}
[]
}
>
Parameters
input
:
{
bearer_token
:
string
}
Returns
Promise
<
{
locations
:
{
id
:
number
;
name
:
string
}
[]
}
>
fetch
Sunwave
Locations
fetchSunwaveLocations
(
input
:
{
api_id
:
string
;
api_secret
:
string
;
realm_id
:
string
;
sunwave_email
:
string
;
}
,
)
:
Promise
<
{
facilities
:
{
id
:
number
;
level_of_cares
:
{
id
:
number
;
is_inpatient
:
boolean
;
legacy_id
:
string
;
name
:
string
;
}
[]
;
name
:
string
;
programs
:
{
id
:
number
;
name
:
string
}
[]
;
}
[]
;
}
,
>
Parameters
input
:
{
api_id
:
string
;
api_secret
:
string
;
realm_id
:
string
;
sunwave_email
:
string
}
Returns
Promise
<
{
facilities
:
{
id
:
number
;
level_of_cares
:
{
id
:
number
;
is_inpatient
:
boolean
;
legacy_id
:
string
;
name
:
string
;
}
[]
;
name
:
string
;
programs
:
{
id
:
number
;
name
:
string
}
[]
;
}
[]
;
}
,
>
modify
Ai
Note
modifyAiNote
(
input
:
{
customPrompt
?:
string
;
optionId
:
|
"custom"
|
"shorten"
|
"lengthen"
|
"remove_name"
|
"remove_sensitive"
|
"regenerate"
;
sessionId
:
number
;
}
,
)
:
Promise
<
{
error
:
null
;
success
:
true
}
|
{
error
:
string
;
success
:
false
}
,
>
Parameters
input
:
{
customPrompt
?:
string
;
optionId
:
|
"custom"
|
"shorten"
|
"lengthen"
|
"remove_name"
|
"remove_sensitive"
|
"regenerate"
;
sessionId
:
number
;
}
Returns
Promise
<
{
error
:
null
;
success
:
true
}
|
{
error
:
string
;
success
:
false
}
>
sync
Admissions
syncAdmissions
(
input
:
{
dry_run
:
boolean
;
end_date
?:
string
;
integration_id
:
string
;
start_date
?:
string
;
}
,
)
:
Promise
<
|
{
error
:
null
;
patients
?:
{
first_name
:
string
;
id
:
number
;
last_name
:
string
}
[]
;
stats
?:
{
date_range
?:
{
end
?:
string
;
start
?:
string
}
;
records_fetched
:
number
;
records_upserted
?:
number
;
}
;
success
:
true
;
}
|
{
details
?:
string
;
error
:
string
;
success
:
false
}
,
>
Parameters
input
:
{
dry_run
:
boolean
;
end_date
?:
string
;
integration_id
:
string
;
start_date
?:
string
;
}
Returns
Promise
<
|
{
error
:
null
;
patients
?:
{
first_name
:
string
;
id
:
number
;
last_name
:
string
}
[]
;
stats
?:
{
date_range
?:
{
end
?:
string
;
start
?:
string
}
;
records_fetched
:
number
;
records_upserted
?:
number
;
}
;
success
:
true
;
}
|
{
details
?:
string
;
error
:
string
;
success
:
false
}
,
>
sync
Patients
syncPatients
(
input
:
{
dry_run
:
boolean
;
integration_id
:
string
}
,
)
:
Promise
<
|
{
error
:
null
;
patients
?:
{
first_name
:
string
;
id
:
number
;
last_name
:
string
}
[]
;
stats
?:
{
date_range
?:
{
end
?:
string
;
start
?:
string
}
;
records_fetched
:
number
;
records_upserted
?:
number
;
}
;
success
:
true
;
}
|
{
details
?:
string
;
error
:
string
;
success
:
false
}
,
>
Parameters
input
:
{
dry_run
:
boolean
;
integration_id
:
string
}
Returns
Promise
<
|
{
error
:
null
;
patients
?:
{
first_name
:
string
;
id
:
number
;
last_name
:
string
}
[]
;
stats
?:
{
date_range
?:
{
end
?:
string
;
start
?:
string
}
;
records_fetched
:
number
;
records_upserted
?:
number
;
}
;
success
:
true
;
}
|
{
details
?:
string
;
error
:
string
;
success
:
false
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
fetch
Kipu
Locations
fetch
Lightning
Step
Locations
fetch
Sunwave
Locations
modify
Ai
Note
sync
Admissions
sync
Patients
Circle V2 API Docs
Loading...