Categorygithub.com/codatio/client-sdk-go/previous-versions/files
modulepackage
0.26.1
Repository: https://github.com/codatio/client-sdk-go.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
13
Dependents
0
Files
908 SLOC

# README

Files

Use Codat's Files API to upload your SMB customers' files.

Summary

Files API: > ### New to Codat?

Our Files API reference is relevant only to our existing clients. Please reach out to your Codat contact so that we can find the right product for you.

An API for uploading and downloading files from 'File Upload' Integrations.

The Accounting file upload, Banking file upload, and Business documents file upload integrations provide simple file upload functionality.

Endpoints

EndpointsDescription
FilesEndpoints to manage uploaded files.

Read more...

See our OpenAPI spec

Table of Contents

SDK Installation

To add the SDK as a dependency to your project:

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

Example Usage

SDK Example Usage

Example

package main

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

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

	ctx := context.Background()
	res, err := s.Files.DownloadFiles(ctx, operations.DownloadFilesRequest{
		CompanyID: "8a210b68-6988-11ed-a1eb-0242ac120002",
		Date:      files.String("2022-10-23T00:00:00Z"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.Data != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

Files

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

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

	ctx := context.Background()
	res, err := s.Files.DownloadFiles(ctx, operations.DownloadFilesRequest{
		CompanyID: "8a210b68-6988-11ed-a1eb-0242ac120002",
		Date:      files.String("2022-10-23T00:00:00Z"),
	}, 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.Data != 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/files"
	"github.com/codatio/client-sdk-go/previous-versions/files/pkg/models/operations"
	"github.com/codatio/client-sdk-go/previous-versions/files/pkg/models/shared"
	"github.com/codatio/client-sdk-go/previous-versions/files/pkg/retry"
	"log"
)

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

	ctx := context.Background()
	res, err := s.Files.DownloadFiles(ctx, operations.DownloadFilesRequest{
		CompanyID: "8a210b68-6988-11ed-a1eb-0242ac120002",
		Date:      files.String("2022-10-23T00:00:00Z"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.Data != 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 ObjectStatus CodeContent Type
sdkerrors.Schema400,401,402,404,429,500,503application/json
sdkerrors.DownloadFilesErrorMessage403application/json
sdkerrors.SDKError4xx-5xx/

Example

package main

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

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

	ctx := context.Background()
	res, err := s.Files.DownloadFiles(ctx, operations.DownloadFilesRequest{
		CompanyID: "8a210b68-6988-11ed-a1eb-0242ac120002",
		Date:      files.String("2022-10-23T00:00:00Z"),
	})
	if err != nil {

		var e *sdkerrors.Schema
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.DownloadFilesErrorMessage
		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:

#ServerVariables
0https://api.codat.ioNone

Example

package main

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

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

	ctx := context.Background()
	res, err := s.Files.DownloadFiles(ctx, operations.DownloadFilesRequest{
		CompanyID: "8a210b68-6988-11ed-a1eb-0242ac120002",
		Date:      files.String("2022-10-23T00:00:00Z"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.Data != 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/files"
	"github.com/codatio/client-sdk-go/previous-versions/files/pkg/models/operations"
	"github.com/codatio/client-sdk-go/previous-versions/files/pkg/models/shared"
	"log"
)

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

	ctx := context.Background()
	res, err := s.Files.DownloadFiles(ctx, operations.DownloadFilesRequest{
		CompanyID: "8a210b68-6988-11ed-a1eb-0242ac120002",
		Date:      files.String("2022-10-23T00:00:00Z"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.Data != 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:

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

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

	ctx := context.Background()
	res, err := s.Files.DownloadFiles(ctx, operations.DownloadFilesRequest{
		CompanyID: "8a210b68-6988-11ed-a1eb-0242ac120002",
		Date:      files.String("2022-10-23T00:00:00Z"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.Data != 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

# Packages

No description provided by the author

# Functions

Bool provides a helper function to return a pointer to a bool.
Float32 provides a helper function to return a pointer to a float32.
Float64 provides a helper function to return a pointer to a float64.
Int provides a helper function to return a pointer to an int.
Int64 provides a helper function to return a pointer to an int64.
New creates a new instance of the SDK with the provided options.
Pointer provides a helper function to return a pointer to a type.
String provides a helper function to return a pointer to a string.
WithClient allows the overriding of the default HTTP client used by the SDK.
No description provided by the author
WithSecurity configures the SDK to use the provided security details.
WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication.
WithServerIndex allows the overriding of the default server by index.
WithServerURL allows the overriding of the default server URL.
WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters.
WithTimeout Optional request timeout applied to each operation.

# Variables

ServerList contains the list of servers available to the SDK.

# Structs

CodatFiles - Files API: > ### New to Codat? > > Our Files API reference is relevant only to our existing clients.
Files - Endpoints to manage uploaded files.

# Interfaces

HTTPClient provides an interface for suplying the SDK with a custom HTTP client.

# Type aliases

No description provided by the author