Skip to content

flexprice/go-sdk-temp

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
docs
docs
 
 
examples
examples
 
 
internal
internal
 
 
models
models
 
 
optionalnullable
optionalnullable
 
 
retry
retry
 
 
speakeasyusagegen/.speakeasy/logs
speakeasyusagegen/.speakeasy/logs
 
 
types
types
 
 
CONTRIBUTING.md
CONTRIBUTING.md
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
USAGE.md
USAGE.md
 
 
addons.go
addons.go
 
 
alertlogs.go
alertlogs.go
 
 
async.go
async.go
 
 
auth.go
auth.go
 
 
connections.go
connections.go
 
 
costs.go
costs.go
 
 
coupons.go
coupons.go
 
 
creditgrants.go
creditgrants.go
 
 
creditnotes.go
creditnotes.go
 
 
customerportal.go
customerportal.go
 
 
customers.go
customers.go
 
 
entitlements.go
entitlements.go
 
 
entityintegrationmappings.go
entityintegrationmappings.go
 
 
environments.go
environments.go
 
 
events.go
events.go
 
 
features.go
features.go
 
 
flexprice.go
flexprice.go
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 
groups.go
groups.go
 
 
helpers.go
helpers.go
 
 
integrations.go
integrations.go
 
 
invoices.go
invoices.go
 
 
payments.go
payments.go
 
 
plans.go
plans.go
 
 
prices.go
prices.go
 
 
priceunits.go
priceunits.go
 
 
rbac.go
rbac.go
 
 
scheduledtasks.go
scheduledtasks.go
 
 
secrets.go
secrets.go
 
 
subscriptions.go
subscriptions.go
 
 
tasks.go
tasks.go
 
 
taxassociations.go
taxassociations.go
 
 
taxrates.go
taxrates.go
 
 
tenants.go
tenants.go
 
 
users.go
users.go
 
 
wallets.go
wallets.go
 
 
webhooks.go
webhooks.go
 
 

Repository files navigation

gosdktemp

Developer-friendly & type-safe Go SDK specifically catered to leverage gosdktemp API.

Built by Speakeasy License: MIT



Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

FlexPrice API: FlexPrice API Service

Table of Contents

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/flexprice/go-sdk-temp

SDK Example Usage

Example

package main

import (
	"context"
	gosdktemp "github.com/flexprice/go-sdk-temp"
	"github.com/flexprice/go-sdk-temp/models/operations"
	"log"
)

func main() {
	ctx := context.Background()

	s := gosdktemp.New(
		"https://api.example.com",
		gosdktemp.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	res, err := s.Addons.GetAddons(ctx, operations.GetAddonsRequest{})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
APIKeyAuth apiKey API key

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

package main

import (
	"context"
	gosdktemp "github.com/flexprice/go-sdk-temp"
	"github.com/flexprice/go-sdk-temp/models/operations"
	"log"
)

func main() {
	ctx := context.Background()

	s := gosdktemp.New(
		"https://api.example.com",
		gosdktemp.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	res, err := s.Addons.GetAddons(ctx, operations.GetAddonsRequest{})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

Addons

AlertLogs

Auth

Connections

Costs

Coupons

CreditNotes

CreditGrants

CustomerPortal

Customers

Entitlements

EntityIntegrationMappings

Environments

Events

Features

Groups

Integrations

Invoices

Payments

Plans

PriceUnits

Prices

Rbac

ScheduledTasks

Secrets

Subscriptions

Tasks

TaxAssociations

TaxRates

Tenants

Users

Wallets

Webhooks

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"
	gosdktemp "github.com/flexprice/go-sdk-temp"
	"github.com/flexprice/go-sdk-temp/models/operations"
	"github.com/flexprice/go-sdk-temp/retry"
	"log"
	"models/operations"
)

func main() {
	ctx := context.Background()

	s := gosdktemp.New(
		"https://api.example.com",
		gosdktemp.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	res, err := s.Addons.GetAddons(ctx, operations.GetAddonsRequest{}, 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 != 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"
	gosdktemp "github.com/flexprice/go-sdk-temp"
	"github.com/flexprice/go-sdk-temp/models/operations"
	"github.com/flexprice/go-sdk-temp/retry"
	"log"
)

func main() {
	ctx := context.Background()

	s := gosdktemp.New(
		"https://api.example.com",
		gosdktemp.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		gosdktemp.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	res, err := s.Addons.GetAddons(ctx, operations.GetAddonsRequest{})
	if err != nil {
		log.Fatal(err)
	}
	if res != 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.

By Default, an API error will return sdkerrors.APIError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.

For example, the GetAddons function may return the following errors:

Error Type Status Code Content Type
sdkerrors.ErrorsErrorResponse 400 application/json
sdkerrors.ErrorsErrorResponse 500 application/json
sdkerrors.APIError 4XX, 5XX */*

Example

package main

import (
	"context"
	"errors"
	gosdktemp "github.com/flexprice/go-sdk-temp"
	"github.com/flexprice/go-sdk-temp/models/operations"
	"github.com/flexprice/go-sdk-temp/models/sdkerrors"
	"log"
)

func main() {
	ctx := context.Background()

	s := gosdktemp.New(
		"https://api.example.com",
		gosdktemp.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	res, err := s.Addons.GetAddons(ctx, operations.GetAddonsRequest{})
	if err != nil {

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

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

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

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/flexprice/go-sdk-temp"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = gosdktemp.New(gosdktemp.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

About

temp

Resources

Readme

License

AGPL-3.0 license

Contributing

Contributing
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

26 tags

Packages

No packages published

Languages