form3

Documentation

Index

• Constants
• func NewRequestSigningHTTPClient(config *RequestSigningClientConfig) *http.Client
• func NewTokenBasedHttpClient(config *TokenBasedClientConfig) *http.Client
• type ClientDefaults
  • func NewClientDefaults() *ClientDefaults
  • func (*ClientDefaults) GetBool(objectName, attributeName string) bool
  • func (*ClientDefaults) GetBoolPtr(objectName, attributeName string) *bool
  • func (*ClientDefaults) GetInt32(objectName, attributeName string) int32
  • func (*ClientDefaults) GetInt64(objectName, attributeName string) int64
  • func (*ClientDefaults) GetInt64Ptr(objectName, attributeName string) *int64
  • func (*ClientDefaults) GetStrfmtDate(objectName, attributeName string) strfmt.Date
  • func (*ClientDefaults) GetStrfmtDatePtr(objectName, attributeName string) *strfmt.Date
  • func (*ClientDefaults) GetStrfmtDateTime(objectName, attributeName string) strfmt.DateTime
  • func (*ClientDefaults) GetStrfmtDateTimePtr(objectName, attributeName string) *strfmt.DateTime
  • func (*ClientDefaults) GetStrfmtURI(objectName, attributeName string) strfmt.URI
  • func (*ClientDefaults) GetStrfmtURIPtr(objectName, attributeName string) *strfmt.URI
  • func (*ClientDefaults) GetStrfmtUUID(objectName, attributeName string) strfmt.UUID
  • func (d *ClientDefaults) GetStrfmtUUIDPtr(objectName, attributeName string) *strfmt.UUID
  • func (*ClientDefaults) GetString(objectName, attributeName string) string
  • func (*ClientDefaults) GetStringArray(objectName, attributeName string) []string
  • func (*ClientDefaults) GetStringPtr(objectName, attributeName string) *string
• type F3
  • func New(host, pubKeyID string, privateKey *rsa.PrivateKey, orgID string) *F3
  • func NewFromEnv() *F3
  • func NewWithTokenBasedAuth(host, clientID, secret, orgID string) *F3
  • func NewWithTokenBasedAuthFromEnv() *F3
• type RequestSigningClientConfig
  • func NewRequestSigningClientConfig(pubKeyID string, privateKey *rsa.PrivateKey) *RequestSigningClientConfig
  • func (c *RequestSigningClientConfig) WithUnderlyingTransport(underlyingTransport http.RoundTripper) *RequestSigningClientConfig
• type TokenBasedClientConfig
  • func NewTokenBasedClientConfig(clientId, clientSecret string, hostUrl *url.URL) *TokenBasedClientConfig
  • func (c *TokenBasedClientConfig) WithUnderlyingTransport(underlyingTransport http.RoundTripper) *TokenBasedClientConfig
  • func (c *TokenBasedClientConfig) WithinitialToken(token string) *TokenBasedClientConfig

Constants

const (
	ReqMimeType = "application/vnd.api+json"
)

Functions

func NewRequestSigningHTTPClient

func NewRequestSigningHTTPClient(config *RequestSigningClientConfig) *http.Client

func NewTokenBasedHttpClient

func NewTokenBasedHttpClient(config *TokenBasedClientConfig) *http.Client

Types

type ClientDefaults

type ClientDefaults struct {
	OrganisationId *strfmt.UUID
}

func NewClientDefaults

func NewClientDefaults() *ClientDefaults

func (*ClientDefaults) GetBool

func (*ClientDefaults) GetBool(objectName, attributeName string) bool

func (*ClientDefaults) GetBoolPtr

func (*ClientDefaults) GetBoolPtr(objectName, attributeName string) *bool

func (*ClientDefaults) GetInt32

func (*ClientDefaults) GetInt32(objectName, attributeName string) int32

func (*ClientDefaults) GetInt64

func (*ClientDefaults) GetInt64(objectName, attributeName string) int64

func (*ClientDefaults) GetInt64Ptr

func (*ClientDefaults) GetInt64Ptr(objectName, attributeName string) *int64

func (*ClientDefaults) GetStrfmtDate

func (*ClientDefaults) GetStrfmtDate(objectName, attributeName string) strfmt.Date

func (*ClientDefaults) GetStrfmtDatePtr

func (*ClientDefaults) GetStrfmtDatePtr(objectName, attributeName string) *strfmt.Date

func (*ClientDefaults) GetStrfmtDateTime

func (*ClientDefaults) GetStrfmtDateTime(objectName, attributeName string) strfmt.DateTime

func (*ClientDefaults) GetStrfmtDateTimePtr

func (*ClientDefaults) GetStrfmtDateTimePtr(objectName, attributeName string) *strfmt.DateTime

func (*ClientDefaults) GetStrfmtURI

func (*ClientDefaults) GetStrfmtURI(objectName, attributeName string) strfmt.URI

func (*ClientDefaults) GetStrfmtURIPtr

func (*ClientDefaults) GetStrfmtURIPtr(objectName, attributeName string) *strfmt.URI

func (*ClientDefaults) GetStrfmtUUID

func (*ClientDefaults) GetStrfmtUUID(objectName, attributeName string) strfmt.UUID

func (*ClientDefaults) GetStrfmtUUIDPtr

func (d *ClientDefaults) GetStrfmtUUIDPtr(objectName, attributeName string) *strfmt.UUID

func (*ClientDefaults) GetString

func (*ClientDefaults) GetString(objectName, attributeName string) string

func (*ClientDefaults) GetStringArray

func (*ClientDefaults) GetStringArray(objectName, attributeName string) []string

func (*ClientDefaults) GetStringPtr

func (*ClientDefaults) GetStringPtr(objectName, attributeName string) *string

type F3

type F3 struct {
	genClient.Form3Public
	Defaults *ClientDefaults
}

func New

func New(host, pubKeyID string, privateKey *rsa.PrivateKey, orgID string) *F3

func NewFromEnv

func NewFromEnv() *F3

func NewWithTokenBasedAuth

func NewWithTokenBasedAuth(host, clientID, secret, orgID string) *F3

func NewWithTokenBasedAuthFromEnv

func NewWithTokenBasedAuthFromEnv() *F3

type RequestSigningClientConfig

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

func NewRequestSigningClientConfig

func NewRequestSigningClientConfig(pubKeyID string, privateKey *rsa.PrivateKey) *RequestSigningClientConfig

func (*RequestSigningClientConfig) WithUnderlyingTransport

func (c *RequestSigningClientConfig) WithUnderlyingTransport(underlyingTransport http.RoundTripper) *RequestSigningClientConfig

type TokenBasedClientConfig

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

func NewTokenBasedClientConfig

func NewTokenBasedClientConfig(clientId, clientSecret string, hostUrl *url.URL) *TokenBasedClientConfig

func (*TokenBasedClientConfig) WithUnderlyingTransport

func (c *TokenBasedClientConfig) WithUnderlyingTransport(underlyingTransport http.RoundTripper) *TokenBasedClientConfig

func (*TokenBasedClientConfig) WithinitialToken

func (c *TokenBasedClientConfig) WithinitialToken(token string) *TokenBasedClientConfig