squadcastsdk.go

// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.

package squadcastsdk

// Generated from OpenAPI doc version 1.0.0 and generator version 2.926.8

import (
	"context"
	"fmt"
	"github.com/solarwinds/squadcast-sdk-go/internal/config"
	"github.com/solarwinds/squadcast-sdk-go/internal/hooks"
	"github.com/solarwinds/squadcast-sdk-go/internal/utils"
	"github.com/solarwinds/squadcast-sdk-go/models/components"
	"github.com/solarwinds/squadcast-sdk-go/retry"
	"net/http"
	"time"
)

// ServerList contains the list of servers available to the SDK
var ServerList = []string{
	// production US env
	"https://api.squadcast.com",
	// production EU env
	"https://api.eu.squadcast.com",
}

// HTTPClient provides an interface for supplying the SDK with a custom HTTP client
type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

// String provides a helper function to return a pointer to a string
func String(s string) *string { return &s }

// Bool provides a helper function to return a pointer to a bool
func Bool(b bool) *bool { return &b }

// Int provides a helper function to return a pointer to an int
func Int(i int) *int { return &i }

// Int64 provides a helper function to return a pointer to an int64
func Int64(i int64) *int64 { return &i }

// Float32 provides a helper function to return a pointer to a float32
func Float32(f float32) *float32 { return &f }

// Float64 provides a helper function to return a pointer to a float64
func Float64(f float64) *float64 { return &f }

// Pointer provides a helper function to return a pointer to a type
func Pointer[T any](v T) *T { return &v }

// SquadcastSDK - Squadcast: ## Overview
// The Squadcast API provides developers the capability to extend and utilize Squadcast in conjunction with other services. Our API has resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
//
// > **Note:** Customers using the V2 version of the Squadcast API would need to migrate to Squadcast API V3, as the former would be deprecated shortly.
//
// ### Service Regions
//
// Squadcast allows customers to choose the geographic region of the Squadcast data centers that host their account. When signing up, you can choose the service region. Currently, the available options are the United States (US) and Europe (EU).
//
// | Service Region | API Endpoints |
// |---|---|
// | US | Authentication: https://auth.squadcast.com · Other APIs: https://api.squadcast.com |
// | EU | Authentication: https://auth.eu.squadcast.com · Other APIs: https://api.eu.squadcast.com |
//
// ### Authentication
//
// In order to access the API programmatically, HTTP bearer authentication needs to be used. HTTP bearer authentication must be constructed using an `access_token`, passed as the `Authorization` header for each request, for example `Authorization: Bearer eyJleHAiOjE2MzU1OTE1OTIsImp0aSI6Im`.
//
// Steps to procure the `access_token`:
//
// 1. Generate a `refresh_token` (API Token) from the Squadcast web app. More details on how to get the `refresh_token` can be found in the Squadcast support documentation.
// 2. Call the authentication API with the `refresh_token` to obtain an `access_token`.
// 3. Use the `access_token` as a Bearer token in the `Authorization` header for all subsequent API requests.
//
// #### Example — Generating an Access Token
//
// ```bash
// curl --location --request GET 'https://auth.squadcast.com/oauth/access-token' \
// --header 'X-Refresh-Token: 0d2a1a9a454dxxxxxxxxxxxx'
// ```
//
// The API response will look similar to:
//
// ```json
//
//	{
//	  "data": {
//	    "access_token": "eyJhbGciOiJIUxxxxx.xxxxxxxxxxxxxxx.xxxxxxxxxxxxxxx",
//	    "expires_at": 1587412870,
//	    "issued_at": 1587240070,
//	    "refresh_token": "0d2a1a9a454dxxxxxxxxxxxx",
//	    "type": "bearer"
//	  }
//	}
//
// ```
//
// ### Access Control
//
// There are three different types of user roles in Squadcast: `account_owner`, `stakeholder`, and `user`. Refresh tokens upon creation are mapped with one of the mentioned user roles, and access to different resources is dependent on the permissions granted to these roles. For more information, please refer to the Squadcast support documentation.
//
// ### Authorization
//
// The access token authorizes users the ability to access different APIs, based on the user roles described above. Pass the access token as a Bearer token in the `Authorization` header of every request.
type SquadcastSDK struct {
	SDKVersion                    string
	Analytics                     *Analytics
	AuditLogs                     *AuditLogs
	EscalationPolicies            *EscalationPolicies
	Exports                       *Exports
	Webhooks                      *Webhooks
	Extensions                    *Extensions
	Msteams                       *Msteams
	CommunicationCards            *CommunicationCards
	GlobalEventRules              *GlobalEventRules
	GlobalEventRulesRulesets      *GlobalEventRulesRulesets
	GlobalEventRulesRulesetsRules *GlobalEventRulesRulesetsRules
	GlobalOncallReminderRules     *GlobalOncallReminderRules
	Incidents                     *Incidents
	Notes                         *Notes
	IncidentActions               *IncidentActions
	APITokens                     *APITokens
	Tokens                        *Tokens
	Users                         *Users
	Runbooks                      *Runbooks
	Services                      *Services
	Overlays                      *Overlays
	Slos                          *Slos
	Teams                         *Teams
	Webforms                      *Webforms
	Workflows                     *Workflows
	Schedules                     *Schedules
	Overrides                     *Overrides
	Rotations                     *Rotations
	Squads                        *Squads
	V4                            *V4
	StatusPages                   *StatusPages

	sdkConfiguration config.SDKConfiguration
	hooks            *hooks.Hooks
}

type SDKOption func(*SquadcastSDK)

// WithServerURL allows providing an alternative server URL
func WithServerURL(serverURL string) SDKOption {
	return func(sdk *SquadcastSDK) {
		sdk.sdkConfiguration.ServerURL = serverURL
	}
}

// WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters
func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption {
	return func(sdk *SquadcastSDK) {
		if params != nil {
			serverURL = utils.ReplaceParameters(serverURL, params)
		}

		sdk.sdkConfiguration.ServerURL = serverURL
	}
}

// WithServerIndex allows the overriding of the default server by index
func WithServerIndex(serverIndex int) SDKOption {
	return func(sdk *SquadcastSDK) {
		if serverIndex < 0 || serverIndex >= len(ServerList) {
			panic(fmt.Errorf("server index %d out of range", serverIndex))
		}

		sdk.sdkConfiguration.ServerIndex = serverIndex
	}
}

// WithClient allows the overriding of the default HTTP client used by the SDK
func WithClient(client HTTPClient) SDKOption {
	return func(sdk *SquadcastSDK) {
		sdk.sdkConfiguration.Client = client
	}
}

// WithSecurity configures the SDK to use the provided security details
func WithSecurity(refreshTokenAuth string) SDKOption {
	return func(sdk *SquadcastSDK) {
		security := components.Security{RefreshTokenAuth: &refreshTokenAuth}
		sdk.sdkConfiguration.Security = utils.AsSecuritySource(&security)
	}
}

// WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication
func WithSecuritySource(security func(context.Context) (components.Security, error)) SDKOption {
	return func(sdk *SquadcastSDK) {
		sdk.sdkConfiguration.Security = func(ctx context.Context) (interface{}, error) {
			return security(ctx)
		}
	}
}

func WithRetryConfig(retryConfig retry.Config) SDKOption {
	return func(sdk *SquadcastSDK) {
		sdk.sdkConfiguration.RetryConfig = &retryConfig
	}
}

// WithTimeout Optional request timeout applied to each operation
func WithTimeout(timeout time.Duration) SDKOption {
	return func(sdk *SquadcastSDK) {
		sdk.sdkConfiguration.Timeout = &timeout
	}
}

// New creates a new instance of the SDK with the provided options
func New(opts ...SDKOption) *SquadcastSDK {
	sdk := &SquadcastSDK{
		SDKVersion: "1.7.3",
		sdkConfiguration: config.SDKConfiguration{
			UserAgent:  "speakeasy-sdk/go 1.7.3 2.926.8 1.0.0 github.com/solarwinds/squadcast-sdk-go",
			ServerList: ServerList,
		},
		hooks: hooks.New(),
	}
	for _, opt := range opts {
		opt(sdk)
	}

	if sdk.sdkConfiguration.Security == nil {
		var envVarSecurity components.Security
		if utils.PopulateSecurityFromEnv(&envVarSecurity) {
			sdk.sdkConfiguration.Security = utils.AsSecuritySource(envVarSecurity)
		}
	}

	// Use WithClient to override the default client if you would like to customize the timeout
	if sdk.sdkConfiguration.Client == nil {
		sdk.sdkConfiguration.Client = &http.Client{Timeout: 60 * time.Second}
	}

	sdk.sdkConfiguration = sdk.hooks.SDKInit(sdk.sdkConfiguration)

	sdk.Analytics = newAnalytics(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.AuditLogs = newAuditLogs(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.EscalationPolicies = newEscalationPolicies(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Exports = newExports(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Webhooks = newWebhooks(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Extensions = newExtensions(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Msteams = newMsteams(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.CommunicationCards = newCommunicationCards(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.GlobalEventRules = newGlobalEventRules(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.GlobalEventRulesRulesets = newGlobalEventRulesRulesets(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.GlobalEventRulesRulesetsRules = newGlobalEventRulesRulesetsRules(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.GlobalOncallReminderRules = newGlobalOncallReminderRules(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Incidents = newIncidents(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Notes = newNotes(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.IncidentActions = newIncidentActions(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.APITokens = newAPITokens(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Tokens = newTokens(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Users = newUsers(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Runbooks = newRunbooks(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Services = newServices(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Overlays = newOverlays(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Slos = newSlos(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Teams = newTeams(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Webforms = newWebforms(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Workflows = newWorkflows(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Schedules = newSchedules(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Overrides = newOverrides(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Rotations = newRotations(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Squads = newSquads(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.V4 = newV4(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.StatusPages = newStatusPages(sdk, sdk.sdkConfiguration, sdk.hooks)

	return sdk
}