Skip to content

Commit 5baaf9a

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 1.0.0, Speakeasy CLI 1.114.1
1 parent bbe9e56 commit 5baaf9a

File tree

2,380 files changed

+14294
-14218
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,380 files changed

+14294
-14218
lines changed

‎README.md‎

Lines changed: 69 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -72,15 +72,15 @@ if res.connection_response is not None:
7272
## Available Resources and Operations
7373

7474

75-
### [connections](docs/sdks/connections/README.md)
75+
### [.connections](docs/sdks/connections/README.md)
7676

7777
* [create_connection](docs/sdks/connections/README.md#create_connection) - Create a connection
7878
* [delete_connection](docs/sdks/connections/README.md#delete_connection) - Delete a Connection
7979
* [get_connection](docs/sdks/connections/README.md#get_connection) - Get Connection details
8080
* [list_connections](docs/sdks/connections/README.md#list_connections) - List connections
8181
* [patch_connection](docs/sdks/connections/README.md#patch_connection) - Update Connection details
8282

83-
### [destinations](docs/sdks/destinations/README.md)
83+
### [.destinations](docs/sdks/destinations/README.md)
8484

8585
* [create_destination](docs/sdks/destinations/README.md#create_destination) - Create a destination
8686
* [delete_destination](docs/sdks/destinations/README.md#delete_destination) - Delete a Destination
@@ -89,14 +89,14 @@ if res.connection_response is not None:
8989
* [patch_destination](docs/sdks/destinations/README.md#patch_destination) - Update a Destination
9090
* [put_destination](docs/sdks/destinations/README.md#put_destination) - Update a Destination and fully overwrite it
9191

92-
### [jobs](docs/sdks/jobs/README.md)
92+
### [.jobs](docs/sdks/jobs/README.md)
9393

9494
* [cancel_job](docs/sdks/jobs/README.md#cancel_job) - Cancel a running Job
9595
* [create_job](docs/sdks/jobs/README.md#create_job) - Trigger a sync or reset job of a connection
9696
* [get_job](docs/sdks/jobs/README.md#get_job) - Get Job status and details
9797
* [list_jobs](docs/sdks/jobs/README.md#list_jobs) - List Jobs by sync type
9898

99-
### [sources](docs/sdks/sources/README.md)
99+
### [.sources](docs/sdks/sources/README.md)
100100

101101
* [create_source](docs/sdks/sources/README.md#create_source) - Create a source
102102
* [delete_source](docs/sdks/sources/README.md#delete_source) - Delete a Source
@@ -106,11 +106,11 @@ if res.connection_response is not None:
106106
* [patch_source](docs/sdks/sources/README.md#patch_source) - Update a Source
107107
* [put_source](docs/sdks/sources/README.md#put_source) - Update a Source and fully overwrite it
108108

109-
### [streams](docs/sdks/streams/README.md)
109+
### [.streams](docs/sdks/streams/README.md)
110110

111111
* [get_stream_properties](docs/sdks/streams/README.md#get_stream_properties) - Get stream properties
112112

113-
### [workspaces](docs/sdks/workspaces/README.md)
113+
### [.workspaces](docs/sdks/workspaces/README.md)
114114

115115
* [create_or_update_workspace_o_auth_credentials](docs/sdks/workspaces/README.md#create_or_update_workspace_o_auth_credentials) - Create OAuth override credentials for a workspace and source type.
116116
* [create_workspace](docs/sdks/workspaces/README.md#create_workspace) - Create a workspace
@@ -144,8 +144,6 @@ Here's an example of one such pagination call:
144144
# Error Handling
145145

146146
Handling errors in your 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.
147-
148-
149147
<!-- End Error Handling -->
150148

151149

@@ -163,19 +161,18 @@ You can override the default server globally by passing a server index to the `s
163161

164162
For example:
165163

166-
167164
```python
168165
import airbyte
169166
from airbyte.models import shared
170167

171168
s = airbyte.Airbyte(
169+
server_idx=0,
172170
security=shared.Security(
173171
basic_auth=shared.SchemeBasicAuth(
174172
password="",
175173
username="",
176174
),
177175
),
178-
server_idx=0
179176
)
180177

181178
req = shared.ConnectionCreateRequest(
@@ -214,19 +211,18 @@ if res.connection_response is not None:
214211

215212
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:
216213

217-
218214
```python
219215
import airbyte
220216
from airbyte.models import shared
221217

222218
s = airbyte.Airbyte(
219+
server_url="https://api.airbyte.com/v1",
223220
security=shared.Security(
224221
basic_auth=shared.SchemeBasicAuth(
225222
password="",
226223
username="",
227224
),
228225
),
229-
server_url="https://api.airbyte.com/v1"
230226
)
231227

232228
req = shared.ConnectionCreateRequest(
@@ -279,9 +275,69 @@ http_client = requests.Session()
279275
http_client.headers.update({'x-custom-header': 'someValue'})
280276
s = airbyte.Airbyte(client: http_client)
281277
```
278+
<!-- End Custom HTTP Client -->
282279

283280

284-
<!-- End Custom HTTP Client -->
281+
282+
<!-- Start Authentication -->
283+
284+
# Authentication
285+
286+
## Per-Client Security Schemes
287+
288+
Your SDK supports the following security schemes globally:
289+
290+
| Name | Type | Scheme |
291+
| ------------- | ------------- | ------------- |
292+
| `basic_auth` | http | HTTP Basic |
293+
| `bearer_auth` | http | HTTP Bearer |
294+
295+
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:
296+
297+
```python
298+
import airbyte
299+
from airbyte.models import shared
300+
301+
s = airbyte.Airbyte(
302+
security=shared.Security(
303+
basic_auth=shared.SchemeBasicAuth(
304+
password="",
305+
username="",
306+
),
307+
),
308+
)
309+
310+
req = shared.ConnectionCreateRequest(
311+
configurations=shared.StreamConfigurations(
312+
streams=[
313+
shared.StreamConfiguration(
314+
cursor_field=[
315+
'string',
316+
],
317+
name='string',
318+
primary_key=[
319+
[
320+
'string',
321+
],
322+
],
323+
),
324+
],
325+
),
326+
destination_id='c669dd1e-3620-483e-afc8-55914e0a570f',
327+
namespace_format='${SOURCE_NAMESPACE}',
328+
schedule=shared.ConnectionSchedule(
329+
schedule_type=shared.ScheduleTypeEnum.MANUAL,
330+
),
331+
source_id='dd427d83-a555-4847-8358-42325b6c7b3f',
332+
)
333+
334+
res = s.connections.create_connection(req)
335+
336+
if res.connection_response is not None:
337+
# handle response
338+
pass
339+
```
340+
<!-- End Authentication -->
285341

286342
<!-- Placeholder for Future Speakeasy SDK Sections -->
287343

‎RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -668,4 +668,14 @@ Based on:
668668
### Generated
669669
- [python v0.41.0] .
670670
### Releases
671-
- [PyPI v0.41.0] https://pypi.org/project/airbyte-api/0.41.0 - .
671+
- [PyPI v0.41.0] https://pypi.org/project/airbyte-api/0.41.0 - .
672+
673+
## 2023-11-07 00:13:23
674+
### Changes
675+
Based on:
676+
- OpenAPI Doc 1.0.0
677+
- Speakeasy CLI 1.114.1 (2.181.1) https://github.com/speakeasy-api/speakeasy
678+
### Generated
679+
- [python v0.42.0] .
680+
### Releases
681+
- [PyPI v0.42.0] https://pypi.org/project/airbyte-api/0.42.0 - .

‎docs/models/shared/accesstoken.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# AccessToken
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
8+
| `access_token` | *str* | :heavy_check_mark: | The access token generated for your developer application. Refer to our <a href='https://docs.airbyte.com/integrations/sources/linkedin-ads#setup-guide'>documentation</a> for more information. |
9+
| `auth_method` | [Optional[shared.SourceLinkedinAdsSchemasAuthMethod]](../../models/shared/sourcelinkedinadsschemasauthmethod.md) | :heavy_minus_sign: | N/A |

‎docs/models/shared/accesstokenisrequiredforauthenticationrequests.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# AccessTokenIsRequiredForAuthenticationRequests
2+
3+
4+
## Values
5+
6+
| Name | Value |
7+
| -------------- | -------------- |
8+
| `ACCESS_TOKEN` | access_token |

‎docs/models/shared/actionreporttime.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# ActionReportTime
2+
3+
Determines the report time of action stats. For example, if a person saw the ad on Jan 1st but converted on Jan 2nd, when you query the API with action_report_time=impression, you see a conversion on Jan 1st. When you query the API with action_report_time=conversion, you see a conversion on Jan 2nd.
4+
5+
6+
## Values
7+
8+
| Name | Value |
9+
| ------------ | ------------ |
10+
| `CONVERSION` | conversion |
11+
| `IMPRESSION` | impression |
12+
| `MIXED` | mixed |

‎docs/models/shared/adanalyticsreportconfiguration.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AdAnalyticsReportConfiguration
2+
3+
Config for custom ad Analytics Report
4+
5+
6+
## Fields
7+
8+
| Field | Type | Required | Description |
9+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
10+
| `name` | *str* | :heavy_check_mark: | The name for the custom report. |
11+
| `pivot_by` | [shared.PivotCategory](../../models/shared/pivotcategory.md) | :heavy_check_mark: | Choose a category to pivot your analytics report around. This selection will organize your data based on the chosen attribute, allowing you to analyze trends and performance from different perspectives. |
12+
| `time_granularity` | [shared.TimeGranularity](../../models/shared/timegranularity.md) | :heavy_check_mark: | Choose how to group the data in your report by time. The options are:<br>- 'ALL': A single result summarizing the entire time range.<br>- 'DAILY': Group results by each day.<br>- 'MONTHLY': Group results by each month.<br>- 'YEARLY': Group results by each year.<br>Selecting a time grouping helps you analyze trends and patterns over different time periods. |

‎docs/models/shared/aescbcenvelopeencryption.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# AESCBCEnvelopeEncryption
2+
3+
Staging data will be encrypted using AES-CBC envelope encryption.
4+
5+
6+
## Fields
7+
8+
| Field | Type | Required | Description |
9+
| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
10+
| `encryption_type` | [Optional[shared.DestinationRedshiftEncryptionType]](../../models/shared/destinationredshiftencryptiontype.md) | :heavy_minus_sign: | N/A |
11+
| `key_encrypting_key` | *Optional[str]* | :heavy_minus_sign: | The key, base64-encoded. Must be either 128, 192, or 256 bits. Leave blank to have Airbyte generate an ephemeral key for each sync. |

‎docs/models/shared/aha.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Aha
2+
3+
4+
## Values
5+
6+
| Name | Value |
7+
| ----- | ----- |
8+
| `AHA` | aha |

0 commit comments

Comments
 (0)