requester

Documentation

Overview

Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved

Index

• Constants
• func ValidateBaseUrl(baseUrl string) error
• type GraphQLError
  • func (e GraphQLError) Error() string
• type GraphQLInternalError
  • func (e GraphQLInternalError) Error() string
• type RequestError
  • func (e RequestError) Error() string
• type Requester
  • func NewRequester(apiTokenClientId string, apiTokenClientSecret string) *Requester
  • func NewRequesterWithBaseUrl(apiTokenClientId string, apiTokenClientSecret string, baseUrl *string) *Requester
  • func (r *Requester) ExecuteGraphql(query string, variables map[string]interface{}, signingKey SigningKey) (map[string]interface{}, error)
  • func (r *Requester) ExecuteGraphqlWithContext(ctx context.Context, query string, variables map[string]interface{}, ...) (map[string]interface{}, error)
• type RsaSigningKey
  • func (s *RsaSigningKey) Sign(payload []byte) ([]byte, error)
• type Secp256k1SigningKey
  • func (s *Secp256k1SigningKey) Sign(payload []byte) ([]byte, error)
• type SigningKey

Constants

const DEFAULT_BASE_URL = "https://api.lightspark.com/graphql/server/2023-09-13"

Functions

func ValidateBaseUrl

func ValidateBaseUrl(baseUrl string) error

Types

type GraphQLError

type GraphQLError struct {
	Message string
	Type    string
}

GraphQLError indicates the GraphQL request succeeded, but there's a user error. The request should not be retried, because the error is due to the user's input.

func (GraphQLError) Error

func (e GraphQLError) Error() string

type GraphQLInternalError

type GraphQLInternalError struct {
	Message string
}

GraphQLInternalError indicates there's a failure in the Lightspark API. It could be due to a bug on Ligthspark's side. The request can be retried, because the error might be transient.

func (GraphQLInternalError) Error

func (e GraphQLInternalError) Error() string

type RequestError

type RequestError struct {
	Message    string
	StatusCode int
}

RequestError indicates that a request to the Lightspark API failed. It could be due to a service outage or a network error. The request should be retried if RequestError is returned with server errors (500-599).

func (RequestError) Error

func (e RequestError) Error() string

type Requester

type Requester struct {
	ApiTokenClientId string

	ApiTokenClientSecret string

	BaseUrl *string

	HTTPClient *http.Client
}

func NewRequester

func NewRequester(apiTokenClientId string, apiTokenClientSecret string) *Requester

func NewRequesterWithBaseUrl

func NewRequesterWithBaseUrl(apiTokenClientId string, apiTokenClientSecret string, baseUrl *string) *Requester

func (*Requester) ExecuteGraphql

func (r *Requester) ExecuteGraphql(query string, variables map[string]interface{},
	signingKey SigningKey,
) (map[string]interface{}, error)

func (*Requester) ExecuteGraphqlWithContext

func (r *Requester) ExecuteGraphqlWithContext(ctx context.Context, query string, variables map[string]interface{},
	signingKey SigningKey,
) (map[string]interface{}, error)

type RsaSigningKey

type RsaSigningKey struct {
	PrivateKey []byte
}

func (*RsaSigningKey) Sign

func (s *RsaSigningKey) Sign(payload []byte) ([]byte, error)

type Secp256k1SigningKey

type Secp256k1SigningKey struct {
	PrivateKey []byte
}

func (*Secp256k1SigningKey) Sign

func (s *Secp256k1SigningKey) Sign(payload []byte) ([]byte, error)

type SigningKey

type SigningKey interface {
	Sign(payload []byte) ([]byte, error)
}