saclient

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

type ClientAPI interface {
	// Populate settings from environment variables and flags
	//
	// Note that once populated, the settings gets immutable.
	// Also note that first call to [Do] implicityly implies population,
	// means you cannot change settings afterwards.
	Populate() error

	// A copy without population.  You can modify settings and repopulate.
	Dup() ClientAPI

	// “`golang
	//
	//	import (
	//		"os"
	//
	//	   "github.com/sacloud/saclient-go"
	//	)
	//
	//	var client saclient.Client
	//
	//	func main() {
	//		client.SetEnviron(os.Environ())
	//		client.Populate()
	//		// ...
	//	}
	// “`
	SetEnviron(env []string) error

	// “`golang
	//
	//	import (
	//		"context"
	//		"os"
	//
	//		"github.com/hashicorp/terraform-plugin-framework/provider"
	//		"github.com/sacloud/saclient-go"
	//	)
	//
	//	type providerModel struct {
	//		// ...
	//	}
	//
	//	var _ saclient.TerraformProviderInterface = (*providerModel)(nil)
	//
	//	func (p *provider) Configure(ctx context.Context, req provider.ConfigureRequest, resp *provider.ConfigureResponse) {
	//		var config providerModel
	//		var client saclient.Client
	//		diags := req.Config.Get(ctx, &config)
	//		resp.Diagnostics.Append(diags...)
	//		if resp.Diagnostics.HasError() {
	//			return
	//		}
	//
	//		client.SetEnviron(os.Environ())
	//		client.SettingsFromTerraformProvider(&config)
	//		client.Populate()
	//	}
	// “`
	SettingsFromTerraformProvider(config TerraformProviderInterface) error

	// Deprecated: This method does not cover all settings.
	//
	// “`golang
	//
	//	import (
	//		old "github.com/sacloud/saclient-go"
	//		current "github.com/sacloud/saclient-go"
	//	)
	//
	//	var client current.Client
	//
	//	func main() {
	//		client.CompatSettingsFromAPIClientParams(
	//			"https://secure.sakura.ad.jp/...",
	//			old.WithApiKeys("your-token", "your-secret"),
	//			// ...
	//		)
	//		client.Populate()
	//		// ...
	//	}
	// “`
	CompatSettingsFromAPIClientParams(url string, params ...old.ClientParam) error

	// Deprecated: This method does not cover all settings.
	//
	// “`golang
	//
	//	import (
	//		old "github.com/sacloud/saclient-go"
	//		current "github.com/sacloud/saclient-go"
	//	)
	//
	//	var client current.Client
	//
	//	func main() {
	//		client.CompatSettingsFromAPIClientOptions(&old.Options{
	//			AccessToken: "your-token",
	//			AccessTokenSecret: "your-secret",
	//			// ...
	//		})
	//		client.Populate()
	//		// ...
	//	}
	// “`
	CompatSettingsFromAPIClientOptions(opts ...*old.Options) error

	// Deprecated: This is a compatibility layer.  Many aspects are missing here,
	// for instance this does not return error.
	ServerURL() string

	// “`golang
	//
	//	import (
	//	   "github.com/spf13/cobra"
	//	   "github.com/spf13/pflag"
	//	   "github.com/sacloud/saclient-go"
	//	)
	//
	//	var client saclient.Client
	//	var command = &cobra.Command{
	//	    RunE: func(cmd *cobra.Command, args []string) error {
	//	        if err := client.Populate(); err != nil {
	//	            return err
	//	        }
	//	        // ...
	//	        return nil
	//	    },
	//	}
	//
	//	func init() {
	//	   client.SetEnviron(os.Environ())
	//	   command.PersistentFlags().AddGoFlagSet(client.FlagSet(flag.PanicOnError))
	//	}
	// “`
	FlagSet(eh flag.ErrorHandling) *flag.FlagSet

	// Returns the currently selected profile, or nil if absent.
	// Profile historically includes much more than client configuration,
	// like usacloud's ArgumentMatchMode.
	//
	// Note that it's completely normal to have nil here.
	// The user can just opt not to have profiles at all.
	// (typical situation for CI environments etc.)
	Profile() (*Profile, error)

	// _Calculated_ name of the current profile.
	//
	// On normal situations this is identical to Profile().Name.  But
	// there are cases when the specified profile does not exist, or
	// is broken.  This method returns something, regardless of such
	// situations.
	//
	// Note however that this can still return nil, in case there is
	// no profile specified at all.
	ProfileName() (dir, name *string)

	// CRUD-style API operator for Profile resource
	ProfileOp() (ProfileAPI, error)

	// HTTP request doer
	Do(req *http.Request) (*http.Response, error)

	// EndpointConfig returns the resolved endpoint configuration.
	// This contains service-specific base endpoints, zone information,
	// and other configuration needed for SDKs to assemble final API URLs.
	EndpointConfig() (*EndpointConfig, error)
}

