> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# API
> API reference for Faraday: every `faraday.api.*` operation with input and output types.
Every `faraday.api.*` operation is listed below with parameter shapes and return types from the plugin Zod schemas.
**New to Corsair?** See [API access](/concepts/api), [authentication](/concepts/auth), and [error handling](/concepts/error-handling).
## Accounts
### create
`accounts.create`
Create a Faraday subaccount
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.accounts.create({});
```
**Input**
| Name | Type | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `name` | `string` | Yes | — |
| `branding` | `object` | No | — |
```ts theme={null}
{
suppress_from_reports?: boolean
}
```
**Output**
| Name | Type | Required | Description |
| ------------------------ | -------------------------------------------------------- | -------- | ----------- |
| `id` | `string` | Yes | — |
| `name` | `string` | No | — |
| `resource_type` | `string` | No | — |
| `status` | `new \| starting \| running \| ready \| error \| string` | No | — |
| `created_at` | `string` | No | — |
| `updated_at` | `string` | No | — |
| `archived_at` | `string` | No | — |
| `status_changed_at` | `string` | No | — |
| `status_error` | `string` | No | — |
| `last_read_input_at` | `string` | No | — |
| `last_updated_config_at` | `string` | No | — |
| `last_updated_output_at` | `string` | No | — |
| `branding` | `object` | No | — |
| `commitment` | `object` | No | — |
| `contract_started_at` | `string` | No | — |
| `identity_graph` | `object` | No | — |
| `parent_account_id` | `string` | No | — |
| `stripe_customer_id` | `string` | No | — |
```ts theme={null}
{
suppress_from_reports?: boolean
}
```
```ts theme={null}
{
monthly_cost?: number,
renewal_date?: string
}
```
```ts theme={null}
{
feature_store_id: string
}
```
***
### delete
`accounts.delete`
Delete a Faraday account
**Risk:** `destructive`
```ts theme={null}
await corsair.faraday.api.accounts.delete({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### get
`accounts.get`
Retrieve a Faraday account
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.accounts.get({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output**
| Name | Type | Required | Description |
| ------------------------ | -------------------------------------------------------- | -------- | ----------- |
| `id` | `string` | Yes | — |
| `name` | `string` | No | — |
| `resource_type` | `string` | No | — |
| `status` | `new \| starting \| running \| ready \| error \| string` | No | — |
| `created_at` | `string` | No | — |
| `updated_at` | `string` | No | — |
| `archived_at` | `string` | No | — |
| `status_changed_at` | `string` | No | — |
| `status_error` | `string` | No | — |
| `last_read_input_at` | `string` | No | — |
| `last_updated_config_at` | `string` | No | — |
| `last_updated_output_at` | `string` | No | — |
| `branding` | `object` | No | — |
| `commitment` | `object` | No | — |
| `contract_started_at` | `string` | No | — |
| `identity_graph` | `object` | No | — |
| `parent_account_id` | `string` | No | — |
| `stripe_customer_id` | `string` | No | — |
```ts theme={null}
{
suppress_from_reports?: boolean
}
```
```ts theme={null}
{
monthly_cost?: number,
renewal_date?: string
}
```
```ts theme={null}
{
feature_store_id: string
}
```
***
### getBilling
`accounts.getBilling`
Get billing for a Faraday account
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.accounts.getBilling({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getCurrent
`accounts.getCurrent`
Retrieve the current Faraday account
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.accounts.getCurrent({});
```
**Input:** *empty object*
**Output**
| Name | Type | Required | Description |
| ------------------------ | -------------------------------------------------------- | -------- | ----------- |
| `id` | `string` | Yes | — |
| `name` | `string` | No | — |
| `resource_type` | `string` | No | — |
| `status` | `new \| starting \| running \| ready \| error \| string` | No | — |
| `created_at` | `string` | No | — |
| `updated_at` | `string` | No | — |
| `archived_at` | `string` | No | — |
| `status_changed_at` | `string` | No | — |
| `status_error` | `string` | No | — |
| `last_read_input_at` | `string` | No | — |
| `last_updated_config_at` | `string` | No | — |
| `last_updated_output_at` | `string` | No | — |
| `branding` | `object` | No | — |
| `commitment` | `object` | No | — |
| `contract_started_at` | `string` | No | — |
| `identity_graph` | `object` | No | — |
| `parent_account_id` | `string` | No | — |
| `stripe_customer_id` | `string` | No | — |
```ts theme={null}
{
suppress_from_reports?: boolean
}
```
```ts theme={null}
{
monthly_cost?: number,
renewal_date?: string
}
```
```ts theme={null}
{
feature_store_id: string
}
```
***
### getCurrentBilling
`accounts.getCurrentBilling`
Get billing for the current Faraday account
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.accounts.getCurrentBilling({});
```
**Input:** *empty object*
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### list
`accounts.list`
List Faraday accounts
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.accounts.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object[]`
```ts theme={null}
{
id: string,
name?: string,
resource_type?: string,
status?: new | starting | running | ready | error | string,
created_at?: string,
updated_at?: string,
archived_at?: string | null,
status_changed_at?: string,
status_error?: string | null,
last_read_input_at?: string,
last_updated_config_at?: string,
last_updated_output_at?: string,
branding?: {
suppress_from_reports?: boolean
},
commitment?: {
monthly_cost?: number,
renewal_date?: string
},
contract_started_at?: string,
identity_graph?: {
feature_store_id: string
},
parent_account_id?: string,
stripe_customer_id?: string
}[]
```
***
### update
`accounts.update`
Update a Faraday account (JSON Merge Patch)
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.accounts.update({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output**
| Name | Type | Required | Description |
| ------------------------ | -------------------------------------------------------- | -------- | ----------- |
| `id` | `string` | Yes | — |
| `name` | `string` | No | — |
| `resource_type` | `string` | No | — |
| `status` | `new \| starting \| running \| ready \| error \| string` | No | — |
| `created_at` | `string` | No | — |
| `updated_at` | `string` | No | — |
| `archived_at` | `string` | No | — |
| `status_changed_at` | `string` | No | — |
| `status_error` | `string` | No | — |
| `last_read_input_at` | `string` | No | — |
| `last_updated_config_at` | `string` | No | — |
| `last_updated_output_at` | `string` | No | — |
| `branding` | `object` | No | — |
| `commitment` | `object` | No | — |
| `contract_started_at` | `string` | No | — |
| `identity_graph` | `object` | No | — |
| `parent_account_id` | `string` | No | — |
| `stripe_customer_id` | `string` | No | — |
```ts theme={null}
{
suppress_from_reports?: boolean
}
```
```ts theme={null}
{
monthly_cost?: number,
renewal_date?: string
}
```
```ts theme={null}
{
feature_store_id: string
}
```
***
## Attributes
### list
`attributes.list`
List Faraday attributes
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.attributes.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
## Cohorts
### archive
`cohorts.archive`
Archive a Faraday cohort
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.cohorts.archive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### create
`cohorts.create`
Create a Faraday cohort
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.cohorts.create({});
```
**Input**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `name` | `string` | Yes | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### delete
`cohorts.delete`
Delete a Faraday cohort
**Risk:** `destructive`
```ts theme={null}
await corsair.faraday.api.cohorts.delete({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### forceUpdate
`cohorts.forceUpdate`
Force update a Faraday cohort
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.cohorts.forceUpdate({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### get
`cohorts.get`
Retrieve a Faraday cohort
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.cohorts.get({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getMembershipAnalysis
`cohorts.getMembershipAnalysis`
Get Faraday cohort membership analysis
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.cohorts.getMembershipAnalysis({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### list
`cohorts.list`
List Faraday cohorts
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.cohorts.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
### unarchive
`cohorts.unarchive`
Unarchive a Faraday cohort
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.cohorts.unarchive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### update
`cohorts.update`
Update a Faraday cohort (JSON Merge Patch)
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.cohorts.update({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
## Connections
### archive
`connections.archive`
Archive a Faraday connection
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.connections.archive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### delete
`connections.delete`
Delete a Faraday connection
**Risk:** `destructive`
```ts theme={null}
await corsair.faraday.api.connections.delete({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### forceUpdate
`connections.forceUpdate`
Force update a Faraday connection
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.connections.forceUpdate({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### getDatasets
`connections.getDatasets`
List datasets for a Faraday connection
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.connections.getDatasets({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getTargets
`connections.getTargets`
List targets for a Faraday connection
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.connections.getTargets({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### list
`connections.list`
List Faraday connections
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.connections.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
### update
`connections.update`
Update a Faraday connection (JSON Merge Patch)
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.connections.update({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
## Datasets
### archive
`datasets.archive`
Archive a Faraday dataset
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.datasets.archive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### create
`datasets.create`
Create a Faraday dataset
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.datasets.create({});
```
**Input**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `name` | `string` | Yes | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### delete
`datasets.delete`
Delete a Faraday dataset
**Risk:** `destructive`
```ts theme={null}
await corsair.faraday.api.datasets.delete({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### forceUpdate
`datasets.forceUpdate`
Force update a Faraday dataset
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.datasets.forceUpdate({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### get
`datasets.get`
Retrieve a Faraday dataset
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.datasets.get({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getIngressLogs
`datasets.getIngressLogs`
Get Faraday dataset ingress logs
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.datasets.getIngressLogs({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### list
`datasets.list`
List Faraday datasets
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.datasets.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
### unarchive
`datasets.unarchive`
Unarchive a Faraday dataset
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.datasets.unarchive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### update
`datasets.update`
Update a Faraday dataset (JSON Merge Patch)
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.datasets.update({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
## Feature Stores
### list
`featureStores.list`
List Faraday feature stores
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.featureStores.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
## Graph
### get
`graph.get`
Retrieve the Faraday resource dependency graph
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.graph.get({});
```
**Input:** *empty object*
**Output:** `object[]`
```ts theme={null}
{
downstream_id: string,
downstream_literate?: string,
downstream_status?: string,
downstream_type?: string,
upstream_id: string,
upstream_literate?: string,
upstream_status?: string,
upstream_type?: string
}[]
```
***
## Market Opportunity Analyses
### list
`marketOpportunityAnalyses.list`
List Faraday market opportunity analyses
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.marketOpportunityAnalyses.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
## Outcomes
### archive
`outcomes.archive`
Archive a Faraday outcome
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.outcomes.archive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### create
`outcomes.create`
Create a Faraday outcome
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.outcomes.create({});
```
**Input**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `name` | `string` | Yes | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### delete
`outcomes.delete`
Delete a Faraday outcome
**Risk:** `destructive`
```ts theme={null}
await corsair.faraday.api.outcomes.delete({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### forceUpdate
`outcomes.forceUpdate`
Force update a Faraday outcome
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.outcomes.forceUpdate({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### get
`outcomes.get`
Retrieve a Faraday outcome
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.outcomes.get({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### list
`outcomes.list`
List Faraday outcomes
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.outcomes.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
### unarchive
`outcomes.unarchive`
Unarchive a Faraday outcome
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.outcomes.unarchive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### update
`outcomes.update`
Update a Faraday outcome (JSON Merge Patch)
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.outcomes.update({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
## Persona Sets
### archive
`personaSets.archive`
Archive a Faraday persona set
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.personaSets.archive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### create
`personaSets.create`
Create a Faraday persona set
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.personaSets.create({});
```
**Input**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `name` | `string` | Yes | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### delete
`personaSets.delete`
Delete a Faraday persona set
**Risk:** `destructive`
```ts theme={null}
await corsair.faraday.api.personaSets.delete({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### forceUpdate
`personaSets.forceUpdate`
Force update a Faraday persona set
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.personaSets.forceUpdate({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### get
`personaSets.get`
Retrieve a Faraday persona set
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.personaSets.get({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getAnalysisDimensions
`personaSets.getAnalysisDimensions`
Get Faraday persona set dimension analysis
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.personaSets.getAnalysisDimensions({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getAnalysisFlow
`personaSets.getAnalysisFlow`
Get Faraday persona set flow analysis
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.personaSets.getAnalysisFlow({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### list
`personaSets.list`
List Faraday persona sets
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.personaSets.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
### unarchive
`personaSets.unarchive`
Unarchive a Faraday persona set
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.personaSets.unarchive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### update
`personaSets.update`
Update a Faraday persona set (JSON Merge Patch)
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.personaSets.update({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
## Places
### archive
`places.archive`
Archive a Faraday place
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.places.archive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### create
`places.create`
Create a Faraday place
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.places.create({});
```
**Input**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `name` | `string` | Yes | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### delete
`places.delete`
Delete a Faraday place
**Risk:** `destructive`
```ts theme={null}
await corsair.faraday.api.places.delete({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### forceUpdate
`places.forceUpdate`
Force update a Faraday place
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.places.forceUpdate({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### get
`places.get`
Retrieve a Faraday place
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.places.get({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### list
`places.list`
List Faraday places
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.places.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
### unarchive
`places.unarchive`
Unarchive a Faraday place
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.places.unarchive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### update
`places.update`
Update a Faraday place (JSON Merge Patch)
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.places.update({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
## Recommenders
### list
`recommenders.list`
List Faraday recommenders
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.recommenders.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
## Scopes
### archive
`scopes.archive`
Archive a Faraday scope
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.scopes.archive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### create
`scopes.create`
Create a Faraday scope
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.scopes.create({});
```
**Input**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `name` | `string` | Yes | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### delete
`scopes.delete`
Delete a Faraday scope
**Risk:** `destructive`
```ts theme={null}
await corsair.faraday.api.scopes.delete({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### forceUpdate
`scopes.forceUpdate`
Force update a Faraday scope
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.scopes.forceUpdate({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### get
`scopes.get`
Retrieve a Faraday scope
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.scopes.get({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getAnalysis
`scopes.getAnalysis`
Get Faraday scope analysis
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.scopes.getAnalysis({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getDatasets
`scopes.getDatasets`
List datasets for a Faraday scope
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.scopes.getDatasets({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getEfficacy
`scopes.getEfficacy`
Get Faraday scope efficacy
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.scopes.getEfficacy({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getPayloadCohorts
`scopes.getPayloadCohorts`
Get Faraday scope payload cohorts
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.scopes.getPayloadCohorts({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getPayloadOutcomes
`scopes.getPayloadOutcomes`
Get Faraday scope payload outcomes
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.scopes.getPayloadOutcomes({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getPayloadPersonaSets
`scopes.getPayloadPersonaSets`
Get Faraday scope payload persona sets
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.scopes.getPayloadPersonaSets({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getPayloadRecommenders
`scopes.getPayloadRecommenders`
Get Faraday scope payload recommenders
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.scopes.getPayloadRecommenders({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getPopulationCohorts
`scopes.getPopulationCohorts`
Get Faraday scope population cohorts
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.scopes.getPopulationCohorts({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getPopulationExclusionCohorts
`scopes.getPopulationExclusionCohorts`
Get Faraday scope population exclusion cohorts
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.scopes.getPopulationExclusionCohorts({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getTargets
`scopes.getTargets`
Get Faraday scope targets
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.scopes.getTargets({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### list
`scopes.list`
List Faraday scopes
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.scopes.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
### unarchive
`scopes.unarchive`
Unarchive a Faraday scope
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.scopes.unarchive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### update
`scopes.update`
Update a Faraday scope (JSON Merge Patch)
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.scopes.update({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
## Streams
### archive
`streams.archive`
Archive a Faraday stream
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.streams.archive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### create
`streams.create`
Create a Faraday stream
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.streams.create({});
```
**Input**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `name` | `string` | Yes | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### delete
`streams.delete`
Delete a Faraday stream
**Risk:** `destructive`
```ts theme={null}
await corsair.faraday.api.streams.delete({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### forceUpdate
`streams.forceUpdate`
Force update a Faraday stream
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.streams.forceUpdate({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### get
`streams.get`
Retrieve a Faraday stream
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.streams.get({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getAnalysis
`streams.getAnalysis`
Get Faraday stream event analysis
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.streams.getAnalysis({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### list
`streams.list`
List Faraday streams
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.streams.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
### unarchive
`streams.unarchive`
Unarchive a Faraday stream
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.streams.unarchive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### update
`streams.update`
Update a Faraday stream (JSON Merge Patch)
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.streams.update({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
## Targets
### archive
`targets.archive`
Archive a Faraday target
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.targets.archive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### create
`targets.create`
Create a Faraday target
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.targets.create({});
```
**Input**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `name` | `string` | Yes | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### createPreview
`targets.createPreview`
Start a Faraday target preview delivery
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.targets.createPreview({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | -------- | -------- | ----------- |
| `target_id` | `string` | Yes | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### delete
`targets.delete`
Delete a Faraday target
**Risk:** `destructive`
```ts theme={null}
await corsair.faraday.api.targets.delete({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### forceUpdate
`targets.forceUpdate`
Force update a Faraday target
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.targets.forceUpdate({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### get
`targets.get`
Retrieve a Faraday target
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.targets.get({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getAnalysis
`targets.getAnalysis`
Get Faraday target analysis
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.targets.getAnalysis({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### list
`targets.list`
List Faraday targets
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.targets.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
### update
`targets.update`
Update a Faraday target (JSON Merge Patch)
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.targets.update({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
## Traits
### archive
`traits.archive`
Archive a Faraday trait
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.traits.archive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### create
`traits.create`
Create a Faraday trait
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.traits.create({});
```
**Input**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `name` | `string` | Yes | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### delete
`traits.delete`
Delete a Faraday trait
**Risk:** `destructive`
```ts theme={null}
await corsair.faraday.api.traits.delete({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### deleteOrphaned
`traits.deleteOrphaned`
Delete all orphaned Faraday traits
**Risk:** `destructive`
```ts theme={null}
await corsair.faraday.api.traits.deleteOrphaned({});
```
**Input:** *empty object*
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### forceUpdate
`traits.forceUpdate`
Force update a Faraday trait
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.traits.forceUpdate({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### get
`traits.get`
Retrieve a Faraday trait
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.traits.get({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getAnalysisDimensions
`traits.getAnalysisDimensions`
Get Faraday trait dimension analysis
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.traits.getAnalysisDimensions({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### getCsv
`traits.getCsv`
Download Faraday traits as CSV
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.traits.getCsv({});
```
**Input:** *empty object*
**Output**
| Name | Type | Required | Description |
| --------- | -------- | -------- | ----------- |
| `content` | `string` | Yes | — |
***
### list
`traits.list`
List Faraday traits
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.traits.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
### unarchive
`traits.unarchive`
Unarchive a Faraday trait
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.traits.unarchive({});
```
**Input:** `object`
```ts theme={null}
{
account_id?: string,
cohort_id?: string,
dataset_id?: string,
stream_id?: string,
outcome_id?: string,
persona_set_id?: string,
place_id?: string,
scope_id?: string,
target_id?: string,
trait_id?: string,
connection_id?: string,
webhook_endpoint_id?: string,
id?: string
}& {
cascade_to?: string[],
cascade_to_all?: boolean
}
```
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### update
`traits.update`
Update a Faraday trait (JSON Merge Patch)
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.traits.update({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
## Uploads
### delete
`uploads.delete`
Delete a Faraday uploaded file
**Risk:** `destructive`
```ts theme={null}
await corsair.faraday.api.uploads.delete({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | -------- | -------- | ----------- |
| `directory` | `string` | Yes | — |
| `filename` | `string` | Yes | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### get
`uploads.get`
Download a Faraday uploaded file
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.uploads.get({});
```
**Input**
| Name | Type | Required | Description |
| ----------- | -------- | -------- | ----------- |
| `directory` | `string` | Yes | — |
| `filename` | `string` | Yes | — |
**Output:** `object`
```ts theme={null}
{
content: string
} | {
}
```
***
### list
`uploads.list`
List Faraday uploaded files
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.uploads.list({});
```
**Input:** *empty object*
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
## Usages
### get
`usages.get`
Get Faraday account usage stats
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.usages.get({});
```
**Input:** *empty object*
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
## Webhook Endpoints
### create
`webhookEndpoints.create`
Create a Faraday webhook endpoint
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.webhookEndpoints.create({});
```
**Input**
| Name | Type | Required | Description |
| ---------------- | -------------------------------------------------- | -------- | ----------- |
| `url` | `string` | Yes | — |
| `enabled_events` | `resource.errored \| resource.ready_with_update[]` | Yes | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### delete
`webhookEndpoints.delete`
Delete a Faraday webhook endpoint
**Risk:** `destructive`
```ts theme={null}
await corsair.faraday.api.webhookEndpoints.delete({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
ok: true
} | {
} | {
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}
```
***
### get
`webhookEndpoints.get`
Retrieve a Faraday webhook endpoint
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.webhookEndpoints.get({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ----------- |
| `account_id` | `string` | No | — |
| `cohort_id` | `string` | No | — |
| `dataset_id` | `string` | No | — |
| `stream_id` | `string` | No | — |
| `outcome_id` | `string` | No | — |
| `persona_set_id` | `string` | No | — |
| `place_id` | `string` | No | — |
| `scope_id` | `string` | No | — |
| `target_id` | `string` | No | — |
| `trait_id` | `string` | No | — |
| `connection_id` | `string` | No | — |
| `webhook_endpoint_id` | `string` | No | — |
| `id` | `string` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***
### list
`webhookEndpoints.list`
List Faraday webhook endpoints
**Risk:** `read`
```ts theme={null}
await corsair.faraday.api.webhookEndpoints.list({});
```
**Input**
| Name | Type | Required | Description |
| ----- | ---------- | -------- | ----------- |
| `ids` | `string[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
}[] | {
}
```
***
### update
`webhookEndpoints.update`
Update a Faraday webhook endpoint
**Risk:** `write`
```ts theme={null}
await corsair.faraday.api.webhookEndpoints.update({});
```
**Input**
| Name | Type | Required | Description |
| --------------------- | -------------------------------------------------- | -------- | ----------- |
| `webhook_endpoint_id` | `string` | Yes | — |
| `url` | `string` | No | — |
| `status` | `enabled \| disabled` | No | — |
| `enabled_events` | `resource.errored \| resource.ready_with_update[]` | No | — |
**Output:** `object`
```ts theme={null}
{
id?: string,
name?: string,
resource_type?: string,
status?: string,
created_at?: string,
updated_at?: string,
archived_at?: string | null
} | {
} | {
ok: true
}
```
***