hathoracloud.go

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

package hathoracloud

import (
	"context"
	"fmt"
	"github.com/hathora/cloud-sdk-go/internal/globals"
	"github.com/hathora/cloud-sdk-go/internal/hooks"
	"github.com/hathora/cloud-sdk-go/internal/utils"
	"github.com/hathora/cloud-sdk-go/models/components"
	"github.com/hathora/cloud-sdk-go/retry"
	"net/http"
	"time"
)

// ServerList contains the list of servers available to the SDK
var ServerList = []string{
	"https://api.hathora.dev",
	"https:///",
}

// HTTPClient provides an interface for suplying 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 }

type sdkConfiguration struct {
	Client            HTTPClient
	Security          func(context.Context) (interface{}, error)
	ServerURL         string
	ServerIndex       int
	Language          string
	OpenAPIDocVersion string
	SDKVersion        string
	GenVersion        string
	UserAgent         string
	Globals           globals.Globals
	RetryConfig       *retry.Config
	Hooks             *hooks.Hooks
	Timeout           *time.Duration
}

func (c *sdkConfiguration) GetServerDetails() (string, map[string]string) {
	if c.ServerURL != "" {
		return c.ServerURL, nil
	}

	return ServerList[c.ServerIndex], nil
}

// HathoraCloud - Hathora Cloud API: Welcome to the Hathora Cloud API documentation! Learn how to use the Hathora Cloud APIs to build and scale your game servers globally.
type HathoraCloud struct {
	//
	TokensV1 *TokensV1
	RoomsV1  *RoomsV1
	RoomsV2  *RoomsV2
	// Deprecated. Use [ProcessesV3](https://hathora.dev/api#tag/ProcessesV3).
	ProcessesV1 *ProcessesV1
	// Deprecated. Use [ProcessesV3](https://hathora.dev/api#tag/ProcessesV3).
	ProcessesV2 *ProcessesV2
	// Operations to get data on active and stopped [processes](https://hathora.dev/docs/concepts/hathora-entities#process).
	ProcessesV3     *ProcessesV3
	OrganizationsV1 *OrganizationsV1
	// Operations to get metrics by [process](https://hathora.dev/docs/concepts/hathora-entities#process). We store 72 hours of metrics data.
	MetricsV1 *MetricsV1
	//
	ManagementV1 *ManagementV1
	LogsV1       *LogsV1
	LobbiesV1    *LobbiesV1
	LobbiesV2    *LobbiesV2
	LobbiesV3    *LobbiesV3
	// Operations to manage and view a [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet).
	FleetsV1 *FleetsV1
	// Deprecated. Does not include latest Regions (missing Dallas region). Use [DiscoveryV2](https://hathora.dev/api#tag/DiscoveryV2).
	DiscoveryV1 *DiscoveryV1
	// Service that allows clients to directly ping all Hathora regions to get latency information
	DiscoveryV2   *DiscoveryV2
	DeploymentsV1 *DeploymentsV1
	DeploymentsV2 *DeploymentsV2
	// Operations that allow you configure and manage an application's [build](https://hathora.dev/docs/concepts/hathora-entities#build) at runtime.
	DeploymentsV3 *DeploymentsV3
	BuildsV1      *BuildsV1
	BuildsV2      *BuildsV2
	// Operations that allow you create and manage your [builds](https://hathora.dev/docs/concepts/hathora-entities#build).
	BuildsV3 *BuildsV3
	//
	BillingV1 *BillingV1
	// Operations that allow you to generate a Hathora-signed [JSON web token (JWT)](https://jwt.io/) for [player authentication](https://hathora.dev/docs/lobbies-and-matchmaking/auth-service).
	AuthV1 *AuthV1
	AppsV1 *AppsV1
	// Operations that allow you manage your [applications](https://hathora.dev/docs/concepts/hathora-entities#application).
	AppsV2 *AppsV2

	sdkConfiguration sdkConfiguration
}

type SDKOption func(*HathoraCloud)

// WithServerURL allows the overriding of the default server URL
func WithServerURL(serverURL string) SDKOption {
	return func(sdk *HathoraCloud) {
		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 *HathoraCloud) {
		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 *HathoraCloud) {
		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 *HathoraCloud) {
		sdk.sdkConfiguration.Client = client
	}
}

