reference.md

Reference

BulkSync

client.bulkSync.list({ ...params }) -> Polytomic.BulkSyncListEnvelope

🔌 Usage

await client.bulkSync.list({
    active: true,
});

⚙️ Parameters

request: Polytomic.BulkSyncListRequest

requestOptions: BulkSync.RequestOptions

client.bulkSync.create({ ...params }) -> Polytomic.BulkSyncResponseEnvelope

📝 Description

Create a new Bulk Sync from a source to a destination (data warehouse, database, or cloud storage bucket like S3).

Bulk Syncs are used for the ELT pattern (Extract, Load, and Transform), where you want to sync un-transformed data to your data warehouses, databases, or cloud storage buckets like S3.

All of the functionality described in the product documentation is configurable via the API.

Sample code examples:

• Bulk sync (ELT) from Salesforce to S3
• Bulk sync (ELT) from Salesforce to Snowflake
• Bulk sync (ELT) from HubSpot to PostgreSQL

Connection specific configuration

The destination_configuration is integration-specific configuration for the selected bulk sync destination. This includes settings such as the output schema and is required when creating a new sync.

The source_configuration is optional. It allows configuration for how Polytomic reads data from the source connection. This will not be available for integrations that do not support additional configuration.

Consult the connection configurations to see configurations for particular integrations (for example, here is the available source configuration for the PostgreSQL bulk sync source).

🔌 Usage

await client.bulkSync.create({
    destination_configuration: {
        schema: "my_schema",
    },
    destination_connection_id: "248df4b7-aa70-47b8-a036-33ac447e668d",
    name: "My Bulk Sync",
    schedule: {
        frequency: "manual",
    },
    source_connection_id: "248df4b7-aa70-47b8-a036-33ac447e668d",
});

⚙️ Parameters

request: Polytomic.CreateBulkSyncRequest

requestOptions: BulkSync.RequestOptions

client.bulkSync.get(id, { ...params }) -> Polytomic.BulkSyncResponseEnvelope

🔌 Usage

await client.bulkSync.get("248df4b7-aa70-47b8-a036-33ac447e668d", {
    refresh_schemas: true,
});

⚙️ Parameters

id: string

request: Polytomic.BulkSyncGetRequest

requestOptions: BulkSync.RequestOptions

client.bulkSync.update(id, { ...params }) -> Polytomic.BulkSyncResponseEnvelope

📝 Description

📘 Updating schemas

Schema updates can be performed using the Update Bulk Sync Schemas endpoint.

🔌 Usage

await client.bulkSync.update("248df4b7-aa70-47b8-a036-33ac447e668d", {
    destination_configuration: {
        schema: "my_schema",
    },
    destination_connection_id: "248df4b7-aa70-47b8-a036-33ac447e668d",
    name: "My Bulk Sync",
    schedule: {
        frequency: "manual",
    },
    source_connection_id: "248df4b7-aa70-47b8-a036-33ac447e668d",
});

⚙️ Parameters

id: string

request: Polytomic.UpdateBulkSyncRequest

requestOptions: BulkSync.RequestOptions

client.bulkSync.remove(id, { ...params }) -> void

🔌 Usage

await client.bulkSync.remove("248df4b7-aa70-47b8-a036-33ac447e668d", {
    refresh_schemas: true,
});

⚙️ Parameters

id: string

request: Polytomic.BulkSyncRemoveRequest

requestOptions: BulkSync.RequestOptions

client.bulkSync.activate(id, { ...params }) -> Polytomic.ActivateSyncEnvelope

🔌 Usage

await client.bulkSync.activate("248df4b7-aa70-47b8-a036-33ac447e668d", {
    active: true,
});

⚙️ Parameters

id: string

request: Polytomic.ActivateSyncInput

requestOptions: BulkSync.RequestOptions

client.bulkSync.cancel(id) -> Polytomic.CancelBulkSyncResponseEnvelope

🔌 Usage

