Models

AddDatasetDataTableNodeRequest

Parameters:

Name	Type	Description	Default
`node_type`	`StrictStr`	Type of node in the transformation graph (TABLE for DataTable references, RECIPE for transformation logic)	`None`
`dataset_id`	`StrictInt`	Unique identifier of the Dataset that contains this node	`None`
`data_table_id`	`StrictInt`	Unique identifier of the referenced DataTable	`None`
`data_table_version_number`	`StrictInt \| None`	Specific version number of the DataTable to use in the transformation	`None`

AddDatasetNodeRequest

Use one of: AddDatasetRecipeNodeRequest, AddDatasetDataTableNodeRequest.

Parameters:

Name	Type	Description	Default
`node_type`	`StrictStr`	Type of node in the transformation graph (TABLE for DataTable references, RECIPE for transformation logic)	`None`
`dataset_id`	`StrictInt`	Unique identifier of the Dataset that contains this node	`None`

AddDatasetRecipeNodeRequest

Creates a new recipe node in the transformation graph by referencing an existing recipe. Users must first create a recipe via POST /recipes, then add it to the dataset graph using this endpoint.

Parameters:

Name	Type	Description	Default
`node_type`	`StrictStr`	Type of node in the transformation graph (TABLE for DataTable references, RECIPE for transformation logic)	`None`
`dataset_id`	`StrictInt`	Unique identifier of the Dataset that contains this node	`None`
`source_node_definitions`	`ConstrainedListValue`	Source nodes with aliases. Size must equal recipeVersion.aliases.size().	`None`
`recipe_id`	`StrictInt`	ID of the existing recipe to add to the transformation graph	`None`
`recipe_version_number`	`StrictInt`	Specific version of the recipe to use	`None`

BigQueryConnectionResponse

Response for a BigQuery Connection that provides access to Google BigQuery, including authentication details and dataset configuration.

Parameters:

