Merge pull request #51 from airbytehq/speakeasy-sdk-regen-1699229642

chore: 🐝 Update SDK - Generate

Author: terencecho

.gitattributes

@@ -13,25 +13,28 @@ Developers will need to create an API Key within your [Developer Portal](https:/
 
 The Developer Portal UI can also be used to help build your integration by showing information about network requests in the Requests tab. API usage information is also available to you in the Usage tab.
 
-<!-- Start SDK Installation -->
+<!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
 ```bash
 pip install airbyte-api
 ```
-<!-- End SDK Installation -->
+<!-- End SDK Installation [installation] -->
 
+<!-- Start SDK Example Usage [usage] -->
 ## SDK Example Usage
-<!-- Start SDK Example Usage -->
+
+### Example
+
 ```python
 import airbyte
 from airbyte.models import shared
 
 s = airbyte.Airbyte(
     security=shared.Security(
         basic_auth=shared.SchemeBasicAuth(
-            password="",
-            username="",
+            password="<YOUR_PASSWORD_HERE>",
+            username="<YOUR_USERNAME_HERE>",
         ),
     ),
 )
@@ -41,23 +44,23 @@ req = shared.ConnectionCreateRequest(
         streams=[
             shared.StreamConfiguration(
                 cursor_field=[
-                    'violet',
+                    'string',
                 ],
-                name='Account',
+                name='string',
                 primary_key=[
                     [
-                        'BMW',
+                        'string',
                     ],
                 ],
             ),
         ],
     ),
-    destination_id='e362083e-afc8-4559-94e0-a570f6dd427d',
+    destination_id='c669dd1e-3620-483e-afc8-55914e0a570f',
     namespace_format='${SOURCE_NAMESPACE}',
     schedule=shared.ConnectionSchedule(
-        schedule_type=shared.ScheduleTypeEnum.CRON,
+        schedule_type=shared.ScheduleTypeEnum.MANUAL,
     ),
-    source_id='3a555847-8358-4423-a5b6-c7b3fd2fd307',
+    source_id='dd427d83-a555-4847-8358-42325b6c7b3f',
 )
 
 res = s.connections.create_connection(req)
@@ -66,12 +69,11 @@ if res.connection_response is not None:
     # handle response
     pass
 ```
-<!-- End SDK Example Usage -->
+<!-- End SDK Example Usage [usage] -->
 
-<!-- Start SDK Available Operations -->
+<!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
-
 ### [connections](docs/sdks/connections/README.md)
 
 * [create_connection](docs/sdks/connections/README.md#create_connection) - Create a connection
@@ -118,25 +120,262 @@ 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
-<!-- End SDK Available Operations -->
+<!-- End Available Resources and Operations [operations] -->
+
+
+
+
+
+
+
+<!-- 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.
+
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 4x-5xx          | */*             |
+
+### Example
+
+```python
+import airbyte
+from airbyte.models import shared
+
+s = airbyte.Airbyte(
+    security=shared.Security(
+        basic_auth=shared.SchemeBasicAuth(
+            password="<YOUR_PASSWORD_HERE>",
+            username="<YOUR_USERNAME_HERE>",
+        ),
+    ),
+)
+
+req = shared.ConnectionCreateRequest(
+    configurations=shared.StreamConfigurations(
+        streams=[
+            shared.StreamConfiguration(
+                cursor_field=[
+                    'string',
+                ],
+                name='string',
+                primary_key=[
+                    [
+                        'string',
+                    ],
+                ],
+            ),
+        ],
+    ),
+    destination_id='c669dd1e-3620-483e-afc8-55914e0a570f',
+    namespace_format='${SOURCE_NAMESPACE}',
+    schedule=shared.ConnectionSchedule(
+        schedule_type=shared.ScheduleTypeEnum.MANUAL,
+    ),
+    source_id='dd427d83-a555-4847-8358-42325b6c7b3f',
+)
+
+res = None
+try:
+    res = s.connections.create_connection(req)
+except errors.SDKError as e:
+    print(e)  # handle exception
+    raise(e)
+
+if res.connection_response is not None:
+    # handle response
+    pass
+```
+<!-- End Error Handling [errors] -->
+
+
+
+<!-- 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
+from airbyte.models import shared
+
+s = airbyte.Airbyte(
+    server_idx=0,
+    security=shared.Security(
+        basic_auth=shared.SchemeBasicAuth(
+            password="<YOUR_PASSWORD_HERE>",
+            username="<YOUR_USERNAME_HERE>",
+        ),
+    ),
+)
+
+req = shared.ConnectionCreateRequest(
+    configurations=shared.StreamConfigurations(
+        streams=[
+            shared.StreamConfiguration(
+                cursor_field=[
+                    'string',
+                ],
+                name='string',
+                primary_key=[
+                    [
+                        'string',
+                    ],
+                ],
+            ),
+        ],
+    ),
+    destination_id='c669dd1e-3620-483e-afc8-55914e0a570f',
+    namespace_format='${SOURCE_NAMESPACE}',
+    schedule=shared.ConnectionSchedule(
+        schedule_type=shared.ScheduleTypeEnum.MANUAL,
+    ),
+    source_id='dd427d83-a555-4847-8358-42325b6c7b3f',
+)
+
+res = s.connections.create_connection(req)
+
+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:
+```python
+import airbyte
+from airbyte.models import shared
+
+s = airbyte.Airbyte(
+    server_url="https://api.airbyte.com/v1",
+    security=shared.Security(
+        basic_auth=shared.SchemeBasicAuth(
+            password="<YOUR_PASSWORD_HERE>",
+            username="<YOUR_USERNAME_HERE>",
+        ),
+    ),
+)
+
+req = shared.ConnectionCreateRequest(
+    configurations=shared.StreamConfigurations(
+        streams=[
+            shared.StreamConfiguration(
+                cursor_field=[
+                    'string',
+                ],
+                name='string',
+                primary_key=[
+                    [
+                        'string',
+                    ],
+                ],
+            ),
+        ],
+    ),
+    destination_id='c669dd1e-3620-483e-afc8-55914e0a570f',
+    namespace_format='${SOURCE_NAMESPACE}',
+    schedule=shared.ConnectionSchedule(
+        schedule_type=shared.ScheduleTypeEnum.MANUAL,
+    ),
+    source_id='dd427d83-a555-4847-8358-42325b6c7b3f',
+)
+
+res = s.connections.create_connection(req)
+
+if res.connection_response is not None:
+    # handle response
+    pass
+```
+<!-- End Server Selection [server] -->
 
 
 
-<!-- Start Dev Containers -->
+<!-- Start Custom HTTP Client [http-client] -->
+## Custom HTTP Client
 
-<!-- End Dev Containers -->
+The Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.
+
+For example, you could specify a header for every request that this sdk makes as follows:
+```python
+import airbyte
+import requests
+
+http_client = requests.Session()
+http_client.headers.update({'x-custom-header': 'someValue'})
+s = airbyte.Airbyte(client: http_client)
+```
+<!-- End Custom HTTP Client [http-client] -->
 
 
 
-<!-- Start Pagination -->
-# Pagination
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security schemes globally:
+
+| Name          | Type          | Scheme        |
+| ------------- | ------------- | ------------- |
+| `basic_auth`  | http          | HTTP Basic    |
+| `bearer_auth` | http          | HTTP Bearer   |
+
+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
+import airbyte
+from airbyte.models import shared
 
-Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
-returned response object will have a `Next` method that can be called to pull down the next group of results. If the
-return value of `Next` is `None`, then there are no more pages to be fetched.
+s = airbyte.Airbyte(
+    security=shared.Security(
+        basic_auth=shared.SchemeBasicAuth(
+            password="<YOUR_PASSWORD_HERE>",
+            username="<YOUR_USERNAME_HERE>",
+        ),
+    ),
+)
 
-Here's an example of one such pagination call:
-<!-- End Pagination -->
+req = shared.ConnectionCreateRequest(
+    configurations=shared.StreamConfigurations(
+        streams=[
+            shared.StreamConfiguration(
+                cursor_field=[
+                    'string',
+                ],
+                name='string',
+                primary_key=[
+                    [
+                        'string',
+                    ],
+                ],
+            ),
+        ],
+    ),
+    destination_id='c669dd1e-3620-483e-afc8-55914e0a570f',
+    namespace_format='${SOURCE_NAMESPACE}',
+    schedule=shared.ConnectionSchedule(
+        schedule_type=shared.ScheduleTypeEnum.MANUAL,
+    ),
+    source_id='dd427d83-a555-4847-8358-42325b6c7b3f',
+)
+
+res = s.connections.create_connection(req)
+
+if res.connection_response is not None:
+    # handle response
+    pass
+```
+<!-- End Authentication [security] -->
 
 <!-- Placeholder for Future Speakeasy SDK Sections -->