client

package
v0.7.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 28, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package client provides a server-side Platform93 machine client.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Administration added in v0.6.0

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

func (*Administration) AssignRole added in v0.6.0

func (a *Administration) AssignRole(ctx context.Context, in ManagedRoleAssignment, etag, key string) (UserRoleAssignment, error)

func (*Administration) ChangeUserState added in v0.6.0

func (a *Administration) ChangeUserState(ctx context.Context, id, action, reason, etag, key string) error

func (*Administration) CreateInvitation added in v0.6.0

func (a *Administration) CreateInvitation(ctx context.Context, in CreateInvitation, key string) (InvitationDelivery, error)

func (*Administration) CreateUser added in v0.6.0

func (a *Administration) CreateUser(ctx context.Context, in ManagedUserCreate, key string) (User, error)

func (*Administration) GetInvitation added in v0.6.0

func (a *Administration) GetInvitation(ctx context.Context, id string) (Invitation, error)

func (*Administration) GetUser added in v0.6.0

func (a *Administration) GetUser(ctx context.Context, id string) (User, error)

func (*Administration) ListAssignments added in v0.6.0

func (a *Administration) ListAssignments(ctx context.Context, user string, options ...AdministrationSearch) (Page[UserRoleAssignment], error)

func (*Administration) ListInvitations added in v0.6.0

func (a *Administration) ListInvitations(ctx context.Context, options ...AdministrationSearch) (Page[Invitation], error)

func (*Administration) ListRoles added in v0.6.0

func (a *Administration) ListRoles(ctx context.Context, options ...AdministrationSearch) (Page[ApplicationRole], error)

func (*Administration) ListSessions added in v0.6.0

func (a *Administration) ListSessions(ctx context.Context, id string, options ...AdministrationSearch) (Page[UserSession], error)

func (*Administration) ListUsers added in v0.6.0

func (a *Administration) ListUsers(ctx context.Context, search, cursor string, limit int) (Page[User], error)

func (*Administration) RemoveRole added in v0.6.0

func (a *Administration) RemoveRole(ctx context.Context, id, reason, etag string) error

func (*Administration) RevokeInvitation added in v0.6.0

func (a *Administration) RevokeInvitation(ctx context.Context, id, reason, etag string) error

func (*Administration) RotateInvitation added in v0.6.0

func (a *Administration) RotateInvitation(ctx context.Context, id string, in RotateInvitation, etag, key string) (InvitationDelivery, error)

func (*Administration) UpdateAttributes added in v0.6.0

func (a *Administration) UpdateAttributes(ctx context.Context, id string, in ManagedAttributes, etag string) error

func (*Administration) UpdateUser added in v0.6.0

func (a *Administration) UpdateUser(ctx context.Context, id string, in ManagedUserUpdate, etag string) error

type AdministrationSearch added in v0.6.0

type AdministrationSearch struct {
	Query  string
	Cursor string
	Limit  int
}

type ApplicationRole added in v0.6.0

type ApplicationRole struct {
	ID          string   `json:"id"`
	Key         string   `json:"key"`
	Name        string   `json:"name"`
	Scope       string   `json:"scope"`
	Permissions []string `json:"permissions"`
}

type Attachment

type Attachment struct {
	Filename      string `json:"filename"`
	ContentType   string `json:"content_type"`
	ContentBase64 string `json:"content_base64"`
}

type BillingProfile

type BillingProfile struct {
	ID               string  `json:"id"`
	SubjectType      string  `json:"subject_type"`
	SubjectID        string  `json:"subject_id"`
	Name             *string `json:"name"`
	Email            *string `json:"email"`
	TaxID            *string `json:"tax_id"`
	DefaultAddressID *string `json:"default_address_id"`
	Version          int64   `json:"version"`
}

type BillingSummary

type BillingSummary struct {
	SubjectType    string          `json:"subject_type"`
	SubjectID      string          `json:"subject_id"`
	BillingProfile *BillingProfile `json:"billing_profile"`
	Subscriptions  []Subscription  `json:"subscriptions"`
}

type Client

type Client struct {
	BaseURL       string
	ApplicationID string
	ClientID      string
	ClientSecret  string
	Scopes        []string
	HTTPClient    *http.Client
	// AccessToken forwards an application-user session without machine credentials.
	AccessToken func(context.Context) (string, error)
	// contains filtered or unexported fields
}

func (*Client) Administration added in v0.6.0

func (c *Client) Administration() *Administration

func (*Client) CheckResourceAccess added in v0.5.0

func (c *Client) CheckResourceAccess(ctx context.Context, input ResourceAccessCheckRequest) (ResourceAccessCheckResponse, error)

func (*Client) CreateInvitation

func (c *Client) CreateInvitation(ctx context.Context, input CreateInvitation, idempotencyKey string) (InvitationDelivery, error)

func (*Client) GetInvitation

func (c *Client) GetInvitation(ctx context.Context, id string) (Invitation, error)

func (*Client) GetUser

func (c *Client) GetUser(ctx context.Context, id string) (User, error)

func (*Client) GetWorkspace

func (c *Client) GetWorkspace(ctx context.Context, id string) (Workspace, error)

func (*Client) GetWorkspaceAccess

func (c *Client) GetWorkspaceAccess(ctx context.Context, id string) (Page[WorkspaceAccess], error)

func (*Client) ListInvitations

func (c *Client) ListInvitations(ctx context.Context, options ...AdministrationSearch) (Page[Invitation], error)

func (*Client) ListUsers

func (c *Client) ListUsers(ctx context.Context) (Page[User], error)

func (*Client) ListWorkspaces

func (c *Client) ListWorkspaces(ctx context.Context) (Page[Workspace], error)

func (*Client) PublishEvent

func (c *Client) PublishEvent(ctx context.Context, input CustomEvent, idempotencyKey string) (PublishedEvent, error)

func (*Client) ResendInvitation

func (c *Client) ResendInvitation(ctx context.Context, id, reason, etag, idempotencyKey string) (InvitationDelivery, error)

func (*Client) RevokeInvitation

func (c *Client) RevokeInvitation(ctx context.Context, id, reason, etag string) error

func (*Client) SendNotification

func (c *Client) SendNotification(ctx context.Context, input Notification, idempotencyKey string) (QueuedNotification, error)

func (*Client) SubjectBilling

func (c *Client) SubjectBilling(ctx context.Context, subjectType, subjectID string) (BillingSummary, error)

func (*Client) SubjectEntitlements

func (c *Client) SubjectEntitlements(ctx context.Context, subjectType, subjectID string) (Page[EntitlementGrant], error)

func (*Client) UpdateSecret

func (c *Client) UpdateSecret(secret string)

type CreateInvitation

type CreateInvitation struct {
	OnboardingMethod    string   `json:"onboarding_method,omitempty"`
	SendEmail           *bool    `json:"send_email,omitempty"`
	Reason              string   `json:"reason,omitempty"`
	Email               string   `json:"email"`
	WorkspaceID         string   `json:"workspace_id,omitempty"`
	ApplicationRoleKeys []string `json:"application_role_keys,omitempty"`
	WorkspaceRoleKeys   []string `json:"workspace_role_keys,omitempty"`
	ExpiresIn           int64    `json:"expires_in,omitempty"`
	HostedClientID      string   `json:"hosted_client_id,omitempty"`
	HostedRedirectURI   string   `json:"hosted_redirect_uri,omitempty"`
}

type CustomEvent

type CustomEvent struct {
	Type          string          `json:"type"`
	Subject       string          `json:"subject"`
	Data          json.RawMessage `json:"data"`
	CorrelationID string          `json:"correlation_id,omitempty"`
	CausationID   string          `json:"causation_id,omitempty"`
}

type EntitlementGrant

type EntitlementGrant struct {
	ID                string          `json:"id"`
	SubjectType       string          `json:"subject_type"`
	SubjectID         string          `json:"subject_id"`
	SourceType        string          `json:"source_type"`
	SourceID          *string         `json:"source_id"`
	FeatureValues     json.RawMessage `json:"feature_values"`
	Configuration     json.RawMessage `json:"configuration"`
	StartsAt          time.Time       `json:"starts_at"`
	ExpiresAt         *time.Time      `json:"expires_at"`
	RevokedAt         *time.Time      `json:"revoked_at"`
	ExternalReference *string         `json:"external_reference"`
}

type InvalidAdministrationAction added in v0.6.0

type InvalidAdministrationAction struct{}

func (*InvalidAdministrationAction) Error added in v0.6.0

type Invitation

type Invitation struct {
	ApplicationID       string     `json:"application_id"`
	OnboardingMethod    string     `json:"onboarding_method"`
	Version             int64      `json:"version"`
	HostedClientID      *string    `json:"hosted_client_id"`
	HostedRedirectURI   *string    `json:"hosted_redirect_uri"`
	ID                  string     `json:"id"`
	Email               string     `json:"email"`
	WorkspaceID         *string    `json:"workspace_id"`
	ApplicationRoleKeys []string   `json:"application_role_keys"`
	WorkspaceRoleKeys   []string   `json:"workspace_role_keys"`
	Status              string     `json:"status"`
	ExpiresAt           time.Time  `json:"expires_at"`
	LastSentAt          *time.Time `json:"last_sent_at"`
	ResendAvailableAt   time.Time  `json:"resend_available_at"`
	AcceptedAt          *time.Time `json:"accepted_at"`
	RevokedAt           *time.Time `json:"revoked_at"`
}

type InvitationDelivery added in v0.6.0

type InvitationDelivery struct {
	Invitation
	InvitationURL string `json:"invitation_url"`
	EmailQueued   bool   `json:"email_queued"`
	Version       int64  `json:"version"`
}

type ManagedAttributes added in v0.6.0

type ManagedAttributes struct {
	CustomAttributes map[string]any `json:"custom_attributes"`
	Reason           string         `json:"reason"`
}

type ManagedRoleAssignment added in v0.6.0

type ManagedRoleAssignment struct {
	UserID      string  `json:"user_id"`
	RoleID      string  `json:"role_id"`
	WorkspaceID *string `json:"workspace_id,omitempty"`
	Reason      string  `json:"reason"`
}

type ManagedUserCreate added in v0.6.0

type ManagedUserCreate struct {
	Email            string          `json:"email"`
	FirstName        string          `json:"first_name,omitempty"`
	LastName         string          `json:"last_name,omitempty"`
	Username         *string         `json:"username,omitempty"`
	Locale           string          `json:"locale,omitempty"`
	EmailVerified    *bool           `json:"email_verified,omitempty"`
	IsOrgVerified    *bool           `json:"is_org_verified,omitempty"`
	CustomAttributes *map[string]any `json:"custom_attributes,omitempty"`
	Reason           string          `json:"reason"`
}

type ManagedUserUpdate added in v0.6.0

type ManagedUserUpdate struct {
	FirstName *string `json:"first_name,omitempty"`
	LastName  *string `json:"last_name,omitempty"`
	Username  *string `json:"username,omitempty"`
	Locale    *string `json:"locale,omitempty"`
	Reason    string  `json:"reason"`
}

type Notification

type Notification struct {
	TemplateKey string         `json:"template_key"`
	UserID      string         `json:"user_id,omitempty"`
	Recipient   string         `json:"recipient,omitempty"`
	Locale      string         `json:"locale,omitempty"`
	Variables   map[string]any `json:"variables,omitempty"`
	Attachments []Attachment   `json:"attachments,omitempty"`
}

type OAuthConnection added in v0.5.0

type OAuthConnection struct {
	ID              string   `json:"id"`
	ApplicationID   string   `json:"application_id"`
	ResourceID      string   `json:"resource_id"`
	ResourceVersion int64    `json:"resource_version"`
	UserID          string   `json:"user_id"`
	ClientID        string   `json:"client_id"`
	SessionID       string   `json:"session_id"`
	Capabilities    []string `json:"capabilities"`
	PersonalAccess  bool     `json:"personal_access"`
	WorkspaceIDs    []string `json:"workspace_ids"`
	ExpiresAt       string   `json:"expires_at"`
	RevokedAt       *string  `json:"revoked_at"`
	Version         int64    `json:"version"`
	CreatedAt       string   `json:"created_at"`
	UpdatedAt       string   `json:"updated_at"`
}

type OAuthResource added in v0.5.0

type OAuthResource struct {
	ID                  string               `json:"id"`
	ApplicationID       string               `json:"application_id"`
	URI                 string               `json:"uri"`
	Name                string               `json:"name"`
	Enabled             bool                 `json:"enabled"`
	AllowClientMetadata bool                 `json:"allow_client_metadata"`
	ClientIDs           []string             `json:"client_ids"`
	Capabilities        []ResourceCapability `json:"capabilities"`
	Version             int64                `json:"version"`
	CreatedAt           string               `json:"created_at"`
	UpdatedAt           string               `json:"updated_at"`
}

type Page

type Page[T any] struct {
	Items       []T     `json:"items"`
	NextCursor  *string `json:"next_cursor"`
	UserVersion *int64  `json:"user_version,omitempty"`
}

type PublishedEvent

type PublishedEvent struct {
	ID            string          `json:"id"`
	SpecVersion   string          `json:"specversion"`
	Source        string          `json:"source"`
	Type          string          `json:"type"`
	Subject       string          `json:"subject"`
	SchemaVersion string          `json:"schema_version"`
	Data          json.RawMessage `json:"data"`
}

type QueuedNotification

type QueuedNotification struct {
	ID              string `json:"id"`
	Status          string `json:"status"`
	RequestedLocale string `json:"requested_locale"`
	ResolvedLocale  string `json:"resolved_locale"`
	FallbackUsed    bool   `json:"fallback_used"`
}

type ResourceAccessCheckRequest added in v0.5.0

type ResourceAccessCheckRequest struct {
	Token       string `json:"token"`
	Resource    string `json:"resource"`
	Capability  string `json:"capability"`
	WorkspaceID string `json:"workspace_id,omitempty"`
}

type ResourceAccessCheckResponse added in v0.5.0

type ResourceAccessCheckResponse struct {
	Allowed      bool    `json:"allowed"`
	Reason       string  `json:"reason"`
	UserID       *string `json:"user_id,omitempty"`
	ConnectionID *string `json:"connection_id,omitempty"`
	WorkspaceID  *string `json:"workspace_id,omitempty"`
}

func (*ResourceAccessCheckResponse) UnmarshalJSON added in v0.5.0

func (r *ResourceAccessCheckResponse) UnmarshalJSON(data []byte) error

type ResourceCapability added in v0.5.0

type ResourceCapability struct {
	Key         string   `json:"key"`
	Name        string   `json:"name"`
	Context     string   `json:"context"`
	Permissions []string `json:"permissions"`
}

type RotateInvitation added in v0.6.0

type RotateInvitation struct {
	SendEmail bool   `json:"send_email"`
	Reason    string `json:"reason"`
}

type Subscription

type Subscription struct {
	ID                string     `json:"id"`
	SubjectType       string     `json:"subject_type"`
	SubjectID         string     `json:"subject_id"`
	PriceID           string     `json:"price_id"`
	ProviderID        string     `json:"provider_id"`
	Status            string     `json:"status"`
	CurrentPeriodEnd  *time.Time `json:"current_period_end"`
	CancelAtPeriodEnd bool       `json:"cancel_at_period_end"`
	ExternalReference *string    `json:"external_reference"`
}

type User

type User struct {
	ID               string          `json:"id"`
	ApplicationID    string          `json:"application_id"`
	Email            string          `json:"email"`
	FirstName        string          `json:"first_name"`
	LastName         string          `json:"last_name"`
	Username         *string         `json:"username"`
	Locale           string          `json:"locale"`
	EmailVerified    bool            `json:"email_verified"`
	OrganizationOK   bool            `json:"is_org_verified"`
	Status           string          `json:"status"`
	CustomAttributes json.RawMessage `json:"custom_attributes"`
	Version          int64           `json:"version"`
}

type UserRoleAssignment added in v0.6.0

type UserRoleAssignment struct {
	ID          string  `json:"id"`
	UserID      *string `json:"user_id"`
	RoleID      string  `json:"role_id"`
	RoleKey     string  `json:"role_key,omitempty"`
	RoleScope   string  `json:"role_scope,omitempty"`
	WorkspaceID *string `json:"workspace_id"`
}

type UserSession added in v0.6.0

type UserSession struct {
	ID              string   `json:"id"`
	UserAgent       *string  `json:"user_agent"`
	AuthenticatedAt string   `json:"authenticated_at"`
	ExpiresAt       string   `json:"expires_at"`
	RevokedAt       *string  `json:"revoked_at"`
	AMR             []string `json:"amr"`
}

type Workspace

type Workspace struct {
	ID            string          `json:"id"`
	ApplicationID string          `json:"application_id"`
	OwnerUserID   string          `json:"owner_user_id"`
	Key           string          `json:"key"`
	Name          string          `json:"name"`
	Metadata      json.RawMessage `json:"metadata"`
	Status        string          `json:"status"`
	Version       int64           `json:"version"`
	CreatedAt     time.Time       `json:"created_at"`
	UpdatedAt     time.Time       `json:"updated_at"`
}

type WorkspaceAccess

type WorkspaceAccess struct {
	Type         string     `json:"type"`
	WorkspaceID  string     `json:"workspace_id"`
	UserID       *string    `json:"user_id"`
	Email        *string    `json:"email"`
	RoleKeys     []string   `json:"role_keys"`
	InvitationID *string    `json:"invitation_id"`
	Status       string     `json:"status"`
	ExpiresAt    *time.Time `json:"expires_at"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL