http_client

Feb 5, 2024

Changes in this version

+ const DefaultEnableDynamicRateLimiting

+ const DefaultLogLevel

+ const DefaultMaxConcurrentRequests

+ const DefaultMaxRetryAttempts

+ const DefaultTokenBufferPeriod

+ const DefaultTotalRetryDuration

+ type AuthConfig struct

+ ClientID string

+ ClientSecret string

+ InstanceName string

+ OverrideBaseDomain string

+ Password string

+ Username string

+ func LoadAuthConfig(filename string) (*AuthConfig, error)

type Config

+ Auth AuthConfig

+ CustomTimeout time.Duration

+ InstanceName string

+ type PerformanceMetrics struct

+ TokenWaitTime time.Duration

+ TotalRateLimitErrors int64

+ TotalRequests int64

+ TotalResponseTime time.Duration

+ TotalRetries int64

Feb 1, 2024

Changes in this version

+ func ExtractErrorMessageFromHTML(htmlContent string) string

+ func IsNonRetryableError(resp *http.Response) bool

+ func IsRateLimitError(resp *http.Response) bool

+ func IsTransientError(resp *http.Response) bool

+ func ParseJSONErrorResponse(body []byte) (string, error)

+ func TranslateStatusCode(statusCode int) string

type Client

+ func (c *Client) HandleAPIError(resp *http.Response) error

Nov 19, 2023

Changes in this version

+ const DefaultBaseDomain

type Client

+ OverrideBaseDomain string

+ func (c *Client) GetBaseDomain() string

type ClientAuthConfig

+ OverrideBaseDomain string

Nov 10, 2023

Changes in this version

type Client

+ AuthMethod string

Nov 9, 2023

Changes in this version

+ func LoadUserConfig(filename string) error

+ type ConfigMap map[string]EndpointConfig

+ type EndpointConfig struct

+ Accept string

+ ContentType *string

+ type UnifiedJamfAPIHandler struct

+ func (u *UnifiedJamfAPIHandler) GetAcceptHeader() string

+ func (u *UnifiedJamfAPIHandler) GetContentTypeHeader(endpoint string) string

+ func (u *UnifiedJamfAPIHandler) MarshalMultipartRequest(fields map[string]string, files map[string]string) ([]byte, string, error)

+ func (u *UnifiedJamfAPIHandler) MarshalRequest(body interface{}, method string, endpoint string) ([]byte, error)

+ func (u *UnifiedJamfAPIHandler) SetLogger(logger Logger)

+ func (u *UnifiedJamfAPIHandler) UnmarshalResponse(resp *http.Response, out interface{}) error

Nov 7, 2023

Changes in this version

+ func GetUserAgentHeader() string

type APIHandler

+ GetContentTypeHeader func(method string) string

type ClassicApiHandler

+ func (h *ClassicApiHandler) GetContentTypeHeader(method string) string

type Config

+ LogLevel LogLevel

type JamfProApiHandler

+ func (h *JamfProApiHandler) GetContentTypeHeader(method string) string

+ type LogLevel int

+ const LogLevelDebug

+ const LogLevelInfo

+ const LogLevelNone

+ const LogLevelWarning

type Logger

+ SetLevel func(level LogLevel)

type UnknownApiHandler

+ func (h *UnknownApiHandler) GetContentTypeHeader(method string) string

Nov 5, 2023

Changes in this version

+ func MarshalMultipartFormData(fields map[string]string, files map[string]string) ([]byte, string, error)

type APIHandler

+ GetAcceptHeader func(url string) string

+ MarshalMultipartRequest func(fields map[string]string, files map[string]string) ([]byte, string, error)

type ClassicApiHandler

+ func (h *ClassicApiHandler) GetAcceptHeader(url string) string

+ func (h *ClassicApiHandler) MarshalMultipartRequest(fields map[string]string, files map[string]string) ([]byte, string, error)

type Client

+ func (c *Client) DoMultipartRequest(method, endpoint string, fields map[string]string, files map[string]string, ...) (*http.Response, error)

type JamfProApiHandler

+ func (h *JamfProApiHandler) GetAcceptHeader(url string) string