// WithSecurity configures the SDK to use the provided security details
func WithSecurity(hathoraDevToken string) SDKOption {
	return func(sdk *HathoraCloud) {
		security := components.Security{HathoraDevToken: &hathoraDevToken}
		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 *HathoraCloud) {
		sdk.sdkConfiguration.Security = func(ctx context.Context) (interface{}, error) {
			return security(ctx)
		}
	}
}

// WithOrgID allows setting the OrgID parameter for all supported operations
func WithOrgID(orgID string) SDKOption {
	return func(sdk *HathoraCloud) {
		sdk.sdkConfiguration.Globals.OrgID = &orgID
	}
}

// WithAppID allows setting the AppID parameter for all supported operations
func WithAppID(appID string) SDKOption {
	return func(sdk *HathoraCloud) {
		sdk.sdkConfiguration.Globals.AppID = &appID
	}
}

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

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

// New creates a new instance of the SDK with the provided options
func New(opts ...SDKOption) *HathoraCloud {
	sdk := &HathoraCloud{
		sdkConfiguration: sdkConfiguration{
			Language:          "go",
			OpenAPIDocVersion: "0.0.1",
			SDKVersion:        "0.2.1",
			GenVersion:        "2.480.1",
			UserAgent:         "speakeasy-sdk/go 0.2.1 2.480.1 0.0.1 hathoracloud",
			Globals:           globals.Globals{},
			Hooks:             hooks.New(),
		},
	}
	for _, opt := range opts {
		opt(sdk)
	}

	// 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}
	}

	currentServerURL, _ := sdk.sdkConfiguration.GetServerDetails()
	serverURL := currentServerURL
	serverURL, sdk.sdkConfiguration.Client = sdk.sdkConfiguration.Hooks.SDKInit(currentServerURL, sdk.sdkConfiguration.Client)
	if serverURL != currentServerURL {
		sdk.sdkConfiguration.ServerURL = serverURL
	}

	sdk.TokensV1 = newTokensV1(sdk.sdkConfiguration)

	sdk.RoomsV1 = newRoomsV1(sdk.sdkConfiguration)

	sdk.RoomsV2 = newRoomsV2(sdk.sdkConfiguration)

	sdk.ProcessesV1 = newProcessesV1(sdk.sdkConfiguration)

	sdk.ProcessesV2 = newProcessesV2(sdk.sdkConfiguration)

	sdk.ProcessesV3 = newProcessesV3(sdk.sdkConfiguration)

	sdk.OrganizationsV1 = newOrganizationsV1(sdk.sdkConfiguration)

	sdk.MetricsV1 = newMetricsV1(sdk.sdkConfiguration)

	sdk.ManagementV1 = newManagementV1(sdk.sdkConfiguration)

	sdk.LogsV1 = newLogsV1(sdk.sdkConfiguration)

	sdk.LobbiesV1 = newLobbiesV1(sdk.sdkConfiguration)

	sdk.LobbiesV2 = newLobbiesV2(sdk.sdkConfiguration)

	sdk.LobbiesV3 = newLobbiesV3(sdk.sdkConfiguration)

	sdk.FleetsV1 = newFleetsV1(sdk.sdkConfiguration)

	sdk.DiscoveryV1 = newDiscoveryV1(sdk.sdkConfiguration)

	sdk.DiscoveryV2 = newDiscoveryV2(sdk.sdkConfiguration)

	sdk.DeploymentsV1 = newDeploymentsV1(sdk.sdkConfiguration)

	sdk.DeploymentsV2 = newDeploymentsV2(sdk.sdkConfiguration)

	sdk.DeploymentsV3 = newDeploymentsV3(sdk.sdkConfiguration)

	sdk.BuildsV1 = newBuildsV1(sdk.sdkConfiguration)

	sdk.BuildsV2 = newBuildsV2(sdk.sdkConfiguration)

	sdk.BuildsV3 = newBuildsV3(sdk.sdkConfiguration)

	sdk.BillingV1 = newBillingV1(sdk.sdkConfiguration)

	sdk.AuthV1 = newAuthV1(sdk.sdkConfiguration)

	sdk.AppsV1 = newAppsV1(sdk.sdkConfiguration)

	sdk.AppsV2 = newAppsV2(sdk.sdkConfiguration)

	return sdk
}