shared

package
v3.9.0 Latest Latest
Warning

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

 Go to latest Published: Jul 11, 2024 License: Apache-2.0 Imports: 4 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type API 

type API struct {
	// The ID of this Api. This is a human-readable name (subject to change).
	APIID string `json:"api_id"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at"`
	// A detailed description of the Api.
	Description string `json:"description"`
	// Determines if all the endpoints within the Api are found in the OpenAPI spec associated with the Api.
	Matched *bool `json:"matched,omitempty"`
	// A set of values associated with a meta_data key. This field is only set on get requests.
	MetaData map[string][]string `json:"meta_data,omitempty"`
	// Last update timestamp.
	UpdatedAt time.Time `json:"updated_at"`
	// The version ID of this Api. This is semantic version identifier.
	VersionID string `json:"version_id"`
	// The workspace ID this Api belongs to.
	WorkspaceID string `json:"workspace_id"`
}

API - An Api is representation of a API (a collection of API Endpoints) within the Speakeasy Platform.

func (*API) GetAPIID 

func (o *API) GetAPIID() string

func (*API) GetCreatedAt 

func (o *API) GetCreatedAt() time.Time

func (*API) GetDescription 

func (o *API) GetDescription() string

func (*API) GetMatched 

func (o *API) GetMatched() *bool

func (*API) GetMetaData 

func (o *API) GetMetaData() map[string][]string

func (*API) GetUpdatedAt 

func (o *API) GetUpdatedAt() time.Time

func (*API) GetVersionID 

func (o *API) GetVersionID() string

func (*API) GetWorkspaceID 

func (o *API) GetWorkspaceID() string

func (API) MarshalJSON 

func (a API) MarshalJSON() ([]byte, error)

func (*API) UnmarshalJSON 

func (a *API) UnmarshalJSON(data []byte) error

type APIEndpoint 

type APIEndpoint struct {
	// The ID of this ApiEndpoint. This is a hash of the method and path.
	APIEndpointID string `json:"api_endpoint_id"`
	// The ID of the Api this ApiEndpoint belongs to.
	APIID string `json:"api_id"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at"`
	// A detailed description of the ApiEndpoint.
	Description string `json:"description"`
	// A human-readable name for the ApiEndpoint.
	DisplayName string `json:"display_name"`
	// Determines if the endpoint was found in the OpenAPI spec associated with the parent Api.
	Matched *bool `json:"matched,omitempty"`
	// HTTP verb.
	Method string `json:"method"`
	// Path that handles this Api.
	Path string `json:"path"`
	// Last update timestamp.
	UpdatedAt time.Time `json:"updated_at"`
	// The version ID of the Api this ApiEndpoint belongs to.
	VersionID string `json:"version_id"`
	// The workspace ID this ApiEndpoint belongs to.
	WorkspaceID string `json:"workspace_id"`
}

APIEndpoint - An ApiEndpoint is a description of an Endpoint for an API.

func (*APIEndpoint) GetAPIEndpointID 

func (o *APIEndpoint) GetAPIEndpointID() string

func (*APIEndpoint) GetAPIID 

func (o *APIEndpoint) GetAPIID() string

func (*APIEndpoint) GetCreatedAt 

func (o *APIEndpoint) GetCreatedAt() time.Time

func (*APIEndpoint) GetDescription 

func (o *APIEndpoint) GetDescription() string

func (*APIEndpoint) GetDisplayName 

func (o *APIEndpoint) GetDisplayName() string

func (*APIEndpoint) GetMatched 

func (o *APIEndpoint) GetMatched() *bool

func (*APIEndpoint) GetMethod 

func (o *APIEndpoint) GetMethod() string

func (*APIEndpoint) GetPath 

func (o *APIEndpoint) GetPath() string

func (*APIEndpoint) GetUpdatedAt 

func (o *APIEndpoint) GetUpdatedAt() time.Time

func (*APIEndpoint) GetVersionID 

func (o *APIEndpoint) GetVersionID() string

func (*APIEndpoint) GetWorkspaceID 

func (o *APIEndpoint) GetWorkspaceID() string

func (APIEndpoint) MarshalJSON 

func (a APIEndpoint) MarshalJSON() ([]byte, error)

func (*APIEndpoint) UnmarshalJSON 

func (a *APIEndpoint) UnmarshalJSON(data []byte) error

type APIEndpointInput 

type APIEndpointInput struct {
	// The ID of this ApiEndpoint. This is a hash of the method and path.
	APIEndpointID string `json:"api_endpoint_id"`
	// A detailed description of the ApiEndpoint.
	Description string `json:"description"`
	// A human-readable name for the ApiEndpoint.
	DisplayName string `json:"display_name"`
	// HTTP verb.
	Method string `json:"method"`
	// Path that handles this Api.
	Path string `json:"path"`
	// The version ID of the Api this ApiEndpoint belongs to.
	VersionID string `json:"version_id"`
}

APIEndpointInput - An ApiEndpoint is a description of an Endpoint for an API.

func (*APIEndpointInput) GetAPIEndpointID 

func (o *APIEndpointInput) GetAPIEndpointID() string

func (*APIEndpointInput) GetDescription 

func (o *APIEndpointInput) GetDescription() string

func (*APIEndpointInput) GetDisplayName 

func (o *APIEndpointInput) GetDisplayName() string

func (*APIEndpointInput) GetMethod 

func (o *APIEndpointInput) GetMethod() string

func (*APIEndpointInput) GetPath 

func (o *APIEndpointInput) GetPath() string

func (*APIEndpointInput) GetVersionID 

func (o *APIEndpointInput) GetVersionID() string

type APIInput 

type APIInput struct {
	// The ID of this Api. This is a human-readable name (subject to change).
	APIID string `json:"api_id"`
	// A detailed description of the Api.
	Description string `json:"description"`
	// A set of values associated with a meta_data key. This field is only set on get requests.
	MetaData map[string][]string `json:"meta_data,omitempty"`
	// The version ID of this Api. This is semantic version identifier.
	VersionID string `json:"version_id"`
}

APIInput - An Api is representation of a API (a collection of API Endpoints) within the Speakeasy Platform.

func (*APIInput) GetAPIID 

func (o *APIInput) GetAPIID() string

func (*APIInput) GetDescription 

func (o *APIInput) GetDescription() string

func (*APIInput) GetMetaData 

func (o *APIInput) GetMetaData() map[string][]string

func (*APIInput) GetVersionID 

func (o *APIInput) GetVersionID() string

type APIKeyDetails added in v3.1.0 

type APIKeyDetails struct {
	AccountType     AccountType `json:"account_type"`
	EnabledFeatures []string    `json:"enabled_features"`
	// Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
	FeatureFlags              []string `json:"feature_flags,omitempty"`
	GenerationAccessUnlimited *bool    `json:"generation_access_unlimited,omitempty"`
	OrgSlug                   string   `json:"org_slug"`
	TelemetryDisabled         bool     `json:"telemetry_disabled"`
	WorkspaceID               string   `json:"workspace_id"`
	WorkspaceSlug             string   `json:"workspace_slug"`
}

func (*APIKeyDetails) GetAccountType added in v3.3.1 

func (o *APIKeyDetails) GetAccountType() AccountType

func (*APIKeyDetails) GetEnabledFeatures added in v3.7.3 

func (o *APIKeyDetails) GetEnabledFeatures() []string

func (*APIKeyDetails) GetFeatureFlags added in v3.5.5 

func (o *APIKeyDetails) GetFeatureFlags() []string

func (*APIKeyDetails) GetGenerationAccessUnlimited added in v3.2.2 

func (o *APIKeyDetails) GetGenerationAccessUnlimited() *bool

func (*APIKeyDetails) GetOrgSlug added in v3.5.9 

func (o *APIKeyDetails) GetOrgSlug() string

func (*APIKeyDetails) GetTelemetryDisabled added in v3.8.4 

func (o *APIKeyDetails) GetTelemetryDisabled() bool

func (*APIKeyDetails) GetWorkspaceID added in v3.1.0 

func (o *APIKeyDetails) GetWorkspaceID() string

func (*APIKeyDetails) GetWorkspaceSlug added in v3.5.9 

func (o *APIKeyDetails) GetWorkspaceSlug() string

type AccessDetails added in v3.2.2 

type AccessDetails struct {
	GenerationAllowed bool   `json:"generation_allowed"`
	Level             *Level `json:"level,omitempty"`
	Message           string `json:"message"`
}

func (*AccessDetails) GetGenerationAllowed added in v3.2.2 

func (o *AccessDetails) GetGenerationAllowed() bool

func (*AccessDetails) GetLevel added in v3.4.2 

func (o *AccessDetails) GetLevel() *Level

func (*AccessDetails) GetMessage added in v3.3.10 

func (o *AccessDetails) GetMessage() string

type AccessToken added in v3.3.11 

type AccessToken struct {
	AccessToken  string          `json:"access_token"`
	Claims       Claims          `json:"claims"`
	FeatureFlags []FeatureFlag   `json:"feature_flags,omitempty"`
	User         AccessTokenUser `json:"user"`
	Workspaces   []Workspaces    `json:"workspaces,omitempty"`
}

An AccessToken is a token that can be used to authenticate with the Speakeasy API.

func (*AccessToken) GetAccessToken added in v3.3.11 

func (o *AccessToken) GetAccessToken() string

func (*AccessToken) GetClaims added in v3.3.11 

func (o *AccessToken) GetClaims() Claims

func (*AccessToken) GetFeatureFlags added in v3.7.2 

func (o *AccessToken) GetFeatureFlags() []FeatureFlag

func (*AccessToken) GetUser added in v3.3.11 

func (o *AccessToken) GetUser() AccessTokenUser

func (*AccessToken) GetWorkspaces added in v3.3.11 

func (o *AccessToken) GetWorkspaces() []Workspaces

type AccessTokenAccountType added in v3.5.5 

type AccessTokenAccountType string
const (
	AccessTokenAccountTypeFree       AccessTokenAccountType = "free"
	AccessTokenAccountTypeScaleUp    AccessTokenAccountType = "scale-up"
	AccessTokenAccountTypeEnterprise AccessTokenAccountType = "enterprise"
)

func (AccessTokenAccountType) ToPointer added in v3.5.5 

func (e AccessTokenAccountType) ToPointer() *AccessTokenAccountType

func (*AccessTokenAccountType) UnmarshalJSON added in v3.5.5 

func (e *AccessTokenAccountType) UnmarshalJSON(data []byte) error

type AccessTokenUser added in v3.4.6 

type AccessTokenUser struct {
	Admin         *bool      `json:"admin,omitempty"`
	CreatedAt     *time.Time `json:"created_at,omitempty"`
	DisplayName   *string    `json:"display_name,omitempty"`
	Email         *string    `json:"email,omitempty"`
	EmailVerified *bool      `json:"email_verified,omitempty"`
	ID            *string    `json:"id,omitempty"`
}

func (*AccessTokenUser) GetAdmin added in v3.4.6 

func (o *AccessTokenUser) GetAdmin() *bool

func (*AccessTokenUser) GetCreatedAt added in v3.4.6 

func (o *AccessTokenUser) GetCreatedAt() *time.Time

func (*AccessTokenUser) GetDisplayName added in v3.4.6 

func (o *AccessTokenUser) GetDisplayName() *string

func (*AccessTokenUser) GetEmail added in v3.4.6 

func (o *AccessTokenUser) GetEmail() *string

func (*AccessTokenUser) GetEmailVerified added in v3.4.6 

func (o *AccessTokenUser) GetEmailVerified() *bool

func (*AccessTokenUser) GetID added in v3.4.6 