+ func (h *JamfProApiHandler) MarshalMultipartRequest(fields map[string]string, files map[string]string) ([]byte, string, error)

type UnknownApiHandler

+ func (h *UnknownApiHandler) GetAcceptHeader(url string) string

+ func (h *UnknownApiHandler) MarshalMultipartRequest(fields map[string]string, files map[string]string) ([]byte, string, error)

Oct 29, 2023

Changes in this version

type Client

+ func (c *Client) GetPerformanceMetrics() *ClientPerformanceMetrics

Oct 24, 2023

Changes in this version

type Client

+ func (c *Client) ConstructAPIAuthEndpoint(endpointPath string) string

+ func (c *Client) ConstructAPIResourceEndpoint(endpointPath string) string

Oct 24, 2023

Changes in this version

+ const EvaluationInterval

+ const MaxConcurrency

+ const MinConcurrency

+ func Min(a, b int) int

type Client

+ PerfMetrics ClientPerformanceMetrics

+ func (c *Client) AdjustConcurrencyBasedOnMetrics()

+ func (c *Client) AverageAcquisitionTime() time.Duration

+ func (c *Client) EvaluateMetricsAndAdjustConcurrency()

+ func (c *Client) HistoricalAverageAcquisitionTime() time.Duration

+ func (c *Client) StartConcurrencyAdjustment()

+ func (c *Client) StartMetricEvaluation()

+ type ClientPerformanceMetrics struct

+ TokenWaitTime time.Duration

+ TotalRateLimitErrors int64

+ TotalRequests int64

+ TotalResponseTime time.Duration

+ TotalRetries int64

type ConcurrencyManager

+ AcquisitionTimes []time.Duration

+ func (c *ConcurrencyManager) AdjustConcurrencyLimit(newLimit int)

+ func (c *ConcurrencyManager) AverageAcquisitionTime() time.Duration

+ func (c *ConcurrencyManager) HistoricalAverageAcquisitionTime() time.Duration

Oct 15, 2023

Changes in this version

type Client

+ BearerTokenAuthCredentials BearerTokenAuthCredentials

+ OAuthCredentials OAuthCredentials

type Config

+ TokenRefreshBufferPeriod time.Duration

Oct 14, 2023

Changes in this version

type Client

+ func (c *Client) GetBearerAuthCredentials() BearerTokenAuthCredentials

+ func (c *Client) GetOAuthCredentials() OAuthCredentials

Oct 11, 2023

Changes in this version

type Client

+ func (c *Client) SetAuthenticationCredentials(creds map[string]string)

Oct 9, 2023

Changes in this version

+ const BaseDomain

+ const BearerTokenEndpoint

+ const OAuthTokenEndpoint

+ const TokenInvalidateEndpoint

+ const TokenRefreshEndpoint

type Client

+ InstanceName string

type ClientAuthConfig

+ InstanceName string

Oct 3, 2023

Changes in this version

+ const DefaultTimeout

+ const SDKVersion

+ const UserAgentBase

+ func CheckDeprecationHeader(resp *http.Response, logger Logger)

+ func EnsureHTTPScheme(url string) string

+ func GetUserAgent() string

+ func ParseISO8601Date(dateStr string) (time.Time, error)

+ type APIError struct

+ Message string

+ StatusCode int

+ func (e *APIError) Error() string

+ type APIHandler interface

+ GetContentType func(method string) string

+ MarshalRequest func(body interface{}, method string) ([]byte, error)

+ SetDebugMode func(debug bool)

+ SetLogger func(logger Logger)

+ UnmarshalResponse func(resp *http.Response, out interface{}) error

+ func GetAPIHandler(endpoint string, debugMode bool) APIHandler

+ type BearerTokenAuthCredentials struct

+ Password string

+ Username string

+ type ClassicApiHandler struct

+ func (h *ClassicApiHandler) GetContentType(method string) string

+ func (h *ClassicApiHandler) MarshalRequest(body interface{}, method string) ([]byte, error)

+ func (h *ClassicApiHandler) SetDebugMode(debug bool)

+ func (h *ClassicApiHandler) SetLogger(logger Logger)

