api

package
v0.0.1-test9 Latest Latest
Warning

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

 Go to latest Published: May 7, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

Package api contains generated Meta API wire types.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AgentScope 

type AgentScope string

AgentScope is a Meta API string enum. 

const (
	AgentScopeAgentChat           AgentScope = "agent.chat"
	AgentScopeAgentRead           AgentScope = "agent.read"
	AgentScopeAgentCancel         AgentScope = "agent.cancel"
	AgentScopeAgentFilesRead      AgentScope = "agent.files.read"
	AgentScopeAgentTerminal       AgentScope = "agent.terminal"
	AgentScopeAgentSecretsResolve AgentScope = "agent.secrets.resolve"
	AgentScopeAgentAdmin          AgentScope = "agent.admin"
)

type AgentScopes 

type AgentScopes []AgentScope

AgentScopes is a Meta API type generated from JSON Schema.

type AgentSession 

type AgentSession struct {
	CreatedAt       Timestamp `json:"createdAt"`
	CreatedByUserID ID        `json:"createdByUserId"`
	Description     *string   `json:"description,omitempty"`
	ID              ID        `json:"id"`
	Name            string    `json:"name"`
	ProjectID       ID        `json:"projectId"`
	Status          string    `json:"status"`
	UpdatedAt       Timestamp `json:"updatedAt"`
}

AgentSession is a Meta API object generated from JSON Schema.

type AgentSessionMember 

type AgentSessionMember struct {
	AgentSessionID ID               `json:"agentSessionId"`
	CreatedAt      Timestamp        `json:"createdAt"`
	ID             ID               `json:"id"`
	Role           AgentSessionRole `json:"role"`
	UpdatedAt      Timestamp        `json:"updatedAt"`
	UserID         ID               `json:"userId"`
}

AgentSessionMember is a Meta API object generated from JSON Schema.

type AgentSessionPublicKey 

type AgentSessionPublicKey struct {
	AgentSessionID ID              `json:"agentSessionId"`
	Algorithm      string          `json:"algorithm"`
	CreatedAt      Timestamp       `json:"createdAt"`
	ID             ID              `json:"id"`
	PublicKey      Base64Bytes     `json:"publicKey"`
	Status         PublicKeyStatus `json:"status"`
	UpdatedAt      Timestamp       `json:"updatedAt"`
}

AgentSessionPublicKey is a Meta API object generated from JSON Schema.

type AgentSessionRole 

type AgentSessionRole string

AgentSessionRole is a Meta API string enum. 

const (
	AgentSessionRoleOwner  AgentSessionRole = "owner"
	AgentSessionRoleEditor AgentSessionRole = "editor"
	AgentSessionRoleViewer AgentSessionRole = "viewer"
)

type AuditEvent 

type AuditEvent struct {
	Action             string          `json:"action"`
	ActorDeviceID      *ID             `json:"actorDeviceId,omitempty"`
	ActorUserID        *ID             `json:"actorUserId,omitempty"`
	ActorUserSessionID *ID             `json:"actorUserSessionId,omitempty"`
	AgentSessionID     *ID             `json:"agentSessionId,omitempty"`
	CreatedAt          Timestamp       `json:"createdAt"`
	HTTPMethod         string          `json:"httpMethod"`
	ID                 ID              `json:"id"`
	Metadata           json.RawMessage `json:"metadata,omitempty"`
	OrganizationID     *ID             `json:"organizationId,omitempty"`
	Path               string          `json:"path"`
	PathTemplate       string          `json:"pathTemplate"`
	ProjectID          *ID             `json:"projectId,omitempty"`
	Query              json.RawMessage `json:"query,omitempty"`
	Result             AuditResult     `json:"result"`
	Scopes             []string        `json:"scopes,omitempty"`
	TargetID           ID              `json:"targetId"`
	TargetType         string          `json:"targetType"`
}

AuditEvent is a Meta API object generated from JSON Schema.

type AuditResult 

type AuditResult string

AuditResult is a Meta API string enum. 

const (
	AuditResultSuccess AuditResult = "success"
	AuditResultDenied  AuditResult = "denied"
	AuditResultError   AuditResult = "error"
)

type Base64Bytes 

type Base64Bytes []byte

Base64Bytes base64-encoded bytes.

