Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: 🐝 Update SDK - Generate 1.7.0 #113

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.speakeasy/reports
# Ignore IDE-specific configs
.project
.settings/
Expand Down
168 changes: 120 additions & 48 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
speakeasyVersion: 1.453.10
speakeasyVersion: 1.481.1
sources:
my-source:
sourceNamespace: my-source
Expand All @@ -9,11 +9,11 @@ sources:
- main
sample-source:
sourceNamespace: my-source
sourceRevisionDigest: sha256:aa3c5e64a0c5b50601e64821c42101dc6e22d9c63c67fc5b2c6df95683549fc3
sourceBlobDigest: sha256:fa5143179ee978611fb032f3948584f4cbf071857ff2ff6611fbac17e1b67eb9
sourceRevisionDigest: sha256:1808b66517c4741752dccb25c8ad521d04eeb815ee3feb5808d6cb306f32358a
sourceBlobDigest: sha256:986e0a204bd4d6b411c07dbccc22df6b14844a5ce43aabe0d640fe9ef7446e52
tags:
- latest
- speakeasy-sdk-regen-1733271463
- speakeasy-sdk-regen-1733962674
- 1.0.0
targets:
airbyte-api:
Expand All @@ -24,10 +24,10 @@ targets:
testing:
source: sample-source
sourceNamespace: my-source
sourceRevisionDigest: sha256:aa3c5e64a0c5b50601e64821c42101dc6e22d9c63c67fc5b2c6df95683549fc3
sourceBlobDigest: sha256:fa5143179ee978611fb032f3948584f4cbf071857ff2ff6611fbac17e1b67eb9
sourceRevisionDigest: sha256:1808b66517c4741752dccb25c8ad521d04eeb815ee3feb5808d6cb306f32358a
sourceBlobDigest: sha256:986e0a204bd4d6b411c07dbccc22df6b14844a5ce43aabe0d640fe9ef7446e52
codeSamplesNamespace: my-source-java-code-samples
codeSamplesRevisionDigest: sha256:4bcdc1c05c1002038c44996ff6e1425317394805a9bbc73842fbd2e75ccfab04
codeSamplesRevisionDigest: sha256:3c53faf1302da43fa5f5caee2f701ced4accb93fdde179bbcdef774810a80a8f
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
339 changes: 338 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,338 @@
undefined
undefined
<!-- Start Summary [summary] -->
## Summary