await client.bulkSync.cancel("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string — The active execution of this bulk sync ID will be cancelled.

requestOptions: BulkSync.RequestOptions

client.bulkSync.start(id, { ...params }) -> Polytomic.BulkSyncExecutionEnvelope

🔌 Usage

await client.bulkSync.start("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

request: Polytomic.StartBulkSyncRequest

requestOptions: BulkSync.RequestOptions

client.bulkSync.getStatus(id) -> Polytomic.BulkSyncStatusEnvelope

🔌 Usage

await client.bulkSync.getStatus("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: BulkSync.RequestOptions

client.bulkSync.getSource(id, { ...params }) -> Polytomic.BulkSyncSourceEnvelope

🔌 Usage

await client.bulkSync.getSource("248df4b7-aa70-47b8-a036-33ac447e668d", {
    include_fields: true,
});

⚙️ Parameters

id: string

request: Polytomic.BulkSyncGetSourceRequest

requestOptions: BulkSync.RequestOptions

client.bulkSync.getDestination(id) -> Polytomic.BulkSyncDestEnvelope

🔌 Usage

await client.bulkSync.getDestination("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: BulkSync.RequestOptions

Connections

client.connections.getTypes() -> Polytomic.ConnectionTypeResponseEnvelope

🔌 Usage

await client.connections.getTypes();

⚙️ Parameters

requestOptions: Connections.RequestOptions

client.connections.getConnectionTypeSchema(id) -> Polytomic.JsonschemaSchema

🔌 Usage

await client.connections.getConnectionTypeSchema("postgresql");

⚙️ Parameters

id: string

requestOptions: Connections.RequestOptions

client.connections.getTypeParameterValues(type_, { ...params }) -> Polytomic.ConnectionParameterValuesResponseEnvelope

🔌 Usage

await client.connections.getTypeParameterValues("type", {
    field: "field",
});

⚙️ Parameters

type_: string

request: Polytomic.GetConnectionTypeParameterValuesRequestSchema

requestOptions: Connections.RequestOptions

client.connections.list() -> Polytomic.ConnectionListResponseEnvelope

🔌 Usage

await client.connections.list();

⚙️ Parameters

requestOptions: Connections.RequestOptions

client.connections.create({ ...params }) -> Polytomic.CreateConnectionResponseEnvelope

🔌 Usage

await client.connections.create({
    configuration: {
        database: "example",
        hostname: "postgres.example.com",
        password: "********",
        port: 5432,
        username: "user",
    },
    name: "My Postgres Connection",
    type: "postgresql",
});

⚙️ Parameters

request: Polytomic.CreateConnectionRequestSchema

requestOptions: Connections.RequestOptions

client.connections.connect({ ...params }) -> Polytomic.ConnectCardResponseEnvelope

📝 Description

Creates a new request for Polytomic Connect.

This endpoint configures a Polytomic Connect request and returns the URL to redirect users to. This allows embedding Polytomic connection authorization in other applications.

See also:

• Embedding authentication, a guide to using Polytomic Connect.

🔌 Usage

await client.connections.connect({
    name: "Salesforce Connection",
    redirect_url: "redirect_url",
});

⚙️ Parameters

request: Polytomic.ConnectCardRequest

requestOptions: Connections.RequestOptions

client.connections.testConnection({ ...params }) -> void

📝 Description

Tests a connection configuration.

🔌 Usage

await client.connections.testConnection({
    configuration: {
        database: "example",
        hostname: "postgres.example.com",
        password: "password",
        port: 5432,
        username: "user",
    },
    type: "postgresql",
});

⚙️ Parameters

request: Polytomic.TestConnectionRequest

requestOptions: Connections.RequestOptions

client.connections.get(id) -> Polytomic.ConnectionResponseEnvelope

🔌 Usage

await client.connections.get("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: Connections.RequestOptions

client.connections.update(id, { ...params }) -> Polytomic.CreateConnectionResponseEnvelope

🔌 Usage

await client.connections.update("248df4b7-aa70-47b8-a036-33ac447e668d", {
    configuration: {
        database: "example",
        hostname: "postgres.example.com",
        password: "********",
        port: 5432,
        username: "user",
    },
    name: "My Postgres Connection",
});

⚙️ Parameters

id: string

request: Polytomic.UpdateConnectionRequestSchema

requestOptions: Connections.RequestOptions

client.connections.remove(id, { ...params }) -> void

🔌 Usage

await client.connections.remove("248df4b7-aa70-47b8-a036-33ac447e668d", {
    force: true,
});

⚙️ Parameters

id: string

request: Polytomic.ConnectionsRemoveRequest

requestOptions: Connections.RequestOptions

client.connections.getParameterValues(id) -> Polytomic.ConnectionParameterValuesResponseEnvelope

🔌 Usage

await client.connections.getParameterValues("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: Connections.RequestOptions

client.connections.createSharedConnection(parentConnectionId, { ...params }) -> Polytomic.V2CreateSharedConnectionResponseEnvelope

📝 Description

🚧 Requires partner key

Shared connections can only be created by using partner keys.

🔌 Usage

await client.connections.createSharedConnection("248df4b7-aa70-47b8-a036-33ac447e668d", {
    child_organization_id: "248df4b7-aa70-47b8-a036-33ac447e668d",
});

⚙️ Parameters

parentConnectionId: string

request: Polytomic.ApiRequest

requestOptions: Connections.RequestOptions

client.connections.listSharedConnections(parentConnectionId) -> Polytomic.ConnectionListResponseEnvelope

🔌 Usage

await client.connections.listSharedConnections("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

parentConnectionId: string

requestOptions: Connections.RequestOptions

QueryRunner

client.queryRunner.runQuery(connectionId, { ...params }) -> Polytomic.V4RunQueryEnvelope

📝 Description

Submit a query for asynchronous execution against the connection. The initial response may only contain the query task id and status. Poll GET /api/queries/{id} with the returned id to retrieve completion status, fields, and results.

🔌 Usage

await client.queryRunner.runQuery("248df4b7-aa70-47b8-a036-33ac447e668d", {
    query: "SELECT * FROM table",
});

⚙️ Parameters

connectionId: string

request: Polytomic.V4RunQueryRequest

requestOptions: QueryRunner.RequestOptions

client.queryRunner.getQuery(id, { ...params }) -> Polytomic.V4QueryResultsEnvelope

📝 Description

Fetch the latest status for a submitted query and, once complete, return fields and paginated results. Use the query id returned by POST /api/connections/{connection_id}/query.

🔌 Usage

await client.queryRunner.getQuery("248df4b7-aa70-47b8-a036-33ac447e668d", {
    page: "page",
});

⚙️ Parameters

id: string

request: Polytomic.QueryRunnerGetQueryRequest

requestOptions: QueryRunner.RequestOptions

Schemas

client.schemas.upsertField(connectionId, schemaId, { ...params }) -> void

🔌 Usage

await client.schemas.upsertField("248df4b7-aa70-47b8-a036-33ac447e668d", "public.users");

⚙️ Parameters

connectionId: string

schemaId: string

request: Polytomic.UpsertSchemaFieldRequest

requestOptions: Schemas.RequestOptions

client.schemas.deleteField(connectionId, schemaId, fieldId) -> void

🔌 Usage

await client.schemas.deleteField("248df4b7-aa70-47b8-a036-33ac447e668d", "public.users", "first_name");

⚙️ Parameters

connectionId: string

schemaId: string

fieldId: string

requestOptions: Schemas.RequestOptions

client.schemas.setPrimaryKeys(connectionId, schemaId, { ...params }) -> void

🔌 Usage

await client.schemas.setPrimaryKeys("248df4b7-aa70-47b8-a036-33ac447e668d", "public.users");

⚙️ Parameters

connectionId: string

schemaId: string

request: Polytomic.SetPrimaryKeysRequest

requestOptions: Schemas.RequestOptions

client.schemas.resetPrimaryKeys(connectionId, schemaId) -> void

📝 Description

Delete all primary key overrides for a schema. After this call the schema will use the primary keys detected from the source connection, if any.

🔌 Usage

await client.schemas.resetPrimaryKeys("248df4b7-aa70-47b8-a036-33ac447e668d", "public.users");

⚙️ Parameters

connectionId: string

schemaId: string

requestOptions: Schemas.RequestOptions

client.schemas.refresh(id) -> void

🔌 Usage

await client.schemas.refresh("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: Schemas.RequestOptions

client.schemas.getStatus(id) -> Polytomic.BulkSyncSourceStatusEnvelope

📝 Description

Polytomic periodically inspects the schemas for connections to discover new fields and update metadata. This endpoint returns the current inspection status.

🔌 Usage

await client.schemas.getStatus("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: Schemas.RequestOptions

client.schemas.get(id, schemaId) -> Polytomic.BulkSyncSourceSchemaEnvelope

🔌 Usage

await client.schemas.get("248df4b7-aa70-47b8-a036-33ac447e668d", "public.users");

⚙️ Parameters

id: string

schemaId: string

requestOptions: Schemas.RequestOptions

client.schemas.getRecords(id, schemaId) -> Polytomic.SchemaRecordsResponseEnvelope

🔌 Usage

await client.schemas.getRecords("248df4b7-aa70-47b8-a036-33ac447e668d", "public.users");

⚙️ Parameters

id: string

schemaId: string

requestOptions: Schemas.RequestOptions

Models

client.models.getEnrichmentSource(id, { ...params }) -> Polytomic.GetModelSyncSourceMetaEnvelope

🔌 Usage

await client.models.getEnrichmentSource("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

request: Polytomic.ModelsGetEnrichmentSourceRequest

requestOptions: Models.RequestOptions

client.models.post(connectionId, { ...params }) -> Polytomic.V2GetEnrichmentInputFieldsResponseEnvelope

📝 Description

For a given connection and enrichment configuration, provides the valid sets of input fields.

🔌 Usage

await client.models.post("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

connectionId: string

request: Polytomic.GetEnrichmentInputFieldsRequest

requestOptions: Models.RequestOptions

client.models.preview({ ...params }) -> Polytomic.ModelResponseEnvelope

🔌 Usage

await client.models.preview({
    async: true,
    body: {
        configuration: {
            table: "public.users",
        },
        connection_id: "248df4b7-aa70-47b8-a036-33ac447e668d",
        name: "Users",
    },
});

⚙️ Parameters

request: Polytomic.ModelsPreviewRequest

requestOptions: Models.RequestOptions

client.models.list() -> Polytomic.ModelListResponseEnvelope

🔌 Usage

await client.models.list();

⚙️ Parameters

requestOptions: Models.RequestOptions

client.models.create({ ...params }) -> Polytomic.ModelResponseEnvelope

🔌 Usage

await client.models.create({
    async: true,
    body: {
        configuration: {
            table: "public.users",
        },
        connection_id: "248df4b7-aa70-47b8-a036-33ac447e668d",
        name: "Users",
    },
});

⚙️ Parameters

request: Polytomic.ModelsCreateRequest

requestOptions: Models.RequestOptions

client.models.get(id, { ...params }) -> Polytomic.ModelResponseEnvelope

🔌 Usage

await client.models.get("248df4b7-aa70-47b8-a036-33ac447e668d", {
    async: true,
});

⚙️ Parameters

id: string

request: Polytomic.ModelsGetRequest

requestOptions: Models.RequestOptions

client.models.update(id, { ...params }) -> Polytomic.ModelResponseEnvelope

🔌 Usage

await client.models.update("248df4b7-aa70-47b8-a036-33ac447e668d", {
    async: false,
    configuration: {
        table: "public.users",
    },
    connection_id: "248df4b7-aa70-47b8-a036-33ac447e668d",
    name: "Users",
});

⚙️ Parameters

id: string

request: Polytomic.UpdateModelRequest

requestOptions: Models.RequestOptions

client.models.remove(id, { ...params }) -> void

🔌 Usage

await client.models.remove("248df4b7-aa70-47b8-a036-33ac447e668d", {
    async: true,
});

⚙️ Parameters

id: string

request: Polytomic.ModelsRemoveRequest

requestOptions: Models.RequestOptions

client.models.sample(id, { ...params }) -> Polytomic.ModelSampleResponseEnvelope

📝 Description

Returns sample records from the model. The first ten records that the source provides will be returned after being enriched (if applicable). Synchronous requests must complete within 10s. If either querying or enrichment exceeds 10s, please use the async option.

🔌 Usage

await client.models.sample("248df4b7-aa70-47b8-a036-33ac447e668d", {
    async: true,
});

⚙️ Parameters

id: string

request: Polytomic.ModelsSampleRequest

requestOptions: Models.RequestOptions

ModelSync

client.modelSync.getSource(id, { ...params }) -> Polytomic.GetModelSyncSourceMetaEnvelope

🔌 Usage

await client.modelSync.getSource("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

request: Polytomic.ModelSyncGetSourceRequest

requestOptions: ModelSync.RequestOptions

client.modelSync.getSourceFields(id, { ...params }) -> Polytomic.ModelFieldResponse

🔌 Usage

await client.modelSync.getSourceFields("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

request: Polytomic.ModelSyncGetSourceFieldsRequest

requestOptions: ModelSync.RequestOptions

client.modelSync.list({ ...params }) -> Polytomic.ListModelSyncResponseEnvelope

🔌 Usage

await client.modelSync.list({
    active: true,
    mode: "create",
    target_connection_id: "0b155265-c537-44c9-9359-a3ceb468a4da",
});

⚙️ Parameters

request: Polytomic.ModelSyncListRequest

requestOptions: ModelSync.RequestOptions

client.modelSync.create({ ...params }) -> Polytomic.ModelSyncResponseEnvelope

📝 Description

Create a new sync from one or more models to a destination.

All of the functionality described in the product documentation is configurable via the API.

Guides:

• Model sync (Reverse ETL) from Snowflake query to Salesforce
• Joined model sync from Postgres, Airtable, and Stripe to Hubspot

Targets (Destinations)

Polytomic refers to a model sync's destination as the "target object", or target. Target objects are identified by a connection ID and an object ID. You can retrieve a list of all target objects for a connection using the Get Target Objects endpoint.

The target object in the request specifies information about the sync destination.

"target": {
    "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "object": "Users",
},

Some connections support additional configuration for targets. For example, Salesforce connections support optionally specifying the ingestion API to use. The target specific options are passed as configuration; consult the integration guides for details about specific connection configurations.

Creating a new target

Some integrations support creating a new target when creating a model sync. For example, an ad audience or database table.

When creating a new target, object is omitted and create is specified instead. The create property is an object containing integration specific configuration for the new target.

"target": {
    "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "create": {
        "name": "New audience",
        "type": "user_audience"
    }
},

The Get Target List endpoint returns information about whether a connection supports target creation.

🔌 Usage

await client.modelSync.create({
    fields: [
        {
            target: "name",
        },
    ],
    mode: "create",
    name: "Users Sync",
    schedule: {},
    target: {
        connection_id: "248df4b7-aa70-47b8-a036-33ac447e668d",
    },
});

⚙️ Parameters

request: Polytomic.CreateModelSyncRequest

requestOptions: ModelSync.RequestOptions

client.modelSync.getScheduleOptions() -> Polytomic.ScheduleOptionResponseEnvelope

🔌 Usage

await client.modelSync.getScheduleOptions();

⚙️ Parameters

requestOptions: ModelSync.RequestOptions

client.modelSync.get(id) -> Polytomic.ModelSyncResponseEnvelope

🔌 Usage

await client.modelSync.get("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: ModelSync.RequestOptions

client.modelSync.update(id, { ...params }) -> Polytomic.ModelSyncResponseEnvelope

🔌 Usage

await client.modelSync.update("248df4b7-aa70-47b8-a036-33ac447e668d", {
    fields: [
        {
            target: "name",
        },
    ],
    mode: "create",
    name: "Users Sync",
    schedule: {},
    target: {
        connection_id: "248df4b7-aa70-47b8-a036-33ac447e668d",
    },
});

⚙️ Parameters

id: string

request: Polytomic.UpdateModelSyncRequest

requestOptions: ModelSync.RequestOptions

client.modelSync.remove(id) -> void

🔌 Usage

await client.modelSync.remove("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: ModelSync.RequestOptions

client.modelSync.activate(id, { ...params }) -> Polytomic.ActivateSyncEnvelope

🔌 Usage

await client.modelSync.activate("248df4b7-aa70-47b8-a036-33ac447e668d", {
    active: true,
});

⚙️ Parameters

id: string

request: Polytomic.ActivateSyncInput

requestOptions: ModelSync.RequestOptions

client.modelSync.cancel(id) -> Polytomic.CancelModelSyncResponseEnvelope

🔌 Usage

await client.modelSync.cancel("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string — The active execution of this sync ID will be cancelled.

requestOptions: ModelSync.RequestOptions

client.modelSync.start(id, { ...params }) -> Polytomic.StartModelSyncResponseEnvelope

📝 Description

🚧 Force full resync

Use caution when setting the resync parameter to true. This will force a full resync of the data from the source system. This can be a time-consuming operation and may impact the performance of the source system. It is recommended to only use this option when necessary.

🔌 Usage

await client.modelSync.start("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

request: Polytomic.StartModelSyncRequest

requestOptions: ModelSync.RequestOptions

client.modelSync.getStatus(id) -> Polytomic.SyncStatusEnvelope

🔌 Usage

await client.modelSync.getStatus("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: ModelSync.RequestOptions

Events

client.events.list({ ...params }) -> Polytomic.EventsEnvelope

🔌 Usage

await client.events.list({
    organization_id: "248df4b7-aa70-47b8-a036-33ac447e668d",
    type: "type",
    starting_after: "2020-01-01T00:00:00Z",
    ending_before: "2020-01-01T00:00:00Z",
    limit: 1,
});

⚙️ Parameters

request: Polytomic.EventsListRequest

requestOptions: Events.RequestOptions

client.events.getTypes() -> Polytomic.EventTypesEnvelope

🔌 Usage

await client.events.getTypes();

⚙️ Parameters

requestOptions: Events.RequestOptions

Jobs

client.jobs.get(type_, id) -> Polytomic.JobResponseEnvelope

🔌 Usage

await client.jobs.get("createmodel", "248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

type_: string

id: string

requestOptions: Jobs.RequestOptions

Identity

client.identity.get() -> Polytomic.GetIdentityResponseEnvelope

📝 Description

Returns information about the caller's identity.

🔌 Usage

await client.identity.get();

⚙️ Parameters

requestOptions: Identity.RequestOptions

Notifications

client.notifications.getGlobalErrorSubscribers() -> Polytomic.V4GlobalErrorSubscribersResponse

🔌 Usage

await client.notifications.getGlobalErrorSubscribers();

⚙️ Parameters

requestOptions: Notifications.RequestOptions

client.notifications.setGlobalErrorSubscribers({ ...params }) -> Polytomic.V4GlobalErrorSubscribersResponse

🔌 Usage

await client.notifications.setGlobalErrorSubscribers();

⚙️ Parameters

request: Polytomic.V4GlobalErrorSubscribersRequest

requestOptions: Notifications.RequestOptions

Organization

client.organization.list() -> Polytomic.OrganizationsEnvelope

📝 Description

🚧 Requires partner key

Organization endpoints are only accessible using partner keys.

🔌 Usage

await client.organization.list();

⚙️ Parameters

requestOptions: Organization.RequestOptions

client.organization.create({ ...params }) -> Polytomic.OrganizationEnvelope

📝 Description

🚧 Requires partner key

Organization endpoints are only accessible using partner keys.

🔌 Usage

await client.organization.create({
    name: "My Organization",
});

⚙️ Parameters

request: Polytomic.CreateOrganizationRequestSchema

requestOptions: Organization.RequestOptions

client.organization.get(id) -> Polytomic.OrganizationEnvelope

📝 Description

🚧 Requires partner key

Organization endpoints are only accessible using partner keys.

🔌 Usage

await client.organization.get("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: Organization.RequestOptions

client.organization.update(id, { ...params }) -> Polytomic.OrganizationEnvelope

📝 Description

🚧 Requires partner key

Organization endpoints are only accessible using partner keys.

🔌 Usage

await client.organization.update("248df4b7-aa70-47b8-a036-33ac447e668d", {
    name: "My Organization",
});

⚙️ Parameters

id: string

request: Polytomic.UpdateOrganizationRequestSchema

requestOptions: Organization.RequestOptions

client.organization.remove(id) -> void

📝 Description

🚧 Requires partner key

Organization endpoints are only accessible using partner keys.

🔌 Usage

await client.organization.remove("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: Organization.RequestOptions

Users

client.users.list(orgId) -> Polytomic.ListUsersEnvelope

🔌 Usage

await client.users.list("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

orgId: string

requestOptions: Users.RequestOptions

client.users.create(orgId, { ...params }) -> Polytomic.UserEnvelope

🔌 Usage

await client.users.create("248df4b7-aa70-47b8-a036-33ac447e668d", {
    email: "mail@example.com",
});

⚙️ Parameters

orgId: string

request: Polytomic.CreateUserRequestSchema

requestOptions: Users.RequestOptions

client.users.get(orgId, id) -> Polytomic.UserEnvelope

🔌 Usage

await client.users.get("248df4b7-aa70-47b8-a036-33ac447e668d", "248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

orgId: string

id: string

requestOptions: Users.RequestOptions

client.users.update(orgId, id, { ...params }) -> Polytomic.UserEnvelope

🔌 Usage

await client.users.update("248df4b7-aa70-47b8-a036-33ac447e668d", "248df4b7-aa70-47b8-a036-33ac447e668d", {
    email: "mail@example.com",
});

⚙️ Parameters

orgId: string

id: string

request: Polytomic.UpdateUserRequestSchema

requestOptions: Users.RequestOptions

client.users.remove(orgId, id) -> Polytomic.UserEnvelope

🔌 Usage

await client.users.remove("248df4b7-aa70-47b8-a036-33ac447e668d", "248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

orgId: string

id: string

requestOptions: Users.RequestOptions

client.users.createApiKey(orgId, id, { ...params }) -> Polytomic.ApiKeyResponseEnvelope

📝 Description

🚧 Requires partner key

User endpoints are only accessible using partner keys.

🔌 Usage

await client.users.createApiKey("248df4b7-aa70-47b8-a036-33ac447e668d", "248df4b7-aa70-47b8-a036-33ac447e668d", {
    force: true,
});

⚙️ Parameters

orgId: string

id: string

request: Polytomic.UsersCreateApiKeyRequest

requestOptions: Users.RequestOptions

Webhooks

client.webhooks.list() -> Polytomic.WebhookListEnvelope

📝 Description

Webooks can be set up using the webhook API endpoints. Currently, only one webhook may be created per organization. The webhook will be called for events in that organization.

Consult the Events documentation for more information.

🔌 Usage

await client.webhooks.list();

⚙️ Parameters

requestOptions: Webhooks.RequestOptions

client.webhooks.create({ ...params }) -> Polytomic.WebhookEnvelope

📝 Description

Webooks can be set up using the webhook API endpoints. Currently, only one webhook may be created per organization. The webhook will be called for events in that organization.

Consult the Events documentation for more information.

🔌 Usage

await client.webhooks.create({
    endpoint: "https://example.com/webhook",
    secret: "secret",
});

⚙️ Parameters

request: Polytomic.CreateWebhooksSchema

requestOptions: Webhooks.RequestOptions

client.webhooks.get(id) -> Polytomic.WebhookEnvelope

📝 Description

Webooks can be set up using the webhook API endpoints. Currently, only one webhook may be created per organization. The webhook will be called for events in that organization.

Consult the Events documentation for more information.

🔌 Usage

await client.webhooks.get("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: Webhooks.RequestOptions

client.webhooks.update(id, { ...params }) -> Polytomic.WebhookEnvelope

📝 Description

Webooks can be set up using the webhook API endpoints. Currently, only one webhook may be created per organization. The webhook will be called for events in that organization.

Consult the Events documentation for more information.

🔌 Usage

await client.webhooks.update("248df4b7-aa70-47b8-a036-33ac447e668d", {
    endpoint: "https://example.com/webhook",
    secret: "secret",
});

⚙️ Parameters

id: string

request: Polytomic.UpdateWebhooksSchema

requestOptions: Webhooks.RequestOptions

client.webhooks.remove(id) -> void

🔌 Usage

await client.webhooks.remove("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: Webhooks.RequestOptions

client.webhooks.disable(id) -> Polytomic.WebhookEnvelope

🔌 Usage

await client.webhooks.disable("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: Webhooks.RequestOptions

client.webhooks.enable(id) -> Polytomic.WebhookEnvelope

🔌 Usage

await client.webhooks.enable("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: Webhooks.RequestOptions

BulkSync Executions

client.bulkSync.executions.listStatus({ ...params }) -> Polytomic.ListBulkSyncExecutionStatusEnvelope

🔌 Usage

await client.bulkSync.executions.listStatus({
    all: true,
    active: true,
});

⚙️ Parameters

request: Polytomic.bulkSync.ExecutionsListStatusRequest

requestOptions: Executions.RequestOptions

client.bulkSync.executions.list(id, { ...params }) -> Polytomic.ListBulkSyncExecutionsEnvelope

🔌 Usage

await client.bulkSync.executions.list("248df4b7-aa70-47b8-a036-33ac447e668d", {
    page_token: "AmkYh8v0jR5B3kls2Qcc9y8MjrPmvR4CvaK7H0F4rEwqvg76K==",
    only_terminal: true,
    ascending: true,
    limit: 100,
});

⚙️ Parameters

id: string

request: Polytomic.bulkSync.ExecutionsListRequest

requestOptions: Executions.RequestOptions

client.bulkSync.executions.get(id, execId) -> Polytomic.BulkSyncExecutionEnvelope

🔌 Usage

await client.bulkSync.executions.get("248df4b7-aa70-47b8-a036-33ac447e668d", "248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

execId: string

requestOptions: Executions.RequestOptions

client.bulkSync.executions.cancel(id, execId) -> Polytomic.CancelBulkSyncResponseEnvelope

🔌 Usage

await client.bulkSync.executions.cancel("248df4b7-aa70-47b8-a036-33ac447e668d", "248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string — The bulk sync ID.

execId: string — The execution ID to cancel.

requestOptions: Executions.RequestOptions

client.bulkSync.executions.getLogs(syncId, executionId) -> Polytomic.V4BulkSyncExecutionLogsEnvelope

🔌 Usage

await client.bulkSync.executions.getLogs(
    "248df4b7-aa70-47b8-a036-33ac447e668d",
    "248df4b7-aa70-47b8-a036-33ac447e668d",
);

⚙️ Parameters

syncId: string

executionId: string

requestOptions: Executions.RequestOptions

client.bulkSync.executions.exportLogs(syncId, executionId, { ...params }) -> Polytomic.V4ExportSyncLogsEnvelope

🔌 Usage

await client.bulkSync.executions.exportLogs(
    "248df4b7-aa70-47b8-a036-33ac447e668d",
    "248df4b7-aa70-47b8-a036-33ac447e668d",
    {
        notify: true,
    },
);

⚙️ Parameters

syncId: string

executionId: string

request: Polytomic.bulkSync.ExecutionsExportLogsRequest

requestOptions: Executions.RequestOptions

BulkSync Schemas

client.bulkSync.schemas.list(id, { ...params }) -> Polytomic.ListBulkSchema

🔌 Usage

await client.bulkSync.schemas.list("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

request: Polytomic.bulkSync.SchemasListRequest

requestOptions: Schemas.RequestOptions

client.bulkSync.schemas.patch(id, { ...params }) -> Polytomic.ListBulkSchema

🔌 Usage

await client.bulkSync.schemas.patch("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

request: Polytomic.bulkSync.BulkSyncSchemasRequest

requestOptions: Schemas.RequestOptions

client.bulkSync.schemas.get(id, schemaId) -> Polytomic.BulkSchemaEnvelope

🔌 Usage

await client.bulkSync.schemas.get("248df4b7-aa70-47b8-a036-33ac447e668d", "Contact");

⚙️ Parameters

id: string

schemaId: string

requestOptions: Schemas.RequestOptions

client.bulkSync.schemas.update(id, schemaId, { ...params }) -> Polytomic.BulkSchemaEnvelope

🔌 Usage

await client.bulkSync.schemas.update("248df4b7-aa70-47b8-a036-33ac447e668d", "contact");

⚙️ Parameters

id: string

schemaId: string

request: Polytomic.bulkSync.UpdateBulkSchema

requestOptions: Schemas.RequestOptions

client.bulkSync.schemas.cancel(id, schemaId) -> Polytomic.CancelBulkSyncResponseEnvelope

🔌 Usage

await client.bulkSync.schemas.cancel("248df4b7-aa70-47b8-a036-33ac447e668d", "schema_id");

⚙️ Parameters

id: string — The bulk sync ID.

schemaId: string — The schema ID to cancel for the bulk sync.

requestOptions: Schemas.RequestOptions

BulkSync Schedules

client.bulkSync.schedules.list(syncId) -> Polytomic.SchedulesEnvelope

🔌 Usage

await client.bulkSync.schedules.list("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

syncId: string

requestOptions: Schedules.RequestOptions

client.bulkSync.schedules.create(syncId, { ...params }) -> Polytomic.ScheduleEnvelope

🔌 Usage

await client.bulkSync.schedules.create("248df4b7-aa70-47b8-a036-33ac447e668d", {
    schedule: {
        frequency: "manual",
    },
});

⚙️ Parameters

syncId: string

request: Polytomic.bulkSync.CreateScheduleRequest

requestOptions: Schedules.RequestOptions

client.bulkSync.schedules.get(syncId, scheduleId) -> Polytomic.ScheduleEnvelope

🔌 Usage

await client.bulkSync.schedules.get("248df4b7-aa70-47b8-a036-33ac447e668d", "248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

syncId: string

scheduleId: string

requestOptions: Schedules.RequestOptions

client.bulkSync.schedules.update(syncId, scheduleId, { ...params }) -> Polytomic.ScheduleEnvelope

🔌 Usage

await client.bulkSync.schedules.update("248df4b7-aa70-47b8-a036-33ac447e668d", "248df4b7-aa70-47b8-a036-33ac447e668d", {
    schedule: {
        frequency: "manual",
    },
});

⚙️ Parameters

syncId: string

scheduleId: string

request: Polytomic.bulkSync.UpdateScheduleRequest

requestOptions: Schedules.RequestOptions

client.bulkSync.schedules.delete(syncId, scheduleId) -> void

🔌 Usage

await client.bulkSync.schedules.delete("248df4b7-aa70-47b8-a036-33ac447e668d", "248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

syncId: string

scheduleId: string

requestOptions: Schedules.RequestOptions

ModelSync Targets

client.modelSync.targets.getTarget(id, { ...params }) -> Polytomic.GetConnectionMetaEnvelope

🔌 Usage

await client.modelSync.targets.getTarget("248df4b7-aa70-47b8-a036-33ac447e668d", {
    type: "type",
    search: "search",
});

⚙️ Parameters

id: string

request: Polytomic.modelSync.TargetsGetTargetRequest

requestOptions: Targets.RequestOptions

client.modelSync.targets.getTargetFields(id, { ...params }) -> Polytomic.TargetResponseEnvelope

🔌 Usage

await client.modelSync.targets.getTargetFields("248df4b7-aa70-47b8-a036-33ac447e668d", {
    target: "database.table",
    refresh: false,
});

⚙️ Parameters

id: string

request: Polytomic.modelSync.TargetsGetTargetFieldsRequest

requestOptions: Targets.RequestOptions

client.modelSync.targets.list(id) -> Polytomic.V4TargetObjectsResponseEnvelope

📝 Description

Returns available model sync destinations for a connection.

If the connection supports creating new destinations, the target_creation object will contain information on what properties are required to create the target.

Target creation properties are all string values; the enum flag indicates if the property has a fixed set of valid values. When enum is true, the Target Creation Property Values endpoint can be used to retrieve the valid values.

Sync modes

The sync mode determines which records are written to the destination for a model sync. The modes array for a target object defines the id along with what operations the mode supports.

🔌 Usage

await client.modelSync.targets.list("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: Targets.RequestOptions

client.modelSync.targets.getCreateProperty(id, property) -> Polytomic.V4TargetPropertyValuesEnvelope

📝 Description

Connections which support creating new sync target objects (destinations) will return target_creation with their target object list. This endpoint will return possible values for properties where enum is true.

If the connection does not support creating new target objects, an HTTP 404 will be returned.

The values array lists the valid options (and labels) for the property. Each member of the values array has a label and value. For exaample,

{
    "data": [
        {
            "id": "account",
            "title": "Account ID",
            "enum": true,
            "values": [
                {
                    "value": "1234567::urn:li:organization:987654",
                    "label": "Polytomic Inc. (1234567)"
                }
            ]
        }
    ]
}

The value for the selected option should be passed when creating a sync.

🔌 Usage

await client.modelSync.targets.getCreateProperty("248df4b7-aa70-47b8-a036-33ac447e668d", "property");

⚙️ Parameters

id: string

property: string

requestOptions: Targets.RequestOptions

ModelSync Executions

client.modelSync.executions.list(syncId, { ...params }) -> Polytomic.ListExecutionResponseEnvelope

🔌 Usage

await client.modelSync.executions.list("248df4b7-aa70-47b8-a036-33ac447e668d", {
    page_token: "AmkYh8v0jR5B3kls2Qcc9y8MjrPmvR4CvaK7H0F4rEwqvg76K==",
    only_completed: true,
    ascending: true,
});

⚙️ Parameters

syncId: string

request: Polytomic.modelSync.ExecutionsListRequest

requestOptions: Executions.RequestOptions

client.modelSync.executions.get(syncId, id) -> Polytomic.GetExecutionResponseEnvelope

🔌 Usage

await client.modelSync.executions.get("248df4b7-aa70-47b8-a036-33ac447e668d", "248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

syncId: string

id: string

requestOptions: Executions.RequestOptions

client.modelSync.executions.update(syncId, id, { ...params }) -> Polytomic.GetExecutionResponseEnvelope

🔌 Usage

await client.modelSync.executions.update(
    "248df4b7-aa70-47b8-a036-33ac447e668d",
    "248df4b7-aa70-47b8-a036-33ac447e668d",
    {
        status: "created",
    },
);

⚙️ Parameters

syncId: string

id: string — The ID of the execution to update.

request: Polytomic.modelSync.UpdateExecutionRequest

requestOptions: Executions.RequestOptions

client.modelSync.executions.getLogUrls(syncId, id, type_) -> Polytomic.ExecutionLogsResponseEnvelope

🔌 Usage

await client.modelSync.executions.getLogUrls(
    "248df4b7-aa70-47b8-a036-33ac447e668d",
    "248df4b7-aa70-47b8-a036-33ac447e668d",
    "records",
);

⚙️ Parameters

syncId: string

id: string

type_: Polytomic.V2ExecutionLogType

requestOptions: Executions.RequestOptions

client.modelSync.executions.getLogs(syncId, id, type_, filename) -> void

🔌 Usage

await client.modelSync.executions.getLogs(
    "248df4b7-aa70-47b8-a036-33ac447e668d",
    "0ecd09c1-b901-4d27-9053-f0367c427254",
    "records",
    "path/to/file.json",
);

⚙️ Parameters

syncId: string

id: string

type_: Polytomic.V2ExecutionLogType

filename: string

requestOptions: Executions.RequestOptions

Permissions Policies

client.permissions.policies.list() -> Polytomic.ListPoliciesResponseEnvelope

🔌 Usage

await client.permissions.policies.list();

⚙️ Parameters

requestOptions: Policies.RequestOptions

client.permissions.policies.create({ ...params }) -> Polytomic.PolicyResponseEnvelope

🔌 Usage

await client.permissions.policies.create({
    name: "Custom",
});

⚙️ Parameters

request: Polytomic.permissions.CreatePolicyRequest

requestOptions: Policies.RequestOptions

client.permissions.policies.get(id) -> Polytomic.PolicyResponseEnvelope

🔌 Usage

await client.permissions.policies.get("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: Policies.RequestOptions

client.permissions.policies.update(id, { ...params }) -> Polytomic.PolicyResponseEnvelope

🔌 Usage

await client.permissions.policies.update("248df4b7-aa70-47b8-a036-33ac447e668d", {
    name: "Custom",
});

⚙️ Parameters

id: string

request: Polytomic.permissions.UpdatePolicyRequest

requestOptions: Policies.RequestOptions

client.permissions.policies.remove(id) -> void

🔌 Usage

await client.permissions.policies.remove("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: Policies.RequestOptions

Permissions Roles

client.permissions.roles.list() -> Polytomic.RoleListResponseEnvelope

🔌 Usage

await client.permissions.roles.list();

⚙️ Parameters

requestOptions: Roles.RequestOptions

client.permissions.roles.create({ ...params }) -> Polytomic.RoleResponseEnvelope

🔌 Usage

await client.permissions.roles.create({
    name: "Custom",
});

⚙️ Parameters

request: Polytomic.permissions.CreateRoleRequest

requestOptions: Roles.RequestOptions

client.permissions.roles.get(id) -> Polytomic.RoleResponseEnvelope

🔌 Usage

await client.permissions.roles.get("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: Roles.RequestOptions

client.permissions.roles.update(id, { ...params }) -> Polytomic.RoleResponseEnvelope

🔌 Usage

await client.permissions.roles.update("248df4b7-aa70-47b8-a036-33ac447e668d", {
    name: "Custom",
});

⚙️ Parameters

id: string

request: Polytomic.permissions.UpdateRoleRequest

requestOptions: Roles.RequestOptions

client.permissions.roles.remove(id) -> void

🔌 Usage

await client.permissions.roles.remove("248df4b7-aa70-47b8-a036-33ac447e668d");

⚙️ Parameters

id: string

requestOptions: Roles.RequestOptions