Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/hightouch-go-sdk
A Go SDK for accessing the Hightouch API.
https://github.com/speakeasy-sdks/hightouch-go-sdk
cdp go hightouch sdk
Last synced: 1 day ago
JSON representation
A Go SDK for accessing the Hightouch API.
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/hightouch-go-sdk
- Owner: speakeasy-sdks
- Created: 2023-03-02T05:40:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:13:13.000Z (7 months ago)
- Last Synced: 2024-06-21T21:06:04.305Z (5 months ago)
- Topics: cdp, go, hightouch, sdk
- Language: Go
- Homepage: https://hightouch.com/docs/api-reference
- Size: 419 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Hightouch Go SDK
Hightouch exposes a REST API that lets users interact with resources like syncs, models, sources and destinations.
## SDK Installation
```bash
go get github.com/speakeasy-sdks/hightouch-go-sdk
```
## Authentication
- Create an [API key](https://app.hightouch.com/settings/api-keys)
- From the API keys tab on the Settings page, select Add API key.
- Enter a descriptive Name for your key.
- Copy your API key and store it in a safe location. The key will only be displayed once.
- Click Create API key.
## SDK Example Usage
### Example
```go
package main
import (
"context"
hightouchgosdk "github.com/speakeasy-sdks/hightouch-go-sdk"
"github.com/speakeasy-sdks/hightouch-go-sdk/pkg/models/shared"
"log"
)
func main() {
s := hightouchgosdk.New(
hightouchgosdk.WithSecurity(""),
)
ctx := context.Background()
res, err := s.CreateDestination(ctx, shared.DestinationCreate{
Configuration: map[string]interface{}{
"key": "",
},
Name: "",
Slug: "",
Type: "",
})
if err != nil {
log.Fatal(err)
}
if res.OneOf != nil {
// handle response
}
}
```
## Available Resources and Operations
### [Hightouch SDK](docs/sdks/hightouch/README.md)
* [CreateDestination](docs/sdks/hightouch/README.md#createdestination) - Create Destination
* [CreateModel](docs/sdks/hightouch/README.md#createmodel) - Create Model
* [CreateSource](docs/sdks/hightouch/README.md#createsource) - Create Source
* [CreateSync](docs/sdks/hightouch/README.md#createsync) - Create Sync
* [GetDestination](docs/sdks/hightouch/README.md#getdestination) - Get Destination
* [GetModel](docs/sdks/hightouch/README.md#getmodel) - Get Model
* [GetSource](docs/sdks/hightouch/README.md#getsource) - Get Source
* [GetSync](docs/sdks/hightouch/README.md#getsync) - Get Sync
* [GetSyncSequenceRun](docs/sdks/hightouch/README.md#getsyncsequencerun) - Sync sequence status
* [ListDestination](docs/sdks/hightouch/README.md#listdestination) - List Destinations
* [ListModel](docs/sdks/hightouch/README.md#listmodel) - List Models
* [ListSource](docs/sdks/hightouch/README.md#listsource) - List Sources
* [ListSync](docs/sdks/hightouch/README.md#listsync) - List Syncs
* [ListSyncRuns](docs/sdks/hightouch/README.md#listsyncruns) - List Sync Runs
* [TriggerRun](docs/sdks/hightouch/README.md#triggerrun) - Trigger Sync
* [TriggerRunCustom](docs/sdks/hightouch/README.md#triggerruncustom) - Trigger Sync From ID or Slug
* [TriggerRunIDGraph](docs/sdks/hightouch/README.md#triggerrunidgraph)
* [TriggerSequenceRun](docs/sdks/hightouch/README.md#triggersequencerun) - Trigger Sync sequence
* [UpdateDestination](docs/sdks/hightouch/README.md#updatedestination) - Update Destination
* [UpdateModel](docs/sdks/hightouch/README.md#updatemodel) - Update Model
* [UpdateSource](docs/sdks/hightouch/README.md#updatesource) - Update Source
* [UpdateSync](docs/sdks/hightouch/README.md#updatesync) - Update Sync
## Special Types
## Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.
| Error Object | Status Code | Content Type |
| --------------------------- | --------------------------- | --------------------------- |
| sdkerrors.ValidateErrorJSON | 409,422 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
### Example
```go
package main
import (
"context"
"errors"
hightouchgosdk "github.com/speakeasy-sdks/hightouch-go-sdk"
"github.com/speakeasy-sdks/hightouch-go-sdk/pkg/models/sdkerrors"
"github.com/speakeasy-sdks/hightouch-go-sdk/pkg/models/shared"
"log"
)
func main() {
s := hightouchgosdk.New(
hightouchgosdk.WithSecurity(""),
)
ctx := context.Background()
res, err := s.CreateDestination(ctx, shared.DestinationCreate{
Configuration: map[string]interface{}{
"key": "",
},
Name: "",
Slug: "",
Type: "",
})
if err != nil {
var e *sdkerrors.ValidateErrorJSON
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.SDKError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
}
}
```
## Server Selection
### Select Server by Index
You can override the default server globally using the `WithServerIndex` option 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.hightouch.com/api/v1` | None |
#### Example
```go
package main
import (
"context"
hightouchgosdk "github.com/speakeasy-sdks/hightouch-go-sdk"
"github.com/speakeasy-sdks/hightouch-go-sdk/pkg/models/shared"
"log"
)
func main() {
s := hightouchgosdk.New(
hightouchgosdk.WithServerIndex(0),
hightouchgosdk.WithSecurity(""),
)
ctx := context.Background()
res, err := s.CreateDestination(ctx, shared.DestinationCreate{
Configuration: map[string]interface{}{
"key": "",
},
Name: "",
Slug: "",
Type: "",
})
if err != nil {
log.Fatal(err)
}
if res.OneOf != nil {
// handle response
}
}
```
### Override Server URL Per-Client
The default server can also be overridden globally using the `WithServerURL` option when initializing the SDK client instance. For example:
```go
package main
import (
"context"
hightouchgosdk "github.com/speakeasy-sdks/hightouch-go-sdk"
"github.com/speakeasy-sdks/hightouch-go-sdk/pkg/models/shared"
"log"
)
func main() {
s := hightouchgosdk.New(
hightouchgosdk.WithServerURL("https://api.hightouch.com/api/v1"),
hightouchgosdk.WithSecurity(""),
)
ctx := context.Background()
res, err := s.CreateDestination(ctx, shared.DestinationCreate{
Configuration: map[string]interface{}{
"key": "",
},
Name: "",
Slug: "",
Type: "",
})
if err != nil {
log.Fatal(err)
}
if res.OneOf != nil {
// handle response
}
}
```
## Custom HTTP Client
The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:
```go
type HTTPClient interface {
Do(req *http.Request) (*http.Response, error)
}
```
The built-in `net/http` client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.
```go
import (
"net/http"
"time"
"github.com/myorg/your-go-sdk"
)
var (
httpClient = &http.Client{Timeout: 30 * time.Second}
sdkClient = sdk.New(sdk.WithClient(httpClient))
)
```
This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.
## Authentication
### Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| ------------ | ------------ | ------------ |
| `BearerAuth` | http | HTTP Bearer |
You can configure it using the `WithSecurity` option when initializing the SDK client instance. For example:
```go
package main
import (
"context"
hightouchgosdk "github.com/speakeasy-sdks/hightouch-go-sdk"
"github.com/speakeasy-sdks/hightouch-go-sdk/pkg/models/shared"
"log"
)
func main() {
s := hightouchgosdk.New(
hightouchgosdk.WithSecurity(""),
)
ctx := context.Background()
res, err := s.CreateDestination(ctx, shared.DestinationCreate{
Configuration: map[string]interface{}{
"key": "",
},
Name: "",
Slug: "",
Type: "",
})
if err != nil {
log.Fatal(err)
}
if res.OneOf != nil {
// handle response
}
}
```
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)