type Error 

type Error struct {
	Error json.RawMessage `json:"error"`
}

Error is a Meta API object generated from JSON Schema.

type Group 

type Group struct {
	CreatedAt      Timestamp   `json:"createdAt"`
	Description    *string     `json:"description,omitempty"`
	ID             ID          `json:"id"`
	Name           string      `json:"name"`
	OrganizationID ID          `json:"organizationId"`
	Status         GroupStatus `json:"status"`
	UpdatedAt      Timestamp   `json:"updatedAt"`
}

Group is a Meta API object generated from JSON Schema.

type GroupIdentity 

type GroupIdentity struct {
	Claims     json.RawMessage `json:"claims,omitempty"`
	CreatedAt  Timestamp       `json:"createdAt"`
	ExternalID *string         `json:"externalId,omitempty"`
	GroupID    ID              `json:"groupId"`
	ID         ID              `json:"id"`
	Name       string          `json:"name"`
	Provider   string          `json:"provider"`
	UpdatedAt  Timestamp       `json:"updatedAt"`
}

GroupIdentity is a Meta API object generated from JSON Schema.

type GroupMember 

type GroupMember struct {
	CreatedAt Timestamp       `json:"createdAt"`
	GroupID   ID              `json:"groupId"`
	ID        ID              `json:"id"`
	Role      GroupMemberRole `json:"role"`
	Source    string          `json:"source"`
	UpdatedAt Timestamp       `json:"updatedAt"`
	UserID    ID              `json:"userId"`
}

GroupMember is a Meta API object generated from JSON Schema.

type GroupMemberRole 

type GroupMemberRole string

GroupMemberRole is a Meta API string enum. 

const (
	GroupMemberRoleAdmin  GroupMemberRole = "admin"
	GroupMemberRoleMember GroupMemberRole = "member"
)

type GroupStatus 

type GroupStatus string

GroupStatus is a Meta API string enum. 

const (
	GroupStatusActive   GroupStatus = "active"
	GroupStatusDisabled GroupStatus = "disabled"
)

type ID 

type ID string

ID stable opaque identifier using Meta's prefixed ULID convention, such as `usr_01hx3z9m8w7t2k5v3q6yb4n2rc`.

type JSONRawMessage 

type JSONRawMessage json.RawMessage

JSONRawMessage arbitrary JSON object. Contents are resource-specific.

type OAuthApplication 

type OAuthApplication struct {
	ClientID                string                 `json:"clientId"`
	CreatedAt               Timestamp              `json:"createdAt"`
	CreatedByUserID         ID                     `json:"createdByUserId"`
	GrantTypes              []string               `json:"grantTypes"`
	ID                      ID                     `json:"id"`
	Name                    string                 `json:"name"`
	OrganizationID          ID                     `json:"organizationId"`
	RedirectUris            []string               `json:"redirectUris"`
	ResponseTypes           []string               `json:"responseTypes"`
	Scopes                  []string               `json:"scopes"`
	Status                  OAuthApplicationStatus `json:"status"`
	TokenEndpointAuthMethod string                 `json:"tokenEndpointAuthMethod"`
	UpdatedAt               Timestamp              `json:"updatedAt"`
}

OAuthApplication is a Meta API object generated from JSON Schema.

type OAuthApplicationStatus 

type OAuthApplicationStatus string

OAuthApplicationStatus is a Meta API string enum. 

const (
	OAuthApplicationStatusActive   OAuthApplicationStatus = "active"
	OAuthApplicationStatusDisabled OAuthApplicationStatus = "disabled"
	OAuthApplicationStatusDeleted  OAuthApplicationStatus = "deleted"
)

type Organization 

type Organization struct {
	CreatedAt   Timestamp          `json:"createdAt"`
	Description *string            `json:"description,omitempty"`
	Domain      string             `json:"domain"`
	ID          ID                 `json:"id"`
	Name        string             `json:"name"`
	Status      OrganizationStatus `json:"status"`
	UpdatedAt   Timestamp          `json:"updatedAt"`
}

Organization is a Meta API object generated from JSON Schema.

type OrganizationMember 

