nexla_sdk.models

Classes

AccessRole

Defined in nexla_sdk/models/enums.py:4

Access roles for resources.

Members:

• OWNER = owner
• ADMIN = admin
• OPERATOR = operator
• COLLABORATOR = collaborator

AccessorType

Defined in nexla_sdk/models/access/enums.py:4

Types of accessors.

Members:

• USER = USER
• TEAM = TEAM
• ORG = ORG

AccessorsRequest

Defined in nexla_sdk/models/access/requests.py:38

Request model for accessor operations.

Fields:

• accessors: List — List of accessor requests

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

AccountMetrics

Defined in nexla_sdk/models/metrics/responses.py:6

Account utilization metrics.

Fields:

• status: int
• metrics: List

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

AccountSummary

Defined in nexla_sdk/models/organizations/responses.py:60

Organization account summary statistics.

Fields:

• org_id: int
• data_sources: Dict
• data_sets: Dict
• data_sinks: Dict

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

BaseModel

Defined in nexla_sdk/models/base.py:8

Base model class with Pydantic functionality and Nexla API compatibility.

Features:

• Automatically ignores unknown fields from API responses
• Supports both camelCase and snake_case field names
• Handles datetime parsing automatically
• Provides JSON serialization methods
• Validates data types automatically
• Easy logging and printing support

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

Connector

Defined in nexla_sdk/models/common.py:31

Connector information.

Fields:

• id: int
• type: str
• connection_type: str
• name: str
• description: str
• nexset_api_compatible: bool

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

ConnectorCategory

Defined in nexla_sdk/models/enums.py:85

Connector categories.

Members:

• FILE = file
• DATABASE = database
• NOSQL = nosql
• STREAMING = streaming
• API = api
• VECTOR_DB = vector_db
• SPECIAL = special

Credential

Defined in nexla_sdk/models/credentials/responses.py:8

Data credential response model.

Fields:

• id: int
• name: str
• credentials_type: str
• owner: Optional
• org: Optional
• access_roles: Optional
• verified_status: Optional
• connector: Optional
• description: Optional
• credentials_version: Optional
• api_keys: Optional
• credentials_non_secure_data: Optional
• verified_at: Optional
• copied_from_id: Optional
• template_config: Optional
• vendor: Optional
• auth_template: Optional
• referenced_resource_ids: Optional
• tags: Optional
• created_at: Optional
• updated_at: Optional
• managed: bool

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

CredentialCreate

Defined in nexla_sdk/models/credentials/requests.py:5

Request model for creating a credential.

Fields:

• name: str
• credentials_type: str
• description: Optional
• auth_template_id: Optional
• vendor_id: Optional
• template_config: Optional
• credentials: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

CredentialType

Defined in nexla_sdk/models/credentials/enums.py:4

Supported credential types.

Members:

• AS400 = as400
• AWS_ATHENA = aws_athena
• AZURE_BLB = azure_blb
• AZURE_DATA_LAKE = azure_data_lake
• AZURE_SYNAPSE = azure_synapse
• BIGQUERY = bigquery
• BOX = box
• CLOUDSQL_MYSQL = cloudsql_mysql
• CLOUDSQL_POSTGRES = cloudsql_postgres
• CLOUDSQL_SQLSERVER = cloudsql_sqlserver
• CONFLUENT_KAFKA = confluent_kafka
• DATABRICKS = databricks
• DB2 = db2
• DELTA_LAKE_AZURE_BLB = delta_lake_azure_blb
• DELTA_LAKE_AZURE_DATA_LAKE = delta_lake_azure_data_lake
• DELTA_LAKE_S3 = delta_lake_s3
• DROPBOX = dropbox
• DYNAMODB = dynamodb
• FIREBASE = firebase
• FIREBOLT = firebolt
• FTP = ftp
• GCP_ALLOYDB = gcp_alloydb
• GCP_SPANNER = gcp_spanner
• GCS = gcs
• GDRIVE = gdrive
• GOOGLE_PUBSUB = google_pubsub
• HANA_JDBC = hana_jdbc
• HIVE = hive
• JMS = jms
• KAFKA = kafka
• MIN_IO_S3 = min_io_s3
• MONGO = mongo
• MYSQL = mysql
• NETSUITE_JDBC = netsuite_jdbc
• NEXLA_MONITOR = nexla_monitor
• ORACLE = oracle
• ORACLE_AUTONOMOUS = oracle_autonomous
• PINECONE = pinecone
• POSTGRES = postgres
• REDSHIFT = redshift
• REST = rest
• S3 = s3
• S3_ICEBERG = s3_iceberg
• SHAREPOINT = sharepoint
• SNOWFLAKE = snowflake
• SNOWFLAKE_DCR = snowflake_dcr
• SOAP = soap
• SQLSERVER = sqlserver
• SYBASE = sybase
• TERADATA = teradata
• TIBCO = tibco
• WEBDAV = webdav

CredentialUpdate

Defined in nexla_sdk/models/credentials/requests.py:20

Request model for updating a credential.

Fields:

• name: Optional
• description: Optional
• credentials: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

DashboardMetrics

Defined in nexla_sdk/models/metrics/responses.py:20

24-hour dashboard metrics.

Fields:

• status: int
• metrics: Dict

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

DataMapInfo

Defined in nexla_sdk/models/destinations/responses.py:22

Basic data map information for destination.

Fields:

• id: int
• owner_id: int
• org_id: int
• name: str
• description: str
• public: bool
• created_at: datetime
• updated_at: datetime

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

DataSetBrief

Defined in nexla_sdk/models/sources/responses.py:9

Brief dataset information.

Fields:

• id: int
• owner_id: int
• org_id: int
• name: Optional
• description: Optional
• version: Optional
• created_at: Optional
• updated_at: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

DataSetInfo

Defined in nexla_sdk/models/destinations/responses.py:10

Basic dataset information for destination.

Fields:

• id: int
• name: str
• description: Optional
• status: Optional
• output_schema: Optional
• version: Optional
• created_at: Optional
• updated_at: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

DataSinkSimplified

Defined in nexla_sdk/models/nexsets/responses.py:10

Simplified data sink information.

Fields:

• id: int
• owner_id: int
• org_id: int
• name: str
• status: Optional
• sink_type: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

DefaultOrg

Defined in nexla_sdk/models/users/responses.py:7

User's default organization.

Fields:

• id: int
• name: str

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

Destination

Defined in nexla_sdk/models/destinations/responses.py:34

Destination (data sink) response model.

Fields:

• id: int
• name: str
• status: str
• sink_type: str
• connector_type: Optional
• owner: Optional
• org: Optional
• access_roles: Optional
• managed: Optional
• connector: Optional
• description: Optional
• data_set_id: Optional
• data_map_id: Optional
• data_source_id: Optional
• sink_format: Optional
• sink_config: Optional
• sink_schedule: Optional
• in_memory: bool
• data_set: Optional
• data_map: Optional
• data_credentials_id: Optional
• data_credentials: Optional
• copied_from_id: Optional
• flow_type: Optional
• has_template: Optional
• vendor_endpoint: Optional
• vendor: Optional
• tags: List
• created_at: Optional
• updated_at: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

DestinationCopyOptions

Defined in nexla_sdk/models/destinations/requests.py:30

Options for copying a destination.

Fields:

• reuse_data_credentials: bool
• copy_access_controls: bool
• owner_id: Optional
• org_id: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

DestinationCreate

Defined in nexla_sdk/models/destinations/requests.py:5

Request model for creating a destination.

Fields:

• name: str
• sink_type: str
• data_credentials_id: int
• data_set_id: int
• description: Optional
• sink_config: Optional
• vendor_endpoint_id: Optional
• template_config: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

DestinationFormat

Defined in nexla_sdk/models/destinations/enums.py:58

Output format for destinations.

Members:

• JSON = json
• CSV = csv
• PARQUET = parquet
• AVRO = avro
• XML = xml
• DELIMITED = delimited
• FIXED_WIDTH = fixed_width

DestinationStatus

Defined in nexla_sdk/models/destinations/enums.py:4

Destination status values.

Members:

• ACTIVE = ACTIVE
• PAUSED = PAUSED
• DRAFT = DRAFT
• DELETED = DELETED
• ERROR = ERROR

DestinationType

Defined in nexla_sdk/models/destinations/enums.py:13

Supported sink types.

Members:

• S3 = s3
• GCS = gcs
• AZURE_BLB = azure_blb
• FTP = ftp
• DROPBOX = dropbox
• BOX = box
• GDRIVE = gdrive
• SHAREPOINT = sharepoint
• MYSQL = mysql
• POSTGRES = postgres
• SQLSERVER = sqlserver
• ORACLE = oracle
• REDSHIFT = redshift
• SNOWFLAKE = snowflake
• BIGQUERY = bigquery
• DATABRICKS = databricks
• MONGO = mongo
• DYNAMODB = dynamodb
• FIREBASE = firebase
• KAFKA = kafka
• CONFLUENT_KAFKA = confluent_kafka
• GOOGLE_PUBSUB = google_pubsub
• REST = rest
• EMAIL = email
• DATA_MAP = data_map
• PINECONE = pinecone

DestinationUpdate

Defined in nexla_sdk/models/destinations/requests.py:21

Request model for updating a destination.

Fields:

• name: Optional
• description: Optional
• sink_config: Optional
• data_credentials_id: Optional
• data_set_id: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

FlowCopyOptions

Defined in nexla_sdk/models/flows/requests.py:5

Options for copying a flow.

Fields:

• reuse_data_credentials: bool
• copy_access_controls: bool
• copy_dependent_data_flows: bool
• owner_id: Optional
• org_id: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

FlowElements

Defined in nexla_sdk/models/flows/responses.py:22

Flow elements containing all resources.

Fields:

• code_containers: List
• data_sources: List
• data_sets: List
• data_sinks: List
• data_credentials: List
• shared_data_sets: List
• orgs: List
• users: List
• projects: List

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

FlowMetrics

Defined in nexla_sdk/models/flows/responses.py:12

Flow metrics information.

Fields:

• origin_node_id: int
• records: int
• size: int
• errors: int
• reporting_date: datetime
• run_id: int

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

FlowNode

Defined in nexla_sdk/models/common.py:61

Flow node in a data pipeline.

Fields:

• id: int
• origin_node_id: int
• parent_node_id: Optional
• data_source_id: Optional
• data_set_id: Optional
• data_sink_id: Optional
• status: Optional
• project_id: Optional
• flow_type: Optional
• ingestion_mode: Optional
• name: Optional
• description: Optional
• children: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

FlowResponse

Defined in nexla_sdk/models/flows/responses.py:35

Flow response model.

Fields:

• flows: List
• code_containers: Optional
• data_sources: Optional
• data_sets: Optional
• data_sinks: Optional
• data_credentials: Optional
• shared_data_sets: Optional
• orgs: Optional
• users: Optional
• projects: Optional
• metrics: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

FlowType

Defined in nexla_sdk/models/sources/enums.py:68

Flow processing types.

Members:

• BATCH = batch
• STREAMING = streaming
• REAL_TIME = real_time

IngestMethod

Defined in nexla_sdk/models/sources/enums.py:59

Data ingestion methods.

Members:

• BATCH = BATCH
• STREAMING = STREAMING
• REAL_TIME = REAL_TIME
• SCHEDULED = SCHEDULED
• POLL = POLL

LogEntry

Defined in nexla_sdk/models/common.py:41

Audit log entry.

Fields:

• id: int
• item_type: str
• item_id: int
• event: str
• change_summary: List
• object_changes: Dict
• request_ip: str
• request_user_agent: str
• request_url: str
• user: Dict
• org_id: int
• owner_id: int
• owner_email: str
• created_at: datetime
• association_resource: Optional
• impersonator_id: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

Lookup

Defined in nexla_sdk/models/lookups/responses.py:8

Lookup (data map) response model.

Fields:

• id: int
• name: str
• description: str
• map_primary_key: str
• owner: Owner
• org: Organization
• access_roles: List
• public: bool
• managed: bool
• data_type: str
• emit_data_default: bool
• use_versioning: bool
• data_format: Optional
• data_sink_id: Optional
• data_defaults: Dict
• data_set_id: Optional
• map_entry_count: Optional
• map_entry_schema: Optional
• tags: List
• created_at: Optional
• updated_at: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

LookupCreate

Defined in nexla_sdk/models/lookups/requests.py:6

Request model for creating a lookup.

Fields:

• name: str
• data_type: str
• map_primary_key: str
• description: Optional
• data_defaults: Dict
• emit_data_default: bool
• data_map: Optional
• tags: List

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

LookupEntriesUpsert

Defined in nexla_sdk/models/lookups/requests.py:28

Request model for upserting lookup entries.

Fields:

• entries: List

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

LookupUpdate

Defined in nexla_sdk/models/lookups/requests.py:18

Request model for updating a lookup.

Fields:

• name: Optional
• description: Optional
• map_primary_key: Optional
• data_defaults: Optional
• emit_data_default: Optional
• tags: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

MetricsByRunResponse

Defined in nexla_sdk/models/metrics/responses.py:50

Metrics by run response with pagination.

Fields:

• status: int
• metrics: Dict

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

MetricsResponse

Defined in nexla_sdk/models/metrics/responses.py:44

Generic metrics response.

Fields:

• status: int
• metrics: List

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

Nexset

Defined in nexla_sdk/models/nexsets/responses.py:20

Nexset (data set) response model.

Fields:

• id: int
• name: Optional
• description: Optional
• status: Optional
• owner: Optional
• org: Optional
• access_roles: Optional
• flow_type: Optional
• data_source_id: Optional
• data_source: Optional
• parent_data_sets: List
• data_sinks: List
• transform_id: Optional
• output_schema: Optional
• copied_from_id: Optional
• tags: List
• created_at: Optional
• updated_at: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

NexsetCopyOptions

Defined in nexla_sdk/models/nexsets/requests.py:41

Options for copying a nexset.

Fields:

• copy_access_controls: bool
• owner_id: Optional
• org_id: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

NexsetCreate

Defined in nexla_sdk/models/nexsets/requests.py:7

Request model for creating a nexset.

Fields:

• name: str
• parent_data_set_id: int
• has_custom_transform: bool
• transform: Optional
• transform_id: Optional
• description: Optional
• output_schema_annotations: Optional
• output_schema_validation_enabled: bool
• output_validation_schema: Optional
• data_sinks: List
• custom_config: Optional
• tags: List

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

NexsetSample

Defined in nexla_sdk/models/nexsets/responses.py:43

Nexset sample record.

Fields:

• raw_message: Dict
• nexla_metadata: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

NexsetStatus

Defined in nexla_sdk/models/nexsets/enums.py:4

Nexset status values.

Members:

• ACTIVE = ACTIVE
• PAUSED = PAUSED
• DRAFT = DRAFT
• DELETED = DELETED
• ERROR = ERROR
• PROCESSING = PROCESSING

NexsetUpdate

Defined in nexla_sdk/models/nexsets/requests.py:26

Request model for updating a nexset.

Fields:

• name: Optional
• description: Optional
• has_custom_transform: Optional
• transform: Optional
• transform_id: Optional
• output_schema_annotations: Optional
• output_schema_validation_enabled: Optional
• output_validation_schema: Optional
• data_sinks: Optional
• custom_config: Optional
• tags: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

Notification

Defined in nexla_sdk/models/notifications/responses.py:8

Notification response model.

Fields:

• id: int
• owner: Owner
• org: Organization
• access_roles: List
• level: str
• resource_id: int
• resource_type: str
• message_id: int
• message: str
• read_at: Optional
• created_at: Optional
• updated_at: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

NotificationChannel

Defined in nexla_sdk/models/enums.py:53

Notification delivery channels.

Members:

• APP = APP
• EMAIL = EMAIL
• SMS = SMS
• SLACK = SLACK
• WEBHOOKS = WEBHOOKS

NotificationChannelSetting

Defined in nexla_sdk/models/notifications/responses.py:37

Notification channel configuration.

Fields:

• id: int
• owner_id: int
• org_id: int
• channel: str
• config: Dict

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

NotificationChannelSettingCreate

Defined in nexla_sdk/models/notifications/requests.py:6

Request model for creating notification channel setting.

Fields:

• channel: str
• config: Dict

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

NotificationChannelSettingUpdate

Defined in nexla_sdk/models/notifications/requests.py:12

Request model for updating notification channel setting.

Fields:

• channel: Optional
• config: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

NotificationCount

Defined in nexla_sdk/models/notifications/responses.py:67

Notification count response.

Fields:

• count: int

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

NotificationLevel

Defined in nexla_sdk/models/enums.py:43

Notification levels.

Members:

• DEBUG = DEBUG
• INFO = INFO
• WARN = WARN
• ERROR = ERROR
• RECOVERED = RECOVERED
• RESOLVED = RESOLVED

NotificationSetting

Defined in nexla_sdk/models/notifications/responses.py:46

Notification setting configuration.

Fields:

• id: int
• org_id: int
• owner_id: int
• channel: str
• notification_resource_type: str
• resource_id: int
• status: str
• notification_type_id: int
• name: str
• description: str
• code: int
• category: str
• event_type: str
• resource_type: str
• config: Dict
• priority: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

NotificationSettingCreate

Defined in nexla_sdk/models/notifications/requests.py:18

Request model for creating notification setting.

Fields:

• channel: str
• notification_type_id: int
• status: Optional
• config: Dict
• notification_resource_type: Optional
• resource_id: Optional
• notification_channel_setting_id: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

NotificationSettingUpdate

Defined in nexla_sdk/models/notifications/requests.py:29

Request model for updating notification setting.

Fields:

• channel: Optional
• status: Optional
• config: Optional
• notification_resource_type: Optional
• resource_id: Optional
• checked: Optional
• notification_channel_setting_id: Optional
• notification_type_id: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

NotificationType

Defined in nexla_sdk/models/notifications/responses.py:25

Notification type information.

Fields:

• id: int
• name: str
• description: str
• category: str
• default: bool
• status: bool
• event_type: str
• resource_type: str

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

OrgAccessorRequest

Defined in nexla_sdk/models/access/requests.py:25

Request model for ORG type accessor.

Fields:

• type: Literal
• id: Optional — Unique ID of the organization
• client_identifier: Optional — Client identifier for the organization
• email_domain: Optional — Email domain for the organization
• access_roles: List — List of access roles

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

OrgAccessorResponse

Defined in nexla_sdk/models/access/responses.py:30

Response model for ORG type accessor.

Fields:

• type: Literal
• id: Optional — Unique ID of the organization
• client_identifier: Optional — Client identifier for the organization
• email_domain: Optional — Email domain for the organization
• access_roles: List — List of access roles
• created_at: Optional — Creation timestamp
• updated_at: Optional — Last update timestamp

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

OrgMember

Defined in nexla_sdk/models/organizations/responses.py:49

Organization member information.

Fields:

• id: int
• full_name: str
• email: str
• is_admin: bool
• access_role: Optional
• org_membership_status: str
• user_status: str

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

OrgMemberActivateDeactivateRequest

Defined in nexla_sdk/models/organizations/requests.py:71

Request model for activating/deactivating org members.

Fields:

• members: List

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

OrgMemberCreateRequest

Defined in nexla_sdk/models/organizations/requests.py:12

Request model for creating an org member.

Fields:

• full_name: str
• email: str
• admin: bool

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

OrgMemberDelete

Defined in nexla_sdk/models/organizations/requests.py:66

Request model for deleting org members.

Fields:

• members: List

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

OrgMemberDeleteRequest

Defined in nexla_sdk/models/organizations/requests.py:59

Request model for deleting a single org member.

Fields:

• id: Optional
• email: Optional
• delegate_owner_id: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

OrgMemberList

Defined in nexla_sdk/models/organizations/requests.py:54

Request model for updating org members.

Fields:

• members: List

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

OrgMemberUpdate

Defined in nexla_sdk/models/organizations/requests.py:45

Request model for updating org member.

Fields:

• id: Optional
• email: Optional
• full_name: Optional
• admin: Optional
• access_role: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

OrgMembership

Defined in nexla_sdk/models/users/responses.py:13

Organization membership details.

Fields:

• id: int
• name: str
• is_admin: Optional
• org_membership_status: str
• api_key: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

OrgMembershipStatus

Defined in nexla_sdk/models/enums.py:79

Organization membership status.

Members:

• ACTIVE = ACTIVE
• DEACTIVATED = DEACTIVATED

OrgTier

Defined in nexla_sdk/models/organizations/responses.py:8

Organization tier information.

Fields:

• id: int
• name: str
• display_name: str
• record_count_limit: int
• record_count_limit_time: str
• data_source_count_limit: int
• trial_period_days: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

Organization

Defined in nexla_sdk/models/organizations/responses.py:19

Organization response model.

Fields:

• id: int
• name: str
• email_domain: Optional
• access_roles: List
• owner: Optional
• status: Optional
• members_default_access_role: Optional
• default_reusable_code_container_access_role: Optional
• require_org_admin_to_publish: Optional
• require_org_admin_to_subscribe: Optional
• enable_nexla_password_login: Optional
• description: Optional
• email: Optional
• client_identifier: Optional
• org_webhook_host: Optional
• default_cluster_id: Optional
• billing_owner: Optional
• admins: List
• org_tier: Optional
• account_tier_display_name: Optional
• account_tier_name: Optional
• email_domain_verified_at: Optional
• name_verified_at: Optional
• created_at: Optional
• updated_at: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

