bibleit

package module
v0.4.0 Latest Latest
Warning

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

 Go to latest Published: Nov 2, 2026 License: MIT Imports: 16 Imported by: 0

README

Bibleit Go client

A Go SDK for Bibleit REST resources, registered OAuth clients, and SSH command construction/decoding. HTTP resources use the pinned https://api.bibleit.app/v1 service. Browser authentication uses https://bibleit.app. There is no command-style HTTP transport.

The module is released independently from the Bibleit CLI. Use the Go version in go.mod. The SDK does not read CLI configuration, open browsers, store credentials, or depend on the CLI.

Installation

go get github.com/bibleit-labs/bibleit-go

Resource client

Import github.com/bibleit-labs/bibleit-go. The client includes all 89 REST operations, generated schemas, response metadata, conditional writes, binary streams, versioned Live event polling and lazy whole-book page iterators. See REST usage and the runnable reading example.

client, err := bibleit.NewClient(token)
if err != nil { return err }
response, err := client.GetPersonalIdentity(ctx)
if err != nil { return err }
defer response.Body.Close()
var identity bibleit.PersonalIdentity
if err := response.Decode(&identity); err != nil { return err }
fmt.Println(identity.ID, identity.PersonalAccountID)

Credentials are explicit: finite personal bt_, delegated oa_, or organization svc_ tokens. The server enforces their separate scopes and resource boundaries. ProblemError exposes HTTP status, stable code, request ID and response headers. Operations never retry automatically; redirects are blocked and TLS verification is enabled. The host cannot be overridden through configuration or environment.

SSH protocol helpers

The bibleit package contains validated command builders, response parsers and typed domain helpers for SSH. It does not open SSH connections. Applications supply their own SSH executor to NewSSHClient:

client, err := bibleit.NewSSHClient(func(ctx context.Context, cmd bibleit.Command) (bibleit.CommandResponse, error) {
    // Execute cmd.String() over your verified SSH connection, then decode stdout.
    return bibleit.DecodeCommandResponse(cmd, stdout)
})

The executor owns SSH authentication, host-key verification and connection lifetime. The CLI uses OpenSSH to bibleit.app:22. Persistent Live subscriptions use the streaming protocol directly, rather than the finite executor. Protocol fixtures document quoting and response framing. No command-to-REST adapter is provided. Bearer credential clients cannot execute commands. NewClient returns a resource client; NewSSHClient returns an SSHClient with command and domain helpers. SSH decoders return CommandResponse; SSH Live collection results use SSHLiveList, SSHLiveStack and SSHLiveStatistics.

Browser login and registered OAuth

NewAuthClient / NewAuthClientWithHTTPClient exchange an approved CLI browser code with ExchangeCode. The application validates callback state, supplies the PKCE verifier and securely stores the result. Revoke that browser-issued CLI credential by constructing a resource client with NewClient(token) and calling client.RevokeCredential(ctx). The token exchange and logout endpoints remain supported.

For registered delegated OAuth clients use the separate bibleit.NewOAuthClient: S256 consent URLs, metadata, code exchange, refresh rotation and revocation stay on the website origin. Codes and refresh tokens are single-use. The SDK never retries an ambiguous exchange or refresh attempt.

Development

See CONTRIBUTING.md, SECURITY.md, and the REST contract regeneration instructions.

GOWORK=off go test -race ./...
GOWORK=off go vet ./...

Licensed under MIT.

Generated-code and dependency redistribution notices are retained in THIRD_PARTY_NOTICES, alongside the project MIT license.

Documentation

Overview

Package bibleit provides a client for Bibleit Server protocol v1. It does not read CLI configuration, open browsers, or manage credentials.

Package bibleit provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.

Package bibleit provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.

Index

Constants

View Source 
const Endpoint = "https://api.bibleit.app/v1"

Endpoint is the fixed resource API origin.

View Source 
const MaxCommandBytes = 8192
View Source 
const MaxRequestBytes = 16384
View Source 
const OAuthEndpoint = "https://bibleit.app"
View Source 
const ServerEndpoint = "https://bibleit.app"

ServerEndpoint is the project-managed browser authentication origin. Applications cannot override it through configuration or environment variables. HTTPS certificate verification is enabled by the default transport.

Variables

View Source 
var ErrIncompleteTerm = errors.New("unterminated protocol term")

ErrIncompleteTerm means an opaque compound field needs another input line. Stream readers may append the next line and retry ParseRecord.

View Source 
var ErrInvalidBookPage = errors.New("invalid REST book page")

ErrInvalidBookPage means a paged response could not be traversed safely. Callers should discard partial results rather than treat them as a full book.

Functions

func AuthorizationURL added in v0.3.0 

func AuthorizationURL(clientID, redirectURI, state, challenge string, scopes []string) (string, error)

AuthorizationURL builds the browser consent URL with S256 PKCE. The callback and scopes must match the server-side client registration. Keep the verifier private; only its SHA-256 base64url challenge belongs in this URL.

func OperationNames added in v0.3.0 

func OperationNames() []string

func Operations added in v0.3.0 

func Operations() map[string]Operation

Operations returns a copy of the pinned contract's REST operation directory.

Types

type AccountInfo 

type AccountInfo struct {
	Actor, DisplayName, Handle, AvatarURL, Locale, Theme string
	Plan, PlanName, PlanSource                           string
	PlanActivatedAt                                      int64
	Lives, Translations, Tokens, Keys                    int64
	Raw                                                  CommandResponse
}

type AccountQuota added in v0.3.0 

type AccountQuota struct {
	Action   string `json:"action"`
	Limit    int64  `json:"limit"`
	Resource string `json:"resource"`
	Used     int64  `json:"used"`
}

AccountQuota defines model for AccountQuota.

type AccountQuotaCollection added in v0.3.0 

type AccountQuotaCollection struct {
	Data []AccountQuota `json:"data"`
}

AccountQuotaCollection defines model for AccountQuotaCollection.

type AuthClient 

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

AuthClient exchanges an approved browser code. It does not run a browser, validate callback state, persist credentials, or retry a consumed code.

func NewAuthClient 

func NewAuthClient() (*AuthClient, error)

NewAuthClient creates an unauthenticated client for browser-code exchange.

func NewAuthClientWithHTTPClient 

func NewAuthClientWithHTTPClient(httpClient *http.Client) (*AuthClient, error)

NewAuthClientWithHTTPClient configures transport/timeouts for code exchange at the same fixed service endpoint. It copies the supplied HTTP client.

func (*AuthClient) ExchangeCode 

func (c *AuthClient) ExchangeCode(ctx context.Context, exchange CodeExchange) (AuthorizationResult, error)

ExchangeCode redeems an approved one-use code with its PKCE verifier. Even a rejected verifier can consume the code on the current server.

type AuthorizationResult 

type AuthorizationResult struct {
	Actor, IdentityName, DisplayName, AuthProvider, TokenID, AccessToken string
	Fields                                                               map[string]json.RawMessage
}

AuthorizationResult contains a secret AccessToken; Fields also contains the original JSON response, including that secret. Callers own secure storage.

type AuthorizeMcpOAuthParams added in v0.4.0 

type AuthorizeMcpOAuthParams struct {
	ResponseType        *AuthorizeMcpOAuthParamsResponseType        `form:"response_type,omitempty" json:"response_type,omitempty"`
	ClientID            *string                                     `form:"client_id,omitempty" json:"client_id,omitempty"`
	RedirectURI         *string                                     `form:"redirect_uri,omitempty" json:"redirect_uri,omitempty"`
	Scope               *string                                     `form:"scope,omitempty" json:"scope,omitempty"`
	State               *string                                     `form:"state,omitempty" json:"state,omitempty"`
	CodeChallenge       *string                                     `form:"code_challenge,omitempty" json:"code_challenge,omitempty"`
	CodeChallengeMethod *AuthorizeMcpOAuthParamsCodeChallengeMethod `form:"code_challenge_method,omitempty" json:"code_challenge_method,omitempty"`
	Request             *string                                     `form:"request,omitempty" json:"request,omitempty"`
	Resource            *string                                     `form:"resource,omitempty" json:"resource,omitempty"`

	// Prompt Optional explicit consent request, used by Claude Code. Silent authorization is not supported.
	Prompt *AuthorizeMcpOAuthParamsPrompt `form:"prompt,omitempty" json:"prompt,omitempty"`

	// UILocales Optional bounded space-separated language tags, as sent by ChatGPT. Advisory only; consent currently retains its existing language.
	UILocales *string `form:"ui_locales,omitempty" json:"ui_locales,omitempty"`
}

AuthorizeMcpOAuthParams defines parameters for AuthorizeMcpOAuth.

type AuthorizeMcpOAuthParamsCodeChallengeMethod added in v0.4.0 

type AuthorizeMcpOAuthParamsCodeChallengeMethod string

AuthorizeMcpOAuthParamsCodeChallengeMethod defines parameters for AuthorizeMcpOAuth. 

const (
	AuthorizeMcpOAuthParamsCodeChallengeMethodS256 AuthorizeMcpOAuthParamsCodeChallengeMethod = "S256"
)

Defines values for AuthorizeMcpOAuthParamsCodeChallengeMethod.

func (AuthorizeMcpOAuthParamsCodeChallengeMethod) Valid added in v0.4.0 

func (e AuthorizeMcpOAuthParamsCodeChallengeMethod) Valid() bool

Valid indicates whether the value is a known member of the AuthorizeMcpOAuthParamsCodeChallengeMethod enum.

type AuthorizeMcpOAuthParamsPrompt added in v0.4.0 

type AuthorizeMcpOAuthParamsPrompt string

AuthorizeMcpOAuthParamsPrompt defines parameters for AuthorizeMcpOAuth. 

const (
	Consent AuthorizeMcpOAuthParamsPrompt = "consent"
)

Defines values for AuthorizeMcpOAuthParamsPrompt.

func (AuthorizeMcpOAuthParamsPrompt) Valid added in v0.4.0 

func (e AuthorizeMcpOAuthParamsPrompt) Valid() bool

Valid indicates whether the value is a known member of the AuthorizeMcpOAuthParamsPrompt enum.

type AuthorizeMcpOAuthParamsResponseType added in v0.4.0 

type AuthorizeMcpOAuthParamsResponseType string

AuthorizeMcpOAuthParamsResponseType defines parameters for AuthorizeMcpOAuth. 

const (
	AuthorizeMcpOAuthParamsResponseTypeCode AuthorizeMcpOAuthParamsResponseType = "code"
)

Defines values for AuthorizeMcpOAuthParamsResponseType.

func (AuthorizeMcpOAuthParamsResponseType) Valid added in v0.4.0 

func (e AuthorizeMcpOAuthParamsResponseType) Valid() bool

Valid indicates whether the value is a known member of the AuthorizeMcpOAuthParamsResponseType enum.

type AuthorizeOAuthParams added in v0.3.0 

type AuthorizeOAuthParams struct {
	ResponseType        *AuthorizeOAuthParamsResponseType        `form:"response_type,omitempty" json:"response_type,omitempty"`
	ClientID            *string                                  `form:"client_id,omitempty" json:"client_id,omitempty"`
	RedirectURI         *string                                  `form:"redirect_uri,omitempty" json:"redirect_uri,omitempty"`
	Scope               *string                                  `form:"scope,omitempty" json:"scope,omitempty"`
	State               *string                                  `form:"state,omitempty" json:"state,omitempty"`
	CodeChallenge       *string                                  `form:"code_challenge,omitempty" json:"code_challenge,omitempty"`
	CodeChallengeMethod *AuthorizeOAuthParamsCodeChallengeMethod `form:"code_challenge_method,omitempty" json:"code_challenge_method,omitempty"`
	Request             *string                                  `form:"request,omitempty" json:"request,omitempty"`
}

AuthorizeOAuthParams defines parameters for AuthorizeOAuth.

type AuthorizeOAuthParamsCodeChallengeMethod added in v0.3.0 

type AuthorizeOAuthParamsCodeChallengeMethod string

AuthorizeOAuthParamsCodeChallengeMethod defines parameters for AuthorizeOAuth. 

const (
	AuthorizeOAuthParamsCodeChallengeMethodS256 AuthorizeOAuthParamsCodeChallengeMethod = "S256"
)

Defines values for AuthorizeOAuthParamsCodeChallengeMethod.

func (AuthorizeOAuthParamsCodeChallengeMethod) Valid added in v0.3.0 

func (e AuthorizeOAuthParamsCodeChallengeMethod) Valid() bool

Valid indicates whether the value is a known member of the AuthorizeOAuthParamsCodeChallengeMethod enum.

type AuthorizeOAuthParamsResponseType added in v0.3.0 

type AuthorizeOAuthParamsResponseType string

AuthorizeOAuthParamsResponseType defines parameters for AuthorizeOAuth. 

const (
	AuthorizeOAuthParamsResponseTypeCode AuthorizeOAuthParamsResponseType = "code"
)

Defines values for AuthorizeOAuthParamsResponseType.

func (AuthorizeOAuthParamsResponseType) Valid added in v0.3.0 

func (e AuthorizeOAuthParamsResponseType) Valid() bool

Valid indicates whether the value is a known member of the AuthorizeOAuthParamsResponseType enum.

type BookCollection added in v0.3.0 

type BookCollection struct {
	Data []BookDefinition `json:"data"`

	// NextCursor Pass unchanged as after on the next request; null ends the collection.
	NextCursor *string `json:"next_cursor"`
}

BookCollection defines model for BookCollection.

type BookDefinition added in v0.3.0 

type BookDefinition struct {
	Aliases []string             `json:"aliases"`
	Code    string               `json:"code"`
	ID      int64                `json:"id"`
	Names   BookDefinition_Names `json:"names"`
}

BookDefinition defines model for BookDefinition.

type BookDefinition_Names added in v0.3.1 

type BookDefinition_Names struct {
	De string `json:"de"`
	En string `json:"en"`
	Pt string `json:"pt"`
}

BookDefinition_Names defines model for BookDefinition.Names.

type CatalogBook 

type CatalogBook struct {
	ID       int64 // Server source book identifier; not the book's position in Books.
	Name     string
	Chapters []CatalogChapter
	Fields   map[string]string
}

type CatalogChapter 

type CatalogChapter struct {
	Number int64
	// Verses is the highest source verse identifier, not the number of present
	// rows. Editions may omit identifiers; reading an omitted verse fails.
	Verses int64
	Fields map[string]string
}

type CatalogueTranslation added in v0.3.0 

type CatalogueTranslation struct {
	BookIds    []int64                      `json:"book_ids"`
	Installed  bool                         `json:"installed"`
	Language   CatalogueTranslationLanguage `json:"language"`
	Name       string                       `json:"name"`
	Provenance TranslationProvenance        `json:"provenance"`
	Rights     TranslationRights            `json:"rights"`
	Slug       string                       `json:"slug"`
}

CatalogueTranslation defines model for CatalogueTranslation.

type CatalogueTranslationLanguage added in v0.3.1 

type CatalogueTranslationLanguage string

CatalogueTranslationLanguage defines model for CatalogueTranslation.Language. 

const (
	CatalogueTranslationLanguageDe  CatalogueTranslationLanguage = "de"
	CatalogueTranslationLanguageEn  CatalogueTranslationLanguage = "en"
	CatalogueTranslationLanguagePt  CatalogueTranslationLanguage = "pt"
	CatalogueTranslationLanguageUnd CatalogueTranslationLanguage = "und"
)

Defines values for CatalogueTranslationLanguage.

func (CatalogueTranslationLanguage) Valid added in v0.3.1 

func (e CatalogueTranslationLanguage) Valid() bool

Valid indicates whether the value is a known member of the CatalogueTranslationLanguage enum.

type ClearLiveStackParams added in v0.3.0 

type ClearLiveStackParams struct {
	// IfMatch Current strong Live ETag. Missing:428; stale:412. No automatic retry.
	IfMatch string `json:"If-Match"`
}

ClearLiveStackParams defines parameters for ClearLiveStack.

type Client 

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

Client provides resource operations, pagination and credential revocation.

func NewClient 

func NewClient(token string, transports ...*http.Client) (*Client, error)

NewClient creates a resource client. It accepts personal bt_, delegated oa_, or organization svc_ credentials. The server enforces each credential's resource boundaries and scopes. An empty token is permitted for public discovery. Pass an optional HTTP client to configure transport and timeouts. No operation is automatically retried.

func NewClientWithHTTPClient 

func NewClientWithHTTPClient(token string, transport *http.Client) (*Client, error)

NewClientWithHTTPClient creates a resource client with a custom HTTP transport.

func (*Client) Call added in v0.3.0 

func (c *Client) Call(ctx context.Context, operation string, params map[string]string, options *Options) (*Response, error)

Call invokes one named operation from the checked-in OpenAPI contract. Paths cannot select another host or bypass the pinned /v1 API. Conditional writes use the caller's exact ETag; 412/428 are returned without retry.

func (*Client) ClearLiveStack added in v0.3.0 

func (c *Client) ClearLiveStack(ctx context.Context, live_id string, options ...*Options) (*Response, error)

ClearLiveStack Clear the retained scripture stack.

func (*Client) CreateLive 

func (c *Client) CreateLive(ctx context.Context, organization_id string, options ...*Options) (*Response, error)

CreateLive Create an organization Live.

func (*Client) CreateLiveAudienceSecret added in v0.3.0 

func (c *Client) CreateLiveAudienceSecret(ctx context.Context, live_id string, options ...*Options) (*Response, error)

CreateLiveAudienceSecret Create a one-time audience secret.

func (*Client) CreateLiveQueueItem added in v0.3.0 

func (c *Client) CreateLiveQueueItem(ctx context.Context, live_id string, options ...*Options) (*Response, error)

CreateLiveQueueItem Insert a scripture queue item.

func (*Client) CreatePersonalLive added in v0.3.0 

func (c *Client) CreatePersonalLive(ctx context.Context, account_id string, options ...*Options) (*Response, error)

CreatePersonalLive Create a personal Reader Live.

func (*Client) CreatePresentation added in v0.3.0 

func (c *Client) CreatePresentation(ctx context.Context, organization_id string, options ...*Options) (*Response, error)

CreatePresentation Create an organization presentation.

func (*Client) CreatePresentationExport added in v0.3.0 

func (c *Client) CreatePresentationExport(ctx context.Context, presentation_id string, options ...*Options) (*Response, error)

CreatePresentationExport Queue a saved-revision presentation export.

func (*Client) CreateServiceToken added in v0.3.0 

func (c *Client) CreateServiceToken(ctx context.Context, organization_id string, options ...*Options) (*Response, error)

CreateServiceToken Create a service token.

func (*Client) DeleteLive added in v0.3.0 

func (c *Client) DeleteLive(ctx context.Context, live_id string, options ...*Options) (*Response, error)

DeleteLive Delete a Live.

func (*Client) DeleteLiveAudienceSecret added in v0.3.0 

func (c *Client) DeleteLiveAudienceSecret(ctx context.Context, live_id string, options ...*Options) (*Response, error)

DeleteLiveAudienceSecret Remove audience-secret protection.

func (*Client) DeleteLiveQueueItem added in v0.3.0 

func (c *Client) DeleteLiveQueueItem(ctx context.Context, live_id string, item_id string, options ...*Options) (*Response, error)

DeleteLiveQueueItem Remove a queue item.

func (*Client) DeleteOrganizationLives added in v0.3.0 

func (c *Client) DeleteOrganizationLives(ctx context.Context, organization_id string, options ...*Options) (*Response, error)

DeleteOrganizationLives Atomically delete all Lives in this workspace.

func (*Client) DeleteOrganizationMember added in v0.3.0 

func (c *Client) DeleteOrganizationMember(ctx context.Context, organization_id string, member_id string, options ...*Options) (*Response, error)

DeleteOrganizationMember Remove a member.

func (*Client) DeletePersonalLives added in v0.3.0 

func (c *Client) DeletePersonalLives(ctx context.Context, account_id string, options ...*Options) (*Response, error)

DeletePersonalLives Atomically delete all Lives in this workspace.

func (*Client) DeletePresentation added in v0.3.0 

func (c *Client) DeletePresentation(ctx context.Context, presentation_id string, options ...*Options) (*Response, error)

DeletePresentation Delete a saved presentation.

func (*Client) DisableOrganizationTranslation added in v0.3.0 

func (c *Client) DisableOrganizationTranslation(ctx context.Context, organization_id string, slug string, options ...*Options) (*Response, error)

DisableOrganizationTranslation Remove a translation from the organization library.

func (*Client) DisablePersonalTranslation added in v0.3.0 

func (c *Client) DisablePersonalTranslation(ctx context.Context, account_id string, slug string, options ...*Options) (*Response, error)

DisablePersonalTranslation Disable a personal translation.

func (*Client) DownloadPresentationExport added in v0.3.0 

func (c *Client) DownloadPresentationExport(ctx context.Context, presentation_id string, export_id string, options ...*Options) (*Response, error)

DownloadPresentationExport Consume and download a completed export once.

func (*Client) EnableOrganizationTranslation added in v0.3.0 

func (c *Client) EnableOrganizationTranslation(ctx context.Context, organization_id string, slug string, options ...*Options) (*Response, error)

EnableOrganizationTranslation Enable an installed translation in the organization library.

func (*Client) EnablePersonalTranslation added in v0.3.0 

func (c *Client) EnablePersonalTranslation(ctx context.Context, account_id string, slug string, options ...*Options) (*Response, error)

EnablePersonalTranslation Enable an installed personal translation.

func (*Client) GetLive 

func (c *Client) GetLive(ctx context.Context, live_id string, options ...*Options) (*Response, error)

GetLive Read Live state.

func (*Client) GetLiveDisplay added in v0.3.0 

func (c *Client) GetLiveDisplay(ctx context.Context, live_id string, options ...*Options) (*Response, error)

GetLiveDisplay Read the Live display.

func (*Client) GetLiveEvents added in v0.3.0 

func (c *Client) GetLiveEvents(ctx context.Context, live_id string, options ...*Options) (*Response, error)

GetLiveEvents Receive versioned Live events.

func (*Client) GetLivePlayback added in v0.3.0 

func (c *Client) GetLivePlayback(ctx context.Context, live_id string, options ...*Options) (*Response, error)

GetLivePlayback Read Live playback state.

func (*Client) GetLiveQueueItem added in v0.3.0 

func (c *Client) GetLiveQueueItem(ctx context.Context, live_id string, item_id string, options ...*Options) (*Response, error)

GetLiveQueueItem Read a stable queue item.

func (*Client) GetLiveSettings added in v0.3.0 

func (c *Client) GetLiveSettings(ctx context.Context, live_id string, options ...*Options) (*Response, error)

GetLiveSettings Read retained reference and selected translations.

func (*Client) GetLiveStack 

func (c *Client) GetLiveStack(ctx context.Context, live_id string, options ...*Options) (*Response, error)

GetLiveStack Read retained scripture stack.

func (*Client) GetLiveStatistics added in v0.3.0 

func (c *Client) GetLiveStatistics(ctx context.Context, live_id string, options ...*Options) (*Response, error)

GetLiveStatistics Read Live connection and retained-stack statistics.

func (*Client) GetOpenAPI added in v0.3.0 

func (c *Client) GetOpenAPI(ctx context.Context, options ...*Options) (*Response, error)

GetOpenAPI Download the OpenAPI contract.

func (*Client) GetOpenApi added in v0.3.0 

func (c *Client) GetOpenApi(ctx context.Context, options *Options) (*Response, error)

GetOpenApi preserves the v0.1.0 spelling. New code can use GetOpenAPI.

func (*Client) GetOrganization added in v0.3.0 

func (c *Client) GetOrganization(ctx context.Context, organization_id string, options ...*Options) (*Response, error)

GetOrganization Read organization identity.

func (*Client) GetOrganizationLiveStudio added in v0.3.0 

func (c *Client) GetOrganizationLiveStudio(ctx context.Context, organization_id string, options ...*Options) (*Response, error)

GetOrganizationLiveStudio Read organization Live Studio settings.

func (*Client) GetOrganizationMember added in v0.3.0 

func (c *Client) GetOrganizationMember(ctx context.Context, organization_id string, member_id string, options ...*Options) (*Response, error)

GetOrganizationMember Read an active membership.

func (*Client) GetOrganizationQuotas added in v0.3.0 

func (c *Client) GetOrganizationQuotas(ctx context.Context, organization_id string, options ...*Options) (*Response, error)

GetOrganizationQuotas Read organization limits and usage.

func (*Client) GetOrganizationTranslation added in v0.3.0 

func (c *Client) GetOrganizationTranslation(ctx context.Context, organization_id string, slug string, options ...*Options) (*Response, error)

GetOrganizationTranslation Read an organization library membership.

func (*Client) GetPersonalAccount added in v0.3.0 

func (c *Client) GetPersonalAccount(ctx context.Context, account_id string, options ...*Options) (*Response, error)

GetPersonalAccount Read your personal account.

func (*Client) GetPersonalIdentity added in v0.3.0 

func (c *Client) GetPersonalIdentity(ctx context.Context, options ...*Options) (*Response, error)

GetPersonalIdentity Read your personal identity.

func (*Client) GetPersonalOrganizationApplication added in v0.3.0 

func (c *Client) GetPersonalOrganizationApplication(ctx context.Context, application_id string, options ...*Options) (*Response, error)

GetPersonalOrganizationApplication Read your organization application status.

func (*Client) GetPersonalQuotas added in v0.3.0 

func (c *Client) GetPersonalQuotas(ctx context.Context, account_id string, options ...*Options) (*Response, error)

GetPersonalQuotas Read your effective personal quotas and current usage.

func (*Client) GetPersonalTranslation added in v0.3.0 

func (c *Client) GetPersonalTranslation(ctx context.Context, account_id string, slug string, options ...*Options) (*Response, error)

GetPersonalTranslation Read an personal account library membership.

func (*Client) GetPresentation added in v0.3.0 

func (c *Client) GetPresentation(ctx context.Context, presentation_id string, options ...*Options) (*Response, error)

GetPresentation Read a saved presentation.

func (*Client) GetPresentationAsset added in v0.3.0 

func (c *Client) GetPresentationAsset(ctx context.Context, presentation_id string, asset_id string, options ...*Options) (*Response, error)

GetPresentationAsset Read protected presentation asset bytes.

func (*Client) GetPresentationExport added in v0.3.0 

func (c *Client) GetPresentationExport(ctx context.Context, presentation_id string, export_id string, options ...*Options) (*Response, error)

GetPresentationExport Read export job status.

func (*Client) GetServiceOrganization added in v0.3.0 

func (c *Client) GetServiceOrganization(ctx context.Context, options ...*Options) (*Response, error)

GetServiceOrganization Discover the service token organization.

func (*Client) GetServiceToken added in v0.3.0 

func (c *Client) GetServiceToken(ctx context.Context, organization_id string, credential_id string, options ...*Options) (*Response, error)

GetServiceToken Read service-token configuration.

func (*Client) GetTranslation added in v0.3.0 

func (c *Client) GetTranslation(ctx context.Context, slug string, options ...*Options) (*Response, error)

GetTranslation Read translation edition metadata.

func (*Client) GetTranslationCatalogueDetails added in v0.3.0 

func (c *Client) GetTranslationCatalogueDetails(ctx context.Context, slug string, options ...*Options) (*Response, error)

GetTranslationCatalogueDetails Read installed chapter and verse catalogue.

func (*Client) ImportPresentation added in v0.3.0 

func (c *Client) ImportPresentation(ctx context.Context, organization_id string, options ...*Options) (*Response, error)

ImportPresentation Import a portable presentation bundle.

func (*Client) ListBooks added in v0.3.0 

func (c *Client) ListBooks(ctx context.Context, options ...*Options) (*Response, error)

ListBooks List canonical book definitions.

func (*Client) ListLiveQueueItems added in v0.3.0 

func (c *Client) ListLiveQueueItems(ctx context.Context, live_id string, options ...*Options) (*Response, error)

ListLiveQueueItems List ordered Live queue items.

func (*Client) ListLives 

func (c *Client) ListLives(ctx context.Context, organization_id string, options ...*Options) (*Response, error)

ListLives List organization Lives.

func (*Client) ListOAuthGrants added in v0.3.0 

func (c *Client) ListOAuthGrants(ctx context.Context, options ...*Options) (*Response, error)

ListOAuthGrants List your connected OAuth applications.

func (*Client) ListOrganizationMembers added in v0.3.0 

func (c *Client) ListOrganizationMembers(ctx context.Context, organization_id string, options ...*Options) (*Response, error)

ListOrganizationMembers List active organization memberships.

func (*Client) ListOrganizationTranslations added in v0.3.0 

func (c *Client) ListOrganizationTranslations(ctx context.Context, organization_id string, options ...*Options) (*Response, error)

ListOrganizationTranslations List the organization translation library.

func (*Client) ListPersonalAccounts added in v0.3.0 

func (c *Client) ListPersonalAccounts(ctx context.Context, options ...*Options) (*Response, error)

ListPersonalAccounts List your personal account.

func (*Client) ListPersonalLives added in v0.3.0 

func (c *Client) ListPersonalLives(ctx context.Context, account_id string, options ...*Options) (*Response, error)

ListPersonalLives List your personal Lives.

func (*Client) ListPersonalOrganizations added in v0.3.0 

func (c *Client) ListPersonalOrganizations(ctx context.Context, options ...*Options) (*Response, error)

ListPersonalOrganizations List your memberships and applications.

func (*Client) ListPersonalTokens added in v0.3.0 

func (c *Client) ListPersonalTokens(ctx context.Context, account_id string, options ...*Options) (*Response, error)

ListPersonalTokens List personal credential metadata.

func (*Client) ListPersonalTranslations added in v0.3.0 

func (c *Client) ListPersonalTranslations(ctx context.Context, account_id string, options ...*Options) (*Response, error)

ListPersonalTranslations List the personal account translation library.

func (*Client) ListPresentationExports added in v0.3.0 

func (c *Client) ListPresentationExports(ctx context.Context, presentation_id string, options ...*Options) (*Response, error)

ListPresentationExports List the requesting service credential’s export jobs.

func (*Client) ListPresentations added in v0.3.0 

func (c *Client) ListPresentations(ctx context.Context, organization_id string, options ...*Options) (*Response, error)

ListPresentations List organization presentations.

func (*Client) ListServiceTokens added in v0.3.0 

func (c *Client) ListServiceTokens(ctx context.Context, organization_id string, options ...*Options) (*Response, error)

ListServiceTokens List service tokens.

func (*Client) ListTranslationBooks added in v0.3.0 

func (c *Client) ListTranslationBooks(ctx context.Context, slug string, options ...*Options) (*Response, error)

ListTranslationBooks List a translation edition book coverage.

func (*Client) ListTranslationCatalogue added in v0.3.0 

func (c *Client) ListTranslationCatalogue(ctx context.Context, options ...*Options) (*Response, error)

ListTranslationCatalogue List reviewed translation editions.

func (*Client) MoveLiveWorkspace added in v0.3.0 

func (c *Client) MoveLiveWorkspace(ctx context.Context, live_id string, options ...*Options) (*Response, error)

MoveLiveWorkspace Move a Live to another organization.

func (*Client) PollLiveEvents added in v0.3.0 

func (c *Client) PollLiveEvents(ctx context.Context, id, after string, wait int) (Event, error)

PollLiveEvents performs exactly one bounded long poll; it never retries. Run writes independently of the outstanding poll and honor rate limits.

func (*Client) PollLiveEventsWithOptions added in v0.3.1 

func (c *Client) PollLiveEventsWithOptions(ctx context.Context, id string, options ...*GetLiveEventsParams) (Event, error)

PollLiveEventsWithOptions performs one long poll with a default wait of 25 seconds and no cursor. Set After to resume, or Wait to explicitly choose a wait (including zero). The supplied parameters are never changed.

func (*Client) PopLiveStack added in v0.3.0 

func (c *Client) PopLiveStack(ctx context.Context, live_id string, options ...*Options) (*Response, error)

PopLiveStack Remove a positive count from the retained stack tail.

func (*Client) PushLiveStack added in v0.3.0 

func (c *Client) PushLiveStack(ctx context.Context, live_id string, options ...*Options) (*Response, error)

PushLiveStack Push retained scripture with optional selected translations.

func (*Client) ReadBook added in v0.3.0 

func (c *Client) ReadBook(ctx context.Context, organization_id string, slug string, book_id string, options ...*Options) (*Response, error)

ReadBook Read a book page with source verse identifiers.

func (*Client) ReadBookPages added in v0.3.0 

func (c *Client) ReadBookPages(ctx context.Context, organizationID, slug, bookID string, options ...*Options) iter.Seq2[ScriptureBookRead, error]

ReadBookPages is the organization-scoped counterpart of ReadPersonalBookPages. It has the same lazy iteration, cancellation and error behavior. ReadBook remains a single-request method returning one bounded page.

func (*Client) ReadChapter added in v0.3.0 

func (c *Client) ReadChapter(ctx context.Context, organization_id string, slug string, book_id string, chapter string, options ...*Options) (*Response, error)

ReadChapter Read a chapter.

func (*Client) ReadPersonalBook added in v0.3.0 

func (c *Client) ReadPersonalBook(ctx context.Context, account_id string, slug string, book_id string, options ...*Options) (*Response, error)

ReadPersonalBook Read a book page with source verse identifiers.

func (*Client) ReadPersonalBookPages added in v0.3.0 

func (c *Client) ReadPersonalBookPages(ctx context.Context, accountID, slug, bookID string, options ...*Options) iter.Seq2[ScriptureBookRead, error]

ReadPersonalBookPages lazily reads a personal book in bounded pages. It fetches cursor pages with limit=50 unless Options.Query specifies a limit (1..500). Query.after can resume a previous traversal. Options are copied; caller query values are never changed. Each iteration starts a new traversal. Stop iteration or cancel ctx to stop fetching. Errors are yielded once, with a zero page, and are never retried. Every response body is closed before yield. ReadPersonalBook remains a single request and returns one page (50 verses by default). Use this iterator to read the complete book.

func (*Client) ReadPersonalChapter added in v0.3.0 

func (c *Client) ReadPersonalChapter(ctx context.Context, account_id string, slug string, book_id string, chapter string, options ...*Options) (*Response, error)

ReadPersonalChapter Read a chapter.

func (*Client) ReadPersonalVerse added in v0.3.0 

func (c *Client) ReadPersonalVerse(ctx context.Context, account_id string, slug string, book_id string, chapter string, verse string, options ...*Options) (*Response, error)

ReadPersonalVerse Read a verse.

func (*Client) ReadVerse added in v0.3.0 

func (c *Client) ReadVerse(ctx context.Context, organization_id string, slug string, book_id string, chapter string, verse string, options ...*Options) (*Response, error)

ReadVerse Read a verse.

func (*Client) ReplaceLiveDisplay added in v0.3.0 

func (c *Client) ReplaceLiveDisplay(ctx context.Context, live_id string, options ...*Options) (*Response, error)

ReplaceLiveDisplay Replace or clear the Live display.

func (*Client) ReplaceLiveQueueOrder added in v0.3.0 

func (c *Client) ReplaceLiveQueueOrder(ctx context.Context, live_id string, options ...*Options) (*Response, error)

ReplaceLiveQueueOrder Replace queue ordering.

func (*Client) ReplaceOrganizationLiveStudio added in v0.3.0 

func (c *Client) ReplaceOrganizationLiveStudio(ctx context.Context, organization_id string, options ...*Options) (*Response, error)

ReplaceOrganizationLiveStudio Replace organization Live Studio settings.

func (*Client) ReplacePresentation added in v0.3.0 

func (c *Client) ReplacePresentation(ctx context.Context, presentation_id string, options ...*Options) (*Response, error)

ReplacePresentation Replace a saved presentation document.

func (*Client) RevokeCredential 

func (c *Client) RevokeCredential(ctx context.Context) error

RevokeCredential revokes this client's bearer credential via CLI logout. Only HTTP 204 is a successful acknowledgement; errors never mutate the client.

