airbyte-api 0.52.0__tar.gz → 0.52.2__tar.gz

{airbyte-api-0.52.0/src/airbyte_api.egg-info → airbyte-api-0.52.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: airbyte-api
-Version: 0.52.0
+Version: 0.52.2
 Summary: Python Client SDK for Airbyte API
 Home-page: https://github.com/airbytehq/airbyte-api-python-sdk.git
 Author: Airbyte
@@ -23,19 +23,21 @@ Description: <div align="center">
         <!-- Start Summary [summary] -->
         ## Summary
         
-        airbyte-api: Programatically control Airbyte Cloud, OSS & Enterprise.
+        airbyte-api: Programmatically control Airbyte Cloud, OSS & Enterprise.
         <!-- End Summary [summary] -->
         
         <!-- Start Table of Contents [toc] -->
         ## Table of Contents
+        <!-- $toc-max-depth=2 -->
+          * [Authentication](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#authentication)
+          * [SDK Installation](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#sdk-installation)
+          * [SDK Example Usage](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#sdk-example-usage)
+          * [Available Resources and Operations](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#available-resources-and-operations)
+          * [Error Handling](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#error-handling)
+          * [Server Selection](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#server-selection)
+          * [Custom HTTP Client](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#custom-http-client)
+          * [Authentication](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#authentication-1)
         
-        * [SDK Installation](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#sdk-installation)
-        * [SDK Example Usage](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#sdk-example-usage)
-        * [Available Resources and Operations](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#available-resources-and-operations)
-        * [Error Handling](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#error-handling)
-        * [Server Selection](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#server-selection)
-        * [Custom HTTP Client](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#custom-http-client)
-        * [Authentication](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#authentication)
         <!-- End Table of Contents [toc] -->
         
         <!-- Start SDK Installation [installation] -->
@@ -60,8 +62,8 @@ Description: <div align="center">
         s = airbyte_api.AirbyteAPI(
             security=models.Security(
                 basic_auth=models.SchemeBasicAuth(
-                    password="",
-                    username="",
+                    password='',
+                    username='',
                 ),
             ),
         )
@@ -84,6 +86,10 @@ Description: <div align="center">
         <!-- Start Available Resources and Operations [operations] -->
         ## Available Resources and Operations
         
+        <details open>
+        <summary>Available methods</summary>
+        
+        
         ### [connections](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/connections/README.md)
         
         * [create_connection](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/connections/README.md#create_connection) - Create a connection
@@ -150,6 +156,8 @@ Description: <div align="center">
         * [get_workspace](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/workspaces/README.md#get_workspace) - Get Workspace details
         * [list_workspaces](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/workspaces/README.md#list_workspaces) - List workspaces
         * [update_workspace](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/workspaces/README.md#update_workspace) - Update a workspace
+        
+        </details>
         <!-- End Available Resources and Operations [operations] -->
         
         
@@ -161,11 +169,22 @@ Description: <div align="center">
         <!-- Start Error Handling [errors] -->
         ## Error Handling
         
-        Handling errors in this SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
+        Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
+        
+        By default, an API error will raise a errors.SDKError exception, which has the following properties:
+        
+        | Property        | Type             | Description           |
+        |-----------------|------------------|-----------------------|
+        | `.status_code`  | *int*            | The HTTP status code  |
+        | `.message`      | *str*            | The error message     |
+        | `.raw_response` | *httpx.Response* | The raw HTTP response |
+        | `.body`         | *str*            | The response content  |
         
-        | Error Object    | Status Code     | Content Type    |
-        | --------------- | --------------- | --------------- |
-        | errors.SDKError | 4xx-5xx         | */*             |
+        When custom error responses are specified for an operation, the SDK may also raise their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create_connection` method may raise the following exceptions:
+        
+        | Error Type      | Status Code | Content Type |
+        | --------------- | ----------- | ------------ |
+        | errors.SDKError | 4XX, 5XX    | \*/\*        |
         
         ### Example
         
@@ -176,8 +195,8 @@ Description: <div align="center">
         s = airbyte_api.AirbyteAPI(
             security=models.Security(
                 basic_auth=models.SchemeBasicAuth(
-                    password="",
-                    username="",
+                    password='',
+                    username='',
                 ),
             ),
         )
@@ -207,45 +226,6 @@ Description: <div align="center">
         <!-- Start Server Selection [server] -->
         ## Server Selection
         
-        ### Select Server by Index
-        
-        You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
-        
-        | # | Server | Variables |
-        | - | ------ | --------- |
-        | 0 | `https://api.airbyte.com/v1` | None |
-        
-        #### Example
-        
-        ```python
-        import airbyte_api
-        from airbyte_api import models
-        
-        s = airbyte_api.AirbyteAPI(
-            server_idx=0,
-            security=models.Security(
-                basic_auth=models.SchemeBasicAuth(
-                    password="",
-                    username="",
-                ),
-            ),
-        )
-        
-        
-        res = s.connections.create_connection(request=models.ConnectionCreateRequest(
-            destination_id='e478de0d-a3a0-475c-b019-25f7dd29e281',
-            source_id='95e66a59-8045-4307-9678-63bc3c9b8c93',
-            name='Postgres-to-Bigquery',
-            namespace_format='${SOURCE_NAMESPACE}',
-        ))
-        
-        if res.connection_response is not None:
-            # handle response
-            pass
-        
-        ```
-        
-        
         ### Override Server URL Per-Client
         
         The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
@@ -254,11 +234,11 @@ Description: <div align="center">
         from airbyte_api import models
         
         s = airbyte_api.AirbyteAPI(
-            server_url="https://api.airbyte.com/v1",
+            server_url='https://api.airbyte.com/v1',
             security=models.Security(
                 basic_auth=models.SchemeBasicAuth(
-                    password="",
-                    username="",
+                    password='',
+                    username='',
                 ),
             ),
         )
@@ -305,11 +285,11 @@ Description: <div align="center">
         
         This SDK supports the following security schemes globally:
         
-        | Name                 | Type                 | Scheme               |
-        | -------------------- | -------------------- | -------------------- |
-        | `basic_auth`         | http                 | HTTP Basic           |
-        | `bearer_auth`        | http                 | HTTP Bearer          |
-        | `client_credentials` | oauth2               | OAuth2 token         |
+        | Name                 | Type   | Scheme       |
+        | -------------------- | ------ | ------------ |
+        | `basic_auth`         | http   | HTTP Basic   |
+        | `bearer_auth`        | http   | HTTP Bearer  |
+        | `client_credentials` | oauth2 | OAuth2 token |
         
         You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
         ```python
@@ -319,8 +299,8 @@ Description: <div align="center">
         s = airbyte_api.AirbyteAPI(
             security=models.Security(
                 basic_auth=models.SchemeBasicAuth(
-                    password="",
-                    username="",
+                    password='',
+                    username='',
                 ),
             ),
         )

{airbyte-api-0.52.0 → airbyte-api-0.52.2}/README.md

@@ -16,19 +16,21 @@ The Developer Portal UI can also be used to help build your integration by showi
 <!-- Start Summary [summary] -->
 ## Summary
 
-airbyte-api: Programatically control Airbyte Cloud, OSS & Enterprise.
+airbyte-api: Programmatically control Airbyte Cloud, OSS & Enterprise.
 <!-- End Summary [summary] -->
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
+<!-- $toc-max-depth=2 -->
+  * [Authentication](#authentication)
+  * [SDK Installation](#sdk-installation)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Authentication](#authentication-1)
 
-* [SDK Installation](#sdk-installation)
-* [SDK Example Usage](#sdk-example-usage)
-* [Available Resources and Operations](#available-resources-and-operations)
-* [Error Handling](#error-handling)
-* [Server Selection](#server-selection)
-* [Custom HTTP Client](#custom-http-client)
-* [Authentication](#authentication)
 <!-- End Table of Contents [toc] -->
 
 <!-- Start SDK Installation [installation] -->
@@ -53,8 +55,8 @@ from airbyte_api import models
 s = airbyte_api.AirbyteAPI(
     security=models.Security(
         basic_auth=models.SchemeBasicAuth(
-            password="",
-            username="",
+            password='',
+            username='',
         ),
     ),
 )
@@ -77,6 +79,10 @@ if res.connection_response is not None:
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
+<details open>
+<summary>Available methods</summary>
+
+
 ### [connections](docs/sdks/connections/README.md)
 
 * [create_connection](docs/sdks/connections/README.md#create_connection) - Create a connection
@@ -143,6 +149,8 @@ if res.connection_response is not None:
 * [get_workspace](docs/sdks/workspaces/README.md#get_workspace) - Get Workspace details
 * [list_workspaces](docs/sdks/workspaces/README.md#list_workspaces) - List workspaces
 * [update_workspace](docs/sdks/workspaces/README.md#update_workspace) - Update a workspace
+
+</details>
 <!-- End Available Resources and Operations [operations] -->
 
 
@@ -154,11 +162,22 @@ if res.connection_response is not None:
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Handling errors in this SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
+Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
+
+By default, an API error will raise a errors.SDKError exception, which has the following properties:
+
+| Property        | Type             | Description           |
+|-----------------|------------------|-----------------------|
+| `.status_code`  | *int*            | The HTTP status code  |
+| `.message`      | *str*            | The error message     |
+| `.raw_response` | *httpx.Response* | The raw HTTP response |
+| `.body`         | *str*            | The response content  |
 
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+When custom error responses are specified for an operation, the SDK may also raise their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create_connection` method may raise the following exceptions:
+
+| Error Type      | Status Code | Content Type |
+| --------------- | ----------- | ------------ |
+| errors.SDKError | 4XX, 5XX    | \*/\*        |
 
 ### Example
 
@@ -169,8 +188,8 @@ from airbyte_api import errors, models
 s = airbyte_api.AirbyteAPI(
     security=models.Security(
         basic_auth=models.SchemeBasicAuth(
-            password="",
-            username="",
+            password='',
+            username='',
         ),
     ),
 )
@@ -200,45 +219,6 @@ if res.connection_response is not None:
 <!-- Start Server Selection [server] -->
 ## Server Selection
 
-### Select Server by Index
-
-You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
-
-| # | Server | Variables |
-| - | ------ | --------- |
-| 0 | `https://api.airbyte.com/v1` | None |
-
-#### Example
-
-```python
-import airbyte_api
-from airbyte_api import models
-
-s = airbyte_api.AirbyteAPI(
-    server_idx=0,
-    security=models.Security(
-        basic_auth=models.SchemeBasicAuth(
-            password="",
-            username="",
-        ),
-    ),
-)
-
-
-res = s.connections.create_connection(request=models.ConnectionCreateRequest(
-    destination_id='e478de0d-a3a0-475c-b019-25f7dd29e281',
-    source_id='95e66a59-8045-4307-9678-63bc3c9b8c93',
-    name='Postgres-to-Bigquery',
-    namespace_format='${SOURCE_NAMESPACE}',
-))
-
-if res.connection_response is not None:
-    # handle response
-    pass
-
-```
-
-
 ### Override Server URL Per-Client
 
 The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
@@ -247,11 +227,11 @@ import airbyte_api
 from airbyte_api import models
 
 s = airbyte_api.AirbyteAPI(
-    server_url="https://api.airbyte.com/v1",
+    server_url='https://api.airbyte.com/v1',
     security=models.Security(
         basic_auth=models.SchemeBasicAuth(
-            password="",
-            username="",
+            password='',
+            username='',
         ),
     ),
 )
@@ -298,11 +278,11 @@ s = airbyte_api.AirbyteAPI(client=http_client)
 
 This SDK supports the following security schemes globally:
 
-| Name                 | Type                 | Scheme               |
-| -------------------- | -------------------- | -------------------- |
-| `basic_auth`         | http                 | HTTP Basic           |
-| `bearer_auth`        | http                 | HTTP Bearer          |
-| `client_credentials` | oauth2               | OAuth2 token         |
+| Name                 | Type   | Scheme       |
+| -------------------- | ------ | ------------ |
+| `basic_auth`         | http   | HTTP Basic   |
+| `bearer_auth`        | http   | HTTP Bearer  |
+| `client_credentials` | oauth2 | OAuth2 token |
 
 You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
 ```python
@@ -312,8 +292,8 @@ from airbyte_api import models
 s = airbyte_api.AirbyteAPI(
     security=models.Security(
         basic_auth=models.SchemeBasicAuth(
-            password="",
-            username="",
+            password='',
+            username='',
         ),
     ),
 )

{airbyte-api-0.52.0 → airbyte-api-0.52.2}/setup.py

@@ -19,7 +19,7 @@ except FileNotFoundError:
 
 setuptools.setup(
     name='airbyte-api',
-    version='0.52.0',
+    version='0.52.2',
     author='Airbyte',
     description='Python Client SDK for Airbyte API',
     url='https://github.com/airbytehq/airbyte-api-python-sdk.git',