OrganizationCreate

Defined in nexla_sdk/models/organizations/requests.py:19

Request model for creating an organization.

Fields:

• name: str
• email_domain: str
• owner: Optional
• owner_id: Optional
• description: Optional
• billing_owner: Optional
• billing_owner_id: Optional
• email: Optional
• account_tier_id: Optional
• members: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

OrganizationUpdate

Defined in nexla_sdk/models/organizations/requests.py:33

Request model for updating an organization.

Fields:

• name: Optional
• description: Optional
• owner: Optional
• owner_id: Optional
• billing_owner: Optional
• billing_owner_id: Optional
• email: Optional
• members: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

OutputType

Defined in nexla_sdk/models/nexsets/enums.py:23

Transform output types.

Members:

• RECORD = record
• ATTRIBUTE = attribute
• CUSTOM = custom

Owner

Defined in nexla_sdk/models/common.py:6

User who owns a resource.

Fields:

• id: int
• full_name: str
• email: str
• email_verified_at: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

ProbeSampleRequest

Defined in nexla_sdk/models/credentials/requests.py:35

Request for previewing connector content.

Fields:

• path: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

ProbeSampleResponse

Defined in nexla_sdk/models/credentials/responses.py:61

Response from credential probe sample operation.

Fields:

• status: str
• message: str
• connection_type: str
• output: Dict

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

ProbeTreeRequest

Defined in nexla_sdk/models/credentials/requests.py:27

Request for probing storage structure.

Fields:

• depth: int
• path: Optional
• database: Optional
• table: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

ProbeTreeResponse

Defined in nexla_sdk/models/credentials/responses.py:53

Response from credential probe tree operation.

Fields:

• status: str
• message: str
• connection_type: str
• object: Dict

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

Project

Defined in nexla_sdk/models/projects/responses.py:21

Project response model.

Fields:

• id: int
• owner: Owner
• org: Organization
• name: str
• description: str
• access_roles: List
• data_flows: List
• flows: List
• client_identifier: Optional
• client_url: Optional
• flows_count: Optional
• tags: List
• copied_from_id: Optional
• created_at: Optional
• updated_at: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

ProjectCreate

Defined in nexla_sdk/models/projects/requests.py:12

Request model for creating a project.

Fields:

• name: str
• description: Optional
• data_flows: List

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

ProjectDataFlow

Defined in nexla_sdk/models/projects/responses.py:8

Project data flow information.

Fields:

• id: int
• project_id: int
• data_source_id: Optional
• data_set_id: Optional
• data_sink_id: Optional
• name: Optional
• description: Optional
• created_at: Optional
• updated_at: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

ProjectFlowIdentifier

Defined in nexla_sdk/models/projects/requests.py:6

Flow identifier for project.

Fields:

• data_source_id: Optional
• data_set_id: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

ProjectFlowList

Defined in nexla_sdk/models/projects/requests.py:26

Request model for managing project flows.

Fields:

• data_flows: Optional
• flows: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

ProjectUpdate

Defined in nexla_sdk/models/projects/requests.py:19

Request model for updating a project.

Fields:

• name: Optional
• description: Optional
• data_flows: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

ResourceMetricDaily

Defined in nexla_sdk/models/metrics/responses.py:26

Daily resource metrics.

Fields:

• time: str
• records: int
• size: int
• errors: int

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

ResourceMetricsByRun

Defined in nexla_sdk/models/metrics/responses.py:34

Resource metrics grouped by run.

Fields:

• runId: Optional
• lastWritten: Optional
• dataSetId: int
• records: int
• size: int
• errors: int

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

ResourceStatus

Defined in nexla_sdk/models/enums.py:12

Common resource status values.

Members:

• ACTIVE = ACTIVE
• PAUSED = PAUSED
• DRAFT = DRAFT
• DELETED = DELETED
• ERROR = ERROR
• INIT = INIT
• PROCESSING = PROCESSING

ResourceType

Defined in nexla_sdk/models/metrics/enums.py:4

Valid resource types for metrics endpoints.

Members:

• DATA_SOURCES = data_sources
• DATA_SINKS = data_sinks
• DATA_SETS = data_sets

RunInfo

Defined in nexla_sdk/models/sources/responses.py:21

Run information.

Fields:

• id: int
• created_at: datetime

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

Source

Defined in nexla_sdk/models/sources/responses.py:27

Data source response model.

Fields:

• id: int
• name: str
• status: str
• source_type: str
• connector_type: Optional
• owner: Optional
• org: Optional
• access_roles: Optional
• managed: Optional
• auto_generated: Optional
• connector: Optional
• description: Optional
• ingest_method: Optional
• source_format: Optional
• source_config: Optional
• poll_schedule: Optional
• code_container_id: Optional
• data_credentials_id: Optional
• data_credentials: Optional
• data_sets: List
• api_keys: List
• run_ids: List
• copied_from_id: Optional
• flow_type: Optional
• has_template: Optional
• vendor_endpoint: Optional
• vendor: Optional
• tags: List
• created_at: Optional
• updated_at: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

SourceCopyOptions

Defined in nexla_sdk/models/sources/requests.py:30

Options for copying a source.

Fields:

• reuse_data_credentials: bool
• copy_access_controls: bool
• owner_id: Optional
• org_id: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

SourceCreate

Defined in nexla_sdk/models/sources/requests.py:6

Request model for creating a source.

Fields:

• name: str
• source_type: str
• data_credentials_id: int
• description: Optional
• source_config: Optional
• vendor_endpoint_id: Optional
• ingest_method: Optional
• template_config: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

SourceStatus

Defined in nexla_sdk/models/sources/enums.py:5

Source status values.

Members:

• ACTIVE = ACTIVE
• PAUSED = PAUSED
• DRAFT = DRAFT
• DELETED = DELETED
• ERROR = ERROR

SourceType

Defined in nexla_sdk/models/sources/enums.py:14

Supported source types.

Members:

• S3 = s3
• GCS = gcs
• AZURE_BLB = azure_blb
• FTP = ftp
• DROPBOX = dropbox
• BOX = box
• GDRIVE = gdrive
• SHAREPOINT = sharepoint
• MYSQL = mysql
• POSTGRES = postgres
• SQLSERVER = sqlserver
• ORACLE = oracle
• REDSHIFT = redshift
• SNOWFLAKE = snowflake
• BIGQUERY = bigquery
• DATABRICKS = databricks
• MONGO = mongo
• DYNAMODB = dynamodb
• FIREBASE = firebase
• KAFKA = kafka
• CONFLUENT_KAFKA = confluent_kafka
• GOOGLE_PUBSUB = google_pubsub
• REST = rest
• SOAP = soap
• NEXLA_REST = nexla_rest
• FILE_UPLOAD = file_upload
• EMAIL = email
• NEXLA_MONITOR = nexla_monitor

SourceUpdate

Defined in nexla_sdk/models/sources/requests.py:22

Request model for updating a source.

Fields:

• name: Optional
• description: Optional
• source_config: Optional
• data_credentials_id: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

Team

Defined in nexla_sdk/models/teams/responses.py:15

Team response model.

Fields:

• id: int
• name: str
• description: str
• owner: Owner
• org: Organization
• member: bool
• members: List
• access_roles: List
• tags: List
• created_at: Optional
• updated_at: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

TeamAccessorRequest

Defined in nexla_sdk/models/access/requests.py:17

Request model for TEAM type accessor.

Fields:

• type: Literal
• id: Optional — Unique ID of the team
• name: Optional — Name of the team
• access_roles: List — List of access roles

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

TeamAccessorResponse

Defined in nexla_sdk/models/access/responses.py:20

Response model for TEAM type accessor.

Fields:

• type: Literal
• id: Optional — Unique ID of the team
• name: Optional — Name of the team
• access_roles: List — List of access roles
• created_at: Optional — Creation timestamp
• updated_at: Optional — Last update timestamp

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

TeamCreate

Defined in nexla_sdk/models/teams/requests.py:14

Request model for creating a team.

Fields:

• name: str
• description: Optional
• members: List

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

TeamMember

Defined in nexla_sdk/models/teams/responses.py:8

Team member information.

Fields:

• id: int
• email: str
• admin: bool

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

TeamMemberList

Defined in nexla_sdk/models/teams/requests.py:28

Request model for team member operations.

Fields:

• members: List

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

TeamMemberRequest

Defined in nexla_sdk/models/teams/requests.py:6

Request model for team member.

Fields:

