settings20

Documentation

Index

• Variables
• func CreateRequiresOAuth(response Response) bool
• func IsSuccess(resp *http.Response) bool
• func RequestInfo(request *http.Request) rest.RequestInfo
• func Service[T settings.Settings](credentials *settings.Credentials, schemaID string, schemaVersion string, ...) settings.CRUDService[T]
• func UpdateRequiresOAuth(response Response) bool
• type Client
  • func NewClient(tokenClient *rest.Client, oAuthClient *rest.Client, schemaID string, ...) *Client
  • func (c Client) Create(ctx context.Context, scope string, data []byte) (Response, error)
  • func (c Client) Delete(ctx context.Context, id string) (Response, error)
  • func (c Client) Get(ctx context.Context, id string) (Response, error)
  • func (c Client) List(ctx context.Context) (Response, error)
  • func (c Client) Update(ctx context.Context, id string, data []byte) (Response, error)
• type Config
• type Matcher
• type Option
  • func WithUpdateRetrySettings(maxRetries int, waitDuration time.Duration) Option
• type Response
• type ServiceOptions
• type SettingsObject
• type SettingsObjectCreate
• type SettingsObjectCreateResponse
• type SettingsObjectList
• type SettingsObjectListItem
• type SettingsObjectResponse
  • func (sor SettingsObjectResponse) RequiresOAuth() bool
• type SettingsObjectUpdate

Variables

var NO_REPAIR_INPUT = os.Getenv("DT_NO_REPAIR_INPUT") == "true"

Functions

func CreateRequiresOAuth

func CreateRequiresOAuth(response Response) bool

func IsSuccess

func IsSuccess(resp *http.Response) bool

IsSuccess returns true if the response indicates a successful HTTP status code. A status code between 200 and 299 (inclusive) is considered a success.

func RequestInfo

func RequestInfo(request *http.Request) rest.RequestInfo

func Service

func Service[T settings.Settings](credentials *settings.Credentials, schemaID string, schemaVersion string, options ...*ServiceOptions[T]) settings.CRUDService[T]

func UpdateRequiresOAuth

func UpdateRequiresOAuth(response Response) bool

Types

type Client

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

func NewClient

func NewClient(tokenClient *rest.Client, oAuthClient *rest.Client, schemaID string, option ...Option) *Client

func (Client) Create

func (c Client) Create(ctx context.Context, scope string, data []byte) (Response, error)

func (Client) Delete

func (c Client) Delete(ctx context.Context, id string) (Response, error)

func (Client) Get

func (c Client) Get(ctx context.Context, id string) (Response, error)

func (Client) List

func (c Client) List(ctx context.Context) (Response, error)

func (Client) Update

func (c Client) Update(ctx context.Context, id string, data []byte) (Response, error)

type Config

type Config interface {
	New() settings.Settings
}

type Matcher

type Matcher interface {
	Match(o any) bool
}

type Option

type Option func(*Client)

Option represents a functional Option for the Client.

func WithUpdateRetrySettings

func WithUpdateRetrySettings(maxRetries int, waitDuration time.Duration) Option

WithUpdateRetrySettings sets the maximum number of retries as well as duration between retries for Update HTTP requests

type Response

type Response struct {
	api.Response
	ID    string
	Items []struct {
		ID    string          `json:"objectId"`
		Scope string          `json:"scope"`
		Value json.RawMessage `json:"value"`
	}
}

type ServiceOptions

type ServiceOptions[T settings.Settings] struct {
	LegacyID       func(id string) string
	Name           func(id string, v T) (string, error)
	HijackOnCreate func(err error, service settings.RService[T], v T) (*api.Stub, error)
	CreateRetry    func(v T, err error) T
	UpdateRetry    func(v T, err error) T
	Duplicates     func(service settings.RService[T], v T) (*api.Stub, error)
}

type SettingsObject

type SettingsObject struct {
	SchemaVersion string          `json:"schemaVersion"`
	SchemaID      string          `json:"schemaId"`
	Scope         string          `json:"scope"`
	Value         json.RawMessage `json:"value"`
}

type SettingsObjectCreate

type SettingsObjectCreate struct {
	SchemaVersion string `json:"schemaVersion,omitempty"`
	SchemaID      string `json:"schemaId"`
	Scope         string `json:"scope,omitempty"`
	Value         any    `json:"value"`
	InsertAfter   string `json:"insertAfter,omitempty"`
}

type SettingsObjectCreateResponse

type SettingsObjectCreateResponse struct {
	ObjectID string `json:"objectId"`
}

type SettingsObjectList

type SettingsObjectList struct {
	Items       []*SettingsObjectListItem `json:"items"`
	NextPageKey *string                   `json:"nextPageKey,omitempty"`
}

type SettingsObjectListItem

type SettingsObjectListItem struct {
	ObjectID      string          `json:"objectId"`
	Scope         string          `json:"scope"`
	SchemaVersion string          `json:"schemaVersion"`
	Value         json.RawMessage `json:"value"`
}

type SettingsObjectResponse

type SettingsObjectResponse struct {
	Code  int `json:"code"`
	Error struct {
		Code    int    `json:"code"`
		Message string `json:"message"`
	} `json:"error"`
}

func (SettingsObjectResponse) RequiresOAuth

func (sor SettingsObjectResponse) RequiresOAuth() bool

type SettingsObjectUpdate

type SettingsObjectUpdate struct {
	SchemaVersion string `json:"schemaVersion,omitempty"`
	Value         any    `json:"value"`
	InsertAfter   string `json:"insertAfter,omitempty"`
}