+ func (h *ClassicApiHandler) UnmarshalResponse(resp *http.Response, out interface{}) error

+ type Client struct

+ BaseURL string

+ ConcurrencyMgr *ConcurrencyManager

+ Expiry time.Time

+ Token string

+ func NewClient(baseURL string, config Config, logger Logger, options ...ClientOption) *Client

+ func (c *Client) Delete(endpoint string, out interface{}) (*http.Response, error)

+ func (c *Client) DoRequest(method, endpoint string, body, out interface{}) (*http.Response, error)

+ func (c *Client) Get(endpoint string, out interface{}) (*http.Response, error)

+ func (c *Client) InvalidateOAuthToken() error

+ func (c *Client) ObtainOAuthToken(credentials OAuthCredentials) error

+ func (c *Client) ObtainToken() error

+ func (c *Client) Patch(endpoint string, body, out interface{}) (*http.Response, error)

+ func (c *Client) Post(endpoint string, body, out interface{}) (*http.Response, error)

+ func (c *Client) Put(endpoint string, body, out interface{}) (*http.Response, error)

+ func (c *Client) RefreshOAuthToken() error

+ func (c *Client) RefreshToken() error

+ func (c *Client) SetBearerTokenAuthCredentials(credentials BearerTokenAuthCredentials)

+ func (c *Client) SetOAuthCredentials(credentials OAuthCredentials)

+ func (c *Client) ValidAuthTokenCheck() bool

+ type ClientAuthConfig struct

+ BaseURL string

+ ClientID string

+ ClientSecret string

+ Password string

+ Username string

+ func LoadClientAuthConfig(filename string) (*ClientAuthConfig, error)

+ type ClientOption func(*Client)

+ type ConcurrencyManager struct

+ func NewConcurrencyManager(limit int, logger Logger, debugMode bool) *ConcurrencyManager

+ func (c *ConcurrencyManager) Acquire(ctx context.Context) (uuid.UUID, error)

+ func (c *ConcurrencyManager) Release(requestID uuid.UUID)

+ type Config struct

+ BufferPeriod time.Duration

+ CustomBackoff func(attempt int) time.Duration

+ DebugMode bool

+ EnableDynamicRateLimiting bool

+ Logger Logger

+ MaxConcurrentRequests int

+ MaxRetryAttempts int

+ TokenLifespan time.Duration

+ TotalRetryDuration time.Duration

+ type JamfProApiHandler struct

+ func (h *JamfProApiHandler) GetContentType(method string) string

+ func (h *JamfProApiHandler) MarshalRequest(body interface{}, method string) ([]byte, error)

+ func (h *JamfProApiHandler) SetDebugMode(debug bool)

+ func (h *JamfProApiHandler) SetLogger(logger Logger)

+ func (h *JamfProApiHandler) UnmarshalResponse(resp *http.Response, out interface{}) error

+ type Logger interface

+ Debug func(msg string, keysAndValues ...interface{})

+ Error func(msg string, keysAndValues ...interface{})

+ Fatal func(msg string, keysAndValues ...interface{})

+ Info func(msg string, keysAndValues ...interface{})

+ Trace func(msg string, keysAndValues ...interface{})

+ Warn func(msg string, keysAndValues ...interface{})

+ func NewDefaultLogger() Logger

+ type OAuthCredentials struct

+ ClientID string

+ ClientSecret string

+ type OAuthResponse struct

+ AccessToken string

+ Error string

+ ExpiresIn int64

+ RefreshToken string

+ TokenType string

+ type StructuredError struct

+ Error struct{ ... }

+ type TokenResponse struct

+ Expires time.Time

+ Token string

+ type UnknownApiHandler struct

+ func (h *UnknownApiHandler) GetContentType(method string) string

+ func (h *UnknownApiHandler) MarshalRequest(body interface{}, method string) ([]byte, error)

+ func (h *UnknownApiHandler) SetDebugMode(debug bool)

+ func (h *UnknownApiHandler) SetLogger(logger Logger)

+ func (h *UnknownApiHandler) UnmarshalResponse(resp *http.Response, out interface{}) error