func (o *AccessTokenUser) GetID() *string

func (AccessTokenUser) MarshalJSON added in v3.4.6 

func (a AccessTokenUser) MarshalJSON() ([]byte, error)

func (*AccessTokenUser) UnmarshalJSON added in v3.4.6 

func (a *AccessTokenUser) UnmarshalJSON(data []byte) error

type AccountType added in v3.3.1 

type AccountType string
const (
	AccountTypeFree       AccountType = "free"
	AccountTypeScaleUp    AccountType = "scale-up"
	AccountTypeEnterprise AccountType = "enterprise"
)

func (AccountType) ToPointer added in v3.3.1 

func (e AccountType) ToPointer() *AccountType

func (*AccountType) UnmarshalJSON added in v3.3.1 

func (e *AccountType) UnmarshalJSON(data []byte) error

type AddTags added in v3.5.10 

type AddTags struct {
	// revision digest to add tags too sha256:...
	RevisionDigest string `json:"revision_digest"`
	// string tags to add to the revision
	Tags []string `json:"tags"`
}

AddTags - Request body of tags to add to a revision

func (*AddTags) GetRevisionDigest added in v3.5.10 

func (o *AddTags) GetRevisionDigest() string

func (*AddTags) GetTags added in v3.5.10 

func (o *AddTags) GetTags() []string

type Annotations added in v3.5.4 

type Annotations struct {
	// The authors of the image
	OrgOpencontainersImageAuthors *string `json:"org.opencontainers.image.authors,omitempty"`
	// The time the image was created
	OrgOpencontainersImageCreated *string `json:"org.opencontainers.image.created,omitempty"`
	// Human-readable description of the software packaged in the image
	OrgOpencontainersImageDescription *string `json:"org.opencontainers.image.description,omitempty"`
	// The documentation URL of the image
	OrgOpencontainersImageDocumentation *string `json:"org.opencontainers.image.documentation,omitempty"`
	OrgOpencontainersImageLicenses      *string `json:"org.opencontainers.image.licenses,omitempty"`
	// Name of the reference for a target
	OrgOpencontainersImageRefName *string `json:"org.opencontainers.image.ref.name,omitempty"`
	// Source control revision identifier
	OrgOpencontainersImageRevision *string `json:"org.opencontainers.image.revision,omitempty"`
	// The URL to get source code for building the image
	OrgOpencontainersImageSource *string `json:"org.opencontainers.image.source,omitempty"`
	// Human-readable title of the image
	OrgOpencontainersImageTitle *string `json:"org.opencontainers.image.title,omitempty"`
	// The URL of the image
	OrgOpencontainersImageURL *string `json:"org.opencontainers.image.url,omitempty"`
	// Name of the distributing entity, organization or individual.
	OrgOpencontainersImageVendor *string `json:"org.opencontainers.image.vendor,omitempty"`
	// The version of the packaged software
	OrgOpencontainersImageVersion *string `json:"org.opencontainers.image.version,omitempty"`
}

Annotations

func (*Annotations) GetOrgOpencontainersImageAuthors added in v3.5.4 

func (o *Annotations) GetOrgOpencontainersImageAuthors() *string

func (*Annotations) GetOrgOpencontainersImageCreated added in v3.5.4 

func (o *Annotations) GetOrgOpencontainersImageCreated() *string

func (*Annotations) GetOrgOpencontainersImageDescription added in v3.5.4 

func (o *Annotations) GetOrgOpencontainersImageDescription() *string

func (*Annotations) GetOrgOpencontainersImageDocumentation added in v3.5.4 

func (o *Annotations) GetOrgOpencontainersImageDocumentation() *string

func (*Annotations) GetOrgOpencontainersImageLicenses added in v3.5.4 

func (o *Annotations) GetOrgOpencontainersImageLicenses() *string

func (*Annotations) GetOrgOpencontainersImageRefName added in v3.5.4 

func (o *Annotations) GetOrgOpencontainersImageRefName() *string

func (*Annotations) GetOrgOpencontainersImageRevision added in v3.5.4 

func (o *Annotations) GetOrgOpencontainersImageRevision() *string

func (*Annotations) GetOrgOpencontainersImageSource added in v3.5.4 

func (o *Annotations) GetOrgOpencontainersImageSource() *string

func (*Annotations) GetOrgOpencontainersImageTitle added in v3.5.4 

func (o *Annotations) GetOrgOpencontainersImageTitle() *string

func (*Annotations) GetOrgOpencontainersImageURL added in v3.5.4 

func (o *Annotations) GetOrgOpencontainersImageURL() *string

func (*Annotations) GetOrgOpencontainersImageVendor added in v3.5.4 

func (o *Annotations) GetOrgOpencontainersImageVendor() *string

func (*Annotations) GetOrgOpencontainersImageVersion added in v3.5.4 

func (o *Annotations) GetOrgOpencontainersImageVersion() *string

type Auth added in v3.8.9 

type Auth struct {
	Header string `json:"header"`
	Secret string `json:"secret"`
}

func (*Auth) GetHeader added in v3.8.9 

func (o *Auth) GetHeader() string

func (*Auth) GetSecret added in v3.8.9 

func (o *Auth) GetSecret() string

type BoundedRequest 

type BoundedRequest struct {
	// The ID of the ApiEndpoint this request was made to.
	APIEndpointID string `json:"api_endpoint_id"`
	// The ID of the Api this request was made to.
	APIID string `json:"api_id"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at"`
	// The ID of the customer that made this request.
	CustomerID string `json:"customer_id"`
	// The latency of the request.
	Latency int64 `json:"latency"`
	// Metadata associated with this request
	Metadata []RequestMetadata `json:"metadata,omitempty"`
	// HTTP verb.
	Method string `json:"method"`
	// The path of the request.
	Path string `json:"path"`
	// The time the request finished.
	RequestFinishTime time.Time `json:"request_finish_time"`
	// The ID of this request.
	RequestID string `json:"request_id"`
	// The time the request was made.
	RequestStartTime time.Time `json:"request_start_time"`
	// The status code of the request.
	Status int64 `json:"status"`
	// The version ID of the Api this request was made to.
	VersionID string `json:"version_id"`
	// The workspace ID this request was made to.
	WorkspaceID string `json:"workspace_id"`
}

A BoundedRequest is a request that has been logged by the Speakeasy without the contents of the request.

func (*BoundedRequest) GetAPIEndpointID 

func (o *BoundedRequest) GetAPIEndpointID() string

func (*BoundedRequest) GetAPIID 

func (o *BoundedRequest) GetAPIID() string

func (*BoundedRequest) GetCreatedAt 

func (o *BoundedRequest) GetCreatedAt() time.Time

func (*BoundedRequest) GetCustomerID 

func (o *BoundedRequest) GetCustomerID() string

func (*BoundedRequest) GetLatency 

func (o *BoundedRequest) GetLatency() int64

func (*BoundedRequest) GetMetadata 

func (o *BoundedRequest) GetMetadata() []RequestMetadata

func (*BoundedRequest) GetMethod 

func (o *BoundedRequest) GetMethod() string

func (*BoundedRequest) GetPath 

func (o *BoundedRequest) GetPath() string

func (*BoundedRequest) GetRequestFinishTime 

func (o *BoundedRequest) GetRequestFinishTime() time.Time

func (*BoundedRequest) GetRequestID 

func (o *BoundedRequest) GetRequestID() string

func (*BoundedRequest) GetRequestStartTime 

func (o *BoundedRequest) GetRequestStartTime() time.Time

func (*BoundedRequest) GetStatus 

func (o *BoundedRequest) GetStatus() int64

func (*BoundedRequest) GetVersionID 

func (o *BoundedRequest) GetVersionID() string

func (*BoundedRequest) GetWorkspaceID 

func (o *BoundedRequest) GetWorkspaceID() string

func (BoundedRequest) MarshalJSON 

func (b BoundedRequest) MarshalJSON() ([]byte, error)

func (*BoundedRequest) UnmarshalJSON 

func (b *BoundedRequest) UnmarshalJSON(data []byte) error

type Claims added in v3.3.11 

type Claims struct {
}

type CliEvent added in v3.1.0 