func (*Client) RevokeOAuthGrant added in v0.3.0 

func (c *Client) RevokeOAuthGrant(ctx context.Context, grant_id string, options ...*Options) (*Response, error)

RevokeOAuthGrant Disconnect your OAuth grant.

func (*Client) RevokeServiceToken added in v0.3.0 

func (c *Client) RevokeServiceToken(ctx context.Context, organization_id string, credential_id string, options ...*Options) (*Response, error)

RevokeServiceToken Revoke a service token.

func (*Client) RotateLiveAudienceSecret added in v0.3.0 

func (c *Client) RotateLiveAudienceSecret(ctx context.Context, live_id string, options ...*Options) (*Response, error)

RotateLiveAudienceSecret Rotate a one-time audience secret.

func (*Client) RotateServiceToken added in v0.3.0 

func (c *Client) RotateServiceToken(ctx context.Context, organization_id string, credential_id string, options ...*Options) (*Response, error)

RotateServiceToken Rotate a service-token secret.

func (*Client) SearchPersonalScripture added in v0.3.0 

func (c *Client) SearchPersonalScripture(ctx context.Context, account_id string, slug string, options ...*Options) (*Response, error)

SearchPersonalScripture Search personal account scripture.

func (*Client) SearchScripture added in v0.3.0 

func (c *Client) SearchScripture(ctx context.Context, organization_id string, slug string, options ...*Options) (*Response, error)

SearchScripture Search organization scripture.

func (*Client) StageLiveQueueItem added in v0.4.0 

func (c *Client) StageLiveQueueItem(ctx context.Context, live_id string, options ...*Options) (*Response, error)

StageLiveQueueItem Stage a scripture queue item while stopped.

func (*Client) UpdateLiveMetadata added in v0.3.0 

func (c *Client) UpdateLiveMetadata(ctx context.Context, live_id string, options ...*Options) (*Response, error)

UpdateLiveMetadata Edit Live metadata.

func (*Client) UpdateLivePlayback added in v0.3.0 

func (c *Client) UpdateLivePlayback(ctx context.Context, live_id string, options ...*Options) (*Response, error)

UpdateLivePlayback Update Live playback state.

func (*Client) UpdateLiveSettings added in v0.3.0 

func (c *Client) UpdateLiveSettings(ctx context.Context, live_id string, options ...*Options) (*Response, error)

UpdateLiveSettings Update retained reference and translations.

func (*Client) UpdateOrganizationMember added in v0.3.0 

func (c *Client) UpdateOrganizationMember(ctx context.Context, organization_id string, member_id string, options ...*Options) (*Response, error)

UpdateOrganizationMember Change a member role.

func (*Client) UpdateServiceToken added in v0.3.0 

func (c *Client) UpdateServiceToken(ctx context.Context, organization_id string, credential_id string, options ...*Options) (*Response, error)

UpdateServiceToken Edit service-token configuration.

func (*Client) UploadPresentationAsset added in v0.3.0 

func (c *Client) UploadPresentationAsset(ctx context.Context, presentation_id string, options ...*Options) (*Response, error)

UploadPresentationAsset Upload a staged presentation asset.

type CodeExchange 

type CodeExchange struct {
	Code, Verifier, DeviceName string
}

type Command 

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

Command is a validated customer operation. Its zero value is invalid. String exposes the wire representation for transport adapters; it may contain secrets.

func AccountInfoCommand 

func AccountInfoCommand() Command

func AccountQuotasCommand 

func AccountQuotasCommand() Command

func AccountTokensCommand 

func AccountTokensCommand() Command

func AddTranslationCommand 

func AddTranslationCommand(slug string) (Command, error)

func CreateLiveCommand 

func CreateLiveCommand(name string) (Command, error)

func DeleteAllLivesCommand 

func DeleteAllLivesCommand() Command

func HelpCommand 

func HelpCommand(topic string) (Command, error)

HelpCommand asks the server for commands visible to the current principal. An empty topic selects the root. The server decides permission visibility.

func IdentityCommand 

func IdentityCommand() Command

func LiveCommand 

func LiveCommand(id string, action LiveAction) (Command, error)

func LiveListCommand 

func LiveListCommand() Command

func LiveSecretCommand 

func LiveSecretCommand(id string, action SecretAction, value string) (Command, error)

func LiveStackCommand 

func LiveStackCommand(id string, action StackAction) (Command, error)

func OrganizationApplicationStatusCommand added in v0.0.2 

func OrganizationApplicationStatusCommand(id string) (Command, error)

func OrganizationListCommand added in v0.0.2 

func OrganizationListCommand(cursor string) (Command, error)

OrganizationListCommand returns one page; pass the previous Next cursor unchanged.

func PingCommand 

func PingCommand() Command

func PopLiveCommand 

func PopLiveCommand(id string, count int) (Command, error)

func PushLiveCommand 

func PushLiveCommand(id string, ref Reference) (Command, error)

func ReadCommand 

func ReadCommand(ref Reference) (Command, error)

func RemoveTranslationCommand 

func RemoveTranslationCommand(slug string) (Command, error)

func SearchCommand 

func SearchCommand(translation, query string) (Command, error)

func ServerInfoCommand 

func ServerInfoCommand() Command

func SetLiveCommand 

func SetLiveCommand(id string, field LiveField, values ...string) (Command, error)

func TranslationCatalogCommand 

func TranslationCatalogCommand(slug string) (Command, error)

func TranslationInfoCommand 

func TranslationInfoCommand(slug string) (Command, error)

func TranslationListCommand 

func TranslationListCommand() Command

func (Command) Streaming 

func (c Command) Streaming() bool

func (Command) String 

func (c Command) String() string

type CommandResponse added in v0.3.0 

type CommandResponse struct {
	Lines   []string
	Records []Record
}

CommandResponse retains original lines for CLI raw output. END is excluded. Protocol v1 fields remain strings; future typed models can build on Records.

func DecodeCommandResponse 

func DecodeCommandResponse(command Command, reader io.Reader) (CommandResponse, error)

DecodeCommandResponse uses the command's framing contract for a finite reply. Account translation replies contain count but are single records without END.

func DecodeResponse 

func DecodeResponse(reader io.Reader) (CommandResponse, error)

DecodeResponse decodes one finite HTTP or SSH-exec reply, requiring END for multi-record replies. It is not a decoder for a persistent SSH subscription.

type CreateLive added in v0.3.0 

type CreateLive struct {
	// Name At most 128 UTF-8 bytes.
	Name string `json:"name,omitempty"`
}

CreateLive Examples: {"name":"Sunday Service"}

type CreateLiveAudienceSecretJSONRequestBody added in v0.3.0 

type CreateLiveAudienceSecretJSONRequestBody = EmptyObject

CreateLiveAudienceSecretJSONRequestBody defines body for CreateLiveAudienceSecret for application/json ContentType.

type CreateLiveAudienceSecretParams added in v0.3.0 

type CreateLiveAudienceSecretParams struct {
	// IfMatch Current strong Live ETag. Missing:428; stale:412. No automatic retry.
	IfMatch string `json:"If-Match"`
}

CreateLiveAudienceSecretParams defines parameters for CreateLiveAudienceSecret.

type CreateLiveJSONRequestBody added in v0.3.0 

type CreateLiveJSONRequestBody = CreateLive

CreateLiveJSONRequestBody defines body for CreateLive for application/json ContentType.

type CreateLiveParams added in v0.3.0 

