api

package module
v0.0.12 Latest Latest
Warning

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

 Go to latest Published: Apr 25, 2024 License: MIT Imports: 5 Imported by: 0

README

Flatfile Go Library

fern shield go shield

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

Constants

This section is empty.

Variables

This section is empty.

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 added in v0.0.8 

func MustParseDate(date string) time.Time

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

func MustParseDateTime added in v0.0.8 

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 added in v0.0.8 

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 added in v0.0.9 

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) MarshalJSON added in v0.0.9 

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

func (*Account) String added in v0.0.9 

func (a *Account) String() string

func (*Account) UnmarshalJSON added in v0.0.9 

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

type AccountId 

type AccountId = string

Account ID

type AccountPatch added in v0.0.9 

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

Properties used to update an account

func (*AccountPatch) String added in v0.0.9 

func (a *AccountPatch) String() string

func (*AccountPatch) UnmarshalJSON added in v0.0.9 

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

type AccountResponse added in v0.0.9 

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

func (*AccountResponse) String added in v0.0.9 

func (a *AccountResponse) String() string

func (*AccountResponse) UnmarshalJSON added in v0.0.9 

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"`
	// The text on the button itself.
	Label string `json:"label" url:"label"`
	// 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"`
	// contains filtered or unexported fields
}

func (*Action) String 

func (a *Action) String() string

func (*Action) UnmarshalJSON 

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

type ActionConstraint 

type ActionConstraint struct {
	Type ActionConstraintType `json:"type,omitempty" url:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*ActionConstraint) String 

func (a *ActionConstraint) String() string

func (*ActionConstraint) UnmarshalJSON 

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

type ActionConstraintType 

type ActionConstraintType string
const (
	ActionConstraintTypeHasAllValid  ActionConstraintType = "hasAllValid"
	ActionConstraintTypeHasSelection ActionConstraintType = "hasSelection"
	ActionConstraintTypeHasData      ActionConstraintType = "hasData"
)

func NewActionConstraintTypeFromString 

func NewActionConstraintTypeFromString(s string) (ActionConstraintType, error)

func (ActionConstraintType) Ptr 

func (a ActionConstraintType) Ptr() *ActionConstraintType

type ActionMessage added in v0.0.6 

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

func (*ActionMessage) String added in v0.0.6 

func (a *ActionMessage) String() string

func (*ActionMessage) UnmarshalJSON added in v0.0.6 

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

type ActionMessageType added in v0.0.6 

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

func NewActionMessageTypeFromString added in v0.0.6 

func NewActionMessageTypeFromString(s string) (ActionMessageType, error)

func (ActionMessageType) Ptr added in v0.0.6 

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 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 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) 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 added in v0.0.8 

type ActorRoleId = string

Actor Role ID

type ActorRoleResponse added in v0.0.8 

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) MarshalJSON added in v0.0.8 

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

func (*ActorRoleResponse) String added in v0.0.8 

func (a *ActorRoleResponse) String() string

func (*ActorRoleResponse) UnmarshalJSON added in v0.0.8 

func (a *ActorRoleResponse) 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 slug of the agent
	Slug *string `json:"slug,omitempty" url:"slug,omitempty"`
	Id   AgentId `json:"id" url:"id"`
	// contains filtered or unexported fields
}

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 slug of the agent
	Slug *string `json:"slug,omitempty" url:"slug,omitempty"`
	// contains filtered or unexported fields
}

Properties used to create a new agent

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) 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) String 

func (a *AgentResponse) String() string

func (*AgentResponse) UnmarshalJSON 

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

type App added in v0.0.6 

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,omitempty" url:"type,omitempty"`
	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"`
	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) MarshalJSON added in v0.0.8 

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

func (*App) String added in v0.0.6 

func (a *App) String() string

func (*App) UnmarshalJSON added in v0.0.6 

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

type AppCreate added in v0.0.6 

type AppCreate struct {
	Name               string      `json:"name" url:"name"`
	Namespace          string      `json:"namespace" url:"namespace"`
	Type               AppType     `json:"type,omitempty" url:"type,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"`
	// contains filtered or unexported fields
}

Create an app

func (*AppCreate) String added in v0.0.6 

func (a *AppCreate) String() string

func (*AppCreate) UnmarshalJSON added in v0.0.6 

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

type AppId added in v0.0.6 

type AppId = string

App ID

type AppPatch added in v0.0.6 

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"`
	ActivatedAt        *time.Time  `json:"activatedAt,omitempty" url:"activatedAt,omitempty"`
	// contains filtered or unexported fields
}

Update an app

func (*AppPatch) MarshalJSON added in v0.0.8 

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

func (*AppPatch) String added in v0.0.6 

func (a *AppPatch) String() string

func (*AppPatch) UnmarshalJSON added in v0.0.6 

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

type AppResponse added in v0.0.6 

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

func (*AppResponse) String added in v0.0.6 

func (a *AppResponse) String() string

func (*AppResponse) UnmarshalJSON added in v0.0.6 

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

type AppType added in v0.0.6 

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

func NewAppTypeFromString added in v0.0.6 