type CliEvent struct {
	// Remote commit ID.
	CommitHead *string `json:"commit_head,omitempty"`
	// Name of the CI environment.
	ContinuousIntegrationEnvironment *string `json:"continuous_integration_environment,omitempty"`
	// Timestamp when the event was created in the database.
	CreatedAt time.Time `json:"created_at"`
	// Duration of the event in milliseconds.
	DurationMs *int64 `json:"duration_ms,omitempty"`
	// Error message if the event was not successful.
	Error *string `json:"error,omitempty"`
	// Unique identifier for each execution of the CLI.
	ExecutionID string `json:"execution_id"`
	// Bump type of the lock file (calculated semver delta, or a custom change (manual release))
	GenerateBumpType *GenerateBumpType `json:"generate_bump_type,omitempty"`
	// Checksum of the configuration file (post generation)
	GenerateConfigPostChecksum *string `json:"generate_config_post_checksum,omitempty"`
	// Rendered configuration file (post generation)
	GenerateConfigPostRaw *string `json:"generate_config_post_raw,omitempty"`
	// The version of the customer's SDK that we just generated
	GenerateConfigPostVersion *string `json:"generate_config_post_version,omitempty"`
	// Checksum of the configuration file (prior to generation)
	GenerateConfigPreChecksum *string `json:"generate_config_pre_checksum,omitempty"`
	// Rendered configuration file (prior to generation)
	GenerateConfigPreRaw *string `json:"generate_config_pre_raw,omitempty"`
	// The version of the customer's SDK before we generated
	GenerateConfigPreVersion *string `json:"generate_config_pre_version,omitempty"`
	// Eligible feature set during generation
	GenerateEligibleFeatures *string `json:"generate_eligible_features,omitempty"`
	// gen.lock ID (expected to be a uuid).
	GenerateGenLockID *string `json:"generate_gen_lock_id,omitempty"`
	// Features post generation
	GenerateGenLockPostFeatures *string `json:"generate_gen_lock_post_features,omitempty"`
	// Blob digest of the Previous Generation
	GenerateGenLockPreBlobDigest *string `json:"generate_gen_lock_pre_blob_digest,omitempty"`
	// Checksum of the Previous Rendered OpenAPI document (prior to generation, via gen lock)
	GenerateGenLockPreDocChecksum *string `json:"generate_gen_lock_pre_doc_checksum,omitempty"`
	// info.Version of the Previous Rendered OpenAPI document (prior to generation, via gen lock)
	GenerateGenLockPreDocVersion *string `json:"generate_gen_lock_pre_doc_version,omitempty"`
	// Features prior to generation
	GenerateGenLockPreFeatures *string `json:"generate_gen_lock_pre_features,omitempty"`
	// Namespace name of the Previous Generation
	GenerateGenLockPreNamespaceName *string `json:"generate_gen_lock_pre_namespace_name,omitempty"`
	// Revision digest of the Previous Generation
	GenerateGenLockPreRevisionDigest *string `json:"generate_gen_lock_pre_revision_digest,omitempty"`
	// Artifact version for the Previous Generation
	GenerateGenLockPreVersion *string `json:"generate_gen_lock_pre_version,omitempty"`
	// The number of operations ignored in generation.
	GenerateNumberOfOperationsIgnored *int64 `json:"generate_number_of_operations_ignored,omitempty"`
	// The number of operations used in generation.
	GenerateNumberOfOperationsUsed *int64 `json:"generate_number_of_operations_used,omitempty"`
	// Indicates whether tests were output.
	GenerateOutputTests *bool `json:"generate_output_tests,omitempty"`
	// Indicates whether the target was considered published.
	GeneratePublished *bool `json:"generate_published,omitempty"`
	// Expected Repo URL, for use in documentation generation.
	GenerateRepoURL *string `json:"generate_repo_url,omitempty"`
	// The target of the event.
	GenerateTarget *string `json:"generate_target,omitempty"`
	// The workflow name of the target.
	GenerateTargetName *string `json:"generate_target_name,omitempty"`
	// The version of the target.
	GenerateTargetVersion *string `json:"generate_target_version,omitempty"`
	// Version of the generation logic used.
	GenerateVersion *string `json:"generate_version,omitempty"`
	// GitHub organization of the action.
	GhActionOrganization *string `json:"gh_action_organization,omitempty"`
	// GitHub Action ref value.
	GhActionRef *string `json:"gh_action_ref,omitempty"`
	// GitHub repository of the action.
	GhActionRepository *string `json:"gh_action_repository,omitempty"`
	// Link to the GitHub action run.
	GhActionRunLink *string `json:"gh_action_run_link,omitempty"`
	// Version of the GitHub action.
	GhActionVersion *string `json:"gh_action_version,omitempty"`
	// Current working directory relative to the git root.
	GitRelativeCwd *string `json:"git_relative_cwd,omitempty"`
	// Default owner for git remote.
	GitRemoteDefaultOwner *string `json:"git_remote_default_owner,omitempty"`
	// Default repository name for git remote.
	GitRemoteDefaultRepo *string `json:"git_remote_default_repo,omitempty"`
	// User email from git configuration.
	GitUserEmail *string `json:"git_user_email,omitempty"`
	// User's name from git configuration. (not GitHub username)
	GitUserName *string `json:"git_user_name,omitempty"`
	// Remote hostname.
	Hostname *string `json:"hostname,omitempty"`
	// Unique identifier for each event.
	ID string `json:"id"`
	// Type of interaction.
	InteractionType InteractionType `json:"interaction_type"`
	// The last step of the event.
	LastStep *string `json:"last_step,omitempty"`
	// The checksum of the lint report.
	LintReportDigest *string `json:"lint_report_digest,omitempty"`
	// The number of errors in the lint report.
	LintReportErrorCount *int64 `json:"lint_report_error_count,omitempty"`
	// The number of info messages in the lint report.
	LintReportInfoCount *int64 `json:"lint_report_info_count,omitempty"`
	// The number of warnings in the lint report.
	LintReportWarningCount *int64 `json:"lint_report_warning_count,omitempty"`
	// Timestamp when the event completed, in local time.
	LocalCompletedAt *time.Time `json:"local_completed_at,omitempty"`
	// Timestamp when the event started, in local time.
	LocalStartedAt time.Time `json:"local_started_at"`
	// Checksum of the currently Rendered OpenAPI document.
	ManagementDocChecksum *string `json:"management_doc_checksum,omitempty"`
	// Version taken from info.version field of the Rendered OpenAPI document.
	ManagementDocVersion *string `json:"management_doc_version,omitempty"`
	// Mermaid diagram
	MermaidDiagram *string `json:"mermaid_diagram,omitempty"`
	// The blob digest of the base source.
	OpenapiDiffBaseSourceBlobDigest *string `json:"openapi_diff_base_source_blob_digest,omitempty"`
	// The namespace name of the base source.
	OpenapiDiffBaseSourceNamespaceName *string `json:"openapi_diff_base_source_namespace_name,omitempty"`
	// The revision digest of the base source.
	OpenapiDiffBaseSourceRevisionDigest *string `json:"openapi_diff_base_source_revision_digest,omitempty"`
	// The number of breaking changes in the openapi diff report.
	OpenapiDiffBreakingChangesCount *int64 `json:"openapi_diff_breaking_changes_count,omitempty"`
	// Bump type of the lock file (calculated semver delta, or a custom change (manual release))
	OpenapiDiffBumpType *OpenapiDiffBumpType `json:"openapi_diff_bump_type,omitempty"`
	// The checksum of the openapi diff report.
	OpenapiDiffReportDigest *string `json:"openapi_diff_report_digest,omitempty"`
	// Name of the published package.
	PublishPackageName *string `json:"publish_package_name,omitempty"`
	// Name of the registry where the package was published.
	PublishPackageRegistryName *string `json:"publish_package_registry_name,omitempty"`
	// URL of the published package.
	PublishPackageURL *string `json:"publish_package_url,omitempty"`
	// Version of the published package.
	PublishPackageVersion *string `json:"publish_package_version,omitempty"`
	// Full CLI command.
	RawCommand *string `json:"raw_command,omitempty"`
	// Label of the git repository.
	RepoLabel *string `json:"repo_label,omitempty"`
	// The blob digest of the source.
	SourceBlobDigest *string `json:"source_blob_digest,omitempty"`
	// The namespace name of the source.
	SourceNamespaceName *string `json:"source_namespace_name,omitempty"`
	// The revision digest of the source.
	SourceRevisionDigest *string `json:"source_revision_digest,omitempty"`
	// Identifier of the Speakeasy API key.
	SpeakeasyAPIKeyName string `json:"speakeasy_api_key_name"`
	// Version of the Speakeasy CLI.
	SpeakeasyVersion string `json:"speakeasy_version"`
	// Indicates whether the event was successful.
	Success bool `json:"success"`
	// Workflow lock file (post execution)
	WorkflowLockPostRaw *string `json:"workflow_lock_post_raw,omitempty"`
	// Workflow lock file (prior to execution)
	WorkflowLockPreRaw *string `json:"workflow_lock_pre_raw,omitempty"`
	// Workflow file (post execution)
	WorkflowPostRaw *string `json:"workflow_post_raw,omitempty"`
	// Workflow file (prior to execution)
	WorkflowPreRaw *string `json:"workflow_pre_raw,omitempty"`
	// Identifier of the workspace.
	WorkspaceID string `json:"workspace_id"`
}

func (*CliEvent) GetCommitHead added in v3.1.0 

func (o *CliEvent) GetCommitHead() *string

func (*CliEvent) GetContinuousIntegrationEnvironment added in v3.3.13 

func (o *CliEvent) GetContinuousIntegrationEnvironment() *string

func (*CliEvent) GetCreatedAt added in v3.1.0 

func (o *CliEvent) GetCreatedAt() time.Time

func (*CliEvent) GetDurationMs added in v3.1.0 

func (o *CliEvent) GetDurationMs() *int64

func (*CliEvent) GetError added in v3.5.10 

func (o *CliEvent) GetError() *string

func (*CliEvent) GetExecutionID added in v3.1.0 

func (o *CliEvent) GetExecutionID() string

func (*CliEvent) GetGenerateBumpType added in v3.1.0 

func (o *CliEvent) GetGenerateBumpType() *GenerateBumpType

func (*CliEvent) GetGenerateConfigPostChecksum added in v3.1.0 

func (o *CliEvent) GetGenerateConfigPostChecksum() *string

func (*CliEvent) GetGenerateConfigPostRaw added in v3.1.0 

func (o *CliEvent) GetGenerateConfigPostRaw() *string

func (*CliEvent) GetGenerateConfigPostVersion added in v3.1.0 

func (o *CliEvent) GetGenerateConfigPostVersion() *string

func (*CliEvent) GetGenerateConfigPreChecksum added in v3.1.0 

func (o *CliEvent) GetGenerateConfigPreChecksum() *string

func (*CliEvent) GetGenerateConfigPreRaw added in v3.1.0 

func (o *CliEvent) GetGenerateConfigPreRaw() *string

func (*CliEvent) GetGenerateConfigPreVersion added in v3.1.0 

func (o *CliEvent) GetGenerateConfigPreVersion() *string

func (*CliEvent) GetGenerateEligibleFeatures added in v3.7.1 

func (o *CliEvent) GetGenerateEligibleFeatures() *string

func (*CliEvent) GetGenerateGenLockID added in v3.1.0 

func (o *CliEvent) GetGenerateGenLockID() *string

func (*CliEvent) GetGenerateGenLockPostFeatures added in v3.1.0 

func (o *CliEvent) GetGenerateGenLockPostFeatures() *string

func (*CliEvent) GetGenerateGenLockPreBlobDigest added in v3.5.7 

func (o *CliEvent) GetGenerateGenLockPreBlobDigest() *string

func (*CliEvent) GetGenerateGenLockPreDocChecksum added in v3.1.0 

func (o *CliEvent) GetGenerateGenLockPreDocChecksum() *string

func (*CliEvent) GetGenerateGenLockPreDocVersion added in v3.1.0 

func (o *CliEvent) GetGenerateGenLockPreDocVersion() *string

func (*CliEvent) GetGenerateGenLockPreFeatures added in v3.1.0 

func (o *CliEvent) GetGenerateGenLockPreFeatures() *string

func (*CliEvent) GetGenerateGenLockPreNamespaceName added in v3.5.7 

func (o *CliEvent) GetGenerateGenLockPreNamespaceName() *string

func (*CliEvent) GetGenerateGenLockPreRevisionDigest added in v3.5.7 

func (o *CliEvent) GetGenerateGenLockPreRevisionDigest() *string

func (*CliEvent) GetGenerateGenLockPreVersion added in v3.1.0 

func (o *CliEvent) GetGenerateGenLockPreVersion() *string

func (*CliEvent) GetGenerateNumberOfOperationsIgnored added in v3.7.1 

func (o *CliEvent) GetGenerateNumberOfOperationsIgnored() *int64

func (*CliEvent) GetGenerateNumberOfOperationsUsed added in v3.7.1 

func (o *CliEvent) GetGenerateNumberOfOperationsUsed() *int64

func (*CliEvent) GetGenerateOutputTests added in v3.1.0 

func (o *CliEvent) GetGenerateOutputTests() *bool

func (*CliEvent) GetGeneratePublished added in v3.1.0 

func (o *CliEvent) GetGeneratePublished() *bool

func (*CliEvent) GetGenerateRepoURL added in v3.1.0 

func (o *CliEvent) GetGenerateRepoURL() *string

func (*CliEvent) GetGenerateTarget added in v3.1.0 

func (o *CliEvent) GetGenerateTarget() *string

func (*CliEvent) GetGenerateTargetName added in v3.8.8 

func (o *CliEvent) GetGenerateTargetName() *string

func (*CliEvent) GetGenerateTargetVersion added in v3.1.0 

func (o *CliEvent) GetGenerateTargetVersion() *string

func (*CliEvent) GetGenerateVersion added in v3.1.0 

func (o *CliEvent) GetGenerateVersion() *string

func (*CliEvent) GetGhActionOrganization added in v3.1.0 

func (o *CliEvent) GetGhActionOrganization() *string

func (*CliEvent) GetGhActionRef added in v3.7.1 

func (o *CliEvent) GetGhActionRef() *string

func (*CliEvent) GetGhActionRepository added in v3.1.0 

func (o *CliEvent) GetGhActionRepository() *string
func (o *CliEvent) GetGhActionRunLink() *string

func (*CliEvent) GetGhActionVersion added in v3.1.0 

func (o *CliEvent) GetGhActionVersion() *string

func (*CliEvent) GetGitRelativeCwd added in v3.1.0 

func (o *CliEvent) GetGitRelativeCwd() *string

func (*CliEvent) GetGitRemoteDefaultOwner added in v3.1.0 

func (o *CliEvent) GetGitRemoteDefaultOwner() *string

func (*CliEvent) GetGitRemoteDefaultRepo added in v3.1.0 

func (o *CliEvent) GetGitRemoteDefaultRepo() *string

func (*CliEvent) GetGitUserEmail added in v3.1.0 

func (o *CliEvent) GetGitUserEmail() *string

func (*CliEvent) GetGitUserName added in v3.1.0 

func (o *CliEvent) GetGitUserName() *string

func (*CliEvent) GetHostname added in v3.1.0 

func (o *CliEvent) GetHostname() *string

func (*CliEvent) GetID added in v3.1.0 

func (o *CliEvent) GetID() string

func (*CliEvent) GetInteractionType added in v3.1.0 

func (o *CliEvent) GetInteractionType() InteractionType

func (*CliEvent) GetLastStep added in v3.5.11 

func (o *CliEvent) GetLastStep() *string

func (*CliEvent) GetLintReportDigest added in v3.5.7 

func (o *CliEvent) GetLintReportDigest() *string

func (*CliEvent) GetLintReportErrorCount added in v3.5.7 

func (o *CliEvent) GetLintReportErrorCount() *int64

func (*CliEvent) GetLintReportInfoCount added in v3.5.7 

func (o *CliEvent) GetLintReportInfoCount() *int64

func (*CliEvent) GetLintReportWarningCount added in v3.5.7 

func (o *CliEvent) GetLintReportWarningCount() *int64

func (*CliEvent) GetLocalCompletedAt added in v3.1.0 

func (o *CliEvent) GetLocalCompletedAt() *time.Time

func (*CliEvent) GetLocalStartedAt added in v3.1.0 

func (o *CliEvent) GetLocalStartedAt() time.Time

func (*CliEvent) GetManagementDocChecksum added in v3.1.0 

func (o *CliEvent) GetManagementDocChecksum() *string

func (*CliEvent) GetManagementDocVersion added in v3.1.0 

func (o *CliEvent) GetManagementDocVersion() *string

func (*CliEvent) GetMermaidDiagram added in v3.5.11 

func (o *CliEvent) GetMermaidDiagram() *string

func (*CliEvent) GetOpenapiDiffBaseSourceBlobDigest added in v3.5.7 

func (o *CliEvent) GetOpenapiDiffBaseSourceBlobDigest() *string

func (*CliEvent) GetOpenapiDiffBaseSourceNamespaceName added in v3.5.7 

func (o *CliEvent) GetOpenapiDiffBaseSourceNamespaceName() *string

func (*CliEvent) GetOpenapiDiffBaseSourceRevisionDigest added in v3.5.7 

func (o *CliEvent) GetOpenapiDiffBaseSourceRevisionDigest() *string

func (*CliEvent) GetOpenapiDiffBreakingChangesCount added in v3.5.7 

func (o *CliEvent) GetOpenapiDiffBreakingChangesCount() *int64

func (*CliEvent) GetOpenapiDiffBumpType added in v3.5.7 

func (o *CliEvent) GetOpenapiDiffBumpType() *OpenapiDiffBumpType

func (*CliEvent) GetOpenapiDiffReportDigest added in v3.5.7 

func (o *CliEvent) GetOpenapiDiffReportDigest() *string

func (*CliEvent) GetPublishPackageName added in v3.3.8 

func (o *CliEvent) GetPublishPackageName() *string

func (*CliEvent) GetPublishPackageRegistryName added in v3.3.8 

func (o *CliEvent) GetPublishPackageRegistryName() *string

func (*CliEvent) GetPublishPackageURL added in v3.3.8 

func (o *CliEvent) GetPublishPackageURL() *string

func (*CliEvent) GetPublishPackageVersion added in v3.3.8 

func (o *CliEvent) GetPublishPackageVersion() *string

func (*CliEvent) GetRawCommand added in v3.1.0 

func (o *CliEvent) GetRawCommand() *string

func (*CliEvent) GetRepoLabel added in v3.1.0 

func (o *CliEvent) GetRepoLabel() *string

func (*CliEvent) GetSourceBlobDigest added in v3.5.7 

func (o *CliEvent) GetSourceBlobDigest() *string

func (*CliEvent) GetSourceNamespaceName added in v3.5.7 

func (o *CliEvent) GetSourceNamespaceName() *string

func (*CliEvent) GetSourceRevisionDigest added in v3.5.7 

func (o *CliEvent) GetSourceRevisionDigest() *string

func (*CliEvent) GetSpeakeasyAPIKeyName added in v3.1.0 

func (o *CliEvent) GetSpeakeasyAPIKeyName() string

func (*CliEvent) GetSpeakeasyVersion added in v3.1.0 

func (o *CliEvent) GetSpeakeasyVersion() string

func (*CliEvent) GetSuccess added in v3.1.0 

func (o *CliEvent) GetSuccess() bool

func (*CliEvent) GetWorkflowLockPostRaw added in v3.5.11 

func (o *CliEvent) GetWorkflowLockPostRaw() *string

func (*CliEvent) GetWorkflowLockPreRaw added in v3.5.11 

func (o *CliEvent) GetWorkflowLockPreRaw() *string

func (*CliEvent) GetWorkflowPostRaw added in v3.5.11 

func (o *CliEvent) GetWorkflowPostRaw() *string

func (*CliEvent) GetWorkflowPreRaw added in v3.5.11 

func (o *CliEvent) GetWorkflowPreRaw() *string

func (*CliEvent) GetWorkspaceID added in v3.1.0 

func (o *CliEvent) GetWorkspaceID() string

func (CliEvent) MarshalJSON added in v3.1.0 

func (c CliEvent) MarshalJSON() ([]byte, error)

func (*CliEvent) UnmarshalJSON added in v3.1.0 

func (c *CliEvent) UnmarshalJSON(data []byte) error

type DepthStyle added in v3.8.9 

type DepthStyle string
const (
	DepthStyleOriginal DepthStyle = "original"
	DepthStyleFlat     DepthStyle = "flat"
	DepthStyleNested   DepthStyle = "nested"
	DepthStyleDeep     DepthStyle = "deep"
)

func (DepthStyle) ToPointer added in v3.8.9 

func (e DepthStyle) ToPointer() *DepthStyle

func (*DepthStyle) UnmarshalJSON added in v3.8.9 

func (e *DepthStyle) UnmarshalJSON(data []byte) error

type EmbedAccessTokenResponse 

type EmbedAccessTokenResponse struct {
	AccessToken string `json:"access_token"`
}

An EmbedAccessTokenResponse contains a token that can be used to embed a Speakeasy dashboard.

func (*EmbedAccessTokenResponse) GetAccessToken 

func (o *EmbedAccessTokenResponse) GetAccessToken() string

type EmbedToken 

type EmbedToken struct {
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at"`
	// The ID of the user that created this token.
	CreatedBy string `json:"created_by"`
	// A detailed description of the EmbedToken.
	Description string `json:"description"`
	// The time this token expires.
	ExpiresAt time.Time `json:"expires_at"`
	// The filters applied to this token.
	Filters string `json:"filters"`
	// The ID of this EmbedToken.
	ID string `json:"id"`
	// The last time this token was used.
	LastUsed *time.Time `json:"last_used,omitempty"`
	// The time this token was revoked.
	RevokedAt *time.Time `json:"revoked_at,omitempty"`
	// The ID of the user that revoked this token.
	RevokedBy *string `json:"revoked_by,omitempty"`
	// The workspace ID this token belongs to.
	WorkspaceID string `json:"workspace_id"`
}

EmbedToken - A representation of an embed token granted for working with Speakeasy components.

func (*EmbedToken) GetCreatedAt 

func (o *EmbedToken) GetCreatedAt() time.Time

func (*EmbedToken) GetCreatedBy 

func (o *EmbedToken) GetCreatedBy() string

func (*EmbedToken) GetDescription 

func (o *EmbedToken) GetDescription() string

func (*EmbedToken) GetExpiresAt 

func (o *EmbedToken) GetExpiresAt() time.Time

func (*EmbedToken) GetFilters 

func (o *EmbedToken) GetFilters() string

func (*EmbedToken) GetID 

func (o *EmbedToken) GetID() string

func (*EmbedToken) GetLastUsed 

func (o *EmbedToken) GetLastUsed() *time.Time

func (*EmbedToken) GetRevokedAt 

func (o *EmbedToken) GetRevokedAt() *time.Time

func (*EmbedToken) GetRevokedBy 

func (o *EmbedToken) GetRevokedBy() *string

func (*EmbedToken) GetWorkspaceID 

func (o *EmbedToken) GetWorkspaceID() string

func (EmbedToken) MarshalJSON 

func (e EmbedToken) MarshalJSON() ([]byte, error)

func (*EmbedToken) UnmarshalJSON 

func (e *EmbedToken) UnmarshalJSON(data []byte) error

type FeatureFlag added in v3.7.2 

type FeatureFlag struct {
	FeatureFlag string     `json:"feature_flag"`
	TrialEndsAt *time.Time `json:"trial_ends_at,omitempty"`
}

FeatureFlag - A feature flag is a key-value pair that can be used to enable or disable features.

func (*FeatureFlag) GetFeatureFlag added in v3.7.2 

func (o *FeatureFlag) GetFeatureFlag() string

func (*FeatureFlag) GetTrialEndsAt added in v3.7.2 

func (o *FeatureFlag) GetTrialEndsAt() *time.Time

func (FeatureFlag) MarshalJSON added in v3.7.2 

func (f FeatureFlag) MarshalJSON() ([]byte, error)

func (*FeatureFlag) UnmarshalJSON added in v3.7.2 

func (f *FeatureFlag) UnmarshalJSON(data []byte) error

type Filter 

type Filter struct {
	// The key of the filter.
	Key string `json:"key"`
	// The operator of the filter.
	Operator string `json:"operator"`
	// The value of the filter.
	Value string `json:"value"`
}

Filter - A filter is a key-value pair that can be used to filter a list of requests.

func (*Filter) GetKey 

func (o *Filter) GetKey() string

func (*Filter) GetOperator 

func (o *Filter) GetOperator() string

func (*Filter) GetValue 

func (o *Filter) GetValue() string

type Filters 

type Filters struct {
	// A list of filters to apply to the query.
	Filters []Filter `json:"filters"`
	// The maximum number of results to return.
	Limit int64 `json:"limit"`
	// The offset to start the query from.
	Offset int64 `json:"offset"`
	// The operator to use when combining filters.
	Operator string `json:"operator"`
}

Filters are used to query requests.

func (*Filters) GetFilters 

func (o *Filters) GetFilters() []Filter

func (*Filters) GetLimit 

func (o *Filters) GetLimit() int64

func (*Filters) GetOffset 

func (o *Filters) GetOffset() int64

func (*Filters) GetOperator 

func (o *Filters) GetOperator() string

type GenerateBumpType added in v3.1.0 

type GenerateBumpType string

GenerateBumpType - Bump type of the lock file (calculated semver delta, or a custom change (manual release)) 

const (
	GenerateBumpTypeMajor  GenerateBumpType = "major"
	GenerateBumpTypeMinor  GenerateBumpType = "minor"
	GenerateBumpTypePatch  GenerateBumpType = "patch"
	GenerateBumpTypeCustom GenerateBumpType = "custom"
	GenerateBumpTypeNone   GenerateBumpType = "none"
)

func (GenerateBumpType) ToPointer added in v3.1.0 

func (e GenerateBumpType) ToPointer() *GenerateBumpType

func (*GenerateBumpType) UnmarshalJSON added in v3.1.0 

func (e *GenerateBumpType) UnmarshalJSON(data []byte) error

type GenerateOpenAPISpecDiff 

type GenerateOpenAPISpecDiff struct {
	CurrentSchema string `json:"current_schema"`
	NewSchema     string `json:"new_schema"`
}

func (*GenerateOpenAPISpecDiff) GetCurrentSchema 

func (o *GenerateOpenAPISpecDiff) GetCurrentSchema() string

func (*GenerateOpenAPISpecDiff) GetNewSchema 

func (o *GenerateOpenAPISpecDiff) GetNewSchema() string

type GetNamespacesResponse added in v3.5.3 

type GetNamespacesResponse struct {
	Items []Namespace `json:"items"`
}

func (*GetNamespacesResponse) GetItems added in v3.5.3 

func (o *GetNamespacesResponse) GetItems() []Namespace

type GetRevisionsResponse added in v3.5.3 

type GetRevisionsResponse struct {
	Items         []Revision `json:"items"`
	NextPageToken string     `json:"next_page_token"`
}

func (*GetRevisionsResponse) GetItems added in v3.5.3 

func (o *GetRevisionsResponse) GetItems() []Revision

func (*GetRevisionsResponse) GetNextPageToken added in v3.5.3 

func (o *GetRevisionsResponse) GetNextPageToken() string

type GetTagsResponse added in v3.5.4 

type GetTagsResponse struct {
	Items []Tag `json:"items"`
}

func (*GetTagsResponse) GetItems added in v3.5.4 

func (o *GetTagsResponse) GetItems() []Tag

type GithubConfigureCodeSamplesRequest added in v3.8.9 

type GithubConfigureCodeSamplesRequest struct {
	// The GitHub organization name
	Org string `json:"org"`
	// The GitHub repository name
	Repo string `json:"repo"`
	// The target name for the code samples
	TargetName string `json:"targetName"`
}

GithubConfigureCodeSamplesRequest - A request to configure GitHub code samples

func (*GithubConfigureCodeSamplesRequest) GetOrg added in v3.8.9 

func (o *GithubConfigureCodeSamplesRequest) GetOrg() string

func (*GithubConfigureCodeSamplesRequest) GetRepo added in v3.8.9 

func (o *GithubConfigureCodeSamplesRequest) GetRepo() string

func (*GithubConfigureCodeSamplesRequest) GetTargetName added in v3.8.9 

func (o *GithubConfigureCodeSamplesRequest) GetTargetName() string

type GithubConfigureCodeSamplesResponse added in v3.8.9 

type GithubConfigureCodeSamplesResponse struct {
	// The URL of the code sample overlay registry
	CodeSampleOverlayRegistryURL string `json:"codeSampleOverlayRegistryURL"`
	// The ID of the GitHub action that was dispatched
	GhActionID *string `json:"ghActionID,omitempty"`
	// A document referenced by a workflow
	Source WorkflowDocument `json:"source"`
}

GithubConfigureCodeSamplesResponse - A response to configure GitHub code samples

func (*GithubConfigureCodeSamplesResponse) GetCodeSampleOverlayRegistryURL added in v3.8.9 

func (o *GithubConfigureCodeSamplesResponse) GetCodeSampleOverlayRegistryURL() string

func (*GithubConfigureCodeSamplesResponse) GetGhActionID added in v3.8.9 

func (o *GithubConfigureCodeSamplesResponse) GetGhActionID() *string

func (*GithubConfigureCodeSamplesResponse) GetSource added in v3.8.9 

func (o *GithubConfigureCodeSamplesResponse) GetSource() WorkflowDocument

type GithubConfigureMintlifyRepoRequest added in v3.8.9 

type GithubConfigureMintlifyRepoRequest struct {
	// The input OpenAPI document
	Input string `json:"input"`
	// The GitHub organization name
	Org string `json:"org"`
	// The overlays to apply
	Overlays []string `json:"overlays"`
	// The GitHub repository name
	Repo string `json:"repo"`
	// The subdirectory (location of mint.json)
	Subdirectory *string `json:"subdirectory,omitempty"`
}

GithubConfigureMintlifyRepoRequest - A request to configure a GitHub repository for mintlify

func (*GithubConfigureMintlifyRepoRequest) GetInput added in v3.8.9 

func (o *GithubConfigureMintlifyRepoRequest) GetInput() string

func (*GithubConfigureMintlifyRepoRequest) GetOrg added in v3.8.9 

func (o *GithubConfigureMintlifyRepoRequest) GetOrg() string

func (*GithubConfigureMintlifyRepoRequest) GetOverlays added in v3.8.9 

func (o *GithubConfigureMintlifyRepoRequest) GetOverlays() []string

func (*GithubConfigureMintlifyRepoRequest) GetRepo added in v3.8.9 

func (o *GithubConfigureMintlifyRepoRequest) GetRepo() string

func (*GithubConfigureMintlifyRepoRequest) GetSubdirectory added in v3.9.0 

func (o *GithubConfigureMintlifyRepoRequest) GetSubdirectory() *string

type GithubConfigureTargetRequest added in v3.8.0 

type GithubConfigureTargetRequest struct {
	// The GitHub organization name
	Org string `json:"org"`
	// The GitHub repository name
	RepoName string `json:"repo_name"`
}

GithubConfigureTargetRequest - A request to configure a GitHub target

func (*GithubConfigureTargetRequest) GetOrg added in v3.8.0 

func (o *GithubConfigureTargetRequest) GetOrg() string

func (*GithubConfigureTargetRequest) GetRepoName added in v3.8.0 

func (o *GithubConfigureTargetRequest) GetRepoName() string

type GithubGetActionResponse added in v3.9.0 

type GithubGetActionResponse struct {
	// The status of the latest action run if available
	RunStatus *string `json:"run_status,omitempty"`
	// The URL for latest action run if available
	RunURL *string `json:"run_url,omitempty"`
}

GithubGetActionResponse - response to a getting the latest action run on a GitHub request

func (*GithubGetActionResponse) GetRunStatus added in v3.9.0 

func (o *GithubGetActionResponse) GetRunStatus() *string

func (*GithubGetActionResponse) GetRunURL added in v3.9.0 

func (o *GithubGetActionResponse) GetRunURL() *string

type GithubMissingPublishingSecretsResponse added in v3.8.6 

type GithubMissingPublishingSecretsResponse struct {
	MissingSecrets []string `json:"missing_secrets,omitempty"`
}

GithubMissingPublishingSecretsResponse - A valid response containing MISSING publishing secret keys for a github target

func (*GithubMissingPublishingSecretsResponse) GetMissingSecrets added in v3.8.6 

func (o *GithubMissingPublishingSecretsResponse) GetMissingSecrets() []string

type GithubPublishingPRResponse added in v3.8.6 

type GithubPublishingPRResponse struct {
	GenerationPullRequest *string `json:"generation_pull_request,omitempty"`
	PendingVersion        *string `json:"pending_version,omitempty"`
}

GithubPublishingPRResponse - Open generation PRs pending publishing

func (*GithubPublishingPRResponse) GetGenerationPullRequest added in v3.8.6 

func (o *GithubPublishingPRResponse) GetGenerationPullRequest() *string

func (*GithubPublishingPRResponse) GetPendingVersion added in v3.8.6 

func (o *GithubPublishingPRResponse) GetPendingVersion() *string

type GithubStorePublishingSecretsRequest added in v3.8.6 

type GithubStorePublishingSecretsRequest struct {
	// The generation lock ID
	GenerateGenLockID string `json:"generate_gen_lock_id"`
	// A map of secrets to store in the GitHub target
	Secrets map[string]string `json:"secrets,omitempty"`
}

GithubStorePublishingSecretsRequest - A request to store publishing secrets for a github target

func (*GithubStorePublishingSecretsRequest) GetGenerateGenLockID added in v3.8.6 

func (o *GithubStorePublishingSecretsRequest) GetGenerateGenLockID() string

func (*GithubStorePublishingSecretsRequest) GetSecrets added in v3.8.6 

func (o *GithubStorePublishingSecretsRequest) GetSecrets() map[string]string

type GithubTriggerActionRequest added in v3.8.0 

type GithubTriggerActionRequest struct {
	// The generation lock ID
	GenLockID string `json:"gen_lock_id"`
	// The GitHub organization name
	Org string `json:"org"`
	// The GitHub repository name
	RepoName string `json:"repo_name"`
	// A version to override the SDK too in workflow dispatch
	SetVersion *string `json:"set_version,omitempty"`
	// The target name for the action
	TargetName *string `json:"target_name,omitempty"`
}

GithubTriggerActionRequest - A request to trigger an action on a GitHub target

func (*GithubTriggerActionRequest) GetGenLockID added in v3.8.0 

func (o *GithubTriggerActionRequest) GetGenLockID() string

func (*GithubTriggerActionRequest) GetOrg added in v3.8.0 

func (o *GithubTriggerActionRequest) GetOrg() string

func (*GithubTriggerActionRequest) GetRepoName added in v3.8.0 

func (o *GithubTriggerActionRequest) GetRepoName() string

func (*GithubTriggerActionRequest) GetSetVersion added in v3.9.0 

func (o *GithubTriggerActionRequest) GetSetVersion() *string

func (*GithubTriggerActionRequest) GetTargetName added in v3.8.0 

func (o *GithubTriggerActionRequest) GetTargetName() *string

type InteractionType added in v3.1.0 

type InteractionType string

InteractionType - Type of interaction. 

const (
	InteractionTypeCiExec         InteractionType = "CI_EXEC"
	InteractionTypeCliExec        InteractionType = "CLI_EXEC"
	InteractionTypeLint           InteractionType = "LINT"
	InteractionTypeOpenapiDiff    InteractionType = "OPENAPI_DIFF"
	InteractionTypeTargetGenerate InteractionType = "TARGET_GENERATE"
	InteractionTypeTombstone      InteractionType = "TOMBSTONE"
	InteractionTypeAuthenticate   InteractionType = "AUTHENTICATE"
	InteractionTypeQuickstart     InteractionType = "QUICKSTART"
	InteractionTypeRun            InteractionType = "RUN"
	InteractionTypeConfigure      InteractionType = "CONFIGURE"
	InteractionTypePublish        InteractionType = "PUBLISH"
)

func (InteractionType) ToPointer added in v3.1.0 

func (e InteractionType) ToPointer() *InteractionType

func (*InteractionType) UnmarshalJSON added in v3.1.0 

func (e *InteractionType) UnmarshalJSON(data []byte) error

type Level added in v3.4.2 

type Level string
const (
	LevelAllowed Level = "allowed"
	LevelWarning Level = "warning"
	LevelBlocked Level = "blocked"
)

func (Level) ToPointer added in v3.4.2 

func (e Level) ToPointer() *Level

func (*Level) UnmarshalJSON added in v3.4.2 

func (e *Level) UnmarshalJSON(data []byte) error

type License added in v3.8.9 

type License struct {
	Identifier *string `json:"identifier,omitempty"`
}

func (*License) GetIdentifier added in v3.8.9 

func (o *License) GetIdentifier() *string

type Manifest added in v3.5.4 

type Manifest struct {
	// Annotations
	Annotations *Annotations `json:"annotations,omitempty"`
	// Type of artifact
	ArtifactType *string `json:"artifactType,omitempty"`
	// List of V2 image layer information
	Layers []V2Descriptor `json:"layers,omitempty"`
	// Media type usually application/vnd.docker.distribution.manifest.v2+json if this is in the accept header
	MediaType *string `json:"mediaType,omitempty"`
	// Schema version
	SchemaVersion *int64 `json:"schemaVersion,omitempty"`
}

Manifest - Returns the requested manifest file

func (*Manifest) GetAnnotations added in v3.5.4 

func (o *Manifest) GetAnnotations() *Annotations