type CreateLiveParams struct {
	// IdempotencyKey Optional case-sensitive retry key, retained 24 hours from successful commit. Scoped to credential principal (stable service-token ID; personal bt_ credential; delegated OAuth grant), account and concrete method/path. Payload, If-Match, query string and Content-Type must match. JSON object key order is ignored; queue reference casing/defaults are normalized; raw upload/import bytes are hashed. Replays retain original success body, Location and ETag with a fresh X-Request-Id, after current authority/ownership/processing/library checks. Same scope/key with changed input:409 idempotency_conflict. Concurrent requests serialize; a contended retry lock can return 409 idempotency_in_progress; bounded database waits can return 503. Errors are not recorded. After expiry, a key is treated as new; original resource/job lifetime is unchanged. No key means no retry guarantee.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

CreateLiveParams defines parameters for CreateLive.

type CreateLiveQueueItem added in v0.3.0 

type CreateLiveQueueItem struct {
	// BeforeItemID Insert before this item ID. Omit or use null to append. Unknown anchor returns 404.
	BeforeItemID json.RawMessage               `json:"before_item_id,omitempty"`
	Reference    CreateLiveQueueItem_Reference `json:"reference"`
}

CreateLiveQueueItem Examples: {"reference":{"book_id":1,"chapter":1,"translation":"web","verse":1}}

type CreateLiveQueueItemJSONRequestBody added in v0.3.0 

type CreateLiveQueueItemJSONRequestBody = CreateLiveQueueItem

CreateLiveQueueItemJSONRequestBody defines body for CreateLiveQueueItem for application/json ContentType.

type CreateLiveQueueItemParams added in v0.3.0 

type CreateLiveQueueItemParams struct {
	// IfMatch Shared Live sequence validator. Any relevant metadata, display, playback or workspace change invalidates it. Missing:428; stale:412; malformed, weak, wildcard or list:422.
	IfMatch string `json:"If-Match"`

	// IdempotencyKey Optional case-sensitive retry key, retained 24 hours from successful commit. Scoped to credential principal (stable service-token ID; personal bt_ credential; delegated OAuth grant), account and concrete method/path. Payload, If-Match, query string and Content-Type must match. JSON object key order is ignored; queue reference casing/defaults are normalized; raw upload/import bytes are hashed. Replays retain original success body, Location and ETag with a fresh X-Request-Id, after current authority/ownership/processing/library checks. Same scope/key with changed input:409 idempotency_conflict. Concurrent requests serialize; a contended retry lock can return 409 idempotency_in_progress; bounded database waits can return 503. Errors are not recorded. After expiry, a key is treated as new; original resource/job lifetime is unchanged. No key means no retry guarantee.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

CreateLiveQueueItemParams defines parameters for CreateLiveQueueItem.

type CreateLiveQueueItem_Reference added in v0.3.1 

type CreateLiveQueueItem_Reference struct {
	BookID      int64  `json:"book_id"`
	Chapter     int64  `json:"chapter"`
	Translation string `json:"translation"`
	Verse       int64  `json:"verse"`
}

CreateLiveQueueItem_Reference defines model for CreateLiveQueueItem.Reference.

type CreatePersonalLiveJSONRequestBody added in v0.3.0 

type CreatePersonalLiveJSONRequestBody = CreateLive

CreatePersonalLiveJSONRequestBody defines body for CreatePersonalLive for application/json ContentType.

type CreatePersonalLiveParams added in v0.3.0 

type CreatePersonalLiveParams struct {
	// IdempotencyKey Optional case-sensitive retry key, retained 24 hours from successful commit. Scoped to credential principal (stable service-token ID; personal bt_ credential; delegated OAuth grant), account and concrete method/path. Payload, If-Match, query string and Content-Type must match. JSON object key order is ignored; queue reference casing/defaults are normalized; raw upload/import bytes are hashed. Replays retain original success body, Location and ETag with a fresh X-Request-Id, after current authority/ownership/processing/library checks. Same scope/key with changed input:409 idempotency_conflict. Concurrent requests serialize; a contended retry lock can return 409 idempotency_in_progress; bounded database waits can return 503. Errors are not recorded. After expiry, a key is treated as new; original resource/job lifetime is unchanged. No key means no retry guarantee.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

CreatePersonalLiveParams defines parameters for CreatePersonalLive.

type CreatePresentation added in v0.3.0 

type CreatePresentation struct {
	// Name UTF-8 text, at most 200 bytes; NUL is rejected.
	Name string `json:"name"`
}

CreatePresentation Examples: {"name":"Sunday"}

type CreatePresentationExport added in v0.3.0 

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

CreatePresentationExport Explicit current saved revision. PNG/JPEG require one slide_index; other formats export the whole deck and reject slide_index. Empty presentations support only bibleit. Locale affects exported navigation labels.

Examples: {"format":"bibleit","revision":1}, {"format":"png","locale":"de","revision":3,"slide_index":0}

func (CreatePresentationExport) AsCreatePresentationExport0 added in v0.3.0 

func (t CreatePresentationExport) AsCreatePresentationExport0() (CreatePresentationExport0, error)

AsCreatePresentationExport0 returns the union data inside the CreatePresentationExport as a CreatePresentationExport0

func (CreatePresentationExport) AsCreatePresentationExport1 added in v0.3.0 

func (t CreatePresentationExport) AsCreatePresentationExport1() (CreatePresentationExport1, error)

AsCreatePresentationExport1 returns the union data inside the CreatePresentationExport as a CreatePresentationExport1

func (*CreatePresentationExport) FromCreatePresentationExport0 added in v0.3.0 

func (t *CreatePresentationExport) FromCreatePresentationExport0(v CreatePresentationExport0) error

FromCreatePresentationExport0 overwrites any union data inside the CreatePresentationExport as the provided CreatePresentationExport0

func (*CreatePresentationExport) FromCreatePresentationExport1 added in v0.3.0 

func (t *CreatePresentationExport) FromCreatePresentationExport1(v CreatePresentationExport1) error

FromCreatePresentationExport1 overwrites any union data inside the CreatePresentationExport as the provided CreatePresentationExport1

func (CreatePresentationExport) MarshalJSON added in v0.3.0 

func (t CreatePresentationExport) MarshalJSON() ([]byte, error)

func (*CreatePresentationExport) MergeCreatePresentationExport0 added in v0.3.0 

func (t *CreatePresentationExport) MergeCreatePresentationExport0(v CreatePresentationExport0) error

MergeCreatePresentationExport0 performs a merge with any union data inside the CreatePresentationExport, using the provided CreatePresentationExport0

func (*CreatePresentationExport) MergeCreatePresentationExport1 added in v0.3.0 

func (t *CreatePresentationExport) MergeCreatePresentationExport1(v CreatePresentationExport1) error

MergeCreatePresentationExport1 performs a merge with any union data inside the CreatePresentationExport, using the provided CreatePresentationExport1

func (*CreatePresentationExport) UnmarshalJSON added in v0.3.0 

func (t *CreatePresentationExport) UnmarshalJSON(b []byte) error

type CreatePresentationExport0 added in v0.3.0 

type CreatePresentationExport0 CreatePresentationExport_0

CreatePresentationExport0 defines model for CreatePresentationExport.0.

type CreatePresentationExport0Format added in v0.3.0 

type CreatePresentationExport0Format string

CreatePresentationExport0Format defines model for CreatePresentationExport.0.Format. 

const (
	CreatePresentationExport0FormatBibleit CreatePresentationExport0Format = "bibleit"
	CreatePresentationExport0FormatHTML    CreatePresentationExport0Format = "html"
	CreatePresentationExport0FormatPdf     CreatePresentationExport0Format = "pdf"
)

Defines values for CreatePresentationExport0Format.

func (CreatePresentationExport0Format) Valid added in v0.3.0 

func (e CreatePresentationExport0Format) Valid() bool

Valid indicates whether the value is a known member of the CreatePresentationExport0Format enum.

type CreatePresentationExport0Locale added in v0.3.0 

type CreatePresentationExport0Locale string

CreatePresentationExport0Locale defines model for CreatePresentationExport.0.Locale. 

const (
	CreatePresentationExport0LocaleDe CreatePresentationExport0Locale = "de"
	CreatePresentationExport0LocaleEn CreatePresentationExport0Locale = "en"
	CreatePresentationExport0LocalePt CreatePresentationExport0Locale = "pt"
)

Defines values for CreatePresentationExport0Locale.

func (CreatePresentationExport0Locale) Valid added in v0.3.0 

func (e CreatePresentationExport0Locale) Valid() bool

Valid indicates whether the value is a known member of the CreatePresentationExport0Locale enum.

type CreatePresentationExport1 added in v0.3.0 

type CreatePresentationExport1 CreatePresentationExport_1

CreatePresentationExport1 defines model for CreatePresentationExport.1.

type CreatePresentationExport1Format added in v0.3.0 

type CreatePresentationExport1Format string

CreatePresentationExport1Format defines model for CreatePresentationExport.1.Format. 

const (
	CreatePresentationExport1FormatJpeg CreatePresentationExport1Format = "jpeg"
	CreatePresentationExport1FormatPng  CreatePresentationExport1Format = "png"
)

Defines values for CreatePresentationExport1Format.

func (CreatePresentationExport1Format) Valid added in v0.3.0 

func (e CreatePresentationExport1Format) Valid() bool

Valid indicates whether the value is a known member of the CreatePresentationExport1Format enum.

type CreatePresentationExport1Locale added in v0.3.0 

type CreatePresentationExport1Locale string

CreatePresentationExport1Locale defines model for CreatePresentationExport.1.Locale. 

const (
	CreatePresentationExport1LocaleDe CreatePresentationExport1Locale = "de"
	CreatePresentationExport1LocaleEn CreatePresentationExport1Locale = "en"
	CreatePresentationExport1LocalePt CreatePresentationExport1Locale = "pt"
)

Defines values for CreatePresentationExport1Locale.

func (CreatePresentationExport1Locale) Valid added in v0.3.0 

func (e CreatePresentationExport1Locale) Valid() bool

Valid indicates whether the value is a known member of the CreatePresentationExport1Locale enum.

type CreatePresentationExportJSONRequestBody added in v0.3.0 

type CreatePresentationExportJSONRequestBody = CreatePresentationExport

CreatePresentationExportJSONRequestBody defines body for CreatePresentationExport for application/json ContentType.

type CreatePresentationExportParams added in v0.3.0 

type CreatePresentationExportParams struct {
	// IdempotencyKey Optional case-sensitive retry key, retained 24 hours from successful commit. Scoped to credential principal (stable service-token ID; personal bt_ credential; delegated OAuth grant), account and concrete method/path. Payload, If-Match, query string and Content-Type must match. JSON object key order is ignored; queue reference casing/defaults are normalized; raw upload/import bytes are hashed. Replays retain original success body, Location and ETag with a fresh X-Request-Id, after current authority/ownership/processing/library checks. Same scope/key with changed input:409 idempotency_conflict. Concurrent requests serialize; a contended retry lock can return 409 idempotency_in_progress; bounded database waits can return 503. Errors are not recorded. After expiry, a key is treated as new; original resource/job lifetime is unchanged. No key means no retry guarantee.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

CreatePresentationExportParams defines parameters for CreatePresentationExport.

type CreatePresentationExport_0 added in v0.3.1 

type CreatePresentationExport_0 struct {
	Format   CreatePresentationExport0Format  `json:"format"`
	Locale   *CreatePresentationExport0Locale `json:"locale,omitempty"`
	Revision int64                            `json:"revision"`
}

CreatePresentationExport_0 defines model for CreatePresentationExport.0.

type CreatePresentationExport_1 added in v0.3.1 

type CreatePresentationExport_1 struct {
	Format   CreatePresentationExport1Format  `json:"format"`
	Locale   *CreatePresentationExport1Locale `json:"locale,omitempty"`
	Revision int64                            `json:"revision"`

	// SlideIndex Required zero-based index in this saved revision.
	SlideIndex int64 `json:"slide_index"`
}

CreatePresentationExport_1 defines model for CreatePresentationExport.1.

type CreatePresentationJSONRequestBody added in v0.3.0 

type CreatePresentationJSONRequestBody = CreatePresentation

CreatePresentationJSONRequestBody defines body for CreatePresentation for application/json ContentType.

type CreatePresentationParams added in v0.3.0 

type CreatePresentationParams struct {
	// IdempotencyKey Optional case-sensitive retry key, retained 24 hours from successful commit. Scoped to credential principal (stable service-token ID; personal bt_ credential; delegated OAuth grant), account and concrete method/path. Payload, If-Match, query string and Content-Type must match. JSON object key order is ignored; queue reference casing/defaults are normalized; raw upload/import bytes are hashed. Replays retain original success body, Location and ETag with a fresh X-Request-Id, after current authority/ownership/processing/library checks. Same scope/key with changed input:409 idempotency_conflict. Concurrent requests serialize; a contended retry lock can return 409 idempotency_in_progress; bounded database waits can return 503. Errors are not recorded. After expiry, a key is treated as new; original resource/job lifetime is unchanged. No key means no retry guarantee.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

CreatePresentationParams defines parameters for CreatePresentation.

type CreateServiceToken added in v0.3.0 

type CreateServiceToken struct {
	// ExpiresAt Future Unix seconds, at most 90 days ahead. Omit for 30 days; null explicitly permits no expiration.
	ExpiresAt json.RawMessage `json:"expires_at,omitempty"`

	// Label At most 128 UTF-8 bytes.
	Label string `json:"label"`

	// Scopes Every scope must be held by the issuer; duplicate entries are normalized.
	Scopes []Scope `json:"scopes"`
}

CreateServiceToken Examples: {"expires_at":null,"label":"Integration backend","scopes":["live.list","live.get"]}

type CreateServiceTokenJSONRequestBody added in v0.3.0 

type CreateServiceTokenJSONRequestBody = CreateServiceToken

CreateServiceTokenJSONRequestBody defines body for CreateServiceToken for application/json ContentType.

type DecideMcpOAuthFormdataBody added in v0.4.0 

type DecideMcpOAuthFormdataBody struct {
	Csrf     string                             `form:"csrf" json:"csrf"`
	Decision DecideMcpOAuthFormdataBodyDecision `form:"decision" json:"decision"`
	Request  string                             `form:"request" json:"request"`
}

DecideMcpOAuthFormdataBody defines parameters for DecideMcpOAuth.

type DecideMcpOAuthFormdataBodyDecision added in v0.4.0 

type DecideMcpOAuthFormdataBodyDecision string

DecideMcpOAuthFormdataBodyDecision defines parameters for DecideMcpOAuth. 

const (
	DecideMcpOAuthFormdataBodyDecisionAllow DecideMcpOAuthFormdataBodyDecision = "allow"
	DecideMcpOAuthFormdataBodyDecisionDeny  DecideMcpOAuthFormdataBodyDecision = "deny"
)

Defines values for DecideMcpOAuthFormdataBodyDecision.

func (DecideMcpOAuthFormdataBodyDecision) Valid added in v0.4.0 

func (e DecideMcpOAuthFormdataBodyDecision) Valid() bool

Valid indicates whether the value is a known member of the DecideMcpOAuthFormdataBodyDecision enum.

type DecideMcpOAuthFormdataRequestBody added in v0.4.0 

type DecideMcpOAuthFormdataRequestBody DecideMcpOAuthFormdataBody

DecideMcpOAuthFormdataRequestBody defines body for DecideMcpOAuth for application/x-www-form-urlencoded ContentType.

type DecideMcpOAuthParams added in v0.4.0 

type DecideMcpOAuthParams struct {
	Origin string `json:"Origin"`
}

DecideMcpOAuthParams defines parameters for DecideMcpOAuth.

type DecideOAuthConsentFormdataBody added in v0.3.0 

type DecideOAuthConsentFormdataBody struct {
	Csrf     string                                 `form:"csrf" json:"csrf"`
	Decision DecideOAuthConsentFormdataBodyDecision `form:"decision" json:"decision"`
	Request  string                                 `form:"request" json:"request"`
}

DecideOAuthConsentFormdataBody defines parameters for DecideOAuthConsent.

type DecideOAuthConsentFormdataBodyDecision added in v0.3.0 

type DecideOAuthConsentFormdataBodyDecision string

DecideOAuthConsentFormdataBodyDecision defines parameters for DecideOAuthConsent. 

const (
	DecideOAuthConsentFormdataBodyDecisionAllow DecideOAuthConsentFormdataBodyDecision = "allow"
	DecideOAuthConsentFormdataBodyDecisionDeny  DecideOAuthConsentFormdataBodyDecision = "deny"
)

Defines values for DecideOAuthConsentFormdataBodyDecision.

func (DecideOAuthConsentFormdataBodyDecision) Valid added in v0.3.0 

func (e DecideOAuthConsentFormdataBodyDecision) Valid() bool

Valid indicates whether the value is a known member of the DecideOAuthConsentFormdataBodyDecision enum.

type DecideOAuthConsentFormdataRequestBody added in v0.3.0 

type DecideOAuthConsentFormdataRequestBody DecideOAuthConsentFormdataBody

DecideOAuthConsentFormdataRequestBody defines body for DecideOAuthConsent for application/x-www-form-urlencoded ContentType.

type DecideOAuthConsentParams added in v0.3.0 

type DecideOAuthConsentParams struct {
	Origin string `json:"Origin"`
}

DecideOAuthConsentParams defines parameters for DecideOAuthConsent.

type DeleteLiveAudienceSecretParams added in v0.3.0 

type DeleteLiveAudienceSecretParams struct {
	// IfMatch Current strong Live ETag. Missing:428; stale:412. No automatic retry.
	IfMatch string `json:"If-Match"`
}

DeleteLiveAudienceSecretParams defines parameters for DeleteLiveAudienceSecret.

type DeleteLiveParams added in v0.3.0 

type DeleteLiveParams struct {
	// IfMatch Required for personal-token deletion. Use the current strong Live ETag. Service-token deletion keeps its existing unconditional semantics.
	IfMatch *string `json:"If-Match,omitempty"`
}

DeleteLiveParams defines parameters for DeleteLive.

type DeleteLiveQueueItemParams added in v0.3.0 

type DeleteLiveQueueItemParams struct {
	// IfMatch Shared Live sequence validator. Any relevant metadata, display, playback or workspace change invalidates it. Missing:428; stale:412; malformed, weak, wildcard or list:422.
	IfMatch string `json:"If-Match"`
}

DeleteLiveQueueItemParams defines parameters for DeleteLiveQueueItem.

type DeleteOrganizationMemberParams added in v0.3.0 

type DeleteOrganizationMemberParams struct {
	// IfMatch Strong validator for this membership representation and row revision. Membership writes require the latest value unchanged. Missing:428; stale:412; malformed, weak, wildcard or list:422.
	IfMatch string `json:"If-Match"`
}

DeleteOrganizationMemberParams defines parameters for DeleteOrganizationMember.

type DeletePresentationParams added in v0.3.0 

type DeletePresentationParams struct {
	// IfMatch Strong validator covering presentation ID, organization, revision and rights-normalized document. Browser/editor saves and changed effective rights notices invalidate it. Missing:428; stale:412; malformed/weak/wildcard/list:422.
	IfMatch string `json:"If-Match"`
}

DeletePresentationParams defines parameters for DeletePresentation.

type DisconnectOAuthAppFormdataBody added in v0.3.0 

type DisconnectOAuthAppFormdataBody struct {
	Csrf    string `form:"csrf" json:"csrf"`
	GrantID string `form:"grant_id" json:"grant_id"`
}

DisconnectOAuthAppFormdataBody defines parameters for DisconnectOAuthApp.

type DisconnectOAuthAppFormdataRequestBody added in v0.3.0 

type DisconnectOAuthAppFormdataRequestBody DisconnectOAuthAppFormdataBody

DisconnectOAuthAppFormdataRequestBody defines body for DisconnectOAuthApp for application/x-www-form-urlencoded ContentType.

type DisconnectOAuthAppParams added in v0.3.0 

type DisconnectOAuthAppParams struct {
	Origin string `json:"Origin"`
}

DisconnectOAuthAppParams defines parameters for DisconnectOAuthApp.

type DisconnectSettingsApplicationFormdataBody added in v0.4.0 

type DisconnectSettingsApplicationFormdataBody struct {
	Csrf    string `form:"csrf" json:"csrf"`
	GrantID string `form:"grant_id" json:"grant_id"`
}

DisconnectSettingsApplicationFormdataBody defines parameters for DisconnectSettingsApplication.

type DisconnectSettingsApplicationFormdataRequestBody added in v0.4.0 

type DisconnectSettingsApplicationFormdataRequestBody DisconnectSettingsApplicationFormdataBody

DisconnectSettingsApplicationFormdataRequestBody defines body for DisconnectSettingsApplication for application/x-www-form-urlencoded ContentType.

type DisconnectSettingsApplicationParams added in v0.4.0 

type DisconnectSettingsApplicationParams struct {
	Origin string `json:"Origin"`
}

DisconnectSettingsApplicationParams defines parameters for DisconnectSettingsApplication.

type DisplayVerse added in v0.3.0 

type DisplayVerse struct {
	Attribution string            `json:"attribution"`
	Book        string            `json:"book"`
	BookID      int64             `json:"book_id"`
	Chapter     int64             `json:"chapter"`
	Rights      TranslationRights `json:"rights"`
	Text        string            `json:"text"`
	Translation string            `json:"translation"`
	Verse       int64             `json:"verse"`
}

DisplayVerse defines model for DisplayVerse.

type DownloadPresentationExportJSONBody added in v0.3.0 

type DownloadPresentationExportJSONBody = EmptyObject

DownloadPresentationExportJSONBody defines parameters for DownloadPresentationExport.

type DownloadPresentationExportJSONRequestBody added in v0.3.0 

type DownloadPresentationExportJSONRequestBody = DownloadPresentationExportJSONBody

DownloadPresentationExportJSONRequestBody defines body for DownloadPresentationExport for application/json ContentType.

type EmptyObject added in v0.3.0 

type EmptyObject = struct{}

EmptyObject defines model for EmptyObject.

type EnableOrganizationTranslationJSONRequestBody added in v0.3.0 

type EnableOrganizationTranslationJSONRequestBody = EmptyObject

EnableOrganizationTranslationJSONRequestBody defines body for EnableOrganizationTranslation for application/json ContentType.

type EnablePersonalTranslationJSONRequestBody added in v0.3.0 

type EnablePersonalTranslationJSONRequestBody = EmptyObject

EnablePersonalTranslationJSONRequestBody defines body for EnablePersonalTranslation for application/json ContentType.

type Event added in v0.3.0 

type Event struct {
	SchemaVersion int                `json:"schema_version"`
	Type          string             `json:"type"`
	ResourceType  string             `json:"resource_type"`
	ResourceID    string             `json:"resource_id"`
	Sequence      int64              `json:"sequence"`
	Cursor        string             `json:"cursor"`
	Data          *LiveEventSnapshot `json:"data"`
}

Event is a v1 snapshot, changed snapshot, or heartbeat. Cursor is opaque and is never an ETag. Data is nil on heartbeats. Sequence can remain unchanged when Studio design changes. Callers should reconnect without a cursor to resync.

type ExchangeMcpOAuthTokenFormdataBody added in v0.4.0 

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

ExchangeMcpOAuthTokenFormdataBody defines parameters for ExchangeMcpOAuthToken.

func (ExchangeMcpOAuthTokenFormdataBody) AsExchangeMcpOAuthTokenFormdataBody0 added in v0.4.0 

func (t ExchangeMcpOAuthTokenFormdataBody) AsExchangeMcpOAuthTokenFormdataBody0() (ExchangeMcpOAuthTokenFormdataBody0, error)

AsExchangeMcpOAuthTokenFormdataBody0 returns the union data inside the ExchangeMcpOAuthTokenFormdataBody as a ExchangeMcpOAuthTokenFormdataBody0

func (ExchangeMcpOAuthTokenFormdataBody) AsExchangeMcpOAuthTokenFormdataBody1 added in v0.4.0 

func (t ExchangeMcpOAuthTokenFormdataBody) AsExchangeMcpOAuthTokenFormdataBody1() (ExchangeMcpOAuthTokenFormdataBody1, error)

AsExchangeMcpOAuthTokenFormdataBody1 returns the union data inside the ExchangeMcpOAuthTokenFormdataBody as a ExchangeMcpOAuthTokenFormdataBody1

func (*ExchangeMcpOAuthTokenFormdataBody) FromExchangeMcpOAuthTokenFormdataBody0 added in v0.4.0 

func (t *ExchangeMcpOAuthTokenFormdataBody) FromExchangeMcpOAuthTokenFormdataBody0(v ExchangeMcpOAuthTokenFormdataBody0) error

FromExchangeMcpOAuthTokenFormdataBody0 overwrites any union data inside the ExchangeMcpOAuthTokenFormdataBody as the provided ExchangeMcpOAuthTokenFormdataBody0

func (*ExchangeMcpOAuthTokenFormdataBody) FromExchangeMcpOAuthTokenFormdataBody1 added in v0.4.0 

func (t *ExchangeMcpOAuthTokenFormdataBody) FromExchangeMcpOAuthTokenFormdataBody1(v ExchangeMcpOAuthTokenFormdataBody1) error

FromExchangeMcpOAuthTokenFormdataBody1 overwrites any union data inside the ExchangeMcpOAuthTokenFormdataBody as the provided ExchangeMcpOAuthTokenFormdataBody1

func (ExchangeMcpOAuthTokenFormdataBody) MarshalJSON added in v0.4.0 

func (t ExchangeMcpOAuthTokenFormdataBody) MarshalJSON() ([]byte, error)

func (*ExchangeMcpOAuthTokenFormdataBody) MergeExchangeMcpOAuthTokenFormdataBody0 added in v0.4.0 

func (t *ExchangeMcpOAuthTokenFormdataBody) MergeExchangeMcpOAuthTokenFormdataBody0(v ExchangeMcpOAuthTokenFormdataBody0) error

MergeExchangeMcpOAuthTokenFormdataBody0 performs a merge with any union data inside the ExchangeMcpOAuthTokenFormdataBody, using the provided ExchangeMcpOAuthTokenFormdataBody0

func (*ExchangeMcpOAuthTokenFormdataBody) MergeExchangeMcpOAuthTokenFormdataBody1 added in v0.4.0 

func (t *ExchangeMcpOAuthTokenFormdataBody) MergeExchangeMcpOAuthTokenFormdataBody1(v ExchangeMcpOAuthTokenFormdataBody1) error

MergeExchangeMcpOAuthTokenFormdataBody1 performs a merge with any union data inside the ExchangeMcpOAuthTokenFormdataBody, using the provided ExchangeMcpOAuthTokenFormdataBody1

func (*ExchangeMcpOAuthTokenFormdataBody) UnmarshalJSON added in v0.4.0 

func (t *ExchangeMcpOAuthTokenFormdataBody) UnmarshalJSON(b []byte) error

type ExchangeMcpOAuthTokenFormdataBody0 added in v0.4.0 

type ExchangeMcpOAuthTokenFormdataBody0 ExchangeMcpOAuthTokenFormdataBody_0

ExchangeMcpOAuthTokenFormdataBody0 defines parameters for ExchangeMcpOAuthToken.

type ExchangeMcpOAuthTokenFormdataBody0GrantType added in v0.4.0 

type ExchangeMcpOAuthTokenFormdataBody0GrantType string

ExchangeMcpOAuthTokenFormdataBody0GrantType defines parameters for ExchangeMcpOAuthToken. 

const (
	ExchangeMcpOAuthTokenFormdataBody0GrantTypeAuthorizationCode ExchangeMcpOAuthTokenFormdataBody0GrantType = "authorization_code"
)

Defines values for ExchangeMcpOAuthTokenFormdataBody0GrantType.

func (ExchangeMcpOAuthTokenFormdataBody0GrantType) Valid added in v0.4.0 

func (e ExchangeMcpOAuthTokenFormdataBody0GrantType) Valid() bool

Valid indicates whether the value is a known member of the ExchangeMcpOAuthTokenFormdataBody0GrantType enum.

type ExchangeMcpOAuthTokenFormdataBody1 added in v0.4.0 

type ExchangeMcpOAuthTokenFormdataBody1 ExchangeMcpOAuthTokenFormdataBody_1

ExchangeMcpOAuthTokenFormdataBody1 defines parameters for ExchangeMcpOAuthToken.

type ExchangeMcpOAuthTokenFormdataBody1GrantType added in v0.4.0 

type ExchangeMcpOAuthTokenFormdataBody1GrantType string

ExchangeMcpOAuthTokenFormdataBody1GrantType defines parameters for ExchangeMcpOAuthToken. 

const (
	ExchangeMcpOAuthTokenFormdataBody1GrantTypeRefreshToken ExchangeMcpOAuthTokenFormdataBody1GrantType = "refresh_token"
)

Defines values for ExchangeMcpOAuthTokenFormdataBody1GrantType.

func (ExchangeMcpOAuthTokenFormdataBody1GrantType) Valid added in v0.4.0 

func (e ExchangeMcpOAuthTokenFormdataBody1GrantType) Valid() bool

Valid indicates whether the value is a known member of the ExchangeMcpOAuthTokenFormdataBody1GrantType enum.

type ExchangeMcpOAuthTokenFormdataBody_0 added in v0.4.0 

type ExchangeMcpOAuthTokenFormdataBody_0 struct {
	ClientID     string                                      `json:"client_id"`
	Code         string                                      `json:"code"`
	CodeVerifier string                                      `json:"code_verifier"`
	GrantType    ExchangeMcpOAuthTokenFormdataBody0GrantType `json:"grant_type"`
	RedirectURI  string                                      `json:"redirect_uri"`

	// Resource Optional MCP resource indicator. Must equal the configured MCP resource URI and remain identical at code and refresh exchange. Omit for existing REST-only grants. MCP permits identity.read, offline_access and the read-only scopes advertised by its issuer metadata. Newly requested scopes require client approval and fresh user consent; existing grants are never widened automatically.
	Resource string `json:"resource"`
}

ExchangeMcpOAuthTokenFormdataBody_0 defines parameters for ExchangeMcpOAuthToken.

type ExchangeMcpOAuthTokenFormdataBody_1 added in v0.4.0 

type ExchangeMcpOAuthTokenFormdataBody_1 struct {
	ClientID     string                                      `json:"client_id"`
	GrantType    ExchangeMcpOAuthTokenFormdataBody1GrantType `json:"grant_type"`
	RefreshToken string                                      `json:"refresh_token"`

	// Resource Optional MCP resource indicator. Must equal the configured MCP resource URI and remain identical at code and refresh exchange. Omit for existing REST-only grants. MCP permits identity.read, offline_access and the read-only scopes advertised by its issuer metadata. Newly requested scopes require client approval and fresh user consent; existing grants are never widened automatically.
	Resource string `json:"resource"`

	// Scope Space-separated explicit registered personal scopes. No empty scope. offline_access alone is invalid.
	Scope *string `json:"scope,omitempty"`
}

ExchangeMcpOAuthTokenFormdataBody_1 defines parameters for ExchangeMcpOAuthToken.

type ExchangeMcpOAuthTokenFormdataRequestBody added in v0.4.0 

type ExchangeMcpOAuthTokenFormdataRequestBody ExchangeMcpOAuthTokenFormdataBody

ExchangeMcpOAuthTokenFormdataRequestBody defines body for ExchangeMcpOAuthToken for application/x-www-form-urlencoded ContentType.

type ExchangeOAuthTokenFormdataBody added in v0.3.0 

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

ExchangeOAuthTokenFormdataBody defines parameters for ExchangeOAuthToken.

func (ExchangeOAuthTokenFormdataBody) AsExchangeOAuthTokenFormdataBody0 added in v0.3.0 

func (t ExchangeOAuthTokenFormdataBody) AsExchangeOAuthTokenFormdataBody0() (ExchangeOAuthTokenFormdataBody0, error)

AsExchangeOAuthTokenFormdataBody0 returns the union data inside the ExchangeOAuthTokenFormdataBody as a ExchangeOAuthTokenFormdataBody0

func (ExchangeOAuthTokenFormdataBody) AsExchangeOAuthTokenFormdataBody1 added in v0.3.0 

func (t ExchangeOAuthTokenFormdataBody) AsExchangeOAuthTokenFormdataBody1() (ExchangeOAuthTokenFormdataBody1, error)

AsExchangeOAuthTokenFormdataBody1 returns the union data inside the ExchangeOAuthTokenFormdataBody as a ExchangeOAuthTokenFormdataBody1

func (*ExchangeOAuthTokenFormdataBody) FromExchangeOAuthTokenFormdataBody0 added in v0.3.0 

func (t *ExchangeOAuthTokenFormdataBody) FromExchangeOAuthTokenFormdataBody0(v ExchangeOAuthTokenFormdataBody0) error

FromExchangeOAuthTokenFormdataBody0 overwrites any union data inside the ExchangeOAuthTokenFormdataBody as the provided ExchangeOAuthTokenFormdataBody0

func (*ExchangeOAuthTokenFormdataBody) FromExchangeOAuthTokenFormdataBody1 added in v0.3.0 

func (t *ExchangeOAuthTokenFormdataBody) FromExchangeOAuthTokenFormdataBody1(v ExchangeOAuthTokenFormdataBody1) error

FromExchangeOAuthTokenFormdataBody1 overwrites any union data inside the ExchangeOAuthTokenFormdataBody as the provided ExchangeOAuthTokenFormdataBody1

func (ExchangeOAuthTokenFormdataBody) MarshalJSON added in v0.3.0 

func (t ExchangeOAuthTokenFormdataBody) MarshalJSON() ([]byte, error)

func (*ExchangeOAuthTokenFormdataBody) MergeExchangeOAuthTokenFormdataBody0 added in v0.3.0 

func (t *ExchangeOAuthTokenFormdataBody) MergeExchangeOAuthTokenFormdataBody0(v ExchangeOAuthTokenFormdataBody0) error

MergeExchangeOAuthTokenFormdataBody0 performs a merge with any union data inside the ExchangeOAuthTokenFormdataBody, using the provided ExchangeOAuthTokenFormdataBody0

func (*ExchangeOAuthTokenFormdataBody) MergeExchangeOAuthTokenFormdataBody1 added in v0.3.0 

func (t *ExchangeOAuthTokenFormdataBody) MergeExchangeOAuthTokenFormdataBody1(v ExchangeOAuthTokenFormdataBody1) error

MergeExchangeOAuthTokenFormdataBody1 performs a merge with any union data inside the ExchangeOAuthTokenFormdataBody, using the provided ExchangeOAuthTokenFormdataBody1

func (*ExchangeOAuthTokenFormdataBody) UnmarshalJSON added in v0.3.0 

func (t *ExchangeOAuthTokenFormdataBody) UnmarshalJSON(b []byte) error

type ExchangeOAuthTokenFormdataBody0 added in v0.3.0 

type ExchangeOAuthTokenFormdataBody0 ExchangeOAuthTokenFormdataBody_0

ExchangeOAuthTokenFormdataBody0 defines parameters for ExchangeOAuthToken.

type ExchangeOAuthTokenFormdataBody0GrantType added in v0.3.0 

type ExchangeOAuthTokenFormdataBody0GrantType string

ExchangeOAuthTokenFormdataBody0GrantType defines parameters for ExchangeOAuthToken. 

const (
	ExchangeOAuthTokenFormdataBody0GrantTypeAuthorizationCode ExchangeOAuthTokenFormdataBody0GrantType = "authorization_code"
)

Defines values for ExchangeOAuthTokenFormdataBody0GrantType.

func (ExchangeOAuthTokenFormdataBody0GrantType) Valid added in v0.3.0 

func (e ExchangeOAuthTokenFormdataBody0GrantType) Valid() bool

Valid indicates whether the value is a known member of the ExchangeOAuthTokenFormdataBody0GrantType enum.

type ExchangeOAuthTokenFormdataBody1 added in v0.3.0 

type ExchangeOAuthTokenFormdataBody1 ExchangeOAuthTokenFormdataBody_1

ExchangeOAuthTokenFormdataBody1 defines parameters for ExchangeOAuthToken.

type ExchangeOAuthTokenFormdataBody1GrantType added in v0.3.0 

type ExchangeOAuthTokenFormdataBody1GrantType string

ExchangeOAuthTokenFormdataBody1GrantType defines parameters for ExchangeOAuthToken. 

const (
	ExchangeOAuthTokenFormdataBody1GrantTypeRefreshToken ExchangeOAuthTokenFormdataBody1GrantType = "refresh_token"
)

Defines values for ExchangeOAuthTokenFormdataBody1GrantType.

func (ExchangeOAuthTokenFormdataBody1GrantType) Valid added in v0.3.0 

func (e ExchangeOAuthTokenFormdataBody1GrantType) Valid() bool

Valid indicates whether the value is a known member of the ExchangeOAuthTokenFormdataBody1GrantType enum.

type ExchangeOAuthTokenFormdataBody_0 added in v0.3.1 

type ExchangeOAuthTokenFormdataBody_0 struct {
	ClientID     string                                   `json:"client_id"`
	Code         string                                   `json:"code"`
	CodeVerifier string                                   `json:"code_verifier"`
	GrantType    ExchangeOAuthTokenFormdataBody0GrantType `json:"grant_type"`
	RedirectURI  string                                   `json:"redirect_uri"`
}

ExchangeOAuthTokenFormdataBody_0 defines parameters for ExchangeOAuthToken.

type ExchangeOAuthTokenFormdataBody_1 added in v0.3.1 

type ExchangeOAuthTokenFormdataBody_1 struct {
	ClientID     string                                   `json:"client_id"`
	GrantType    ExchangeOAuthTokenFormdataBody1GrantType `json:"grant_type"`
	RefreshToken string                                   `json:"refresh_token"`

	// Scope Space-separated explicit registered personal scopes. No empty scope. offline_access alone is invalid.
	Scope *string `json:"scope,omitempty"`
}

ExchangeOAuthTokenFormdataBody_1 defines parameters for ExchangeOAuthToken.

type ExchangeOAuthTokenFormdataRequestBody added in v0.3.0 

type ExchangeOAuthTokenFormdataRequestBody ExchangeOAuthTokenFormdataBody

ExchangeOAuthTokenFormdataRequestBody defines body for ExchangeOAuthToken for application/x-www-form-urlencoded ContentType.

type GetLive200JSONResponseBody added in v0.3.0 

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

GetLive200JSONResponseBody defines parameters for GetLive.

func (GetLive200JSONResponseBody) AsLive added in v0.3.0 

func (t GetLive200JSONResponseBody) AsLive() (Live, error)

AsLive returns the union data inside the GetLive200JSONResponseBody as a Live

func (GetLive200JSONResponseBody) AsPersonalLive added in v0.3.0 

func (t GetLive200JSONResponseBody) AsPersonalLive() (PersonalLive, error)

AsPersonalLive returns the union data inside the GetLive200JSONResponseBody as a PersonalLive

func (*GetLive200JSONResponseBody) FromLive added in v0.3.0 

func (t *GetLive200JSONResponseBody) FromLive(v Live) error

FromLive overwrites any union data inside the GetLive200JSONResponseBody as the provided Live

func (*GetLive200JSONResponseBody) FromPersonalLive added in v0.3.0 

func (t *GetLive200JSONResponseBody) FromPersonalLive(v PersonalLive) error

FromPersonalLive overwrites any union data inside the GetLive200JSONResponseBody as the provided PersonalLive

func (GetLive200JSONResponseBody) MarshalJSON added in v0.3.0 

func (t GetLive200JSONResponseBody) MarshalJSON() ([]byte, error)

func (*GetLive200JSONResponseBody) MergeLive added in v0.3.0 

func (t *GetLive200JSONResponseBody) MergeLive(v Live) error

MergeLive performs a merge with any union data inside the GetLive200JSONResponseBody, using the provided Live

func (*GetLive200JSONResponseBody) MergePersonalLive added in v0.3.0 

func (t *GetLive200JSONResponseBody) MergePersonalLive(v PersonalLive) error

MergePersonalLive performs a merge with any union data inside the GetLive200JSONResponseBody, using the provided PersonalLive

func (*GetLive200JSONResponseBody) UnmarshalJSON added in v0.3.0 

func (t *GetLive200JSONResponseBody) UnmarshalJSON(b []byte) error

type GetLiveDisplay200JSONResponseBody added in v0.3.0 

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

GetLiveDisplay200JSONResponseBody defines parameters for GetLiveDisplay.

func (GetLiveDisplay200JSONResponseBody) AsLiveDisplay added in v0.3.0 

func (t GetLiveDisplay200JSONResponseBody) AsLiveDisplay() (LiveDisplay, error)

AsLiveDisplay returns the union data inside the GetLiveDisplay200JSONResponseBody as a LiveDisplay

func (GetLiveDisplay200JSONResponseBody) AsPersonalLiveDisplay added in v0.3.0 

func (t GetLiveDisplay200JSONResponseBody) AsPersonalLiveDisplay() (PersonalLiveDisplay, error)

AsPersonalLiveDisplay returns the union data inside the GetLiveDisplay200JSONResponseBody as a PersonalLiveDisplay

func (*GetLiveDisplay200JSONResponseBody) FromLiveDisplay added in v0.3.0 

func (t *GetLiveDisplay200JSONResponseBody) FromLiveDisplay(v LiveDisplay) error

FromLiveDisplay overwrites any union data inside the GetLiveDisplay200JSONResponseBody as the provided LiveDisplay

func (*GetLiveDisplay200JSONResponseBody) FromPersonalLiveDisplay added in v0.3.0 

func (t *GetLiveDisplay200JSONResponseBody) FromPersonalLiveDisplay(v PersonalLiveDisplay) error

FromPersonalLiveDisplay overwrites any union data inside the GetLiveDisplay200JSONResponseBody as the provided PersonalLiveDisplay

func (GetLiveDisplay200JSONResponseBody) MarshalJSON added in v0.3.0 

func (t GetLiveDisplay200JSONResponseBody) MarshalJSON() ([]byte, error)

func (*GetLiveDisplay200JSONResponseBody) MergeLiveDisplay added in v0.3.0 

func (t *GetLiveDisplay200JSONResponseBody) MergeLiveDisplay(v LiveDisplay) error

MergeLiveDisplay performs a merge with any union data inside the GetLiveDisplay200JSONResponseBody, using the provided LiveDisplay

func (*GetLiveDisplay200JSONResponseBody) MergePersonalLiveDisplay added in v0.3.0 

func (t *GetLiveDisplay200JSONResponseBody) MergePersonalLiveDisplay(v PersonalLiveDisplay) error

MergePersonalLiveDisplay performs a merge with any union data inside the GetLiveDisplay200JSONResponseBody, using the provided PersonalLiveDisplay

func (*GetLiveDisplay200JSONResponseBody) UnmarshalJSON added in v0.3.0 

func (t *GetLiveDisplay200JSONResponseBody) UnmarshalJSON(b []byte) error

type GetLiveEventsParams added in v0.3.0 

type GetLiveEventsParams struct {
	// After Previous cursor returned by this resource. Omit to obtain a fresh snapshot on reconnect.
	After *string `form:"after,omitempty" json:"after,omitempty"`

	// Wait Maximum intended idle wait in seconds. Dependency/actor queue delays may add normal request latency; clients should allow timeout margin.
	Wait *int64 `form:"wait,omitempty" json:"wait,omitempty"`
}

GetLiveEventsParams defines parameters for GetLiveEvents.

func (GetLiveEventsParams) QueryValues added in v0.3.1 

func (p GetLiveEventsParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (GetLiveEventsParams) WithAfter added in v0.3.1 

func (p GetLiveEventsParams) WithAfter(value string) GetLiveEventsParams

WithAfter returns a copy with the after query parameter set.

func (GetLiveEventsParams) WithWait added in v0.3.1 

func (p GetLiveEventsParams) WithWait(value int64) GetLiveEventsParams

WithWait returns a copy with the wait query parameter set.

type GetPresentationAssetParams added in v0.3.0 

type GetPresentationAssetParams struct {
	// Range Optional single bytes range, for example bytes=0-1023 or bytes=-1024.
	Range *string `json:"Range,omitempty"`
}

GetPresentationAssetParams defines parameters for GetPresentationAsset.

type HTTPError 

type HTTPError struct {
	StatusCode int
	Code       string
	Fields     map[string]any
}

HTTPError represents a failure without a usable protocol error envelope.

func (*HTTPError) Error 

func (e *HTTPError) Error() string

type HelpEntry 

type HelpEntry struct {
	Usage, Summary string
	// Auth is "none" when the server omits the auth field.
	Auth   string
	Fields map[string]string
}

type HelpResult 

type HelpResult struct {
	Authenticated bool
	Commands      []HelpEntry
	Raw           CommandResponse
}

type IdempotencyKey added in v0.3.0 

type IdempotencyKey = string

IdempotencyKey defines model for IdempotencyKey.

type IdentityInfo 

type IdentityInfo struct {
	Actor, DisplayName, IdentityName, AuthProvider, KeyFingerprint string
	Authenticated                                                  bool
	Roles, Permissions                                             []string
	Raw                                                            CommandResponse
}

type ImportPresentationParams added in v0.3.0 

type ImportPresentationParams struct {
	// ContentLength Required exact raw body byte count. Missing returns 411, excessive returns 413. Chunked-only requests are unsupported.
	ContentLength int64 `json:"Content-Length"`

	// IdempotencyKey Optional case-sensitive retry key, retained 24 hours from successful commit. Scoped to credential principal (stable service-token ID; personal bt_ credential; delegated OAuth grant), account and concrete method/path. Payload, If-Match, query string and Content-Type must match. JSON object key order is ignored; queue reference casing/defaults are normalized; raw upload/import bytes are hashed. Replays retain original success body, Location and ETag with a fresh X-Request-Id, after current authority/ownership/processing/library checks. Same scope/key with changed input:409 idempotency_conflict. Concurrent requests serialize; a contended retry lock can return 409 idempotency_in_progress; bounded database waits can return 503. Errors are not recorded. After expiry, a key is treated as new; original resource/job lifetime is unchanged. No key means no retry guarantee.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

ImportPresentationParams defines parameters for ImportPresentation.

type IssuedServiceToken added in v0.3.0 

type IssuedServiceToken struct {
	// ExpiresAt Unix timestamp in seconds; null means no deadline or no recorded use.
	ExpiresAt      *int64  `json:"expires_at"`
	ID             string  `json:"id"`
	Label          string  `json:"label"`
	OrganizationID string  `json:"organization_id"`
	Scopes         []Scope `json:"scopes"`

	// Secret Returned once. Store in a confidential backend.
	Secret string `json:"secret"`
}

IssuedServiceToken defines model for IssuedServiceToken.

type ListBooksParams added in v0.3.0 

type ListBooksParams struct {
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Cursor returned by this collection; book collections use the canonical numeric ID. Translation collections use lowercase slugs.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ListBooksParams defines parameters for ListBooks.

func (ListBooksParams) QueryValues added in v0.3.1 

func (p ListBooksParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ListBooksParams) WithAfter added in v0.3.1 

func (p ListBooksParams) WithAfter(value string) ListBooksParams

WithAfter returns a copy with the after query parameter set.

func (ListBooksParams) WithLimit added in v0.3.1 

func (p ListBooksParams) WithLimit(value int64) ListBooksParams

WithLimit returns a copy with the limit query parameter set.

type ListLiveQueueItems200JSONResponseBody added in v0.3.0 

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

ListLiveQueueItems200JSONResponseBody defines parameters for ListLiveQueueItems.

func (ListLiveQueueItems200JSONResponseBody) AsLiveQueuePage added in v0.3.0 

func (t ListLiveQueueItems200JSONResponseBody) AsLiveQueuePage() (LiveQueuePage, error)

AsLiveQueuePage returns the union data inside the ListLiveQueueItems200JSONResponseBody as a LiveQueuePage

func (ListLiveQueueItems200JSONResponseBody) AsPersonalLiveQueuePage added in v0.3.0 

func (t ListLiveQueueItems200JSONResponseBody) AsPersonalLiveQueuePage() (PersonalLiveQueuePage, error)

AsPersonalLiveQueuePage returns the union data inside the ListLiveQueueItems200JSONResponseBody as a PersonalLiveQueuePage

func (*ListLiveQueueItems200JSONResponseBody) FromLiveQueuePage added in v0.3.0 

func (t *ListLiveQueueItems200JSONResponseBody) FromLiveQueuePage(v LiveQueuePage) error

FromLiveQueuePage overwrites any union data inside the ListLiveQueueItems200JSONResponseBody as the provided LiveQueuePage

func (*ListLiveQueueItems200JSONResponseBody) FromPersonalLiveQueuePage added in v0.3.0 

func (t *ListLiveQueueItems200JSONResponseBody) FromPersonalLiveQueuePage(v PersonalLiveQueuePage) error

FromPersonalLiveQueuePage overwrites any union data inside the ListLiveQueueItems200JSONResponseBody as the provided PersonalLiveQueuePage

func (ListLiveQueueItems200JSONResponseBody) MarshalJSON added in v0.3.0 

func (t ListLiveQueueItems200JSONResponseBody) MarshalJSON() ([]byte, error)

func (*ListLiveQueueItems200JSONResponseBody) MergeLiveQueuePage added in v0.3.0 

func (t *ListLiveQueueItems200JSONResponseBody) MergeLiveQueuePage(v LiveQueuePage) error

MergeLiveQueuePage performs a merge with any union data inside the ListLiveQueueItems200JSONResponseBody, using the provided LiveQueuePage

func (*ListLiveQueueItems200JSONResponseBody) MergePersonalLiveQueuePage added in v0.3.0 

func (t *ListLiveQueueItems200JSONResponseBody) MergePersonalLiveQueuePage(v PersonalLiveQueuePage) error

MergePersonalLiveQueuePage performs a merge with any union data inside the ListLiveQueueItems200JSONResponseBody, using the provided PersonalLiveQueuePage

func (*ListLiveQueueItems200JSONResponseBody) UnmarshalJSON added in v0.3.0 

func (t *ListLiveQueueItems200JSONResponseBody) UnmarshalJSON(b []byte) error

type ListLiveQueueItemsParams added in v0.3.0 

type ListLiveQueueItemsParams struct {
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Opaque sequence-bound next_cursor from this collection.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ListLiveQueueItemsParams defines parameters for ListLiveQueueItems.

func (ListLiveQueueItemsParams) QueryValues added in v0.3.1 

func (p ListLiveQueueItemsParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ListLiveQueueItemsParams) WithAfter added in v0.3.1 

func (p ListLiveQueueItemsParams) WithAfter(value string) ListLiveQueueItemsParams

WithAfter returns a copy with the after query parameter set.

func (ListLiveQueueItemsParams) WithLimit added in v0.3.1 

func (p ListLiveQueueItemsParams) WithLimit(value int64) ListLiveQueueItemsParams

WithLimit returns a copy with the limit query parameter set.

type ListLivesParams added in v0.3.0 

type ListLivesParams struct {
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Opaque cursor returned as next_cursor.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ListLivesParams defines parameters for ListLives.

func (ListLivesParams) QueryValues added in v0.3.1 

func (p ListLivesParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ListLivesParams) WithAfter added in v0.3.1 

func (p ListLivesParams) WithAfter(value string) ListLivesParams

WithAfter returns a copy with the after query parameter set.

func (ListLivesParams) WithLimit added in v0.3.1 

func (p ListLivesParams) WithLimit(value int64) ListLivesParams

WithLimit returns a copy with the limit query parameter set.

type ListOrganizationMembersParams added in v0.3.0 

type ListOrganizationMembersParams struct {
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Opaque next_cursor from this collection.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ListOrganizationMembersParams defines parameters for ListOrganizationMembers.

func (ListOrganizationMembersParams) QueryValues added in v0.3.1 

func (p ListOrganizationMembersParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ListOrganizationMembersParams) WithAfter added in v0.3.1 

func (p ListOrganizationMembersParams) WithAfter(value string) ListOrganizationMembersParams

WithAfter returns a copy with the after query parameter set.

func (ListOrganizationMembersParams) WithLimit added in v0.3.1 

func (p ListOrganizationMembersParams) WithLimit(value int64) ListOrganizationMembersParams

WithLimit returns a copy with the limit query parameter set.

type ListOrganizationTranslationsParams added in v0.3.0 

type ListOrganizationTranslationsParams struct {
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Cursor returned by this collection; book collections use the canonical numeric ID. Translation collections use lowercase slugs.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ListOrganizationTranslationsParams defines parameters for ListOrganizationTranslations.

func (ListOrganizationTranslationsParams) QueryValues added in v0.3.1 

func (p ListOrganizationTranslationsParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ListOrganizationTranslationsParams) WithAfter added in v0.3.1 

func (p ListOrganizationTranslationsParams) WithAfter(value string) ListOrganizationTranslationsParams

WithAfter returns a copy with the after query parameter set.

func (ListOrganizationTranslationsParams) WithLimit added in v0.3.1 

func (p ListOrganizationTranslationsParams) WithLimit(value int64) ListOrganizationTranslationsParams

WithLimit returns a copy with the limit query parameter set.

type ListPersonalAccountsParams added in v0.3.0 

type ListPersonalAccountsParams struct {
	// Limit Page size.
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Opaque next_cursor from a previous response. At most 128 UTF-8 bytes.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ListPersonalAccountsParams defines parameters for ListPersonalAccounts.

func (ListPersonalAccountsParams) QueryValues added in v0.3.1 

func (p ListPersonalAccountsParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ListPersonalAccountsParams) WithAfter added in v0.3.1 

func (p ListPersonalAccountsParams) WithAfter(value string) ListPersonalAccountsParams

WithAfter returns a copy with the after query parameter set.

func (ListPersonalAccountsParams) WithLimit added in v0.3.1 

func (p ListPersonalAccountsParams) WithLimit(value int64) ListPersonalAccountsParams

WithLimit returns a copy with the limit query parameter set.

type ListPersonalLivesParams added in v0.3.0 

type ListPersonalLivesParams struct {
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Opaque cursor returned as next_cursor.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ListPersonalLivesParams defines parameters for ListPersonalLives.

func (ListPersonalLivesParams) QueryValues added in v0.3.1 

func (p ListPersonalLivesParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ListPersonalLivesParams) WithAfter added in v0.3.1 

func (p ListPersonalLivesParams) WithAfter(value string) ListPersonalLivesParams

WithAfter returns a copy with the after query parameter set.

func (ListPersonalLivesParams) WithLimit added in v0.3.1 

func (p ListPersonalLivesParams) WithLimit(value int64) ListPersonalLivesParams

WithLimit returns a copy with the limit query parameter set.

type ListPersonalOrganizationsParams added in v0.3.0 

type ListPersonalOrganizationsParams struct {
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ListPersonalOrganizationsParams defines parameters for ListPersonalOrganizations.

func (ListPersonalOrganizationsParams) QueryValues added in v0.3.1 

func (p ListPersonalOrganizationsParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ListPersonalOrganizationsParams) WithAfter added in v0.3.1 

func (p ListPersonalOrganizationsParams) WithAfter(value string) ListPersonalOrganizationsParams

WithAfter returns a copy with the after query parameter set.

type ListPersonalTokensParams added in v0.3.0 

type ListPersonalTokensParams struct {
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Cursor returned by this collection; book collections use the canonical numeric ID. Translation collections use lowercase slugs.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ListPersonalTokensParams defines parameters for ListPersonalTokens.

func (ListPersonalTokensParams) QueryValues added in v0.3.1 

func (p ListPersonalTokensParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ListPersonalTokensParams) WithAfter added in v0.3.1 

func (p ListPersonalTokensParams) WithAfter(value string) ListPersonalTokensParams

WithAfter returns a copy with the after query parameter set.

func (ListPersonalTokensParams) WithLimit added in v0.3.1 

func (p ListPersonalTokensParams) WithLimit(value int64) ListPersonalTokensParams

WithLimit returns a copy with the limit query parameter set.

type ListPersonalTranslationsParams added in v0.3.0 

type ListPersonalTranslationsParams struct {
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Cursor returned by this collection; book collections use the canonical numeric ID. Translation collections use lowercase slugs.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ListPersonalTranslationsParams defines parameters for ListPersonalTranslations.

func (ListPersonalTranslationsParams) QueryValues added in v0.3.1 

func (p ListPersonalTranslationsParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ListPersonalTranslationsParams) WithAfter added in v0.3.1 

func (p ListPersonalTranslationsParams) WithAfter(value string) ListPersonalTranslationsParams

WithAfter returns a copy with the after query parameter set.

func (ListPersonalTranslationsParams) WithLimit added in v0.3.1 

func (p ListPersonalTranslationsParams) WithLimit(value int64) ListPersonalTranslationsParams

WithLimit returns a copy with the limit query parameter set.

type ListPresentationExportsParams added in v0.3.0 

type ListPresentationExportsParams struct {
	// Limit Page size.
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Opaque next_cursor from a previous response. At most 128 UTF-8 bytes.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ListPresentationExportsParams defines parameters for ListPresentationExports.

func (ListPresentationExportsParams) QueryValues added in v0.3.1 

func (p ListPresentationExportsParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ListPresentationExportsParams) WithAfter added in v0.3.1 

func (p ListPresentationExportsParams) WithAfter(value string) ListPresentationExportsParams

WithAfter returns a copy with the after query parameter set.

func (ListPresentationExportsParams) WithLimit added in v0.3.1 

func (p ListPresentationExportsParams) WithLimit(value int64) ListPresentationExportsParams

WithLimit returns a copy with the limit query parameter set.

type ListPresentationsParams added in v0.3.0 

type ListPresentationsParams struct {
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Opaque next_cursor from the prior page.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ListPresentationsParams defines parameters for ListPresentations.

func (ListPresentationsParams) QueryValues added in v0.3.1 

func (p ListPresentationsParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ListPresentationsParams) WithAfter added in v0.3.1 

func (p ListPresentationsParams) WithAfter(value string) ListPresentationsParams

WithAfter returns a copy with the after query parameter set.

func (ListPresentationsParams) WithLimit added in v0.3.1 

func (p ListPresentationsParams) WithLimit(value int64) ListPresentationsParams

WithLimit returns a copy with the limit query parameter set.

type ListServiceTokensParams added in v0.3.0 

type ListServiceTokensParams struct {
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Opaque cursor returned as next_cursor.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ListServiceTokensParams defines parameters for ListServiceTokens.

func (ListServiceTokensParams) QueryValues added in v0.3.1 

func (p ListServiceTokensParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ListServiceTokensParams) WithAfter added in v0.3.1 

func (p ListServiceTokensParams) WithAfter(value string) ListServiceTokensParams

WithAfter returns a copy with the after query parameter set.

func (ListServiceTokensParams) WithLimit added in v0.3.1 

func (p ListServiceTokensParams) WithLimit(value int64) ListServiceTokensParams

WithLimit returns a copy with the limit query parameter set.

type ListTranslationBooksParams added in v0.3.0 

type ListTranslationBooksParams struct {
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Cursor returned by this collection; book collections use the canonical numeric ID. Translation collections use lowercase slugs.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ListTranslationBooksParams defines parameters for ListTranslationBooks.

func (ListTranslationBooksParams) QueryValues added in v0.3.1 

func (p ListTranslationBooksParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ListTranslationBooksParams) WithAfter added in v0.3.1 

func (p ListTranslationBooksParams) WithAfter(value string) ListTranslationBooksParams

WithAfter returns a copy with the after query parameter set.

func (ListTranslationBooksParams) WithLimit added in v0.3.1 

func (p ListTranslationBooksParams) WithLimit(value int64) ListTranslationBooksParams

WithLimit returns a copy with the limit query parameter set.

type ListTranslationCatalogueParams added in v0.3.0 

type ListTranslationCatalogueParams struct {
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Cursor returned by this collection; book collections use the canonical numeric ID. Translation collections use lowercase slugs.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ListTranslationCatalogueParams defines parameters for ListTranslationCatalogue.

func (ListTranslationCatalogueParams) QueryValues added in v0.3.1 

func (p ListTranslationCatalogueParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ListTranslationCatalogueParams) WithAfter added in v0.3.1 

func (p ListTranslationCatalogueParams) WithAfter(value string) ListTranslationCatalogueParams

WithAfter returns a copy with the after query parameter set.

func (ListTranslationCatalogueParams) WithLimit added in v0.3.1 

func (p ListTranslationCatalogueParams) WithLimit(value int64) ListTranslationCatalogueParams

WithLimit returns a copy with the limit query parameter set.

type Live added in v0.3.0 

type Live struct {
	ID             string     `json:"id"`
	Mode           LiveMode   `json:"mode"`
	Name           string     `json:"name"`
	OrganizationID string     `json:"organization_id"`
	Paused         bool       `json:"paused"`
	Sequence       int64      `json:"sequence"`
	Status         LiveStatus `json:"status"`
}

Live Examples: {"id":"sample-live","mode":"reader","name":"Sunday Service","organization_id":"00000000-0000-4000-8000-000000000001","paused":false,"sequence":0,"status":"stopped"}

type LiveAction 

type LiveAction string
const (
	LiveInfo      LiveAction = "INFO"
	LiveStats     LiveAction = "STATS"
	LiveStart     LiveAction = "START"
	LiveStop      LiveAction = "STOP"
	LivePause     LiveAction = "PAUSE"
	LiveResume    LiveAction = "RESUME"
	LiveClear     LiveAction = "CLEAR"
	LiveDelete    LiveAction = "DELETE"
	LiveSubscribe LiveAction = "SUBSCRIBE"
)

type LiveActionResult 

type LiveActionResult struct {
	State  *LiveState
	Paused *bool
	Event  string
	Raw    CommandResponse
}

LiveActionResult reflects the server acknowledgement without fetching state.

type LiveAudienceSecret added in v0.3.0 

type LiveAudienceSecret struct {
	LiveID    string  `json:"live_id"`
	Protected bool    `json:"protected"`
	Secret    *string `json:"secret,omitempty"`
	Sequence  int64   `json:"sequence"`
}

LiveAudienceSecret defines model for LiveAudienceSecret.

type LiveBulkDeletion added in v0.3.0 

type LiveBulkDeletion struct {
	Deleted int64 `json:"deleted"`
}

LiveBulkDeletion defines model for LiveBulkDeletion.

type LiveConnection 

type LiveConnection struct {
	Actor, Access                    string
	ConnectedAt, ConnectedForSeconds int64
	Fields                           map[string]string
}

type LiveDisplay added in v0.3.0 

type LiveDisplay struct {
	LiveID         string            `json:"live_id"`
	OrganizationID string            `json:"organization_id"`
	Paused         bool              `json:"paused"`
	Sequence       int64             `json:"sequence"`
	Showing        bool              `json:"showing"`
	Snapshot       *SnapshotSummary  `json:"snapshot"`
	Status         LiveDisplayStatus `json:"status"`
	Type           LiveDisplayType   `json:"type"`
	Verses         []DisplayVerse    `json:"verses"`
}

LiveDisplay defines model for LiveDisplay.

type LiveDisplayStatus added in v0.3.1 

type LiveDisplayStatus string

LiveDisplayStatus defines model for LiveDisplay.Status. 

const (
	LiveDisplayStatusRunning LiveDisplayStatus = "running"
	LiveDisplayStatusStopped LiveDisplayStatus = "stopped"
)

Defines values for LiveDisplayStatus.

func (LiveDisplayStatus) Valid added in v0.3.1 

func (e LiveDisplayStatus) Valid() bool

Valid indicates whether the value is a known member of the LiveDisplayStatus enum.

type LiveDisplayType added in v0.3.1 

type LiveDisplayType string

LiveDisplayType defines model for LiveDisplay.Type. 

const (
	LiveDisplayTypeEmpty        LiveDisplayType = "empty"
	LiveDisplayTypePresentation LiveDisplayType = "presentation"
	LiveDisplayTypeScripture    LiveDisplayType = "scripture"
)

Defines values for LiveDisplayType.

func (LiveDisplayType) Valid added in v0.3.1 

func (e LiveDisplayType) Valid() bool

Valid indicates whether the value is a known member of the LiveDisplayType enum.

type LiveEvent added in v0.3.0 

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

LiveEvent Event schema major version 1. Snapshot on connection/reconnection; changed snapshot when comparison differs; null-data heartbeat at wait expiry. Notifications may coalesce, repeat or be missed. Not exactly-once and no historical replay.

func (LiveEvent) AsLiveHeartbeatEvent added in v0.3.0 

func (t LiveEvent) AsLiveHeartbeatEvent() (LiveHeartbeatEvent, error)

AsLiveHeartbeatEvent returns the union data inside the LiveEvent as a LiveHeartbeatEvent

func (LiveEvent) AsLiveSnapshotEvent added in v0.3.0 

func (t LiveEvent) AsLiveSnapshotEvent() (LiveSnapshotEvent, error)

AsLiveSnapshotEvent returns the union data inside the LiveEvent as a LiveSnapshotEvent

func (*LiveEvent) FromLiveHeartbeatEvent added in v0.3.0 

func (t *LiveEvent) FromLiveHeartbeatEvent(v LiveHeartbeatEvent) error

FromLiveHeartbeatEvent overwrites any union data inside the LiveEvent as the provided LiveHeartbeatEvent

func (*LiveEvent) FromLiveSnapshotEvent added in v0.3.0 

func (t *LiveEvent) FromLiveSnapshotEvent(v LiveSnapshotEvent) error

FromLiveSnapshotEvent overwrites any union data inside the LiveEvent as the provided LiveSnapshotEvent

func (LiveEvent) MarshalJSON added in v0.3.0 

func (t LiveEvent) MarshalJSON() ([]byte, error)

func (*LiveEvent) MergeLiveHeartbeatEvent added in v0.3.0 

func (t *LiveEvent) MergeLiveHeartbeatEvent(v LiveHeartbeatEvent) error

MergeLiveHeartbeatEvent performs a merge with any union data inside the LiveEvent, using the provided LiveHeartbeatEvent

func (*LiveEvent) MergeLiveSnapshotEvent added in v0.3.0 

func (t *LiveEvent) MergeLiveSnapshotEvent(v LiveSnapshotEvent) error

MergeLiveSnapshotEvent performs a merge with any union data inside the LiveEvent, using the provided LiveSnapshotEvent

func (*LiveEvent) UnmarshalJSON added in v0.3.0 

func (t *LiveEvent) UnmarshalJSON(b []byte) error

type LiveEventDesign added in v0.3.0 

type LiveEventDesign struct {
	Organization *string `json:"organization,omitempty"`
	Revision     int64   `json:"revision"`

	// Settings Examples: {"container":{"border":null,"padding":null,"radius":null},"controls":{"fontSize":true,"fullscreen":true,"theme":true},"elements":{"reference":{"align":"left","bold":true,"font":"sans","italic":false,"lineHeight":112,"size":100},"text":{"align":"left","bold":false,"font":"serif","italic":false,"lineHeight":112,"size":100},"translation":{"align":"left","bold":true,"font":"sans","italic":false,"lineHeight":112,"size":100}},"order":["translation","reference","text"],"palettes":{"dark":{"background":null,"container":null,"reference":null,"text":null,"translation":null},"light":{"background":null,"container":null,"reference":null,"text":null,"translation":null}},"preset":"default","showLogo":true,"transition":"none","version":1}
	Settings LiveStudioSettings `json:"settings"`
}

LiveEventDesign Audience-safe Studio design. revision is independent of the Live sequence. Personal Lives use defaults and omit organization.

type LiveEventSnapshot added in v0.3.0 

type LiveEventSnapshot struct {
	// Design Audience-safe Studio design. revision is independent of the Live sequence. Personal Lives use defaults and omit organization.
	Design         LiveEventDesign           `json:"design"`
	Display        LiveEventSnapshot_Display `json:"display"`
	Live           LiveEventSnapshot_Live    `json:"live"`
	Queue          []LiveQueueItem           `json:"queue"`
	ViewerSettings LiveEventViewerSettings   `json:"viewer_settings"`
}

LiveEventSnapshot Current authorized snapshot. Queue is null in presentation mode. Presentation data is immutable snapshot metadata; editable documents, permissions, secrets, publisher identities and media paths are excluded. No audience membership or viewer statistics are created by reading.

type LiveEventSnapshot_Display added in v0.3.0 

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

LiveEventSnapshot_Display defines model for LiveEventSnapshot.Display.

func (LiveEventSnapshot_Display) AsLiveDisplay added in v0.3.0 

func (t LiveEventSnapshot_Display) AsLiveDisplay() (LiveDisplay, error)

AsLiveDisplay returns the union data inside the LiveEventSnapshot_Display as a LiveDisplay

func (LiveEventSnapshot_Display) AsPersonalLiveDisplay added in v0.3.0 

func (t LiveEventSnapshot_Display) AsPersonalLiveDisplay() (PersonalLiveDisplay, error)

AsPersonalLiveDisplay returns the union data inside the LiveEventSnapshot_Display as a PersonalLiveDisplay

func (*LiveEventSnapshot_Display) FromLiveDisplay added in v0.3.0 

func (t *LiveEventSnapshot_Display) FromLiveDisplay(v LiveDisplay) error

FromLiveDisplay overwrites any union data inside the LiveEventSnapshot_Display as the provided LiveDisplay

func (*LiveEventSnapshot_Display) FromPersonalLiveDisplay added in v0.3.0 

func (t *LiveEventSnapshot_Display) FromPersonalLiveDisplay(v PersonalLiveDisplay) error

FromPersonalLiveDisplay overwrites any union data inside the LiveEventSnapshot_Display as the provided PersonalLiveDisplay

func (LiveEventSnapshot_Display) MarshalJSON added in v0.3.0 

func (t LiveEventSnapshot_Display) MarshalJSON() ([]byte, error)

func (*LiveEventSnapshot_Display) MergeLiveDisplay added in v0.3.0 

func (t *LiveEventSnapshot_Display) MergeLiveDisplay(v LiveDisplay) error

MergeLiveDisplay performs a merge with any union data inside the LiveEventSnapshot_Display, using the provided LiveDisplay

func (*LiveEventSnapshot_Display) MergePersonalLiveDisplay added in v0.3.0 

func (t *LiveEventSnapshot_Display) MergePersonalLiveDisplay(v PersonalLiveDisplay) error

MergePersonalLiveDisplay performs a merge with any union data inside the LiveEventSnapshot_Display, using the provided PersonalLiveDisplay

func (*LiveEventSnapshot_Display) UnmarshalJSON added in v0.3.0 

func (t *LiveEventSnapshot_Display) UnmarshalJSON(b []byte) error

type LiveEventSnapshot_Live added in v0.3.0 

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

LiveEventSnapshot_Live defines model for LiveEventSnapshot.Live.

func (LiveEventSnapshot_Live) AsLive added in v0.3.0 

func (t LiveEventSnapshot_Live) AsLive() (Live, error)

AsLive returns the union data inside the LiveEventSnapshot_Live as a Live

func (LiveEventSnapshot_Live) AsPersonalLive added in v0.3.0 

func (t LiveEventSnapshot_Live) AsPersonalLive() (PersonalLive, error)

AsPersonalLive returns the union data inside the LiveEventSnapshot_Live as a PersonalLive

func (*LiveEventSnapshot_Live) FromLive added in v0.3.0 

func (t *LiveEventSnapshot_Live) FromLive(v Live) error

FromLive overwrites any union data inside the LiveEventSnapshot_Live as the provided Live

func (*LiveEventSnapshot_Live) FromPersonalLive added in v0.3.0 

func (t *LiveEventSnapshot_Live) FromPersonalLive(v PersonalLive) error

FromPersonalLive overwrites any union data inside the LiveEventSnapshot_Live as the provided PersonalLive

func (LiveEventSnapshot_Live) MarshalJSON added in v0.3.0 

func (t LiveEventSnapshot_Live) MarshalJSON() ([]byte, error)

func (*LiveEventSnapshot_Live) MergeLive added in v0.3.0 

func (t *LiveEventSnapshot_Live) MergeLive(v Live) error

MergeLive performs a merge with any union data inside the LiveEventSnapshot_Live, using the provided Live

func (*LiveEventSnapshot_Live) MergePersonalLive added in v0.3.0 

func (t *LiveEventSnapshot_Live) MergePersonalLive(v PersonalLive) error

MergePersonalLive performs a merge with any union data inside the LiveEventSnapshot_Live, using the provided PersonalLive

func (*LiveEventSnapshot_Live) UnmarshalJSON added in v0.3.0 

func (t *LiveEventSnapshot_Live) UnmarshalJSON(b []byte) error

type LiveEventViewerSettings added in v0.3.0 

type LiveEventViewerSettings struct {
	Presentation bool                           `json:"presentation"`
	Preset       *LiveEventViewerSettingsPreset `json:"preset,omitempty"`

	// Scale Existing viewer font-size step, independent of Studio text size.
	Scale      int64                              `json:"scale"`
	Theme      LiveEventViewerSettingsTheme       `json:"theme"`
	Transition *LiveEventViewerSettingsTransition `json:"transition,omitempty"`
}

LiveEventViewerSettings defines model for LiveEventViewerSettings.

type LiveEventViewerSettingsPreset added in v0.3.1 

type LiveEventViewerSettingsPreset string

LiveEventViewerSettingsPreset defines model for LiveEventViewerSettings.Preset. 

const (
	LiveEventViewerSettingsPresetDefault  LiveEventViewerSettingsPreset = "default"
	LiveEventViewerSettingsPresetMidnight LiveEventViewerSettingsPreset = "midnight"
	LiveEventViewerSettingsPresetOcean    LiveEventViewerSettingsPreset = "ocean"
	LiveEventViewerSettingsPresetPaper    LiveEventViewerSettingsPreset = "paper"
)

Defines values for LiveEventViewerSettingsPreset.

func (LiveEventViewerSettingsPreset) Valid added in v0.3.1 

func (e LiveEventViewerSettingsPreset) Valid() bool

Valid indicates whether the value is a known member of the LiveEventViewerSettingsPreset enum.

type LiveEventViewerSettingsTheme added in v0.3.1 

type LiveEventViewerSettingsTheme string

LiveEventViewerSettingsTheme defines model for LiveEventViewerSettings.Theme. 

const (
	Dark  LiveEventViewerSettingsTheme = "dark"
	Light LiveEventViewerSettingsTheme = "light"
)

Defines values for LiveEventViewerSettingsTheme.

func (LiveEventViewerSettingsTheme) Valid added in v0.3.1 

func (e LiveEventViewerSettingsTheme) Valid() bool

Valid indicates whether the value is a known member of the LiveEventViewerSettingsTheme enum.

type LiveEventViewerSettingsTransition added in v0.3.1 

type LiveEventViewerSettingsTransition string

LiveEventViewerSettingsTransition defines model for LiveEventViewerSettings.Transition. 

const (
	LiveEventViewerSettingsTransitionFade      LiveEventViewerSettingsTransition = "fade"
	LiveEventViewerSettingsTransitionNone      LiveEventViewerSettingsTransition = "none"
	LiveEventViewerSettingsTransitionSlide     LiveEventViewerSettingsTransition = "slide"
	LiveEventViewerSettingsTransitionSlideDown LiveEventViewerSettingsTransition = "slide_down"
	LiveEventViewerSettingsTransitionSlideUp   LiveEventViewerSettingsTransition = "slide_up"
	LiveEventViewerSettingsTransitionWipe      LiveEventViewerSettingsTransition = "wipe"
	LiveEventViewerSettingsTransitionZoomIn    LiveEventViewerSettingsTransition = "zoom_in"
	LiveEventViewerSettingsTransitionZoomOut   LiveEventViewerSettingsTransition = "zoom_out"
)

Defines values for LiveEventViewerSettingsTransition.

func (LiveEventViewerSettingsTransition) Valid added in v0.3.1 

func (e LiveEventViewerSettingsTransition) Valid() bool

Valid indicates whether the value is a known member of the LiveEventViewerSettingsTransition enum.

type LiveField 

type LiveField string
const (
	LiveName         LiveField = "NAME"
	LiveReference    LiveField = "REFERENCE"
	LiveTranslations LiveField = "TRANSLATIONS"
)

type LiveHeartbeatEvent added in v0.3.0 

type LiveHeartbeatEvent struct {
	// Cursor Opaque current-state comparison token covering the snapshot including independent design revisions. No durable log position, event ID, expiry promise or universal ETag.
	Cursor        string                          `json:"cursor"`
	Data          *LiveEventSnapshot              `json:"data"`
	ResourceID    string                          `json:"resource_id"`
	ResourceType  LiveHeartbeatEventResourceType  `json:"resource_type"`
	SchemaVersion LiveHeartbeatEventSchemaVersion `json:"schema_version"`

	// Sequence Current Live content sequence. Studio design revision can change independently. Never use an event cursor as an If-Match validator.
	Sequence int64                  `json:"sequence"`
	Type     LiveHeartbeatEventType `json:"type"`
}

LiveHeartbeatEvent Examples: {"cursor":"v1:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","data":null,"resource_id":"sample-live","resource_type":"live","schema_version":1,"sequence":3,"type":"stream.heartbeat"}

type LiveHeartbeatEventResourceType added in v0.3.0 

type LiveHeartbeatEventResourceType string

LiveHeartbeatEventResourceType defines model for LiveHeartbeatEvent.ResourceType. 

const (
	LiveHeartbeatEventResourceTypeLive LiveHeartbeatEventResourceType = "live"
)

Defines values for LiveHeartbeatEventResourceType.

func (LiveHeartbeatEventResourceType) Valid added in v0.3.0 

func (e LiveHeartbeatEventResourceType) Valid() bool

Valid indicates whether the value is a known member of the LiveHeartbeatEventResourceType enum.

type LiveHeartbeatEventSchemaVersion added in v0.3.0 

type LiveHeartbeatEventSchemaVersion int64

LiveHeartbeatEventSchemaVersion defines model for LiveHeartbeatEvent.SchemaVersion. 

const (
	LiveHeartbeatEventSchemaVersionN1 LiveHeartbeatEventSchemaVersion = 1
)

Defines values for LiveHeartbeatEventSchemaVersion.

func (LiveHeartbeatEventSchemaVersion) Valid added in v0.3.0 

func (e LiveHeartbeatEventSchemaVersion) Valid() bool

Valid indicates whether the value is a known member of the LiveHeartbeatEventSchemaVersion enum.

type LiveHeartbeatEventType added in v0.3.0 

type LiveHeartbeatEventType string

LiveHeartbeatEventType defines model for LiveHeartbeatEvent.Type. 

const (
	StreamHeartbeat LiveHeartbeatEventType = "stream.heartbeat"
)

Defines values for LiveHeartbeatEventType.

func (LiveHeartbeatEventType) Valid added in v0.3.0 

func (e LiveHeartbeatEventType) Valid() bool

Valid indicates whether the value is a known member of the LiveHeartbeatEventType enum.

type LiveList 

type LiveList struct {
	Data []LiveSummary `json:"data"`

	// NextCursor Pass this value unchanged as after; null ends the collection.
	NextCursor *string `json:"next_cursor"`
}

LiveList defines model for LiveList.

type LiveMetadataPatch added in v0.3.0 

type LiveMetadataPatch struct {
	// Name Nonempty UTF-8 name, at most 128 bytes.
	Name string `json:"name"`
}

LiveMetadataPatch Examples: {"name":"Sunday evening"}

type LiveMode added in v0.3.0 

type LiveMode string

LiveMode defines model for Live.Mode. 

const (
	LiveModePresentation LiveMode = "presentation"
	LiveModeReader       LiveMode = "reader"
)

Defines values for LiveMode.

func (LiveMode) Valid added in v0.3.0 

func (e LiveMode) Valid() bool

Valid indicates whether the value is a known member of the LiveMode enum.

type LiveQueueItem added in v0.3.0 

type LiveQueueItem struct {
	// ID Opaque stable queue item ID. Preserved through reordering, metadata edits and restart; removing/recreating a verse yields a new ID.
	ID string `json:"id"`

	// Position Zero-based position in the entire current queue, not the current page.
	Position int64        `json:"position"`
	Verse    DisplayVerse `json:"verse"`
}

LiveQueueItem defines model for LiveQueueItem.

type LiveQueueOrder added in v0.3.0 

type LiveQueueOrder struct {
	// ItemIds Complete permutation of the current item IDs. Missing, extra, foreign or duplicate IDs return 422. Empty is valid only for an empty queue.
	ItemIds []string `json:"item_ids"`
}

LiveQueueOrder Examples: {"item_ids":[]}

type LiveQueuePage added in v0.3.0 

type LiveQueuePage struct {
	Data   []LiveQueueItem `json:"data"`
	LiveID string          `json:"live_id"`

	// NextCursor Opaque sequence-bound cursor. Pass unchanged as after. Any intervening Live sequence change returns 409; malformed/unknown cursor returns 422.
	NextCursor     *string `json:"next_cursor"`
	OrganizationID string  `json:"organization_id"`
	Sequence       int64   `json:"sequence"`
}

LiveQueuePage defines model for LiveQueuePage.

type LiveResult 

type LiveResult struct {
	Live LiveState
	Raw  CommandResponse
}

type LiveSettings added in v0.3.0 

type LiveSettings struct {
	LiveID       string   `json:"live_id"`
	Reference    *string  `json:"reference"`
	Sequence     int64    `json:"sequence"`
	Translations []string `json:"translations"`
}

LiveSettings defines model for LiveSettings.

type LiveSettingsPatch added in v0.3.0 

type LiveSettingsPatch struct {
	Reference    *string  `json:"reference,omitempty"`
	Translations []string `json:"translations,omitempty"`
}

LiveSettingsPatch defines model for LiveSettingsPatch.

type LiveSnapshotEvent added in v0.3.0 

type LiveSnapshotEvent struct {
	// Cursor Opaque current-state comparison token covering the snapshot including independent design revisions. No durable log position, event ID, expiry promise or universal ETag.
	Cursor string `json:"cursor"`

	// Data Current authorized snapshot. Queue is null in presentation mode. Presentation data is immutable snapshot metadata; editable documents, permissions, secrets, publisher identities and media paths are excluded. No audience membership or viewer statistics are created by reading.
	Data          LiveEventSnapshot              `json:"data"`
	ResourceID    string                         `json:"resource_id"`
	ResourceType  LiveSnapshotEventResourceType  `json:"resource_type"`
	SchemaVersion LiveSnapshotEventSchemaVersion `json:"schema_version"`

	// Sequence Current Live content sequence. Studio design revision can change independently. Never use an event cursor as an If-Match validator.
	Sequence int64                 `json:"sequence"`
	Type     LiveSnapshotEventType `json:"type"`
}

LiveSnapshotEvent defines model for LiveSnapshotEvent.

type LiveSnapshotEventResourceType added in v0.3.0 

type LiveSnapshotEventResourceType string

LiveSnapshotEventResourceType defines model for LiveSnapshotEvent.ResourceType. 

const (
	LiveSnapshotEventResourceTypeLive LiveSnapshotEventResourceType = "live"
)

Defines values for LiveSnapshotEventResourceType.

func (LiveSnapshotEventResourceType) Valid added in v0.3.0 

func (e LiveSnapshotEventResourceType) Valid() bool

Valid indicates whether the value is a known member of the LiveSnapshotEventResourceType enum.

type LiveSnapshotEventSchemaVersion added in v0.3.0 

type LiveSnapshotEventSchemaVersion int64

LiveSnapshotEventSchemaVersion defines model for LiveSnapshotEvent.SchemaVersion. 

const (
	LiveSnapshotEventSchemaVersionN1 LiveSnapshotEventSchemaVersion = 1
)

Defines values for LiveSnapshotEventSchemaVersion.

func (LiveSnapshotEventSchemaVersion) Valid added in v0.3.0 

func (e LiveSnapshotEventSchemaVersion) Valid() bool

Valid indicates whether the value is a known member of the LiveSnapshotEventSchemaVersion enum.

type LiveSnapshotEventType added in v0.3.0 

type LiveSnapshotEventType string

LiveSnapshotEventType defines model for LiveSnapshotEvent.Type. 

const (
	LiveChanged  LiveSnapshotEventType = "live.changed"
	LiveSnapshot LiveSnapshotEventType = "live.snapshot"
)

Defines values for LiveSnapshotEventType.

func (LiveSnapshotEventType) Valid added in v0.3.0 

func (e LiveSnapshotEventType) Valid() bool

Valid indicates whether the value is a known member of the LiveSnapshotEventType enum.

type LiveStack 

type LiveStack struct {
	Affected int64            `json:"affected"`
	Data     []LiveStackVerse `json:"data"`
	LiveID   string           `json:"live_id"`
	Sequence int64            `json:"sequence"`
}

LiveStack defines model for LiveStack.

type LiveStackPush added in v0.3.0 

type LiveStackPush struct {
	Reference LiveStackReference `json:"reference"`
}

LiveStackPush defines model for LiveStackPush.

type LiveStackReference added in v0.3.0 

type LiveStackReference struct {
	BookID      int64   `json:"book_id"`
	Chapter     *int64  `json:"chapter,omitempty"`
	Translation *string `json:"translation,omitempty"`
	Verse       *int64  `json:"verse,omitempty"`
}

LiveStackReference defines model for LiveStackReference.

type LiveStackRemoval added in v0.3.0 

type LiveStackRemoval struct {
	Count *int64 `json:"count,omitempty"`
}

LiveStackRemoval defines model for LiveStackRemoval.

type LiveStackVerse added in v0.3.0 

type LiveStackVerse struct {
	Attribution string            `json:"attribution"`
	Book        string            `json:"book"`
	BookID      int64             `json:"book_id"`
	Chapter     int64             `json:"chapter"`
	Position    int64             `json:"position"`
	Rights      TranslationRights `json:"rights"`
	Text        string            `json:"text"`
	Translation string            `json:"translation"`
	Verse       int64             `json:"verse"`
}

LiveStackVerse defines model for LiveStackVerse.

type LiveState 

type LiveState struct {
	ID, Name, Status                            string
	Paused                                      bool
	Reference, Owner, CreatedBy, OrganizationID *string
	Owned, Protected                            *bool
	CreatedAt                                   *int64
	Translations                                []string
	Fields                                      map[string]string
}

type LiveStatistics 

type LiveStatistics struct {
	AnonymousConnections int64            `json:"anonymous_connections"`
	Connections          int64            `json:"connections"`
	ID                   string           `json:"id"`
	RunningForSeconds    int64            `json:"running_for_seconds"`
	Sequence             int64            `json:"sequence"`
	StackEntries         int64            `json:"stack_entries"`
	Subscribers          []LiveSubscriber `json:"subscribers"`
	UserConnections      int64            `json:"user_connections"`
}

LiveStatistics defines model for LiveStatistics.

type LiveStatus added in v0.3.0 

type LiveStatus string

LiveStatus defines model for Live.Status. 

const (
	LiveStatusRunning LiveStatus = "running"
	LiveStatusStopped LiveStatus = "stopped"
)

Defines values for LiveStatus.

func (LiveStatus) Valid added in v0.3.0 

func (e LiveStatus) Valid() bool

Valid indicates whether the value is a known member of the LiveStatus enum.

type LiveStudioSettings added in v0.3.0 

type LiveStudioSettings struct {
	Container  LiveStudioSettings_Container `json:"container"`
	Controls   LiveStudioSettings_Controls  `json:"controls"`
	Elements   LiveStudioSettings_Elements  `json:"elements"`
	Order      []LiveStudioSettingsOrder    `json:"order"`
	Palettes   LiveStudioSettings_Palettes  `json:"palettes"`
	Preset     LiveStudioSettingsPreset     `json:"preset"`
	Transition LiveStudioSettingsTransition `json:"transition"`
	Version    LiveStudioSettingsVersion    `json:"version"`
}

LiveStudioSettings Examples: {"container":{"border":null,"padding":null,"radius":null},"controls":{"fontSize":true,"fullscreen":true,"theme":true},"elements":{"reference":{"align":"left","bold":true,"font":"sans","italic":false,"lineHeight":112,"size":100},"text":{"align":"left","bold":false,"font":"serif","italic":false,"lineHeight":112,"size":100},"translation":{"align":"left","bold":true,"font":"sans","italic":false,"lineHeight":112,"size":100}},"order":["translation","reference","text"],"palettes":{"dark":{"background":null,"container":null,"reference":null,"text":null,"translation":null},"light":{"background":null,"container":null,"reference":null,"text":null,"translation":null}},"preset":"default","showLogo":true,"transition":"none","version":1}

type LiveStudioSettingsElementsReferenceAlign added in v0.3.1 

type LiveStudioSettingsElementsReferenceAlign string

LiveStudioSettingsElementsReferenceAlign defines model for LiveStudioSettings.Elements.Reference.Align. 

const (
	LiveStudioSettingsElementsReferenceAlignCenter LiveStudioSettingsElementsReferenceAlign = "center"
	LiveStudioSettingsElementsReferenceAlignLeft   LiveStudioSettingsElementsReferenceAlign = "left"
	LiveStudioSettingsElementsReferenceAlignRight  LiveStudioSettingsElementsReferenceAlign = "right"
)

Defines values for LiveStudioSettingsElementsReferenceAlign.

func (LiveStudioSettingsElementsReferenceAlign) Valid added in v0.3.1 

func (e LiveStudioSettingsElementsReferenceAlign) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsElementsReferenceAlign enum.

type LiveStudioSettingsElementsReferenceFont added in v0.3.1 

type LiveStudioSettingsElementsReferenceFont string

LiveStudioSettingsElementsReferenceFont defines model for LiveStudioSettings.Elements.Reference.Font. 

const (
	LiveStudioSettingsElementsReferenceFontMono  LiveStudioSettingsElementsReferenceFont = "mono"
	LiveStudioSettingsElementsReferenceFontSans  LiveStudioSettingsElementsReferenceFont = "sans"
	LiveStudioSettingsElementsReferenceFontSerif LiveStudioSettingsElementsReferenceFont = "serif"
)

Defines values for LiveStudioSettingsElementsReferenceFont.

func (LiveStudioSettingsElementsReferenceFont) Valid added in v0.3.1 

func (e LiveStudioSettingsElementsReferenceFont) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsElementsReferenceFont enum.

type LiveStudioSettingsElementsTextAlign added in v0.3.1 

type LiveStudioSettingsElementsTextAlign string

LiveStudioSettingsElementsTextAlign defines model for LiveStudioSettings.Elements.Text.Align. 

const (
	LiveStudioSettingsElementsTextAlignCenter LiveStudioSettingsElementsTextAlign = "center"
	LiveStudioSettingsElementsTextAlignLeft   LiveStudioSettingsElementsTextAlign = "left"
	LiveStudioSettingsElementsTextAlignRight  LiveStudioSettingsElementsTextAlign = "right"
)

Defines values for LiveStudioSettingsElementsTextAlign.

func (LiveStudioSettingsElementsTextAlign) Valid added in v0.3.1 

func (e LiveStudioSettingsElementsTextAlign) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsElementsTextAlign enum.

type LiveStudioSettingsElementsTextFont added in v0.3.1 

type LiveStudioSettingsElementsTextFont string

LiveStudioSettingsElementsTextFont defines model for LiveStudioSettings.Elements.Text.Font. 

const (
	LiveStudioSettingsElementsTextFontMono  LiveStudioSettingsElementsTextFont = "mono"
	LiveStudioSettingsElementsTextFontSans  LiveStudioSettingsElementsTextFont = "sans"
	LiveStudioSettingsElementsTextFontSerif LiveStudioSettingsElementsTextFont = "serif"
)

Defines values for LiveStudioSettingsElementsTextFont.

func (LiveStudioSettingsElementsTextFont) Valid added in v0.3.1 

func (e LiveStudioSettingsElementsTextFont) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsElementsTextFont enum.

type LiveStudioSettingsElementsTranslationAlign added in v0.3.1 

type LiveStudioSettingsElementsTranslationAlign string

LiveStudioSettingsElementsTranslationAlign defines model for LiveStudioSettings.Elements.Translation.Align. 

const (
	LiveStudioSettingsElementsTranslationAlignCenter LiveStudioSettingsElementsTranslationAlign = "center"
	LiveStudioSettingsElementsTranslationAlignLeft   LiveStudioSettingsElementsTranslationAlign = "left"
	LiveStudioSettingsElementsTranslationAlignRight  LiveStudioSettingsElementsTranslationAlign = "right"
)

Defines values for LiveStudioSettingsElementsTranslationAlign.

func (LiveStudioSettingsElementsTranslationAlign) Valid added in v0.3.1 

func (e LiveStudioSettingsElementsTranslationAlign) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsElementsTranslationAlign enum.

type LiveStudioSettingsElementsTranslationFont added in v0.3.1 

type LiveStudioSettingsElementsTranslationFont string

LiveStudioSettingsElementsTranslationFont defines model for LiveStudioSettings.Elements.Translation.Font. 

const (
	LiveStudioSettingsElementsTranslationFontMono  LiveStudioSettingsElementsTranslationFont = "mono"
	LiveStudioSettingsElementsTranslationFontSans  LiveStudioSettingsElementsTranslationFont = "sans"
	LiveStudioSettingsElementsTranslationFontSerif LiveStudioSettingsElementsTranslationFont = "serif"
)

Defines values for LiveStudioSettingsElementsTranslationFont.

func (LiveStudioSettingsElementsTranslationFont) Valid added in v0.3.1 

func (e LiveStudioSettingsElementsTranslationFont) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsElementsTranslationFont enum.

type LiveStudioSettingsInput added in v0.3.0 

type LiveStudioSettingsInput struct {
	Container  LiveStudioSettingsInput_Container  `json:"container"`
	Controls   LiveStudioSettingsInput_Controls   `json:"controls"`
	Elements   LiveStudioSettingsInput_Elements   `json:"elements"`
	Order      []LiveStudioSettingsInputOrder     `json:"order"`
	Palettes   LiveStudioSettingsInput_Palettes   `json:"palettes"`
	Preset     *LiveStudioSettingsInputPreset     `json:"preset,omitempty"`
	Transition *LiveStudioSettingsInputTransition `json:"transition,omitempty"`
	Version    LiveStudioSettingsInputVersion     `json:"version"`
}

LiveStudioSettingsInput Full settings replacement using the existing version-1 Studio model. Only preset and transition may be omitted; they default to default and none. Every other field and all nested keys are required. Unknown fields are rejected at every level.

Examples: {"container":{"border":null,"padding":null,"radius":null},"controls":{"fontSize":true,"fullscreen":true,"theme":true},"elements":{"reference":{"align":"left","bold":true,"font":"sans","italic":false,"lineHeight":112,"size":100},"text":{"align":"left","bold":false,"font":"serif","italic":false,"lineHeight":112,"size":100},"translation":{"align":"left","bold":true,"font":"sans","italic":false,"lineHeight":112,"size":100}},"order":["translation","reference","text"],"palettes":{"dark":{"background":null,"container":null,"reference":null,"text":null,"translation":null},"light":{"background":null,"container":null,"reference":null,"text":null,"translation":null}},"preset":"default","showLogo":true,"transition":"none","version":1}

type LiveStudioSettingsInputElementsReferenceAlign added in v0.3.1 

type LiveStudioSettingsInputElementsReferenceAlign string

LiveStudioSettingsInputElementsReferenceAlign defines model for LiveStudioSettingsInput.Elements.Reference.Align. 

const (
	LiveStudioSettingsInputElementsReferenceAlignCenter LiveStudioSettingsInputElementsReferenceAlign = "center"
	LiveStudioSettingsInputElementsReferenceAlignLeft   LiveStudioSettingsInputElementsReferenceAlign = "left"
	LiveStudioSettingsInputElementsReferenceAlignRight  LiveStudioSettingsInputElementsReferenceAlign = "right"
)

Defines values for LiveStudioSettingsInputElementsReferenceAlign.

func (LiveStudioSettingsInputElementsReferenceAlign) Valid added in v0.3.1 

func (e LiveStudioSettingsInputElementsReferenceAlign) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsInputElementsReferenceAlign enum.

type LiveStudioSettingsInputElementsReferenceFont added in v0.3.1 

type LiveStudioSettingsInputElementsReferenceFont string

LiveStudioSettingsInputElementsReferenceFont defines model for LiveStudioSettingsInput.Elements.Reference.Font. 

const (
	LiveStudioSettingsInputElementsReferenceFontMono  LiveStudioSettingsInputElementsReferenceFont = "mono"
	LiveStudioSettingsInputElementsReferenceFontSans  LiveStudioSettingsInputElementsReferenceFont = "sans"
	LiveStudioSettingsInputElementsReferenceFontSerif LiveStudioSettingsInputElementsReferenceFont = "serif"
)

Defines values for LiveStudioSettingsInputElementsReferenceFont.

func (LiveStudioSettingsInputElementsReferenceFont) Valid added in v0.3.1 

func (e LiveStudioSettingsInputElementsReferenceFont) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsInputElementsReferenceFont enum.

type LiveStudioSettingsInputElementsTextAlign added in v0.3.1 

type LiveStudioSettingsInputElementsTextAlign string

LiveStudioSettingsInputElementsTextAlign defines model for LiveStudioSettingsInput.Elements.Text.Align. 

const (
	LiveStudioSettingsInputElementsTextAlignCenter LiveStudioSettingsInputElementsTextAlign = "center"
	LiveStudioSettingsInputElementsTextAlignLeft   LiveStudioSettingsInputElementsTextAlign = "left"
	LiveStudioSettingsInputElementsTextAlignRight  LiveStudioSettingsInputElementsTextAlign = "right"
)

Defines values for LiveStudioSettingsInputElementsTextAlign.

func (LiveStudioSettingsInputElementsTextAlign) Valid added in v0.3.1 

func (e LiveStudioSettingsInputElementsTextAlign) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsInputElementsTextAlign enum.

type LiveStudioSettingsInputElementsTextFont added in v0.3.1 

type LiveStudioSettingsInputElementsTextFont string

LiveStudioSettingsInputElementsTextFont defines model for LiveStudioSettingsInput.Elements.Text.Font. 

const (
	LiveStudioSettingsInputElementsTextFontMono  LiveStudioSettingsInputElementsTextFont = "mono"
	LiveStudioSettingsInputElementsTextFontSans  LiveStudioSettingsInputElementsTextFont = "sans"
	LiveStudioSettingsInputElementsTextFontSerif LiveStudioSettingsInputElementsTextFont = "serif"
)

Defines values for LiveStudioSettingsInputElementsTextFont.

func (LiveStudioSettingsInputElementsTextFont) Valid added in v0.3.1 

func (e LiveStudioSettingsInputElementsTextFont) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsInputElementsTextFont enum.

type LiveStudioSettingsInputElementsTranslationAlign added in v0.3.1 

type LiveStudioSettingsInputElementsTranslationAlign string

LiveStudioSettingsInputElementsTranslationAlign defines model for LiveStudioSettingsInput.Elements.Translation.Align. 

const (
	LiveStudioSettingsInputElementsTranslationAlignCenter LiveStudioSettingsInputElementsTranslationAlign = "center"
	LiveStudioSettingsInputElementsTranslationAlignLeft   LiveStudioSettingsInputElementsTranslationAlign = "left"
	LiveStudioSettingsInputElementsTranslationAlignRight  LiveStudioSettingsInputElementsTranslationAlign = "right"
)

Defines values for LiveStudioSettingsInputElementsTranslationAlign.

func (LiveStudioSettingsInputElementsTranslationAlign) Valid added in v0.3.1 

func (e LiveStudioSettingsInputElementsTranslationAlign) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsInputElementsTranslationAlign enum.

type LiveStudioSettingsInputElementsTranslationFont added in v0.3.1 

type LiveStudioSettingsInputElementsTranslationFont string

LiveStudioSettingsInputElementsTranslationFont defines model for LiveStudioSettingsInput.Elements.Translation.Font. 

const (
	LiveStudioSettingsInputElementsTranslationFontMono  LiveStudioSettingsInputElementsTranslationFont = "mono"
	LiveStudioSettingsInputElementsTranslationFontSans  LiveStudioSettingsInputElementsTranslationFont = "sans"
	LiveStudioSettingsInputElementsTranslationFontSerif LiveStudioSettingsInputElementsTranslationFont = "serif"
)

Defines values for LiveStudioSettingsInputElementsTranslationFont.

func (LiveStudioSettingsInputElementsTranslationFont) Valid added in v0.3.1 

func (e LiveStudioSettingsInputElementsTranslationFont) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsInputElementsTranslationFont enum.

type LiveStudioSettingsInputOrder added in v0.3.1 

type LiveStudioSettingsInputOrder string

LiveStudioSettingsInputOrder defines model for LiveStudioSettingsInput.Order. 

const (
	LiveStudioSettingsInputOrderReference   LiveStudioSettingsInputOrder = "reference"
	LiveStudioSettingsInputOrderText        LiveStudioSettingsInputOrder = "text"
	LiveStudioSettingsInputOrderTranslation LiveStudioSettingsInputOrder = "translation"
)

Defines values for LiveStudioSettingsInputOrder.

func (LiveStudioSettingsInputOrder) Valid added in v0.3.1 

func (e LiveStudioSettingsInputOrder) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsInputOrder enum.

type LiveStudioSettingsInputPreset added in v0.3.1 

type LiveStudioSettingsInputPreset string

LiveStudioSettingsInputPreset defines model for LiveStudioSettingsInput.Preset. 

const (
	LiveStudioSettingsInputPresetDefault  LiveStudioSettingsInputPreset = "default"
	LiveStudioSettingsInputPresetMidnight LiveStudioSettingsInputPreset = "midnight"
	LiveStudioSettingsInputPresetOcean    LiveStudioSettingsInputPreset = "ocean"
	LiveStudioSettingsInputPresetPaper    LiveStudioSettingsInputPreset = "paper"
)

Defines values for LiveStudioSettingsInputPreset.

func (LiveStudioSettingsInputPreset) Valid added in v0.3.1 

func (e LiveStudioSettingsInputPreset) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsInputPreset enum.

type LiveStudioSettingsInputTransition added in v0.3.1 

type LiveStudioSettingsInputTransition string

LiveStudioSettingsInputTransition defines model for LiveStudioSettingsInput.Transition. 

const (
	LiveStudioSettingsInputTransitionFade      LiveStudioSettingsInputTransition = "fade"
	LiveStudioSettingsInputTransitionNone      LiveStudioSettingsInputTransition = "none"
	LiveStudioSettingsInputTransitionSlide     LiveStudioSettingsInputTransition = "slide"
	LiveStudioSettingsInputTransitionSlideDown LiveStudioSettingsInputTransition = "slide_down"
	LiveStudioSettingsInputTransitionSlideUp   LiveStudioSettingsInputTransition = "slide_up"
	LiveStudioSettingsInputTransitionWipe      LiveStudioSettingsInputTransition = "wipe"
	LiveStudioSettingsInputTransitionZoomIn    LiveStudioSettingsInputTransition = "zoom_in"
	LiveStudioSettingsInputTransitionZoomOut   LiveStudioSettingsInputTransition = "zoom_out"
)

Defines values for LiveStudioSettingsInputTransition.

func (LiveStudioSettingsInputTransition) Valid added in v0.3.1 

func (e LiveStudioSettingsInputTransition) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsInputTransition enum.

type LiveStudioSettingsInputVersion added in v0.3.0 

type LiveStudioSettingsInputVersion int64

LiveStudioSettingsInputVersion defines model for LiveStudioSettingsInput.Version. 

const (
	LiveStudioSettingsInputVersionN1 LiveStudioSettingsInputVersion = 1
)

Defines values for LiveStudioSettingsInputVersion.

func (LiveStudioSettingsInputVersion) Valid added in v0.3.0 

func (e LiveStudioSettingsInputVersion) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsInputVersion enum.

type LiveStudioSettingsInput_Container added in v0.3.1 

type LiveStudioSettingsInput_Container struct {
	// Border Six-digit hexadecimal color; null inherits the selected preset.
	Border  *string `json:"border"`
	Padding *int64  `json:"padding"`
	Radius  *int64  `json:"radius"`
}

LiveStudioSettingsInput_Container defines model for LiveStudioSettingsInput.Container.

type LiveStudioSettingsInput_Controls added in v0.3.1 

type LiveStudioSettingsInput_Controls struct {
	FontSize   bool `json:"fontSize"`
	Fullscreen bool `json:"fullscreen"`
	Theme      bool `json:"theme"`
}

LiveStudioSettingsInput_Controls defines model for LiveStudioSettingsInput.Controls.

type LiveStudioSettingsInput_Elements added in v0.3.1 

type LiveStudioSettingsInput_Elements struct {
	Reference   LiveStudioSettingsInput_Elements_Reference   `json:"reference"`
	Text        LiveStudioSettingsInput_Elements_Text        `json:"text"`
	Translation LiveStudioSettingsInput_Elements_Translation `json:"translation"`
}

LiveStudioSettingsInput_Elements defines model for LiveStudioSettingsInput.Elements.

type LiveStudioSettingsInput_Elements_Reference added in v0.3.1 

type LiveStudioSettingsInput_Elements_Reference struct {
	Align      LiveStudioSettingsInputElementsReferenceAlign `json:"align"`
	Bold       bool                                          `json:"bold"`
	Font       LiveStudioSettingsInputElementsReferenceFont  `json:"font"`
	Italic     bool                                          `json:"italic"`
	LineHeight int64                                         `json:"lineHeight"`
	Size       int64                                         `json:"size"`
}

LiveStudioSettingsInput_Elements_Reference defines model for LiveStudioSettingsInput.Elements.Reference.

type LiveStudioSettingsInput_Elements_Text added in v0.3.1 

type LiveStudioSettingsInput_Elements_Text struct {
	Align      LiveStudioSettingsInputElementsTextAlign `json:"align"`
	Bold       bool                                     `json:"bold"`
	Font       LiveStudioSettingsInputElementsTextFont  `json:"font"`
	Italic     bool                                     `json:"italic"`
	LineHeight int64                                    `json:"lineHeight"`
	Size       int64                                    `json:"size"`
}

LiveStudioSettingsInput_Elements_Text defines model for LiveStudioSettingsInput.Elements.Text.

type LiveStudioSettingsInput_Elements_Translation added in v0.3.1 

type LiveStudioSettingsInput_Elements_Translation struct {
	Align      LiveStudioSettingsInputElementsTranslationAlign `json:"align"`
	Bold       bool                                            `json:"bold"`
	Font       LiveStudioSettingsInputElementsTranslationFont  `json:"font"`
	Italic     bool                                            `json:"italic"`
	LineHeight int64                                           `json:"lineHeight"`
	Size       int64                                           `json:"size"`
}

LiveStudioSettingsInput_Elements_Translation defines model for LiveStudioSettingsInput.Elements.Translation.

type LiveStudioSettingsInput_Palettes added in v0.3.1 

type LiveStudioSettingsInput_Palettes struct {
	Dark  LiveStudioSettingsInput_Palettes_Dark  `json:"dark"`
	Light LiveStudioSettingsInput_Palettes_Light `json:"light"`
}

LiveStudioSettingsInput_Palettes defines model for LiveStudioSettingsInput.Palettes.

type LiveStudioSettingsInput_Palettes_Dark added in v0.3.1 

type LiveStudioSettingsInput_Palettes_Dark struct {
	// Background Six-digit hexadecimal color; null inherits the selected preset.
	Background *string `json:"background"`

	// Container Six-digit hexadecimal color; null inherits the selected preset.
	Container *string `json:"container"`

	// Reference Six-digit hexadecimal color; null inherits the selected preset.
	Reference *string `json:"reference"`

	// Text Six-digit hexadecimal color; null inherits the selected preset.
	Text *string `json:"text"`

	// Translation Six-digit hexadecimal color; null inherits the selected preset.
	Translation *string `json:"translation"`
}

LiveStudioSettingsInput_Palettes_Dark defines model for LiveStudioSettingsInput.Palettes.Dark.

type LiveStudioSettingsInput_Palettes_Light added in v0.3.1 

type LiveStudioSettingsInput_Palettes_Light struct {
	// Background Six-digit hexadecimal color; null inherits the selected preset.
	Background *string `json:"background"`

	// Container Six-digit hexadecimal color; null inherits the selected preset.
	Container *string `json:"container"`

	// Reference Six-digit hexadecimal color; null inherits the selected preset.
	Reference *string `json:"reference"`

	// Text Six-digit hexadecimal color; null inherits the selected preset.
	Text *string `json:"text"`

	// Translation Six-digit hexadecimal color; null inherits the selected preset.
	Translation *string `json:"translation"`
}

LiveStudioSettingsInput_Palettes_Light defines model for LiveStudioSettingsInput.Palettes.Light.

type LiveStudioSettingsOrder added in v0.3.1 

type LiveStudioSettingsOrder string

LiveStudioSettingsOrder defines model for LiveStudioSettings.Order. 

const (
	LiveStudioSettingsOrderReference   LiveStudioSettingsOrder = "reference"
	LiveStudioSettingsOrderText        LiveStudioSettingsOrder = "text"
	LiveStudioSettingsOrderTranslation LiveStudioSettingsOrder = "translation"
)

Defines values for LiveStudioSettingsOrder.

func (LiveStudioSettingsOrder) Valid added in v0.3.1 

func (e LiveStudioSettingsOrder) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsOrder enum.

type LiveStudioSettingsPreset added in v0.3.1 

type LiveStudioSettingsPreset string

LiveStudioSettingsPreset defines model for LiveStudioSettings.Preset. 

const (
	LiveStudioSettingsPresetDefault  LiveStudioSettingsPreset = "default"
	LiveStudioSettingsPresetMidnight LiveStudioSettingsPreset = "midnight"
	LiveStudioSettingsPresetOcean    LiveStudioSettingsPreset = "ocean"
	LiveStudioSettingsPresetPaper    LiveStudioSettingsPreset = "paper"
)

Defines values for LiveStudioSettingsPreset.

func (LiveStudioSettingsPreset) Valid added in v0.3.1 

func (e LiveStudioSettingsPreset) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsPreset enum.

type LiveStudioSettingsTransition added in v0.3.1 

type LiveStudioSettingsTransition string

LiveStudioSettingsTransition defines model for LiveStudioSettings.Transition. 

const (
	LiveStudioSettingsTransitionFade      LiveStudioSettingsTransition = "fade"
	LiveStudioSettingsTransitionNone      LiveStudioSettingsTransition = "none"
	LiveStudioSettingsTransitionSlide     LiveStudioSettingsTransition = "slide"
	LiveStudioSettingsTransitionSlideDown LiveStudioSettingsTransition = "slide_down"
	LiveStudioSettingsTransitionSlideUp   LiveStudioSettingsTransition = "slide_up"
	LiveStudioSettingsTransitionWipe      LiveStudioSettingsTransition = "wipe"
	LiveStudioSettingsTransitionZoomIn    LiveStudioSettingsTransition = "zoom_in"
	LiveStudioSettingsTransitionZoomOut   LiveStudioSettingsTransition = "zoom_out"
)

Defines values for LiveStudioSettingsTransition.

func (LiveStudioSettingsTransition) Valid added in v0.3.1 

func (e LiveStudioSettingsTransition) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsTransition enum.

type LiveStudioSettingsVersion added in v0.3.0 

type LiveStudioSettingsVersion int64

LiveStudioSettingsVersion defines model for LiveStudioSettings.Version. 

const (
	LiveStudioSettingsVersionN1 LiveStudioSettingsVersion = 1
)

Defines values for LiveStudioSettingsVersion.

func (LiveStudioSettingsVersion) Valid added in v0.3.0 

func (e LiveStudioSettingsVersion) Valid() bool

Valid indicates whether the value is a known member of the LiveStudioSettingsVersion enum.

type LiveStudioSettings_Container added in v0.3.1 

type LiveStudioSettings_Container struct {
	// Border Six-digit hexadecimal color; null inherits the selected preset.
	Border  *string `json:"border"`
	Padding *int64  `json:"padding"`
	Radius  *int64  `json:"radius"`
}

LiveStudioSettings_Container defines model for LiveStudioSettings.Container.

type LiveStudioSettings_Controls added in v0.3.1 

type LiveStudioSettings_Controls struct {
	FontSize   bool `json:"fontSize"`
	Fullscreen bool `json:"fullscreen"`
	Theme      bool `json:"theme"`
}

LiveStudioSettings_Controls defines model for LiveStudioSettings.Controls.

type LiveStudioSettings_Elements added in v0.3.1 

type LiveStudioSettings_Elements struct {
	Reference   LiveStudioSettings_Elements_Reference   `json:"reference"`
	Text        LiveStudioSettings_Elements_Text        `json:"text"`
	Translation LiveStudioSettings_Elements_Translation `json:"translation"`
}

LiveStudioSettings_Elements defines model for LiveStudioSettings.Elements.

type LiveStudioSettings_Elements_Reference added in v0.3.1 

type LiveStudioSettings_Elements_Reference struct {
	Align      LiveStudioSettingsElementsReferenceAlign `json:"align"`
	Bold       bool                                     `json:"bold"`
	Font       LiveStudioSettingsElementsReferenceFont  `json:"font"`
	Italic     bool                                     `json:"italic"`
	LineHeight int64                                    `json:"lineHeight"`
	Size       int64                                    `json:"size"`
}

LiveStudioSettings_Elements_Reference defines model for LiveStudioSettings.Elements.Reference.

type LiveStudioSettings_Elements_Text added in v0.3.1 

type LiveStudioSettings_Elements_Text struct {
	Align      LiveStudioSettingsElementsTextAlign `json:"align"`
	Bold       bool                                `json:"bold"`
	Font       LiveStudioSettingsElementsTextFont  `json:"font"`
	Italic     bool                                `json:"italic"`
	LineHeight int64                               `json:"lineHeight"`
	Size       int64                               `json:"size"`
}

LiveStudioSettings_Elements_Text defines model for LiveStudioSettings.Elements.Text.

type LiveStudioSettings_Elements_Translation added in v0.3.1 

type LiveStudioSettings_Elements_Translation struct {
	Align      LiveStudioSettingsElementsTranslationAlign `json:"align"`
	Bold       bool                                       `json:"bold"`
	Font       LiveStudioSettingsElementsTranslationFont  `json:"font"`
	Italic     bool                                       `json:"italic"`
	LineHeight int64                                      `json:"lineHeight"`
	Size       int64                                      `json:"size"`
}

LiveStudioSettings_Elements_Translation defines model for LiveStudioSettings.Elements.Translation.

type LiveStudioSettings_Palettes added in v0.3.1 

type LiveStudioSettings_Palettes struct {
	Dark  LiveStudioSettings_Palettes_Dark  `json:"dark"`
	Light LiveStudioSettings_Palettes_Light `json:"light"`
}

LiveStudioSettings_Palettes defines model for LiveStudioSettings.Palettes.

type LiveStudioSettings_Palettes_Dark added in v0.3.1 

type LiveStudioSettings_Palettes_Dark struct {
	// Background Six-digit hexadecimal color; null inherits the selected preset.
	Background *string `json:"background"`

	// Container Six-digit hexadecimal color; null inherits the selected preset.
	Container *string `json:"container"`

	// Reference Six-digit hexadecimal color; null inherits the selected preset.
	Reference *string `json:"reference"`

	// Text Six-digit hexadecimal color; null inherits the selected preset.
	Text *string `json:"text"`

	// Translation Six-digit hexadecimal color; null inherits the selected preset.
	Translation *string `json:"translation"`
}

LiveStudioSettings_Palettes_Dark defines model for LiveStudioSettings.Palettes.Dark.

type LiveStudioSettings_Palettes_Light added in v0.3.1 

type LiveStudioSettings_Palettes_Light struct {
	// Background Six-digit hexadecimal color; null inherits the selected preset.
	Background *string `json:"background"`

	// Container Six-digit hexadecimal color; null inherits the selected preset.
	Container *string `json:"container"`

	// Reference Six-digit hexadecimal color; null inherits the selected preset.
	Reference *string `json:"reference"`

	// Text Six-digit hexadecimal color; null inherits the selected preset.
	Text *string `json:"text"`

	// Translation Six-digit hexadecimal color; null inherits the selected preset.
	Translation *string `json:"translation"`
}

LiveStudioSettings_Palettes_Light defines model for LiveStudioSettings.Palettes.Light.

type LiveSubscriber added in v0.3.0 

type LiveSubscriber struct {
	Access              LiveSubscriberAccess `json:"access"`
	ConnectedAt         int64                `json:"connected_at"`
	ConnectedForSeconds int64                `json:"connected_for_seconds"`
	User                string               `json:"user"`
}

LiveSubscriber defines model for LiveSubscriber.

type LiveSubscriberAccess added in v0.3.0 

type LiveSubscriberAccess string

LiveSubscriberAccess defines model for LiveSubscriber.Access. 

const (
	Actor  LiveSubscriberAccess = "actor"
	Open   LiveSubscriberAccess = "open"
	Secret LiveSubscriberAccess = "secret"
)

Defines values for LiveSubscriberAccess.

func (LiveSubscriberAccess) Valid added in v0.3.0 

func (e LiveSubscriberAccess) Valid() bool

Valid indicates whether the value is a known member of the LiveSubscriberAccess enum.

type LiveSummary added in v0.3.0 

type LiveSummary struct {
	ID             string `json:"id"`
	Name           string `json:"name"`
	OrganizationID string `json:"organization_id"`
}

LiveSummary defines model for LiveSummary.

type LiveVerse 

type LiveVerse struct {
	Translation, Reference, Text string
	Fields                       map[string]string
}

type LiveVerseResult 

type LiveVerseResult struct {
	Event  string
	Verses []LiveVerse
	Raw    CommandResponse
}

type LiveWorkspacePut added in v0.3.0 

type LiveWorkspacePut struct {
	// OrganizationID Immutable destination organization UUID. Personal workspaces and handles are not accepted.
	OrganizationID string `json:"organization_id"`
}

LiveWorkspacePut Examples: {"organization_id":"00000000-0000-4000-8000-000000000002"}

type McpOAuthMetadata added in v0.4.0 

type McpOAuthMetadata struct {
	AuthorizationEndpoint                      string                                                     `json:"authorization_endpoint"`
	AuthorizationResponseIssParameterSupported McpOAuthMetadataAuthorizationResponseIssParameterSupported `json:"authorization_response_iss_parameter_supported"`
	CodeChallengeMethodsSupported              []McpOAuthMetadataCodeChallengeMethodsSupported            `json:"code_challenge_methods_supported"`
	GrantTypesSupported                        []McpOAuthMetadataGrantTypesSupported                      `json:"grant_types_supported"`
	Issuer                                     string                                                     `json:"issuer"`
	ResponseTypesSupported                     []McpOAuthMetadataResponseTypesSupported                   `json:"response_types_supported"`
	RevocationEndpoint                         string                                                     `json:"revocation_endpoint"`
	RevocationEndpointAuthMethodsSupported     []McpOAuthMetadataRevocationEndpointAuthMethodsSupported   `json:"revocation_endpoint_auth_methods_supported"`
	ScopesSupported                            []McpOAuthScope                                            `json:"scopes_supported"`
	TokenEndpoint                              string                                                     `json:"token_endpoint"`
	TokenEndpointAuthMethodsSupported          []McpOAuthMetadataTokenEndpointAuthMethodsSupported        `json:"token_endpoint_auth_methods_supported"`
}

McpOAuthMetadata MCP resource issuer capability metadata. Its advertised scope vocabulary can extend independently of ordinary REST issuer/request scopes; newly advertised write scopes require explicit consent and current domain authority.

type McpOAuthMetadataAuthorizationResponseIssParameterSupported added in v0.4.0 

type McpOAuthMetadataAuthorizationResponseIssParameterSupported bool

McpOAuthMetadataAuthorizationResponseIssParameterSupported defines model for McpOAuthMetadata.AuthorizationResponseIssParameterSupported. 

const (
	McpOAuthMetadataAuthorizationResponseIssParameterSupportedTrue McpOAuthMetadataAuthorizationResponseIssParameterSupported = true
)

Defines values for McpOAuthMetadataAuthorizationResponseIssParameterSupported.

func (McpOAuthMetadataAuthorizationResponseIssParameterSupported) Valid added in v0.4.0 

func (e McpOAuthMetadataAuthorizationResponseIssParameterSupported) Valid() bool

Valid indicates whether the value is a known member of the McpOAuthMetadataAuthorizationResponseIssParameterSupported enum.

type McpOAuthMetadataCodeChallengeMethodsSupported added in v0.4.0 

type McpOAuthMetadataCodeChallengeMethodsSupported string

McpOAuthMetadataCodeChallengeMethodsSupported defines model for McpOAuthMetadata.CodeChallengeMethodsSupported. 

const (
	McpOAuthMetadataCodeChallengeMethodsSupportedS256 McpOAuthMetadataCodeChallengeMethodsSupported = "S256"
)

Defines values for McpOAuthMetadataCodeChallengeMethodsSupported.

func (McpOAuthMetadataCodeChallengeMethodsSupported) Valid added in v0.4.0 

func (e McpOAuthMetadataCodeChallengeMethodsSupported) Valid() bool

Valid indicates whether the value is a known member of the McpOAuthMetadataCodeChallengeMethodsSupported enum.

type McpOAuthMetadataGrantTypesSupported added in v0.4.0 

type McpOAuthMetadataGrantTypesSupported string

McpOAuthMetadataGrantTypesSupported defines model for McpOAuthMetadata.GrantTypesSupported. 

const (
	McpOAuthMetadataGrantTypesSupportedAuthorizationCode McpOAuthMetadataGrantTypesSupported = "authorization_code"
	McpOAuthMetadataGrantTypesSupportedRefreshToken      McpOAuthMetadataGrantTypesSupported = "refresh_token"
)

Defines values for McpOAuthMetadataGrantTypesSupported.

func (McpOAuthMetadataGrantTypesSupported) Valid added in v0.4.0 

func (e McpOAuthMetadataGrantTypesSupported) Valid() bool

Valid indicates whether the value is a known member of the McpOAuthMetadataGrantTypesSupported enum.

type McpOAuthMetadataResponseTypesSupported added in v0.4.0 

type McpOAuthMetadataResponseTypesSupported string

McpOAuthMetadataResponseTypesSupported defines model for McpOAuthMetadata.ResponseTypesSupported. 

const (
	McpOAuthMetadataResponseTypesSupportedCode McpOAuthMetadataResponseTypesSupported = "code"
)

Defines values for McpOAuthMetadataResponseTypesSupported.

func (McpOAuthMetadataResponseTypesSupported) Valid added in v0.4.0 

func (e McpOAuthMetadataResponseTypesSupported) Valid() bool

Valid indicates whether the value is a known member of the McpOAuthMetadataResponseTypesSupported enum.

type McpOAuthMetadataRevocationEndpointAuthMethodsSupported added in v0.4.0 

type McpOAuthMetadataRevocationEndpointAuthMethodsSupported string

McpOAuthMetadataRevocationEndpointAuthMethodsSupported defines model for McpOAuthMetadata.RevocationEndpointAuthMethodsSupported. 

const (
	McpOAuthMetadataRevocationEndpointAuthMethodsSupportedNone McpOAuthMetadataRevocationEndpointAuthMethodsSupported = "none"
)

Defines values for McpOAuthMetadataRevocationEndpointAuthMethodsSupported.

func (McpOAuthMetadataRevocationEndpointAuthMethodsSupported) Valid added in v0.4.0 

func (e McpOAuthMetadataRevocationEndpointAuthMethodsSupported) Valid() bool

Valid indicates whether the value is a known member of the McpOAuthMetadataRevocationEndpointAuthMethodsSupported enum.

type McpOAuthMetadataTokenEndpointAuthMethodsSupported added in v0.4.0 

type McpOAuthMetadataTokenEndpointAuthMethodsSupported string

McpOAuthMetadataTokenEndpointAuthMethodsSupported defines model for McpOAuthMetadata.TokenEndpointAuthMethodsSupported. 

const (
	McpOAuthMetadataTokenEndpointAuthMethodsSupportedNone McpOAuthMetadataTokenEndpointAuthMethodsSupported = "none"
)

Defines values for McpOAuthMetadataTokenEndpointAuthMethodsSupported.

func (McpOAuthMetadataTokenEndpointAuthMethodsSupported) Valid added in v0.4.0 

func (e McpOAuthMetadataTokenEndpointAuthMethodsSupported) Valid() bool

Valid indicates whether the value is a known member of the McpOAuthMetadataTokenEndpointAuthMethodsSupported enum.

type McpOAuthProbe added in v0.4.0 

type McpOAuthProbe struct {
	ClientID    string `json:"client_id"`
	DisplayName string `json:"display_name"`

	// DomainPermissions Current Scripture authority intersected with the grant's approved scopes. Absent in older issuer responses; clients must deny domain tools when absent. This never expands an existing grant.
	DomainPermissions []McpOAuthProbeDomainPermissions `json:"domain_permissions,omitempty"`
	ExpiresAt         int64                            `json:"expires_at"`
	Handle            *string                          `json:"handle"`
	ID                string                           `json:"id"`

	// LivePermissions Current personal Reader Live authority intersected with the grant’s approved scopes, including separately consented stopped creation and quiet queue staging. Absent in older issuer responses; clients must deny Live tools when absent. Existing read-only grants never acquire write scopes automatically.
	LivePermissions []McpOAuthProbeLivePermissions `json:"live_permissions,omitempty"`

	// Permissions Fresh actor MCP entitlement, separate from consented OAuth scopes. Missing mcp.get denies the request; list/call are enforced by the adapter.
	Permissions       []McpOAuthProbePermissions `json:"permissions"`
	PersonalAccountID string                     `json:"personal_account_id"`
	Resource          string                     `json:"resource"`
	Scopes            []string                   `json:"scopes"`
}

McpOAuthProbe Issuer validation result for a valid identity.read MCP-audience token. No token secrets or email. Domain permissions are optional for compatibility with older issuer versions.

type McpOAuthProbeDomainPermissions added in v0.4.0 

type McpOAuthProbeDomainPermissions string

McpOAuthProbeDomainPermissions defines model for McpOAuthProbe.DomainPermissions. 

const (
	McpOAuthProbeDomainPermissionsTranslationGet    McpOAuthProbeDomainPermissions = "translation.get"
	McpOAuthProbeDomainPermissionsTranslationList   McpOAuthProbeDomainPermissions = "translation.list"
	McpOAuthProbeDomainPermissionsTranslationRead   McpOAuthProbeDomainPermissions = "translation.read"
	McpOAuthProbeDomainPermissionsTranslationSearch McpOAuthProbeDomainPermissions = "translation.search"
)

Defines values for McpOAuthProbeDomainPermissions.

func (McpOAuthProbeDomainPermissions) Valid added in v0.4.0 

func (e McpOAuthProbeDomainPermissions) Valid() bool

Valid indicates whether the value is a known member of the McpOAuthProbeDomainPermissions enum.

type McpOAuthProbeError added in v0.4.0 

type McpOAuthProbeError struct {
	Error McpOAuthProbeErrorError `json:"error"`
}

McpOAuthProbeError MCP issuer probe error. Authentication failures are invalid_token; missing identity.read is insufficient_scope.

type McpOAuthProbeErrorError added in v0.4.0 

type McpOAuthProbeErrorError string

McpOAuthProbeErrorError defines model for McpOAuthProbeError.Error. 

const (
	McpOAuthProbeErrorErrorAccessDenied            McpOAuthProbeErrorError = "access_denied"
	McpOAuthProbeErrorErrorInsufficientScope       McpOAuthProbeErrorError = "insufficient_scope"
	McpOAuthProbeErrorErrorInvalidClient           McpOAuthProbeErrorError = "invalid_client"
	McpOAuthProbeErrorErrorInvalidGrant            McpOAuthProbeErrorError = "invalid_grant"
	McpOAuthProbeErrorErrorInvalidRedirectURI      McpOAuthProbeErrorError = "invalid_redirect_uri"
	McpOAuthProbeErrorErrorInvalidRequest          McpOAuthProbeErrorError = "invalid_request"
	McpOAuthProbeErrorErrorInvalidScope            McpOAuthProbeErrorError = "invalid_scope"
	McpOAuthProbeErrorErrorInvalidToken            McpOAuthProbeErrorError = "invalid_token"
	McpOAuthProbeErrorErrorSlowDown                McpOAuthProbeErrorError = "slow_down"
	McpOAuthProbeErrorErrorTemporarilyUnavailable  McpOAuthProbeErrorError = "temporarily_unavailable"
	McpOAuthProbeErrorErrorUnsupportedGrantType    McpOAuthProbeErrorError = "unsupported_grant_type"
	McpOAuthProbeErrorErrorUnsupportedResponseType McpOAuthProbeErrorError = "unsupported_response_type"
)

Defines values for McpOAuthProbeErrorError.

func (McpOAuthProbeErrorError) Valid added in v0.4.0 

func (e McpOAuthProbeErrorError) Valid() bool

Valid indicates whether the value is a known member of the McpOAuthProbeErrorError enum.

type McpOAuthProbeLivePermissions added in v0.4.0 

type McpOAuthProbeLivePermissions string

McpOAuthProbeLivePermissions defines model for McpOAuthProbe.LivePermissions. 

const (
	McpOAuthProbeLivePermissionsLiveCreate     McpOAuthProbeLivePermissions = "live.create"
	McpOAuthProbeLivePermissionsLiveGet        McpOAuthProbeLivePermissions = "live.get"
	McpOAuthProbeLivePermissionsLiveList       McpOAuthProbeLivePermissions = "live.list"
	McpOAuthProbeLivePermissionsLiveQueueStage McpOAuthProbeLivePermissions = "live.queue.stage"
	McpOAuthProbeLivePermissionsLiveRename     McpOAuthProbeLivePermissions = "live.rename"
)

Defines values for McpOAuthProbeLivePermissions.

func (McpOAuthProbeLivePermissions) Valid added in v0.4.0 

func (e McpOAuthProbeLivePermissions) Valid() bool

Valid indicates whether the value is a known member of the McpOAuthProbeLivePermissions enum.

type McpOAuthProbePermissions added in v0.4.0 

type McpOAuthProbePermissions string

McpOAuthProbePermissions defines model for McpOAuthProbe.Permissions. 

const (
	McpCall McpOAuthProbePermissions = "mcp.call"
	McpGet  McpOAuthProbePermissions = "mcp.get"
	McpList McpOAuthProbePermissions = "mcp.list"
)

Defines values for McpOAuthProbePermissions.

func (McpOAuthProbePermissions) Valid added in v0.4.0 

func (e McpOAuthProbePermissions) Valid() bool

Valid indicates whether the value is a known member of the McpOAuthProbePermissions enum.

type McpOAuthScope added in v0.4.0 

type McpOAuthScope string

McpOAuthScope Scopes advertised by the MCP resource issuer. Preparation scopes require explicit client approval and new consent; existing grants remain unchanged. This is separate from ordinary REST authorization scopes. 

const (
	McpOAuthScopeIdentityRead      McpOAuthScope = "identity.read"
	McpOAuthScopeLiveCreate        McpOAuthScope = "live.create"
	McpOAuthScopeLiveGet           McpOAuthScope = "live.get"
	McpOAuthScopeLiveList          McpOAuthScope = "live.list"
	McpOAuthScopeLiveQueueStage    McpOAuthScope = "live.queue.stage"
	McpOAuthScopeLiveRename        McpOAuthScope = "live.rename"
	McpOAuthScopeOfflineAccess     McpOAuthScope = "offline_access"
	McpOAuthScopeTranslationGet    McpOAuthScope = "translation.get"
	McpOAuthScopeTranslationList   McpOAuthScope = "translation.list"
	McpOAuthScopeTranslationRead   McpOAuthScope = "translation.read"
	McpOAuthScopeTranslationSearch McpOAuthScope = "translation.search"
)

Defines values for McpOAuthScope.

func (McpOAuthScope) Valid added in v0.4.0 

func (e McpOAuthScope) Valid() bool

Valid indicates whether the value is a known member of the McpOAuthScope enum.

type Membership added in v0.3.0 

type Membership struct {
	DisplayName    string         `json:"display_name"`
	Handle         string         `json:"handle"`
	ID             string         `json:"id"`
	OrganizationID string         `json:"organization_id"`
	Role           MembershipRole `json:"role"`
}

Membership defines model for Membership.

type MembershipPage added in v0.3.0 

type MembershipPage struct {
	Data       []Membership `json:"data"`
	NextCursor *string      `json:"next_cursor"`
}

MembershipPage defines model for MembershipPage.

type MembershipPatch added in v0.3.0 

type MembershipPatch struct {
	Role MembershipPatchRole `json:"role"`
}

MembershipPatch Examples: {"role":"viewer"}

type MembershipPatchRole added in v0.3.1 

type MembershipPatchRole string

MembershipPatchRole defines model for MembershipPatch.Role. 

const (
	MembershipPatchRoleAdmin    MembershipPatchRole = "admin"
	MembershipPatchRoleOperator MembershipPatchRole = "operator"
	MembershipPatchRoleViewer   MembershipPatchRole = "viewer"
)

Defines values for MembershipPatchRole.

func (MembershipPatchRole) Valid added in v0.3.1 

func (e MembershipPatchRole) Valid() bool

Valid indicates whether the value is a known member of the MembershipPatchRole enum.

type MembershipRole added in v0.3.1 

type MembershipRole string

MembershipRole defines model for Membership.Role. 

const (
	MembershipRoleAdmin    MembershipRole = "admin"
	MembershipRoleOperator MembershipRole = "operator"
	MembershipRoleOwner    MembershipRole = "owner"
	MembershipRoleViewer   MembershipRole = "viewer"
)

Defines values for MembershipRole.

func (MembershipRole) Valid added in v0.3.1 

func (e MembershipRole) Valid() bool

Valid indicates whether the value is a known member of the MembershipRole enum.

type MoveLiveWorkspaceJSONRequestBody added in v0.3.0 

type MoveLiveWorkspaceJSONRequestBody = LiveWorkspacePut

MoveLiveWorkspaceJSONRequestBody defines body for MoveLiveWorkspace for application/json ContentType.

type MoveLiveWorkspaceParams added in v0.3.0 

type MoveLiveWorkspaceParams struct {
	// IfMatch Shared Live sequence validator. Any relevant metadata, display, playback or workspace change invalidates it. Missing:428; stale:412; malformed, weak, wildcard or list:422.
	IfMatch string `json:"If-Match"`
}

MoveLiveWorkspaceParams defines parameters for MoveLiveWorkspace.

type OAuthClient added in v0.3.0 

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

OAuthClient implements the public-client protocol for registered clients. It never sends a bearer token, opens a browser, or persists issued secrets. Callers validate callback state and own secure refresh-token storage.

func NewOAuthClient added in v0.3.0 

func NewOAuthClient(transport *http.Client) (*OAuthClient, error)

func (*OAuthClient) ExchangeCode added in v0.3.0 

func (c *OAuthClient) ExchangeCode(ctx context.Context, clientID, code, redirectURI, verifier string) (OAuthToken, error)

ExchangeCode is a single attempt. Replaying a consumed code can revoke the entire grant; this client never retries, including after transport failures.

func (*OAuthClient) Metadata added in v0.3.0 

func (c *OAuthClient) Metadata(ctx context.Context) (OAuthMetadata, error)

func (*OAuthClient) Refresh added in v0.3.0 

func (c *OAuthClient) Refresh(ctx context.Context, clientID, refreshToken string, scopes []string) (OAuthToken, error)

Refresh rotates a single-use refresh token. Replace stored credentials atomically after success. Reusing a consumed refresh token revokes the grant.

func (*OAuthClient) Revoke added in v0.3.0 

func (c *OAuthClient) Revoke(ctx context.Context, clientID, token string) error

type OAuthError added in v0.3.0 

type OAuthError struct {
	Error OAuthErrorError `json:"error"`
}

OAuthError OAuth protocol error JSON, rather than REST Problem Details. Error redirects are sent only following a validated, session-bound consent decision. Invalid clients/redirects fail locally.

type OAuthErrorError added in v0.3.0 

type OAuthErrorError string

OAuthErrorError defines model for OAuthError.Error. 

const (
	OAuthErrorErrorAccessDenied            OAuthErrorError = "access_denied"
	OAuthErrorErrorInvalidClient           OAuthErrorError = "invalid_client"
	OAuthErrorErrorInvalidGrant            OAuthErrorError = "invalid_grant"
	OAuthErrorErrorInvalidRedirectURI      OAuthErrorError = "invalid_redirect_uri"
	OAuthErrorErrorInvalidRequest          OAuthErrorError = "invalid_request"
	OAuthErrorErrorInvalidScope            OAuthErrorError = "invalid_scope"
	OAuthErrorErrorSlowDown                OAuthErrorError = "slow_down"
	OAuthErrorErrorTemporarilyUnavailable  OAuthErrorError = "temporarily_unavailable"
	OAuthErrorErrorUnsupportedGrantType    OAuthErrorError = "unsupported_grant_type"
	OAuthErrorErrorUnsupportedResponseType OAuthErrorError = "unsupported_response_type"
)

Defines values for OAuthErrorError.

func (OAuthErrorError) Valid added in v0.3.0 

func (e OAuthErrorError) Valid() bool

Valid indicates whether the value is a known member of the OAuthErrorError enum.

type OAuthGrant added in v0.3.0 

type OAuthGrant struct {
	ClientID   string              `json:"client_id"`
	ClientName string              `json:"client_name"`
	ExpiresAt  int64               `json:"expires_at"`
	ID         string              `json:"id"`
	Scopes     []OAuthGrantedScope `json:"scopes"`
}

OAuthGrant defines model for OAuthGrant.

type OAuthGrantList added in v0.3.0 

type OAuthGrantList struct {
	Data []OAuthGrant `json:"data"`
}

OAuthGrantList defines model for OAuthGrantList.

type OAuthGrantedScope added in v0.4.0 

type OAuthGrantedScope string

OAuthGrantedScope Response-only scope vocabulary for an owner inspecting existing REST or MCP grants. Does not allow MCP-only scopes in ordinary REST authorization requests. 

const (
	OAuthGrantedScopeIdentityRead      OAuthGrantedScope = "identity.read"
	OAuthGrantedScopeLiveCreate        OAuthGrantedScope = "live.create"
	OAuthGrantedScopeLiveDelete        OAuthGrantedScope = "live.delete"
	OAuthGrantedScopeLiveGet           OAuthGrantedScope = "live.get"
	OAuthGrantedScopeLiveList          OAuthGrantedScope = "live.list"
	OAuthGrantedScopeLiveQueueStage    OAuthGrantedScope = "live.queue.stage"
	OAuthGrantedScopeLiveRename        OAuthGrantedScope = "live.rename"
	OAuthGrantedScopeLiveUpdate        OAuthGrantedScope = "live.update"
	OAuthGrantedScopeOfflineAccess     OAuthGrantedScope = "offline_access"
	OAuthGrantedScopeTranslationGet    OAuthGrantedScope = "translation.get"
	OAuthGrantedScopeTranslationList   OAuthGrantedScope = "translation.list"
	OAuthGrantedScopeTranslationRead   OAuthGrantedScope = "translation.read"
	OAuthGrantedScopeTranslationSearch OAuthGrantedScope = "translation.search"
)

Defines values for OAuthGrantedScope.

func (OAuthGrantedScope) Valid added in v0.4.0 

func (e OAuthGrantedScope) Valid() bool

Valid indicates whether the value is a known member of the OAuthGrantedScope enum.

type OAuthMetadata added in v0.3.0 

type OAuthMetadata struct {
	AuthorizationEndpoint                      string                                                  `json:"authorization_endpoint"`
	AuthorizationResponseIssParameterSupported OAuthMetadataAuthorizationResponseIssParameterSupported `json:"authorization_response_iss_parameter_supported"`
	CodeChallengeMethodsSupported              []OAuthMetadataCodeChallengeMethodsSupported            `json:"code_challenge_methods_supported"`
	GrantTypesSupported                        []OAuthMetadataGrantTypesSupported                      `json:"grant_types_supported"`
	Issuer                                     string                                                  `json:"issuer"`
	ResponseTypesSupported                     []OAuthMetadataResponseTypesSupported                   `json:"response_types_supported"`
	RevocationEndpoint                         string                                                  `json:"revocation_endpoint"`
	RevocationEndpointAuthMethodsSupported     []OAuthMetadataRevocationEndpointAuthMethodsSupported   `json:"revocation_endpoint_auth_methods_supported"`
	ScopesSupported                            []OAuthMetadataScopesSupported                          `json:"scopes_supported"`
	TokenEndpoint                              string                                                  `json:"token_endpoint"`
	TokenEndpointAuthMethodsSupported          []OAuthMetadataTokenEndpointAuthMethodsSupported        `json:"token_endpoint_auth_methods_supported"`
}

OAuthMetadata defines model for OAuthMetadata.

type OAuthMetadataAuthorizationResponseIssParameterSupported added in v0.3.0 

type OAuthMetadataAuthorizationResponseIssParameterSupported bool

OAuthMetadataAuthorizationResponseIssParameterSupported defines model for OAuthMetadata.AuthorizationResponseIssParameterSupported. 

const (
	OAuthMetadataAuthorizationResponseIssParameterSupportedTrue OAuthMetadataAuthorizationResponseIssParameterSupported = true
)

Defines values for OAuthMetadataAuthorizationResponseIssParameterSupported.

func (OAuthMetadataAuthorizationResponseIssParameterSupported) Valid added in v0.3.0 

func (e OAuthMetadataAuthorizationResponseIssParameterSupported) Valid() bool

Valid indicates whether the value is a known member of the OAuthMetadataAuthorizationResponseIssParameterSupported enum.

type OAuthMetadataCodeChallengeMethodsSupported added in v0.3.0 

type OAuthMetadataCodeChallengeMethodsSupported string

OAuthMetadataCodeChallengeMethodsSupported defines model for OAuthMetadata.CodeChallengeMethodsSupported. 

const (
	OAuthMetadataCodeChallengeMethodsSupportedS256 OAuthMetadataCodeChallengeMethodsSupported = "S256"
)

Defines values for OAuthMetadataCodeChallengeMethodsSupported.

func (OAuthMetadataCodeChallengeMethodsSupported) Valid added in v0.3.0 

func (e OAuthMetadataCodeChallengeMethodsSupported) Valid() bool

Valid indicates whether the value is a known member of the OAuthMetadataCodeChallengeMethodsSupported enum.

type OAuthMetadataGrantTypesSupported added in v0.3.0 

type OAuthMetadataGrantTypesSupported string

OAuthMetadataGrantTypesSupported defines model for OAuthMetadata.GrantTypesSupported. 

const (
	OAuthMetadataGrantTypesSupportedAuthorizationCode OAuthMetadataGrantTypesSupported = "authorization_code"
	OAuthMetadataGrantTypesSupportedRefreshToken      OAuthMetadataGrantTypesSupported = "refresh_token"
)

Defines values for OAuthMetadataGrantTypesSupported.

func (OAuthMetadataGrantTypesSupported) Valid added in v0.3.0 

func (e OAuthMetadataGrantTypesSupported) Valid() bool

Valid indicates whether the value is a known member of the OAuthMetadataGrantTypesSupported enum.

type OAuthMetadataResponseTypesSupported added in v0.3.0 

type OAuthMetadataResponseTypesSupported string

OAuthMetadataResponseTypesSupported defines model for OAuthMetadata.ResponseTypesSupported. 

const (
	OAuthMetadataResponseTypesSupportedCode OAuthMetadataResponseTypesSupported = "code"
)

Defines values for OAuthMetadataResponseTypesSupported.

func (OAuthMetadataResponseTypesSupported) Valid added in v0.3.0 

func (e OAuthMetadataResponseTypesSupported) Valid() bool

Valid indicates whether the value is a known member of the OAuthMetadataResponseTypesSupported enum.

type OAuthMetadataRevocationEndpointAuthMethodsSupported added in v0.3.0 

type OAuthMetadataRevocationEndpointAuthMethodsSupported string

OAuthMetadataRevocationEndpointAuthMethodsSupported defines model for OAuthMetadata.RevocationEndpointAuthMethodsSupported. 

const (
	OAuthMetadataRevocationEndpointAuthMethodsSupportedNone OAuthMetadataRevocationEndpointAuthMethodsSupported = "none"
)

Defines values for OAuthMetadataRevocationEndpointAuthMethodsSupported.

func (OAuthMetadataRevocationEndpointAuthMethodsSupported) Valid added in v0.3.0 

func (e OAuthMetadataRevocationEndpointAuthMethodsSupported) Valid() bool

Valid indicates whether the value is a known member of the OAuthMetadataRevocationEndpointAuthMethodsSupported enum.

type OAuthMetadataScopesSupported added in v0.3.0 

type OAuthMetadataScopesSupported string

OAuthMetadataScopesSupported defines model for OAuthMetadata.ScopesSupported. 

const (
	OAuthMetadataScopesSupportedIdentityRead      OAuthMetadataScopesSupported = "identity.read"
	OAuthMetadataScopesSupportedLiveCreate        OAuthMetadataScopesSupported = "live.create"
	OAuthMetadataScopesSupportedLiveDelete        OAuthMetadataScopesSupported = "live.delete"
	OAuthMetadataScopesSupportedLiveGet           OAuthMetadataScopesSupported = "live.get"
	OAuthMetadataScopesSupportedLiveList          OAuthMetadataScopesSupported = "live.list"
	OAuthMetadataScopesSupportedLiveUpdate        OAuthMetadataScopesSupported = "live.update"
	OAuthMetadataScopesSupportedOfflineAccess     OAuthMetadataScopesSupported = "offline_access"
	OAuthMetadataScopesSupportedTranslationGet    OAuthMetadataScopesSupported = "translation.get"
	OAuthMetadataScopesSupportedTranslationList   OAuthMetadataScopesSupported = "translation.list"
	OAuthMetadataScopesSupportedTranslationRead   OAuthMetadataScopesSupported = "translation.read"
	OAuthMetadataScopesSupportedTranslationSearch OAuthMetadataScopesSupported = "translation.search"
)

Defines values for OAuthMetadataScopesSupported.

func (OAuthMetadataScopesSupported) Valid added in v0.3.0 

func (e OAuthMetadataScopesSupported) Valid() bool

Valid indicates whether the value is a known member of the OAuthMetadataScopesSupported enum.

type OAuthMetadataTokenEndpointAuthMethodsSupported added in v0.3.0 

type OAuthMetadataTokenEndpointAuthMethodsSupported string

OAuthMetadataTokenEndpointAuthMethodsSupported defines model for OAuthMetadata.TokenEndpointAuthMethodsSupported. 

const (
	OAuthMetadataTokenEndpointAuthMethodsSupportedNone OAuthMetadataTokenEndpointAuthMethodsSupported = "none"
)

Defines values for OAuthMetadataTokenEndpointAuthMethodsSupported.

func (OAuthMetadataTokenEndpointAuthMethodsSupported) Valid added in v0.3.0 

func (e OAuthMetadataTokenEndpointAuthMethodsSupported) Valid() bool

Valid indicates whether the value is a known member of the OAuthMetadataTokenEndpointAuthMethodsSupported enum.

type OAuthProtocolError added in v0.3.0 

type OAuthProtocolError struct {
	Code        string      `json:"error"`
	Description string      `json:"error_description"`
	Status      int         `json:"-"`
	Header      http.Header `json:"-"`
}

func (*OAuthProtocolError) Error added in v0.3.0 

func (e *OAuthProtocolError) Error() string

type OAuthResourceError added in v0.4.0 

type OAuthResourceError struct {
	Error OAuthResourceErrorError `json:"error"`
}

OAuthResourceError OAuth errors for resource-aware authorization and token exchange. invalid_target applies to the opt-in MCP audience extension.

type OAuthResourceErrorError added in v0.4.0 

type OAuthResourceErrorError string

OAuthResourceErrorError defines model for OAuthResourceError.Error. 

const (
	OAuthResourceErrorErrorAccessDenied            OAuthResourceErrorError = "access_denied"
	OAuthResourceErrorErrorInvalidClient           OAuthResourceErrorError = "invalid_client"
	OAuthResourceErrorErrorInvalidGrant            OAuthResourceErrorError = "invalid_grant"
	OAuthResourceErrorErrorInvalidRedirectURI      OAuthResourceErrorError = "invalid_redirect_uri"
	OAuthResourceErrorErrorInvalidRequest          OAuthResourceErrorError = "invalid_request"
	OAuthResourceErrorErrorInvalidScope            OAuthResourceErrorError = "invalid_scope"
	OAuthResourceErrorErrorInvalidTarget           OAuthResourceErrorError = "invalid_target"
	OAuthResourceErrorErrorSlowDown                OAuthResourceErrorError = "slow_down"
	OAuthResourceErrorErrorTemporarilyUnavailable  OAuthResourceErrorError = "temporarily_unavailable"
	OAuthResourceErrorErrorUnsupportedGrantType    OAuthResourceErrorError = "unsupported_grant_type"
	OAuthResourceErrorErrorUnsupportedResponseType OAuthResourceErrorError = "unsupported_response_type"
)

Defines values for OAuthResourceErrorError.

func (OAuthResourceErrorError) Valid added in v0.4.0 

func (e OAuthResourceErrorError) Valid() bool

Valid indicates whether the value is a known member of the OAuthResourceErrorError enum.

type OAuthScope added in v0.3.0 

type OAuthScope string

OAuthScope defines model for OAuthScope. 

const (
	OAuthScopeIdentityRead      OAuthScope = "identity.read"
	OAuthScopeLiveCreate        OAuthScope = "live.create"
	OAuthScopeLiveDelete        OAuthScope = "live.delete"
	OAuthScopeLiveGet           OAuthScope = "live.get"
	OAuthScopeLiveList          OAuthScope = "live.list"
	OAuthScopeLiveUpdate        OAuthScope = "live.update"
	OAuthScopeOfflineAccess     OAuthScope = "offline_access"
	OAuthScopeTranslationGet    OAuthScope = "translation.get"
	OAuthScopeTranslationList   OAuthScope = "translation.list"
	OAuthScopeTranslationRead   OAuthScope = "translation.read"
	OAuthScopeTranslationSearch OAuthScope = "translation.search"
)

Defines values for OAuthScope.

func (OAuthScope) Valid added in v0.3.0 

func (e OAuthScope) Valid() bool

Valid indicates whether the value is a known member of the OAuthScope enum.

type OAuthToken added in v0.3.0 

type OAuthToken struct {
	AccessToken  string              `json:"access_token"`
	ExpiresIn    int64               `json:"expires_in"`
	RefreshToken *string             `json:"refresh_token,omitempty"`
	Scope        string              `json:"scope"`
	TokenType    OAuthTokenTokenType `json:"token_type"`
}

OAuthToken Opaque access token; at most 15 minutes and never beyond the grant deadline. refresh_token appears only with offline_access. Store tokens securely; hashes alone are retained server-side. Fixed grant lifetime 30 days; refreshing never extends it.

type OAuthTokenTokenType added in v0.3.0 

type OAuthTokenTokenType string

OAuthTokenTokenType defines model for OAuthToken.TokenType. 

const (
	Bearer OAuthTokenTokenType = "Bearer"
)

Defines values for OAuthTokenTokenType.

func (OAuthTokenTokenType) Valid added in v0.3.0 

func (e OAuthTokenTokenType) Valid() bool

Valid indicates whether the value is a known member of the OAuthTokenTokenType enum.

type Operation added in v0.3.0 

type Operation struct{ Method, Path, Summary string }

type Options added in v0.3.0 

type Options struct {
	// Params accepts generated typed parameters, such as ReadPersonalBookParams.
	// Params and Query are mutually exclusive.
	Params QueryParameters
	Query  url.Values
	JSON   any
	// Body streams raw uploads/imports. It is mutually exclusive with JSON.
	Body        io.Reader
	ContentType string
	// ContentLength is required for raw uploads; use the exact byte length.
	ContentLength                                    int64
	IfMatch, IdempotencyKey, DestinationToken, Range string
}

type Organization added in v0.3.0 

type Organization struct {
	Handle  string `json:"handle"`
	ID      string `json:"id"`
	LogoURL string `json:"logo_url"`
	Name    string `json:"name"`
	Website string `json:"website"`
}

Organization defines model for Organization.

type OrganizationApplicationResult added in v0.0.2 

type OrganizationApplicationResult struct {
	Application OrganizationDirectoryEntry
	Raw         CommandResponse
}

type OrganizationDirectory added in v0.0.2 

type OrganizationDirectory struct {
	Entries []OrganizationDirectoryEntry
	Next    *string
	Raw     CommandResponse
}

type OrganizationDirectoryEntry added in v0.0.2 

type OrganizationDirectoryEntry struct {
	Kind, ID, ApplicationID, Handle, Name, Domain, Role      string
	Verification, Status, State, NextAction, VerificationURL string
	OrganizationID                                           *string
	Fields                                                   map[string]string
}

OrganizationDirectoryEntry represents either a membership or a private application. State and verification strings remain open to future server values.

type OrganizationLiveStudio added in v0.3.0 

type OrganizationLiveStudio struct {
	OrganizationID string `json:"organization_id"`

	// Revision Settings revision independent of any Live sequence. Zero represents unsaved defaults; every accepted PUT increments the revision, even for identical settings.
	Revision int64 `json:"revision"`

	// Settings Examples: {"container":{"border":null,"padding":null,"radius":null},"controls":{"fontSize":true,"fullscreen":true,"theme":true},"elements":{"reference":{"align":"left","bold":true,"font":"sans","italic":false,"lineHeight":112,"size":100},"text":{"align":"left","bold":false,"font":"serif","italic":false,"lineHeight":112,"size":100},"translation":{"align":"left","bold":true,"font":"sans","italic":false,"lineHeight":112,"size":100}},"order":["translation","reference","text"],"palettes":{"dark":{"background":null,"container":null,"reference":null,"text":null,"translation":null},"light":{"background":null,"container":null,"reference":null,"text":null,"translation":null}},"preset":"default","showLogo":true,"transition":"none","version":1}
	Settings LiveStudioSettings `json:"settings"`
}

OrganizationLiveStudio defines model for OrganizationLiveStudio.

type PatchServiceToken added in v0.3.0 

type PatchServiceToken struct {
	// ExpiresAt Future Unix seconds, at most 90 days ahead. Omit to preserve the exact existing expiry; null explicitly selects no expiration.
	ExpiresAt json.RawMessage `json:"expires_at,omitempty"`

	// Label At most 128 UTF-8 bytes.
	Label *string `json:"label,omitempty"`

	// Scopes Every scope must be held by the issuer; duplicate entries are normalized.
	Scopes []Scope `json:"scopes,omitempty"`
}

PatchServiceToken Partial configuration edit. Omitted label/scopes/expiry are preserved exactly. expires_at:null explicitly permits no expiration; finite deadlines must be future and at most 90 days ahead. The resulting scopes must be a subset of the caller scopes. Repeated authentication does not change the configuration ETag.

Examples: {"label":"Integration production"}, {"scopes":["live.list","live.get"]}, {"expires_at":null}

type PersonalAccount added in v0.3.0 

type PersonalAccount struct {
	Handle *string             `json:"handle"`
	ID     string              `json:"id"`
	Kind   PersonalAccountKind `json:"kind"`
	Name   string              `json:"name"`
}

PersonalAccount defines model for PersonalAccount.

type PersonalAccountKind added in v0.3.0 

type PersonalAccountKind string

PersonalAccountKind defines model for PersonalAccount.Kind. 

const (
	Personal PersonalAccountKind = "personal"
)

Defines values for PersonalAccountKind.

func (PersonalAccountKind) Valid added in v0.3.0 

func (e PersonalAccountKind) Valid() bool

Valid indicates whether the value is a known member of the PersonalAccountKind enum.

type PersonalAccountList added in v0.3.0 

type PersonalAccountList struct {
	Data       []PersonalAccount `json:"data"`
	NextCursor *string           `json:"next_cursor"`
}

PersonalAccountList defines model for PersonalAccountList.

type PersonalDirectory added in v0.3.0 

type PersonalDirectory struct {
	Data       []PersonalDirectoryEntry `json:"data"`
	NextCursor *string                  `json:"next_cursor"`
}

PersonalDirectory defines model for PersonalDirectory.

type PersonalDirectoryEntry added in v0.3.0 

type PersonalDirectoryEntry struct {
	ApplicationID   *string         `json:"application_id,omitempty"`
	Domain          *string         `json:"domain,omitempty"`
	Handle          json.RawMessage `json:"handle,omitempty"`
	ID              *string         `json:"id,omitempty"`
	Name            string          `json:"name"`
	NextAction      *string         `json:"next_action,omitempty"`
	OrganizationID  json.RawMessage `json:"organization_id,omitempty"`
	Record          string          `json:"record"`
	Role            *string         `json:"role,omitempty"`
	State           *string         `json:"state,omitempty"`
	Status          *string         `json:"status,omitempty"`
	Verification    *string         `json:"verification,omitempty"`
	VerificationURL *string         `json:"verification_url,omitempty"`
}

PersonalDirectoryEntry defines model for PersonalDirectoryEntry.

type PersonalIdentity added in v0.3.0 

type PersonalIdentity struct {
	DisplayName       string  `json:"display_name"`
	Handle            *string `json:"handle"`
	ID                string  `json:"id"`
	PersonalAccountID string  `json:"personal_account_id"`
}

PersonalIdentity Self-only safe user identity. No email, provider subject, internal principal, credentials or global user directory.

type PersonalLive added in v0.3.0 

type PersonalLive struct {
	AccountID string             `json:"account_id"`
	ID        string             `json:"id"`
	Mode      PersonalLiveMode   `json:"mode"`
	Name      string             `json:"name"`
	Paused    bool               `json:"paused"`
	Sequence  int64              `json:"sequence"`
	Status    PersonalLiveStatus `json:"status"`
}

PersonalLive Personal-account Reader Live resource. Uses account_id instead of organization_id; only the personal account owner can access it with current personal token authority.

type PersonalLiveDisplay added in v0.3.0 

type PersonalLiveDisplay struct {
	AccountID string                    `json:"account_id"`
	LiveID    string                    `json:"live_id"`
	Paused    bool                      `json:"paused"`
	Sequence  int64                     `json:"sequence"`
	Showing   bool                      `json:"showing"`
	Snapshot  *SnapshotSummary          `json:"snapshot"`
	Status    PersonalLiveDisplayStatus `json:"status"`
	Type      PersonalLiveDisplayType   `json:"type"`
	Verses    []DisplayVerse            `json:"verses"`
}

PersonalLiveDisplay Personal-account Reader Live resource. Uses account_id instead of organization_id; only the personal account owner can access it with current personal token authority.

type PersonalLiveDisplayStatus added in v0.3.1 

type PersonalLiveDisplayStatus string

PersonalLiveDisplayStatus defines model for PersonalLiveDisplay.Status. 

const (
	PersonalLiveDisplayStatusRunning PersonalLiveDisplayStatus = "running"
	PersonalLiveDisplayStatusStopped PersonalLiveDisplayStatus = "stopped"
)

Defines values for PersonalLiveDisplayStatus.

func (PersonalLiveDisplayStatus) Valid added in v0.3.1 

func (e PersonalLiveDisplayStatus) Valid() bool

Valid indicates whether the value is a known member of the PersonalLiveDisplayStatus enum.

type PersonalLiveDisplayType added in v0.3.0 

type PersonalLiveDisplayType string

PersonalLiveDisplayType defines model for PersonalLiveDisplay.Type. 

const (
	PersonalLiveDisplayTypeEmpty     PersonalLiveDisplayType = "empty"
	PersonalLiveDisplayTypeScripture PersonalLiveDisplayType = "scripture"
)

Defines values for PersonalLiveDisplayType.

func (PersonalLiveDisplayType) Valid added in v0.3.0 

func (e PersonalLiveDisplayType) Valid() bool

Valid indicates whether the value is a known member of the PersonalLiveDisplayType enum.

type PersonalLiveList added in v0.3.0 

type PersonalLiveList struct {
	Data []PersonalLiveSummary `json:"data"`

	// NextCursor Pass this value unchanged as after; null ends the collection.
	NextCursor *string `json:"next_cursor"`
}

PersonalLiveList Personal-account Reader Live resource. Uses account_id instead of organization_id; only the personal account owner can access it with current personal token authority.

type PersonalLiveMode added in v0.3.0 

type PersonalLiveMode string

PersonalLiveMode defines model for PersonalLive.Mode. 

const (
	PersonalLiveModeReader PersonalLiveMode = "reader"
)

Defines values for PersonalLiveMode.

func (PersonalLiveMode) Valid added in v0.3.0 

func (e PersonalLiveMode) Valid() bool

Valid indicates whether the value is a known member of the PersonalLiveMode enum.

type PersonalLiveQueuePage added in v0.3.0 

type PersonalLiveQueuePage struct {
	AccountID string          `json:"account_id"`
	Data      []LiveQueueItem `json:"data"`
	LiveID    string          `json:"live_id"`

	// NextCursor Opaque sequence-bound cursor. Pass unchanged as after. Any intervening Live sequence change returns 409; malformed/unknown cursor returns 422.
	NextCursor *string `json:"next_cursor"`
	Sequence   int64   `json:"sequence"`
}

PersonalLiveQueuePage Personal-account Reader Live resource. Uses account_id instead of organization_id; only the personal account owner can access it with current personal token authority.

type PersonalLiveStatus added in v0.3.0 

type PersonalLiveStatus string

PersonalLiveStatus defines model for PersonalLive.Status. 

const (
	PersonalLiveStatusRunning PersonalLiveStatus = "running"
	PersonalLiveStatusStopped PersonalLiveStatus = "stopped"
)

Defines values for PersonalLiveStatus.

func (PersonalLiveStatus) Valid added in v0.3.0 

func (e PersonalLiveStatus) Valid() bool

Valid indicates whether the value is a known member of the PersonalLiveStatus enum.

type PersonalLiveSummary added in v0.3.0 

type PersonalLiveSummary struct {
	AccountID string `json:"account_id"`
	ID        string `json:"id"`
	Name      string `json:"name"`
}

PersonalLiveSummary Personal-account Reader Live resource. Uses account_id instead of organization_id; only the personal account owner can access it with current personal token authority.

type PersonalOrganizationApplication added in v0.3.0 

type PersonalOrganizationApplication struct {
	ApplicationID   string  `json:"application_id"`
	Domain          string  `json:"domain"`
	Name            string  `json:"name"`
	NextAction      string  `json:"next_action"`
	OrganizationID  *string `json:"organization_id"`
	State           string  `json:"state"`
	VerificationURL string  `json:"verification_url"`
}

PersonalOrganizationApplication defines model for PersonalOrganizationApplication.

type PersonalTokenCollection added in v0.3.0 

type PersonalTokenCollection struct {
	Data       []PersonalTokenMetadata `json:"data"`
	NextCursor *string                 `json:"next_cursor"`
}

PersonalTokenCollection defines model for PersonalTokenCollection.

type PersonalTokenMetadata added in v0.3.0 

type PersonalTokenMetadata struct {
	ExpiresAt  *int64                      `json:"expires_at"`
	ID         string                      `json:"id"`
	IssuedAt   int64                       `json:"issued_at"`
	Label      *string                     `json:"label"`
	LastUsedAt *int64                      `json:"last_used_at"`
	Retiring   bool                        `json:"retiring"`
	Scopes     []string                    `json:"scopes"`
	Source     PersonalTokenMetadataSource `json:"source"`
}

PersonalTokenMetadata defines model for PersonalTokenMetadata.

type PersonalTokenMetadataSource added in v0.3.0 

type PersonalTokenMetadataSource string

PersonalTokenMetadataSource defines model for PersonalTokenMetadata.Source. 

const (
	API    PersonalTokenMetadataSource = "api"
	Cli    PersonalTokenMetadataSource = "cli"
	Manual PersonalTokenMetadataSource = "manual"
)

Defines values for PersonalTokenMetadataSource.

func (PersonalTokenMetadataSource) Valid added in v0.3.0 

func (e PersonalTokenMetadataSource) Valid() bool

Valid indicates whether the value is a known member of the PersonalTokenMetadataSource enum.

type Playback added in v0.3.0 

type Playback struct {
	LiveID   string         `json:"live_id"`
	Paused   bool           `json:"paused"`
	Sequence int64          `json:"sequence"`
	Showing  bool           `json:"showing"`
	Status   PlaybackStatus `json:"status"`
}

Playback defines model for Playback.

type PlaybackPatch added in v0.3.0 

type PlaybackPatch struct {
	Paused *bool                `json:"paused,omitempty"`
	Status *PlaybackPatchStatus `json:"status,omitempty"`
}

PlaybackPatch Change lifecycle status and/or pause state atomically. Pausing a stopped Live returns 409. Stopping resets pause and visibility; starting alone does not redisplay content. paused:false resumes retained content on a running Live.

Examples: {"paused":true}, {"status":"stopped"}

type PlaybackPatchStatus added in v0.3.1 

type PlaybackPatchStatus string

PlaybackPatchStatus defines model for PlaybackPatch.Status. 

const (
	PlaybackPatchStatusRunning PlaybackPatchStatus = "running"
	PlaybackPatchStatusStopped PlaybackPatchStatus = "stopped"
)

Defines values for PlaybackPatchStatus.

func (PlaybackPatchStatus) Valid added in v0.3.1 

func (e PlaybackPatchStatus) Valid() bool

Valid indicates whether the value is a known member of the PlaybackPatchStatus enum.

type PlaybackStatus added in v0.3.1 

type PlaybackStatus string

PlaybackStatus defines model for Playback.Status. 

const (
	PlaybackStatusRunning PlaybackStatus = "running"
	PlaybackStatusStopped PlaybackStatus = "stopped"
)

Defines values for PlaybackStatus.

func (PlaybackStatus) Valid added in v0.3.1 

func (e PlaybackStatus) Valid() bool

Valid indicates whether the value is a known member of the PlaybackStatus enum.

type PopLiveStackJSONRequestBody added in v0.3.0 

type PopLiveStackJSONRequestBody = LiveStackRemoval

PopLiveStackJSONRequestBody defines body for PopLiveStack for application/json ContentType.

type PopLiveStackParams added in v0.3.0 

type PopLiveStackParams struct {
	// IfMatch Current strong Live ETag. Missing:428; stale:412. No automatic retry.
	IfMatch string `json:"If-Match"`
}

PopLiveStackParams defines parameters for PopLiveStack.

type Presentation added in v0.3.0 

type Presentation struct {
	// Document Version-1 document, at most 2,000,000 encoded JSON bytes. Slide IDs are unique across the deck, element IDs within each slide. Omitted slide background is preserved as omitted. Save retains caller slide/element IDs; no automatic publishing. Existing same-workspace ready media references are checked by the domain; upload and portable import endpoints provide ready media. Uploading alone never modifies the saved document.
	//
	// Examples: {"name":"Sunday","slides":[{"background":"#ffffff","elements":[{"height":560,"id":"heading","text":"Welcome","type":"text","width":1120,"x":80,"y":80}],"id":"opening"}],"version":1}
	Document       PresentationDocument `json:"document"`
	ID             string               `json:"id"`
	OrganizationID string               `json:"organization_id"`
	Revision       int64                `json:"revision"`
}

Presentation defines model for Presentation.

type PresentationAsset added in v0.3.0 

type PresentationAsset struct {
	Bytes          int64                 `json:"bytes"`
	Height         int64                 `json:"height"`
	ID             string                `json:"id"`
	Kind           PresentationAssetKind `json:"kind"`
	Mime           PresentationAssetMime `json:"mime"`
	OrganizationID string                `json:"organization_id"`
	PresentationID string                `json:"presentation_id"`
	Width          int64                 `json:"width"`
}

PresentationAsset defines model for PresentationAsset.

type PresentationAssetKind added in v0.3.0 

type PresentationAssetKind string

PresentationAssetKind defines model for PresentationAsset.Kind. 

const (
	PresentationAssetKindImage PresentationAssetKind = "image"
	PresentationAssetKindVideo PresentationAssetKind = "video"
)

Defines values for PresentationAssetKind.

func (PresentationAssetKind) Valid added in v0.3.0 

func (e PresentationAssetKind) Valid() bool

Valid indicates whether the value is a known member of the PresentationAssetKind enum.

type PresentationAssetMime added in v0.3.0 

type PresentationAssetMime string

PresentationAssetMime defines model for PresentationAsset.Mime. 

const (
	ImageGif  PresentationAssetMime = "image/gif"
	ImageJpeg PresentationAssetMime = "image/jpeg"
	ImagePng  PresentationAssetMime = "image/png"
	VideoMp4  PresentationAssetMime = "video/mp4"
	VideoWebm PresentationAssetMime = "video/webm"
)

Defines values for PresentationAssetMime.

func (PresentationAssetMime) Valid added in v0.3.0 

func (e PresentationAssetMime) Valid() bool

Valid indicates whether the value is a known member of the PresentationAssetMime enum.

type PresentationDisplayReference added in v0.3.0 

type PresentationDisplayReference struct {
	PresentationID string                           `json:"presentation_id"`
	Revision       int64                            `json:"revision"`
	SlideID        *string                          `json:"slide_id,omitempty"`
	Type           PresentationDisplayReferenceType `json:"type"`
}

PresentationDisplayReference Explicitly capture the current saved revision of a same-organization deck. This API has no historical revision archive: if the current saved revision differs, return 409 presentation_revision_conflict. Optional slide_id selects a stable saved slide. Missing slide returns 422. Empty decks and stopped Lives return 409.

type PresentationDisplayReferenceType added in v0.3.1 

type PresentationDisplayReferenceType string

PresentationDisplayReferenceType defines model for PresentationDisplayReference.Type. 

const (
	PresentationDisplayReferenceTypePresentation PresentationDisplayReferenceType = "presentation"
)

Defines values for PresentationDisplayReferenceType.

func (PresentationDisplayReferenceType) Valid added in v0.3.1 

func (e PresentationDisplayReferenceType) Valid() bool

Valid indicates whether the value is a known member of the PresentationDisplayReferenceType enum.

type PresentationDocument added in v0.3.0 

type PresentationDocument struct {
	// Name UTF-8 text, at most 200 bytes; NUL is rejected.
	Name    string                      `json:"name"`
	Slides  []PresentationSlide         `json:"slides"`
	Version PresentationDocumentVersion `json:"version"`
}

PresentationDocument Version-1 document, at most 2,000,000 encoded JSON bytes. Slide IDs are unique across the deck, element IDs within each slide. Omitted slide background is preserved as omitted. Save retains caller slide/element IDs; no automatic publishing. Existing same-workspace ready media references are checked by the domain; upload and portable import endpoints provide ready media. Uploading alone never modifies the saved document.

Examples: {"name":"Sunday","slides":[{"background":"#ffffff","elements":[{"height":560,"id":"heading","text":"Welcome","type":"text","width":1120,"x":80,"y":80}],"id":"opening"}],"version":1}

type PresentationDocumentVersion added in v0.3.0 

type PresentationDocumentVersion int64

PresentationDocumentVersion defines model for PresentationDocument.Version. 

const (
	PresentationDocumentVersionN1 PresentationDocumentVersion = 1
)

Defines values for PresentationDocumentVersion.

func (PresentationDocumentVersion) Valid added in v0.3.0 

func (e PresentationDocumentVersion) Valid() bool

Valid indicates whether the value is a known member of the PresentationDocumentVersion enum.

type PresentationElement added in v0.3.0 

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

PresentationElement defines model for PresentationElement.

func (PresentationElement) AsPresentationImageElement added in v0.3.0 

func (t PresentationElement) AsPresentationImageElement() (PresentationImageElement, error)

AsPresentationImageElement returns the union data inside the PresentationElement as a PresentationImageElement

func (PresentationElement) AsPresentationShapeElement added in v0.3.0 

func (t PresentationElement) AsPresentationShapeElement() (PresentationShapeElement, error)

AsPresentationShapeElement returns the union data inside the PresentationElement as a PresentationShapeElement

func (PresentationElement) AsPresentationTextElement added in v0.3.0 

func (t PresentationElement) AsPresentationTextElement() (PresentationTextElement, error)

AsPresentationTextElement returns the union data inside the PresentationElement as a PresentationTextElement

func (PresentationElement) AsPresentationVerseElement added in v0.3.0 

func (t PresentationElement) AsPresentationVerseElement() (PresentationVerseElement, error)

AsPresentationVerseElement returns the union data inside the PresentationElement as a PresentationVerseElement

func (PresentationElement) AsPresentationVideoElement added in v0.3.0 

func (t PresentationElement) AsPresentationVideoElement() (PresentationVideoElement, error)

AsPresentationVideoElement returns the union data inside the PresentationElement as a PresentationVideoElement

func (PresentationElement) AsPresentationYouTubeElement added in v0.3.0 

func (t PresentationElement) AsPresentationYouTubeElement() (PresentationYouTubeElement, error)

AsPresentationYouTubeElement returns the union data inside the PresentationElement as a PresentationYouTubeElement

func (PresentationElement) Discriminator added in v0.3.0 

func (t PresentationElement) Discriminator() (string, error)

func (*PresentationElement) FromPresentationImageElement added in v0.3.0 

func (t *PresentationElement) FromPresentationImageElement(v PresentationImageElement) error

FromPresentationImageElement overwrites any union data inside the PresentationElement as the provided PresentationImageElement

func (*PresentationElement) FromPresentationShapeElement added in v0.3.0 

func (t *PresentationElement) FromPresentationShapeElement(v PresentationShapeElement) error

FromPresentationShapeElement overwrites any union data inside the PresentationElement as the provided PresentationShapeElement

func (*PresentationElement) FromPresentationTextElement added in v0.3.0 

func (t *PresentationElement) FromPresentationTextElement(v PresentationTextElement) error

FromPresentationTextElement overwrites any union data inside the PresentationElement as the provided PresentationTextElement

func (*PresentationElement) FromPresentationVerseElement added in v0.3.0 

func (t *PresentationElement) FromPresentationVerseElement(v PresentationVerseElement) error

FromPresentationVerseElement overwrites any union data inside the PresentationElement as the provided PresentationVerseElement

func (*PresentationElement) FromPresentationVideoElement added in v0.3.0 

func (t *PresentationElement) FromPresentationVideoElement(v PresentationVideoElement) error

FromPresentationVideoElement overwrites any union data inside the PresentationElement as the provided PresentationVideoElement

func (*PresentationElement) FromPresentationYouTubeElement added in v0.3.0 

func (t *PresentationElement) FromPresentationYouTubeElement(v PresentationYouTubeElement) error

FromPresentationYouTubeElement overwrites any union data inside the PresentationElement as the provided PresentationYouTubeElement

func (PresentationElement) MarshalJSON added in v0.3.0 

func (t PresentationElement) MarshalJSON() ([]byte, error)

func (*PresentationElement) MergePresentationImageElement added in v0.3.0 

func (t *PresentationElement) MergePresentationImageElement(v PresentationImageElement) error

MergePresentationImageElement performs a merge with any union data inside the PresentationElement, using the provided PresentationImageElement

func (*PresentationElement) MergePresentationShapeElement added in v0.3.0 

func (t *PresentationElement) MergePresentationShapeElement(v PresentationShapeElement) error

MergePresentationShapeElement performs a merge with any union data inside the PresentationElement, using the provided PresentationShapeElement

func (*PresentationElement) MergePresentationTextElement added in v0.3.0 

func (t *PresentationElement) MergePresentationTextElement(v PresentationTextElement) error

MergePresentationTextElement performs a merge with any union data inside the PresentationElement, using the provided PresentationTextElement

func (*PresentationElement) MergePresentationVerseElement added in v0.3.0 

func (t *PresentationElement) MergePresentationVerseElement(v PresentationVerseElement) error

MergePresentationVerseElement performs a merge with any union data inside the PresentationElement, using the provided PresentationVerseElement

func (*PresentationElement) MergePresentationVideoElement added in v0.3.0 

func (t *PresentationElement) MergePresentationVideoElement(v PresentationVideoElement) error

MergePresentationVideoElement performs a merge with any union data inside the PresentationElement, using the provided PresentationVideoElement

func (*PresentationElement) MergePresentationYouTubeElement added in v0.3.0 

func (t *PresentationElement) MergePresentationYouTubeElement(v PresentationYouTubeElement) error

MergePresentationYouTubeElement performs a merge with any union data inside the PresentationElement, using the provided PresentationYouTubeElement

func (*PresentationElement) UnmarshalJSON added in v0.3.0 

func (t *PresentationElement) UnmarshalJSON(b []byte) error

func (PresentationElement) ValueByDiscriminator added in v0.3.0 

func (t PresentationElement) ValueByDiscriminator() (interface{}, error)

type PresentationElementStyle added in v0.3.0 

type PresentationElementStyle struct {
	Align       *PresentationElementStyleAlign       `json:"align,omitempty"`
	Bold        *bool                                `json:"bold,omitempty"`
	Color       *string                              `json:"color,omitempty"`
	Fill        *string                              `json:"fill,omitempty"`
	FontFamily  *PresentationElementStyleFontFamily  `json:"font_family,omitempty"`
	FontSize    *float32                             `json:"font_size,omitempty"`
	Italic      *bool                                `json:"italic,omitempty"`
	LineHeight  *float32                             `json:"line_height,omitempty"`
	Opacity     *float32                             `json:"opacity,omitempty"`
	Stroke      *string                              `json:"stroke,omitempty"`
	StrokeStyle *PresentationElementStyleStrokeStyle `json:"stroke_style,omitempty"`
	StrokeWidth *float32                             `json:"stroke_width,omitempty"`
}

PresentationElementStyle defines model for PresentationElementStyle.

type PresentationElementStyleAlign added in v0.3.1 

type PresentationElementStyleAlign string

PresentationElementStyleAlign defines model for PresentationElementStyle.Align. 

const (
	PresentationElementStyleAlignCenter PresentationElementStyleAlign = "center"
	PresentationElementStyleAlignLeft   PresentationElementStyleAlign = "left"
	PresentationElementStyleAlignRight  PresentationElementStyleAlign = "right"
)

Defines values for PresentationElementStyleAlign.

func (PresentationElementStyleAlign) Valid added in v0.3.1 

func (e PresentationElementStyleAlign) Valid() bool

Valid indicates whether the value is a known member of the PresentationElementStyleAlign enum.

type PresentationElementStyleFontFamily added in v0.3.1 

type PresentationElementStyleFontFamily string

PresentationElementStyleFontFamily defines model for PresentationElementStyle.FontFamily. 

const (
	PresentationElementStyleFontFamilyMono  PresentationElementStyleFontFamily = "mono"
	PresentationElementStyleFontFamilySans  PresentationElementStyleFontFamily = "sans"
	PresentationElementStyleFontFamilySerif PresentationElementStyleFontFamily = "serif"
)

Defines values for PresentationElementStyleFontFamily.

func (PresentationElementStyleFontFamily) Valid added in v0.3.1 

func (e PresentationElementStyleFontFamily) Valid() bool

Valid indicates whether the value is a known member of the PresentationElementStyleFontFamily enum.

type PresentationElementStyleStrokeStyle added in v0.3.1 

type PresentationElementStyleStrokeStyle string

PresentationElementStyleStrokeStyle defines model for PresentationElementStyle.StrokeStyle. 

const (
	Dashed PresentationElementStyleStrokeStyle = "dashed"
	Dotted PresentationElementStyleStrokeStyle = "dotted"
	Solid  PresentationElementStyleStrokeStyle = "solid"
)

Defines values for PresentationElementStyleStrokeStyle.

func (PresentationElementStyleStrokeStyle) Valid added in v0.3.1 

func (e PresentationElementStyleStrokeStyle) Valid() bool

Valid indicates whether the value is a known member of the PresentationElementStyleStrokeStyle enum.

type PresentationExport added in v0.3.0 

type PresentationExport struct {
	Bytes     *int64 `json:"bytes"`
	CreatedAt int64  `json:"created_at"`

	// DownloadURL Relative POST downloads URL, available only when completed. Requires the requesting credential and current presentation.export scope. Never a public URL.
	DownloadURL    *string                  `json:"download_url"`
	Error          *PresentationExportError `json:"error"`
	ExpiresAt      int64                    `json:"expires_at"`
	Format         PresentationExportFormat `json:"format"`
	ID             string                   `json:"id"`
	OrganizationID string                   `json:"organization_id"`
	PresentationID string                   `json:"presentation_id"`
	Revision       int64                    `json:"revision"`
	Status         PresentationExportStatus `json:"status"`
}

PresentationExport Safe requester-private job projection. Timestamps are Unix seconds. Jobs snapshot the saved revision at creation; later saves never alter the captured document. Expiry is initially ten minutes and resets to ten minutes on completion/failure. Jobs disappear on expiry, presentation deletion or successful download consumption. Starting a new export removes this requester’s failed jobs.

type PresentationExportError added in v0.3.0 

type PresentationExportError string

PresentationExportError defines model for PresentationExport.Error. 

const (
	ExportCancelled    PresentationExportError = "export_cancelled"
	ExportFailed       PresentationExportError = "export_failed"
	ExportInterrupted  PresentationExportError = "export_interrupted"
	ExportTooLarge     PresentationExportError = "export_too_large"
	LessThanNil        PresentationExportError = "<nil>"
	RuntimeUnavailable PresentationExportError = "runtime_unavailable"
)

Defines values for PresentationExportError.

func (PresentationExportError) Valid added in v0.3.0 

func (e PresentationExportError) Valid() bool

Valid indicates whether the value is a known member of the PresentationExportError enum.

type PresentationExportFormat added in v0.3.0 

type PresentationExportFormat string

PresentationExportFormat defines model for PresentationExport.Format. 

const (
	PresentationExportFormatBibleit PresentationExportFormat = "bibleit"
	PresentationExportFormatHTML    PresentationExportFormat = "html"
	PresentationExportFormatJpeg    PresentationExportFormat = "jpeg"
	PresentationExportFormatPdf     PresentationExportFormat = "pdf"
	PresentationExportFormatPng     PresentationExportFormat = "png"
)

Defines values for PresentationExportFormat.

func (PresentationExportFormat) Valid added in v0.3.0 

func (e PresentationExportFormat) Valid() bool

Valid indicates whether the value is a known member of the PresentationExportFormat enum.

type PresentationExportList added in v0.3.0 

type PresentationExportList struct {
	Data       []PresentationExport `json:"data"`
	NextCursor *string              `json:"next_cursor"`
}

PresentationExportList defines model for PresentationExportList.

type PresentationExportStatus added in v0.3.0 

type PresentationExportStatus string

PresentationExportStatus defines model for PresentationExport.Status. 

const (
	PresentationExportStatusCompleted PresentationExportStatus = "completed"
	PresentationExportStatusFailed    PresentationExportStatus = "failed"
	PresentationExportStatusQueued    PresentationExportStatus = "queued"
	PresentationExportStatusRunning   PresentationExportStatus = "running"
)

Defines values for PresentationExportStatus.

func (PresentationExportStatus) Valid added in v0.3.0 

func (e PresentationExportStatus) Valid() bool

Valid indicates whether the value is a known member of the PresentationExportStatus enum.

type PresentationImageElement added in v0.3.0 

type PresentationImageElement struct {
	// Alt UTF-8 text, at most 1000 bytes; NUL is rejected.
	Alt      string                       `json:"alt"`
	Asset    string                       `json:"asset"`
	Fit      PresentationImageElementFit  `json:"fit"`
	Height   int64                        `json:"height"`
	ID       string                       `json:"id"`
	Rotation *int64                       `json:"rotation,omitempty"`
	Style    *PresentationElementStyle    `json:"style,omitempty"`
	Type     PresentationImageElementType `json:"type"`
	Width    int64                        `json:"width"`
	X        int64                        `json:"x"`
	Y        int64                        `json:"y"`
}

PresentationImageElement Coordinates and dimensions are integer canvas units; x+width must be <=1280 and y+height <=720 (checked by the domain validator). IDs must be unique within a slide.

type PresentationImageElementFit added in v0.3.1 

type PresentationImageElementFit string

PresentationImageElementFit defines model for PresentationImageElement.Fit. 

const (
	PresentationImageElementFitContain PresentationImageElementFit = "contain"
	PresentationImageElementFitCover   PresentationImageElementFit = "cover"
)

Defines values for PresentationImageElementFit.

func (PresentationImageElementFit) Valid added in v0.3.1 

func (e PresentationImageElementFit) Valid() bool

Valid indicates whether the value is a known member of the PresentationImageElementFit enum.

type PresentationImageElementType added in v0.3.1 

type PresentationImageElementType string

PresentationImageElementType defines model for PresentationImageElement.Type. 

const (
	PresentationImageElementTypeImage PresentationImageElementType = "image"
)

Defines values for PresentationImageElementType.

func (PresentationImageElementType) Valid added in v0.3.1 

func (e PresentationImageElementType) Valid() bool

Valid indicates whether the value is a known member of the PresentationImageElementType enum.

type PresentationPage added in v0.3.0 

type PresentationPage struct {
	Data       []PresentationSummary `json:"data"`
	NextCursor *string               `json:"next_cursor"`
}

PresentationPage defines model for PresentationPage.

type PresentationShapeElement added in v0.3.0 

type PresentationShapeElement struct {
	Height   int64                         `json:"height"`
	ID       string                        `json:"id"`
	Rotation *int64                        `json:"rotation,omitempty"`
	Shape    PresentationShapeElementShape `json:"shape"`
	Style    *PresentationElementStyle     `json:"style,omitempty"`
	Type     PresentationShapeElementType  `json:"type"`
	Width    int64                         `json:"width"`
	X        int64                         `json:"x"`
	Y        int64                         `json:"y"`
}

PresentationShapeElement Coordinates and dimensions are integer canvas units; x+width must be <=1280 and y+height <=720 (checked by the domain validator). IDs must be unique within a slide.

type PresentationShapeElementShape added in v0.3.1 

type PresentationShapeElementShape string

PresentationShapeElementShape defines model for PresentationShapeElement.Shape. 

const (
	Arrow            PresentationShapeElementShape = "arrow"
	CurvedConnector  PresentationShapeElementShape = "curved_connector"
	Diamond          PresentationShapeElementShape = "diamond"
	ElbowConnector   PresentationShapeElementShape = "elbow_connector"
	Ellipse          PresentationShapeElementShape = "ellipse"
	Line             PresentationShapeElementShape = "line"
	LineArrow        PresentationShapeElementShape = "line_arrow"
	Rectangle        PresentationShapeElementShape = "rectangle"
	RoundedRectangle PresentationShapeElementShape = "rounded_rectangle"
	Triangle         PresentationShapeElementShape = "triangle"
)

Defines values for PresentationShapeElementShape.

func (PresentationShapeElementShape) Valid added in v0.3.1 

func (e PresentationShapeElementShape) Valid() bool

Valid indicates whether the value is a known member of the PresentationShapeElementShape enum.

type PresentationShapeElementType added in v0.3.1 

type PresentationShapeElementType string

PresentationShapeElementType defines model for PresentationShapeElement.Type. 

const (
	Shape PresentationShapeElementType = "shape"
)

Defines values for PresentationShapeElementType.

func (PresentationShapeElementType) Valid added in v0.3.1 

func (e PresentationShapeElementType) Valid() bool

Valid indicates whether the value is a known member of the PresentationShapeElementType enum.

type PresentationSlide added in v0.3.0 

type PresentationSlide struct {
	Background *string               `json:"background,omitempty"`
	Elements   []PresentationElement `json:"elements"`
	ID         string                `json:"id"`
}

PresentationSlide defines model for PresentationSlide.

type PresentationSummary added in v0.3.0 

type PresentationSummary struct {
	ID             string `json:"id"`
	Name           string `json:"name"`
	OrganizationID string `json:"organization_id"`
	Revision       int64  `json:"revision"`
	SlideCount     int64  `json:"slide_count"`
}

PresentationSummary defines model for PresentationSummary.

type PresentationTextElement added in v0.3.0 

type PresentationTextElement struct {
	Height   int64                     `json:"height"`
	ID       string                    `json:"id"`
	Rotation *int64                    `json:"rotation,omitempty"`
	Style    *PresentationElementStyle `json:"style,omitempty"`

	// Text UTF-8 text, at most 20000 bytes; NUL is rejected.
	Text  string                      `json:"text"`
	Type  PresentationTextElementType `json:"type"`
	Width int64                       `json:"width"`
	X     int64                       `json:"x"`
	Y     int64                       `json:"y"`
}

PresentationTextElement Coordinates and dimensions are integer canvas units; x+width must be <=1280 and y+height <=720 (checked by the domain validator). IDs must be unique within a slide.

type PresentationTextElementType added in v0.3.1 

type PresentationTextElementType string

PresentationTextElementType defines model for PresentationTextElement.Type. 

const (
	PresentationTextElementTypeText PresentationTextElementType = "text"
)

Defines values for PresentationTextElementType.

func (PresentationTextElementType) Valid added in v0.3.1 

func (e PresentationTextElementType) Valid() bool

Valid indicates whether the value is a known member of the PresentationTextElementType enum.

type PresentationVerseElement added in v0.3.0 

type PresentationVerseElement struct {
	// Attribution UTF-8 text, at most 2000 bytes; NUL is rejected.
	Attribution string `json:"attribution"`

	// Edition UTF-8 text, at most 2000 bytes; NUL is rejected.
	Edition string `json:"edition"`
	Height  int64  `json:"height"`
	ID      string `json:"id"`

	// Reference UTF-8 text, at most 200 bytes; NUL is rejected.
	Reference string                    `json:"reference"`
	Rotation  *int64                    `json:"rotation,omitempty"`
	Style     *PresentationElementStyle `json:"style,omitempty"`

	// Text UTF-8 text, at most 20000 bytes; NUL is rejected.
	Text string `json:"text"`

	// Translation UTF-8 text, at most 200 bytes; NUL is rejected.
	Translation string                       `json:"translation"`
	Type        PresentationVerseElementType `json:"type"`
	Width       int64                        `json:"width"`
	X           int64                        `json:"x"`
	Y           int64                        `json:"y"`
}

PresentationVerseElement Coordinates and dimensions are integer canvas units; x+width must be <=1280 and y+height <=720 (checked by the domain validator). IDs must be unique within a slide. Known open-license edition/attribution fields are restored from the reviewed catalogue on saves and reads.

type PresentationVerseElementType added in v0.3.1 

type PresentationVerseElementType string

PresentationVerseElementType defines model for PresentationVerseElement.Type. 

const (
	PresentationVerseElementTypeVerse PresentationVerseElementType = "verse"
)

Defines values for PresentationVerseElementType.

func (PresentationVerseElementType) Valid added in v0.3.1 

func (e PresentationVerseElementType) Valid() bool

Valid indicates whether the value is a known member of the PresentationVerseElementType enum.

type PresentationVideoElement added in v0.3.0 

type PresentationVideoElement struct {
	Asset    string                       `json:"asset"`
	Fit      PresentationVideoElementFit  `json:"fit"`
	Height   int64                        `json:"height"`
	ID       string                       `json:"id"`
	Loop     *bool                        `json:"loop,omitempty"`
	Muted    *bool                        `json:"muted,omitempty"`
	Poster   *string                      `json:"poster,omitempty"`
	Rotation *int64                       `json:"rotation,omitempty"`
	Style    *PresentationElementStyle    `json:"style,omitempty"`
	Type     PresentationVideoElementType `json:"type"`
	Width    int64                        `json:"width"`
	X        int64                        `json:"x"`
	Y        int64                        `json:"y"`
}

PresentationVideoElement Coordinates and dimensions are integer canvas units; x+width must be <=1280 and y+height <=720 (checked by the domain validator). IDs must be unique within a slide.

type PresentationVideoElementFit added in v0.3.1 

type PresentationVideoElementFit string

PresentationVideoElementFit defines model for PresentationVideoElement.Fit. 

const (
	PresentationVideoElementFitContain PresentationVideoElementFit = "contain"
	PresentationVideoElementFitCover   PresentationVideoElementFit = "cover"
)

Defines values for PresentationVideoElementFit.

func (PresentationVideoElementFit) Valid added in v0.3.1 

func (e PresentationVideoElementFit) Valid() bool

Valid indicates whether the value is a known member of the PresentationVideoElementFit enum.

type PresentationVideoElementType added in v0.3.1 

type PresentationVideoElementType string

PresentationVideoElementType defines model for PresentationVideoElement.Type. 

const (
	PresentationVideoElementTypeVideo PresentationVideoElementType = "video"
)

Defines values for PresentationVideoElementType.

func (PresentationVideoElementType) Valid added in v0.3.1 

func (e PresentationVideoElementType) Valid() bool

Valid indicates whether the value is a known member of the PresentationVideoElementType enum.

type PresentationYouTubeElement added in v0.3.0 

type PresentationYouTubeElement struct {
	Height   int64                          `json:"height"`
	ID       string                         `json:"id"`
	Rotation *int64                         `json:"rotation,omitempty"`
	Style    *PresentationElementStyle      `json:"style,omitempty"`
	Type     PresentationYouTubeElementType `json:"type"`
	VideoID  string                         `json:"video_id"`
	Width    int64                          `json:"width"`
	X        int64                          `json:"x"`
	Y        int64                          `json:"y"`
}

PresentationYouTubeElement Coordinates and dimensions are integer canvas units; x+width must be <=1280 and y+height <=720 (checked by the domain validator). IDs must be unique within a slide.

type PresentationYouTubeElementType added in v0.3.1 

type PresentationYouTubeElementType string

PresentationYouTubeElementType defines model for PresentationYouTubeElement.Type. 

const (
	Youtube PresentationYouTubeElementType = "youtube"
)

Defines values for PresentationYouTubeElementType.

func (PresentationYouTubeElementType) Valid added in v0.3.1 

func (e PresentationYouTubeElementType) Valid() bool

Valid indicates whether the value is a known member of the PresentationYouTubeElementType enum.

type Problem added in v0.3.0 

type Problem struct {
	Code string `json:"code"`

	// Detail Safe explanation and recovery guidance, including invalid, mismatched and stale Scripture cursors.
	Detail    *string     `json:"detail,omitempty"`
	RequestID string      `json:"request_id"`
	Status    int64       `json:"status"`
	Title     string      `json:"title"`
	Type      ProblemType `json:"type"`
}

Problem Examples: {"code":"forbidden","request_id":"000000000000000000000000","status":403,"title":"Forbidden","type":"about:blank"}

type ProblemError added in v0.3.0 

type ProblemError struct {
	Type  string `json:"type"`
	Title string `json:"title"`
	// Detail is server-supplied guidance. Error() intentionally omits it.
	Detail    string      `json:"detail,omitempty"`
	Status    int         `json:"status"`
	Code      string      `json:"code"`
	RequestID string      `json:"request_id"`
	Header    http.Header `json:"-"`
}

func (*ProblemError) Error added in v0.3.0 

func (e *ProblemError) Error() string

func (*ProblemError) RetryAfter added in v0.3.0 

func (e *ProblemError) RetryAfter() time.Duration

type ProblemType added in v0.3.1 

type ProblemType string

ProblemType defines model for Problem.Type. 

const (
	AboutBlank ProblemType = "about:blank"
)

Defines values for ProblemType.

func (ProblemType) Valid added in v0.3.1 

func (e ProblemType) Valid() bool

Valid indicates whether the value is a known member of the ProblemType enum.

type PushLiveStackJSONRequestBody added in v0.3.0 

type PushLiveStackJSONRequestBody = LiveStackPush

PushLiveStackJSONRequestBody defines body for PushLiveStack for application/json ContentType.

type PushLiveStackParams added in v0.3.0 

type PushLiveStackParams struct {
	// IfMatch Current strong Live ETag. Missing:428; stale:412. No automatic retry.
	IfMatch string `json:"If-Match"`
}

PushLiveStackParams defines parameters for PushLiveStack.

type PutOrganizationLiveStudio added in v0.3.0 

type PutOrganizationLiveStudio struct {
	// Settings Full settings replacement using the existing version-1 Studio model. Only preset and transition may be omitted; they default to default and none. Every other field and all nested keys are required. Unknown fields are rejected at every level.
	//
	// Examples: {"container":{"border":null,"padding":null,"radius":null},"controls":{"fontSize":true,"fullscreen":true,"theme":true},"elements":{"reference":{"align":"left","bold":true,"font":"sans","italic":false,"lineHeight":112,"size":100},"text":{"align":"left","bold":false,"font":"serif","italic":false,"lineHeight":112,"size":100},"translation":{"align":"left","bold":true,"font":"sans","italic":false,"lineHeight":112,"size":100}},"order":["translation","reference","text"],"palettes":{"dark":{"background":null,"container":null,"reference":null,"text":null,"translation":null},"light":{"background":null,"container":null,"reference":null,"text":null,"translation":null}},"preset":"default","showLogo":true,"transition":"none","version":1}
	Settings LiveStudioSettingsInput `json:"settings"`
}

PutOrganizationLiveStudio Examples: {"settings":{"container":{"border":null,"padding":null,"radius":null},"controls":{"fontSize":true,"fullscreen":true,"theme":true},"elements":{"reference":{"align":"left","bold":true,"font":"sans","italic":false,"lineHeight":112,"size":100},"text":{"align":"left","bold":false,"font":"serif","italic":false,"lineHeight":112,"size":100},"translation":{"align":"left","bold":true,"font":"sans","italic":false,"lineHeight":112,"size":100}},"order":["translation","reference","text"],"palettes":{"dark":{"background":null,"container":null,"reference":null,"text":null,"translation":null},"light":{"background":null,"container":null,"reference":null,"text":null,"translation":null}},"preset":"default","showLogo":true,"transition":"none","version":1}}

type PutPresentation added in v0.3.0 

type PutPresentation struct {
	// Document Version-1 document, at most 2,000,000 encoded JSON bytes. Slide IDs are unique across the deck, element IDs within each slide. Omitted slide background is preserved as omitted. Save retains caller slide/element IDs; no automatic publishing. Existing same-workspace ready media references are checked by the domain; upload and portable import endpoints provide ready media. Uploading alone never modifies the saved document.
	//
	// Examples: {"name":"Sunday","slides":[{"background":"#ffffff","elements":[{"height":560,"id":"heading","text":"Welcome","type":"text","width":1120,"x":80,"y":80}],"id":"opening"}],"version":1}
	Document PresentationDocument `json:"document"`
}

PutPresentation defines model for PutPresentation.

type QueryParameters added in v0.3.1 

type QueryParameters interface {
	QueryValues() url.Values
}

QueryParameters is implemented by generated operation Params with query fields.

type Quota 

type Quota struct {
	Permission string
	Limit      QuotaLimit
	Used       int64
	Fields     map[string]string
}

type QuotaLimit 

type QuotaLimit struct {
	Unlimited bool
	Value     int64 // Meaningful only when Unlimited is false.
}

type QuotaResult 

type QuotaResult struct {
	Quotas []Quota
	Raw    CommandResponse
}

type ReadBookParams added in v0.3.0 

type ReadBookParams struct {
	// Limit Maximum verses per page, 1–500; default 50 even when no query parameters are supplied. A 3MiB serialized response cap may produce fewer items. Follow next_cursor until null.
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Opaque next_cursor from the preceding page; omit for the first page. Bound to account, normalized translation, canonical book and installed edition revision; limit may change. Invalid/tampered: 422 invalid_cursor. Different resource: 422 cursor_mismatch. Changed edition: 409 stale_cursor. Restart without after after edition/key changes.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ReadBookParams defines parameters for ReadBook.

func (ReadBookParams) QueryValues added in v0.3.1 

func (p ReadBookParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ReadBookParams) WithAfter added in v0.3.1 

func (p ReadBookParams) WithAfter(value string) ReadBookParams

WithAfter returns a copy with the after query parameter set.

func (ReadBookParams) WithLimit added in v0.3.1 

func (p ReadBookParams) WithLimit(value int64) ReadBookParams

WithLimit returns a copy with the limit query parameter set.

type ReadPersonalBookParams added in v0.3.0 

type ReadPersonalBookParams struct {
	// Limit Maximum verses per page, 1–500; default 50 even when no query parameters are supplied. A 3MiB serialized response cap may produce fewer items. Follow next_cursor until null.
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// After Opaque next_cursor from the preceding page; omit for the first page. Bound to account, normalized translation, canonical book and installed edition revision; limit may change. Invalid/tampered: 422 invalid_cursor. Different resource: 422 cursor_mismatch. Changed edition: 409 stale_cursor. Restart without after after edition/key changes.
	After *string `form:"after,omitempty" json:"after,omitempty"`
}

ReadPersonalBookParams defines parameters for ReadPersonalBook.

func (ReadPersonalBookParams) QueryValues added in v0.3.1 

func (p ReadPersonalBookParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (ReadPersonalBookParams) WithAfter added in v0.3.1 

func (p ReadPersonalBookParams) WithAfter(value string) ReadPersonalBookParams

WithAfter returns a copy with the after query parameter set.

func (ReadPersonalBookParams) WithLimit added in v0.3.1 

func (p ReadPersonalBookParams) WithLimit(value int64) ReadPersonalBookParams

WithLimit returns a copy with the limit query parameter set.

type Reading 

type Reading struct {
	Translation string
	// Header coordinates describe the requested range; per-verse source metadata
	// is available in Verses when supplied by the server.
	Book, Chapter, Verse *int64
	Verses               []VerseText
	Raw                  CommandResponse
}

type Record 

type Record struct {
	Type   string
	Fields map[string]string
	Order  []string
}

Record preserves unknown v1 fields and their wire order.

func ParseRecord 

func ParseRecord(line string) (Record, error)

ParseRecord decodes response quoting and escaping, rejecting truncated strings.

type Reference 

type Reference struct {
	Translation string
	Book        string
	Chapter     int
	Verse       int
}

Reference identifies a book, chapter, or verse. Zero chapter/verse means omitted.

type ReplaceDisplay added in v0.3.0 

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

ReplaceDisplay Replace with credited scripture, an explicitly selected saved presentation revision, or clear. Scripture needs translation.read; presentation needs presentation.present in addition to live.update. Saving a presentation never publishes it. Scripture ranges contain 1..100 existing verses in one chapter.

Examples: {"reference":{"book_id":1,"chapter":1,"translation":"web","verse_end":2,"verse_start":1},"type":"scripture"}, {"type":"empty"}, {"presentation_id":"00000000-0000-4000-8000-000000000001","revision":1,"slide_id":"opening","type":"presentation"}

func (ReplaceDisplay) AsPresentationDisplayReference added in v0.3.0 

func (t ReplaceDisplay) AsPresentationDisplayReference() (PresentationDisplayReference, error)

AsPresentationDisplayReference returns the union data inside the ReplaceDisplay as a PresentationDisplayReference

func (ReplaceDisplay) AsReplaceDisplay0 added in v0.3.0 

func (t ReplaceDisplay) AsReplaceDisplay0() (ReplaceDisplay0, error)

AsReplaceDisplay0 returns the union data inside the ReplaceDisplay as a ReplaceDisplay0

func (ReplaceDisplay) AsReplaceDisplay1 added in v0.3.0 

func (t ReplaceDisplay) AsReplaceDisplay1() (ReplaceDisplay1, error)

AsReplaceDisplay1 returns the union data inside the ReplaceDisplay as a ReplaceDisplay1

func (*ReplaceDisplay) FromPresentationDisplayReference added in v0.3.0 

func (t *ReplaceDisplay) FromPresentationDisplayReference(v PresentationDisplayReference) error

FromPresentationDisplayReference overwrites any union data inside the ReplaceDisplay as the provided PresentationDisplayReference

func (*ReplaceDisplay) FromReplaceDisplay0 added in v0.3.0 

func (t *ReplaceDisplay) FromReplaceDisplay0(v ReplaceDisplay0) error

FromReplaceDisplay0 overwrites any union data inside the ReplaceDisplay as the provided ReplaceDisplay0

func (*ReplaceDisplay) FromReplaceDisplay1 added in v0.3.0 

func (t *ReplaceDisplay) FromReplaceDisplay1(v ReplaceDisplay1) error

FromReplaceDisplay1 overwrites any union data inside the ReplaceDisplay as the provided ReplaceDisplay1

func (ReplaceDisplay) MarshalJSON added in v0.3.0 

func (t ReplaceDisplay) MarshalJSON() ([]byte, error)

func (*ReplaceDisplay) MergePresentationDisplayReference added in v0.3.0 

func (t *ReplaceDisplay) MergePresentationDisplayReference(v PresentationDisplayReference) error

MergePresentationDisplayReference performs a merge with any union data inside the ReplaceDisplay, using the provided PresentationDisplayReference

func (*ReplaceDisplay) MergeReplaceDisplay0 added in v0.3.0 

func (t *ReplaceDisplay) MergeReplaceDisplay0(v ReplaceDisplay0) error

MergeReplaceDisplay0 performs a merge with any union data inside the ReplaceDisplay, using the provided ReplaceDisplay0

func (*ReplaceDisplay) MergeReplaceDisplay1 added in v0.3.0 

func (t *ReplaceDisplay) MergeReplaceDisplay1(v ReplaceDisplay1) error

MergeReplaceDisplay1 performs a merge with any union data inside the ReplaceDisplay, using the provided ReplaceDisplay1

func (*ReplaceDisplay) UnmarshalJSON added in v0.3.0 

func (t *ReplaceDisplay) UnmarshalJSON(b []byte) error

type ReplaceDisplay0 added in v0.3.0 

type ReplaceDisplay0 ReplaceDisplay_0

ReplaceDisplay0 defines model for ReplaceDisplay.0.

type ReplaceDisplay0Type added in v0.3.1 

type ReplaceDisplay0Type string

ReplaceDisplay0Type defines model for ReplaceDisplay.0.Type. 

const (
	ReplaceDisplay0TypeEmpty ReplaceDisplay0Type = "empty"
)

Defines values for ReplaceDisplay0Type.

func (ReplaceDisplay0Type) Valid added in v0.3.1 

func (e ReplaceDisplay0Type) Valid() bool

Valid indicates whether the value is a known member of the ReplaceDisplay0Type enum.

type ReplaceDisplay1 added in v0.3.0 

type ReplaceDisplay1 ReplaceDisplay_1

ReplaceDisplay1 defines model for ReplaceDisplay.1.

type ReplaceDisplay1Type added in v0.3.1 

type ReplaceDisplay1Type string

ReplaceDisplay1Type defines model for ReplaceDisplay.1.Type. 

const (
	ReplaceDisplay1TypeScripture ReplaceDisplay1Type = "scripture"
)

Defines values for ReplaceDisplay1Type.

func (ReplaceDisplay1Type) Valid added in v0.3.1 

func (e ReplaceDisplay1Type) Valid() bool

Valid indicates whether the value is a known member of the ReplaceDisplay1Type enum.

type ReplaceDisplay_0 added in v0.3.1 

type ReplaceDisplay_0 struct {
	Type ReplaceDisplay0Type `json:"type"`
}

ReplaceDisplay_0 defines model for ReplaceDisplay.0.

type ReplaceDisplay_1 added in v0.3.1 

type ReplaceDisplay_1 struct {
	Reference ScriptureReference  `json:"reference"`
	Type      ReplaceDisplay1Type `json:"type"`
}

ReplaceDisplay_1 defines model for ReplaceDisplay.1.

type ReplaceLiveDisplay200JSONResponseBody added in v0.3.0 

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

ReplaceLiveDisplay200JSONResponseBody defines parameters for ReplaceLiveDisplay.

func (ReplaceLiveDisplay200JSONResponseBody) AsLiveDisplay added in v0.3.0 

func (t ReplaceLiveDisplay200JSONResponseBody) AsLiveDisplay() (LiveDisplay, error)

AsLiveDisplay returns the union data inside the ReplaceLiveDisplay200JSONResponseBody as a LiveDisplay

func (ReplaceLiveDisplay200JSONResponseBody) AsPersonalLiveDisplay added in v0.3.0 

func (t ReplaceLiveDisplay200JSONResponseBody) AsPersonalLiveDisplay() (PersonalLiveDisplay, error)

AsPersonalLiveDisplay returns the union data inside the ReplaceLiveDisplay200JSONResponseBody as a PersonalLiveDisplay

func (*ReplaceLiveDisplay200JSONResponseBody) FromLiveDisplay added in v0.3.0 

func (t *ReplaceLiveDisplay200JSONResponseBody) FromLiveDisplay(v LiveDisplay) error

FromLiveDisplay overwrites any union data inside the ReplaceLiveDisplay200JSONResponseBody as the provided LiveDisplay

func (*ReplaceLiveDisplay200JSONResponseBody) FromPersonalLiveDisplay added in v0.3.0 

func (t *ReplaceLiveDisplay200JSONResponseBody) FromPersonalLiveDisplay(v PersonalLiveDisplay) error

FromPersonalLiveDisplay overwrites any union data inside the ReplaceLiveDisplay200JSONResponseBody as the provided PersonalLiveDisplay

func (ReplaceLiveDisplay200JSONResponseBody) MarshalJSON added in v0.3.0 

func (t ReplaceLiveDisplay200JSONResponseBody) MarshalJSON() ([]byte, error)

func (*ReplaceLiveDisplay200JSONResponseBody) MergeLiveDisplay added in v0.3.0 

func (t *ReplaceLiveDisplay200JSONResponseBody) MergeLiveDisplay(v LiveDisplay) error

MergeLiveDisplay performs a merge with any union data inside the ReplaceLiveDisplay200JSONResponseBody, using the provided LiveDisplay

func (*ReplaceLiveDisplay200JSONResponseBody) MergePersonalLiveDisplay added in v0.3.0 

func (t *ReplaceLiveDisplay200JSONResponseBody) MergePersonalLiveDisplay(v PersonalLiveDisplay) error

MergePersonalLiveDisplay performs a merge with any union data inside the ReplaceLiveDisplay200JSONResponseBody, using the provided PersonalLiveDisplay

func (*ReplaceLiveDisplay200JSONResponseBody) UnmarshalJSON added in v0.3.0 

func (t *ReplaceLiveDisplay200JSONResponseBody) UnmarshalJSON(b []byte) error

type ReplaceLiveDisplayJSONRequestBody added in v0.3.0 

type ReplaceLiveDisplayJSONRequestBody = ReplaceDisplay

ReplaceLiveDisplayJSONRequestBody defines body for ReplaceLiveDisplay for application/json ContentType.

type ReplaceLiveDisplayParams added in v0.3.0 

type ReplaceLiveDisplayParams struct {
	// IfMatch Use the ETag from the latest display/playback response. Missing: 428; stale: 412. Wildcards, weak validators and lists are not accepted.
	IfMatch string `json:"If-Match"`
}

ReplaceLiveDisplayParams defines parameters for ReplaceLiveDisplay.

type ReplaceLiveQueueOrder200JSONResponseBody added in v0.3.0 

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

ReplaceLiveQueueOrder200JSONResponseBody defines parameters for ReplaceLiveQueueOrder.

func (ReplaceLiveQueueOrder200JSONResponseBody) AsLiveQueuePage added in v0.3.0 

func (t ReplaceLiveQueueOrder200JSONResponseBody) AsLiveQueuePage() (LiveQueuePage, error)

AsLiveQueuePage returns the union data inside the ReplaceLiveQueueOrder200JSONResponseBody as a LiveQueuePage

func (ReplaceLiveQueueOrder200JSONResponseBody) AsPersonalLiveQueuePage added in v0.3.0 

func (t ReplaceLiveQueueOrder200JSONResponseBody) AsPersonalLiveQueuePage() (PersonalLiveQueuePage, error)

AsPersonalLiveQueuePage returns the union data inside the ReplaceLiveQueueOrder200JSONResponseBody as a PersonalLiveQueuePage

func (*ReplaceLiveQueueOrder200JSONResponseBody) FromLiveQueuePage added in v0.3.0 

func (t *ReplaceLiveQueueOrder200JSONResponseBody) FromLiveQueuePage(v LiveQueuePage) error

FromLiveQueuePage overwrites any union data inside the ReplaceLiveQueueOrder200JSONResponseBody as the provided LiveQueuePage

func (*ReplaceLiveQueueOrder200JSONResponseBody) FromPersonalLiveQueuePage added in v0.3.0 

func (t *ReplaceLiveQueueOrder200JSONResponseBody) FromPersonalLiveQueuePage(v PersonalLiveQueuePage) error

FromPersonalLiveQueuePage overwrites any union data inside the ReplaceLiveQueueOrder200JSONResponseBody as the provided PersonalLiveQueuePage

func (ReplaceLiveQueueOrder200JSONResponseBody) MarshalJSON added in v0.3.0 

func (t ReplaceLiveQueueOrder200JSONResponseBody) MarshalJSON() ([]byte, error)

func (*ReplaceLiveQueueOrder200JSONResponseBody) MergeLiveQueuePage added in v0.3.0 

func (t *ReplaceLiveQueueOrder200JSONResponseBody) MergeLiveQueuePage(v LiveQueuePage) error

MergeLiveQueuePage performs a merge with any union data inside the ReplaceLiveQueueOrder200JSONResponseBody, using the provided LiveQueuePage

func (*ReplaceLiveQueueOrder200JSONResponseBody) MergePersonalLiveQueuePage added in v0.3.0 

func (t *ReplaceLiveQueueOrder200JSONResponseBody) MergePersonalLiveQueuePage(v PersonalLiveQueuePage) error

MergePersonalLiveQueuePage performs a merge with any union data inside the ReplaceLiveQueueOrder200JSONResponseBody, using the provided PersonalLiveQueuePage

func (*ReplaceLiveQueueOrder200JSONResponseBody) UnmarshalJSON added in v0.3.0 

func (t *ReplaceLiveQueueOrder200JSONResponseBody) UnmarshalJSON(b []byte) error

type ReplaceLiveQueueOrderJSONRequestBody added in v0.3.0 

type ReplaceLiveQueueOrderJSONRequestBody = LiveQueueOrder

ReplaceLiveQueueOrderJSONRequestBody defines body for ReplaceLiveQueueOrder for application/json ContentType.

type ReplaceLiveQueueOrderParams added in v0.3.0 

type ReplaceLiveQueueOrderParams struct {
	// IfMatch Shared Live sequence validator. Any relevant metadata, display, playback or workspace change invalidates it. Missing:428; stale:412; malformed, weak, wildcard or list:422.
	IfMatch string `json:"If-Match"`
}

ReplaceLiveQueueOrderParams defines parameters for ReplaceLiveQueueOrder.

type ReplaceOrganizationLiveStudioJSONRequestBody added in v0.3.0 

type ReplaceOrganizationLiveStudioJSONRequestBody = PutOrganizationLiveStudio

ReplaceOrganizationLiveStudioJSONRequestBody defines body for ReplaceOrganizationLiveStudio for application/json ContentType.

type ReplaceOrganizationLiveStudioParams added in v0.3.0 

type ReplaceOrganizationLiveStudioParams struct {
	// IfMatch Strong validator covering the effective settings and revision. Separate from Live playback/display sequence validators. Use unchanged as If-Match on PUT.
	IfMatch string `json:"If-Match"`
}

ReplaceOrganizationLiveStudioParams defines parameters for ReplaceOrganizationLiveStudio.

type ReplacePresentationJSONRequestBody added in v0.3.0 

type ReplacePresentationJSONRequestBody = PutPresentation

ReplacePresentationJSONRequestBody defines body for ReplacePresentation for application/json ContentType.

type ReplacePresentationParams added in v0.3.0 

type ReplacePresentationParams struct {
	// IfMatch Strong validator covering presentation ID, organization, revision and rights-normalized document. Browser/editor saves and changed effective rights notices invalidate it. Missing:428; stale:412; malformed/weak/wildcard/list:422.
	IfMatch string `json:"If-Match"`
}

ReplacePresentationParams defines parameters for ReplacePresentation.

type RequestSizeError 

type RequestSizeError struct {
	Part  string
	Bytes int
	Limit int
}

RequestSizeError reports a request rejected locally before any network call.

func (*RequestSizeError) Error 

func (e *RequestSizeError) Error() string

type Response 

type Response struct{ *http.Response }

Response retains ETag, Location, Retry-After and request IDs in Header. The caller must close Body, including after Decode. Binary downloads are streamed directly from Body, and are never retried or buffered by the SDK.

func (*Response) Decode added in v0.3.0 

func (r *Response) Decode(target any) error

type RevokeOAuthTokenFormdataBody added in v0.3.0 

type RevokeOAuthTokenFormdataBody struct {
	ClientID      string  `form:"client_id" json:"client_id"`
	Token         string  `form:"token" json:"token"`
	TokenTypeHint *string `form:"token_type_hint,omitempty" json:"token_type_hint,omitempty"`
}

RevokeOAuthTokenFormdataBody defines parameters for RevokeOAuthToken.

type RevokeOAuthTokenFormdataRequestBody added in v0.3.0 

type RevokeOAuthTokenFormdataRequestBody RevokeOAuthTokenFormdataBody

RevokeOAuthTokenFormdataRequestBody defines body for RevokeOAuthToken for application/x-www-form-urlencoded ContentType.

type RotateLiveAudienceSecretJSONRequestBody added in v0.3.0 

type RotateLiveAudienceSecretJSONRequestBody = EmptyObject

RotateLiveAudienceSecretJSONRequestBody defines body for RotateLiveAudienceSecret for application/json ContentType.

type RotateLiveAudienceSecretParams added in v0.3.0 

type RotateLiveAudienceSecretParams struct {
	// IfMatch Current strong Live ETag. Missing:428; stale:412. No automatic retry.
	IfMatch string `json:"If-Match"`
}

RotateLiveAudienceSecretParams defines parameters for RotateLiveAudienceSecret.

type RotateServiceTokenJSONRequestBody added in v0.3.0 

type RotateServiceTokenJSONRequestBody = EmptyObject

RotateServiceTokenJSONRequestBody defines body for RotateServiceToken for application/json ContentType.

type RotateServiceTokenParams added in v0.3.0 

type RotateServiceTokenParams struct {
	// IfMatch Use the latest service-token configuration ETag unchanged. Missing: 428; stale: 412. Wildcards, lists and weak validators are rejected.
	IfMatch string `json:"If-Match"`
}

RotateServiceTokenParams defines parameters for RotateServiceToken.

type SSHClient added in v0.3.0 

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

SSHClient executes commands through a caller-owned SSH connection.

func NewSSHClient added in v0.1.0 

func NewSSHClient(execute func(context.Context, Command) (CommandResponse, error)) (*SSHClient, error)

NewSSHClient binds command helpers to an explicit caller-owned SSH executor. Use NewClient for resource operations over HTTP.

func (*SSHClient) ControlLive added in v0.3.0 

func (c *SSHClient) ControlLive(ctx context.Context, id string, action LiveAction) (LiveActionResult, error)

func (*SSHClient) CreateLive added in v0.3.0 

func (c *SSHClient) CreateLive(ctx context.Context, name string) (LiveResult, error)

func (*SSHClient) Execute added in v0.3.0 

func (c *SSHClient) Execute(ctx context.Context, command Command) (CommandResponse, error)

func (*SSHClient) GetAccountInfo added in v0.3.0 

func (c *SSHClient) GetAccountInfo(ctx context.Context) (AccountInfo, error)

func (*SSHClient) GetIdentity added in v0.3.0 

func (c *SSHClient) GetIdentity(ctx context.Context) (IdentityInfo, error)

func (*SSHClient) GetLive added in v0.3.0 

func (c *SSHClient) GetLive(ctx context.Context, id string) (LiveResult, error)

func (*SSHClient) GetLiveStack added in v0.3.0 

func (c *SSHClient) GetLiveStack(ctx context.Context, id string) (SSHLiveStack, error)

func (*SSHClient) GetLiveStats added in v0.3.0 

func (c *SSHClient) GetLiveStats(ctx context.Context, id string) (SSHLiveStatistics, error)

func (*SSHClient) GetOrganizationApplicationStatus added in v0.3.0 

func (c *SSHClient) GetOrganizationApplicationStatus(ctx context.Context, id string) (OrganizationApplicationResult, error)

func (*SSHClient) GetServerInfo added in v0.3.0 

func (c *SSHClient) GetServerInfo(ctx context.Context) (ServerInfo, error)

func (*SSHClient) GetTranslationCatalog added in v0.3.0 

func (c *SSHClient) GetTranslationCatalog(ctx context.Context, slug string) (TranslationCatalog, error)

func (*SSHClient) GetTranslationInfo added in v0.3.0 

func (c *SSHClient) GetTranslationInfo(ctx context.Context, slug string) (TranslationInfo, error)

func (*SSHClient) Help added in v0.3.0 

func (c *SSHClient) Help(ctx context.Context, topic string) (HelpResult, error)

func (*SSHClient) Identity added in v0.3.0 

func (c *SSHClient) Identity(ctx context.Context) (CommandResponse, error)

func (*SSHClient) ListLives added in v0.3.0 

func (c *SSHClient) ListLives(ctx context.Context) (SSHLiveList, error)

func (*SSHClient) ListOrganizations added in v0.3.0 

func (c *SSHClient) ListOrganizations(ctx context.Context, cursor string) (OrganizationDirectory, error)

func (*SSHClient) ListQuotas added in v0.3.0 

func (c *SSHClient) ListQuotas(ctx context.Context) (QuotaResult, error)

func (*SSHClient) ListTokens added in v0.3.0 

func (c *SSHClient) ListTokens(ctx context.Context) (TokenList, error)

ListTokens lists active personal token metadata. The server filters expired, revoked and expired rotation-grace credentials; it does not return a history.

func (*SSHClient) ListTranslations added in v0.3.0 

func (c *SSHClient) ListTranslations(ctx context.Context) (CommandResponse, error)

func (*SSHClient) Ping added in v0.3.0 

func (c *SSHClient) Ping(ctx context.Context) (CommandResponse, error)

func (*SSHClient) PopLive added in v0.3.0 

func (c *SSHClient) PopLive(ctx context.Context, id string, count int) (LiveVerseResult, error)

func (*SSHClient) PushLive added in v0.3.0 

func (c *SSHClient) PushLive(ctx context.Context, id string, ref Reference) (LiveVerseResult, error)

func (*SSHClient) Read added in v0.3.0 

func (c *SSHClient) Read(ctx context.Context, ref Reference) (CommandResponse, error)

func (*SSHClient) ReadVerses added in v0.3.0 

func (c *SSHClient) ReadVerses(ctx context.Context, ref Reference) (Reading, error)

func (*SSHClient) Search added in v0.3.0 

func (c *SSHClient) Search(ctx context.Context, translation, query string) (CommandResponse, error)

func (*SSHClient) SearchVerses added in v0.3.0 

func (c *SSHClient) SearchVerses(ctx context.Context, translation, query string) (Reading, error)

func (*SSHClient) SetLive added in v0.3.0 

func (c *SSHClient) SetLive(ctx context.Context, id string, field LiveField, values ...string) (LiveResult, error)

type SSHLiveList added in v0.3.0 

type SSHLiveList struct {
	Lives []LiveState
	Raw   CommandResponse
}

type SSHLiveStack added in v0.3.0 

type SSHLiveStack struct {
	ID      string
	Entries []StackEntry
	Raw     CommandResponse
}

type SSHLiveStatistics added in v0.3.0 

type SSHLiveStatistics struct {
	ID                                                                                string
	RunningForSeconds, Revision, StackEntries, ActorConnections, AnonymousConnections int64
	Connections                                                                       []LiveConnection
	Raw                                                                               CommandResponse
}

type Scope added in v0.3.0 

type Scope string

Scope defines model for Scope. 

const (
	ScopeAssetCreate         Scope = "asset.create"
	ScopeAssetGet            Scope = "asset.get"
	ScopeHelpGet             Scope = "help.get"
	ScopeLiveCreate          Scope = "live.create"
	ScopeLiveDelete          Scope = "live.delete"
	ScopeLiveGet             Scope = "live.get"
	ScopeLiveList            Scope = "live.list"
	ScopeLiveMove            Scope = "live.move"
	ScopeLiveStudioGet       Scope = "live_studio.get"
	ScopeLiveStudioUpdate    Scope = "live_studio.update"
	ScopeLiveSubscribe       Scope = "live.subscribe"
	ScopeLiveUpdate          Scope = "live.update"
	ScopeMembershipDelete    Scope = "membership.delete"
	ScopeMembershipGet       Scope = "membership.get"
	ScopeMembershipUpdate    Scope = "membership.update"
	ScopeOrganizationGet     Scope = "organization.get"
	ScopePresentationCreate  Scope = "presentation.create"
	ScopePresentationDelete  Scope = "presentation.delete"
	ScopePresentationExport  Scope = "presentation.export"
	ScopePresentationGet     Scope = "presentation.get"
	ScopePresentationImport  Scope = "presentation.import"
	ScopePresentationList    Scope = "presentation.list"
	ScopePresentationPresent Scope = "presentation.present"
	ScopePresentationUpdate  Scope = "presentation.update"
	ScopeServerGet           Scope = "server.get"
	ScopeTokenCreate         Scope = "token.create"
	ScopeTokenDelete         Scope = "token.delete"
	ScopeTokenGet            Scope = "token.get"
	ScopeTranslationEnable   Scope = "translation.enable"
	ScopeTranslationGet      Scope = "translation.get"
	ScopeTranslationList     Scope = "translation.list"
	ScopeTranslationRead     Scope = "translation.read"
	ScopeTranslationSearch   Scope = "translation.search"
)

Defines values for Scope.

func (Scope) Valid added in v0.3.0 

func (e Scope) Valid() bool

Valid indicates whether the value is a known member of the Scope enum.

type ScriptureBookRead added in v0.3.0 

type ScriptureBookRead struct {
	// NextCursor Required opaque continuation cursor. Null only on the last page; otherwise pass unchanged as after. Carries no authority.
	NextCursor  *string           `json:"next_cursor"`
	Rights      TranslationRights `json:"rights"`
	Translation string            `json:"translation"`
	Verses      []Verse           `json:"verses"`
}

ScriptureBookRead One bounded book page, always paginated: default 50, maximum 500 verses, and at most 3MiB serialized JSON including metadata. The byte budget can return fewer verses with nonnull next_cursor. Stable chapter/verse order; no totals or unbounded mode.

type ScriptureRead added in v0.3.0 

type ScriptureRead struct {
	Rights      TranslationRights `json:"rights"`
	Translation string            `json:"translation"`
	Verses      []Verse           `json:"verses"`
}

ScriptureRead defines model for ScriptureRead.

type ScriptureReference added in v0.3.0 

type ScriptureReference struct {
	BookID      int64  `json:"book_id"`
	Chapter     int64  `json:"chapter"`
	Translation string `json:"translation"`
	VerseEnd    *int64 `json:"verse_end,omitempty"`
	VerseStart  int64  `json:"verse_start"`
}

ScriptureReference defines model for ScriptureReference.

type ScriptureSearch added in v0.3.0 

type ScriptureSearch struct {
	HasMore     bool              `json:"has_more"`
	Rights      TranslationRights `json:"rights"`
	Translation string            `json:"translation"`
	Verses      []Verse           `json:"verses"`
}

ScriptureSearch defines model for ScriptureSearch.

type SearchPersonalScriptureParams added in v0.3.0 

type SearchPersonalScriptureParams struct {
	Q     string `form:"q" json:"q"`
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`
}

SearchPersonalScriptureParams defines parameters for SearchPersonalScripture.

func (SearchPersonalScriptureParams) QueryValues added in v0.3.1 

func (p SearchPersonalScriptureParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (SearchPersonalScriptureParams) WithLimit added in v0.3.1 

func (p SearchPersonalScriptureParams) WithLimit(value int64) SearchPersonalScriptureParams

WithLimit returns a copy with the limit query parameter set.

func (SearchPersonalScriptureParams) WithQ added in v0.3.1 

func (p SearchPersonalScriptureParams) WithQ(value string) SearchPersonalScriptureParams

WithQ returns a copy with the q query parameter set.

type SearchScriptureParams added in v0.3.0 

type SearchScriptureParams struct {
	Q     string `form:"q" json:"q"`
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`
}

SearchScriptureParams defines parameters for SearchScripture.

func (SearchScriptureParams) QueryValues added in v0.3.1 

func (p SearchScriptureParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (SearchScriptureParams) WithLimit added in v0.3.1 

func (p SearchScriptureParams) WithLimit(value int64) SearchScriptureParams

WithLimit returns a copy with the limit query parameter set.

func (SearchScriptureParams) WithQ added in v0.3.1 

func (p SearchScriptureParams) WithQ(value string) SearchScriptureParams

WithQ returns a copy with the q query parameter set.

type SecretAction 

type SecretAction string
const (
	SecretAuthenticate SecretAction = ""
	SecretCreate       SecretAction = "CREATE"
	SecretRotate       SecretAction = "ROTATE"
	SecretDelete       SecretAction = "DELETE"
)

type ServerError 

type ServerError struct {
	Code   string
	Fields map[string]string
}

ServerError preserves the server code and metadata, including unknown codes.

func (*ServerError) Error 

func (e *ServerError) Error() string

func (*ServerError) RetryAfter 

func (e *ServerError) RetryAfter() time.Duration

type ServerInfo 

type ServerInfo struct {
	ProtocolVersion int64
	Version         string
	Capabilities    []string
	Raw             CommandResponse
}

Typed results retain Raw for unknown fields and original wire records.

type ServiceToken added in v0.3.0 

type ServiceToken struct {
	// ExpiresAt Unix timestamp in seconds; null means no deadline or no recorded use.
	ExpiresAt *int64 `json:"expires_at"`
	ID        string `json:"id"`
	IssuedAt  int64  `json:"issued_at"`
	Label     string `json:"label"`

	// LastUsedAt Unix timestamp in seconds; null means no deadline or no recorded use.
	LastUsedAt     *int64  `json:"last_used_at"`
	OrganizationID string  `json:"organization_id"`
	Scopes         []Scope `json:"scopes"`
}

ServiceToken defines model for ServiceToken.

type ServiceTokenConfiguration added in v0.3.0 

type ServiceTokenConfiguration struct {
	// ExpiresAt Unix timestamp in seconds; null means no deadline or no recorded use.
	ExpiresAt      *int64  `json:"expires_at"`
	ID             string  `json:"id"`
	IssuedAt       int64   `json:"issued_at"`
	Label          string  `json:"label"`
	OrganizationID string  `json:"organization_id"`
	Scopes         []Scope `json:"scopes"`
}

ServiceTokenConfiguration defines model for ServiceTokenConfiguration.

type ServiceTokenList added in v0.3.0 

type ServiceTokenList struct {
	Data []ServiceToken `json:"data"`

	// NextCursor Pass this value unchanged as after; null ends the collection.
	NextCursor *string `json:"next_cursor"`
}

ServiceTokenList defines model for ServiceTokenList.

type SnapshotSummary added in v0.3.0 

type SnapshotSummary struct {
	Blank    bool   `json:"blank"`
	Deck     string `json:"deck"`
	ID       string `json:"id"`
	Index    int64  `json:"index"`
	Revision int64  `json:"revision"`

	// SlideID Stable selected slide ID from the immutable saved snapshot. Prefer this over the retained zero-based index.
	SlideID string `json:"slide_id"`
}

SnapshotSummary defines model for SnapshotSummary.

type StackAction 

type StackAction string
const (
	StackInfo  StackAction = "INFO"
	StackClear StackAction = "CLEAR"
)

type StackEntry 

type StackEntry struct {
	Position int64
	LiveVerse
}

type StageLiveQueueItemJSONRequestBody added in v0.4.0 

type StageLiveQueueItemJSONRequestBody = CreateLiveQueueItem

StageLiveQueueItemJSONRequestBody defines body for StageLiveQueueItem for application/json ContentType.

type StageLiveQueueItemParams added in v0.4.0 

type StageLiveQueueItemParams struct {
	// IfMatch Shared Live sequence validator. Any relevant metadata, display, playback or workspace change invalidates it. Missing:428; stale:412; malformed, weak, wildcard or list:422.
	IfMatch string `json:"If-Match"`
}

StageLiveQueueItemParams defines parameters for StageLiveQueueItem.

type TokenList 

type TokenList struct {
	Actor  string
	Tokens []TokenMetadata
	Raw    CommandResponse
}

type TokenMetadata 

type TokenMetadata struct {
	ID, Source      string
	IssuedAt        int64
	IssuedBy, Label *string
	// Empty scopes inherit the actor's permissions. Nil means the field was absent;
	// it must not be interpreted as unrestricted authority.
	Scopes                []string
	LastUsedAt, ExpiresAt *int64
	Retiring              *bool
	Fields                map[string]string
}

TokenMetadata describes a currently active personal credential, never its value. Timestamp fields are Unix seconds. Optional fields remain nil when absent.

type TranslationBookMetadata added in v0.3.0 

type TranslationBookMetadata struct {
	Book     int64                        `json:"book"`
	Chapters []TranslationChapterMetadata `json:"chapters"`
	Name     string                       `json:"name"`
}

TranslationBookMetadata defines model for TranslationBookMetadata.

type TranslationCatalog 

type TranslationCatalog struct {
	Translation string
	Books       []CatalogBook
	Raw         CommandResponse
}

type TranslationCatalogueDetails added in v0.3.0 

type TranslationCatalogueDetails struct {
	Data        []TranslationBookMetadata `json:"data"`
	Translation string                    `json:"translation"`
}

TranslationCatalogueDetails defines model for TranslationCatalogueDetails.

type TranslationChapterMetadata added in v0.3.0 

type TranslationChapterMetadata struct {
	Chapter int64 `json:"chapter"`
	Verses  int64 `json:"verses"`
}

TranslationChapterMetadata defines model for TranslationChapterMetadata.

type TranslationCollection added in v0.3.0 

type TranslationCollection struct {
	Data []CatalogueTranslation `json:"data"`

	// NextCursor Pass unchanged as after on the next request; null ends the collection.
	NextCursor *string `json:"next_cursor"`
}

TranslationCollection defines model for TranslationCollection.

type TranslationInfo 

type TranslationInfo struct {
	ShortName, FullName                             string
	Edition, Updated                                string
	RightsStatus, RightsLabel, RightsURL, SourceURL string
	Attribution, TrademarkNotice                    string
	Raw                                             CommandResponse
}

type TranslationProvenance added in v0.3.0 

type TranslationProvenance struct {
	ArchiveSha256 *string `json:"archive_sha256"`
	ReviewedOn    *string `json:"reviewed_on"`
	SourceID      *string `json:"source_id"`
}

TranslationProvenance defines model for TranslationProvenance.

type TranslationRights added in v0.3.0 

type TranslationRights struct {
	Attribution  string  `json:"attribution"`
	ChangeNotice *string `json:"change_notice,omitempty"`
	Copyright    *string `json:"copyright,omitempty"`
	Edition      string  `json:"edition"`
	LicenseID    *string `json:"license_id,omitempty"`
	LicenseURL   *string `json:"license_url,omitempty"`
	RightsStatus string  `json:"rights_status"`
	SourceURL    string  `json:"source_url"`
}

TranslationRights defines model for TranslationRights.

type UpdateLiveMetadata200JSONResponseBody added in v0.3.0 

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

UpdateLiveMetadata200JSONResponseBody defines parameters for UpdateLiveMetadata.

func (UpdateLiveMetadata200JSONResponseBody) AsLive added in v0.3.0 

func (t UpdateLiveMetadata200JSONResponseBody) AsLive() (Live, error)

AsLive returns the union data inside the UpdateLiveMetadata200JSONResponseBody as a Live

func (UpdateLiveMetadata200JSONResponseBody) AsPersonalLive added in v0.3.0 

func (t UpdateLiveMetadata200JSONResponseBody) AsPersonalLive() (PersonalLive, error)

AsPersonalLive returns the union data inside the UpdateLiveMetadata200JSONResponseBody as a PersonalLive

func (*UpdateLiveMetadata200JSONResponseBody) FromLive added in v0.3.0 

func (t *UpdateLiveMetadata200JSONResponseBody) FromLive(v Live) error

FromLive overwrites any union data inside the UpdateLiveMetadata200JSONResponseBody as the provided Live

func (*UpdateLiveMetadata200JSONResponseBody) FromPersonalLive added in v0.3.0 

func (t *UpdateLiveMetadata200JSONResponseBody) FromPersonalLive(v PersonalLive) error

FromPersonalLive overwrites any union data inside the UpdateLiveMetadata200JSONResponseBody as the provided PersonalLive

func (UpdateLiveMetadata200JSONResponseBody) MarshalJSON added in v0.3.0 

func (t UpdateLiveMetadata200JSONResponseBody) MarshalJSON() ([]byte, error)

func (*UpdateLiveMetadata200JSONResponseBody) MergeLive added in v0.3.0 

func (t *UpdateLiveMetadata200JSONResponseBody) MergeLive(v Live) error

MergeLive performs a merge with any union data inside the UpdateLiveMetadata200JSONResponseBody, using the provided Live

func (*UpdateLiveMetadata200JSONResponseBody) MergePersonalLive added in v0.3.0 

func (t *UpdateLiveMetadata200JSONResponseBody) MergePersonalLive(v PersonalLive) error

MergePersonalLive performs a merge with any union data inside the UpdateLiveMetadata200JSONResponseBody, using the provided PersonalLive

func (*UpdateLiveMetadata200JSONResponseBody) UnmarshalJSON added in v0.3.0 

func (t *UpdateLiveMetadata200JSONResponseBody) UnmarshalJSON(b []byte) error

type UpdateLiveMetadataJSONRequestBody added in v0.3.0 

type UpdateLiveMetadataJSONRequestBody = LiveMetadataPatch

UpdateLiveMetadataJSONRequestBody defines body for UpdateLiveMetadata for application/json ContentType.

type UpdateLiveMetadataParams added in v0.3.0 

type UpdateLiveMetadataParams struct {
	// IfMatch Shared Live sequence validator. Any relevant metadata, display, playback or workspace change invalidates it. Missing:428; stale:412; malformed, weak, wildcard or list:422.
	IfMatch string `json:"If-Match"`
}

UpdateLiveMetadataParams defines parameters for UpdateLiveMetadata.

type UpdateLivePlaybackJSONRequestBody added in v0.3.0 

type UpdateLivePlaybackJSONRequestBody = PlaybackPatch

UpdateLivePlaybackJSONRequestBody defines body for UpdateLivePlayback for application/json ContentType.

type UpdateLivePlaybackParams added in v0.3.0 

type UpdateLivePlaybackParams struct {
	// IfMatch Use the ETag from the latest display/playback response. Missing: 428; stale: 412. Wildcards, weak validators and lists are not accepted.
	IfMatch string `json:"If-Match"`
}

UpdateLivePlaybackParams defines parameters for UpdateLivePlayback.

type UpdateLiveSettingsJSONRequestBody added in v0.3.0 

type UpdateLiveSettingsJSONRequestBody = LiveSettingsPatch

UpdateLiveSettingsJSONRequestBody defines body for UpdateLiveSettings for application/json ContentType.

type UpdateLiveSettingsParams added in v0.3.0 

type UpdateLiveSettingsParams struct {
	// IfMatch Current strong Live ETag. Missing:428; stale:412. No automatic retry.
	IfMatch string `json:"If-Match"`
}

UpdateLiveSettingsParams defines parameters for UpdateLiveSettings.

type UpdateOrganizationMemberJSONRequestBody added in v0.3.0 

type UpdateOrganizationMemberJSONRequestBody = MembershipPatch

UpdateOrganizationMemberJSONRequestBody defines body for UpdateOrganizationMember for application/json ContentType.

type UpdateOrganizationMemberParams added in v0.3.0 

type UpdateOrganizationMemberParams struct {
	// IfMatch Strong validator for this membership representation and row revision. Membership writes require the latest value unchanged. Missing:428; stale:412; malformed, weak, wildcard or list:422.
	IfMatch string `json:"If-Match"`
}

UpdateOrganizationMemberParams defines parameters for UpdateOrganizationMember.

type UpdateServiceTokenJSONRequestBody added in v0.3.0 

type UpdateServiceTokenJSONRequestBody = PatchServiceToken

UpdateServiceTokenJSONRequestBody defines body for UpdateServiceToken for application/json ContentType.

type UpdateServiceTokenParams added in v0.3.0 

type UpdateServiceTokenParams struct {
	// IfMatch Use the latest service-token configuration ETag unchanged. Missing: 428; stale: 412. Wildcards, lists and weak validators are rejected.
	IfMatch string `json:"If-Match"`
}

UpdateServiceTokenParams defines parameters for UpdateServiceToken.

type UploadPresentationAssetParams added in v0.3.0 

type UploadPresentationAssetParams struct {
	// Kind Image: up to 10 MiB. Video: up to 64 MiB.
	Kind UploadPresentationAssetParamsKind `form:"kind" json:"kind"`

	// ContentLength Required exact raw body byte count. Missing returns 411, excessive returns 413. Chunked-only requests are unsupported.
	ContentLength int64 `json:"Content-Length"`

	// IdempotencyKey Optional case-sensitive retry key, retained 24 hours from successful commit. Scoped to credential principal (stable service-token ID; personal bt_ credential; delegated OAuth grant), account and concrete method/path. Payload, If-Match, query string and Content-Type must match. JSON object key order is ignored; queue reference casing/defaults are normalized; raw upload/import bytes are hashed. Replays retain original success body, Location and ETag with a fresh X-Request-Id, after current authority/ownership/processing/library checks. Same scope/key with changed input:409 idempotency_conflict. Concurrent requests serialize; a contended retry lock can return 409 idempotency_in_progress; bounded database waits can return 503. Errors are not recorded. After expiry, a key is treated as new; original resource/job lifetime is unchanged. No key means no retry guarantee.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

UploadPresentationAssetParams defines parameters for UploadPresentationAsset.

func (UploadPresentationAssetParams) QueryValues added in v0.3.1 

func (p UploadPresentationAssetParams) QueryValues() url.Values

QueryValues encodes the operation's typed query parameters. Each call returns fresh values.

func (UploadPresentationAssetParams) WithKind added in v0.3.1 

func (p UploadPresentationAssetParams) WithKind(value UploadPresentationAssetParamsKind) UploadPresentationAssetParams

WithKind returns a copy with the kind query parameter set.

type UploadPresentationAssetParamsKind added in v0.3.0 

type UploadPresentationAssetParamsKind string

UploadPresentationAssetParamsKind defines parameters for UploadPresentationAsset. 

const (
	UploadPresentationAssetParamsKindImage UploadPresentationAssetParamsKind = "image"
	UploadPresentationAssetParamsKindVideo UploadPresentationAssetParamsKind = "video"
)

Defines values for UploadPresentationAssetParamsKind.

func (UploadPresentationAssetParamsKind) Valid added in v0.3.0 

func (e UploadPresentationAssetParamsKind) Valid() bool

Valid indicates whether the value is a known member of the UploadPresentationAssetParamsKind enum.

type Verse added in v0.3.0 

type Verse struct {
	Book    string `json:"book"`
	BookID  int64  `json:"book_id"`
	Chapter int64  `json:"chapter"`
	Text    string `json:"text"`
	Verse   int64  `json:"verse"`
}

Verse defines model for Verse.

type VerseText 

type VerseText struct {
	// Text retains the historical wire text, including any reference prefix.
	Text string
	// Structured source metadata is optional on older SSH servers.
	Content                          *string
	Translation, BookName, Reference string
	BookID, Chapter, Verse           *int64
	Fields                           map[string]string
}

Source Files

View all Source files

Directories

Path Synopsis
examples
read command
Read a verse using a finite personal token supplied by the application.
 Read a verse using a finite personal token supplied by the application.

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.