testgo

README

github.com/speakeasy-sdks/test-go

SDK Installation

go get github.com/speakeasy-sdks/test-go

SDK Example Usage

package main

import (
	"context"
	testgo "github.com/speakeasy-sdks/test-go"
	"github.com/speakeasy-sdks/test-go/pkg/models/shared"
	"log"
)

func main() {
	s := testgo.New()

	ctx := context.Background()
	res, err := s.AcmeGo.CreateUserv1(ctx, shared.UserInput{
		Country:   "Benin",
		Email:     "Della67@yahoo.com",
		Firstname: "Enrique",
		Lastname:  "Ernser",
		Nickname:  "string",
		Password:  "TOXx1B29WwlhtAA",
	})
	if err != nil {
		log.Fatal(err)
	}

	if res.User != nil {
		// handle response
	}
}

Available Resources and Operations

AcmeGo SDK

• CreateUserv1 - Create user
• DeleteUserv1 - Delete a user by ID
• GetHealth - Healthcheck
• GetUserv1 - Get a user by ID
• SearchUsersv1 - Search users
• UpdateUserv1

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is nil, then there are no more pages to be fetched.

Here's an example of one such pagination call:

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. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy

Documentation

Index

• Variables
• func Bool(b bool) *bool
• func Float32(f float32) *float32
• func Float64(f float64) *float64
• func Int(i int) *int
• func Int64(i int64) *int64
• func String(s string) *string
• type AcmeGo
  • func New(opts ...SDKOption) *AcmeGo
  • func (s *AcmeGo) CreateUserv1(ctx context.Context, request shared.UserInput) (*operations.CreateUserv1Response, error)
  • func (s *AcmeGo) DeleteUserv1(ctx context.Context, request operations.DeleteUserv1Request) (*operations.DeleteUserv1Response, error)
  • func (s *AcmeGo) GetHealth(ctx context.Context) (*operations.GetHealthResponse, error)
  • func (s *AcmeGo) GetUserv1(ctx context.Context, request operations.GetUserv1Request) (*operations.GetUserv1Response, error)
  • func (s *AcmeGo) SearchUsersv1(ctx context.Context, request shared.Filters) (*operations.SearchUsersv1Response, error)
  • func (s *AcmeGo) UpdateUserv1(ctx context.Context, request operations.UpdateUserv1Request) (*operations.UpdateUserv1Response, error)
• type HTTPClient
• type SDKOption
  • func WithClient(client HTTPClient) SDKOption
  • func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption
  • func WithServerIndex(serverIndex int) SDKOption
  • func WithServerURL(serverURL string) SDKOption
  • func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

Variables

var ServerList = []string{
	"http://localhost:8080",
}

ServerList contains the list of servers available to the SDK

Functions

func Bool

func Bool(b bool) *bool

Bool provides a helper function to return a pointer to a bool

func Float32

func Float32(f float32) *float32

Float32 provides a helper function to return a pointer to a float32

func Float64

func Float64(f float64) *float64

Float64 provides a helper function to return a pointer to a float64

func Int

func Int(i int) *int

Int provides a helper function to return a pointer to an int

func Int64

func Int64(i int64) *int64

Int64 provides a helper function to return a pointer to an int64

func String

func String(s string) *string

String provides a helper function to return a pointer to a string

Types

type AcmeGo

type AcmeGo struct {
	// contains filtered or unexported fields
}

AcmeGo - User API for Speakeasy template service: The Rest Template API is an API used for instrucitonal purposes.

func New

func New(opts ...SDKOption) *AcmeGo

New creates a new instance of the SDK with the provided options

func (*AcmeGo) CreateUserv1

func (s *AcmeGo) CreateUserv1(ctx context.Context, request shared.UserInput) (*operations.CreateUserv1Response, error)

CreateUserv1 - Create user

func (*AcmeGo) DeleteUserv1

func (s *AcmeGo) DeleteUserv1(ctx context.Context, request operations.DeleteUserv1Request) (*operations.DeleteUserv1Response, error)

DeleteUserv1 - Delete a user by ID

func (*AcmeGo) GetHealth

func (s *AcmeGo) GetHealth(ctx context.Context) (*operations.GetHealthResponse, error)

GetHealth - Healthcheck

func (*AcmeGo) GetUserv1

func (s *AcmeGo) GetUserv1(ctx context.Context, request operations.GetUserv1Request) (*operations.GetUserv1Response, error)

GetUserv1 - Get a user by ID

func (*AcmeGo) SearchUsersv1

func (s *AcmeGo) SearchUsersv1(ctx context.Context, request shared.Filters) (*operations.SearchUsersv1Response, error)

SearchUsersv1 - Search users

func (*AcmeGo) UpdateUserv1

func (s *AcmeGo) UpdateUserv1(ctx context.Context, request operations.UpdateUserv1Request) (*operations.UpdateUserv1Response, error)

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

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

type SDKOption

type SDKOption func(*AcmeGo)

func WithClient

func WithClient(client HTTPClient) SDKOption

WithClient allows the overriding of the default HTTP client used by the SDK

func WithRetryConfig

func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption

func WithServerIndex

func WithServerIndex(serverIndex int) SDKOption

WithServerIndex allows the overriding of the default server by index

func WithServerURL

func WithServerURL(serverURL string) SDKOption

WithServerURL allows the overriding of the default server URL

func WithTemplatedServerURL

func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters