Common

Manage the building blocks of Codat, including companies, connections, and more.

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/codatio/client-sdk-go/previous-versions/common

Example Usage

SDK Example Usage

Example

package main

import (
	"context"
	"github.com/codatio/client-sdk-go/previous-versions/common"
	"github.com/codatio/client-sdk-go/previous-versions/common/pkg/models/shared"
	"log"
)

func main() {
	s := common.New(
		common.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Settings.CreateAPIKey(ctx, &shared.CreateAPIKey{
		Name: common.String("azure-invoice-finance-processor"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.APIKeyDetails != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

Companies

• Create - Create company
• Delete - Delete a company
• Get - Get company
• List - List companies
• Update - Update company

ConnectionManagement

• GetAccessToken - Get access token

ConnectionManagement.CorsSettings

• Get - Get CORS settings
• Set - Set CORS settings

Connections

• Create - Create connection
• Delete - Delete connection
• Get - Get connection
• List - List connections
• Unlink - Unlink connection
• UpdateAuthorization - Update authorization

CustomDataType

• Configure - Configure custom data type
• GetConfiguration - Get custom data configuration
• List - List custom data type records
• Refresh - Refresh custom data type

Groups

• AddCompany - Add company
• Create - Create group
• List - List groups
• RemoveCompany - Remove company

Integrations

• Get - Get integration
• GetBranding - Get branding
• List - List integrations

PushData

• GetModelOptions - Get push options
• GetOperation - Get push operation
• ListOperations - List push operations

RefreshData

• All - Refresh all data
• ByDataType - Refresh data type
• Get - Get data status
• GetPullOperation - Get pull operation
• ListPullOperations - List pull operations

Settings

• CreateAPIKey - Create API key
• DeleteAPIKey - Delete API key
• GetProfile - Get profile
• GetSyncSettings - Get sync settings
• ListAPIKeys - List API keys
• UpdateProfile - Update profile
• UpdateSyncSettings - Update all sync settings

SupplementalData

• Configure - Configure
• GetConfiguration - Get configuration

Webhooks

• Create - Create webhook :warning: Deprecated
• CreateConsumer - Create webhook consumer
• DeleteConsumer - Delete webhook consumer
• Get - Get webhook :warning: Deprecated
• List - List webhooks :warning: Deprecated
• ListConsumers - List webhook consumers

Special Types

Summary

Platform API: Platform API

An API for the common components of all of Codat's products.

These end points cover creating and managing your companies, data connections, and integrations.

Read about the building blocks of Codat... | See our OpenAPI spec

---

Endpoints

Endpoints	Description
Companies	Create and manage your SMB users' companies.
Connections	Create new and manage existing data connections for a company.
Connection management	Configure connection management UI and retrieve access tokens for authentication.
Groups	Define and manage sets of companies based on a chosen characteristic.
Webhooks	Create and manage webhooks that listen to Codat's events.
Integrations	Get a list of integrations supported by Codat and their logos.
Refresh data	Initiate data refreshes, view pull status and history.
Settings	Manage company profile configuration, sync settings, and API keys.
Push data	Initiate and monitor Create, Update, and Delete operations.
Supplemental data	Configure and pull additional data you can include in Codat's standard data types.
Custom data type	Configure and pull additional data types that are not included in Codat's standardized data model.

Table of Contents

• SDK Installation
• SDK Example Usage
• Available Resources and Operations
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• Special Types

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"
	"github.com/codatio/client-sdk-go/previous-versions/common"
	"github.com/codatio/client-sdk-go/previous-versions/common/pkg/models/shared"
	"github.com/codatio/client-sdk-go/previous-versions/common/pkg/retry"
	"log"
	"pkg/models/operations"
)

func main() {
	s := common.New(
		common.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Settings.CreateAPIKey(ctx, &shared.CreateAPIKey{
		Name: common.String("azure-invoice-finance-processor"),
	}, 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.APIKeyDetails != 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"
	"github.com/codatio/client-sdk-go/previous-versions/common"
	"github.com/codatio/client-sdk-go/previous-versions/common/pkg/models/shared"
	"github.com/codatio/client-sdk-go/previous-versions/common/pkg/retry"
	"log"
)

func main() {
	s := common.New(
		common.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		common.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Settings.CreateAPIKey(ctx, &shared.CreateAPIKey{
		Name: common.String("azure-invoice-finance-processor"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.APIKeyDetails != nil {
		// handle response
	}
}

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.ErrorMessage	400,401,402,403,409,429,500,503	application/json
sdkerrors.SDKError	4xx-5xx	/

Example

package main

import (
	"context"
	"errors"
	"github.com/codatio/client-sdk-go/previous-versions/common"
	"github.com/codatio/client-sdk-go/previous-versions/common/pkg/models/sdkerrors"
	"github.com/codatio/client-sdk-go/previous-versions/common/pkg/models/shared"
	"log"
)

func main() {
	s := common.New(
		common.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Settings.CreateAPIKey(ctx, &shared.CreateAPIKey{
		Name: common.String("azure-invoice-finance-processor"),
	})
	if err != nil {

		var e *sdkerrors.ErrorMessage
		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.codat.io	None

Example

package main

import (
	"context"
	"github.com/codatio/client-sdk-go/previous-versions/common"
	"github.com/codatio/client-sdk-go/previous-versions/common/pkg/models/shared"
	"log"
)

func main() {
	s := common.New(
		common.WithServerIndex(0),
		common.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Settings.CreateAPIKey(ctx, &shared.CreateAPIKey{
		Name: common.String("azure-invoice-finance-processor"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.APIKeyDetails != 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"
	"github.com/codatio/client-sdk-go/previous-versions/common"
	"github.com/codatio/client-sdk-go/previous-versions/common/pkg/models/shared"
	"log"
)

func main() {
	s := common.New(
		common.WithServerURL("https://api.codat.io"),
		common.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Settings.CreateAPIKey(ctx, &shared.CreateAPIKey{
		Name: common.String("azure-invoice-finance-processor"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.APIKeyDetails != 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
AuthHeader	apiKey	API key

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

package main

import (
	"context"
	"github.com/codatio/client-sdk-go/previous-versions/common"
	"github.com/codatio/client-sdk-go/previous-versions/common/pkg/models/shared"
	"log"
)

func main() {
	s := common.New(
		common.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Settings.CreateAPIKey(ctx, &shared.CreateAPIKey{
		Name: common.String("azure-invoice-finance-processor"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.APIKeyDetails != nil {
		// handle response
	}
}

Support

If you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance. You can raise any issues by contacting your dedicated Codat representative or reaching out to our support team. We're here to help ensure a smooth experience for you.

Library generated by Speakeasy