modulepackage
0.25.0
Repository: https://github.com/codatio/client-sdk-go.git
Documentation: pkg.go.dev
# README
github.com/codatio/client-sdk-go/common
SDK Installation
go get github.com/codatio/client-sdk-go/common
SDK Example Usage
package main
import(
"context"
"log"
"github.com/codatio/client-sdk-go/common"
"github.com/codatio/client-sdk-go/common/pkg/models/shared"
)
func main() {
s := codatcommon.New(
codatcommon.WithSecurity(shared.Security{
AuthHeader: "",
}),
)
ctx := context.Background()
res, err := s.Companies.Create(ctx, shared.CompanyRequestBody{
Description: codatcommon.String("Requested early access to the new financing scheme."),
Name: "Bank of Dave",
})
if err != nil {
log.Fatal(err)
}
if res.Company != nil {
// handle response
}
}
Available Resources and Operations
Companies
- Create - Create company
- Delete - Delete a company
- Get - Get company
- List - List companies
- Update - Update company
Connections
- Create - Create connection
- Delete - Delete connection
- Get - Get connection
- List - List connections
- UnlinkConnection - Unlink connection
- UpdateAuthorization - Update authorization
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
GetProfile- Get profile :warning: Deprecated- GetSyncSettings - Get sync settings
- UpdateProfile - Update profile
- UpdateSyncSettings - Update all sync settings
SupplementalData
- Configure - Configure
- GetConfiguration - Get configuration
Webhooks
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
CodatCommon - Common API: Common API An API for the common components of all of Codat's products.
# Interfaces
HTTPClient provides an interface for suplying the SDK with a custom HTTP client.
# Type aliases
No description provided by the author