type ClientOptionAPI interface {
	// destructive application of argument options
	SetWith(...clientOption) error

	// duplicative application of argument options;
	// use it when the receiver is already populated (or unknown)
	DupWith(...clientOption) (ClientAPI, error)
}

type EndpointConfig struct {
	// Endpoints is the primary information for API routing.
	// The map key identifies a service (e.g. "iaas", "iam") and the value is its base endpoint.
	//
	// saclient-go treats service keys as opaque identifiers.
	// Keys are not interpreted or validated by this package.
	// Their meaning is defined by each SDK.
	Endpoints map[string]string

	// Zone is the currently selected zone.
	Zone string

	// Zones lists all permitted zones.
	//
	// Deprecated: Do not use. Kept only for compatibility.
	Zones []string

	// APIRootURL is the base URL used by iaas-api-go.
	//
	// Deprecated: Do not use. Kept only for compatibility.
	APIRootURL string
}

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

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

type Middleware func(*http.Request, func() (Middleware, bool)) (*http.Response, error)

type Profile struct {

	// Name (intuitive)
	Name string

	// Profile contents
	//
	// This is intentionally untyped to allow arbitrary key/values
	Attributes map[string]any
	// contains filtered or unexported fields
}

type ProfileAPI interface {
	// List the currently known names of profiles
	List() ([]string, error)

	// Load one of profiles, by name
	Read(name string) (*Profile, error)

	// Create a new profile
	Create(profile *Profile) error

	// Update (merge) an existing profile, updated contents returned
	Update(profile *Profile) (*Profile, error)

	// Delete an existing profile
	Delete(name string) error

	// Get the default profile
	GetCurrentName() (string, error)

	// Set the default profile
	SetCurrentName(name string) error

	// The directory where profiles are stored
	Dir() string
}

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

type TerraformProviderInterface interface {
	LookupClientConfigProfileName() (string, bool)

	// Returns if a Service Principal ID is set, and its value
	// (this ID is unformatted)
	LookupClientConfigServicePrincipalID() (string, bool)

	// Returns if a Service Principal Key ID is set, and its value
	// (this ID is unformatted)
	LookupClientConfigServicePrincipalKeyID() (string, bool)

	// Returns if a Service Principal BYOK Private Key's path is set, and its value
	LookupClientConfigPrivateKeyPath() (string, bool)

	// Returns if an API key is set, and its value
	LookupClientConfigAccessToken() (string, bool)

	// Returns if an API secret is set, and its value
	LookupClientConfigAccessTokenSecret() (string, bool)

	// Returns if the IaaS target zone is set, and its value
	LookupClientConfigZone() (string, bool)

	// Returns if the "Default" zone is set, and its value.
	LookupClientConfigDefaultZone() (string, bool)

	// Returns if the available zones are set, and their values
	LookupClientConfigZones() ([]string, bool)

	// Returns if the max number of retries is set, and its value
	LookupClientConfigRetryMax() (int64, bool)

	// Returns if the seconds to wait between retries is set, and its value
	LookupClientConfigRetryWaitMax() (int64, bool)

	// Returns if the seconds to wait between retries is set, and its value
	LookupClientConfigRetryWaitMin() (int64, bool)

	// Returns if the API root URL is set, and its value
	LookupClientConfigAPIRootURL() (string, bool)

	// Returns if the API request timeout (in seconds) is set, and its value
	LookupClientConfigAPIRequestTimeout() (int64, bool)

	// Returns if the API request rate limit (requests per second) is set, and its value
	LookupClientConfigAPIRequestRateLimit() (int64, bool)

	// Returns the mysterious "trace" mode value, if set
	LookupClientConfigTraceMode() (string, bool)
}