func NewAppTypeFromString(s string) (AppType, error)

func (AppType) Ptr added in v0.0.6 

func (a AppType) Ptr() *AppType

type AppsResponse added in v0.0.6 

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

func (*AppsResponse) String added in v0.0.6 

func (a *AppsResponse) String() string

func (*AppsResponse) UnmarshalJSON added in v0.0.6 

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) String 

func (a *ArrayableProperty) String() string

func (*ArrayableProperty) UnmarshalJSON 

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

type AssignActorRoleRequest added in v0.0.8 

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

func (*AssignActorRoleRequest) String added in v0.0.8 

func (a *AssignActorRoleRequest) String() string

func (*AssignActorRoleRequest) UnmarshalJSON added in v0.0.8 

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) 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) MarshalJSON added in v0.0.8 

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,omitempty" url:"domain,omitempty"`
	// 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) 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"`
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,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) 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"`
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,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) 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) 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) String 

func (c *CategoryMapping) String() string

func (*CategoryMapping) UnmarshalJSON 

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

type CellConfig added in v0.0.10 

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

CellConfig

func (*CellConfig) String added in v0.0.10 

func (c *CellConfig) String() string

func (*CellConfig) UnmarshalJSON added in v0.0.10 

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"`
	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) MarshalJSON added in v0.0.8 

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
	// 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 (*CellValueUnion) Accept 

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

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
}

type CellValueWithCounts 

type CellValueWithCounts struct {
	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"`
	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) MarshalJSON added in v0.0.8 

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 struct {
	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"`
	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) MarshalJSON added in v0.0.8 

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) 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) 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) MarshalJSON added in v0.0.8 

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) 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 added in v0.0.6 

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"`
	Strategy CompositeUniqueConstraintStrategy `json:"strategy,omitempty" url:"strategy,omitempty"`
	// contains filtered or unexported fields
}

func (*CompositeUniqueConstraint) String added in v0.0.6 

func (c *CompositeUniqueConstraint) String() string

func (*CompositeUniqueConstraint) UnmarshalJSON added in v0.0.6 

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

type CompositeUniqueConstraintStrategy added in v0.0.6 

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 added in v0.0.6 

func NewCompositeUniqueConstraintStrategyFromString(s string) (CompositeUniqueConstraintStrategy, error)

func (CompositeUniqueConstraintStrategy) Ptr added in v0.0.6 

func (c CompositeUniqueConstraintStrategy) Ptr() *CompositeUniqueConstraintStrategy

type Constraint 

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

func NewConstraintFromComputed 

func NewConstraintFromComputed(value interface{}) *Constraint

func NewConstraintFromExternal added in v0.0.8 

func NewConstraintFromExternal(value *ExternalConstraint) *Constraint

func NewConstraintFromRequired 

func NewConstraintFromRequired(value interface{}) *Constraint

func NewConstraintFromUnique 

func NewConstraintFromUnique(value *UniqueConstraint) *Constraint

func (*Constraint) Accept 

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

func (Constraint) MarshalJSON 

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

func (*Constraint) UnmarshalJSON 

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

type ConstraintVisitor 

type ConstraintVisitor interface {
	VisitRequired(interface{}) error
	VisitUnique(*UniqueConstraint) error
	VisitComputed(interface{}) error
	VisitExternal(*ExternalConstraint) 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"`
	// contains filtered or unexported fields
}

The context of the event

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,omitempty" url:"domain,omitempty"`
	// 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,omitempty" url:"topic,omitempty"`
	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) MarshalJSON added in v0.0.8 

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:"spaceId"`
	EnvironmentId EnvironmentId `json:"environmentId" url:"environmentId"`
	// The storage mode of file to insert, defaults to "import"
	Mode *Mode `json:"mode,omitempty" url:"mode,omitempty"`
	// The actions attached to the file
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
	// The origin of the file, ie filesystem
	Origin *FileOrigin `json:"origin,omitempty" url:"origin,omitempty"`
}

type CreateGuestResponse 

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

func (*CreateGuestResponse) String 

func (c *CreateGuestResponse) String() string

func (*CreateGuestResponse) UnmarshalJSON 

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

type CreateMappingRulesRequest added in v0.0.6 

type CreateMappingRulesRequest = []*MappingRuleConfig

type CreateSnapshotRequest 

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

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"`
	// contains filtered or unexported fields
}

Properties used to create a new Workbook

func (*CreateWorkbookConfig) String 

func (c *CreateWorkbookConfig) String() string

func (*CreateWorkbookConfig) UnmarshalJSON 

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

type DataRetentionPolicy added in v0.0.6 

type DataRetentionPolicy struct {
	Type          DataRetentionPolicyEnum `json:"type,omitempty" url:"type,omitempty"`
	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) MarshalJSON added in v0.0.8 

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

func (*DataRetentionPolicy) String added in v0.0.6 

func (d *DataRetentionPolicy) String() string

func (*DataRetentionPolicy) UnmarshalJSON added in v0.0.6 

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

type DataRetentionPolicyConfig added in v0.0.6 

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

func (*DataRetentionPolicyConfig) String added in v0.0.6 

func (d *DataRetentionPolicyConfig) String() string

func (*DataRetentionPolicyConfig) UnmarshalJSON added in v0.0.6 

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

type DataRetentionPolicyEnum added in v0.0.6 

type DataRetentionPolicyEnum string

The type of data retention policy on an environment 

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

func NewDataRetentionPolicyEnumFromString added in v0.0.6 

func NewDataRetentionPolicyEnumFromString(s string) (DataRetentionPolicyEnum, error)

func (DataRetentionPolicyEnum) Ptr added in v0.0.6 

func (d DataRetentionPolicyEnum) Ptr() *DataRetentionPolicyEnum

type DataRetentionPolicyId added in v0.0.6 

type DataRetentionPolicyId = string

Data Retention Policy ID

type DataRetentionPolicyResponse added in v0.0.6 

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

func (*DataRetentionPolicyResponse) String added in v0.0.6 

func (d *DataRetentionPolicyResponse) String() string

func (*DataRetentionPolicyResponse) UnmarshalJSON added in v0.0.6 

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"`
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,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) 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 added in v0.0.10 

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

type DeleteRecordsJobConfig 

type DeleteRecordsJobConfig struct {
	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"`
	// 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"`
	// contains filtered or unexported fields
}

The configuration for a delete job

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) 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) MarshalJSON added in v0.0.8 

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"`
	// contains filtered or unexported fields
}

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) 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"`
	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"`
	// contains filtered or unexported fields
}

func (*DiffValue) MarshalJSON added in v0.0.8 

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) MarshalJSON added in v0.0.8 

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) 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) 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"
)

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) 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) String 

func (e *EmptyObject) String() string

func (*EmptyObject) UnmarshalJSON 

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

type Entitlement added in v0.0.8 

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) String added in v0.0.8 

func (e *Entitlement) String() string

func (*Entitlement) UnmarshalJSON added in v0.0.8 

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) String 

func (e *EnumDetails) String() string

func (*EnumDetails) UnmarshalJSON 

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

type EnumListProperty added in v0.0.12 

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"`
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,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) String added in v0.0.12 

func (e *EnumListProperty) String() string

func (*EnumListProperty) UnmarshalJSON added in v0.0.12 

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"`
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,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) 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"`
	// contains filtered or unexported fields
}

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, 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"`
	// Alternative names to match this enum option to
	AlternativeNames []string `json:"alternativeNames,omitempty" url:"alternativeNames,omitempty"`
	// contains filtered or unexported fields
}

func (*EnumPropertyOption) String 

func (e *EnumPropertyOption) String() string

func (*EnumPropertyOption) UnmarshalJSON 

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

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) 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) 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) 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) 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) 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) 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) 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
}

An event that tracks an activity within an environment

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 NewEventFromDocumentCreated 

func NewEventFromDocumentCreated(value *GenericEvent) *Event

func NewEventFromDocumentDeleted 

func NewEventFromDocumentDeleted(value *GenericEvent) *Event

func NewEventFromDocumentUpdated 

func NewEventFromDocumentUpdated(value *GenericEvent) *Event

func NewEventFromFileCreated 

func NewEventFromFileCreated(value *GenericEvent) *Event

func NewEventFromFileDeleted 

func NewEventFromFileDeleted(value *GenericEvent) *Event

func NewEventFromFileExpired added in v0.0.5 

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 added in v0.0.6 

func NewEventFromProgramCreated(value *GenericEvent) *Event

func NewEventFromProgramUpdated added in v0.0.6 

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 added in v0.0.6 

func NewEventFromSecretCreated(value *GenericEvent) *Event

func NewEventFromSecretDeleted added in v0.0.6 

func NewEventFromSecretDeleted(value *GenericEvent) *Event

func NewEventFromSecretUpdated added in v0.0.6 

func NewEventFromSecretUpdated(value *GenericEvent) *Event

func NewEventFromSheetCountsUpdated added in v0.0.9 

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 added in v0.0.6 

func NewEventFromSpaceArchived(value *GenericEvent) *Event

func NewEventFromSpaceCreated 

func NewEventFromSpaceCreated(value *GenericEvent) *Event

func NewEventFromSpaceDeleted 

func NewEventFromSpaceDeleted(value *GenericEvent) *Event

func NewEventFromSpaceExpired added in v0.0.5 

func NewEventFromSpaceExpired(value *GenericEvent) *Event

func NewEventFromSpaceGuestAdded added in v0.0.6 

func NewEventFromSpaceGuestAdded(value *GenericEvent) *Event

func NewEventFromSpaceGuestRemoved added in v0.0.6 

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 added in v0.0.5 

func NewEventFromWorkbookExpired(value *GenericEvent) *Event

func NewEventFromWorkbookUpdated 

func NewEventFromWorkbookUpdated(value *GenericEvent) *Event

func (*Event) Accept 

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

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) MarshalJSON added in v0.0.8 

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) 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) 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) 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) 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"
	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"
)

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
}

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) MarshalJSON added in v0.0.8 

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) 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) String 

func (e *ExportOptions) String() string

func (*ExportOptions) UnmarshalJSON 

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

type ExternalConstraint added in v0.0.8 

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

func (*ExternalConstraint) String added in v0.0.8 

func (e *ExternalConstraint) String() string

func (*ExternalConstraint) UnmarshalJSON added in v0.0.8 

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

type ExternalSheetConstraint added in v0.0.8 

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) String added in v0.0.8 

func (e *ExternalSheetConstraint) String() string

func (*ExternalSheetConstraint) UnmarshalJSON added in v0.0.8 

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

type FamilyId added in v0.0.6 

type FamilyId = string

Mapping Family ID

type FieldAppearance added in v0.0.10 

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) String added in v0.0.10 

func (f *FieldAppearance) String() string

func (*FieldAppearance) UnmarshalJSON added in v0.0.10 

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 added in v0.0.8 

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) String added in v0.0.8 

func (f *FieldRecordCounts) String() string

func (*FieldRecordCounts) UnmarshalJSON added in v0.0.8 

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

type FieldSize added in v0.0.10 

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 added in v0.0.10 

func NewFieldSizeFromString(s string) (FieldSize, error)

func (FieldSize) Ptr added in v0.0.10 

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,omitempty" url:"status,omitempty"`
	// 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) MarshalJSON added in v0.0.8 

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,omitempty" url:"driver,omitempty"`
	// The options to use for extracting data from the file
	Options map[string]interface{} `json:"options,omitempty" url:"options,omitempty"`
	// contains filtered or unexported fields
}

func (*FileJobConfig) String 

func (f *FileJobConfig) String() string

func (*FileJobConfig) UnmarshalJSON 

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

type FileOrigin added in v0.0.10 

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

func NewFileOriginFromString added in v0.0.10 

func NewFileOriginFromString(s string) (FileOrigin, error)

func (FileOrigin) Ptr added in v0.0.10 

func (f FileOrigin) Ptr() *FileOrigin

type FileResponse 

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

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"`
	// contains filtered or unexported fields
}

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:"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"`
}

type ForbiddenError added in v0.0.8 

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

func (*ForbiddenError) MarshalJSON added in v0.0.8 

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

func (*ForbiddenError) UnmarshalJSON added in v0.0.8 

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

func (*ForbiddenError) Unwrap added in v0.0.8 

func (f *ForbiddenError) Unwrap() error

type GenericEvent 

type GenericEvent struct {
	// The domain of the event
	Domain Domain `json:"domain,omitempty" url:"domain,omitempty"`
	// 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) MarshalJSON added in v0.0.8 

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 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) 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"`
}

type GetDetailedAgentLogResponse 

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

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) 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) 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 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 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"`
	// 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) 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) 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"
)

func NewGetSpacesSortFieldFromString 

func NewGetSpacesSortFieldFromString(s string) (GetSpacesSortField, error)

func (GetSpacesSortField) Ptr 

func (g GetSpacesSortField) Ptr() *GetSpacesSortField

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) MarshalJSON added in v0.0.8 

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) 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) 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) 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) MarshalJSON added in v0.0.8 

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) 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) 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) String 

func (g *GuestWorkbook) String() string

func (*GuestWorkbook) UnmarshalJSON 

func (g *GuestWorkbook) 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) 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,omitempty" url:"type,omitempty"`
	// contains filtered or unexported fields
}

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) 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) 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,omitempty" url:"type,omitempty"`
	Fields []*InputField `json:"fields,omitempty" url:"fields,omitempty"`
	// contains filtered or unexported fields
}

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"`
	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"`
	// contains filtered or unexported fields
}

func (*InternalSpaceConfigBase) MarshalJSON added in v0.0.8 

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) 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,omitempty" url:"type,omitempty"`
	// 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"`
	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) MarshalJSON added in v0.0.8 

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) MarshalJSON added in v0.0.8 

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) 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) 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,omitempty" url:"type,omitempty"`
	// 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"`
	// contains filtered or unexported fields
}

A single unit of work that a pipeline will execute

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) 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) 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) 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) 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"`
	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) 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
	Wait     *JobOutcomeNextWait
	Snapshot *JobOutcomeNextSnapshot
	Retry    *JobOutcomeNextRetry
}

func NewJobOutcomeNextFromDownload 

func NewJobOutcomeNextFromDownload(value *JobOutcomeNextDownload) *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 NewJobOutcomeNextFromWait 

func NewJobOutcomeNextFromWait(value *JobOutcomeNextWait) *JobOutcomeNext

func (*JobOutcomeNext) Accept 

func (j *JobOutcomeNext) Accept(visitor JobOutcomeNextVisitor) error

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) String 

func (j *JobOutcomeNextDownload) String() string

func (*JobOutcomeNextDownload) UnmarshalJSON 

func (j *JobOutcomeNextDownload) 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) 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) 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) 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) String 

func (j *JobOutcomeNextUrl) String() string

func (*JobOutcomeNextUrl) UnmarshalJSON 

func (j *JobOutcomeNextUrl) UnmarshalJSON(data []byte) error

type JobOutcomeNextVisitor 

type JobOutcomeNextVisitor interface {
	VisitId(*JobOutcomeNextId) error
	VisitUrl(*JobOutcomeNextUrl) error
	VisitDownload(*JobOutcomeNextDownload) error
	VisitWait(*JobOutcomeNextWait) error
	VisitSnapshot(*JobOutcomeNextSnapshot) error
	VisitRetry(*JobOutcomeNextRetry) 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) String 

func (j *JobOutcomeNextWait) String() string

func (*JobOutcomeNextWait) UnmarshalJSON 

func (j *JobOutcomeNextWait) UnmarshalJSON(data []byte) 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) 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) 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) 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) 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, or sheet

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) 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"
)

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) 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"
)

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"`
	// contains filtered or unexported fields
}

A single unit of work that will be executed

func (*JobUpdate) MarshalJSON added in v0.0.8 

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
	EmptyObject             *EmptyObject
	// contains filtered or unexported fields
}

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 (*JobUpdateConfig) Accept 

func (j *JobUpdateConfig) Accept(visitor JobUpdateConfigVisitor) error

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
	VisitEmptyObject(*EmptyObject) error
}

type ListActorRolesResponse added in v0.0.8 

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

func (*ListActorRolesResponse) String added in v0.0.8 

func (l *ListActorRolesResponse) String() string

func (*ListActorRolesResponse) UnmarshalJSON added in v0.0.8 

func (l *ListActorRolesResponse) 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) 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) 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) String 

func (l *ListCommitsResponse) String() string

func (*ListCommitsResponse) UnmarshalJSON 

func (l *ListCommitsResponse) UnmarshalJSON(data []byte) error

type ListDataRetentionPoliciesRequest added in v0.0.6 

type ListDataRetentionPoliciesRequest struct {
	// The associated Environment ID of the policy.
	EnvironmentId *EnvironmentId `json:"-" url:"environmentId,omitempty"`
}

type ListDataRetentionPoliciesResponse added in v0.0.6 

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

func (*ListDataRetentionPoliciesResponse) String added in v0.0.6 

func (l *ListDataRetentionPoliciesResponse) String() string

func (*ListDataRetentionPoliciesResponse) UnmarshalJSON added in v0.0.6 

func (l *ListDataRetentionPoliciesResponse) UnmarshalJSON(data []byte) error

type ListDocumentsResponse 

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

func (*ListDocumentsResponse) String 

func (l *ListDocumentsResponse) String() string

func (*ListDocumentsResponse) UnmarshalJSON 

func (l *ListDocumentsResponse) UnmarshalJSON(data []byte) error

type ListEntitlementsRequest added in v0.0.8 

type ListEntitlementsRequest struct {
	// The associated Resource ID for the entitlements.
	ResourceId string `json:"-" url:"resourceId"`
}

type ListEntitlementsResponse added in v0.0.8 

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

func (*ListEntitlementsResponse) String added in v0.0.8 

func (l *ListEntitlementsResponse) String() string

func (*ListEntitlementsResponse) UnmarshalJSON added in v0.0.8 

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) 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) 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) String 

func (l *ListGuestsResponse) String() string

func (*ListGuestsResponse) UnmarshalJSON 

func (l *ListGuestsResponse) UnmarshalJSON(data []byte) error

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"`
}

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) String 

func (l *ListJobsResponse) String() string

func (*ListJobsResponse) UnmarshalJSON 

func (l *ListJobsResponse) UnmarshalJSON(data []byte) error

type ListProgramsRequest added in v0.0.6 

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 added in v0.0.9 

type ListPromptsRequest struct {
	// 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 added in v0.0.8 

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

func (*ListRolesResponse) String added in v0.0.8 

func (l *ListRolesResponse) String() string

func (*ListRolesResponse) UnmarshalJSON added in v0.0.8 

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"`
}

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) 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"`
}

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"`
}

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) 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"`
}

type ListUsersResponse 

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

func (*ListUsersResponse) String 

func (l *ListUsersResponse) String() string

func (*ListUsersResponse) UnmarshalJSON 

func (l *ListUsersResponse) UnmarshalJSON(data []byte) error

type ListViewsRequest added in v0.0.11 

type ListViewsRequest struct {
	// The associated sheet ID of the view.
	SheetId SheetId `json:"-" url:"sheetId"`
}

type ListViewsResponse added in v0.0.11 

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) String added in v0.0.11 

func (l *ListViewsResponse) String() string

func (*ListViewsResponse) UnmarshalJSON added in v0.0.11 

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"`
	// 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) String 

func (l *ListWorkbooksResponse) String() string

func (*ListWorkbooksResponse) UnmarshalJSON 

func (l *ListWorkbooksResponse) UnmarshalJSON(data []byte) error

type MappingId added in v0.0.6 

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) String 

func (m *MappingProgramJobConfig) String() string

func (*MappingProgramJobConfig) UnmarshalJSON 

func (m *MappingProgramJobConfig) UnmarshalJSON(data []byte) error

type MappingRule added in v0.0.6 

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"`
	// 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) MarshalJSON added in v0.0.8 

func (m *MappingRule) MarshalJSON() ([]byte, error)

func (*MappingRule) String added in v0.0.6 

func (m *MappingRule) String() string

func (*MappingRule) UnmarshalJSON added in v0.0.6 

func (m *MappingRule) UnmarshalJSON(data []byte) error

type MappingRuleConfig added in v0.0.6 

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"`
	// contains filtered or unexported fields
}

func (*MappingRuleConfig) MarshalJSON added in v0.0.8 

func (m *MappingRuleConfig) MarshalJSON() ([]byte, error)

func (*MappingRuleConfig) String added in v0.0.6 

func (m *MappingRuleConfig) String() string

func (*MappingRuleConfig) UnmarshalJSON added in v0.0.6 

func (m *MappingRuleConfig) UnmarshalJSON(data []byte) error

type MappingRuleOrConfig added in v0.0.6 

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"`
	// 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) MarshalJSON added in v0.0.8 

func (m *MappingRuleOrConfig) MarshalJSON() ([]byte, error)

func (*MappingRuleOrConfig) String added in v0.0.6 

func (m *MappingRuleOrConfig) String() string

func (*MappingRuleOrConfig) UnmarshalJSON added in v0.0.6 

func (m *MappingRuleOrConfig) UnmarshalJSON(data []byte) error

type MappingRuleResponse added in v0.0.6 

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

func (*MappingRuleResponse) String added in v0.0.6 

func (m *MappingRuleResponse) String() string

func (*MappingRuleResponse) UnmarshalJSON added in v0.0.6 

func (m *MappingRuleResponse) UnmarshalJSON(data []byte) error

type MappingRulesResponse added in v0.0.6 

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

func (*MappingRulesResponse) String added in v0.0.6 

func (m *MappingRulesResponse) String() string

func (*MappingRulesResponse) UnmarshalJSON added in v0.0.6 

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"`
	// contains filtered or unexported fields
}

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) 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) 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"`
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,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) 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) 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) 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) String 

func (p *PipelineJobConfig) String() string

func (*PipelineJobConfig) UnmarshalJSON 

func (p *PipelineJobConfig) UnmarshalJSON(data []byte) error

type Program added in v0.0.6 

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) MarshalJSON added in v0.0.8 

func (p *Program) MarshalJSON() ([]byte, error)

func (*Program) String added in v0.0.6 

func (p *Program) String() string

func (*Program) UnmarshalJSON added in v0.0.6 

func (p *Program) UnmarshalJSON(data []byte) error

type ProgramConfig added in v0.0.6 

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) String added in v0.0.6 

func (p *ProgramConfig) String() string

func (*ProgramConfig) UnmarshalJSON added in v0.0.6 

func (p *ProgramConfig) UnmarshalJSON(data []byte) error

type ProgramId added in v0.0.6 

type ProgramId = string

Mapping Program ID

type ProgramResponse added in v0.0.6 

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

func (*ProgramResponse) String added in v0.0.6 

func (p *ProgramResponse) String() string

func (*ProgramResponse) UnmarshalJSON added in v0.0.6 

func (p *ProgramResponse) UnmarshalJSON(data []byte) error

type ProgramSummary added in v0.0.6 

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) String added in v0.0.6 

func (p *ProgramSummary) String() string

func (*ProgramSummary) UnmarshalJSON added in v0.0.6 

func (p *ProgramSummary) UnmarshalJSON(data []byte) error

type ProgramsResponse added in v0.0.6 

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

func (*ProgramsResponse) String added in v0.0.6 

func (p *ProgramsResponse) String() string

func (*ProgramsResponse) UnmarshalJSON added in v0.0.6 

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) String 

func (p *Progress) String() string

func (*Progress) UnmarshalJSON 

func (p *Progress) UnmarshalJSON(data []byte) error

type Prompt added in v0.0.9 

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"`
	// 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) MarshalJSON added in v0.0.9 

func (p *Prompt) MarshalJSON() ([]byte, error)

func (*Prompt) String added in v0.0.9 

func (p *Prompt) String() string

func (*Prompt) UnmarshalJSON added in v0.0.9 

func (p *Prompt) UnmarshalJSON(data []byte) error

type PromptCreate added in v0.0.9 

type PromptCreate struct {
	Prompt string `json:"prompt" url:"prompt"`
	// contains filtered or unexported fields
}

Create a prompts

func (*PromptCreate) String added in v0.0.9 

func (p *PromptCreate) String() string

func (*PromptCreate) UnmarshalJSON added in v0.0.9 

func (p *PromptCreate) UnmarshalJSON(data []byte) error

type PromptId added in v0.0.9 

type PromptId = string

Prompt ID

type PromptPatch added in v0.0.9 

type PromptPatch struct {
	Prompt *string `json:"prompt,omitempty" url:"prompt,omitempty"`
	// contains filtered or unexported fields
}

Update a prompts

func (*PromptPatch) String added in v0.0.9 

func (p *PromptPatch) String() string

func (*PromptPatch) UnmarshalJSON added in v0.0.9 

func (p *PromptPatch) UnmarshalJSON(data []byte) error

type PromptResponse added in v0.0.9 

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

func (*PromptResponse) String added in v0.0.9 

func (p *PromptResponse) String() string

func (*PromptResponse) UnmarshalJSON added in v0.0.9 

func (p *PromptResponse) UnmarshalJSON(data []byte) error

type PromptsResponse added in v0.0.9 

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) String added in v0.0.9 

func (p *PromptsResponse) String() string

func (*PromptsResponse) UnmarshalJSON added in v0.0.9 

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
	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 added in v0.0.12 

func NewPropertyFromEnumList(value *EnumListProperty) *Property

func NewPropertyFromNumber 

func NewPropertyFromNumber(value *NumberProperty) *Property

func NewPropertyFromReference 

func NewPropertyFromReference(value *ReferenceProperty) *Property

func NewPropertyFromString 

func NewPropertyFromString(value *StringProperty) *Property

func NewPropertyFromStringList added in v0.0.12 

func NewPropertyFromStringList(value *StringListProperty) *Property

func (*Property) Accept 

func (p *Property) Accept(visitor PropertyVisitor) error

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
	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) 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) String 

func (r *RecordBase) String() string

func (*RecordBase) UnmarshalJSON 

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

type RecordConfig added in v0.0.10 

type RecordConfig struct {
	Readonly *bool                  `json:"readonly,omitempty" url:"readonly,omitempty"`
	Fields   map[string]*CellConfig `json:"fields,omitempty" url:"fields,omitempty"`
	// contains filtered or unexported fields
}

Configuration of a record or specific fields in the record

func (*RecordConfig) String added in v0.0.10 

func (r *RecordConfig) String() string

func (*RecordConfig) UnmarshalJSON added in v0.0.10 

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) 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) 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) 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 = map[string]*CellValueWithLinks

A single row of data in a Sheet, including links to related rows

type RecordId 

type RecordId = string

Record ID 

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) 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) 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) String 

func (r *RecordsResponseData) String() string

func (*RecordsResponseData) UnmarshalJSON 

func (r *RecordsResponseData) UnmarshalJSON(data []byte) error
type RecordsWithLinks = []*RecordWithLinks

List of Record objects, including links to related rows

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"`
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,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) 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) 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 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) 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) 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) String 

func (r *RestoreOptions) String() string

func (*RestoreOptions) UnmarshalJSON 

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

type RoleId 

type RoleId = string

Role ID

type RoleResponse added in v0.0.8 

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) MarshalJSON added in v0.0.8 

func (r *RoleResponse) MarshalJSON() ([]byte, error)

func (*RoleResponse) String added in v0.0.8 

func (r *RoleResponse) String() string

func (*RoleResponse) UnmarshalJSON added in v0.0.8 

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

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 ID of the secret.
	Id SecretId `json:"id" url:"id"`
	// contains filtered or unexported fields
}

The value of a secret

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) 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"`
	// 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) MarshalJSON added in v0.0.8 

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) 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"`
	// 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) MarshalJSON added in v0.0.8 

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) String 

func (s *SheetConfigUpdate) String() string

func (*SheetConfigUpdate) UnmarshalJSON 

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

type SheetConstraint added in v0.0.6 

type SheetConstraint struct {
	Type     string
	Unique   *CompositeUniqueConstraint
	External *ExternalSheetConstraint
}

func NewSheetConstraintFromExternal added in v0.0.8 

func NewSheetConstraintFromExternal(value *ExternalSheetConstraint) *SheetConstraint

func NewSheetConstraintFromUnique added in v0.0.6 

func NewSheetConstraintFromUnique(value *CompositeUniqueConstraint) *SheetConstraint

func (*SheetConstraint) Accept added in v0.0.6 

func (s *SheetConstraint) Accept(visitor SheetConstraintVisitor) error

func (SheetConstraint) MarshalJSON added in v0.0.6 

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

func (*SheetConstraint) UnmarshalJSON added in v0.0.6 

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

type SheetConstraintVisitor added in v0.0.6 

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) 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"`
	// 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) MarshalJSON added in v0.0.8 

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 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.
	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"`
	// contains filtered or unexported fields
}

func (*Snapshot) MarshalJSON added in v0.0.8 

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) 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"`
	// contains filtered or unexported fields
}

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) 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) 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"`
	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"`
	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) MarshalJSON added in v0.0.8 

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"`
	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"`
	// 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) MarshalJSON added in v0.0.8 

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) String 

func (s *SpaceResponse) String() string

func (*SpaceResponse) UnmarshalJSON 

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

type SpaceSettings added in v0.0.10 

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) String added in v0.0.10 

func (s *SpaceSettings) String() string

func (*SpaceSettings) UnmarshalJSON added in v0.0.10 

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

type SpaceSidebarConfig added in v0.0.10 

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) String added in v0.0.10 

func (s *SpaceSidebarConfig) String() string

func (*SpaceSidebarConfig) UnmarshalJSON added in v0.0.10 

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) String 

func (s *SpaceSize) String() string

func (*SpaceSize) UnmarshalJSON 

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

type StringConfig 

type StringConfig struct {
	Size StringConfigOptions `json:"size,omitempty" url:"size,omitempty"`
	// contains filtered or unexported fields
}

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 added in v0.0.12 

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"`
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,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) String added in v0.0.12 

func (s *StringListProperty) String() string

func (*StringListProperty) UnmarshalJSON added in v0.0.12 

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"`
	Constraints []*Constraint    `json:"constraints,omitempty" url:"constraints,omitempty"`
	Readonly    *bool            `json:"readonly,omitempty" url:"readonly,omitempty"`
	Appearance  *FieldAppearance `json:"appearance,omitempty" url:"appearance,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) 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) 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) String 

func (s *SuccessData) String() string

func (*SuccessData) UnmarshalJSON 

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

type SuccessQueryParameter 

type SuccessQueryParameter = bool

Boolean

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) 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 UniqueConstraint 

type UniqueConstraint struct {
	Config *UniqueConstraintConfig `json:"config,omitempty" url:"config,omitempty"`
	// contains filtered or unexported fields
}

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) String 

func (u *UniqueConstraintConfig) String() string

func (*UniqueConstraintConfig) UnmarshalJSON 

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

type UpdateFileRequest 

type UpdateFileRequest struct {
	WorkbookId *WorkbookId `json:"workbookId,omitempty" url:"workbookId,omitempty"`
	// The name of the file
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// The storage mode of file to update
	Mode *Mode `json:"mode,omitempty" url:"mode,omitempty"`
	// Status of the file
	Status *ModelFileStatusEnum `json:"status,omitempty" url:"status,omitempty"`
	// The actions attached to the file
	Actions []*Action `json:"actions,omitempty" url:"actions,omitempty"`
}

type UpdateMappingRulesRequest added in v0.0.8 

type UpdateMappingRulesRequest = []*MappingRule

type UpdateUserRequest added in v0.0.8 

type UpdateUserRequest struct {
	Name      *string `json:"name,omitempty" url:"name,omitempty"`
	Dashboard *int    `json:"dashboard,omitempty" url:"dashboard,omitempty"`
}

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) MarshalJSON added in v0.0.8 

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) String 

func (u *UserConfig) String() string

func (*UserConfig) UnmarshalJSON 

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

type UserCreateAndInviteRequest added in v0.0.9 

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) String added in v0.0.9 

func (u *UserCreateAndInviteRequest) String() string

func (*UserCreateAndInviteRequest) UnmarshalJSON added in v0.0.9 

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) String 

func (u *UserResponse) String() string

func (*UserResponse) UnmarshalJSON 

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

type UserWithRoles added in v0.0.10 

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) MarshalJSON added in v0.0.10 

func (u *UserWithRoles) MarshalJSON() ([]byte, error)

func (*UserWithRoles) String added in v0.0.10 

func (u *UserWithRoles) String() string

func (*UserWithRoles) UnmarshalJSON added in v0.0.10 

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

type UserWithRolesResponse added in v0.0.10 

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

func (*UserWithRolesResponse) String added in v0.0.10 

func (u *UserWithRolesResponse) String() string

func (*UserWithRolesResponse) UnmarshalJSON added in v0.0.10 

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

type ValidationMessage 

type ValidationMessage struct {
	Type    *ValidationType   `json:"type,omitempty" url:"type,omitempty"`
	Source  *ValidationSource `json:"source,omitempty" url:"source,omitempty"`
	Message *string           `json:"message,omitempty" url:"message,omitempty"`
	// contains filtered or unexported fields
}

Record data validation messages

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) 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) 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:"sheetId,omitempty"`
	// 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:"parentVersionId,omitempty"`
}

type View added in v0.0.11 

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"`
	// contains filtered or unexported fields
}

A view

func (*View) String added in v0.0.11 

func (v *View) String() string

func (*View) UnmarshalJSON added in v0.0.11 

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

type ViewConfig added in v0.0.11 

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) String added in v0.0.11 

func (v *ViewConfig) String() string

func (*ViewConfig) UnmarshalJSON added in v0.0.11 

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

type ViewCreate added in v0.0.11 

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) String added in v0.0.11 

func (v *ViewCreate) String() string

func (*ViewCreate) UnmarshalJSON added in v0.0.11 

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

type ViewId added in v0.0.11 

type ViewId = string

View ID

type ViewResponse added in v0.0.11 

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

func (*ViewResponse) String added in v0.0.11 

func (v *ViewResponse) String() string

func (*ViewResponse) UnmarshalJSON added in v0.0.11 

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

type ViewUpdate added in v0.0.11 

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) String added in v0.0.11 

func (v *ViewUpdate) String() string

func (*ViewUpdate) UnmarshalJSON added in v0.0.11 

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"`
	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) MarshalJSON added in v0.0.8 

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"`
	// contains filtered or unexported fields
}

Settings for a workbook

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) String 

func (w *WorkbookResponse) String() string

func (*WorkbookResponse) UnmarshalJSON 

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

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) 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"`
	// 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) String 

func (w *WriteSecret) String() string

func (*WriteSecret) UnmarshalJSON 

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

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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