modulepackage
0.22.0
Repository: https://github.com/codatio/client-sdk-go.git
Documentation: pkg.go.dev
# README
github.com/codatio/client-sdk-go/files
SDK Installation
go get github.com/codatio/client-sdk-go/files
SDK Example Usage
package main
import(
"context"
"log"
"github.com/codatio/client-sdk-go/files"
"github.com/codatio/client-sdk-go/files/pkg/models/operations"
)
func main() {
s := codatfiles.New(
codatfiles.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: codatfiles.String("2022-10-23T00:00:00.000Z"),
})
if err != nil {
log.Fatal(err)
}
if res.Data != nil {
// handle response
}
}
Available Resources and Operations
Files
- DownloadFiles - Download all files for a company
- ListFiles - List all files uploaded by a company
- UploadFiles - Upload files for a company
SDK 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.
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.
WithSecurity configures the SDK to use the provided security details.
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.
# Variables
ServerList contains the list of servers available to the SDK.
# Structs
CodatFiles - Files API: An API for uploading and downloading files from 'File Upload' Integrations.
# Interfaces
HTTPClient provides an interface for suplying the SDK with a custom HTTP client.
# Type aliases
No description provided by the author