func (*Manifest) GetArtifactType added in v3.5.4 

func (o *Manifest) GetArtifactType() *string

func (*Manifest) GetLayers added in v3.5.4 

func (o *Manifest) GetLayers() []V2Descriptor

func (*Manifest) GetMediaType added in v3.5.4 

func (o *Manifest) GetMediaType() *string

func (*Manifest) GetSchemaVersion added in v3.5.4 

func (o *Manifest) GetSchemaVersion() *int64

type Namespace added in v3.5.3 

type Namespace struct {
	CreatedAt time.Time `json:"created_at"`
	// {organization_slug}/{workspace_slug}/{namespace_name}
	ID string `json:"id"`
	// A human-readable name for the namespace.
	Name      string    `json:"name"`
	UpdatedAt time.Time `json:"updated_at"`
}

Namespace - A namespace contains many revisions.

func (*Namespace) GetCreatedAt added in v3.5.3 

func (o *Namespace) GetCreatedAt() time.Time

func (*Namespace) GetID added in v3.5.3 

func (o *Namespace) GetID() string

func (*Namespace) GetName added in v3.5.4 

func (o *Namespace) GetName() string

func (*Namespace) GetUpdatedAt added in v3.5.3 

func (o *Namespace) GetUpdatedAt() time.Time

func (Namespace) MarshalJSON added in v3.5.3 

func (n Namespace) MarshalJSON() ([]byte, error)

func (*Namespace) UnmarshalJSON added in v3.5.3 

func (n *Namespace) UnmarshalJSON(data []byte) error

type OASInfo added in v3.8.9 

type OASInfo struct {
	Description string  `json:"description"`
	License     License `json:"license"`
	Summary     string  `json:"summary"`
	Title       string  `json:"title"`
	Version     string  `json:"version"`
}

func (*OASInfo) GetDescription added in v3.8.9 

func (o *OASInfo) GetDescription() string

func (*OASInfo) GetLicense added in v3.8.9 

func (o *OASInfo) GetLicense() License

func (*OASInfo) GetSummary added in v3.8.9 

func (o *OASInfo) GetSummary() string

func (*OASInfo) GetTitle added in v3.8.9 

func (o *OASInfo) GetTitle() string

func (*OASInfo) GetVersion added in v3.8.9 

func (o *OASInfo) GetVersion() string

type OASOperation added in v3.8.9 

type OASOperation struct {
	Description string   `json:"description"`
	Method      string   `json:"method"`
	OperationID string   `json:"operation_id"`
	Path        string   `json:"path"`
	Tags        []string `json:"tags"`
}

func (*OASOperation) GetDescription added in v3.8.9 

func (o *OASOperation) GetDescription() string

func (*OASOperation) GetMethod added in v3.8.9 

func (o *OASOperation) GetMethod() string

func (*OASOperation) GetOperationID added in v3.8.9 

func (o *OASOperation) GetOperationID() string

func (*OASOperation) GetPath added in v3.8.9 

func (o *OASOperation) GetPath() string

func (*OASOperation) GetTags added in v3.8.9 

func (o *OASOperation) GetTags() []string

type OASSummary added in v3.8.9 

type OASSummary struct {
	Info       OASInfo        `json:"info"`
	Operations []OASOperation `json:"operations"`
}

func (*OASSummary) GetInfo added in v3.8.9 

func (o *OASSummary) GetInfo() OASInfo

func (*OASSummary) GetOperations added in v3.8.9 

func (o *OASSummary) GetOperations() []OASOperation

type OpenapiDiffBumpType added in v3.5.7 

type OpenapiDiffBumpType string

OpenapiDiffBumpType - Bump type of the lock file (calculated semver delta, or a custom change (manual release)) 

const (
	OpenapiDiffBumpTypeMajor OpenapiDiffBumpType = "major"
	OpenapiDiffBumpTypeMinor OpenapiDiffBumpType = "minor"
	OpenapiDiffBumpTypePatch OpenapiDiffBumpType = "patch"
	OpenapiDiffBumpTypeNone  OpenapiDiffBumpType = "none"
)

func (OpenapiDiffBumpType) ToPointer added in v3.5.7 

func (e OpenapiDiffBumpType) ToPointer() *OpenapiDiffBumpType

func (*OpenapiDiffBumpType) UnmarshalJSON added in v3.5.7 

func (e *OpenapiDiffBumpType) UnmarshalJSON(data []byte) error

type Organization added in v3.4.2 

type Organization struct {
	AccountType       OrganizationAccountType `json:"account_type"`
	CreatedAt         *time.Time              `json:"created_at,omitempty"`
	ID                string                  `json:"id"`
	Name              string                  `json:"name"`
	Slug              *string                 `json:"slug,omitempty"`
	TelemetryDisabled bool                    `json:"telemetry_disabled"`
	UpdatedAt         *time.Time              `json:"updated_at,omitempty"`
}

Organization - A speakeasy organization

func (*Organization) GetAccountType added in v3.4.2 

func (o *Organization) GetAccountType() OrganizationAccountType

func (*Organization) GetCreatedAt added in v3.4.2 

func (o *Organization) GetCreatedAt() *time.Time

func (*Organization) GetID added in v3.4.2 

func (o *Organization) GetID() string

func (*Organization) GetName added in v3.4.2 

func (o *Organization) GetName() string

func (*Organization) GetSlug added in v3.4.2 

func (o *Organization) GetSlug() *string

func (*Organization) GetTelemetryDisabled added in v3.8.4 

func (o *Organization) GetTelemetryDisabled() bool

func (*Organization) GetUpdatedAt added in v3.4.2 

func (o *Organization) GetUpdatedAt() *time.Time

func (Organization) MarshalJSON added in v3.4.2 

func (o Organization) MarshalJSON() ([]byte, error)

func (*Organization) UnmarshalJSON added in v3.4.2 

func (o *Organization) UnmarshalJSON(data []byte) error

type OrganizationAccountType added in v3.4.2 

type OrganizationAccountType string
const (
	OrganizationAccountTypeFree       OrganizationAccountType = "free"
	OrganizationAccountTypeScaleUp    OrganizationAccountType = "scale-up"
	OrganizationAccountTypeEnterprise OrganizationAccountType = "enterprise"
)

func (OrganizationAccountType) ToPointer added in v3.4.2 

func (e OrganizationAccountType) ToPointer() *OrganizationAccountType

func (*OrganizationAccountType) UnmarshalJSON added in v3.4.2 

func (e *OrganizationAccountType) UnmarshalJSON(data []byte) error

type OrganizationUsage added in v3.8.0 

type OrganizationUsage struct {
	// Indicates if the features are accessible
	Accessible bool `json:"accessible"`
	// Features that are accessible
	AccessibleFeatures []string `json:"accessible_features"`
	// List of generation lock IDs
	GenLockIds []string `json:"gen_lock_ids"`
	// The programming language used
	Language string `json:"language"`
	// Number of operations performed
	NumberOfOperations int64 `json:"number_of_operations"`
	// Features that have been used
	UsedFeatures []string `json:"used_features"`
	// List of workspace IDs
	Workspaces []string `json:"workspaces"`
}

func (*OrganizationUsage) GetAccessible added in v3.8.0 

func (o *OrganizationUsage) GetAccessible() bool

func (*OrganizationUsage) GetAccessibleFeatures added in v3.8.0 

func (o *OrganizationUsage) GetAccessibleFeatures() []string

func (*OrganizationUsage) GetGenLockIds added in v3.8.0 

func (o *OrganizationUsage) GetGenLockIds() []string

func (*OrganizationUsage) GetLanguage added in v3.8.0 

func (o *OrganizationUsage) GetLanguage() string

func (*OrganizationUsage) GetNumberOfOperations added in v3.8.0 

func (o *OrganizationUsage) GetNumberOfOperations() int64

func (*OrganizationUsage) GetUsedFeatures added in v3.8.0 

func (o *OrganizationUsage) GetUsedFeatures() []string

func (*OrganizationUsage) GetWorkspaces added in v3.8.0 

func (o *OrganizationUsage) GetWorkspaces() []string

type OrganizationUsageResponse added in v3.8.0 

type OrganizationUsageResponse struct {
	// List of allowed languages
	AllowedLanguages []string `json:"allowed_languages"`
	// Expiry date of the free trial, will be null if no trial
	FreeTrialExpiry *time.Time `json:"free_trial_expiry,omitempty"`
	// Total number of allowed languages, -1 if unlimited
	TotalAllowedLanguages int64               `json:"total_allowed_languages"`
	Usage                 []OrganizationUsage `json:"usage"`
}

OrganizationUsageResponse - A billing summary of organization usage

func (*OrganizationUsageResponse) GetAllowedLanguages added in v3.8.0 

func (o *OrganizationUsageResponse) GetAllowedLanguages() []string

func (*OrganizationUsageResponse) GetFreeTrialExpiry added in v3.8.0 

func (o *OrganizationUsageResponse) GetFreeTrialExpiry() *time.Time

func (*OrganizationUsageResponse) GetTotalAllowedLanguages added in v3.8.0 

func (o *OrganizationUsageResponse) GetTotalAllowedLanguages() int64

func (*OrganizationUsageResponse) GetUsage added in v3.8.0 

func (o *OrganizationUsageResponse) GetUsage() []OrganizationUsage

func (OrganizationUsageResponse) MarshalJSON added in v3.8.0 

func (o OrganizationUsageResponse) MarshalJSON() ([]byte, error)

func (*OrganizationUsageResponse) UnmarshalJSON added in v3.8.0 

func (o *OrganizationUsageResponse) UnmarshalJSON(data []byte) error

type PreflightRequest added in v3.5.4 

type PreflightRequest struct {
	NamespaceName string `json:"namespace_name"`
}

func (*PreflightRequest) GetNamespaceName added in v3.5.4 

func (o *PreflightRequest) GetNamespaceName() string

type PreflightToken added in v3.5.3 

type PreflightToken struct {
	AuthToken *string `json:"auth_token,omitempty"`
}

A PreflightToken is a token that allows access to the OCI distribution endpoints.

func (*PreflightToken) GetAuthToken added in v3.5.4 

func (o *PreflightToken) GetAuthToken() *string

type Report added in v3.5.5 

type Report struct {
	Type *Type `json:"type,omitempty"`
}

func (*Report) GetType added in v3.5.5 

func (o *Report) GetType() *Type

type RequestMetadata 

type RequestMetadata struct {
	Key   *string `json:"key,omitempty"`
	Value *string `json:"value,omitempty"`
}

RequestMetadata - Key-Value pairs associated with a request

func (*RequestMetadata) GetKey 

func (o *RequestMetadata) GetKey() *string

func (*RequestMetadata) GetValue 

func (o *RequestMetadata) GetValue() *string

type Revision added in v3.5.3 

type Revision struct {
	CreatedAt time.Time `json:"created_at"`
	Digest    string    `json:"digest"`
	// Format {namespace_id}/{revision_digest}
	ID            string    `json:"id"`
	NamespaceName string    `json:"namespace_name"`
	Tags          []string  `json:"tags"`
	UpdatedAt     time.Time `json:"updated_at"`
}

func (*Revision) GetCreatedAt added in v3.5.3 

func (o *Revision) GetCreatedAt() time.Time

func (*Revision) GetDigest added in v3.5.5 

func (o *Revision) GetDigest() string

func (*Revision) GetID added in v3.5.3 

func (o *Revision) GetID() string

func (*Revision) GetNamespaceName added in v3.5.4 

func (o *Revision) GetNamespaceName() string

func (*Revision) GetTags added in v3.5.3 

