testboltapi

package module
v0.16.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 2, 2024 License: MIT Imports: 13 Imported by: 0

README

github.com/speakeasy-sdks/Test_Bolt_API

SDK Installation

go get github.com/speakeasy-sdks/Test_Bolt_API

SDK Example Usage

Example
package main

import (
	"context"
	testboltapi "github.com/speakeasy-sdks/Test_Bolt_API"
	"github.com/speakeasy-sdks/Test_Bolt_API/pkg/models/operations"
	"github.com/speakeasy-sdks/Test_Bolt_API/pkg/models/shared"
	"log"
)

func main() {
	s := testboltapi.New(
		testboltapi.WithSecurity(shared.Security{
			APIKey: testboltapi.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.Account.AddAddress(ctx, operations.AccountAddressCreateRequest{
		XPublishableKey: "<value>",
		AddressListing: shared.AddressListingInput{
			Company:        testboltapi.String("ACME Corporation"),
			CountryCode:    shared.CountryCodeUs,
			Email:          testboltapi.String("alice@example.com"),
			FirstName:      "Alice",
			IsDefault:      testboltapi.Bool(true),
			LastName:       "Baker",
			Locality:       "San Francisco",
			Phone:          testboltapi.String("+14155550199"),
			PostalCode:     "94105",
			Region:         testboltapi.String("CA"),
			StreetAddress1: "535 Mission St, Ste 1401",
			StreetAddress2: testboltapi.String("c/o Shipping Department"),
		},
	})
	if err != nil {
		log.Fatal(err)
	}

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

Available Resources and Operations

Account
Payments.Guest
  • Initialize - Initialize a Bolt payment for guest shoppers
  • PerformAction - Perform an irreversible action (e.g. finalize) on a pending guest payment
  • Update - Update an existing guest payment
Payments.LoggedIn
  • Initialize - Initialize a Bolt payment for logged in shoppers
  • PerformAction - Perform an irreversible action (e.g. finalize) on a pending payment
  • Update - Update an existing payment
OAuth
Testing

Special Types

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. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.

Error Object Status Code Content Type
sdkerrors.AccountAddressCreateResponseBody 4XX application/json
sdkerrors.SDKError 4xx-5xx /
Example
package main

import (
	"context"
	"errors"
	testboltapi "github.com/speakeasy-sdks/Test_Bolt_API"
	"github.com/speakeasy-sdks/Test_Bolt_API/pkg/models/operations"
	"github.com/speakeasy-sdks/Test_Bolt_API/pkg/models/sdkerrors"
	"github.com/speakeasy-sdks/Test_Bolt_API/pkg/models/shared"
	"log"
)

func main() {
	s := testboltapi.New(
		testboltapi.WithSecurity(shared.Security{
			APIKey: testboltapi.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.Account.AddAddress(ctx, operations.AccountAddressCreateRequest{
		XPublishableKey: "<value>",
		AddressListing: shared.AddressListingInput{
			Company:        testboltapi.String("ACME Corporation"),
			CountryCode:    shared.CountryCodeUs,
			Email:          testboltapi.String("alice@example.com"),
			FirstName:      "Alice",
			IsDefault:      testboltapi.Bool(true),
			LastName:       "Baker",
			Locality:       "San Francisco",
			Phone:          testboltapi.String("+14155550199"),
			PostalCode:     "94105",
			Region:         testboltapi.String("CA"),
			StreetAddress1: "535 Mission St, Ste 1401",
			StreetAddress2: testboltapi.String("c/o Shipping Department"),
		},
	})
	if err != nil {

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

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

Server Selection

Select Server by Index

You can override the default server globally using the WithServerIndex option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Variables
0 https://{environment}.bolt.com/v3 environment (default is api-sandbox)
Example
package main

import (
	"context"
	testboltapi "github.com/speakeasy-sdks/Test_Bolt_API"
	"github.com/speakeasy-sdks/Test_Bolt_API/pkg/models/operations"
	"github.com/speakeasy-sdks/Test_Bolt_API/pkg/models/shared"
	"log"
)

func main() {
	s := testboltapi.New(
		testboltapi.WithServerIndex(0),
		testboltapi.WithSecurity(shared.Security{
			APIKey: testboltapi.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.Account.AddAddress(ctx, operations.AccountAddressCreateRequest{
		XPublishableKey: "<value>",
		AddressListing: shared.AddressListingInput{
			Company:        testboltapi.String("ACME Corporation"),
			CountryCode:    shared.CountryCodeUs,
			Email:          testboltapi.String("alice@example.com"),
			FirstName:      "Alice",
			IsDefault:      testboltapi.Bool(true),
			LastName:       "Baker",
			Locality:       "San Francisco",
			Phone:          testboltapi.String("+14155550199"),
			PostalCode:     "94105",
			Region:         testboltapi.String("CA"),
			StreetAddress1: "535 Mission St, Ste 1401",
			StreetAddress2: testboltapi.String("c/o Shipping Department"),
		},
	})
	if err != nil {
		log.Fatal(err)
	}

	if res.AddressListing != nil {
		// handle response
	}
}
Variables

Some of the server options above contain variables. If you want to set the values of those variables, the following options are provided for doing so:

  • WithEnvironment testboltapi.ServerEnvironment
Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL option when initializing the SDK client instance. For example:

package main

import (
	"context"
	testboltapi "github.com/speakeasy-sdks/Test_Bolt_API"
	"github.com/speakeasy-sdks/Test_Bolt_API/pkg/models/operations"
	"github.com/speakeasy-sdks/Test_Bolt_API/pkg/models/shared"
	"log"
)

func main() {
	s := testboltapi.New(
		testboltapi.WithServerURL("https://{environment}.bolt.com/v3"),
		testboltapi.WithSecurity(shared.Security{
			APIKey: testboltapi.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.Account.AddAddress(ctx, operations.AccountAddressCreateRequest{
		XPublishableKey: "<value>",
		AddressListing: shared.AddressListingInput{
			Company:        testboltapi.String("ACME Corporation"),
			CountryCode:    shared.CountryCodeUs,
			Email:          testboltapi.String("alice@example.com"),
			FirstName:      "Alice",
			IsDefault:      testboltapi.Bool(true),
			LastName:       "Baker",
			Locality:       "San Francisco",
			Phone:          testboltapi.String("+14155550199"),
			PostalCode:     "94105",
			Region:         testboltapi.String("CA"),
			StreetAddress1: "535 Mission St, Ste 1401",
			StreetAddress2: testboltapi.String("c/o Shipping Department"),
		},
	})
	if err != nil {
		log.Fatal(err)
	}

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

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/myorg/your-go-sdk"
)

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

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

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name Type Scheme
APIKey apiKey API key
Oauth oauth2 OAuth2 token

You can set the security parameters through the WithSecurity option when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

package main

import (
	"context"
	testboltapi "github.com/speakeasy-sdks/Test_Bolt_API"
	"github.com/speakeasy-sdks/Test_Bolt_API/pkg/models/operations"
	"github.com/speakeasy-sdks/Test_Bolt_API/pkg/models/shared"
	"log"
)

func main() {
	s := testboltapi.New(
		testboltapi.WithSecurity(shared.Security{
			APIKey: testboltapi.String("<YOUR_API_KEY_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.Account.AddAddress(ctx, operations.AccountAddressCreateRequest{
		XPublishableKey: "<value>",
		AddressListing: shared.AddressListingInput{
			Company:        testboltapi.String("ACME Corporation"),
			CountryCode:    shared.CountryCodeUs,
			Email:          testboltapi.String("alice@example.com"),
			FirstName:      "Alice",
			IsDefault:      testboltapi.Bool(true),
			LastName:       "Baker",
			Locality:       "San Francisco",
			Phone:          testboltapi.String("+14155550199"),
			PostalCode:     "94105",
			Region:         testboltapi.String("CA"),
			StreetAddress1: "535 Mission St, Ste 1401",
			StreetAddress2: testboltapi.String("c/o Shipping Department"),
		},
	})
	if err != nil {
		log.Fatal(err)
	}

	if res.AddressListing != nil {
		// handle response
	}
}
Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

package main

import (
	"context"
	testboltapi "github.com/speakeasy-sdks/Test_Bolt_API"
	"github.com/speakeasy-sdks/Test_Bolt_API/pkg/models/operations"
	"github.com/speakeasy-sdks/Test_Bolt_API/pkg/models/shared"
	"log"
)

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

	operationSecurity := operations.GuestPaymentsInitializeSecurity{
		APIKey: "<YOUR_API_KEY_HERE>",
	}

	ctx := context.Background()
	res, err := s.Payments.Guest.Initialize(ctx, operations.GuestPaymentsInitializeRequest{
		XPublishableKey: "<value>",
		GuestPaymentInitializeRequest: shared.GuestPaymentInitializeRequest{
			Cart: shared.Cart{
				DisplayID:        testboltapi.String("215614191"),
				OrderDescription: testboltapi.String("Order #1234567890"),
				OrderReference:   "order_100",
				Tax: shared.Amount{
					Currency: shared.CurrencyUsd,
					Units:    900,
				},
				Total: shared.Amount{
					Currency: shared.CurrencyUsd,
					Units:    900,
				},
			},
			PaymentMethod: shared.CreatePaymentMethodPaymentMethodCreditCard(
				shared.PaymentMethodCreditCard{
					DotTag: shared.PaymentMethodCreditCardTagCreditCard,
					BillingAddress: shared.CreateAddressReferenceSchemasInput(
						shared.SchemasInput{
							DotTag:         shared.SchemasTagExplicit,
							Company:        testboltapi.String("ACME Corporation"),
							CountryCode:    shared.SchemasCountryCodeUs,
							Email:          testboltapi.String("alice@example.com"),
							FirstName:      "Alice",
							LastName:       "Baker",
							Locality:       "San Francisco",
							Phone:          testboltapi.String("+14155550199"),
							PostalCode:     "94105",
							Region:         testboltapi.String("CA"),
							StreetAddress1: "535 Mission St, Ste 1401",
							StreetAddress2: testboltapi.String("c/o Shipping Department"),
						},
					),
					Bin:        "411111",
					Expiration: "2029-03",
					Last4:      "1004",
					Network:    shared.NetworkVisa,
					Token:      "a1B2c3D4e5F6G7H8i9J0k1L2m3N4o5P6Q7r8S9t0",
				},
			),
			Profile: shared.ProfileCreationData{
				CreateAccount: true,
				Email:         "alice@example.com",
				FirstName:     "Alice",
				LastName:      "Baker",
				Phone:         testboltapi.String("+14155550199"),
			},
		},
	}, operationSecurity)
	if err != nil {
		log.Fatal(err)
	}

	if res.PaymentResponse != nil {
		// handle response
	}
}
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

Constants

This section is empty.

Variables

View Source 
var ServerList = []string{
	"https://{environment}.bolt.com/v3",
}

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 Account added in v0.8.0 

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

Account endpoints allow you to view and manage shoppers' accounts. For example, you can add or remove addresses and payment information.

func (*Account) AddAddress added in v0.8.0 

func (s *Account) AddAddress(ctx context.Context, request operations.AccountAddressCreateRequest) (*operations.AccountAddressCreateResponse, error)

AddAddress - Add an address Add an address to the shopper's account

func (*Account) AddPaymentMethod added in v0.8.0 

func (s *Account) AddPaymentMethod(ctx context.Context, request operations.AccountAddPaymentMethodRequest) (*operations.AccountAddPaymentMethodResponse, error)

AddPaymentMethod - Add a payment method to a shopper's Bolt account Wallet. Add a payment method to a shopper's Bolt account Wallet. For security purposes, this request must come from your backend because authentication requires the use of your private key.<br /> **Note**: Before using this API, the credit card details must be tokenized using Bolt's JavaScript library function, which is documented in [Install the Bolt Tokenizer](https://help.bolt.com/developers/references/bolt-tokenizer).

func (*Account) DeleteAddress added in v0.8.0 

func (s *Account) DeleteAddress(ctx context.Context, request operations.AccountAddressDeleteRequest) (*operations.AccountAddressDeleteResponse, error)

DeleteAddress - Delete an existing address Delete an existing address. Deleting an address does not invalidate transactions or shipments that are associated with it.

func (*Account) DeletePaymentMethod added in v0.8.0 

func (s *Account) DeletePaymentMethod(ctx context.Context, request operations.AccountPaymentMethodDeleteRequest) (*operations.AccountPaymentMethodDeleteResponse, error)

DeletePaymentMethod - Delete an existing payment method Delete an existing payment method. Deleting a payment method does not invalidate transactions or orders that are associated with it.

func (*Account) Detect added in v0.8.0 

func (s *Account) Detect(ctx context.Context, request operations.AccountExistsRequest) (*operations.AccountExistsResponse, error)

Detect - Determine the existence of a Bolt account Determine whether or not an identifier is associated with an existing Bolt account.

func (*Account) GetDetails added in v0.8.0 

func (s *Account) GetDetails(ctx context.Context, request operations.AccountGetRequest) (*operations.AccountGetResponse, error)

GetDetails - Retrieve account details Retrieve a shopper's account details, such as addresses and payment information

func (*Account) UpdateAddress added in v0.8.0 

func (s *Account) UpdateAddress(ctx context.Context, request operations.AccountAddressEditRequest) (*operations.AccountAddressEditResponse, error)

UpdateAddress - Edit an existing address Edit an existing address on the shopper's account. This does not edit addresses that are already associated with other resources, such as transactions or shipments.

type Guest added in v0.8.0 

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

func (*Guest) Initialize added in v0.8.0 

func (s *Guest) Initialize(ctx context.Context, request operations.GuestPaymentsInitializeRequest, security operations.GuestPaymentsInitializeSecurity) (*operations.GuestPaymentsInitializeResponse, error)

Initialize a Bolt payment for guest shoppers Initialize a Bolt payment token that will be used to reference this payment to Bolt when it is updated or finalized for guest shoppers.

func (*Guest) PerformAction added in v0.8.0 

func (s *Guest) PerformAction(ctx context.Context, request operations.GuestPaymentsActionRequest, security operations.GuestPaymentsActionSecurity) (*operations.GuestPaymentsActionResponse, error)

PerformAction - Perform an irreversible action (e.g. finalize) on a pending guest payment Perform an irreversible action on a pending guest payment, such as finalizing it.

func (*Guest) Update added in v0.8.0 

func (s *Guest) Update(ctx context.Context, request operations.GuestPaymentsUpdateRequest, security operations.GuestPaymentsUpdateSecurity) (*operations.GuestPaymentsUpdateResponse, error)

Update an existing guest payment Update a pending guest payment

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 LoggedIn added in v0.8.0 

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

func (*LoggedIn) Initialize added in v0.8.0 

func (s *LoggedIn) Initialize(ctx context.Context, request operations.PaymentsInitializeRequest) (*operations.PaymentsInitializeResponse, error)

Initialize a Bolt payment for logged in shoppers Initialize a Bolt payment token that will be used to reference this payment to Bolt when it is updated or finalized for logged in shoppers.

func (*LoggedIn) PerformAction added in v0.8.0 

func (s *LoggedIn) PerformAction(ctx context.Context, request operations.PaymentsActionRequest) (*operations.PaymentsActionResponse, error)

PerformAction - Perform an irreversible action (e.g. finalize) on a pending payment Perform an irreversible action on a pending payment, such as finalizing it.

func (*LoggedIn) Update added in v0.8.0 

func (s *LoggedIn) Update(ctx context.Context, request operations.PaymentsUpdateRequest) (*operations.PaymentsUpdateResponse, error)

Update an existing payment Update a pending payment

type OAuth added in v0.8.3 

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

OAuth - Use this endpoint to retrieve an OAuth token. Use the token to allow your ecommerce server to make calls to the Account endpoint and create a one-click checkout experience for shoppers.

https://help.bolt.com/products/accounts/direct-api/oauth-guide/

func (*OAuth) GetToken added in v0.8.3 

func (s *OAuth) GetToken(ctx context.Context, request shared.GetAccessTokenRequest) (*operations.OauthGetTokenResponse, error)

GetToken - Get OAuth token Retrieve a new or refresh an existing OAuth token.

type Payments added in v0.8.0 

type Payments struct {
	Guest    *Guest
	LoggedIn *LoggedIn
	// contains filtered or unexported fields
}

type SDKOption 

type SDKOption func(*TestBolt)

func WithClient 

func WithClient(client HTTPClient) SDKOption

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

func WithEnvironment 

func WithEnvironment(environment ServerEnvironment) SDKOption

WithEnvironment allows setting the environment variable for url substitution

func WithRetryConfig added in v0.4.0 

func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption

func WithSecurity added in v0.6.0 

func WithSecurity(security shared.Security) SDKOption

WithSecurity configures the SDK to use the provided security details

func WithSecuritySource added in v0.6.0 

func WithSecuritySource(security func(context.Context) (shared.Security, error)) SDKOption

WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication

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

type ServerEnvironment 

type ServerEnvironment string
const (
	ServerEnvironmentAPI        ServerEnvironment = "api"
	ServerEnvironmentAPISandbox ServerEnvironment = "api-sandbox"
)

func (ServerEnvironment) ToPointer 

func (e ServerEnvironment) ToPointer() *ServerEnvironment

func (*ServerEnvironment) UnmarshalJSON 

func (e *ServerEnvironment) UnmarshalJSON(data []byte) error

type TestBolt 

type TestBolt struct {
	// Account endpoints allow you to view and manage shoppers' accounts. For example,
	// you can add or remove addresses and payment information.
	//
	Account  *Account
	Payments *Payments
	// Use this endpoint to retrieve an OAuth token. Use the token to allow your ecommerce server to make calls to the Account
	// endpoint and create a one-click checkout experience for shoppers.
	//
	//
	// https://help.bolt.com/products/accounts/direct-api/oauth-guide/
	OAuth *OAuth
	// Endpoints that allow you to generate and retrieve test data to verify certain
	// flows in non-production environments.
	//
	Testing *Testing
	// contains filtered or unexported fields
}

TestBolt - Bolt API Reference: A comprehensive Bolt API reference for interacting with Transactions, Orders, Product Catalog, Configuration, Testing, and much more.

func New 

func New(opts ...SDKOption) *TestBolt

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

type Testing added in v0.8.0 

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

Testing - Endpoints that allow you to generate and retrieve test data to verify certain flows in non-production environments.

func (*Testing) CreateAccount added in v0.8.0 

func (s *Testing) CreateAccount(ctx context.Context, request operations.TestingAccountCreateRequest, security operations.TestingAccountCreateSecurity) (*operations.TestingAccountCreateResponse, error)

CreateAccount - Create a test account Create a Bolt shopper account for testing purposes.

func (*Testing) GetCreditCard added in v0.8.0 

func (s *Testing) GetCreditCard(ctx context.Context, security operations.TestingCreditCardGetSecurity) (*operations.TestingCreditCardGetResponse, error)

GetCreditCard - Retrieve a test credit card, including its token Retrieve test credit card information. This includes its token, which is generated against the `4111 1111 1111 1004` test card.

Source Files

View all Source files

Directories

Path Synopsis
internal
hooks
pkg
models/operations
models/sdkerrors
models/shared
types
utils

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.