Documentation
¶
Index ¶
Constants ¶
View Source
const (
BaseURL = "https://api.hubapi.com"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Configuration ¶
type Configuration struct {
APIKey string // API key for authentication
AccessToken string // Access token for authentication
DeveloperAPIKey string // Developer API key
BasePath string // Base URL for API requests
DefaultHeaders map[string]string // Default headers for requests
NumberOfAPICallRetries int // API call retry count
LimiterOptions *LimiterOptions // Rate limiter configuration
LimiterJobOptions *LimiterJobOptions // Per-job rate limiter options
HTTPAgent *http.Transport // HTTP transport agent
}
Configuration struct holds all settings required for API requests.
func NewConfiguration ¶
func NewConfiguration( apiKey, accessToken, developerAPIKey, basePath string, defaultHeaders map[string]string, retries int, limiterOptions *LimiterOptions, jobOptions *LimiterJobOptions, httpAgent *http.Transport, ) *Configuration
NewConfiguration creates a new Configuration.
type LimiterJobOptions ¶
LimiterJobOptions represents options for individual jobs within the rate limiter.
type LimiterOptions ¶
type LimiterOptions struct {
MaxConcurrent int // Maximum concurrent jobs
MinTime time.Duration // Minimum time between each job
Reservoir int // Initial tokens in the reservoir
ReservoirRefreshInterval time.Duration // Interval to refresh reservoir tokens
ReservoirRefreshAmount int // Tokens added on each refresh
}
LimiterOptions represents the configuration options for a rate limiter.
Click to show internal directories.
Click to hide internal directories.