func (o *Revision) GetTags() []string

func (*Revision) GetUpdatedAt added in v3.5.3 

func (o *Revision) GetUpdatedAt() time.Time

func (Revision) MarshalJSON added in v3.5.3 

func (r Revision) MarshalJSON() ([]byte, error)

func (*Revision) UnmarshalJSON added in v3.5.3 

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

type Schema 

type Schema struct {
	// The ID of the Api this Schema belongs to.
	APIID string `json:"api_id"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at"`
	// A detailed description of the Schema.
	Description string `json:"description"`
	// An ID referencing this particular revision of the Schema.
	RevisionID string `json:"revision_id"`
	// The version ID of the Api this Schema belongs to.
	VersionID string `json:"version_id"`
	// The workspace ID this Schema belongs to.
	WorkspaceID string `json:"workspace_id"`
}

A Schema represents an API schema for a particular Api and Version.

func (*Schema) GetAPIID 

func (o *Schema) GetAPIID() string

func (*Schema) GetCreatedAt 

func (o *Schema) GetCreatedAt() time.Time

func (*Schema) GetDescription 

func (o *Schema) GetDescription() string

func (*Schema) GetRevisionID 

func (o *Schema) GetRevisionID() string

func (*Schema) GetVersionID 

func (o *Schema) GetVersionID() string

func (*Schema) GetWorkspaceID 

func (o *Schema) GetWorkspaceID() string

func (Schema) MarshalJSON 

func (s Schema) MarshalJSON() ([]byte, error)

func (*Schema) UnmarshalJSON 

func (s *Schema) UnmarshalJSON(data []byte) error

type SchemaDiff 

type SchemaDiff struct {
	// Holds every addition change in the diff.
	Additions []string `json:"additions"`
	// Holds every deletion change in the diff.
	Deletions []string `json:"deletions"`
	// Holds every modification change in the diff.
	Modifications map[string]ValueChange `json:"modifications"`
}

A SchemaDiff represents a diff of two Schemas.

func (*SchemaDiff) GetAdditions 

func (o *SchemaDiff) GetAdditions() []string

func (*SchemaDiff) GetDeletions 

func (o *SchemaDiff) GetDeletions() []string

func (*SchemaDiff) GetModifications 

func (o *SchemaDiff) GetModifications() map[string]ValueChange

type Security 

type Security struct {
	APIKey *string `security:"scheme,type=apiKey,subtype=header,name=x-api-key"`
	Bearer *string `security:"scheme,type=http,subtype=bearer,name=Authorization"`
}

func (*Security) GetAPIKey 

func (o *Security) GetAPIKey() *string

func (*Security) GetBearer added in v3.3.8 

func (o *Security) GetBearer() *string

type ShortURL added in v3.9.0 

type ShortURL struct {
	FullURL  string `json:"full_url"`
	ShortURL string `json:"short_url"`
}

func (*ShortURL) GetFullURL added in v3.9.0 

func (o *ShortURL) GetFullURL() string

func (*ShortURL) GetShortURL added in v3.9.0 

func (o *ShortURL) GetShortURL() string

type Style added in v3.8.9 

type Style string
const (
	StyleStandardize Style = "standardize"
	StyleResource    Style = "resource"
)

func (Style) ToPointer added in v3.8.9 

func (e Style) ToPointer() *Style

func (*Style) UnmarshalJSON added in v3.8.9 

func (e *Style) UnmarshalJSON(data []byte) error

type SuggestOperationIDsOpts added in v3.8.9 

type SuggestOperationIDsOpts struct {
	DepthStyle *DepthStyle `json:"depth_style,omitempty"`
	Style      *Style      `json:"style,omitempty"`
}

func (*SuggestOperationIDsOpts) GetDepthStyle added in v3.8.9 

func (o *SuggestOperationIDsOpts) GetDepthStyle() *DepthStyle

func (*SuggestOperationIDsOpts) GetStyle added in v3.8.9 

func (o *SuggestOperationIDsOpts) GetStyle() *Style

type SuggestedOperationIDs added in v3.8.9 

type SuggestedOperationIDs struct {
	OperationIds map[string][]string `json:"operation_ids"`
}

func (*SuggestedOperationIDs) GetOperationIds added in v3.8.9 

func (o *SuggestedOperationIDs) GetOperationIds() map[string][]string

type Tag added in v3.5.4 

type Tag struct {
	// Format {namespace_id}/{tag}
	ID string `json:"id"`
	// Human readable tag name
	Name           string `json:"name"`
	NamespaceName  string `json:"namespace_name"`
	RevisionDigest string `json:"revision_digest"`
}

func (*Tag) GetID added in v3.5.4 

func (o *Tag) GetID() string

func (*Tag) GetName added in v3.5.5 

func (o *Tag) GetName() string

func (*Tag) GetNamespaceName added in v3.5.4 

func (o *Tag) GetNamespaceName() string

func (*Tag) GetRevisionDigest added in v3.5.5 

func (o *Tag) GetRevisionDigest() string

type TargetSDK added in v3.3.8 

type TargetSDK struct {
	// Remote commit ID.
	CommitHead *string `json:"commit_head,omitempty"`
	// Name of the CI environment.
	ContinuousIntegrationEnvironment *string `json:"continuous_integration_environment,omitempty"`
	// Error message if the last event was not successful.
	Error *string `json:"error,omitempty"`
	// Version of the generated target (post generation)
	GenerateConfigPostVersion *string `json:"generate_config_post_version,omitempty"`
	// Eligible feature set during generation
	GenerateEligibleFeatures *string `json:"generate_eligible_features,omitempty"`
	// gen.lock ID (expected to be a uuid). The same as `id`. A unique identifier for the target.
	GenerateGenLockID string `json:"generate_gen_lock_id"`
	// Features prior to generation
	GenerateGenLockPreFeatures *string `json:"generate_gen_lock_pre_features,omitempty"`
	// Artifact version for the Previous Generation
	GenerateGenLockPreVersion *string `json:"generate_gen_lock_pre_version,omitempty"`
	// The number of operations ignored in generation.
	GenerateNumberOfOperationsIgnored *int64 `json:"generate_number_of_operations_ignored,omitempty"`
	// The number of operations used in generation.
	GenerateNumberOfOperationsUsed *int64 `json:"generate_number_of_operations_used,omitempty"`
	// Indicates whether the target was considered published.
	GeneratePublished *bool `json:"generate_published,omitempty"`
	// eg `typescript`, `terraform`, `python`
	GenerateTarget string `json:"generate_target"`
	// The workflow name of the target.
	GenerateTargetName *string `json:"generate_target_name,omitempty"`
	// The version of the Speakeasy generator for this target eg v2 of the typescript generator.
	GenerateTargetVersion *string `json:"generate_target_version,omitempty"`
	// GitHub organization of the action.
	GhActionOrganization *string `json:"gh_action_organization,omitempty"`
	// GitHub Action ref value.
	GhActionRef *string `json:"gh_action_ref,omitempty"`
	// GitHub repository of the action.
	GhActionRepository *string `json:"gh_action_repository,omitempty"`
	// Link to the GitHub action run.
	GhActionRunLink *string `json:"gh_action_run_link,omitempty"`
	// Version of the GitHub action.
	GhActionVersion *string `json:"gh_action_version,omitempty"`
	// Current working directory relative to the git root.
	GitRelativeCwd *string `json:"git_relative_cwd,omitempty"`
	// Default owner for git remote.
	GitRemoteDefaultOwner *string `json:"git_remote_default_owner,omitempty"`
	// Default repository name for git remote.
	GitRemoteDefaultRepo *string `json:"git_remote_default_repo,omitempty"`
	// User email from git configuration.
	GitUserEmail *string `json:"git_user_email,omitempty"`
	// User's name from git configuration. (not GitHub username)
	GitUserName *string `json:"git_user_name,omitempty"`
	// Remote hostname.
	Hostname *string `json:"hostname,omitempty"`
	// Unique identifier of the target the same as `generate_gen_lock_id`
	ID string `json:"id"`
	// Timestamp when the event was created in the database.
	LastEventCreatedAt time.Time `json:"last_event_created_at"`
	// Unique identifier of the last event for the target
	LastEventID string `json:"last_event_id"`
	// Type of interaction.
	LastEventInteractionType InteractionType `json:"last_event_interaction_type"`
	// Label of the git repository.
	RepoLabel *string `json:"repo_label,omitempty"`
	// The blob digest of the source.
	SourceBlobDigest *string `json:"source_blob_digest,omitempty"`
	// The namespace name of the source.
	SourceNamespaceName *string `json:"source_namespace_name,omitempty"`
	// The revision digest of the source.
	SourceRevisionDigest *string `json:"source_revision_digest,omitempty"`
	// Indicates whether the event was successful.
	Success *bool `json:"success,omitempty"`
	// Workflow file (post execution)
	WorkflowPostRaw *string `json:"workflow_post_raw,omitempty"`
	// Workflow file (prior to execution)
	WorkflowPreRaw *string `json:"workflow_pre_raw,omitempty"`
}

func (*TargetSDK) GetCommitHead added in v3.3.8 

func (o *TargetSDK) GetCommitHead() *string

func (*TargetSDK) GetContinuousIntegrationEnvironment added in v3.3.13 

func (o *TargetSDK) GetContinuousIntegrationEnvironment() *string

func (*TargetSDK) GetError added in v3.5.10 

func (o *TargetSDK) GetError() *string

func (*TargetSDK) GetGenerateConfigPostVersion added in v3.3.8 

func (o *TargetSDK) GetGenerateConfigPostVersion() *string

func (*TargetSDK) GetGenerateEligibleFeatures added in v3.7.1 

func (o *TargetSDK) GetGenerateEligibleFeatures() *string

func (*TargetSDK) GetGenerateGenLockID added in v3.3.8 

func (o *TargetSDK) GetGenerateGenLockID() string

func (*TargetSDK) GetGenerateGenLockPreFeatures added in v3.3.13 

func (o *TargetSDK) GetGenerateGenLockPreFeatures() *string

func (*TargetSDK) GetGenerateGenLockPreVersion added in v3.3.13 

func (o *TargetSDK) GetGenerateGenLockPreVersion() *string

func (*TargetSDK) GetGenerateNumberOfOperationsIgnored added in v3.7.1 

func (o *TargetSDK) GetGenerateNumberOfOperationsIgnored() *int64

func (*TargetSDK) GetGenerateNumberOfOperationsUsed added in v3.7.1 

func (o *TargetSDK) GetGenerateNumberOfOperationsUsed() *int64

func (*TargetSDK) GetGeneratePublished added in v3.3.8 

func (o *TargetSDK) GetGeneratePublished() *bool

func (*TargetSDK) GetGenerateTarget added in v3.3.8 

func (o *TargetSDK) GetGenerateTarget() string

func (*TargetSDK) GetGenerateTargetName added in v3.3.10 

func (o *TargetSDK) GetGenerateTargetName() *string

func (*TargetSDK) GetGenerateTargetVersion added in v3.3.8 

func (o *TargetSDK) GetGenerateTargetVersion() *string

func (*TargetSDK) GetGhActionOrganization added in v3.3.9 

func (o *TargetSDK) GetGhActionOrganization() *string

func (*TargetSDK) GetGhActionRef added in v3.7.1 

func (o *TargetSDK) GetGhActionRef() *string

func (*TargetSDK) GetGhActionRepository added in v3.3.9 

func (o *TargetSDK) GetGhActionRepository() *string
func (o *TargetSDK) GetGhActionRunLink() *string

func (*TargetSDK) GetGhActionVersion added in v3.3.9 