type OrganizationMember struct {
	CreatedAt      Timestamp        `json:"createdAt"`
	ID             ID               `json:"id"`
	OrganizationID ID               `json:"organizationId"`
	Role           OrganizationRole `json:"role"`
	UpdatedAt      Timestamp        `json:"updatedAt"`
	UserID         ID               `json:"userId"`
}

OrganizationMember is a Meta API object generated from JSON Schema.

type OrganizationRole 

type OrganizationRole string

OrganizationRole is a Meta API string enum. 

const (
	OrganizationRoleOwner  OrganizationRole = "owner"
	OrganizationRoleAdmin  OrganizationRole = "admin"
	OrganizationRoleMember OrganizationRole = "member"
)

type OrganizationStatus 

type OrganizationStatus string

OrganizationStatus is a Meta API string enum. 

const (
	OrganizationStatusActive   OrganizationStatus = "active"
	OrganizationStatusDisabled OrganizationStatus = "disabled"
)

type PageInfo 

type PageInfo struct {
	HasMore    bool    `json:"hasMore"`
	NextCursor *string `json:"nextCursor,omitempty"`
}

PageInfo is a Meta API object generated from JSON Schema.

type Project 

type Project struct {
	CreatedAt       Timestamp     `json:"createdAt"`
	CreatedByUserID ID            `json:"createdByUserId"`
	Description     *string       `json:"description,omitempty"`
	ID              ID            `json:"id"`
	Name            string        `json:"name"`
	OrganizationID  ID            `json:"organizationId"`
	Slug            string        `json:"slug"`
	Status          ProjectStatus `json:"status"`
	UpdatedAt       Timestamp     `json:"updatedAt"`
}

Project is a Meta API object generated from JSON Schema.

type ProjectMember 

type ProjectMember struct {
	CreatedAt  Timestamp         `json:"createdAt"`
	ID         ID                `json:"id"`
	MemberID   ID                `json:"memberId"`
	MemberType ProjectMemberType `json:"memberType"`
	ProjectID  ID                `json:"projectId"`
	Role       ProjectRole       `json:"role"`
	UpdatedAt  Timestamp         `json:"updatedAt"`
}

ProjectMember is a Meta API object generated from JSON Schema.

type ProjectMemberType 

type ProjectMemberType string

ProjectMemberType is a Meta API string enum. 

const (
	ProjectMemberTypeUser  ProjectMemberType = "user"
	ProjectMemberTypeGroup ProjectMemberType = "group"
)

type ProjectRole 

type ProjectRole string

ProjectRole is a Meta API string enum. 

const (
	ProjectRoleOwner  ProjectRole = "owner"
	ProjectRoleAdmin  ProjectRole = "admin"
	ProjectRoleMember ProjectRole = "member"
	ProjectRoleViewer ProjectRole = "viewer"
)

type ProjectStatus 

type ProjectStatus string

ProjectStatus is a Meta API string enum. 

const (
	ProjectStatusActive   ProjectStatus = "active"
	ProjectStatusArchived ProjectStatus = "archived"
	ProjectStatusDeleted  ProjectStatus = "deleted"
)

type PublicKeyStatus 

type PublicKeyStatus string

PublicKeyStatus is a Meta API string enum. 

const (
	PublicKeyStatusActive   PublicKeyStatus = "active"
	PublicKeyStatusDisabled PublicKeyStatus = "disabled"
	PublicKeyStatusDeleted  PublicKeyStatus = "deleted"
)

type Secret 

type Secret struct {
	CreatedAt        Timestamp       `json:"createdAt"`
	CreatedByUserID  ID              `json:"createdByUserId"`
	CurrentVersionID *ID             `json:"currentVersionId,omitempty"`
	Description      *string         `json:"description,omitempty"`
	ID               ID              `json:"id"`
	Metadata         json.RawMessage `json:"metadata,omitempty"`
	Name             string          `json:"name"`
	OrganizationID   ID              `json:"organizationId"`
	Type             SecretType      `json:"type"`
	UpdatedAt        Timestamp       `json:"updatedAt"`
}

Secret is a Meta API object generated from JSON Schema.

type SecretBinding 

type SecretBinding struct {
	CreatedAt       Timestamp           `json:"createdAt"`
	CreatedByUserID ID                  `json:"createdByUserId"`
	ExpiresAt       *Timestamp          `json:"expiresAt,omitempty"`
	ID              ID                  `json:"id"`
	Scopes          SecretScopes        `json:"scopes"`
	SecretID        ID                  `json:"secretId"`
	TargetID        ID                  `json:"targetId"`
	TargetType      SecretBindingTarget `json:"targetType"`
	UpdatedAt       Timestamp           `json:"updatedAt"`
}

SecretBinding is a Meta API object generated from JSON Schema.

type SecretBindingTarget 

type SecretBindingTarget string

SecretBindingTarget is a Meta API string enum. 

const (
	SecretBindingTargetProject      SecretBindingTarget = "project"
	SecretBindingTargetAgentSession SecretBindingTarget = "agent_session"
)

type SecretOwner 

type SecretOwner struct {
	CreatedAt Timestamp       `json:"createdAt"`
	ID        ID              `json:"id"`
	OwnerID   ID              `json:"ownerId"`
	OwnerType SecretOwnerType `json:"ownerType"`
	SecretID  ID              `json:"secretId"`
}

SecretOwner is a Meta API object generated from JSON Schema.

type SecretOwnerType 

type SecretOwnerType string

SecretOwnerType is a Meta API string enum. 

const (
	SecretOwnerTypeUser    SecretOwnerType = "user"
	SecretOwnerTypeGroup   SecretOwnerType = "group"
	SecretOwnerTypeProject SecretOwnerType = "project"
)

type SecretRecipientType 

type SecretRecipientType string

SecretRecipientType is a Meta API string enum. 

const (
	SecretRecipientTypeUser         SecretRecipientType = "user"
	SecretRecipientTypeAgentSession SecretRecipientType = "agent_session"
)

type SecretRecipientWrap 

type SecretRecipientWrap struct {
	Algorithm       string              `json:"algorithm"`
	CreatedAt       Timestamp           `json:"createdAt"`
	CreatedByUserID *ID                 `json:"createdByUserId,omitempty"`
	EncapsulatedKey Base64Bytes         `json:"encapsulatedKey,omitempty"`
	ID              ID                  `json:"id"`
	RecipientID     ID                  `json:"recipientId"`
	RecipientKeyID  ID                  `json:"recipientKeyId"`
	RecipientType   SecretRecipientType `json:"recipientType"`
	SecretVersionID ID                  `json:"secretVersionId"`
	WrappedKey      Base64Bytes         `json:"wrappedKey"`
}

SecretRecipientWrap is a Meta API object generated from JSON Schema.

type SecretScope 

type SecretScope string

SecretScope is a Meta API string enum. 

const (
	SecretScopeLLM      SecretScope = "llm"
	SecretScopeHooks    SecretScope = "hooks"
	SecretScopeServices SecretScope = "services"
	SecretScopeTools    SecretScope = "tools"
)

type SecretScopes 

type SecretScopes []SecretScope

SecretScopes is a Meta API type generated from JSON Schema.

type SecretType 

type SecretType string

SecretType is a Meta API string enum. 

const (
	SecretTypeAPIKey      SecretType = "api_key"
	SecretTypeOAuth       SecretType = "oauth"
	SecretTypeToken       SecretType = "token"
	SecretTypeEnvironment SecretType = "environment"
)

type SecretVersion 

type SecretVersion struct {
	CreatedAt           Timestamp          `json:"createdAt"`
	CreatedByUserID     ID                 `json:"createdByUserId"`
	Digest              *string            `json:"digest,omitempty"`
	EncryptedData       Base64Bytes        `json:"encryptedData"`
	EncryptionAlgorithm string             `json:"encryptionAlgorithm"`
	EncryptionNonce     Base64Bytes        `json:"encryptionNonce,omitempty"`
	ID                  ID                 `json:"id"`
	SecretID            ID                 `json:"secretId"`
	State               SecretVersionState `json:"state"`
	Version             int                `json:"version"`
}

SecretVersion is a Meta API object generated from JSON Schema.

type SecretVersionState 

type SecretVersionState string

SecretVersionState is a Meta API string enum. 

const (
	SecretVersionStateActive   SecretVersionState = "active"
	SecretVersionStateDisabled SecretVersionState = "disabled"
	SecretVersionStateDeleted  SecretVersionState = "deleted"
)

type Timestamp 

type Timestamp time.Time

Timestamp is a Meta API type generated from JSON Schema.

type User 

type User struct {
	AvatarURL     *string    `json:"avatarUrl,omitempty"`
	CreatedAt     Timestamp  `json:"createdAt"`
	DisplayName   *string    `json:"displayName,omitempty"`
	EmailVerified bool       `json:"emailVerified"`
	ID            ID         `json:"id"`
	PrimaryEmail  string     `json:"primaryEmail"`
	Status        UserStatus `json:"status"`
	UpdatedAt     Timestamp  `json:"updatedAt"`
}

User is a Meta API object generated from JSON Schema.

type UserDevice 

type UserDevice struct {
	ApprovedAt         *Timestamp       `json:"approvedAt,omitempty"`
	ApprovedByDeviceID *ID              `json:"approvedByDeviceId,omitempty"`
	CreatedAt          Timestamp        `json:"createdAt"`
	ID                 ID               `json:"id"`
	LastSeenAt         *Timestamp       `json:"lastSeenAt,omitempty"`
	Name               string           `json:"name"`
	PublicKey          Base64Bytes      `json:"publicKey"`
	PublicKeyAlgorithm string           `json:"publicKeyAlgorithm"`
	Status             UserDeviceStatus `json:"status"`
	UpdatedAt          Timestamp        `json:"updatedAt"`
	UserID             ID               `json:"userId"`
}

UserDevice is a Meta API object generated from JSON Schema.

type UserDeviceStatus 

type UserDeviceStatus string

UserDeviceStatus is a Meta API string enum. 

const (
	UserDeviceStatusPending  UserDeviceStatus = "pending"
	UserDeviceStatusActive   UserDeviceStatus = "active"
	UserDeviceStatusDisabled UserDeviceStatus = "disabled"
	UserDeviceStatusDeleted  UserDeviceStatus = "deleted"
)

type UserIdentity 

type UserIdentity struct {
	Claims        json.RawMessage `json:"claims,omitempty"`
	CreatedAt     Timestamp       `json:"createdAt"`
	Email         string          `json:"email"`
	EmailVerified bool            `json:"emailVerified"`
	ID            ID              `json:"id"`
	Provider      string          `json:"provider"`
	Subject       string          `json:"subject"`
	UpdatedAt     Timestamp       `json:"updatedAt"`
	UserID        ID              `json:"userId"`
}

UserIdentity is a Meta API object generated from JSON Schema.

type UserSession 

type UserSession struct {
	CreatedAt     Timestamp         `json:"createdAt"`
	DeviceID      *ID               `json:"deviceId,omitempty"`
	DisplayName   *string           `json:"displayName,omitempty"`
	ExpiresAt     Timestamp         `json:"expiresAt"`
	ID            ID                `json:"id"`
	IPAddress     *string           `json:"ipAddress,omitempty"`
	Kind          UserSessionKind   `json:"kind"`
	LastSeenAt    *Timestamp        `json:"lastSeenAt,omitempty"`
	RevokedAt     *Timestamp        `json:"revokedAt,omitempty"`
	RevokedReason *string           `json:"revokedReason,omitempty"`
	Status        UserSessionStatus `json:"status"`
	UpdatedAt     Timestamp         `json:"updatedAt"`
	UserAgent     *string           `json:"userAgent,omitempty"`
	UserID        ID                `json:"userId"`
}

UserSession is a Meta API object generated from JSON Schema.

type UserSessionKind 

type UserSessionKind string

UserSessionKind is a Meta API string enum. 

const (
	UserSessionKindBrowser      UserSessionKind = "browser"
	UserSessionKindDesktop      UserSessionKind = "desktop"
	UserSessionKindAPIToken     UserSessionKind = "api_token"
	UserSessionKindRefreshToken UserSessionKind = "refresh_token"
)

type UserSessionStatus 

type UserSessionStatus string

UserSessionStatus is a Meta API string enum. 

const (
	UserSessionStatusActive  UserSessionStatus = "active"
	UserSessionStatusRevoked UserSessionStatus = "revoked"
	UserSessionStatusExpired UserSessionStatus = "expired"
)

type UserStatus 

type UserStatus string

UserStatus is a Meta API string enum. 

const (
	UserStatusActive   UserStatus = "active"
	UserStatusDisabled UserStatus = "disabled"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.