diff --git a/docs/models/connectioncreaterequest.md b/docs/models/connectioncreaterequest.md index e6f5b0a6..0311f00d 100644 --- a/docs/models/connectioncreaterequest.md +++ b/docs/models/connectioncreaterequest.md @@ -3,17 +3,18 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configurations` | [Optional[models.StreamConfigurations]](../models/streamconfigurations.md) | :heavy_minus_sign: | A list of configured stream options for a connection. | | -| ~~`data_residency`~~ | *Optional[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: We no longer support modifying dataResidency on Community and Enterprise connections. All connections will use the dataResidency of their associated workspace.. | | -| `destination_id` | *str* | :heavy_check_mark: | N/A | | -| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name of the connection | | -| `namespace_definition` | [Optional[models.NamespaceDefinitionEnum]](../models/namespacedefinitionenum.md) | :heavy_minus_sign: | Define the location where the data will be stored in the destination | | -| `namespace_format` | *Optional[str]* | :heavy_minus_sign: | Used when namespaceDefinition is 'custom_format'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. | ${SOURCE_NAMESPACE} | -| `non_breaking_schema_updates_behavior` | [Optional[models.NonBreakingSchemaUpdatesBehaviorEnum]](../models/nonbreakingschemaupdatesbehaviorenum.md) | :heavy_minus_sign: | Set how Airbyte handles syncs when it detects a non-breaking schema change in the source | | -| `prefix` | *Optional[str]* | :heavy_minus_sign: | Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte_” causes “projects” => “airbyte_projects”). | | -| `schedule` | [Optional[models.AirbyteAPIConnectionSchedule]](../models/airbyteapiconnectionschedule.md) | :heavy_minus_sign: | schedule for when the the connection should run, per the schedule type | | -| `source_id` | *str* | :heavy_check_mark: | N/A | | -| `status` | [Optional[models.ConnectionStatusEnum]](../models/connectionstatusenum.md) | :heavy_minus_sign: | N/A | | -| `tags` | List[[models.Tag](../models/tag.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `configurations` | [Optional[models.StreamConfigurations]](../models/streamconfigurations.md) | :heavy_minus_sign: | A list of configured stream options for a connection. | | +| ~~`data_residency`~~ | *Optional[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: We no longer support modifying dataResidency on Community and Enterprise connections. All connections will use the dataResidency of their associated workspace.. | | +| `destination_id` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name of the connection | | +| `namespace_definition` | [Optional[models.NamespaceDefinitionEnum]](../models/namespacedefinitionenum.md) | :heavy_minus_sign: | Define the location where the data will be stored in the destination | | +| `namespace_format` | *Optional[str]* | :heavy_minus_sign: | Used when namespaceDefinition is 'custom_format'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. | ${SOURCE_NAMESPACE} | +| `non_breaking_schema_updates_behavior` | [Optional[models.NonBreakingSchemaUpdatesBehaviorEnum]](../models/nonbreakingschemaupdatesbehaviorenum.md) | :heavy_minus_sign: | Set how Airbyte handles syncs when it detects a non-breaking schema change in the source | | +| `notify_schema_changes` | *Optional[bool]* | :heavy_minus_sign: | Turns schema change notifications on or off for this connection. The workspace's notification settings decide where they are sent. Breaking changes use `connectionUpdateActionRequired`. Other schema changes use `connectionUpdate`. If omitted, it is true when the workspace's `connectionUpdate` settings have email or webhook enabled. Otherwise it is false. | | +| `prefix` | *Optional[str]* | :heavy_minus_sign: | Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte_” causes “projects” => “airbyte_projects”). | | +| `schedule` | [Optional[models.AirbyteAPIConnectionSchedule]](../models/airbyteapiconnectionschedule.md) | :heavy_minus_sign: | schedule for when the the connection should run, per the schedule type | | +| `source_id` | *str* | :heavy_check_mark: | N/A | | +| `status` | [Optional[models.ConnectionStatusEnum]](../models/connectionstatusenum.md) | :heavy_minus_sign: | N/A | | +| `tags` | List[[models.Tag](../models/tag.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/connectionpatchrequest.md b/docs/models/connectionpatchrequest.md index 141d0f90..79105136 100644 --- a/docs/models/connectionpatchrequest.md +++ b/docs/models/connectionpatchrequest.md @@ -3,15 +3,16 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configurations` | [Optional[models.StreamConfigurations]](../models/streamconfigurations.md) | :heavy_minus_sign: | A list of configured stream options for a connection. | | -| ~~`data_residency`~~ | *Optional[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: We no longer support modifying dataResidency on Community and Enterprise connections. All connections will use the dataResidency of their associated workspace.. | | -| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name of the connection | | -| `namespace_definition` | [Optional[models.NamespaceDefinitionEnumNoDefault]](../models/namespacedefinitionenumnodefault.md) | :heavy_minus_sign: | Define the location where the data will be stored in the destination | | -| `namespace_format` | *Optional[str]* | :heavy_minus_sign: | Used when namespaceDefinition is 'custom_format'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. | ${SOURCE_NAMESPACE} | -| `non_breaking_schema_updates_behavior` | [Optional[models.NonBreakingSchemaUpdatesBehaviorEnumNoDefault]](../models/nonbreakingschemaupdatesbehaviorenumnodefault.md) | :heavy_minus_sign: | Set how Airbyte handles syncs when it detects a non-breaking schema change in the source | | -| `prefix` | *Optional[str]* | :heavy_minus_sign: | Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte_” causes “projects” => “airbyte_projects”). | | -| `schedule` | [Optional[models.AirbyteAPIConnectionSchedule]](../models/airbyteapiconnectionschedule.md) | :heavy_minus_sign: | schedule for when the the connection should run, per the schedule type | | -| `status` | [Optional[models.ConnectionStatusEnum]](../models/connectionstatusenum.md) | :heavy_minus_sign: | N/A | | -| `tags` | List[[models.Tag](../models/tag.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `configurations` | [Optional[models.StreamConfigurations]](../models/streamconfigurations.md) | :heavy_minus_sign: | A list of configured stream options for a connection. | | +| ~~`data_residency`~~ | *Optional[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: We no longer support modifying dataResidency on Community and Enterprise connections. All connections will use the dataResidency of their associated workspace.. | | +| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name of the connection | | +| `namespace_definition` | [Optional[models.NamespaceDefinitionEnumNoDefault]](../models/namespacedefinitionenumnodefault.md) | :heavy_minus_sign: | Define the location where the data will be stored in the destination | | +| `namespace_format` | *Optional[str]* | :heavy_minus_sign: | Used when namespaceDefinition is 'custom_format'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. | ${SOURCE_NAMESPACE} | +| `non_breaking_schema_updates_behavior` | [Optional[models.NonBreakingSchemaUpdatesBehaviorEnumNoDefault]](../models/nonbreakingschemaupdatesbehaviorenumnodefault.md) | :heavy_minus_sign: | Set how Airbyte handles syncs when it detects a non-breaking schema change in the source | | +| `notify_schema_changes` | *Optional[bool]* | :heavy_minus_sign: | Turns schema change notifications on or off for this connection. The workspace's notification settings decide where they are sent. Breaking changes use `connectionUpdateActionRequired`. Other schema changes use `connectionUpdate`. | | +| `prefix` | *Optional[str]* | :heavy_minus_sign: | Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte_” causes “projects” => “airbyte_projects”). | | +| `schedule` | [Optional[models.AirbyteAPIConnectionSchedule]](../models/airbyteapiconnectionschedule.md) | :heavy_minus_sign: | schedule for when the the connection should run, per the schedule type | | +| `status` | [Optional[models.ConnectionStatusEnum]](../models/connectionstatusenum.md) | :heavy_minus_sign: | N/A | | +| `tags` | List[[models.Tag](../models/tag.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/connectionresponse.md b/docs/models/connectionresponse.md index 3772ec88..c08aa415 100644 --- a/docs/models/connectionresponse.md +++ b/docs/models/connectionresponse.md @@ -5,20 +5,21 @@ Provides details of a single connection. ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `configurations` | [models.StreamConfigurations](../models/streamconfigurations.md) | :heavy_check_mark: | A list of configured stream options for a connection. | -| `connection_id` | *str* | :heavy_check_mark: | N/A | -| `created_at` | *int* | :heavy_check_mark: | N/A | -| `destination_id` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `namespace_definition` | [Optional[models.NamespaceDefinitionEnum]](../models/namespacedefinitionenum.md) | :heavy_minus_sign: | Define the location where the data will be stored in the destination | -| `namespace_format` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `non_breaking_schema_updates_behavior` | [Optional[models.NonBreakingSchemaUpdatesBehaviorEnum]](../models/nonbreakingschemaupdatesbehaviorenum.md) | :heavy_minus_sign: | Set how Airbyte handles syncs when it detects a non-breaking schema change in the source | -| `prefix` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `schedule` | [models.ConnectionScheduleResponse](../models/connectionscheduleresponse.md) | :heavy_check_mark: | schedule for when the the connection should run, per the schedule type | -| `source_id` | *str* | :heavy_check_mark: | N/A | -| `status` | [models.ConnectionStatusEnum](../models/connectionstatusenum.md) | :heavy_check_mark: | N/A | -| `status_reason` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `tags` | List[[models.Tag](../models/tag.md)] | :heavy_check_mark: | N/A | -| `workspace_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `configurations` | [models.StreamConfigurations](../models/streamconfigurations.md) | :heavy_check_mark: | A list of configured stream options for a connection. | +| `connection_id` | *str* | :heavy_check_mark: | N/A | +| `created_at` | *int* | :heavy_check_mark: | N/A | +| `destination_id` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `namespace_definition` | [Optional[models.NamespaceDefinitionEnum]](../models/namespacedefinitionenum.md) | :heavy_minus_sign: | Define the location where the data will be stored in the destination | +| `namespace_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `non_breaking_schema_updates_behavior` | [Optional[models.NonBreakingSchemaUpdatesBehaviorEnum]](../models/nonbreakingschemaupdatesbehaviorenum.md) | :heavy_minus_sign: | Set how Airbyte handles syncs when it detects a non-breaking schema change in the source | +| `notify_schema_changes` | *Optional[bool]* | :heavy_minus_sign: | Turns schema change notifications on or off for this connection. The workspace's notification settings decide where they are sent. Breaking changes use `connectionUpdateActionRequired`. Other schema changes use `connectionUpdate`. | +| `prefix` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `schedule` | [models.ConnectionScheduleResponse](../models/connectionscheduleresponse.md) | :heavy_check_mark: | schedule for when the the connection should run, per the schedule type | +| `source_id` | *str* | :heavy_check_mark: | N/A | +| `status` | [models.ConnectionStatusEnum](../models/connectionstatusenum.md) | :heavy_check_mark: | N/A | +| `status_reason` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `tags` | List[[models.Tag](../models/tag.md)] | :heavy_check_mark: | N/A | +| `workspace_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/src/airbyte_api/models/connectioncreaterequest.py b/src/airbyte_api/models/connectioncreaterequest.py index 9fcfb404..ed6a5bda 100644 --- a/src/airbyte_api/models/connectioncreaterequest.py +++ b/src/airbyte_api/models/connectioncreaterequest.py @@ -33,6 +33,8 @@ class ConnectionCreateRequestTypedDict(TypedDict): NonBreakingSchemaUpdatesBehaviorEnum ] r"""Set how Airbyte handles syncs when it detects a non-breaking schema change in the source""" + notify_schema_changes: NotRequired[bool] + r"""Turns schema change notifications on or off for this connection. The workspace's notification settings decide where they are sent. Breaking changes use `connectionUpdateActionRequired`. Other schema changes use `connectionUpdate`. If omitted, it is true when the workspace's `connectionUpdate` settings have email or webhook enabled. Otherwise it is false.""" prefix: NotRequired[str] r"""Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte_” causes “projects” => “airbyte_projects”).""" schedule: NotRequired[AirbyteAPIConnectionScheduleTypedDict] @@ -76,6 +78,11 @@ class ConnectionCreateRequest(BaseModel): ] = NonBreakingSchemaUpdatesBehaviorEnum.IGNORE r"""Set how Airbyte handles syncs when it detects a non-breaking schema change in the source""" + notify_schema_changes: Annotated[ + Optional[bool], pydantic.Field(alias="notifySchemaChanges") + ] = None + r"""Turns schema change notifications on or off for this connection. The workspace's notification settings decide where they are sent. Breaking changes use `connectionUpdateActionRequired`. Other schema changes use `connectionUpdate`. If omitted, it is true when the workspace's `connectionUpdate` settings have email or webhook enabled. Otherwise it is false.""" + prefix: Optional[str] = "" r"""Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte_” causes “projects” => “airbyte_projects”).""" @@ -96,6 +103,7 @@ def serialize_model(self, handler): "namespaceDefinition", "namespaceFormat", "nonBreakingSchemaUpdatesBehavior", + "notifySchemaChanges", "prefix", "schedule", "status", diff --git a/src/airbyte_api/models/connectionpatchrequest.py b/src/airbyte_api/models/connectionpatchrequest.py index fec5624d..a5d822ea 100644 --- a/src/airbyte_api/models/connectionpatchrequest.py +++ b/src/airbyte_api/models/connectionpatchrequest.py @@ -33,6 +33,8 @@ class ConnectionPatchRequestTypedDict(TypedDict): NonBreakingSchemaUpdatesBehaviorEnumNoDefault ] r"""Set how Airbyte handles syncs when it detects a non-breaking schema change in the source""" + notify_schema_changes: NotRequired[bool] + r"""Turns schema change notifications on or off for this connection. The workspace's notification settings decide where they are sent. Breaking changes use `connectionUpdateActionRequired`. Other schema changes use `connectionUpdate`.""" prefix: NotRequired[str] r"""Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte_” causes “projects” => “airbyte_projects”).""" schedule: NotRequired[AirbyteAPIConnectionScheduleTypedDict] @@ -73,6 +75,11 @@ class ConnectionPatchRequest(BaseModel): ] = None r"""Set how Airbyte handles syncs when it detects a non-breaking schema change in the source""" + notify_schema_changes: Annotated[ + Optional[bool], pydantic.Field(alias="notifySchemaChanges") + ] = None + r"""Turns schema change notifications on or off for this connection. The workspace's notification settings decide where they are sent. Breaking changes use `connectionUpdateActionRequired`. Other schema changes use `connectionUpdate`.""" + prefix: Optional[str] = None r"""Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte_” causes “projects” => “airbyte_projects”).""" @@ -93,6 +100,7 @@ def serialize_model(self, handler): "namespaceDefinition", "namespaceFormat", "nonBreakingSchemaUpdatesBehavior", + "notifySchemaChanges", "prefix", "schedule", "status", diff --git a/src/airbyte_api/models/connectionresponse.py b/src/airbyte_api/models/connectionresponse.py index 49deb3ba..0171ba84 100644 --- a/src/airbyte_api/models/connectionresponse.py +++ b/src/airbyte_api/models/connectionresponse.py @@ -39,6 +39,8 @@ class ConnectionResponseTypedDict(TypedDict): NonBreakingSchemaUpdatesBehaviorEnum ] r"""Set how Airbyte handles syncs when it detects a non-breaking schema change in the source""" + notify_schema_changes: NotRequired[bool] + r"""Turns schema change notifications on or off for this connection. The workspace's notification settings decide where they are sent. Breaking changes use `connectionUpdateActionRequired`. Other schema changes use `connectionUpdate`.""" prefix: NotRequired[str] status_reason: NotRequired[str] @@ -83,6 +85,11 @@ class ConnectionResponse(BaseModel): ] = NonBreakingSchemaUpdatesBehaviorEnum.IGNORE r"""Set how Airbyte handles syncs when it detects a non-breaking schema change in the source""" + notify_schema_changes: Annotated[ + Optional[bool], pydantic.Field(alias="notifySchemaChanges") + ] = None + r"""Turns schema change notifications on or off for this connection. The workspace's notification settings decide where they are sent. Breaking changes use `connectionUpdateActionRequired`. Other schema changes use `connectionUpdate`.""" + prefix: Optional[str] = None status_reason: Annotated[Optional[str], pydantic.Field(alias="statusReason")] = None @@ -94,6 +101,7 @@ def serialize_model(self, handler): "namespaceDefinition", "namespaceFormat", "nonBreakingSchemaUpdatesBehavior", + "notifySchemaChanges", "prefix", "statusReason", ]