• id: Optional
• email: Optional
• admin: bool

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

TeamUpdate

Defined in nexla_sdk/models/teams/requests.py:21

Request model for updating a team.

Fields:

• name: Optional
• description: Optional
• members: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

TransformType

Defined in nexla_sdk/models/nexsets/enums.py:14

Transform types.

Members:

• JOLT_STANDARD = jolt_standard
• JOLT_CUSTOM = jolt_custom
• PYTHON = python
• JAVASCRIPT = javascript
• SQL = sql

User

Defined in nexla_sdk/models/users/responses.py:22

User response model.

Fields:

• id: int
• email: str
• full_name: str
• super_user: Optional
• impersonated: bool
• default_org: DefaultOrg
• user_tier: Optional
• status: str
• account_locked: bool
• org_memberships: List
• api_key: Optional
• email_verified_at: Optional
• tos_signed_at: Optional
• created_at: Optional
• updated_at: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

UserAccessorRequest

Defined in nexla_sdk/models/access/requests.py:8

Request model for USER type accessor.

Fields:

• type: Literal
• id: Optional — Unique ID of the user
• email: Optional — Email of the user
• org_id: Optional — Organization ID for cross-org access
• access_roles: List — List of access roles

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

UserAccessorResponse

Defined in nexla_sdk/models/access/responses.py:9

Response model for USER type accessor.

Fields:

• type: Literal
• id: Optional — Unique ID of the user
• email: Optional — Email of the user
• org_id: Optional — Organization ID for cross-org access
• access_roles: List — List of access roles
• created_at: Optional — Creation timestamp
• updated_at: Optional — Last update timestamp

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

UserCreate

Defined in nexla_sdk/models/users/requests.py:6

Request model for creating a user.

Fields:

• full_name: str
• email: str
• default_org_id: Optional
• status: Optional
• user_tier_id: Optional
• user_tier: Optional
• password: Optional
• tos_signed_at: Optional
• admin: Union

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

UserExpanded

Defined in nexla_sdk/models/users/responses.py:50

User with expanded account summary.

Fields:

• id: int
• email: str
• full_name: str
• super_user: Optional
• impersonated: bool
• default_org: DefaultOrg
• user_tier: Optional
• status: str
• account_locked: bool
• org_memberships: List
• api_key: Optional
• email_verified_at: Optional
• tos_signed_at: Optional
• created_at: Optional
• updated_at: Optional
• account_summary: Optional

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

UserMetricResourceType

Defined in nexla_sdk/models/metrics/enums.py:12

Valid resource types for user metrics endpoints.

Members:

• SOURCE = SOURCE
• SINK = SINK

UserSettings

Defined in nexla_sdk/models/users/responses.py:55

User settings.

Fields:

• id: str
• owner: Dict
• org: Dict
• user_settings_type: str
• settings: Dict

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

UserStatus

Defined in nexla_sdk/models/enums.py:70

User account status.

Members:

• ACTIVE = ACTIVE
• DEACTIVATED = DEACTIVATED
• SOURCE_COUNT_CAPPED = SOURCE_COUNT_CAPPED
• SOURCE_DATA_CAPPED = SOURCE_DATA_CAPPED
• TRIAL_EXPIRED = TRIAL_EXPIRED

UserTier

Defined in nexla_sdk/models/enums.py:62

User account tiers.

Members:

• FREE = FREE
• TRIAL = TRIAL
• PAID = PAID
• FREE_FOREVER = FREE_FOREVER

UserUpdate

Defined in nexla_sdk/models/users/requests.py:19

Request model for updating a user.

Fields:

• name: Optional
• email: Optional
• status: Optional
• user_tier_id: Optional
• user_tier: Optional
• password: Optional
• password_confirmation: Optional
• password_current: Optional
• tos_signed_at: Optional
• admin: Union

Methods:

• to_dict(self, exclude_none: bool = True) -> Dict[str, Any]
  • Source: nexla_sdk/models/base.py:40
  • Convert model to dictionary.
• to_json(self, exclude_none: bool = True, indent: int = 2) -> str
  • Source: nexla_sdk/models/base.py:52
  • Convert model to JSON string.

VerifiedStatus

Defined in nexla_sdk/models/credentials/enums.py:60

Credential verification status.

Members:

• VERIFIED = VERIFIED
• UNVERIFIED = UNVERIFIED
• FAILED = FAILED