Name	Type	Description	Default
`read`	`StrictBool \| None`	If true, the connection has read permission for import.	`True`
`write`	`StrictBool \| None`	If true, the connection has write permission for export.	`False`
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue \| None`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`created_by`	`User \| None`	An enumeration.	`None`
`created_date`	`datetime \| None`	The date and time when the entity was created	`None`
`last_modified_by`	`User \| None`	An enumeration.	`None`
`last_modified_date`	`datetime \| None`	The date and time when the entity was last modified	`None`
`type`	`StrictStr`	The type of Connection (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`dataset_id`	`ConstrainedStrValue \| None`	Optional BigQuery dataset ID to scope the connection. When set, used as the default dataset for table listing and connection testing.	`None`
`auth`	`GcpAuthResponse \| None`	An enumeration.	`None`

BrowseBucketDataSourceRequest

Request to browse the contents of a bucket DataSource at the specified path, returning a list of available files and folders.

Parameters:

Name	Type	Description	Default
`path`	`ConstrainedStrValue`	The path within the bucket where the data files are located	`None`

BrowseBucketDataSourceResponse

Response containing the contents of a bucket DataSource, including folders, files, and metadata about the browsing operation.

Parameters:

Name	Type	Description	Default
`folders`	`ConstrainedListValue \| None`	List of folders found at the specified path	`None`
`files`	`ConstrainedListValue \| None`	List of files found at the specified path	`None`
`metadata`	`BucketObjectMetadata \| None`	An enumeration.	`None`

BucketDataSourceResponse

Response for a bucket-based DataSource that imports data from cloud storage systems, including the configured storage path and connection details.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`connection_id`	`StrictInt`	The unique identifier of the Connection used by this DataSource	`None`
`type`	`StrictStr`	The type of DataSource (bucket for cloud storage, rdbms for databases)	`None`
`path`	`ConstrainedStrValue \| None`	The path within the bucket where the data files are located	`None`

ClientCredentialsAuthRequest

General authentication request using OAuth2 client credentials flow, requiring token endpoint, client credentials, and connection host information.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method to use for access using OAuth2	`None`
`token_url`	`ConstrainedStrValue`	The OAuth2 token endpoint URL	`None`
`client_id`	`ConstrainedStrValue`	The OAuth2 client ID	`None`
`client_secret`	`ConstrainedStrValue`	The OAuth2 client secret	`None`
`scope`	`ConstrainedStrValue`	The OAuth2 scope for the token request	`None`
`host`	`ConstrainedStrValue`	The host/account identifier	`None`

ClientCredentialsAuthResponse

OAuth authentication response using OAuth2 client credentials flow, containing token endpoint and client information.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method used for OAuth2 access	`None`
`token_url`	`ConstrainedStrValue \| None`	The OAuth2 token endpoint URL	`None`
`client_id`	`ConstrainedStrValue \| None`	The OAuth2 client ID	`None`
`client_secret`	`ConstrainedStrValue \| None`	The OAuth2 client secret	`None`
`scope`	`ConstrainedStrValue \| None`	The OAuth2 scope for the token request	`None`
`host`	`ConstrainedStrValue \| None`	The host/account identifier	`None`

ConnectionResponse

Response containing Connection information including its configuration, authentication details, and metadata. Connections define how to authenticate and connect to external data systems.

May be one of: BigQueryConnectionResponse, DeltaSharingConnectionResponse, GcsConnectionResponse, PriceItDimConnectionResponse, S3ConnectionResponse, SnowflakeConnectionResponse.

Parameters:

Name	Type	Description	Default
`read`	`StrictBool \| None`	If true, the connection has read permission for import.	`True`
`write`	`StrictBool \| None`	If true, the connection has write permission for export.	`False`
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue \| None`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`created_by`	`User \| None`	An enumeration.	`None`
`created_date`	`datetime \| None`	The date and time when the entity was created	`None`
`last_modified_by`	`User \| None`	An enumeration.	`None`
`last_modified_date`	`datetime \| None`	The date and time when the entity was last modified	`None`
`type`	`StrictStr`	The type of Connection (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`

ConnectionsResponse

Collection of Connection objects

Parameters:

Name	Type	Description	Default
`offset`	`StrictInt`	Number of records skipped before current result set	`None`
`limit`	`StrictInt`	Number of records in current result set	`None`
`total`	`StrictInt`	Total number of records available in the database	`None`
`items`	`ConstrainedListValue`	list of Connections in current result set	`None`

ConversationIdResponse

Response containing the details of a newly started conversation in the AI assistant service

Parameters:

Name	Type	Description	Default
`conversation_id`	`StrictStr \| None`	Unique identifier for the newly created conversation in the AI assistant service	`None`

ConversationMessageResponse

Represents a single message within a conversation in the AI assistant service, containing the message content, author, and timestamp

Parameters:

Name	Type	Description	Default
`conversation_id`	`StrictStr \| None`	Unique identifier for the containing conversation	`None`
`type`	`StrictStr \| None`	Type of the message in LLM chat	`None`
`content`	`StrictStr \| None`	Content of the message	`None`
`timestamp`	`datetime \| None`	Date and time when the message was sent	`None`

ConversationResponse

Represents a conversation in the AI assistant service, containing metadata and a list of messages

Parameters:

Name	Type	Description	Default
`conversation_id`	`StrictStr \| None`	Unique identifier for the conversation	`None`
`created_date`	`datetime \| None`	Date and time when the conversation was created	`None`
`last_modified_date`	`datetime \| None`	Date and time when the conversation was last modified	`None`

CreateBigQueryConnectionRequest

Request to create a BigQuery Connection for accessing Google BigQuery datasets. Requires GCP service account key authentication, with an optional dataset scope.

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`read`	`StrictBool \| None`	If true, the connection has read permission for import.	`True`
`write`	`StrictBool \| None`	If true, the connection has write permission for export.	`False`
`type`	`StrictStr`	The type of Connection to create (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`dataset_id`	`ConstrainedStrValue \| None`	Optional BigQuery dataset ID to scope the connection. When set, used as the default dataset for table listing and connection testing.	`None`
`auth`	`GcpAuthRequest`	Use one of: GcpServiceAccountKeyAuthRequest, GcpWorkloadIdentityAuthRequest.	`None`

CreateBucketDataSourceRequest

Request to create a DataSource that imports data from cloud storage buckets (S3, etc.). Specifies the path within the bucket where the data files are located.

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`connection_id`	`StrictInt`	The unique identifier of the Connection used by this DataSource	`None`
`type`	`StrictStr`	The type of DataSource to create (bucket for cloud storage, rdbms for databases, delta sharing for shared data)	`None`
`path`	`ConstrainedStrValue`	The path within the bucket where the data files are located	`None`

CreateConnectionRequest

Request to create a new Connection that defines authentication and configuration details for connecting to external data systems. Each Connection type has specific requirements for authentication and connection parameters.

Use one of: CreateBigQueryConnectionRequest, CreateDeltaSharingConnectionRequest, CreateGcsConnectionRequest, CreatePriceItDimConnectionRequest, CreateS3ConnectionRequest, CreateSnowflakeConnectionRequest.

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`read`	`StrictBool \| None`	If true, the connection has read permission for import.	`True`
`write`	`StrictBool \| None`	If true, the connection has write permission for export.	`False`
`type`	`StrictStr`	The type of Connection to create (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`

CreateDataSourceRequest

Request to create a new DataSource that defines how to import data from an external system. The request specifies the connection to use and the data location (path for storage systems, query for databases).

Use one of: CreateBucketDataSourceRequest, CreateDeltaSharingDataSourceRequest, CreateRDBMSDataSourceRequest.

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`connection_id`	`StrictInt`	The unique identifier of the Connection used by this DataSource	`None`
`type`	`StrictStr`	The type of DataSource to create (bucket for cloud storage, rdbms for databases, delta sharing for shared data)	`None`

CreateDataTableRequest

Request payload for creating a new DataTable. Requires a name for identification and a DataSource ID to specify where the data will be imported from

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	Name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	List of unique tags for categorizing and organizing the entity	`None`
`data_source_id`	`StrictInt`	Unique identifier of the DataSource from which this DataTable imports data	`None`
`data_version_exist`	`StrictBool \| None`	Indicates whether this DataTable has any data versions available	`None`

CreateDatasetRequest

Request payload for creating a new Dataset. Initially creates an empty Dataset that can later be populated with transformation graphs containing DataTables and recipes

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	Name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	List of unique tags for categorizing and organizing the entity	`None`

CreateDatasetVersionRequest

Parameters:

Name	Type	Description	Default
`dataset_id`	`StrictInt`	Unique identifier of the Dataset for which to create a new transformation graph version	`None`
`source_transformation_graph_version_number`	`StrictInt \| None`	Version number of the existing transformation graph to use as a template for the new version	`None`

CreateDeltaSharingConnectionRequest

Request to create a Delta Sharing Connection for accessing shared data.

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`read`	`StrictBool \| None`	If true, the connection has read permission for import.	`True`
`write`	`StrictBool \| None`	If true, the connection has write permission for export.	`False`
`type`	`StrictStr`	The type of Connection to create (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`auth`	`DeltaSharingAuthRequest`	Use one of: DeltaSharingJsonProfileAuthRequest.	`None`

CreateDeltaSharingDataSourceRequest

Request to create a Delta Sharing DataSource that imports data from shared tables. Specifies the share, schema, and table to access.

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`connection_id`	`StrictInt`	The unique identifier of the Connection used by this DataSource	`None`
`type`	`StrictStr`	The type of DataSource to create (bucket for cloud storage, rdbms for databases, delta sharing for shared data)	`None`
`share`	`ConstrainedStrValue`	The share to use for accessing shared data	`None`
`var_schema`	`ConstrainedStrValue`	The schema within the Delta Share to use for accessing shared data	`None`
`table`	`ConstrainedStrValue`	The table within the Delta Share to use for accessing shared data	`None`

CreateExportRequest

Parameters:

Name	Type	Description	Default
`target_id`	`StrictInt`	The dataTarget ID that specifies the location to export the data	`None`
`source_type`	`StrictStr`	The type of data source to export (dataset for DataSet, datatable for DataTable)	`None`
`source_id`	`StrictInt`	The ID of the source to export (DataSet ID or DataTable ID)	`None`
`source_version`	`StrictInt`	The specific version of the source to export.	`None`
`use_sample`	`StrictBool \| None`	Whether to export a sample of the data (true) or the full data (false). Default is false.	`False`
`validate_to_release`	`StrictBool \| None`	Whether to validate the data before exporting. Default is true.	`True`
`cast_boolean_to_integer`	`StrictBool \| None`	Whether to cast boolean columns to integer (1/0) during export. Default is false.	`False`
`columns`	`ConstrainedListValue \| None`	Optional list of specific columns to include in the export. If not provided, all columns are exported.	`None`

CreateExportResponse

Parameters:

Name	Type	Description	Default
`export_id`	`StrictInt`	Unique identifier for tracking export job status and progress	`None`

CreateGcsConnectionRequest

Request to create a GCP Object Storage Connection for accessing Google Cloud Storage. Requires authentication credentials, with optional path restrictions for security.

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`read`	`StrictBool \| None`	If true, the connection has read permission for import.	`True`
`write`	`StrictBool \| None`	If true, the connection has write permission for export.	`False`
`type`	`StrictStr`	The type of Connection to create (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`path_restriction`	`ConstrainedStrValue \| None`	Optional path restriction to limit access to specific paths within the GCS bucket	`None`
`auth`	`GcpAuthRequest`	Use one of: GcpServiceAccountKeyAuthRequest, GcpWorkloadIdentityAuthRequest.	`None`

CreatePriceItDimConnectionRequest

Request to create a Price-It Connection for accessing Price-it. Requires OAuth credentials and write permission.

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`read`	`StrictBool \| None`	If true, the connection has read permission for import.	`True`
`write`	`StrictBool \| None`	If true, the connection has write permission for export.	`False`
`type`	`StrictStr`	The type of Connection to create (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`auth`	`OAuthRequest`	Use one of: ClientCredentialsAuthRequest.	`None`

CreateQuotaRequest

Request to create a new quota contract

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue \| None`	Name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	List of unique tags for categorizing and organizing the entity	`None`
`start_date`	`datetime \| None`	Start date of quota contract (inclusive)	`None`
`end_date`	`datetime \| None`	End date of quota contract (exclusive)	`None`
`cpu_time_hours`	`StrictInt \| None`	CPU hours quota	`None`
`data_transfer_gb`	`StrictInt \| None`	Data transfer quota in GB	`None`
`overage_allowed`	`StrictBool \| None`	Whether overage beyond quota is allowed	`None`

CreateRDBMSDataSourceRequest

Request to create a DataSource that imports data from relational databases (Snowflake, etc.). Specifies the SQL query to execute for data retrieval.

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`connection_id`	`StrictInt`	The unique identifier of the Connection used by this DataSource	`None`
`type`	`StrictStr`	The type of DataSource to create (bucket for cloud storage, rdbms for databases, delta sharing for shared data)	`None`
`query`	`ConstrainedStrValue`	The SQL query to execute for data retrieval	`None`
`warehouse`	`ConstrainedStrValue \| None`	The warehouse to use for query execution	`None`

CreateRecipeRequest

Creates a new recipe with version 1

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	Name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	List of unique tags for categorizing and organizing the entity	`None`
`shared`	`StrictBool \| None`	An enumeration.	`True`
`language`	`StrictStr \| None`	Recipe language (shared across all versions)	`None`
`aliases`	`ConstrainedListValue`	Table aliases used in SQL code for recipe transformations. Single-source recipes have 1 alias (e.g. "CurrentTable" for backward compatibility, or any valid name). Multi-source recipes have 2-10 aliases matching table names in SQL.	`None`
`recipe_version`	`RecipeVersion`	An enumeration.	`None`

CreateRecipeVersionRequest

Parameters:

Name	Type	Description	Default
`code`	`ConstrainedStrValue \| None`	SQL code that defines the data transformation logic	`None`

CreateS3ConnectionRequest

Request to create an S3 Connection for accessing cloud storage services. Requires authentication credentials and endpoint configuration, with optional path restrictions for security.

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`read`	`StrictBool \| None`	If true, the connection has read permission for import.	`True`
`write`	`StrictBool \| None`	If true, the connection has write permission for export.	`False`
`type`	`StrictStr`	The type of Connection to create (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`path_restriction`	`ConstrainedStrValue \| None`	Optional path restriction to limit access to specific paths within the S3 bucket	`None`
`auth`	`S3AuthRequest`	Use one of: S3SecretKeyAuthRequest.	`None`

CreateSnowflakeConnectionRequest

Request to create a Snowflake Connection for accessing Snowflake data warehouse. Requires authentication credentials and connection settings including database, schema, and warehouse configuration.

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`read`	`StrictBool \| None`	If true, the connection has read permission for import.	`True`
`write`	`StrictBool \| None`	If true, the connection has write permission for export.	`False`
`type`	`StrictStr`	The type of Connection to create (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`database`	`ConstrainedStrValue \| None`	The Snowflake database to connect to	`None`
`var_schema`	`ConstrainedStrValue \| None`	The Snowflake schema to use	`None`
`warehouse`	`ConstrainedStrValue \| None`	The Snowflake warehouse to use for query execution	`None`
`auth`	`SnowflakeAuthRequest`	Use one of: SnowflakeClientCredentialsAuthRequest, SnowflakePasswordAuthRequest.	`None`

DataSourceResponse

Response containing DataSource information including its configuration, connection details, and metadata. DataSources define how to import data from external systems into the platform.

May be one of: BucketDataSourceResponse, DeltaSharingDataSourceResponse, RDBMSDataSourceResponse.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`connection_id`	`StrictInt`	The unique identifier of the Connection used by this DataSource	`None`
`type`	`StrictStr`	The type of DataSource (bucket for cloud storage, rdbms for databases)	`None`

DataSourcesResponse

Collection of DataSource objects

Parameters:

Name	Type	Description	Default
`offset`	`StrictInt`	Number of records skipped before current result set	`None`
`limit`	`StrictInt`	Number of records in current result set	`None`
`total`	`StrictInt`	Total number of records available in the database	`None`
`items`	`ConstrainedListValue`	list of DataSources in current result set	`None`

DataTableResponse

Represents a DataTable which is a container that can hold multiple versions of imported data from external sources. Each DataTable is linked to a specific DataSource and maintains version history

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue \| None`	Name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	List of unique tags for categorizing and organizing the entity	`None`
`id`	`StrictInt \| None`	Unique identifier of the entity	`None`
`lock_version`	`StrictInt \| None`	Version number used for optimistic locking to prevent concurrent modifications	`None`
`data_source_id`	`StrictInt \| None`	Unique identifier of the DataSource from which this DataTable imports data	`None`
`data_version_exist`	`StrictBool \| None`	Indicates whether this DataTable has any data versions available	`None`
`created_by`	`User`	An enumeration.	`None`
`created_date`	`datetime`	Date and time when this entity was created	`None`
`last_modified_by`	`User`	An enumeration.	`None`
`last_modified_date`	`datetime`	Date and time when this entity was last modified	`None`
`latest_data_version`	`DataVersionResponse \| None`	An enumeration.	`None`
`connection_details`	`ConnectionDetails \| None`	An enumeration.	`None`

DataTablesResponse

Collection of DataTable objects representing all available structured datasets

Parameters:

Name	Type	Description	Default
`offset`	`StrictInt`	Number of records skipped before current result set	`None`
`limit`	`StrictInt`	Number of records in current result set	`None`
`total`	`StrictInt`	Total number of records available in the database	`None`
`items`	`ConstrainedListValue`	list of DataTables in current result set	`None`

DataVersionResponse

Represents a specific version of data within a DataTable. Each version contains imported data from the associated DataSource along with processing status, metadata, and schema information

Parameters:

Name	Type	Description	Default
`data_table_id`	`StrictInt \| None`	Unique identifier of the DataTable that contains this data version	`None`
`version_number`	`StrictInt \| None`	Sequential version number of this data within the DataTable	`None`
`execution`	`JobExecution`	An enumeration.	`None`
`metadata`	`Metadata \| None`	An enumeration.	`None`
`created_by`	`User`	An enumeration.	`None`
`created_date`	`datetime`	Date and time when this entity was created	`None`
`last_modified_by`	`User`	An enumeration.	`None`
`last_modified_date`	`datetime`	Date and time when this entity was last modified	`None`

DatasetDataTableNodeResponse

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue \| None`	Name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	List of unique tags for categorizing and organizing the entity	`None`
`id`	`StrictInt`	Unique identifier of the entity	`None`
`lock_version`	`StrictInt`	Version number used for optimistic locking to prevent concurrent modifications	`None`
`node_type`	`StrictStr \| None`	Type of node in the transformation graph (TABLE for DataTable references, RECIPE for transformation logic)	`None`
`data_table_id`	`StrictInt \| None`	Unique identifier of the referenced DataTable	`None`
`data_table_version_number`	`StrictInt \| None`	Specific version number of the DataTable to use in the transformation	`None`

DatasetEdgeResponse

Parameters:

Name	Type	Description	Default
`source_node_id`	`StrictInt \| None`	Identifier of the source node in the transformation graph connection	`None`
`target_node_id`	`StrictInt \| None`	Identifier of the target node in the transformation graph connection	`None`
`alias`	`StrictStr \| None`	Alias binding for this edge	`None`

DatasetEdgesResponse

Parameters:

Name	Type	Description	Default
`edges`	`ConstrainedListValue \| None`	List of all connections between nodes in the transformation graph, defining the data flow	`None`

DatasetNodeResponse

May be one of: DatasetRecipeNodeResponse, DatasetDataTableNodeResponse.

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue \| None`	Name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	List of unique tags for categorizing and organizing the entity	`None`
`id`	`StrictInt`	Unique identifier of the entity	`None`
`lock_version`	`StrictInt`	Version number used for optimistic locking to prevent concurrent modifications	`None`
`node_type`	`StrictStr \| None`	Type of node in the transformation graph (TABLE for DataTable references, RECIPE for transformation logic)	`None`

DatasetNodesResponse

Parameters:

Name	Type	Description	Default
`nodes`	`ConstrainedListValue \| None`	List of all nodes (DataTables and recipes) within the transformation graph	`None`

DatasetRecipeNodeResponse

Response containing recipe node information including execution status and recipe version details

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue \| None`	Name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	List of unique tags for categorizing and organizing the entity	`None`
`id`	`StrictInt`	Unique identifier of the entity	`None`
`lock_version`	`StrictInt`	Version number used for optimistic locking to prevent concurrent modifications	`None`
`node_type`	`StrictStr \| None`	Type of node in the transformation graph (TABLE for DataTable references, RECIPE for transformation logic)	`None`
`start_time`	`datetime \| None`	Date and time when the recipe execution started, null if not yet started	`None`
`end_time`	`datetime \| None`	Date and time when the recipe execution completed, null if still running or not started	`None`
`use_sample`	`StrictBool \| None`	Whether the recipe was executed on a sample of the data instead of the complete dataset	`None`
`last_run`	`datetime \| None`	Date and time when this entity was created	`None`
`run_by`	`User \| None`	An enumeration.	`None`
`metadata`	`Metadata \| None`	An enumeration.	`None`
`execution`	`JobExecution \| None`	An enumeration.	`None`
`recipe_id`	`StrictInt \| None`	Unique identifier of the referenced Recipe	`None`
`created_by`	`User`	An enumeration.	`None`
`created_date`	`datetime`	Date and time when this entity was created	`None`
`last_modified_by`	`User`	An enumeration.	`None`
`last_modified_date`	`datetime`	Date and time when this entity was last modified	`None`
`recipe_version`	`RecipeVersionResponse \| None`	An enumeration.	`None`

DatasetResponse

Represents a Dataset which is a complex data transformation workflow that combines multiple DataTables and recipes through a transformation graph to produce processed datasets. Datasets support versioning to track different configurations

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue \| None`	Name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	List of unique tags for categorizing and organizing the entity	`None`
`id`	`StrictInt \| None`	Unique identifier of the entity	`None`
`lock_version`	`StrictInt \| None`	Version number used for optimistic locking to prevent concurrent modifications	`None`
`created_by`	`User`	An enumeration.	`None`
`created_date`	`datetime`	Date and time when this entity was created	`None`
`last_modified_by`	`User`	An enumeration.	`None`
`last_modified_date`	`datetime`	Date and time when this entity was last modified	`None`
`latest_transformation_graph`	`LeanTransformationGraphResponse \| None`	An enumeration.	`None`

DatasetsResponse

Collection of Dataset objects representing all available data transformation workflows

Parameters:

Name	Type	Description	Default
`offset`	`StrictInt`	Number of records skipped before current result set	`None`
`limit`	`StrictInt`	Number of records in current result set	`None`
`total`	`StrictInt`	Total number of records available in the database	`None`
`items`	`ConstrainedListValue`	list of Datasets in current result set	`None`

DeltaSharingAuthRequest

Delta Sharing authentication request.

Use one of: DeltaSharingJsonProfileAuthRequest.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	An enumeration.	`None`

DeltaSharingAuthResponse

Delta Sharing connection authentication response.

May be one of: DeltaSharingJsonProfileAuthResponse.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	An enumeration.	`None`

DeltaSharingConnectionResponse

Response for a Delta Sharing Connection that provides access to shared data, including the Delta Share profile configuration.

Parameters:

Name	Type	Description	Default
`read`	`StrictBool \| None`	If true, the connection has read permission for import.	`True`
`write`	`StrictBool \| None`	If true, the connection has write permission for export.	`False`
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue \| None`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`created_by`	`User \| None`	An enumeration.	`None`
`created_date`	`datetime \| None`	The date and time when the entity was created	`None`
`last_modified_by`	`User \| None`	An enumeration.	`None`
`last_modified_date`	`datetime \| None`	The date and time when the entity was last modified	`None`
`type`	`StrictStr`	The type of Connection (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`auth`	`DeltaSharingAuthResponse \| None`	An enumeration.	`None`

DeltaSharingDataSourceResponse

Response for a Delta Sharing DataSource that imports data from shared tables, including the share, schema, and table configuration.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`connection_id`	`StrictInt`	The unique identifier of the Connection used by this DataSource	`None`
`type`	`StrictStr`	The type of DataSource (bucket for cloud storage, rdbms for databases)	`None`
`share`	`ConstrainedStrValue \| None`	The share to use for accessing shared data	`None`
`var_schema`	`ConstrainedStrValue \| None`	The schema within the Delta Share to use for accessing shared data	`None`
`table`	`ConstrainedStrValue \| None`	The table within the Delta Share to use for accessing shared data	`None`

DeltaSharingJsonProfileAuthRequest

Delta Sharing connection authentication request using Deltasharing-profile for authentication.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	An enumeration.	`None`
`delta_sharing_profile_name`	`StrictStr \| None`	The name of Delta Sharing profile configuration.	`None`
`delta_sharing_profile_content`	`ConstrainedStrValue`	The Delta Sharing profile configuration in JSON format, containing connection and authentication details for accessing shared data.	`None`

DeltaSharingJsonProfileAuthResponse

Delta Sharing connection authentication response using json profile.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	An enumeration.	`None`
`delta_sharing_profile_name`	`StrictStr \| None`	The name of Delta Sharing profile configuration.	`None`
`delta_sharing_profile_content_redacted`	`StrictStr \| None`	The Delta Sharing profile configuration in JSON format, containing connection and partially redacted authentication details for accessing shared data.	`None`

ExecuteRecipeRequest

Parameters:

Name	Type	Description	Default
`use_sample`	`StrictBool`	Whether to execute the recipe on a sample of the data instead of the complete dataset. Sample execution is faster and useful for testing and development purposes	`None`

ExportPartResultPairResponse

eTag for each export (upload) part

Parameters:

Name	Type	Description	Default
`e_tag`	`StrictStr \| None`	Entity tag returned by S3 for the uploaded part, used for verification and completion	`None`
`part_number`	`StrictInt \| None`	Sequential number of this part in the multi-part upload process	`None`

ExportResponse

Response containing Export

Parameters:

Name	Type	Description	Default
`id`	`StrictInt \| None`	Unique identifier for the export operation	`None`
`job_id`	`StrictStr \| None`	The job ID associated with the export operation	`None`
`target_id`	`StrictInt \| None`	The dataTarget ID that specifies the location to export the data	`None`
`target_name`	`StrictStr \| None`	The name of the dataTarget that specifies the location to export the data	`None`
`data_target_details`	`Dict[str, Any] \| None`	The details of the data target (e.g., S3 bucket path or PriceIt table path)	`None`
`exported_table_name`	`StrictStr \| None`	The name of the exported table	`None`
`source_type`	`StrictStr \| None`	The type of data source to export (dataset for DataSet, datatable for DataTable)	`None`
`source_id`	`StrictInt \| None`	The ID of the source to export (DataSet ID or DataTable ID)	`None`
`source_version`	`StrictInt \| None`	The specific version of the source to export.	`None`
`source_name`	`StrictStr \| None`	The name of the source to export (DataSet name or DataTable name)	`None`
`use_sample`	`StrictBool \| None`	Whether to export a sample of the data (true) or the full data (false). Default is false.	`False`
`validate_to_release`	`StrictBool \| None`	Whether to validate the data before exporting. Default is true.	`True`
`cast_boolean_to_integer`	`StrictBool \| None`	Whether to cast boolean columns to integer (1/0) during export. Default is false.	`False`
`columns`	`ConstrainedListValue \| None`	Optional list of specific columns to include in the export. If not provided, all columns are exported.	`None`
`connection_id`	`StrictInt \| None`	The unique identifier of the Connection used for this export	`None`
`connection_name`	`StrictStr \| None`	The name of the Connection used for this export	`None`
`execution`	`JobExecution \| None`	An enumeration.	`None`
`created_by`	`User \| None`	An enumeration.	`None`
`created_date`	`datetime \| None`	The date and time when the entity was created	`None`
`last_modified_by`	`User \| None`	An enumeration.	`None`
`last_modified_date`	`datetime \| None`	The date and time when the entity was last modified	`None`

ExportS3JobStatusResponse

Export S3 job status response

Parameters:

Name	Type	Description	Default
`bucket`	`StrictStr \| None`	Name of the S3 bucket where the data will be exported	`None`
`key`	`StrictStr \| None`	S3 object key (path) where the exported data will be stored	`None`
`total_files`	`StrictInt \| None`	Total number of files that will be created during the export process	`None`
`uploaded_files`	`ConstrainedListValue \| None`	List of file names that have been successfully uploaded to S3	`None`
`status`	`ExportS3StatusResponse \| None`	An enumeration.	`None`
`created_date`	`datetime \| None`	Date and time when the export job was created	`None`

ExportS3PartJobStatusResponse

Export S3 part job status response

Parameters:

Name	Type	Description	Default
`status`	`StrictStr \| None`	Current status of the multi-part export job (e.g., PENDING, IN_PROGRESS, COMPLETED, FAILED)	`None`
`error`	`StrictStr \| None`	Error message if the export job failed, null if successful	`None`
`result`	`ConstrainedListValue \| None`	List of upload results for each part of the multi-part export, containing ETags and part numbers	`None`

ExportS3PartRequest

Parameters:

Name	Type	Description	Default
`parts_urls`	`ConstrainedListValue \| None`	List of pre-signed S3 URLs for multi-part upload operations. Each URL corresponds to a part of the data that will be uploaded separately	`None`
`columns`	`ConstrainedListValue \| None`	List of specific column names to include in the export. If not specified, all columns will be exported	`None`
`cast_boolean_to_integer`	`StrictBool \| None`	Whether to convert boolean values to integers (true=1, false=0) in the exported data for compatibility with systems that don't support boolean types	`False`
`use_sample`	`StrictBool \| None`	Whether to export only a sample of the data instead of the complete dataset. Useful for testing and preview purposes	`False`

ExportS3PartResponse

Parameters:

Name	Type	Description	Default
`job_id`	`StrictStr`	Unique identifier for tracking the multi-part S3 export job	`None`

ExportS3Request

Parameters:

Name	Type	Description	Default
`bucket`	`StrictStr`	Name of the S3 bucket where the data will be exported	`None`
`key`	`StrictStr`	S3 object key (path) where the exported data will be stored	`None`
`total_files`	`StrictInt \| None`	Total number of files that will be created during the export process	`None`
`uploaded_files`	`ConstrainedListValue \| None`	List of file names that have been successfully uploaded to S3	`None`
`endpoint`	`StrictStr`	S3-compatible endpoint URL for the target storage service	`None`
`access_key`	`StrictStr`	AWS access key ID for authentication with the S3 service	`None`
`secret_key`	`StrictStr`	AWS secret access key for authentication with the S3 service	`None`
`session_token`	`StrictStr`	AWS session token for temporary credentials (required for STS-based authentication)	`None`
`columns`	`ConstrainedListValue \| None`	List of specific column names to include in the export. If not specified, all columns will be exported	`None`
`cast_boolean_to_integer`	`StrictBool \| None`	Whether to convert boolean values to integers (true=1, false=0) in the exported data for compatibility with systems that don't support boolean types	`False`
`use_sample`	`StrictBool \| None`	Whether to export only a sample of the data instead of the complete dataset. Useful for testing and preview purposes	`False`
`validate_release`	`StrictBool \| None`	Whether to validate that the transformation graph has been released before allowing the export operation	`True`

ExportS3Response

Parameters:

Name	Type	Description	Default
`job_id`	`StrictStr \| None`	Unique identifier for tracking the S3 export job status and progress	`None`

ExportS3StatusResponse

Export S3 job status properties

Parameters:

Name	Type	Description	Default
`status`	`StrictStr \| None`	Current status of the S3 export job (e.g., PENDING, IN_PROGRESS, COMPLETED, FAILED)	`None`
`error_code`	`StrictStr \| None`	Specific error code if the export job failed, null if successful	`None`
`error_cause`	`StrictStr \| None`	Root cause description if the export job failed, null if successful	`None`

ExportsResponse

Collection of Export objects

Parameters:

Name	Type	Description	Default
`offset`	`StrictInt`	Number of records skipped before current result set	`None`
`limit`	`StrictInt`	Number of records in current result set	`None`
`total`	`StrictInt`	Total number of records available in the database	`None`
`items`	`ConstrainedListValue`	list of Export in current result set	`None`

GcpAuthRequest

Authentication configuration for GCP Connections in request objects, specifying the authentication method and credentials.

Use one of: GcpServiceAccountKeyAuthRequest, GcpWorkloadIdentityAuthRequest.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method to use for GCP access	`None`

GcpAuthResponse

Authentication details for GCP Connections in response objects, containing the authentication type and related credentials information.

May be one of: GcpServiceAccountKeyAuthResponse, GcpWorkloadIdentityAuthResponse.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method used for GCP access	`None`

GcpServiceAccountKeyAuthRequest

GCP authentication request using service account key authentication, requiring the project ID and service account key JSON content.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method to use for GCP access	`None`
`project_id`	`ConstrainedStrValue`	The GCP project ID	`None`
`service_account_key_json`	`ConstrainedStrValue`	The service account key in JSON format	`None`

GcpServiceAccountKeyAuthResponse

GCP authentication response using service account key authentication, containing the project ID (secret key JSON is omitted).

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method used for GCP access	`None`
`project_id`	`ConstrainedStrValue \| None`	The GCP project ID	`None`

GcpWorkloadIdentityAuthRequest

GCP authentication request using workload identity federation, requiring OAuth2 token exchange configuration and service account details.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method to use for GCP access	`None`
`client_id`	`ConstrainedStrValue`	The OAuth2 client ID for workload identity federation	`None`
`client_secret`	`ConstrainedStrValue`	The OAuth2 client secret for workload identity federation	`None`
`token_url`	`ConstrainedStrValue`	The OAuth2 token endpoint URL for workload identity federation	`None`
`scope`	`ConstrainedStrValue`	The OAuth2 scope for the token request	`None`
`service_account_email`	`ConstrainedStrValue`	The GCP service account email to impersonate	`None`
`audience`	`ConstrainedStrValue`	The audience for the workload identity token	`None`
`project_id`	`ConstrainedStrValue`	The GCP project ID	`None`

GcpWorkloadIdentityAuthResponse

GCP authentication response using workload identity federation, containing OAuth2 configuration and service account details (client secret is omitted).

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method used for GCP access	`None`
`client_id`	`ConstrainedStrValue \| None`	The OAuth2 client ID for workload identity federation	`None`
`token_url`	`ConstrainedStrValue \| None`	The OAuth2 token endpoint URL for workload identity federation	`None`
`scope`	`ConstrainedStrValue \| None`	The OAuth2 scope for the token request	`None`
`service_account_email`	`ConstrainedStrValue \| None`	The GCP service account email to impersonate	`None`
`audience`	`ConstrainedStrValue \| None`	The audience for the workload identity token	`None`
`project_id`	`ConstrainedStrValue \| None`	The GCP project ID	`None`

GcsConnectionResponse

Response for a GCP Object Storage Connection that provides access to Google Cloud Storage, including authentication details and path restrictions.

Parameters:

Name	Type	Description	Default
`read`	`StrictBool \| None`	If true, the connection has read permission for import.	`True`
`write`	`StrictBool \| None`	If true, the connection has write permission for export.	`False`
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue \| None`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`created_by`	`User \| None`	An enumeration.	`None`
`created_date`	`datetime \| None`	The date and time when the entity was created	`None`
`last_modified_by`	`User \| None`	An enumeration.	`None`
`last_modified_date`	`datetime \| None`	The date and time when the entity was last modified	`None`
`type`	`StrictStr`	The type of Connection (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`path_restriction`	`ConstrainedStrValue \| None`	Optional path restriction to limit access to specific paths within the GCS bucket	`None`
`auth`	`GcpAuthResponse \| None`	An enumeration.	`None`

LeanTransformationGraphResponse

Parameters:

Name	Type	Description	Default
`created_by`	`User`	An enumeration.	`None`
`created_date`	`datetime`	Date and time when this entity was created	`None`
`last_modified_by`	`User`	An enumeration.	`None`
`last_modified_date`	`datetime`	Date and time when this entity was last modified	`None`
`dataset_id`	`StrictInt \| None`	Unique identifier of the Dataset that contains this transformation graph	`None`
`version_number`	`StrictInt \| None`	Version number of this transformation graph within the Dataset	`None`
`release_status`	`StrictBool \| None`	Indicates whether this transformation graph version has been released for production use	`None`
`lock_version`	`StrictInt \| None`	Version number used for optimistic locking to prevent concurrent modifications	`None`

ListQuery

Parameters:

Name	Type	Description	Default
`offset`	`ConstrainedIntValue \| None`	Number of records to skip before starting to collect the result set	`0`
`limit`	`ConstrainedIntValue \| None`	Number of records to retrieve in result set	`1000`
`sort`	`StrictStr \| None`	Sorting criteria for result set	`None`
`filter`	`StrictStr \| None`	Expression describing a filter for result set	`None`

MergeBigQueryConnectionRequest

Request to partially update a BigQuery Connection, allowing selective modification of authentication credentials and dataset configuration.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue \| None`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`type`	`StrictStr`	The type of Connection being merged (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`dataset_id`	`ConstrainedStrValue \| None`	Optional BigQuery dataset ID to scope the connection. When set, used as the default dataset for table listing and connection testing.	`None`
`auth`	`GcpAuthRequest \| None`	An enumeration.	`None`

MergeConnectionRequest

Request to partially update a Connection by applying only the provided fields while leaving other fields unchanged. Uses merge-patch semantics and requires the current lock version.

Use one of: MergeBigQueryConnectionRequest, MergeDeltaSharingConnectionRequest, MergeGcsConnectionRequest, MergePriceItDimConnectionRequest, MergeS3ConnectionRequest, MergeSnowflakeConnectionRequest.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue \| None`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`type`	`StrictStr`	The type of Connection being merged (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`

MergeDeltaSharingConnectionRequest

Request to partially update a DeltaSharing Connection including the Deltashare-profile configuration.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue \| None`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`type`	`StrictStr`	The type of Connection being merged (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`auth`	`DeltaSharingAuthRequest \| None`	An enumeration.	`None`

MergeGcsConnectionRequest

Request to partially update a GCP Object Storage Connection, allowing selective modification of authentication credentials and path restrictions.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue \| None`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`type`	`StrictStr`	The type of Connection being merged (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`path_restriction`	`ConstrainedStrValue \| None`	Optional path restriction to limit access to specific paths within the GCS bucket	`None`
`auth`	`GcpAuthRequest \| None`	An enumeration.	`None`

MergePriceItDimConnectionRequest

Request to partially update a Snowflake Connection, allowing selective modification of authentication credentials and connection settings including database, schema, and warehouse configuration.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue \| None`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`type`	`StrictStr`	The type of Connection being merged (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`auth`	`OAuthRequest \| None`	An enumeration.	`None`

MergeS3ConnectionRequest

Request to partially update an S3 Connection, allowing selective modification of authentication credentials, endpoint configuration, and path restrictions.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue \| None`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`type`	`StrictStr`	The type of Connection being merged (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`path_restriction`	`ConstrainedStrValue \| None`	Optional path restriction to limit access to specific paths within the S3 bucket	`None`
`auth`	`S3AuthRequest \| None`	An enumeration.	`None`

MergeSnowflakeConnectionRequest

Request to partially update a Snowflake Connection, allowing selective modification of authentication credentials and connection settings including database, schema, and warehouse configuration.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue \| None`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`type`	`StrictStr`	The type of Connection being merged (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`database`	`ConstrainedStrValue \| None`	The Snowflake database to connect to	`None`
`var_schema`	`ConstrainedStrValue \| None`	The Snowflake schema to use	`None`
`warehouse`	`ConstrainedStrValue \| None`	The Snowflake warehouse to use for query execution	`None`
`auth`	`SnowflakeAuthRequest \| None`	An enumeration.	`None`

OAuthRequest

Authentication configuration for Connections in request objects, supporting OAuth2 client credentials.

Use one of: ClientCredentialsAuthRequest.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method to use for access using OAuth2	`None`

OAuthResponse

Authentication details for OAuth Connections in response objects.

May be one of: ClientCredentialsAuthResponse.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method used for OAuth2 access	`None`

PriceItDimConnectionResponse

Response for a Price-It Dim Connection that provides access to Price-It, including authentication details and connection settings.

Parameters:

Name	Type	Description	Default
`read`	`StrictBool \| None`	If true, the connection has read permission for import.	`True`
`write`	`StrictBool \| None`	If true, the connection has write permission for export.	`False`
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue \| None`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`created_by`	`User \| None`	An enumeration.	`None`
`created_date`	`datetime \| None`	The date and time when the entity was created	`None`
`last_modified_by`	`User \| None`	An enumeration.	`None`
`last_modified_date`	`datetime \| None`	The date and time when the entity was last modified	`None`
`type`	`StrictStr`	The type of Connection (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`type_mapping`	`Dict[str, StrictStr] \| None`	JSON object mapping source columns to target types in price-it. Keys are source column names, values are target types values in price-it.	`None`
`type_mapping_name`	`StrictStr \| None`	Optional name/label for the type mapping configuration.	`None`
`auth`	`OAuthResponse \| None`	An enumeration.	`None`

QuotaContractResponse

Quota contract response with audit information

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue \| None`	Name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	List of unique tags for categorizing and organizing the entity	`None`
`id`	`StrictInt \| None`	Unique identifier of the entity	`None`
`lock_version`	`StrictInt \| None`	Version number used for optimistic locking to prevent concurrent modifications	`None`
`start_date`	`datetime \| None`	Start date of quota contract (inclusive)	`None`
`end_date`	`datetime \| None`	End date of quota contract (exclusive)	`None`
`cpu_time_hours`	`StrictInt \| None`	CPU hours quota	`None`
`data_transfer_gb`	`StrictInt \| None`	Data transfer quota in GB	`None`
`overage_allowed`	`StrictBool \| None`	Whether overage beyond quota is allowed	`None`
`created_by`	`User \| None`	An enumeration.	`None`
`created_date`	`datetime \| None`	Date and time when this entity was created	`None`
`last_modified_by`	`User \| None`	An enumeration.	`None`
`last_modified_date`	`datetime \| None`	Date and time when this entity was last modified	`None`

QuotaOverageAllowedRequest

Request to modify overage allowed on the current quota contract

Parameters:

Name	Type	Description	Default
`overage_allowed`	`StrictBool`	Whether overage beyond quota is allowed	`None`

RDBMSDataSourceResponse

Response for a database-based DataSource that imports data from relational database systems, including the configured SQL query and warehouse settings.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`connection_id`	`StrictInt`	The unique identifier of the Connection used by this DataSource	`None`
`type`	`StrictStr`	The type of DataSource (bucket for cloud storage, rdbms for databases)	`None`
`query`	`ConstrainedStrValue \| None`	The SQL query to execute for data retrieval	`None`
`warehouse`	`ConstrainedStrValue \| None`	The warehouse to use for query execution	`None`

RecipeCodeResponse

Response containing the actual recipe code for the given dataset node (recipe)

Parameters:

Name	Type	Description	Default
`code`	`StrictStr \| None`	The actual SQL code of the recipe	`None`

RecipeResponse

Recipe information including base properties and latest version details. This represents the overall recipe entity with its current active version information for display in lists and references.

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue \| None`	Name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	List of unique tags for categorizing and organizing the entity	`None`
`shared`	`StrictBool \| None`	An enumeration.	`True`
`language`	`StrictStr \| None`	Recipe language (shared across all versions)	`None`
`id`	`StrictInt \| None`	Unique identifier of the entity	`None`
`lock_version`	`StrictInt \| None`	Version number used for optimistic locking to prevent concurrent modifications	`None`
`created_by`	`User`	An enumeration.	`None`
`created_date`	`datetime`	Date and time when this entity was created	`None`
`last_modified_by`	`User`	An enumeration.	`None`
`last_modified_date`	`datetime`	Date and time when this entity was last modified	`None`
`latest_version`	`RecipeVersionResponse \| None`	An enumeration.	`None`

RecipeStatusResponse

Represents the current execution status of a recipe node within a transformation graph

Parameters:

Name	Type	Description	Default
`start_time`	`datetime \| None`	Date and time when the recipe execution started, null if not yet started	`None`
`end_time`	`datetime \| None`	Date and time when the recipe execution completed, null if still running or not started	`None`
`use_sample`	`StrictBool \| None`	Whether the recipe was executed on a sample of the data instead of the complete dataset	`None`
`last_run`	`datetime \| None`	Date and time when this entity was created	`None`
`run_by`	`User \| None`	An enumeration.	`None`
`metadata`	`Metadata \| None`	An enumeration.	`None`
`execution`	`JobExecution \| None`	An enumeration.	`None`

RecipeVersionResponse

Recipe version information including code, version number, and lock status. This represents a specific version of a recipe with its executable code and metadata.

Parameters:

Name	Type	Description	Default
`code`	`ConstrainedStrValue \| None`	SQL code that defines the data transformation logic	`None`
`version_number`	`StrictInt \| None`	Recipe version number (current version used by this node)	`None`
`is_locked`	`StrictBool \| None`	Whether this recipe version is locked (used in released datasets)	`None`
`lock_version`	`StrictInt \| None`	Version number used for optimistic locking to prevent concurrent modifications of this recipe version	`None`
`aliases`	`ConstrainedListValue \| None`	Table aliases defined for this recipe version	`None`
`created_by`	`User`	An enumeration.	`None`
`created_date`	`datetime`	Date and time when this entity was created	`None`
`last_modified_by`	`User`	An enumeration.	`None`
`last_modified_date`	`datetime`	Date and time when this entity was last modified	`None`

RecipeVersionUsageResponse

Information about how a recipe version is used in a specific dataset version

Parameters:

Name	Type	Description	Default
`created_by`	`User`	An enumeration.	`None`
`created_date`	`datetime`	Date and time when this entity was created	`None`
`last_modified_by`	`User`	An enumeration.	`None`
`last_modified_date`	`datetime`	Date and time when this entity was last modified	`None`
`dataset_id`	`StrictInt \| None`	Unique identifier of the Dataset that contains this transformation graph	`None`
`version_number`	`StrictInt \| None`	Version number of this transformation graph within the Dataset	`None`
`release_status`	`StrictBool \| None`	Indicates whether this transformation graph version has been released for production use	`None`
`lock_version`	`StrictInt \| None`	Version number used for optimistic locking to prevent concurrent modifications	`None`
`dataset_name`	`StrictStr \| None`	Name of the Dataset	`None`
`node_id`	`StrictInt \| None`	Unique identifier of the recipe node within this dataset version	`None`

RecipesResponse

Paginated list of recipes with their latest version nested

Parameters:

Name	Type	Description	Default
`items`	`ConstrainedListValue \| None`	An enumeration.	`None`
`total_count`	`StrictInt \| None`	An enumeration.	`None`
`page_size`	`StrictInt \| None`	An enumeration.	`None`
`page_number`	`StrictInt \| None`	An enumeration.	`None`

S3AuthRequest

Authentication configuration for S3 Connections in request objects, specifying the authentication method and credentials.

Use one of: S3SecretKeyAuthRequest.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method to use for S3 access	`None`

S3AuthResponse

Authentication details for S3 Connections in response objects, containing the authentication type and related credentials information.

May be one of: S3SecretKeyAuthResponse.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method used for S3 access	`None`

S3ConnectionResponse

Response for an S3 Connection that provides access to cloud storage services, including authentication details and path restrictions.

Parameters:

Name	Type	Description	Default
`read`	`StrictBool \| None`	If true, the connection has read permission for import.	`True`
`write`	`StrictBool \| None`	If true, the connection has write permission for export.	`False`
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue \| None`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`created_by`	`User \| None`	An enumeration.	`None`
`created_date`	`datetime \| None`	The date and time when the entity was created	`None`
`last_modified_by`	`User \| None`	An enumeration.	`None`
`last_modified_date`	`datetime \| None`	The date and time when the entity was last modified	`None`
`type`	`StrictStr`	The type of Connection (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`path_restriction`	`ConstrainedStrValue \| None`	Optional path restriction to limit access to specific paths within the S3 bucket	`None`
`auth`	`S3AuthResponse \| None`	An enumeration.	`None`

S3SecretKeyAuthRequest

S3 authentication request using secret key authentication, requiring access key ID, secret access key, and endpoint configuration.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method to use for S3 access	`None`
`access_key_id`	`ConstrainedStrValue`	The access key ID for authentication	`None`
`secret_access_key`	`ConstrainedStrValue`	The secret access key for authentication	`None`
`endpoint`	`ConstrainedStrValue`	The HTTPS endpoint URL for the S3-compatible service	`None`

S3SecretKeyAuthResponse

S3 authentication response using secret key authentication, containing access key and endpoint information.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method used for S3 access	`None`
`access_key_id`	`ConstrainedStrValue \| None`	The access key ID for authentication	`None`
`secret_access_key`	`ConstrainedStrValue \| None`	The secret access key for authentication	`None`
`endpoint`	`ConstrainedStrValue \| None`	The HTTPS endpoint URL for the S3-compatible service	`None`

SchemaAnalysisStatusResponse

Schema analysis job progress status

Parameters:

Name	Type	Description	Default
`execution`	`JobExecution \| None`	An enumeration.	`None`

SnowflakeAuthRequest

Authentication configuration for Snowflake Connections in request objects, supporting multiple authentication methods including password and OAuth2 client credentials.

Use one of: SnowflakeClientCredentialsAuthRequest, SnowflakePasswordAuthRequest.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method to use for Snowflake access	`None`

SnowflakeAuthResponse

Authentication details for Snowflake Connections in response objects, supporting multiple authentication methods.

May be one of: SnowflakeClientCredentialsAuthResponse, SnowflakePasswordAuthResponse.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method used for Snowflake access	`None`

SnowflakeClientCredentialsAuthRequest

Snowflake authentication request using OAuth2 client credentials flow, requiring token endpoint, client credentials, and connection host information.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method to use for Snowflake access	`None`
`token_url`	`ConstrainedStrValue`	The OAuth2 token endpoint URL	`None`
`client_id`	`ConstrainedStrValue`	The OAuth2 client ID	`None`
`client_secret`	`ConstrainedStrValue`	The OAuth2 client secret	`None`
`scope`	`ConstrainedStrValue`	The OAuth2 scope for the token request	`None`
`host`	`ConstrainedStrValue`	The host/account identifier	`None`

SnowflakeClientCredentialsAuthResponse

Snowflake authentication response using OAuth2 client credentials flow, containing token endpoint and client information.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method used for Snowflake access	`None`
`token_url`	`ConstrainedStrValue \| None`	The OAuth2 token endpoint URL	`None`
`client_id`	`ConstrainedStrValue \| None`	The OAuth2 client ID	`None`
`client_secret`	`ConstrainedStrValue \| None`	The OAuth2 client secret	`None`
`scope`	`ConstrainedStrValue \| None`	The OAuth2 scope for the token request	`None`
`host`	`ConstrainedStrValue \| None`	The host/account identifier	`None`

SnowflakeConnectionResponse

Response for a Snowflake Connection that provides access to Snowflake data warehouse, including authentication details and connection settings.

Parameters:

Name	Type	Description	Default
`read`	`StrictBool \| None`	If true, the connection has read permission for import.	`True`
`write`	`StrictBool \| None`	If true, the connection has write permission for export.	`False`
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue \| None`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`created_by`	`User \| None`	An enumeration.	`None`
`created_date`	`datetime \| None`	The date and time when the entity was created	`None`
`last_modified_by`	`User \| None`	An enumeration.	`None`
`last_modified_date`	`datetime \| None`	The date and time when the entity was last modified	`None`
`type`	`StrictStr`	The type of Connection (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`database`	`ConstrainedStrValue \| None`	The Snowflake database to connect to	`None`
`var_schema`	`ConstrainedStrValue \| None`	The Snowflake schema to use	`None`
`warehouse`	`ConstrainedStrValue \| None`	The Snowflake warehouse to use for query execution	`None`
`auth`	`SnowflakeAuthResponse \| None`	An enumeration.	`None`

SnowflakePasswordAuthRequest

Snowflake authentication request using username/password authentication, requiring user credentials and connection host information.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method to use for Snowflake access	`None`
`username`	`ConstrainedStrValue`	The Snowflake username for authentication	`None`
`password`	`ConstrainedStrValue`	The Snowflake password for authentication	`None`
`host`	`ConstrainedStrValue`	The Snowflake host/account identifier	`None`

SnowflakePasswordAuthResponse

Snowflake authentication response using username/password authentication, containing connection host and user credentials.

Parameters:

Name	Type	Description	Default
`auth_type`	`StrictStr`	The authentication method used for Snowflake access	`None`
`username`	`ConstrainedStrValue \| None`	The Snowflake username for authentication	`None`
`password`	`ConstrainedStrValue \| None`	The Snowflake password for authentication	`None`
`host`	`ConstrainedStrValue \| None`	The Snowflake host/account identifier	`None`

TableDetailsResponse

Response containing details about a database table including its name, database, and schema information.

Parameters:

Name	Type	Description	Default
`name`	`StrictStr \| None`	The name of the table	`None`
`database`	`StrictStr \| None`	The database containing the table	`None`
`var_schema`	`StrictStr \| None`	The schema containing the table	`None`

TestBigQueryConnectionRequest

Request to test a BigQuery Connection by attempting to authenticate and access Google BigQuery using the provided credentials and configuration.

Parameters:

Name	Type	Description	Default
`type`	`StrictStr`	The type of Connection to test (s3, snowflake, delta_sharing, priceit_dim, gcs, or bigquery)	`None`
`dataset_id`	`ConstrainedStrValue \| None`	Optional BigQuery dataset ID to scope the connection. When set, used as the default dataset for table listing and connection testing.	`None`
`auth`	`GcpAuthRequest`	Use one of: GcpServiceAccountKeyAuthRequest, GcpWorkloadIdentityAuthRequest.	`None`

TestConnectionRequest

Request to test a Connection configuration by attempting to establish a connection using the provided authentication details and connection parameters.

Use one of: TestBigQueryConnectionRequest, TestDeltaSharingConnectionRequest, TestGcsConnectionRequest, TestPriceItDimConnectionRequest, TestS3ConnectionRequest, TestSnowflakeConnectionRequest.

Parameters:

Name	Type	Description	Default
`type`	`StrictStr`	The type of Connection to test (s3, snowflake, delta_sharing, priceit_dim, gcs, or bigquery)	`None`

TestDeltaSharingConnectionRequest

Request to test an DeltaSharing Connection by attempting to authenticate and access the DeltaSharing service using the provided credentials and endpoint configuration.

Parameters:

Name	Type	Description	Default
`type`	`StrictStr`	The type of Connection to test (s3, snowflake, delta_sharing, priceit_dim, gcs, or bigquery)	`None`
`auth`	`DeltaSharingAuthRequest`	Use one of: DeltaSharingJsonProfileAuthRequest.	`None`

TestGcsConnectionRequest

Request to test a GCP Object Storage Connection by attempting to authenticate and access Google Cloud Storage using the provided credentials and configuration.

Parameters:

Name	Type	Description	Default
`type`	`StrictStr`	The type of Connection to test (s3, snowflake, delta_sharing, priceit_dim, gcs, or bigquery)	`None`
`path_restriction`	`ConstrainedStrValue \| None`	Optional path restriction to limit access to specific paths within the GCS bucket	`None`
`auth`	`GcpAuthRequest`	Use one of: GcpServiceAccountKeyAuthRequest, GcpWorkloadIdentityAuthRequest.	`None`

TestPriceItDimConnectionRequest

Request to test a Price-It Connection by attempting to authenticate and access the Price-It DIM using the provided credentials and endpoint configuration.

Parameters:

Name	Type	Description	Default
`type`	`StrictStr`	The type of Connection to test (s3, snowflake, delta_sharing, priceit_dim, gcs, or bigquery)	`None`
`auth`	`ClientCredentialsAuthRequest`	An enumeration.	`None`

TestRDBMSDataSourceRequest

Request to test an RDBMS DataSource configuration by executing the specified query to verify connectivity and data accessibility.

Parameters:

Name	Type	Description	Default
`query`	`ConstrainedStrValue`	The SQL query to execute for data retrieval	`None`
`warehouse`	`ConstrainedStrValue \| None`	The warehouse to use for query execution	`None`

TestS3ConnectionRequest

Request to test an S3 Connection by attempting to authenticate and access the S3 service using the provided credentials and endpoint configuration.

Parameters:

Name	Type	Description	Default
`type`	`StrictStr`	The type of Connection to test (s3, snowflake, delta_sharing, priceit_dim, gcs, or bigquery)	`None`
`path_restriction`	`ConstrainedStrValue \| None`	Optional path restriction to limit access to specific paths within the S3 bucket	`None`
`auth`	`S3AuthRequest`	Use one of: S3SecretKeyAuthRequest.	`None`

TestSnowflakeConnectionRequest

Request to test a Snowflake Connection by attempting to authenticate and connect to the Snowflake database using the provided credentials and connection settings.

Parameters:

Name	Type	Description	Default
`type`	`StrictStr`	The type of Connection to test (s3, snowflake, delta_sharing, priceit_dim, gcs, or bigquery)	`None`
`database`	`ConstrainedStrValue \| None`	The Snowflake database to connect to	`None`
`var_schema`	`ConstrainedStrValue \| None`	The Snowflake schema to use	`None`
`warehouse`	`ConstrainedStrValue \| None`	The Snowflake warehouse to use for query execution	`None`
`auth`	`SnowflakeAuthRequest`	Use one of: SnowflakeClientCredentialsAuthRequest, SnowflakePasswordAuthRequest.	`None`

TestUpdatedBigQueryConnectionRequest

Request to test an updated BigQuery Connection using the current configuration stored in the system.

Parameters:

Name	Type	Description	Default
`type`	`StrictStr`	The type of Connection to test (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`dataset_id`	`ConstrainedStrValue \| None`	Optional BigQuery dataset ID to scope the connection. When set, used as the default dataset for table listing and connection testing.	`None`

TestUpdatedConnectionRequest

Request to test an updated Connection configuration by attempting to establish a connection using the current settings stored in the system.

Use one of: TestUpdatedBigQueryConnectionRequest, TestUpdatedDeltaSharingConnectionRequest, TestUpdatedGcsConnectionRequest, TestUpdatedPriceItDimConnectionRequest, TestUpdatedS3ConnectionRequest, TestUpdatedSnowflakeConnectionRequest.

Parameters:

Name	Type	Description	Default
`type`	`StrictStr`	The type of Connection to test (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`

TestUpdatedDeltaSharingConnectionRequest

Request to test Deltasharing Connection using the current configuration stored in the system.

Parameters:

Name	Type	Description	Default
`type`	`StrictStr`	The type of Connection to test (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`

TestUpdatedGcsConnectionRequest

Request to test an updated GCP Object Storage Connection using the current configuration stored in the system, including any path restrictions.

Parameters:

Name	Type	Description	Default
`type`	`StrictStr`	The type of Connection to test (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`path_restriction`	`ConstrainedStrValue \| None`	Optional path restriction to limit access to specific paths within the GCS bucket	`None`

TestUpdatedPriceItDimConnectionRequest

Request to test Price-It Connection using the current configuration stored in the system.

Parameters:

Name	Type	Description	Default
`type`	`StrictStr`	The type of Connection to test (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`

TestUpdatedS3ConnectionRequest

Request to test an updated S3 Connection using the current configuration stored in the system, including any path restrictions.

Parameters:

Name	Type	Description	Default
`type`	`StrictStr`	The type of Connection to test (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`path_restriction`	`ConstrainedStrValue \| None`	Optional path restriction to limit access to specific paths within the S3 bucket	`None`

TestUpdatedSnowflakeConnectionRequest

Request to test an updated Snowflake Connection using the current configuration stored in the system, including database, schema, and warehouse settings.

Parameters:

Name	Type	Description	Default
`type`	`StrictStr`	The type of Connection to test (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`database`	`ConstrainedStrValue \| None`	The Snowflake database to connect to	`None`
`var_schema`	`ConstrainedStrValue \| None`	The Snowflake schema to use	`None`
`warehouse`	`ConstrainedStrValue \| None`	The Snowflake warehouse to use for query execution	`None`

TransformationGraphResponse

Parameters:

Name	Type	Description	Default
`created_by`	`User`	An enumeration.	`None`
`created_date`	`datetime`	Date and time when this entity was created	`None`
`last_modified_by`	`User`	An enumeration.	`None`
`last_modified_date`	`datetime`	Date and time when this entity was last modified	`None`
`nodes`	`ConstrainedListValue \| None`	List of all nodes (DataTables and recipes) within the transformation graph	`None`
`edges`	`ConstrainedListValue \| None`	List of all connections between nodes in the transformation graph, defining the data flow	`None`
`dataset_id`	`StrictInt \| None`	Unique identifier of the Dataset that contains this transformation graph	`None`
`version_number`	`StrictInt \| None`	Version number of this transformation graph within the Dataset	`None`
`output_dataset_recipe_node_id`	`StrictInt \| None`	Identifier of the final recipe node that produces the output of this transformation graph	`None`
`release_status`	`StrictBool \| None`	Indicates whether this transformation graph version has been released for production use	`None`
`lock_version`	`StrictInt \| None`	Version number used for optimistic locking to prevent concurrent modifications	`None`

TransformationGraphWrapperResponse

The most recent version of the transformation graph configuration

Parameters:

Name	Type	Description	Default
`latest_transformation_graph`	`TransformationGraphResponse \| None`	An enumeration.	`None`

UpdateBigQueryConnectionRequest

Request to update a BigQuery Connection, allowing modification of authentication credentials and dataset configuration.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`type`	`StrictStr`	The type of Connection being updated (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`dataset_id`	`ConstrainedStrValue \| None`	Optional BigQuery dataset ID to scope the connection. When set, used as the default dataset for table listing and connection testing.	`None`
`auth`	`GcpAuthRequest`	Use one of: GcpServiceAccountKeyAuthRequest, GcpWorkloadIdentityAuthRequest.	`None`

UpdateBucketDataSourceRequest

Request to update a bucket-based DataSource, allowing modification of the storage path and other configuration settings.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`connection_id`	`StrictInt`	The unique identifier of the Connection used by this DataSource	`None`
`type`	`StrictStr`	The type of DataSource being updated (bucket, rdbms, delta sharing)	`None`
`path`	`ConstrainedStrValue`	The path within the bucket where the data files are located	`None`

UpdateConnectionRequest

Request to update an existing Connection configuration including authentication details and connection parameters. Requires the current lock version to prevent concurrent modifications.

Use one of: UpdateBigQueryConnectionRequest, UpdateDeltaSharingConnectionRequest, UpdateGcsConnectionRequest, UpdatePriceItDimConnectionRequest, UpdateS3ConnectionRequest, UpdateSnowflakeConnectionRequest.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`type`	`StrictStr`	The type of Connection being updated (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`

UpdateConnectionTypeMappingRequest

Request to update the type mapping of a price it connection.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`type_mapping`	`ConstrainedStrValue`	JSON-formatted string mapping source columns to target types in price-it. Keys are source column names, values are target type values in price-it. Example: {"columnA":"integer","columnB":"text"}	`None`
`type_mapping_name`	`ConstrainedStrValue \| None`	Optional name/label for the type mapping configuration.	`None`

UpdateDataSourceRequest

Request to update an existing DataSource configuration. Requires the current lock version to prevent concurrent modifications and allows changing connection settings and data location parameters.

Use one of: UpdateBucketDataSourceRequest, UpdateDeltaSharingDataSourceRequest, UpdateRDBMSDataSourceRequest.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`connection_id`	`StrictInt`	The unique identifier of the Connection used by this DataSource	`None`
`type`	`StrictStr`	The type of DataSource being updated (bucket, rdbms, delta sharing)	`None`

UpdateDataTableRequest

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	Name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	List of unique tags for categorizing and organizing the entity	`None`
`id`	`StrictInt`	Unique identifier of the entity	`None`
`lock_version`	`StrictInt`	Version number used for optimistic locking to prevent concurrent modifications	`None`
`data_source_id`	`StrictInt`	Unique identifier of the DataSource from which this DataTable imports data	`None`
`data_version_exist`	`StrictBool \| None`	Indicates whether this DataTable has any data versions available	`None`

UpdateDatasetDataTableNodeRequest

Updates the configuration of an existing DataTable node within the transformation graph. This allows modification of node properties.

Parameters:

Name	Type	Description	Default
`node_type`	`StrictStr`	Type of node in the transformation graph (TABLE for DataTable references, RECIPE for transformation logic)	`None`
`dataset_id`	`StrictInt`	Unique identifier of the Dataset that contains this node	`None`
`id`	`StrictInt`	Unique identifier of the entity	`None`
`lock_version`	`StrictInt`	Version number used for optimistic locking to prevent concurrent modifications	`None`
`data_table_id`	`StrictInt \| None`	Unique identifier of the referenced DataTable	`None`
`data_table_version_number`	`StrictInt \| None`	Specific version number of the DataTable to use in the transformation	`None`

UpdateDatasetNodeRequest

Use one of: UpdateDatasetRecipeNodeRequest, UpdateDatasetDataTableNodeRequest.

Parameters:

Name	Type	Description	Default
`node_type`	`StrictStr`	Type of node in the transformation graph (TABLE for DataTable references, RECIPE for transformation logic)	`None`
`dataset_id`	`StrictInt`	Unique identifier of the Dataset that contains this node	`None`
`id`	`StrictInt`	Unique identifier of the entity	`None`
`lock_version`	`StrictInt`	Version number used for optimistic locking to prevent concurrent modifications	`None`

UpdateDatasetRecipeNodeRequest

Updates the configuration of an existing recipe node within the transformation graph. This allows modification of node properties. To update recipe code, use PUT /v1/recipes/{recipe-id}/versions/{version-number}.

Parameters:

Name	Type	Description	Default
`node_type`	`StrictStr`	Type of node in the transformation graph (TABLE for DataTable references, RECIPE for transformation logic)	`None`
`dataset_id`	`StrictInt`	Unique identifier of the Dataset that contains this node	`None`
`id`	`StrictInt`	Unique identifier of the entity	`None`
`lock_version`	`StrictInt`	Version number used for optimistic locking to prevent concurrent modifications	`None`
`source_node_definitions`	`ConstrainedListValue`	Source nodes with aliases. Size must equal recipeVersion.aliases.size().	`None`
`recipe_id`	`StrictInt`	ID of the existing recipe to reference in the transformation graph (optional, only needed when switching to a different recipe)	`None`
`recipe_version_number`	`StrictInt`	An enumeration.	`None`

UpdateDatasetRequest

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue \| None`	Name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	List of unique tags for categorizing and organizing the entity	`None`
`id`	`StrictInt`	Unique identifier of the entity	`None`
`lock_version`	`StrictInt`	Version number used for optimistic locking to prevent concurrent modifications	`None`

UpdateDeltaSharingConnectionRequest

Request to update a Delta Sharing Connection including the Deltashare-profile configuration.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`type`	`StrictStr`	The type of Connection being updated (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`auth`	`DeltaSharingAuthRequest`	Use one of: DeltaSharingJsonProfileAuthRequest.	`None`

UpdateDeltaSharingDataSourceRequest

Request to update a Delta Sharing DataSource, allowing modification of the share, schema, and table configuration.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`connection_id`	`StrictInt`	The unique identifier of the Connection used by this DataSource	`None`
`type`	`StrictStr`	The type of DataSource being updated (bucket, rdbms, delta sharing)	`None`
`share`	`ConstrainedStrValue \| None`	The share to use for accessing shared data	`None`
`var_schema`	`ConstrainedStrValue \| None`	The schema within the Delta Share to use for accessing shared data	`None`
`table`	`ConstrainedStrValue \| None`	The table within the Delta Share to use for accessing shared data	`None`

UpdateGcsConnectionRequest

Request to update a GCP Object Storage Connection, allowing modification of authentication credentials and path restrictions.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`type`	`StrictStr`	The type of Connection being updated (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`path_restriction`	`ConstrainedStrValue \| None`	Optional path restriction to limit access to specific paths within the GCS bucket	`None`
`auth`	`GcpAuthRequest`	Use one of: GcpServiceAccountKeyAuthRequest, GcpWorkloadIdentityAuthRequest.	`None`

UpdatePriceItDimConnectionRequest

Request to update a Price-it DIM Connection, allowing modification of authentication credentials.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`type`	`StrictStr`	The type of Connection being updated (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`auth`	`OAuthRequest`	Use one of: ClientCredentialsAuthRequest.	`None`

UpdateRDBMSDataSourceRequest

Request to update a database-based DataSource, allowing modification of the SQL query, warehouse settings, and other configuration parameters.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`connection_id`	`StrictInt`	The unique identifier of the Connection used by this DataSource	`None`
`type`	`StrictStr`	The type of DataSource being updated (bucket, rdbms, delta sharing)	`None`
`query`	`ConstrainedStrValue`	The SQL query to execute for data retrieval	`None`
`warehouse`	`ConstrainedStrValue \| None`	The warehouse to use for query execution	`None`

UpdateRecipeRequest

Request payload for updating recipe base metadata (name and description). These fields are shared across all recipe versions.

Parameters:

Name	Type	Description	Default
`name`	`ConstrainedStrValue`	Name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	List of unique tags for categorizing and organizing the entity	`None`
`id`	`StrictInt`	Unique identifier of the entity	`None`
`lock_version`	`StrictInt`	Version number used for optimistic locking to prevent concurrent modifications	`None`
`shared`	`StrictBool \| None`	An enumeration.	`True`

UpdateRecipeVersionRequest

Updates version-specific code (can only update if version is NOT locked)

Parameters:

Name	Type	Description	Default
`code`	`ConstrainedStrValue`	SQL code that defines the data transformation logic	`None`
`version_number`	`StrictInt`	Recipe version number (current version used by this node)	`None`
`aliases`	`ConstrainedListValue \| None`	Table aliases used in SQL code for recipe transformations. Single-source recipes have 1 alias (e.g. "CurrentTable" for backward compatibility, or any valid name). Multi-source recipes have 2-10 aliases matching table names in SQL.	`None`
`lock_version`	`StrictInt`	Optimistic locking version	`None`

UpdateS3ConnectionRequest

Request to update an S3 Connection, allowing modification of authentication credentials, endpoint configuration, and path restrictions.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`type`	`StrictStr`	The type of Connection being updated (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`path_restriction`	`ConstrainedStrValue \| None`	Optional path restriction to limit access to specific paths within the S3 bucket	`None`
`auth`	`S3AuthRequest`	Use one of: S3SecretKeyAuthRequest.	`None`

UpdateSnowflakeConnectionRequest

Request to update a Snowflake Connection, allowing modification of authentication credentials and connection settings including database, schema, and warehouse configuration.

Parameters:

Name	Type	Description	Default
`id`	`StrictInt`	The unique identifier of the entity	`None`
`lock_version`	`StrictInt`	The current version of the entity used for optimistic locking to prevent concurrent modifications	`None`
`name`	`ConstrainedStrValue`	The name of the entity for identification and display purposes	`None`
`description`	`ConstrainedStrValue \| None`	Optional detailed description providing additional context about the entity	`None`
`tags`	`ConstrainedListValue \| None`	A list of unique tags for categorizing and organizing the entity	`None`
`type`	`StrictStr`	The type of Connection being updated (s3, snowflake, delta_sharing, priceit_dim, gcs, bigquery)	`None`
`database`	`ConstrainedStrValue \| None`	The Snowflake database to connect to	`None`
`var_schema`	`ConstrainedStrValue \| None`	The Snowflake schema to use	`None`
`warehouse`	`ConstrainedStrValue \| None`	The Snowflake warehouse to use for query execution	`None`
`auth`	`SnowflakeAuthRequest`	Use one of: SnowflakeClientCredentialsAuthRequest, SnowflakePasswordAuthRequest.	`None`

UsageMonitoringResponse

Aggregated usage metrics for a tenant

Parameters:

Name	Type	Description	Default
`metric_type`	`StrictStr`	Type of usage metric	`None`
`total_value`	`StrictInt`	Total aggregated metric value across all jobs	`None`

UserMessageRequest

Parameters:

Name	Type	Description	Default
`user_message`	`ConstrainedStrValue`	The message content provided by the user to be added to the conversation	`None`