/unified-go-sdk

Primary LanguageGoMIT LicenseMIT

SDK Installation

go get github.com/unified-to/unified-go-sdk

SDK Example Usage

Example

package main

import (
	"context"
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"log"
)

func main() {
	s := unifiedgosdk.New()
	request := operations.CreateAccountingAccountRequest{
		ConnectionID: "<value>",
	}
	ctx := context.Background()
	res, err := s.Accounting.CreateAccountingAccount(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	if res.AccountingAccount != nil {
		// handle response
	}
}

Available Resources and Operations

Accounting

Account

Contact

Invoice

Journal

Organization

Taxrate

Transaction

Ats

Activity

Application

Applicationstatus

Candidate

Company

Document

Interview

Job

Scorecard

Commerce

Collection

Inventory

Item

Location

Crm

Deal

Event

Lead

Pipeline

Enrich

Person

Genai

Model

Prompt

Hris

Employee

Group

Payslip

Timeoff

Kms

Page

Space

Martech

List

Member

Messaging

Channel

Message

Passthrough

Payment

Link

Payout

Refund

Storage

File

Task

Project

Ticketing

Customer

Note

Ticket

Uc

Call

Unified

Apicall

Connection

Integration

Auth

Login

Issue

Webhook

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.SDKError 4xx-5xx /

Example

package main

import (
	"context"
	"errors"
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"github.com/unified-to/unified-go-sdk/pkg/models/sdkerrors"
	"log"
)

func main() {
	s := unifiedgosdk.New()
	request := operations.CreateAccountingAccountRequest{
		ConnectionID: "<value>",
	}
	ctx := context.Background()
	res, err := s.Accounting.CreateAccountingAccount(ctx, request)
	if err != nil {

		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.unified.to None
1 https://api-eu.unified.to None

Example

package main

import (
	"context"
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"log"
)

func main() {
	s := unifiedgosdk.New(
		unifiedgosdk.WithServerIndex(1),
	)
	request := operations.CreateAccountingAccountRequest{
		ConnectionID: "<value>",
	}
	ctx := context.Background()
	res, err := s.Accounting.CreateAccountingAccount(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	if res.AccountingAccount != 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:

package main

import (
	"context"
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"log"
)

func main() {
	s := unifiedgosdk.New(
		unifiedgosdk.WithServerURL("https://api.unified.to"),
	)
	request := operations.CreateAccountingAccountRequest{
		ConnectionID: "<value>",
	}
	ctx := context.Background()
	res, err := s.Accounting.CreateAccountingAccount(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	if res.AccountingAccount != 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:

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.

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
Jwt apiKey API key

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"log"
)

func main() {
	s := unifiedgosdk.New(
		unifiedgosdk.WithSecurity("<YOUR_API_KEY_HERE>"),
	)
	request := operations.CreateAccountingAccountRequest{
		ConnectionID: "<value>",
	}
	ctx := context.Background()
	res, err := s.Accounting.CreateAccountingAccount(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	if res.AccountingAccount != nil {
		// handle response
	}
}

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:

package main

import (
	"context"
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"github.com/unified-to/unified-go-sdk/pkg/retry"
	"log"
	"pkg/models/operations"
)

func main() {
	s := unifiedgosdk.New()
	request := operations.CreateAccountingAccountRequest{
		ConnectionID: "<value>",
	}
	ctx := context.Background()
	res, err := s.Accounting.CreateAccountingAccount(ctx, request, operations.WithRetries(
		retry.Config{
			Strategy: "backoff",
			Backoff: &retry.BackoffStrategy{
				InitialInterval: 1,
				MaxInterval:     50,
				Exponent:        1.1,
				MaxElapsedTime:  100,
			},
			RetryConnectionErrors: false,
		}))
	if err != nil {
		log.Fatal(err)
	}
	if res.AccountingAccount != nil {
		// handle response
	}
}

If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:

package main

import (
	"context"
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"github.com/unified-to/unified-go-sdk/pkg/retry"
	"log"
)

func main() {
	s := unifiedgosdk.New(
		unifiedgosdk.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
	)
	request := operations.CreateAccountingAccountRequest{
		ConnectionID: "<value>",
	}
	ctx := context.Background()
	res, err := s.Accounting.CreateAccountingAccount(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	if res.AccountingAccount != nil {
		// handle response
	}
}

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy