api

README

Flatfile Go Library

The Flatfile Go library provides convenient access to the Flatfile API from Go.

Documentation

API reference documentation is available here.

Requirements

This module requires Go version >= 1.13.

Installation

Run the following command to use the Flatfile Go library in your module:

go get github.com/FlatFilers/flatfile-go

Usage

import flatfileclient "github.com/FlatFilers/flatfile-go/client"

client := flatfileclient.NewClient(flatfileclient.WithToken("<YOUR_AUTH_TOKEN>"))

Create Environment

import (
  flatfile       "github.com/FlatFilers/flatfile-go"
  flatfileclient "github.com/FlatFilers/flatfile-go/client"
)

client := flatfileclient.NewClient(flatfileclient.WithToken("<YOUR_AUTH_TOKEN>"))
response, err := client.Environments.Create(
  context.TODO(),
  &flatfile.EnvironmentConfigCreate{
    Name:   "development",
    IsProd: false,
  },
)

Timeouts

Setting a timeout for each individual request is as simple as using the standard context library. Setting a one second timeout for an individual API call looks like the following:

ctx, cancel := context.WithTimeout(context.TODO(), time.Second)
defer cancel()

response, err := client.Environments.Create(
  context.TODO(),
  &flatfile.EnvironmentConfigCreate{
    Name:   "development",
    IsProd: false,
  },
)

Client Options

A variety of client options are included to adapt the behavior of the library, which includes configuring authorization tokens to be sent on every request, or providing your own instrumented *http.Client. Both of these options are shown below:

client := flatfileclient.NewClient(
  flatfileclient.WithToken("<YOUR_AUTH_TOKEN>"),
  flatfileclient.WithHTTPClient(
    &http.Client{
      Timeout: 5 * time.Second,
    },
  ),
)

Providing your own *http.Client is recommended. Otherwise, the http.DefaultClient will be used, and your client will wait indefinitely for a response (unless the per-request, context-based timeout is used).

Errors

Structured error types are returned from API calls that return non-success status codes. For example, you can check if the error was due to a bad request (i.e. status code 400) with the following:

response, err := client.Environments.GetEnvironmentEventToken(
  context.TODO(),
  &flatfile.GetEnvironmentEventTokenRequest{
    EnvironmentId: "invalid-id",
  },
)
if err != nil {
  if badRequestErr, ok := err.(*flatfile.BadRequestError);
    // Do something with the bad request ...
  }
  return err
}

These errors are also compatible with the errors.Is and errors.As APIs, so you can access the error like so:

response, err := client.Environments.GetEnvironmentEventToken(
  context.TODO(),
  &flatfile.GetEnvironmentEventTokenRequest{
    EnvironmentId: "invalid-id",
  },
)
if err != nil {
  var badRequestErr *flatfile.BadRequestError
  if errors.As(err, badRequestErr) {
    // Do something with the bad request ...
  }
  return err
}

If you'd like to wrap the errors with additional information and still retain the ability to access the type with errors.Is and errors.As, you can use the %w directive:

response, err := client.Environments.GetEnvironmentEventToken(
  context.TODO(),
  &flatfile.GetEnvironmentEventTokenRequest{
    EnvironmentId: "invalid-id",
  },
)
if err != nil {
  return fmt.Errorf("failed to generate response: %w", err)
}

Beta Status

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version. This way, you can install the same version each time without breaking changes.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

Documentation

Index

• func Bool(b bool) *bool
• func Byte(b byte) *byte
• func Complex128(c complex128) *complex128
• func Complex64(c complex64) *complex64
• func Float32(f float32) *float32
• func Float64(f float64) *float64
• func Int(i int) *int
• func Int16(i int16) *int16
• func Int32(i int32) *int32
• func Int64(i int64) *int64
• func Int8(i int8) *int8
• func MustParseDate(date string) time.Time
• func MustParseDateTime(datetime string) time.Time
• func Rune(r rune) *rune
• func String(s string) *string
• func Time(t time.Time) *time.Time
• func UUID(u uuid.UUID) *uuid.UUID
• func Uint(u uint) *uint
• func Uint16(u uint16) *uint16
• func Uint32(u uint32) *uint32
• func Uint64(u uint64) *uint64
• func Uint8(u uint8) *uint8
• func Uintptr(u uintptr) *uintptr
• type Account
  • func (a *Account) GetCreatedAt() time.Time
  • func (a *Account) GetCustomFromEmail() *string
  • func (a *Account) GetDashboard() *int
  • func (a *Account) GetDefaultAppId() *AppId
  • func (a *Account) GetEmbeddedDomainWhitelist() []string
  • func (a *Account) GetExtraProperties() map[string]interface{}
  • func (a *Account) GetId() AccountId
  • func (a *Account) GetMetadata() map[string]interface{}
  • func (a *Account) GetName() string
  • func (a *Account) GetStripeCustomerId() *string
  • func (a *Account) GetSubdomain() *string
  • func (a *Account) GetUpdatedAt() time.Time
  • func (a *Account) GetVanityDomainDashboard() *string
  • func (a *Account) GetVanityDomainSpaces() *string
  • func (a *Account) MarshalJSON() ([]byte, error)
  • func (a *Account) String() string
  • func (a *Account) UnmarshalJSON(data []byte) error
• type AccountId
• type AccountPatch
  • func (a *AccountPatch) GetDefaultAppId() AppId
  • func (a *AccountPatch) GetExtraProperties() map[string]interface{}
  • func (a *AccountPatch) String() string
  • func (a *AccountPatch) UnmarshalJSON(data []byte) error
• type AccountResponse
  • func (a *AccountResponse) GetData() *Account
  • func (a *AccountResponse) GetExtraProperties() map[string]interface{}
  • func (a *AccountResponse) String() string
  • func (a *AccountResponse) UnmarshalJSON(data []byte) error
• type Action
  • func (a *Action) GetConfirm() *bool
  • func (a *Action) GetConstraints() []*ActionConstraint
  • func (a *Action) GetDescription() *string
  • func (a *Action) GetExtraProperties() map[string]interface{}
  • func (a *Action) GetGuardrail() *Guardrail
  • func (a *Action) GetGuide() *Guide
  • func (a *Action) GetIcon() *string
  • func (a *Action) GetInputForm() *InputForm
  • func (a *Action) GetLabel() string
  • func (a *Action) GetMessages() []*ActionMessage
  • func (a *Action) GetMode() *ActionMode
  • func (a *Action) GetMount() *ActionMount
  • func (a *Action) GetOperation() *string
  • func (a *Action) GetPrimary() *bool
  • func (a *Action) GetRequireAllValid() *bool
  • func (a *Action) GetRequireSelection() *bool
  • func (a *Action) GetSchedule() *ActionSchedule
  • func (a *Action) GetSlug() *string
  • func (a *Action) GetTooltip() *string
  • func (a *Action) GetType() *string
  • func (a *Action) String() string
  • func (a *Action) UnmarshalJSON(data []byte) error
• type ActionConstraint
  • func NewActionConstraintFromHasAllValid(value *ActionConstraintHasAllValid) *ActionConstraint
  • func NewActionConstraintFromHasColumnEnabled(value *ActionConstraintHasColumnEnabled) *ActionConstraint
  • func NewActionConstraintFromHasData(value *ActionConstraintHasData) *ActionConstraint
  • func NewActionConstraintFromHasSelection(value *ActionConstraintHasSelection) *ActionConstraint
  • func (a *ActionConstraint) Accept(visitor ActionConstraintVisitor) error
  • func (a *ActionConstraint) GetHasAllValid() *ActionConstraintHasAllValid
  • func (a *ActionConstraint) GetHasColumnEnabled() *ActionConstraintHasColumnEnabled
  • func (a *ActionConstraint) GetHasData() *ActionConstraintHasData
  • func (a *ActionConstraint) GetHasSelection() *ActionConstraintHasSelection
  • func (a *ActionConstraint) GetType() string
  • func (a ActionConstraint) MarshalJSON() ([]byte, error)
  • func (a *ActionConstraint) UnmarshalJSON(data []byte) error
• type ActionConstraintHasAllValid
  • func (a *ActionConstraintHasAllValid) GetExtraProperties() map[string]interface{}
  • func (a *ActionConstraintHasAllValid) GetIgnoreSelection() *bool
  • func (a *ActionConstraintHasAllValid) String() string
  • func (a *ActionConstraintHasAllValid) UnmarshalJSON(data []byte) error
• type ActionConstraintHasColumnEnabled
  • func (a *ActionConstraintHasColumnEnabled) GetExtraProperties() map[string]interface{}
  • func (a *ActionConstraintHasColumnEnabled) String() string
  • func (a *ActionConstraintHasColumnEnabled) UnmarshalJSON(data []byte) error
• type ActionConstraintHasData
  • func (a *ActionConstraintHasData) GetExtraProperties() map[string]interface{}
  • func (a *ActionConstraintHasData) String() string
  • func (a *ActionConstraintHasData) UnmarshalJSON(data []byte) error
• type ActionConstraintHasSelection
  • func (a *ActionConstraintHasSelection) GetExtraProperties() map[string]interface{}
  • func (a *ActionConstraintHasSelection) String() string
  • func (a *ActionConstraintHasSelection) UnmarshalJSON(data []byte) error
• type ActionConstraintVisitor
• type ActionCreateRequest
  • func (a *ActionCreateRequest) MarshalJSON() ([]byte, error)
  • func (a *ActionCreateRequest) UnmarshalJSON(data []byte) error
• type ActionId
• type ActionMessage
  • func (a *ActionMessage) GetContent() string
  • func (a *ActionMessage) GetExtraProperties() map[string]interface{}
  • func (a *ActionMessage) GetType() ActionMessageType
  • func (a *ActionMessage) String() string
  • func (a *ActionMessage) UnmarshalJSON(data []byte) error
• type ActionMessageType
  • func NewActionMessageTypeFromString(s string) (ActionMessageType, error)
  • func (a ActionMessageType) Ptr() *ActionMessageType
• type ActionMode
  • func NewActionModeFromString(s string) (ActionMode, error)
  • func (a ActionMode) Ptr() *ActionMode
• type ActionMount
  • func NewActionMountFromDocument(value *ActionMountDocument) *ActionMount
  • func NewActionMountFromField(value *ActionMountField) *ActionMount
  • func NewActionMountFromFile(value *ActionMountFile) *ActionMount
  • func NewActionMountFromSheet(value *ActionMountSheet) *ActionMount
  • func NewActionMountFromWorkbook(value *ActionMountWorkbook) *ActionMount
  • func (a *ActionMount) Accept(visitor ActionMountVisitor) error
  • func (a *ActionMount) GetDocument() *ActionMountDocument
  • func (a *ActionMount) GetField() *ActionMountField
  • func (a *ActionMount) GetFile() *ActionMountFile
  • func (a *ActionMount) GetSheet() *ActionMountSheet
  • func (a *ActionMount) GetType() string
  • func (a *ActionMount) GetWorkbook() *ActionMountWorkbook
  • func (a ActionMount) MarshalJSON() ([]byte, error)
  • func (a *ActionMount) UnmarshalJSON(data []byte) error
• type ActionMountDocument
  • func (a *ActionMountDocument) GetExtraProperties() map[string]interface{}
  • func (a *ActionMountDocument) String() string
  • func (a *ActionMountDocument) UnmarshalJSON(data []byte) error
• type ActionMountField
  • func (a *ActionMountField) GetExtraProperties() map[string]interface{}
  • func (a *ActionMountField) GetKeys() []string
  • func (a *ActionMountField) String() string
  • func (a *ActionMountField) UnmarshalJSON(data []byte) error
• type ActionMountFile
  • func (a *ActionMountFile) GetExtraProperties() map[string]interface{}
  • func (a *ActionMountFile) String() string
  • func (a *ActionMountFile) UnmarshalJSON(data []byte) error
• type ActionMountSheet
  • func (a *ActionMountSheet) GetExtraProperties() map[string]interface{}
  • func (a *ActionMountSheet) GetSlugs() []string
  • func (a *ActionMountSheet) String() string
  • func (a *ActionMountSheet) UnmarshalJSON(data []byte) error
• type ActionMountVisitor
• type ActionMountWorkbook
  • func (a *ActionMountWorkbook) GetExtraProperties() map[string]interface{}
  • func (a *ActionMountWorkbook) GetSlugs() []string
  • func (a *ActionMountWorkbook) String() string
  • func (a *ActionMountWorkbook) UnmarshalJSON(data []byte) error
• type ActionName
• type ActionSchedule
  • func NewActionScheduleFromString(s string) (ActionSchedule, error)
  • func (a ActionSchedule) Ptr() *ActionSchedule
• type ActionUpdate
  • func (a *ActionUpdate) GetConfirm() *bool
  • func (a *ActionUpdate) GetConstraints() []*ActionConstraint
  • func (a *ActionUpdate) GetDescription() *string
  • func (a *ActionUpdate) GetExtraProperties() map[string]interface{}
  • func (a *ActionUpdate) GetGuardrail() *Guardrail
  • func (a *ActionUpdate) GetGuide() *Guide
  • func (a *ActionUpdate) GetIcon() *string
  • func (a *ActionUpdate) GetInputForm() *InputForm
  • func (a *ActionUpdate) GetLabel() *string
  • func (a *ActionUpdate) GetMessages() []*ActionMessage
  • func (a *ActionUpdate) GetMode() *ActionMode
  • func (a *ActionUpdate) GetMount() *ActionMount
  • func (a *ActionUpdate) GetOperation() *string
  • func (a *ActionUpdate) GetPrimary() *bool
  • func (a *ActionUpdate) GetRequireAllValid() *bool
  • func (a *ActionUpdate) GetRequireSelection() *bool
  • func (a *ActionUpdate) GetSchedule() *ActionSchedule
  • func (a *ActionUpdate) GetSlug() *string
  • func (a *ActionUpdate) GetTooltip() *string
  • func (a *ActionUpdate) GetType() *string
  • func (a *ActionUpdate) String() string
  • func (a *ActionUpdate) UnmarshalJSON(data []byte) error
• type ActionWithoutLabel
  • func (a *ActionWithoutLabel) GetConfirm() *bool
  • func (a *ActionWithoutLabel) GetConstraints() []*ActionConstraint
  • func (a *ActionWithoutLabel) GetDescription() *string
  • func (a *ActionWithoutLabel) GetExtraProperties() map[string]interface{}
  • func (a *ActionWithoutLabel) GetGuardrail() *Guardrail
  • func (a *ActionWithoutLabel) GetGuide() *Guide
  • func (a *ActionWithoutLabel) GetIcon() *string
  • func (a *ActionWithoutLabel) GetInputForm() *InputForm
  • func (a *ActionWithoutLabel) GetMessages() []*ActionMessage
  • func (a *ActionWithoutLabel) GetMode() *ActionMode
  • func (a *ActionWithoutLabel) GetMount() *ActionMount
  • func (a *ActionWithoutLabel) GetOperation() *string
  • func (a *ActionWithoutLabel) GetPrimary() *bool
  • func (a *ActionWithoutLabel) GetRequireAllValid() *bool
  • func (a *ActionWithoutLabel) GetRequireSelection() *bool
  • func (a *ActionWithoutLabel) GetSchedule() *ActionSchedule
  • func (a *ActionWithoutLabel) GetSlug() *string
  • func (a *ActionWithoutLabel) GetTooltip() *string
  • func (a *ActionWithoutLabel) GetType() *string
  • func (a *ActionWithoutLabel) String() string
  • func (a *ActionWithoutLabel) UnmarshalJSON(data []byte) error
• type ActionsBulkCreateRequest
  • func (a *ActionsBulkCreateRequest) MarshalJSON() ([]byte, error)
  • func (a *ActionsBulkCreateRequest) UnmarshalJSON(data []byte) error
• type ActorIdUnion
  • func NewActorIdUnionFromAgentId(value AgentId) *ActorIdUnion
  • func NewActorIdUnionFromGuestId(value GuestId) *ActorIdUnion
  • func NewActorIdUnionFromUserId(value UserId) *ActorIdUnion
  • func (a *ActorIdUnion) Accept(visitor ActorIdUnionVisitor) error
  • func (a *ActorIdUnion) GetAgentId() AgentId
  • func (a *ActorIdUnion) GetGuestId() GuestId
  • func (a *ActorIdUnion) GetUserId() UserId
  • func (a ActorIdUnion) MarshalJSON() ([]byte, error)
  • func (a *ActorIdUnion) UnmarshalJSON(data []byte) error
• type ActorIdUnionVisitor
• type ActorRoleId
• type ActorRoleResponse
  • func (a *ActorRoleResponse) GetActorId() *ActorIdUnion
  • func (a *ActorRoleResponse) GetCreatedAt() time.Time
  • func (a *ActorRoleResponse) GetExtraProperties() map[string]interface{}
  • func (a *ActorRoleResponse) GetId() ActorRoleId
  • func (a *ActorRoleResponse) GetResourceId() *ResourceIdUnion
  • func (a *ActorRoleResponse) GetRoleId() RoleId
  • func (a *ActorRoleResponse) GetUpdatedAt() time.Time
  • func (a *ActorRoleResponse) MarshalJSON() ([]byte, error)
  • func (a *ActorRoleResponse) String() string
  • func (a *ActorRoleResponse) UnmarshalJSON(data []byte) error
• type AddRecordsToDataClipJobConfig
  • func (a *AddRecordsToDataClipJobConfig) GetDataClipId() DataClipId
  • func (a *AddRecordsToDataClipJobConfig) GetExtraProperties() map[string]interface{}
  • func (a *AddRecordsToDataClipJobConfig) GetSheetId() SheetId
  • func (a *AddRecordsToDataClipJobConfig) String() string
  • func (a *AddRecordsToDataClipJobConfig) UnmarshalJSON(data []byte) error
• type Agent
  • func (a *Agent) GetAccountId() AccountId
  • func (a *Agent) GetCompiler() *Compiler
  • func (a *Agent) GetCreatedAt() time.Time
  • func (a *Agent) GetEnvironmentId() EnvironmentId
  • func (a *Agent) GetExtraProperties() map[string]interface{}
  • func (a *Agent) GetId() AgentId
  • func (a *Agent) GetOptions() map[string]interface{}
  • func (a *Agent) GetSlug() *string
  • func (a *Agent) GetSource() *string
  • func (a *Agent) GetSourceMap() *string
  • func (a *Agent) GetTopics() []EventTopic
  • func (a *Agent) GetUpdatedAt() time.Time
  • func (a *Agent) MarshalJSON() ([]byte, error)
  • func (a *Agent) String() string
  • func (a *Agent) UnmarshalJSON(data []byte) error
• type AgentConfig
  • func (a *AgentConfig) GetCompiler() *Compiler
  • func (a *AgentConfig) GetExtraProperties() map[string]interface{}
  • func (a *AgentConfig) GetOptions() map[string]interface{}
  • func (a *AgentConfig) GetSlug() *string
  • func (a *AgentConfig) GetSource() *string
  • func (a *AgentConfig) GetSourceMap() *string
  • func (a *AgentConfig) GetTopics() []EventTopic
  • func (a *AgentConfig) String() string
  • func (a *AgentConfig) UnmarshalJSON(data []byte) error
• type AgentId
• type AgentLog
  • func (a *AgentLog) GetCompletedAt() string
  • func (a *AgentLog) GetCreatedAt() string
  • func (a *AgentLog) GetEventId() EventId
  • func (a *AgentLog) GetExtraProperties() map[string]interface{}
  • func (a *AgentLog) GetLog() *string
  • func (a *AgentLog) GetSuccess() bool
  • func (a *AgentLog) String() string
  • func (a *AgentLog) UnmarshalJSON(data []byte) error
• type AgentResponse
  • func (a *AgentResponse) GetData() *Agent
  • func (a *AgentResponse) GetExtraProperties() map[string]interface{}
  • func (a *AgentResponse) String() string
  • func (a *AgentResponse) UnmarshalJSON(data []byte) error
• type AgentVersion
  • func (a *AgentVersion) GetAgentId() AgentId
  • func (a *AgentVersion) GetCompiler() *Compiler
  • func (a *AgentVersion) GetCreatedAt() time.Time
  • func (a *AgentVersion) GetExtraProperties() map[string]interface{}
  • func (a *AgentVersion) GetId() AgentVersionId
  • func (a *AgentVersion) GetOptions() map[string]interface{}
  • func (a *AgentVersion) GetOrigin() int
  • func (a *AgentVersion) GetSlug() *string
  • func (a *AgentVersion) GetSource() *string
  • func (a *AgentVersion) GetSourceMap() *string
  • func (a *AgentVersion) GetTopics() []EventTopic
  • func (a *AgentVersion) GetUpdatedAt() time.Time
  • func (a *AgentVersion) GetVersion() int
  • func (a *AgentVersion) MarshalJSON() ([]byte, error)
  • func (a *AgentVersion) String() string
  • func (a *AgentVersion) UnmarshalJSON(data []byte) error
• type AgentVersionId
• type AgentVersionResponse
  • func (a *AgentVersionResponse) GetData() *AgentVersion
  • func (a *AgentVersionResponse) GetExtraProperties() map[string]interface{}
  • func (a *AgentVersionResponse) String() string
  • func (a *AgentVersionResponse) UnmarshalJSON(data []byte) error
• type AiGenerateBlueprintConstraintsJobConfig
  • func (a *AiGenerateBlueprintConstraintsJobConfig) GetExtraProperties() map[string]interface{}
  • func (a *AiGenerateBlueprintConstraintsJobConfig) GetSpaceId() SpaceId
  • func (a *AiGenerateBlueprintConstraintsJobConfig) GetWorkbookId() WorkbookId
  • func (a *AiGenerateBlueprintConstraintsJobConfig) String() string
  • func (a *AiGenerateBlueprintConstraintsJobConfig) UnmarshalJSON(data []byte) error
• type AiGenerateBlueprintJobConfig
  • func (a *AiGenerateBlueprintJobConfig) GetAppId() AppId
  • func (a *AiGenerateBlueprintJobConfig) GetExtraProperties() map[string]interface{}
  • func (a *AiGenerateBlueprintJobConfig) GetSpaceId() SpaceId
  • func (a *AiGenerateBlueprintJobConfig) String() string
  • func (a *AiGenerateBlueprintJobConfig) UnmarshalJSON(data []byte) error
• type AiGenerateConstraintJobConfig
  • func (a *AiGenerateConstraintJobConfig) GetConstraints() []*StoredConstraint
  • func (a *AiGenerateConstraintJobConfig) GetDescription() *string
  • func (a *AiGenerateConstraintJobConfig) GetExtraProperties() map[string]interface{}
  • func (a *AiGenerateConstraintJobConfig) GetSpaceId() SpaceId
  • func (a *AiGenerateConstraintJobConfig) String() string
  • func (a *AiGenerateConstraintJobConfig) UnmarshalJSON(data []byte) error
• type AiGenerateSampleDataJobConfig
  • func (a *AiGenerateSampleDataJobConfig) GetAppId() AppId
  • func (a *AiGenerateSampleDataJobConfig) GetExtraProperties() map[string]interface{}
  • func (a *AiGenerateSampleDataJobConfig) GetSpaceId() SpaceId
  • func (a *AiGenerateSampleDataJobConfig) String() string
  • func (a *AiGenerateSampleDataJobConfig) UnmarshalJSON(data []byte) error
• type AiRuleCreationJobConfig
  • func (a *AiRuleCreationJobConfig) GetExtraProperties() map[string]interface{}
  • func (a *AiRuleCreationJobConfig) GetFieldKey() string
  • func (a *AiRuleCreationJobConfig) GetIndex() *int
  • func (a *AiRuleCreationJobConfig) GetLabel() *string
  • func (a *AiRuleCreationJobConfig) GetPrompt() string
  • func (a *AiRuleCreationJobConfig) GetSheetId() SheetId
  • func (a *AiRuleCreationJobConfig) String() string
  • func (a *AiRuleCreationJobConfig) UnmarshalJSON(data []byte) error
• type ApiAction
  • func (a *ApiAction) GetConfirm() *bool
  • func (a *ApiAction) GetConstraints() []*ActionConstraint
  • func (a *ApiAction) GetCreatedAt() time.Time
  • func (a *ApiAction) GetDescription() *string
  • func (a *ApiAction) GetExtraProperties() map[string]interface{}
  • func (a *ApiAction) GetGuardrail() *Guardrail
  • func (a *ApiAction) GetGuide() *Guide
  • func (a *ApiAction) GetIcon() *string
  • func (a *ApiAction) GetId() ActionId
  • func (a *ApiAction) GetInputForm() *InputForm
  • func (a *ApiAction) GetLabel() string
  • func (a *ApiAction) GetMessages() []*ActionMessage
  • func (a *ApiAction) GetMode() *ActionMode
  • func (a *ApiAction) GetMount() *ActionMount
  • func (a *ApiAction) GetOperation() *string
  • func (a *ApiAction) GetPrimary() *bool
  • func (a *ApiAction) GetRequireAllValid() *bool
  • func (a *ApiAction) GetRequireSelection() *bool
  • func (a *ApiAction) GetSchedule() *ActionSchedule
  • func (a *ApiAction) GetSlug() *string
  • func (a *ApiAction) GetTargetId() string
  • func (a *ApiAction) GetTooltip() *string
  • func (a *ApiAction) GetType() *string
  • func (a *ApiAction) GetUpdatedAt() time.Time
  • func (a *ApiAction) MarshalJSON() ([]byte, error)
  • func (a *ApiAction) String() string
  • func (a *ApiAction) UnmarshalJSON(data []byte) error
• type ApiActionConfig
  • func (a *ApiActionConfig) GetConfirm() *bool
  • func (a *ApiActionConfig) GetConstraints() []*ActionConstraint
  • func (a *ApiActionConfig) GetDescription() *string
  • func (a *ApiActionConfig) GetExtraProperties() map[string]interface{}
  • func (a *ApiActionConfig) GetGuardrail() *Guardrail
  • func (a *ApiActionConfig) GetGuide() *Guide
  • func (a *ApiActionConfig) GetIcon() *string
  • func (a *ApiActionConfig) GetInputForm() *InputForm
  • func (a *ApiActionConfig) GetLabel() string
  • func (a *ApiActionConfig) GetMessages() []*ActionMessage
  • func (a *ApiActionConfig) GetMode() *ActionMode
  • func (a *ApiActionConfig) GetMount() *ActionMount
  • func (a *ApiActionConfig) GetOperation() *string
  • func (a *ApiActionConfig) GetPrimary() *bool
  • func (a *ApiActionConfig) GetRequireAllValid() *bool
  • func (a *ApiActionConfig) GetRequireSelection() *bool
  • func (a *ApiActionConfig) GetSchedule() *ActionSchedule
  • func (a *ApiActionConfig) GetSlug() *string
  • func (a *ApiActionConfig) GetTargetId() string
  • func (a *ApiActionConfig) GetTooltip() *string
  • func (a *ApiActionConfig) GetType() *string
  • func (a *ApiActionConfig) String() string
  • func (a *ApiActionConfig) UnmarshalJSON(data []byte) error
• type ApiActionConfigs
• type ApiActionResponse
• type ApiActionsResponse
• type App
  • func (a *App) GetActivatedAt() *time.Time
  • func (a *App) GetBlueprint() interface{}
  • func (a *App) GetCreatedAt() time.Time
  • func (a *App) GetDeletedAt() *time.Time
  • func (a *App) GetEntity() string
  • func (a *App) GetEntityPlural() string
  • func (a *App) GetEnvironmentFilters() interface{}
  • func (a *App) GetExtraProperties() map[string]interface{}
  • func (a *App) GetIcon() *string
  • func (a *App) GetId() AppId
  • func (a *App) GetMetadata() interface{}
  • func (a *App) GetName() string
  • func (a *App) GetNamespace() string
  • func (a *App) GetType() AppType
  • func (a *App) GetUpdatedAt() time.Time
  • func (a *App) MarshalJSON() ([]byte, error)
  • func (a *App) String() string
  • func (a *App) UnmarshalJSON(data []byte) error
• type AppAutobuildDeployJobConfig
  • func (a *AppAutobuildDeployJobConfig) GetAppId() AppId
  • func (a *AppAutobuildDeployJobConfig) GetExtraProperties() map[string]interface{}
  • func (a *AppAutobuildDeployJobConfig) GetSpaceId() SpaceId
  • func (a *AppAutobuildDeployJobConfig) String() string
  • func (a *AppAutobuildDeployJobConfig) UnmarshalJSON(data []byte) error
• type AppCreate
  • func (a *AppCreate) GetBlueprint() interface{}
  • func (a *AppCreate) GetEntity() *string
  • func (a *AppCreate) GetEntityPlural() *string
  • func (a *AppCreate) GetEnvironmentFilters() interface{}
  • func (a *AppCreate) GetExtraProperties() map[string]interface{}
  • func (a *AppCreate) GetIcon() *string
  • func (a *AppCreate) GetMetadata() interface{}
  • func (a *AppCreate) GetName() string
  • func (a *AppCreate) GetNamespace() string
  • func (a *AppCreate) GetType() AppType
  • func (a *AppCreate) String() string
  • func (a *AppCreate) UnmarshalJSON(data []byte) error
• type AppId
• type AppPatch
  • func (a *AppPatch) GetActivatedAt() *time.Time
  • func (a *AppPatch) GetBlueprint() interface{}
  • func (a *AppPatch) GetEntity() *string
  • func (a *AppPatch) GetEntityPlural() *string
  • func (a *AppPatch) GetEnvironmentFilters() interface{}
  • func (a *AppPatch) GetExtraProperties() map[string]interface{}
  • func (a *AppPatch) GetIcon() *string
  • func (a *AppPatch) GetMetadata() interface{}
  • func (a *AppPatch) GetName() *string
  • func (a *AppPatch) GetNamespace() *string
  • func (a *AppPatch) MarshalJSON() ([]byte, error)
  • func (a *AppPatch) String() string
  • func (a *AppPatch) UnmarshalJSON(data []byte) error
• type AppResponse
  • func (a *AppResponse) GetData() *App
  • func (a *AppResponse) GetExtraProperties() map[string]interface{}
  • func (a *AppResponse) String() string
  • func (a *AppResponse) UnmarshalJSON(data []byte) error
• type AppType
  • func NewAppTypeFromString(s string) (AppType, error)
  • func (a AppType) Ptr() *AppType
• type AppsResponse
  • func (a *AppsResponse) GetData() []*App
  • func (a *AppsResponse) GetExtraProperties() map[string]interface{}
  • func (a *AppsResponse) String() string
  • func (a *AppsResponse) UnmarshalJSON(data []byte) error
• type ArrayableProperty
  • func (a *ArrayableProperty) GetExtraProperties() map[string]interface{}
  • func (a *ArrayableProperty) GetIsArray() *bool
  • func (a *ArrayableProperty) String() string
  • func (a *ArrayableProperty) UnmarshalJSON(data []byte) error
• type AssignActorRoleRequest
  • func (a *AssignActorRoleRequest) GetExtraProperties() map[string]interface{}
  • func (a *AssignActorRoleRequest) GetResourceId() *ResourceIdUnion
  • func (a *AssignActorRoleRequest) GetRoleId() RoleId
  • func (a *AssignActorRoleRequest) String() string
  • func (a *AssignActorRoleRequest) UnmarshalJSON(data []byte) error
• type AssignRoleResponse
  • func (a *AssignRoleResponse) GetData() *AssignRoleResponseData
  • func (a *AssignRoleResponse) GetExtraProperties() map[string]interface{}
  • func (a *AssignRoleResponse) String() string
  • func (a *AssignRoleResponse) UnmarshalJSON(data []byte) error
• type AssignRoleResponseData
  • func (a *AssignRoleResponseData) GetActorId() *ActorIdUnion
  • func (a *AssignRoleResponseData) GetCreatedAt() time.Time
  • func (a *AssignRoleResponseData) GetExtraProperties() map[string]interface{}
  • func (a *AssignRoleResponseData) GetId() ActorRoleId
  • func (a *AssignRoleResponseData) GetResourceId() *ResourceIdUnion
  • func (a *AssignRoleResponseData) GetRoleId() RoleId
  • func (a *AssignRoleResponseData) GetUpdatedAt() time.Time
  • func (a *AssignRoleResponseData) MarshalJSON() ([]byte, error)
  • func (a *AssignRoleResponseData) String() string
  • func (a *AssignRoleResponseData) UnmarshalJSON(data []byte) error
• type BadRequestError
  • func (b *BadRequestError) MarshalJSON() ([]byte, error)
  • func (b *BadRequestError) UnmarshalJSON(data []byte) error
  • func (b *BadRequestError) Unwrap() error
• type BaseEvent
  • func (b *BaseEvent) GetAttributes() *EventAttributes
  • func (b *BaseEvent) GetCallbackUrl() *string
  • func (b *BaseEvent) GetContext() *Context
  • func (b *BaseEvent) GetDataUrl() *string
  • func (b *BaseEvent) GetDomain() Domain
  • func (b *BaseEvent) GetExtraProperties() map[string]interface{}
  • func (b *BaseEvent) GetNamespaces() []string
  • func (b *BaseEvent) GetOrigin() *Origin
  • func (b *BaseEvent) GetTarget() *string
  • func (b *BaseEvent) String() string
  • func (b *BaseEvent) UnmarshalJSON(data []byte) error
• type BaseProperty
  • func (b *BaseProperty) GetActions() []*Action
  • func (b *BaseProperty) GetAlternativeNames() []string
  • func (b *BaseProperty) GetAppearance() *FieldAppearance
  • func (b *BaseProperty) GetConstraints() []*Constraint
  • func (b *BaseProperty) GetDescription() *string
  • func (b *BaseProperty) GetExtraProperties() map[string]interface{}
  • func (b *BaseProperty) GetKey() string
  • func (b *BaseProperty) GetLabel() *string
  • func (b *BaseProperty) GetMetadata() interface{}
  • func (b *BaseProperty) GetReadonly() *bool
  • func (b *BaseProperty) GetTreatments() []string
  • func (b *BaseProperty) String() string
  • func (b *BaseProperty) UnmarshalJSON(data []byte) error
• type BooleanProperty
  • func (b *BooleanProperty) GetActions() []*Action
  • func (b *BooleanProperty) GetAlternativeNames() []string
  • func (b *BooleanProperty) GetAppearance() *FieldAppearance
  • func (b *BooleanProperty) GetConfig() *BooleanPropertyConfig
  • func (b *BooleanProperty) GetConstraints() []*Constraint
  • func (b *BooleanProperty) GetDescription() *string
  • func (b *BooleanProperty) GetExtraProperties() map[string]interface{}
  • func (b *BooleanProperty) GetKey() string
  • func (b *BooleanProperty) GetLabel() *string
  • func (b *BooleanProperty) GetMetadata() interface{}
  • func (b *BooleanProperty) GetReadonly() *bool
  • func (b *BooleanProperty) GetTreatments() []string
  • func (b *BooleanProperty) String() string
  • func (b *BooleanProperty) UnmarshalJSON(data []byte) error
• type BooleanPropertyConfig
  • func (b *BooleanPropertyConfig) GetAllowIndeterminate() bool
  • func (b *BooleanPropertyConfig) GetExtraProperties() map[string]interface{}
  • func (b *BooleanPropertyConfig) String() string
  • func (b *BooleanPropertyConfig) UnmarshalJSON(data []byte) error
• type CategoryMapping
  • func (c *CategoryMapping) GetDestinationValue() *EnumValue
  • func (c *CategoryMapping) GetExtraProperties() map[string]interface{}
  • func (c *CategoryMapping) GetSourceValue() *EnumValue
  • func (c *CategoryMapping) String() string
  • func (c *CategoryMapping) UnmarshalJSON(data []byte) error
• type CellConfig
  • func (c *CellConfig) GetExtraProperties() map[string]interface{}
  • func (c *CellConfig) GetReadonly() *bool
  • func (c *CellConfig) String() string
  • func (c *CellConfig) UnmarshalJSON(data []byte) error
• type CellValue
  • func (c *CellValue) GetExtraProperties() map[string]interface{}
  • func (c *CellValue) GetLayer() *string
  • func (c *CellValue) GetMessages() []*ValidationMessage
  • func (c *CellValue) GetMetadata() map[string]interface{}
  • func (c *CellValue) GetUpdatedAt() *time.Time
  • func (c *CellValue) GetValid() *bool
  • func (c *CellValue) GetValue() *CellValueUnion
  • func (c *CellValue) MarshalJSON() ([]byte, error)
  • func (c *CellValue) String() string
  • func (c *CellValue) UnmarshalJSON(data []byte) error
• type CellValueUnion
  • func NewCellValueUnionFromBoolean(value bool) *CellValueUnion
  • func NewCellValueUnionFromDate(value time.Time) *CellValueUnion
  • func NewCellValueUnionFromDateTime(value time.Time) *CellValueUnion
  • func NewCellValueUnionFromDouble(value float64) *CellValueUnion
  • func NewCellValueUnionFromInteger(value int) *CellValueUnion
  • func NewCellValueUnionFromLong(value int64) *CellValueUnion
  • func NewCellValueUnionFromString(value string) *CellValueUnion
  • func NewCellValueUnionFromStringList(value []string) *CellValueUnion
  • func (c *CellValueUnion) Accept(visitor CellValueUnionVisitor) error
  • func (c *CellValueUnion) GetBoolean() bool
  • func (c *CellValueUnion) GetDate() time.Time
  • func (c *CellValueUnion) GetDateTime() time.Time
  • func (c *CellValueUnion) GetDouble() float64
  • func (c *CellValueUnion) GetInteger() int
  • func (c *CellValueUnion) GetLong() int64
  • func (c *CellValueUnion) GetString() string
  • func (c *CellValueUnion) GetStringList() []string
  • func (c CellValueUnion) MarshalJSON() ([]byte, error)
  • func (c *CellValueUnion) UnmarshalJSON(data []byte) error
• type CellValueUnionVisitor
• type CellValueWithCounts
  • func (c *CellValueWithCounts) GetCounts() *RecordCounts
  • func (c *CellValueWithCounts) GetExtraProperties() map[string]interface{}
  • func (c *CellValueWithCounts) GetLayer() *string
  • func (c *CellValueWithCounts) GetMessages() []*ValidationMessage
  • func (c *CellValueWithCounts) GetMetadata() map[string]interface{}
  • func (c *CellValueWithCounts) GetUpdatedAt() *time.Time
  • func (c *CellValueWithCounts) GetValid() *bool
  • func (c *CellValueWithCounts) GetValue() *CellValueUnion
  • func (c *CellValueWithCounts) MarshalJSON() ([]byte, error)
  • func (c *CellValueWithCounts) String() string
  • func (c *CellValueWithCounts) UnmarshalJSON(data []byte) error
• type CellValueWithLinks
  • func (c *CellValueWithLinks) GetExtraProperties() map[string]interface{}
  • func (c *CellValueWithLinks) GetLayer() *string
  • func (c *CellValueWithLinks) GetLinks() *Records
  • func (c *CellValueWithLinks) GetMessages() []*ValidationMessage
  • func (c *CellValueWithLinks) GetMetadata() map[string]interface{}
  • func (c *CellValueWithLinks) GetUpdatedAt() *time.Time
  • func (c *CellValueWithLinks) GetValid() *bool
  • func (c *CellValueWithLinks) GetValue() *CellValueUnion
  • func (c *CellValueWithLinks) MarshalJSON() ([]byte, error)
  • func (c *CellValueWithLinks) String() string
  • func (c *CellValueWithLinks) UnmarshalJSON(data []byte) error
• type CellsResponse
  • func (c *CellsResponse) GetData() CellsResponseData
  • func (c *CellsResponse) GetExtraProperties() map[string]interface{}
  • func (c *CellsResponse) String() string
  • func (c *CellsResponse) UnmarshalJSON(data []byte) error
• type CellsResponseData
• type Certainty
  • func NewCertaintyFromString(s string) (Certainty, error)
  • func (c Certainty) Ptr() *Certainty
• type ChangeType
  • func NewChangeTypeFromString(s string) (ChangeType, error)
  • func (c ChangeType) Ptr() *ChangeType
• type CollectionJobSubject
  • func (c *CollectionJobSubject) GetExtraProperties() map[string]interface{}
  • func (c *CollectionJobSubject) GetParams() map[string]interface{}
  • func (c *CollectionJobSubject) GetQuery() map[string]interface{}
  • func (c *CollectionJobSubject) GetResource() string
  • func (c *CollectionJobSubject) String() string
  • func (c *CollectionJobSubject) UnmarshalJSON(data []byte) error
• type Commit
  • func (c *Commit) GetCompletedAt() *time.Time
  • func (c *Commit) GetCompletedBy() *string
  • func (c *Commit) GetCreatedAt() time.Time
  • func (c *Commit) GetCreatedBy() string
  • func (c *Commit) GetExtraProperties() map[string]interface{}
  • func (c *Commit) GetId() CommitId
  • func (c *Commit) GetSheetId() SheetId
  • func (c *Commit) MarshalJSON() ([]byte, error)
  • func (c *Commit) String() string
  • func (c *Commit) UnmarshalJSON(data []byte) error
• type CommitId
• type CommitResponse
  • func (c *CommitResponse) GetData() *Commit
  • func (c *CommitResponse) GetExtraProperties() map[string]interface{}
  • func (c *CommitResponse) String() string
  • func (c *CommitResponse) UnmarshalJSON(data []byte) error
• type Compiler
  • func NewCompilerFromString(s string) (Compiler, error)
  • func (c Compiler) Ptr() *Compiler
• type CompositeUniqueConstraint
  • func (c *CompositeUniqueConstraint) GetExtraProperties() map[string]interface{}
  • func (c *CompositeUniqueConstraint) GetFields() []string
  • func (c *CompositeUniqueConstraint) GetName() string
  • func (c *CompositeUniqueConstraint) GetRequiredFields() []string
  • func (c *CompositeUniqueConstraint) GetStrategy() CompositeUniqueConstraintStrategy
  • func (c *CompositeUniqueConstraint) String() string
  • func (c *CompositeUniqueConstraint) UnmarshalJSON(data []byte) error
• type CompositeUniqueConstraintStrategy
  • func NewCompositeUniqueConstraintStrategyFromString(s string) (CompositeUniqueConstraintStrategy, error)
  • func (c CompositeUniqueConstraintStrategy) Ptr() *CompositeUniqueConstraintStrategy
• type Constraint
  • func NewConstraintFromComputed(value interface{}) *Constraint
  • func NewConstraintFromExternal(value *ExternalConstraint) *Constraint
  • func NewConstraintFromRequired(value interface{}) *Constraint
  • func NewConstraintFromStored(value *StoredConstraint) *Constraint
  • func NewConstraintFromUnique(value *UniqueConstraint) *Constraint
  • func (c *Constraint) Accept(visitor ConstraintVisitor) error
  • func (c *Constraint) GetComputed() interface{}
  • func (c *Constraint) GetExternal() *ExternalConstraint
  • func (c *Constraint) GetRequired() interface{}
  • func (c *Constraint) GetStored() *StoredConstraint
  • func (c *Constraint) GetType() string
  • func (c *Constraint) GetUnique() *UniqueConstraint
  • func (c Constraint) MarshalJSON() ([]byte, error)
  • func (c *Constraint) UnmarshalJSON(data []byte) error
• type ConstraintCreate
  • func (c *ConstraintCreate) GetDescription() *string
  • func (c *ConstraintCreate) GetExtraProperties() map[string]interface{}
  • func (c *ConstraintCreate) GetFunction() *string
  • func (c *ConstraintCreate) GetLabel() *string
  • func (c *ConstraintCreate) GetOptions() interface{}
  • func (c *ConstraintCreate) String() string
  • func (c *ConstraintCreate) UnmarshalJSON(data []byte) error
• type ConstraintId
• type ConstraintResource
  • func (c *ConstraintResource) GetAppId() AppId
  • func (c *ConstraintResource) GetCreatedAt() time.Time
  • func (c *ConstraintResource) GetDescription() *string
  • func (c *ConstraintResource) GetExtraProperties() map[string]interface{}
  • func (c *ConstraintResource) GetFunction() *string
  • func (c *ConstraintResource) GetId() ConstraintId
  • func (c *ConstraintResource) GetLabel() *string
  • func (c *ConstraintResource) GetOptions() interface{}
  • func (c *ConstraintResource) GetUpdatedAt() time.Time
  • func (c *ConstraintResource) GetValidator() string
  • func (c *ConstraintResource) MarshalJSON() ([]byte, error)
  • func (c *ConstraintResource) String() string
  • func (c *ConstraintResource) UnmarshalJSON(data []byte) error
• type ConstraintResponse
  • func (c *ConstraintResponse) GetData() *ConstraintResource
  • func (c *ConstraintResponse) GetExtraProperties() map[string]interface{}
  • func (c *ConstraintResponse) String() string
  • func (c *ConstraintResponse) UnmarshalJSON(data []byte) error
• type ConstraintUpdate
  • func (c *ConstraintUpdate) GetDescription() *string
  • func (c *ConstraintUpdate) GetExtraProperties() map[string]interface{}
  • func (c *ConstraintUpdate) GetFunction() *string
  • func (c *ConstraintUpdate) GetLabel() *string
  • func (c *ConstraintUpdate) GetOptions() interface{}
  • func (c *ConstraintUpdate) String() string
  • func (c *ConstraintUpdate) UnmarshalJSON(data []byte) error
• type ConstraintVersionResource
  • func (c *ConstraintVersionResource) GetAppId() AppId
  • func (c *ConstraintVersionResource) GetCreatedAt() time.Time
  • func (c *ConstraintVersionResource) GetDescription() *string
  • func (c *ConstraintVersionResource) GetExtraProperties() map[string]interface{}
  • func (c *ConstraintVersionResource) GetFunction() *string
  • func (c *ConstraintVersionResource) GetId() ConstraintId
  • func (c *ConstraintVersionResource) GetLabel() *string
  • func (c *ConstraintVersionResource) GetOptions() interface{}
  • func (c *ConstraintVersionResource) GetPrompt() *string
  • func (c *ConstraintVersionResource) GetUpdatedAt() time.Time
  • func (c *ConstraintVersionResource) GetValidator() string
  • func (c *ConstraintVersionResource) GetVersion() int
  • func (c *ConstraintVersionResource) MarshalJSON() ([]byte, error)
  • func (c *ConstraintVersionResource) String() string
  • func (c *ConstraintVersionResource) UnmarshalJSON(data []byte) error
• type ConstraintVersionResponse
  • func (c *ConstraintVersionResponse) GetData() *ConstraintVersionResource
  • func (c *ConstraintVersionResponse) GetExtraProperties() map[string]interface{}
  • func (c *ConstraintVersionResponse) String() string
  • func (c *ConstraintVersionResponse) UnmarshalJSON(data []byte) error
• type ConstraintVersionsResponse
  • func (c *ConstraintVersionsResponse) GetData() []*ConstraintVersionResource
  • func (c *ConstraintVersionsResponse) GetExtraProperties() map[string]interface{}
  • func (c *ConstraintVersionsResponse) String() string
  • func (c *ConstraintVersionsResponse) UnmarshalJSON(data []byte) error
• type ConstraintVisitor
• type ConstraintsResponse
  • func (c *ConstraintsResponse) GetData() []*ConstraintResource
  • func (c *ConstraintsResponse) GetExtraProperties() map[string]interface{}
  • func (c *ConstraintsResponse) String() string
  • func (c *ConstraintsResponse) UnmarshalJSON(data []byte) error
• type Context
  • func (c *Context) GetAccountId() AccountId
  • func (c *Context) GetActionId() *ActionId
  • func (c *Context) GetActionName() *ActionName
  • func (c *Context) GetActorId() *string
  • func (c *Context) GetAppId() *AppId
  • func (c *Context) GetCommitId() *CommitId
  • func (c *Context) GetDataClipId() *DataClipId
  • func (c *Context) GetDocumentId() *DocumentId
  • func (c *Context) GetEnvironmentId() EnvironmentId
  • func (c *Context) GetExtraProperties() map[string]interface{}
  • func (c *Context) GetFileId() *FileId
  • func (c *Context) GetJobId() *JobId
  • func (c *Context) GetNamespaces() []string
  • func (c *Context) GetPrecedingEventId() *EventId
  • func (c *Context) GetProgramId() *ProgramId
  • func (c *Context) GetSheetId() *SheetId
  • func (c *Context) GetSheetSlug() *SheetSlug
  • func (c *Context) GetSlugs() *EventContextSlugs
  • func (c *Context) GetSnapshotId() *SnapshotId
  • func (c *Context) GetSpaceId() *SpaceId
  • func (c *Context) GetVersionId() *VersionId
  • func (c *Context) GetWorkbookId() *WorkbookId
  • func (c *Context) String() string
  • func (c *Context) UnmarshalJSON(data []byte) error
• type CreateAgentsRequest
  • func (c *CreateAgentsRequest) MarshalJSON() ([]byte, error)
  • func (c *CreateAgentsRequest) UnmarshalJSON(data []byte) error
• type CreateEventConfig
  • func (c *CreateEventConfig) GetAttributes() *EventAttributes
  • func (c *CreateEventConfig) GetCallbackUrl() *string
  • func (c *CreateEventConfig) GetContext() *Context
  • func (c *CreateEventConfig) GetDataUrl() *string
  • func (c *CreateEventConfig) GetDeletedAt() *time.Time
  • func (c *CreateEventConfig) GetDomain() Domain
  • func (c *CreateEventConfig) GetExtraProperties() map[string]interface{}
  • func (c *CreateEventConfig) GetNamespaces() []string
  • func (c *CreateEventConfig) GetOrigin() *Origin
  • func (c *CreateEventConfig) GetPayload() map[string]interface{}
  • func (c *CreateEventConfig) GetTarget() *string
  • func (c *CreateEventConfig) GetTopic() EventTopic
  • func (c *CreateEventConfig) MarshalJSON() ([]byte, error)
  • func (c *CreateEventConfig) String() string
  • func (c *CreateEventConfig) UnmarshalJSON(data []byte) error
• type CreateFileRequest
• type CreateGuestResponse
  • func (c *CreateGuestResponse) GetData() []*Guest
  • func (c *CreateGuestResponse) GetExtraProperties() map[string]interface{}
  • func (c *CreateGuestResponse) String() string
  • func (c *CreateGuestResponse) UnmarshalJSON(data []byte) error
• type CreateMappingRulesRequest
• type CreateSnapshotRequest
• type CreateWorkbookConfig
  • func (c *CreateWorkbookConfig) GetActions() []*Action
  • func (c *CreateWorkbookConfig) GetEnvironmentId() *EnvironmentId
  • func (c *CreateWorkbookConfig) GetExtraProperties() map[string]interface{}
  • func (c *CreateWorkbookConfig) GetLabels() []string
  • func (c *CreateWorkbookConfig) GetMetadata() interface{}
  • func (c *CreateWorkbookConfig) GetName() string
  • func (c *CreateWorkbookConfig) GetNamespace() *string
  • func (c *CreateWorkbookConfig) GetSettings() *WorkbookConfigSettings
  • func (c *CreateWorkbookConfig) GetSheets() []*SheetConfig
  • func (c *CreateWorkbookConfig) GetSpaceId() *SpaceId
  • func (c *CreateWorkbookConfig) GetTreatments() []WorkbookTreatments
  • func (c *CreateWorkbookConfig) String() string
  • func (c *CreateWorkbookConfig) UnmarshalJSON(data []byte) error
• type DataClipId
• type DataRetentionPolicy
  • func (d *DataRetentionPolicy) GetCreatedAt() time.Time
  • func (d *DataRetentionPolicy) GetEnvironmentId() EnvironmentId
  • func (d *DataRetentionPolicy) GetExtraProperties() map[string]interface{}
  • func (d *DataRetentionPolicy) GetId() DataRetentionPolicyId
  • func (d *DataRetentionPolicy) GetPeriod() int
  • func (d *DataRetentionPolicy) GetType() DataRetentionPolicyEnum
  • func (d *DataRetentionPolicy) GetUpdatedAt() time.Time
  • func (d *DataRetentionPolicy) MarshalJSON() ([]byte, error)
  • func (d *DataRetentionPolicy) String() string
  • func (d *DataRetentionPolicy) UnmarshalJSON(data []byte) error
• type DataRetentionPolicyConfig
  • func (d *DataRetentionPolicyConfig) GetEnvironmentId() EnvironmentId
  • func (d *DataRetentionPolicyConfig) GetExtraProperties() map[string]interface{}
  • func (d *DataRetentionPolicyConfig) GetPeriod() int
  • func (d *DataRetentionPolicyConfig) GetType() DataRetentionPolicyEnum
  • func (d *DataRetentionPolicyConfig) String() string
  • func (d *DataRetentionPolicyConfig) UnmarshalJSON(data []byte) error
• type DataRetentionPolicyEnum
  • func NewDataRetentionPolicyEnumFromString(s string) (DataRetentionPolicyEnum, error)
  • func (d DataRetentionPolicyEnum) Ptr() *DataRetentionPolicyEnum
• type DataRetentionPolicyId
• type DataRetentionPolicyResponse
  • func (d *DataRetentionPolicyResponse) GetData() *DataRetentionPolicy
  • func (d *DataRetentionPolicyResponse) GetExtraProperties() map[string]interface{}
  • func (d *DataRetentionPolicyResponse) String() string
  • func (d *DataRetentionPolicyResponse) UnmarshalJSON(data []byte) error
• type DateProperty
  • func (d *DateProperty) GetActions() []*Action
  • func (d *DateProperty) GetAlternativeNames() []string
  • func (d *DateProperty) GetAppearance() *FieldAppearance
  • func (d *DateProperty) GetConstraints() []*Constraint
  • func (d *DateProperty) GetDescription() *string
  • func (d *DateProperty) GetExtraProperties() map[string]interface{}
  • func (d *DateProperty) GetKey() string
  • func (d *DateProperty) GetLabel() *string
  • func (d *DateProperty) GetMetadata() interface{}
  • func (d *DateProperty) GetReadonly() *bool
  • func (d *DateProperty) GetTreatments() []string
  • func (d *DateProperty) String() string
  • func (d *DateProperty) UnmarshalJSON(data []byte) error
• type DeleteAgentRequest
• type DeleteAllHistoryForUserRequest
• type DeleteMultipleRulesRequest
• type DeleteRecordsJobConfig
  • func (d *DeleteRecordsJobConfig) GetExceptions() []RecordId
  • func (d *DeleteRecordsJobConfig) GetExtraProperties() map[string]interface{}
  • func (d *DeleteRecordsJobConfig) GetFilter() *Filter
  • func (d *DeleteRecordsJobConfig) GetFilterField() *FilterField
  • func (d *DeleteRecordsJobConfig) GetQ() *string
  • func (d *DeleteRecordsJobConfig) GetSearchField() *SearchField
  • func (d *DeleteRecordsJobConfig) GetSearchValue() *SearchValue
  • func (d *DeleteRecordsJobConfig) GetSheet() SheetId
  • func (d *DeleteRecordsJobConfig) GetSnapshotLabel() *string
  • func (d *DeleteRecordsJobConfig) String() string
  • func (d *DeleteRecordsJobConfig) UnmarshalJSON(data []byte) error
• type DeleteRecordsRequest
• type DeleteSpacesRequest
• type DestinationField
  • func (d *DestinationField) GetDestinationField() *Property
  • func (d *DestinationField) GetExtraProperties() map[string]interface{}
  • func (d *DestinationField) GetPreview() []string
  • func (d *DestinationField) String() string
  • func (d *DestinationField) UnmarshalJSON(data []byte) error
• type DetailedAgentLog
  • func (d *DetailedAgentLog) GetCompletedAt() time.Time
  • func (d *DetailedAgentLog) GetContext() map[string]interface{}
  • func (d *DetailedAgentLog) GetCreatedAt() time.Time
  • func (d *DetailedAgentLog) GetDuration() int
  • func (d *DetailedAgentLog) GetEventId() EventId
  • func (d *DetailedAgentLog) GetExtraProperties() map[string]interface{}
  • func (d *DetailedAgentLog) GetLog() *string
  • func (d *DetailedAgentLog) GetSuccess() bool
  • func (d *DetailedAgentLog) GetTopic() string
  • func (d *DetailedAgentLog) MarshalJSON() ([]byte, error)
  • func (d *DetailedAgentLog) String() string
  • func (d *DetailedAgentLog) UnmarshalJSON(data []byte) error
• type DiffData
• type DiffRecord
  • func (d *DiffRecord) GetCommitId() *CommitId
  • func (d *DiffRecord) GetConfig() *RecordConfig
  • func (d *DiffRecord) GetExtraProperties() map[string]interface{}
  • func (d *DiffRecord) GetId() RecordId
  • func (d *DiffRecord) GetMessages() []*ValidationMessage
  • func (d *DiffRecord) GetMetadata() map[string]interface{}
  • func (d *DiffRecord) GetResolves() []*Resolve
  • func (d *DiffRecord) GetValid() *bool
  • func (d *DiffRecord) GetValues() DiffData
  • func (d *DiffRecord) GetVersionId() *VersionId
  • func (d *DiffRecord) String() string
  • func (d *DiffRecord) UnmarshalJSON(data []byte) error
• type DiffRecords
• type DiffRecordsResponse
  • func (d *DiffRecordsResponse) GetData() DiffRecords
  • func (d *DiffRecordsResponse) GetExtraProperties() map[string]interface{}
  • func (d *DiffRecordsResponse) String() string
  • func (d *DiffRecordsResponse) UnmarshalJSON(data []byte) error
• type DiffValue
  • func (d *DiffValue) GetClipValue() *CellValueUnion
  • func (d *DiffValue) GetExtraProperties() map[string]interface{}
  • func (d *DiffValue) GetLayer() *string
  • func (d *DiffValue) GetMessages() []*ValidationMessage
  • func (d *DiffValue) GetMetadata() map[string]interface{}
  • func (d *DiffValue) GetSnapshotValue() *CellValueUnion
  • func (d *DiffValue) GetUpdatedAt() *time.Time
  • func (d *DiffValue) GetValid() *bool
  • func (d *DiffValue) GetValue() *CellValueUnion
  • func (d *DiffValue) MarshalJSON() ([]byte, error)
  • func (d *DiffValue) String() string
  • func (d *DiffValue) UnmarshalJSON(data []byte) error
• type Distinct
• type Document
  • func (d *Document) GetActions() []*Action
  • func (d *Document) GetBody() string
  • func (d *Document) GetCreatedAt() time.Time
  • func (d *Document) GetEnvironmentId() *EnvironmentId
  • func (d *Document) GetExtraProperties() map[string]interface{}
  • func (d *Document) GetId() DocumentId
  • func (d *Document) GetSpaceId() *SpaceId
  • func (d *Document) GetTitle() string
  • func (d *Document) GetTreatments() []string
  • func (d *Document) GetUpdatedAt() time.Time
  • func (d *Document) MarshalJSON() ([]byte, error)
  • func (d *Document) String() string
  • func (d *Document) UnmarshalJSON(data []byte) error
• type DocumentConfig
  • func (d *DocumentConfig) GetActions() []*Action
  • func (d *DocumentConfig) GetBody() string
  • func (d *DocumentConfig) GetExtraProperties() map[string]interface{}
  • func (d *DocumentConfig) GetTitle() string
  • func (d *DocumentConfig) GetTreatments() []string
  • func (d *DocumentConfig) String() string
  • func (d *DocumentConfig) UnmarshalJSON(data []byte) error
• type DocumentId
• type DocumentResponse
  • func (d *DocumentResponse) GetData() *Document
  • func (d *DocumentResponse) GetExtraProperties() map[string]interface{}
  • func (d *DocumentResponse) String() string
  • func (d *DocumentResponse) UnmarshalJSON(data []byte) error
• type Domain
  • func NewDomainFromString(s string) (Domain, error)
  • func (d Domain) Ptr() *Domain
• type Driver
  • func NewDriverFromString(s string) (Driver, error)
  • func (d Driver) Ptr() *Driver
• type Edge
  • func (e *Edge) GetDestinationField() *Property
  • func (e *Edge) GetEnumDetails() *EnumDetails
  • func (e *Edge) GetExtraProperties() map[string]interface{}
  • func (e *Edge) GetMetadata() *Metadata
  • func (e *Edge) GetPreview() []string
  • func (e *Edge) GetSourceField() *Property
  • func (e *Edge) String() string
  • func (e *Edge) UnmarshalJSON(data []byte) error
• type EmptyObject
  • func (e *EmptyObject) GetExtraProperties() map[string]interface{}
  • func (e *EmptyObject) String() string
  • func (e *EmptyObject) UnmarshalJSON(data []byte) error
• type Entitlement
  • func (e *Entitlement) GetExtraProperties() map[string]interface{}
  • func (e *Entitlement) GetKey() string
  • func (e *Entitlement) GetMetadata() interface{}
  • func (e *Entitlement) String() string
  • func (e *Entitlement) UnmarshalJSON(data []byte) error
• type EnumDetails
  • func (e *EnumDetails) GetExtraProperties() map[string]interface{}
  • func (e *EnumDetails) GetMapping() []*CategoryMapping
  • func (e *EnumDetails) GetUnusedDestinationValues() []*EnumValue
  • func (e *EnumDetails) GetUnusedSourceValues() []*EnumValue
  • func (e *EnumDetails) String() string
  • func (e *EnumDetails) UnmarshalJSON(data []byte) error
• type EnumListProperty
  • func (e *EnumListProperty) GetActions() []*Action
  • func (e *EnumListProperty) GetAlternativeNames() []string
  • func (e *EnumListProperty) GetAppearance() *FieldAppearance
  • func (e *EnumListProperty) GetConfig() *EnumPropertyConfig
  • func (e *EnumListProperty) GetConstraints() []*Constraint
  • func (e *EnumListProperty) GetDescription() *string
  • func (e *EnumListProperty) GetExtraProperties() map[string]interface{}
  • func (e *EnumListProperty) GetKey() string
  • func (e *EnumListProperty) GetLabel() *string
  • func (e *EnumListProperty) GetMetadata() interface{}
  • func (e *EnumListProperty) GetReadonly() *bool
  • func (e *EnumListProperty) GetTreatments() []string
  • func (e *EnumListProperty) String() string
  • func (e *EnumListProperty) UnmarshalJSON(data []byte) error
• type EnumProperty
  • func (e *EnumProperty) GetActions() []*Action
  • func (e *EnumProperty) GetAlternativeNames() []string
  • func (e *EnumProperty) GetAppearance() *FieldAppearance
  • func (e *EnumProperty) GetConfig() *EnumPropertyConfig
  • func (e *EnumProperty) GetConstraints() []*Constraint
  • func (e *EnumProperty) GetDescription() *string
  • func (e *EnumProperty) GetExtraProperties() map[string]interface{}
  • func (e *EnumProperty) GetIsArray() *bool
  • func (e *EnumProperty) GetKey() string
  • func (e *EnumProperty) GetLabel() *string
  • func (e *EnumProperty) GetMetadata() interface{}
  • func (e *EnumProperty) GetMulti() *bool
  • func (e *EnumProperty) GetReadonly() *bool
  • func (e *EnumProperty) GetTreatments() []string
  • func (e *EnumProperty) String() string
  • func (e *EnumProperty) UnmarshalJSON(data []byte) error
• type EnumPropertyConfig
  • func (e *EnumPropertyConfig) GetAllowCustom() *bool
  • func (e *EnumPropertyConfig) GetExtraProperties() map[string]interface{}
  • func (e *EnumPropertyConfig) GetOptions() []*EnumPropertyOption
  • func (e *EnumPropertyConfig) GetSortBy() *EnumPropertySortBy
  • func (e *EnumPropertyConfig) String() string
  • func (e *EnumPropertyConfig) UnmarshalJSON(data []byte) error
• type EnumPropertyOption
  • func (e *EnumPropertyOption) GetAlternativeNames() []string
  • func (e *EnumPropertyOption) GetColor() *string
  • func (e *EnumPropertyOption) GetDescription() *string
  • func (e *EnumPropertyOption) GetExtraProperties() map[string]interface{}
  • func (e *EnumPropertyOption) GetIcon() *string
  • func (e *EnumPropertyOption) GetLabel() *string
  • func (e *EnumPropertyOption) GetMeta() map[string]interface{}
  • func (e *EnumPropertyOption) GetOrdinal() *int
  • func (e *EnumPropertyOption) GetValue() interface{}
  • func (e *EnumPropertyOption) String() string
  • func (e *EnumPropertyOption) UnmarshalJSON(data []byte) error
• type EnumPropertySortBy
  • func NewEnumPropertySortByFromString(s string) (EnumPropertySortBy, error)
  • func (e EnumPropertySortBy) Ptr() *EnumPropertySortBy
• type EnumValue
  • func NewEnumValueFromBoolean(value bool) *EnumValue
  • func NewEnumValueFromInteger(value int) *EnumValue
  • func NewEnumValueFromString(value string) *EnumValue
  • func (e *EnumValue) Accept(visitor EnumValueVisitor) error
  • func (e *EnumValue) GetBoolean() bool
  • func (e *EnumValue) GetInteger() int
  • func (e *EnumValue) GetString() string
  • func (e EnumValue) MarshalJSON() ([]byte, error)
  • func (e *EnumValue) UnmarshalJSON(data []byte) error
• type EnumValueVisitor
• type Environment
  • func (e *Environment) GetAccountId() AccountId
  • func (e *Environment) GetExtraProperties() map[string]interface{}
  • func (e *Environment) GetFeatures() map[string]interface{}
  • func (e *Environment) GetGuestAuthentication() []GuestAuthenticationEnum
  • func (e *Environment) GetId() EnvironmentId
  • func (e *Environment) GetIsProd() bool
  • func (e *Environment) GetLanguageOverride() *string
  • func (e *Environment) GetMetadata() map[string]interface{}
  • func (e *Environment) GetName() string
  • func (e *Environment) GetNamespaces() []string
  • func (e *Environment) GetTranslationsPath() *string
  • func (e *Environment) String() string
  • func (e *Environment) UnmarshalJSON(data []byte) error
• type EnvironmentConfigCreate
  • func (e *EnvironmentConfigCreate) GetExtraProperties() map[string]interface{}
  • func (e *EnvironmentConfigCreate) GetGuestAuthentication() []GuestAuthenticationEnum
  • func (e *EnvironmentConfigCreate) GetIsProd() bool
  • func (e *EnvironmentConfigCreate) GetLanguageOverride() *string
  • func (e *EnvironmentConfigCreate) GetMetadata() map[string]interface{}
  • func (e *EnvironmentConfigCreate) GetName() string
  • func (e *EnvironmentConfigCreate) GetNamespaces() []string
  • func (e *EnvironmentConfigCreate) GetTranslationsPath() *string
  • func (e *EnvironmentConfigCreate) String() string
  • func (e *EnvironmentConfigCreate) UnmarshalJSON(data []byte) error
• type EnvironmentConfigUpdate
  • func (e *EnvironmentConfigUpdate) GetExtraProperties() map[string]interface{}
  • func (e *EnvironmentConfigUpdate) GetGuestAuthentication() []GuestAuthenticationEnum
  • func (e *EnvironmentConfigUpdate) GetIsProd() *bool
  • func (e *EnvironmentConfigUpdate) GetLanguageOverride() *string
  • func (e *EnvironmentConfigUpdate) GetMetadata() map[string]interface{}
  • func (e *EnvironmentConfigUpdate) GetName() *string
  • func (e *EnvironmentConfigUpdate) GetNamespaces() []string
  • func (e *EnvironmentConfigUpdate) GetTranslationsPath() *string
  • func (e *EnvironmentConfigUpdate) String() string
  • func (e *EnvironmentConfigUpdate) UnmarshalJSON(data []byte) error
• type EnvironmentId
• type EnvironmentResponse
  • func (e *EnvironmentResponse) GetData() *Environment
  • func (e *EnvironmentResponse) GetExtraProperties() map[string]interface{}
  • func (e *EnvironmentResponse) String() string
  • func (e *EnvironmentResponse) UnmarshalJSON(data []byte) error
• type Error
  • func (e *Error) GetExtraProperties() map[string]interface{}
  • func (e *Error) GetKey() *string
  • func (e *Error) GetMessage() string
  • func (e *Error) String() string
  • func (e *Error) UnmarshalJSON(data []byte) error
• type Errors
  • func (e *Errors) GetErrors() []*Error
  • func (e *Errors) GetExtraProperties() map[string]interface{}
  • func (e *Errors) String() string
  • func (e *Errors) UnmarshalJSON(data []byte) error
• type Event
  • func NewEventFromActionCreated(value *GenericEvent) *Event
  • func NewEventFromActionDeleted(value *GenericEvent) *Event
  • func NewEventFromActionUpdated(value *GenericEvent) *Event
  • func NewEventFromAgentCreated(value *GenericEvent) *Event
  • func NewEventFromAgentDeleted(value *GenericEvent) *Event
  • func NewEventFromAgentUpdated(value *GenericEvent) *Event
  • func NewEventFromCommitCompleted(value *GenericEvent) *Event
  • func NewEventFromCommitCreated(value *GenericEvent) *Event
  • func NewEventFromCommitUpdated(value *GenericEvent) *Event
  • func NewEventFromDataClipCollaboratorUpdated(value *GenericEvent) *Event
  • func NewEventFromDataClipCreated(value *GenericEvent) *Event
  • func NewEventFromDataClipDeleted(value *GenericEvent) *Event
  • func NewEventFromDataClipResolutionsCreated(value *GenericEvent) *Event
  • func NewEventFromDataClipResolutionsRefreshed(value *GenericEvent) *Event
  • func NewEventFromDataClipResolutionsUpdated(value *GenericEvent) *Event
  • func NewEventFromDataClipUpdated(value *GenericEvent) *Event
  • func NewEventFromDocumentCreated(value *GenericEvent) *Event
  • func NewEventFromDocumentDeleted(value *GenericEvent) *Event
  • func NewEventFromDocumentUpdated(value *GenericEvent) *Event
  • func NewEventFromEnvironmentCreated(value *GenericEvent) *Event
  • func NewEventFromEnvironmentDeleted(value *GenericEvent) *Event
  • func NewEventFromEnvironmentUpdated(value *GenericEvent) *Event
  • func NewEventFromFileCreated(value *GenericEvent) *Event
  • func NewEventFromFileDeleted(value *GenericEvent) *Event
  • func NewEventFromFileExpired(value *GenericEvent) *Event
  • func NewEventFromFileUpdated(value *GenericEvent) *Event
  • func NewEventFromJobCompleted(value *GenericEvent) *Event
  • func NewEventFromJobCreated(value *GenericEvent) *Event
  • func NewEventFromJobDeleted(value *GenericEvent) *Event
  • func NewEventFromJobFailed(value *GenericEvent) *Event
  • func NewEventFromJobOutcomeAcknowledged(value *GenericEvent) *Event
  • func NewEventFromJobPartsCompleted(value *GenericEvent) *Event
  • func NewEventFromJobReady(value *GenericEvent) *Event
  • func NewEventFromJobScheduled(value *GenericEvent) *Event
  • func NewEventFromJobUpdated(value *GenericEvent) *Event
  • func NewEventFromLayerCreated(value *GenericEvent) *Event
  • func NewEventFromProgramCreated(value *GenericEvent) *Event
  • func NewEventFromProgramUpdated(value *GenericEvent) *Event
  • func NewEventFromRecordsCreated(value *GenericEvent) *Event
  • func NewEventFromRecordsDeleted(value *GenericEvent) *Event
  • func NewEventFromRecordsUpdated(value *GenericEvent) *Event
  • func NewEventFromSecretCreated(value *GenericEvent) *Event
  • func NewEventFromSecretDeleted(value *GenericEvent) *Event
  • func NewEventFromSecretUpdated(value *GenericEvent) *Event
  • func NewEventFromSheetCountsUpdated(value *GenericEvent) *Event
  • func NewEventFromSheetCreated(value *GenericEvent) *Event
  • func NewEventFromSheetDeleted(value *GenericEvent) *Event
  • func NewEventFromSheetUpdated(value *GenericEvent) *Event
  • func NewEventFromSnapshotCreated(value *GenericEvent) *Event
  • func NewEventFromSpaceArchived(value *GenericEvent) *Event
  • func NewEventFromSpaceCreated(value *GenericEvent) *Event
  • func NewEventFromSpaceDeleted(value *GenericEvent) *Event
  • func NewEventFromSpaceExpired(value *GenericEvent) *Event
  • func NewEventFromSpaceGuestAdded(value *GenericEvent) *Event
  • func NewEventFromSpaceGuestRemoved(value *GenericEvent) *Event
  • func NewEventFromSpaceUpdated(value *GenericEvent) *Event
  • func NewEventFromWorkbookCreated(value *GenericEvent) *Event
  • func NewEventFromWorkbookDeleted(value *GenericEvent) *Event
  • func NewEventFromWorkbookExpired(value *GenericEvent) *Event
  • func NewEventFromWorkbookUpdated(value *GenericEvent) *Event
  • func (e *Event) Accept(visitor EventVisitor) error
  • func (e *Event) GetActionCreated() *GenericEvent
  • func (e *Event) GetActionDeleted() *GenericEvent
  • func (e *Event) GetActionUpdated() *GenericEvent
  • func (e *Event) GetAgentCreated() *GenericEvent
  • func (e *Event) GetAgentDeleted() *GenericEvent
  • func (e *Event) GetAgentUpdated() *GenericEvent
  • func (e *Event) GetCommitCompleted() *GenericEvent
  • func (e *Event) GetCommitCreated() *GenericEvent
  • func (e *Event) GetCommitUpdated() *GenericEvent
  • func (e *Event) GetDataClipCollaboratorUpdated() *GenericEvent
  • func (e *Event) GetDataClipCreated() *GenericEvent
  • func (e *Event) GetDataClipDeleted() *GenericEvent
  • func (e *Event) GetDataClipResolutionsCreated() *GenericEvent
  • func (e *Event) GetDataClipResolutionsRefreshed() *GenericEvent
  • func (e *Event) GetDataClipResolutionsUpdated() *GenericEvent
  • func (e *Event) GetDataClipUpdated() *GenericEvent
  • func (e *Event) GetDocumentCreated() *GenericEvent
  • func (e *Event) GetDocumentDeleted() *GenericEvent
  • func (e *Event) GetDocumentUpdated() *GenericEvent
  • func (e *Event) GetEnvironmentCreated() *GenericEvent
  • func (e *Event) GetEnvironmentDeleted() *GenericEvent
  • func (e *Event) GetEnvironmentUpdated() *GenericEvent
  • func (e *Event) GetFileCreated() *GenericEvent
  • func (e *Event) GetFileDeleted() *GenericEvent
  • func (e *Event) GetFileExpired() *GenericEvent
  • func (e *Event) GetFileUpdated() *GenericEvent
  • func (e *Event) GetJobCompleted() *GenericEvent
  • func (e *Event) GetJobCreated() *GenericEvent
  • func (e *Event) GetJobDeleted() *GenericEvent
  • func (e *Event) GetJobFailed() *GenericEvent
  • func (e *Event) GetJobOutcomeAcknowledged() *GenericEvent
  • func (e *Event) GetJobPartsCompleted() *GenericEvent
  • func (e *Event) GetJobReady() *GenericEvent
  • func (e *Event) GetJobScheduled() *GenericEvent
  • func (e *Event) GetJobUpdated() *GenericEvent
  • func (e *Event) GetLayerCreated() *GenericEvent
  • func (e *Event) GetProgramCreated() *GenericEvent
  • func (e *Event) GetProgramUpdated() *GenericEvent
  • func (e *Event) GetRecordsCreated() *GenericEvent
  • func (e *Event) GetRecordsDeleted() *GenericEvent
  • func (e *Event) GetRecordsUpdated() *GenericEvent
  • func (e *Event) GetSecretCreated() *GenericEvent
  • func (e *Event) GetSecretDeleted() *GenericEvent
  • func (e *Event) GetSecretUpdated() *GenericEvent
  • func (e *Event) GetSheetCountsUpdated() *GenericEvent
  • func (e *Event) GetSheetCreated() *GenericEvent
  • func (e *Event) GetSheetDeleted() *GenericEvent
  • func (e *Event) GetSheetUpdated() *GenericEvent
  • func (e *Event) GetSnapshotCreated() *GenericEvent
  • func (e *Event) GetSpaceArchived() *GenericEvent
  • func (e *Event) GetSpaceCreated() *GenericEvent
  • func (e *Event) GetSpaceDeleted() *GenericEvent
  • func (e *Event) GetSpaceExpired() *GenericEvent
  • func (e *Event) GetSpaceGuestAdded() *GenericEvent
  • func (e *Event) GetSpaceGuestRemoved() *GenericEvent
  • func (e *Event) GetSpaceUpdated() *GenericEvent
  • func (e *Event) GetTopic() string
  • func (e *Event) GetWorkbookCreated() *GenericEvent
  • func (e *Event) GetWorkbookDeleted() *GenericEvent
  • func (e *Event) GetWorkbookExpired() *GenericEvent
  • func (e *Event) GetWorkbookUpdated() *GenericEvent
  • func (e Event) MarshalJSON() ([]byte, error)
  • func (e *Event) UnmarshalJSON(data []byte) error
• type EventAttributes
  • func (e *EventAttributes) GetExtraProperties() map[string]interface{}
  • func (e *EventAttributes) GetProgress() *Progress
  • func (e *EventAttributes) GetTargetUpdatedAt() *time.Time
  • func (e *EventAttributes) MarshalJSON() ([]byte, error)
  • func (e *EventAttributes) String() string
  • func (e *EventAttributes) UnmarshalJSON(data []byte) error
• type EventContextSlugs
  • func (e *EventContextSlugs) GetExtraProperties() map[string]interface{}
  • func (e *EventContextSlugs) GetSheet() *string
  • func (e *EventContextSlugs) GetSpace() *string
  • func (e *EventContextSlugs) GetWorkbook() *string
  • func (e *EventContextSlugs) String() string
  • func (e *EventContextSlugs) UnmarshalJSON(data []byte) error
• type EventId
• type EventResponse
  • func (e *EventResponse) GetData() *Event
  • func (e *EventResponse) GetExtraProperties() map[string]interface{}
  • func (e *EventResponse) String() string
  • func (e *EventResponse) UnmarshalJSON(data []byte) error
• type EventToken
  • func (e *EventToken) GetAccountId() *AccountId
  • func (e *EventToken) GetExtraProperties() map[string]interface{}
  • func (e *EventToken) GetSubscribeKey() *string
  • func (e *EventToken) GetToken() *string
  • func (e *EventToken) GetTtl() *int
  • func (e *EventToken) String() string
  • func (e *EventToken) UnmarshalJSON(data []byte) error
• type EventTokenResponse
  • func (e *EventTokenResponse) GetData() *EventToken
  • func (e *EventTokenResponse) GetExtraProperties() map[string]interface{}
  • func (e *EventTokenResponse) String() string
  • func (e *EventTokenResponse) UnmarshalJSON(data []byte) error
• type EventTopic
  • func NewEventTopicFromString(s string) (EventTopic, error)
  • func (e EventTopic) Ptr() *EventTopic
• type EventVisitor
• type Execution
  • func (e *Execution) GetCompletedAt() time.Time
  • func (e *Execution) GetCreatedAt() time.Time
  • func (e *Execution) GetDuration() int
  • func (e *Execution) GetEventId() EventId
  • func (e *Execution) GetExtraProperties() map[string]interface{}
  • func (e *Execution) GetSuccess() bool
  • func (e *Execution) GetTopic() string
  • func (e *Execution) MarshalJSON() ([]byte, error)
  • func (e *Execution) String() string
  • func (e *Execution) UnmarshalJSON(data []byte) error
• type ExportJobConfig
  • func (e *ExportJobConfig) GetExtraProperties() map[string]interface{}
  • func (e *ExportJobConfig) GetOptions() *ExportOptions
  • func (e *ExportJobConfig) String() string
  • func (e *ExportJobConfig) UnmarshalJSON(data []byte) error
• type ExportOptions
  • func (e *ExportOptions) GetCommitId() *CommitId
  • func (e *ExportOptions) GetExtraProperties() map[string]interface{}
  • func (e *ExportOptions) GetFilter() *Filter
  • func (e *ExportOptions) GetFilterField() *FilterField
  • func (e *ExportOptions) GetIds() []RecordId
  • func (e *ExportOptions) GetQ() *string
  • func (e *ExportOptions) GetSearchField() *SearchField
  • func (e *ExportOptions) GetSearchValue() *SearchValue
  • func (e *ExportOptions) GetSortDirection() *SortDirection
  • func (e *ExportOptions) GetSortField() *SortField
  • func (e *ExportOptions) GetVersionId() *VersionId
  • func (e *ExportOptions) String() string
  • func (e *ExportOptions) UnmarshalJSON(data []byte) error
• type ExternalConstraint
  • func (e *ExternalConstraint) GetConfig() interface{}
  • func (e *ExternalConstraint) GetExtraProperties() map[string]interface{}
  • func (e *ExternalConstraint) GetValidator() string
  • func (e *ExternalConstraint) String() string
  • func (e *ExternalConstraint) UnmarshalJSON(data []byte) error
• type ExternalSheetConstraint
  • func (e *ExternalSheetConstraint) GetConfig() interface{}
  • func (e *ExternalSheetConstraint) GetExtraProperties() map[string]interface{}
  • func (e *ExternalSheetConstraint) GetFields() []string
  • func (e *ExternalSheetConstraint) GetValidator() string
  • func (e *ExternalSheetConstraint) String() string
  • func (e *ExternalSheetConstraint) UnmarshalJSON(data []byte) error
• type FamilyId
• type FieldAppearance
  • func (f *FieldAppearance) GetExtraProperties() map[string]interface{}
  • func (f *FieldAppearance) GetSize() *FieldSize
  • func (f *FieldAppearance) String() string
  • func (f *FieldAppearance) UnmarshalJSON(data []byte) error
• type FieldKey
• type FieldRecordCounts
  • func (f *FieldRecordCounts) GetEmpty() int
  • func (f *FieldRecordCounts) GetError() int
  • func (f *FieldRecordCounts) GetExtraProperties() map[string]interface{}
  • func (f *FieldRecordCounts) GetTotal() int
  • func (f *FieldRecordCounts) GetValid() int
  • func (f *FieldRecordCounts) String() string
  • func (f *FieldRecordCounts) UnmarshalJSON(data []byte) error
• type FieldSize
  • func NewFieldSizeFromString(s string) (FieldSize, error)
  • func (f FieldSize) Ptr() *FieldSize
• type File
  • func (f *File) GetActions() []*Action
  • func (f *File) GetBytesReceived() int
  • func (f *File) GetCreatedAt() time.Time
  • func (f *File) GetEncoding() string
  • func (f *File) GetExpiredAt() *time.Time
  • func (f *File) GetExt() string
  • func (f *File) GetExtraProperties() map[string]interface{}
  • func (f *File) GetId() FileId
  • func (f *File) GetMimetype() string
  • func (f *File) GetMode() *Mode
  • func (f *File) GetName() string
  • func (f *File) GetOrigin() *FileOrigin
  • func (f *File) GetSheetId() *SheetId
  • func (f *File) GetSize() int
  • func (f *File) GetSpaceId() SpaceId
  • func (f *File) GetStatus() ModelFileStatusEnum
  • func (f *File) GetUpdatedAt() time.Time
  • func (f *File) GetWorkbookId() *WorkbookId
  • func (f *File) MarshalJSON() ([]byte, error)
  • func (f *File) String() string
  • func (f *File) UnmarshalJSON(data []byte) error
• type FileId
• type FileJobConfig
  • func (f *FileJobConfig) GetDetectedHeaderRow() *int
  • func (f *FileJobConfig) GetDriver() Driver
  • func (f *FileJobConfig) GetExtraProperties() map[string]interface{}
  • func (f *FileJobConfig) GetOptions() map[string]interface{}
  • func (f *FileJobConfig) String() string
  • func (f *FileJobConfig) UnmarshalJSON(data []byte) error
• type FileOrigin
  • func NewFileOriginFromString(s string) (FileOrigin, error)
  • func (f FileOrigin) Ptr() *FileOrigin
• type FileParam
  • func NewFileParam(reader io.Reader, filename string, contentType string, opts ...FileParamOption) *FileParam
  • func (f *FileParam) ContentType() string
  • func (f *FileParam) Name() string
• type FileParamOption
• type FileResponse
  • func (f *FileResponse) GetData() *File
  • func (f *FileResponse) GetExtraProperties() map[string]interface{}
  • func (f *FileResponse) String() string
  • func (f *FileResponse) UnmarshalJSON(data []byte) error
• type Filter
  • func NewFilterFromString(s string) (Filter, error)
  • func (f Filter) Ptr() *Filter
• type FilterField
• type FindAndReplaceJobConfig
  • func (f *FindAndReplaceJobConfig) GetExtraProperties() map[string]interface{}
  • func (f *FindAndReplaceJobConfig) GetFieldKey() string
  • func (f *FindAndReplaceJobConfig) GetFilter() *Filter
  • func (f *FindAndReplaceJobConfig) GetFilterField() *FilterField
  • func (f *FindAndReplaceJobConfig) GetFind() *CellValueUnion
  • func (f *FindAndReplaceJobConfig) GetIds() []RecordId
  • func (f *FindAndReplaceJobConfig) GetQ() *string
  • func (f *FindAndReplaceJobConfig) GetReplace() *CellValueUnion
  • func (f *FindAndReplaceJobConfig) GetSearchField() *SearchField
  • func (f *FindAndReplaceJobConfig) GetSearchValue() *SearchValue
  • func (f *FindAndReplaceJobConfig) GetSnapshotLabel() *string
  • func (f *FindAndReplaceJobConfig) String() string
  • func (f *FindAndReplaceJobConfig) UnmarshalJSON(data []byte) error
• type FindAndReplaceRecordRequest
• type ForbiddenError
  • func (f *ForbiddenError) MarshalJSON() ([]byte, error)
  • func (f *ForbiddenError) UnmarshalJSON(data []byte) error
  • func (f *ForbiddenError) Unwrap() error
• type GenericEvent
  • func (g *GenericEvent) GetAcknowledgedAt() *time.Time
  • func (g *GenericEvent) GetAcknowledgedBy() *string
  • func (g *GenericEvent) GetAttributes() *EventAttributes
  • func (g *GenericEvent) GetCallbackUrl() *string
  • func (g *GenericEvent) GetContext() *Context
  • func (g *GenericEvent) GetCreatedAt() time.Time
  • func (g *GenericEvent) GetDataUrl() *string
  • func (g *GenericEvent) GetDeletedAt() *time.Time
  • func (g *GenericEvent) GetDomain() Domain
  • func (g *GenericEvent) GetExtraProperties() map[string]interface{}
  • func (g *GenericEvent) GetId() EventId
  • func (g *GenericEvent) GetNamespaces() []string
  • func (g *GenericEvent) GetOrigin() *Origin
  • func (g *GenericEvent) GetPayload() map[string]interface{}
  • func (g *GenericEvent) GetTarget() *string
  • func (g *GenericEvent) MarshalJSON() ([]byte, error)
  • func (g *GenericEvent) String() string
  • func (g *GenericEvent) UnmarshalJSON(data []byte) error
• type GetActionsRequest
• type GetAgentLogRequest
• type GetAgentLogsRequest
• type GetAgentLogsResponse
  • func (g *GetAgentLogsResponse) GetData() []*AgentLog
  • func (g *GetAgentLogsResponse) GetExtraProperties() map[string]interface{}
  • func (g *GetAgentLogsResponse) GetPagination() *Pagination
  • func (g *GetAgentLogsResponse) String() string
  • func (g *GetAgentLogsResponse) UnmarshalJSON(data []byte) error
• type GetAgentRequest
• type GetConstraintsRequest
• type GetDetailedAgentLogResponse
  • func (g *GetDetailedAgentLogResponse) GetData() *DetailedAgentLog
  • func (g *GetDetailedAgentLogResponse) GetExtraProperties() map[string]interface{}
  • func (g *GetDetailedAgentLogResponse) String() string
  • func (g *GetDetailedAgentLogResponse) UnmarshalJSON(data []byte) error
• type GetDetailedAgentLogsResponse
  • func (g *GetDetailedAgentLogsResponse) GetData() []*DetailedAgentLog
  • func (g *GetDetailedAgentLogsResponse) GetExtraProperties() map[string]interface{}
  • func (g *GetDetailedAgentLogsResponse) GetPagination() *Pagination
  • func (g *GetDetailedAgentLogsResponse) String() string
  • func (g *GetDetailedAgentLogsResponse) UnmarshalJSON(data []byte) error
• type GetEnvironmentAgentExecutionsRequest
• type GetEnvironmentAgentLogsRequest
• type GetEnvironmentEventTokenRequest
• type GetEventTokenRequest
• type GetExecutionsResponse
  • func (g *GetExecutionsResponse) GetData() []*Execution
  • func (g *GetExecutionsResponse) GetExtraProperties() map[string]interface{}
  • func (g *GetExecutionsResponse) GetPagination() *Pagination
  • func (g *GetExecutionsResponse) String() string
  • func (g *GetExecutionsResponse) UnmarshalJSON(data []byte) error
• type GetFieldValuesRequest
• type GetGuestTokenRequest
• type GetGuidanceRequest
• type GetRecordCountsRequest
• type GetRecordIndicesRequest
• type GetRecordIndicesResponse
• type GetRecordsCsvRequest
• type GetRecordsRequest
• type GetRecordsResponse
  • func (g *GetRecordsResponse) GetData() *GetRecordsResponseData
  • func (g *GetRecordsResponse) GetExtraProperties() map[string]interface{}
  • func (g *GetRecordsResponse) String() string
  • func (g *GetRecordsResponse) UnmarshalJSON(data []byte) error
• type GetRecordsResponseData
  • func (g *GetRecordsResponseData) GetCommitId() *CommitId
  • func (g *GetRecordsResponseData) GetCounts() *RecordCounts
  • func (g *GetRecordsResponseData) GetExtraProperties() map[string]interface{}
  • func (g *GetRecordsResponseData) GetRecords() RecordsWithLinks
  • func (g *GetRecordsResponseData) GetSuccess() bool
  • func (g *GetRecordsResponseData) GetVersionId() *VersionId
  • func (g *GetRecordsResponseData) String() string
  • func (g *GetRecordsResponseData) UnmarshalJSON(data []byte) error
• type GetSnapshotRecordsRequest
• type GetSnapshotRequest
• type GetSpacesSortField
  • func NewGetSpacesSortFieldFromString(s string) (GetSpacesSortField, error)
  • func (g GetSpacesSortField) Ptr() *GetSpacesSortField
• type Guardrail
  • func (g *Guardrail) GetContent() string
  • func (g *Guardrail) GetExtraProperties() map[string]interface{}
  • func (g *Guardrail) String() string
  • func (g *Guardrail) UnmarshalJSON(data []byte) error
• type Guest
  • func (g *Guest) GetCreatedAt() time.Time
  • func (g *Guest) GetEmail() string
  • func (g *Guest) GetEnvironmentId() EnvironmentId
  • func (g *Guest) GetExtraProperties() map[string]interface{}
  • func (g *Guest) GetId() GuestId
  • func (g *Guest) GetName() string
  • func (g *Guest) GetSpaces() []*GuestSpace
  • func (g *Guest) GetUpdatedAt() time.Time
  • func (g *Guest) MarshalJSON() ([]byte, error)
  • func (g *Guest) String() string
  • func (g *Guest) UnmarshalJSON(data []byte) error
• type GuestAuthenticationEnum
  • func NewGuestAuthenticationEnumFromString(s string) (GuestAuthenticationEnum, error)
  • func (g GuestAuthenticationEnum) Ptr() *GuestAuthenticationEnum
• type GuestConfig
  • func (g *GuestConfig) GetEmail() string
  • func (g *GuestConfig) GetEnvironmentId() EnvironmentId
  • func (g *GuestConfig) GetExtraProperties() map[string]interface{}
  • func (g *GuestConfig) GetName() string
  • func (g *GuestConfig) GetSpaces() []*GuestSpace
  • func (g *GuestConfig) String() string
  • func (g *GuestConfig) UnmarshalJSON(data []byte) error
• type GuestConfigUpdate
  • func (g *GuestConfigUpdate) GetEmail() *string
  • func (g *GuestConfigUpdate) GetEnvironmentId() *EnvironmentId
  • func (g *GuestConfigUpdate) GetExtraProperties() map[string]interface{}
  • func (g *GuestConfigUpdate) GetName() *string
  • func (g *GuestConfigUpdate) GetSpaces() []*GuestSpace
  • func (g *GuestConfigUpdate) String() string
  • func (g *GuestConfigUpdate) UnmarshalJSON(data []byte) error
• type GuestId
• type GuestResponse
  • func (g *GuestResponse) GetData() *Guest
  • func (g *GuestResponse) GetExtraProperties() map[string]interface{}
  • func (g *GuestResponse) String() string
  • func (g *GuestResponse) UnmarshalJSON(data []byte) error
• type GuestSpace
  • func (g *GuestSpace) GetExtraProperties() map[string]interface{}
  • func (g *GuestSpace) GetId() SpaceId
  • func (g *GuestSpace) GetLastAccessed() *time.Time
  • func (g *GuestSpace) GetWorkbooks() []*GuestWorkbook
  • func (g *GuestSpace) MarshalJSON() ([]byte, error)
  • func (g *GuestSpace) String() string
  • func (g *GuestSpace) UnmarshalJSON(data []byte) error
• type GuestToken
  • func (g *GuestToken) GetExtraProperties() map[string]interface{}
  • func (g *GuestToken) GetToken() string
  • func (g *GuestToken) GetValid() bool
  • func (g *GuestToken) String() string
  • func (g *GuestToken) UnmarshalJSON(data []byte) error
• type GuestTokenResponse
  • func (g *GuestTokenResponse) GetData() *GuestToken
  • func (g *GuestTokenResponse) GetExtraProperties() map[string]interface{}
  • func (g *GuestTokenResponse) String() string
  • func (g *GuestTokenResponse) UnmarshalJSON(data []byte) error
• type GuestWorkbook
  • func (g *GuestWorkbook) GetExtraProperties() map[string]interface{}
  • func (g *GuestWorkbook) GetId() WorkbookId
  • func (g *GuestWorkbook) String() string
  • func (g *GuestWorkbook) UnmarshalJSON(data []byte) error
• type GuidanceApiCreateData
  • func (g *GuidanceApiCreateData) GetExtraProperties() map[string]interface{}
  • func (g *GuidanceApiCreateData) GetGuideSlug() string
  • func (g *GuidanceApiCreateData) GetOptions() *GuidanceOptions
  • func (g *GuidanceApiCreateData) String() string
  • func (g *GuidanceApiCreateData) UnmarshalJSON(data []byte) error
• type GuidanceApiUpdateData
  • func (g *GuidanceApiUpdateData) GetExtraProperties() map[string]interface{}
  • func (g *GuidanceApiUpdateData) GetOptions() *GuidanceOptions
  • func (g *GuidanceApiUpdateData) String() string
  • func (g *GuidanceApiUpdateData) UnmarshalJSON(data []byte) error
• type GuidanceId
• type GuidanceListResponse
  • func (g *GuidanceListResponse) GetData() []*GuidanceResource
  • func (g *GuidanceListResponse) GetExtraProperties() map[string]interface{}
  • func (g *GuidanceListResponse) String() string
  • func (g *GuidanceListResponse) UnmarshalJSON(data []byte) error
• type GuidanceOptions
  • func (g *GuidanceOptions) GetExtraProperties() map[string]interface{}
  • func (g *GuidanceOptions) GetRole() RoleEnum
  • func (g *GuidanceOptions) GetTarget() string
  • func (g *GuidanceOptions) GetTrigger() TriggerEnum
  • func (g *GuidanceOptions) GetType() TypeEnum
  • func (g *GuidanceOptions) String() string
  • func (g *GuidanceOptions) UnmarshalJSON(data []byte) error
• type GuidanceResource
  • func (g *GuidanceResource) GetExtraProperties() map[string]interface{}
  • func (g *GuidanceResource) GetGuideSlug() string
  • func (g *GuidanceResource) GetId() GuidanceId
  • func (g *GuidanceResource) GetOptions() *GuidanceOptions
  • func (g *GuidanceResource) String() string
  • func (g *GuidanceResource) UnmarshalJSON(data []byte) error
• type Guide
  • func (g *Guide) GetContent() string
  • func (g *Guide) GetExtraProperties() map[string]interface{}
  • func (g *Guide) String() string
  • func (g *Guide) UnmarshalJSON(data []byte) error
• type GuideCreateRequest
  • func (g *GuideCreateRequest) GetBlocks() []map[string]interface{}
  • func (g *GuideCreateRequest) GetDescription() string
  • func (g *GuideCreateRequest) GetEnvironmentId() string
  • func (g *GuideCreateRequest) GetExtraProperties() map[string]interface{}
  • func (g *GuideCreateRequest) GetMetadata() map[string]interface{}
  • func (g *GuideCreateRequest) GetSlug() string
  • func (g *GuideCreateRequest) GetTitle() string
  • func (g *GuideCreateRequest) GetVersions() []*GuideVersionResource
  • func (g *GuideCreateRequest) String() string
  • func (g *GuideCreateRequest) UnmarshalJSON(data []byte) error
• type GuideDeleteResponse
  • func (g *GuideDeleteResponse) GetData() *GuideDeleteResponseData
  • func (g *GuideDeleteResponse) GetExtraProperties() map[string]interface{}
  • func (g *GuideDeleteResponse) String() string
  • func (g *GuideDeleteResponse) UnmarshalJSON(data []byte) error
• type GuideDeleteResponseData
  • func (g *GuideDeleteResponseData) GetExtraProperties() map[string]interface{}
  • func (g *GuideDeleteResponseData) GetSuccess() bool
  • func (g *GuideDeleteResponseData) String() string
  • func (g *GuideDeleteResponseData) UnmarshalJSON(data []byte) error
• type GuideDetailResponse
  • func (g *GuideDetailResponse) GetData() *GuideResource
  • func (g *GuideDetailResponse) GetExtraProperties() map[string]interface{}
  • func (g *GuideDetailResponse) String() string
  • func (g *GuideDetailResponse) UnmarshalJSON(data []byte) error
• type GuideId
• type GuideListResponse
  • func (g *GuideListResponse) GetData() []*GuideResource
  • func (g *GuideListResponse) GetExtraProperties() map[string]interface{}
  • func (g *GuideListResponse) String() string
  • func (g *GuideListResponse) UnmarshalJSON(data []byte) error
• type GuideResource
  • func (g *GuideResource) GetBlocks() []map[string]interface{}
  • func (g *GuideResource) GetCreatedAt() time.Time
  • func (g *GuideResource) GetDescription() *string
  • func (g *GuideResource) GetExtraProperties() map[string]interface{}
  • func (g *GuideResource) GetId() GuideId
  • func (g *GuideResource) GetMetadata() map[string]interface{}
  • func (g *GuideResource) GetSlug() string
  • func (g *GuideResource) GetTitle() string
  • func (g *GuideResource) GetUpdatedAt() time.Time
  • func (g *GuideResource) GetVersions() []*GuideVersionResource
  • func (g *GuideResource) MarshalJSON() ([]byte, error)
  • func (g *GuideResource) String() string
  • func (g *GuideResource) UnmarshalJSON(data []byte) error
• type GuideUpdateRequest
  • func (g *GuideUpdateRequest) GetBlocks() []map[string]interface{}
  • func (g *GuideUpdateRequest) GetDescription() *string
  • func (g *GuideUpdateRequest) GetEnvironmentId() *string
  • func (g *GuideUpdateRequest) GetExtraProperties() map[string]interface{}
  • func (g *GuideUpdateRequest) GetMetadata() map[string]interface{}
  • func (g *GuideUpdateRequest) GetSlug() *string
  • func (g *GuideUpdateRequest) GetTitle() *string
  • func (g *GuideUpdateRequest) GetVersions() []*GuideVersionResource
  • func (g *GuideUpdateRequest) String() string
  • func (g *GuideUpdateRequest) UnmarshalJSON(data []byte) error
• type GuideVersionResource
  • func (g *GuideVersionResource) GetContent() string
  • func (g *GuideVersionResource) GetCreatedAt() time.Time
  • func (g *GuideVersionResource) GetExtraProperties() map[string]interface{}
  • func (g *GuideVersionResource) GetId() string
  • func (g *GuideVersionResource) GetUpdatedAt() time.Time
  • func (g *GuideVersionResource) GetVersion() int
  • func (g *GuideVersionResource) MarshalJSON() ([]byte, error)
  • func (g *GuideVersionResource) String() string
  • func (g *GuideVersionResource) UnmarshalJSON(data []byte) error
• type GuideVersionResponse
  • func (g *GuideVersionResponse) GetData() *GuideVersionResource
  • func (g *GuideVersionResponse) GetExtraProperties() map[string]interface{}
  • func (g *GuideVersionResponse) String() string
  • func (g *GuideVersionResponse) UnmarshalJSON(data []byte) error
• type IncludeCounts
• type InputConfig
  • func (i *InputConfig) GetExtraProperties() map[string]interface{}
  • func (i *InputConfig) GetOptions() []*InputEnumPropertyOption
  • func (i *InputConfig) String() string
  • func (i *InputConfig) UnmarshalJSON(data []byte) error
• type InputConstraint
  • func (i *InputConstraint) GetExtraProperties() map[string]interface{}
  • func (i *InputConstraint) GetType() InputConstraintType
  • func (i *InputConstraint) String() string
  • func (i *InputConstraint) UnmarshalJSON(data []byte) error
• type InputConstraintType
  • func NewInputConstraintTypeFromString(s string) (InputConstraintType, error)
  • func (i InputConstraintType) Ptr() *InputConstraintType
• type InputEnumPropertyOption
  • func (i *InputEnumPropertyOption) GetColor() *string
  • func (i *InputEnumPropertyOption) GetDescription() *string
  • func (i *InputEnumPropertyOption) GetExtraProperties() map[string]interface{}
  • func (i *InputEnumPropertyOption) GetIcon() *string
  • func (i *InputEnumPropertyOption) GetLabel() *string
  • func (i *InputEnumPropertyOption) GetMeta() map[string]interface{}
  • func (i *InputEnumPropertyOption) GetValue() interface{}
  • func (i *InputEnumPropertyOption) String() string
  • func (i *InputEnumPropertyOption) UnmarshalJSON(data []byte) error
• type InputField
  • func (i *InputField) GetConfig() *InputConfig
  • func (i *InputField) GetConstraints() []*InputConstraint
  • func (i *InputField) GetDefaultValue() interface{}
  • func (i *InputField) GetDescription() *string
  • func (i *InputField) GetExtraProperties() map[string]interface{}
  • func (i *InputField) GetKey() string
  • func (i *InputField) GetLabel() string
  • func (i *InputField) GetType() string
  • func (i *InputField) String() string
  • func (i *InputField) UnmarshalJSON(data []byte) error
• type InputForm
  • func (i *InputForm) GetExtraProperties() map[string]interface{}
  • func (i *InputForm) GetFields() []*InputField
  • func (i *InputForm) GetType() InputFormType
  • func (i *InputForm) String() string
  • func (i *InputForm) UnmarshalJSON(data []byte) error
• type InputFormType
  • func NewInputFormTypeFromString(s string) (InputFormType, error)
  • func (i InputFormType) Ptr() *InputFormType
• type InternalSpaceConfigBase
  • func (i *InternalSpaceConfigBase) GetAccess() []SpaceAccess
  • func (i *InternalSpaceConfigBase) GetActions() []*Action
  • func (i *InternalSpaceConfigBase) GetAppId() *AppId
  • func (i *InternalSpaceConfigBase) GetArchivedAt() *time.Time
  • func (i *InternalSpaceConfigBase) GetAutoConfigure() *bool
  • func (i *InternalSpaceConfigBase) GetEnvironmentId() *EnvironmentId
  • func (i *InternalSpaceConfigBase) GetExtraProperties() map[string]interface{}
  • func (i *InternalSpaceConfigBase) GetIsAppTemplate() *bool
  • func (i *InternalSpaceConfigBase) GetLabels() []string
  • func (i *InternalSpaceConfigBase) GetLanguageOverride() *string
  • func (i *InternalSpaceConfigBase) GetMetadata() interface{}
  • func (i *InternalSpaceConfigBase) GetNamespace() *string
  • func (i *InternalSpaceConfigBase) GetPrimaryWorkbookId() *WorkbookId
  • func (i *InternalSpaceConfigBase) GetSettings() *SpaceSettings
  • func (i *InternalSpaceConfigBase) GetSpaceConfigId() *SpaceConfigId
  • func (i *InternalSpaceConfigBase) GetTranslationsPath() *string
  • func (i *InternalSpaceConfigBase) MarshalJSON() ([]byte, error)
  • func (i *InternalSpaceConfigBase) String() string
  • func (i *InternalSpaceConfigBase) UnmarshalJSON(data []byte) error
• type Invite
  • func (i *Invite) GetExtraProperties() map[string]interface{}
  • func (i *Invite) GetFromName() *string
  • func (i *Invite) GetGuestId() GuestId
  • func (i *Invite) GetMessage() *string
  • func (i *Invite) GetSpaceId() SpaceId
  • func (i *Invite) String() string
  • func (i *Invite) UnmarshalJSON(data []byte) error
• type Job
  • func (j *Job) GetConfig() *JobUpdateConfig
  • func (j *Job) GetCreatedAt() time.Time
  • func (j *Job) GetDestination() *JobDestination
  • func (j *Job) GetEnvironmentId() *EnvironmentId
  • func (j *Job) GetExtraProperties() map[string]interface{}
  • func (j *Job) GetFileId() *FileId
  • func (j *Job) GetFinishedAt() *time.Time
  • func (j *Job) GetId() JobId
  • func (j *Job) GetInfo() *string
  • func (j *Job) GetInput() map[string]interface{}
  • func (j *Job) GetManaged() *bool
  • func (j *Job) GetMetadata() map[string]interface{}
  • func (j *Job) GetMode() *JobMode
  • func (j *Job) GetOperation() string
  • func (j *Job) GetOutcome() map[string]interface{}
  • func (j *Job) GetOutcomeAcknowledgedAt() *time.Time
  • func (j *Job) GetParentId() *JobId
  • func (j *Job) GetPart() *int
  • func (j *Job) GetPartData() map[string]interface{}
  • func (j *Job) GetPartExecution() *JobPartExecution
  • func (j *Job) GetPredecessorIds() []JobId
  • func (j *Job) GetProgress() *int
  • func (j *Job) GetSource() JobSource
  • func (j *Job) GetStartedAt() *time.Time
  • func (j *Job) GetStatus() *JobStatus
  • func (j *Job) GetSubject() *JobSubject
  • func (j *Job) GetTrigger() *Trigger
  • func (j *Job) GetType() JobType
  • func (j *Job) GetUpdatedAt() time.Time
  • func (j *Job) MarshalJSON() ([]byte, error)
  • func (j *Job) String() string
  • func (j *Job) UnmarshalJSON(data []byte) error
• type JobAckDetails
  • func (j *JobAckDetails) GetEstimatedCompletionAt() *time.Time
  • func (j *JobAckDetails) GetExtraProperties() map[string]interface{}
  • func (j *JobAckDetails) GetInfo() *string
  • func (j *JobAckDetails) GetProgress() *int
  • func (j *JobAckDetails) MarshalJSON() ([]byte, error)
  • func (j *JobAckDetails) String() string
  • func (j *JobAckDetails) UnmarshalJSON(data []byte) error
• type JobCancelDetails
  • func (j *JobCancelDetails) GetExtraProperties() map[string]interface{}
  • func (j *JobCancelDetails) GetInfo() *string
  • func (j *JobCancelDetails) String() string
  • func (j *JobCancelDetails) UnmarshalJSON(data []byte) error
• type JobCompleteDetails
  • func (j *JobCompleteDetails) GetExtraProperties() map[string]interface{}
  • func (j *JobCompleteDetails) GetInfo() *string
  • func (j *JobCompleteDetails) GetOutcome() *JobOutcome
  • func (j *JobCompleteDetails) String() string
  • func (j *JobCompleteDetails) UnmarshalJSON(data []byte) error
• type JobConfig
  • func (j *JobConfig) GetConfig() *JobUpdateConfig
  • func (j *JobConfig) GetDestination() *JobDestination
  • func (j *JobConfig) GetEnvironmentId() *EnvironmentId
  • func (j *JobConfig) GetExtraProperties() map[string]interface{}
  • func (j *JobConfig) GetFileId() *FileId
  • func (j *JobConfig) GetInfo() *string
  • func (j *JobConfig) GetInput() map[string]interface{}
  • func (j *JobConfig) GetManaged() *bool
  • func (j *JobConfig) GetMetadata() map[string]interface{}
  • func (j *JobConfig) GetMode() *JobMode
  • func (j *JobConfig) GetOperation() string
  • func (j *JobConfig) GetOutcome() map[string]interface{}
  • func (j *JobConfig) GetParentId() *JobId
  • func (j *JobConfig) GetPart() *int
  • func (j *JobConfig) GetPartData() map[string]interface{}
  • func (j *JobConfig) GetPartExecution() *JobPartExecution
  • func (j *JobConfig) GetPredecessorIds() []JobId
  • func (j *JobConfig) GetProgress() *int
  • func (j *JobConfig) GetSource() JobSource
  • func (j *JobConfig) GetStatus() *JobStatus
  • func (j *JobConfig) GetSubject() *JobSubject
  • func (j *JobConfig) GetTrigger() *Trigger
  • func (j *JobConfig) GetType() JobType
  • func (j *JobConfig) String() string
  • func (j *JobConfig) UnmarshalJSON(data []byte) error
• type JobDestination
• type JobExecutionPlan
  • func (j *JobExecutionPlan) GetExtraProperties() map[string]interface{}
  • func (j *JobExecutionPlan) GetFieldMapping() []*Edge
  • func (j *JobExecutionPlan) GetProgramId() *string
  • func (j *JobExecutionPlan) GetUnmappedDestinationFields() []*DestinationField
  • func (j *JobExecutionPlan) GetUnmappedSourceFields() []*SourceField
  • func (j *JobExecutionPlan) String() string
  • func (j *JobExecutionPlan) UnmarshalJSON(data []byte) error
• type JobExecutionPlanConfig
  • func (j *JobExecutionPlanConfig) GetExtraProperties() map[string]interface{}
  • func (j *JobExecutionPlanConfig) GetFieldMapping() []*Edge
  • func (j *JobExecutionPlanConfig) GetProgramId() *string
  • func (j *JobExecutionPlanConfig) GetUnmappedDestinationFields() []*DestinationField
  • func (j *JobExecutionPlanConfig) GetUnmappedSourceFields() []*SourceField
  • func (j *JobExecutionPlanConfig) String() string
  • func (j *JobExecutionPlanConfig) UnmarshalJSON(data []byte) error
• type JobExecutionPlanConfigRequest
  • func (j *JobExecutionPlanConfigRequest) GetExtraProperties() map[string]interface{}
  • func (j *JobExecutionPlanConfigRequest) GetFieldMapping() []*Edge
  • func (j *JobExecutionPlanConfigRequest) GetFileId() FileId
  • func (j *JobExecutionPlanConfigRequest) GetJobId() JobId
  • func (j *JobExecutionPlanConfigRequest) GetProgramId() *string
  • func (j *JobExecutionPlanConfigRequest) GetUnmappedDestinationFields() []*DestinationField
  • func (j *JobExecutionPlanConfigRequest) GetUnmappedSourceFields() []*SourceField
  • func (j *JobExecutionPlanConfigRequest) String() string
  • func (j *JobExecutionPlanConfigRequest) UnmarshalJSON(data []byte) error
• type JobExecutionPlanRequest
  • func (j *JobExecutionPlanRequest) GetExtraProperties() map[string]interface{}
  • func (j *JobExecutionPlanRequest) GetFieldMapping() []*Edge
  • func (j *JobExecutionPlanRequest) GetFileId() FileId
  • func (j *JobExecutionPlanRequest) GetJobId() JobId
  • func (j *JobExecutionPlanRequest) GetProgramId() *string
  • func (j *JobExecutionPlanRequest) GetUnmappedDestinationFields() []*DestinationField
  • func (j *JobExecutionPlanRequest) GetUnmappedSourceFields() []*SourceField
  • func (j *JobExecutionPlanRequest) String() string
  • func (j *JobExecutionPlanRequest) UnmarshalJSON(data []byte) error
• type JobId
• type JobMode
  • func NewJobModeFromString(s string) (JobMode, error)
  • func (j JobMode) Ptr() *JobMode
• type JobOutcome
  • func (j *JobOutcome) GetAcknowledge() *bool
  • func (j *JobOutcome) GetButtonText() *string
  • func (j *JobOutcome) GetExtraProperties() map[string]interface{}
  • func (j *JobOutcome) GetHeading() *string
  • func (j *JobOutcome) GetHideDefaultButton() *bool
  • func (j *JobOutcome) GetMessage() *string
  • func (j *JobOutcome) GetNext() *JobOutcomeNext
  • func (j *JobOutcome) GetTrigger() *JobOutcomeTrigger
  • func (j *JobOutcome) String() string
  • func (j *JobOutcome) UnmarshalJSON(data []byte) error
• type JobOutcomeNext
  • func NewJobOutcomeNextFromDownload(value *JobOutcomeNextDownload) *JobOutcomeNext
  • func NewJobOutcomeNextFromFiles(value *JobOutcomeNextFiles) *JobOutcomeNext
  • func NewJobOutcomeNextFromId(value *JobOutcomeNextId) *JobOutcomeNext
  • func NewJobOutcomeNextFromRetry(value *JobOutcomeNextRetry) *JobOutcomeNext
  • func NewJobOutcomeNextFromSnapshot(value *JobOutcomeNextSnapshot) *JobOutcomeNext
  • func NewJobOutcomeNextFromUrl(value *JobOutcomeNextUrl) *JobOutcomeNext
  • func NewJobOutcomeNextFromView(value *JobOutcomeNextView) *JobOutcomeNext
  • func NewJobOutcomeNextFromWait(value *JobOutcomeNextWait) *JobOutcomeNext
  • func (j *JobOutcomeNext) Accept(visitor JobOutcomeNextVisitor) error
  • func (j *JobOutcomeNext) GetDownload() *JobOutcomeNextDownload
  • func (j *JobOutcomeNext) GetFiles() *JobOutcomeNextFiles
  • func (j *JobOutcomeNext) GetId() *JobOutcomeNextId
  • func (j *JobOutcomeNext) GetRetry() *JobOutcomeNextRetry
  • func (j *JobOutcomeNext) GetSnapshot() *JobOutcomeNextSnapshot
  • func (j *JobOutcomeNext) GetType() string
  • func (j *JobOutcomeNext) GetUrl() *JobOutcomeNextUrl
  • func (j *JobOutcomeNext) GetView() *JobOutcomeNextView
  • func (j *JobOutcomeNext) GetWait() *JobOutcomeNextWait
  • func (j JobOutcomeNext) MarshalJSON() ([]byte, error)
  • func (j *JobOutcomeNext) UnmarshalJSON(data []byte) error
• type JobOutcomeNextDownload
  • func (j *JobOutcomeNextDownload) GetExtraProperties() map[string]interface{}
  • func (j *JobOutcomeNextDownload) GetFileName() *string
  • func (j *JobOutcomeNextDownload) GetLabel() *string
  • func (j *JobOutcomeNextDownload) GetUrl() string
  • func (j *JobOutcomeNextDownload) String() string
  • func (j *JobOutcomeNextDownload) UnmarshalJSON(data []byte) error
• type JobOutcomeNextFileObject
  • func (j *JobOutcomeNextFileObject) GetExtraProperties() map[string]interface{}
  • func (j *JobOutcomeNextFileObject) GetFileId() string
  • func (j *JobOutcomeNextFileObject) GetLabel() *string
  • func (j *JobOutcomeNextFileObject) String() string
  • func (j *JobOutcomeNextFileObject) UnmarshalJSON(data []byte) error
• type JobOutcomeNextFiles
  • func (j *JobOutcomeNextFiles) GetExtraProperties() map[string]interface{}
  • func (j *JobOutcomeNextFiles) GetFiles() []*JobOutcomeNextFileObject
  • func (j *JobOutcomeNextFiles) GetLabel() *string
  • func (j *JobOutcomeNextFiles) String() string
  • func (j *JobOutcomeNextFiles) UnmarshalJSON(data []byte) error
• type JobOutcomeNextId
  • func (j *JobOutcomeNextId) GetExtraProperties() map[string]interface{}
  • func (j *JobOutcomeNextId) GetId() string
  • func (j *JobOutcomeNextId) GetLabel() *string
  • func (j *JobOutcomeNextId) GetPath() *string
  • func (j *JobOutcomeNextId) GetQuery() *string
  • func (j *JobOutcomeNextId) String() string
  • func (j *JobOutcomeNextId) UnmarshalJSON(data []byte) error
• type JobOutcomeNextRetry
  • func (j *JobOutcomeNextRetry) GetExtraProperties() map[string]interface{}
  • func (j *JobOutcomeNextRetry) GetLabel() *string
  • func (j *JobOutcomeNextRetry) String() string
  • func (j *JobOutcomeNextRetry) UnmarshalJSON(data []byte) error
• type JobOutcomeNextSnapshot
  • func (j *JobOutcomeNextSnapshot) GetExtraProperties() map[string]interface{}
  • func (j *JobOutcomeNextSnapshot) GetSheetId() string
  • func (j *JobOutcomeNextSnapshot) GetSnapshotId() string
  • func (j *JobOutcomeNextSnapshot) String() string
  • func (j *JobOutcomeNextSnapshot) UnmarshalJSON(data []byte) error
• type JobOutcomeNextUrl
  • func (j *JobOutcomeNextUrl) GetExtraProperties() map[string]interface{}
  • func (j *JobOutcomeNextUrl) GetLabel() *string
  • func (j *JobOutcomeNextUrl) GetUrl() string
  • func (j *JobOutcomeNextUrl) String() string
  • func (j *JobOutcomeNextUrl) UnmarshalJSON(data []byte) error
• type JobOutcomeNextView
  • func (j *JobOutcomeNextView) GetExtraProperties() map[string]interface{}
  • func (j *JobOutcomeNextView) GetHiddenColumns() []string
  • func (j *JobOutcomeNextView) GetLabel() *string
  • func (j *JobOutcomeNextView) GetSheetId() string
  • func (j *JobOutcomeNextView) String() string
  • func (j *JobOutcomeNextView) UnmarshalJSON(data []byte) error
• type JobOutcomeNextVisitor
• type JobOutcomeNextWait
  • func (j *JobOutcomeNextWait) GetConfetti() *bool
  • func (j *JobOutcomeNextWait) GetExtraProperties() map[string]interface{}
  • func (j *JobOutcomeNextWait) GetFade() *bool
  • func (j *JobOutcomeNextWait) String() string
  • func (j *JobOutcomeNextWait) UnmarshalJSON(data []byte) error
• type JobOutcomeTrigger
  • func NewJobOutcomeTriggerFromJobOutcomeTriggerDetails(value *JobOutcomeTriggerDetails) *JobOutcomeTrigger
  • func NewJobOutcomeTriggerFromJobOutcomeTriggerType(value JobOutcomeTriggerType) *JobOutcomeTrigger
  • func (j *JobOutcomeTrigger) Accept(visitor JobOutcomeTriggerVisitor) error
  • func (j *JobOutcomeTrigger) GetJobOutcomeTriggerDetails() *JobOutcomeTriggerDetails
  • func (j *JobOutcomeTrigger) GetJobOutcomeTriggerType() JobOutcomeTriggerType
  • func (j JobOutcomeTrigger) MarshalJSON() ([]byte, error)
  • func (j *JobOutcomeTrigger) UnmarshalJSON(data []byte) error
• type JobOutcomeTriggerAudience
  • func NewJobOutcomeTriggerAudienceFromString(s string) (JobOutcomeTriggerAudience, error)
  • func (j JobOutcomeTriggerAudience) Ptr() *JobOutcomeTriggerAudience
• type JobOutcomeTriggerDetails
  • func (j *JobOutcomeTriggerDetails) GetAudience() *JobOutcomeTriggerAudience
  • func (j *JobOutcomeTriggerDetails) GetExtraProperties() map[string]interface{}
  • func (j *JobOutcomeTriggerDetails) GetType() JobOutcomeTriggerType
  • func (j *JobOutcomeTriggerDetails) String() string
  • func (j *JobOutcomeTriggerDetails) UnmarshalJSON(data []byte) error
• type JobOutcomeTriggerType
  • func NewJobOutcomeTriggerTypeFromString(s string) (JobOutcomeTriggerType, error)
  • func (j JobOutcomeTriggerType) Ptr() *JobOutcomeTriggerType
• type JobOutcomeTriggerVisitor
• type JobPartExecution
  • func NewJobPartExecutionFromString(s string) (JobPartExecution, error)
  • func (j JobPartExecution) Ptr() *JobPartExecution
• type JobParts
  • func NewJobPartsFromInteger(value int) *JobParts
  • func NewJobPartsFromJobPartsArray(value JobPartsArray) *JobParts
  • func (j *JobParts) Accept(visitor JobPartsVisitor) error
  • func (j *JobParts) GetInteger() int
  • func (j *JobParts) GetJobPartsArray() JobPartsArray
  • func (j JobParts) MarshalJSON() ([]byte, error)
  • func (j *JobParts) UnmarshalJSON(data []byte) error
• type JobPartsArray
• type JobPartsVisitor
• type JobPlan
  • func (j *JobPlan) GetExtraProperties() map[string]interface{}
  • func (j *JobPlan) GetJob() *Job
  • func (j *JobPlan) GetPlan() *JobExecutionPlan
  • func (j *JobPlan) String() string
  • func (j *JobPlan) UnmarshalJSON(data []byte) error
• type JobPlanResponse
  • func (j *JobPlanResponse) GetData() *JobPlan
  • func (j *JobPlanResponse) GetExtraProperties() map[string]interface{}
  • func (j *JobPlanResponse) String() string
  • func (j *JobPlanResponse) UnmarshalJSON(data []byte) error
• type JobResponse
  • func (j *JobResponse) GetData() *Job
  • func (j *JobResponse) GetExtraProperties() map[string]interface{}
  • func (j *JobResponse) String() string
  • func (j *JobResponse) UnmarshalJSON(data []byte) error
• type JobSource
• type JobSplitDetails
  • func (j *JobSplitDetails) GetExtraProperties() map[string]interface{}
  • func (j *JobSplitDetails) GetParts() *JobParts
  • func (j *JobSplitDetails) GetRunInParallel() *bool
  • func (j *JobSplitDetails) String() string
  • func (j *JobSplitDetails) UnmarshalJSON(data []byte) error
• type JobStatus
  • func NewJobStatusFromString(s string) (JobStatus, error)
  • func (j JobStatus) Ptr() *JobStatus
• type JobSubject
  • func NewJobSubjectFromCollection(value *CollectionJobSubject) *JobSubject
  • func NewJobSubjectFromResource(value *ResourceJobSubject) *JobSubject
  • func (j *JobSubject) Accept(visitor JobSubjectVisitor) error
  • func (j *JobSubject) GetCollection() *CollectionJobSubject
  • func (j *JobSubject) GetResource() *ResourceJobSubject
  • func (j *JobSubject) GetType() string
  • func (j JobSubject) MarshalJSON() ([]byte, error)
  • func (j *JobSubject) UnmarshalJSON(data []byte) error
• type JobSubjectVisitor
• type JobType
  • func NewJobTypeFromString(s string) (JobType, error)
  • func (j JobType) Ptr() *JobType
• type JobUpdate
  • func (j *JobUpdate) GetConfig() *JobUpdateConfig
  • func (j *JobUpdate) GetExtraProperties() map[string]interface{}
  • func (j *JobUpdate) GetInfo() *string
  • func (j *JobUpdate) GetMetadata() map[string]interface{}
  • func (j *JobUpdate) GetOutcomeAcknowledgedAt() *time.Time
  • func (j *JobUpdate) GetProgress() *int
  • func (j *JobUpdate) GetStatus() *JobStatus
  • func (j *JobUpdate) MarshalJSON() ([]byte, error)
  • func (j *JobUpdate) String() string
  • func (j *JobUpdate) UnmarshalJSON(data []byte) error
• type JobUpdateConfig
  • func NewJobUpdateConfigFromAddRecordsToDataClipJobConfig(value *AddRecordsToDataClipJobConfig) *JobUpdateConfig
  • func NewJobUpdateConfigFromAiGenerateBlueprintConstraintsJobConfig(value *AiGenerateBlueprintConstraintsJobConfig) *JobUpdateConfig
  • func NewJobUpdateConfigFromAiGenerateBlueprintJobConfig(value *AiGenerateBlueprintJobConfig) *JobUpdateConfig
  • func NewJobUpdateConfigFromAiGenerateConstraintJobConfig(value *AiGenerateConstraintJobConfig) *JobUpdateConfig
  • func NewJobUpdateConfigFromAiGenerateSampleDataJobConfig(value *AiGenerateSampleDataJobConfig) *JobUpdateConfig
  • func NewJobUpdateConfigFromAiRuleCreationJobConfig(value *AiRuleCreationJobConfig) *JobUpdateConfig
  • func NewJobUpdateConfigFromAppAutobuildDeployJobConfig(value *AppAutobuildDeployJobConfig) *JobUpdateConfig
  • func NewJobUpdateConfigFromDeleteRecordsJobConfig(value *DeleteRecordsJobConfig) *JobUpdateConfig
  • func NewJobUpdateConfigFromEmptyObject(value *EmptyObject) *JobUpdateConfig
  • func NewJobUpdateConfigFromExportJobConfig(value *ExportJobConfig) *JobUpdateConfig
  • func NewJobUpdateConfigFromFileJobConfig(value *FileJobConfig) *JobUpdateConfig
  • func NewJobUpdateConfigFromFindAndReplaceJobConfig(value *FindAndReplaceJobConfig) *JobUpdateConfig
  • func NewJobUpdateConfigFromMappingProgramJobConfig(value *MappingProgramJobConfig) *JobUpdateConfig
  • func NewJobUpdateConfigFromMutateJobConfig(value *MutateJobConfig) *JobUpdateConfig
  • func NewJobUpdateConfigFromPipelineJobConfig(value *PipelineJobConfig) *JobUpdateConfig
  • func NewJobUpdateConfigFromUpdateDataClipResolutionsJobConfig(value *UpdateDataClipResolutionsJobConfig) *JobUpdateConfig
  • func (j *JobUpdateConfig) Accept(visitor JobUpdateConfigVisitor) error
  • func (j *JobUpdateConfig) GetAddRecordsToDataClipJobConfig() *AddRecordsToDataClipJobConfig
  • func (j *JobUpdateConfig) GetAiGenerateBlueprintConstraintsJobConfig() *AiGenerateBlueprintConstraintsJobConfig
  • func (j *JobUpdateConfig) GetAiGenerateBlueprintJobConfig() *AiGenerateBlueprintJobConfig
  • func (j *JobUpdateConfig) GetAiGenerateConstraintJobConfig() *AiGenerateConstraintJobConfig
  • func (j *JobUpdateConfig) GetAiGenerateSampleDataJobConfig() *AiGenerateSampleDataJobConfig
  • func (j *JobUpdateConfig) GetAiRuleCreationJobConfig() *AiRuleCreationJobConfig
  • func (j *JobUpdateConfig) GetAppAutobuildDeployJobConfig() *AppAutobuildDeployJobConfig
  • func (j *JobUpdateConfig) GetDeleteRecordsJobConfig() *DeleteRecordsJobConfig
  • func (j *JobUpdateConfig) GetEmptyObject() *EmptyObject
  • func (j *JobUpdateConfig) GetExportJobConfig() *ExportJobConfig
  • func (j *JobUpdateConfig) GetFileJobConfig() *FileJobConfig
  • func (j *JobUpdateConfig) GetFindAndReplaceJobConfig() *FindAndReplaceJobConfig
  • func (j *JobUpdateConfig) GetMappingProgramJobConfig() *MappingProgramJobConfig
  • func (j *JobUpdateConfig) GetMutateJobConfig() *MutateJobConfig
  • func (j *JobUpdateConfig) GetPipelineJobConfig() *PipelineJobConfig
  • func (j *JobUpdateConfig) GetUpdateDataClipResolutionsJobConfig() *UpdateDataClipResolutionsJobConfig
  • func (j JobUpdateConfig) MarshalJSON() ([]byte, error)
  • func (j *JobUpdateConfig) UnmarshalJSON(data []byte) error
• type JobUpdateConfigVisitor
• type JsonPathString
• type ListActorRolesResponse
  • func (l *ListActorRolesResponse) GetData() []*ActorRoleResponse
  • func (l *ListActorRolesResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListActorRolesResponse) String() string
  • func (l *ListActorRolesResponse) UnmarshalJSON(data []byte) error
• type ListAgentVersionsResponse
  • func (l *ListAgentVersionsResponse) GetData() []*AgentVersion
  • func (l *ListAgentVersionsResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListAgentVersionsResponse) String() string
  • func (l *ListAgentVersionsResponse) UnmarshalJSON(data []byte) error
• type ListAgentsRequest
• type ListAgentsResponse
  • func (l *ListAgentsResponse) GetData() []*Agent
  • func (l *ListAgentsResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListAgentsResponse) String() string
  • func (l *ListAgentsResponse) UnmarshalJSON(data []byte) error
• type ListAllEventsResponse
  • func (l *ListAllEventsResponse) GetData() []*Event
  • func (l *ListAllEventsResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListAllEventsResponse) String() string
  • func (l *ListAllEventsResponse) UnmarshalJSON(data []byte) error
• type ListCommitsResponse
  • func (l *ListCommitsResponse) GetData() []*Commit
  • func (l *ListCommitsResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListCommitsResponse) String() string
  • func (l *ListCommitsResponse) UnmarshalJSON(data []byte) error
• type ListDataRetentionPoliciesRequest
• type ListDataRetentionPoliciesResponse
  • func (l *ListDataRetentionPoliciesResponse) GetData() []*DataRetentionPolicy
  • func (l *ListDataRetentionPoliciesResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListDataRetentionPoliciesResponse) String() string
  • func (l *ListDataRetentionPoliciesResponse) UnmarshalJSON(data []byte) error
• type ListDocumentsResponse
  • func (l *ListDocumentsResponse) GetData() []*Document
  • func (l *ListDocumentsResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListDocumentsResponse) String() string
  • func (l *ListDocumentsResponse) UnmarshalJSON(data []byte) error
• type ListEntitlementsRequest
• type ListEntitlementsResponse
  • func (l *ListEntitlementsResponse) GetData() []*Entitlement
  • func (l *ListEntitlementsResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListEntitlementsResponse) String() string
  • func (l *ListEntitlementsResponse) UnmarshalJSON(data []byte) error
• type ListEnvironmentsRequest
• type ListEnvironmentsResponse
  • func (l *ListEnvironmentsResponse) GetData() []*Environment
  • func (l *ListEnvironmentsResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListEnvironmentsResponse) GetPagination() *Pagination
  • func (l *ListEnvironmentsResponse) String() string
  • func (l *ListEnvironmentsResponse) UnmarshalJSON(data []byte) error
• type ListEventsRequest
• type ListFilesRequest
• type ListFilesResponse
  • func (l *ListFilesResponse) GetData() []*File
  • func (l *ListFilesResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListFilesResponse) GetPagination() *Pagination
  • func (l *ListFilesResponse) String() string
  • func (l *ListFilesResponse) UnmarshalJSON(data []byte) error
• type ListGuestsRequest
• type ListGuestsResponse
  • func (l *ListGuestsResponse) GetData() []*Guest
  • func (l *ListGuestsResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListGuestsResponse) String() string
  • func (l *ListGuestsResponse) UnmarshalJSON(data []byte) error
• type ListGuidanceRequest
• type ListJobsRequest
• type ListJobsResponse
  • func (l *ListJobsResponse) GetData() []*Job
  • func (l *ListJobsResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListJobsResponse) GetPagination() *Pagination
  • func (l *ListJobsResponse) String() string
  • func (l *ListJobsResponse) UnmarshalJSON(data []byte) error
• type ListProgramsRequest
• type ListPromptsRequest
• type ListRolesResponse
  • func (l *ListRolesResponse) GetData() []*RoleResponse
  • func (l *ListRolesResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListRolesResponse) String() string
  • func (l *ListRolesResponse) UnmarshalJSON(data []byte) error
• type ListSecrets
• type ListSheetCommitsRequest
• type ListSheetsRequest
• type ListSheetsResponse
  • func (l *ListSheetsResponse) GetData() []*Sheet
  • func (l *ListSheetsResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListSheetsResponse) String() string
  • func (l *ListSheetsResponse) UnmarshalJSON(data []byte) error
• type ListSnapshotRequest
• type ListSpacesRequest
• type ListSpacesResponse
  • func (l *ListSpacesResponse) GetData() []*Space
  • func (l *ListSpacesResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListSpacesResponse) GetPagination() *Pagination
  • func (l *ListSpacesResponse) String() string
  • func (l *ListSpacesResponse) UnmarshalJSON(data []byte) error
• type ListUsersRequest
• type ListUsersResponse
  • func (l *ListUsersResponse) GetData() []*User
  • func (l *ListUsersResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListUsersResponse) GetPagination() *Pagination
  • func (l *ListUsersResponse) String() string
  • func (l *ListUsersResponse) UnmarshalJSON(data []byte) error
• type ListUsersSortField
  • func NewListUsersSortFieldFromString(s string) (ListUsersSortField, error)
  • func (l ListUsersSortField) Ptr() *ListUsersSortField
• type ListViewsRequest
• type ListViewsResponse
  • func (l *ListViewsResponse) GetData() []*View
  • func (l *ListViewsResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListViewsResponse) GetPagination() *Pagination
  • func (l *ListViewsResponse) String() string
  • func (l *ListViewsResponse) UnmarshalJSON(data []byte) error
• type ListWorkbookCommitsRequest
• type ListWorkbooksRequest
• type ListWorkbooksResponse
  • func (l *ListWorkbooksResponse) GetData() []*Workbook
  • func (l *ListWorkbooksResponse) GetExtraProperties() map[string]interface{}
  • func (l *ListWorkbooksResponse) String() string
  • func (l *ListWorkbooksResponse) UnmarshalJSON(data []byte) error
• type MappingId
• type MappingProgramJobConfig
  • func (m *MappingProgramJobConfig) GetDestinationSheetId() SheetId
  • func (m *MappingProgramJobConfig) GetExtraProperties() map[string]interface{}
  • func (m *MappingProgramJobConfig) GetMappingRules() []map[string]interface{}
  • func (m *MappingProgramJobConfig) GetSourceSheetId() SheetId
  • func (m *MappingProgramJobConfig) String() string
  • func (m *MappingProgramJobConfig) UnmarshalJSON(data []byte) error
• type MappingRule
  • func (m *MappingRule) GetAcceptedAt() *time.Time
  • func (m *MappingRule) GetAcceptedBy() *UserId
  • func (m *MappingRule) GetConfidence() *int
  • func (m *MappingRule) GetConfig() interface{}
  • func (m *MappingRule) GetCreatedAt() time.Time
  • func (m *MappingRule) GetCreatedBy() *UserId
  • func (m *MappingRule) GetDeletedAt() *time.Time
  • func (m *MappingRule) GetExtraProperties() map[string]interface{}
  • func (m *MappingRule) GetId() MappingId
  • func (m *MappingRule) GetMetadata() interface{}
  • func (m *MappingRule) GetName() string
  • func (m *MappingRule) GetType() string
  • func (m *MappingRule) GetUpdatedAt() time.Time
  • func (m *MappingRule) MarshalJSON() ([]byte, error)
  • func (m *MappingRule) String() string
  • func (m *MappingRule) UnmarshalJSON(data []byte) error
• type MappingRuleConfig
  • func (m *MappingRuleConfig) GetAcceptedAt() *time.Time
  • func (m *MappingRuleConfig) GetAcceptedBy() *UserId
  • func (m *MappingRuleConfig) GetConfig() interface{}
  • func (m *MappingRuleConfig) GetExtraProperties() map[string]interface{}
  • func (m *MappingRuleConfig) GetMetadata() interface{}
  • func (m *MappingRuleConfig) GetName() string
  • func (m *MappingRuleConfig) GetType() string
  • func (m *MappingRuleConfig) MarshalJSON() ([]byte, error)
  • func (m *MappingRuleConfig) String() string
  • func (m *MappingRuleConfig) UnmarshalJSON(data []byte) error
• type MappingRuleOrConfig
  • func (m *MappingRuleOrConfig) GetAcceptedAt() *time.Time
  • func (m *MappingRuleOrConfig) GetAcceptedBy() *UserId
  • func (m *MappingRuleOrConfig) GetConfidence() *int
  • func (m *MappingRuleOrConfig) GetConfig() interface{}
  • func (m *MappingRuleOrConfig) GetCreatedAt() *time.Time
  • func (m *MappingRuleOrConfig) GetCreatedBy() *UserId
  • func (m *MappingRuleOrConfig) GetDeletedAt() *time.Time
  • func (m *MappingRuleOrConfig) GetExtraProperties() map[string]interface{}
  • func (m *MappingRuleOrConfig) GetId() *MappingId
  • func (m *MappingRuleOrConfig) GetMetadata() interface{}
  • func (m *MappingRuleOrConfig) GetName() string
  • func (m *MappingRuleOrConfig) GetType() string
  • func (m *MappingRuleOrConfig) GetUpdatedAt() *time.Time
  • func (m *MappingRuleOrConfig) MarshalJSON() ([]byte, error)
  • func (m *MappingRuleOrConfig) String() string
  • func (m *MappingRuleOrConfig) UnmarshalJSON(data []byte) error
• type MappingRuleResponse
  • func (m *MappingRuleResponse) GetData() *MappingRule
  • func (m *MappingRuleResponse) GetExtraProperties() map[string]interface{}
  • func (m *MappingRuleResponse) String() string
  • func (m *MappingRuleResponse) UnmarshalJSON(data []byte) error
• type MappingRulesResponse
  • func (m *MappingRulesResponse) GetData() []*MappingRule
  • func (m *MappingRulesResponse) GetExtraProperties() map[string]interface{}
  • func (m *MappingRulesResponse) String() string
  • func (m *MappingRulesResponse) UnmarshalJSON(data []byte) error
• type Metadata
  • func (m *Metadata) GetCertainty() *Certainty
  • func (m *Metadata) GetConfidence() *float64
  • func (m *Metadata) GetDetectedDelimiter() *string
  • func (m *Metadata) GetExtraProperties() map[string]interface{}
  • func (m *Metadata) GetSource() *string
  • func (m *Metadata) String() string
  • func (m *Metadata) UnmarshalJSON(data []byte) error
• type Mode
  • func NewModeFromString(s string) (Mode, error)
  • func (m Mode) Ptr() *Mode
• type ModelFileStatusEnum
  • func NewModelFileStatusEnumFromString(s string) (ModelFileStatusEnum, error)
  • func (m ModelFileStatusEnum) Ptr() *ModelFileStatusEnum
• type MutateJobConfig
  • func (m *MutateJobConfig) GetExtraProperties() map[string]interface{}
  • func (m *MutateJobConfig) GetFilter() *Filter
  • func (m *MutateJobConfig) GetFilterField() *FilterField
  • func (m *MutateJobConfig) GetIds() []RecordId
  • func (m *MutateJobConfig) GetMutateRecord() string
  • func (m *MutateJobConfig) GetMutationId() *string
  • func (m *MutateJobConfig) GetQ() *string
  • func (m *MutateJobConfig) GetSearchField() *SearchField
  • func (m *MutateJobConfig) GetSearchValue() *SearchValue
  • func (m *MutateJobConfig) GetSheetId() SheetId
  • func (m *MutateJobConfig) GetSnapshotId() *string
  • func (m *MutateJobConfig) GetSnapshotLabel() *string
  • func (m *MutateJobConfig) String() string
  • func (m *MutateJobConfig) UnmarshalJSON(data []byte) error
• type NotFoundError
  • func (n *NotFoundError) MarshalJSON() ([]byte, error)
  • func (n *NotFoundError) UnmarshalJSON(data []byte) error
  • func (n *NotFoundError) Unwrap() error
• type NumberConfig
  • func (n *NumberConfig) GetDecimalPlaces() *int
  • func (n *NumberConfig) GetExtraProperties() map[string]interface{}
  • func (n *NumberConfig) String() string
  • func (n *NumberConfig) UnmarshalJSON(data []byte) error
• type NumberProperty
  • func (n *NumberProperty) GetActions() []*Action
  • func (n *NumberProperty) GetAlternativeNames() []string
  • func (n *NumberProperty) GetAppearance() *FieldAppearance
  • func (n *NumberProperty) GetConfig() *NumberConfig
  • func (n *NumberProperty) GetConstraints() []*Constraint
  • func (n *NumberProperty) GetDescription() *string
  • func (n *NumberProperty) GetExtraProperties() map[string]interface{}
  • func (n *NumberProperty) GetIsArray() *bool
  • func (n *NumberProperty) GetKey() string
  • func (n *NumberProperty) GetLabel() *string
  • func (n *NumberProperty) GetMetadata() interface{}
  • func (n *NumberProperty) GetReadonly() *bool
  • func (n *NumberProperty) GetTreatments() []string
  • func (n *NumberProperty) String() string
  • func (n *NumberProperty) UnmarshalJSON(data []byte) error
• type Origin
  • func (o *Origin) GetExtraProperties() map[string]interface{}
  • func (o *Origin) GetId() *string
  • func (o *Origin) GetSlug() *string
  • func (o *Origin) String() string
  • func (o *Origin) UnmarshalJSON(data []byte) error
• type PageNumber
• type PageSize
• type Pagination
  • func (p *Pagination) GetCurrentPage() int
  • func (p *Pagination) GetExtraProperties() map[string]interface{}
  • func (p *Pagination) GetPageCount() int
  • func (p *Pagination) GetTotalCount() int
  • func (p *Pagination) String() string
  • func (p *Pagination) UnmarshalJSON(data []byte) error
• type PipelineJobConfig
  • func (p *PipelineJobConfig) GetDestinationSheetId() SheetId
  • func (p *PipelineJobConfig) GetExtraProperties() map[string]interface{}
  • func (p *PipelineJobConfig) GetSourceSheetId() SheetId
  • func (p *PipelineJobConfig) String() string
  • func (p *PipelineJobConfig) UnmarshalJSON(data []byte) error
• type Program
  • func (p *Program) GetAccessToken() *string
  • func (p *Program) GetCreatedAt() *time.Time
  • func (p *Program) GetCreatedBy() *UserId
  • func (p *Program) GetDestinationKeys() []string
  • func (p *Program) GetExtraProperties() map[string]interface{}
  • func (p *Program) GetFamilyId() *FamilyId
  • func (p *Program) GetId() *string
  • func (p *Program) GetNamespace() *string
  • func (p *Program) GetRules() []*MappingRuleOrConfig
  • func (p *Program) GetSourceKeys() []string
  • func (p *Program) GetSummary() *ProgramSummary
  • func (p *Program) MarshalJSON() ([]byte, error)
  • func (p *Program) String() string
  • func (p *Program) UnmarshalJSON(data []byte) error
• type ProgramConfig
  • func (p *ProgramConfig) GetDestination() *SheetConfig
  • func (p *ProgramConfig) GetExtraProperties() map[string]interface{}
  • func (p *ProgramConfig) GetFamilyId() *FamilyId
  • func (p *ProgramConfig) GetNamespace() *string
  • func (p *ProgramConfig) GetSave() *bool
  • func (p *ProgramConfig) GetSource() *SheetConfig
  • func (p *ProgramConfig) String() string
  • func (p *ProgramConfig) UnmarshalJSON(data []byte) error
• type ProgramId
• type ProgramResponse
  • func (p *ProgramResponse) GetData() *Program
  • func (p *ProgramResponse) GetExtraProperties() map[string]interface{}
  • func (p *ProgramResponse) String() string
  • func (p *ProgramResponse) UnmarshalJSON(data []byte) error
• type ProgramSummary
  • func (p *ProgramSummary) GetAddedRuleCount() int
  • func (p *ProgramSummary) GetDeletedRuleCount() int
  • func (p *ProgramSummary) GetExtraProperties() map[string]interface{}
  • func (p *ProgramSummary) GetTotalRuleCount() int
  • func (p *ProgramSummary) String() string
  • func (p *ProgramSummary) UnmarshalJSON(data []byte) error
• type ProgramsResponse
  • func (p *ProgramsResponse) GetData() []*Program
  • func (p *ProgramsResponse) GetExtraProperties() map[string]interface{}
  • func (p *ProgramsResponse) String() string
  • func (p *ProgramsResponse) UnmarshalJSON(data []byte) error
• type Progress
  • func (p *Progress) GetCurrent() *int
  • func (p *Progress) GetExtraProperties() map[string]interface{}
  • func (p *Progress) GetPercent() *int
  • func (p *Progress) GetTotal() *int
  • func (p *Progress) String() string
  • func (p *Progress) UnmarshalJSON(data []byte) error
• type Prompt
  • func (p *Prompt) GetAccountId() AccountId
  • func (p *Prompt) GetCreatedAt() time.Time
  • func (p *Prompt) GetCreatedById() string
  • func (p *Prompt) GetDeletedAt() *time.Time
  • func (p *Prompt) GetEnvironmentId() *EnvironmentId
  • func (p *Prompt) GetExtraProperties() map[string]interface{}
  • func (p *Prompt) GetId() PromptId
  • func (p *Prompt) GetPrompt() string
  • func (p *Prompt) GetPromptType() PromptTypeEnum
  • func (p *Prompt) GetSpaceId() *SpaceId
  • func (p *Prompt) GetUpdatedAt() time.Time
  • func (p *Prompt) MarshalJSON() ([]byte, error)
  • func (p *Prompt) String() string
  • func (p *Prompt) UnmarshalJSON(data []byte) error
• type PromptCreate
  • func (p *PromptCreate) GetEnvironmentId() EnvironmentId
  • func (p *PromptCreate) GetExtraProperties() map[string]interface{}
  • func (p *PromptCreate) GetPrompt() string
  • func (p *PromptCreate) GetPromptType() *PromptTypeEnum
  • func (p *PromptCreate) GetSpaceId() SpaceId
  • func (p *PromptCreate) String() string
  • func (p *PromptCreate) UnmarshalJSON(data []byte) error
• type PromptId
• type PromptPatch
  • func (p *PromptPatch) GetExtraProperties() map[string]interface{}
  • func (p *PromptPatch) GetPrompt() string
  • func (p *PromptPatch) String() string
  • func (p *PromptPatch) UnmarshalJSON(data []byte) error
• type PromptResponse
  • func (p *PromptResponse) GetData() *Prompt
  • func (p *PromptResponse) GetExtraProperties() map[string]interface{}
  • func (p *PromptResponse) String() string
  • func (p *PromptResponse) UnmarshalJSON(data []byte) error
• type PromptTypeEnum
  • func NewPromptTypeEnumFromString(s string) (PromptTypeEnum, error)
  • func (p PromptTypeEnum) Ptr() *PromptTypeEnum
• type PromptTypeQueryEnum
  • func NewPromptTypeQueryEnumFromString(s string) (PromptTypeQueryEnum, error)
  • func (p PromptTypeQueryEnum) Ptr() *PromptTypeQueryEnum
• type PromptsResponse
  • func (p *PromptsResponse) GetData() []*Prompt
  • func (p *PromptsResponse) GetExtraProperties() map[string]interface{}
  • func (p *PromptsResponse) GetPagination() *Pagination
  • func (p *PromptsResponse) String() string
  • func (p *PromptsResponse) UnmarshalJSON(data []byte) error
• type Property
  • func NewPropertyFromBoolean(value *BooleanProperty) *Property
  • func NewPropertyFromDate(value *DateProperty) *Property
  • func NewPropertyFromEnum(value *EnumProperty) *Property
  • func NewPropertyFromEnumList(value *EnumListProperty) *Property
  • func NewPropertyFromNumber(value *NumberProperty) *Property
  • func NewPropertyFromReference(value *ReferenceProperty) *Property
  • func NewPropertyFromReferenceList(value *ReferenceListProperty) *Property
  • func NewPropertyFromString(value *StringProperty) *Property
  • func NewPropertyFromStringList(value *StringListProperty) *Property
  • func (p *Property) Accept(visitor PropertyVisitor) error
  • func (p *Property) GetBoolean() *BooleanProperty
  • func (p *Property) GetDate() *DateProperty
  • func (p *Property) GetEnum() *EnumProperty
  • func (p *Property) GetEnumList() *EnumListProperty
  • func (p *Property) GetNumber() *NumberProperty
  • func (p *Property) GetReference() *ReferenceProperty
  • func (p *Property) GetReferenceList() *ReferenceListProperty
  • func (p *Property) GetString() *StringProperty
  • func (p *Property) GetStringList() *StringListProperty
  • func (p *Property) GetType() string
  • func (p Property) MarshalJSON() ([]byte, error)
  • func (p *Property) UnmarshalJSON(data []byte) error
• type PropertyVisitor
• type Record
  • func (r *Record) GetCommitId() *CommitId
  • func (r *Record) GetConfig() *RecordConfig
  • func (r *Record) GetExtraProperties() map[string]interface{}
  • func (r *Record) GetId() RecordId
  • func (r *Record) GetMessages() []*ValidationMessage
  • func (r *Record) GetMetadata() map[string]interface{}
  • func (r *Record) GetValid() *bool
  • func (r *Record) GetValues() RecordData
  • func (r *Record) GetVersionId() *VersionId
  • func (r *Record) String() string
  • func (r *Record) UnmarshalJSON(data []byte) error
• type RecordBase
  • func (r *RecordBase) GetCommitId() *CommitId
  • func (r *RecordBase) GetConfig() *RecordConfig
  • func (r *RecordBase) GetExtraProperties() map[string]interface{}
  • func (r *RecordBase) GetId() RecordId
  • func (r *RecordBase) GetMessages() []*ValidationMessage
  • func (r *RecordBase) GetMetadata() map[string]interface{}
  • func (r *RecordBase) GetValid() *bool
  • func (r *RecordBase) GetVersionId() *VersionId
  • func (r *RecordBase) String() string
  • func (r *RecordBase) UnmarshalJSON(data []byte) error
• type RecordConfig
  • func (r *RecordConfig) GetExtraProperties() map[string]interface{}
  • func (r *RecordConfig) GetFields() map[string]*CellConfig
  • func (r *RecordConfig) GetMarkedForDeletion() *bool
  • func (r *RecordConfig) GetReadonly() *bool
  • func (r *RecordConfig) String() string
  • func (r *RecordConfig) UnmarshalJSON(data []byte) error
• type RecordCounts
  • func (r *RecordCounts) GetByField() map[string]*FieldRecordCounts
  • func (r *RecordCounts) GetError() int
  • func (r *RecordCounts) GetErrorsByField() map[string]int
  • func (r *RecordCounts) GetExtraProperties() map[string]interface{}
  • func (r *RecordCounts) GetTotal() int
  • func (r *RecordCounts) GetValid() int
  • func (r *RecordCounts) String() string
  • func (r *RecordCounts) UnmarshalJSON(data []byte) error
• type RecordCountsResponse
  • func (r *RecordCountsResponse) GetData() *RecordCountsResponseData
  • func (r *RecordCountsResponse) GetExtraProperties() map[string]interface{}
  • func (r *RecordCountsResponse) String() string
  • func (r *RecordCountsResponse) UnmarshalJSON(data []byte) error
• type RecordCountsResponseData
  • func (r *RecordCountsResponseData) GetCounts() *RecordCounts
  • func (r *RecordCountsResponseData) GetExtraProperties() map[string]interface{}
  • func (r *RecordCountsResponseData) GetSuccess() bool
  • func (r *RecordCountsResponseData) String() string
  • func (r *RecordCountsResponseData) UnmarshalJSON(data []byte) error
• type RecordData
• type RecordDataWithLinks
• type RecordId
• type RecordIndices
  • func (r *RecordIndices) GetExtraProperties() map[string]interface{}
  • func (r *RecordIndices) GetId() string
  • func (r *RecordIndices) GetIndex() int
  • func (r *RecordIndices) String() string
  • func (r *RecordIndices) UnmarshalJSON(data []byte) error
• type RecordWithLinks
  • func (r *RecordWithLinks) GetConfig() *RecordConfig
  • func (r *RecordWithLinks) GetExtraProperties() map[string]interface{}
  • func (r *RecordWithLinks) GetId() RecordId
  • func (r *RecordWithLinks) GetMessages() []*ValidationMessage
  • func (r *RecordWithLinks) GetMetadata() map[string]interface{}
  • func (r *RecordWithLinks) GetValid() *bool
  • func (r *RecordWithLinks) GetValues() RecordDataWithLinks
  • func (r *RecordWithLinks) String() string
  • func (r *RecordWithLinks) UnmarshalJSON(data []byte) error
• type Records
• type RecordsResponse
  • func (r *RecordsResponse) GetData() *RecordsResponseData
  • func (r *RecordsResponse) GetExtraProperties() map[string]interface{}
  • func (r *RecordsResponse) String() string
  • func (r *RecordsResponse) UnmarshalJSON(data []byte) error
• type RecordsResponseData
  • func (r *RecordsResponseData) GetCommitId() *CommitId
  • func (r *RecordsResponseData) GetCounts() *RecordCounts
  • func (r *RecordsResponseData) GetExtraProperties() map[string]interface{}
  • func (r *RecordsResponseData) GetRecords() *RecordsWithLinks
  • func (r *RecordsResponseData) GetSuccess() bool
  • func (r *RecordsResponseData) GetVersionId() *VersionId
  • func (r *RecordsResponseData) String() string
  • func (r *RecordsResponseData) UnmarshalJSON(data []byte) error
• type RecordsWithLinks
• type ReferenceListProperty
  • func (r *ReferenceListProperty) GetActions() []*Action
  • func (r *ReferenceListProperty) GetAlternativeNames() []string
  • func (r *ReferenceListProperty) GetAppearance() *FieldAppearance
  • func (r *ReferenceListProperty) GetConfig() *ReferenceListPropertyConfig
  • func (r *ReferenceListProperty) GetConstraints() []*Constraint
  • func (r *ReferenceListProperty) GetDescription() *string
  • func (r *ReferenceListProperty) GetExtraProperties() map[string]interface{}
  • func (r *ReferenceListProperty) GetIsArray() *bool
  • func (r *ReferenceListProperty) GetKey() string
  • func (r *ReferenceListProperty) GetLabel() *string
  • func (r *ReferenceListProperty) GetMetadata() interface{}
  • func (r *ReferenceListProperty) GetReadonly() *bool
  • func (r *ReferenceListProperty) GetTreatments() []string
  • func (r *ReferenceListProperty) String() string
  • func (r *ReferenceListProperty) UnmarshalJSON(data []byte) error
• type ReferenceListPropertyConfig
  • func (r *ReferenceListPropertyConfig) GetExtraProperties() map[string]interface{}
  • func (r *ReferenceListPropertyConfig) GetKey() string
  • func (r *ReferenceListPropertyConfig) GetRef() string
  • func (r *ReferenceListPropertyConfig) String() string
  • func (r *ReferenceListPropertyConfig) UnmarshalJSON(data []byte) error
• type ReferenceProperty
  • func (r *ReferenceProperty) GetActions() []*Action
  • func (r *ReferenceProperty) GetAlternativeNames() []string
  • func (r *ReferenceProperty) GetAppearance() *FieldAppearance
  • func (r *ReferenceProperty) GetConfig() *ReferencePropertyConfig
  • func (r *ReferenceProperty) GetConstraints() []*Constraint
  • func (r *ReferenceProperty) GetDescription() *string
  • func (r *ReferenceProperty) GetExtraProperties() map[string]interface{}
  • func (r *ReferenceProperty) GetIsArray() *bool
  • func (r *ReferenceProperty) GetKey() string
  • func (r *ReferenceProperty) GetLabel() *string
  • func (r *ReferenceProperty) GetMetadata() interface{}
  • func (r *ReferenceProperty) GetReadonly() *bool
  • func (r *ReferenceProperty) GetTreatments() []string
  • func (r *ReferenceProperty) String() string
  • func (r *ReferenceProperty) UnmarshalJSON(data []byte) error
• type ReferencePropertyConfig
  • func (r *ReferencePropertyConfig) GetExtraProperties() map[string]interface{}
  • func (r *ReferencePropertyConfig) GetKey() string
  • func (r *ReferencePropertyConfig) GetRef() string
  • func (r *ReferencePropertyConfig) GetRelationship() *ReferencePropertyRelationship
  • func (r *ReferencePropertyConfig) String() string
  • func (r *ReferencePropertyConfig) UnmarshalJSON(data []byte) error
• type ReferencePropertyRelationship
  • func NewReferencePropertyRelationshipFromString(s string) (ReferencePropertyRelationship, error)
  • func (r ReferencePropertyRelationship) Ptr() *ReferencePropertyRelationship
• type Resolve
  • func (r *Resolve) GetClipValueReference() *string
  • func (r *Resolve) GetExtraProperties() map[string]interface{}
  • func (r *Resolve) GetField() *string
  • func (r *Resolve) GetMainValueReference() *string
  • func (r *Resolve) GetResolveTo() *ResolveTo
  • func (r *Resolve) GetType() *ResolveType
  • func (r *Resolve) String() string
  • func (r *Resolve) UnmarshalJSON(data []byte) error
• type ResolveTo
  • func NewResolveToFromString(s string) (ResolveTo, error)
  • func (r ResolveTo) Ptr() *ResolveTo
• type ResolveType
  • func NewResolveTypeFromString(s string) (ResolveType, error)
  • func (r ResolveType) Ptr() *ResolveType
• type ResourceIdUnion
  • func NewResourceIdUnionFromAccountId(value AccountId) *ResourceIdUnion
  • func NewResourceIdUnionFromEnvironmentId(value EnvironmentId) *ResourceIdUnion
  • func NewResourceIdUnionFromSpaceId(value SpaceId) *ResourceIdUnion
  • func (r *ResourceIdUnion) Accept(visitor ResourceIdUnionVisitor) error
  • func (r *ResourceIdUnion) GetAccountId() AccountId
  • func (r *ResourceIdUnion) GetEnvironmentId() EnvironmentId
  • func (r *ResourceIdUnion) GetSpaceId() SpaceId
  • func (r ResourceIdUnion) MarshalJSON() ([]byte, error)
  • func (r *ResourceIdUnion) UnmarshalJSON(data []byte) error
• type ResourceIdUnionVisitor
• type ResourceJobSubject
  • func (r *ResourceJobSubject) GetExtraProperties() map[string]interface{}
  • func (r *ResourceJobSubject) GetId() string
  • func (r *ResourceJobSubject) String() string
  • func (r *ResourceJobSubject) UnmarshalJSON(data []byte) error
• type RestoreOptions
  • func (r *RestoreOptions) GetCreated() bool
  • func (r *RestoreOptions) GetDeleted() bool
  • func (r *RestoreOptions) GetExtraProperties() map[string]interface{}
  • func (r *RestoreOptions) GetUpdated() bool
  • func (r *RestoreOptions) String() string
  • func (r *RestoreOptions) UnmarshalJSON(data []byte) error
• type RoleEnum
  • func NewRoleEnumFromString(s string) (RoleEnum, error)
  • func (r RoleEnum) Ptr() *RoleEnum
• type RoleId
• type RoleResponse
  • func (r *RoleResponse) GetAccountId() AccountId
  • func (r *RoleResponse) GetCreatedAt() time.Time
  • func (r *RoleResponse) GetExtraProperties() map[string]interface{}
  • func (r *RoleResponse) GetId() RoleId
  • func (r *RoleResponse) GetName() string
  • func (r *RoleResponse) GetUpdatedAt() time.Time
  • func (r *RoleResponse) MarshalJSON() ([]byte, error)
  • func (r *RoleResponse) String() string
  • func (r *RoleResponse) UnmarshalJSON(data []byte) error
• type SchemaDiffData
• type SchemaDiffEnum
  • func NewSchemaDiffEnumFromString(s string) (SchemaDiffEnum, error)
  • func (s SchemaDiffEnum) Ptr() *SchemaDiffEnum
• type SchemaDiffRecord
• type SearchField
• type SearchValue
• type Secret
  • func (s *Secret) GetActorId() *ActorIdUnion
  • func (s *Secret) GetEnvironmentId() *EnvironmentId
  • func (s *Secret) GetExtraProperties() map[string]interface{}
  • func (s *Secret) GetId() SecretId
  • func (s *Secret) GetName() SecretName
  • func (s *Secret) GetSpaceId() *SpaceId
  • func (s *Secret) GetValue() SecretValue
  • func (s *Secret) String() string
  • func (s *Secret) UnmarshalJSON(data []byte) error
• type SecretId
• type SecretName
• type SecretValue
• type SecretsResponse
  • func (s *SecretsResponse) GetData() []*Secret
  • func (s *SecretsResponse) GetExtraProperties() map[string]interface{}
  • func (s *SecretsResponse) String() string
  • func (s *SecretsResponse) UnmarshalJSON(data []byte) error
• type Sheet
  • func (s *Sheet) GetConfig() *SheetConfig
  • func (s *Sheet) GetCreatedAt() time.Time
  • func (s *Sheet) GetExtraProperties() map[string]interface{}
  • func (s *Sheet) GetId() SheetId
  • func (s *Sheet) GetLockedAt() *time.Time
  • func (s *Sheet) GetLockedBy() *string
  • func (s *Sheet) GetMetadata() interface{}
  • func (s *Sheet) GetName() string
  • func (s *Sheet) GetNamespace() *string
  • func (s *Sheet) GetRecordCounts() *RecordCounts
  • func (s *Sheet) GetSlug() string
  • func (s *Sheet) GetUpdatedAt() time.Time
  • func (s *Sheet) GetWorkbookId() WorkbookId
  • func (s *Sheet) MarshalJSON() ([]byte, error)
  • func (s *Sheet) String() string
  • func (s *Sheet) UnmarshalJSON(data []byte) error
• type SheetAccess
  • func NewSheetAccessFromString(s string) (SheetAccess, error)
  • func (s SheetAccess) Ptr() *SheetAccess
• type SheetConfig
  • func (s *SheetConfig) GetAccess() []SheetAccess
  • func (s *SheetConfig) GetActions() []*Action
  • func (s *SheetConfig) GetAllowAdditionalFields() *bool
  • func (s *SheetConfig) GetConstraints() []*SheetConstraint
  • func (s *SheetConfig) GetDescription() *string
  • func (s *SheetConfig) GetExtraProperties() map[string]interface{}
  • func (s *SheetConfig) GetFields() []*Property
  • func (s *SheetConfig) GetMappingConfidenceThreshold() *float64
  • func (s *SheetConfig) GetMetadata() interface{}
  • func (s *SheetConfig) GetName() string
  • func (s *SheetConfig) GetReadonly() *bool
  • func (s *SheetConfig) GetSlug() *string
  • func (s *SheetConfig) String() string
  • func (s *SheetConfig) UnmarshalJSON(data []byte) error
• type SheetConfigOrUpdate
  • func (s *SheetConfigOrUpdate) GetAccess() []SheetAccess
  • func (s *SheetConfigOrUpdate) GetActions() []*Action
  • func (s *SheetConfigOrUpdate) GetAllowAdditionalFields() *bool
  • func (s *SheetConfigOrUpdate) GetConfig() *SheetConfig
  • func (s *SheetConfigOrUpdate) GetCreatedAt() *time.Time
  • func (s *SheetConfigOrUpdate) GetDescription() *string
  • func (s *SheetConfigOrUpdate) GetExtraProperties() map[string]interface{}
  • func (s *SheetConfigOrUpdate) GetFields() []*Property
  • func (s *SheetConfigOrUpdate) GetId() *SheetId
  • func (s *SheetConfigOrUpdate) GetMappingConfidenceThreshold() *float64
  • func (s *SheetConfigOrUpdate) GetMetadata() interface{}
  • func (s *SheetConfigOrUpdate) GetName() *string
  • func (s *SheetConfigOrUpdate) GetNamespace() *string
  • func (s *SheetConfigOrUpdate) GetReadonly() *bool
  • func (s *SheetConfigOrUpdate) GetSlug() *string
  • func (s *SheetConfigOrUpdate) GetUpdatedAt() *time.Time
  • func (s *SheetConfigOrUpdate) GetWorkbookId() *WorkbookId
  • func (s *SheetConfigOrUpdate) MarshalJSON() ([]byte, error)
  • func (s *SheetConfigOrUpdate) String() string
  • func (s *SheetConfigOrUpdate) UnmarshalJSON(data []byte) error
• type SheetConfigUpdate
  • func (s *SheetConfigUpdate) GetAccess() []SheetAccess
  • func (s *SheetConfigUpdate) GetActions() []*Action
  • func (s *SheetConfigUpdate) GetAllowAdditionalFields() *bool
  • func (s *SheetConfigUpdate) GetDescription() *string
  • func (s *SheetConfigUpdate) GetExtraProperties() map[string]interface{}
  • func (s *SheetConfigUpdate) GetFields() []*Property
  • func (s *SheetConfigUpdate) GetMappingConfidenceThreshold() *float64
  • func (s *SheetConfigUpdate) GetName() *string
  • func (s *SheetConfigUpdate) GetReadonly() *bool
  • func (s *SheetConfigUpdate) GetSlug() *string
  • func (s *SheetConfigUpdate) String() string
  • func (s *SheetConfigUpdate) UnmarshalJSON(data []byte) error
• type SheetConstraint
  • func NewSheetConstraintFromExternal(value *ExternalSheetConstraint) *SheetConstraint
  • func NewSheetConstraintFromUnique(value *CompositeUniqueConstraint) *SheetConstraint
  • func (s *SheetConstraint) Accept(visitor SheetConstraintVisitor) error
  • func (s *SheetConstraint) GetExternal() *ExternalSheetConstraint
  • func (s *SheetConstraint) GetType() string
  • func (s *SheetConstraint) GetUnique() *CompositeUniqueConstraint
  • func (s SheetConstraint) MarshalJSON() ([]byte, error)
  • func (s *SheetConstraint) UnmarshalJSON(data []byte) error
• type SheetConstraintVisitor
• type SheetId
• type SheetResponse
  • func (s *SheetResponse) GetData() *Sheet
  • func (s *SheetResponse) GetExtraProperties() map[string]interface{}
  • func (s *SheetResponse) String() string
  • func (s *SheetResponse) UnmarshalJSON(data []byte) error
• type SheetSlug
• type SheetUpdate
  • func (s *SheetUpdate) GetConfig() *SheetConfig
  • func (s *SheetUpdate) GetCreatedAt() *time.Time
  • func (s *SheetUpdate) GetExtraProperties() map[string]interface{}
  • func (s *SheetUpdate) GetId() *SheetId
  • func (s *SheetUpdate) GetMetadata() interface{}
  • func (s *SheetUpdate) GetNamespace() *string
  • func (s *SheetUpdate) GetUpdatedAt() *time.Time
  • func (s *SheetUpdate) GetWorkbookId() *WorkbookId
  • func (s *SheetUpdate) MarshalJSON() ([]byte, error)
  • func (s *SheetUpdate) String() string
  • func (s *SheetUpdate) UnmarshalJSON(data []byte) error
• type SheetUpdateRequest
  • func (s *SheetUpdateRequest) GetExtraProperties() map[string]interface{}
  • func (s *SheetUpdateRequest) GetMetadata() interface{}
  • func (s *SheetUpdateRequest) GetName() *string
  • func (s *SheetUpdateRequest) GetSlug() *string
  • func (s *SheetUpdateRequest) String() string
  • func (s *SheetUpdateRequest) UnmarshalJSON(data []byte) error
• type Snapshot
  • func (s *Snapshot) GetCreatedAt() time.Time
  • func (s *Snapshot) GetCreatedBy() UserId
  • func (s *Snapshot) GetExtraProperties() map[string]interface{}
  • func (s *Snapshot) GetId() SnapshotId
  • func (s *Snapshot) GetLabel() *string
  • func (s *Snapshot) GetSheetId() SheetId
  • func (s *Snapshot) GetSummary() *SnapshotSummary
  • func (s *Snapshot) GetThreadId() *string
  • func (s *Snapshot) MarshalJSON() ([]byte, error)
  • func (s *Snapshot) String() string
  • func (s *Snapshot) UnmarshalJSON(data []byte) error
• type SnapshotId
• type SnapshotResponse
  • func (s *SnapshotResponse) GetData() *Snapshot
  • func (s *SnapshotResponse) GetExtraProperties() map[string]interface{}
  • func (s *SnapshotResponse) String() string
  • func (s *SnapshotResponse) UnmarshalJSON(data []byte) error
• type SnapshotSummary
  • func (s *SnapshotSummary) GetConfig() *SheetConfig
  • func (s *SnapshotSummary) GetCreatedSince() *SummarySection
  • func (s *SnapshotSummary) GetDeletedSince() *SummarySection
  • func (s *SnapshotSummary) GetExtraProperties() map[string]interface{}
  • func (s *SnapshotSummary) GetSchemaDiff() SchemaDiffRecord
  • func (s *SnapshotSummary) GetUpdatedSince() *SummarySection
  • func (s *SnapshotSummary) String() string
  • func (s *SnapshotSummary) UnmarshalJSON(data []byte) error
• type SnapshotsResponse
  • func (s *SnapshotsResponse) GetData() []*Snapshot
  • func (s *SnapshotsResponse) GetExtraProperties() map[string]interface{}
  • func (s *SnapshotsResponse) String() string
  • func (s *SnapshotsResponse) UnmarshalJSON(data []byte) error
• type SortDirection
  • func NewSortDirectionFromString(s string) (SortDirection, error)
  • func (s SortDirection) Ptr() *SortDirection
• type SortField
• type SourceField
  • func (s *SourceField) GetExtraProperties() map[string]interface{}
  • func (s *SourceField) GetPreview() []string
  • func (s *SourceField) GetSourceField() *Property
  • func (s *SourceField) String() string
  • func (s *SourceField) UnmarshalJSON(data []byte) error
• type Space
  • func (s *Space) GetAccess() []SpaceAccess
  • func (s *Space) GetAccessToken() *string
  • func (s *Space) GetActions() []*Action
  • func (s *Space) GetAppId() *AppId
  • func (s *Space) GetArchivedAt() *time.Time
  • func (s *Space) GetAutoConfigure() *bool
  • func (s *Space) GetCreatedAt() time.Time
  • func (s *Space) GetCreatedByUserId() *UserId
  • func (s *Space) GetCreatedByUserName() *string
  • func (s *Space) GetDisplayOrder() *int
  • func (s *Space) GetEnvironmentId() *EnvironmentId
  • func (s *Space) GetExpiredAt() *time.Time
  • func (s *Space) GetExtraProperties() map[string]interface{}
  • func (s *Space) GetFilesCount() *int
  • func (s *Space) GetGuestAuthentication() []GuestAuthenticationEnum
  • func (s *Space) GetGuestLink() *string
  • func (s *Space) GetId() SpaceId
  • func (s *Space) GetIsAppTemplate() *bool
  • func (s *Space) GetIsCollaborative() *bool
  • func (s *Space) GetLabels() []string
  • func (s *Space) GetLanguageOverride() *string
  • func (s *Space) GetLastActivityAt() *time.Time
  • func (s *Space) GetMetadata() interface{}
  • func (s *Space) GetName() string
  • func (s *Space) GetNamespace() *string
  • func (s *Space) GetPrimaryWorkbookId() *WorkbookId
  • func (s *Space) GetSettings() *SpaceSettings
  • func (s *Space) GetSize() *SpaceSize
  • func (s *Space) GetSpaceConfigId() *SpaceConfigId
  • func (s *Space) GetTranslationsPath() *string
  • func (s *Space) GetUpdatedAt() time.Time
  • func (s *Space) GetUpgradedAt() *time.Time
  • func (s *Space) GetWorkbooksCount() *int
  • func (s *Space) MarshalJSON() ([]byte, error)
  • func (s *Space) String() string
  • func (s *Space) UnmarshalJSON(data []byte) error
• type SpaceAccess
  • func NewSpaceAccessFromString(s string) (SpaceAccess, error)
  • func (s SpaceAccess) Ptr() *SpaceAccess
• type SpaceConfig
  • func (s *SpaceConfig) GetAccess() []SpaceAccess
  • func (s *SpaceConfig) GetActions() []*Action
  • func (s *SpaceConfig) GetAppId() *AppId
  • func (s *SpaceConfig) GetArchivedAt() *time.Time
  • func (s *SpaceConfig) GetAutoConfigure() *bool
  • func (s *SpaceConfig) GetDisplayOrder() *int
  • func (s *SpaceConfig) GetEnvironmentId() *EnvironmentId
  • func (s *SpaceConfig) GetExtraProperties() map[string]interface{}
  • func (s *SpaceConfig) GetGuestAuthentication() []GuestAuthenticationEnum
  • func (s *SpaceConfig) GetIsAppTemplate() *bool
  • func (s *SpaceConfig) GetLabels() []string
  • func (s *SpaceConfig) GetLanguageOverride() *string
  • func (s *SpaceConfig) GetMetadata() interface{}
  • func (s *SpaceConfig) GetName() *string
  • func (s *SpaceConfig) GetNamespace() *string
  • func (s *SpaceConfig) GetPrimaryWorkbookId() *WorkbookId
  • func (s *SpaceConfig) GetSettings() *SpaceSettings
  • func (s *SpaceConfig) GetSpaceConfigId() *SpaceConfigId
  • func (s *SpaceConfig) GetTranslationsPath() *string
  • func (s *SpaceConfig) MarshalJSON() ([]byte, error)
  • func (s *SpaceConfig) String() string
  • func (s *SpaceConfig) UnmarshalJSON(data []byte) error
• type SpaceConfigId
• type SpaceId
• type SpaceResponse
  • func (s *SpaceResponse) GetData() *Space
  • func (s *SpaceResponse) GetExtraProperties() map[string]interface{}
  • func (s *SpaceResponse) String() string
  • func (s *SpaceResponse) UnmarshalJSON(data []byte) error
• type SpaceSettings
  • func (s *SpaceSettings) GetExtraProperties() map[string]interface{}
  • func (s *SpaceSettings) GetSidebarConfig() *SpaceSidebarConfig
  • func (s *SpaceSettings) String() string
  • func (s *SpaceSettings) UnmarshalJSON(data []byte) error
• type SpaceSidebarConfig
  • func (s *SpaceSidebarConfig) GetExtraProperties() map[string]interface{}
  • func (s *SpaceSidebarConfig) GetWorkbookSidebarOrder() []WorkbookId
  • func (s *SpaceSidebarConfig) String() string
  • func (s *SpaceSidebarConfig) UnmarshalJSON(data []byte) error
• type SpaceSize
  • func (s *SpaceSize) GetExtraProperties() map[string]interface{}
  • func (s *SpaceSize) GetId() string
  • func (s *SpaceSize) GetName() string
  • func (s *SpaceSize) GetNumFiles() int
  • func (s *SpaceSize) GetNumUsers() int
  • func (s *SpaceSize) GetPdv() int
  • func (s *SpaceSize) String() string
  • func (s *SpaceSize) UnmarshalJSON(data []byte) error
• type StoredConstraint
  • func (s *StoredConstraint) GetConfig() interface{}
  • func (s *StoredConstraint) GetDescription() *string
  • func (s *StoredConstraint) GetExtraProperties() map[string]interface{}
  • func (s *StoredConstraint) GetLabel() *string
  • func (s *StoredConstraint) GetValidator() string
  • func (s *StoredConstraint) GetVersion() *int
  • func (s *StoredConstraint) String() string
  • func (s *StoredConstraint) UnmarshalJSON(data []byte) error
• type StringConfig
  • func (s *StringConfig) GetExtraProperties() map[string]interface{}
  • func (s *StringConfig) GetSize() StringConfigOptions
  • func (s *StringConfig) String() string
  • func (s *StringConfig) UnmarshalJSON(data []byte) error
• type StringConfigOptions
  • func NewStringConfigOptionsFromString(s string) (StringConfigOptions, error)
  • func (s StringConfigOptions) Ptr() *StringConfigOptions
• type StringListProperty
  • func (s *StringListProperty) GetActions() []*Action
  • func (s *StringListProperty) GetAlternativeNames() []string
  • func (s *StringListProperty) GetAppearance() *FieldAppearance
  • func (s *StringListProperty) GetConstraints() []*Constraint
  • func (s *StringListProperty) GetDescription() *string
  • func (s *StringListProperty) GetExtraProperties() map[string]interface{}
  • func (s *StringListProperty) GetKey() string
  • func (s *StringListProperty) GetLabel() *string
  • func (s *StringListProperty) GetMetadata() interface{}
  • func (s *StringListProperty) GetReadonly() *bool
  • func (s *StringListProperty) GetTreatments() []string
  • func (s *StringListProperty) String() string
  • func (s *StringListProperty) UnmarshalJSON(data []byte) error
• type StringProperty
  • func (s *StringProperty) GetActions() []*Action
  • func (s *StringProperty) GetAlternativeNames() []string
  • func (s *StringProperty) GetAppearance() *FieldAppearance
  • func (s *StringProperty) GetConfig() *StringConfig
  • func (s *StringProperty) GetConstraints() []*Constraint
  • func (s *StringProperty) GetDescription() *string
  • func (s *StringProperty) GetExtraProperties() map[string]interface{}
  • func (s *StringProperty) GetKey() string
  • func (s *StringProperty) GetLabel() *string
  • func (s *StringProperty) GetMetadata() interface{}
  • func (s *StringProperty) GetReadonly() *bool
  • func (s *StringProperty) GetTreatments() []string
  • func (s *StringProperty) String() string
  • func (s *StringProperty) UnmarshalJSON(data []byte) error
• type Success
  • func (s *Success) GetData() *SuccessData
  • func (s *Success) GetExtraProperties() map[string]interface{}
  • func (s *Success) String() string
  • func (s *Success) UnmarshalJSON(data []byte) error
• type SuccessData
  • func (s *SuccessData) GetExtraProperties() map[string]interface{}
  • func (s *SuccessData) GetSuccess() bool
  • func (s *SuccessData) String() string
  • func (s *SuccessData) UnmarshalJSON(data []byte) error
• type SuccessQueryParameter
• type SuccessResponse
  • func (s *SuccessResponse) GetExtraProperties() map[string]interface{}
  • func (s *SuccessResponse) GetSuccess() bool
  • func (s *SuccessResponse) String() string
  • func (s *SuccessResponse) UnmarshalJSON(data []byte) error
• type SummarySection
  • func (s *SummarySection) GetByField() map[string]int
  • func (s *SummarySection) GetExtraProperties() map[string]interface{}
  • func (s *SummarySection) GetTotal() int
  • func (s *SummarySection) String() string
  • func (s *SummarySection) UnmarshalJSON(data []byte) error
• type Trigger
  • func NewTriggerFromString(s string) (Trigger, error)
  • func (t Trigger) Ptr() *Trigger
• type TriggerEnum
  • func NewTriggerEnumFromString(s string) (TriggerEnum, error)
  • func (t TriggerEnum) Ptr() *TriggerEnum
• type TypeEnum
  • func NewTypeEnumFromString(s string) (TypeEnum, error)
  • func (t TypeEnum) Ptr() *TypeEnum
• type UniqueConstraint
  • func (u *UniqueConstraint) GetConfig() *UniqueConstraintConfig
  • func (u *UniqueConstraint) GetExtraProperties() map[string]interface{}
  • func (u *UniqueConstraint) String() string
  • func (u *UniqueConstraint) UnmarshalJSON(data []byte) error
• type UniqueConstraintConfig
  • func (u *UniqueConstraintConfig) GetCaseSensitive() *bool
  • func (u *UniqueConstraintConfig) GetExtraProperties() map[string]interface{}
  • func (u *UniqueConstraintConfig) GetIgnoreEmpty() *bool
  • func (u *UniqueConstraintConfig) String() string
  • func (u *UniqueConstraintConfig) UnmarshalJSON(data []byte) error
• type UpdateDataClipResolutionsJobConfig
  • func (u *UpdateDataClipResolutionsJobConfig) GetClipId() DataClipId
  • func (u *UpdateDataClipResolutionsJobConfig) GetClippedSheetId() SheetId
  • func (u *UpdateDataClipResolutionsJobConfig) GetColumnField() string
  • func (u *UpdateDataClipResolutionsJobConfig) GetColumnValue() string
  • func (u *UpdateDataClipResolutionsJobConfig) GetExtraProperties() map[string]interface{}
  • func (u *UpdateDataClipResolutionsJobConfig) GetResolveTo() ResolveTo
  • func (u *UpdateDataClipResolutionsJobConfig) String() string
  • func (u *UpdateDataClipResolutionsJobConfig) UnmarshalJSON(data []byte) error
• type UpdateFileRequest
• type UpdateMappingRulesRequest
• type UpdateUserRequest
• type User
  • func (u *User) GetAccountId() AccountId
  • func (u *User) GetCreatedAt() time.Time
  • func (u *User) GetDashboard() *int
  • func (u *User) GetEmail() string
  • func (u *User) GetExtraProperties() map[string]interface{}
  • func (u *User) GetId() UserId
  • func (u *User) GetIdp() string
  • func (u *User) GetIdpRef() *string
  • func (u *User) GetLastSeenAt() *time.Time
  • func (u *User) GetMetadata() map[string]interface{}
  • func (u *User) GetName() string
  • func (u *User) GetUpdatedAt() time.Time
  • func (u *User) MarshalJSON() ([]byte, error)
  • func (u *User) String() string
  • func (u *User) UnmarshalJSON(data []byte) error
• type UserConfig
  • func (u *UserConfig) GetAccountId() AccountId
  • func (u *UserConfig) GetEmail() string
  • func (u *UserConfig) GetExtraProperties() map[string]interface{}
  • func (u *UserConfig) GetName() string
  • func (u *UserConfig) String() string
  • func (u *UserConfig) UnmarshalJSON(data []byte) error
• type UserCreateAndInviteRequest
  • func (u *UserCreateAndInviteRequest) GetActorRoles() []*AssignActorRoleRequest
  • func (u *UserCreateAndInviteRequest) GetEmail() string
  • func (u *UserCreateAndInviteRequest) GetExtraProperties() map[string]interface{}
  • func (u *UserCreateAndInviteRequest) GetName() string
  • func (u *UserCreateAndInviteRequest) String() string
  • func (u *UserCreateAndInviteRequest) UnmarshalJSON(data []byte) error
• type UserId
• type UserResponse
  • func (u *UserResponse) GetData() *User
  • func (u *UserResponse) GetExtraProperties() map[string]interface{}
  • func (u *UserResponse) String() string
  • func (u *UserResponse) UnmarshalJSON(data []byte) error
• type UserWithRoles
  • func (u *UserWithRoles) GetAccountId() AccountId
  • func (u *UserWithRoles) GetActorRoles() []*ActorRoleResponse
  • func (u *UserWithRoles) GetCreatedAt() time.Time
  • func (u *UserWithRoles) GetDashboard() *int
  • func (u *UserWithRoles) GetEmail() string
  • func (u *UserWithRoles) GetExtraProperties() map[string]interface{}
  • func (u *UserWithRoles) GetId() UserId
  • func (u *UserWithRoles) GetIdp() string
  • func (u *UserWithRoles) GetIdpRef() *string
  • func (u *UserWithRoles) GetLastSeenAt() *time.Time
  • func (u *UserWithRoles) GetMetadata() map[string]interface{}
  • func (u *UserWithRoles) GetName() string
  • func (u *UserWithRoles) GetUpdatedAt() time.Time
  • func (u *UserWithRoles) MarshalJSON() ([]byte, error)
  • func (u *UserWithRoles) String() string
  • func (u *UserWithRoles) UnmarshalJSON(data []byte) error
• type UserWithRolesResponse
  • func (u *UserWithRolesResponse) GetData() *UserWithRoles
  • func (u *UserWithRolesResponse) GetExtraProperties() map[string]interface{}
  • func (u *UserWithRolesResponse) String() string
  • func (u *UserWithRolesResponse) UnmarshalJSON(data []byte) error
• type ValidationMessage
  • func (v *ValidationMessage) GetExtraProperties() map[string]interface{}
  • func (v *ValidationMessage) GetField() *string
  • func (v *ValidationMessage) GetMessage() *string
  • func (v *ValidationMessage) GetPath() *JsonPathString
  • func (v *ValidationMessage) GetSource() *ValidationSource
  • func (v *ValidationMessage) GetType() *ValidationType
  • func (v *ValidationMessage) String() string
  • func (v *ValidationMessage) UnmarshalJSON(data []byte) error
• type ValidationSource
  • func NewValidationSourceFromString(s string) (ValidationSource, error)
  • func (v ValidationSource) Ptr() *ValidationSource
• type ValidationType
  • func NewValidationTypeFromString(s string) (ValidationType, error)
  • func (v ValidationType) Ptr() *ValidationType
• type Version
  • func (v *Version) GetExtraProperties() map[string]interface{}
  • func (v *Version) GetVersionId() VersionId
  • func (v *Version) String() string
  • func (v *Version) UnmarshalJSON(data []byte) error
• type VersionId
• type VersionResponse
  • func (v *VersionResponse) GetData() *Version
  • func (v *VersionResponse) GetExtraProperties() map[string]interface{}
  • func (v *VersionResponse) String() string
  • func (v *VersionResponse) UnmarshalJSON(data []byte) error
• type VersionsPostRequestBody
• type View
  • func (v *View) GetConfig() *ViewConfig
  • func (v *View) GetCreatedBy() string
  • func (v *View) GetExtraProperties() map[string]interface{}
  • func (v *View) GetId() ViewId
  • func (v *View) GetName() string
  • func (v *View) GetSheetId() SheetId
  • func (v *View) String() string
  • func (v *View) UnmarshalJSON(data []byte) error
• type ViewConfig
  • func (v *ViewConfig) GetCommitId() *CommitId
  • func (v *ViewConfig) GetExtraProperties() map[string]interface{}
  • func (v *ViewConfig) GetFilter() *Filter
  • func (v *ViewConfig) GetFilterField() *FilterField
  • func (v *ViewConfig) GetFor() *EventId
  • func (v *ViewConfig) GetIds() []RecordId
  • func (v *ViewConfig) GetIncludeCounts() *bool
  • func (v *ViewConfig) GetIncludeLength() *bool
  • func (v *ViewConfig) GetIncludeLinks() *bool
  • func (v *ViewConfig) GetIncludeMessages() *bool
  • func (v *ViewConfig) GetPageNumber() *int
  • func (v *ViewConfig) GetPageSize() *int
  • func (v *ViewConfig) GetQ() *string
  • func (v *ViewConfig) GetSearchField() *SearchField
  • func (v *ViewConfig) GetSearchValue() *SearchValue
  • func (v *ViewConfig) GetSinceCommitId() *CommitId
  • func (v *ViewConfig) GetSinceVersionId() *VersionId
  • func (v *ViewConfig) GetSortDirection() *SortDirection
  • func (v *ViewConfig) GetSortField() *SortField
  • func (v *ViewConfig) GetVersionId() *VersionId
  • func (v *ViewConfig) String() string
  • func (v *ViewConfig) UnmarshalJSON(data []byte) error
• type ViewCreate
  • func (v *ViewCreate) GetConfig() *ViewConfig
  • func (v *ViewCreate) GetExtraProperties() map[string]interface{}
  • func (v *ViewCreate) GetName() string
  • func (v *ViewCreate) GetSheetId() SheetId
  • func (v *ViewCreate) String() string
  • func (v *ViewCreate) UnmarshalJSON(data []byte) error
• type ViewId
• type ViewResponse
  • func (v *ViewResponse) GetData() *View
  • func (v *ViewResponse) GetExtraProperties() map[string]interface{}
  • func (v *ViewResponse) String() string
  • func (v *ViewResponse) UnmarshalJSON(data []byte) error
• type ViewUpdate
  • func (v *ViewUpdate) GetConfig() *ViewConfig
  • func (v *ViewUpdate) GetExtraProperties() map[string]interface{}
  • func (v *ViewUpdate) GetName() *string
  • func (v *ViewUpdate) String() string
  • func (v *ViewUpdate) UnmarshalJSON(data []byte) error
• type Workbook
  • func (w *Workbook) GetActions() []*Action
  • func (w *Workbook) GetCreatedAt() time.Time
  • func (w *Workbook) GetEnvironmentId() EnvironmentId
  • func (w *Workbook) GetExpiredAt() *time.Time
  • func (w *Workbook) GetExtraProperties() map[string]interface{}
  • func (w *Workbook) GetId() WorkbookId
  • func (w *Workbook) GetLabels() []string
  • func (w *Workbook) GetMetadata() interface{}
  • func (w *Workbook) GetName() *string
  • func (w *Workbook) GetNamespace() *string
  • func (w *Workbook) GetSettings() *WorkbookConfigSettings
  • func (w *Workbook) GetSheets() []*Sheet
  • func (w *Workbook) GetSpaceId() SpaceId
  • func (w *Workbook) GetTreatments() []WorkbookTreatments
  • func (w *Workbook) GetUpdatedAt() time.Time
  • func (w *Workbook) MarshalJSON() ([]byte, error)
  • func (w *Workbook) String() string
  • func (w *Workbook) UnmarshalJSON(data []byte) error
• type WorkbookConfigSettings
  • func (w *WorkbookConfigSettings) GetExtraProperties() map[string]interface{}
  • func (w *WorkbookConfigSettings) GetNoMappingRedirect() *bool
  • func (w *WorkbookConfigSettings) GetSheetSidebarOrder() []SheetId
  • func (w *WorkbookConfigSettings) GetTrackChanges() *bool
  • func (w *WorkbookConfigSettings) String() string
  • func (w *WorkbookConfigSettings) UnmarshalJSON(data []byte) error
• type WorkbookId
• type WorkbookResponse
  • func (w *WorkbookResponse) GetData() *Workbook
  • func (w *WorkbookResponse) GetExtraProperties() map[string]interface{}
  • func (w *WorkbookResponse) String() string
  • func (w *WorkbookResponse) UnmarshalJSON(data []byte) error
• type WorkbookTreatments
  • func NewWorkbookTreatmentsFromString(s string) (WorkbookTreatments, error)
  • func (w WorkbookTreatments) Ptr() *WorkbookTreatments
• type WorkbookUpdate
  • func (w *WorkbookUpdate) GetActions() []*Action
  • func (w *WorkbookUpdate) GetEnvironmentId() *EnvironmentId
  • func (w *WorkbookUpdate) GetExtraProperties() map[string]interface{}
  • func (w *WorkbookUpdate) GetLabels() []string
  • func (w *WorkbookUpdate) GetMetadata() interface{}
  • func (w *WorkbookUpdate) GetName() *string
  • func (w *WorkbookUpdate) GetNamespace() *string
  • func (w *WorkbookUpdate) GetSheets() []*SheetConfigOrUpdate
  • func (w *WorkbookUpdate) GetSpaceId() *SpaceId
  • func (w *WorkbookUpdate) String() string
  • func (w *WorkbookUpdate) UnmarshalJSON(data []byte) error
• type WriteSecret
  • func (w *WriteSecret) GetActorId() *ActorIdUnion
  • func (w *WriteSecret) GetEnvironmentId() *EnvironmentId
  • func (w *WriteSecret) GetExtraProperties() map[string]interface{}
  • func (w *WriteSecret) GetName() SecretName
  • func (w *WriteSecret) GetSpaceId() *SpaceId
  • func (w *WriteSecret) GetValue() SecretValue
  • func (w *WriteSecret) String() string
  • func (w *WriteSecret) UnmarshalJSON(data []byte) error

Functions

func Bool

func Bool(b bool) *bool

Bool returns a pointer to the given bool value.

func Byte

func Byte(b byte) *byte

Byte returns a pointer to the given byte value.

func Complex128

func Complex128(c complex128) *complex128

Complex128 returns a pointer to the given complex128 value.

func Complex64

func Complex64(c complex64) *complex64

Complex64 returns a pointer to the given complex64 value.

func Float32

func Float32(f float32) *float32

Float32 returns a pointer to the given float32 value.

func Float64

func Float64(f float64) *float64

Float64 returns a pointer to the given float64 value.

func Int

func Int(i int) *int

Int returns a pointer to the given int value.

func Int16

func Int16(i int16) *int16

Int16 returns a pointer to the given int16 value.

func Int32

func Int32(i int32) *int32

Int32 returns a pointer to the given int32 value.

func Int64

func Int64(i int64) *int64

Int64 returns a pointer to the given int64 value.

func Int8

func Int8(i int8) *int8

Int8 returns a pointer to the given int8 value.

func MustParseDate

func MustParseDate(date string) time.Time

MustParseDate attempts to parse the given string as a date time.Time, and panics upon failure.

func MustParseDateTime

func MustParseDateTime(datetime string) time.Time

MustParseDateTime attempts to parse the given string as a datetime time.Time, and panics upon failure.

func Rune

func Rune(r rune) *rune

Rune returns a pointer to the given rune value.

func String

func String(s string) *string

String returns a pointer to the given string value.

func Time

func Time(t time.Time) *time.Time

Time returns a pointer to the given time.Time value.

func UUID

func UUID(u uuid.UUID) *uuid.UUID

UUID returns a pointer to the given uuid.UUID value.

func Uint

func Uint(u uint) *uint

Uint returns a pointer to the given uint value.

func Uint16

func Uint16(u uint16) *uint16

Uint16 returns a pointer to the given uint16 value.

func Uint32

func Uint32(u uint32) *uint32

Uint32 returns a pointer to the given uint32 value.

func Uint64

func Uint64(u uint64) *uint64

Uint64 returns a pointer to the given uint64 value.

func Uint8

func Uint8(u uint8) *uint8

Uint8 returns a pointer to the given uint8 value.

func Uintptr

func Uintptr(u uintptr) *uintptr

Uintptr returns a pointer to the given uintptr value.

Types

type Account

type Account struct {
	Id                      AccountId              `json:"id" url:"id"`
	Name                    string                 `json:"name" url:"name"`
	Subdomain               *string                `json:"subdomain,omitempty" url:"subdomain,omitempty"`
	VanityDomainDashboard   *string                `json:"vanityDomainDashboard,omitempty" url:"vanityDomainDashboard,omitempty"`
	VanityDomainSpaces      *string                `json:"vanityDomainSpaces,omitempty" url:"vanityDomainSpaces,omitempty"`
	EmbeddedDomainWhitelist []string               `json:"embeddedDomainWhitelist,omitempty" url:"embeddedDomainWhitelist,omitempty"`
	CustomFromEmail         *string                `json:"customFromEmail,omitempty" url:"customFromEmail,omitempty"`
	StripeCustomerId        *string                `json:"stripeCustomerId,omitempty" url:"stripeCustomerId,omitempty"`
	Metadata                map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	CreatedAt               time.Time              `json:"createdAt" url:"createdAt"`
	UpdatedAt               time.Time              `json:"updatedAt" url:"updatedAt"`
	DefaultAppId            *AppId                 `json:"defaultAppId,omitempty" url:"defaultAppId,omitempty"`
	Dashboard               *int                   `json:"dashboard,omitempty" url:"dashboard,omitempty"`
	// contains filtered or unexported fields
}

An account

func (*Account) GetCreatedAt

func (a *Account) GetCreatedAt() time.Time

func (*Account) GetCustomFromEmail

func (a *Account) GetCustomFromEmail() *string

func (*Account) GetDashboard

func (a *Account) GetDashboard() *int

func (*Account) GetDefaultAppId

func (a *Account) GetDefaultAppId() *AppId

func (*Account) GetEmbeddedDomainWhitelist

func (a *Account) GetEmbeddedDomainWhitelist() []string

func (*Account) GetExtraProperties

func (a *Account) GetExtraProperties() map[string]interface{}

func (*Account) GetId

func (a *Account) GetId() AccountId

func (*Account) GetMetadata

func (a *Account) GetMetadata() map[string]interface{}

func (*Account) GetName

func (a *Account) GetName() string

func (*Account) GetStripeCustomerId

func (a *Account) GetStripeCustomerId() *string

func (*Account) GetSubdomain

func (a *Account) GetSubdomain() *string

func (*Account) GetUpdatedAt

func (a *Account) GetUpdatedAt() time.Time

func (*Account) GetVanityDomainDashboard

func (a *Account) GetVanityDomainDashboard() *string

func (*Account) GetVanityDomainSpaces

func (a *Account) GetVanityDomainSpaces() *string

func (*Account) MarshalJSON

func (a *Account) MarshalJSON() ([]byte, error)

func (*Account) String

func (a *Account) String() string

func (*Account) UnmarshalJSON

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

type AccountId

type AccountId = string

Account ID

type AccountPatch

type AccountPatch struct {
	DefaultAppId AppId `json:"defaultAppId" url:"defaultAppId"`
	// contains filtered or unexported fields
}

Properties used to update an account

func (*AccountPatch) GetDefaultAppId

func (a *AccountPatch) GetDefaultAppId() AppId

func (*AccountPatch) GetExtraProperties

func (a *AccountPatch) GetExtraProperties() map[string]interface{}

func (*AccountPatch) String

func (a *AccountPatch) String() string

func (*AccountPatch) UnmarshalJSON

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

type AccountResponse

type AccountResponse struct {
	Data *Account `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*AccountResponse) GetData

func (a *AccountResponse) GetData() *Account

func (*AccountResponse) GetExtraProperties

func (a *AccountResponse) GetExtraProperties() map[string]interface{}

func (*AccountResponse) String

func (a *AccountResponse) String() string

func (*AccountResponse) UnmarshalJSON

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

type Action

type Action struct {
	// **This is deprecated. Use `operation` instead.**
	Slug *string `json:"slug,omitempty" url:"slug,omitempty"`
	// This will become the job operation that is triggered
	Operation *string `json:"operation,omitempty" url:"operation,omitempty"`
	// Foreground and toolbarBlocking action mode will prevent interacting with the resource until complete
	Mode *ActionMode `json:"mode,omitempty" url:"mode,omitempty"`
	// A tooltip that appears when hovering the action button
	Tooltip  *string          `json:"tooltip,omitempty" url:"tooltip,omitempty"`
	Messages []*ActionMessage `json:"messages,omitempty" url:"messages,omitempty"`
	// **This is deprecated.**
	Type *string `json:"type,omitempty" url:"type,omitempty"`
	// The text that appears in the dialog after the action is clicked.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// Determines if the action should happen on a regular cadence.
	Schedule *ActionSchedule `json:"schedule,omitempty" url:"schedule,omitempty"`
	// A primary action will be more visibly present, whether in Sheet or Workbook.
	Primary *bool `json:"primary,omitempty" url:"primary,omitempty"`
	// Whether to show a modal to confirm the action
	Confirm *bool `json:"confirm,omitempty" url:"confirm,omitempty"`
	// Icon will work on primary actions. It will only accept an already existing Flatfile design system icon.
	Icon *string `json:"icon,omitempty" url:"icon,omitempty"`
	// **This is deprecated. Use `constraints` instead.**
	RequireAllValid *bool `json:"requireAllValid,omitempty" url:"requireAllValid,omitempty"`
	// **This is deprecated. Use `constraints` instead.**
	RequireSelection *bool `json:"requireSelection,omitempty" url:"requireSelection,omitempty"`
	// Adds an input form for this action after it is clicked.
	InputForm *InputForm `json:"inputForm,omitempty" url:"inputForm,omitempty"`
	// A limitation or restriction on the action.
	Constraints []*ActionConstraint `json:"constraints,omitempty" url:"constraints,omitempty"`
	Mount       *ActionMount        `json:"mount,omitempty" url:"mount,omitempty"`
	Guide       *Guide              `json:"guide,omitempty" url:"guide,omitempty"`
	Guardrail   *Guardrail          `json:"guardrail,omitempty" url:"guardrail,omitempty"`
	// The text on the Button itself
	Label string `json:"label" url:"label"`
	// contains filtered or unexported fields
}

func (*Action) GetConfirm

func (a *Action) GetConfirm() *bool

func (*Action) GetConstraints

func (a *Action) GetConstraints() []*ActionConstraint

func (*Action) GetDescription

func (a *Action) GetDescription() *string

func (*Action) GetExtraProperties

func (a *Action) GetExtraProperties() map[string]interface{}

func (*Action) GetGuardrail

func (a *Action) GetGuardrail() *Guardrail

func (*Action) GetGuide

func (a *Action) GetGuide() *Guide

func (*Action) GetIcon

func (a *Action) GetIcon() *string

func (*Action) GetInputForm

func (a *Action) GetInputForm() *InputForm

func (*Action) GetLabel

func (a *Action) GetLabel() string

func (*Action) GetMessages

func (a *Action) GetMessages() []*ActionMessage

func (*Action) GetMode

func (a *Action) GetMode() *ActionMode

func (*Action) GetMount

func (a *Action) GetMount() *ActionMount

func (*Action) GetOperation

func (a *Action) GetOperation() *string

func (*Action) GetPrimary

func (a *Action) GetPrimary() *bool

func (*Action) GetRequireAllValid

func (a *Action) GetRequireAllValid() *bool

func (*Action) GetRequireSelection

func (a *Action) GetRequireSelection() *bool

func (*Action) GetSchedule

func (a *Action) GetSchedule() *ActionSchedule

func (*Action) GetSlug

func (a *Action) GetSlug() *string

func (*Action) GetTooltip

func (a *Action) GetTooltip() *string

func (*Action) GetType

func (a *Action) GetType() *string

func (*Action) String

func (a *Action) String() string

func (*Action) UnmarshalJSON

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

type ActionConstraint

type ActionConstraint struct {
	Type             string
	HasAllValid      *ActionConstraintHasAllValid
	HasSelection     *ActionConstraintHasSelection
	HasData          *ActionConstraintHasData
	HasColumnEnabled *ActionConstraintHasColumnEnabled
}

func NewActionConstraintFromHasAllValid

func NewActionConstraintFromHasAllValid(value *ActionConstraintHasAllValid) *ActionConstraint

func NewActionConstraintFromHasColumnEnabled

func NewActionConstraintFromHasColumnEnabled(value *ActionConstraintHasColumnEnabled) *ActionConstraint

func NewActionConstraintFromHasData

func NewActionConstraintFromHasData(value *ActionConstraintHasData) *ActionConstraint

func NewActionConstraintFromHasSelection

func NewActionConstraintFromHasSelection(value *ActionConstraintHasSelection) *ActionConstraint

func (*ActionConstraint) Accept

func (a *ActionConstraint) Accept(visitor ActionConstraintVisitor) error

func (*ActionConstraint) GetHasAllValid

func (a *ActionConstraint) GetHasAllValid() *ActionConstraintHasAllValid

func (*ActionConstraint) GetHasColumnEnabled

func (a *ActionConstraint) GetHasColumnEnabled() *ActionConstraintHasColumnEnabled

func (*ActionConstraint) GetHasData

func (a *ActionConstraint) GetHasData() *ActionConstraintHasData

func (*ActionConstraint) GetHasSelection

func (a *ActionConstraint) GetHasSelection() *ActionConstraintHasSelection

func (*ActionConstraint) GetType

func (a *ActionConstraint) GetType() string

func (ActionConstraint) MarshalJSON

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

func (*ActionConstraint) UnmarshalJSON

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

type ActionConstraintHasAllValid

type ActionConstraintHasAllValid struct {
	IgnoreSelection *bool `json:"ignoreSelection,omitempty" url:"ignoreSelection,omitempty"`
	// contains filtered or unexported fields
}

This constraint requires that all records are valid before the action can be performed.

func (*ActionConstraintHasAllValid) GetExtraProperties

func (a *ActionConstraintHasAllValid) GetExtraProperties() map[string]interface{}

func (*ActionConstraintHasAllValid) GetIgnoreSelection

func (a *ActionConstraintHasAllValid) GetIgnoreSelection() *bool

func (*ActionConstraintHasAllValid) String

func (a *ActionConstraintHasAllValid) String() string

func (*ActionConstraintHasAllValid) UnmarshalJSON

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

type ActionConstraintHasColumnEnabled

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

This constraint requires the column to be enabled and not readonly before the action can be performed.

func (*ActionConstraintHasColumnEnabled) GetExtraProperties

func (a *ActionConstraintHasColumnEnabled) GetExtraProperties() map[string]interface{}

func (*ActionConstraintHasColumnEnabled) String

func (a *ActionConstraintHasColumnEnabled) String() string

func (*ActionConstraintHasColumnEnabled) UnmarshalJSON

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

type ActionConstraintHasData

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

This constraint requires that at least one record exists before the action can be performed.

func (*ActionConstraintHasData) GetExtraProperties

func (a *ActionConstraintHasData) GetExtraProperties() map[string]interface{}

func (*ActionConstraintHasData) String

func (a *ActionConstraintHasData) String() string

func (*ActionConstraintHasData) UnmarshalJSON

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

type ActionConstraintHasSelection

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

This constraint requires that at least one record is selected before the action can be performed.

func (*ActionConstraintHasSelection) GetExtraProperties

func (a *ActionConstraintHasSelection) GetExtraProperties() map[string]interface{}

func (*ActionConstraintHasSelection) String

func (a *ActionConstraintHasSelection) String() string

func (*ActionConstraintHasSelection) UnmarshalJSON

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

type ActionConstraintVisitor

type ActionConstraintVisitor interface {
	VisitHasAllValid(*ActionConstraintHasAllValid) error
	VisitHasSelection(*ActionConstraintHasSelection) error
	VisitHasData(*ActionConstraintHasData) error
	VisitHasColumnEnabled(*ActionConstraintHasColumnEnabled) error
}

type ActionCreateRequest

type ActionCreateRequest struct {
	// The Space ID for which to create the Action.
	SpaceId SpaceId          `json:"-" url:"spaceId"`
	Body    *ApiActionConfig `json:"-" url:"-"`
}

func (*ActionCreateRequest) MarshalJSON

func (a *ActionCreateRequest) MarshalJSON() ([]byte, error)

func (*ActionCreateRequest) UnmarshalJSON

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

type ActionId

type ActionId = string

Action ID

type ActionMessage

type ActionMessage struct {
	Type    ActionMessageType `json:"type" url:"type"`
	Content string            `json:"content" url:"content"`
	// contains filtered or unexported fields
}

func (*ActionMessage) GetContent

func (a *ActionMessage) GetContent() string

func (*ActionMessage) GetExtraProperties

func (a *ActionMessage) GetExtraProperties() map[string]interface{}

func (*ActionMessage) GetType

func (a *ActionMessage) GetType() ActionMessageType

func (*ActionMessage) String

func (a *ActionMessage) String() string

func (*ActionMessage) UnmarshalJSON

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

type ActionMessageType

type ActionMessageType string

const (
	ActionMessageTypeError ActionMessageType = "error"
	ActionMessageTypeInfo  ActionMessageType = "info"
)

func NewActionMessageTypeFromString

func NewActionMessageTypeFromString(s string) (ActionMessageType, error)

func (ActionMessageType) Ptr

func (a ActionMessageType) Ptr() *ActionMessageType

type ActionMode

type ActionMode string

Foreground actions will prevent interacting with the resource until complete

const (
	ActionModeForeground      ActionMode = "foreground"
	ActionModeBackground      ActionMode = "background"
	ActionModeToolbarBlocking ActionMode = "toolbarBlocking"
)

func NewActionModeFromString

func NewActionModeFromString(s string) (ActionMode, error)

func (ActionMode) Ptr

func (a ActionMode) Ptr() *ActionMode

type ActionMount

type ActionMount struct {
	Type     string
	Sheet    *ActionMountSheet
	Workbook *ActionMountWorkbook
	Field    *ActionMountField
	Document *ActionMountDocument
	File     *ActionMountFile
}

func NewActionMountFromDocument

func NewActionMountFromDocument(value *ActionMountDocument) *ActionMount

func NewActionMountFromField

func NewActionMountFromField(value *ActionMountField) *ActionMount

func NewActionMountFromFile

func NewActionMountFromFile(value *ActionMountFile) *ActionMount

func NewActionMountFromSheet

func NewActionMountFromSheet(value *ActionMountSheet) *ActionMount

func NewActionMountFromWorkbook

func NewActionMountFromWorkbook(value *ActionMountWorkbook) *ActionMount

func (*ActionMount) Accept

func (a *ActionMount) Accept(visitor ActionMountVisitor) error

func (*ActionMount) GetDocument

func (a *ActionMount) GetDocument() *ActionMountDocument

func (*ActionMount) GetField

func (a *ActionMount) GetField() *ActionMountField

func (*ActionMount) GetFile

func (a *ActionMount) GetFile() *ActionMountFile

func (*ActionMount) GetSheet

func (a *ActionMount) GetSheet() *ActionMountSheet

func (*ActionMount) GetType

func (a *ActionMount) GetType() string

func (*ActionMount) GetWorkbook

func (a *ActionMount) GetWorkbook() *ActionMountWorkbook

func (ActionMount) MarshalJSON

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

func (*ActionMount) UnmarshalJSON

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

type ActionMountDocument

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

Used to mount this action on documents.

func (*ActionMountDocument) GetExtraProperties

func (a *ActionMountDocument) GetExtraProperties() map[string]interface{}

func (*ActionMountDocument) String

func (a *ActionMountDocument) String() string

func (*ActionMountDocument) UnmarshalJSON

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

type ActionMountField

type ActionMountField struct {
	Keys []string `json:"keys,omitempty" url:"keys,omitempty"`
	// contains filtered or unexported fields
}

Used to mount this action on Sheet Columns.

func (*ActionMountField) GetExtraProperties

func (a *ActionMountField) GetExtraProperties() map[string]interface{}

func (*ActionMountField) GetKeys

func (a *ActionMountField) GetKeys() []string

func (*ActionMountField) String

func (a *ActionMountField) String() string

func (*ActionMountField) UnmarshalJSON

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

type ActionMountFile

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

Used to mount this action on files.

func (*ActionMountFile) GetExtraProperties

func (a *ActionMountFile) GetExtraProperties() map[string]interface{}

func (*ActionMountFile) String

func (a *ActionMountFile) String() string

func (*ActionMountFile) UnmarshalJSON

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

type ActionMountSheet

type ActionMountSheet struct {
	Slugs []string `json:"slugs,omitempty" url:"slugs,omitempty"`
	// contains filtered or unexported fields
}

Used to mount this action on Sheets.

func (*ActionMountSheet) GetExtraProperties

func (a *ActionMountSheet) GetExtraProperties() map[string]interface{}

func (*ActionMountSheet) GetSlugs

func (a *ActionMountSheet) GetSlugs() []string

func (*ActionMountSheet) String

func (a *ActionMountSheet) String() string

func (*ActionMountSheet) UnmarshalJSON

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

type ActionMountVisitor

type ActionMountVisitor interface {
	VisitSheet(*ActionMountSheet) error
	VisitWorkbook(*ActionMountWorkbook) error
	VisitField(*ActionMountField) error
	VisitDocument(*ActionMountDocument) error
	VisitFile(*ActionMountFile) error
}

type ActionMountWorkbook

type ActionMountWorkbook struct {
	Slugs []string `json:"slugs,omitempty" url:"slugs,omitempty"`
	// contains filtered or unexported fields
}

Used to mount this action on Workbooks.

func (*ActionMountWorkbook) GetExtraProperties

func (a *ActionMountWorkbook) GetExtraProperties() map[string]interface{}

func (*ActionMountWorkbook) GetSlugs

func (a *ActionMountWorkbook) GetSlugs() []string

func (*ActionMountWorkbook) String

func (a *ActionMountWorkbook) String() string

func (*ActionMountWorkbook) UnmarshalJSON

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

type ActionName

type ActionName = string

Name of an action

type ActionSchedule

type ActionSchedule string

const (
	ActionScheduleWeekly ActionSchedule = "weekly"
	ActionScheduleDaily  ActionSchedule = "daily"
	ActionScheduleHourly ActionSchedule = "hourly"
)

func NewActionScheduleFromString

func NewActionScheduleFromString(s string) (ActionSchedule, error)

func (ActionSchedule) Ptr

func (a ActionSchedule) Ptr() *ActionSchedule

type ActionUpdate

type ActionUpdate struct {
	// **This is deprecated. Use `operation` instead.**
	Slug *string `json:"slug,omitempty" url:"slug,omitempty"`
	// This will become the job operation that is triggered
	Operation *string `json:"operation,omitempty" url:"operation,omitempty"`
	// Foreground and toolbarBlocking action mode will prevent interacting with the resource until complete
	Mode *ActionMode `json:"mode,omitempty" url:"mode,omitempty"`
	// A tooltip that appears when hovering the action button
	Tooltip  *string          `json:"tooltip,omitempty" url:"tooltip,omitempty"`
	Messages []*ActionMessage `json:"messages,omitempty" url:"messages,omitempty"`
	// **This is deprecated.**
	Type *string `json:"type,omitempty" url:"type,omitempty"`
	// The text that appears in the dialog after the action is clicked.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// Determines if the action should happen on a regular cadence.
	Schedule *ActionSchedule `json:"schedule,omitempty" url:"schedule,omitempty"`
	// A primary action will be more visibly present, whether in Sheet or Workbook.
	Primary *bool `json:"primary,omitempty" url:"primary,omitempty"`
	// Whether to show a modal to confirm the action
	Confirm *bool `json:"confirm,omitempty" url:"confirm,omitempty"`
	// Icon will work on primary actions. It will only accept an already existing Flatfile design system icon.
	Icon *string `json:"icon,omitempty" url:"icon,omitempty"`
	// **This is deprecated. Use `constraints` instead.**
	RequireAllValid *bool `json:"requireAllValid,omitempty" url:"requireAllValid,omitempty"`
	// **This is deprecated. Use `constraints` instead.**
	RequireSelection *bool `json:"requireSelection,omitempty" url:"requireSelection,omitempty"`
	// Adds an input form for this action after it is clicked.
	InputForm *InputForm `json:"inputForm,omitempty" url:"inputForm,omitempty"`
	// A limitation or restriction on the action.
	Constraints []*ActionConstraint `json:"constraints,omitempty" url:"constraints,omitempty"`
	Mount       *ActionMount        `json:"mount,omitempty" url:"mount,omitempty"`
	Guide       *Guide              `json:"guide,omitempty" url:"guide,omitempty"`
	Guardrail   *Guardrail          `json:"guardrail,omitempty" url:"guardrail,omitempty"`
	Label       *string             `json:"label,omitempty" url:"label,omitempty"`
	// contains filtered or unexported fields
}

func (*ActionUpdate) GetConfirm

func (a *ActionUpdate) GetConfirm() *bool

func (*ActionUpdate) GetConstraints

func (a *ActionUpdate) GetConstraints() []*ActionConstraint

func (*ActionUpdate) GetDescription

func (a *ActionUpdate) GetDescription() *string

func (*ActionUpdate) GetExtraProperties

func (a *ActionUpdate) GetExtraProperties() map[string]interface{}

func (*ActionUpdate) GetGuardrail

func (a *ActionUpdate) GetGuardrail() *Guardrail

func (*ActionUpdate) GetGuide

func (a *ActionUpdate) GetGuide() *Guide

func (*ActionUpdate) GetIcon

func (a *ActionUpdate) GetIcon() *string

func (*ActionUpdate) GetInputForm

func (a *ActionUpdate) GetInputForm() *InputForm

func (*ActionUpdate) GetLabel

func (a *ActionUpdate) GetLabel() *string

func (*ActionUpdate) GetMessages

func (a *ActionUpdate) GetMessages() []*ActionMessage

func (*ActionUpdate) GetMode

func (a *ActionUpdate) GetMode() *ActionMode

func (*ActionUpdate) GetMount

func (a *ActionUpdate) GetMount() *ActionMount

func (*ActionUpdate) GetOperation

func (a *ActionUpdate) GetOperation() *string

func (*ActionUpdate) GetPrimary

func (a *ActionUpdate) GetPrimary() *bool

func (*ActionUpdate) GetRequireAllValid

func (a *ActionUpdate) GetRequireAllValid() *bool

func (*ActionUpdate) GetRequireSelection

func (a *ActionUpdate) GetRequireSelection() *bool

func (*ActionUpdate) GetSchedule

func (a *ActionUpdate) GetSchedule() *ActionSchedule

func (*ActionUpdate) GetSlug

func (a *ActionUpdate) GetSlug() *string

func (*ActionUpdate) GetTooltip

func (a *ActionUpdate) GetTooltip() *string

func (*ActionUpdate) GetType

func (a *ActionUpdate) GetType() *string

func (*ActionUpdate) String

func (a *ActionUpdate) String() string

func (*ActionUpdate) UnmarshalJSON

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

type ActionWithoutLabel

type ActionWithoutLabel struct {
	// **This is deprecated. Use `operation` instead.**
	Slug *string `json:"slug,omitempty" url:"slug,omitempty"`
	// This will become the job operation that is triggered
	Operation *string `json:"operation,omitempty" url:"operation,omitempty"`
	// Foreground and toolbarBlocking action mode will prevent interacting with the resource until complete
	Mode *ActionMode `json:"mode,omitempty" url:"mode,omitempty"`
	// A tooltip that appears when hovering the action button
	Tooltip  *string          `json:"tooltip,omitempty" url:"tooltip,omitempty"`
	Messages []*ActionMessage `json:"messages,omitempty" url:"messages,omitempty"`
	// **This is deprecated.**
	Type *string `json:"type,omitempty" url:"type,omitempty"`
	// The text that appears in the dialog after the action is clicked.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// Determines if the action should happen on a regular cadence.
	Schedule *ActionSchedule `json:"schedule,omitempty" url:"schedule,omitempty"`
	// A primary action will be more visibly present, whether in Sheet or Workbook.
	Primary *bool `json:"primary,omitempty" url:"primary,omitempty"`
	// Whether to show a modal to confirm the action
	Confirm *bool `json:"confirm,omitempty" url:"confirm,omitempty"`
	// Icon will work on primary actions. It will only accept an already existing Flatfile design system icon.
	Icon *string `json:"icon,omitempty" url:"icon,omitempty"`
	// **This is deprecated. Use `constraints` instead.**
	RequireAllValid *bool `json:"requireAllValid,omitempty" url:"requireAllValid,omitempty"`
	// **This is deprecated. Use `constraints` instead.**
	RequireSelection *bool `json:"requireSelection,omitempty" url:"requireSelection,omitempty"`
	// Adds an input form for this action after it is clicked.
	InputForm *InputForm `json:"inputForm,omitempty" url:"inputForm,omitempty"`
	// A limitation or restriction on the action.
	Constraints []*ActionConstraint `json:"constraints,omitempty" url:"constraints,omitempty"`
	Mount       *ActionMount        `json:"mount,omitempty" url:"mount,omitempty"`
	Guide       *Guide              `json:"guide,omitempty" url:"guide,omitempty"`
	Guardrail   *Guardrail          `json:"guardrail,omitempty" url:"guardrail,omitempty"`
	// contains filtered or unexported fields
}

func (*ActionWithoutLabel) GetConfirm

func (a *ActionWithoutLabel) GetConfirm() *bool

func (*ActionWithoutLabel) GetConstraints

func (a *ActionWithoutLabel) GetConstraints() []*ActionConstraint

func (*ActionWithoutLabel) GetDescription

func (a *ActionWithoutLabel) GetDescription() *string

func (*ActionWithoutLabel) GetExtraProperties

func (a *ActionWithoutLabel) GetExtraProperties() map[string]interface{}

func (*ActionWithoutLabel) GetGuardrail

func (a *ActionWithoutLabel) GetGuardrail() *Guardrail

func (*ActionWithoutLabel) GetGuide

func (a *ActionWithoutLabel) GetGuide() *Guide

func (*ActionWithoutLabel) GetIcon

func (a *ActionWithoutLabel) GetIcon() *string

func (*ActionWithoutLabel) GetInputForm

func (a *ActionWithoutLabel) GetInputForm() *InputForm

func (*ActionWithoutLabel) GetMessages

func (a *ActionWithoutLabel) GetMessages() []*ActionMessage

func (*ActionWithoutLabel) GetMode

func (a *ActionWithoutLabel) GetMode() *ActionMode

func (*ActionWithoutLabel) GetMount

func (a *ActionWithoutLabel) GetMount() *ActionMount

func (*ActionWithoutLabel) GetOperation

func (a *ActionWithoutLabel) GetOperation() *string

func (*ActionWithoutLabel) GetPrimary

func (a *ActionWithoutLabel) GetPrimary() *bool

func (*ActionWithoutLabel) GetRequireAllValid

func (a *ActionWithoutLabel) GetRequireAllValid() *bool

func (*ActionWithoutLabel) GetRequireSelection

func (a *ActionWithoutLabel) GetRequireSelection() *bool

func (*ActionWithoutLabel) GetSchedule

func (a *ActionWithoutLabel) GetSchedule() *ActionSchedule

func (*ActionWithoutLabel) GetSlug

func (a *ActionWithoutLabel) GetSlug() *string

func (*ActionWithoutLabel) GetTooltip

func (a *ActionWithoutLabel) GetTooltip() *string

func (*ActionWithoutLabel) GetType

func (a *ActionWithoutLabel) GetType() *string

func (*ActionWithoutLabel) String

func (a *ActionWithoutLabel) String() string

func (*ActionWithoutLabel) UnmarshalJSON

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

type ActionsBulkCreateRequest

type ActionsBulkCreateRequest struct {
	// The Space ID for which to create the Actions.
	SpaceId SpaceId          `json:"-" url:"spaceId"`
	Body    ApiActionConfigs `json:"-" url:"-"`
}

func (*ActionsBulkCreateRequest) MarshalJSON

func (a *ActionsBulkCreateRequest) MarshalJSON() ([]byte, error)

func (*ActionsBulkCreateRequest) UnmarshalJSON

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

type ActorIdUnion

type ActorIdUnion struct {
	UserId  UserId
	AgentId AgentId
	GuestId GuestId
	// contains filtered or unexported fields
}

func NewActorIdUnionFromAgentId

func NewActorIdUnionFromAgentId(value AgentId) *ActorIdUnion

func NewActorIdUnionFromGuestId

func NewActorIdUnionFromGuestId(value GuestId) *ActorIdUnion

func NewActorIdUnionFromUserId

func NewActorIdUnionFromUserId(value UserId) *ActorIdUnion

func (*ActorIdUnion) Accept

func (a *ActorIdUnion) Accept(visitor ActorIdUnionVisitor) error

func (*ActorIdUnion) GetAgentId

func (a *ActorIdUnion) GetAgentId() AgentId

func (*ActorIdUnion) GetGuestId

func (a *ActorIdUnion) GetGuestId() GuestId

func (*ActorIdUnion) GetUserId

func (a *ActorIdUnion) GetUserId() UserId

func (ActorIdUnion) MarshalJSON

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

func (*ActorIdUnion) UnmarshalJSON

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

type ActorIdUnionVisitor

type ActorIdUnionVisitor interface {
	VisitUserId(UserId) error
	VisitAgentId(AgentId) error
	VisitGuestId(GuestId) error
}

type ActorRoleId

type ActorRoleId = string

Actor Role ID

type ActorRoleResponse

type ActorRoleResponse struct {
	Id         ActorRoleId      `json:"id" url:"id"`
	RoleId     RoleId           `json:"roleId" url:"roleId"`
	ActorId    *ActorIdUnion    `json:"actorId,omitempty" url:"actorId,omitempty"`
	ResourceId *ResourceIdUnion `json:"resourceId,omitempty" url:"resourceId,omitempty"`
	CreatedAt  time.Time        `json:"createdAt" url:"createdAt"`
	UpdatedAt  time.Time        `json:"updatedAt" url:"updatedAt"`
	// contains filtered or unexported fields
}

func (*ActorRoleResponse) GetActorId

func (a *ActorRoleResponse) GetActorId() *ActorIdUnion

func (*ActorRoleResponse) GetCreatedAt

func (a *ActorRoleResponse) GetCreatedAt() time.Time

func (*ActorRoleResponse) GetExtraProperties

func (a *ActorRoleResponse) GetExtraProperties() map[string]interface{}

func (*ActorRoleResponse) GetId

func (a *ActorRoleResponse) GetId() ActorRoleId

func (*ActorRoleResponse) GetResourceId

func (a *ActorRoleResponse) GetResourceId() *ResourceIdUnion

func (*ActorRoleResponse) GetRoleId

func (a *ActorRoleResponse) GetRoleId() RoleId

func (*ActorRoleResponse) GetUpdatedAt

func (a *ActorRoleResponse) GetUpdatedAt() time.Time

func (*ActorRoleResponse) MarshalJSON

func (a *ActorRoleResponse) MarshalJSON() ([]byte, error)

func (*ActorRoleResponse) String

func (a *ActorRoleResponse) String() string

func (*ActorRoleResponse) UnmarshalJSON

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

type AddRecordsToDataClipJobConfig

type AddRecordsToDataClipJobConfig struct {
	DataClipId DataClipId `json:"dataClipId" url:"dataClipId"`
	SheetId    SheetId    `json:"sheetId" url:"sheetId"`
	// contains filtered or unexported fields
}

The configuration for an add records to DataClip job

func (*AddRecordsToDataClipJobConfig) GetDataClipId

func (a *AddRecordsToDataClipJobConfig) GetDataClipId() DataClipId

func (*AddRecordsToDataClipJobConfig) GetExtraProperties

func (a *AddRecordsToDataClipJobConfig) GetExtraProperties() map[string]interface{}

func (*AddRecordsToDataClipJobConfig) GetSheetId

func (a *AddRecordsToDataClipJobConfig) GetSheetId() SheetId

func (*AddRecordsToDataClipJobConfig) String

func (a *AddRecordsToDataClipJobConfig) String() string

func (*AddRecordsToDataClipJobConfig) UnmarshalJSON

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

type Agent

type Agent struct {
	// The topics the agent should listen for
	Topics []EventTopic `json:"topics,omitempty" url:"topics,omitempty"`
	// The compiler of the agent
	Compiler *Compiler `json:"compiler,omitempty" url:"compiler,omitempty"`
	// The source of the agent
	Source *string `json:"source,omitempty" url:"source,omitempty"`
	// The source map of the agent
	SourceMap *string `json:"sourceMap,omitempty" url:"sourceMap,omitempty"`
	// The slug of the agent
	Slug *string `json:"slug,omitempty" url:"slug,omitempty"`
	// Options for the agent
	Options       map[string]interface{} `json:"options,omitempty" url:"options,omitempty"`
	Id            AgentId                `json:"id" url:"id"`
	CreatedAt     time.Time              `json:"createdAt" url:"createdAt"`
	UpdatedAt     time.Time              `json:"updatedAt" url:"updatedAt"`
	AccountId     AccountId              `json:"accountId" url:"accountId"`
	EnvironmentId EnvironmentId          `json:"environmentId" url:"environmentId"`
	// contains filtered or unexported fields
}

func (*Agent) GetAccountId

func (a *Agent) GetAccountId() AccountId

func (*Agent) GetCompiler

func (a *Agent) GetCompiler() *Compiler

func (*Agent) GetCreatedAt

func (a *Agent) GetCreatedAt() time.Time

func (*Agent) GetEnvironmentId

func (a *Agent) GetEnvironmentId() EnvironmentId

func (*Agent) GetExtraProperties

func (a *Agent) GetExtraProperties() map[string]interface{}

func (*Agent) GetId

func (a *Agent) GetId() AgentId

func (*Agent) GetOptions

func (a *Agent) GetOptions() map[string]interface{}

func (*Agent) GetSlug

func (a *Agent) GetSlug() *string

func (*Agent) GetSource

func (a *Agent) GetSource() *string

func (*Agent) GetSourceMap

func (a *Agent) GetSourceMap() *string

func (*Agent) GetTopics

func (a *Agent) GetTopics() []EventTopic

func (*Agent) GetUpdatedAt

func (a *Agent) GetUpdatedAt() time.Time

func (*Agent) MarshalJSON

func (a *Agent) MarshalJSON() ([]byte, error)

func (*Agent) String

func (a *Agent) String() string

func (*Agent) UnmarshalJSON

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

type AgentConfig

type AgentConfig struct {
	// The topics the agent should listen for
	Topics []EventTopic `json:"topics,omitempty" url:"topics,omitempty"`
	// The compiler of the agent
	Compiler *Compiler `json:"compiler,omitempty" url:"compiler,omitempty"`
	// The source of the agent
	Source *string `json:"source,omitempty" url:"source,omitempty"`
	// The source map of the agent
	SourceMap *string `json:"sourceMap,omitempty" url:"sourceMap,omitempty"`
	// The slug of the agent
	Slug *string `json:"slug,omitempty" url:"slug,omitempty"`
	// Options for the agent
	Options map[string]interface{} `json:"options,omitempty" url:"options,omitempty"`
	// contains filtered or unexported fields
}

Properties used to create a new agent

func (*AgentConfig) GetCompiler

func (a *AgentConfig) GetCompiler() *Compiler

func (*AgentConfig) GetExtraProperties

func (a *AgentConfig) GetExtraProperties() map[string]interface{}

func (*AgentConfig) GetOptions

func (a *AgentConfig) GetOptions() map[string]interface{}

func (*AgentConfig) GetSlug

func (a *AgentConfig) GetSlug() *string

func (*AgentConfig) GetSource

func (a *AgentConfig) GetSource() *string

func (*AgentConfig) GetSourceMap

func (a *AgentConfig) GetSourceMap() *string

func (*AgentConfig) GetTopics

func (a *AgentConfig) GetTopics() []EventTopic

func (*AgentConfig) String

func (a *AgentConfig) String() string

func (*AgentConfig) UnmarshalJSON

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

type AgentId

type AgentId = string

Agent ID

type AgentLog

type AgentLog struct {
	EventId EventId `json:"eventId" url:"eventId"`
	// Whether the agent execution was successful
	Success     bool   `json:"success" url:"success"`
	CreatedAt   string `json:"createdAt" url:"createdAt"`
	CompletedAt string `json:"completedAt" url:"completedAt"`
	// The log of the agent execution
	Log *string `json:"log,omitempty" url:"log,omitempty"`
	// contains filtered or unexported fields
}

A log of an agent execution

func (*AgentLog) GetCompletedAt

func (a *AgentLog) GetCompletedAt() string

func (*AgentLog) GetCreatedAt

func (a *AgentLog) GetCreatedAt() string

func (*AgentLog) GetEventId

func (a *AgentLog) GetEventId() EventId

func (*AgentLog) GetExtraProperties

func (a *AgentLog) GetExtraProperties() map[string]interface{}

func (*AgentLog) GetLog

func (a *AgentLog) GetLog() *string

func (*AgentLog) GetSuccess

func (a *AgentLog) GetSuccess() bool

func (*AgentLog) String

func (a *AgentLog) String() string

func (*AgentLog) UnmarshalJSON

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

type AgentResponse

type AgentResponse struct {
	Data *Agent `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*AgentResponse) GetData

func (a *AgentResponse) GetData() *Agent

func (*AgentResponse) GetExtraProperties

func (a *AgentResponse) GetExtraProperties() map[string]interface{}

func (*AgentResponse) String

func (a *AgentResponse) String() string

func (*AgentResponse) UnmarshalJSON

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

type AgentVersion

type AgentVersion struct {
	// The topics the agent should listen for
	Topics []EventTopic `json:"topics,omitempty" url:"topics,omitempty"`
	// The compiler of the agent
	Compiler *Compiler `json:"compiler,omitempty" url:"compiler,omitempty"`
	// The source of the agent
	Source *string `json:"source,omitempty" url:"source,omitempty"`
	// The source map of the agent
	SourceMap *string `json:"sourceMap,omitempty" url:"sourceMap,omitempty"`
	// The slug of the agent
	Slug *string `json:"slug,omitempty" url:"slug,omitempty"`
	// Options for the agent
	Options   map[string]interface{} `json:"options,omitempty" url:"options,omitempty"`
	Id        AgentVersionId         `json:"id" url:"id"`
	Version   int                    `json:"version" url:"version"`
	Origin    int                    `json:"origin" url:"origin"`
	CreatedAt time.Time              `json:"createdAt" url:"createdAt"`
	UpdatedAt time.Time              `json:"updatedAt" url:"updatedAt"`
	AgentId   AgentId                `json:"agent_id" url:"agent_id"`
	// contains filtered or unexported fields
}

func (*AgentVersion) GetAgentId

func (a *AgentVersion) GetAgentId() AgentId

func (*AgentVersion) GetCompiler

func (a *AgentVersion) GetCompiler() *Compiler

func (*AgentVersion) GetCreatedAt

func (a *AgentVersion) GetCreatedAt() time.Time

func (*AgentVersion) GetExtraProperties

func (a *AgentVersion) GetExtraProperties() map[string]interface{}

func (*AgentVersion) GetId

func (a *AgentVersion) GetId() AgentVersionId

func (*AgentVersion) GetOptions

func (a *AgentVersion) GetOptions() map[string]interface{}

func (*AgentVersion) GetOrigin

func (a *AgentVersion) GetOrigin() int

func (*AgentVersion) GetSlug

func (a *AgentVersion) GetSlug() *string

func (*AgentVersion) GetSource

func (a *AgentVersion) GetSource() *string

func (*AgentVersion) GetSourceMap

func (a *AgentVersion) GetSourceMap() *string

func (*AgentVersion) GetTopics

func (a *AgentVersion) GetTopics() []EventTopic

func (*AgentVersion) GetUpdatedAt

func (a *AgentVersion) GetUpdatedAt() time.Time

func (*AgentVersion) GetVersion

func (a *AgentVersion) GetVersion() int

func (*AgentVersion) MarshalJSON

func (a *AgentVersion) MarshalJSON() ([]byte, error)

func (*AgentVersion) String

func (a *AgentVersion) String() string

func (*AgentVersion) UnmarshalJSON

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

type AgentVersionId

type AgentVersionId = string

Agent version ID

type AgentVersionResponse

type AgentVersionResponse struct {
	Data *AgentVersion `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*AgentVersionResponse) GetData

func (a *AgentVersionResponse) GetData() *AgentVersion

func (*AgentVersionResponse) GetExtraProperties

func (a *AgentVersionResponse) GetExtraProperties() map[string]interface{}

func (*AgentVersionResponse) String

func (a *AgentVersionResponse) String() string

func (*AgentVersionResponse) UnmarshalJSON

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

type AiGenerateBlueprintConstraintsJobConfig

type AiGenerateBlueprintConstraintsJobConfig struct {
	SpaceId    SpaceId    `json:"spaceId" url:"spaceId"`
	WorkbookId WorkbookId `json:"workbookId" url:"workbookId"`
	// contains filtered or unexported fields
}

func (*AiGenerateBlueprintConstraintsJobConfig) GetExtraProperties

func (a *AiGenerateBlueprintConstraintsJobConfig) GetExtraProperties() map[string]interface{}

func (*AiGenerateBlueprintConstraintsJobConfig) GetSpaceId

func (a *AiGenerateBlueprintConstraintsJobConfig) GetSpaceId() SpaceId

func (*AiGenerateBlueprintConstraintsJobConfig) GetWorkbookId

func (a *AiGenerateBlueprintConstraintsJobConfig) GetWorkbookId() WorkbookId

func (*AiGenerateBlueprintConstraintsJobConfig) String

func (a *AiGenerateBlueprintConstraintsJobConfig) String() string

func (*AiGenerateBlueprintConstraintsJobConfig) UnmarshalJSON

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

type AiGenerateBlueprintJobConfig

type AiGenerateBlueprintJobConfig struct {
	SpaceId SpaceId `json:"spaceId" url:"spaceId"`
	AppId   AppId   `json:"appId" url:"appId"`
	// contains filtered or unexported fields
}

func (*AiGenerateBlueprintJobConfig) GetAppId

func (a *AiGenerateBlueprintJobConfig) GetAppId() AppId

func (*AiGenerateBlueprintJobConfig) GetExtraProperties

func (a *AiGenerateBlueprintJobConfig) GetExtraProperties() map[string]interface{}

func (*AiGenerateBlueprintJobConfig) GetSpaceId

func (a *AiGenerateBlueprintJobConfig) GetSpaceId() SpaceId

func (*AiGenerateBlueprintJobConfig) String

func (a *AiGenerateBlueprintJobConfig) String() string

func (*AiGenerateBlueprintJobConfig) UnmarshalJSON

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

type AiGenerateConstraintJobConfig

type AiGenerateConstraintJobConfig struct {
	SpaceId     SpaceId             `json:"spaceId" url:"spaceId"`
	Constraints []*StoredConstraint `json:"constraints,omitempty" url:"constraints,omitempty"`
	// A description of what the constraint to be generated should do
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// contains filtered or unexported fields
}

func (*AiGenerateConstraintJobConfig) GetConstraints

func (a *AiGenerateConstraintJobConfig) GetConstraints() []*StoredConstraint

func (*AiGenerateConstraintJobConfig) GetDescription

func (a *AiGenerateConstraintJobConfig) GetDescription() *string

func (*AiGenerateConstraintJobConfig) GetExtraProperties

func (a *AiGenerateConstraintJobConfig) GetExtraProperties() map[string]interface{}

func (*AiGenerateConstraintJobConfig) GetSpaceId

func (a *AiGenerateConstraintJobConfig) GetSpaceId() SpaceId

func (*AiGenerateConstraintJobConfig) String

func (a *AiGenerateConstraintJobConfig) String() string

func (*AiGenerateConstraintJobConfig) UnmarshalJSON

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

type AiGenerateSampleDataJobConfig

type AiGenerateSampleDataJobConfig struct {
	SpaceId SpaceId `json:"spaceId" url:"spaceId"`
	AppId   AppId   `json:"appId" url:"appId"`
	// contains filtered or unexported fields
}

func (*AiGenerateSampleDataJobConfig) GetAppId

func (a *AiGenerateSampleDataJobConfig) GetAppId() AppId

func (*AiGenerateSampleDataJobConfig) GetExtraProperties

func (a *AiGenerateSampleDataJobConfig) GetExtraProperties() map[string]interface{}

func (*AiGenerateSampleDataJobConfig) GetSpaceId

func (a *AiGenerateSampleDataJobConfig) GetSpaceId() SpaceId

func (*AiGenerateSampleDataJobConfig) String

func (a *AiGenerateSampleDataJobConfig) String() string

func (*AiGenerateSampleDataJobConfig) UnmarshalJSON

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

type AiRuleCreationJobConfig

type AiRuleCreationJobConfig struct {
	// Display name for the rule to be created
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// The natural language description of the rule to be created
	Prompt string `json:"prompt" url:"prompt"`
	// The ID of the sheet containing the field to create/update the rule for
	SheetId SheetId `json:"sheetId" url:"sheetId"`
	// The key of the field to create/update the rule for
	FieldKey string `json:"fieldKey" url:"fieldKey"`
	// To edit an existing rule, provide the index of the constraint in the constraints array for the field and that constraint will be replaced.
	Index *int `json:"index,omitempty" url:"index,omitempty"`
	// contains filtered or unexported fields
}

Configuration for AI-powered rule creation jobs that generate or replace field constraints

func (*AiRuleCreationJobConfig) GetExtraProperties

func (a *AiRuleCreationJobConfig) GetExtraProperties() map[string]interface{}

func (*AiRuleCreationJobConfig) GetFieldKey

func (a *AiRuleCreationJobConfig) GetFieldKey() string

func (*AiRuleCreationJobConfig) GetIndex

func (a *AiRuleCreationJobConfig) GetIndex() *int

func (*AiRuleCreationJobConfig) GetLabel

func (a *AiRuleCreationJobConfig) GetLabel() *string

func (*AiRuleCreationJobConfig) GetPrompt

func (a *AiRuleCreationJobConfig) GetPrompt() string

func (*AiRuleCreationJobConfig) GetSheetId

func (a *AiRuleCreationJobConfig) GetSheetId() SheetId

func (*AiRuleCreationJobConfig) String

func (a *AiRuleCreationJobConfig) String() string

func (*AiRuleCreationJobConfig) UnmarshalJSON

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

type ApiAction

type ApiAction struct {
	// **This is deprecated. Use `operation` instead.**
	Slug *string `json:"slug,omitempty" url:"slug,omitempty"`
	// This will become the job operation that is triggered
	Operation *string `json:"operation,omitempty" url:"operation,omitempty"`
	// Foreground and toolbarBlocking action mode will prevent interacting with the resource until complete
	Mode *ActionMode `json:"mode,omitempty" url:"mode,omitempty"`
	// A tooltip that appears when hovering the action button
	Tooltip  *string          `json:"tooltip,omitempty" url:"tooltip,omitempty"`
	Messages []*ActionMessage `json:"messages,omitempty" url:"messages,omitempty"`
	// **This is deprecated.**
	Type *string `json:"type,omitempty" url:"type,omitempty"`
	// The text that appears in the dialog after the action is clicked.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// Determines if the action should happen on a regular cadence.
	Schedule *ActionSchedule `json:"schedule,omitempty" url:"schedule,omitempty"`
	// A primary action will be more visibly present, whether in Sheet or Workbook.
	Primary *bool `json:"primary,omitempty" url:"primary,omitempty"`
	// Whether to show a modal to confirm the action
	Confirm *bool `json:"confirm,omitempty" url:"confirm,omitempty"`
	// Icon will work on primary actions. It will only accept an already existing Flatfile design system icon.
	Icon *string `json:"icon,omitempty" url:"icon,omitempty"`
	// **This is deprecated. Use `constraints` instead.**
	RequireAllValid *bool `json:"requireAllValid,omitempty" url:"requireAllValid,omitempty"`
	// **This is deprecated. Use `constraints` instead.**
	RequireSelection *bool `json:"requireSelection,omitempty" url:"requireSelection,omitempty"`
	// Adds an input form for this action after it is clicked.
	InputForm *InputForm `json:"inputForm,omitempty" url:"inputForm,omitempty"`
	// A limitation or restriction on the action.
	Constraints []*ActionConstraint `json:"constraints,omitempty" url:"constraints,omitempty"`
	Mount       *ActionMount        `json:"mount,omitempty" url:"mount,omitempty"`
	Guide       *Guide              `json:"guide,omitempty" url:"guide,omitempty"`
	Guardrail   *Guardrail          `json:"guardrail,omitempty" url:"guardrail,omitempty"`
	// The text on the Button itself
	Label     string    `json:"label" url:"label"`
	Id        ActionId  `json:"id" url:"id"`
	TargetId  string    `json:"targetId" url:"targetId"`
	UpdatedAt time.Time `json:"updatedAt" url:"updatedAt"`
	CreatedAt time.Time `json:"createdAt" url:"createdAt"`
	// contains filtered or unexported fields
}

func (*ApiAction) GetConfirm

func (a *ApiAction) GetConfirm() *bool

func (*ApiAction) GetConstraints

func (a *ApiAction) GetConstraints() []*ActionConstraint

func (*ApiAction) GetCreatedAt

func (a *ApiAction) GetCreatedAt() time.Time

func (*ApiAction) GetDescription

func (a *ApiAction) GetDescription() *string

func (*ApiAction) GetExtraProperties

func (a *ApiAction) GetExtraProperties() map[string]interface{}

func (*ApiAction) GetGuardrail

func (a *ApiAction) GetGuardrail() *Guardrail

func (*ApiAction) GetGuide

func (a *ApiAction) GetGuide() *Guide

func (*ApiAction) GetIcon

func (a *ApiAction) GetIcon() *string

func (*ApiAction) GetId

func (a *ApiAction) GetId() ActionId

func (*ApiAction) GetInputForm

func (a *ApiAction) GetInputForm() *InputForm

func (*ApiAction) GetLabel

func (a *ApiAction) GetLabel() string

func (*ApiAction) GetMessages

func (a *ApiAction) GetMessages() []*ActionMessage

func (*ApiAction) GetMode

func (a *ApiAction) GetMode() *ActionMode

func (*ApiAction) GetMount

func (a *ApiAction) GetMount() *ActionMount

func (*ApiAction) GetOperation

func (a *ApiAction) GetOperation() *string

func (*ApiAction) GetPrimary

func (a *ApiAction) GetPrimary() *bool

func (*ApiAction) GetRequireAllValid

func (a *ApiAction) GetRequireAllValid() *bool

func (*ApiAction) GetRequireSelection

func (a *ApiAction) GetRequireSelection() *bool

func (*ApiAction) GetSchedule

func (a *ApiAction) GetSchedule() *ActionSchedule

func (*ApiAction) GetSlug

func (a *ApiAction) GetSlug() *string

func (*ApiAction) GetTargetId

func (a *ApiAction) GetTargetId() string

func (*ApiAction) GetTooltip

func (a *ApiAction) GetTooltip() *string

func (*ApiAction) GetType

func (a *ApiAction) GetType() *string

func (*ApiAction) GetUpdatedAt

func (a *ApiAction) GetUpdatedAt() time.Time

func (*ApiAction) MarshalJSON

func (a *ApiAction) MarshalJSON() ([]byte, error)

func (*ApiAction) String

func (a *ApiAction) String() string

func (*ApiAction) UnmarshalJSON

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

type ApiActionConfig

type ApiActionConfig struct {
	// **This is deprecated. Use `operation` instead.**
	Slug *string `json:"slug,omitempty" url:"slug,omitempty"`
	// This will become the job operation that is triggered
	Operation *string `json:"operation,omitempty" url:"operation,omitempty"`
	// Foreground and toolbarBlocking action mode will prevent interacting with the resource until complete
	Mode *ActionMode `json:"mode,omitempty" url:"mode,omitempty"`
	// A tooltip that appears when hovering the action button
	Tooltip  *string          `json:"tooltip,omitempty" url:"tooltip,omitempty"`
	Messages []*ActionMessage `json:"messages,omitempty" url:"messages,omitempty"`
	// **This is deprecated.**
	Type *string `json:"type,omitempty" url:"type,omitempty"`
	// The text that appears in the dialog after the action is clicked.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// Determines if the action should happen on a regular cadence.
	Schedule *ActionSchedule `json:"schedule,omitempty" url:"schedule,omitempty"`
	// A primary action will be more visibly present, whether in Sheet or Workbook.
	Primary *bool `json:"primary,omitempty" url:"primary,omitempty"`
	// Whether to show a modal to confirm the action
	Confirm *bool `json:"confirm,omitempty" url:"confirm,omitempty"`
	// Icon will work on primary actions. It will only accept an already existing Flatfile design system icon.
	Icon *string `json:"icon,omitempty" url:"icon,omitempty"`
	// **This is deprecated. Use `constraints` instead.**
	RequireAllValid *bool `json:"requireAllValid,omitempty" url:"requireAllValid,omitempty"`
	// **This is deprecated. Use `constraints` instead.**
	RequireSelection *bool `json:"requireSelection,omitempty" url:"requireSelection,omitempty"`
	// Adds an input form for this action after it is clicked.
	InputForm *InputForm `json:"inputForm,omitempty" url:"inputForm,omitempty"`
	// A limitation or restriction on the action.
	Constraints []*ActionConstraint `json:"constraints,omitempty" url:"constraints,omitempty"`
	Mount       *ActionMount        `json:"mount,omitempty" url:"mount,omitempty"`
	Guide       *Guide              `json:"guide,omitempty" url:"guide,omitempty"`
	Guardrail   *Guardrail          `json:"guardrail,omitempty" url:"guardrail,omitempty"`
	// The text on the Button itself
	Label    string `json:"label" url:"label"`
	TargetId string `json:"targetId" url:"targetId"`
	// contains filtered or unexported fields
}

func (*ApiActionConfig) GetConfirm

func (a *ApiActionConfig) GetConfirm() *bool

func (*ApiActionConfig) GetConstraints

func (a *ApiActionConfig) GetConstraints() []*ActionConstraint

func (*ApiActionConfig) GetDescription

func (a *ApiActionConfig) GetDescription() *string

func (*ApiActionConfig) GetExtraProperties

func (a *ApiActionConfig) GetExtraProperties() map[string]interface{}

func (*ApiActionConfig) GetGuardrail

func (a *ApiActionConfig) GetGuardrail() *Guardrail

func (*ApiActionConfig) GetGuide

func (a *ApiActionConfig) GetGuide() *Guide

func (*ApiActionConfig) GetIcon

func (a *ApiActionConfig) GetIcon() *string

func (*ApiActionConfig) GetInputForm

func (a *ApiActionConfig) GetInputForm() *InputForm

func (*ApiActionConfig) GetLabel

func (a *ApiActionConfig) GetLabel() string

func (*ApiActionConfig) GetMessages

func (a *ApiActionConfig) GetMessages() []*ActionMessage

func (*ApiActionConfig) GetMode

func (a *ApiActionConfig) GetMode() *ActionMode

func (*ApiActionConfig) GetMount

func (a *ApiActionConfig) GetMount() *ActionMount

func (*ApiActionConfig) GetOperation

func (a *ApiActionConfig) GetOperation() *string

func (*ApiActionConfig) GetPrimary

func (a *ApiActionConfig) GetPrimary() *bool

func (*ApiActionConfig) GetRequireAllValid

func (a *ApiActionConfig) GetRequireAllValid() *bool

func (*ApiActionConfig) GetRequireSelection

func (a *ApiActionConfig) GetRequireSelection() *bool

func (*ApiActionConfig) GetSchedule

func (a *ApiActionConfig) GetSchedule() *ActionSchedule

func (*ApiActionConfig) GetSlug

func (a *ApiActionConfig) GetSlug() *string

func (*ApiActionConfig) GetTargetId

func (a *ApiActionConfig) GetTargetId() string

func (*ApiActionConfig) GetTooltip

func (a *ApiActionConfig) GetTooltip() *string

func (*ApiActionConfig) GetType

func (a *ApiActionConfig) GetType() *string

func (*ApiActionConfig) String

func (a *ApiActionConfig) String() string

func (*ApiActionConfig) UnmarshalJSON

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

type ApiActionConfigs

type ApiActionConfigs = []*ApiActionConfig

type ApiActionResponse

type ApiActionResponse = *ApiAction

type ApiActionsResponse

type ApiActionsResponse = []*ApiAction

type App

type App struct {
	Id                 AppId       `json:"id" url:"id"`
	Name               string      `json:"name" url:"name"`
	Namespace          string      `json:"namespace" url:"namespace"`
	Type               AppType     `json:"type" url:"type"`
	Entity             string      `json:"entity" url:"entity"`
	EntityPlural       string      `json:"entityPlural" url:"entityPlural"`
	Icon               *string     `json:"icon,omitempty" url:"icon,omitempty"`
	Metadata           interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	EnvironmentFilters interface{} `json:"environmentFilters,omitempty" url:"environmentFilters,omitempty"`
	Blueprint          interface{} `json:"blueprint,omitempty" url:"blueprint,omitempty"`
	CreatedAt          time.Time   `json:"createdAt" url:"createdAt"`
	UpdatedAt          time.Time   `json:"updatedAt" url:"updatedAt"`
	DeletedAt          *time.Time  `json:"deletedAt,omitempty" url:"deletedAt,omitempty"`
	ActivatedAt        *time.Time  `json:"activatedAt,omitempty" url:"activatedAt,omitempty"`
	// contains filtered or unexported fields
}

An app

func (*App) GetActivatedAt

func (a *App) GetActivatedAt() *time.Time

func (*App) GetBlueprint

func (a *App) GetBlueprint() interface{}

func (*App) GetCreatedAt

func (a *App) GetCreatedAt() time.Time

func (*App) GetDeletedAt

func (a *App) GetDeletedAt() *time.Time

func (*App) GetEntity

func (a *App) GetEntity() string

func (*App) GetEntityPlural

func (a *App) GetEntityPlural() string

func (*App) GetEnvironmentFilters

func (a *App) GetEnvironmentFilters() interface{}

func (*App) GetExtraProperties

func (a *App) GetExtraProperties() map[string]interface{}

func (*App) GetIcon

func (a *App) GetIcon() *string

func (*App) GetId

func (a *App) GetId() AppId

func (*App) GetMetadata

func (a *App) GetMetadata() interface{}

func (*App) GetName

func (a *App) GetName() string

func (*App) GetNamespace

func (a *App) GetNamespace() string

func (*App) GetType

func (a *App) GetType() AppType

func (*App) GetUpdatedAt

func (a *App) GetUpdatedAt() time.Time

func (*App) MarshalJSON

func (a *App) MarshalJSON() ([]byte, error)

func (*App) String

func (a *App) String() string

func (*App) UnmarshalJSON

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

type AppAutobuildDeployJobConfig

type AppAutobuildDeployJobConfig struct {
	SpaceId SpaceId `json:"spaceId" url:"spaceId"`
	AppId   AppId   `json:"appId" url:"appId"`
	// contains filtered or unexported fields
}

func (*AppAutobuildDeployJobConfig) GetAppId

func (a *AppAutobuildDeployJobConfig) GetAppId() AppId

func (*AppAutobuildDeployJobConfig) GetExtraProperties

func (a *AppAutobuildDeployJobConfig) GetExtraProperties() map[string]interface{}

func (*AppAutobuildDeployJobConfig) GetSpaceId

func (a *AppAutobuildDeployJobConfig) GetSpaceId() SpaceId

func (*AppAutobuildDeployJobConfig) String

func (a *AppAutobuildDeployJobConfig) String() string

func (*AppAutobuildDeployJobConfig) UnmarshalJSON

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

type AppCreate

type AppCreate struct {
	Name               string      `json:"name" url:"name"`
	Namespace          string      `json:"namespace" url:"namespace"`
	Type               AppType     `json:"type" url:"type"`
	Entity             *string     `json:"entity,omitempty" url:"entity,omitempty"`
	EntityPlural       *string     `json:"entityPlural,omitempty" url:"entityPlural,omitempty"`
	Icon               *string     `json:"icon,omitempty" url:"icon,omitempty"`
	Metadata           interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	EnvironmentFilters interface{} `json:"environmentFilters,omitempty" url:"environmentFilters,omitempty"`
	Blueprint          interface{} `json:"blueprint,omitempty" url:"blueprint,omitempty"`
	// contains filtered or unexported fields
}

Create an app

func (*AppCreate) GetBlueprint

func (a *AppCreate) GetBlueprint() interface{}

func (*AppCreate) GetEntity

func (a *AppCreate) GetEntity() *string

func (*AppCreate) GetEntityPlural

func (a *AppCreate) GetEntityPlural() *string

func (*AppCreate) GetEnvironmentFilters

func (a *AppCreate) GetEnvironmentFilters() interface{}

func (*AppCreate) GetExtraProperties

func (a *AppCreate) GetExtraProperties() map[string]interface{}

func (*AppCreate) GetIcon

func (a *AppCreate) GetIcon() *string

func (*AppCreate) GetMetadata

func (a *AppCreate) GetMetadata() interface{}

func (*AppCreate) GetName

func (a *AppCreate) GetName() string

func (*AppCreate) GetNamespace

func (a *AppCreate) GetNamespace() string

func (*AppCreate) GetType

func (a *AppCreate) GetType() AppType

func (*AppCreate) String

func (a *AppCreate) String() string

func (*AppCreate) UnmarshalJSON

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

type AppId

type AppId = string

App ID

type AppPatch

type AppPatch struct {
	Name               *string     `json:"name,omitempty" url:"name,omitempty"`
	Namespace          *string     `json:"namespace,omitempty" url:"namespace,omitempty"`
	Entity             *string     `json:"entity,omitempty" url:"entity,omitempty"`
	EntityPlural       *string     `json:"entityPlural,omitempty" url:"entityPlural,omitempty"`
	Icon               *string     `json:"icon,omitempty" url:"icon,omitempty"`
	Metadata           interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	EnvironmentFilters interface{} `json:"environmentFilters,omitempty" url:"environmentFilters,omitempty"`
	Blueprint          interface{} `json:"blueprint,omitempty" url:"blueprint,omitempty"`
	ActivatedAt        *time.Time  `json:"activatedAt,omitempty" url:"activatedAt,omitempty"`
	// contains filtered or unexported fields
}

Update an app

func (*AppPatch) GetActivatedAt

func (a *AppPatch) GetActivatedAt() *time.Time

func (*AppPatch) GetBlueprint

func (a *AppPatch) GetBlueprint() interface{}

func (*AppPatch) GetEntity

func (a *AppPatch) GetEntity() *string

func (*AppPatch) GetEntityPlural

func (a *AppPatch) GetEntityPlural() *string

func (*AppPatch) GetEnvironmentFilters

func (a *AppPatch) GetEnvironmentFilters() interface{}

func (*AppPatch) GetExtraProperties

func (a *AppPatch) GetExtraProperties() map[string]interface{}

func (*AppPatch) GetIcon

func (a *AppPatch) GetIcon() *string

func (*AppPatch) GetMetadata

func (a *AppPatch) GetMetadata() interface{}

func (*AppPatch) GetName

func (a *AppPatch) GetName() *string

func (*AppPatch) GetNamespace

func (a *AppPatch) GetNamespace() *string

func (*AppPatch) MarshalJSON

func (a *AppPatch) MarshalJSON() ([]byte, error)

func (*AppPatch) String

func (a *AppPatch) String() string

func (*AppPatch) UnmarshalJSON

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

type AppResponse

type AppResponse struct {
	Data *App `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*AppResponse) GetData

func (a *AppResponse) GetData() *App

func (*AppResponse) GetExtraProperties

func (a *AppResponse) GetExtraProperties() map[string]interface{}

func (*AppResponse) String

func (a *AppResponse) String() string

func (*AppResponse) UnmarshalJSON

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

type AppType

type AppType string

const (
	AppTypePortal    AppType = "PORTAL"
	AppTypeProjects  AppType = "PROJECTS"
	AppTypeMapping   AppType = "MAPPING"
	AppTypeWorkbooks AppType = "WORKBOOKS"
	AppTypeCustom    AppType = "CUSTOM"
)

func NewAppTypeFromString

func NewAppTypeFromString(s string) (AppType, error)

func (AppType) Ptr

func (a AppType) Ptr() *AppType

type AppsResponse

type AppsResponse struct {
	Data []*App `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*AppsResponse) GetData

func (a *AppsResponse) GetData() []*App

func (*AppsResponse) GetExtraProperties

func (a *AppsResponse) GetExtraProperties() map[string]interface{}

func (*AppsResponse) String

func (a *AppsResponse) String() string

func (*AppsResponse) UnmarshalJSON

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

type ArrayableProperty

type ArrayableProperty struct {
	// Will allow multiple values and store as an array
	IsArray *bool `json:"isArray,omitempty" url:"isArray,omitempty"`
	// contains filtered or unexported fields
}

func (*ArrayableProperty) GetExtraProperties

func (a *ArrayableProperty) GetExtraProperties() map[string]interface{}

func (*ArrayableProperty) GetIsArray

func (a *ArrayableProperty) GetIsArray() *bool

func (*ArrayableProperty) String

func (a *ArrayableProperty) String() string

func (*ArrayableProperty) UnmarshalJSON

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

type AssignActorRoleRequest

type AssignActorRoleRequest struct {
	RoleId     RoleId           `json:"roleId" url:"roleId"`
	ResourceId *ResourceIdUnion `json:"resourceId,omitempty" url:"resourceId,omitempty"`
	// contains filtered or unexported fields
}

func (*AssignActorRoleRequest) GetExtraProperties

func (a *AssignActorRoleRequest) GetExtraProperties() map[string]interface{}

func (*AssignActorRoleRequest) GetResourceId

func (a *AssignActorRoleRequest) GetResourceId() *ResourceIdUnion

func (*AssignActorRoleRequest) GetRoleId

func (a *AssignActorRoleRequest) GetRoleId() RoleId

func (*AssignActorRoleRequest) String

func (a *AssignActorRoleRequest) String() string

func (*AssignActorRoleRequest) UnmarshalJSON

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

type AssignRoleResponse

type AssignRoleResponse struct {
	Data *AssignRoleResponseData `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*AssignRoleResponse) GetData

func (a *AssignRoleResponse) GetData() *AssignRoleResponseData

func (*AssignRoleResponse) GetExtraProperties

func (a *AssignRoleResponse) GetExtraProperties() map[string]interface{}

func (*AssignRoleResponse) String

func (a *AssignRoleResponse) String() string

func (*AssignRoleResponse) UnmarshalJSON

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

type AssignRoleResponseData

type AssignRoleResponseData struct {
	Id         ActorRoleId      `json:"id" url:"id"`
	RoleId     RoleId           `json:"roleId" url:"roleId"`
	ActorId    *ActorIdUnion    `json:"actorId,omitempty" url:"actorId,omitempty"`
	ResourceId *ResourceIdUnion `json:"resourceId,omitempty" url:"resourceId,omitempty"`
	CreatedAt  time.Time        `json:"createdAt" url:"createdAt"`
	UpdatedAt  time.Time        `json:"updatedAt" url:"updatedAt"`
	// contains filtered or unexported fields
}

func (*AssignRoleResponseData) GetActorId

func (a *AssignRoleResponseData) GetActorId() *ActorIdUnion

func (*AssignRoleResponseData) GetCreatedAt

func (a *AssignRoleResponseData) GetCreatedAt() time.Time

func (*AssignRoleResponseData) GetExtraProperties

func (a *AssignRoleResponseData) GetExtraProperties() map[string]interface{}

func (*AssignRoleResponseData) GetId

func (a *AssignRoleResponseData) GetId() ActorRoleId

func (*AssignRoleResponseData) GetResourceId

func (a *AssignRoleResponseData) GetResourceId() *ResourceIdUnion

func (*AssignRoleResponseData) GetRoleId

func (a *AssignRoleResponseData) GetRoleId() RoleId

func (*AssignRoleResponseData) GetUpdatedAt

func (a *AssignRoleResponseData) GetUpdatedAt() time.Time

func (*AssignRoleResponseData) MarshalJSON

func (a *AssignRoleResponseData) MarshalJSON() ([]byte, error)

func (*AssignRoleResponseData) String

func (a *AssignRoleResponseData) String() string

func (*AssignRoleResponseData) UnmarshalJSON

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

type BadRequestError

type BadRequestError struct {
	*core.APIError
	Body *Errors
}

func (*BadRequestError) MarshalJSON

func (b *BadRequestError) MarshalJSON() ([]byte, error)

func (*BadRequestError) UnmarshalJSON

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

func (*BadRequestError) Unwrap

func (b *BadRequestError) Unwrap() error

type BaseEvent

type BaseEvent struct {
	// The domain of the event
	Domain Domain `json:"domain" url:"domain"`
	// The context of the event
	Context *Context `json:"context,omitempty" url:"context,omitempty"`
	// The attributes of the event
	Attributes *EventAttributes `json:"attributes,omitempty" url:"attributes,omitempty"`
	// The callback url to acknowledge the event
	CallbackUrl *string `json:"callbackUrl,omitempty" url:"callbackUrl,omitempty"`
	// The url to retrieve the data associated with the event
	DataUrl    *string  `json:"dataUrl,omitempty" url:"dataUrl,omitempty"`
	Target     *string  `json:"target,omitempty" url:"target,omitempty"`
	Origin     *Origin  `json:"origin,omitempty" url:"origin,omitempty"`
	Namespaces []string `json:"namespaces,omitempty" url:"namespaces,omitempty"`
	// contains filtered or unexported fields
}

func (*BaseEvent) GetAttributes

func (b *BaseEvent) GetAttributes() *EventAttributes

func (*BaseEvent) GetCallbackUrl

func (b *BaseEvent) GetCallbackUrl() *string

func (*BaseEvent) GetContext

func (b *BaseEvent) GetContext() *Context

func (*BaseEvent) GetDataUrl

func (b *BaseEvent) GetDataUrl() *string

func (*BaseEvent) GetDomain

func (b *BaseEvent) GetDomain() Domain

func (*BaseEvent) GetExtraProperties

func (b *BaseEvent) GetExtraProperties() map[string]interface{}

func (*BaseEvent) GetNamespaces

func (b *BaseEvent) GetNamespaces() []string

func (*BaseEvent) GetOrigin

func (b *BaseEvent) GetOrigin() *Origin

func (*BaseEvent) GetTarget

func (b *BaseEvent) GetTarget() *string

func (*BaseEvent) String

func (b *BaseEvent) String() string

func (*BaseEvent) UnmarshalJSON

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

type BaseProperty

type BaseProperty struct {
	Key string `json:"key" url:"key"`
	// User friendly field name
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// A short description of the field. Markdown syntax is supported.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values.
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,omitempty"`
	// An array of actions that end users can perform on this Column.
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// Useful for any contextual metadata regarding the schema. Store any valid json here.
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// A unique presentation for a field in the UI.
	Treatments       []string `json:"treatments,omitempty" url:"treatments,omitempty"`
	AlternativeNames []string `json:"alternativeNames,omitempty" url:"alternativeNames,omitempty"`
	// contains filtered or unexported fields
}

func (*BaseProperty) GetActions

func (b *BaseProperty) GetActions() []*Action

func (*BaseProperty) GetAlternativeNames

func (b *BaseProperty) GetAlternativeNames() []string

func (*BaseProperty) GetAppearance

func (b *BaseProperty) GetAppearance() *FieldAppearance

func (*BaseProperty) GetConstraints

func (b *BaseProperty) GetConstraints() []*Constraint

func (*BaseProperty) GetDescription

func (b *BaseProperty) GetDescription() *string

func (*BaseProperty) GetExtraProperties

func (b *BaseProperty) GetExtraProperties() map[string]interface{}

func (*BaseProperty) GetKey

func (b *BaseProperty) GetKey() string

func (*BaseProperty) GetLabel

func (b *BaseProperty) GetLabel() *string

func (*BaseProperty) GetMetadata

func (b *BaseProperty) GetMetadata() interface{}

func (*BaseProperty) GetReadonly

func (b *BaseProperty) GetReadonly() *bool

func (*BaseProperty) GetTreatments

func (b *BaseProperty) GetTreatments() []string

func (*BaseProperty) String

func (b *BaseProperty) String() string

func (*BaseProperty) UnmarshalJSON

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

type BooleanProperty

type BooleanProperty struct {
	Key string `json:"key" url:"key"`
	// User friendly field name
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// A short description of the field. Markdown syntax is supported.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values.
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,omitempty"`
	// An array of actions that end users can perform on this Column.
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// Useful for any contextual metadata regarding the schema. Store any valid json here.
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// A unique presentation for a field in the UI.
	Treatments       []string               `json:"treatments,omitempty" url:"treatments,omitempty"`
	AlternativeNames []string               `json:"alternativeNames,omitempty" url:"alternativeNames,omitempty"`
	Config           *BooleanPropertyConfig `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

A `true` or `false` value type. Matching engines should attempt to resolve all common ways of representing this value and it should usually be displayed as a checkbox.

func (*BooleanProperty) GetActions

func (b *BooleanProperty) GetActions() []*Action

func (*BooleanProperty) GetAlternativeNames

func (b *BooleanProperty) GetAlternativeNames() []string

func (*BooleanProperty) GetAppearance

func (b *BooleanProperty) GetAppearance() *FieldAppearance

func (*BooleanProperty) GetConfig

func (b *BooleanProperty) GetConfig() *BooleanPropertyConfig

func (*BooleanProperty) GetConstraints

func (b *BooleanProperty) GetConstraints() []*Constraint

func (*BooleanProperty) GetDescription

func (b *BooleanProperty) GetDescription() *string

func (*BooleanProperty) GetExtraProperties

func (b *BooleanProperty) GetExtraProperties() map[string]interface{}

func (*BooleanProperty) GetKey

func (b *BooleanProperty) GetKey() string

func (*BooleanProperty) GetLabel

func (b *BooleanProperty) GetLabel() *string

func (*BooleanProperty) GetMetadata

func (b *BooleanProperty) GetMetadata() interface{}

func (*BooleanProperty) GetReadonly

func (b *BooleanProperty) GetReadonly() *bool

func (*BooleanProperty) GetTreatments

func (b *BooleanProperty) GetTreatments() []string

func (*BooleanProperty) String

func (b *BooleanProperty) String() string

func (*BooleanProperty) UnmarshalJSON

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

type BooleanPropertyConfig

type BooleanPropertyConfig struct {
	// Allow a neither true or false state to be stored as `null`
	AllowIndeterminate bool `json:"allowIndeterminate" url:"allowIndeterminate"`
	// contains filtered or unexported fields
}

func (*BooleanPropertyConfig) GetAllowIndeterminate

func (b *BooleanPropertyConfig) GetAllowIndeterminate() bool

func (*BooleanPropertyConfig) GetExtraProperties

func (b *BooleanPropertyConfig) GetExtraProperties() map[string]interface{}

func (*BooleanPropertyConfig) String

func (b *BooleanPropertyConfig) String() string

func (*BooleanPropertyConfig) UnmarshalJSON

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

type CategoryMapping

type CategoryMapping struct {
	// The source value to map from
	SourceValue *EnumValue `json:"sourceValue,omitempty" url:"sourceValue,omitempty"`
	// The destination value to map to
	DestinationValue *EnumValue `json:"destinationValue,omitempty" url:"destinationValue,omitempty"`
	// contains filtered or unexported fields
}

func (*CategoryMapping) GetDestinationValue

func (c *CategoryMapping) GetDestinationValue() *EnumValue

func (*CategoryMapping) GetExtraProperties

func (c *CategoryMapping) GetExtraProperties() map[string]interface{}

func (*CategoryMapping) GetSourceValue

func (c *CategoryMapping) GetSourceValue() *EnumValue

func (*CategoryMapping) String

func (c *CategoryMapping) String() string

func (*CategoryMapping) UnmarshalJSON

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

type CellConfig

type CellConfig struct {
	Readonly *bool `json:"readonly,omitempty" url:"readonly,omitempty"`
	// contains filtered or unexported fields
}

CellConfig

func (*CellConfig) GetExtraProperties

func (c *CellConfig) GetExtraProperties() map[string]interface{}

func (*CellConfig) GetReadonly

func (c *CellConfig) GetReadonly() *bool

func (*CellConfig) String

func (c *CellConfig) String() string

func (*CellConfig) UnmarshalJSON

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

type CellValue

type CellValue struct {
	Valid    *bool                `json:"valid,omitempty" url:"valid,omitempty"`
	Messages []*ValidationMessage `json:"messages,omitempty" url:"messages,omitempty"`
	// Deprecated, use record level metadata instead.
	Metadata  map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	Value     *CellValueUnion        `json:"value,omitempty" url:"value,omitempty"`
	Layer     *string                `json:"layer,omitempty" url:"layer,omitempty"`
	UpdatedAt *time.Time             `json:"updatedAt,omitempty" url:"updatedAt,omitempty"`
	// contains filtered or unexported fields
}

func (*CellValue) GetExtraProperties

func (c *CellValue) GetExtraProperties() map[string]interface{}

func (*CellValue) GetLayer

func (c *CellValue) GetLayer() *string

func (*CellValue) GetMessages

func (c *CellValue) GetMessages() []*ValidationMessage

func (*CellValue) GetMetadata

func (c *CellValue) GetMetadata() map[string]interface{}

func (*CellValue) GetUpdatedAt

func (c *CellValue) GetUpdatedAt() *time.Time

func (*CellValue) GetValid

func (c *CellValue) GetValid() *bool

func (*CellValue) GetValue

func (c *CellValue) GetValue() *CellValueUnion

func (*CellValue) MarshalJSON

func (c *CellValue) MarshalJSON() ([]byte, error)

func (*CellValue) String

func (c *CellValue) String() string

func (*CellValue) UnmarshalJSON

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

type CellValueUnion

type CellValueUnion struct {
	String     string
	Integer    int
	Long       int64
	Double     float64
	Boolean    bool
	Date       time.Time
	DateTime   time.Time
	StringList []string
	// contains filtered or unexported fields
}

func NewCellValueUnionFromBoolean

func NewCellValueUnionFromBoolean(value bool) *CellValueUnion

func NewCellValueUnionFromDate

func NewCellValueUnionFromDate(value time.Time) *CellValueUnion

func NewCellValueUnionFromDateTime

func NewCellValueUnionFromDateTime(value time.Time) *CellValueUnion

func NewCellValueUnionFromDouble

func NewCellValueUnionFromDouble(value float64) *CellValueUnion

func NewCellValueUnionFromInteger

func NewCellValueUnionFromInteger(value int) *CellValueUnion

func NewCellValueUnionFromLong

func NewCellValueUnionFromLong(value int64) *CellValueUnion

func NewCellValueUnionFromString

func NewCellValueUnionFromString(value string) *CellValueUnion

func NewCellValueUnionFromStringList

func NewCellValueUnionFromStringList(value []string) *CellValueUnion

func (*CellValueUnion) Accept

func (c *CellValueUnion) Accept(visitor CellValueUnionVisitor) error

func (*CellValueUnion) GetBoolean

func (c *CellValueUnion) GetBoolean() bool

func (*CellValueUnion) GetDate

func (c *CellValueUnion) GetDate() time.Time

func (*CellValueUnion) GetDateTime

func (c *CellValueUnion) GetDateTime() time.Time

func (*CellValueUnion) GetDouble

func (c *CellValueUnion) GetDouble() float64

func (*CellValueUnion) GetInteger

func (c *CellValueUnion) GetInteger() int

func (*CellValueUnion) GetLong

func (c *CellValueUnion) GetLong() int64

func (*CellValueUnion) GetString

func (c *CellValueUnion) GetString() string

func (*CellValueUnion) GetStringList

func (c *CellValueUnion) GetStringList() []string

func (CellValueUnion) MarshalJSON

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

func (*CellValueUnion) UnmarshalJSON

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

type CellValueUnionVisitor

type CellValueUnionVisitor interface {
	VisitString(string) error
	VisitInteger(int) error
	VisitLong(int64) error
	VisitDouble(float64) error
	VisitBoolean(bool) error
	VisitDate(time.Time) error
	VisitDateTime(time.Time) error
	VisitStringList([]string) error
}

type CellValueWithCounts

type CellValueWithCounts struct {
	Valid    *bool                `json:"valid,omitempty" url:"valid,omitempty"`
	Messages []*ValidationMessage `json:"messages,omitempty" url:"messages,omitempty"`
	// Deprecated, use record level metadata instead.
	Metadata  map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	Value     *CellValueUnion        `json:"value,omitempty" url:"value,omitempty"`
	Layer     *string                `json:"layer,omitempty" url:"layer,omitempty"`
	UpdatedAt *time.Time             `json:"updatedAt,omitempty" url:"updatedAt,omitempty"`
	Counts    *RecordCounts          `json:"counts,omitempty" url:"counts,omitempty"`
	// contains filtered or unexported fields
}

func (*CellValueWithCounts) GetCounts

func (c *CellValueWithCounts) GetCounts() *RecordCounts

func (*CellValueWithCounts) GetExtraProperties

func (c *CellValueWithCounts) GetExtraProperties() map[string]interface{}

func (*CellValueWithCounts) GetLayer

func (c *CellValueWithCounts) GetLayer() *string

func (*CellValueWithCounts) GetMessages

func (c *CellValueWithCounts) GetMessages() []*ValidationMessage

func (*CellValueWithCounts) GetMetadata

func (c *CellValueWithCounts) GetMetadata() map[string]interface{}

func (*CellValueWithCounts) GetUpdatedAt

func (c *CellValueWithCounts) GetUpdatedAt() *time.Time

func (*CellValueWithCounts) GetValid

func (c *CellValueWithCounts) GetValid() *bool

func (*CellValueWithCounts) GetValue

func (c *CellValueWithCounts) GetValue() *CellValueUnion

func (*CellValueWithCounts) MarshalJSON

func (c *CellValueWithCounts) MarshalJSON() ([]byte, error)

func (*CellValueWithCounts) String

func (c *CellValueWithCounts) String() string

func (*CellValueWithCounts) UnmarshalJSON

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

type CellValueWithLinks

type CellValueWithLinks struct {
	Valid    *bool                `json:"valid,omitempty" url:"valid,omitempty"`
	Messages []*ValidationMessage `json:"messages,omitempty" url:"messages,omitempty"`
	// Deprecated, use record level metadata instead.
	Metadata  map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	Value     *CellValueUnion        `json:"value,omitempty" url:"value,omitempty"`
	Layer     *string                `json:"layer,omitempty" url:"layer,omitempty"`
	UpdatedAt *time.Time             `json:"updatedAt,omitempty" url:"updatedAt,omitempty"`
	Links     *Records               `json:"links,omitempty" url:"links,omitempty"`
	// contains filtered or unexported fields
}

func (*CellValueWithLinks) GetExtraProperties

func (c *CellValueWithLinks) GetExtraProperties() map[string]interface{}

func (*CellValueWithLinks) GetLayer

func (c *CellValueWithLinks) GetLayer() *string

func (*CellValueWithLinks) GetLinks

func (c *CellValueWithLinks) GetLinks() *Records

func (*CellValueWithLinks) GetMessages

func (c *CellValueWithLinks) GetMessages() []*ValidationMessage

func (*CellValueWithLinks) GetMetadata

func (c *CellValueWithLinks) GetMetadata() map[string]interface{}

func (*CellValueWithLinks) GetUpdatedAt

func (c *CellValueWithLinks) GetUpdatedAt() *time.Time

func (*CellValueWithLinks) GetValid

func (c *CellValueWithLinks) GetValid() *bool

func (*CellValueWithLinks) GetValue

func (c *CellValueWithLinks) GetValue() *CellValueUnion

func (*CellValueWithLinks) MarshalJSON

func (c *CellValueWithLinks) MarshalJSON() ([]byte, error)

func (*CellValueWithLinks) String

func (c *CellValueWithLinks) String() string

func (*CellValueWithLinks) UnmarshalJSON

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

type CellsResponse

type CellsResponse struct {
	Data CellsResponseData `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*CellsResponse) GetData

func (c *CellsResponse) GetData() CellsResponseData

func (*CellsResponse) GetExtraProperties

func (c *CellsResponse) GetExtraProperties() map[string]interface{}

func (*CellsResponse) String

func (c *CellsResponse) String() string

func (*CellsResponse) UnmarshalJSON

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

type CellsResponseData

type CellsResponseData = map[string][]*CellValueWithCounts

Cell values grouped by field key

type Certainty

type Certainty string

const (
	CertaintyAbsolute Certainty = "absolute"
	CertaintyStrong   Certainty = "strong"
	CertaintyModerate Certainty = "moderate"
	CertaintyWeak     Certainty = "weak"
)

func NewCertaintyFromString

func NewCertaintyFromString(s string) (Certainty, error)

func (Certainty) Ptr

func (c Certainty) Ptr() *Certainty

type ChangeType

type ChangeType string

Options to filter records in a snapshot

const (
	ChangeTypeCreatedSince ChangeType = "createdSince"
	ChangeTypeUpdatedSince ChangeType = "updatedSince"
	ChangeTypeDeletedSince ChangeType = "deletedSince"
)

func NewChangeTypeFromString

func NewChangeTypeFromString(s string) (ChangeType, error)

func (ChangeType) Ptr

func (c ChangeType) Ptr() *ChangeType

type CollectionJobSubject

type CollectionJobSubject struct {
	Resource string                 `json:"resource" url:"resource"`
	Params   map[string]interface{} `json:"params,omitempty" url:"params,omitempty"`
	Query    map[string]interface{} `json:"query,omitempty" url:"query,omitempty"`
	// contains filtered or unexported fields
}

func (*CollectionJobSubject) GetExtraProperties

func (c *CollectionJobSubject) GetExtraProperties() map[string]interface{}

func (*CollectionJobSubject) GetParams

func (c *CollectionJobSubject) GetParams() map[string]interface{}

func (*CollectionJobSubject) GetQuery

func (c *CollectionJobSubject) GetQuery() map[string]interface{}

func (*CollectionJobSubject) GetResource

func (c *CollectionJobSubject) GetResource() string

func (*CollectionJobSubject) String

func (c *CollectionJobSubject) String() string

func (*CollectionJobSubject) UnmarshalJSON

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

type Commit

type Commit struct {
	Id      CommitId `json:"id" url:"id"`
	SheetId SheetId  `json:"sheetId" url:"sheetId"`
	// The actor (user or system) who created the commit
	CreatedBy string `json:"createdBy" url:"createdBy"`
	// The actor (user or system) who completed the commit
	CompletedBy *string `json:"completedBy,omitempty" url:"completedBy,omitempty"`
	// The time the commit was created
	CreatedAt time.Time `json:"createdAt" url:"createdAt"`
	// The time the commit was acknowledged
	CompletedAt *time.Time `json:"completedAt,omitempty" url:"completedAt,omitempty"`
	// contains filtered or unexported fields
}

A commit version

func (*Commit) GetCompletedAt

func (c *Commit) GetCompletedAt() *time.Time

func (*Commit) GetCompletedBy

func (c *Commit) GetCompletedBy() *string

func (*Commit) GetCreatedAt

func (c *Commit) GetCreatedAt() time.Time

func (*Commit) GetCreatedBy

func (c *Commit) GetCreatedBy() string

func (*Commit) GetExtraProperties

func (c *Commit) GetExtraProperties() map[string]interface{}

func (*Commit) GetId

func (c *Commit) GetId() CommitId

func (*Commit) GetSheetId

func (c *Commit) GetSheetId() SheetId

func (*Commit) MarshalJSON

func (c *Commit) MarshalJSON() ([]byte, error)

func (*Commit) String

func (c *Commit) String() string

func (*Commit) UnmarshalJSON

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

type CommitId

type CommitId = string

Commit ID

type CommitResponse

type CommitResponse struct {
	Data *Commit `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*CommitResponse) GetData

func (c *CommitResponse) GetData() *Commit

func (*CommitResponse) GetExtraProperties

func (c *CommitResponse) GetExtraProperties() map[string]interface{}

func (*CommitResponse) String

func (c *CommitResponse) String() string

func (*CommitResponse) UnmarshalJSON

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

type Compiler

type Compiler string

The compiler of the agent

const (
	CompilerJs Compiler = "js"
)

func NewCompilerFromString

func NewCompilerFromString(s string) (Compiler, error)

func (Compiler) Ptr

func (c Compiler) Ptr() *Compiler

type CompositeUniqueConstraint

type CompositeUniqueConstraint struct {
	// The name of the constraint
	Name string `json:"name" url:"name"`
	// The fields that must be unique together
	Fields []string `json:"fields,omitempty" url:"fields,omitempty"`
	// Fields that, when empty, will cause this unique constraint to be ignored
	RequiredFields []string                          `json:"requiredFields,omitempty" url:"requiredFields,omitempty"`
	Strategy       CompositeUniqueConstraintStrategy `json:"strategy" url:"strategy"`
	// contains filtered or unexported fields
}

func (*CompositeUniqueConstraint) GetExtraProperties

func (c *CompositeUniqueConstraint) GetExtraProperties() map[string]interface{}

func (*CompositeUniqueConstraint) GetFields

func (c *CompositeUniqueConstraint) GetFields() []string

func (*CompositeUniqueConstraint) GetName

func (c *CompositeUniqueConstraint) GetName() string

func (*CompositeUniqueConstraint) GetRequiredFields

func (c *CompositeUniqueConstraint) GetRequiredFields() []string

func (*CompositeUniqueConstraint) GetStrategy

func (c *CompositeUniqueConstraint) GetStrategy() CompositeUniqueConstraintStrategy

func (*CompositeUniqueConstraint) String

func (c *CompositeUniqueConstraint) String() string

func (*CompositeUniqueConstraint) UnmarshalJSON

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

type CompositeUniqueConstraintStrategy

type CompositeUniqueConstraintStrategy string

const (
	// A hash of the fields will be used to determine uniqueness
	CompositeUniqueConstraintStrategyHash CompositeUniqueConstraintStrategy = "hash"
	// The values of the fields will be concatenated to determine uniqueness
	CompositeUniqueConstraintStrategyConcat CompositeUniqueConstraintStrategy = "concat"
)

func NewCompositeUniqueConstraintStrategyFromString

func NewCompositeUniqueConstraintStrategyFromString(s string) (CompositeUniqueConstraintStrategy, error)

func (CompositeUniqueConstraintStrategy) Ptr

func (c CompositeUniqueConstraintStrategy) Ptr() *CompositeUniqueConstraintStrategy

type Constraint

type Constraint struct {
	Type     string
	Required interface{}
	Unique   *UniqueConstraint
	Computed interface{}
	External *ExternalConstraint
	Stored   *StoredConstraint
}

func NewConstraintFromComputed

func NewConstraintFromComputed(value interface{}) *Constraint

func NewConstraintFromExternal

func NewConstraintFromExternal(value *ExternalConstraint) *Constraint

func NewConstraintFromRequired

func NewConstraintFromRequired(value interface{}) *Constraint

func NewConstraintFromStored

func NewConstraintFromStored(value *StoredConstraint) *Constraint

func NewConstraintFromUnique

func NewConstraintFromUnique(value *UniqueConstraint) *Constraint

func (*Constraint) Accept

func (c *Constraint) Accept(visitor ConstraintVisitor) error

func (*Constraint) GetComputed

func (c *Constraint) GetComputed() interface{}

func (*Constraint) GetExternal

func (c *Constraint) GetExternal() *ExternalConstraint

func (*Constraint) GetRequired

func (c *Constraint) GetRequired() interface{}

func (*Constraint) GetStored

func (c *Constraint) GetStored() *StoredConstraint

func (*Constraint) GetType

func (c *Constraint) GetType() string

func (*Constraint) GetUnique

func (c *Constraint) GetUnique() *UniqueConstraint

func (Constraint) MarshalJSON

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

func (*Constraint) UnmarshalJSON

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

type ConstraintCreate

type ConstraintCreate struct {
	Description *string     `json:"description,omitempty" url:"description,omitempty"`
	Function    *string     `json:"function,omitempty" url:"function,omitempty"`
	Options     interface{} `json:"options,omitempty" url:"options,omitempty"`
	Label       *string     `json:"label,omitempty" url:"label,omitempty"`
	// contains filtered or unexported fields
}

func (*ConstraintCreate) GetDescription

func (c *ConstraintCreate) GetDescription() *string

func (*ConstraintCreate) GetExtraProperties

func (c *ConstraintCreate) GetExtraProperties() map[string]interface{}

func (*ConstraintCreate) GetFunction

func (c *ConstraintCreate) GetFunction() *string

func (*ConstraintCreate) GetLabel

func (c *ConstraintCreate) GetLabel() *string

func (*ConstraintCreate) GetOptions

func (c *ConstraintCreate) GetOptions() interface{}

func (*ConstraintCreate) String

func (c *ConstraintCreate) String() string

func (*ConstraintCreate) UnmarshalJSON

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

type ConstraintId

type ConstraintId = string

Constraint ID

type ConstraintResource

type ConstraintResource struct {
	Id          ConstraintId `json:"id" url:"id"`
	AppId       AppId        `json:"appId" url:"appId"`
	Validator   string       `json:"validator" url:"validator"`
	Description *string      `json:"description,omitempty" url:"description,omitempty"`
	Function    *string      `json:"function,omitempty" url:"function,omitempty"`
	Options     interface{}  `json:"options,omitempty" url:"options,omitempty"`
	Label       *string      `json:"label,omitempty" url:"label,omitempty"`
	CreatedAt   time.Time    `json:"createdAt" url:"createdAt"`
	UpdatedAt   time.Time    `json:"updatedAt" url:"updatedAt"`
	// contains filtered or unexported fields
}

func (*ConstraintResource) GetAppId

func (c *ConstraintResource) GetAppId() AppId

func (*ConstraintResource) GetCreatedAt

func (c *ConstraintResource) GetCreatedAt() time.Time

func (*ConstraintResource) GetDescription

func (c *ConstraintResource) GetDescription() *string

func (*ConstraintResource) GetExtraProperties

func (c *ConstraintResource) GetExtraProperties() map[string]interface{}

func (*ConstraintResource) GetFunction

func (c *ConstraintResource) GetFunction() *string

func (*ConstraintResource) GetId

func (c *ConstraintResource) GetId() ConstraintId

func (*ConstraintResource) GetLabel

func (c *ConstraintResource) GetLabel() *string

func (*ConstraintResource) GetOptions

func (c *ConstraintResource) GetOptions() interface{}

func (*ConstraintResource) GetUpdatedAt

func (c *ConstraintResource) GetUpdatedAt() time.Time

func (*ConstraintResource) GetValidator

func (c *ConstraintResource) GetValidator() string

func (*ConstraintResource) MarshalJSON

func (c *ConstraintResource) MarshalJSON() ([]byte, error)

func (*ConstraintResource) String

func (c *ConstraintResource) String() string

func (*ConstraintResource) UnmarshalJSON

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

type ConstraintResponse

type ConstraintResponse struct {
	Data *ConstraintResource `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ConstraintResponse) GetData

func (c *ConstraintResponse) GetData() *ConstraintResource

func (*ConstraintResponse) GetExtraProperties

func (c *ConstraintResponse) GetExtraProperties() map[string]interface{}

func (*ConstraintResponse) String

func (c *ConstraintResponse) String() string

func (*ConstraintResponse) UnmarshalJSON

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

type ConstraintUpdate

type ConstraintUpdate struct {
	Description *string     `json:"description,omitempty" url:"description,omitempty"`
	Function    *string     `json:"function,omitempty" url:"function,omitempty"`
	Options     interface{} `json:"options,omitempty" url:"options,omitempty"`
	Label       *string     `json:"label,omitempty" url:"label,omitempty"`
	// contains filtered or unexported fields
}

func (*ConstraintUpdate) GetDescription

func (c *ConstraintUpdate) GetDescription() *string

func (*ConstraintUpdate) GetExtraProperties

func (c *ConstraintUpdate) GetExtraProperties() map[string]interface{}

func (*ConstraintUpdate) GetFunction

func (c *ConstraintUpdate) GetFunction() *string

func (*ConstraintUpdate) GetLabel

func (c *ConstraintUpdate) GetLabel() *string

func (*ConstraintUpdate) GetOptions

func (c *ConstraintUpdate) GetOptions() interface{}

func (*ConstraintUpdate) String

func (c *ConstraintUpdate) String() string

func (*ConstraintUpdate) UnmarshalJSON

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

type ConstraintVersionResource

type ConstraintVersionResource struct {
	Id          ConstraintId `json:"id" url:"id"`
	AppId       AppId        `json:"appId" url:"appId"`
	Validator   string       `json:"validator" url:"validator"`
	Description *string      `json:"description,omitempty" url:"description,omitempty"`
	Function    *string      `json:"function,omitempty" url:"function,omitempty"`
	Options     interface{}  `json:"options,omitempty" url:"options,omitempty"`
	Label       *string      `json:"label,omitempty" url:"label,omitempty"`
	CreatedAt   time.Time    `json:"createdAt" url:"createdAt"`
	UpdatedAt   time.Time    `json:"updatedAt" url:"updatedAt"`
	Version     int          `json:"version" url:"version"`
	Prompt      *string      `json:"prompt,omitempty" url:"prompt,omitempty"`
	// contains filtered or unexported fields
}

func (*ConstraintVersionResource) GetAppId

func (c *ConstraintVersionResource) GetAppId() AppId

func (*ConstraintVersionResource) GetCreatedAt

func (c *ConstraintVersionResource) GetCreatedAt() time.Time

func (*ConstraintVersionResource) GetDescription

func (c *ConstraintVersionResource) GetDescription() *string

func (*ConstraintVersionResource) GetExtraProperties

func (c *ConstraintVersionResource) GetExtraProperties() map[string]interface{}

func (*ConstraintVersionResource) GetFunction

func (c *ConstraintVersionResource) GetFunction() *string

func (*ConstraintVersionResource) GetId

func (c *ConstraintVersionResource) GetId() ConstraintId

func (*ConstraintVersionResource) GetLabel

func (c *ConstraintVersionResource) GetLabel() *string

func (*ConstraintVersionResource) GetOptions

func (c *ConstraintVersionResource) GetOptions() interface{}

func (*ConstraintVersionResource) GetPrompt

func (c *ConstraintVersionResource) GetPrompt() *string

func (*ConstraintVersionResource) GetUpdatedAt

func (c *ConstraintVersionResource) GetUpdatedAt() time.Time

func (*ConstraintVersionResource) GetValidator

func (c *ConstraintVersionResource) GetValidator() string

func (*ConstraintVersionResource) GetVersion

func (c *ConstraintVersionResource) GetVersion() int

func (*ConstraintVersionResource) MarshalJSON

func (c *ConstraintVersionResource) MarshalJSON() ([]byte, error)

func (*ConstraintVersionResource) String

func (c *ConstraintVersionResource) String() string

func (*ConstraintVersionResource) UnmarshalJSON

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

type ConstraintVersionResponse

type ConstraintVersionResponse struct {
	Data *ConstraintVersionResource `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ConstraintVersionResponse) GetData

func (c *ConstraintVersionResponse) GetData() *ConstraintVersionResource

func (*ConstraintVersionResponse) GetExtraProperties

func (c *ConstraintVersionResponse) GetExtraProperties() map[string]interface{}

func (*ConstraintVersionResponse) String

func (c *ConstraintVersionResponse) String() string

func (*ConstraintVersionResponse) UnmarshalJSON

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

type ConstraintVersionsResponse

type ConstraintVersionsResponse struct {
	Data []*ConstraintVersionResource `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ConstraintVersionsResponse) GetData

func (c *ConstraintVersionsResponse) GetData() []*ConstraintVersionResource

func (*ConstraintVersionsResponse) GetExtraProperties

func (c *ConstraintVersionsResponse) GetExtraProperties() map[string]interface{}

func (*ConstraintVersionsResponse) String

func (c *ConstraintVersionsResponse) String() string

func (*ConstraintVersionsResponse) UnmarshalJSON

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

type ConstraintVisitor

type ConstraintVisitor interface {
	VisitRequired(interface{}) error
	VisitUnique(*UniqueConstraint) error
	VisitComputed(interface{}) error
	VisitExternal(*ExternalConstraint) error
	VisitStored(*StoredConstraint) error
}

type ConstraintsResponse

type ConstraintsResponse struct {
	Data []*ConstraintResource `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ConstraintsResponse) GetData

func (c *ConstraintsResponse) GetData() []*ConstraintResource

func (*ConstraintsResponse) GetExtraProperties

func (c *ConstraintsResponse) GetExtraProperties() map[string]interface{}

func (*ConstraintsResponse) String

func (c *ConstraintsResponse) String() string

func (*ConstraintsResponse) UnmarshalJSON

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

type Context

type Context struct {
	// The namespaces of the event
	Namespaces []string `json:"namespaces,omitempty" url:"namespaces,omitempty"`
	// The slugs of related resources
	Slugs         *EventContextSlugs `json:"slugs,omitempty" url:"slugs,omitempty"`
	ActionName    *ActionName        `json:"actionName,omitempty" url:"actionName,omitempty"`
	AccountId     AccountId          `json:"accountId" url:"accountId"`
	EnvironmentId EnvironmentId      `json:"environmentId" url:"environmentId"`
	SpaceId       *SpaceId           `json:"spaceId,omitempty" url:"spaceId,omitempty"`
	WorkbookId    *WorkbookId        `json:"workbookId,omitempty" url:"workbookId,omitempty"`
	SheetId       *SheetId           `json:"sheetId,omitempty" url:"sheetId,omitempty"`
	SheetSlug     *SheetSlug         `json:"sheetSlug,omitempty" url:"sheetSlug,omitempty"`
	SnapshotId    *SnapshotId        `json:"snapshotId,omitempty" url:"snapshotId,omitempty"`
	// Deprecated, use `commitId` instead.
	VersionId        *VersionId  `json:"versionId,omitempty" url:"versionId,omitempty"`
	CommitId         *CommitId   `json:"commitId,omitempty" url:"commitId,omitempty"`
	JobId            *JobId      `json:"jobId,omitempty" url:"jobId,omitempty"`
	ProgramId        *ProgramId  `json:"programId,omitempty" url:"programId,omitempty"`
	FileId           *FileId     `json:"fileId,omitempty" url:"fileId,omitempty"`
	DocumentId       *DocumentId `json:"documentId,omitempty" url:"documentId,omitempty"`
	PrecedingEventId *EventId    `json:"precedingEventId,omitempty" url:"precedingEventId,omitempty"`
	// Can be a UserId, GuestId, or AgentId
	ActorId    *string     `json:"actorId,omitempty" url:"actorId,omitempty"`
	AppId      *AppId      `json:"appId,omitempty" url:"appId,omitempty"`
	ActionId   *ActionId   `json:"actionId,omitempty" url:"actionId,omitempty"`
	DataClipId *DataClipId `json:"dataClipId,omitempty" url:"dataClipId,omitempty"`
	// contains filtered or unexported fields
}

The context of the event

func (*Context) GetAccountId

func (c *Context) GetAccountId() AccountId

func (*Context) GetActionId

func (c *Context) GetActionId() *ActionId

func (*Context) GetActionName

func (c *Context) GetActionName() *ActionName

func (*Context) GetActorId

func (c *Context) GetActorId() *string

func (*Context) GetAppId

func (c *Context) GetAppId() *AppId

func (*Context) GetCommitId

func (c *Context) GetCommitId() *CommitId

func (*Context) GetDataClipId

func (c *Context) GetDataClipId() *DataClipId

func (*Context) GetDocumentId

func (c *Context) GetDocumentId() *DocumentId

func (*Context) GetEnvironmentId

func (c *Context) GetEnvironmentId() EnvironmentId

func (*Context) GetExtraProperties

func (c *Context) GetExtraProperties() map[string]interface{}

func (*Context) GetFileId

func (c *Context) GetFileId() *FileId

func (*Context) GetJobId

func (c *Context) GetJobId() *JobId

func (*Context) GetNamespaces

func (c *Context) GetNamespaces() []string

func (*Context) GetPrecedingEventId

func (c *Context) GetPrecedingEventId() *EventId

func (*Context) GetProgramId

func (c *Context) GetProgramId() *ProgramId

func (*Context) GetSheetId

func (c *Context) GetSheetId() *SheetId

func (*Context) GetSheetSlug

func (c *Context) GetSheetSlug() *SheetSlug

func (*Context) GetSlugs

func (c *Context) GetSlugs() *EventContextSlugs

func (*Context) GetSnapshotId

func (c *Context) GetSnapshotId() *SnapshotId

func (*Context) GetSpaceId

func (c *Context) GetSpaceId() *SpaceId

func (*Context) GetVersionId

func (c *Context) GetVersionId() *VersionId

func (*Context) GetWorkbookId

func (c *Context) GetWorkbookId() *WorkbookId

func (*Context) String

func (c *Context) String() string

func (*Context) UnmarshalJSON

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

type CreateAgentsRequest

type CreateAgentsRequest struct {
	EnvironmentId EnvironmentId `json:"-" url:"environmentId"`
	Body          *AgentConfig  `json:"-" url:"-"`
}

func (*CreateAgentsRequest) MarshalJSON

func (c *CreateAgentsRequest) MarshalJSON() ([]byte, error)

func (*CreateAgentsRequest) UnmarshalJSON

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

type CreateEventConfig

type CreateEventConfig struct {
	// The domain of the event
	Domain Domain `json:"domain" url:"domain"`
	// The context of the event
	Context *Context `json:"context,omitempty" url:"context,omitempty"`
	// The attributes of the event
	Attributes *EventAttributes `json:"attributes,omitempty" url:"attributes,omitempty"`
	// The callback url to acknowledge the event
	CallbackUrl *string `json:"callbackUrl,omitempty" url:"callbackUrl,omitempty"`
	// The url to retrieve the data associated with the event
	DataUrl    *string                `json:"dataUrl,omitempty" url:"dataUrl,omitempty"`
	Target     *string                `json:"target,omitempty" url:"target,omitempty"`
	Origin     *Origin                `json:"origin,omitempty" url:"origin,omitempty"`
	Namespaces []string               `json:"namespaces,omitempty" url:"namespaces,omitempty"`
	Topic      EventTopic             `json:"topic" url:"topic"`
	Payload    map[string]interface{} `json:"payload,omitempty" url:"payload,omitempty"`
	// Date the event was deleted
	DeletedAt *time.Time `json:"deletedAt,omitempty" url:"deletedAt,omitempty"`
	// contains filtered or unexported fields
}

Properties used to create a new event

func (*CreateEventConfig) GetAttributes

func (c *CreateEventConfig) GetAttributes() *EventAttributes

func (*CreateEventConfig) GetCallbackUrl

func (c *CreateEventConfig) GetCallbackUrl() *string

func (*CreateEventConfig) GetContext

func (c *CreateEventConfig) GetContext() *Context

func (*CreateEventConfig) GetDataUrl

func (c *CreateEventConfig) GetDataUrl() *string

func (*CreateEventConfig) GetDeletedAt

func (c *CreateEventConfig) GetDeletedAt() *time.Time

func (*CreateEventConfig) GetDomain

func (c *CreateEventConfig) GetDomain() Domain

func (*CreateEventConfig) GetExtraProperties

func (c *CreateEventConfig) GetExtraProperties() map[string]interface{}

func (*CreateEventConfig) GetNamespaces

func (c *CreateEventConfig) GetNamespaces() []string

func (*CreateEventConfig) GetOrigin

func (c *CreateEventConfig) GetOrigin() *Origin

func (*CreateEventConfig) GetPayload

func (c *CreateEventConfig) GetPayload() map[string]interface{}

func (*CreateEventConfig) GetTarget

func (c *CreateEventConfig) GetTarget() *string

func (*CreateEventConfig) GetTopic

func (c *CreateEventConfig) GetTopic() EventTopic

func (*CreateEventConfig) MarshalJSON

func (c *CreateEventConfig) MarshalJSON() ([]byte, error)

func (*CreateEventConfig) String

func (c *CreateEventConfig) String() string

func (*CreateEventConfig) UnmarshalJSON

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

type CreateFileRequest

type CreateFileRequest struct {
	SpaceId       SpaceId       `json:"spaceId" url:"-"`
	EnvironmentId EnvironmentId `json:"environmentId" url:"-"`
	// The storage mode of file to insert, defaults to "import"
	Mode *Mode `json:"mode,omitempty" url:"-"`
	// The actions attached to the file
	Actions []*Action `json:"actions,omitempty" url:"-"`
	// The origin of the file, ie filesystem
	Origin *FileOrigin `json:"origin,omitempty" url:"-"`
}

type CreateGuestResponse

type CreateGuestResponse struct {
	Data []*Guest `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateGuestResponse) GetData

func (c *CreateGuestResponse) GetData() []*Guest

func (*CreateGuestResponse) GetExtraProperties

func (c *CreateGuestResponse) GetExtraProperties() map[string]interface{}

func (*CreateGuestResponse) String

func (c *CreateGuestResponse) String() string

func (*CreateGuestResponse) UnmarshalJSON

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

type CreateMappingRulesRequest

type CreateMappingRulesRequest = []*MappingRuleConfig

type CreateSnapshotRequest

type CreateSnapshotRequest struct {
	// ID of sheet
	SheetId SheetId `json:"sheetId" url:"-"`
	// Label for the snapshot
	Label *string `json:"label,omitempty" url:"-"`
	// ThreadId for the snapshot
	ThreadId *string `json:"threadId,omitempty" url:"-"`
}

type CreateWorkbookConfig

type CreateWorkbookConfig struct {
	// The name of the Workbook.
	Name string `json:"name" url:"name"`
	// An optional list of labels for the Workbook.
	Labels []string `json:"labels,omitempty" url:"labels,omitempty"`
	// Space to associate with the Workbook.
	SpaceId *SpaceId `json:"spaceId,omitempty" url:"spaceId,omitempty"`
	// Environment to associate with the Workbook
	EnvironmentId *EnvironmentId `json:"environmentId,omitempty" url:"environmentId,omitempty"`
	// Optional namespace to apply to the Workbook.
	Namespace *string `json:"namespace,omitempty" url:"namespace,omitempty"`
	// Sheets to create on the Workbook.
	Sheets []*SheetConfig `json:"sheets,omitempty" url:"sheets,omitempty"`
	// Actions to create on the Workbook.
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// The Workbook settings.
	Settings *WorkbookConfigSettings `json:"settings,omitempty" url:"settings,omitempty"`
	// Metadata for the workbook
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// Treatments for the workbook
	Treatments []WorkbookTreatments `json:"treatments,omitempty" url:"treatments,omitempty"`
	// contains filtered or unexported fields
}

Properties used to create a new Workbook

func (*CreateWorkbookConfig) GetActions

func (c *CreateWorkbookConfig) GetActions() []*Action

func (*CreateWorkbookConfig) GetEnvironmentId

func (c *CreateWorkbookConfig) GetEnvironmentId() *EnvironmentId

func (*CreateWorkbookConfig) GetExtraProperties

func (c *CreateWorkbookConfig) GetExtraProperties() map[string]interface{}

func (*CreateWorkbookConfig) GetLabels

func (c *CreateWorkbookConfig) GetLabels() []string

func (*CreateWorkbookConfig) GetMetadata

func (c *CreateWorkbookConfig) GetMetadata() interface{}

func (*CreateWorkbookConfig) GetName

func (c *CreateWorkbookConfig) GetName() string

func (*CreateWorkbookConfig) GetNamespace

func (c *CreateWorkbookConfig) GetNamespace() *string

func (*CreateWorkbookConfig) GetSettings

func (c *CreateWorkbookConfig) GetSettings() *WorkbookConfigSettings

func (*CreateWorkbookConfig) GetSheets

func (c *CreateWorkbookConfig) GetSheets() []*SheetConfig

func (*CreateWorkbookConfig) GetSpaceId

func (c *CreateWorkbookConfig) GetSpaceId() *SpaceId

func (*CreateWorkbookConfig) GetTreatments

func (c *CreateWorkbookConfig) GetTreatments() []WorkbookTreatments

func (*CreateWorkbookConfig) String

func (c *CreateWorkbookConfig) String() string

func (*CreateWorkbookConfig) UnmarshalJSON

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

type DataClipId

type DataClipId = string

Data Clip ID

type DataRetentionPolicy

type DataRetentionPolicy struct {
	Type          DataRetentionPolicyEnum `json:"type" url:"type"`
	Period        int                     `json:"period" url:"period"`
	EnvironmentId EnvironmentId           `json:"environmentId" url:"environmentId"`
	Id            DataRetentionPolicyId   `json:"id" url:"id"`
	// Date the policy was created
	CreatedAt time.Time `json:"createdAt" url:"createdAt"`
	// Date the policy was last updated
	UpdatedAt time.Time `json:"updatedAt" url:"updatedAt"`
	// contains filtered or unexported fields
}

A data retention policy belonging to an environment

func (*DataRetentionPolicy) GetCreatedAt

func (d *DataRetentionPolicy) GetCreatedAt() time.Time

func (*DataRetentionPolicy) GetEnvironmentId

func (d *DataRetentionPolicy) GetEnvironmentId() EnvironmentId

func (*DataRetentionPolicy) GetExtraProperties

func (d *DataRetentionPolicy) GetExtraProperties() map[string]interface{}

func (*DataRetentionPolicy) GetId

func (d *DataRetentionPolicy) GetId() DataRetentionPolicyId

func (*DataRetentionPolicy) GetPeriod

func (d *DataRetentionPolicy) GetPeriod() int

func (*DataRetentionPolicy) GetType

func (d *DataRetentionPolicy) GetType() DataRetentionPolicyEnum

func (*DataRetentionPolicy) GetUpdatedAt

func (d *DataRetentionPolicy) GetUpdatedAt() time.Time

func (*DataRetentionPolicy) MarshalJSON

func (d *DataRetentionPolicy) MarshalJSON() ([]byte, error)

func (*DataRetentionPolicy) String

func (d *DataRetentionPolicy) String() string

func (*DataRetentionPolicy) UnmarshalJSON

func (d *DataRetentionPolicy) UnmarshalJSON(data []byte) error

type DataRetentionPolicyConfig

type DataRetentionPolicyConfig struct {
	Type          DataRetentionPolicyEnum `json:"type" url:"type"`
	Period        int                     `json:"period" url:"period"`
	EnvironmentId EnvironmentId           `json:"environmentId" url:"environmentId"`
	// contains filtered or unexported fields
}

func (*DataRetentionPolicyConfig) GetEnvironmentId

func (d *DataRetentionPolicyConfig) GetEnvironmentId() EnvironmentId

func (*DataRetentionPolicyConfig) GetExtraProperties

func (d *DataRetentionPolicyConfig) GetExtraProperties() map[string]interface{}

func (*DataRetentionPolicyConfig) GetPeriod

func (d *DataRetentionPolicyConfig) GetPeriod() int

func (*DataRetentionPolicyConfig) GetType

func (d *DataRetentionPolicyConfig) GetType() DataRetentionPolicyEnum

func (*DataRetentionPolicyConfig) String

func (d *DataRetentionPolicyConfig) String() string

func (*DataRetentionPolicyConfig) UnmarshalJSON

func (d *DataRetentionPolicyConfig) UnmarshalJSON(data []byte) error

type DataRetentionPolicyEnum

type DataRetentionPolicyEnum string

The type of data retention policy on an environment

const (
	DataRetentionPolicyEnumLastActivity DataRetentionPolicyEnum = "lastActivity"
	DataRetentionPolicyEnumSinceCreated DataRetentionPolicyEnum = "sinceCreated"
)

func NewDataRetentionPolicyEnumFromString

func NewDataRetentionPolicyEnumFromString(s string) (DataRetentionPolicyEnum, error)

func (DataRetentionPolicyEnum) Ptr

func (d DataRetentionPolicyEnum) Ptr() *DataRetentionPolicyEnum

type DataRetentionPolicyId

type DataRetentionPolicyId = string

Data Retention Policy ID

type DataRetentionPolicyResponse

type DataRetentionPolicyResponse struct {
	Data *DataRetentionPolicy `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*DataRetentionPolicyResponse) GetData

func (d *DataRetentionPolicyResponse) GetData() *DataRetentionPolicy

func (*DataRetentionPolicyResponse) GetExtraProperties

func (d *DataRetentionPolicyResponse) GetExtraProperties() map[string]interface{}

func (*DataRetentionPolicyResponse) String

func (d *DataRetentionPolicyResponse) String() string

func (*DataRetentionPolicyResponse) UnmarshalJSON

func (d *DataRetentionPolicyResponse) UnmarshalJSON(data []byte) error

type DateProperty

type DateProperty struct {
	Key string `json:"key" url:"key"`
	// User friendly field name
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// A short description of the field. Markdown syntax is supported.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values.
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,omitempty"`
	// An array of actions that end users can perform on this Column.
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// Useful for any contextual metadata regarding the schema. Store any valid json here.
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// A unique presentation for a field in the UI.
	Treatments       []string `json:"treatments,omitempty" url:"treatments,omitempty"`
	AlternativeNames []string `json:"alternativeNames,omitempty" url:"alternativeNames,omitempty"`
	// contains filtered or unexported fields
}

Store a field as a GMT date. Data hooks must convert this value into a `YYYY-MM-DD` format in order for it to be considered a valid value. Datetime should be a separate and future supported value as it must consider timezone.

func (*DateProperty) GetActions

func (d *DateProperty) GetActions() []*Action

func (*DateProperty) GetAlternativeNames

func (d *DateProperty) GetAlternativeNames() []string

func (*DateProperty) GetAppearance

func (d *DateProperty) GetAppearance() *FieldAppearance

func (*DateProperty) GetConstraints

func (d *DateProperty) GetConstraints() []*Constraint

func (*DateProperty) GetDescription

func (d *DateProperty) GetDescription() *string

func (*DateProperty) GetExtraProperties

func (d *DateProperty) GetExtraProperties() map[string]interface{}

func (*DateProperty) GetKey

func (d *DateProperty) GetKey() string

func (*DateProperty) GetLabel

func (d *DateProperty) GetLabel() *string

func (*DateProperty) GetMetadata

func (d *DateProperty) GetMetadata() interface{}

func (*DateProperty) GetReadonly

func (d *DateProperty) GetReadonly() *bool

func (*DateProperty) GetTreatments

func (d *DateProperty) GetTreatments() []string

func (*DateProperty) String

func (d *DateProperty) String() string

func (*DateProperty) UnmarshalJSON

func (d *DateProperty) UnmarshalJSON(data []byte) error

type DeleteAgentRequest

type DeleteAgentRequest struct {
	EnvironmentId EnvironmentId `json:"-" url:"environmentId"`
}

type DeleteAllHistoryForUserRequest

type DeleteAllHistoryForUserRequest struct {
	EnvironmentId *EnvironmentId `json:"environmentId,omitempty" url:"-"`
}

type DeleteMultipleRulesRequest

type DeleteMultipleRulesRequest struct {
	// Array of rule IDs to be deleted
	RuleIds []MappingId `json:"ruleIds,omitempty" url:"-"`
}

type DeleteRecordsJobConfig

type DeleteRecordsJobConfig struct {
	// Options to filter records (default=none)
	Filter *Filter `json:"filter,omitempty" url:"filter,omitempty"`
	// Use this to narrow the valid/error filter results to a specific field (Requires filter to be set)
	FilterField *FilterField `json:"filterField,omitempty" url:"filterField,omitempty"`
	SearchValue *SearchValue `json:"searchValue,omitempty" url:"searchValue,omitempty"`
	SearchField *SearchField `json:"searchField,omitempty" url:"searchField,omitempty"`
	// FFQL query to filter records
	Q     *string `json:"q,omitempty" url:"q,omitempty"`
	Sheet SheetId `json:"sheet" url:"sheet"`
	// List of record ids to exclude from deletion
	Exceptions []RecordId `json:"exceptions,omitempty" url:"exceptions,omitempty"`
	// If specified, a snapshot will be generated with this label
	SnapshotLabel *string `json:"snapshotLabel,omitempty" url:"snapshotLabel,omitempty"`
	// contains filtered or unexported fields
}

The configuration for a delete job

func (*DeleteRecordsJobConfig) GetExceptions

func (d *DeleteRecordsJobConfig) GetExceptions() []RecordId

func (*DeleteRecordsJobConfig) GetExtraProperties

func (d *DeleteRecordsJobConfig) GetExtraProperties() map[string]interface{}

func (*DeleteRecordsJobConfig) GetFilter

func (d *DeleteRecordsJobConfig) GetFilter() *Filter

func (*DeleteRecordsJobConfig) GetFilterField

func (d *DeleteRecordsJobConfig) GetFilterField() *FilterField

func (*DeleteRecordsJobConfig) GetQ

func (d *DeleteRecordsJobConfig) GetQ() *string

func (*DeleteRecordsJobConfig) GetSearchField

func (d *DeleteRecordsJobConfig) GetSearchField() *SearchField

func (*DeleteRecordsJobConfig) GetSearchValue

func (d *DeleteRecordsJobConfig) GetSearchValue() *SearchValue

func (*DeleteRecordsJobConfig) GetSheet

func (d *DeleteRecordsJobConfig) GetSheet() SheetId

func (*DeleteRecordsJobConfig) GetSnapshotLabel

func (d *DeleteRecordsJobConfig) GetSnapshotLabel() *string

func (*DeleteRecordsJobConfig) String

func (d *DeleteRecordsJobConfig) String() string

func (*DeleteRecordsJobConfig) UnmarshalJSON

func (d *DeleteRecordsJobConfig) UnmarshalJSON(data []byte) error

type DeleteRecordsRequest

type DeleteRecordsRequest struct {
	// A list of record IDs to delete. Maximum of 100 allowed.
	Ids []RecordId `json:"-" url:"ids"`
}

type DeleteSpacesRequest

type DeleteSpacesRequest struct {
	// List of ids for the spaces to be deleted
	SpaceIds []SpaceId `json:"-" url:"spaceIds"`
}

type DestinationField

type DestinationField struct {
	// The description of the destination field
	DestinationField *Property `json:"destinationField,omitempty" url:"destinationField,omitempty"`
	// A list of preview values of the data in the destination field
	Preview []string `json:"preview,omitempty" url:"preview,omitempty"`
	// contains filtered or unexported fields
}

func (*DestinationField) GetDestinationField

func (d *DestinationField) GetDestinationField() *Property

func (*DestinationField) GetExtraProperties

func (d *DestinationField) GetExtraProperties() map[string]interface{}

func (*DestinationField) GetPreview

func (d *DestinationField) GetPreview() []string

func (*DestinationField) String

func (d *DestinationField) String() string

func (*DestinationField) UnmarshalJSON

func (d *DestinationField) UnmarshalJSON(data []byte) error

type DetailedAgentLog

type DetailedAgentLog struct {
	EventId EventId `json:"eventId" url:"eventId"`
	// Whether the agent execution was successful
	Success     bool      `json:"success" url:"success"`
	CreatedAt   time.Time `json:"createdAt" url:"createdAt"`
	CompletedAt time.Time `json:"completedAt" url:"completedAt"`
	// The duration of the agent execution
	Duration int `json:"duration" url:"duration"`
	// The topics of the agent execution
	Topic string `json:"topic" url:"topic"`
	// The context of the agent execution
	Context map[string]interface{} `json:"context,omitempty" url:"context,omitempty"`
	// The log of the agent execution
	Log *string `json:"log,omitempty" url:"log,omitempty"`
	// contains filtered or unexported fields
}

A log of an agent execution

func (*DetailedAgentLog) GetCompletedAt

func (d *DetailedAgentLog) GetCompletedAt() time.Time

func (*DetailedAgentLog) GetContext

func (d *DetailedAgentLog) GetContext() map[string]interface{}

func (*DetailedAgentLog) GetCreatedAt

func (d *DetailedAgentLog) GetCreatedAt() time.Time

func (*DetailedAgentLog) GetDuration

func (d *DetailedAgentLog) GetDuration() int

func (*DetailedAgentLog) GetEventId

func (d *DetailedAgentLog) GetEventId() EventId

func (*DetailedAgentLog) GetExtraProperties

func (d *DetailedAgentLog) GetExtraProperties() map[string]interface{}

func (*DetailedAgentLog) GetLog

func (d *DetailedAgentLog) GetLog() *string

func (*DetailedAgentLog) GetSuccess

func (d *DetailedAgentLog) GetSuccess() bool

func (*DetailedAgentLog) GetTopic

func (d *DetailedAgentLog) GetTopic() string

func (*DetailedAgentLog) MarshalJSON

func (d *DetailedAgentLog) MarshalJSON() ([]byte, error)

func (*DetailedAgentLog) String

func (d *DetailedAgentLog) String() string

func (*DetailedAgentLog) UnmarshalJSON

func (d *DetailedAgentLog) UnmarshalJSON(data []byte) error

type DiffData

type DiffData = map[string]*DiffValue

type DiffRecord

type DiffRecord struct {
	Id RecordId `json:"id" url:"id"`
	// Deprecated, use `commitId` instead.
	VersionId *VersionId `json:"versionId,omitempty" url:"versionId,omitempty"`
	CommitId  *CommitId  `json:"commitId,omitempty" url:"commitId,omitempty"`
	// Auto-generated value based on whether the record contains a field with an error message. Cannot be set via the API.
	Valid *bool `json:"valid,omitempty" url:"valid,omitempty"`
	// This record level `messages` property is deprecated and no longer stored or used. Use the `messages` property on the individual cell values instead. This property will be removed in a future release.
	Messages []*ValidationMessage   `json:"messages,omitempty" url:"messages,omitempty"`
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	Config   *RecordConfig          `json:"config,omitempty" url:"config,omitempty"`
	Values   DiffData               `json:"values,omitempty" url:"values,omitempty"`
	Resolves []*Resolve             `json:"resolves,omitempty" url:"resolves,omitempty"`
	// contains filtered or unexported fields
}

func (*DiffRecord) GetCommitId

func (d *DiffRecord) GetCommitId() *CommitId

func (*DiffRecord) GetConfig

func (d *DiffRecord) GetConfig() *RecordConfig

func (*DiffRecord) GetExtraProperties

func (d *DiffRecord) GetExtraProperties() map[string]interface{}

func (*DiffRecord) GetId

func (d *DiffRecord) GetId() RecordId

func (*DiffRecord) GetMessages

func (d *DiffRecord) GetMessages() []*ValidationMessage

func (*DiffRecord) GetMetadata

func (d *DiffRecord) GetMetadata() map[string]interface{}

func (*DiffRecord) GetResolves

func (d *DiffRecord) GetResolves() []*Resolve

func (*DiffRecord) GetValid

func (d *DiffRecord) GetValid() *bool

func (*DiffRecord) GetValues

func (d *DiffRecord) GetValues() DiffData

func (*DiffRecord) GetVersionId

func (d *DiffRecord) GetVersionId() *VersionId

func (*DiffRecord) String

func (d *DiffRecord) String() string

func (*DiffRecord) UnmarshalJSON

func (d *DiffRecord) UnmarshalJSON(data []byte) error

type DiffRecords

type DiffRecords = []*DiffRecord

List of DiffRecord objects

type DiffRecordsResponse

type DiffRecordsResponse struct {
	Data DiffRecords `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*DiffRecordsResponse) GetData

func (d *DiffRecordsResponse) GetData() DiffRecords

func (*DiffRecordsResponse) GetExtraProperties

func (d *DiffRecordsResponse) GetExtraProperties() map[string]interface{}

func (*DiffRecordsResponse) String

func (d *DiffRecordsResponse) String() string

func (*DiffRecordsResponse) UnmarshalJSON

func (d *DiffRecordsResponse) UnmarshalJSON(data []byte) error

type DiffValue

type DiffValue struct {
	Valid    *bool                `json:"valid,omitempty" url:"valid,omitempty"`
	Messages []*ValidationMessage `json:"messages,omitempty" url:"messages,omitempty"`
	// Deprecated, use record level metadata instead.
	Metadata      map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	Value         *CellValueUnion        `json:"value,omitempty" url:"value,omitempty"`
	Layer         *string                `json:"layer,omitempty" url:"layer,omitempty"`
	UpdatedAt     *time.Time             `json:"updatedAt,omitempty" url:"updatedAt,omitempty"`
	SnapshotValue *CellValueUnion        `json:"snapshotValue,omitempty" url:"snapshotValue,omitempty"`
	ClipValue     *CellValueUnion        `json:"clipValue,omitempty" url:"clipValue,omitempty"`
	// contains filtered or unexported fields
}

func (*DiffValue) GetClipValue

func (d *DiffValue) GetClipValue() *CellValueUnion

func (*DiffValue) GetExtraProperties

func (d *DiffValue) GetExtraProperties() map[string]interface{}

func (*DiffValue) GetLayer

func (d *DiffValue) GetLayer() *string

func (*DiffValue) GetMessages

func (d *DiffValue) GetMessages() []*ValidationMessage

func (*DiffValue) GetMetadata

func (d *DiffValue) GetMetadata() map[string]interface{}

func (*DiffValue) GetSnapshotValue

func (d *DiffValue) GetSnapshotValue() *CellValueUnion

func (*DiffValue) GetUpdatedAt

func (d *DiffValue) GetUpdatedAt() *time.Time

func (*DiffValue) GetValid

func (d *DiffValue) GetValid() *bool

func (*DiffValue) GetValue

func (d *DiffValue) GetValue() *CellValueUnion

func (*DiffValue) MarshalJSON

func (d *DiffValue) MarshalJSON() ([]byte, error)

func (*DiffValue) String

func (d *DiffValue) String() string

func (*DiffValue) UnmarshalJSON

func (d *DiffValue) UnmarshalJSON(data []byte) error

type Distinct

type Distinct = bool

When true, excludes duplicate values

type Document

type Document struct {
	Title string `json:"title" url:"title"`
	Body  string `json:"body" url:"body"`
	// Certain treatments will cause your Document to look or behave differently.
	Treatments    []string       `json:"treatments,omitempty" url:"treatments,omitempty"`
	Actions       []*Action      `json:"actions,omitempty" url:"actions,omitempty"`
	Id            DocumentId     `json:"id" url:"id"`
	SpaceId       *SpaceId       `json:"spaceId,omitempty" url:"spaceId,omitempty"`
	EnvironmentId *EnvironmentId `json:"environmentId,omitempty" url:"environmentId,omitempty"`
	// Date the document was created
	CreatedAt time.Time `json:"createdAt" url:"createdAt"`
	// Date the document was last updated
	UpdatedAt time.Time `json:"updatedAt" url:"updatedAt"`
	// contains filtered or unexported fields
}

A document (markdown components) belong to a space

func (*Document) GetActions

func (d *Document) GetActions() []*Action

func (*Document) GetBody

func (d *Document) GetBody() string

func (*Document) GetCreatedAt

func (d *Document) GetCreatedAt() time.Time

func (*Document) GetEnvironmentId

func (d *Document) GetEnvironmentId() *EnvironmentId

func (*Document) GetExtraProperties

func (d *Document) GetExtraProperties() map[string]interface{}

func (*Document) GetId

func (d *Document) GetId() DocumentId

func (*Document) GetSpaceId

func (d *Document) GetSpaceId() *SpaceId

func (*Document) GetTitle

func (d *Document) GetTitle() string

func (*Document) GetTreatments

func (d *Document) GetTreatments() []string

func (*Document) GetUpdatedAt

func (d *Document) GetUpdatedAt() time.Time

func (*Document) MarshalJSON

func (d *Document) MarshalJSON() ([]byte, error)

func (*Document) String

func (d *Document) String() string

func (*Document) UnmarshalJSON

func (d *Document) UnmarshalJSON(data []byte) error

type DocumentConfig

type DocumentConfig struct {
	Title string `json:"title" url:"title"`
	Body  string `json:"body" url:"body"`
	// Certain treatments will cause your Document to look or behave differently.
	Treatments []string  `json:"treatments,omitempty" url:"treatments,omitempty"`
	Actions    []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentConfig) GetActions

func (d *DocumentConfig) GetActions() []*Action

func (*DocumentConfig) GetBody

func (d *DocumentConfig) GetBody() string

func (*DocumentConfig) GetExtraProperties

func (d *DocumentConfig) GetExtraProperties() map[string]interface{}

func (*DocumentConfig) GetTitle

func (d *DocumentConfig) GetTitle() string

func (*DocumentConfig) GetTreatments

func (d *DocumentConfig) GetTreatments() []string

func (*DocumentConfig) String

func (d *DocumentConfig) String() string

func (*DocumentConfig) UnmarshalJSON

func (d *DocumentConfig) UnmarshalJSON(data []byte) error

type DocumentId

type DocumentId = string

Document ID

type DocumentResponse

type DocumentResponse struct {
	Data *Document `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentResponse) GetData

func (d *DocumentResponse) GetData() *Document

func (*DocumentResponse) GetExtraProperties

func (d *DocumentResponse) GetExtraProperties() map[string]interface{}

func (*DocumentResponse) String

func (d *DocumentResponse) String() string

func (*DocumentResponse) UnmarshalJSON

func (d *DocumentResponse) UnmarshalJSON(data []byte) error

type Domain

type Domain string

The domain of the event

const (
	DomainFile        Domain = "file"
	DomainSpace       Domain = "space"
	DomainWorkbook    Domain = "workbook"
	DomainJob         Domain = "job"
	DomainDocument    Domain = "document"
	DomainSheet       Domain = "sheet"
	DomainProgram     Domain = "program"
	DomainSecret      Domain = "secret"
	DomainCron        Domain = "cron"
	DomainEnvironment Domain = "environment"
	DomainDataClip    Domain = "data-clip"
)

func NewDomainFromString

func NewDomainFromString(s string) (Domain, error)

func (Domain) Ptr

func (d Domain) Ptr() *Domain

type Driver

type Driver string

The driver to use for extracting data from the file

const (
	DriverCsv Driver = "csv"
)

func NewDriverFromString

func NewDriverFromString(s string) (Driver, error)

func (Driver) Ptr

func (d Driver) Ptr() *Driver

type Edge

type Edge struct {
	// The description of the source field
	SourceField *Property `json:"sourceField,omitempty" url:"sourceField,omitempty"`
	// The description of the destination field
	DestinationField *Property `json:"destinationField,omitempty" url:"destinationField,omitempty"`
	// A list of preview values of the data in the destination field
	Preview []string `json:"preview,omitempty" url:"preview,omitempty"`
	// Only available if one or more of the destination fields is of type enum. Provides category mapping.
	EnumDetails *EnumDetails `json:"enumDetails,omitempty" url:"enumDetails,omitempty"`
	// Metadata about the edge
	Metadata *Metadata `json:"metadata,omitempty" url:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*Edge) GetDestinationField

func (e *Edge) GetDestinationField() *Property

func (*Edge) GetEnumDetails

func (e *Edge) GetEnumDetails() *EnumDetails

func (*Edge) GetExtraProperties

func (e *Edge) GetExtraProperties() map[string]interface{}

func (*Edge) GetMetadata

func (e *Edge) GetMetadata() *Metadata

func (*Edge) GetPreview

func (e *Edge) GetPreview() []string

func (*Edge) GetSourceField

func (e *Edge) GetSourceField() *Property

func (*Edge) String

func (e *Edge) String() string

func (*Edge) UnmarshalJSON

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

type EmptyObject

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

func (*EmptyObject) GetExtraProperties

func (e *EmptyObject) GetExtraProperties() map[string]interface{}

func (*EmptyObject) String

func (e *EmptyObject) String() string

func (*EmptyObject) UnmarshalJSON

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

type Entitlement

type Entitlement struct {
	// Short name for the entitlement
	Key string `json:"key" url:"key"`
	// Contains conditions or limits for an entitlement
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// contains filtered or unexported fields
}

An entitlement belonging to a resource

func (*Entitlement) GetExtraProperties

func (e *Entitlement) GetExtraProperties() map[string]interface{}

func (*Entitlement) GetKey

func (e *Entitlement) GetKey() string

func (*Entitlement) GetMetadata

func (e *Entitlement) GetMetadata() interface{}

func (*Entitlement) String

func (e *Entitlement) String() string

func (*Entitlement) UnmarshalJSON

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

type EnumDetails

type EnumDetails struct {
	// The mapping of source values to destination values
	Mapping []*CategoryMapping `json:"mapping,omitempty" url:"mapping,omitempty"`
	// A list of source values that are not mapped from
	UnusedSourceValues []*EnumValue `json:"unusedSourceValues,omitempty" url:"unusedSourceValues,omitempty"`
	// A list of destination values that are not mapped to
	UnusedDestinationValues []*EnumValue `json:"unusedDestinationValues,omitempty" url:"unusedDestinationValues,omitempty"`
	// contains filtered or unexported fields
}

Only available if one or more of the destination fields is of type enum. Provides category mapping.

func (*EnumDetails) GetExtraProperties

func (e *EnumDetails) GetExtraProperties() map[string]interface{}

func (*EnumDetails) GetMapping

func (e *EnumDetails) GetMapping() []*CategoryMapping

func (*EnumDetails) GetUnusedDestinationValues

func (e *EnumDetails) GetUnusedDestinationValues() []*EnumValue

func (*EnumDetails) GetUnusedSourceValues

func (e *EnumDetails) GetUnusedSourceValues() []*EnumValue

func (*EnumDetails) String

func (e *EnumDetails) String() string

func (*EnumDetails) UnmarshalJSON

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

type EnumListProperty

type EnumListProperty struct {
	Key string `json:"key" url:"key"`
	// User friendly field name
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// A short description of the field. Markdown syntax is supported.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values.
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,omitempty"`
	// An array of actions that end users can perform on this Column.
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// Useful for any contextual metadata regarding the schema. Store any valid json here.
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// A unique presentation for a field in the UI.
	Treatments       []string            `json:"treatments,omitempty" url:"treatments,omitempty"`
	AlternativeNames []string            `json:"alternativeNames,omitempty" url:"alternativeNames,omitempty"`
	Config           *EnumPropertyConfig `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

Defines an array of values selected from an enumerated list of options. Matching tooling attempts to resolve incoming data assigment to a valid option. The maximum number of items that can be in this list is `100`.

func (*EnumListProperty) GetActions

func (e *EnumListProperty) GetActions() []*Action

func (*EnumListProperty) GetAlternativeNames

func (e *EnumListProperty) GetAlternativeNames() []string

func (*EnumListProperty) GetAppearance

func (e *EnumListProperty) GetAppearance() *FieldAppearance

func (*EnumListProperty) GetConfig

func (e *EnumListProperty) GetConfig() *EnumPropertyConfig

func (*EnumListProperty) GetConstraints

func (e *EnumListProperty) GetConstraints() []*Constraint

func (*EnumListProperty) GetDescription

func (e *EnumListProperty) GetDescription() *string

func (*EnumListProperty) GetExtraProperties

func (e *EnumListProperty) GetExtraProperties() map[string]interface{}

func (*EnumListProperty) GetKey

func (e *EnumListProperty) GetKey() string

func (*EnumListProperty) GetLabel

func (e *EnumListProperty) GetLabel() *string

func (*EnumListProperty) GetMetadata

func (e *EnumListProperty) GetMetadata() interface{}

func (*EnumListProperty) GetReadonly

func (e *EnumListProperty) GetReadonly() *bool

func (*EnumListProperty) GetTreatments

func (e *EnumListProperty) GetTreatments() []string

func (*EnumListProperty) String

func (e *EnumListProperty) String() string

func (*EnumListProperty) UnmarshalJSON

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

type EnumProperty

type EnumProperty struct {
	Key string `json:"key" url:"key"`
	// User friendly field name
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// A short description of the field. Markdown syntax is supported.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values.
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,omitempty"`
	// An array of actions that end users can perform on this Column.
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// Useful for any contextual metadata regarding the schema. Store any valid json here.
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// A unique presentation for a field in the UI.
	Treatments       []string `json:"treatments,omitempty" url:"treatments,omitempty"`
	AlternativeNames []string `json:"alternativeNames,omitempty" url:"alternativeNames,omitempty"`
	// Will allow multiple values and store as an array
	IsArray *bool `json:"isArray,omitempty" url:"isArray,omitempty"`
	// Will allow multiple values and store / provide the values in an array if set. Not all field types support arrays.
	Multi  *bool               `json:"multi,omitempty" url:"multi,omitempty"`
	Config *EnumPropertyConfig `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

Defines an enumerated list of options for the user to select from. Matching tooling attempts to resolve incoming data assigment to a valid option. The maximum number of options for this list is `100`. For larger lists, users should use the reference or future `lookup` types.

func (*EnumProperty) GetActions

func (e *EnumProperty) GetActions() []*Action

func (*EnumProperty) GetAlternativeNames

func (e *EnumProperty) GetAlternativeNames() []string

func (*EnumProperty) GetAppearance

func (e *EnumProperty) GetAppearance() *FieldAppearance

func (*EnumProperty) GetConfig

func (e *EnumProperty) GetConfig() *EnumPropertyConfig

func (*EnumProperty) GetConstraints

func (e *EnumProperty) GetConstraints() []*Constraint

func (*EnumProperty) GetDescription

func (e *EnumProperty) GetDescription() *string

func (*EnumProperty) GetExtraProperties

func (e *EnumProperty) GetExtraProperties() map[string]interface{}

func (*EnumProperty) GetIsArray

func (e *EnumProperty) GetIsArray() *bool

func (*EnumProperty) GetKey

func (e *EnumProperty) GetKey() string

func (*EnumProperty) GetLabel

func (e *EnumProperty) GetLabel() *string

func (*EnumProperty) GetMetadata

func (e *EnumProperty) GetMetadata() interface{}

func (*EnumProperty) GetMulti

func (e *EnumProperty) GetMulti() *bool

func (*EnumProperty) GetReadonly

func (e *EnumProperty) GetReadonly() *bool

func (*EnumProperty) GetTreatments

func (e *EnumProperty) GetTreatments() []string

func (*EnumProperty) String

func (e *EnumProperty) String() string

func (*EnumProperty) UnmarshalJSON

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

type EnumPropertyConfig

type EnumPropertyConfig struct {
	// Permit the user to create new options for this specific field.
	AllowCustom *bool                 `json:"allowCustom,omitempty" url:"allowCustom,omitempty"`
	Options     []*EnumPropertyOption `json:"options,omitempty" url:"options,omitempty"`
	// Sort the options by the value of this property. Defaults to `label`.
	SortBy *EnumPropertySortBy `json:"sortBy,omitempty" url:"sortBy,omitempty"`
	// contains filtered or unexported fields
}

func (*EnumPropertyConfig) GetAllowCustom

func (e *EnumPropertyConfig) GetAllowCustom() *bool

func (*EnumPropertyConfig) GetExtraProperties

func (e *EnumPropertyConfig) GetExtraProperties() map[string]interface{}

func (*EnumPropertyConfig) GetOptions

func (e *EnumPropertyConfig) GetOptions() []*EnumPropertyOption

func (*EnumPropertyConfig) GetSortBy

func (e *EnumPropertyConfig) GetSortBy() *EnumPropertySortBy

func (*EnumPropertyConfig) String

func (e *EnumPropertyConfig) String() string

func (*EnumPropertyConfig) UnmarshalJSON

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

type EnumPropertyOption

type EnumPropertyOption struct {
	// A visual label for this option
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// A short description for this option
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// An optional color to assign this option
	Color *string `json:"color,omitempty" url:"color,omitempty"`
	// A reference pointer to a previously registered icon
	Icon *string `json:"icon,omitempty" url:"icon,omitempty"`
	// An arbitrary JSON object to be associated with this option and made available to hooks
	Meta map[string]interface{} `json:"meta,omitempty" url:"meta,omitempty"`
	// The value or ID of this option. This value will be sent in egress. The type is a string | integer | boolean.
	Value interface{} `json:"value,omitempty" url:"value,omitempty"`
	// Alternative names to match this enum option to
	AlternativeNames []string `json:"alternativeNames,omitempty" url:"alternativeNames,omitempty"`
	// The order of this option in the list. SortBy must be set to `ordinal` to use this.
	Ordinal *int `json:"ordinal,omitempty" url:"ordinal,omitempty"`
	// contains filtered or unexported fields
}

func (*EnumPropertyOption) GetAlternativeNames

func (e *EnumPropertyOption) GetAlternativeNames() []string

func (*EnumPropertyOption) GetColor

func (e *EnumPropertyOption) GetColor() *string

func (*EnumPropertyOption) GetDescription

func (e *EnumPropertyOption) GetDescription() *string

func (*EnumPropertyOption) GetExtraProperties

func (e *EnumPropertyOption) GetExtraProperties() map[string]interface{}

func (*EnumPropertyOption) GetIcon

func (e *EnumPropertyOption) GetIcon() *string

func (*EnumPropertyOption) GetLabel

func (e *EnumPropertyOption) GetLabel() *string

func (*EnumPropertyOption) GetMeta

func (e *EnumPropertyOption) GetMeta() map[string]interface{}

func (*EnumPropertyOption) GetOrdinal

func (e *EnumPropertyOption) GetOrdinal() *int

func (*EnumPropertyOption) GetValue

func (e *EnumPropertyOption) GetValue() interface{}

func (*EnumPropertyOption) String

func (e *EnumPropertyOption) String() string

func (*EnumPropertyOption) UnmarshalJSON

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

type EnumPropertySortBy

type EnumPropertySortBy string

const (
	EnumPropertySortByLabel   EnumPropertySortBy = "label"
	EnumPropertySortByValue   EnumPropertySortBy = "value"
	EnumPropertySortByOrdinal EnumPropertySortBy = "ordinal"
)

func NewEnumPropertySortByFromString

func NewEnumPropertySortByFromString(s string) (EnumPropertySortBy, error)

func (EnumPropertySortBy) Ptr

func (e EnumPropertySortBy) Ptr() *EnumPropertySortBy

type EnumValue

type EnumValue struct {
	String  string
	Integer int
	Boolean bool
	// contains filtered or unexported fields
}

func NewEnumValueFromBoolean

func NewEnumValueFromBoolean(value bool) *EnumValue

func NewEnumValueFromInteger

func NewEnumValueFromInteger(value int) *EnumValue

func NewEnumValueFromString

func NewEnumValueFromString(value string) *EnumValue

func (*EnumValue) Accept

func (e *EnumValue) Accept(visitor EnumValueVisitor) error

func (*EnumValue) GetBoolean

func (e *EnumValue) GetBoolean() bool

func (*EnumValue) GetInteger

func (e *EnumValue) GetInteger() int

func (*EnumValue) GetString

func (e *EnumValue) GetString() string

func (EnumValue) MarshalJSON

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

func (*EnumValue) UnmarshalJSON

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

type EnumValueVisitor

type EnumValueVisitor interface {
	VisitString(string) error
	VisitInteger(int) error
	VisitBoolean(bool) error
}

type Environment

type Environment struct {
	Id        EnvironmentId `json:"id" url:"id"`
	AccountId AccountId     `json:"accountId" url:"accountId"`
	// The name of the environment
	Name string `json:"name" url:"name"`
	// Whether or not the environment is a production environment
	IsProd              bool                      `json:"isProd" url:"isProd"`
	GuestAuthentication []GuestAuthenticationEnum `json:"guestAuthentication,omitempty" url:"guestAuthentication,omitempty"`
	Features            map[string]interface{}    `json:"features,omitempty" url:"features,omitempty"`
	Metadata            map[string]interface{}    `json:"metadata,omitempty" url:"metadata,omitempty"`
	TranslationsPath    *string                   `json:"translationsPath,omitempty" url:"translationsPath,omitempty"`
	Namespaces          []string                  `json:"namespaces,omitempty" url:"namespaces,omitempty"`
	LanguageOverride    *string                   `json:"languageOverride,omitempty" url:"languageOverride,omitempty"`
	// contains filtered or unexported fields
}

func (*Environment) GetAccountId

func (e *Environment) GetAccountId() AccountId

func (*Environment) GetExtraProperties

func (e *Environment) GetExtraProperties() map[string]interface{}

func (*Environment) GetFeatures

func (e *Environment) GetFeatures() map[string]interface{}

func (*Environment) GetGuestAuthentication

func (e *Environment) GetGuestAuthentication() []GuestAuthenticationEnum

func (*Environment) GetId

func (e *Environment) GetId() EnvironmentId

func (*Environment) GetIsProd

func (e *Environment) GetIsProd() bool

func (*Environment) GetLanguageOverride

func (e *Environment) GetLanguageOverride() *string

func (*Environment) GetMetadata

func (e *Environment) GetMetadata() map[string]interface{}

func (*Environment) GetName

func (e *Environment) GetName() string

func (*Environment) GetNamespaces

func (e *Environment) GetNamespaces() []string

func (*Environment) GetTranslationsPath

func (e *Environment) GetTranslationsPath() *string

func (*Environment) String

func (e *Environment) String() string

func (*Environment) UnmarshalJSON

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

type EnvironmentConfigCreate

type EnvironmentConfigCreate struct {
	// The name of the environment
	Name string `json:"name" url:"name"`
	// Whether or not the environment is a production environment
	IsProd              bool                      `json:"isProd" url:"isProd"`
	GuestAuthentication []GuestAuthenticationEnum `json:"guestAuthentication,omitempty" url:"guestAuthentication,omitempty"`
	Metadata            map[string]interface{}    `json:"metadata,omitempty" url:"metadata,omitempty"`
	TranslationsPath    *string                   `json:"translationsPath,omitempty" url:"translationsPath,omitempty"`
	Namespaces          []string                  `json:"namespaces,omitempty" url:"namespaces,omitempty"`
	LanguageOverride    *string                   `json:"languageOverride,omitempty" url:"languageOverride,omitempty"`
	// contains filtered or unexported fields
}

Properties used to create a new environment

func (*EnvironmentConfigCreate) GetExtraProperties

func (e *EnvironmentConfigCreate) GetExtraProperties() map[string]interface{}

func (*EnvironmentConfigCreate) GetGuestAuthentication

func (e *EnvironmentConfigCreate) GetGuestAuthentication() []GuestAuthenticationEnum

func (*EnvironmentConfigCreate) GetIsProd

func (e *EnvironmentConfigCreate) GetIsProd() bool

func (*EnvironmentConfigCreate) GetLanguageOverride

func (e *EnvironmentConfigCreate) GetLanguageOverride() *string

func (*EnvironmentConfigCreate) GetMetadata

func (e *EnvironmentConfigCreate) GetMetadata() map[string]interface{}

func (*EnvironmentConfigCreate) GetName

func (e *EnvironmentConfigCreate) GetName() string

func (*EnvironmentConfigCreate) GetNamespaces

func (e *EnvironmentConfigCreate) GetNamespaces() []string

func (*EnvironmentConfigCreate) GetTranslationsPath

func (e *EnvironmentConfigCreate) GetTranslationsPath() *string

func (*EnvironmentConfigCreate) String

func (e *EnvironmentConfigCreate) String() string

func (*EnvironmentConfigCreate) UnmarshalJSON

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

type EnvironmentConfigUpdate

type EnvironmentConfigUpdate struct {
	// The name of the environment
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// Whether or not the environment is a production environment
	IsProd              *bool                     `json:"isProd,omitempty" url:"isProd,omitempty"`
	GuestAuthentication []GuestAuthenticationEnum `json:"guestAuthentication,omitempty" url:"guestAuthentication,omitempty"`
	Metadata            map[string]interface{}    `json:"metadata,omitempty" url:"metadata,omitempty"`
	TranslationsPath    *string                   `json:"translationsPath,omitempty" url:"translationsPath,omitempty"`
	Namespaces          []string                  `json:"namespaces,omitempty" url:"namespaces,omitempty"`
	LanguageOverride    *string                   `json:"languageOverride,omitempty" url:"languageOverride,omitempty"`
	// contains filtered or unexported fields
}

Properties used to update an environment

func (*EnvironmentConfigUpdate) GetExtraProperties

func (e *EnvironmentConfigUpdate) GetExtraProperties() map[string]interface{}

func (*EnvironmentConfigUpdate) GetGuestAuthentication

func (e *EnvironmentConfigUpdate) GetGuestAuthentication() []GuestAuthenticationEnum

func (*EnvironmentConfigUpdate) GetIsProd

func (e *EnvironmentConfigUpdate) GetIsProd() *bool

func (*EnvironmentConfigUpdate) GetLanguageOverride

func (e *EnvironmentConfigUpdate) GetLanguageOverride() *string

func (*EnvironmentConfigUpdate) GetMetadata

func (e *EnvironmentConfigUpdate) GetMetadata() map[string]interface{}

func (*EnvironmentConfigUpdate) GetName

func (e *EnvironmentConfigUpdate) GetName() *string

func (*EnvironmentConfigUpdate) GetNamespaces

func (e *EnvironmentConfigUpdate) GetNamespaces() []string

func (*EnvironmentConfigUpdate) GetTranslationsPath

func (e *EnvironmentConfigUpdate) GetTranslationsPath() *string

func (*EnvironmentConfigUpdate) String

func (e *EnvironmentConfigUpdate) String() string

func (*EnvironmentConfigUpdate) UnmarshalJSON

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

type EnvironmentId

type EnvironmentId = string

Environment ID

type EnvironmentResponse

type EnvironmentResponse struct {
	Data *Environment `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*EnvironmentResponse) GetData

func (e *EnvironmentResponse) GetData() *Environment

func (*EnvironmentResponse) GetExtraProperties

func (e *EnvironmentResponse) GetExtraProperties() map[string]interface{}

func (*EnvironmentResponse) String

func (e *EnvironmentResponse) String() string

func (*EnvironmentResponse) UnmarshalJSON

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

type Error

type Error struct {
	Key     *string `json:"key,omitempty" url:"key,omitempty"`
	Message string  `json:"message" url:"message"`
	// contains filtered or unexported fields
}

func (*Error) GetExtraProperties

func (e *Error) GetExtraProperties() map[string]interface{}

func (*Error) GetKey

func (e *Error) GetKey() *string

func (*Error) GetMessage

func (e *Error) GetMessage() string

func (*Error) String

func (e *Error) String() string

func (*Error) UnmarshalJSON

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

type Errors

type Errors struct {
	Errors []*Error `json:"errors,omitempty" url:"errors,omitempty"`
	// contains filtered or unexported fields
}

func (*Errors) GetErrors

func (e *Errors) GetErrors() []*Error

func (*Errors) GetExtraProperties

func (e *Errors) GetExtraProperties() map[string]interface{}

func (*Errors) String

func (e *Errors) String() string

func (*Errors) UnmarshalJSON

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

type Event

type Event struct {
	Topic                        string
	AgentCreated                 *GenericEvent
	AgentUpdated                 *GenericEvent
	AgentDeleted                 *GenericEvent
	SpaceCreated                 *GenericEvent
	SpaceUpdated                 *GenericEvent
	SpaceDeleted                 *GenericEvent
	SpaceArchived                *GenericEvent
	SpaceExpired                 *GenericEvent
	SpaceGuestAdded              *GenericEvent
	SpaceGuestRemoved            *GenericEvent
	DocumentCreated              *GenericEvent
	DocumentUpdated              *GenericEvent
	DocumentDeleted              *GenericEvent
	WorkbookCreated              *GenericEvent
	WorkbookUpdated              *GenericEvent
	WorkbookDeleted              *GenericEvent
	WorkbookExpired              *GenericEvent
	SheetCreated                 *GenericEvent
	SheetUpdated                 *GenericEvent
	SheetDeleted                 *GenericEvent
	SheetCountsUpdated           *GenericEvent
	SnapshotCreated              *GenericEvent
	RecordsCreated               *GenericEvent
	RecordsUpdated               *GenericEvent
	RecordsDeleted               *GenericEvent
	FileCreated                  *GenericEvent
	FileUpdated                  *GenericEvent
	FileDeleted                  *GenericEvent
	FileExpired                  *GenericEvent
	JobCreated                   *GenericEvent
	JobUpdated                   *GenericEvent
	JobDeleted                   *GenericEvent
	JobFailed                    *GenericEvent
	JobCompleted                 *GenericEvent
	JobReady                     *GenericEvent
	JobScheduled                 *GenericEvent
	JobOutcomeAcknowledged       *GenericEvent
	JobPartsCompleted            *GenericEvent
	ProgramCreated               *GenericEvent
	ProgramUpdated               *GenericEvent
	CommitCreated                *GenericEvent
	CommitUpdated                *GenericEvent
	CommitCompleted              *GenericEvent
	SecretCreated                *GenericEvent
	SecretUpdated                *GenericEvent
	SecretDeleted                *GenericEvent
	LayerCreated                 *GenericEvent
	EnvironmentCreated           *GenericEvent
	EnvironmentUpdated           *GenericEvent
	EnvironmentDeleted           *GenericEvent
	ActionCreated                *GenericEvent
	ActionUpdated                *GenericEvent
	ActionDeleted                *GenericEvent
	DataClipCreated              *GenericEvent
	DataClipUpdated              *GenericEvent
	DataClipDeleted              *GenericEvent
	DataClipCollaboratorUpdated  *GenericEvent
	DataClipResolutionsCreated   *GenericEvent
	DataClipResolutionsUpdated   *GenericEvent
	DataClipResolutionsRefreshed *GenericEvent
}

An event that tracks an activity within an environment

func NewEventFromActionCreated

func NewEventFromActionCreated(value *GenericEvent) *Event

func NewEventFromActionDeleted

func NewEventFromActionDeleted(value *GenericEvent) *Event

func NewEventFromActionUpdated

func NewEventFromActionUpdated(value *GenericEvent) *Event

func NewEventFromAgentCreated

func NewEventFromAgentCreated(value *GenericEvent) *Event

func NewEventFromAgentDeleted

func NewEventFromAgentDeleted(value *GenericEvent) *Event

func NewEventFromAgentUpdated

func NewEventFromAgentUpdated(value *GenericEvent) *Event

func NewEventFromCommitCompleted

func NewEventFromCommitCompleted(value *GenericEvent) *Event

func NewEventFromCommitCreated

func NewEventFromCommitCreated(value *GenericEvent) *Event

func NewEventFromCommitUpdated

func NewEventFromCommitUpdated(value *GenericEvent) *Event

func NewEventFromDataClipCollaboratorUpdated

func NewEventFromDataClipCollaboratorUpdated(value *GenericEvent) *Event

func NewEventFromDataClipCreated

func NewEventFromDataClipCreated(value *GenericEvent) *Event

func NewEventFromDataClipDeleted

func NewEventFromDataClipDeleted(value *GenericEvent) *Event

func NewEventFromDataClipResolutionsCreated

func NewEventFromDataClipResolutionsCreated(value *GenericEvent) *Event

func NewEventFromDataClipResolutionsRefreshed

func NewEventFromDataClipResolutionsRefreshed(value *GenericEvent) *Event

func NewEventFromDataClipResolutionsUpdated

func NewEventFromDataClipResolutionsUpdated(value *GenericEvent) *Event

func NewEventFromDataClipUpdated

func NewEventFromDataClipUpdated(value *GenericEvent) *Event

func NewEventFromDocumentCreated

func NewEventFromDocumentCreated(value *GenericEvent) *Event

func NewEventFromDocumentDeleted

func NewEventFromDocumentDeleted(value *GenericEvent) *Event

func NewEventFromDocumentUpdated

func NewEventFromDocumentUpdated(value *GenericEvent) *Event

func NewEventFromEnvironmentCreated

func NewEventFromEnvironmentCreated(value *GenericEvent) *Event

func NewEventFromEnvironmentDeleted

func NewEventFromEnvironmentDeleted(value *GenericEvent) *Event

func NewEventFromEnvironmentUpdated

func NewEventFromEnvironmentUpdated(value *GenericEvent) *Event

func NewEventFromFileCreated

func NewEventFromFileCreated(value *GenericEvent) *Event

func NewEventFromFileDeleted

func NewEventFromFileDeleted(value *GenericEvent) *Event

func NewEventFromFileExpired

func NewEventFromFileExpired(value *GenericEvent) *Event

func NewEventFromFileUpdated

func NewEventFromFileUpdated(value *GenericEvent) *Event

func NewEventFromJobCompleted

func NewEventFromJobCompleted(value *GenericEvent) *Event

func NewEventFromJobCreated

func NewEventFromJobCreated(value *GenericEvent) *Event

func NewEventFromJobDeleted

func NewEventFromJobDeleted(value *GenericEvent) *Event

func NewEventFromJobFailed

func NewEventFromJobFailed(value *GenericEvent) *Event

func NewEventFromJobOutcomeAcknowledged

func NewEventFromJobOutcomeAcknowledged(value *GenericEvent) *Event

func NewEventFromJobPartsCompleted

func NewEventFromJobPartsCompleted(value *GenericEvent) *Event

func NewEventFromJobReady

func NewEventFromJobReady(value *GenericEvent) *Event

func NewEventFromJobScheduled

func NewEventFromJobScheduled(value *GenericEvent) *Event

func NewEventFromJobUpdated

func NewEventFromJobUpdated(value *GenericEvent) *Event

func NewEventFromLayerCreated

func NewEventFromLayerCreated(value *GenericEvent) *Event

func NewEventFromProgramCreated

func NewEventFromProgramCreated(value *GenericEvent) *Event

func NewEventFromProgramUpdated

func NewEventFromProgramUpdated(value *GenericEvent) *Event

func NewEventFromRecordsCreated

func NewEventFromRecordsCreated(value *GenericEvent) *Event

func NewEventFromRecordsDeleted

func NewEventFromRecordsDeleted(value *GenericEvent) *Event

func NewEventFromRecordsUpdated

func NewEventFromRecordsUpdated(value *GenericEvent) *Event

func NewEventFromSecretCreated

func NewEventFromSecretCreated(value *GenericEvent) *Event

func NewEventFromSecretDeleted

func NewEventFromSecretDeleted(value *GenericEvent) *Event

func NewEventFromSecretUpdated

func NewEventFromSecretUpdated(value *GenericEvent) *Event

func NewEventFromSheetCountsUpdated

func NewEventFromSheetCountsUpdated(value *GenericEvent) *Event

func NewEventFromSheetCreated

func NewEventFromSheetCreated(value *GenericEvent) *Event

func NewEventFromSheetDeleted

func NewEventFromSheetDeleted(value *GenericEvent) *Event

func NewEventFromSheetUpdated

func NewEventFromSheetUpdated(value *GenericEvent) *Event

func NewEventFromSnapshotCreated

func NewEventFromSnapshotCreated(value *GenericEvent) *Event

func NewEventFromSpaceArchived

func NewEventFromSpaceArchived(value *GenericEvent) *Event

func NewEventFromSpaceCreated

func NewEventFromSpaceCreated(value *GenericEvent) *Event

func NewEventFromSpaceDeleted

func NewEventFromSpaceDeleted(value *GenericEvent) *Event

func NewEventFromSpaceExpired

func NewEventFromSpaceExpired(value *GenericEvent) *Event

func NewEventFromSpaceGuestAdded

func NewEventFromSpaceGuestAdded(value *GenericEvent) *Event

func NewEventFromSpaceGuestRemoved

func NewEventFromSpaceGuestRemoved(value *GenericEvent) *Event

func NewEventFromSpaceUpdated

func NewEventFromSpaceUpdated(value *GenericEvent) *Event

func NewEventFromWorkbookCreated

func NewEventFromWorkbookCreated(value *GenericEvent) *Event

func NewEventFromWorkbookDeleted

func NewEventFromWorkbookDeleted(value *GenericEvent) *Event

func NewEventFromWorkbookExpired

func NewEventFromWorkbookExpired(value *GenericEvent) *Event

func NewEventFromWorkbookUpdated

func NewEventFromWorkbookUpdated(value *GenericEvent) *Event

func (*Event) Accept

func (e *Event) Accept(visitor EventVisitor) error

func (*Event) GetActionCreated

func (e *Event) GetActionCreated() *GenericEvent

func (*Event) GetActionDeleted

func (e *Event) GetActionDeleted() *GenericEvent

func (*Event) GetActionUpdated

func (e *Event) GetActionUpdated() *GenericEvent

func (*Event) GetAgentCreated

func (e *Event) GetAgentCreated() *GenericEvent

func (*Event) GetAgentDeleted

func (e *Event) GetAgentDeleted() *GenericEvent

func (*Event) GetAgentUpdated

func (e *Event) GetAgentUpdated() *GenericEvent

func (*Event) GetCommitCompleted

func (e *Event) GetCommitCompleted() *GenericEvent

func (*Event) GetCommitCreated

func (e *Event) GetCommitCreated() *GenericEvent

func (*Event) GetCommitUpdated

func (e *Event) GetCommitUpdated() *GenericEvent

func (*Event) GetDataClipCollaboratorUpdated

func (e *Event) GetDataClipCollaboratorUpdated() *GenericEvent

func (*Event) GetDataClipCreated

func (e *Event) GetDataClipCreated() *GenericEvent

func (*Event) GetDataClipDeleted

func (e *Event) GetDataClipDeleted() *GenericEvent

func (*Event) GetDataClipResolutionsCreated

func (e *Event) GetDataClipResolutionsCreated() *GenericEvent

func (*Event) GetDataClipResolutionsRefreshed

func (e *Event) GetDataClipResolutionsRefreshed() *GenericEvent

func (*Event) GetDataClipResolutionsUpdated

func (e *Event) GetDataClipResolutionsUpdated() *GenericEvent

func (*Event) GetDataClipUpdated

func (e *Event) GetDataClipUpdated() *GenericEvent

func (*Event) GetDocumentCreated

func (e *Event) GetDocumentCreated() *GenericEvent

func (*Event) GetDocumentDeleted

func (e *Event) GetDocumentDeleted() *GenericEvent

func (*Event) GetDocumentUpdated

func (e *Event) GetDocumentUpdated() *GenericEvent

func (*Event) GetEnvironmentCreated

func (e *Event) GetEnvironmentCreated() *GenericEvent

func (*Event) GetEnvironmentDeleted

func (e *Event) GetEnvironmentDeleted() *GenericEvent

func (*Event) GetEnvironmentUpdated

func (e *Event) GetEnvironmentUpdated() *GenericEvent

func (*Event) GetFileCreated

func (e *Event) GetFileCreated() *GenericEvent

func (*Event) GetFileDeleted

func (e *Event) GetFileDeleted() *GenericEvent

func (*Event) GetFileExpired

func (e *Event) GetFileExpired() *GenericEvent

func (*Event) GetFileUpdated

func (e *Event) GetFileUpdated() *GenericEvent

func (*Event) GetJobCompleted

func (e *Event) GetJobCompleted() *GenericEvent

func (*Event) GetJobCreated

func (e *Event) GetJobCreated() *GenericEvent

func (*Event) GetJobDeleted

func (e *Event) GetJobDeleted() *GenericEvent

func (*Event) GetJobFailed

func (e *Event) GetJobFailed() *GenericEvent

func (*Event) GetJobOutcomeAcknowledged

func (e *Event) GetJobOutcomeAcknowledged() *GenericEvent

func (*Event) GetJobPartsCompleted

func (e *Event) GetJobPartsCompleted() *GenericEvent

func (*Event) GetJobReady

func (e *Event) GetJobReady() *GenericEvent

func (*Event) GetJobScheduled

func (e *Event) GetJobScheduled() *GenericEvent

func (*Event) GetJobUpdated

func (e *Event) GetJobUpdated() *GenericEvent

func (*Event) GetLayerCreated

func (e *Event) GetLayerCreated() *GenericEvent

func (*Event) GetProgramCreated

func (e *Event) GetProgramCreated() *GenericEvent

func (*Event) GetProgramUpdated

func (e *Event) GetProgramUpdated() *GenericEvent

func (*Event) GetRecordsCreated

func (e *Event) GetRecordsCreated() *GenericEvent

func (*Event) GetRecordsDeleted

func (e *Event) GetRecordsDeleted() *GenericEvent

func (*Event) GetRecordsUpdated

func (e *Event) GetRecordsUpdated() *GenericEvent

func (*Event) GetSecretCreated

func (e *Event) GetSecretCreated() *GenericEvent

func (*Event) GetSecretDeleted

func (e *Event) GetSecretDeleted() *GenericEvent

func (*Event) GetSecretUpdated

func (e *Event) GetSecretUpdated() *GenericEvent

func (*Event) GetSheetCountsUpdated

func (e *Event) GetSheetCountsUpdated() *GenericEvent

func (*Event) GetSheetCreated

func (e *Event) GetSheetCreated() *GenericEvent

func (*Event) GetSheetDeleted

func (e *Event) GetSheetDeleted() *GenericEvent

func (*Event) GetSheetUpdated

func (e *Event) GetSheetUpdated() *GenericEvent

func (*Event) GetSnapshotCreated

func (e *Event) GetSnapshotCreated() *GenericEvent

func (*Event) GetSpaceArchived

func (e *Event) GetSpaceArchived() *GenericEvent

func (*Event) GetSpaceCreated

func (e *Event) GetSpaceCreated() *GenericEvent

func (*Event) GetSpaceDeleted

func (e *Event) GetSpaceDeleted() *GenericEvent

func (*Event) GetSpaceExpired

func (e *Event) GetSpaceExpired() *GenericEvent

func (*Event) GetSpaceGuestAdded

func (e *Event) GetSpaceGuestAdded() *GenericEvent

func (*Event) GetSpaceGuestRemoved

func (e *Event) GetSpaceGuestRemoved() *GenericEvent

func (*Event) GetSpaceUpdated

func (e *Event) GetSpaceUpdated() *GenericEvent

func (*Event) GetTopic

func (e *Event) GetTopic() string

func (*Event) GetWorkbookCreated

func (e *Event) GetWorkbookCreated() *GenericEvent

func (*Event) GetWorkbookDeleted

func (e *Event) GetWorkbookDeleted() *GenericEvent

func (*Event) GetWorkbookExpired

func (e *Event) GetWorkbookExpired() *GenericEvent

func (*Event) GetWorkbookUpdated

func (e *Event) GetWorkbookUpdated() *GenericEvent

func (Event) MarshalJSON

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

func (*Event) UnmarshalJSON

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

type EventAttributes

type EventAttributes struct {
	// Date the related entity was last updated
	TargetUpdatedAt *time.Time `json:"targetUpdatedAt,omitempty" url:"targetUpdatedAt,omitempty"`
	// The progress of the event within a collection of iterable events
	Progress *Progress `json:"progress,omitempty" url:"progress,omitempty"`
	// contains filtered or unexported fields
}

The attributes of the event

func (*EventAttributes) GetExtraProperties

func (e *EventAttributes) GetExtraProperties() map[string]interface{}

func (*EventAttributes) GetProgress

func (e *EventAttributes) GetProgress() *Progress

func (*EventAttributes) GetTargetUpdatedAt

func (e *EventAttributes) GetTargetUpdatedAt() *time.Time

func (*EventAttributes) MarshalJSON

func (e *EventAttributes) MarshalJSON() ([]byte, error)

func (*EventAttributes) String

func (e *EventAttributes) String() string

func (*EventAttributes) UnmarshalJSON

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

type EventContextSlugs

type EventContextSlugs struct {
	// The slug of the space
	Space *string `json:"space,omitempty" url:"space,omitempty"`
	// The slug of the workbook
	Workbook *string `json:"workbook,omitempty" url:"workbook,omitempty"`
	// The slug of the sheet
	Sheet *string `json:"sheet,omitempty" url:"sheet,omitempty"`
	// contains filtered or unexported fields
}

func (*EventContextSlugs) GetExtraProperties

func (e *EventContextSlugs) GetExtraProperties() map[string]interface{}

func (*EventContextSlugs) GetSheet

func (e *EventContextSlugs) GetSheet() *string

func (*EventContextSlugs) GetSpace

func (e *EventContextSlugs) GetSpace() *string

func (*EventContextSlugs) GetWorkbook

func (e *EventContextSlugs) GetWorkbook() *string

func (*EventContextSlugs) String

func (e *EventContextSlugs) String() string

func (*EventContextSlugs) UnmarshalJSON

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

type EventId

type EventId = string

Event ID

type EventResponse

type EventResponse struct {
	Data *Event `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*EventResponse) GetData

func (e *EventResponse) GetData() *Event

func (*EventResponse) GetExtraProperties

func (e *EventResponse) GetExtraProperties() map[string]interface{}

func (*EventResponse) String

func (e *EventResponse) String() string

func (*EventResponse) UnmarshalJSON

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

type EventToken

type EventToken struct {
	// The ID of the Account.
	AccountId *AccountId `json:"accountId,omitempty" url:"accountId,omitempty"`
	// The id of the event bus to subscribe to
	SubscribeKey *string `json:"subscribeKey,omitempty" url:"subscribeKey,omitempty"`
	// Time to live in minutes
	Ttl *int `json:"ttl,omitempty" url:"ttl,omitempty"`
	// This should be your API key.
	Token *string `json:"token,omitempty" url:"token,omitempty"`
	// contains filtered or unexported fields
}

Properties used to allow users to connect to the event bus

func (*EventToken) GetAccountId

func (e *EventToken) GetAccountId() *AccountId

func (*EventToken) GetExtraProperties

func (e *EventToken) GetExtraProperties() map[string]interface{}

func (*EventToken) GetSubscribeKey

func (e *EventToken) GetSubscribeKey() *string

func (*EventToken) GetToken

func (e *EventToken) GetToken() *string

func (*EventToken) GetTtl

func (e *EventToken) GetTtl() *int

func (*EventToken) String

func (e *EventToken) String() string

func (*EventToken) UnmarshalJSON

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

type EventTokenResponse

type EventTokenResponse struct {
	Data *EventToken `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*EventTokenResponse) GetData

func (e *EventTokenResponse) GetData() *EventToken

func (*EventTokenResponse) GetExtraProperties

func (e *EventTokenResponse) GetExtraProperties() map[string]interface{}

func (*EventTokenResponse) String

func (e *EventTokenResponse) String() string

func (*EventTokenResponse) UnmarshalJSON

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

type EventTopic

type EventTopic string

The topic of the event

const (
	EventTopicAgentCreated                 EventTopic = "agent:created"
	EventTopicAgentUpdated                 EventTopic = "agent:updated"
	EventTopicAgentDeleted                 EventTopic = "agent:deleted"
	EventTopicSpaceCreated                 EventTopic = "space:created"
	EventTopicSpaceUpdated                 EventTopic = "space:updated"
	EventTopicSpaceDeleted                 EventTopic = "space:deleted"
	EventTopicSpaceArchived                EventTopic = "space:archived"
	EventTopicSpaceUnarchived              EventTopic = "space:unarchived"
	EventTopicSpaceExpired                 EventTopic = "space:expired"
	EventTopicSpaceGuestAdded              EventTopic = "space:guestAdded"
	EventTopicSpaceGuestRemoved            EventTopic = "space:guestRemoved"
	EventTopicDocumentCreated              EventTopic = "document:created"
	EventTopicDocumentUpdated              EventTopic = "document:updated"
	EventTopicDocumentDeleted              EventTopic = "document:deleted"
	EventTopicWorkbookCreated              EventTopic = "workbook:created"
	EventTopicWorkbookUpdated              EventTopic = "workbook:updated"
	EventTopicWorkbookDeleted              EventTopic = "workbook:deleted"
	EventTopicWorkbookExpired              EventTopic = "workbook:expired"
	EventTopicSheetCreated                 EventTopic = "sheet:created"
	EventTopicSheetUpdated                 EventTopic = "sheet:updated"
	EventTopicSheetDeleted                 EventTopic = "sheet:deleted"
	EventTopicSheetCountsUpdated           EventTopic = "sheet:counts-updated"
	EventTopicSnapshotCreated              EventTopic = "snapshot:created"
	EventTopicRecordsCreated               EventTopic = "records:created"
	EventTopicRecordsUpdated               EventTopic = "records:updated"
	EventTopicRecordsDeleted               EventTopic = "records:deleted"
	EventTopicFileCreated                  EventTopic = "file:created"
	EventTopicFileUpdated                  EventTopic = "file:updated"
	EventTopicFileDeleted                  EventTopic = "file:deleted"
	EventTopicFileExpired                  EventTopic = "file:expired"
	EventTopicJobCreated                   EventTopic = "job:created"
	EventTopicJobUpdated                   EventTopic = "job:updated"
	EventTopicJobDeleted                   EventTopic = "job:deleted"
	EventTopicJobCompleted                 EventTopic = "job:completed"
	EventTopicJobReady                     EventTopic = "job:ready"
	EventTopicJobScheduled                 EventTopic = "job:scheduled"
	EventTopicJobOutcomeAcknowledged       EventTopic = "job:outcome-acknowledged"
	EventTopicJobPartsCompleted            EventTopic = "job:parts-completed"
	EventTopicJobFailed                    EventTopic = "job:failed"
	EventTopicProgramCreated               EventTopic = "program:created"
	EventTopicProgramUpdated               EventTopic = "program:updated"
	EventTopicCommitCreated                EventTopic = "commit:created"
	EventTopicCommitUpdated                EventTopic = "commit:updated"
	EventTopicCommitCompleted              EventTopic = "commit:completed"
	EventTopicLayerCreated                 EventTopic = "layer:created"
	EventTopicSecretCreated                EventTopic = "secret:created"
	EventTopicSecretUpdated                EventTopic = "secret:updated"
	EventTopicSecretDeleted                EventTopic = "secret:deleted"
	EventTopicCron5Minutes                 EventTopic = "cron:5-minutes"
	EventTopicCronHourly                   EventTopic = "cron:hourly"
	EventTopicCronDaily                    EventTopic = "cron:daily"
	EventTopicCronWeekly                   EventTopic = "cron:weekly"
	EventTopicEnvironmentCreated           EventTopic = "environment:created"
	EventTopicEnvironmentUpdated           EventTopic = "environment:updated"
	EventTopicEnvironmentDeleted           EventTopic = "environment:deleted"
	EventTopicActionCreated                EventTopic = "action:created"
	EventTopicActionUpdated                EventTopic = "action:updated"
	EventTopicActionDeleted                EventTopic = "action:deleted"
	EventTopicDataClipCreated              EventTopic = "data-clip:created"
	EventTopicDataClipUpdated              EventTopic = "data-clip:updated"
	EventTopicDataClipDeleted              EventTopic = "data-clip:deleted"
	EventTopicDataClipCollaboratorUpdated  EventTopic = "data-clip:collaborator-updated"
	EventTopicDataClipResolutionsCreated   EventTopic = "data-clip:resolutions-created"
	EventTopicDataClipResolutionsUpdated   EventTopic = "data-clip:resolutions-updated"
	EventTopicDataClipResolutionsRefreshed EventTopic = "data-clip:resolutions-refreshed"
)

func NewEventTopicFromString

func NewEventTopicFromString(s string) (EventTopic, error)

func (EventTopic) Ptr

func (e EventTopic) Ptr() *EventTopic

type EventVisitor

type EventVisitor interface {
	VisitAgentCreated(*GenericEvent) error
	VisitAgentUpdated(*GenericEvent) error
	VisitAgentDeleted(*GenericEvent) error
	VisitSpaceCreated(*GenericEvent) error
	VisitSpaceUpdated(*GenericEvent) error
	VisitSpaceDeleted(*GenericEvent) error
	VisitSpaceArchived(*GenericEvent) error
	VisitSpaceExpired(*GenericEvent) error
	VisitSpaceGuestAdded(*GenericEvent) error
	VisitSpaceGuestRemoved(*GenericEvent) error
	VisitDocumentCreated(*GenericEvent) error
	VisitDocumentUpdated(*GenericEvent) error
	VisitDocumentDeleted(*GenericEvent) error
	VisitWorkbookCreated(*GenericEvent) error
	VisitWorkbookUpdated(*GenericEvent) error
	VisitWorkbookDeleted(*GenericEvent) error
	VisitWorkbookExpired(*GenericEvent) error
	VisitSheetCreated(*GenericEvent) error
	VisitSheetUpdated(*GenericEvent) error
	VisitSheetDeleted(*GenericEvent) error
	VisitSheetCountsUpdated(*GenericEvent) error
	VisitSnapshotCreated(*GenericEvent) error
	VisitRecordsCreated(*GenericEvent) error
	VisitRecordsUpdated(*GenericEvent) error
	VisitRecordsDeleted(*GenericEvent) error
	VisitFileCreated(*GenericEvent) error
	VisitFileUpdated(*GenericEvent) error
	VisitFileDeleted(*GenericEvent) error
	VisitFileExpired(*GenericEvent) error
	VisitJobCreated(*GenericEvent) error
	VisitJobUpdated(*GenericEvent) error
	VisitJobDeleted(*GenericEvent) error
	VisitJobFailed(*GenericEvent) error
	VisitJobCompleted(*GenericEvent) error
	VisitJobReady(*GenericEvent) error
	VisitJobScheduled(*GenericEvent) error
	VisitJobOutcomeAcknowledged(*GenericEvent) error
	VisitJobPartsCompleted(*GenericEvent) error
	VisitProgramCreated(*GenericEvent) error
	VisitProgramUpdated(*GenericEvent) error
	VisitCommitCreated(*GenericEvent) error
	VisitCommitUpdated(*GenericEvent) error
	VisitCommitCompleted(*GenericEvent) error
	VisitSecretCreated(*GenericEvent) error
	VisitSecretUpdated(*GenericEvent) error
	VisitSecretDeleted(*GenericEvent) error
	VisitLayerCreated(*GenericEvent) error
	VisitEnvironmentCreated(*GenericEvent) error
	VisitEnvironmentUpdated(*GenericEvent) error
	VisitEnvironmentDeleted(*GenericEvent) error
	VisitActionCreated(*GenericEvent) error
	VisitActionUpdated(*GenericEvent) error
	VisitActionDeleted(*GenericEvent) error
	VisitDataClipCreated(*GenericEvent) error
	VisitDataClipUpdated(*GenericEvent) error
	VisitDataClipDeleted(*GenericEvent) error
	VisitDataClipCollaboratorUpdated(*GenericEvent) error
	VisitDataClipResolutionsCreated(*GenericEvent) error
	VisitDataClipResolutionsUpdated(*GenericEvent) error
	VisitDataClipResolutionsRefreshed(*GenericEvent) error
}

type Execution

type Execution struct {
	EventId EventId `json:"eventId" url:"eventId"`
	// Whether the agent execution was successful
	Success     bool      `json:"success" url:"success"`
	CreatedAt   time.Time `json:"createdAt" url:"createdAt"`
	CompletedAt time.Time `json:"completedAt" url:"completedAt"`
	// The duration of the agent execution
	Duration int `json:"duration" url:"duration"`
	// The topics of the agent execution
	Topic string `json:"topic" url:"topic"`
	// contains filtered or unexported fields
}

An execution of an agent

func (*Execution) GetCompletedAt

func (e *Execution) GetCompletedAt() time.Time

func (*Execution) GetCreatedAt

func (e *Execution) GetCreatedAt() time.Time

func (*Execution) GetDuration

func (e *Execution) GetDuration() int

func (*Execution) GetEventId

func (e *Execution) GetEventId() EventId

func (*Execution) GetExtraProperties

func (e *Execution) GetExtraProperties() map[string]interface{}

func (*Execution) GetSuccess

func (e *Execution) GetSuccess() bool

func (*Execution) GetTopic

func (e *Execution) GetTopic() string

func (*Execution) MarshalJSON

func (e *Execution) MarshalJSON() ([]byte, error)

func (*Execution) String

func (e *Execution) String() string

func (*Execution) UnmarshalJSON

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

type ExportJobConfig

type ExportJobConfig struct {
	Options *ExportOptions `json:"options,omitempty" url:"options,omitempty"`
	// contains filtered or unexported fields
}

func (*ExportJobConfig) GetExtraProperties

func (e *ExportJobConfig) GetExtraProperties() map[string]interface{}

func (*ExportJobConfig) GetOptions

func (e *ExportJobConfig) GetOptions() *ExportOptions

func (*ExportJobConfig) String

func (e *ExportJobConfig) String() string

func (*ExportJobConfig) UnmarshalJSON

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

type ExportOptions

type ExportOptions struct {
	// Deprecated, use `commitId` instead
	VersionId *VersionId `json:"versionId,omitempty" url:"versionId,omitempty"`
	// If provided, the snapshot version of the workbook will be used for the export
	CommitId *CommitId `json:"commitId,omitempty" url:"commitId,omitempty"`
	// The field to sort the records on
	SortField *SortField `json:"sortField,omitempty" url:"sortField,omitempty"`
	// The direction to sort the records
	SortDirection *SortDirection `json:"sortDirection,omitempty" url:"sortDirection,omitempty"`
	// The filter to apply to the records
	Filter *Filter `json:"filter,omitempty" url:"filter,omitempty"`
	// The field to filter on
	FilterField *FilterField `json:"filterField,omitempty" url:"filterField,omitempty"`
	// The value to search for
	SearchValue *SearchValue `json:"searchValue,omitempty" url:"searchValue,omitempty"`
	// The field to search for the search value in
	SearchField *SearchField `json:"searchField,omitempty" url:"searchField,omitempty"`
	// The FFQL query to filter records
	Q *string `json:"q,omitempty" url:"q,omitempty"`
	// The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records
	Ids []RecordId `json:"ids,omitempty" url:"ids,omitempty"`
	// contains filtered or unexported fields
}

func (*ExportOptions) GetCommitId

func (e *ExportOptions) GetCommitId() *CommitId

func (*ExportOptions) GetExtraProperties

func (e *ExportOptions) GetExtraProperties() map[string]interface{}

func (*ExportOptions) GetFilter

func (e *ExportOptions) GetFilter() *Filter

func (*ExportOptions) GetFilterField

func (e *ExportOptions) GetFilterField() *FilterField

func (*ExportOptions) GetIds

func (e *ExportOptions) GetIds() []RecordId

func (*ExportOptions) GetQ

func (e *ExportOptions) GetQ() *string

func (*ExportOptions) GetSearchField

func (e *ExportOptions) GetSearchField() *SearchField

func (*ExportOptions) GetSearchValue

func (e *ExportOptions) GetSearchValue() *SearchValue

func (*ExportOptions) GetSortDirection

func (e *ExportOptions) GetSortDirection() *SortDirection

func (*ExportOptions) GetSortField

func (e *ExportOptions) GetSortField() *SortField

func (*ExportOptions) GetVersionId

func (e *ExportOptions) GetVersionId() *VersionId

func (*ExportOptions) String

func (e *ExportOptions) String() string

func (*ExportOptions) UnmarshalJSON

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

type ExternalConstraint

type ExternalConstraint struct {
	Validator string      `json:"validator" url:"validator"`
	Config    interface{} `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

func (*ExternalConstraint) GetConfig

func (e *ExternalConstraint) GetConfig() interface{}

func (*ExternalConstraint) GetExtraProperties

func (e *ExternalConstraint) GetExtraProperties() map[string]interface{}

func (*ExternalConstraint) GetValidator

func (e *ExternalConstraint) GetValidator() string

func (*ExternalConstraint) String

func (e *ExternalConstraint) String() string

func (*ExternalConstraint) UnmarshalJSON

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

type ExternalSheetConstraint

type ExternalSheetConstraint struct {
	Validator string `json:"validator" url:"validator"`
	// The fields that must be unique together
	Fields []string    `json:"fields,omitempty" url:"fields,omitempty"`
	Config interface{} `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

func (*ExternalSheetConstraint) GetConfig

func (e *ExternalSheetConstraint) GetConfig() interface{}

func (*ExternalSheetConstraint) GetExtraProperties

func (e *ExternalSheetConstraint) GetExtraProperties() map[string]interface{}

func (*ExternalSheetConstraint) GetFields

func (e *ExternalSheetConstraint) GetFields() []string

func (*ExternalSheetConstraint) GetValidator

func (e *ExternalSheetConstraint) GetValidator() string

func (*ExternalSheetConstraint) String

func (e *ExternalSheetConstraint) String() string

func (*ExternalSheetConstraint) UnmarshalJSON

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

type FamilyId

type FamilyId = string

Mapping Family ID

type FieldAppearance

type FieldAppearance struct {
	Size *FieldSize `json:"size,omitempty" url:"size,omitempty"`
	// contains filtered or unexported fields
}

Control the appearance of this field when it's displayed in a table or input

func (*FieldAppearance) GetExtraProperties

func (f *FieldAppearance) GetExtraProperties() map[string]interface{}

func (*FieldAppearance) GetSize

func (f *FieldAppearance) GetSize() *FieldSize

func (*FieldAppearance) String

func (f *FieldAppearance) String() string

func (*FieldAppearance) UnmarshalJSON

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

type FieldKey

type FieldKey = string

Returns results from the given field only. Otherwise all field cells are returned

type FieldRecordCounts

type FieldRecordCounts struct {
	Total int `json:"total" url:"total"`
	Valid int `json:"valid" url:"valid"`
	Error int `json:"error" url:"error"`
	Empty int `json:"empty" url:"empty"`
	// contains filtered or unexported fields
}

func (*FieldRecordCounts) GetEmpty

func (f *FieldRecordCounts) GetEmpty() int

func (*FieldRecordCounts) GetError

func (f *FieldRecordCounts) GetError() int

func (*FieldRecordCounts) GetExtraProperties

func (f *FieldRecordCounts) GetExtraProperties() map[string]interface{}

func (*FieldRecordCounts) GetTotal

func (f *FieldRecordCounts) GetTotal() int

func (*FieldRecordCounts) GetValid

func (f *FieldRecordCounts) GetValid() int

func (*FieldRecordCounts) String

func (f *FieldRecordCounts) String() string

func (*FieldRecordCounts) UnmarshalJSON

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

type FieldSize

type FieldSize string

The default visual sizing. This sizing may be overridden by a user

const (
	FieldSizeXs FieldSize = "xs"
	FieldSizeS  FieldSize = "s"
	FieldSizeM  FieldSize = "m"
	FieldSizeL  FieldSize = "l"
	FieldSizeXl FieldSize = "xl"
)

func NewFieldSizeFromString

func NewFieldSizeFromString(s string) (FieldSize, error)

func (FieldSize) Ptr

func (f FieldSize) Ptr() *FieldSize

type File

type File struct {
	Id FileId `json:"id" url:"id"`
	// Original filename
	Name string `json:"name" url:"name"`
	// Extension of the file
	Ext string `json:"ext" url:"ext"`
	// MIME Type of the file
	Mimetype string `json:"mimetype" url:"mimetype"`
	// Text encoding of the file
	Encoding string `json:"encoding" url:"encoding"`
	// Status of the file
	Status ModelFileStatusEnum `json:"status" url:"status"`
	// The storage mode of file
	Mode *Mode `json:"mode,omitempty" url:"mode,omitempty"`
	// Size of file in bytes
	Size int `json:"size" url:"size"`
	// Number of bytes that have been uploaded so far (useful for progress tracking)
	BytesReceived int `json:"bytesReceived" url:"bytesReceived"`
	// Date the file was created
	CreatedAt time.Time `json:"createdAt" url:"createdAt"`
	// Date the file was last updated
	UpdatedAt time.Time `json:"updatedAt" url:"updatedAt"`
	// Date the file was expired
	ExpiredAt  *time.Time  `json:"expiredAt,omitempty" url:"expiredAt,omitempty"`
	SpaceId    SpaceId     `json:"spaceId" url:"spaceId"`
	WorkbookId *WorkbookId `json:"workbookId,omitempty" url:"workbookId,omitempty"`
	SheetId    *SheetId    `json:"sheetId,omitempty" url:"sheetId,omitempty"`
	Actions    []*Action   `json:"actions,omitempty" url:"actions,omitempty"`
	Origin     *FileOrigin `json:"origin,omitempty" url:"origin,omitempty"`
	// contains filtered or unexported fields
}

Any uploaded file of any type

func (*File) GetActions

func (f *File) GetActions() []*Action

func (*File) GetBytesReceived

func (f *File) GetBytesReceived() int

func (*File) GetCreatedAt

func (f *File) GetCreatedAt() time.Time

func (*File) GetEncoding

func (f *File) GetEncoding() string

func (*File) GetExpiredAt

func (f *File) GetExpiredAt() *time.Time

func (*File) GetExt

func (f *File) GetExt() string

func (*File) GetExtraProperties

func (f *File) GetExtraProperties() map[string]interface{}

func (*File) GetId

func (f *File) GetId() FileId

func (*File) GetMimetype

func (f *File) GetMimetype() string

func (*File) GetMode

func (f *File) GetMode() *Mode

func (*File) GetName

func (f *File) GetName() string

func (*File) GetOrigin

func (f *File) GetOrigin() *FileOrigin

func (*File) GetSheetId

func (f *File) GetSheetId() *SheetId

func (*File) GetSize

func (f *File) GetSize() int

func (*File) GetSpaceId

func (f *File) GetSpaceId() SpaceId

func (*File) GetStatus

func (f *File) GetStatus() ModelFileStatusEnum

func (*File) GetUpdatedAt

func (f *File) GetUpdatedAt() time.Time

func (*File) GetWorkbookId

func (f *File) GetWorkbookId() *WorkbookId

func (*File) MarshalJSON

func (f *File) MarshalJSON() ([]byte, error)

func (*File) String

func (f *File) String() string

func (*File) UnmarshalJSON

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

type FileId

type FileId = string

File ID

type FileJobConfig

type FileJobConfig struct {
	// The driver to use for extracting data from the file
	Driver Driver `json:"driver" url:"driver"`
	// The options to use for extracting data from the file
	Options map[string]interface{} `json:"options,omitempty" url:"options,omitempty"`
	// The row number of the header row detected at extraction time
	DetectedHeaderRow *int `json:"detectedHeaderRow,omitempty" url:"detectedHeaderRow,omitempty"`
	// contains filtered or unexported fields
}

func (*FileJobConfig) GetDetectedHeaderRow

func (f *FileJobConfig) GetDetectedHeaderRow() *int

func (*FileJobConfig) GetDriver

func (f *FileJobConfig) GetDriver() Driver

func (*FileJobConfig) GetExtraProperties

func (f *FileJobConfig) GetExtraProperties() map[string]interface{}

func (*FileJobConfig) GetOptions

func (f *FileJobConfig) GetOptions() map[string]interface{}

func (*FileJobConfig) String

func (f *FileJobConfig) String() string

func (*FileJobConfig) UnmarshalJSON

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

type FileOrigin

type FileOrigin string

const (
	FileOriginFilesystem  FileOrigin = "filesystem"
	FileOriginGoogledrive FileOrigin = "googledrive"
	FileOriginBox         FileOrigin = "box"
	FileOriginOnedrive    FileOrigin = "onedrive"
)

func NewFileOriginFromString

func NewFileOriginFromString(s string) (FileOrigin, error)

func (FileOrigin) Ptr

func (f FileOrigin) Ptr() *FileOrigin

type FileParam

type FileParam struct {
	io.Reader
	// contains filtered or unexported fields
}

FileParam is a file type suitable for multipart/form-data uploads.

func NewFileParam

func NewFileParam(
	reader io.Reader,
	filename string,
	contentType string,
	opts ...FileParamOption,
) *FileParam

NewFileParam returns a *FileParam type suitable for multipart/form-data uploads. All file upload endpoints accept a simple io.Reader, which is usually created by opening a file via os.Open.

However, some endpoints require additional metadata about the file such as a specific Content-Type or custom filename. FileParam makes it easier to create the correct type signature for these endpoints.

func (*FileParam) ContentType

func (f *FileParam) ContentType() string

func (*FileParam) Name

func (f *FileParam) Name() string

type FileParamOption

type FileParamOption interface {
	// contains filtered or unexported methods
}

FileParamOption adapts the behavior of the FileParam. No options are implemented yet, but this interface allows for future extensibility.

type FileResponse

type FileResponse struct {
	Data *File `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*FileResponse) GetData

func (f *FileResponse) GetData() *File

func (*FileResponse) GetExtraProperties

func (f *FileResponse) GetExtraProperties() map[string]interface{}

func (*FileResponse) String

func (f *FileResponse) String() string

func (*FileResponse) UnmarshalJSON

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

type Filter

type Filter string

Options to filter records

const (
	FilterValid Filter = "valid"
	FilterError Filter = "error"
	FilterAll   Filter = "all"
	FilterNone  Filter = "none"
)

func NewFilterFromString

func NewFilterFromString(s string) (Filter, error)

func (Filter) Ptr

func (f Filter) Ptr() *Filter

type FilterField

type FilterField = string

Use this to narrow the valid/error filter results to a specific field

type FindAndReplaceJobConfig

type FindAndReplaceJobConfig struct {
	// The filter to apply to the records
	Filter *Filter `json:"filter,omitempty" url:"filter,omitempty"`
	// The field to filter on
	FilterField *FilterField `json:"filterField,omitempty" url:"filterField,omitempty"`
	// The value to search for
	SearchValue *SearchValue `json:"searchValue,omitempty" url:"searchValue,omitempty"`
	// The field to search for the search value in
	SearchField *SearchField `json:"searchField,omitempty" url:"searchField,omitempty"`
	// The FFQL query to filter records
	Q *string `json:"q,omitempty" url:"q,omitempty"`
	// The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records
	Ids []RecordId `json:"ids,omitempty" url:"ids,omitempty"`
	// A value to find for a given field in a sheet. Wrap the value in "" for exact match
	Find *CellValueUnion `json:"find,omitempty" url:"find,omitempty"`
	// The value to replace found values with
	Replace *CellValueUnion `json:"replace,omitempty" url:"replace,omitempty"`
	// A unique key used to identify a field in a sheet
	FieldKey string `json:"fieldKey" url:"fieldKey"`
	// If specified, a snapshot will be generated with this label
	SnapshotLabel *string `json:"snapshotLabel,omitempty" url:"snapshotLabel,omitempty"`
	// contains filtered or unexported fields
}

func (*FindAndReplaceJobConfig) GetExtraProperties

func (f *FindAndReplaceJobConfig) GetExtraProperties() map[string]interface{}

func (*FindAndReplaceJobConfig) GetFieldKey

func (f *FindAndReplaceJobConfig) GetFieldKey() string

func (*FindAndReplaceJobConfig) GetFilter

func (f *FindAndReplaceJobConfig) GetFilter() *Filter

func (*FindAndReplaceJobConfig) GetFilterField

func (f *FindAndReplaceJobConfig) GetFilterField() *FilterField

func (*FindAndReplaceJobConfig) GetFind

func (f *FindAndReplaceJobConfig) GetFind() *CellValueUnion

func (*FindAndReplaceJobConfig) GetIds

func (f *FindAndReplaceJobConfig) GetIds() []RecordId

func (*FindAndReplaceJobConfig) GetQ

func (f *FindAndReplaceJobConfig) GetQ() *string

func (*FindAndReplaceJobConfig) GetReplace

func (f *FindAndReplaceJobConfig) GetReplace() *CellValueUnion

func (*FindAndReplaceJobConfig) GetSearchField

func (f *FindAndReplaceJobConfig) GetSearchField() *SearchField

func (*FindAndReplaceJobConfig) GetSearchValue

func (f *FindAndReplaceJobConfig) GetSearchValue() *SearchValue

func (*FindAndReplaceJobConfig) GetSnapshotLabel

func (f *FindAndReplaceJobConfig) GetSnapshotLabel() *string

func (*FindAndReplaceJobConfig) String

func (f *FindAndReplaceJobConfig) String() string

func (*FindAndReplaceJobConfig) UnmarshalJSON

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

type FindAndReplaceRecordRequest

type FindAndReplaceRecordRequest struct {
	Filter *Filter `json:"-" url:"filter,omitempty"`
	// Name of field by which to filter records
	FilterField *FilterField `json:"-" url:"filterField,omitempty"`
	SearchValue *SearchValue `json:"-" url:"searchValue,omitempty"`
	SearchField *SearchField `json:"-" url:"searchField,omitempty"`
	// The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records
	Ids []*RecordId `json:"-" url:"ids,omitempty"`
	// An FFQL query used to filter the result set
	Q *string `json:"-" url:"q,omitempty"`
	// A value to find for a given field in a sheet. For exact matches, wrap the value in double quotes ("Bob")
	Find *CellValueUnion `json:"find,omitempty" url:"-"`
	// The value to replace found values with
	Replace *CellValueUnion `json:"replace,omitempty" url:"-"`
	// A unique key used to identify a field in a sheet
	FieldKey string `json:"fieldKey" url:"-"`
}

type ForbiddenError

type ForbiddenError struct {
	*core.APIError
	Body *Errors
}

func (*ForbiddenError) MarshalJSON

func (f *ForbiddenError) MarshalJSON() ([]byte, error)

func (*ForbiddenError) UnmarshalJSON

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

func (*ForbiddenError) Unwrap

func (f *ForbiddenError) Unwrap() error

type GenericEvent

type GenericEvent struct {
	// The domain of the event
	Domain Domain `json:"domain" url:"domain"`
	// The context of the event
	Context *Context `json:"context,omitempty" url:"context,omitempty"`
	// The attributes of the event
	Attributes *EventAttributes `json:"attributes,omitempty" url:"attributes,omitempty"`
	// The callback url to acknowledge the event
	CallbackUrl *string `json:"callbackUrl,omitempty" url:"callbackUrl,omitempty"`
	// The url to retrieve the data associated with the event
	DataUrl    *string  `json:"dataUrl,omitempty" url:"dataUrl,omitempty"`
	Target     *string  `json:"target,omitempty" url:"target,omitempty"`
	Origin     *Origin  `json:"origin,omitempty" url:"origin,omitempty"`
	Namespaces []string `json:"namespaces,omitempty" url:"namespaces,omitempty"`
	Id         EventId  `json:"id" url:"id"`
	// Date the event was created
	CreatedAt time.Time `json:"createdAt" url:"createdAt"`
	// Date the event was deleted
	DeletedAt *time.Time `json:"deletedAt,omitempty" url:"deletedAt,omitempty"`
	// Date the event was acknowledged
	AcknowledgedAt *time.Time `json:"acknowledgedAt,omitempty" url:"acknowledgedAt,omitempty"`
	// The actor (user or system) who acknowledged the event
	AcknowledgedBy *string                `json:"acknowledgedBy,omitempty" url:"acknowledgedBy,omitempty"`
	Payload        map[string]interface{} `json:"payload,omitempty" url:"payload,omitempty"`
	// contains filtered or unexported fields
}

func (*GenericEvent) GetAcknowledgedAt

func (g *GenericEvent) GetAcknowledgedAt() *time.Time

func (*GenericEvent) GetAcknowledgedBy

func (g *GenericEvent) GetAcknowledgedBy() *string

func (*GenericEvent) GetAttributes

func (g *GenericEvent) GetAttributes() *EventAttributes

func (*GenericEvent) GetCallbackUrl

func (g *GenericEvent) GetCallbackUrl() *string

func (*GenericEvent) GetContext

func (g *GenericEvent) GetContext() *Context

func (*GenericEvent) GetCreatedAt

func (g *GenericEvent) GetCreatedAt() time.Time

func (*GenericEvent) GetDataUrl

func (g *GenericEvent) GetDataUrl() *string

func (*GenericEvent) GetDeletedAt

func (g *GenericEvent) GetDeletedAt() *time.Time

func (*GenericEvent) GetDomain

func (g *GenericEvent) GetDomain() Domain

func (*GenericEvent) GetExtraProperties

func (g *GenericEvent) GetExtraProperties() map[string]interface{}

func (*GenericEvent) GetId

func (g *GenericEvent) GetId() EventId

func (*GenericEvent) GetNamespaces

func (g *GenericEvent) GetNamespaces() []string

func (*GenericEvent) GetOrigin

func (g *GenericEvent) GetOrigin() *Origin

func (*GenericEvent) GetPayload

func (g *GenericEvent) GetPayload() map[string]interface{}

func (*GenericEvent) GetTarget

func (g *GenericEvent) GetTarget() *string

func (*GenericEvent) MarshalJSON

func (g *GenericEvent) MarshalJSON() ([]byte, error)

func (*GenericEvent) String

func (g *GenericEvent) String() string

func (*GenericEvent) UnmarshalJSON

func (g *GenericEvent) UnmarshalJSON(data []byte) error

type GetActionsRequest

type GetActionsRequest struct {
	// The Space ID for which to get the Actions.
	SpaceId SpaceId `json:"-" url:"spaceId"`
}

type GetAgentLogRequest

type GetAgentLogRequest struct {
	EnvironmentId EnvironmentId `json:"-" url:"environmentId"`
}

type GetAgentLogsRequest

type GetAgentLogsRequest struct {
	EnvironmentId EnvironmentId `json:"-" url:"environmentId"`
}

type GetAgentLogsResponse

type GetAgentLogsResponse struct {
	Pagination *Pagination `json:"pagination,omitempty" url:"pagination,omitempty"`
	Data       []*AgentLog `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*GetAgentLogsResponse) GetData

func (g *GetAgentLogsResponse) GetData() []*AgentLog

func (*GetAgentLogsResponse) GetExtraProperties

func (g *GetAgentLogsResponse) GetExtraProperties() map[string]interface{}

func (*GetAgentLogsResponse) GetPagination

func (g *GetAgentLogsResponse) GetPagination() *Pagination

func (*GetAgentLogsResponse) String

func (g *GetAgentLogsResponse) String() string

func (*GetAgentLogsResponse) UnmarshalJSON

func (g *GetAgentLogsResponse) UnmarshalJSON(data []byte) error

type GetAgentRequest

type GetAgentRequest struct {
	EnvironmentId *EnvironmentId `json:"-" url:"environmentId,omitempty"`
}

type GetConstraintsRequest

type GetConstraintsRequest struct {
	// Whether to include built-in constraints
	IncludeBuiltins *bool `json:"-" url:"includeBuiltins,omitempty"`
}

type GetDetailedAgentLogResponse

type GetDetailedAgentLogResponse struct {
	Data *DetailedAgentLog `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDetailedAgentLogResponse) GetData

func (g *GetDetailedAgentLogResponse) GetData() *DetailedAgentLog

func (*GetDetailedAgentLogResponse) GetExtraProperties

func (g *GetDetailedAgentLogResponse) GetExtraProperties() map[string]interface{}

func (*GetDetailedAgentLogResponse) String

func (g *GetDetailedAgentLogResponse) String() string

func (*GetDetailedAgentLogResponse) UnmarshalJSON

func (g *GetDetailedAgentLogResponse) UnmarshalJSON(data []byte) error

type GetDetailedAgentLogsResponse

type GetDetailedAgentLogsResponse struct {
	Pagination *Pagination         `json:"pagination,omitempty" url:"pagination,omitempty"`
	Data       []*DetailedAgentLog `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDetailedAgentLogsResponse) GetData

func (g *GetDetailedAgentLogsResponse) GetData() []*DetailedAgentLog

func (*GetDetailedAgentLogsResponse) GetExtraProperties

func (g *GetDetailedAgentLogsResponse) GetExtraProperties() map[string]interface{}

func (*GetDetailedAgentLogsResponse) GetPagination

func (g *GetDetailedAgentLogsResponse) GetPagination() *Pagination

func (*GetDetailedAgentLogsResponse) String

func (g *GetDetailedAgentLogsResponse) String() string

func (*GetDetailedAgentLogsResponse) UnmarshalJSON

func (g *GetDetailedAgentLogsResponse) UnmarshalJSON(data []byte) error

type GetEnvironmentAgentExecutionsRequest

type GetEnvironmentAgentExecutionsRequest struct {
	EnvironmentId EnvironmentId          `json:"-" url:"environmentId"`
	SpaceId       *SpaceId               `json:"-" url:"spaceId,omitempty"`
	Success       *SuccessQueryParameter `json:"-" url:"success,omitempty"`
	PageSize      *PageSize              `json:"-" url:"pageSize,omitempty"`
	PageNumber    *PageNumber            `json:"-" url:"pageNumber,omitempty"`
}

type GetEnvironmentAgentLogsRequest

type GetEnvironmentAgentLogsRequest struct {
	EnvironmentId EnvironmentId          `json:"-" url:"environmentId"`
	SpaceId       *SpaceId               `json:"-" url:"spaceId,omitempty"`
	Success       *SuccessQueryParameter `json:"-" url:"success,omitempty"`
	PageSize      *PageSize              `json:"-" url:"pageSize,omitempty"`
	PageNumber    *PageNumber            `json:"-" url:"pageNumber,omitempty"`
}

type GetEnvironmentEventTokenRequest

type GetEnvironmentEventTokenRequest struct {
	// ID of environment to return
	EnvironmentId EnvironmentId `json:"-" url:"environmentId"`
}

type GetEventTokenRequest

type GetEventTokenRequest struct {
	// The resource ID of the event stream (space or environment id)
	Scope *string `json:"-" url:"scope,omitempty"`
	// The space ID of the event stream
	SpaceId *SpaceId `json:"-" url:"spaceId,omitempty"`
}

type GetExecutionsResponse

type GetExecutionsResponse struct {
	Pagination *Pagination  `json:"pagination,omitempty" url:"pagination,omitempty"`
	Data       []*Execution `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*GetExecutionsResponse) GetData

func (g *GetExecutionsResponse) GetData() []*Execution

func (*GetExecutionsResponse) GetExtraProperties

func (g *GetExecutionsResponse) GetExtraProperties() map[string]interface{}

func (*GetExecutionsResponse) GetPagination

func (g *GetExecutionsResponse) GetPagination() *Pagination

func (*GetExecutionsResponse) String

func (g *GetExecutionsResponse) String() string

func (*GetExecutionsResponse) UnmarshalJSON

func (g *GetExecutionsResponse) UnmarshalJSON(data []byte) error

type GetFieldValuesRequest

type GetFieldValuesRequest struct {
	FieldKey      *FieldKey      `json:"-" url:"fieldKey,omitempty"`
	SortField     *SortField     `json:"-" url:"sortField,omitempty"`
	SortDirection *SortDirection `json:"-" url:"sortDirection,omitempty"`
	Filter        *Filter        `json:"-" url:"filter,omitempty"`
	// Name of field by which to filter records
	FilterField *FilterField `json:"-" url:"filterField,omitempty"`
	// Number of records to return in a page (default 1000 if pageNumber included)
	PageSize *PageSize `json:"-" url:"pageSize,omitempty"`
	// Based on pageSize, which page of records to return
	PageNumber *PageNumber `json:"-" url:"pageNumber,omitempty"`
	// Must be set to true
	Distinct      Distinct       `json:"-" url:"distinct"`
	IncludeCounts *IncludeCounts `json:"-" url:"includeCounts,omitempty"`
	// A value to find for a given field in a sheet. Wrap the value in "" for exact match
	SearchValue *SearchValue `json:"-" url:"searchValue,omitempty"`
}

type GetGuestTokenRequest

type GetGuestTokenRequest struct {
	// ID of space to return
	SpaceId *SpaceId `json:"-" url:"spaceId,omitempty"`
}

type GetGuidanceRequest

type GetGuidanceRequest struct {
	// Include the guide with the guidance
	Guide *string `json:"-" url:"guide,omitempty"`
}

type GetRecordCountsRequest

type GetRecordCountsRequest struct {
	// Returns records that were changed in that version and only those records.
	VersionId *string `json:"-" url:"versionId,omitempty"`
	// Deprecated, use `sinceCommitId` instead.
	SinceVersionId *VersionId `json:"-" url:"sinceVersionId,omitempty"`
	// Returns records that were changed in that version in addition to any records from versions after that version.
	CommitId *CommitId `json:"-" url:"commitId,omitempty"`
	// Listing a commit ID here will return all records since the specified commit.
	SinceCommitId *CommitId `json:"-" url:"sinceCommitId,omitempty"`
	// Options to filter records
	Filter *Filter `json:"-" url:"filter,omitempty"`
	// The field to filter the data on.
	FilterField *FilterField `json:"-" url:"filterField,omitempty"`
	// The value to search for data on.
	SearchValue *SearchValue `json:"-" url:"searchValue,omitempty"`
	// The field to search for data on.
	SearchField *SearchField `json:"-" url:"searchField,omitempty"`
	// If true, the counts for each field will also be returned
	ByField *bool `json:"-" url:"byField,omitempty"`
	// An FFQL query used to filter the result set to be counted
	Q *string `json:"-" url:"q,omitempty"`
}

type GetRecordIndicesRequest

type GetRecordIndicesRequest struct {
	CommitId      *CommitId      `json:"-" url:"commitId,omitempty"`
	SinceCommitId *CommitId      `json:"-" url:"sinceCommitId,omitempty"`
	SortField     *SortField     `json:"-" url:"sortField,omitempty"`
	SortDirection *SortDirection `json:"-" url:"sortDirection,omitempty"`
	Filter        *Filter        `json:"-" url:"filter,omitempty"`
	// Name of field by which to filter records
	FilterField *FilterField `json:"-" url:"filterField,omitempty"`
	SearchValue *SearchValue `json:"-" url:"searchValue,omitempty"`
	SearchField *SearchField `json:"-" url:"searchField,omitempty"`
	// List of record IDs to include in the query. Limit 100.
	Ids []RecordId `json:"-" url:"ids"`
	// An FFQL query used to filter the result set
	Q *string `json:"-" url:"q,omitempty"`
}

type GetRecordIndicesResponse

type GetRecordIndicesResponse = []*RecordIndices

type GetRecordsCsvRequest

type GetRecordsCsvRequest struct {
	// Deprecated, use `sinceCommitId` instead.
	VersionId *string `json:"-" url:"versionId,omitempty"`
	// Returns records that were changed in that version  in that version and only those records.
	CommitId *CommitId `json:"-" url:"commitId,omitempty"`
	// Deprecated, use `sinceCommitId` instead.
	SinceVersionId *VersionId `json:"-" url:"sinceVersionId,omitempty"`
	// Returns records that were changed in that version in addition to any records from versions after that version.
	SinceCommitId *CommitId `json:"-" url:"sinceCommitId,omitempty"`
	// The field to sort the data on.
	SortField *SortField `json:"-" url:"sortField,omitempty"`
	// Sort direction - asc (ascending) or desc (descending)
	SortDirection *SortDirection `json:"-" url:"sortDirection,omitempty"`
	// Options to filter records
	Filter *Filter `json:"-" url:"filter,omitempty"`
	// The field to filter the data on.
	FilterField *FilterField `json:"-" url:"filterField,omitempty"`
	// The value to search for data on.
	SearchValue *SearchValue `json:"-" url:"searchValue,omitempty"`
	// The field to search for data on.
	SearchField *SearchField `json:"-" url:"searchField,omitempty"`
	// The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records
	Ids []*RecordId `json:"-" url:"ids,omitempty"`
}

type GetRecordsRequest

type GetRecordsRequest struct {
	// Deprecated, use `commitId` instead.
	VersionId *VersionId `json:"-" url:"versionId,omitempty"`
	CommitId  *CommitId  `json:"-" url:"commitId,omitempty"`
	// Deprecated, use `sinceCommitId` instead.
	SinceVersionId *VersionId     `json:"-" url:"sinceVersionId,omitempty"`
	SinceCommitId  *CommitId      `json:"-" url:"sinceCommitId,omitempty"`
	SortField      *SortField     `json:"-" url:"sortField,omitempty"`
	SortDirection  *SortDirection `json:"-" url:"sortDirection,omitempty"`
	Filter         *Filter        `json:"-" url:"filter,omitempty"`
	// Name of field by which to filter records
	FilterField *FilterField `json:"-" url:"filterField,omitempty"`
	SearchValue *SearchValue `json:"-" url:"searchValue,omitempty"`
	SearchField *SearchField `json:"-" url:"searchField,omitempty"`
	// The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records. Maximum of 100 allowed.
	Ids []*RecordId `json:"-" url:"ids,omitempty"`
	// Number of records to return in a page (default 10,000)
	PageSize *int `json:"-" url:"pageSize,omitempty"`
	// Based on pageSize, which page of records to return (Note - numbers start at 1)
	PageNumber *int `json:"-" url:"pageNumber,omitempty"`
	// **DEPRECATED** Use GET /sheets/:sheetId/counts
	IncludeCounts *bool `json:"-" url:"includeCounts,omitempty"`
	// The length of the record result set, returned as counts.total
	IncludeLength *bool `json:"-" url:"includeLength,omitempty"`
	// If true, linked records will be included in the results. Defaults to false.
	IncludeLinks *bool `json:"-" url:"includeLinks,omitempty"`
	// Include error messages, defaults to false.
	IncludeMessages *bool `json:"-" url:"includeMessages,omitempty"`
	// A list of field keys to include in the response. If not provided, all fields will be included.
	Fields []*string `json:"-" url:"fields,omitempty"`
	// if "for" is provided, the query parameters will be pulled from the event payload
	For *EventId `json:"-" url:"for,omitempty"`
	// An FFQL query used to filter the result set
	Q *string `json:"-" url:"q,omitempty"`
}

type GetRecordsResponse

type GetRecordsResponse struct {
	Data *GetRecordsResponseData `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRecordsResponse) GetData

func (g *GetRecordsResponse) GetData() *GetRecordsResponseData

func (*GetRecordsResponse) GetExtraProperties

func (g *GetRecordsResponse) GetExtraProperties() map[string]interface{}

func (*GetRecordsResponse) String

func (g *GetRecordsResponse) String() string

func (*GetRecordsResponse) UnmarshalJSON

func (g *GetRecordsResponse) UnmarshalJSON(data []byte) error

type GetRecordsResponseData

type GetRecordsResponseData struct {
	Success bool             `json:"success" url:"success"`
	Records RecordsWithLinks `json:"records,omitempty" url:"records,omitempty"`
	Counts  *RecordCounts    `json:"counts,omitempty" url:"counts,omitempty"`
	// Deprecated, use `commitId` instead.
	VersionId *VersionId `json:"versionId,omitempty" url:"versionId,omitempty"`
	CommitId  *CommitId  `json:"commitId,omitempty" url:"commitId,omitempty"`
	// contains filtered or unexported fields
}

A list of records with optional record counts

func (*GetRecordsResponseData) GetCommitId

func (g *GetRecordsResponseData) GetCommitId() *CommitId

func (*GetRecordsResponseData) GetCounts

func (g *GetRecordsResponseData) GetCounts() *RecordCounts

func (*GetRecordsResponseData) GetExtraProperties

func (g *GetRecordsResponseData) GetExtraProperties() map[string]interface{}

func (*GetRecordsResponseData) GetRecords

func (g *GetRecordsResponseData) GetRecords() RecordsWithLinks

func (*GetRecordsResponseData) GetSuccess

func (g *GetRecordsResponseData) GetSuccess() bool

func (*GetRecordsResponseData) GetVersionId

func (g *GetRecordsResponseData) GetVersionId() *VersionId

func (*GetRecordsResponseData) String

func (g *GetRecordsResponseData) String() string

func (*GetRecordsResponseData) UnmarshalJSON

func (g *GetRecordsResponseData) UnmarshalJSON(data []byte) error

type GetSnapshotRecordsRequest

type GetSnapshotRecordsRequest struct {
	// Number of records to return in a page
	PageSize *int `json:"-" url:"pageSize,omitempty"`
	// Based on pageSize, which page of records to return
	PageNumber *int `json:"-" url:"pageNumber,omitempty"`
	// Filter records by change type
	ChangeType *ChangeType `json:"-" url:"changeType,omitempty"`
}

type GetSnapshotRequest

type GetSnapshotRequest struct {
	// Whether to include a summary in the snapshot response
	IncludeSummary bool `json:"-" url:"includeSummary"`
}

type GetSpacesSortField

type GetSpacesSortField string

const (
	GetSpacesSortFieldName              GetSpacesSortField = "name"
	GetSpacesSortFieldWorkbooksCount    GetSpacesSortField = "workbooksCount"
	GetSpacesSortFieldFilesCount        GetSpacesSortField = "filesCount"
	GetSpacesSortFieldEnvironmentId     GetSpacesSortField = "environmentId"
	GetSpacesSortFieldCreatedByUserName GetSpacesSortField = "createdByUserName"
	GetSpacesSortFieldCreatedAt         GetSpacesSortField = "createdAt"
	GetSpacesSortFieldLastActivityAt    GetSpacesSortField = "lastActivityAt"
)

func NewGetSpacesSortFieldFromString

func NewGetSpacesSortFieldFromString(s string) (GetSpacesSortField, error)

func (GetSpacesSortField) Ptr

func (g GetSpacesSortField) Ptr() *GetSpacesSortField

type Guardrail

type Guardrail struct {
	// Markdown guardrail for this action
	Content string `json:"content" url:"content"`
	// contains filtered or unexported fields
}

func (*Guardrail) GetContent

func (g *Guardrail) GetContent() string

func (*Guardrail) GetExtraProperties

func (g *Guardrail) GetExtraProperties() map[string]interface{}

func (*Guardrail) String

func (g *Guardrail) String() string

func (*Guardrail) UnmarshalJSON

func (g *Guardrail) UnmarshalJSON(data []byte) error

type Guest

type Guest struct {
	EnvironmentId EnvironmentId `json:"environmentId" url:"environmentId"`
	Email         string        `json:"email" url:"email"`
	Name          string        `json:"name" url:"name"`
	Spaces        []*GuestSpace `json:"spaces,omitempty" url:"spaces,omitempty"`
	Id            GuestId       `json:"id" url:"id"`
	// Date the guest object was created
	CreatedAt time.Time `json:"createdAt" url:"createdAt"`
	// Date the guest object was last updated
	UpdatedAt time.Time `json:"updatedAt" url:"updatedAt"`
	// contains filtered or unexported fields
}

func (*Guest) GetCreatedAt

func (g *Guest) GetCreatedAt() time.Time

func (*Guest) GetEmail

func (g *Guest) GetEmail() string

func (*Guest) GetEnvironmentId

func (g *Guest) GetEnvironmentId() EnvironmentId

func (*Guest) GetExtraProperties

func (g *Guest) GetExtraProperties() map[string]interface{}

func (*Guest) GetId

func (g *Guest) GetId() GuestId

func (*Guest) GetName

func (g *Guest) GetName() string

func (*Guest) GetSpaces

func (g *Guest) GetSpaces() []*GuestSpace

func (*Guest) GetUpdatedAt

func (g *Guest) GetUpdatedAt() time.Time

func (*Guest) MarshalJSON

func (g *Guest) MarshalJSON() ([]byte, error)

func (*Guest) String

func (g *Guest) String() string

func (*Guest) UnmarshalJSON

func (g *Guest) UnmarshalJSON(data []byte) error

type GuestAuthenticationEnum

type GuestAuthenticationEnum string

The type of authentication to use for guests

const (
	GuestAuthenticationEnumSharedLink GuestAuthenticationEnum = "shared_link"
	GuestAuthenticationEnumMagicLink  GuestAuthenticationEnum = "magic_link"
)

func NewGuestAuthenticationEnumFromString

func NewGuestAuthenticationEnumFromString(s string) (GuestAuthenticationEnum, error)

func (GuestAuthenticationEnum) Ptr

func (g GuestAuthenticationEnum) Ptr() *GuestAuthenticationEnum

type GuestConfig

type GuestConfig struct {
	EnvironmentId EnvironmentId `json:"environmentId" url:"environmentId"`
	Email         string        `json:"email" url:"email"`
	Name          string        `json:"name" url:"name"`
	Spaces        []*GuestSpace `json:"spaces,omitempty" url:"spaces,omitempty"`
	// contains filtered or unexported fields
}

Configurations for the guests

func (*GuestConfig) GetEmail

func (g *GuestConfig) GetEmail() string

func (*GuestConfig) GetEnvironmentId

func (g *GuestConfig) GetEnvironmentId() EnvironmentId

func (*GuestConfig) GetExtraProperties

func (g *GuestConfig) GetExtraProperties() map[string]interface{}

func (*GuestConfig) GetName

func (g *GuestConfig) GetName() string

func (*GuestConfig) GetSpaces

func (g *GuestConfig) GetSpaces() []*GuestSpace

func (*GuestConfig) String

func (g *GuestConfig) String() string

func (*GuestConfig) UnmarshalJSON

func (g *GuestConfig) UnmarshalJSON(data []byte) error

type GuestConfigUpdate

type GuestConfigUpdate struct {
	EnvironmentId *EnvironmentId `json:"environmentId,omitempty" url:"environmentId,omitempty"`
	Email         *string        `json:"email,omitempty" url:"email,omitempty"`
	Name          *string        `json:"name,omitempty" url:"name,omitempty"`
	Spaces        []*GuestSpace  `json:"spaces,omitempty" url:"spaces,omitempty"`
	// contains filtered or unexported fields
}

Properties used to update an existing guest

func (*GuestConfigUpdate) GetEmail

func (g *GuestConfigUpdate) GetEmail() *string

func (*GuestConfigUpdate) GetEnvironmentId

func (g *GuestConfigUpdate) GetEnvironmentId() *EnvironmentId

func (*GuestConfigUpdate) GetExtraProperties

func (g *GuestConfigUpdate) GetExtraProperties() map[string]interface{}

func (*GuestConfigUpdate) GetName

func (g *GuestConfigUpdate) GetName() *string

func (*GuestConfigUpdate) GetSpaces

func (g *GuestConfigUpdate) GetSpaces() []*GuestSpace

func (*GuestConfigUpdate) String

func (g *GuestConfigUpdate) String() string

func (*GuestConfigUpdate) UnmarshalJSON

func (g *GuestConfigUpdate) UnmarshalJSON(data []byte) error

type GuestId

type GuestId = string

Guest ID

type GuestResponse

type GuestResponse struct {
	Data *Guest `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*GuestResponse) GetData

func (g *GuestResponse) GetData() *Guest

func (*GuestResponse) GetExtraProperties

func (g *GuestResponse) GetExtraProperties() map[string]interface{}

func (*GuestResponse) String

func (g *GuestResponse) String() string

func (*GuestResponse) UnmarshalJSON

func (g *GuestResponse) UnmarshalJSON(data []byte) error

type GuestSpace

type GuestSpace struct {
	Id           SpaceId          `json:"id" url:"id"`
	Workbooks    []*GuestWorkbook `json:"workbooks,omitempty" url:"workbooks,omitempty"`
	LastAccessed *time.Time       `json:"lastAccessed,omitempty" url:"lastAccessed,omitempty"`
	// contains filtered or unexported fields
}

func (*GuestSpace) GetExtraProperties

func (g *GuestSpace) GetExtraProperties() map[string]interface{}

func (*GuestSpace) GetId

func (g *GuestSpace) GetId() SpaceId

func (*GuestSpace) GetLastAccessed

func (g *GuestSpace) GetLastAccessed() *time.Time

func (*GuestSpace) GetWorkbooks

func (g *GuestSpace) GetWorkbooks() []*GuestWorkbook

func (*GuestSpace) MarshalJSON

func (g *GuestSpace) MarshalJSON() ([]byte, error)

func (*GuestSpace) String

func (g *GuestSpace) String() string

func (*GuestSpace) UnmarshalJSON

func (g *GuestSpace) UnmarshalJSON(data []byte) error

type GuestToken

type GuestToken struct {
	// The token used to authenticate the guest
	Token string `json:"token" url:"token"`
	Valid bool   `json:"valid" url:"valid"`
	// contains filtered or unexported fields
}

func (*GuestToken) GetExtraProperties

func (g *GuestToken) GetExtraProperties() map[string]interface{}

func (*GuestToken) GetToken

func (g *GuestToken) GetToken() string

func (*GuestToken) GetValid

func (g *GuestToken) GetValid() bool

func (*GuestToken) String

func (g *GuestToken) String() string

func (*GuestToken) UnmarshalJSON

func (g *GuestToken) UnmarshalJSON(data []byte) error

type GuestTokenResponse

type GuestTokenResponse struct {
	Data *GuestToken `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*GuestTokenResponse) GetData

func (g *GuestTokenResponse) GetData() *GuestToken

func (*GuestTokenResponse) GetExtraProperties

func (g *GuestTokenResponse) GetExtraProperties() map[string]interface{}

func (*GuestTokenResponse) String

func (g *GuestTokenResponse) String() string

func (*GuestTokenResponse) UnmarshalJSON

func (g *GuestTokenResponse) UnmarshalJSON(data []byte) error

type GuestWorkbook

type GuestWorkbook struct {
	Id WorkbookId `json:"id" url:"id"`
	// contains filtered or unexported fields
}

func (*GuestWorkbook) GetExtraProperties

func (g *GuestWorkbook) GetExtraProperties() map[string]interface{}

func (*GuestWorkbook) GetId

func (g *GuestWorkbook) GetId() WorkbookId

func (*GuestWorkbook) String

func (g *GuestWorkbook) String() string

func (*GuestWorkbook) UnmarshalJSON

func (g *GuestWorkbook) UnmarshalJSON(data []byte) error

type GuidanceApiCreateData

type GuidanceApiCreateData struct {
	GuideSlug string `json:"guideSlug" url:"guideSlug"`
	// Options for the guidance
	Options *GuidanceOptions `json:"options,omitempty" url:"options,omitempty"`
	// contains filtered or unexported fields
}

func (*GuidanceApiCreateData) GetExtraProperties

func (g *GuidanceApiCreateData) GetExtraProperties() map[string]interface{}

func (*GuidanceApiCreateData) GetGuideSlug

func (g *GuidanceApiCreateData) GetGuideSlug() string

func (*GuidanceApiCreateData) GetOptions

func (g *GuidanceApiCreateData) GetOptions() *GuidanceOptions

func (*GuidanceApiCreateData) String

func (g *GuidanceApiCreateData) String() string

func (*GuidanceApiCreateData) UnmarshalJSON

func (g *GuidanceApiCreateData) UnmarshalJSON(data []byte) error

type GuidanceApiUpdateData

type GuidanceApiUpdateData struct {
	// Options for the guidance
	Options *GuidanceOptions `json:"options,omitempty" url:"options,omitempty"`
	// contains filtered or unexported fields
}

func (*GuidanceApiUpdateData) GetExtraProperties

func (g *GuidanceApiUpdateData) GetExtraProperties() map[string]interface{}

func (*GuidanceApiUpdateData) GetOptions

func (g *GuidanceApiUpdateData) GetOptions() *GuidanceOptions

func (*GuidanceApiUpdateData) String

func (g *GuidanceApiUpdateData) String() string

func (*GuidanceApiUpdateData) UnmarshalJSON

func (g *GuidanceApiUpdateData) UnmarshalJSON(data []byte) error

type GuidanceId

type GuidanceId = string

Guidance ID

type GuidanceListResponse

type GuidanceListResponse struct {
	Data []*GuidanceResource `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*GuidanceListResponse) GetData

func (g *GuidanceListResponse) GetData() []*GuidanceResource

func (*GuidanceListResponse) GetExtraProperties

func (g *GuidanceListResponse) GetExtraProperties() map[string]interface{}

func (*GuidanceListResponse) String

func (g *GuidanceListResponse) String() string

func (*GuidanceListResponse) UnmarshalJSON

func (g *GuidanceListResponse) UnmarshalJSON(data []byte) error

type GuidanceOptions

type GuidanceOptions struct {
	Target  string      `json:"target" url:"target"`
	Trigger TriggerEnum `json:"trigger" url:"trigger"`
	Type    TypeEnum    `json:"type" url:"type"`
	Role    RoleEnum    `json:"role" url:"role"`
	// contains filtered or unexported fields
}

func (*GuidanceOptions) GetExtraProperties

func (g *GuidanceOptions) GetExtraProperties() map[string]interface{}

func (*GuidanceOptions) GetRole

func (g *GuidanceOptions) GetRole() RoleEnum

func (*GuidanceOptions) GetTarget

func (g *GuidanceOptions) GetTarget() string

func (*GuidanceOptions) GetTrigger

func (g *GuidanceOptions) GetTrigger() TriggerEnum

func (*GuidanceOptions) GetType

func (g *GuidanceOptions) GetType() TypeEnum

func (*GuidanceOptions) String

func (g *GuidanceOptions) String() string

func (*GuidanceOptions) UnmarshalJSON

func (g *GuidanceOptions) UnmarshalJSON(data []byte) error

type GuidanceResource

type GuidanceResource struct {
	Id        GuidanceId       `json:"id" url:"id"`
	GuideSlug string           `json:"guideSlug" url:"guideSlug"`
	Options   *GuidanceOptions `json:"options,omitempty" url:"options,omitempty"`
	// contains filtered or unexported fields
}

func (*GuidanceResource) GetExtraProperties

func (g *GuidanceResource) GetExtraProperties() map[string]interface{}

func (*GuidanceResource) GetGuideSlug

func (g *GuidanceResource) GetGuideSlug() string

func (*GuidanceResource) GetId

func (g *GuidanceResource) GetId() GuidanceId

func (*GuidanceResource) GetOptions

func (g *GuidanceResource) GetOptions() *GuidanceOptions

func (*GuidanceResource) String

func (g *GuidanceResource) String() string

func (*GuidanceResource) UnmarshalJSON

func (g *GuidanceResource) UnmarshalJSON(data []byte) error

type Guide

type Guide struct {
	// Markdown guidance for this action
	Content string `json:"content" url:"content"`
	// contains filtered or unexported fields
}

func (*Guide) GetContent

func (g *Guide) GetContent() string

func (*Guide) GetExtraProperties

func (g *Guide) GetExtraProperties() map[string]interface{}

func (*Guide) String

func (g *Guide) String() string

func (*Guide) UnmarshalJSON

func (g *Guide) UnmarshalJSON(data []byte) error

type GuideCreateRequest

type GuideCreateRequest struct {
	Description   string                   `json:"description" url:"description"`
	Title         string                   `json:"title" url:"title"`
	Metadata      map[string]interface{}   `json:"metadata,omitempty" url:"metadata,omitempty"`
	Slug          string                   `json:"slug" url:"slug"`
	Versions      []*GuideVersionResource  `json:"versions,omitempty" url:"versions,omitempty"`
	Blocks        []map[string]interface{} `json:"blocks,omitempty" url:"blocks,omitempty"`
	EnvironmentId string                   `json:"environmentId" url:"environmentId"`
	// contains filtered or unexported fields
}

Create a guide

func (*GuideCreateRequest) GetBlocks

func (g *GuideCreateRequest) GetBlocks() []map[string]interface{}

func (*GuideCreateRequest) GetDescription

func (g *GuideCreateRequest) GetDescription() string

func (*GuideCreateRequest) GetEnvironmentId

func (g *GuideCreateRequest) GetEnvironmentId() string

func (*GuideCreateRequest) GetExtraProperties

func (g *GuideCreateRequest) GetExtraProperties() map[string]interface{}

func (*GuideCreateRequest) GetMetadata

func (g *GuideCreateRequest) GetMetadata() map[string]interface{}

func (*GuideCreateRequest) GetSlug

func (g *GuideCreateRequest) GetSlug() string

func (*GuideCreateRequest) GetTitle

func (g *GuideCreateRequest) GetTitle() string

func (*GuideCreateRequest) GetVersions

func (g *GuideCreateRequest) GetVersions() []*GuideVersionResource

func (*GuideCreateRequest) String

func (g *GuideCreateRequest) String() string

func (*GuideCreateRequest) UnmarshalJSON

func (g *GuideCreateRequest) UnmarshalJSON(data []byte) error

type GuideDeleteResponse

type GuideDeleteResponse struct {
	Data *GuideDeleteResponseData `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*GuideDeleteResponse) GetData

func (g *GuideDeleteResponse) GetData() *GuideDeleteResponseData

func (*GuideDeleteResponse) GetExtraProperties

func (g *GuideDeleteResponse) GetExtraProperties() map[string]interface{}

func (*GuideDeleteResponse) String

func (g *GuideDeleteResponse) String() string

func (*GuideDeleteResponse) UnmarshalJSON

func (g *GuideDeleteResponse) UnmarshalJSON(data []byte) error

type GuideDeleteResponseData

type GuideDeleteResponseData struct {
	Success bool `json:"success" url:"success"`
	// contains filtered or unexported fields
}

func (*GuideDeleteResponseData) GetExtraProperties

func (g *GuideDeleteResponseData) GetExtraProperties() map[string]interface{}

func (*GuideDeleteResponseData) GetSuccess

func (g *GuideDeleteResponseData) GetSuccess() bool

func (*GuideDeleteResponseData) String

func (g *GuideDeleteResponseData) String() string

func (*GuideDeleteResponseData) UnmarshalJSON

func (g *GuideDeleteResponseData) UnmarshalJSON(data []byte) error

type GuideDetailResponse

type GuideDetailResponse struct {
	Data *GuideResource `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*GuideDetailResponse) GetData

func (g *GuideDetailResponse) GetData() *GuideResource

func (*GuideDetailResponse) GetExtraProperties

func (g *GuideDetailResponse) GetExtraProperties() map[string]interface{}

func (*GuideDetailResponse) String

func (g *GuideDetailResponse) String() string

func (*GuideDetailResponse) UnmarshalJSON

func (g *GuideDetailResponse) UnmarshalJSON(data []byte) error

type GuideId

type GuideId = string

Guide ID

type GuideListResponse

type GuideListResponse struct {
	Data []*GuideResource `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*GuideListResponse) GetData

func (g *GuideListResponse) GetData() []*GuideResource

func (*GuideListResponse) GetExtraProperties

func (g *GuideListResponse) GetExtraProperties() map[string]interface{}

func (*GuideListResponse) String

func (g *GuideListResponse) String() string

func (*GuideListResponse) UnmarshalJSON

func (g *GuideListResponse) UnmarshalJSON(data []byte) error

type GuideResource

type GuideResource struct {
	Id          GuideId                  `json:"id" url:"id"`
	Description *string                  `json:"description,omitempty" url:"description,omitempty"`
	Metadata    map[string]interface{}   `json:"metadata,omitempty" url:"metadata,omitempty"`
	Slug        string                   `json:"slug" url:"slug"`
	Title       string                   `json:"title" url:"title"`
	Versions    []*GuideVersionResource  `json:"versions,omitempty" url:"versions,omitempty"`
	Blocks      []map[string]interface{} `json:"blocks,omitempty" url:"blocks,omitempty"`
	CreatedAt   time.Time                `json:"createdAt" url:"createdAt"`
	UpdatedAt   time.Time                `json:"updatedAt" url:"updatedAt"`
	// contains filtered or unexported fields
}

A guide

func (*GuideResource) GetBlocks

func (g *GuideResource) GetBlocks() []map[string]interface{}

func (*GuideResource) GetCreatedAt

func (g *GuideResource) GetCreatedAt() time.Time

func (*GuideResource) GetDescription

func (g *GuideResource) GetDescription() *string

func (*GuideResource) GetExtraProperties

func (g *GuideResource) GetExtraProperties() map[string]interface{}

func (*GuideResource) GetId

func (g *GuideResource) GetId() GuideId

func (*GuideResource) GetMetadata

func (g *GuideResource) GetMetadata() map[string]interface{}

func (*GuideResource) GetSlug

func (g *GuideResource) GetSlug() string

func (*GuideResource) GetTitle

func (g *GuideResource) GetTitle() string

func (*GuideResource) GetUpdatedAt

func (g *GuideResource) GetUpdatedAt() time.Time

func (*GuideResource) GetVersions

func (g *GuideResource) GetVersions() []*GuideVersionResource

func (*GuideResource) MarshalJSON

func (g *GuideResource) MarshalJSON() ([]byte, error)

func (*GuideResource) String

func (g *GuideResource) String() string

func (*GuideResource) UnmarshalJSON

func (g *GuideResource) UnmarshalJSON(data []byte) error

type GuideUpdateRequest

type GuideUpdateRequest struct {
	Description   *string                  `json:"description,omitempty" url:"description,omitempty"`
	Title         *string                  `json:"title,omitempty" url:"title,omitempty"`
	Metadata      map[string]interface{}   `json:"metadata,omitempty" url:"metadata,omitempty"`
	Slug          *string                  `json:"slug,omitempty" url:"slug,omitempty"`
	Versions      []*GuideVersionResource  `json:"versions,omitempty" url:"versions,omitempty"`
	Blocks        []map[string]interface{} `json:"blocks,omitempty" url:"blocks,omitempty"`
	EnvironmentId *string                  `json:"environmentId,omitempty" url:"environmentId,omitempty"`
	// contains filtered or unexported fields
}

Update a guide

func (*GuideUpdateRequest) GetBlocks

func (g *GuideUpdateRequest) GetBlocks() []map[string]interface{}

func (*GuideUpdateRequest) GetDescription

func (g *GuideUpdateRequest) GetDescription() *string

func (*GuideUpdateRequest) GetEnvironmentId

func (g *GuideUpdateRequest) GetEnvironmentId() *string

func (*GuideUpdateRequest) GetExtraProperties

func (g *GuideUpdateRequest) GetExtraProperties() map[string]interface{}

func (*GuideUpdateRequest) GetMetadata

func (g *GuideUpdateRequest) GetMetadata() map[string]interface{}

func (*GuideUpdateRequest) GetSlug

func (g *GuideUpdateRequest) GetSlug() *string

func (*GuideUpdateRequest) GetTitle

func (g *GuideUpdateRequest) GetTitle() *string

func (*GuideUpdateRequest) GetVersions

func (g *GuideUpdateRequest) GetVersions() []*GuideVersionResource

func (*GuideUpdateRequest) String

func (g *GuideUpdateRequest) String() string

func (*GuideUpdateRequest) UnmarshalJSON

func (g *GuideUpdateRequest) UnmarshalJSON(data []byte) error

type GuideVersionResource

type GuideVersionResource struct {
	Id        string    `json:"id" url:"id"`
	Version   int       `json:"version" url:"version"`
	Content   string    `json:"content" url:"content"`
	CreatedAt time.Time `json:"createdAt" url:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt" url:"updatedAt"`
	// contains filtered or unexported fields
}

A version of a guide

func (*GuideVersionResource) GetContent

func (g *GuideVersionResource) GetContent() string

func (*GuideVersionResource) GetCreatedAt

func (g *GuideVersionResource) GetCreatedAt() time.Time

func (*GuideVersionResource) GetExtraProperties

func (g *GuideVersionResource) GetExtraProperties() map[string]interface{}

func (*GuideVersionResource) GetId

func (g *GuideVersionResource) GetId() string

func (*GuideVersionResource) GetUpdatedAt

func (g *GuideVersionResource) GetUpdatedAt() time.Time

func (*GuideVersionResource) GetVersion

func (g *GuideVersionResource) GetVersion() int

func (*GuideVersionResource) MarshalJSON

func (g *GuideVersionResource) MarshalJSON() ([]byte, error)

func (*GuideVersionResource) String

func (g *GuideVersionResource) String() string

func (*GuideVersionResource) UnmarshalJSON

func (g *GuideVersionResource) UnmarshalJSON(data []byte) error

type GuideVersionResponse

type GuideVersionResponse struct {
	Data *GuideVersionResource `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*GuideVersionResponse) GetData

func (g *GuideVersionResponse) GetData() *GuideVersionResource

func (*GuideVersionResponse) GetExtraProperties

func (g *GuideVersionResponse) GetExtraProperties() map[string]interface{}

func (*GuideVersionResponse) String

func (g *GuideVersionResponse) String() string

func (*GuideVersionResponse) UnmarshalJSON

func (g *GuideVersionResponse) UnmarshalJSON(data []byte) error

type IncludeCounts

type IncludeCounts = bool

When both distinct and includeCounts are true, the count of distinct field values will be returned

type InputConfig

type InputConfig struct {
	Options []*InputEnumPropertyOption `json:"options,omitempty" url:"options,omitempty"`
	// contains filtered or unexported fields
}

func (*InputConfig) GetExtraProperties

func (i *InputConfig) GetExtraProperties() map[string]interface{}

func (*InputConfig) GetOptions

func (i *InputConfig) GetOptions() []*InputEnumPropertyOption

func (*InputConfig) String

func (i *InputConfig) String() string

func (*InputConfig) UnmarshalJSON

func (i *InputConfig) UnmarshalJSON(data []byte) error

type InputConstraint

type InputConstraint struct {
	Type InputConstraintType `json:"type" url:"type"`
	// contains filtered or unexported fields
}

func (*InputConstraint) GetExtraProperties

func (i *InputConstraint) GetExtraProperties() map[string]interface{}

func (*InputConstraint) GetType

func (i *InputConstraint) GetType() InputConstraintType

func (*InputConstraint) String

func (i *InputConstraint) String() string

func (*InputConstraint) UnmarshalJSON

func (i *InputConstraint) UnmarshalJSON(data []byte) error

type InputConstraintType

type InputConstraintType string

const (
	InputConstraintTypeRequired InputConstraintType = "required"
)

func NewInputConstraintTypeFromString

func NewInputConstraintTypeFromString(s string) (InputConstraintType, error)

func (InputConstraintType) Ptr

func (i InputConstraintType) Ptr() *InputConstraintType

type InputEnumPropertyOption

type InputEnumPropertyOption struct {
	// A visual label for this option, defaults to value if not provided
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// A short description for this option
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// An optional color to assign this option
	Color *string `json:"color,omitempty" url:"color,omitempty"`
	// A reference pointer to a previously registered icon
	Icon *string `json:"icon,omitempty" url:"icon,omitempty"`
	// An arbitrary JSON object to be associated with this option and made available to hooks
	Meta map[string]interface{} `json:"meta,omitempty" url:"meta,omitempty"`
	// The value or ID of this option. This value will be sent in egress. The type is a string | integer | boolean.
	Value interface{} `json:"value,omitempty" url:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*InputEnumPropertyOption) GetColor

func (i *InputEnumPropertyOption) GetColor() *string

func (*InputEnumPropertyOption) GetDescription

func (i *InputEnumPropertyOption) GetDescription() *string

func (*InputEnumPropertyOption) GetExtraProperties

func (i *InputEnumPropertyOption) GetExtraProperties() map[string]interface{}

func (*InputEnumPropertyOption) GetIcon

func (i *InputEnumPropertyOption) GetIcon() *string

func (*InputEnumPropertyOption) GetLabel

func (i *InputEnumPropertyOption) GetLabel() *string

func (*InputEnumPropertyOption) GetMeta

func (i *InputEnumPropertyOption) GetMeta() map[string]interface{}

func (*InputEnumPropertyOption) GetValue

func (i *InputEnumPropertyOption) GetValue() interface{}

func (*InputEnumPropertyOption) String

func (i *InputEnumPropertyOption) String() string

func (*InputEnumPropertyOption) UnmarshalJSON

func (i *InputEnumPropertyOption) UnmarshalJSON(data []byte) error

type InputField

type InputField struct {
	// Unique key for a Field.
	Key string `json:"key" url:"key"`
	// Visible name of a Field.
	Label string `json:"label" url:"label"`
	// Brief description below the name of the Field.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// Field Types inform the user interface how to sort and display data.
	Type string `json:"type" url:"type"`
	// Default value for a Field.
	DefaultValue interface{} `json:"defaultValue,omitempty" url:"defaultValue,omitempty"`
	// Additional configuration for enum Fields.
	Config *InputConfig `json:"config,omitempty" url:"config,omitempty"`
	// Indicate additional validations that will be applied to the Field.
	Constraints []*InputConstraint `json:"constraints,omitempty" url:"constraints,omitempty"`
	// contains filtered or unexported fields
}

func (*InputField) GetConfig

func (i *InputField) GetConfig() *InputConfig

func (*InputField) GetConstraints

func (i *InputField) GetConstraints() []*InputConstraint

func (*InputField) GetDefaultValue

func (i *InputField) GetDefaultValue() interface{}

func (*InputField) GetDescription

func (i *InputField) GetDescription() *string

func (*InputField) GetExtraProperties

func (i *InputField) GetExtraProperties() map[string]interface{}

func (*InputField) GetKey

func (i *InputField) GetKey() string

func (*InputField) GetLabel

func (i *InputField) GetLabel() string

func (*InputField) GetType

func (i *InputField) GetType() string

func (*InputField) String

func (i *InputField) String() string

func (*InputField) UnmarshalJSON

func (i *InputField) UnmarshalJSON(data []byte) error

type InputForm

type InputForm struct {
	Type   InputFormType `json:"type" url:"type"`
	Fields []*InputField `json:"fields,omitempty" url:"fields,omitempty"`
	// contains filtered or unexported fields
}

func (*InputForm) GetExtraProperties

func (i *InputForm) GetExtraProperties() map[string]interface{}

func (*InputForm) GetFields

func (i *InputForm) GetFields() []*InputField

func (*InputForm) GetType

func (i *InputForm) GetType() InputFormType

func (*InputForm) String

func (i *InputForm) String() string

func (*InputForm) UnmarshalJSON

func (i *InputForm) UnmarshalJSON(data []byte) error

type InputFormType

type InputFormType string

const (
	InputFormTypeSimple InputFormType = "simple"
)

func NewInputFormTypeFromString

func NewInputFormTypeFromString(s string) (InputFormType, error)

func (InputFormType) Ptr

func (i InputFormType) Ptr() *InputFormType

type InternalSpaceConfigBase

type InternalSpaceConfigBase struct {
	SpaceConfigId *SpaceConfigId `json:"spaceConfigId,omitempty" url:"spaceConfigId,omitempty"`
	EnvironmentId *EnvironmentId `json:"environmentId,omitempty" url:"environmentId,omitempty"`
	// The ID of the primary workbook for the space. This should not be included in create space requests.
	PrimaryWorkbookId *WorkbookId `json:"primaryWorkbookId,omitempty" url:"primaryWorkbookId,omitempty"`
	// Metadata for the space
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// The Space settings.
	Settings         *SpaceSettings `json:"settings,omitempty" url:"settings,omitempty"`
	Actions          []*Action      `json:"actions,omitempty" url:"actions,omitempty"`
	Access           []SpaceAccess  `json:"access,omitempty" url:"access,omitempty"`
	AutoConfigure    *bool          `json:"autoConfigure,omitempty" url:"autoConfigure,omitempty"`
	Namespace        *string        `json:"namespace,omitempty" url:"namespace,omitempty"`
	Labels           []string       `json:"labels,omitempty" url:"labels,omitempty"`
	TranslationsPath *string        `json:"translationsPath,omitempty" url:"translationsPath,omitempty"`
	LanguageOverride *string        `json:"languageOverride,omitempty" url:"languageOverride,omitempty"`
	// Date when space was archived
	ArchivedAt *time.Time `json:"archivedAt,omitempty" url:"archivedAt,omitempty"`
	// The ID of the App that space is associated with
	AppId *AppId `json:"appId,omitempty" url:"appId,omitempty"`
	// Whether the space is an app template. Only one space per app can be an app template.
	IsAppTemplate *bool `json:"isAppTemplate,omitempty" url:"isAppTemplate,omitempty"`
	// contains filtered or unexported fields
}

func (*InternalSpaceConfigBase) GetAccess

func (i *InternalSpaceConfigBase) GetAccess() []SpaceAccess

func (*InternalSpaceConfigBase) GetActions

func (i *InternalSpaceConfigBase) GetActions() []*Action

func (*InternalSpaceConfigBase) GetAppId

func (i *InternalSpaceConfigBase) GetAppId() *AppId

func (*InternalSpaceConfigBase) GetArchivedAt

func (i *InternalSpaceConfigBase) GetArchivedAt() *time.Time

func (*InternalSpaceConfigBase) GetAutoConfigure

func (i *InternalSpaceConfigBase) GetAutoConfigure() *bool

func (*InternalSpaceConfigBase) GetEnvironmentId

func (i *InternalSpaceConfigBase) GetEnvironmentId() *EnvironmentId

func (*InternalSpaceConfigBase) GetExtraProperties

func (i *InternalSpaceConfigBase) GetExtraProperties() map[string]interface{}

func (*InternalSpaceConfigBase) GetIsAppTemplate

func (i *InternalSpaceConfigBase) GetIsAppTemplate() *bool

func (*InternalSpaceConfigBase) GetLabels

func (i *InternalSpaceConfigBase) GetLabels() []string

func (*InternalSpaceConfigBase) GetLanguageOverride

func (i *InternalSpaceConfigBase) GetLanguageOverride() *string

func (*InternalSpaceConfigBase) GetMetadata

func (i *InternalSpaceConfigBase) GetMetadata() interface{}

func (*InternalSpaceConfigBase) GetNamespace

func (i *InternalSpaceConfigBase) GetNamespace() *string

func (*InternalSpaceConfigBase) GetPrimaryWorkbookId

func (i *InternalSpaceConfigBase) GetPrimaryWorkbookId() *WorkbookId

func (*InternalSpaceConfigBase) GetSettings

func (i *InternalSpaceConfigBase) GetSettings() *SpaceSettings

func (*InternalSpaceConfigBase) GetSpaceConfigId

func (i *InternalSpaceConfigBase) GetSpaceConfigId() *SpaceConfigId

func (*InternalSpaceConfigBase) GetTranslationsPath

func (i *InternalSpaceConfigBase) GetTranslationsPath() *string

func (*InternalSpaceConfigBase) MarshalJSON

func (i *InternalSpaceConfigBase) MarshalJSON() ([]byte, error)

func (*InternalSpaceConfigBase) String

func (i *InternalSpaceConfigBase) String() string

func (*InternalSpaceConfigBase) UnmarshalJSON

func (i *InternalSpaceConfigBase) UnmarshalJSON(data []byte) error

type Invite

type Invite struct {
	GuestId GuestId `json:"guestId" url:"guestId"`
	SpaceId SpaceId `json:"spaceId" url:"spaceId"`
	// The name of the person or company sending the invitation
	FromName *string `json:"fromName,omitempty" url:"fromName,omitempty"`
	// Message to send with the invite
	Message *string `json:"message,omitempty" url:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*Invite) GetExtraProperties

func (i *Invite) GetExtraProperties() map[string]interface{}

func (*Invite) GetFromName

func (i *Invite) GetFromName() *string

func (*Invite) GetGuestId

func (i *Invite) GetGuestId() GuestId

func (*Invite) GetMessage

func (i *Invite) GetMessage() *string

func (*Invite) GetSpaceId

func (i *Invite) GetSpaceId() SpaceId

func (*Invite) String

func (i *Invite) String() string

func (*Invite) UnmarshalJSON

func (i *Invite) UnmarshalJSON(data []byte) error

type Job

type Job struct {
	// The type of job
	Type JobType `json:"type" url:"type"`
	// the type of operation to perform on the data. For example, "export".
	Operation   string           `json:"operation" url:"operation"`
	Source      JobSource        `json:"source" url:"source"`
	Destination *JobDestination  `json:"destination,omitempty" url:"destination,omitempty"`
	Config      *JobUpdateConfig `json:"config,omitempty" url:"config,omitempty"`
	// the type of trigger to use for this job
	Trigger *Trigger `json:"trigger,omitempty" url:"trigger,omitempty"`
	// the status of the job
	Status *JobStatus `json:"status,omitempty" url:"status,omitempty"`
	// the progress of the job. Whole number between 0 and 100
	Progress *int    `json:"progress,omitempty" url:"progress,omitempty"`
	FileId   *FileId `json:"fileId,omitempty" url:"fileId,omitempty"`
	// the mode of the job
	Mode *JobMode `json:"mode,omitempty" url:"mode,omitempty"`
	// Input parameters for this job type.
	Input map[string]interface{} `json:"input,omitempty" url:"input,omitempty"`
	// Subject parameters for this job type.
	Subject *JobSubject `json:"subject,omitempty" url:"subject,omitempty"`
	// Outcome summary of job.
	Outcome map[string]interface{} `json:"outcome,omitempty" url:"outcome,omitempty"`
	// Current status of job in text
	Info *string `json:"info,omitempty" url:"info,omitempty"`
	// Indicates if Flatfile is managing the control flow of this job or if it is being manually tracked.
	Managed *bool `json:"managed,omitempty" url:"managed,omitempty"`
	// The id of the environment this job belongs to
	EnvironmentId *EnvironmentId `json:"environmentId,omitempty" url:"environmentId,omitempty"`
	// The part number of this job
	Part *int `json:"part,omitempty" url:"part,omitempty"`
	// The data for this part of the job
	PartData map[string]interface{} `json:"partData,omitempty" url:"partData,omitempty"`
	// The execution mode for this part of the job
	PartExecution *JobPartExecution `json:"partExecution,omitempty" url:"partExecution,omitempty"`
	// The id of the parent job
	ParentId *JobId `json:"parentId,omitempty" url:"parentId,omitempty"`
	// The ids of the jobs that must complete before this job can start
	PredecessorIds []JobId `json:"predecessorIds,omitempty" url:"predecessorIds,omitempty"`
	// Additional metadata for the job
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	Id       JobId                  `json:"id" url:"id"`
	// Date the item was created
	CreatedAt time.Time `json:"createdAt" url:"createdAt"`
	// Date the item was last updated
	UpdatedAt time.Time `json:"updatedAt" url:"updatedAt"`
	// the time that the job started at
	StartedAt *time.Time `json:"startedAt,omitempty" url:"startedAt,omitempty"`
	// the time that the job finished at
	FinishedAt *time.Time `json:"finishedAt,omitempty" url:"finishedAt,omitempty"`
	// the time that the job's outcome has been acknowledged by a user
	OutcomeAcknowledgedAt *time.Time `json:"outcomeAcknowledgedAt,omitempty" url:"outcomeAcknowledgedAt,omitempty"`
	// contains filtered or unexported fields
}

A single unit of work that will execute asynchronously

func (*Job) GetConfig

func (j *Job) GetConfig() *JobUpdateConfig

func (*Job) GetCreatedAt

func (j *Job) GetCreatedAt() time.Time

func (*Job) GetDestination

func (j *Job) GetDestination() *JobDestination

func (*Job) GetEnvironmentId

func (j *Job) GetEnvironmentId() *EnvironmentId

func (*Job) GetExtraProperties

func (j *Job) GetExtraProperties() map[string]interface{}

func (*Job) GetFileId

func (j *Job) GetFileId() *FileId

func (*Job) GetFinishedAt

func (j *Job) GetFinishedAt() *time.Time

func (*Job) GetId

func (j *Job) GetId() JobId

func (*Job) GetInfo

func (j *Job) GetInfo() *string

func (*Job) GetInput

func (j *Job) GetInput() map[string]interface{}

func (*Job) GetManaged

func (j *Job) GetManaged() *bool

func (*Job) GetMetadata

func (j *Job) GetMetadata() map[string]interface{}

func (*Job) GetMode

func (j *Job) GetMode() *JobMode

func (*Job) GetOperation

func (j *Job) GetOperation() string

func (*Job) GetOutcome

func (j *Job) GetOutcome() map[string]interface{}

func (*Job) GetOutcomeAcknowledgedAt

func (j *Job) GetOutcomeAcknowledgedAt() *time.Time

func (*Job) GetParentId

func (j *Job) GetParentId() *JobId

func (*Job) GetPart

func (j *Job) GetPart() *int

func (*Job) GetPartData

func (j *Job) GetPartData() map[string]interface{}

func (*Job) GetPartExecution

func (j *Job) GetPartExecution() *JobPartExecution

func (*Job) GetPredecessorIds

func (j *Job) GetPredecessorIds() []JobId

func (*Job) GetProgress

func (j *Job) GetProgress() *int

func (*Job) GetSource

func (j *Job) GetSource() JobSource

func (*Job) GetStartedAt

func (j *Job) GetStartedAt() *time.Time

func (*Job) GetStatus

func (j *Job) GetStatus() *JobStatus

func (*Job) GetSubject

func (j *Job) GetSubject() *JobSubject

func (*Job) GetTrigger

func (j *Job) GetTrigger() *Trigger

func (*Job) GetType

func (j *Job) GetType() JobType

func (*Job) GetUpdatedAt

func (j *Job) GetUpdatedAt() time.Time

func (*Job) MarshalJSON

func (j *Job) MarshalJSON() ([]byte, error)

func (*Job) String

func (j *Job) String() string

func (*Job) UnmarshalJSON

func (j *Job) UnmarshalJSON(data []byte) error

type JobAckDetails

type JobAckDetails struct {
	Info *string `json:"info,omitempty" url:"info,omitempty"`
	// the progress of the job. Whole number between 0 and 100
	Progress              *int       `json:"progress,omitempty" url:"progress,omitempty"`
	EstimatedCompletionAt *time.Time `json:"estimatedCompletionAt,omitempty" url:"estimatedCompletionAt,omitempty"`
	// contains filtered or unexported fields
}

Details about the user who acknowledged the job

func (*JobAckDetails) GetEstimatedCompletionAt

func (j *JobAckDetails) GetEstimatedCompletionAt() *time.Time

func (*JobAckDetails) GetExtraProperties

func (j *JobAckDetails) GetExtraProperties() map[string]interface{}

func (*JobAckDetails) GetInfo

func (j *JobAckDetails) GetInfo() *string

func (*JobAckDetails) GetProgress

func (j *JobAckDetails) GetProgress() *int

func (*JobAckDetails) MarshalJSON

func (j *JobAckDetails) MarshalJSON() ([]byte, error)

func (*JobAckDetails) String

func (j *JobAckDetails) String() string

func (*JobAckDetails) UnmarshalJSON

func (j *JobAckDetails) UnmarshalJSON(data []byte) error

type JobCancelDetails

type JobCancelDetails struct {
	Info *string `json:"info,omitempty" url:"info,omitempty"`
	// contains filtered or unexported fields
}

Info about the reason the job was canceled

func (*JobCancelDetails) GetExtraProperties

func (j *JobCancelDetails) GetExtraProperties() map[string]interface{}

func (*JobCancelDetails) GetInfo

func (j *JobCancelDetails) GetInfo() *string

func (*JobCancelDetails) String

func (j *JobCancelDetails) String() string

func (*JobCancelDetails) UnmarshalJSON

func (j *JobCancelDetails) UnmarshalJSON(data []byte) error

type JobCompleteDetails

type JobCompleteDetails struct {
	Outcome *JobOutcome `json:"outcome,omitempty" url:"outcome,omitempty"`
	Info    *string     `json:"info,omitempty" url:"info,omitempty"`
	// contains filtered or unexported fields
}

Outcome summary of a job

func (*JobCompleteDetails) GetExtraProperties

func (j *JobCompleteDetails) GetExtraProperties() map[string]interface{}

func (*JobCompleteDetails) GetInfo

func (j *JobCompleteDetails) GetInfo() *string

func (*JobCompleteDetails) GetOutcome

func (j *JobCompleteDetails) GetOutcome() *JobOutcome

func (*JobCompleteDetails) String

func (j *JobCompleteDetails) String() string

func (*JobCompleteDetails) UnmarshalJSON

func (j *JobCompleteDetails) UnmarshalJSON(data []byte) error

type JobConfig

type JobConfig struct {
	// The type of job
	Type JobType `json:"type" url:"type"`
	// the type of operation to perform on the data. For example, "export".
	Operation   string           `json:"operation" url:"operation"`
	Source      JobSource        `json:"source" url:"source"`
	Destination *JobDestination  `json:"destination,omitempty" url:"destination,omitempty"`
	Config      *JobUpdateConfig `json:"config,omitempty" url:"config,omitempty"`
	// the type of trigger to use for this job
	Trigger *Trigger `json:"trigger,omitempty" url:"trigger,omitempty"`
	// the status of the job
	Status *JobStatus `json:"status,omitempty" url:"status,omitempty"`
	// the progress of the job. Whole number between 0 and 100
	Progress *int    `json:"progress,omitempty" url:"progress,omitempty"`
	FileId   *FileId `json:"fileId,omitempty" url:"fileId,omitempty"`
	// the mode of the job
	Mode *JobMode `json:"mode,omitempty" url:"mode,omitempty"`
	// Input parameters for this job type.
	Input map[string]interface{} `json:"input,omitempty" url:"input,omitempty"`
	// Subject parameters for this job type.
	Subject *JobSubject `json:"subject,omitempty" url:"subject,omitempty"`
	// Outcome summary of job.
	Outcome map[string]interface{} `json:"outcome,omitempty" url:"outcome,omitempty"`
	// Current status of job in text
	Info *string `json:"info,omitempty" url:"info,omitempty"`
	// Indicates if Flatfile is managing the control flow of this job or if it is being manually tracked.
	Managed *bool `json:"managed,omitempty" url:"managed,omitempty"`
	// The id of the environment this job belongs to
	EnvironmentId *EnvironmentId `json:"environmentId,omitempty" url:"environmentId,omitempty"`
	// The part number of this job
	Part *int `json:"part,omitempty" url:"part,omitempty"`
	// The data for this part of the job
	PartData map[string]interface{} `json:"partData,omitempty" url:"partData,omitempty"`
	// The execution mode for this part of the job
	PartExecution *JobPartExecution `json:"partExecution,omitempty" url:"partExecution,omitempty"`
	// The id of the parent job
	ParentId *JobId `json:"parentId,omitempty" url:"parentId,omitempty"`
	// The ids of the jobs that must complete before this job can start
	PredecessorIds []JobId `json:"predecessorIds,omitempty" url:"predecessorIds,omitempty"`
	// Additional metadata for the job
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// contains filtered or unexported fields
}

A single unit of work that a pipeline will execute

func (*JobConfig) GetConfig

func (j *JobConfig) GetConfig() *JobUpdateConfig

func (*JobConfig) GetDestination

func (j *JobConfig) GetDestination() *JobDestination

func (*JobConfig) GetEnvironmentId

func (j *JobConfig) GetEnvironmentId() *EnvironmentId

func (*JobConfig) GetExtraProperties

func (j *JobConfig) GetExtraProperties() map[string]interface{}

func (*JobConfig) GetFileId

func (j *JobConfig) GetFileId() *FileId

func (*JobConfig) GetInfo

func (j *JobConfig) GetInfo() *string

func (*JobConfig) GetInput

func (j *JobConfig) GetInput() map[string]interface{}

func (*JobConfig) GetManaged

func (j *JobConfig) GetManaged() *bool

func (*JobConfig) GetMetadata

func (j *JobConfig) GetMetadata() map[string]interface{}

func (*JobConfig) GetMode

func (j *JobConfig) GetMode() *JobMode

func (*JobConfig) GetOperation

func (j *JobConfig) GetOperation() string

func (*JobConfig) GetOutcome

func (j *JobConfig) GetOutcome() map[string]interface{}

func (*JobConfig) GetParentId

func (j *JobConfig) GetParentId() *JobId

func (*JobConfig) GetPart

func (j *JobConfig) GetPart() *int

func (*JobConfig) GetPartData

func (j *JobConfig) GetPartData() map[string]interface{}

func (*JobConfig) GetPartExecution

func (j *JobConfig) GetPartExecution() *JobPartExecution

func (*JobConfig) GetPredecessorIds

func (j *JobConfig) GetPredecessorIds() []JobId

func (*JobConfig) GetProgress

func (j *JobConfig) GetProgress() *int

func (*JobConfig) GetSource

func (j *JobConfig) GetSource() JobSource

func (*JobConfig) GetStatus

func (j *JobConfig) GetStatus() *JobStatus

func (*JobConfig) GetSubject

func (j *JobConfig) GetSubject() *JobSubject

func (*JobConfig) GetTrigger

func (j *JobConfig) GetTrigger() *Trigger

func (*JobConfig) GetType

func (j *JobConfig) GetType() JobType

func (*JobConfig) String

func (j *JobConfig) String() string

func (*JobConfig) UnmarshalJSON

func (j *JobConfig) UnmarshalJSON(data []byte) error

type JobDestination

type JobDestination = WorkbookId

The id of the workbook where extracted file data will be sent

type JobExecutionPlan

type JobExecutionPlan struct {
	FieldMapping              []*Edge             `json:"fieldMapping,omitempty" url:"fieldMapping,omitempty"`
	UnmappedSourceFields      []*SourceField      `json:"unmappedSourceFields,omitempty" url:"unmappedSourceFields,omitempty"`
	UnmappedDestinationFields []*DestinationField `json:"unmappedDestinationFields,omitempty" url:"unmappedDestinationFields,omitempty"`
	ProgramId                 *string             `json:"programId,omitempty" url:"programId,omitempty"`
	// contains filtered or unexported fields
}

The execution plan for a job, for example, for a map job, the execution plan is the mapping of the source sheet to the destination sheet.

func (*JobExecutionPlan) GetExtraProperties

func (j *JobExecutionPlan) GetExtraProperties() map[string]interface{}

func (*JobExecutionPlan) GetFieldMapping

func (j *JobExecutionPlan) GetFieldMapping() []*Edge

func (*JobExecutionPlan) GetProgramId

func (j *JobExecutionPlan) GetProgramId() *string

func (*JobExecutionPlan) GetUnmappedDestinationFields

func (j *JobExecutionPlan) GetUnmappedDestinationFields() []*DestinationField

func (*JobExecutionPlan) GetUnmappedSourceFields

func (j *JobExecutionPlan) GetUnmappedSourceFields() []*SourceField

func (*JobExecutionPlan) String

func (j *JobExecutionPlan) String() string

func (*JobExecutionPlan) UnmarshalJSON

func (j *JobExecutionPlan) UnmarshalJSON(data []byte) error

type JobExecutionPlanConfig

type JobExecutionPlanConfig struct {
	FieldMapping              []*Edge             `json:"fieldMapping,omitempty" url:"fieldMapping,omitempty"`
	UnmappedSourceFields      []*SourceField      `json:"unmappedSourceFields,omitempty" url:"unmappedSourceFields,omitempty"`
	UnmappedDestinationFields []*DestinationField `json:"unmappedDestinationFields,omitempty" url:"unmappedDestinationFields,omitempty"`
	ProgramId                 *string             `json:"programId,omitempty" url:"programId,omitempty"`
	// contains filtered or unexported fields
}

The execution plan for a job, for example, for a map job, the execution plan is the mapping of the source sheet to the destination sheet.

func (*JobExecutionPlanConfig) GetExtraProperties

func (j *JobExecutionPlanConfig) GetExtraProperties() map[string]interface{}

func (*JobExecutionPlanConfig) GetFieldMapping

func (j *JobExecutionPlanConfig) GetFieldMapping() []*Edge

func (*JobExecutionPlanConfig) GetProgramId

func (j *JobExecutionPlanConfig) GetProgramId() *string

func (*JobExecutionPlanConfig) GetUnmappedDestinationFields

func (j *JobExecutionPlanConfig) GetUnmappedDestinationFields() []*DestinationField

func (*JobExecutionPlanConfig) GetUnmappedSourceFields

func (j *JobExecutionPlanConfig) GetUnmappedSourceFields() []*SourceField

func (*JobExecutionPlanConfig) String

func (j *JobExecutionPlanConfig) String() string

func (*JobExecutionPlanConfig) UnmarshalJSON

func (j *JobExecutionPlanConfig) UnmarshalJSON(data []byte) error

type JobExecutionPlanConfigRequest

type JobExecutionPlanConfigRequest struct {
	FieldMapping              []*Edge             `json:"fieldMapping,omitempty" url:"fieldMapping,omitempty"`
	UnmappedSourceFields      []*SourceField      `json:"unmappedSourceFields,omitempty" url:"unmappedSourceFields,omitempty"`
	UnmappedDestinationFields []*DestinationField `json:"unmappedDestinationFields,omitempty" url:"unmappedDestinationFields,omitempty"`
	ProgramId                 *string             `json:"programId,omitempty" url:"programId,omitempty"`
	FileId                    FileId              `json:"fileId" url:"fileId"`
	JobId                     JobId               `json:"jobId" url:"jobId"`
	// contains filtered or unexported fields
}

func (*JobExecutionPlanConfigRequest) GetExtraProperties

func (j *JobExecutionPlanConfigRequest) GetExtraProperties() map[string]interface{}

func (*JobExecutionPlanConfigRequest) GetFieldMapping

func (j *JobExecutionPlanConfigRequest) GetFieldMapping() []*Edge

func (*JobExecutionPlanConfigRequest) GetFileId

func (j *JobExecutionPlanConfigRequest) GetFileId() FileId

func (*JobExecutionPlanConfigRequest) GetJobId

func (j *JobExecutionPlanConfigRequest) GetJobId() JobId

func (*JobExecutionPlanConfigRequest) GetProgramId

func (j *JobExecutionPlanConfigRequest) GetProgramId() *string

func (*JobExecutionPlanConfigRequest) GetUnmappedDestinationFields

func (j *JobExecutionPlanConfigRequest) GetUnmappedDestinationFields() []*DestinationField

func (*JobExecutionPlanConfigRequest) GetUnmappedSourceFields

func (j *JobExecutionPlanConfigRequest) GetUnmappedSourceFields() []*SourceField

func (*JobExecutionPlanConfigRequest) String

func (j *JobExecutionPlanConfigRequest) String() string

func (*JobExecutionPlanConfigRequest) UnmarshalJSON

func (j *JobExecutionPlanConfigRequest) UnmarshalJSON(data []byte) error

type JobExecutionPlanRequest

type JobExecutionPlanRequest struct {
	FieldMapping              []*Edge             `json:"fieldMapping,omitempty" url:"fieldMapping,omitempty"`
	UnmappedSourceFields      []*SourceField      `json:"unmappedSourceFields,omitempty" url:"unmappedSourceFields,omitempty"`
	UnmappedDestinationFields []*DestinationField `json:"unmappedDestinationFields,omitempty" url:"unmappedDestinationFields,omitempty"`
	ProgramId                 *string             `json:"programId,omitempty" url:"programId,omitempty"`
	FileId                    FileId              `json:"fileId" url:"fileId"`
	JobId                     JobId               `json:"jobId" url:"jobId"`
	// contains filtered or unexported fields
}

func (*JobExecutionPlanRequest) GetExtraProperties

func (j *JobExecutionPlanRequest) GetExtraProperties() map[string]interface{}

func (*JobExecutionPlanRequest) GetFieldMapping

func (j *JobExecutionPlanRequest) GetFieldMapping() []*Edge

func (*JobExecutionPlanRequest) GetFileId

func (j *JobExecutionPlanRequest) GetFileId() FileId

func (*JobExecutionPlanRequest) GetJobId

func (j *JobExecutionPlanRequest) GetJobId() JobId

func (*JobExecutionPlanRequest) GetProgramId

func (j *JobExecutionPlanRequest) GetProgramId() *string

func (*JobExecutionPlanRequest) GetUnmappedDestinationFields

func (j *JobExecutionPlanRequest) GetUnmappedDestinationFields() []*DestinationField

func (*JobExecutionPlanRequest) GetUnmappedSourceFields

func (j *JobExecutionPlanRequest) GetUnmappedSourceFields() []*SourceField

func (*JobExecutionPlanRequest) String

func (j *JobExecutionPlanRequest) String() string

func (*JobExecutionPlanRequest) UnmarshalJSON

func (j *JobExecutionPlanRequest) UnmarshalJSON(data []byte) error

type JobId

type JobId = string

Pipeline Job ID

type JobMode

type JobMode string

the mode of the job

const (
	JobModeForeground      JobMode = "foreground"
	JobModeBackground      JobMode = "background"
	JobModeToolbarBlocking JobMode = "toolbarBlocking"
)

func NewJobModeFromString

func NewJobModeFromString(s string) (JobMode, error)

func (JobMode) Ptr

func (j JobMode) Ptr() *JobMode

type JobOutcome

type JobOutcome struct {
	Acknowledge       *bool              `json:"acknowledge,omitempty" url:"acknowledge,omitempty"`
	Trigger           *JobOutcomeTrigger `json:"trigger,omitempty" url:"trigger,omitempty"`
	ButtonText        *string            `json:"buttonText,omitempty" url:"buttonText,omitempty"`
	Next              *JobOutcomeNext    `json:"next,omitempty" url:"next,omitempty"`
	Heading           *string            `json:"heading,omitempty" url:"heading,omitempty"`
	Message           *string            `json:"message,omitempty" url:"message,omitempty"`
	HideDefaultButton *bool              `json:"hideDefaultButton,omitempty" url:"hideDefaultButton,omitempty"`
	// contains filtered or unexported fields
}

Outcome summary of a job

func (*JobOutcome) GetAcknowledge

func (j *JobOutcome) GetAcknowledge() *bool

func (*JobOutcome) GetButtonText

func (j *JobOutcome) GetButtonText() *string

func (*JobOutcome) GetExtraProperties

func (j *JobOutcome) GetExtraProperties() map[string]interface{}

func (*JobOutcome) GetHeading

func (j *JobOutcome) GetHeading() *string

func (*JobOutcome) GetHideDefaultButton

func (j *JobOutcome) GetHideDefaultButton() *bool

func (*JobOutcome) GetMessage

func (j *JobOutcome) GetMessage() *string

func (*JobOutcome) GetNext

func (j *JobOutcome) GetNext() *JobOutcomeNext

func (*JobOutcome) GetTrigger

func (j *JobOutcome) GetTrigger() *JobOutcomeTrigger

func (*JobOutcome) String

func (j *JobOutcome) String() string

func (*JobOutcome) UnmarshalJSON

func (j *JobOutcome) UnmarshalJSON(data []byte) error

type JobOutcomeNext

type JobOutcomeNext struct {
	Type     string
	Id       *JobOutcomeNextId
	Url      *JobOutcomeNextUrl
	Download *JobOutcomeNextDownload
	Files    *JobOutcomeNextFiles
	Wait     *JobOutcomeNextWait
	Snapshot *JobOutcomeNextSnapshot
	Retry    *JobOutcomeNextRetry
	View     *JobOutcomeNextView
}

func NewJobOutcomeNextFromDownload

func NewJobOutcomeNextFromDownload(value *JobOutcomeNextDownload) *JobOutcomeNext

func NewJobOutcomeNextFromFiles

func NewJobOutcomeNextFromFiles(value *JobOutcomeNextFiles) *JobOutcomeNext

func NewJobOutcomeNextFromId

func NewJobOutcomeNextFromId(value *JobOutcomeNextId) *JobOutcomeNext

func NewJobOutcomeNextFromRetry

func NewJobOutcomeNextFromRetry(value *JobOutcomeNextRetry) *JobOutcomeNext

func NewJobOutcomeNextFromSnapshot

func NewJobOutcomeNextFromSnapshot(value *JobOutcomeNextSnapshot) *JobOutcomeNext

func NewJobOutcomeNextFromUrl

func NewJobOutcomeNextFromUrl(value *JobOutcomeNextUrl) *JobOutcomeNext

func NewJobOutcomeNextFromView

func NewJobOutcomeNextFromView(value *JobOutcomeNextView) *JobOutcomeNext

func NewJobOutcomeNextFromWait

func NewJobOutcomeNextFromWait(value *JobOutcomeNextWait) *JobOutcomeNext

func (*JobOutcomeNext) Accept

func (j *JobOutcomeNext) Accept(visitor JobOutcomeNextVisitor) error

func (*JobOutcomeNext) GetDownload

func (j *JobOutcomeNext) GetDownload() *JobOutcomeNextDownload

func (*JobOutcomeNext) GetFiles

func (j *JobOutcomeNext) GetFiles() *JobOutcomeNextFiles

func (*JobOutcomeNext) GetId

func (j *JobOutcomeNext) GetId() *JobOutcomeNextId

func (*JobOutcomeNext) GetRetry

func (j *JobOutcomeNext) GetRetry() *JobOutcomeNextRetry

func (*JobOutcomeNext) GetSnapshot

func (j *JobOutcomeNext) GetSnapshot() *JobOutcomeNextSnapshot

func (*JobOutcomeNext) GetType

func (j *JobOutcomeNext) GetType() string

func (*JobOutcomeNext) GetUrl

func (j *JobOutcomeNext) GetUrl() *JobOutcomeNextUrl

func (*JobOutcomeNext) GetView

func (j *JobOutcomeNext) GetView() *JobOutcomeNextView

func (*JobOutcomeNext) GetWait

func (j *JobOutcomeNext) GetWait() *JobOutcomeNextWait

func (JobOutcomeNext) MarshalJSON

func (j JobOutcomeNext) MarshalJSON() ([]byte, error)

func (*JobOutcomeNext) UnmarshalJSON

func (j *JobOutcomeNext) UnmarshalJSON(data []byte) error

type JobOutcomeNextDownload

type JobOutcomeNextDownload struct {
	Url      string  `json:"url" url:"url"`
	Label    *string `json:"label,omitempty" url:"label,omitempty"`
	FileName *string `json:"fileName,omitempty" url:"fileName,omitempty"`
	// contains filtered or unexported fields
}

func (*JobOutcomeNextDownload) GetExtraProperties

func (j *JobOutcomeNextDownload) GetExtraProperties() map[string]interface{}

func (*JobOutcomeNextDownload) GetFileName

func (j *JobOutcomeNextDownload) GetFileName() *string

func (*JobOutcomeNextDownload) GetLabel

func (j *JobOutcomeNextDownload) GetLabel() *string

func (*JobOutcomeNextDownload) GetUrl

func (j *JobOutcomeNextDownload) GetUrl() string

func (*JobOutcomeNextDownload) String

func (j *JobOutcomeNextDownload) String() string

func (*JobOutcomeNextDownload) UnmarshalJSON

func (j *JobOutcomeNextDownload) UnmarshalJSON(data []byte) error

type JobOutcomeNextFileObject

type JobOutcomeNextFileObject struct {
	FileId string  `json:"fileId" url:"fileId"`
	Label  *string `json:"label,omitempty" url:"label,omitempty"`
	// contains filtered or unexported fields
}

func (*JobOutcomeNextFileObject) GetExtraProperties

func (j *JobOutcomeNextFileObject) GetExtraProperties() map[string]interface{}

func (*JobOutcomeNextFileObject) GetFileId

func (j *JobOutcomeNextFileObject) GetFileId() string

func (*JobOutcomeNextFileObject) GetLabel

func (j *JobOutcomeNextFileObject) GetLabel() *string

func (*JobOutcomeNextFileObject) String

func (j *JobOutcomeNextFileObject) String() string

func (*JobOutcomeNextFileObject) UnmarshalJSON

func (j *JobOutcomeNextFileObject) UnmarshalJSON(data []byte) error

type JobOutcomeNextFiles

type JobOutcomeNextFiles struct {
	Files []*JobOutcomeNextFileObject `json:"files,omitempty" url:"files,omitempty"`
	Label *string                     `json:"label,omitempty" url:"label,omitempty"`
	// contains filtered or unexported fields
}

func (*JobOutcomeNextFiles) GetExtraProperties

func (j *JobOutcomeNextFiles) GetExtraProperties() map[string]interface{}

func (*JobOutcomeNextFiles) GetFiles

func (j *JobOutcomeNextFiles) GetFiles() []*JobOutcomeNextFileObject

func (*JobOutcomeNextFiles) GetLabel

func (j *JobOutcomeNextFiles) GetLabel() *string

func (*JobOutcomeNextFiles) String

func (j *JobOutcomeNextFiles) String() string

func (*JobOutcomeNextFiles) UnmarshalJSON

func (j *JobOutcomeNextFiles) UnmarshalJSON(data []byte) error

type JobOutcomeNextId

type JobOutcomeNextId struct {
	Id    string  `json:"id" url:"id"`
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	Path  *string `json:"path,omitempty" url:"path,omitempty"`
	Query *string `json:"query,omitempty" url:"query,omitempty"`
	// contains filtered or unexported fields
}

func (*JobOutcomeNextId) GetExtraProperties

func (j *JobOutcomeNextId) GetExtraProperties() map[string]interface{}

func (*JobOutcomeNextId) GetId

func (j *JobOutcomeNextId) GetId() string

func (*JobOutcomeNextId) GetLabel

func (j *JobOutcomeNextId) GetLabel() *string

func (*JobOutcomeNextId) GetPath

func (j *JobOutcomeNextId) GetPath() *string

func (*JobOutcomeNextId) GetQuery

func (j *JobOutcomeNextId) GetQuery() *string

func (*JobOutcomeNextId) String

func (j *JobOutcomeNextId) String() string

func (*JobOutcomeNextId) UnmarshalJSON

func (j *JobOutcomeNextId) UnmarshalJSON(data []byte) error

type JobOutcomeNextRetry

type JobOutcomeNextRetry struct {
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// contains filtered or unexported fields
}

func (*JobOutcomeNextRetry) GetExtraProperties

func (j *JobOutcomeNextRetry) GetExtraProperties() map[string]interface{}

func (*JobOutcomeNextRetry) GetLabel

func (j *JobOutcomeNextRetry) GetLabel() *string

func (*JobOutcomeNextRetry) String

func (j *JobOutcomeNextRetry) String() string

func (*JobOutcomeNextRetry) UnmarshalJSON

func (j *JobOutcomeNextRetry) UnmarshalJSON(data []byte) error

type JobOutcomeNextSnapshot

type JobOutcomeNextSnapshot struct {
	SnapshotId string `json:"snapshotId" url:"snapshotId"`
	SheetId    string `json:"sheetId" url:"sheetId"`
	// contains filtered or unexported fields
}

func (*JobOutcomeNextSnapshot) GetExtraProperties

func (j *JobOutcomeNextSnapshot) GetExtraProperties() map[string]interface{}

func (*JobOutcomeNextSnapshot) GetSheetId

func (j *JobOutcomeNextSnapshot) GetSheetId() string

func (*JobOutcomeNextSnapshot) GetSnapshotId

func (j *JobOutcomeNextSnapshot) GetSnapshotId() string

func (*JobOutcomeNextSnapshot) String

func (j *JobOutcomeNextSnapshot) String() string

func (*JobOutcomeNextSnapshot) UnmarshalJSON

func (j *JobOutcomeNextSnapshot) UnmarshalJSON(data []byte) error

type JobOutcomeNextUrl

type JobOutcomeNextUrl struct {
	Url   string  `json:"url" url:"url"`
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// contains filtered or unexported fields
}

func (*JobOutcomeNextUrl) GetExtraProperties

func (j *JobOutcomeNextUrl) GetExtraProperties() map[string]interface{}

func (*JobOutcomeNextUrl) GetLabel

func (j *JobOutcomeNextUrl) GetLabel() *string

func (*JobOutcomeNextUrl) GetUrl

func (j *JobOutcomeNextUrl) GetUrl() string

func (*JobOutcomeNextUrl) String

func (j *JobOutcomeNextUrl) String() string

func (*JobOutcomeNextUrl) UnmarshalJSON

func (j *JobOutcomeNextUrl) UnmarshalJSON(data []byte) error

type JobOutcomeNextView

type JobOutcomeNextView struct {
	SheetId string `json:"sheetId" url:"sheetId"`
	// An array of field keys from the sheet
	HiddenColumns []string `json:"hiddenColumns,omitempty" url:"hiddenColumns,omitempty"`
	Label         *string  `json:"label,omitempty" url:"label,omitempty"`
	// contains filtered or unexported fields
}

func (*JobOutcomeNextView) GetExtraProperties

func (j *JobOutcomeNextView) GetExtraProperties() map[string]interface{}

func (*JobOutcomeNextView) GetHiddenColumns

func (j *JobOutcomeNextView) GetHiddenColumns() []string

func (*JobOutcomeNextView) GetLabel

func (j *JobOutcomeNextView) GetLabel() *string

func (*JobOutcomeNextView) GetSheetId

func (j *JobOutcomeNextView) GetSheetId() string

func (*JobOutcomeNextView) String

func (j *JobOutcomeNextView) String() string

func (*JobOutcomeNextView) UnmarshalJSON

func (j *JobOutcomeNextView) UnmarshalJSON(data []byte) error

type JobOutcomeNextVisitor

type JobOutcomeNextVisitor interface {
	VisitId(*JobOutcomeNextId) error
	VisitUrl(*JobOutcomeNextUrl) error
	VisitDownload(*JobOutcomeNextDownload) error
	VisitFiles(*JobOutcomeNextFiles) error
	VisitWait(*JobOutcomeNextWait) error
	VisitSnapshot(*JobOutcomeNextSnapshot) error
	VisitRetry(*JobOutcomeNextRetry) error
	VisitView(*JobOutcomeNextView) error
}

type JobOutcomeNextWait

type JobOutcomeNextWait struct {
	Fade     *bool `json:"fade,omitempty" url:"fade,omitempty"`
	Confetti *bool `json:"confetti,omitempty" url:"confetti,omitempty"`
	// contains filtered or unexported fields
}

func (*JobOutcomeNextWait) GetConfetti

func (j *JobOutcomeNextWait) GetConfetti() *bool

func (*JobOutcomeNextWait) GetExtraProperties

func (j *JobOutcomeNextWait) GetExtraProperties() map[string]interface{}

func (*JobOutcomeNextWait) GetFade

func (j *JobOutcomeNextWait) GetFade() *bool

func (*JobOutcomeNextWait) String

func (j *JobOutcomeNextWait) String() string

func (*JobOutcomeNextWait) UnmarshalJSON

func (j *JobOutcomeNextWait) UnmarshalJSON(data []byte) error

type JobOutcomeTrigger

type JobOutcomeTrigger struct {
	JobOutcomeTriggerType    JobOutcomeTriggerType
	JobOutcomeTriggerDetails *JobOutcomeTriggerDetails
	// contains filtered or unexported fields
}

func NewJobOutcomeTriggerFromJobOutcomeTriggerDetails

func NewJobOutcomeTriggerFromJobOutcomeTriggerDetails(value *JobOutcomeTriggerDetails) *JobOutcomeTrigger

func NewJobOutcomeTriggerFromJobOutcomeTriggerType

func NewJobOutcomeTriggerFromJobOutcomeTriggerType(value JobOutcomeTriggerType) *JobOutcomeTrigger

func (*JobOutcomeTrigger) Accept

func (j *JobOutcomeTrigger) Accept(visitor JobOutcomeTriggerVisitor) error

func (*JobOutcomeTrigger) GetJobOutcomeTriggerDetails

func (j *JobOutcomeTrigger) GetJobOutcomeTriggerDetails() *JobOutcomeTriggerDetails

func (*JobOutcomeTrigger) GetJobOutcomeTriggerType

func (j *JobOutcomeTrigger) GetJobOutcomeTriggerType() JobOutcomeTriggerType

func (JobOutcomeTrigger) MarshalJSON

func (j JobOutcomeTrigger) MarshalJSON() ([]byte, error)

func (*JobOutcomeTrigger) UnmarshalJSON

func (j *JobOutcomeTrigger) UnmarshalJSON(data []byte) error

type JobOutcomeTriggerAudience

type JobOutcomeTriggerAudience string

For whom the job outcome's next effect should be triggered automatically

const (
	JobOutcomeTriggerAudienceOriginator JobOutcomeTriggerAudience = "originator"
	JobOutcomeTriggerAudienceAll        JobOutcomeTriggerAudience = "all"
)

func NewJobOutcomeTriggerAudienceFromString

func NewJobOutcomeTriggerAudienceFromString(s string) (JobOutcomeTriggerAudience, error)

func (JobOutcomeTriggerAudience) Ptr

func (j JobOutcomeTriggerAudience) Ptr() *JobOutcomeTriggerAudience

type JobOutcomeTriggerDetails

type JobOutcomeTriggerDetails struct {
	Type     JobOutcomeTriggerType      `json:"type" url:"type"`
	Audience *JobOutcomeTriggerAudience `json:"audience,omitempty" url:"audience,omitempty"`
	// contains filtered or unexported fields
}

Details about the trigger for the job outcome

func (*JobOutcomeTriggerDetails) GetAudience

func (j *JobOutcomeTriggerDetails) GetAudience() *JobOutcomeTriggerAudience

func (*JobOutcomeTriggerDetails) GetExtraProperties

func (j *JobOutcomeTriggerDetails) GetExtraProperties() map[string]interface{}

func (*JobOutcomeTriggerDetails) GetType

func (j *JobOutcomeTriggerDetails) GetType() JobOutcomeTriggerType

func (*JobOutcomeTriggerDetails) String

func (j *JobOutcomeTriggerDetails) String() string

func (*JobOutcomeTriggerDetails) UnmarshalJSON

func (j *JobOutcomeTriggerDetails) UnmarshalJSON(data []byte) error

type JobOutcomeTriggerType

type JobOutcomeTriggerType string

Whether a job outcome's effect should be triggered automatically

const (
	JobOutcomeTriggerTypeManual          JobOutcomeTriggerType = "manual"
	JobOutcomeTriggerTypeAutomatic       JobOutcomeTriggerType = "automatic"
	JobOutcomeTriggerTypeAutomaticSilent JobOutcomeTriggerType = "automatic_silent"
)

func NewJobOutcomeTriggerTypeFromString

func NewJobOutcomeTriggerTypeFromString(s string) (JobOutcomeTriggerType, error)

func (JobOutcomeTriggerType) Ptr

func (j JobOutcomeTriggerType) Ptr() *JobOutcomeTriggerType

type JobOutcomeTriggerVisitor

type JobOutcomeTriggerVisitor interface {
	VisitJobOutcomeTriggerType(JobOutcomeTriggerType) error
	VisitJobOutcomeTriggerDetails(*JobOutcomeTriggerDetails) error
}

type JobPartExecution

type JobPartExecution string

const (
	JobPartExecutionSequential JobPartExecution = "sequential"
	JobPartExecutionParallel   JobPartExecution = "parallel"
)

func NewJobPartExecutionFromString

func NewJobPartExecutionFromString(s string) (JobPartExecution, error)

func (JobPartExecution) Ptr

func (j JobPartExecution) Ptr() *JobPartExecution

type JobParts

type JobParts struct {
	Integer       int
	JobPartsArray JobPartsArray
	// contains filtered or unexported fields
}

Info about the number of parts to create

func NewJobPartsFromInteger

func NewJobPartsFromInteger(value int) *JobParts

func NewJobPartsFromJobPartsArray

func NewJobPartsFromJobPartsArray(value JobPartsArray) *JobParts

func (*JobParts) Accept

func (j *JobParts) Accept(visitor JobPartsVisitor) error

func (*JobParts) GetInteger

func (j *JobParts) GetInteger() int

func (*JobParts) GetJobPartsArray

func (j *JobParts) GetJobPartsArray() JobPartsArray

func (JobParts) MarshalJSON

func (j JobParts) MarshalJSON() ([]byte, error)

func (*JobParts) UnmarshalJSON

func (j *JobParts) UnmarshalJSON(data []byte) error

type JobPartsArray

type JobPartsArray = []map[string]interface{}

Data for each of the job parts

type JobPartsVisitor

type JobPartsVisitor interface {
	VisitInteger(int) error
	VisitJobPartsArray(JobPartsArray) error
}

type JobPlan

type JobPlan struct {
	Job  *Job              `json:"job,omitempty" url:"job,omitempty"`
	Plan *JobExecutionPlan `json:"plan,omitempty" url:"plan,omitempty"`
	// contains filtered or unexported fields
}

The job/plan tuple that contains the full plan and the jobs status

func (*JobPlan) GetExtraProperties

func (j *JobPlan) GetExtraProperties() map[string]interface{}

func (*JobPlan) GetJob

func (j *JobPlan) GetJob() *Job

func (*JobPlan) GetPlan

func (j *JobPlan) GetPlan() *JobExecutionPlan

func (*JobPlan) String

func (j *JobPlan) String() string

func (*JobPlan) UnmarshalJSON

func (j *JobPlan) UnmarshalJSON(data []byte) error

type JobPlanResponse

type JobPlanResponse struct {
	Data *JobPlan `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*JobPlanResponse) GetData

func (j *JobPlanResponse) GetData() *JobPlan

func (*JobPlanResponse) GetExtraProperties

func (j *JobPlanResponse) GetExtraProperties() map[string]interface{}

func (*JobPlanResponse) String

func (j *JobPlanResponse) String() string

func (*JobPlanResponse) UnmarshalJSON

func (j *JobPlanResponse) UnmarshalJSON(data []byte) error

type JobResponse

type JobResponse struct {
	Data *Job `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*JobResponse) GetData

func (j *JobResponse) GetData() *Job

func (*JobResponse) GetExtraProperties

func (j *JobResponse) GetExtraProperties() map[string]interface{}

func (*JobResponse) String

func (j *JobResponse) String() string

func (*JobResponse) UnmarshalJSON

func (j *JobResponse) UnmarshalJSON(data []byte) error

type JobSource

type JobSource = string

The id of a file, workbook, sheet, or app

type JobSplitDetails

type JobSplitDetails struct {
	Parts         *JobParts `json:"parts,omitempty" url:"parts,omitempty"`
	RunInParallel *bool     `json:"runInParallel,omitempty" url:"runInParallel,omitempty"`
	// contains filtered or unexported fields
}

Info about the reason the job was split

func (*JobSplitDetails) GetExtraProperties

func (j *JobSplitDetails) GetExtraProperties() map[string]interface{}

func (*JobSplitDetails) GetParts

func (j *JobSplitDetails) GetParts() *JobParts

func (*JobSplitDetails) GetRunInParallel

func (j *JobSplitDetails) GetRunInParallel() *bool

func (*JobSplitDetails) String

func (j *JobSplitDetails) String() string

func (*JobSplitDetails) UnmarshalJSON

func (j *JobSplitDetails) UnmarshalJSON(data []byte) error

type JobStatus

type JobStatus string

the status of the job

const (
	JobStatusCreated   JobStatus = "created"
	JobStatusPlanning  JobStatus = "planning"
	JobStatusScheduled JobStatus = "scheduled"
	JobStatusReady     JobStatus = "ready"
	JobStatusExecuting JobStatus = "executing"
	JobStatusComplete  JobStatus = "complete"
	JobStatusFailed    JobStatus = "failed"
	JobStatusCanceled  JobStatus = "canceled"
	JobStatusWaiting   JobStatus = "waiting"
)

func NewJobStatusFromString

func NewJobStatusFromString(s string) (JobStatus, error)

func (JobStatus) Ptr

func (j JobStatus) Ptr() *JobStatus

type JobSubject

type JobSubject struct {
	Type       string
	Resource   *ResourceJobSubject
	Collection *CollectionJobSubject
}

Subject parameters for this job type

func NewJobSubjectFromCollection

func NewJobSubjectFromCollection(value *CollectionJobSubject) *JobSubject

func NewJobSubjectFromResource

func NewJobSubjectFromResource(value *ResourceJobSubject) *JobSubject

func (*JobSubject) Accept

func (j *JobSubject) Accept(visitor JobSubjectVisitor) error

func (*JobSubject) GetCollection

func (j *JobSubject) GetCollection() *CollectionJobSubject

func (*JobSubject) GetResource

func (j *JobSubject) GetResource() *ResourceJobSubject

func (*JobSubject) GetType

func (j *JobSubject) GetType() string

func (JobSubject) MarshalJSON

func (j JobSubject) MarshalJSON() ([]byte, error)

func (*JobSubject) UnmarshalJSON

func (j *JobSubject) UnmarshalJSON(data []byte) error

type JobSubjectVisitor

type JobSubjectVisitor interface {
	VisitResource(*ResourceJobSubject) error
	VisitCollection(*CollectionJobSubject) error
}

type JobType

type JobType string

The type of job

const (
	JobTypeFile     JobType = "file"
	JobTypeWorkbook JobType = "workbook"
	JobTypeSheet    JobType = "sheet"
	JobTypeSpace    JobType = "space"
	JobTypeDocument JobType = "document"
	JobTypeApp      JobType = "app"
)

func NewJobTypeFromString

func NewJobTypeFromString(s string) (JobType, error)

func (JobType) Ptr

func (j JobType) Ptr() *JobType

type JobUpdate

type JobUpdate struct {
	Config *JobUpdateConfig `json:"config,omitempty" url:"config,omitempty"`
	// the status of the job
	Status *JobStatus `json:"status,omitempty" url:"status,omitempty"`
	// the progress of the job. Whole number between 0 and 100
	Progress *int `json:"progress,omitempty" url:"progress,omitempty"`
	// the time that the job's outcome has been acknowledged by a user
	OutcomeAcknowledgedAt *time.Time `json:"outcomeAcknowledgedAt,omitempty" url:"outcomeAcknowledgedAt,omitempty"`
	// Current status of job in text
	Info *string `json:"info,omitempty" url:"info,omitempty"`
	// Additional metadata for the job
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// contains filtered or unexported fields
}

A single unit of work that will be executed

func (*JobUpdate) GetConfig

func (j *JobUpdate) GetConfig() *JobUpdateConfig

func (*JobUpdate) GetExtraProperties

func (j *JobUpdate) GetExtraProperties() map[string]interface{}

func (*JobUpdate) GetInfo

func (j *JobUpdate) GetInfo() *string

func (*JobUpdate) GetMetadata

func (j *JobUpdate) GetMetadata() map[string]interface{}

func (*JobUpdate) GetOutcomeAcknowledgedAt

func (j *JobUpdate) GetOutcomeAcknowledgedAt() *time.Time

func (*JobUpdate) GetProgress

func (j *JobUpdate) GetProgress() *int

func (*JobUpdate) GetStatus

func (j *JobUpdate) GetStatus() *JobStatus

func (*JobUpdate) MarshalJSON

func (j *JobUpdate) MarshalJSON() ([]byte, error)

func (*JobUpdate) String

func (j *JobUpdate) String() string

func (*JobUpdate) UnmarshalJSON

func (j *JobUpdate) UnmarshalJSON(data []byte) error

type JobUpdateConfig

type JobUpdateConfig struct {
	DeleteRecordsJobConfig                  *DeleteRecordsJobConfig
	FileJobConfig                           *FileJobConfig
	PipelineJobConfig                       *PipelineJobConfig
	ExportJobConfig                         *ExportJobConfig
	MutateJobConfig                         *MutateJobConfig
	FindAndReplaceJobConfig                 *FindAndReplaceJobConfig
	MappingProgramJobConfig                 *MappingProgramJobConfig
	AiGenerateBlueprintJobConfig            *AiGenerateBlueprintJobConfig
	AppAutobuildDeployJobConfig             *AppAutobuildDeployJobConfig
	AiGenerateSampleDataJobConfig           *AiGenerateSampleDataJobConfig
	AiGenerateBlueprintConstraintsJobConfig *AiGenerateBlueprintConstraintsJobConfig
	AiGenerateConstraintJobConfig           *AiGenerateConstraintJobConfig
	AiRuleCreationJobConfig                 *AiRuleCreationJobConfig
	EmptyObject                             *EmptyObject
	AddRecordsToDataClipJobConfig           *AddRecordsToDataClipJobConfig
	UpdateDataClipResolutionsJobConfig      *UpdateDataClipResolutionsJobConfig
	// contains filtered or unexported fields
}

func NewJobUpdateConfigFromAddRecordsToDataClipJobConfig

func NewJobUpdateConfigFromAddRecordsToDataClipJobConfig(value *AddRecordsToDataClipJobConfig) *JobUpdateConfig

func NewJobUpdateConfigFromAiGenerateBlueprintConstraintsJobConfig

func NewJobUpdateConfigFromAiGenerateBlueprintConstraintsJobConfig(value *AiGenerateBlueprintConstraintsJobConfig) *JobUpdateConfig

func NewJobUpdateConfigFromAiGenerateBlueprintJobConfig

func NewJobUpdateConfigFromAiGenerateBlueprintJobConfig(value *AiGenerateBlueprintJobConfig) *JobUpdateConfig

func NewJobUpdateConfigFromAiGenerateConstraintJobConfig

func NewJobUpdateConfigFromAiGenerateConstraintJobConfig(value *AiGenerateConstraintJobConfig) *JobUpdateConfig

func NewJobUpdateConfigFromAiGenerateSampleDataJobConfig

func NewJobUpdateConfigFromAiGenerateSampleDataJobConfig(value *AiGenerateSampleDataJobConfig) *JobUpdateConfig

func NewJobUpdateConfigFromAiRuleCreationJobConfig

func NewJobUpdateConfigFromAiRuleCreationJobConfig(value *AiRuleCreationJobConfig) *JobUpdateConfig

func NewJobUpdateConfigFromAppAutobuildDeployJobConfig

func NewJobUpdateConfigFromAppAutobuildDeployJobConfig(value *AppAutobuildDeployJobConfig) *JobUpdateConfig

func NewJobUpdateConfigFromDeleteRecordsJobConfig

func NewJobUpdateConfigFromDeleteRecordsJobConfig(value *DeleteRecordsJobConfig) *JobUpdateConfig

func NewJobUpdateConfigFromEmptyObject

func NewJobUpdateConfigFromEmptyObject(value *EmptyObject) *JobUpdateConfig

func NewJobUpdateConfigFromExportJobConfig

func NewJobUpdateConfigFromExportJobConfig(value *ExportJobConfig) *JobUpdateConfig

func NewJobUpdateConfigFromFileJobConfig

func NewJobUpdateConfigFromFileJobConfig(value *FileJobConfig) *JobUpdateConfig

func NewJobUpdateConfigFromFindAndReplaceJobConfig

func NewJobUpdateConfigFromFindAndReplaceJobConfig(value *FindAndReplaceJobConfig) *JobUpdateConfig

func NewJobUpdateConfigFromMappingProgramJobConfig

func NewJobUpdateConfigFromMappingProgramJobConfig(value *MappingProgramJobConfig) *JobUpdateConfig

func NewJobUpdateConfigFromMutateJobConfig

func NewJobUpdateConfigFromMutateJobConfig(value *MutateJobConfig) *JobUpdateConfig

func NewJobUpdateConfigFromPipelineJobConfig

func NewJobUpdateConfigFromPipelineJobConfig(value *PipelineJobConfig) *JobUpdateConfig

func NewJobUpdateConfigFromUpdateDataClipResolutionsJobConfig

func NewJobUpdateConfigFromUpdateDataClipResolutionsJobConfig(value *UpdateDataClipResolutionsJobConfig) *JobUpdateConfig

func (*JobUpdateConfig) Accept

func (j *JobUpdateConfig) Accept(visitor JobUpdateConfigVisitor) error

func (*JobUpdateConfig) GetAddRecordsToDataClipJobConfig

func (j *JobUpdateConfig) GetAddRecordsToDataClipJobConfig() *AddRecordsToDataClipJobConfig

func (*JobUpdateConfig) GetAiGenerateBlueprintConstraintsJobConfig

func (j *JobUpdateConfig) GetAiGenerateBlueprintConstraintsJobConfig() *AiGenerateBlueprintConstraintsJobConfig

func (*JobUpdateConfig) GetAiGenerateBlueprintJobConfig

func (j *JobUpdateConfig) GetAiGenerateBlueprintJobConfig() *AiGenerateBlueprintJobConfig

func (*JobUpdateConfig) GetAiGenerateConstraintJobConfig

func (j *JobUpdateConfig) GetAiGenerateConstraintJobConfig() *AiGenerateConstraintJobConfig

func (*JobUpdateConfig) GetAiGenerateSampleDataJobConfig

func (j *JobUpdateConfig) GetAiGenerateSampleDataJobConfig() *AiGenerateSampleDataJobConfig

func (*JobUpdateConfig) GetAiRuleCreationJobConfig

func (j *JobUpdateConfig) GetAiRuleCreationJobConfig() *AiRuleCreationJobConfig

func (*JobUpdateConfig) GetAppAutobuildDeployJobConfig

func (j *JobUpdateConfig) GetAppAutobuildDeployJobConfig() *AppAutobuildDeployJobConfig

func (*JobUpdateConfig) GetDeleteRecordsJobConfig

func (j *JobUpdateConfig) GetDeleteRecordsJobConfig() *DeleteRecordsJobConfig

func (*JobUpdateConfig) GetEmptyObject

func (j *JobUpdateConfig) GetEmptyObject() *EmptyObject

func (*JobUpdateConfig) GetExportJobConfig

func (j *JobUpdateConfig) GetExportJobConfig() *ExportJobConfig

func (*JobUpdateConfig) GetFileJobConfig

func (j *JobUpdateConfig) GetFileJobConfig() *FileJobConfig

func (*JobUpdateConfig) GetFindAndReplaceJobConfig

func (j *JobUpdateConfig) GetFindAndReplaceJobConfig() *FindAndReplaceJobConfig

func (*JobUpdateConfig) GetMappingProgramJobConfig

func (j *JobUpdateConfig) GetMappingProgramJobConfig() *MappingProgramJobConfig

func (*JobUpdateConfig) GetMutateJobConfig

func (j *JobUpdateConfig) GetMutateJobConfig() *MutateJobConfig

func (*JobUpdateConfig) GetPipelineJobConfig

func (j *JobUpdateConfig) GetPipelineJobConfig() *PipelineJobConfig

func (*JobUpdateConfig) GetUpdateDataClipResolutionsJobConfig

func (j *JobUpdateConfig) GetUpdateDataClipResolutionsJobConfig() *UpdateDataClipResolutionsJobConfig

func (JobUpdateConfig) MarshalJSON

func (j JobUpdateConfig) MarshalJSON() ([]byte, error)

func (*JobUpdateConfig) UnmarshalJSON

func (j *JobUpdateConfig) UnmarshalJSON(data []byte) error

type JobUpdateConfigVisitor

type JobUpdateConfigVisitor interface {
	VisitDeleteRecordsJobConfig(*DeleteRecordsJobConfig) error
	VisitFileJobConfig(*FileJobConfig) error
	VisitPipelineJobConfig(*PipelineJobConfig) error
	VisitExportJobConfig(*ExportJobConfig) error
	VisitMutateJobConfig(*MutateJobConfig) error
	VisitFindAndReplaceJobConfig(*FindAndReplaceJobConfig) error
	VisitMappingProgramJobConfig(*MappingProgramJobConfig) error
	VisitAiGenerateBlueprintJobConfig(*AiGenerateBlueprintJobConfig) error
	VisitAppAutobuildDeployJobConfig(*AppAutobuildDeployJobConfig) error
	VisitAiGenerateSampleDataJobConfig(*AiGenerateSampleDataJobConfig) error
	VisitAiGenerateBlueprintConstraintsJobConfig(*AiGenerateBlueprintConstraintsJobConfig) error
	VisitAiGenerateConstraintJobConfig(*AiGenerateConstraintJobConfig) error
	VisitAiRuleCreationJobConfig(*AiRuleCreationJobConfig) error
	VisitEmptyObject(*EmptyObject) error
	VisitAddRecordsToDataClipJobConfig(*AddRecordsToDataClipJobConfig) error
	VisitUpdateDataClipResolutionsJobConfig(*UpdateDataClipResolutionsJobConfig) error
}

type JsonPathString

type JsonPathString = string

A JSONPath string - https://www.rfc-editor.org/rfc/rfc9535

type ListActorRolesResponse

type ListActorRolesResponse struct {
	Data []*ActorRoleResponse `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ListActorRolesResponse) GetData

func (l *ListActorRolesResponse) GetData() []*ActorRoleResponse

func (*ListActorRolesResponse) GetExtraProperties

func (l *ListActorRolesResponse) GetExtraProperties() map[string]interface{}

func (*ListActorRolesResponse) String

func (l *ListActorRolesResponse) String() string

func (*ListActorRolesResponse) UnmarshalJSON

func (l *ListActorRolesResponse) UnmarshalJSON(data []byte) error

type ListAgentVersionsResponse

type ListAgentVersionsResponse struct {
	Data []*AgentVersion `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ListAgentVersionsResponse) GetData

func (l *ListAgentVersionsResponse) GetData() []*AgentVersion

func (*ListAgentVersionsResponse) GetExtraProperties

func (l *ListAgentVersionsResponse) GetExtraProperties() map[string]interface{}

func (*ListAgentVersionsResponse) String

func (l *ListAgentVersionsResponse) String() string

func (*ListAgentVersionsResponse) UnmarshalJSON

func (l *ListAgentVersionsResponse) UnmarshalJSON(data []byte) error

type ListAgentsRequest

type ListAgentsRequest struct {
	EnvironmentId EnvironmentId `json:"-" url:"environmentId"`
}

type ListAgentsResponse

type ListAgentsResponse struct {
	Data []*Agent `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ListAgentsResponse) GetData

func (l *ListAgentsResponse) GetData() []*Agent

func (*ListAgentsResponse) GetExtraProperties

func (l *ListAgentsResponse) GetExtraProperties() map[string]interface{}

func (*ListAgentsResponse) String

func (l *ListAgentsResponse) String() string

func (*ListAgentsResponse) UnmarshalJSON

func (l *ListAgentsResponse) UnmarshalJSON(data []byte) error

type ListAllEventsResponse

type ListAllEventsResponse struct {
	Data []*Event `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ListAllEventsResponse) GetData

func (l *ListAllEventsResponse) GetData() []*Event

func (*ListAllEventsResponse) GetExtraProperties

func (l *ListAllEventsResponse) GetExtraProperties() map[string]interface{}

func (*ListAllEventsResponse) String

func (l *ListAllEventsResponse) String() string

func (*ListAllEventsResponse) UnmarshalJSON

func (l *ListAllEventsResponse) UnmarshalJSON(data []byte) error

type ListCommitsResponse

type ListCommitsResponse struct {
	Data []*Commit `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ListCommitsResponse) GetData

func (l *ListCommitsResponse) GetData() []*Commit

func (*ListCommitsResponse) GetExtraProperties

func (l *ListCommitsResponse) GetExtraProperties() map[string]interface{}

func (*ListCommitsResponse) String

func (l *ListCommitsResponse) String() string

func (*ListCommitsResponse) UnmarshalJSON

func (l *ListCommitsResponse) UnmarshalJSON(data []byte) error

type ListDataRetentionPoliciesRequest

type ListDataRetentionPoliciesRequest struct {
	// The associated Environment ID of the policy.
	EnvironmentId *EnvironmentId `json:"-" url:"environmentId,omitempty"`
}

type ListDataRetentionPoliciesResponse

type ListDataRetentionPoliciesResponse struct {
	Data []*DataRetentionPolicy `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ListDataRetentionPoliciesResponse) GetData

func (l *ListDataRetentionPoliciesResponse) GetData() []*DataRetentionPolicy

func (*ListDataRetentionPoliciesResponse) GetExtraProperties

func (l *ListDataRetentionPoliciesResponse) GetExtraProperties() map[string]interface{}

func (*ListDataRetentionPoliciesResponse) String

func (l *ListDataRetentionPoliciesResponse) String() string

func (*ListDataRetentionPoliciesResponse) UnmarshalJSON

func (l *ListDataRetentionPoliciesResponse) UnmarshalJSON(data []byte) error

type ListDocumentsResponse

type ListDocumentsResponse struct {
	Data []*Document `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ListDocumentsResponse) GetData

func (l *ListDocumentsResponse) GetData() []*Document

func (*ListDocumentsResponse) GetExtraProperties

func (l *ListDocumentsResponse) GetExtraProperties() map[string]interface{}

func (*ListDocumentsResponse) String

func (l *ListDocumentsResponse) String() string

func (*ListDocumentsResponse) UnmarshalJSON

func (l *ListDocumentsResponse) UnmarshalJSON(data []byte) error

type ListEntitlementsRequest

type ListEntitlementsRequest struct {
	// The associated Resource ID for the entitlements.
	ResourceId string `json:"-" url:"resourceId"`
}

type ListEntitlementsResponse

type ListEntitlementsResponse struct {
	Data []*Entitlement `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ListEntitlementsResponse) GetData

func (l *ListEntitlementsResponse) GetData() []*Entitlement

func (*ListEntitlementsResponse) GetExtraProperties

func (l *ListEntitlementsResponse) GetExtraProperties() map[string]interface{}

func (*ListEntitlementsResponse) String

func (l *ListEntitlementsResponse) String() string

func (*ListEntitlementsResponse) UnmarshalJSON

func (l *ListEntitlementsResponse) UnmarshalJSON(data []byte) error

type ListEnvironmentsRequest

type ListEnvironmentsRequest struct {
	// Number of environments to return in a page (default 10)
	PageSize *int `json:"-" url:"pageSize,omitempty"`
	// Based on pageSize, which page of environments to return
	PageNumber *int `json:"-" url:"pageNumber,omitempty"`
}

type ListEnvironmentsResponse

type ListEnvironmentsResponse struct {
	Data       []*Environment `json:"data,omitempty" url:"data,omitempty"`
	Pagination *Pagination    `json:"pagination,omitempty" url:"pagination,omitempty"`
	// contains filtered or unexported fields
}

func (*ListEnvironmentsResponse) GetData

func (l *ListEnvironmentsResponse) GetData() []*Environment

func (*ListEnvironmentsResponse) GetExtraProperties

func (l *ListEnvironmentsResponse) GetExtraProperties() map[string]interface{}

func (*ListEnvironmentsResponse) GetPagination

func (l *ListEnvironmentsResponse) GetPagination() *Pagination

func (*ListEnvironmentsResponse) String

func (l *ListEnvironmentsResponse) String() string

func (*ListEnvironmentsResponse) UnmarshalJSON

func (l *ListEnvironmentsResponse) UnmarshalJSON(data []byte) error

type ListEventsRequest

type ListEventsRequest struct {
	// Filter by environment
	EnvironmentId *EnvironmentId `json:"-" url:"environmentId,omitempty"`
	// Filter by space
	SpaceId *SpaceId `json:"-" url:"spaceId,omitempty"`
	// Filter by event domain
	Domain *string `json:"-" url:"domain,omitempty"`
	// Filter by event topic
	Topic *string `json:"-" url:"topic,omitempty"`
	// Filter by event timestamp
	Since *time.Time `json:"-" url:"since,omitempty"`
	// Number of results to return in a page (default 10)
	PageSize *int `json:"-" url:"pageSize,omitempty"`
	// Based on pageSize, which page of results to return
	PageNumber *int `json:"-" url:"pageNumber,omitempty"`
	// Include acknowledged events
	IncludeAcknowledged *bool `json:"-" url:"includeAcknowledged,omitempty"`
}

type ListFilesRequest

type ListFilesRequest struct {
	SpaceId *string `json:"-" url:"spaceId,omitempty"`
	// Number of files to return in a page (default 20)
	PageSize *int `json:"-" url:"pageSize,omitempty"`
	// Based on pageSize, which page of files to return
	PageNumber *int `json:"-" url:"pageNumber,omitempty"`
	// The storage mode of file to fetch, defaults to "import"
	Mode *Mode `json:"-" url:"mode,omitempty"`
}

type ListFilesResponse

type ListFilesResponse struct {
	Pagination *Pagination `json:"pagination,omitempty" url:"pagination,omitempty"`
	Data       []*File     `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ListFilesResponse) GetData

func (l *ListFilesResponse) GetData() []*File

func (*ListFilesResponse) GetExtraProperties

func (l *ListFilesResponse) GetExtraProperties() map[string]interface{}

func (*ListFilesResponse) GetPagination

func (l *ListFilesResponse) GetPagination() *Pagination

func (*ListFilesResponse) String

func (l *ListFilesResponse) String() string

func (*ListFilesResponse) UnmarshalJSON

func (l *ListFilesResponse) UnmarshalJSON(data []byte) error

type ListGuestsRequest

type ListGuestsRequest struct {
	// ID of space to return
	SpaceId SpaceId `json:"-" url:"spaceId"`
	// Email of guest to return
	Email *string `json:"-" url:"email,omitempty"`
}

type ListGuestsResponse

type ListGuestsResponse struct {
	Data []*Guest `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ListGuestsResponse) GetData

func (l *ListGuestsResponse) GetData() []*Guest

func (*ListGuestsResponse) GetExtraProperties

func (l *ListGuestsResponse) GetExtraProperties() map[string]interface{}

func (*ListGuestsResponse) String

func (l *ListGuestsResponse) String() string

func (*ListGuestsResponse) UnmarshalJSON

func (l *ListGuestsResponse) UnmarshalJSON(data []byte) error

type ListGuidanceRequest

type ListGuidanceRequest struct {
	// Include the guide with the guidance
	Guide *string `json:"-" url:"guide,omitempty"`
}

type ListJobsRequest

type ListJobsRequest struct {
	// When provided, only jobs for the given environment will be returned
	EnvironmentId *EnvironmentId `json:"-" url:"environmentId,omitempty"`
	// When provided, only jobs for the given space will be returned
	SpaceId *SpaceId `json:"-" url:"spaceId,omitempty"`
	// When provided, only jobs for the given workbook will be returned
	WorkbookId *WorkbookId `json:"-" url:"workbookId,omitempty"`
	// When provided, only jobs for the given file will be returned
	FileId *FileId `json:"-" url:"fileId,omitempty"`
	// When provided, only jobs that are parts of the given job will be returned
	ParentId *JobId `json:"-" url:"parentId,omitempty"`
	// Number of jobs to return in a page (default 20)
	PageSize *int `json:"-" url:"pageSize,omitempty"`
	// Based on pageSize, which page of jobs to return
	PageNumber *int `json:"-" url:"pageNumber,omitempty"`
	// Sort direction - asc (ascending) or desc (descending)
	SortDirection *SortDirection `json:"-" url:"sortDirection,omitempty"`
	// When true, only top-level jobs will be returned unless a parentId is specified
	ExcludeChildJobs *bool `json:"-" url:"excludeChildJobs,omitempty"`
}

type ListJobsResponse

type ListJobsResponse struct {
	Pagination *Pagination `json:"pagination,omitempty" url:"pagination,omitempty"`
	Data       []*Job      `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ListJobsResponse) GetData

func (l *ListJobsResponse) GetData() []*Job

func (*ListJobsResponse) GetExtraProperties

func (l *ListJobsResponse) GetExtraProperties() map[string]interface{}

func (*ListJobsResponse) GetPagination

func (l *ListJobsResponse) GetPagination() *Pagination

func (*ListJobsResponse) String

func (l *ListJobsResponse) String() string

func (*ListJobsResponse) UnmarshalJSON

func (l *ListJobsResponse) UnmarshalJSON(data []byte) error

type ListProgramsRequest

type ListProgramsRequest struct {
	// Number of programs to return in a page (default 10)
	PageSize *int `json:"-" url:"pageSize,omitempty"`
	// Based on pageSize, which page of records to return
	PageNumber *int `json:"-" url:"pageNumber,omitempty"`
	// Filter by creator
	CreatedBy *UserId `json:"-" url:"createdBy,omitempty"`
	// Filter by creation time
	CreatedAfter *time.Time `json:"-" url:"createdAfter,omitempty"`
	// Filter by creation time
	CreatedBefore *time.Time `json:"-" url:"createdBefore,omitempty"`
	// The ID of the environment
	EnvironmentId *EnvironmentId `json:"-" url:"environmentId,omitempty"`
	// Filter by family
	FamilyId *FamilyId `json:"-" url:"familyId,omitempty"`
	// Filter by namespace
	Namespace *string `json:"-" url:"namespace,omitempty"`
	// Filter by source keys
	SourceKeys *string `json:"-" url:"sourceKeys,omitempty"`
	// Filter by destination keys
	DestinationKeys *string `json:"-" url:"destinationKeys,omitempty"`
}

type ListPromptsRequest

type ListPromptsRequest struct {
	// Type of prompt (default AI_ASSIST)
	PromptType *PromptTypeQueryEnum `json:"-" url:"promptType,omitempty"`
	// Number of prompts to return in a page (default 7)
	PageSize *int `json:"-" url:"pageSize,omitempty"`
	// Based on pageSize, which page of prompts to return
	PageNumber *int `json:"-" url:"pageNumber,omitempty"`
}

type ListRolesResponse

type ListRolesResponse struct {
	Data []*RoleResponse `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ListRolesResponse) GetData

func (l *ListRolesResponse) GetData() []*RoleResponse

func (*ListRolesResponse) GetExtraProperties

func (l *ListRolesResponse) GetExtraProperties() map[string]interface{}

func (*ListRolesResponse) String

func (l *ListRolesResponse) String() string

func (*ListRolesResponse) UnmarshalJSON

func (l *ListRolesResponse) UnmarshalJSON(data []byte) error

type ListSecrets

type ListSecrets struct {
	// The Environment of the secret.
	EnvironmentId *EnvironmentId `json:"-" url:"environmentId,omitempty"`
	// The Space of the secret.
	SpaceId *SpaceId `json:"-" url:"spaceId,omitempty"`
	// The Actor of the secret.
	ActorId *ActorIdUnion `json:"-" url:"actorId,omitempty"`
}

type ListSheetCommitsRequest

type ListSheetCommitsRequest struct {
	// If true, only return commits that have been completed. If false, only return commits that have not been completed. If not provided, return all commits.
	Completed *bool `json:"-" url:"completed,omitempty"`
}

type ListSheetsRequest

type ListSheetsRequest struct {
	// ID of workbook
	WorkbookId WorkbookId `json:"-" url:"workbookId"`
}

type ListSheetsResponse

type ListSheetsResponse struct {
	Data []*Sheet `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSheetsResponse) GetData

func (l *ListSheetsResponse) GetData() []*Sheet

func (*ListSheetsResponse) GetExtraProperties

func (l *ListSheetsResponse) GetExtraProperties() map[string]interface{}

func (*ListSheetsResponse) String

func (l *ListSheetsResponse) String() string

func (*ListSheetsResponse) UnmarshalJSON

func (l *ListSheetsResponse) UnmarshalJSON(data []byte) error

type ListSnapshotRequest

type ListSnapshotRequest struct {
	// ID of sheet
	SheetId SheetId `json:"-" url:"sheetId"`
	// ThreadId to filter snapshots by
	ThreadId *string `json:"-" url:"threadId,omitempty"`
}

type ListSpacesRequest

type ListSpacesRequest struct {
	// The ID of the environment.
	EnvironmentId *EnvironmentId `json:"-" url:"environmentId,omitempty"`
	// Number of spaces to return in a page (default 10)
	PageSize *int `json:"-" url:"pageSize,omitempty"`
	// Based on pageSize, which page of records to return
	PageNumber *int `json:"-" url:"pageNumber,omitempty"`
	// Search query for spaces
	Search *string `json:"-" url:"search,omitempty"`
	// Search by namespace
	Namespace *string `json:"-" url:"namespace,omitempty"`
	// Flag to include archived spaces
	Archived *bool `json:"-" url:"archived,omitempty"`
	// Field to sort spaces by
	SortField *GetSpacesSortField `json:"-" url:"sortField,omitempty"`
	// Direction of sorting
	SortDirection *SortDirection `json:"-" url:"sortDirection,omitempty"`
	// Flag for collaborative (project) spaces
	IsCollaborative *bool `json:"-" url:"isCollaborative,omitempty"`
	// Filter by appId
	AppId *AppId `json:"-" url:"appId,omitempty"`
	// Flag for app templates
	IsAppTemplate *bool `json:"-" url:"isAppTemplate,omitempty"`
}

type ListSpacesResponse

type ListSpacesResponse struct {
	Pagination *Pagination `json:"pagination,omitempty" url:"pagination,omitempty"`
	Data       []*Space    `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

List of Space objects

func (*ListSpacesResponse) GetData

func (l *ListSpacesResponse) GetData() []*Space

func (*ListSpacesResponse) GetExtraProperties

func (l *ListSpacesResponse) GetExtraProperties() map[string]interface{}

func (*ListSpacesResponse) GetPagination

func (l *ListSpacesResponse) GetPagination() *Pagination

func (*ListSpacesResponse) String

func (l *ListSpacesResponse) String() string

func (*ListSpacesResponse) UnmarshalJSON

func (l *ListSpacesResponse) UnmarshalJSON(data []byte) error

type ListUsersRequest

type ListUsersRequest struct {
	// Email of guest to return
	Email *string `json:"-" url:"email,omitempty"`
	// String to search for users by name and email
	Search *string `json:"-" url:"search,omitempty"`
	// Field to sort users by
	SortField *ListUsersSortField `json:"-" url:"sortField,omitempty"`
	// Direction of sorting
	SortDirection *SortDirection `json:"-" url:"sortDirection,omitempty"`
	// Number of users to return in a page (default 20)
	PageSize *int `json:"-" url:"pageSize,omitempty"`
	// Based on pageSize, which page of users to return
	PageNumber *int `json:"-" url:"pageNumber,omitempty"`
}

type ListUsersResponse

type ListUsersResponse struct {
	Data       []*User     `json:"data,omitempty" url:"data,omitempty"`
	Pagination *Pagination `json:"pagination,omitempty" url:"pagination,omitempty"`
	// contains filtered or unexported fields
}

func (*ListUsersResponse) GetData

func (l *ListUsersResponse) GetData() []*User

func (*ListUsersResponse) GetExtraProperties

func (l *ListUsersResponse) GetExtraProperties() map[string]interface{}

func (*ListUsersResponse) GetPagination

func (l *ListUsersResponse) GetPagination() *Pagination

func (*ListUsersResponse) String

func (l *ListUsersResponse) String() string

func (*ListUsersResponse) UnmarshalJSON

func (l *ListUsersResponse) UnmarshalJSON(data []byte) error

type ListUsersSortField

type ListUsersSortField string

const (
	ListUsersSortFieldEmail      ListUsersSortField = "email"
	ListUsersSortFieldName       ListUsersSortField = "name"
	ListUsersSortFieldId         ListUsersSortField = "id"
	ListUsersSortFieldIdp        ListUsersSortField = "idp"
	ListUsersSortFieldIdpRef     ListUsersSortField = "idp_ref"
	ListUsersSortFieldCreatedAt  ListUsersSortField = "created_at"
	ListUsersSortFieldUpdatedAt  ListUsersSortField = "updated_at"
	ListUsersSortFieldLastSeenAt ListUsersSortField = "last_seen_at"
	ListUsersSortFieldDashboard  ListUsersSortField = "dashboard"
)

func NewListUsersSortFieldFromString

func NewListUsersSortFieldFromString(s string) (ListUsersSortField, error)

func (ListUsersSortField) Ptr

func (l ListUsersSortField) Ptr() *ListUsersSortField

type ListViewsRequest

type ListViewsRequest struct {
	// The associated sheet ID of the view.
	SheetId SheetId `json:"-" url:"sheetId"`
	// Number of prompts to return in a page (default 10)
	PageSize *int `json:"-" url:"pageSize,omitempty"`
	// Based on pageSize, which page of prompts to return
	PageNumber *int `json:"-" url:"pageNumber,omitempty"`
}

type ListViewsResponse

type ListViewsResponse struct {
	Pagination *Pagination `json:"pagination,omitempty" url:"pagination,omitempty"`
	Data       []*View     `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ListViewsResponse) GetData

func (l *ListViewsResponse) GetData() []*View

func (*ListViewsResponse) GetExtraProperties

func (l *ListViewsResponse) GetExtraProperties() map[string]interface{}

func (*ListViewsResponse) GetPagination

func (l *ListViewsResponse) GetPagination() *Pagination

func (*ListViewsResponse) String

func (l *ListViewsResponse) String() string

func (*ListViewsResponse) UnmarshalJSON

func (l *ListViewsResponse) UnmarshalJSON(data []byte) error

type ListWorkbookCommitsRequest

type ListWorkbookCommitsRequest struct {
	// If true, only return commits that have been completed. If false, only return commits that have not been completed. If not provided, return all commits.
	Completed *bool `json:"-" url:"completed,omitempty"`
}

type ListWorkbooksRequest

type ListWorkbooksRequest struct {
	// The associated Space ID of the Workbook.
	SpaceId *SpaceId `json:"-" url:"spaceId,omitempty"`
	// Filter by name. Precede with - to negate the filter
	Name *string `json:"-" url:"name,omitempty"`
	// Filter by namespace. Precede with - to negate the filter
	Namespace *string `json:"-" url:"namespace,omitempty"`
	// Filter by label. Precede with - to negate the filter
	Label *string `json:"-" url:"label,omitempty"`
	// Filter by treatment.
	Treatment *string `json:"-" url:"treatment,omitempty"`
	// Include sheets for the workbook (default true)
	IncludeSheets *bool `json:"-" url:"includeSheets,omitempty"`
	// Include counts for the workbook. **DEPRECATED** Counts will return 0s. Use GET /sheets/:sheetId/counts
	IncludeCounts *bool `json:"-" url:"includeCounts,omitempty"`
}

type ListWorkbooksResponse

type ListWorkbooksResponse struct {
	Data []*Workbook `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ListWorkbooksResponse) GetData

func (l *ListWorkbooksResponse) GetData() []*Workbook

func (*ListWorkbooksResponse) GetExtraProperties

func (l *ListWorkbooksResponse) GetExtraProperties() map[string]interface{}

func (*ListWorkbooksResponse) String

func (l *ListWorkbooksResponse) String() string

func (*ListWorkbooksResponse) UnmarshalJSON

func (l *ListWorkbooksResponse) UnmarshalJSON(data []byte) error

type MappingId

type MappingId = string

Mapping Rule ID

type MappingProgramJobConfig

type MappingProgramJobConfig struct {
	SourceSheetId      SheetId                  `json:"sourceSheetId" url:"sourceSheetId"`
	DestinationSheetId SheetId                  `json:"destinationSheetId" url:"destinationSheetId"`
	MappingRules       []map[string]interface{} `json:"mappingRules,omitempty" url:"mappingRules,omitempty"`
	// contains filtered or unexported fields
}

func (*MappingProgramJobConfig) GetDestinationSheetId

func (m *MappingProgramJobConfig) GetDestinationSheetId() SheetId

func (*MappingProgramJobConfig) GetExtraProperties

func (m *MappingProgramJobConfig) GetExtraProperties() map[string]interface{}

func (*MappingProgramJobConfig) GetMappingRules

func (m *MappingProgramJobConfig) GetMappingRules() []map[string]interface{}

func (*MappingProgramJobConfig) GetSourceSheetId

func (m *MappingProgramJobConfig) GetSourceSheetId() SheetId

func (*MappingProgramJobConfig) String

func (m *MappingProgramJobConfig) String() string

func (*MappingProgramJobConfig) UnmarshalJSON

func (m *MappingProgramJobConfig) UnmarshalJSON(data []byte) error

type MappingRule

type MappingRule struct {
	// Name of the mapping rule
	Name   string      `json:"name" url:"name"`
	Type   string      `json:"type" url:"type"`
	Config interface{} `json:"config,omitempty" url:"config,omitempty"`
	// Time the mapping rule was last updated
	AcceptedAt *time.Time `json:"acceptedAt,omitempty" url:"acceptedAt,omitempty"`
	// User ID of the contributor of the mapping rule
	AcceptedBy *UserId `json:"acceptedBy,omitempty" url:"acceptedBy,omitempty"`
	// Metadata of the mapping rule
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// ID of the mapping rule
	Id MappingId `json:"id" url:"id"`
	// Confidence of the mapping rule
	Confidence *int `json:"confidence,omitempty" url:"confidence,omitempty"`
	// User ID of the user who suggested the mapping rule
	CreatedBy *UserId `json:"createdBy,omitempty" url:"createdBy,omitempty"`
	// Time the mapping rule was created
	CreatedAt time.Time `json:"createdAt" url:"createdAt"`
	// Time the mapping rule was last updated
	UpdatedAt time.Time `json:"updatedAt" url:"updatedAt"`
	// Time the mapping rule was deleted
	DeletedAt *time.Time `json:"deletedAt,omitempty" url:"deletedAt,omitempty"`
	// contains filtered or unexported fields
}

func (*MappingRule) GetAcceptedAt

func (m *MappingRule) GetAcceptedAt() *time.Time

func (*MappingRule) GetAcceptedBy

func (m *MappingRule) GetAcceptedBy() *UserId

func (*MappingRule) GetConfidence

func (m *MappingRule) GetConfidence() *int

func (*MappingRule) GetConfig

func (m *MappingRule) GetConfig() interface{}

func (*MappingRule) GetCreatedAt

func (m *MappingRule) GetCreatedAt() time.Time

func (*MappingRule) GetCreatedBy

func (m *MappingRule) GetCreatedBy() *UserId

func (*MappingRule) GetDeletedAt

func (m *MappingRule) GetDeletedAt() *time.Time

func (*MappingRule) GetExtraProperties

func (m *MappingRule) GetExtraProperties() map[string]interface{}

func (*MappingRule) GetId

func (m *MappingRule) GetId() MappingId

func (*MappingRule) GetMetadata

func (m *MappingRule) GetMetadata() interface{}

func (*MappingRule) GetName

func (m *MappingRule) GetName() string

func (*MappingRule) GetType

func (m *MappingRule) GetType() string

func (*MappingRule) GetUpdatedAt

func (m *MappingRule) GetUpdatedAt() time.Time

func (*MappingRule) MarshalJSON

func (m *MappingRule) MarshalJSON() ([]byte, error)

func (*MappingRule) String

func (m *MappingRule) String() string

func (*MappingRule) UnmarshalJSON

func (m *MappingRule) UnmarshalJSON(data []byte) error

type MappingRuleConfig

type MappingRuleConfig struct {
	// Name of the mapping rule
	Name   string      `json:"name" url:"name"`
	Type   string      `json:"type" url:"type"`
	Config interface{} `json:"config,omitempty" url:"config,omitempty"`
	// Time the mapping rule was last updated
	AcceptedAt *time.Time `json:"acceptedAt,omitempty" url:"acceptedAt,omitempty"`
	// User ID of the contributor of the mapping rule
	AcceptedBy *UserId `json:"acceptedBy,omitempty" url:"acceptedBy,omitempty"`
	// Metadata of the mapping rule
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*MappingRuleConfig) GetAcceptedAt

func (m *MappingRuleConfig) GetAcceptedAt() *time.Time

func (*MappingRuleConfig) GetAcceptedBy

func (m *MappingRuleConfig) GetAcceptedBy() *UserId

func (*MappingRuleConfig) GetConfig

func (m *MappingRuleConfig) GetConfig() interface{}

func (*MappingRuleConfig) GetExtraProperties

func (m *MappingRuleConfig) GetExtraProperties() map[string]interface{}

func (*MappingRuleConfig) GetMetadata

func (m *MappingRuleConfig) GetMetadata() interface{}

func (*MappingRuleConfig) GetName

func (m *MappingRuleConfig) GetName() string

func (*MappingRuleConfig) GetType

func (m *MappingRuleConfig) GetType() string

func (*MappingRuleConfig) MarshalJSON

func (m *MappingRuleConfig) MarshalJSON() ([]byte, error)

func (*MappingRuleConfig) String

func (m *MappingRuleConfig) String() string

func (*MappingRuleConfig) UnmarshalJSON

func (m *MappingRuleConfig) UnmarshalJSON(data []byte) error

type MappingRuleOrConfig

type MappingRuleOrConfig struct {
	// Name of the mapping rule
	Name   string      `json:"name" url:"name"`
	Type   string      `json:"type" url:"type"`
	Config interface{} `json:"config,omitempty" url:"config,omitempty"`
	// Time the mapping rule was last updated
	AcceptedAt *time.Time `json:"acceptedAt,omitempty" url:"acceptedAt,omitempty"`
	// User ID of the contributor of the mapping rule
	AcceptedBy *UserId `json:"acceptedBy,omitempty" url:"acceptedBy,omitempty"`
	// Metadata of the mapping rule
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// ID of the mapping rule
	Id *MappingId `json:"id,omitempty" url:"id,omitempty"`
	// Confidence of the mapping rule
	Confidence *int `json:"confidence,omitempty" url:"confidence,omitempty"`
	// User ID of the creator of the mapping rule
	CreatedBy *UserId `json:"createdBy,omitempty" url:"createdBy,omitempty"`
	// Time the mapping rule was created
	CreatedAt *time.Time `json:"createdAt,omitempty" url:"createdAt,omitempty"`
	// Time the mapping rule was last updated
	UpdatedAt *time.Time `json:"updatedAt,omitempty" url:"updatedAt,omitempty"`
	// Time the mapping rule was deleted
	DeletedAt *time.Time `json:"deletedAt,omitempty" url:"deletedAt,omitempty"`
	// contains filtered or unexported fields
}

func (*MappingRuleOrConfig) GetAcceptedAt

func (m *MappingRuleOrConfig) GetAcceptedAt() *time.Time

func (*MappingRuleOrConfig) GetAcceptedBy

func (m *MappingRuleOrConfig) GetAcceptedBy() *UserId

func (*MappingRuleOrConfig) GetConfidence

func (m *MappingRuleOrConfig) GetConfidence() *int

func (*MappingRuleOrConfig) GetConfig

func (m *MappingRuleOrConfig) GetConfig() interface{}

func (*MappingRuleOrConfig) GetCreatedAt

func (m *MappingRuleOrConfig) GetCreatedAt() *time.Time

func (*MappingRuleOrConfig) GetCreatedBy

func (m *MappingRuleOrConfig) GetCreatedBy() *UserId

func (*MappingRuleOrConfig) GetDeletedAt

func (m *MappingRuleOrConfig) GetDeletedAt() *time.Time

func (*MappingRuleOrConfig) GetExtraProperties

func (m *MappingRuleOrConfig) GetExtraProperties() map[string]interface{}

func (*MappingRuleOrConfig) GetId

func (m *MappingRuleOrConfig) GetId() *MappingId

func (*MappingRuleOrConfig) GetMetadata

func (m *MappingRuleOrConfig) GetMetadata() interface{}

func (*MappingRuleOrConfig) GetName

func (m *MappingRuleOrConfig) GetName() string

func (*MappingRuleOrConfig) GetType

func (m *MappingRuleOrConfig) GetType() string

func (*MappingRuleOrConfig) GetUpdatedAt

func (m *MappingRuleOrConfig) GetUpdatedAt() *time.Time

func (*MappingRuleOrConfig) MarshalJSON

func (m *MappingRuleOrConfig) MarshalJSON() ([]byte, error)

func (*MappingRuleOrConfig) String

func (m *MappingRuleOrConfig) String() string

func (*MappingRuleOrConfig) UnmarshalJSON

func (m *MappingRuleOrConfig) UnmarshalJSON(data []byte) error

type MappingRuleResponse

type MappingRuleResponse struct {
	Data *MappingRule `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*MappingRuleResponse) GetData

func (m *MappingRuleResponse) GetData() *MappingRule

func (*MappingRuleResponse) GetExtraProperties

func (m *MappingRuleResponse) GetExtraProperties() map[string]interface{}

func (*MappingRuleResponse) String

func (m *MappingRuleResponse) String() string

func (*MappingRuleResponse) UnmarshalJSON

func (m *MappingRuleResponse) UnmarshalJSON(data []byte) error

type MappingRulesResponse

type MappingRulesResponse struct {
	Data []*MappingRule `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*MappingRulesResponse) GetData

func (m *MappingRulesResponse) GetData() []*MappingRule

func (*MappingRulesResponse) GetExtraProperties

func (m *MappingRulesResponse) GetExtraProperties() map[string]interface{}

func (*MappingRulesResponse) String

func (m *MappingRulesResponse) String() string

func (*MappingRulesResponse) UnmarshalJSON

func (m *MappingRulesResponse) UnmarshalJSON(data []byte) error

type Metadata

type Metadata struct {
	Certainty         *Certainty `json:"certainty,omitempty" url:"certainty,omitempty"`
	Confidence        *float64   `json:"confidence,omitempty" url:"confidence,omitempty"`
	Source            *string    `json:"source,omitempty" url:"source,omitempty"`
	DetectedDelimiter *string    `json:"detectedDelimiter,omitempty" url:"detectedDelimiter,omitempty"`
	// contains filtered or unexported fields
}

func (*Metadata) GetCertainty

func (m *Metadata) GetCertainty() *Certainty

func (*Metadata) GetConfidence

func (m *Metadata) GetConfidence() *float64

func (*Metadata) GetDetectedDelimiter

func (m *Metadata) GetDetectedDelimiter() *string

func (*Metadata) GetExtraProperties

func (m *Metadata) GetExtraProperties() map[string]interface{}

func (*Metadata) GetSource

func (m *Metadata) GetSource() *string

func (*Metadata) String

func (m *Metadata) String() string

func (*Metadata) UnmarshalJSON

func (m *Metadata) UnmarshalJSON(data []byte) error

type Mode

type Mode string

const (
	ModeImport Mode = "import"
	ModeExport Mode = "export"
)

func NewModeFromString

func NewModeFromString(s string) (Mode, error)

func (Mode) Ptr

func (m Mode) Ptr() *Mode

type ModelFileStatusEnum

type ModelFileStatusEnum string

const (
	ModelFileStatusEnumPartial  ModelFileStatusEnum = "partial"
	ModelFileStatusEnumComplete ModelFileStatusEnum = "complete"
	ModelFileStatusEnumArchived ModelFileStatusEnum = "archived"
	ModelFileStatusEnumPurged   ModelFileStatusEnum = "purged"
	ModelFileStatusEnumFailed   ModelFileStatusEnum = "failed"
)

func NewModelFileStatusEnumFromString

func NewModelFileStatusEnumFromString(s string) (ModelFileStatusEnum, error)

func (ModelFileStatusEnum) Ptr

func (m ModelFileStatusEnum) Ptr() *ModelFileStatusEnum

type MutateJobConfig

type MutateJobConfig struct {
	SheetId SheetId `json:"sheetId" url:"sheetId"`
	// A JavaScript function that will be run on each record in the sheet, it should return a mutated record.
	MutateRecord string `json:"mutateRecord" url:"mutateRecord"`
	// If the mutation was generated through some sort of id-ed process, this links this job and that process.
	MutationId *string `json:"mutationId,omitempty" url:"mutationId,omitempty"`
	// If specified, a snapshot will be generated with this label
	SnapshotLabel *string `json:"snapshotLabel,omitempty" url:"snapshotLabel,omitempty"`
	// The generated snapshotId will be stored here
	SnapshotId  *string      `json:"snapshotId,omitempty" url:"snapshotId,omitempty"`
	Filter      *Filter      `json:"filter,omitempty" url:"filter,omitempty"`
	FilterField *FilterField `json:"filterField,omitempty" url:"filterField,omitempty"`
	SearchValue *SearchValue `json:"searchValue,omitempty" url:"searchValue,omitempty"`
	SearchField *SearchField `json:"searchField,omitempty" url:"searchField,omitempty"`
	Q           *string      `json:"q,omitempty" url:"q,omitempty"`
	// The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records
	Ids []RecordId `json:"ids,omitempty" url:"ids,omitempty"`
	// contains filtered or unexported fields
}

func (*MutateJobConfig) GetExtraProperties

func (m *MutateJobConfig) GetExtraProperties() map[string]interface{}

func (*MutateJobConfig) GetFilter

func (m *MutateJobConfig) GetFilter() *Filter

func (*MutateJobConfig) GetFilterField

func (m *MutateJobConfig) GetFilterField() *FilterField

func (*MutateJobConfig) GetIds

func (m *MutateJobConfig) GetIds() []RecordId

func (*MutateJobConfig) GetMutateRecord

func (m *MutateJobConfig) GetMutateRecord() string

func (*MutateJobConfig) GetMutationId

func (m *MutateJobConfig) GetMutationId() *string

func (*MutateJobConfig) GetQ

func (m *MutateJobConfig) GetQ() *string

func (*MutateJobConfig) GetSearchField

func (m *MutateJobConfig) GetSearchField() *SearchField

func (*MutateJobConfig) GetSearchValue

func (m *MutateJobConfig) GetSearchValue() *SearchValue

func (*MutateJobConfig) GetSheetId

func (m *MutateJobConfig) GetSheetId() SheetId

func (*MutateJobConfig) GetSnapshotId

func (m *MutateJobConfig) GetSnapshotId() *string

func (*MutateJobConfig) GetSnapshotLabel

func (m *MutateJobConfig) GetSnapshotLabel() *string

func (*MutateJobConfig) String

func (m *MutateJobConfig) String() string

func (*MutateJobConfig) UnmarshalJSON

func (m *MutateJobConfig) UnmarshalJSON(data []byte) error

type NotFoundError

type NotFoundError struct {
	*core.APIError
	Body *Errors
}

func (*NotFoundError) MarshalJSON

func (n *NotFoundError) MarshalJSON() ([]byte, error)

func (*NotFoundError) UnmarshalJSON

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

func (*NotFoundError) Unwrap

func (n *NotFoundError) Unwrap() error

type NumberConfig

type NumberConfig struct {
	// Number of decimal places to round data to
	DecimalPlaces *int `json:"decimalPlaces,omitempty" url:"decimalPlaces,omitempty"`
	// contains filtered or unexported fields
}

func (*NumberConfig) GetDecimalPlaces

func (n *NumberConfig) GetDecimalPlaces() *int

func (*NumberConfig) GetExtraProperties

func (n *NumberConfig) GetExtraProperties() map[string]interface{}

func (*NumberConfig) String

func (n *NumberConfig) String() string

func (*NumberConfig) UnmarshalJSON

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

type NumberProperty

type NumberProperty struct {
	Key string `json:"key" url:"key"`
	// User friendly field name
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// A short description of the field. Markdown syntax is supported.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values.
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,omitempty"`
	// An array of actions that end users can perform on this Column.
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// Useful for any contextual metadata regarding the schema. Store any valid json here.
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// A unique presentation for a field in the UI.
	Treatments       []string `json:"treatments,omitempty" url:"treatments,omitempty"`
	AlternativeNames []string `json:"alternativeNames,omitempty" url:"alternativeNames,omitempty"`
	// Will allow multiple values and store as an array
	IsArray *bool         `json:"isArray,omitempty" url:"isArray,omitempty"`
	Config  *NumberConfig `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

Defines a property that should be stored and read as either an integer or floating point number. Database engines should look at the configuration to determine ideal storage format.

func (*NumberProperty) GetActions

func (n *NumberProperty) GetActions() []*Action

func (*NumberProperty) GetAlternativeNames

func (n *NumberProperty) GetAlternativeNames() []string

func (*NumberProperty) GetAppearance

func (n *NumberProperty) GetAppearance() *FieldAppearance

func (*NumberProperty) GetConfig

func (n *NumberProperty) GetConfig() *NumberConfig

func (*NumberProperty) GetConstraints

func (n *NumberProperty) GetConstraints() []*Constraint

func (*NumberProperty) GetDescription

func (n *NumberProperty) GetDescription() *string

func (*NumberProperty) GetExtraProperties

func (n *NumberProperty) GetExtraProperties() map[string]interface{}

func (*NumberProperty) GetIsArray

func (n *NumberProperty) GetIsArray() *bool

func (*NumberProperty) GetKey

func (n *NumberProperty) GetKey() string

func (*NumberProperty) GetLabel

func (n *NumberProperty) GetLabel() *string

func (*NumberProperty) GetMetadata

func (n *NumberProperty) GetMetadata() interface{}

func (*NumberProperty) GetReadonly

func (n *NumberProperty) GetReadonly() *bool

func (*NumberProperty) GetTreatments

func (n *NumberProperty) GetTreatments() []string

func (*NumberProperty) String

func (n *NumberProperty) String() string

func (*NumberProperty) UnmarshalJSON

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

type Origin

type Origin struct {
	Id   *string `json:"id,omitempty" url:"id,omitempty"`
	Slug *string `json:"slug,omitempty" url:"slug,omitempty"`
	// contains filtered or unexported fields
}

The origin resource of the event

func (*Origin) GetExtraProperties

func (o *Origin) GetExtraProperties() map[string]interface{}

func (*Origin) GetId

func (o *Origin) GetId() *string

func (*Origin) GetSlug

func (o *Origin) GetSlug() *string

func (*Origin) String

func (o *Origin) String() string

func (*Origin) UnmarshalJSON

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

type PageNumber

type PageNumber = int

Based on pageSize, which page of records to return

type PageSize

type PageSize = int

Number of logs to return in a page (default 20)

type Pagination

type Pagination struct {
	// current page of results
	CurrentPage int `json:"currentPage" url:"currentPage"`
	// total number of pages of results
	PageCount int `json:"pageCount" url:"pageCount"`
	// total available results
	TotalCount int `json:"totalCount" url:"totalCount"`
	// contains filtered or unexported fields
}

pagination info

func (*Pagination) GetCurrentPage

func (p *Pagination) GetCurrentPage() int

func (*Pagination) GetExtraProperties

func (p *Pagination) GetExtraProperties() map[string]interface{}

func (*Pagination) GetPageCount

func (p *Pagination) GetPageCount() int

func (*Pagination) GetTotalCount

func (p *Pagination) GetTotalCount() int

func (*Pagination) String

func (p *Pagination) String() string

func (*Pagination) UnmarshalJSON

func (p *Pagination) UnmarshalJSON(data []byte) error

type PipelineJobConfig

type PipelineJobConfig struct {
	SourceSheetId      SheetId `json:"sourceSheetId" url:"sourceSheetId"`
	DestinationSheetId SheetId `json:"destinationSheetId" url:"destinationSheetId"`
	// contains filtered or unexported fields
}

func (*PipelineJobConfig) GetDestinationSheetId

func (p *PipelineJobConfig) GetDestinationSheetId() SheetId

func (*PipelineJobConfig) GetExtraProperties

func (p *PipelineJobConfig) GetExtraProperties() map[string]interface{}

func (*PipelineJobConfig) GetSourceSheetId

func (p *PipelineJobConfig) GetSourceSheetId() SheetId

func (*PipelineJobConfig) String

func (p *PipelineJobConfig) String() string

func (*PipelineJobConfig) UnmarshalJSON

func (p *PipelineJobConfig) UnmarshalJSON(data []byte) error

type Program

type Program struct {
	// Mapping rules
	Rules []*MappingRuleOrConfig `json:"rules,omitempty" url:"rules,omitempty"`
	// If this program was saved, this is the ID of the program
	Id *string `json:"id,omitempty" url:"id,omitempty"`
	// Namespace of the program
	Namespace *string `json:"namespace,omitempty" url:"namespace,omitempty"`
	// Family ID of the program, if it belongs to a family
	FamilyId *FamilyId `json:"familyId,omitempty" url:"familyId,omitempty"`
	// If this program was saved, this is the time it was created
	CreatedAt *time.Time `json:"createdAt,omitempty" url:"createdAt,omitempty"`
	// If this program was saved, this is the user ID of the creator
	CreatedBy *UserId `json:"createdBy,omitempty" url:"createdBy,omitempty"`
	// Source keys
	SourceKeys []string `json:"sourceKeys,omitempty" url:"sourceKeys,omitempty"`
	// Destination keys
	DestinationKeys []string `json:"destinationKeys,omitempty" url:"destinationKeys,omitempty"`
	// Summary of the mapping rules
	Summary *ProgramSummary `json:"summary,omitempty" url:"summary,omitempty"`
	// If this program was saved, this token allows you to modify the program
	AccessToken *string `json:"accessToken,omitempty" url:"accessToken,omitempty"`
	// contains filtered or unexported fields
}

func (*Program) GetAccessToken

func (p *Program) GetAccessToken() *string

func (*Program) GetCreatedAt

func (p *Program) GetCreatedAt() *time.Time

func (*Program) GetCreatedBy

func (p *Program) GetCreatedBy() *UserId

func (*Program) GetDestinationKeys

func (p *Program) GetDestinationKeys() []string

func (*Program) GetExtraProperties

func (p *Program) GetExtraProperties() map[string]interface{}

func (*Program) GetFamilyId

func (p *Program) GetFamilyId() *FamilyId

func (*Program) GetId

func (p *Program) GetId() *string

func (*Program) GetNamespace

func (p *Program) GetNamespace() *string

func (*Program) GetRules

func (p *Program) GetRules() []*MappingRuleOrConfig

func (*Program) GetSourceKeys

func (p *Program) GetSourceKeys() []string

func (*Program) GetSummary

func (p *Program) GetSummary() *ProgramSummary

func (*Program) MarshalJSON

func (p *Program) MarshalJSON() ([]byte, error)

func (*Program) String

func (p *Program) String() string

func (*Program) UnmarshalJSON

func (p *Program) UnmarshalJSON(data []byte) error

type ProgramConfig

type ProgramConfig struct {
	// Source schema
	Source *SheetConfig `json:"source,omitempty" url:"source,omitempty"`
	// Destination schema
	Destination *SheetConfig `json:"destination,omitempty" url:"destination,omitempty"`
	// ID of the family to add the program to
	FamilyId *FamilyId `json:"familyId,omitempty" url:"familyId,omitempty"`
	// Namespace of the program
	Namespace *string `json:"namespace,omitempty" url:"namespace,omitempty"`
	// Whether to save the program for editing later. Defaults to false. If true, the response will contain an ID and access token.
	Save *bool `json:"save,omitempty" url:"save,omitempty"`
	// contains filtered or unexported fields
}

func (*ProgramConfig) GetDestination

func (p *ProgramConfig) GetDestination() *SheetConfig

func (*ProgramConfig) GetExtraProperties

func (p *ProgramConfig) GetExtraProperties() map[string]interface{}

func (*ProgramConfig) GetFamilyId

func (p *ProgramConfig) GetFamilyId() *FamilyId

func (*ProgramConfig) GetNamespace

func (p *ProgramConfig) GetNamespace() *string

func (*ProgramConfig) GetSave

func (p *ProgramConfig) GetSave() *bool

func (*ProgramConfig) GetSource

func (p *ProgramConfig) GetSource() *SheetConfig

func (*ProgramConfig) String

func (p *ProgramConfig) String() string

func (*ProgramConfig) UnmarshalJSON

func (p *ProgramConfig) UnmarshalJSON(data []byte) error

type ProgramId

type ProgramId = string

Mapping Program ID

type ProgramResponse

type ProgramResponse struct {
	Data *Program `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ProgramResponse) GetData

func (p *ProgramResponse) GetData() *Program

func (*ProgramResponse) GetExtraProperties

func (p *ProgramResponse) GetExtraProperties() map[string]interface{}

func (*ProgramResponse) String

func (p *ProgramResponse) String() string

func (*ProgramResponse) UnmarshalJSON

func (p *ProgramResponse) UnmarshalJSON(data []byte) error

type ProgramSummary

type ProgramSummary struct {
	// Total number of mapping rules
	TotalRuleCount int `json:"totalRuleCount" url:"totalRuleCount"`
	// Number of mapping rules added
	AddedRuleCount int `json:"addedRuleCount" url:"addedRuleCount"`
	// Number of mapping rules deleted
	DeletedRuleCount int `json:"deletedRuleCount" url:"deletedRuleCount"`
	// contains filtered or unexported fields
}

func (*ProgramSummary) GetAddedRuleCount

func (p *ProgramSummary) GetAddedRuleCount() int

func (*ProgramSummary) GetDeletedRuleCount

func (p *ProgramSummary) GetDeletedRuleCount() int

func (*ProgramSummary) GetExtraProperties

func (p *ProgramSummary) GetExtraProperties() map[string]interface{}

func (*ProgramSummary) GetTotalRuleCount

func (p *ProgramSummary) GetTotalRuleCount() int

func (*ProgramSummary) String

func (p *ProgramSummary) String() string

func (*ProgramSummary) UnmarshalJSON

func (p *ProgramSummary) UnmarshalJSON(data []byte) error

type ProgramsResponse

type ProgramsResponse struct {
	Data []*Program `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ProgramsResponse) GetData

func (p *ProgramsResponse) GetData() []*Program

func (*ProgramsResponse) GetExtraProperties

func (p *ProgramsResponse) GetExtraProperties() map[string]interface{}

func (*ProgramsResponse) String

func (p *ProgramsResponse) String() string

func (*ProgramsResponse) UnmarshalJSON

func (p *ProgramsResponse) UnmarshalJSON(data []byte) error

type Progress

type Progress struct {
	// The current progress of the event
	Current *int `json:"current,omitempty" url:"current,omitempty"`
	// The total number of events in this group
	Total *int `json:"total,omitempty" url:"total,omitempty"`
	// The percent complete of the event group
	Percent *int `json:"percent,omitempty" url:"percent,omitempty"`
	// contains filtered or unexported fields
}

The progress of the event within a collection of iterable events

func (*Progress) GetCurrent

func (p *Progress) GetCurrent() *int

func (*Progress) GetExtraProperties

func (p *Progress) GetExtraProperties() map[string]interface{}

func (*Progress) GetPercent

func (p *Progress) GetPercent() *int

func (*Progress) GetTotal

func (p *Progress) GetTotal() *int

func (*Progress) String

func (p *Progress) String() string

func (*Progress) UnmarshalJSON

func (p *Progress) UnmarshalJSON(data []byte) error

type Prompt

type Prompt struct {
	Id PromptId `json:"id" url:"id"`
	// ID of the user/guest who created the prompt
	CreatedById   string         `json:"createdById" url:"createdById"`
	AccountId     AccountId      `json:"accountId" url:"accountId"`
	EnvironmentId *EnvironmentId `json:"environmentId,omitempty" url:"environmentId,omitempty"`
	SpaceId       *SpaceId       `json:"spaceId,omitempty" url:"spaceId,omitempty"`
	// Type of prompt
	PromptType PromptTypeEnum `json:"promptType" url:"promptType"`
	// Text for prompts for AI Assist
	Prompt    string     `json:"prompt" url:"prompt"`
	CreatedAt time.Time  `json:"createdAt" url:"createdAt"`
	UpdatedAt time.Time  `json:"updatedAt" url:"updatedAt"`
	DeletedAt *time.Time `json:"deletedAt,omitempty" url:"deletedAt,omitempty"`
	// contains filtered or unexported fields
}

func (*Prompt) GetAccountId

func (p *Prompt) GetAccountId() AccountId

func (*Prompt) GetCreatedAt

func (p *Prompt) GetCreatedAt() time.Time

func (*Prompt) GetCreatedById

func (p *Prompt) GetCreatedById() string

func (*Prompt) GetDeletedAt

func (p *Prompt) GetDeletedAt() *time.Time

func (*Prompt) GetEnvironmentId

func (p *Prompt) GetEnvironmentId() *EnvironmentId

func (*Prompt) GetExtraProperties

func (p *Prompt) GetExtraProperties() map[string]interface{}

func (*Prompt) GetId

func (p *Prompt) GetId() PromptId

func (*Prompt) GetPrompt

func (p *Prompt) GetPrompt() string

func (*Prompt) GetPromptType

func (p *Prompt) GetPromptType() PromptTypeEnum

func (*Prompt) GetSpaceId

func (p *Prompt) GetSpaceId() *SpaceId

func (*Prompt) GetUpdatedAt

func (p *Prompt) GetUpdatedAt() time.Time

func (*Prompt) MarshalJSON

func (p *Prompt) MarshalJSON() ([]byte, error)

func (*Prompt) String

func (p *Prompt) String() string

func (*Prompt) UnmarshalJSON

func (p *Prompt) UnmarshalJSON(data []byte) error

type PromptCreate

type PromptCreate struct {
	// Type of prompt; Defaults to AI_ASSIST
	PromptType    *PromptTypeEnum `json:"promptType,omitempty" url:"promptType,omitempty"`
	Prompt        string          `json:"prompt" url:"prompt"`
	EnvironmentId EnvironmentId   `json:"environmentId" url:"environmentId"`
	SpaceId       SpaceId         `json:"spaceId" url:"spaceId"`
	// contains filtered or unexported fields
}

Create a prompts

func (*PromptCreate) GetEnvironmentId

func (p *PromptCreate) GetEnvironmentId() EnvironmentId

func (*PromptCreate) GetExtraProperties

func (p *PromptCreate) GetExtraProperties() map[string]interface{}

func (*PromptCreate) GetPrompt

func (p *PromptCreate) GetPrompt() string

func (*PromptCreate) GetPromptType

func (p *PromptCreate) GetPromptType() *PromptTypeEnum

func (*PromptCreate) GetSpaceId

func (p *PromptCreate) GetSpaceId() SpaceId

func (*PromptCreate) String

func (p *PromptCreate) String() string

func (*PromptCreate) UnmarshalJSON

func (p *PromptCreate) UnmarshalJSON(data []byte) error

type PromptId

type PromptId = string

Prompt ID

type PromptPatch

type PromptPatch struct {
	Prompt string `json:"prompt" url:"prompt"`
	// contains filtered or unexported fields
}

Update a prompts

func (*PromptPatch) GetExtraProperties

func (p *PromptPatch) GetExtraProperties() map[string]interface{}

func (*PromptPatch) GetPrompt

func (p *PromptPatch) GetPrompt() string

func (*PromptPatch) String

func (p *PromptPatch) String() string

func (*PromptPatch) UnmarshalJSON

func (p *PromptPatch) UnmarshalJSON(data []byte) error

type PromptResponse

type PromptResponse struct {
	Data *Prompt `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*PromptResponse) GetData

func (p *PromptResponse) GetData() *Prompt

func (*PromptResponse) GetExtraProperties

func (p *PromptResponse) GetExtraProperties() map[string]interface{}

func (*PromptResponse) String

func (p *PromptResponse) String() string

func (*PromptResponse) UnmarshalJSON

func (p *PromptResponse) UnmarshalJSON(data []byte) error

type PromptTypeEnum

type PromptTypeEnum string

const (
	PromptTypeEnumAiAssist             PromptTypeEnum = "AI_ASSIST"
	PromptTypeEnumConstraintGeneration PromptTypeEnum = "CONSTRAINT_GENERATION"
)

func NewPromptTypeEnumFromString

func NewPromptTypeEnumFromString(s string) (PromptTypeEnum, error)

func (PromptTypeEnum) Ptr

func (p PromptTypeEnum) Ptr() *PromptTypeEnum

type PromptTypeQueryEnum

type PromptTypeQueryEnum string

const (
	PromptTypeQueryEnumAll                  PromptTypeQueryEnum = "ALL"
	PromptTypeQueryEnumAiAssist             PromptTypeQueryEnum = "AI_ASSIST"
	PromptTypeQueryEnumConstraintGeneration PromptTypeQueryEnum = "CONSTRAINT_GENERATION"
)

func NewPromptTypeQueryEnumFromString

func NewPromptTypeQueryEnumFromString(s string) (PromptTypeQueryEnum, error)

func (PromptTypeQueryEnum) Ptr

func (p PromptTypeQueryEnum) Ptr() *PromptTypeQueryEnum

type PromptsResponse

type PromptsResponse struct {
	Pagination *Pagination `json:"pagination,omitempty" url:"pagination,omitempty"`
	Data       []*Prompt   `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*PromptsResponse) GetData

func (p *PromptsResponse) GetData() []*Prompt

func (*PromptsResponse) GetExtraProperties

func (p *PromptsResponse) GetExtraProperties() map[string]interface{}

func (*PromptsResponse) GetPagination

func (p *PromptsResponse) GetPagination() *Pagination

func (*PromptsResponse) String

func (p *PromptsResponse) String() string

func (*PromptsResponse) UnmarshalJSON

func (p *PromptsResponse) UnmarshalJSON(data []byte) error

type Property

type Property struct {
	Type          string
	String        *StringProperty
	Number        *NumberProperty
	Boolean       *BooleanProperty
	Date          *DateProperty
	Enum          *EnumProperty
	Reference     *ReferenceProperty
	ReferenceList *ReferenceListProperty
	StringList    *StringListProperty
	EnumList      *EnumListProperty
}

func NewPropertyFromBoolean

func NewPropertyFromBoolean(value *BooleanProperty) *Property

func NewPropertyFromDate

func NewPropertyFromDate(value *DateProperty) *Property

func NewPropertyFromEnum

func NewPropertyFromEnum(value *EnumProperty) *Property

func NewPropertyFromEnumList

func NewPropertyFromEnumList(value *EnumListProperty) *Property

func NewPropertyFromNumber

func NewPropertyFromNumber(value *NumberProperty) *Property

func NewPropertyFromReference

func NewPropertyFromReference(value *ReferenceProperty) *Property

func NewPropertyFromReferenceList

func NewPropertyFromReferenceList(value *ReferenceListProperty) *Property

func NewPropertyFromString

func NewPropertyFromString(value *StringProperty) *Property

func NewPropertyFromStringList

func NewPropertyFromStringList(value *StringListProperty) *Property

func (*Property) Accept

func (p *Property) Accept(visitor PropertyVisitor) error

func (*Property) GetBoolean

func (p *Property) GetBoolean() *BooleanProperty

func (*Property) GetDate

func (p *Property) GetDate() *DateProperty

func (*Property) GetEnum

func (p *Property) GetEnum() *EnumProperty

func (*Property) GetEnumList

func (p *Property) GetEnumList() *EnumListProperty

func (*Property) GetNumber

func (p *Property) GetNumber() *NumberProperty

func (*Property) GetReference

func (p *Property) GetReference() *ReferenceProperty

func (*Property) GetReferenceList

func (p *Property) GetReferenceList() *ReferenceListProperty

func (*Property) GetString

func (p *Property) GetString() *StringProperty

func (*Property) GetStringList

func (p *Property) GetStringList() *StringListProperty

func (*Property) GetType

func (p *Property) GetType() string

func (Property) MarshalJSON

func (p Property) MarshalJSON() ([]byte, error)

func (*Property) UnmarshalJSON

func (p *Property) UnmarshalJSON(data []byte) error

type PropertyVisitor

type PropertyVisitor interface {
	VisitString(*StringProperty) error
	VisitNumber(*NumberProperty) error
	VisitBoolean(*BooleanProperty) error
	VisitDate(*DateProperty) error
	VisitEnum(*EnumProperty) error
	VisitReference(*ReferenceProperty) error
	VisitReferenceList(*ReferenceListProperty) error
	VisitStringList(*StringListProperty) error
	VisitEnumList(*EnumListProperty) error
}

type Record

type Record struct {
	Id RecordId `json:"id" url:"id"`
	// Deprecated, use `commitId` instead.
	VersionId *VersionId `json:"versionId,omitempty" url:"versionId,omitempty"`
	CommitId  *CommitId  `json:"commitId,omitempty" url:"commitId,omitempty"`
	// Auto-generated value based on whether the record contains a field with an error message. Cannot be set via the API.
	Valid *bool `json:"valid,omitempty" url:"valid,omitempty"`
	// This record level `messages` property is deprecated and no longer stored or used. Use the `messages` property on the individual cell values instead. This property will be removed in a future release.
	Messages []*ValidationMessage   `json:"messages,omitempty" url:"messages,omitempty"`
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	Config   *RecordConfig          `json:"config,omitempty" url:"config,omitempty"`
	Values   RecordData             `json:"values,omitempty" url:"values,omitempty"`
	// contains filtered or unexported fields
}

A single row of data in a Sheet

func (*Record) GetCommitId

func (r *Record) GetCommitId() *CommitId

func (*Record) GetConfig

func (r *Record) GetConfig() *RecordConfig

func (*Record) GetExtraProperties

func (r *Record) GetExtraProperties() map[string]interface{}

func (*Record) GetId

func (r *Record) GetId() RecordId

func (*Record) GetMessages

func (r *Record) GetMessages() []*ValidationMessage

func (*Record) GetMetadata

func (r *Record) GetMetadata() map[string]interface{}

func (*Record) GetValid

func (r *Record) GetValid() *bool

func (*Record) GetValues

func (r *Record) GetValues() RecordData

func (*Record) GetVersionId

func (r *Record) GetVersionId() *VersionId

func (*Record) String

func (r *Record) String() string

func (*Record) UnmarshalJSON

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

type RecordBase

type RecordBase struct {
	Id RecordId `json:"id" url:"id"`
	// Deprecated, use `commitId` instead.
	VersionId *VersionId `json:"versionId,omitempty" url:"versionId,omitempty"`
	CommitId  *CommitId  `json:"commitId,omitempty" url:"commitId,omitempty"`
	// Auto-generated value based on whether the record contains a field with an error message. Cannot be set via the API.
	Valid *bool `json:"valid,omitempty" url:"valid,omitempty"`
	// This record level `messages` property is deprecated and no longer stored or used. Use the `messages` property on the individual cell values instead. This property will be removed in a future release.
	Messages []*ValidationMessage   `json:"messages,omitempty" url:"messages,omitempty"`
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	Config   *RecordConfig          `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

func (*RecordBase) GetCommitId

func (r *RecordBase) GetCommitId() *CommitId

func (*RecordBase) GetConfig

func (r *RecordBase) GetConfig() *RecordConfig

func (*RecordBase) GetExtraProperties

func (r *RecordBase) GetExtraProperties() map[string]interface{}

func (*RecordBase) GetId

func (r *RecordBase) GetId() RecordId

func (*RecordBase) GetMessages

func (r *RecordBase) GetMessages() []*ValidationMessage

func (*RecordBase) GetMetadata

func (r *RecordBase) GetMetadata() map[string]interface{}

func (*RecordBase) GetValid

func (r *RecordBase) GetValid() *bool

func (*RecordBase) GetVersionId

func (r *RecordBase) GetVersionId() *VersionId

func (*RecordBase) String

func (r *RecordBase) String() string

func (*RecordBase) UnmarshalJSON

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

type RecordConfig

type RecordConfig struct {
	Readonly          *bool                  `json:"readonly,omitempty" url:"readonly,omitempty"`
	Fields            map[string]*CellConfig `json:"fields,omitempty" url:"fields,omitempty"`
	MarkedForDeletion *bool                  `json:"markedForDeletion,omitempty" url:"markedForDeletion,omitempty"`
	// contains filtered or unexported fields
}

Configuration of a record or specific fields in the record

func (*RecordConfig) GetExtraProperties

func (r *RecordConfig) GetExtraProperties() map[string]interface{}

func (*RecordConfig) GetFields

func (r *RecordConfig) GetFields() map[string]*CellConfig

func (*RecordConfig) GetMarkedForDeletion

func (r *RecordConfig) GetMarkedForDeletion() *bool

func (*RecordConfig) GetReadonly

func (r *RecordConfig) GetReadonly() *bool

func (*RecordConfig) String

func (r *RecordConfig) String() string

func (*RecordConfig) UnmarshalJSON

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

type RecordCounts

type RecordCounts struct {
	Total         int            `json:"total" url:"total"`
	Valid         int            `json:"valid" url:"valid"`
	Error         int            `json:"error" url:"error"`
	ErrorsByField map[string]int `json:"errorsByField,omitempty" url:"errorsByField,omitempty"`
	// Counts for valid, error, and total records grouped by field key
	ByField map[string]*FieldRecordCounts `json:"byField,omitempty" url:"byField,omitempty"`
	// contains filtered or unexported fields
}

func (*RecordCounts) GetByField

func (r *RecordCounts) GetByField() map[string]*FieldRecordCounts

func (*RecordCounts) GetError

func (r *RecordCounts) GetError() int

func (*RecordCounts) GetErrorsByField

func (r *RecordCounts) GetErrorsByField() map[string]int

func (*RecordCounts) GetExtraProperties

func (r *RecordCounts) GetExtraProperties() map[string]interface{}

func (*RecordCounts) GetTotal

func (r *RecordCounts) GetTotal() int

func (*RecordCounts) GetValid

func (r *RecordCounts) GetValid() int

func (*RecordCounts) String

func (r *RecordCounts) String() string

func (*RecordCounts) UnmarshalJSON

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

type RecordCountsResponse

type RecordCountsResponse struct {
	Data *RecordCountsResponseData `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*RecordCountsResponse) GetData

func (r *RecordCountsResponse) GetData() *RecordCountsResponseData

func (*RecordCountsResponse) GetExtraProperties

func (r *RecordCountsResponse) GetExtraProperties() map[string]interface{}

func (*RecordCountsResponse) String

func (r *RecordCountsResponse) String() string

func (*RecordCountsResponse) UnmarshalJSON

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

type RecordCountsResponseData

type RecordCountsResponseData struct {
	Counts  *RecordCounts `json:"counts,omitempty" url:"counts,omitempty"`
	Success bool          `json:"success" url:"success"`
	// contains filtered or unexported fields
}

func (*RecordCountsResponseData) GetCounts

func (r *RecordCountsResponseData) GetCounts() *RecordCounts

func (*RecordCountsResponseData) GetExtraProperties

func (r *RecordCountsResponseData) GetExtraProperties() map[string]interface{}

func (*RecordCountsResponseData) GetSuccess

func (r *RecordCountsResponseData) GetSuccess() bool

func (*RecordCountsResponseData) String

func (r *RecordCountsResponseData) String() string

func (*RecordCountsResponseData) UnmarshalJSON

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

type RecordData

type RecordData = map[string]*CellValue

A single row of data in a Sheet

type RecordDataWithLinks

type RecordDataWithLinks = map[string]*CellValueWithLinks

A single row of data in a Sheet, including links to related rows

type RecordId

type RecordId = string

Record ID

type RecordIndices

type RecordIndices struct {
	Id    string `json:"id" url:"id"`
	Index int    `json:"index" url:"index"`
	// contains filtered or unexported fields
}

A record index object

func (*RecordIndices) GetExtraProperties

func (r *RecordIndices) GetExtraProperties() map[string]interface{}

func (*RecordIndices) GetId

func (r *RecordIndices) GetId() string

func (*RecordIndices) GetIndex

func (r *RecordIndices) GetIndex() int

func (*RecordIndices) String

func (r *RecordIndices) String() string

func (*RecordIndices) UnmarshalJSON

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

type RecordWithLinks

type RecordWithLinks struct {
	Id       RecordId               `json:"id" url:"id"`
	Values   RecordDataWithLinks    `json:"values,omitempty" url:"values,omitempty"`
	Valid    *bool                  `json:"valid,omitempty" url:"valid,omitempty"`
	Messages []*ValidationMessage   `json:"messages,omitempty" url:"messages,omitempty"`
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	Config   *RecordConfig          `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

A single row of data in a Sheet, including links to related rows

func (*RecordWithLinks) GetConfig

func (r *RecordWithLinks) GetConfig() *RecordConfig

func (*RecordWithLinks) GetExtraProperties

func (r *RecordWithLinks) GetExtraProperties() map[string]interface{}

func (*RecordWithLinks) GetId

func (r *RecordWithLinks) GetId() RecordId

func (*RecordWithLinks) GetMessages

func (r *RecordWithLinks) GetMessages() []*ValidationMessage

func (*RecordWithLinks) GetMetadata

func (r *RecordWithLinks) GetMetadata() map[string]interface{}

func (*RecordWithLinks) GetValid

func (r *RecordWithLinks) GetValid() *bool

func (*RecordWithLinks) GetValues

func (r *RecordWithLinks) GetValues() RecordDataWithLinks

func (*RecordWithLinks) String

func (r *RecordWithLinks) String() string

func (*RecordWithLinks) UnmarshalJSON

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

type Records

type Records = []*Record

List of Record objects

type RecordsResponse

type RecordsResponse struct {
	Data *RecordsResponseData `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*RecordsResponse) GetData

func (r *RecordsResponse) GetData() *RecordsResponseData

func (*RecordsResponse) GetExtraProperties

func (r *RecordsResponse) GetExtraProperties() map[string]interface{}

func (*RecordsResponse) String

func (r *RecordsResponse) String() string

func (*RecordsResponse) UnmarshalJSON

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

type RecordsResponseData

type RecordsResponseData struct {
	Success bool              `json:"success" url:"success"`
	Records *RecordsWithLinks `json:"records,omitempty" url:"records,omitempty"`
	Counts  *RecordCounts     `json:"counts,omitempty" url:"counts,omitempty"`
	// Deprecated, use `commitId` instead.
	VersionId *VersionId `json:"versionId,omitempty" url:"versionId,omitempty"`
	CommitId  *CommitId  `json:"commitId,omitempty" url:"commitId,omitempty"`
	// contains filtered or unexported fields
}

func (*RecordsResponseData) GetCommitId

func (r *RecordsResponseData) GetCommitId() *CommitId

func (*RecordsResponseData) GetCounts

func (r *RecordsResponseData) GetCounts() *RecordCounts

func (*RecordsResponseData) GetExtraProperties

func (r *RecordsResponseData) GetExtraProperties() map[string]interface{}

func (*RecordsResponseData) GetRecords

func (r *RecordsResponseData) GetRecords() *RecordsWithLinks

func (*RecordsResponseData) GetSuccess

func (r *RecordsResponseData) GetSuccess() bool

func (*RecordsResponseData) GetVersionId

func (r *RecordsResponseData) GetVersionId() *VersionId

func (*RecordsResponseData) String

func (r *RecordsResponseData) String() string

func (*RecordsResponseData) UnmarshalJSON

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

type RecordsWithLinks

type RecordsWithLinks = []*RecordWithLinks

List of Record objects, including links to related rows

type ReferenceListProperty

type ReferenceListProperty struct {
	Key string `json:"key" url:"key"`
	// User friendly field name
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// A short description of the field. Markdown syntax is supported.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values.
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,omitempty"`
	// An array of actions that end users can perform on this Column.
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// Useful for any contextual metadata regarding the schema. Store any valid json here.
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// A unique presentation for a field in the UI.
	Treatments       []string `json:"treatments,omitempty" url:"treatments,omitempty"`
	AlternativeNames []string `json:"alternativeNames,omitempty" url:"alternativeNames,omitempty"`
	// Will allow multiple values and store as an array
	IsArray *bool                        `json:"isArray,omitempty" url:"isArray,omitempty"`
	Config  *ReferenceListPropertyConfig `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

Defines an array of values referenced from another sheet. Links should be established automatically by the matching engine or similar upon an evaluation of unique or similar columns between datasets.

func (*ReferenceListProperty) GetActions

func (r *ReferenceListProperty) GetActions() []*Action

func (*ReferenceListProperty) GetAlternativeNames

func (r *ReferenceListProperty) GetAlternativeNames() []string

func (*ReferenceListProperty) GetAppearance

func (r *ReferenceListProperty) GetAppearance() *FieldAppearance

func (*ReferenceListProperty) GetConfig

func (r *ReferenceListProperty) GetConfig() *ReferenceListPropertyConfig

func (*ReferenceListProperty) GetConstraints

func (r *ReferenceListProperty) GetConstraints() []*Constraint

func (*ReferenceListProperty) GetDescription

func (r *ReferenceListProperty) GetDescription() *string

func (*ReferenceListProperty) GetExtraProperties

func (r *ReferenceListProperty) GetExtraProperties() map[string]interface{}

func (*ReferenceListProperty) GetIsArray

func (r *ReferenceListProperty) GetIsArray() *bool

func (*ReferenceListProperty) GetKey

func (r *ReferenceListProperty) GetKey() string

func (*ReferenceListProperty) GetLabel

func (r *ReferenceListProperty) GetLabel() *string

func (*ReferenceListProperty) GetMetadata

func (r *ReferenceListProperty) GetMetadata() interface{}

func (*ReferenceListProperty) GetReadonly

func (r *ReferenceListProperty) GetReadonly() *bool

func (*ReferenceListProperty) GetTreatments

func (r *ReferenceListProperty) GetTreatments() []string

func (*ReferenceListProperty) String

func (r *ReferenceListProperty) String() string

func (*ReferenceListProperty) UnmarshalJSON

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

type ReferenceListPropertyConfig

type ReferenceListPropertyConfig struct {
	// Full path reference to a sheet configuration. Must be in the same workbook.
	Ref string `json:"ref" url:"ref"`
	// Key of the property to use as the reference key. Defaults to `id`
	Key string `json:"key" url:"key"`
	// contains filtered or unexported fields
}

func (*ReferenceListPropertyConfig) GetExtraProperties

func (r *ReferenceListPropertyConfig) GetExtraProperties() map[string]interface{}

func (*ReferenceListPropertyConfig) GetKey

func (r *ReferenceListPropertyConfig) GetKey() string

func (*ReferenceListPropertyConfig) GetRef

func (r *ReferenceListPropertyConfig) GetRef() string

func (*ReferenceListPropertyConfig) String

func (r *ReferenceListPropertyConfig) String() string

func (*ReferenceListPropertyConfig) UnmarshalJSON

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

type ReferenceProperty

type ReferenceProperty struct {
	Key string `json:"key" url:"key"`
	// User friendly field name
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// A short description of the field. Markdown syntax is supported.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values.
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,omitempty"`
	// An array of actions that end users can perform on this Column.
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// Useful for any contextual metadata regarding the schema. Store any valid json here.
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// A unique presentation for a field in the UI.
	Treatments       []string `json:"treatments,omitempty" url:"treatments,omitempty"`
	AlternativeNames []string `json:"alternativeNames,omitempty" url:"alternativeNames,omitempty"`
	// Will allow multiple values and store as an array
	IsArray *bool                    `json:"isArray,omitempty" url:"isArray,omitempty"`
	Config  *ReferencePropertyConfig `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

Defines a reference to another sheet. Links should be established automatically by the matching engine or similar upon an evaluation of unique or similar columns between datasets.

func (*ReferenceProperty) GetActions

func (r *ReferenceProperty) GetActions() []*Action

func (*ReferenceProperty) GetAlternativeNames

func (r *ReferenceProperty) GetAlternativeNames() []string

func (*ReferenceProperty) GetAppearance

func (r *ReferenceProperty) GetAppearance() *FieldAppearance

func (*ReferenceProperty) GetConfig

func (r *ReferenceProperty) GetConfig() *ReferencePropertyConfig

func (*ReferenceProperty) GetConstraints

func (r *ReferenceProperty) GetConstraints() []*Constraint

func (*ReferenceProperty) GetDescription

func (r *ReferenceProperty) GetDescription() *string

func (*ReferenceProperty) GetExtraProperties

func (r *ReferenceProperty) GetExtraProperties() map[string]interface{}

func (*ReferenceProperty) GetIsArray

func (r *ReferenceProperty) GetIsArray() *bool

func (*ReferenceProperty) GetKey

func (r *ReferenceProperty) GetKey() string

func (*ReferenceProperty) GetLabel

func (r *ReferenceProperty) GetLabel() *string

func (*ReferenceProperty) GetMetadata

func (r *ReferenceProperty) GetMetadata() interface{}

func (*ReferenceProperty) GetReadonly

func (r *ReferenceProperty) GetReadonly() *bool

func (*ReferenceProperty) GetTreatments

func (r *ReferenceProperty) GetTreatments() []string

func (*ReferenceProperty) String

func (r *ReferenceProperty) String() string

func (*ReferenceProperty) UnmarshalJSON

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

type ReferencePropertyConfig

type ReferencePropertyConfig struct {
	// Full path reference to a sheet configuration. Must be in the same workbook.
	Ref string `json:"ref" url:"ref"`
	// Key of the property to use as the reference key. Defaults to `id`
	Key string `json:"key" url:"key"`
	// The type of relationship this defines
	Relationship *ReferencePropertyRelationship `json:"relationship,omitempty" url:"relationship,omitempty"`
	// contains filtered or unexported fields
}

func (*ReferencePropertyConfig) GetExtraProperties

func (r *ReferencePropertyConfig) GetExtraProperties() map[string]interface{}

func (*ReferencePropertyConfig) GetKey

func (r *ReferencePropertyConfig) GetKey() string

func (*ReferencePropertyConfig) GetRef

func (r *ReferencePropertyConfig) GetRef() string

func (*ReferencePropertyConfig) GetRelationship

func (r *ReferencePropertyConfig) GetRelationship() *ReferencePropertyRelationship

func (*ReferencePropertyConfig) String

func (r *ReferencePropertyConfig) String() string

func (*ReferencePropertyConfig) UnmarshalJSON

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

type ReferencePropertyRelationship

type ReferencePropertyRelationship string

const (
	ReferencePropertyRelationshipHasOne  ReferencePropertyRelationship = "has-one"
	ReferencePropertyRelationshipHasMany ReferencePropertyRelationship = "has-many"
)

func NewReferencePropertyRelationshipFromString

func NewReferencePropertyRelationshipFromString(s string) (ReferencePropertyRelationship, error)

func (ReferencePropertyRelationship) Ptr

func (r ReferencePropertyRelationship) Ptr() *ReferencePropertyRelationship

type Resolve

type Resolve struct {
	Field              *string      `json:"field,omitempty" url:"field,omitempty"`
	Type               *ResolveType `json:"type,omitempty" url:"type,omitempty"`
	ResolveTo          *ResolveTo   `json:"resolveTo,omitempty" url:"resolveTo,omitempty"`
	ClipValueReference *string      `json:"clip_value_reference,omitempty" url:"clip_value_reference,omitempty"`
	MainValueReference *string      `json:"main_value_reference,omitempty" url:"main_value_reference,omitempty"`
	// contains filtered or unexported fields
}

Conflict resolutions for a record

func (*Resolve) GetClipValueReference

func (r *Resolve) GetClipValueReference() *string

func (*Resolve) GetExtraProperties

func (r *Resolve) GetExtraProperties() map[string]interface{}

func (*Resolve) GetField

func (r *Resolve) GetField() *string

func (*Resolve) GetMainValueReference

func (r *Resolve) GetMainValueReference() *string

func (*Resolve) GetResolveTo

func (r *Resolve) GetResolveTo() *ResolveTo

func (*Resolve) GetType

func (r *Resolve) GetType() *ResolveType

func (*Resolve) String

func (r *Resolve) String() string

func (*Resolve) UnmarshalJSON

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

type ResolveTo

type ResolveTo string

const (
	ResolveToClip     ResolveTo = "clip"
	ResolveToMain     ResolveTo = "main"
	ResolveToSnapshot ResolveTo = "snapshot"
)

func NewResolveToFromString

func NewResolveToFromString(s string) (ResolveTo, error)

func (ResolveTo) Ptr

func (r ResolveTo) Ptr() *ResolveTo

type ResolveType

type ResolveType string

const (
	ResolveTypeConflict ResolveType = "conflict"
	ResolveTypeResolve  ResolveType = "resolve"
)

func NewResolveTypeFromString

func NewResolveTypeFromString(s string) (ResolveType, error)

func (ResolveType) Ptr

func (r ResolveType) Ptr() *ResolveType

type ResourceIdUnion

type ResourceIdUnion struct {
	AccountId     AccountId
	EnvironmentId EnvironmentId
	SpaceId       SpaceId
	// contains filtered or unexported fields
}

func NewResourceIdUnionFromAccountId

func NewResourceIdUnionFromAccountId(value AccountId) *ResourceIdUnion

func NewResourceIdUnionFromEnvironmentId

func NewResourceIdUnionFromEnvironmentId(value EnvironmentId) *ResourceIdUnion

func NewResourceIdUnionFromSpaceId

func NewResourceIdUnionFromSpaceId(value SpaceId) *ResourceIdUnion

func (*ResourceIdUnion) Accept

func (r *ResourceIdUnion) Accept(visitor ResourceIdUnionVisitor) error

func (*ResourceIdUnion) GetAccountId

func (r *ResourceIdUnion) GetAccountId() AccountId

func (*ResourceIdUnion) GetEnvironmentId

func (r *ResourceIdUnion) GetEnvironmentId() EnvironmentId

func (*ResourceIdUnion) GetSpaceId

func (r *ResourceIdUnion) GetSpaceId() SpaceId

func (ResourceIdUnion) MarshalJSON

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

func (*ResourceIdUnion) UnmarshalJSON

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

type ResourceIdUnionVisitor

type ResourceIdUnionVisitor interface {
	VisitAccountId(AccountId) error
	VisitEnvironmentId(EnvironmentId) error
	VisitSpaceId(SpaceId) error
}

type ResourceJobSubject

type ResourceJobSubject struct {
	Id string `json:"id" url:"id"`
	// contains filtered or unexported fields
}

func (*ResourceJobSubject) GetExtraProperties

func (r *ResourceJobSubject) GetExtraProperties() map[string]interface{}

func (*ResourceJobSubject) GetId

func (r *ResourceJobSubject) GetId() string

func (*ResourceJobSubject) String

func (r *ResourceJobSubject) String() string

func (*ResourceJobSubject) UnmarshalJSON

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

type RestoreOptions

type RestoreOptions struct {
	Created bool `json:"created" url:"created"`
	Updated bool `json:"updated" url:"updated"`
	Deleted bool `json:"deleted" url:"deleted"`
	// contains filtered or unexported fields
}

func (*RestoreOptions) GetCreated

func (r *RestoreOptions) GetCreated() bool

func (*RestoreOptions) GetDeleted

func (r *RestoreOptions) GetDeleted() bool

func (*RestoreOptions) GetExtraProperties

func (r *RestoreOptions) GetExtraProperties() map[string]interface{}

func (*RestoreOptions) GetUpdated

func (r *RestoreOptions) GetUpdated() bool

func (*RestoreOptions) String

func (r *RestoreOptions) String() string

func (*RestoreOptions) UnmarshalJSON

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

type RoleEnum

type RoleEnum string

const (
	RoleEnumAdmin RoleEnum = "admin"
	RoleEnumGuest RoleEnum = "guest"
)

func NewRoleEnumFromString

func NewRoleEnumFromString(s string) (RoleEnum, error)

func (RoleEnum) Ptr

func (r RoleEnum) Ptr() *RoleEnum

type RoleId

type RoleId = string

Role ID

type RoleResponse

type RoleResponse struct {
	Id        RoleId    `json:"id" url:"id"`
	Name      string    `json:"name" url:"name"`
	AccountId AccountId `json:"accountId" url:"accountId"`
	CreatedAt time.Time `json:"createdAt" url:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt" url:"updatedAt"`
	// contains filtered or unexported fields
}

func (*RoleResponse) GetAccountId

func (r *RoleResponse) GetAccountId() AccountId

func (*RoleResponse) GetCreatedAt

func (r *RoleResponse) GetCreatedAt() time.Time

func (*RoleResponse) GetExtraProperties

func (r *RoleResponse) GetExtraProperties() map[string]interface{}

func (*RoleResponse) GetId

func (r *RoleResponse) GetId() RoleId

func (*RoleResponse) GetName

func (r *RoleResponse) GetName() string

func (*RoleResponse) GetUpdatedAt

func (r *RoleResponse) GetUpdatedAt() time.Time

func (*RoleResponse) MarshalJSON

func (r *RoleResponse) MarshalJSON() ([]byte, error)

func (*RoleResponse) String

func (r *RoleResponse) String() string

func (*RoleResponse) UnmarshalJSON

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

type SchemaDiffData

type SchemaDiffData = map[string]SchemaDiffEnum

type SchemaDiffEnum

type SchemaDiffEnum string

const (
	SchemaDiffEnumAdded     SchemaDiffEnum = "added"
	SchemaDiffEnumRemoved   SchemaDiffEnum = "removed"
	SchemaDiffEnumUnchanged SchemaDiffEnum = "unchanged"
)

func NewSchemaDiffEnumFromString

func NewSchemaDiffEnumFromString(s string) (SchemaDiffEnum, error)

func (SchemaDiffEnum) Ptr

func (s SchemaDiffEnum) Ptr() *SchemaDiffEnum

type SchemaDiffRecord

type SchemaDiffRecord = SchemaDiffData

type SearchField

type SearchField = string

Use this to narrow the searchValue results to a specific field

type SearchValue

type SearchValue = string

Search for the given value, returning matching rows. For exact matches, wrap the value in double quotes ("Bob"). To search for null values, send empty double quotes ("")

type Secret

type Secret struct {
	// The reference name for a secret.
	Name SecretName `json:"name" url:"name"`
	// The secret value. This is hidden in the UI.
	Value SecretValue `json:"value" url:"value"`
	// The Environment of the secret.
	EnvironmentId *EnvironmentId `json:"environmentId,omitempty" url:"environmentId,omitempty"`
	// The Space of the secret.
	SpaceId *SpaceId `json:"spaceId,omitempty" url:"spaceId,omitempty"`
	// The Actor of the secret.
	ActorId *ActorIdUnion `json:"actorId,omitempty" url:"actorId,omitempty"`
	// The ID of the secret.
	Id SecretId `json:"id" url:"id"`
	// contains filtered or unexported fields
}

The value of a secret

func (*Secret) GetActorId

func (s *Secret) GetActorId() *ActorIdUnion

func (*Secret) GetEnvironmentId

func (s *Secret) GetEnvironmentId() *EnvironmentId

func (*Secret) GetExtraProperties

func (s *Secret) GetExtraProperties() map[string]interface{}

func (*Secret) GetId

func (s *Secret) GetId() SecretId

func (*Secret) GetName

func (s *Secret) GetName() SecretName

func (*Secret) GetSpaceId

func (s *Secret) GetSpaceId() *SpaceId

func (*Secret) GetValue

func (s *Secret) GetValue() SecretValue

func (*Secret) String

func (s *Secret) String() string

func (*Secret) UnmarshalJSON

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

type SecretId

type SecretId = string

Secret ID

type SecretName

type SecretName = string

The name of a secret. Minimum 1 character, maximum 1024

type SecretValue

type SecretValue = string

The value of a secret. Minimum 1 character, maximum 1024

type SecretsResponse

type SecretsResponse struct {
	Data []*Secret `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*SecretsResponse) GetData

func (s *SecretsResponse) GetData() []*Secret

func (*SecretsResponse) GetExtraProperties

func (s *SecretsResponse) GetExtraProperties() map[string]interface{}

func (*SecretsResponse) String

func (s *SecretsResponse) String() string

func (*SecretsResponse) UnmarshalJSON

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

type Sheet

type Sheet struct {
	// The ID of the Sheet.
	Id SheetId `json:"id" url:"id"`
	// The ID of the Workbook.
	WorkbookId WorkbookId `json:"workbookId" url:"workbookId"`
	// The name of the Sheet.
	Name string `json:"name" url:"name"`
	// The slug of the Sheet.
	Slug string `json:"slug" url:"slug"`
	// Describes shape of data as well as behavior
	Config *SheetConfig `json:"config,omitempty" url:"config,omitempty"`
	// Useful for any contextual metadata regarding the sheet. Store any valid json
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// The scoped namespace of the Sheet.
	Namespace *string `json:"namespace,omitempty" url:"namespace,omitempty"`
	// The actor who locked the Sheet.
	LockedBy *string `json:"lockedBy,omitempty" url:"lockedBy,omitempty"`
	// Date the sheet was last updated
	UpdatedAt time.Time `json:"updatedAt" url:"updatedAt"`
	// Date the sheet was created
	CreatedAt time.Time `json:"createdAt" url:"createdAt"`
	// The time the Sheet was locked.
	LockedAt *time.Time `json:"lockedAt,omitempty" url:"lockedAt,omitempty"`
	// The precomputed counts of records in the Sheet (may not exist).
	RecordCounts *RecordCounts `json:"recordCounts,omitempty" url:"recordCounts,omitempty"`
	// contains filtered or unexported fields
}

A place to store tabular data

func (*Sheet) GetConfig

func (s *Sheet) GetConfig() *SheetConfig

func (*Sheet) GetCreatedAt

func (s *Sheet) GetCreatedAt() time.Time

func (*Sheet) GetExtraProperties

func (s *Sheet) GetExtraProperties() map[string]interface{}

func (*Sheet) GetId

func (s *Sheet) GetId() SheetId

func (*Sheet) GetLockedAt

func (s *Sheet) GetLockedAt() *time.Time

func (*Sheet) GetLockedBy

func (s *Sheet) GetLockedBy() *string

func (*Sheet) GetMetadata

func (s *Sheet) GetMetadata() interface{}

func (*Sheet) GetName

func (s *Sheet) GetName() string

func (*Sheet) GetNamespace

func (s *Sheet) GetNamespace() *string

func (*Sheet) GetRecordCounts

func (s *Sheet) GetRecordCounts() *RecordCounts

func (*Sheet) GetSlug

func (s *Sheet) GetSlug() string

func (*Sheet) GetUpdatedAt

func (s *Sheet) GetUpdatedAt() time.Time

func (*Sheet) GetWorkbookId

func (s *Sheet) GetWorkbookId() WorkbookId

func (*Sheet) MarshalJSON

func (s *Sheet) MarshalJSON() ([]byte, error)

func (*Sheet) String

func (s *Sheet) String() string

func (*Sheet) UnmarshalJSON

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

type SheetAccess

type SheetAccess string

const (
	SheetAccessAll    SheetAccess = "*"
	SheetAccessAdd    SheetAccess = "add"
	SheetAccessEdit   SheetAccess = "edit"
	SheetAccessDelete SheetAccess = "delete"
	SheetAccessImport SheetAccess = "import"
)

func NewSheetAccessFromString

func NewSheetAccessFromString(s string) (SheetAccess, error)

func (SheetAccess) Ptr

func (s SheetAccess) Ptr() *SheetAccess

type SheetConfig

type SheetConfig struct {
	// The name of your Sheet as it will appear to your end users.
	Name string `json:"name" url:"name"`
	// A sentence or two describing the purpose of your Sheet.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// A unique identifier for your Sheet.
	Slug *string `json:"slug,omitempty" url:"slug,omitempty"`
	// A boolean specifying whether or not this sheet is read only. Read only sheets are not editable by end users.
	Readonly *bool `json:"readonly,omitempty" url:"readonly,omitempty"`
	// Allow end users to add fields during mapping.
	AllowAdditionalFields *bool `json:"allowAdditionalFields,omitempty" url:"allowAdditionalFields,omitempty"`
	// The minimum confidence required to automatically map a field
	MappingConfidenceThreshold *float64 `json:"mappingConfidenceThreshold,omitempty" url:"mappingConfidenceThreshold,omitempty"`
	// Control Sheet-level access for all users.
	Access []SheetAccess `json:"access,omitempty" url:"access,omitempty"`
	// Where you define your Sheet’s data schema.
	Fields []*Property `json:"fields,omitempty" url:"fields,omitempty"`
	// An array of actions that end users can perform on this Sheet.
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// Useful for any contextual metadata regarding the schema. Store any valid json
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// An array of constraints that end users can perform on this Sheet.
	Constraints []*SheetConstraint `json:"constraints,omitempty" url:"constraints,omitempty"`
	// contains filtered or unexported fields
}

Describes shape of data as well as behavior

func (*SheetConfig) GetAccess

func (s *SheetConfig) GetAccess() []SheetAccess

func (*SheetConfig) GetActions

func (s *SheetConfig) GetActions() []*Action

func (*SheetConfig) GetAllowAdditionalFields

func (s *SheetConfig) GetAllowAdditionalFields() *bool

func (*SheetConfig) GetConstraints

func (s *SheetConfig) GetConstraints() []*SheetConstraint

func (*SheetConfig) GetDescription

func (s *SheetConfig) GetDescription() *string

func (*SheetConfig) GetExtraProperties

func (s *SheetConfig) GetExtraProperties() map[string]interface{}

func (*SheetConfig) GetFields

func (s *SheetConfig) GetFields() []*Property

func (*SheetConfig) GetMappingConfidenceThreshold

func (s *SheetConfig) GetMappingConfidenceThreshold() *float64

func (*SheetConfig) GetMetadata

func (s *SheetConfig) GetMetadata() interface{}

func (*SheetConfig) GetName

func (s *SheetConfig) GetName() string

func (*SheetConfig) GetReadonly

func (s *SheetConfig) GetReadonly() *bool

func (*SheetConfig) GetSlug

func (s *SheetConfig) GetSlug() *string

func (*SheetConfig) String

func (s *SheetConfig) String() string

func (*SheetConfig) UnmarshalJSON

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

type SheetConfigOrUpdate

type SheetConfigOrUpdate struct {
	// The name of your Sheet as it will appear to your end users.
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// A sentence or two describing the purpose of your Sheet.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// A unique identifier for your Sheet. **Required when updating a Workbook.**
	Slug *string `json:"slug,omitempty" url:"slug,omitempty"`
	// A boolean specifying whether or not this sheet is read only. Read only sheets are not editable by end users.
	Readonly *bool `json:"readonly,omitempty" url:"readonly,omitempty"`
	// Allow end users to add fields during mapping.
	AllowAdditionalFields *bool `json:"allowAdditionalFields,omitempty" url:"allowAdditionalFields,omitempty"`
	// The minimum confidence required to automatically map a field
	MappingConfidenceThreshold *float64 `json:"mappingConfidenceThreshold,omitempty" url:"mappingConfidenceThreshold,omitempty"`
	// Control Sheet-level access for all users.
	Access []SheetAccess `json:"access,omitempty" url:"access,omitempty"`
	// Where you define your Sheet’s data schema.
	Fields []*Property `json:"fields,omitempty" url:"fields,omitempty"`
	// An array of actions that end users can perform on this Sheet.
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// The ID of the Sheet.
	Id *SheetId `json:"id,omitempty" url:"id,omitempty"`
	// The ID of the Workbook.
	WorkbookId *WorkbookId `json:"workbookId,omitempty" url:"workbookId,omitempty"`
	// Describes shape of data as well as behavior.
	Config *SheetConfig `json:"config,omitempty" url:"config,omitempty"`
	// Useful for any contextual metadata regarding the sheet. Store any valid json
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// The scoped namespace of the Sheet.
	Namespace *string `json:"namespace,omitempty" url:"namespace,omitempty"`
	// Date the sheet was last updated
	UpdatedAt *time.Time `json:"updatedAt,omitempty" url:"updatedAt,omitempty"`
	// Date the sheet was created
	CreatedAt *time.Time `json:"createdAt,omitempty" url:"createdAt,omitempty"`
	// contains filtered or unexported fields
}

func (*SheetConfigOrUpdate) GetAccess

func (s *SheetConfigOrUpdate) GetAccess() []SheetAccess

func (*SheetConfigOrUpdate) GetActions

func (s *SheetConfigOrUpdate) GetActions() []*Action

func (*SheetConfigOrUpdate) GetAllowAdditionalFields

func (s *SheetConfigOrUpdate) GetAllowAdditionalFields() *bool

func (*SheetConfigOrUpdate) GetConfig

func (s *SheetConfigOrUpdate) GetConfig() *SheetConfig

func (*SheetConfigOrUpdate) GetCreatedAt

func (s *SheetConfigOrUpdate) GetCreatedAt() *time.Time

func (*SheetConfigOrUpdate) GetDescription

func (s *SheetConfigOrUpdate) GetDescription() *string

func (*SheetConfigOrUpdate) GetExtraProperties

func (s *SheetConfigOrUpdate) GetExtraProperties() map[string]interface{}

func (*SheetConfigOrUpdate) GetFields

func (s *SheetConfigOrUpdate) GetFields() []*Property

func (*SheetConfigOrUpdate) GetId

func (s *SheetConfigOrUpdate) GetId() *SheetId

func (*SheetConfigOrUpdate) GetMappingConfidenceThreshold

func (s *SheetConfigOrUpdate) GetMappingConfidenceThreshold() *float64

func (*SheetConfigOrUpdate) GetMetadata

func (s *SheetConfigOrUpdate) GetMetadata() interface{}

func (*SheetConfigOrUpdate) GetName

func (s *SheetConfigOrUpdate) GetName() *string

func (*SheetConfigOrUpdate) GetNamespace

func (s *SheetConfigOrUpdate) GetNamespace() *string

func (*SheetConfigOrUpdate) GetReadonly

func (s *SheetConfigOrUpdate) GetReadonly() *bool

func (*SheetConfigOrUpdate) GetSlug

func (s *SheetConfigOrUpdate) GetSlug() *string

func (*SheetConfigOrUpdate) GetUpdatedAt

func (s *SheetConfigOrUpdate) GetUpdatedAt() *time.Time

func (*SheetConfigOrUpdate) GetWorkbookId

func (s *SheetConfigOrUpdate) GetWorkbookId() *WorkbookId

func (*SheetConfigOrUpdate) MarshalJSON

func (s *SheetConfigOrUpdate) MarshalJSON() ([]byte, error)

func (*SheetConfigOrUpdate) String

func (s *SheetConfigOrUpdate) String() string

func (*SheetConfigOrUpdate) UnmarshalJSON

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

type SheetConfigUpdate

type SheetConfigUpdate struct {
	// The name of your Sheet as it will appear to your end users.
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// A sentence or two describing the purpose of your Sheet.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// A unique identifier for your Sheet. **Required when updating a Workbook.**
	Slug *string `json:"slug,omitempty" url:"slug,omitempty"`
	// A boolean specifying whether or not this sheet is read only. Read only sheets are not editable by end users.
	Readonly *bool `json:"readonly,omitempty" url:"readonly,omitempty"`
	// Allow end users to add fields during mapping.
	AllowAdditionalFields *bool `json:"allowAdditionalFields,omitempty" url:"allowAdditionalFields,omitempty"`
	// The minimum confidence required to automatically map a field
	MappingConfidenceThreshold *float64 `json:"mappingConfidenceThreshold,omitempty" url:"mappingConfidenceThreshold,omitempty"`
	// Control Sheet-level access for all users.
	Access []SheetAccess `json:"access,omitempty" url:"access,omitempty"`
	// Where you define your Sheet’s data schema.
	Fields []*Property `json:"fields,omitempty" url:"fields,omitempty"`
	// An array of actions that end users can perform on this Sheet.
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// contains filtered or unexported fields
}

Changes to make to an existing sheet config

func (*SheetConfigUpdate) GetAccess

func (s *SheetConfigUpdate) GetAccess() []SheetAccess

func (*SheetConfigUpdate) GetActions

func (s *SheetConfigUpdate) GetActions() []*Action

func (*SheetConfigUpdate) GetAllowAdditionalFields

func (s *SheetConfigUpdate) GetAllowAdditionalFields() *bool

func (*SheetConfigUpdate) GetDescription

func (s *SheetConfigUpdate) GetDescription() *string

func (*SheetConfigUpdate) GetExtraProperties

func (s *SheetConfigUpdate) GetExtraProperties() map[string]interface{}

func (*SheetConfigUpdate) GetFields

func (s *SheetConfigUpdate) GetFields() []*Property

func (*SheetConfigUpdate) GetMappingConfidenceThreshold

func (s *SheetConfigUpdate) GetMappingConfidenceThreshold() *float64

func (*SheetConfigUpdate) GetName

func (s *SheetConfigUpdate) GetName() *string

func (*SheetConfigUpdate) GetReadonly

func (s *SheetConfigUpdate) GetReadonly() *bool

func (*SheetConfigUpdate) GetSlug

func (s *SheetConfigUpdate) GetSlug() *string

func (*SheetConfigUpdate) String

func (s *SheetConfigUpdate) String() string

func (*SheetConfigUpdate) UnmarshalJSON

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

type SheetConstraint

type SheetConstraint struct {
	Type     string
	Unique   *CompositeUniqueConstraint
	External *ExternalSheetConstraint
}

func NewSheetConstraintFromExternal

func NewSheetConstraintFromExternal(value *ExternalSheetConstraint) *SheetConstraint

func NewSheetConstraintFromUnique

func NewSheetConstraintFromUnique(value *CompositeUniqueConstraint) *SheetConstraint

func (*SheetConstraint) Accept

func (s *SheetConstraint) Accept(visitor SheetConstraintVisitor) error

func (*SheetConstraint) GetExternal

func (s *SheetConstraint) GetExternal() *ExternalSheetConstraint

func (*SheetConstraint) GetType

func (s *SheetConstraint) GetType() string

func (*SheetConstraint) GetUnique

func (s *SheetConstraint) GetUnique() *CompositeUniqueConstraint

func (SheetConstraint) MarshalJSON

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

func (*SheetConstraint) UnmarshalJSON

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

type SheetConstraintVisitor

type SheetConstraintVisitor interface {
	VisitUnique(*CompositeUniqueConstraint) error
	VisitExternal(*ExternalSheetConstraint) error
}

type SheetId

type SheetId = string

Sheet ID

type SheetResponse

type SheetResponse struct {
	Data *Sheet `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*SheetResponse) GetData

func (s *SheetResponse) GetData() *Sheet

func (*SheetResponse) GetExtraProperties

func (s *SheetResponse) GetExtraProperties() map[string]interface{}

func (*SheetResponse) String

func (s *SheetResponse) String() string

func (*SheetResponse) UnmarshalJSON

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

type SheetSlug

type SheetSlug = string

Sheet Slug

type SheetUpdate

type SheetUpdate struct {
	// The ID of the Sheet.
	Id *SheetId `json:"id,omitempty" url:"id,omitempty"`
	// The ID of the Workbook.
	WorkbookId *WorkbookId `json:"workbookId,omitempty" url:"workbookId,omitempty"`
	// Describes shape of data as well as behavior.
	Config *SheetConfig `json:"config,omitempty" url:"config,omitempty"`
	// Useful for any contextual metadata regarding the sheet. Store any valid json
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// The scoped namespace of the Sheet.
	Namespace *string `json:"namespace,omitempty" url:"namespace,omitempty"`
	// Date the sheet was last updated
	UpdatedAt *time.Time `json:"updatedAt,omitempty" url:"updatedAt,omitempty"`
	// Date the sheet was created
	CreatedAt *time.Time `json:"createdAt,omitempty" url:"createdAt,omitempty"`
	// contains filtered or unexported fields
}

Changes to make to an existing sheet

func (*SheetUpdate) GetConfig

func (s *SheetUpdate) GetConfig() *SheetConfig

func (*SheetUpdate) GetCreatedAt

func (s *SheetUpdate) GetCreatedAt() *time.Time

func (*SheetUpdate) GetExtraProperties

func (s *SheetUpdate) GetExtraProperties() map[string]interface{}

func (*SheetUpdate) GetId

func (s *SheetUpdate) GetId() *SheetId

func (*SheetUpdate) GetMetadata

func (s *SheetUpdate) GetMetadata() interface{}

func (*SheetUpdate) GetNamespace

func (s *SheetUpdate) GetNamespace() *string

func (*SheetUpdate) GetUpdatedAt

func (s *SheetUpdate) GetUpdatedAt() *time.Time

func (*SheetUpdate) GetWorkbookId

func (s *SheetUpdate) GetWorkbookId() *WorkbookId

func (*SheetUpdate) MarshalJSON

func (s *SheetUpdate) MarshalJSON() ([]byte, error)

func (*SheetUpdate) String

func (s *SheetUpdate) String() string

func (*SheetUpdate) UnmarshalJSON

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

type SheetUpdateRequest

type SheetUpdateRequest struct {
	// The name of the Sheet.
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// The slug of the Sheet.
	Slug *string `json:"slug,omitempty" url:"slug,omitempty"`
	// Useful for any contextual metadata regarding the sheet. Store any valid json
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// contains filtered or unexported fields
}

Changes to make to an existing sheet

func (*SheetUpdateRequest) GetExtraProperties

func (s *SheetUpdateRequest) GetExtraProperties() map[string]interface{}

func (*SheetUpdateRequest) GetMetadata

func (s *SheetUpdateRequest) GetMetadata() interface{}

func (*SheetUpdateRequest) GetName

func (s *SheetUpdateRequest) GetName() *string

func (*SheetUpdateRequest) GetSlug

func (s *SheetUpdateRequest) GetSlug() *string

func (*SheetUpdateRequest) String

func (s *SheetUpdateRequest) String() string

func (*SheetUpdateRequest) UnmarshalJSON

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

type Snapshot

type Snapshot struct {
	// The ID of the Snapshot.
	Id SnapshotId `json:"id" url:"id"`
	// The ID of the Sheet.
	SheetId SheetId `json:"sheetId" url:"sheetId"`
	// The title of the Snapshot.
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// A summary of the Snapshot. This field is only available on the single get snapshot endpoint. It is not available for the list snapshots endpoint.
	Summary *SnapshotSummary `json:"summary,omitempty" url:"summary,omitempty"`
	// The time the Snapshot was created.
	CreatedAt time.Time `json:"createdAt" url:"createdAt"`
	// The actor who created the Snapshot.
	CreatedBy UserId `json:"createdBy" url:"createdBy"`
	// The ID of the thread associated with the snapshot.
	ThreadId *string `json:"threadId,omitempty" url:"threadId,omitempty"`
	// contains filtered or unexported fields
}

func (*Snapshot) GetCreatedAt

func (s *Snapshot) GetCreatedAt() time.Time

func (*Snapshot) GetCreatedBy

func (s *Snapshot) GetCreatedBy() UserId

func (*Snapshot) GetExtraProperties

func (s *Snapshot) GetExtraProperties() map[string]interface{}

func (*Snapshot) GetId

func (s *Snapshot) GetId() SnapshotId

func (*Snapshot) GetLabel

func (s *Snapshot) GetLabel() *string

func (*Snapshot) GetSheetId

func (s *Snapshot) GetSheetId() SheetId

func (*Snapshot) GetSummary

func (s *Snapshot) GetSummary() *SnapshotSummary

func (*Snapshot) GetThreadId

func (s *Snapshot) GetThreadId() *string

func (*Snapshot) MarshalJSON

func (s *Snapshot) MarshalJSON() ([]byte, error)

func (*Snapshot) String

func (s *Snapshot) String() string

func (*Snapshot) UnmarshalJSON

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

type SnapshotId

type SnapshotId = string

Snapshot ID

type SnapshotResponse

type SnapshotResponse struct {
	Data *Snapshot `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*SnapshotResponse) GetData

func (s *SnapshotResponse) GetData() *Snapshot

func (*SnapshotResponse) GetExtraProperties

func (s *SnapshotResponse) GetExtraProperties() map[string]interface{}

func (*SnapshotResponse) String

func (s *SnapshotResponse) String() string

func (*SnapshotResponse) UnmarshalJSON

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

type SnapshotSummary

type SnapshotSummary struct {
	CreatedSince *SummarySection `json:"createdSince,omitempty" url:"createdSince,omitempty"`
	UpdatedSince *SummarySection `json:"updatedSince,omitempty" url:"updatedSince,omitempty"`
	DeletedSince *SummarySection `json:"deletedSince,omitempty" url:"deletedSince,omitempty"`
	// The schema diff between the snapshot and the current sheet schema.
	SchemaDiff SchemaDiffRecord `json:"schemaDiff,omitempty" url:"schemaDiff,omitempty"`
	// The sheet configuration at the time of the snapshot.
	Config *SheetConfig `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

func (*SnapshotSummary) GetConfig

func (s *SnapshotSummary) GetConfig() *SheetConfig

func (*SnapshotSummary) GetCreatedSince

func (s *SnapshotSummary) GetCreatedSince() *SummarySection

func (*SnapshotSummary) GetDeletedSince

func (s *SnapshotSummary) GetDeletedSince() *SummarySection

func (*SnapshotSummary) GetExtraProperties

func (s *SnapshotSummary) GetExtraProperties() map[string]interface{}

func (*SnapshotSummary) GetSchemaDiff

func (s *SnapshotSummary) GetSchemaDiff() SchemaDiffRecord

func (*SnapshotSummary) GetUpdatedSince

func (s *SnapshotSummary) GetUpdatedSince() *SummarySection

func (*SnapshotSummary) String

func (s *SnapshotSummary) String() string

func (*SnapshotSummary) UnmarshalJSON

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

type SnapshotsResponse

type SnapshotsResponse struct {
	Data []*Snapshot `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*SnapshotsResponse) GetData

func (s *SnapshotsResponse) GetData() []*Snapshot

func (*SnapshotsResponse) GetExtraProperties

func (s *SnapshotsResponse) GetExtraProperties() map[string]interface{}

func (*SnapshotsResponse) String

func (s *SnapshotsResponse) String() string

func (*SnapshotsResponse) UnmarshalJSON

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

type SortDirection

type SortDirection string

Sort direction - asc (ascending) or desc (descending)

const (
	SortDirectionAsc  SortDirection = "asc"
	SortDirectionDesc SortDirection = "desc"
)

func NewSortDirectionFromString

func NewSortDirectionFromString(s string) (SortDirection, error)

func (SortDirection) Ptr

func (s SortDirection) Ptr() *SortDirection

type SortField

type SortField = string

Name of field by which to sort records

type SourceField

type SourceField struct {
	// The description of the source field
	SourceField *Property `json:"sourceField,omitempty" url:"sourceField,omitempty"`
	// A list of preview values of the data in the source field
	Preview []string `json:"preview,omitempty" url:"preview,omitempty"`
	// contains filtered or unexported fields
}

func (*SourceField) GetExtraProperties

func (s *SourceField) GetExtraProperties() map[string]interface{}

func (*SourceField) GetPreview

func (s *SourceField) GetPreview() []string

func (*SourceField) GetSourceField

func (s *SourceField) GetSourceField() *Property

func (*SourceField) String

func (s *SourceField) String() string

func (*SourceField) UnmarshalJSON

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

type Space

type Space struct {
	SpaceConfigId *SpaceConfigId `json:"spaceConfigId,omitempty" url:"spaceConfigId,omitempty"`
	EnvironmentId *EnvironmentId `json:"environmentId,omitempty" url:"environmentId,omitempty"`
	// The ID of the primary workbook for the space. This should not be included in create space requests.
	PrimaryWorkbookId *WorkbookId `json:"primaryWorkbookId,omitempty" url:"primaryWorkbookId,omitempty"`
	// Metadata for the space
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// The Space settings.
	Settings         *SpaceSettings `json:"settings,omitempty" url:"settings,omitempty"`
	Actions          []*Action      `json:"actions,omitempty" url:"actions,omitempty"`
	Access           []SpaceAccess  `json:"access,omitempty" url:"access,omitempty"`
	AutoConfigure    *bool          `json:"autoConfigure,omitempty" url:"autoConfigure,omitempty"`
	Namespace        *string        `json:"namespace,omitempty" url:"namespace,omitempty"`
	Labels           []string       `json:"labels,omitempty" url:"labels,omitempty"`
	TranslationsPath *string        `json:"translationsPath,omitempty" url:"translationsPath,omitempty"`
	LanguageOverride *string        `json:"languageOverride,omitempty" url:"languageOverride,omitempty"`
	// Date when space was archived
	ArchivedAt *time.Time `json:"archivedAt,omitempty" url:"archivedAt,omitempty"`
	// The ID of the App that space is associated with
	AppId *AppId `json:"appId,omitempty" url:"appId,omitempty"`
	// Whether the space is an app template. Only one space per app can be an app template.
	IsAppTemplate *bool   `json:"isAppTemplate,omitempty" url:"isAppTemplate,omitempty"`
	Id            SpaceId `json:"id" url:"id"`
	// Amount of workbooks in the space
	WorkbooksCount *int `json:"workbooksCount,omitempty" url:"workbooksCount,omitempty"`
	// Amount of files in the space
	FilesCount      *int    `json:"filesCount,omitempty" url:"filesCount,omitempty"`
	CreatedByUserId *UserId `json:"createdByUserId,omitempty" url:"createdByUserId,omitempty"`
	// User name who created space
	CreatedByUserName *string `json:"createdByUserName,omitempty" url:"createdByUserName,omitempty"`
	// Date when space was created
	CreatedAt time.Time `json:"createdAt" url:"createdAt"`
	// Date when space was updated
	UpdatedAt time.Time `json:"updatedAt" url:"updatedAt"`
	// Date when space was expired
	ExpiredAt *time.Time `json:"expiredAt,omitempty" url:"expiredAt,omitempty"`
	// This date marks the most recent activity within the space, tracking actions to the second. Activities include creating or updating records in a sheet, uploading files, or modifying a workbook's configuration.
	LastActivityAt *time.Time `json:"lastActivityAt,omitempty" url:"lastActivityAt,omitempty"`
	// Guest link to the space
	GuestLink *string `json:"guestLink,omitempty" url:"guestLink,omitempty"`
	// The name of the space
	Name string `json:"name" url:"name"`
	// The display order
	DisplayOrder *int `json:"displayOrder,omitempty" url:"displayOrder,omitempty"`
	// Access token for the space
	AccessToken *string `json:"accessToken,omitempty" url:"accessToken,omitempty"`
	// Flag for collaborative (project) spaces
	IsCollaborative *bool `json:"isCollaborative,omitempty" url:"isCollaborative,omitempty"`
	// Size information for the space
	Size *SpaceSize `json:"size,omitempty" url:"size,omitempty"`
	// Date when the space was upgraded
	UpgradedAt *time.Time `json:"upgradedAt,omitempty" url:"upgradedAt,omitempty"`
	// Type of guest authentication
	GuestAuthentication []GuestAuthenticationEnum `json:"guestAuthentication,omitempty" url:"guestAuthentication,omitempty"`
	// contains filtered or unexported fields
}

A place to store your workbooks

func (*Space) GetAccess

func (s *Space) GetAccess() []SpaceAccess

func (*Space) GetAccessToken

func (s *Space) GetAccessToken() *string

func (*Space) GetActions

func (s *Space) GetActions() []*Action

func (*Space) GetAppId

func (s *Space) GetAppId() *AppId

func (*Space) GetArchivedAt

func (s *Space) GetArchivedAt() *time.Time

func (*Space) GetAutoConfigure

func (s *Space) GetAutoConfigure() *bool

func (*Space) GetCreatedAt

func (s *Space) GetCreatedAt() time.Time

func (*Space) GetCreatedByUserId

func (s *Space) GetCreatedByUserId() *UserId

func (*Space) GetCreatedByUserName

func (s *Space) GetCreatedByUserName() *string

func (*Space) GetDisplayOrder

func (s *Space) GetDisplayOrder() *int

func (*Space) GetEnvironmentId

func (s *Space) GetEnvironmentId() *EnvironmentId

func (*Space) GetExpiredAt

func (s *Space) GetExpiredAt() *time.Time

func (*Space) GetExtraProperties

func (s *Space) GetExtraProperties() map[string]interface{}

func (*Space) GetFilesCount

func (s *Space) GetFilesCount() *int

func (*Space) GetGuestAuthentication

func (s *Space) GetGuestAuthentication() []GuestAuthenticationEnum

func (*Space) GetGuestLink

func (s *Space) GetGuestLink() *string

func (*Space) GetId

func (s *Space) GetId() SpaceId

func (*Space) GetIsAppTemplate

func (s *Space) GetIsAppTemplate() *bool

func (*Space) GetIsCollaborative

func (s *Space) GetIsCollaborative() *bool

func (*Space) GetLabels

func (s *Space) GetLabels() []string

func (*Space) GetLanguageOverride

func (s *Space) GetLanguageOverride() *string

func (*Space) GetLastActivityAt

func (s *Space) GetLastActivityAt() *time.Time

func (*Space) GetMetadata

func (s *Space) GetMetadata() interface{}

func (*Space) GetName

func (s *Space) GetName() string

func (*Space) GetNamespace

func (s *Space) GetNamespace() *string

func (*Space) GetPrimaryWorkbookId

func (s *Space) GetPrimaryWorkbookId() *WorkbookId

func (*Space) GetSettings

func (s *Space) GetSettings() *SpaceSettings

func (*Space) GetSize

func (s *Space) GetSize() *SpaceSize

func (*Space) GetSpaceConfigId

func (s *Space) GetSpaceConfigId() *SpaceConfigId

func (*Space) GetTranslationsPath

func (s *Space) GetTranslationsPath() *string

func (*Space) GetUpdatedAt

func (s *Space) GetUpdatedAt() time.Time

func (*Space) GetUpgradedAt

func (s *Space) GetUpgradedAt() *time.Time

func (*Space) GetWorkbooksCount

func (s *Space) GetWorkbooksCount() *int

func (*Space) MarshalJSON

func (s *Space) MarshalJSON() ([]byte, error)

func (*Space) String

func (s *Space) String() string

func (*Space) UnmarshalJSON

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

type SpaceAccess

type SpaceAccess string

const (
	SpaceAccessAll    SpaceAccess = "*"
	SpaceAccessUpload SpaceAccess = "upload"
)

func NewSpaceAccessFromString

func NewSpaceAccessFromString(s string) (SpaceAccess, error)

func (SpaceAccess) Ptr

func (s SpaceAccess) Ptr() *SpaceAccess

type SpaceConfig

type SpaceConfig struct {
	SpaceConfigId *SpaceConfigId `json:"spaceConfigId,omitempty" url:"spaceConfigId,omitempty"`
	EnvironmentId *EnvironmentId `json:"environmentId,omitempty" url:"environmentId,omitempty"`
	// The ID of the primary workbook for the space. This should not be included in create space requests.
	PrimaryWorkbookId *WorkbookId `json:"primaryWorkbookId,omitempty" url:"primaryWorkbookId,omitempty"`
	// Metadata for the space
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// The Space settings.
	Settings         *SpaceSettings `json:"settings,omitempty" url:"settings,omitempty"`
	Actions          []*Action      `json:"actions,omitempty" url:"actions,omitempty"`
	Access           []SpaceAccess  `json:"access,omitempty" url:"access,omitempty"`
	AutoConfigure    *bool          `json:"autoConfigure,omitempty" url:"autoConfigure,omitempty"`
	Namespace        *string        `json:"namespace,omitempty" url:"namespace,omitempty"`
	Labels           []string       `json:"labels,omitempty" url:"labels,omitempty"`
	TranslationsPath *string        `json:"translationsPath,omitempty" url:"translationsPath,omitempty"`
	LanguageOverride *string        `json:"languageOverride,omitempty" url:"languageOverride,omitempty"`
	// Date when space was archived
	ArchivedAt *time.Time `json:"archivedAt,omitempty" url:"archivedAt,omitempty"`
	// The ID of the App that space is associated with
	AppId *AppId `json:"appId,omitempty" url:"appId,omitempty"`
	// Whether the space is an app template. Only one space per app can be an app template.
	IsAppTemplate *bool `json:"isAppTemplate,omitempty" url:"isAppTemplate,omitempty"`
	// The name of the space
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// The display order
	DisplayOrder        *int                      `json:"displayOrder,omitempty" url:"displayOrder,omitempty"`
	GuestAuthentication []GuestAuthenticationEnum `json:"guestAuthentication,omitempty" url:"guestAuthentication,omitempty"`
	// contains filtered or unexported fields
}

Properties used to create a new Space

func (*SpaceConfig) GetAccess

func (s *SpaceConfig) GetAccess() []SpaceAccess

func (*SpaceConfig) GetActions

func (s *SpaceConfig) GetActions() []*Action

func (*SpaceConfig) GetAppId

func (s *SpaceConfig) GetAppId() *AppId

func (*SpaceConfig) GetArchivedAt

func (s *SpaceConfig) GetArchivedAt() *time.Time

func (*SpaceConfig) GetAutoConfigure

func (s *SpaceConfig) GetAutoConfigure() *bool

func (*SpaceConfig) GetDisplayOrder

func (s *SpaceConfig) GetDisplayOrder() *int

func (*SpaceConfig) GetEnvironmentId

func (s *SpaceConfig) GetEnvironmentId() *EnvironmentId

func (*SpaceConfig) GetExtraProperties

func (s *SpaceConfig) GetExtraProperties() map[string]interface{}

func (*SpaceConfig) GetGuestAuthentication

func (s *SpaceConfig) GetGuestAuthentication() []GuestAuthenticationEnum

func (*SpaceConfig) GetIsAppTemplate

func (s *SpaceConfig) GetIsAppTemplate() *bool

func (*SpaceConfig) GetLabels

func (s *SpaceConfig) GetLabels() []string

func (*SpaceConfig) GetLanguageOverride

func (s *SpaceConfig) GetLanguageOverride() *string

func (*SpaceConfig) GetMetadata

func (s *SpaceConfig) GetMetadata() interface{}

func (*SpaceConfig) GetName

func (s *SpaceConfig) GetName() *string

func (*SpaceConfig) GetNamespace

func (s *SpaceConfig) GetNamespace() *string

func (*SpaceConfig) GetPrimaryWorkbookId

func (s *SpaceConfig) GetPrimaryWorkbookId() *WorkbookId

func (*SpaceConfig) GetSettings

func (s *SpaceConfig) GetSettings() *SpaceSettings

func (*SpaceConfig) GetSpaceConfigId

func (s *SpaceConfig) GetSpaceConfigId() *SpaceConfigId

func (*SpaceConfig) GetTranslationsPath

func (s *SpaceConfig) GetTranslationsPath() *string

func (*SpaceConfig) MarshalJSON

func (s *SpaceConfig) MarshalJSON() ([]byte, error)

func (*SpaceConfig) String

func (s *SpaceConfig) String() string

func (*SpaceConfig) UnmarshalJSON

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

type SpaceConfigId

type SpaceConfigId = string

Space Config ID

type SpaceId

type SpaceId = string

Space ID

type SpaceResponse

type SpaceResponse struct {
	Data *Space `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*SpaceResponse) GetData

func (s *SpaceResponse) GetData() *Space

func (*SpaceResponse) GetExtraProperties

func (s *SpaceResponse) GetExtraProperties() map[string]interface{}

func (*SpaceResponse) String

func (s *SpaceResponse) String() string

func (*SpaceResponse) UnmarshalJSON

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

type SpaceSettings

type SpaceSettings struct {
	// The sidebar configuration for the space. (This will eventually replace metadata.sidebarconfig)
	SidebarConfig *SpaceSidebarConfig `json:"sidebarConfig,omitempty" url:"sidebarConfig,omitempty"`
	// contains filtered or unexported fields
}

Settings for a space

func (*SpaceSettings) GetExtraProperties

func (s *SpaceSettings) GetExtraProperties() map[string]interface{}

func (*SpaceSettings) GetSidebarConfig

func (s *SpaceSettings) GetSidebarConfig() *SpaceSidebarConfig

func (*SpaceSettings) String

func (s *SpaceSettings) String() string

func (*SpaceSettings) UnmarshalJSON

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

type SpaceSidebarConfig

type SpaceSidebarConfig struct {
	// Used to set the order of workbooks in the sidebar. This will not affect workbooks that are pinned and workbooks that are not specified here will be sorted alphabetically.
	WorkbookSidebarOrder []WorkbookId `json:"workbookSidebarOrder,omitempty" url:"workbookSidebarOrder,omitempty"`
	// contains filtered or unexported fields
}

func (*SpaceSidebarConfig) GetExtraProperties

func (s *SpaceSidebarConfig) GetExtraProperties() map[string]interface{}

func (*SpaceSidebarConfig) GetWorkbookSidebarOrder

func (s *SpaceSidebarConfig) GetWorkbookSidebarOrder() []WorkbookId

func (*SpaceSidebarConfig) String

func (s *SpaceSidebarConfig) String() string

func (*SpaceSidebarConfig) UnmarshalJSON

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

type SpaceSize

type SpaceSize struct {
	Name     string `json:"name" url:"name"`
	Id       string `json:"id" url:"id"`
	NumUsers int    `json:"numUsers" url:"numUsers"`
	Pdv      int    `json:"pdv" url:"pdv"`
	NumFiles int    `json:"numFiles" url:"numFiles"`
	// contains filtered or unexported fields
}

The size of a space

func (*SpaceSize) GetExtraProperties

func (s *SpaceSize) GetExtraProperties() map[string]interface{}

func (*SpaceSize) GetId

func (s *SpaceSize) GetId() string

func (*SpaceSize) GetName

func (s *SpaceSize) GetName() string

func (*SpaceSize) GetNumFiles

func (s *SpaceSize) GetNumFiles() int

func (*SpaceSize) GetNumUsers

func (s *SpaceSize) GetNumUsers() int

func (*SpaceSize) GetPdv

func (s *SpaceSize) GetPdv() int

func (*SpaceSize) String

func (s *SpaceSize) String() string

func (*SpaceSize) UnmarshalJSON

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

type StoredConstraint

type StoredConstraint struct {
	// Must match the constraint validator name.
	Validator string `json:"validator" url:"validator"`
	// The version of the stored constraint to use. (Defaults to version 1.)
	Version *int `json:"version,omitempty" url:"version,omitempty"`
	// A full description of what this constraint configuration does
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// A short description of what this constraint constraint should do, example - values between 1 and 100
	Label  *string     `json:"label,omitempty" url:"label,omitempty"`
	Config interface{} `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

func (*StoredConstraint) GetConfig

func (s *StoredConstraint) GetConfig() interface{}

func (*StoredConstraint) GetDescription

func (s *StoredConstraint) GetDescription() *string

func (*StoredConstraint) GetExtraProperties

func (s *StoredConstraint) GetExtraProperties() map[string]interface{}

func (*StoredConstraint) GetLabel

func (s *StoredConstraint) GetLabel() *string

func (*StoredConstraint) GetValidator

func (s *StoredConstraint) GetValidator() string

func (*StoredConstraint) GetVersion

func (s *StoredConstraint) GetVersion() *int

func (*StoredConstraint) String

func (s *StoredConstraint) String() string

func (*StoredConstraint) UnmarshalJSON

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

type StringConfig

type StringConfig struct {
	Size StringConfigOptions `json:"size" url:"size"`
	// contains filtered or unexported fields
}

func (*StringConfig) GetExtraProperties

func (s *StringConfig) GetExtraProperties() map[string]interface{}

func (*StringConfig) GetSize

func (s *StringConfig) GetSize() StringConfigOptions

func (*StringConfig) String

func (s *StringConfig) String() string

func (*StringConfig) UnmarshalJSON

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

type StringConfigOptions

type StringConfigOptions string

How much text should be storeable in this field

const (
	// up to 255 characters
	StringConfigOptionsTiny StringConfigOptions = "tiny"
	// 64kb (default)
	StringConfigOptionsNormal StringConfigOptions = "normal"
	// 16mb
	StringConfigOptionsMedium StringConfigOptions = "medium"
	// 4gb
	StringConfigOptionsLong StringConfigOptions = "long"
)

func NewStringConfigOptionsFromString

func NewStringConfigOptionsFromString(s string) (StringConfigOptions, error)

func (StringConfigOptions) Ptr

func (s StringConfigOptions) Ptr() *StringConfigOptions

type StringListProperty

type StringListProperty struct {
	Key string `json:"key" url:"key"`
	// User friendly field name
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// A short description of the field. Markdown syntax is supported.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values.
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,omitempty"`
	// An array of actions that end users can perform on this Column.
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// Useful for any contextual metadata regarding the schema. Store any valid json here.
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// A unique presentation for a field in the UI.
	Treatments       []string `json:"treatments,omitempty" url:"treatments,omitempty"`
	AlternativeNames []string `json:"alternativeNames,omitempty" url:"alternativeNames,omitempty"`
	// contains filtered or unexported fields
}

Defines a property that should be stored and read as an array of strings. Database engines should expect any number of items to be provided here. The maximum number of items that can be in this list is `100`.

func (*StringListProperty) GetActions

func (s *StringListProperty) GetActions() []*Action

func (*StringListProperty) GetAlternativeNames

func (s *StringListProperty) GetAlternativeNames() []string

func (*StringListProperty) GetAppearance

func (s *StringListProperty) GetAppearance() *FieldAppearance

func (*StringListProperty) GetConstraints

func (s *StringListProperty) GetConstraints() []*Constraint

func (*StringListProperty) GetDescription

func (s *StringListProperty) GetDescription() *string

func (*StringListProperty) GetExtraProperties

func (s *StringListProperty) GetExtraProperties() map[string]interface{}

func (*StringListProperty) GetKey

func (s *StringListProperty) GetKey() string

func (*StringListProperty) GetLabel

func (s *StringListProperty) GetLabel() *string

func (*StringListProperty) GetMetadata

func (s *StringListProperty) GetMetadata() interface{}

func (*StringListProperty) GetReadonly

func (s *StringListProperty) GetReadonly() *bool

func (*StringListProperty) GetTreatments

func (s *StringListProperty) GetTreatments() []string

func (*StringListProperty) String

func (s *StringListProperty) String() string

func (*StringListProperty) UnmarshalJSON

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

type StringProperty

type StringProperty struct {
	Key string `json:"key" url:"key"`
	// User friendly field name
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// A short description of the field. Markdown syntax is supported.
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values.
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,omitempty"`
	// An array of actions that end users can perform on this Column.
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// Useful for any contextual metadata regarding the schema. Store any valid json here.
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// A unique presentation for a field in the UI.
	Treatments       []string      `json:"treatments,omitempty" url:"treatments,omitempty"`
	AlternativeNames []string      `json:"alternativeNames,omitempty" url:"alternativeNames,omitempty"`
	Config           *StringConfig `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

Defines a property that should be stored and read as a basic string. Database engines should expect any length of text to be provided here unless explicitly defined in the config.

func (*StringProperty) GetActions

func (s *StringProperty) GetActions() []*Action

func (*StringProperty) GetAlternativeNames

func (s *StringProperty) GetAlternativeNames() []string

func (*StringProperty) GetAppearance

func (s *StringProperty) GetAppearance() *FieldAppearance

func (*StringProperty) GetConfig

func (s *StringProperty) GetConfig() *StringConfig

func (*StringProperty) GetConstraints

func (s *StringProperty) GetConstraints() []*Constraint

func (*StringProperty) GetDescription

func (s *StringProperty) GetDescription() *string

func (*StringProperty) GetExtraProperties

func (s *StringProperty) GetExtraProperties() map[string]interface{}

func (*StringProperty) GetKey

func (s *StringProperty) GetKey() string

func (*StringProperty) GetLabel

func (s *StringProperty) GetLabel() *string

func (*StringProperty) GetMetadata

func (s *StringProperty) GetMetadata() interface{}

func (*StringProperty) GetReadonly

func (s *StringProperty) GetReadonly() *bool

func (*StringProperty) GetTreatments

func (s *StringProperty) GetTreatments() []string

func (*StringProperty) String

func (s *StringProperty) String() string

func (*StringProperty) UnmarshalJSON

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

type Success

type Success struct {
	Data *SuccessData `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

Informs whether or not a request was successful

func (*Success) GetData

func (s *Success) GetData() *SuccessData

func (*Success) GetExtraProperties

func (s *Success) GetExtraProperties() map[string]interface{}

func (*Success) String

func (s *Success) String() string

func (*Success) UnmarshalJSON

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

type SuccessData

type SuccessData struct {
	Success bool `json:"success" url:"success"`
	// contains filtered or unexported fields
}

func (*SuccessData) GetExtraProperties

func (s *SuccessData) GetExtraProperties() map[string]interface{}

func (*SuccessData) GetSuccess

func (s *SuccessData) GetSuccess() bool

func (*SuccessData) String

func (s *SuccessData) String() string

func (*SuccessData) UnmarshalJSON

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

type SuccessQueryParameter

type SuccessQueryParameter = bool

Boolean

type SuccessResponse

type SuccessResponse struct {
	Success bool `json:"success" url:"success"`
	// contains filtered or unexported fields
}

func (*SuccessResponse) GetExtraProperties

func (s *SuccessResponse) GetExtraProperties() map[string]interface{}

func (*SuccessResponse) GetSuccess

func (s *SuccessResponse) GetSuccess() bool

func (*SuccessResponse) String

func (s *SuccessResponse) String() string

func (*SuccessResponse) UnmarshalJSON

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

type SummarySection

type SummarySection struct {
	Total   int            `json:"total" url:"total"`
	ByField map[string]int `json:"byField,omitempty" url:"byField,omitempty"`
	// contains filtered or unexported fields
}

func (*SummarySection) GetByField

func (s *SummarySection) GetByField() map[string]int

func (*SummarySection) GetExtraProperties

func (s *SummarySection) GetExtraProperties() map[string]interface{}

func (*SummarySection) GetTotal

func (s *SummarySection) GetTotal() int

func (*SummarySection) String

func (s *SummarySection) String() string

func (*SummarySection) UnmarshalJSON

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

type Trigger

type Trigger string

The type of trigger to use for this job

const (
	TriggerManual    Trigger = "manual"
	TriggerImmediate Trigger = "immediate"
)

func NewTriggerFromString

func NewTriggerFromString(s string) (Trigger, error)

func (Trigger) Ptr

func (t Trigger) Ptr() *Trigger

type TriggerEnum

type TriggerEnum string

const (
	TriggerEnumFirst  TriggerEnum = "first"
	TriggerEnumHover  TriggerEnum = "hover"
	TriggerEnumEvent  TriggerEnum = "event"
	TriggerEnumManual TriggerEnum = "manual"
)

func NewTriggerEnumFromString

func NewTriggerEnumFromString(s string) (TriggerEnum, error)

func (TriggerEnum) Ptr

func (t TriggerEnum) Ptr() *TriggerEnum

type TypeEnum

type TypeEnum string

const (
	TypeEnumSidebar TypeEnum = "sidebar"
	TypeEnumPopout  TypeEnum = "popout"
	TypeEnumTooltip TypeEnum = "tooltip"
)

func NewTypeEnumFromString

func NewTypeEnumFromString(s string) (TypeEnum, error)

func (TypeEnum) Ptr

func (t TypeEnum) Ptr() *TypeEnum

type UniqueConstraint

type UniqueConstraint struct {
	Config *UniqueConstraintConfig `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

func (*UniqueConstraint) GetConfig

func (u *UniqueConstraint) GetConfig() *UniqueConstraintConfig

func (*UniqueConstraint) GetExtraProperties

func (u *UniqueConstraint) GetExtraProperties() map[string]interface{}

func (*UniqueConstraint) String

func (u *UniqueConstraint) String() string

func (*UniqueConstraint) UnmarshalJSON

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

type UniqueConstraintConfig

type UniqueConstraintConfig struct {
	// Ignore casing when determining uniqueness
	CaseSensitive *bool `json:"caseSensitive,omitempty" url:"caseSensitive,omitempty"`
	// Do not flag empty values as duplicate
	IgnoreEmpty *bool `json:"ignoreEmpty,omitempty" url:"ignoreEmpty,omitempty"`
	// contains filtered or unexported fields
}

func (*UniqueConstraintConfig) GetCaseSensitive

func (u *UniqueConstraintConfig) GetCaseSensitive() *bool

func (*UniqueConstraintConfig) GetExtraProperties

func (u *UniqueConstraintConfig) GetExtraProperties() map[string]interface{}

func (*UniqueConstraintConfig) GetIgnoreEmpty

func (u *UniqueConstraintConfig) GetIgnoreEmpty() *bool

func (*UniqueConstraintConfig) String

func (u *UniqueConstraintConfig) String() string

func (*UniqueConstraintConfig) UnmarshalJSON

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

type UpdateDataClipResolutionsJobConfig

type UpdateDataClipResolutionsJobConfig struct {
	// The ID of the data clip to resolve
	ClipId DataClipId `json:"clipId" url:"clipId"`
	// The ID of the sheet that contains the data clip
	ClippedSheetId SheetId   `json:"clippedSheetId" url:"clippedSheetId"`
	ResolveTo      ResolveTo `json:"resolveTo" url:"resolveTo"`
	// Optional. If provided, only this column will be resolved.
	ColumnField string `json:"columnField" url:"columnField"`
	// Optional. If provided, this value in the column will be replaced with the resolution target.
	ColumnValue string `json:"columnValue" url:"columnValue"`
	// contains filtered or unexported fields
}

Configuration for a data clip resolution job

func (*UpdateDataClipResolutionsJobConfig) GetClipId

func (u *UpdateDataClipResolutionsJobConfig) GetClipId() DataClipId

func (*UpdateDataClipResolutionsJobConfig) GetClippedSheetId

func (u *UpdateDataClipResolutionsJobConfig) GetClippedSheetId() SheetId

func (*UpdateDataClipResolutionsJobConfig) GetColumnField

func (u *UpdateDataClipResolutionsJobConfig) GetColumnField() string

func (*UpdateDataClipResolutionsJobConfig) GetColumnValue

func (u *UpdateDataClipResolutionsJobConfig) GetColumnValue() string

func (*UpdateDataClipResolutionsJobConfig) GetExtraProperties

func (u *UpdateDataClipResolutionsJobConfig) GetExtraProperties() map[string]interface{}

func (*UpdateDataClipResolutionsJobConfig) GetResolveTo

func (u *UpdateDataClipResolutionsJobConfig) GetResolveTo() ResolveTo

func (*UpdateDataClipResolutionsJobConfig) String

func (u *UpdateDataClipResolutionsJobConfig) String() string

func (*UpdateDataClipResolutionsJobConfig) UnmarshalJSON

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

type UpdateFileRequest

type UpdateFileRequest struct {
	WorkbookId *WorkbookId `json:"workbookId,omitempty" url:"-"`
	// The name of the file
	Name *string `json:"name,omitempty" url:"-"`
	// The storage mode of file to update
	Mode *Mode `json:"mode,omitempty" url:"-"`
	// Status of the file
	Status *ModelFileStatusEnum `json:"status,omitempty" url:"-"`
	// The actions attached to the file
	Actions []*Action `json:"actions,omitempty" url:"-"`
}

type UpdateMappingRulesRequest

type UpdateMappingRulesRequest = []*MappingRule

type UpdateUserRequest

type UpdateUserRequest struct {
	Name      *string `json:"name,omitempty" url:"-"`
	Dashboard *int    `json:"dashboard,omitempty" url:"-"`
}

type User

type User struct {
	Email      string                 `json:"email" url:"email"`
	Name       string                 `json:"name" url:"name"`
	AccountId  AccountId              `json:"accountId" url:"accountId"`
	Id         UserId                 `json:"id" url:"id"`
	Idp        string                 `json:"idp" url:"idp"`
	IdpRef     *string                `json:"idpRef,omitempty" url:"idpRef,omitempty"`
	Metadata   map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	CreatedAt  time.Time              `json:"createdAt" url:"createdAt"`
	UpdatedAt  time.Time              `json:"updatedAt" url:"updatedAt"`
	LastSeenAt *time.Time             `json:"lastSeenAt,omitempty" url:"lastSeenAt,omitempty"`
	Dashboard  *int                   `json:"dashboard,omitempty" url:"dashboard,omitempty"`
	// contains filtered or unexported fields
}

Configurations for the user

func (*User) GetAccountId

func (u *User) GetAccountId() AccountId

func (*User) GetCreatedAt

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

func (*User) GetDashboard

func (u *User) GetDashboard() *int

func (*User) GetEmail

func (u *User) GetEmail() string

func (*User) GetExtraProperties

func (u *User) GetExtraProperties() map[string]interface{}

func (*User) GetId

func (u *User) GetId() UserId

func (*User) GetIdp

func (u *User) GetIdp() string

func (*User) GetIdpRef

func (u *User) GetIdpRef() *string

func (*User) GetLastSeenAt

func (u *User) GetLastSeenAt() *time.Time

func (*User) GetMetadata

func (u *User) GetMetadata() map[string]interface{}

func (*User) GetName

func (u *User) GetName() string

func (*User) GetUpdatedAt

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

func (*User) MarshalJSON

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

func (*User) String

func (u *User) String() string

func (*User) UnmarshalJSON

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

type UserConfig

type UserConfig struct {
	Email     string    `json:"email" url:"email"`
	Name      string    `json:"name" url:"name"`
	AccountId AccountId `json:"accountId" url:"accountId"`
	// contains filtered or unexported fields
}

Properties used to create a new user

func (*UserConfig) GetAccountId

func (u *UserConfig) GetAccountId() AccountId

func (*UserConfig) GetEmail

func (u *UserConfig) GetEmail() string

func (*UserConfig) GetExtraProperties

func (u *UserConfig) GetExtraProperties() map[string]interface{}

func (*UserConfig) GetName

func (u *UserConfig) GetName() string

func (*UserConfig) String

func (u *UserConfig) String() string

func (*UserConfig) UnmarshalJSON

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

type UserCreateAndInviteRequest

type UserCreateAndInviteRequest struct {
	Email      string                    `json:"email" url:"email"`
	Name       string                    `json:"name" url:"name"`
	ActorRoles []*AssignActorRoleRequest `json:"actorRoles,omitempty" url:"actorRoles,omitempty"`
	// contains filtered or unexported fields
}

Properties used to create a new user

func (*UserCreateAndInviteRequest) GetActorRoles

func (u *UserCreateAndInviteRequest) GetActorRoles() []*AssignActorRoleRequest

func (*UserCreateAndInviteRequest) GetEmail

func (u *UserCreateAndInviteRequest) GetEmail() string

func (*UserCreateAndInviteRequest) GetExtraProperties

func (u *UserCreateAndInviteRequest) GetExtraProperties() map[string]interface{}

func (*UserCreateAndInviteRequest) GetName

func (u *UserCreateAndInviteRequest) GetName() string

func (*UserCreateAndInviteRequest) String

func (u *UserCreateAndInviteRequest) String() string

func (*UserCreateAndInviteRequest) UnmarshalJSON

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

type UserId

type UserId = string

User ID

type UserResponse

type UserResponse struct {
	Data *User `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*UserResponse) GetData

func (u *UserResponse) GetData() *User

func (*UserResponse) GetExtraProperties

func (u *UserResponse) GetExtraProperties() map[string]interface{}

func (*UserResponse) String

func (u *UserResponse) String() string

func (*UserResponse) UnmarshalJSON

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

type UserWithRoles

type UserWithRoles struct {
	Email      string                 `json:"email" url:"email"`
	Name       string                 `json:"name" url:"name"`
	AccountId  AccountId              `json:"accountId" url:"accountId"`
	Id         UserId                 `json:"id" url:"id"`
	Idp        string                 `json:"idp" url:"idp"`
	IdpRef     *string                `json:"idpRef,omitempty" url:"idpRef,omitempty"`
	Metadata   map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	CreatedAt  time.Time              `json:"createdAt" url:"createdAt"`
	UpdatedAt  time.Time              `json:"updatedAt" url:"updatedAt"`
	LastSeenAt *time.Time             `json:"lastSeenAt,omitempty" url:"lastSeenAt,omitempty"`
	Dashboard  *int                   `json:"dashboard,omitempty" url:"dashboard,omitempty"`
	ActorRoles []*ActorRoleResponse   `json:"actorRoles,omitempty" url:"actorRoles,omitempty"`
	// contains filtered or unexported fields
}

func (*UserWithRoles) GetAccountId

func (u *UserWithRoles) GetAccountId() AccountId

func (*UserWithRoles) GetActorRoles

func (u *UserWithRoles) GetActorRoles() []*ActorRoleResponse

func (*UserWithRoles) GetCreatedAt

func (u *UserWithRoles) GetCreatedAt() time.Time

func (*UserWithRoles) GetDashboard

func (u *UserWithRoles) GetDashboard() *int

func (*UserWithRoles) GetEmail

func (u *UserWithRoles) GetEmail() string

func (*UserWithRoles) GetExtraProperties

func (u *UserWithRoles) GetExtraProperties() map[string]interface{}

func (*UserWithRoles) GetId

func (u *UserWithRoles) GetId() UserId

func (*UserWithRoles) GetIdp

func (u *UserWithRoles) GetIdp() string

func (*UserWithRoles) GetIdpRef

func (u *UserWithRoles) GetIdpRef() *string

func (*UserWithRoles) GetLastSeenAt

func (u *UserWithRoles) GetLastSeenAt() *time.Time

func (*UserWithRoles) GetMetadata

func (u *UserWithRoles) GetMetadata() map[string]interface{}

func (*UserWithRoles) GetName

func (u *UserWithRoles) GetName() string

func (*UserWithRoles) GetUpdatedAt

func (u *UserWithRoles) GetUpdatedAt() time.Time

func (*UserWithRoles) MarshalJSON

func (u *UserWithRoles) MarshalJSON() ([]byte, error)

func (*UserWithRoles) String

func (u *UserWithRoles) String() string

func (*UserWithRoles) UnmarshalJSON

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

type UserWithRolesResponse

type UserWithRolesResponse struct {
	Data *UserWithRoles `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*UserWithRolesResponse) GetData

func (u *UserWithRolesResponse) GetData() *UserWithRoles

func (*UserWithRolesResponse) GetExtraProperties

func (u *UserWithRolesResponse) GetExtraProperties() map[string]interface{}

func (*UserWithRolesResponse) String

func (u *UserWithRolesResponse) String() string

func (*UserWithRolesResponse) UnmarshalJSON

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

type ValidationMessage

type ValidationMessage struct {
	Field   *string           `json:"field,omitempty" url:"field,omitempty"`
	Type    *ValidationType   `json:"type,omitempty" url:"type,omitempty"`
	Source  *ValidationSource `json:"source,omitempty" url:"source,omitempty"`
	Message *string           `json:"message,omitempty" url:"message,omitempty"`
	// This JSONPath is based on the root of mapped cell object.
	Path *JsonPathString `json:"path,omitempty" url:"path,omitempty"`
	// contains filtered or unexported fields
}

Record data validation messages

func (*ValidationMessage) GetExtraProperties

func (v *ValidationMessage) GetExtraProperties() map[string]interface{}

func (*ValidationMessage) GetField

func (v *ValidationMessage) GetField() *string

func (*ValidationMessage) GetMessage

func (v *ValidationMessage) GetMessage() *string

func (*ValidationMessage) GetPath

func (v *ValidationMessage) GetPath() *JsonPathString

func (*ValidationMessage) GetSource

func (v *ValidationMessage) GetSource() *ValidationSource

func (*ValidationMessage) GetType

func (v *ValidationMessage) GetType() *ValidationType

func (*ValidationMessage) String

func (v *ValidationMessage) String() string

func (*ValidationMessage) UnmarshalJSON

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

type ValidationSource

type ValidationSource string

const (
	ValidationSourceRequiredConstraint ValidationSource = "required-constraint"
	ValidationSourceUniqueConstraint   ValidationSource = "unique-constraint"
	ValidationSourceCustomLogic        ValidationSource = "custom-logic"
	ValidationSourceUnlinked           ValidationSource = "unlinked"
	ValidationSourceInvalidOption      ValidationSource = "invalid-option"
	ValidationSourceIsArtifact         ValidationSource = "is-artifact"
)

func NewValidationSourceFromString

func NewValidationSourceFromString(s string) (ValidationSource, error)

func (ValidationSource) Ptr

func (v ValidationSource) Ptr() *ValidationSource

type ValidationType

type ValidationType string

const (
	ValidationTypeError ValidationType = "error"
	ValidationTypeWarn  ValidationType = "warn"
	ValidationTypeInfo  ValidationType = "info"
)

func NewValidationTypeFromString

func NewValidationTypeFromString(s string) (ValidationType, error)

func (ValidationType) Ptr

func (v ValidationType) Ptr() *ValidationType

type Version

type Version struct {
	VersionId VersionId `json:"versionId" url:"versionId"`
	// contains filtered or unexported fields
}

func (*Version) GetExtraProperties

func (v *Version) GetExtraProperties() map[string]interface{}

func (*Version) GetVersionId

func (v *Version) GetVersionId() VersionId

func (*Version) String

func (v *Version) String() string

func (*Version) UnmarshalJSON

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

type VersionId

type VersionId = string

Version ID

type VersionResponse

type VersionResponse struct {
	Data *Version `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*VersionResponse) GetData

func (v *VersionResponse) GetData() *Version

func (*VersionResponse) GetExtraProperties

func (v *VersionResponse) GetExtraProperties() map[string]interface{}

func (*VersionResponse) String

func (v *VersionResponse) String() string

func (*VersionResponse) UnmarshalJSON

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

type VersionsPostRequestBody

type VersionsPostRequestBody struct {
	// The ID of the Sheet.
	SheetId *SheetId `json:"sheetId,omitempty" url:"-"`
	// Deprecated, creating or updating a group of records together will automatically generate a commitId to group those record changes together.
	ParentVersionId *VersionId `json:"parentVersionId,omitempty" url:"-"`
}

type View

type View struct {
	// The ID of the view
	Id ViewId `json:"id" url:"id"`
	// The associated sheet ID of the view
	SheetId SheetId `json:"sheetId" url:"sheetId"`
	// The name of the view
	Name string `json:"name" url:"name"`
	// The view filters of the view
	Config *ViewConfig `json:"config,omitempty" url:"config,omitempty"`
	// ID of the actor who created the view
	CreatedBy string `json:"createdBy" url:"createdBy"`
	// contains filtered or unexported fields
}

A view

func (*View) GetConfig

func (v *View) GetConfig() *ViewConfig

func (*View) GetCreatedBy

func (v *View) GetCreatedBy() string

func (*View) GetExtraProperties

func (v *View) GetExtraProperties() map[string]interface{}

func (*View) GetId

func (v *View) GetId() ViewId

func (*View) GetName

func (v *View) GetName() string

func (*View) GetSheetId

func (v *View) GetSheetId() SheetId

func (*View) String

func (v *View) String() string

func (*View) UnmarshalJSON

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

type ViewConfig

type ViewConfig struct {
	// Deprecated, use `commitId` instead.
	VersionId *VersionId `json:"versionId,omitempty" url:"versionId,omitempty"`
	CommitId  *CommitId  `json:"commitId,omitempty" url:"commitId,omitempty"`
	// Deprecated, use `sinceCommitId` instead.
	SinceVersionId *VersionId     `json:"sinceVersionId,omitempty" url:"sinceVersionId,omitempty"`
	SinceCommitId  *CommitId      `json:"sinceCommitId,omitempty" url:"sinceCommitId,omitempty"`
	SortField      *SortField     `json:"sortField,omitempty" url:"sortField,omitempty"`
	SortDirection  *SortDirection `json:"sortDirection,omitempty" url:"sortDirection,omitempty"`
	Filter         *Filter        `json:"filter,omitempty" url:"filter,omitempty"`
	// Name of field by which to filter records
	FilterField *FilterField `json:"filterField,omitempty" url:"filterField,omitempty"`
	SearchValue *SearchValue `json:"searchValue,omitempty" url:"searchValue,omitempty"`
	SearchField *SearchField `json:"searchField,omitempty" url:"searchField,omitempty"`
	// The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records. Maximum of 100 allowed.
	Ids []RecordId `json:"ids,omitempty" url:"ids,omitempty"`
	// Number of records to return in a page (default 10,000)
	PageSize *int `json:"pageSize,omitempty" url:"pageSize,omitempty"`
	// Based on pageSize, which page of records to return (Note - numbers start at 1)
	PageNumber *int `json:"pageNumber,omitempty" url:"pageNumber,omitempty"`
	// **DEPRECATED** Use GET /sheets/:sheetId/counts
	IncludeCounts *bool `json:"includeCounts,omitempty" url:"includeCounts,omitempty"`
	// The length of the record result set, returned as counts.total
	IncludeLength *bool `json:"includeLength,omitempty" url:"includeLength,omitempty"`
	// If true, linked records will be included in the results. Defaults to false.
	IncludeLinks *bool `json:"includeLinks,omitempty" url:"includeLinks,omitempty"`
	// Include error messages, defaults to false.
	IncludeMessages *bool `json:"includeMessages,omitempty" url:"includeMessages,omitempty"`
	// if "for" is provided, the query parameters will be pulled from the event payload
	For *EventId `json:"for,omitempty" url:"for,omitempty"`
	// An FFQL query used to filter the result set
	Q *string `json:"q,omitempty" url:"q,omitempty"`
	// contains filtered or unexported fields
}

The configuration of a view. Filters, sorting, and search query.

func (*ViewConfig) GetCommitId

func (v *ViewConfig) GetCommitId() *CommitId

func (*ViewConfig) GetExtraProperties

func (v *ViewConfig) GetExtraProperties() map[string]interface{}

func (*ViewConfig) GetFilter

func (v *ViewConfig) GetFilter() *Filter

func (*ViewConfig) GetFilterField

func (v *ViewConfig) GetFilterField() *FilterField

func (*ViewConfig) GetFor

func (v *ViewConfig) GetFor() *EventId

func (*ViewConfig) GetIds

func (v *ViewConfig) GetIds() []RecordId

func (*ViewConfig) GetIncludeCounts

func (v *ViewConfig) GetIncludeCounts() *bool

func (*ViewConfig) GetIncludeLength

func (v *ViewConfig) GetIncludeLength() *bool

func (*ViewConfig) GetIncludeLinks

func (v *ViewConfig) GetIncludeLinks() *bool

func (*ViewConfig) GetIncludeMessages

func (v *ViewConfig) GetIncludeMessages() *bool

func (*ViewConfig) GetPageNumber

func (v *ViewConfig) GetPageNumber() *int

func (*ViewConfig) GetPageSize

func (v *ViewConfig) GetPageSize() *int

func (*ViewConfig) GetQ

func (v *ViewConfig) GetQ() *string

func (*ViewConfig) GetSearchField

func (v *ViewConfig) GetSearchField() *SearchField

func (*ViewConfig) GetSearchValue

func (v *ViewConfig) GetSearchValue() *SearchValue

func (*ViewConfig) GetSinceCommitId

func (v *ViewConfig) GetSinceCommitId() *CommitId

func (*ViewConfig) GetSinceVersionId

func (v *ViewConfig) GetSinceVersionId() *VersionId

func (*ViewConfig) GetSortDirection

func (v *ViewConfig) GetSortDirection() *SortDirection

func (*ViewConfig) GetSortField

func (v *ViewConfig) GetSortField() *SortField

func (*ViewConfig) GetVersionId

func (v *ViewConfig) GetVersionId() *VersionId

func (*ViewConfig) String

func (v *ViewConfig) String() string

func (*ViewConfig) UnmarshalJSON

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

type ViewCreate

type ViewCreate struct {
	SheetId SheetId     `json:"sheetId" url:"sheetId"`
	Name    string      `json:"name" url:"name"`
	Config  *ViewConfig `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

func (*ViewCreate) GetConfig

func (v *ViewCreate) GetConfig() *ViewConfig

func (*ViewCreate) GetExtraProperties

func (v *ViewCreate) GetExtraProperties() map[string]interface{}

func (*ViewCreate) GetName

func (v *ViewCreate) GetName() string

func (*ViewCreate) GetSheetId

func (v *ViewCreate) GetSheetId() SheetId

func (*ViewCreate) String

func (v *ViewCreate) String() string

func (*ViewCreate) UnmarshalJSON

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

type ViewId

type ViewId = string

View ID

type ViewResponse

type ViewResponse struct {
	Data *View `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ViewResponse) GetData

func (v *ViewResponse) GetData() *View

func (*ViewResponse) GetExtraProperties

func (v *ViewResponse) GetExtraProperties() map[string]interface{}

func (*ViewResponse) String

func (v *ViewResponse) String() string

func (*ViewResponse) UnmarshalJSON

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

type ViewUpdate

type ViewUpdate struct {
	Name   *string     `json:"name,omitempty" url:"name,omitempty"`
	Config *ViewConfig `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

func (*ViewUpdate) GetConfig

func (v *ViewUpdate) GetConfig() *ViewConfig

func (*ViewUpdate) GetExtraProperties

func (v *ViewUpdate) GetExtraProperties() map[string]interface{}

func (*ViewUpdate) GetName

func (v *ViewUpdate) GetName() *string

func (*ViewUpdate) String

func (v *ViewUpdate) String() string

func (*ViewUpdate) UnmarshalJSON

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

type Workbook

type Workbook struct {
	// ID of the Workbook.
	Id WorkbookId `json:"id" url:"id"`
	// Name of the Workbook.
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// Associated Space ID of the Workbook.
	SpaceId SpaceId `json:"spaceId" url:"spaceId"`
	// Associated Environment ID of the Workbook.
	EnvironmentId EnvironmentId `json:"environmentId" url:"environmentId"`
	// A list of Sheets associated with the Workbook.
	Sheets []*Sheet `json:"sheets,omitempty" url:"sheets,omitempty"`
	// A list of labels for the Workbook.
	Labels []string `json:"labels,omitempty" url:"labels,omitempty"`
	// A list of Actions associated with the Workbook.
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// The Workbook settings.
	Settings *WorkbookConfigSettings `json:"settings,omitempty" url:"settings,omitempty"`
	// Metadata for the workbook
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// Treatments for the workbook
	Treatments []WorkbookTreatments `json:"treatments,omitempty" url:"treatments,omitempty"`
	Namespace  *string              `json:"namespace,omitempty" url:"namespace,omitempty"`
	// Date the workbook was last updated
	UpdatedAt time.Time `json:"updatedAt" url:"updatedAt"`
	// Date the workbook was created
	CreatedAt time.Time `json:"createdAt" url:"createdAt"`
	// Date the workbook was created
	ExpiredAt *time.Time `json:"expiredAt,omitempty" url:"expiredAt,omitempty"`
	// contains filtered or unexported fields
}

A collection of one or more sheets

func (*Workbook) GetActions

func (w *Workbook) GetActions() []*Action

func (*Workbook) GetCreatedAt

func (w *Workbook) GetCreatedAt() time.Time

func (*Workbook) GetEnvironmentId

func (w *Workbook) GetEnvironmentId() EnvironmentId

func (*Workbook) GetExpiredAt

func (w *Workbook) GetExpiredAt() *time.Time

func (*Workbook) GetExtraProperties

func (w *Workbook) GetExtraProperties() map[string]interface{}

func (*Workbook) GetId

func (w *Workbook) GetId() WorkbookId

func (*Workbook) GetLabels

func (w *Workbook) GetLabels() []string

func (*Workbook) GetMetadata

func (w *Workbook) GetMetadata() interface{}

func (*Workbook) GetName

func (w *Workbook) GetName() *string

func (*Workbook) GetNamespace

func (w *Workbook) GetNamespace() *string

func (*Workbook) GetSettings

func (w *Workbook) GetSettings() *WorkbookConfigSettings

func (*Workbook) GetSheets

func (w *Workbook) GetSheets() []*Sheet

func (*Workbook) GetSpaceId

func (w *Workbook) GetSpaceId() SpaceId

func (*Workbook) GetTreatments

func (w *Workbook) GetTreatments() []WorkbookTreatments

func (*Workbook) GetUpdatedAt

func (w *Workbook) GetUpdatedAt() time.Time

func (*Workbook) MarshalJSON

func (w *Workbook) MarshalJSON() ([]byte, error)

func (*Workbook) String

func (w *Workbook) String() string

func (*Workbook) UnmarshalJSON

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

type WorkbookConfigSettings

type WorkbookConfigSettings struct {
	// Whether to track changes for this workbook. Defaults to false. Tracking changes on a workbook allows for disabling workbook and sheet actions while data in the workbook is still being processed. You must run a recordHook listener if you enable this feature.
	TrackChanges *bool `json:"trackChanges,omitempty" url:"trackChanges,omitempty"`
	// When noMappingRedirect is set to true, dragging a file into a sheet will not redirect to the mapping screen. Defaults to false.
	NoMappingRedirect *bool `json:"noMappingRedirect,omitempty" url:"noMappingRedirect,omitempty"`
	// Used to set the order of sheets in the sidebar. Sheets that are not specified will be shown after those listed.
	SheetSidebarOrder []SheetId `json:"sheetSidebarOrder,omitempty" url:"sheetSidebarOrder,omitempty"`
	// contains filtered or unexported fields
}

Settings for a workbook

func (*WorkbookConfigSettings) GetExtraProperties

func (w *WorkbookConfigSettings) GetExtraProperties() map[string]interface{}

func (*WorkbookConfigSettings) GetNoMappingRedirect

func (w *WorkbookConfigSettings) GetNoMappingRedirect() *bool

func (*WorkbookConfigSettings) GetSheetSidebarOrder

func (w *WorkbookConfigSettings) GetSheetSidebarOrder() []SheetId

func (*WorkbookConfigSettings) GetTrackChanges

func (w *WorkbookConfigSettings) GetTrackChanges() *bool

func (*WorkbookConfigSettings) String

func (w *WorkbookConfigSettings) String() string

func (*WorkbookConfigSettings) UnmarshalJSON

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

type WorkbookId

type WorkbookId = string

Workbook ID

type WorkbookResponse

type WorkbookResponse struct {
	Data *Workbook `json:"data,omitempty" url:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*WorkbookResponse) GetData

func (w *WorkbookResponse) GetData() *Workbook

func (*WorkbookResponse) GetExtraProperties

func (w *WorkbookResponse) GetExtraProperties() map[string]interface{}

func (*WorkbookResponse) String

func (w *WorkbookResponse) String() string

func (*WorkbookResponse) UnmarshalJSON

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

type WorkbookTreatments

type WorkbookTreatments string

Available treatments for a workbook

const (
	WorkbookTreatmentsExtractedFromSource WorkbookTreatments = "EXTRACTED_FROM_SOURCE"
	WorkbookTreatmentsSmallData           WorkbookTreatments = "SMALL_DATA"
)

func NewWorkbookTreatmentsFromString

func NewWorkbookTreatmentsFromString(s string) (WorkbookTreatments, error)

func (WorkbookTreatments) Ptr

func (w WorkbookTreatments) Ptr() *WorkbookTreatments

type WorkbookUpdate

type WorkbookUpdate struct {
	// The name of the Workbook.
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// An optional list of labels for the Workbook.
	Labels []string `json:"labels,omitempty" url:"labels,omitempty"`
	// The Space Id associated with the Workbook.
	SpaceId *SpaceId `json:"spaceId,omitempty" url:"spaceId,omitempty"`
	// The Environment Id associated with the Workbook.
	EnvironmentId *EnvironmentId `json:"environmentId,omitempty" url:"environmentId,omitempty"`
	// The namespace of the Workbook.
	Namespace *string `json:"namespace,omitempty" url:"namespace,omitempty"`
	// Describes shape of data as well as behavior
	Sheets  []*SheetConfigOrUpdate `json:"sheets,omitempty" url:"sheets,omitempty"`
	Actions []*Action              `json:"actions,omitempty" url:"actions,omitempty"`
	// Metadata for the workbook
	Metadata interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// contains filtered or unexported fields
}

The updates to be made to an existing workbook

func (*WorkbookUpdate) GetActions

func (w *WorkbookUpdate) GetActions() []*Action

func (*WorkbookUpdate) GetEnvironmentId

func (w *WorkbookUpdate) GetEnvironmentId() *EnvironmentId

func (*WorkbookUpdate) GetExtraProperties

func (w *WorkbookUpdate) GetExtraProperties() map[string]interface{}

func (*WorkbookUpdate) GetLabels

func (w *WorkbookUpdate) GetLabels() []string

func (*WorkbookUpdate) GetMetadata

func (w *WorkbookUpdate) GetMetadata() interface{}

func (*WorkbookUpdate) GetName

func (w *WorkbookUpdate) GetName() *string

func (*WorkbookUpdate) GetNamespace

func (w *WorkbookUpdate) GetNamespace() *string

func (*WorkbookUpdate) GetSheets

func (w *WorkbookUpdate) GetSheets() []*SheetConfigOrUpdate

func (*WorkbookUpdate) GetSpaceId

func (w *WorkbookUpdate) GetSpaceId() *SpaceId

func (*WorkbookUpdate) String

func (w *WorkbookUpdate) String() string

func (*WorkbookUpdate) UnmarshalJSON

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

type WriteSecret

type WriteSecret struct {
	// The reference name for a secret.
	Name SecretName `json:"name" url:"name"`
	// The secret value. This is hidden in the UI.
	Value SecretValue `json:"value" url:"value"`
	// The Environment of the secret.
	EnvironmentId *EnvironmentId `json:"environmentId,omitempty" url:"environmentId,omitempty"`
	// The Space of the secret.
	SpaceId *SpaceId `json:"spaceId,omitempty" url:"spaceId,omitempty"`
	// The Actor of the secret.
	ActorId *ActorIdUnion `json:"actorId,omitempty" url:"actorId,omitempty"`
	// contains filtered or unexported fields
}

The properties required to write to a secret. Value is the only mutable property. Name, environmentId, spaceId (optional) are used for finding the secret.

func (*WriteSecret) GetActorId

func (w *WriteSecret) GetActorId() *ActorIdUnion

func (*WriteSecret) GetEnvironmentId

func (w *WriteSecret) GetEnvironmentId() *EnvironmentId

func (*WriteSecret) GetExtraProperties

func (w *WriteSecret) GetExtraProperties() map[string]interface{}

func (*WriteSecret) GetName

func (w *WriteSecret) GetName() SecretName

func (*WriteSecret) GetSpaceId

func (w *WriteSecret) GetSpaceId() *SpaceId

func (*WriteSecret) GetValue

func (w *WriteSecret) GetValue() SecretValue

func (*WriteSecret) String

func (w *WriteSecret) String() string

func (*WriteSecret) UnmarshalJSON

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