airbyte-api: Programmatically control Airbyte Cloud, OSS & Enterprise.
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [SDK Installation](#sdk-installation)
* [SDK Example Usage](#sdk-example-usage)
* [Authentication](#authentication)
* [Available Resources and Operations](#available-resources-and-operations)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)

<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
## SDK Installation

### Getting started

JDK 11 or later is required.

The samples below show how a published SDK artifact is used:

Gradle:
```groovy
implementation 'com.airbyte:api:1.7.0'
```

Maven:
```xml
<dependency>
<groupId>com.airbyte</groupId>
<artifactId>api</artifactId>
<version>1.7.0</version>
</dependency>
```

### How to build
After cloning the git repository to your file system you can build the SDK artifact from source to the `build` directory by running `./gradlew build` on *nix systems or `gradlew.bat` on Windows systems.

If you wish to build from source and publish the SDK artifact to your local Maven repository (on your filesystem) then use the following command (after cloning the git repo locally):

On *nix:
```bash
./gradlew publishToMavenLocal -Pskip.signing
```
On Windows:
```bash
gradlew.bat publishToMavenLocal -Pskip.signing
```
<!-- End SDK Installation [installation] -->

<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage

### Example

```java
package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.CreateConnectionResponse;
import com.airbyte.api.models.shared.ConnectionCreateRequest;
import com.airbyte.api.models.shared.SchemeBasicAuth;
import com.airbyte.api.models.shared.Security;
import java.lang.Exception;

public class Application {

public static void main(String[] args) throws Exception {

Airbyte sdk = Airbyte.builder()
.security(Security.builder()
.basicAuth(SchemeBasicAuth.builder()
.password("")
.username("")
.build())
.build())
.build();

ConnectionCreateRequest req = ConnectionCreateRequest.builder()
.destinationId("e478de0d-a3a0-475c-b019-25f7dd29e281")
.sourceId("95e66a59-8045-4307-9678-63bc3c9b8c93")
.name("Postgres-to-Bigquery")
.build();

CreateConnectionResponse res = sdk.connections().createConnection()
.request(req)
.call();

if (res.connectionResponse().isPresent()) {
// handle response
}
}
}
```
<!-- End SDK Example Usage [usage] -->

<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes

This SDK supports the following security schemes globally:

| Name | Type | Scheme |
| ------------------- | ------ | ------------ |
| `basicAuth` | http | HTTP Basic |
| `bearerAuth` | http | HTTP Bearer |
| `clientCredentials` | oauth2 | OAuth2 token |

You can set the security parameters through the `security` builder method 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:
```java
package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.CreateConnectionResponse;
import com.airbyte.api.models.shared.ConnectionCreateRequest;
import com.airbyte.api.models.shared.SchemeBasicAuth;
import com.airbyte.api.models.shared.Security;
import java.lang.Exception;

public class Application {

public static void main(String[] args) throws Exception {

Airbyte sdk = Airbyte.builder()
.security(Security.builder()
.basicAuth(SchemeBasicAuth.builder()
.password("")
.username("")
.build())
.build())
.build();

ConnectionCreateRequest req = ConnectionCreateRequest.builder()
.destinationId("e478de0d-a3a0-475c-b019-25f7dd29e281")
.sourceId("95e66a59-8045-4307-9678-63bc3c9b8c93")
.name("Postgres-to-Bigquery")
.build();

CreateConnectionResponse res = sdk.connections().createConnection()
.request(req)
.call();

if (res.connectionResponse().isPresent()) {
// handle response
}
}
}
```
<!-- End Authentication [security] -->

<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

<details open>
<summary>Available methods</summary>


### [connections()](docs/sdks/connections/README.md)

* [createConnection](docs/sdks/connections/README.md#createconnection) - Create a connection
* [deleteConnection](docs/sdks/connections/README.md#deleteconnection) - Delete a Connection
* [getConnection](docs/sdks/connections/README.md#getconnection) - Get Connection details
* [listConnections](docs/sdks/connections/README.md#listconnections) - List connections
* [patchConnection](docs/sdks/connections/README.md#patchconnection) - Update Connection details

### [destinations()](docs/sdks/destinations/README.md)

* [createDestination](docs/sdks/destinations/README.md#createdestination) - Create a destination
* [deleteDestination](docs/sdks/destinations/README.md#deletedestination) - Delete a Destination
* [getDestination](docs/sdks/destinations/README.md#getdestination) - Get Destination details
* [listDestinations](docs/sdks/destinations/README.md#listdestinations) - List destinations
* [patchDestination](docs/sdks/destinations/README.md#patchdestination) - Update a Destination
* [putDestination](docs/sdks/destinations/README.md#putdestination) - Update a Destination and fully overwrite it

### [health()](docs/sdks/health/README.md)

* [getHealthCheck](docs/sdks/health/README.md#gethealthcheck) - Health Check

### [jobs()](docs/sdks/jobs/README.md)

* [cancelJob](docs/sdks/jobs/README.md#canceljob) - Cancel a running Job
* [createJob](docs/sdks/jobs/README.md#createjob) - Trigger a sync or reset job of a connection
* [getJob](docs/sdks/jobs/README.md#getjob) - Get Job status and details
* [listJobs](docs/sdks/jobs/README.md#listjobs) - List Jobs by sync type

### [organizations()](docs/sdks/organizations/README.md)

* [listOrganizationsForUser](docs/sdks/organizations/README.md#listorganizationsforuser) - List all organizations for a user

### [permissions()](docs/sdks/permissions/README.md)

* [createPermission](docs/sdks/permissions/README.md#createpermission) - Create a permission
* [deletePermission](docs/sdks/permissions/README.md#deletepermission) - Delete a Permission
* [getPermission](docs/sdks/permissions/README.md#getpermission) - Get Permission details
* [listPermissions](docs/sdks/permissions/README.md#listpermissions) - List Permissions by user id
* [updatePermission](docs/sdks/permissions/README.md#updatepermission) - Update a permission

### [sources()](docs/sdks/sources/README.md)

* [createSource](docs/sdks/sources/README.md#createsource) - Create a source
* [deleteSource](docs/sdks/sources/README.md#deletesource) - Delete a Source
* [getSource](docs/sdks/sources/README.md#getsource) - Get Source details
* [initiateOAuth](docs/sdks/sources/README.md#initiateoauth) - Initiate OAuth for a source
* [listSources](docs/sdks/sources/README.md#listsources) - List sources
* [patchSource](docs/sdks/sources/README.md#patchsource) - Update a Source
* [putSource](docs/sdks/sources/README.md#putsource) - Update a Source and fully overwrite it

### [streams()](docs/sdks/streams/README.md)

* [getStreamProperties](docs/sdks/streams/README.md#getstreamproperties) - Get stream properties

### [users()](docs/sdks/users/README.md)

* [listUsersWithinAnOrganization](docs/sdks/users/README.md#listuserswithinanorganization) - List all users within an organization

### [workspaces()](docs/sdks/workspaces/README.md)

* [createOrUpdateWorkspaceOAuthCredentials](docs/sdks/workspaces/README.md#createorupdateworkspaceoauthcredentials) - Create OAuth override credentials for a workspace and source type.
* [createWorkspace](docs/sdks/workspaces/README.md#createworkspace) - Create a workspace
* [deleteWorkspace](docs/sdks/workspaces/README.md#deleteworkspace) - Delete a Workspace
* [getWorkspace](docs/sdks/workspaces/README.md#getworkspace) - Get Workspace details
* [listWorkspaces](docs/sdks/workspaces/README.md#listworkspaces) - List workspaces
* [updateWorkspace](docs/sdks/workspaces/README.md#updateworkspace) - Update a workspace

</details>
<!-- 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 exception.

By default, an API error will throw a `models/errors/SDKError` exception. When custom error responses are specified for an operation, the SDK may also throw 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 `createConnection` method throws the following exceptions:

| Error Type | Status Code | Content Type |
| ---------------------- | ----------- | ------------ |
| models/errors/SDKError | 4XX, 5XX | \*/\* |

### Example

```java
package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.CreateConnectionResponse;
import com.airbyte.api.models.shared.ConnectionCreateRequest;
import com.airbyte.api.models.shared.SchemeBasicAuth;
import com.airbyte.api.models.shared.Security;
import java.lang.Exception;

public class Application {

public static void main(String[] args) throws Exception {

Airbyte sdk = Airbyte.builder()
.security(Security.builder()
.basicAuth(SchemeBasicAuth.builder()
.password("")
.username("")
.build())
.build())
.build();

ConnectionCreateRequest req = ConnectionCreateRequest.builder()
.destinationId("e478de0d-a3a0-475c-b019-25f7dd29e281")
.sourceId("95e66a59-8045-4307-9678-63bc3c9b8c93")
.name("Postgres-to-Bigquery")
.build();

CreateConnectionResponse res = sdk.connections().createConnection()
.request(req)
.call();

if (res.connectionResponse().isPresent()) {
// handle response
}
}
}
```
<!-- End Error Handling [errors] -->

<!-- Start Server Selection [server] -->
## Server Selection

### Override Server URL Per-Client

The default server can also be overridden globally using the `.serverURL(String serverUrl)` builder method when initializing the SDK client instance. For example:
```java
package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.CreateConnectionResponse;
import com.airbyte.api.models.shared.ConnectionCreateRequest;
import com.airbyte.api.models.shared.SchemeBasicAuth;
import com.airbyte.api.models.shared.Security;
import java.lang.Exception;

public class Application {

public static void main(String[] args) throws Exception {

Airbyte sdk = Airbyte.builder()
.serverURL("https://api.airbyte.com/v1")
.security(Security.builder()
.basicAuth(SchemeBasicAuth.builder()
.password("")
.username("")
.build())
.build())
.build();

ConnectionCreateRequest req = ConnectionCreateRequest.builder()
.destinationId("e478de0d-a3a0-475c-b019-25f7dd29e281")
.sourceId("95e66a59-8045-4307-9678-63bc3c9b8c93")
.name("Postgres-to-Bigquery")
.build();

CreateConnectionResponse res = sdk.connections().createConnection()
.request(req)
.call();

if (res.connectionResponse().isPresent()) {
// handle response
}
}
}
```
<!-- End Server Selection [server] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -1191,4 +1191,14 @@ Based on:
### Generated
- [java v1.6.0] .
### Releases
- [Maven Central v1.6.0] https://central.sonatype.com/artifact/com.airbyte/api/1.6.0 - .
- [Maven Central v1.6.0] https://central.sonatype.com/artifact/com.airbyte/api/1.6.0 - .

## 2025-02-01 00:17:18
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.481.1 (2.500.5) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v1.7.0] .
### Releases
- [Maven Central v1.7.0] https://central.sonatype.com/artifact/com.airbyte/api/1.7.0 - .
Loading