func (o *TargetSDK) GetGhActionVersion() *string

func (*TargetSDK) GetGitRelativeCwd added in v3.3.8 

func (o *TargetSDK) GetGitRelativeCwd() *string

func (*TargetSDK) GetGitRemoteDefaultOwner added in v3.3.8 

func (o *TargetSDK) GetGitRemoteDefaultOwner() *string

func (*TargetSDK) GetGitRemoteDefaultRepo added in v3.3.8 

func (o *TargetSDK) GetGitRemoteDefaultRepo() *string

func (*TargetSDK) GetGitUserEmail added in v3.3.9 

func (o *TargetSDK) GetGitUserEmail() *string

func (*TargetSDK) GetGitUserName added in v3.3.9 

func (o *TargetSDK) GetGitUserName() *string

func (*TargetSDK) GetHostname added in v3.3.9 

func (o *TargetSDK) GetHostname() *string

func (*TargetSDK) GetID added in v3.3.8 

func (o *TargetSDK) GetID() string

func (*TargetSDK) GetLastEventCreatedAt added in v3.3.9 

func (o *TargetSDK) GetLastEventCreatedAt() time.Time

func (*TargetSDK) GetLastEventID added in v3.3.9 

func (o *TargetSDK) GetLastEventID() string

func (*TargetSDK) GetLastEventInteractionType added in v3.4.0 

func (o *TargetSDK) GetLastEventInteractionType() InteractionType

func (*TargetSDK) GetRepoLabel added in v3.3.9 

func (o *TargetSDK) GetRepoLabel() *string

func (*TargetSDK) GetSourceBlobDigest added in v3.5.8 

func (o *TargetSDK) GetSourceBlobDigest() *string

func (*TargetSDK) GetSourceNamespaceName added in v3.5.8 

func (o *TargetSDK) GetSourceNamespaceName() *string

func (*TargetSDK) GetSourceRevisionDigest added in v3.5.8 

func (o *TargetSDK) GetSourceRevisionDigest() *string

func (*TargetSDK) GetSuccess added in v3.3.8 

func (o *TargetSDK) GetSuccess() *bool

func (*TargetSDK) GetWorkflowPostRaw added in v3.8.9 

func (o *TargetSDK) GetWorkflowPostRaw() *string

func (*TargetSDK) GetWorkflowPreRaw added in v3.8.9 

func (o *TargetSDK) GetWorkflowPreRaw() *string

func (TargetSDK) MarshalJSON added in v3.3.8 

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

func (*TargetSDK) UnmarshalJSON added in v3.3.8 

func (t *TargetSDK) UnmarshalJSON(data []byte) error

type Type added in v3.5.5 

type Type string
const (
	TypeLinting Type = "linting"
	TypeChanges Type = "changes"
)

func (Type) ToPointer added in v3.5.5 

func (e Type) ToPointer() *Type

func (*Type) UnmarshalJSON added in v3.5.5 

func (e *Type) UnmarshalJSON(data []byte) error

type UnboundedRequest 

type UnboundedRequest struct {
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at"`
	// The HAR content of the request.
	Har string `json:"har"`
	// The size of the HAR content in bytes.
	HarSizeBytes int64 `json:"har_size_bytes"`
	// The ID of this request.
	RequestID string `json:"request_id"`
	// The workspace ID this request was made to.
	WorkspaceID string `json:"workspace_id"`
}

An UnboundedRequest represents the HAR content capture by Speakeasy when logging a request.

func (*UnboundedRequest) GetCreatedAt 

func (o *UnboundedRequest) GetCreatedAt() time.Time

func (*UnboundedRequest) GetHar 

func (o *UnboundedRequest) GetHar() string

func (*UnboundedRequest) GetHarSizeBytes 

func (o *UnboundedRequest) GetHarSizeBytes() int64

func (*UnboundedRequest) GetRequestID 

func (o *UnboundedRequest) GetRequestID() string

func (*UnboundedRequest) GetWorkspaceID 

func (o *UnboundedRequest) GetWorkspaceID() string

func (UnboundedRequest) MarshalJSON 

func (u UnboundedRequest) MarshalJSON() ([]byte, error)

func (*UnboundedRequest) UnmarshalJSON 

func (u *UnboundedRequest) UnmarshalJSON(data []byte) error

type User added in v3.3.11 

type User struct {
	// Indicates whether the user is an admin.
	Admin bool `json:"admin"`
	// Indicates whether the user has been confirmed.
	Confirmed bool `json:"confirmed"`
	// Timestamp of the user's creation.
	CreatedAt time.Time `json:"created_at"`
	// Identifier of the default workspace.
	DefaultWorkspaceID *string `json:"default_workspace_id,omitempty"`
	// Display name of the user.
	DisplayName string `json:"display_name"`
	// Email address of the user.
	Email string `json:"email"`
	// Indicates whether the email address has been verified.
	EmailVerified bool `json:"email_verified"`
	// GitHub handle of the user.
	GithubHandle *string `json:"github_handle,omitempty"`
	// Unique identifier for the user.
	ID string `json:"id"`
	// Timestamp of the last login.
	LastLoginAt time.Time `json:"last_login_at"`
	// URL of the user's photo.
	PhotoURL *string `json:"photo_url,omitempty"`
	// Timestamp of the user's last update.
	UpdatedAt time.Time `json:"updated_at"`
	// Indicates whether the user has been whitelisted.
	Whitelisted bool `json:"whitelisted"`
}

func (*User) GetAdmin added in v3.3.11 

func (o *User) GetAdmin() bool

func (*User) GetConfirmed added in v3.4.6 

func (o *User) GetConfirmed() bool

func (*User) GetCreatedAt added in v3.3.11 

func (o *User) GetCreatedAt() time.Time

func (*User) GetDefaultWorkspaceID added in v3.4.6 

func (o *User) GetDefaultWorkspaceID() *string

func (*User) GetDisplayName added in v3.3.11 

func (o *User) GetDisplayName() string

func (*User) GetEmail added in v3.3.11 

func (o *User) GetEmail() string

func (*User) GetEmailVerified added in v3.3.11 

func (o *User) GetEmailVerified() bool

func (*User) GetGithubHandle added in v3.4.6 

func (o *User) GetGithubHandle() *string

func (*User) GetID added in v3.3.11 

func (o *User) GetID() string

func (*User) GetLastLoginAt added in v3.4.6 

func (o *User) GetLastLoginAt() time.Time

func (*User) GetPhotoURL added in v3.4.6 

func (o *User) GetPhotoURL() *string

func (*User) GetUpdatedAt added in v3.4.6 

func (o *User) GetUpdatedAt() time.Time

func (*User) GetWhitelisted added in v3.4.6 

func (o *User) GetWhitelisted() bool

func (User) MarshalJSON added in v3.3.11 

func (u User) MarshalJSON() ([]byte, error)

func (*User) UnmarshalJSON added in v3.3.11 

func (u *User) UnmarshalJSON(data []byte) error

type V2Descriptor added in v3.5.4 

type V2Descriptor struct {
	// Annotations
	Annotations *Annotations `json:"annotations,omitempty"`
	// Digest
	Digest *string `json:"digest,omitempty"`
	// Media type
	MediaType *string `json:"mediaType,omitempty"`
	// Size
	Size *int64 `json:"size,omitempty"`
}

V2Descriptor - V2 descriptor

func (*V2Descriptor) GetAnnotations added in v3.5.4 

func (o *V2Descriptor) GetAnnotations() *Annotations

func (*V2Descriptor) GetDigest added in v3.5.4 

func (o *V2Descriptor) GetDigest() *string

func (*V2Descriptor) GetMediaType added in v3.5.4 

func (o *V2Descriptor) GetMediaType() *string

func (*V2Descriptor) GetSize added in v3.5.4 

func (o *V2Descriptor) GetSize() *int64

type ValueChange 

type ValueChange struct {
	// Represents the previous value of the element.
	From string `json:"From"`
	// Represents the current value of the element.
	To string `json:"To"`
}

func (*ValueChange) GetFrom 

func (o *ValueChange) GetFrom() string

func (*ValueChange) GetTo 

func (o *ValueChange) GetTo() string

type VersionMetadata 

type VersionMetadata struct {
	// The ID of the Api this Metadata belongs to.
	APIID string `json:"api_id"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at"`
	// The key for this metadata.
	MetaKey string `json:"meta_key"`
	// One of the values for this metadata.
	MetaValue string `json:"meta_value"`
	// The version ID of the Api this Metadata belongs to.
	VersionID string `json:"version_id"`
	// The workspace ID this Metadata belongs to.
	WorkspaceID string `json:"workspace_id"`
}

VersionMetadata - A set of keys and associated values, attached to a particular version of an Api.

func (*VersionMetadata) GetAPIID 

func (o *VersionMetadata) GetAPIID() string

func (*VersionMetadata) GetCreatedAt 

func (o *VersionMetadata) GetCreatedAt() time.Time

func (*VersionMetadata) GetMetaKey 

func (o *VersionMetadata) GetMetaKey() string

func (*VersionMetadata) GetMetaValue 

func (o *VersionMetadata) GetMetaValue() string

func (*VersionMetadata) GetVersionID 

func (o *VersionMetadata) GetVersionID() string

func (*VersionMetadata) GetWorkspaceID 

func (o *VersionMetadata) GetWorkspaceID() string

func (VersionMetadata) MarshalJSON 

func (v VersionMetadata) MarshalJSON() ([]byte, error)

func (*VersionMetadata) UnmarshalJSON 

func (v *VersionMetadata) UnmarshalJSON(data []byte) error

type VersionMetadataInput 

type VersionMetadataInput struct {
	// The key for this metadata.
	MetaKey string `json:"meta_key"`
	// One of the values for this metadata.
	MetaValue string `json:"meta_value"`
}

VersionMetadataInput - A set of keys and associated values, attached to a particular version of an Api.

func (*VersionMetadataInput) GetMetaKey 

func (o *VersionMetadataInput) GetMetaKey() string

func (*VersionMetadataInput) GetMetaValue 

func (o *VersionMetadataInput) GetMetaValue() string

type WorkflowDocument added in v3.8.9 

type WorkflowDocument struct {
	Auth     *Auth  `json:"auth,omitempty"`
	Location string `json:"location"`
}

WorkflowDocument - A document referenced by a workflow

func (*WorkflowDocument) GetAuth added in v3.8.9 

func (o *WorkflowDocument) GetAuth() *Auth

func (*WorkflowDocument) GetLocation added in v3.8.9 

func (o *WorkflowDocument) GetLocation() string

type Workspaces added in v3.3.11 

type Workspaces struct {
	AccountType *AccessTokenAccountType `json:"account_type,omitempty"`
	ID          *string                 `json:"id,omitempty"`
	Name        *string                 `json:"name,omitempty"`
	UpdatedAt   *time.Time              `json:"updated_at,omitempty"`
}

func (*Workspaces) GetAccountType added in v3.5.5 

func (o *Workspaces) GetAccountType() *AccessTokenAccountType

func (*Workspaces) GetID added in v3.5.5 

func (o *Workspaces) GetID() *string

func (*Workspaces) GetName added in v3.5.5 

func (o *Workspaces) GetName() *string

func (*Workspaces) GetUpdatedAt added in v3.5.5 

func (o *Workspaces) GetUpdatedAt() *time.Time

func (Workspaces) MarshalJSON added in v3.5.5 

func (w Workspaces) MarshalJSON() ([]byte, error)

func (*Workspaces) UnmarshalJSON added in v3.5.5 

func (w *Workspaces) UnmarshalJSON(data []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

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