modulepackage
0.19.0
Repository: https://github.com/codatio/client-sdk-go.git
Documentation: pkg.go.dev
# README
Sync for Commerce
Embedded accounting integrations for POS and eCommerce platforms.
SDK Installation
go get github.com/codatio/client-sdk-go/synccommerce
SDK Example Usage
package main
import(
"context"
"log"
"github.com/codatio/client-sdk-go/synccommerce"
"github.com/codatio/client-sdk-go/synccommerce/pkg/models/shared"
)
func main() {
s := codatsynccommerce.New(
codatsynccommerce.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.CompanyManagement.CreateCompany(ctx, shared.CreateCompany{
Name: "Bob's Burgers",
})
if err != nil {
log.Fatal(err)
}
if res.Company != nil {
// handle response
}
}
Available Resources and Operations
CompanyManagement
- CreateCompany - Create Sync for Commerce company
- CreateConnection - Create connection
- ListCompanies - List companies
- ListConnections - List data connections
- UpdateConnection - Update data connection
Configuration
- GetConfiguration - Retrieve config preferences set for a company.
- SetConfiguration - Create or update configuration.
Integrations
- GetIntegrationBranding - Get branding for an integration
- ListIntegrations - List information on Codat's supported integrations
Sync
- GetSyncStatus - Get status for a company's syncs
- RequestSync - Sync new
- RequestSyncForDateRange - Sync range
SyncFlowPreferences
- GetConfigTextSyncFlow - Retrieve preferences for text fields on Sync Flow
- GetSyncFlowURL - Retrieve sync flow url
- GetVisibleAccounts - List visible accounts
- UpdateConfigTextSyncFlow - Update preferences for text fields on sync flow
- UpdateVisibleAccountsSyncFlow - Update the visible accounts on Sync Flow
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
CodatSyncCommerce - Sync for Commerce API: The API for Sync for Commerce.
# Interfaces
HTTPClient provides an interface for suplying the SDK with a custom HTTP client.
# Type aliases
No description provided by the author