client

package
v2.3.0 Latest Latest
Warning

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

 Go to latest Published: Mar 2, 2026 License: MIT Imports: 19 Imported by: 0

Documentation

Overview

Package client provides a QuickBase API client with retry and rate limiting.

This package is typically used through the top-level quickbase package, but can be used directly for advanced use cases like custom pagination.

Basic usage: 

client, err := client.New(realm, authStrategy)
if err != nil {
    log.Fatal(err)
}
app, err := client.GetApp(ctx, appId)

With options: 

client, err := client.New(realm, authStrategy,
    client.WithMaxRetries(5),
    client.WithTimeout(60 * time.Second),
    client.WithProactiveThrottle(100),
)

Package client provides pagination support with fluent API for QuickBase SDK.

Provides automatic pagination for QuickBase API endpoints that return paginated results. Supports both skip-based and token-based pagination.

Example usage: 

// Fetch single page (default)
page, err := client.RunQuery(ctx, params)

// Fetch all pages automatically
all, err := client.RunQuery(ctx, params).All()

// Fetch with record limit
limited, err := client.RunQuery(ctx, params).Paginate(PaginationOptions{Limit: 500})

// Iterate over results
for record, err := range client.RunQueryIterator(ctx, params) {
    if err != nil { ... }
    // process record
}

Package client provides a QuickBase API client.

This file re-exports types from generated to make them available for consumers who need direct access to the Raw* API methods.

Index

Constants

This section is empty.

Variables

View Source 
var ErrNoSchema = &core.SchemaError{Message: "no schema configured; use WithSchema() option"}

ErrNoSchema is returned when a schema operation is attempted without a configured schema.

Functions

func CollectAll 

func CollectAll[T any, R PaginatedResponse[T]](ctx context.Context, fetcher PageFetcher[T, R]) ([]T, error)

CollectAll fetches all pages and returns all items.

func CollectN 

func CollectN[T any, R PaginatedResponse[T]](ctx context.Context, fetcher PageFetcher[T, R], n int) ([]T, error)

CollectN fetches up to n items across pages.

func Deref 

func Deref[T any](ptr *T) T

Deref returns the value of a pointer, or zero value if nil. This is an opt-in helper for working with the many optional (pointer) fields in generated response types.

Example: 

resp, _ := client.GetApp(appId).Run(ctx)
name := quickbase.Deref(resp.JSON200.Name) // string, not *string

func DerefOr 

func DerefOr[T any](ptr *T, defaultVal T) T

DerefOr returns the value of a pointer, or the default if nil. This is an opt-in helper for working with optional pointer fields.

Example: 

resp, _ := client.GetApp(appId).Run(ctx)
name := quickbase.DerefOr(resp.JSON200.Name, "Unknown")

func ExtractSortFields 

func ExtractSortFields(sortBy *generated.SortByUnion) ([]generated.SortField, error)

ExtractSortFields extracts the sort fields from a SortByUnion. Returns the slice of SortField values and nil error if successful.

func HasMorePages 

func HasMorePages(metadata PaginationMetadata, ptype PaginationType, currentCount int) bool

HasMorePages checks if a response has more pages available.

func Paginate 

func Paginate[T any, R PaginatedResponse[T]](ctx context.Context, fetcher PageFetcher[T, R]) iter.Seq2[T, error]

Paginate returns an iterator that automatically fetches all pages.

func SortFieldsToSortByUnion 

func SortFieldsToSortByUnion(fields []generated.SortField) (*generated.SortByUnion, error)

SortFieldsToSortByUnion converts a slice of SortField to a SortByUnion type. The SortBy parameter accepts either an array of sort specifications or false (to disable sorting).

func StringToDeleteWhereUnion 

func StringToDeleteWhereUnion(s string) (generated.DeleteRecordsJSONBody_Where, error)

StringToDeleteWhereUnion converts a string to a DeleteRecordsJSONBody_Where union type. The Where parameter accepts either a query string or an array of record IDs.

func StringToWhereUnion 

func StringToWhereUnion(s string) (*generated.RunQueryJSONBody_Where, error)

StringToWhereUnion converts a string to a RunQueryJSONBody_Where union type. The Where parameter accepts either a query string or an array of record IDs.

func ValidateRealm 

func ValidateRealm(realm string) error

ValidateRealm validates the realm format.

The realm should be just the subdomain portion, not the full hostname. For example, use "mycompany" not "mycompany.quickbase.com".

Types

type AddManagersToGroupBuilder 

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

AddManagersToGroupBuilder provides a fluent API for the addManagersToGroup operation. Add managers

func (*AddManagersToGroupBuilder) Run 

func (b *AddManagersToGroupBuilder) Run(ctx context.Context) (*AddManagersToGroupResult, error)

Run executes the addManagersToGroup request and returns the response data directly.

type AddManagersToGroupJSONRequestBody 

type AddManagersToGroupJSONRequestBody = generated.AddManagersToGroupJSONRequestBody

type AddManagersToGroupResponse 

type AddManagersToGroupResponse = generated.AddManagersToGroupResponse

type AddManagersToGroupResult 

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

AddManagersToGroupResult wraps AddManagersToGroupResponse with convenience methods.

func (*AddManagersToGroupResult) Raw added in v2.1.0 

func (r *AddManagersToGroupResult) Raw() *generated.AddManagersToGroupResponse

Raw returns the underlying generated response.

type AddMembersToGroupBuilder 

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

AddMembersToGroupBuilder provides a fluent API for the addMembersToGroup operation. Add members

func (*AddMembersToGroupBuilder) Run 

func (b *AddMembersToGroupBuilder) Run(ctx context.Context) (*AddMembersToGroupResult, error)

Run executes the addMembersToGroup request and returns the response data directly.

type AddMembersToGroupJSONRequestBody 

type AddMembersToGroupJSONRequestBody = generated.AddMembersToGroupJSONRequestBody

type AddMembersToGroupResponse 

type AddMembersToGroupResponse = generated.AddMembersToGroupResponse

type AddMembersToGroupResult 

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

AddMembersToGroupResult wraps AddMembersToGroupResponse with convenience methods.

func (*AddMembersToGroupResult) Raw added in v2.1.0 

func (r *AddMembersToGroupResult) Raw() *generated.AddMembersToGroupResponse

Raw returns the underlying generated response.

type AddSubgroupsToGroupBuilder 

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

AddSubgroupsToGroupBuilder provides a fluent API for the addSubgroupsToGroup operation. Add child groups

func (*AddSubgroupsToGroupBuilder) Run 

func (b *AddSubgroupsToGroupBuilder) Run(ctx context.Context) (*AddSubgroupsToGroupResult, error)

Run executes the addSubgroupsToGroup request and returns the response data directly.

type AddSubgroupsToGroupJSONRequestBody 

type AddSubgroupsToGroupJSONRequestBody = generated.AddSubgroupsToGroupJSONRequestBody

type AddSubgroupsToGroupResponse 

type AddSubgroupsToGroupResponse = generated.AddSubgroupsToGroupResponse

type AddSubgroupsToGroupResult 

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

AddSubgroupsToGroupResult wraps AddSubgroupsToGroupResponse with convenience methods.

func (*AddSubgroupsToGroupResult) Raw added in v2.1.0 

func (r *AddSubgroupsToGroupResult) Raw() *generated.AddSubgroupsToGroupResponse

Raw returns the underlying generated response.

type AddTrusteesBuilder 

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

AddTrusteesBuilder provides a fluent API for the addTrustees operation. Add trustees to an app

func (*AddTrusteesBuilder) Run 

func (b *AddTrusteesBuilder) Run(ctx context.Context) (*AddTrusteesResult, error)

Run executes the addTrustees request and returns the response data directly.

type AddTrusteesResult 

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

AddTrusteesResult wraps AddTrusteesResponse with convenience methods.

func (*AddTrusteesResult) Raw added in v2.1.0 

func (r *AddTrusteesResult) Raw() *generated.AddTrusteesResponse

Raw returns the underlying generated response.

type AppEventsItem 

type AppEventsItem struct {
	*generated.GetAppEventsItem
}

AppEventsItem wraps GetAppEventsItem with convenience methods.

func (*AppEventsItem) IsActive 

func (r *AppEventsItem) IsActive() bool

IsActive returns the IsActive field value, or zero value if nil.

func (*AppEventsItem) Name 

func (r *AppEventsItem) Name() string

Name returns the Name field value, or zero value if nil.

func (*AppEventsItem) Owner 

func (r *AppEventsItem) Owner() *GetAppEventsItemOwner

Owner returns the Owner field as a wrapped type, or nil if not set.

func (*AppEventsItem) TableId 

func (r *AppEventsItem) TableId() string

TableId returns the TableId field value, or zero value if nil.

func (*AppEventsItem) Type 

func (r *AppEventsItem) Type() string

Type returns the Type field value as a string, or empty string if nil.

func (*AppEventsItem) Url 

func (r *AppEventsItem) Url() string

Url returns the Url field value, or zero value if nil.

type AppEventsResult added in v2.1.0 

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

AppEventsResult wraps GetAppEventsResponse with convenience methods.

func (*AppEventsResult) Raw added in v2.1.0 

func (r *AppEventsResult) Raw() *generated.GetAppEventsResponse

Raw returns the underlying generated response.

type AppResult 

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

AppResult wraps GetAppResponse with convenience methods.

func (*AppResult) AncestorId 

func (r *AppResult) AncestorId() string

AncestorId returns the AncestorId field value, or zero value if nil.

func (*AppResult) Created 

func (r *AppResult) Created() string

Created returns the Created field value, or zero value if nil.

func (*AppResult) DataClassification 

func (r *AppResult) DataClassification() string

DataClassification returns the DataClassification field value, or zero value if nil.

func (*AppResult) DateFormat 

func (r *AppResult) DateFormat() string

DateFormat returns the DateFormat field value, or zero value if nil.

func (*AppResult) Description 

func (r *AppResult) Description() string

Description returns the Description field value, or zero value if nil.

func (*AppResult) HasEveryoneOnTheInternet 

func (r *AppResult) HasEveryoneOnTheInternet() bool

HasEveryoneOnTheInternet returns the HasEveryoneOnTheInternet field value, or zero value if nil.

func (*AppResult) Id 

func (r *AppResult) Id() string

Id returns the Id field value, or zero value if nil.

func (*AppResult) MemoryInfo added in v2.2.0 

func (r *AppResult) MemoryInfo() *GetAppMemoryInfo

MemoryInfo returns the MemoryInfo field as a wrapped type, or nil if not set.

func (*AppResult) Name 

func (r *AppResult) Name() string

Name returns the Name field value.

func (*AppResult) Raw added in v2.1.0 

func (r *AppResult) Raw() *generated.GetAppResponse

Raw returns the underlying generated response.

func (*AppResult) SecurityProperties 

func (r *AppResult) SecurityProperties() *GetAppSecurityProperties

SecurityProperties returns the SecurityProperties field as a wrapped type, or nil if not set.

func (*AppResult) TimeZone 

func (r *AppResult) TimeZone() string

TimeZone returns the TimeZone field value, or zero value if nil.

func (*AppResult) Updated 

func (r *AppResult) Updated() string

Updated returns the Updated field value, or zero value if nil.

type AppTablesItem 

type AppTablesItem struct {
	*generated.GetAppTablesItem
}

AppTablesItem wraps GetAppTablesItem with convenience methods.

func (*AppTablesItem) Alias 

func (r *AppTablesItem) Alias() string

Alias returns the Alias field value, or zero value if nil.

func (*AppTablesItem) Created 

func (r *AppTablesItem) Created() string

Created returns the Created field value, or zero value if nil.

func (*AppTablesItem) DefaultSortFieldId 

func (r *AppTablesItem) DefaultSortFieldId() int

DefaultSortFieldId returns the DefaultSortFieldId field value, or zero value if nil.

func (*AppTablesItem) DefaultSortOrder 

func (r *AppTablesItem) DefaultSortOrder() string

DefaultSortOrder returns the DefaultSortOrder field value as a string, or empty string if nil.

func (*AppTablesItem) Description 

func (r *AppTablesItem) Description() string

Description returns the Description field value, or zero value if nil.

func (*AppTablesItem) Id 

func (r *AppTablesItem) Id() string

Id returns the Id field value, or zero value if nil.

func (*AppTablesItem) KeyFieldId 

func (r *AppTablesItem) KeyFieldId() int

KeyFieldId returns the KeyFieldId field value, or zero value if nil.

func (*AppTablesItem) Name 

func (r *AppTablesItem) Name() string

Name returns the Name field value, or zero value if nil.

func (*AppTablesItem) NextFieldId 

func (r *AppTablesItem) NextFieldId() int

NextFieldId returns the NextFieldId field value, or zero value if nil.

func (*AppTablesItem) NextRecordId 

func (r *AppTablesItem) NextRecordId() int

NextRecordId returns the NextRecordId field value, or zero value if nil.

func (*AppTablesItem) PluralRecordName 

func (r *AppTablesItem) PluralRecordName() string

PluralRecordName returns the PluralRecordName field value, or zero value if nil.

func (*AppTablesItem) SingleRecordName 

func (r *AppTablesItem) SingleRecordName() string

SingleRecordName returns the SingleRecordName field value, or zero value if nil.

func (*AppTablesItem) SizeLimit 

func (r *AppTablesItem) SizeLimit() string

SizeLimit returns the SizeLimit field value, or zero value if nil.

func (*AppTablesItem) SpaceRemaining 

func (r *AppTablesItem) SpaceRemaining() string

SpaceRemaining returns the SpaceRemaining field value, or zero value if nil.

func (*AppTablesItem) SpaceUsed 

func (r *AppTablesItem) SpaceUsed() string

SpaceUsed returns the SpaceUsed field value, or zero value if nil.

func (*AppTablesItem) Updated 

func (r *AppTablesItem) Updated() string

Updated returns the Updated field value, or zero value if nil.

type AppTablesResult added in v2.1.0 

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

AppTablesResult wraps GetAppTablesResponse with convenience methods.

func (*AppTablesResult) Raw added in v2.1.0 

func (r *AppTablesResult) Raw() *generated.GetAppTablesResponse

Raw returns the underlying generated response.

type AuditBuilder 

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

AuditBuilder provides a fluent API for the audit operation. Get audit logs

func (*AuditBuilder) Date 

func (b *AuditBuilder) Date(value string) *AuditBuilder

Date The date for which audit logs need to be fetched. This must be date-time only, as YYYY-MM-DD, and a valid date in the past.

func (*AuditBuilder) NextToken 

func (b *AuditBuilder) NextToken(value string) *AuditBuilder

NextToken Token specifying start of page. For first page don't supply this.

func (*AuditBuilder) NumRows 

func (b *AuditBuilder) NumRows(value int) *AuditBuilder

NumRows Number of logs to return per page, default is 10000, minimum is 1000, max is 50000.

func (*AuditBuilder) QueryId 

func (b *AuditBuilder) QueryId(value string) *AuditBuilder

QueryId The query id of an audit log request. This id is needed to fetch subsequent paged results of a single query.

func (*AuditBuilder) Run 

func (b *AuditBuilder) Run(ctx context.Context) (*AuditResult, error)

Run executes the audit request and returns the response data directly.

func (*AuditBuilder) Topics 

func (b *AuditBuilder) Topics(values ...string) *AuditBuilder

Topics An array that may contain up to 20 [topics](https://resources.quickbase.com/nav/app/budurkasx/action/showpage/2b2941e4-f34d-4d41-9b0e-db790d20e9ab?pageIdV2=quickbase.com-DashboardGroup-15760d74-2243-4ce9-9495-7cc8790f12e7) to filter by. If empty, all topics are returned.

type AuditEventsItem 

type AuditEventsItem struct {
	*generated.AuditEventsItem
}

AuditEventsItem wraps AuditEventsItem with convenience methods.

func (*AuditEventsItem) Application 

func (r *AuditEventsItem) Application() string

Application returns the Application field value.

func (*AuditEventsItem) Description 

func (r *AuditEventsItem) Description() string

Description returns the Description field value.

func (*AuditEventsItem) Email 

func (r *AuditEventsItem) Email() string

Email returns the Email field value.

func (*AuditEventsItem) Firstname 

func (r *AuditEventsItem) Firstname() string

Firstname returns the Firstname field value.

func (*AuditEventsItem) Id 

func (r *AuditEventsItem) Id() string

Id returns the Id field value.

func (*AuditEventsItem) Ipaddress 

func (r *AuditEventsItem) Ipaddress() string

Ipaddress returns the Ipaddress field value.

func (*AuditEventsItem) Lastname 

func (r *AuditEventsItem) Lastname() string

Lastname returns the Lastname field value.

func (*AuditEventsItem) PayloadChanges 

func (r *AuditEventsItem) PayloadChanges() *AuditEventsItem_PayloadChanges

PayloadChanges returns the PayloadChanges field as a wrapped type, or nil if not set.

func (*AuditEventsItem) Time 

func (r *AuditEventsItem) Time() string

Time returns the Time field value.

func (*AuditEventsItem) Topic 

func (r *AuditEventsItem) Topic() string

Topic returns the Topic field value.

func (*AuditEventsItem) Useragent 

func (r *AuditEventsItem) Useragent() string

Useragent returns the Useragent field value.

type AuditEventsItem_PayloadChanges added in v2.2.0 

type AuditEventsItem_PayloadChanges struct {
	*generated.AuditEventsItem_PayloadChanges
}

AuditEventsItem_PayloadChanges wraps AuditEventsItem_PayloadChanges with convenience methods.

func (*AuditEventsItem_PayloadChanges) ChangeType added in v2.2.0 

func (r *AuditEventsItem_PayloadChanges) ChangeType() string

ChangeType returns the ChangeType field value.

func (*AuditEventsItem_PayloadChanges) Rid added in v2.2.0 

func (r *AuditEventsItem_PayloadChanges) Rid() int

Rid returns the Rid field value.

func (*AuditEventsItem_PayloadChanges) Type added in v2.2.0 

func (r *AuditEventsItem_PayloadChanges) Type() string

Type returns the Type field value.

type AuditEventsItem_PayloadChanges_Changes added in v2.2.0 

type AuditEventsItem_PayloadChanges_Changes struct {
	*generated.AuditEventsItem_PayloadChanges_Changes
}

AuditEventsItem_PayloadChanges_Changes wraps AuditEventsItem_PayloadChanges_Changes with convenience methods.

type AuditJSONRequestBody 

type AuditJSONRequestBody = generated.AuditJSONRequestBody

type AuditResponse 

type AuditResponse = generated.AuditResponse

type AuditResult 

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

AuditResult wraps AuditResponse with convenience methods.

func (*AuditResult) Events 

func (r *AuditResult) Events() []*AuditEventsItem

Events returns the Events field as wrapped types, or nil if not set.

func (*AuditResult) NextToken 

func (r *AuditResult) NextToken() string

NextToken returns the NextToken field value, or zero value if nil.

func (*AuditResult) QueryId 

func (r *AuditResult) QueryId() string

QueryId returns the QueryId field value.

func (*AuditResult) Raw added in v2.1.0 

func (r *AuditResult) Raw() *generated.AuditResponse

Raw returns the underlying generated response.

type ChangesetSolutionBuilder 

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

ChangesetSolutionBuilder provides a fluent API for the changesetSolution operation. List solution changes

func (*ChangesetSolutionBuilder) Run 

func (b *ChangesetSolutionBuilder) Run(ctx context.Context) (*generated.ChangesetSolutionResponse, error)

Run executes the changesetSolution request and returns the response data directly.

type ChangesetSolutionFromRecordBuilder 

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

ChangesetSolutionFromRecordBuilder provides a fluent API for the changesetSolutionFromRecord operation. List solution changes from record

func (*ChangesetSolutionFromRecordBuilder) FieldId 

func (b *ChangesetSolutionFromRecordBuilder) FieldId(value int) *ChangesetSolutionFromRecordBuilder

FieldId The unique identifier (fid) of the field. It needs to be a file attachment field.

func (*ChangesetSolutionFromRecordBuilder) RecordId 

func (b *ChangesetSolutionFromRecordBuilder) RecordId(value int) *ChangesetSolutionFromRecordBuilder

RecordId The unique identifier of the record.

func (*ChangesetSolutionFromRecordBuilder) Run 

func (b *ChangesetSolutionFromRecordBuilder) Run(ctx context.Context) (*generated.ChangesetSolutionFromRecordResponse, error)

Run executes the changesetSolutionFromRecord request and returns the response data directly.

type ChangesetSolutionFromRecordParams 

type ChangesetSolutionFromRecordParams = generated.ChangesetSolutionFromRecordParams

type ChangesetSolutionFromRecordResponse 

type ChangesetSolutionFromRecordResponse = generated.ChangesetSolutionFromRecordResponse

type ChangesetSolutionFromRecordResult added in v2.1.0 

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

ChangesetSolutionFromRecordResult wraps ChangesetSolutionFromRecordResponse with convenience methods.

func (*ChangesetSolutionFromRecordResult) Raw added in v2.1.0 

func (r *ChangesetSolutionFromRecordResult) Raw() *generated.ChangesetSolutionFromRecordResponse

Raw returns the underlying generated response.

type ChangesetSolutionJSONRequestBody 

type ChangesetSolutionJSONRequestBody = generated.ChangesetSolutionJSONRequestBody

type ChangesetSolutionParams 

type ChangesetSolutionParams = generated.ChangesetSolutionParams

type ChangesetSolutionResponse 

type ChangesetSolutionResponse = generated.ChangesetSolutionResponse

type ChangesetSolutionResult added in v2.1.0 

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

ChangesetSolutionResult wraps ChangesetSolutionResponse with convenience methods.

func (*ChangesetSolutionResult) Raw added in v2.1.0 

func (r *ChangesetSolutionResult) Raw() *generated.ChangesetSolutionResponse

Raw returns the underlying generated response.

type Client 

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

Client wraps the generated QuickBase client with authentication, automatic retry, and rate limiting. It provides a robust interface for making QuickBase API requests.

The Client automatically:

  • Adds authentication headers to all requests
  • Retries failed requests with exponential backoff and jitter
  • Handles rate limiting (429) responses with automatic retry
  • Refreshes expired tokens for temp token and SSO authentication
  • Applies proactive throttling to avoid hitting rate limits
  • Transforms table/field aliases to IDs (if schema configured)

Access the underlying generated API client via the API() method.

func New 

func New(realm string, authStrategy auth.Strategy, opts ...Option) (*Client, error)

New creates a new QuickBase client.

func (*Client) API 

func (c *Client) API() *generated.ClientWithResponses

API returns the generated API client for making requests.

The returned client provides strongly-typed methods for all QuickBase API endpoints. Each method has two variants:

  • Method(ctx, params) - returns (*http.Response, error)
  • MethodWithResponse(ctx, params) - returns parsed response with JSON200, JSON400, etc. fields

Example: 

resp, err := client.API().GetAppWithResponse(ctx, appId)
if err != nil {
    return err
}
if resp.JSON200 != nil {
    fmt.Println("App name:", resp.JSON200.Name)
}

func (*Client) AddManagersToGroup 

func (c *Client) AddManagersToGroup(gid float32) *AddManagersToGroupBuilder

AddManagersToGroup starts building a addManagersToGroup request.

func (*Client) AddMembersToGroup 

func (c *Client) AddMembersToGroup(gid float32) *AddMembersToGroupBuilder

AddMembersToGroup starts building a addMembersToGroup request.

func (*Client) AddSubgroupsToGroup 

func (c *Client) AddSubgroupsToGroup(gid float32) *AddSubgroupsToGroupBuilder

AddSubgroupsToGroup starts building a addSubgroupsToGroup request.

func (*Client) AddTrustees 

func (c *Client) AddTrustees(appId string) *AddTrusteesBuilder

AddTrustees starts building a addTrustees request.

func (*Client) Audit 

func (c *Client) Audit() *AuditBuilder

Audit starts building a audit request.

func (*Client) ChangesetSolution 

func (c *Client) ChangesetSolution(solutionId string) *ChangesetSolutionBuilder

ChangesetSolution starts building a changesetSolution request.

func (*Client) ChangesetSolutionFromRecord 

func (c *Client) ChangesetSolutionFromRecord(solutionId string, table string) *ChangesetSolutionFromRecordBuilder

ChangesetSolutionFromRecord starts building a changesetSolutionFromRecord request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) CloneUserToken 

func (c *Client) CloneUserToken() *CloneUserTokenBuilder

CloneUserToken starts building a cloneUserToken request.

func (*Client) Close 

func (c *Client) Close()

Close closes idle connections and releases resources. After calling Close, the client should not be used.

func (*Client) CopyApp 

func (c *Client) CopyApp(appId string) *CopyAppBuilder

CopyApp starts building a copyApp request.

func (*Client) CreateApp 

func (c *Client) CreateApp() *CreateAppBuilder

CreateApp starts building a createApp request.

func (*Client) CreateField 

func (c *Client) CreateField(table string) *CreateFieldBuilder

CreateField starts building a createField request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) CreateRelationship 

func (c *Client) CreateRelationship(table string) *CreateRelationshipBuilder

CreateRelationship starts building a createRelationship request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) CreateSolution 

func (c *Client) CreateSolution() *CreateSolutionBuilder

CreateSolution starts building a createSolution request.

func (*Client) CreateSolutionFromRecord 

func (c *Client) CreateSolutionFromRecord(table string) *CreateSolutionFromRecordBuilder

CreateSolutionFromRecord starts building a createSolutionFromRecord request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) CreateTable 

func (c *Client) CreateTable() *CreateTableBuilder

CreateTable starts building a createTable request.

func (*Client) DeactivateUserToken 

func (c *Client) DeactivateUserToken() *DeactivateUserTokenBuilder

DeactivateUserToken starts building a deactivateUserToken request.

func (*Client) DeleteApp 

func (c *Client) DeleteApp(appId string) *DeleteAppBuilder

DeleteApp starts building a deleteApp request.

func (*Client) DeleteFields 

func (c *Client) DeleteFields(table string) *DeleteFieldsBuilder

DeleteFields starts building a deleteFields request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) DeleteFile 

func (c *Client) DeleteFile(table string, recordId int, fieldId int, versionNumber int) *DeleteFileBuilder

DeleteFile starts building a deleteFile request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) DeleteRecords 

func (c *Client) DeleteRecords(table string) *DeleteRecordsBuilder

DeleteRecords starts building a deleteRecords request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) DeleteRelationship 

func (c *Client) DeleteRelationship(table string, relationshipId float32) *DeleteRelationshipBuilder

DeleteRelationship starts building a deleteRelationship request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) DeleteTable 

func (c *Client) DeleteTable(table string) *DeleteTableBuilder

DeleteTable starts building a deleteTable request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) DeleteUserToken 

func (c *Client) DeleteUserToken() *DeleteUserTokenBuilder

DeleteUserToken starts building a deleteUserToken request.

func (*Client) DenyUsers 

func (c *Client) DenyUsers() *DenyUsersBuilder

DenyUsers starts building a denyUsers request.

func (*Client) DenyUsersAndGroups 

func (c *Client) DenyUsersAndGroups(shouldDeleteFromGroups bool) *DenyUsersAndGroupsBuilder

DenyUsersAndGroups starts building a denyUsersAndGroups request.

func (*Client) DoXML deprecated 

func (c *Client) DoXML(ctx context.Context, dbid, action string, body []byte) ([]byte, error)

DoXML makes an XML API request to the legacy QuickBase XML API.

This method is used by the xml sub-package to call legacy XML API endpoints that have no JSON API equivalent (e.g., API_GetRoleInfo, API_GetSchema). It uses the client's existing auth, retry, and throttling infrastructure.

Parameters:

  • ctx: Context for cancellation and timeouts
  • dbid: The database/table ID to call (e.g., app ID or table ID)
  • action: The XML API action (e.g., "API_GetRoleInfo", "API_GetSchema")
  • body: The XML request body (without the outer <qdbapi> tags, which are added automatically)

Returns the raw XML response body.

Deprecated: This method supports legacy XML API endpoints. Use JSON API methods where possible. This will be removed when QuickBase discontinues the XML API.

func (*Client) DownloadFile 

func (c *Client) DownloadFile(table string, recordId int, fieldId int, versionNumber int) *DownloadFileBuilder

DownloadFile starts building a downloadFile request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) ExchangeSsoToken 

func (c *Client) ExchangeSsoToken() *ExchangeSsoTokenBuilder

ExchangeSsoToken starts building a exchangeSsoToken request.

func (*Client) ExportSolution 

func (c *Client) ExportSolution(solutionId string) *ExportSolutionBuilder

ExportSolution starts building a exportSolution request.

func (*Client) ExportSolutionToRecord 

func (c *Client) ExportSolutionToRecord(solutionId string, table string) *ExportSolutionToRecordBuilder

ExportSolutionToRecord starts building a exportSolutionToRecord request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) Field 

func (c *Client) Field(table string, name string) (int, error)

Field resolves a single field name to its ID. The table can be an alias or ID. Returns an error if schema is not configured.

Example: 

id, err := client.Field("projects", "name")  // Returns 6

func (*Client) Fields 

func (c *Client) Fields(table string, names ...string) ([]int, error)

Fields resolves field names to IDs using the configured schema. The table can be an alias or ID. Returns an error if schema is not configured.

Example: 

ids, err := client.Fields("projects", "name", "status", "dueDate")
// Returns []int{6, 7, 12}

Use this to build the Select parameter: 

fieldIDs, _ := client.Fields("projects", "name", "status")
result, err := client.RunQuery(ctx, quickbase.RunQueryBody{
    From:   "bqxyz123",
    Select: &fieldIDs,
})

func (*Client) GenerateDocument 

func (c *Client) GenerateDocument(templateId float32, table string) *GenerateDocumentBuilder

GenerateDocument starts building a generateDocument request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) GetApp 

func (c *Client) GetApp(appId string) *GetAppBuilder

GetApp starts building a getApp request.

func (*Client) GetAppEvents 

func (c *Client) GetAppEvents(appId string) *GetAppEventsBuilder

GetAppEvents starts building a getAppEvents request.

func (*Client) GetAppTables 

func (c *Client) GetAppTables() *GetAppTablesBuilder

GetAppTables starts building a getAppTables request.

func (*Client) GetField 

func (c *Client) GetField(fieldId int, table string) *GetFieldBuilder

GetField starts building a getField request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) GetFieldUsage 

func (c *Client) GetFieldUsage(fieldId int, table string) *GetFieldUsageBuilder

GetFieldUsage starts building a getFieldUsage request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) GetFields 

func (c *Client) GetFields(table string) *GetFieldsBuilder

GetFields starts building a getFields request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) GetFieldsUsage 

func (c *Client) GetFieldsUsage(table string) *GetFieldsUsageBuilder

GetFieldsUsage starts building a getFieldsUsage request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) GetRelationships 

func (c *Client) GetRelationships(table string) *GetRelationshipsBuilder

GetRelationships starts building a getRelationships request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) GetReport 

func (c *Client) GetReport(reportId string, table string) *GetReportBuilder

GetReport starts building a getReport request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) GetRoles 

func (c *Client) GetRoles(appId string) *GetRolesBuilder

GetRoles starts building a getRoles request.

func (*Client) GetSolutionPublic 

func (c *Client) GetSolutionPublic(solutionId string) *GetSolutionPublicBuilder

GetSolutionPublic starts building a getSolutionPublic request.

func (*Client) GetTable 

func (c *Client) GetTable(table string) *GetTableBuilder

GetTable starts building a getTable request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) GetTableReports 

func (c *Client) GetTableReports(table string) *GetTableReportsBuilder

GetTableReports starts building a getTableReports request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) GetTempTokenDBID 

func (c *Client) GetTempTokenDBID(dbid string) *GetTempTokenDBIDBuilder

GetTempTokenDBID starts building a getTempTokenDBID request.

func (*Client) GetTrustees 

func (c *Client) GetTrustees(appId string) *GetTrusteesBuilder

GetTrustees starts building a getTrustees request.

func (*Client) GetUsers 

func (c *Client) GetUsers() *GetUsersBuilder

GetUsers starts building a getUsers request.

func (*Client) HasSchema 

func (c *Client) HasSchema() bool

HasSchema returns true if a schema is configured for this client.

func (*Client) Logger 

func (c *Client) Logger() *core.Logger

Logger returns the client's logger.

func (*Client) PlatformAnalyticEventSummaries 

func (c *Client) PlatformAnalyticEventSummaries() *PlatformAnalyticEventSummariesBuilder

PlatformAnalyticEventSummaries starts building a platformAnalyticEventSummaries request.

func (*Client) PlatformAnalyticReads 

func (c *Client) PlatformAnalyticReads() *PlatformAnalyticReadsBuilder

PlatformAnalyticReads starts building a platformAnalyticReads request.

func (*Client) Query 

func (c *Client) Query(table string) *QueryBuilder

Query starts building a query for the specified table. The table parameter can be a table ID or an alias (if schema is configured).

Example: 

client.Query("projects")        // Table alias (requires schema)
client.Query("bqxyz123")        // Table ID (works without schema)

func (*Client) Realm 

func (c *Client) Realm() string

Realm returns the QuickBase realm name.

func (*Client) RecordsModifiedSince 

func (c *Client) RecordsModifiedSince() *RecordsModifiedSinceBuilder

RecordsModifiedSince starts building a recordsModifiedSince request.

func (*Client) RemoveManagersFromGroup 

func (c *Client) RemoveManagersFromGroup(gid float32) *RemoveManagersFromGroupBuilder

RemoveManagersFromGroup starts building a removeManagersFromGroup request.

func (*Client) RemoveMembersFromGroup 

func (c *Client) RemoveMembersFromGroup(gid float32) *RemoveMembersFromGroupBuilder

RemoveMembersFromGroup starts building a removeMembersFromGroup request.

func (*Client) RemoveSubgroupsFromGroup 

func (c *Client) RemoveSubgroupsFromGroup(gid float32) *RemoveSubgroupsFromGroupBuilder

RemoveSubgroupsFromGroup starts building a removeSubgroupsFromGroup request.

func (*Client) RemoveTrustees 

func (c *Client) RemoveTrustees(appId string) *RemoveTrusteesBuilder

RemoveTrustees starts building a removeTrustees request.

func (*Client) RunFormula 

func (c *Client) RunFormula() *RunFormulaBuilder

RunFormula starts building a runFormula request.

func (*Client) RunQuery 

func (c *Client) RunQuery(ctx context.Context, body generated.RunQueryJSONRequestBody) (*RunQueryResult, error)

RunQuery executes a query and returns the result with convenience methods. For all results, use RunQueryAll or RunQueryIterator.

If a schema is configured, table and field aliases in the body are automatically resolved to IDs before the request is sent.

Use result.Records() for unwrapped record data, or access result.Data directly.

func (*Client) RunQueryAll 

func (c *Client) RunQueryAll(ctx context.Context, body generated.RunQueryJSONRequestBody) ([]generated.QuickbaseRecord, error)

RunQueryAll fetches all records across all pages. This automatically handles pagination and returns raw QuickbaseRecord slices. Use UnwrapRecords() from the quickbase package to convert to map[string]any.

func (*Client) RunQueryN 

func (c *Client) RunQueryN(ctx context.Context, body generated.RunQueryJSONRequestBody, n int) ([]generated.QuickbaseRecord, error)

RunQueryN fetches up to n records across pages. This automatically handles pagination and returns raw QuickbaseRecord slices. Use UnwrapRecords() from the quickbase package to convert to map[string]any.

func (*Client) RunReport 

func (c *Client) RunReport(reportId string, table string) *RunReportBuilder

RunReport starts building a runReport request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) RunReportAll 

func (c *Client) RunReportAll(ctx context.Context, reportID string, tableID string) ([]generated.QuickbaseRecord, error)

RunReportAll fetches all records from a report across all pages. This automatically handles pagination.

func (*Client) RunReportN 

func (c *Client) RunReportN(ctx context.Context, reportID string, tableID string, n int) ([]generated.QuickbaseRecord, error)

RunReportN fetches up to n records from a report across pages.

func (*Client) Schema 

func (c *Client) Schema() *core.ResolvedSchema

Schema returns the resolved schema, if configured.

func (*Client) SignOut 

func (c *Client) SignOut() bool

SignOut clears credentials from memory if the auth strategy supports it.

Currently only auth.TicketStrategy supports signing out. For other strategies (user token, temp token, SSO), this method returns false and has no effect.

After signing out, API calls will fail with an authentication error. Create a new client with fresh credentials to continue making API calls.

This does NOT invalidate tokens on QuickBase's servers - tickets remain valid until they expire. This only clears credentials from local memory.

Returns true if sign out was performed, false if the strategy doesn't support it.

func (*Client) Table 

func (c *Client) Table(alias string) (string, error)

Table resolves a table alias to its ID. Returns the alias as-is if it's already an ID (not found in schema).

Example: 

tableID, err := client.Table("projects")  // Returns "bqxyz123"
tableID, err := client.Table("bqxyz123") // Returns "bqxyz123" (passthrough)

func (*Client) TransferUserToken 

func (c *Client) TransferUserToken() *TransferUserTokenBuilder

TransferUserToken starts building a transferUserToken request.

func (*Client) UndenyUsers 

func (c *Client) UndenyUsers() *UndenyUsersBuilder

UndenyUsers starts building a undenyUsers request.

func (*Client) UpdateApp 

func (c *Client) UpdateApp(appId string) *UpdateAppBuilder

UpdateApp starts building a updateApp request.

func (*Client) UpdateField 

func (c *Client) UpdateField(fieldId int, table string) *UpdateFieldBuilder

UpdateField starts building a updateField request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) UpdateRelationship 

func (c *Client) UpdateRelationship(table string, relationshipId float32) *UpdateRelationshipBuilder

UpdateRelationship starts building a updateRelationship request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) UpdateSolution 

func (c *Client) UpdateSolution(solutionId string) *UpdateSolutionBuilder

UpdateSolution starts building a updateSolution request.

func (*Client) UpdateSolutionToRecord 

func (c *Client) UpdateSolutionToRecord(solutionId string, table string) *UpdateSolutionToRecordBuilder

UpdateSolutionToRecord starts building a updateSolutionToRecord request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) UpdateTable 

func (c *Client) UpdateTable(table string) *UpdateTableBuilder

UpdateTable starts building a updateTable request. The table parameter can be a table ID or an alias (if schema is configured).

func (*Client) UpdateTrustees 

func (c *Client) UpdateTrustees(appId string) *UpdateTrusteesBuilder

UpdateTrustees starts building a updateTrustees request.

func (*Client) Upsert 

func (c *Client) Upsert(table string) *UpsertBuilder

Upsert starts building a upsert request. The table parameter can be a table ID or an alias (if schema is configured).

type CloneUserTokenBuilder 

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

CloneUserTokenBuilder provides a fluent API for the cloneUserToken operation. Clone a user token

func (*CloneUserTokenBuilder) Description 

func (b *CloneUserTokenBuilder) Description(value string) *CloneUserTokenBuilder

Description The description for the cloned user token.

func (*CloneUserTokenBuilder) Name 

func (b *CloneUserTokenBuilder) Name(value string) *CloneUserTokenBuilder

Name The new name for the cloned user token.

func (*CloneUserTokenBuilder) Run 

func (b *CloneUserTokenBuilder) Run(ctx context.Context) (*CloneUserTokenResult, error)

Run executes the cloneUserToken request and returns the response data directly.

type CloneUserTokenJSONRequestBody 

type CloneUserTokenJSONRequestBody = generated.CloneUserTokenJSONRequestBody

type CloneUserTokenResponse 

type CloneUserTokenResponse = generated.CloneUserTokenResponse

type CloneUserTokenResult 

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

CloneUserTokenResult wraps CloneUserTokenResponse with convenience methods.

func (*CloneUserTokenResult) Active 

func (r *CloneUserTokenResult) Active() bool

Active returns the Active field value, or zero value if nil.

func (*CloneUserTokenResult) Description 

func (r *CloneUserTokenResult) Description() string

Description returns the Description field value, or zero value if nil.

func (*CloneUserTokenResult) Id 

func (r *CloneUserTokenResult) Id() int

Id returns the Id field value, or zero value if nil.

func (*CloneUserTokenResult) LastUsed 

func (r *CloneUserTokenResult) LastUsed() string

LastUsed returns the LastUsed field value, or zero value if nil.

func (*CloneUserTokenResult) Name 

func (r *CloneUserTokenResult) Name() string

Name returns the Name field value, or zero value if nil.

func (*CloneUserTokenResult) Raw added in v2.1.0 

func (r *CloneUserTokenResult) Raw() *generated.CloneUserTokenResponse

Raw returns the underlying generated response.

func (*CloneUserTokenResult) Token 

func (r *CloneUserTokenResult) Token() string

Token returns the Token field value, or zero value if nil.

type CopyAppBuilder 

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

CopyAppBuilder provides a fluent API for the copyApp operation. Copy an app

func (*CopyAppBuilder) AssignUserToken 

func (b *CopyAppBuilder) AssignUserToken(value bool) *CopyAppBuilder

AssignUserToken Whether to add the user token used to make this request to the new app

func (*CopyAppBuilder) Description 

func (b *CopyAppBuilder) Description(value string) *CopyAppBuilder

Description The description of the newly copied app

func (*CopyAppBuilder) ExcludeFiles 

func (b *CopyAppBuilder) ExcludeFiles(value bool) *CopyAppBuilder

ExcludeFiles If keepData is true, whether to copy the file attachments as well. If keepData is false, this property is ignored

func (*CopyAppBuilder) KeepData 

func (b *CopyAppBuilder) KeepData(value bool) *CopyAppBuilder

KeepData Whether to copy the app's data along with the schema

func (*CopyAppBuilder) Name 

func (b *CopyAppBuilder) Name(value string) *CopyAppBuilder

Name The name of the newly copied app

func (*CopyAppBuilder) Run 

func (b *CopyAppBuilder) Run(ctx context.Context) (*CopyAppResult, error)

Run executes the copyApp request and returns the response data directly.

func (*CopyAppBuilder) UsersAndRoles 

func (b *CopyAppBuilder) UsersAndRoles(value bool) *CopyAppBuilder

UsersAndRoles If true, users will be copied along with their assigned roles. If false, users and roles will be copied but roles will not be assigned

type CopyAppJSONRequestBody 

type CopyAppJSONRequestBody = generated.CopyAppJSONRequestBody

type CopyAppResponse 

type CopyAppResponse = generated.CopyAppResponse

type CopyAppResult 

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

CopyAppResult wraps CopyAppResponse with convenience methods.

func (*CopyAppResult) AncestorId 

func (r *CopyAppResult) AncestorId() string

AncestorId returns the AncestorId field value, or zero value if nil.

func (*CopyAppResult) Created 

func (r *CopyAppResult) Created() string

Created returns the Created field value, or zero value if nil.

func (*CopyAppResult) DataClassification 

func (r *CopyAppResult) DataClassification() string

DataClassification returns the DataClassification field value, or zero value if nil.

func (*CopyAppResult) DateFormat 

func (r *CopyAppResult) DateFormat() string

DateFormat returns the DateFormat field value, or zero value if nil.

func (*CopyAppResult) Description 

func (r *CopyAppResult) Description() string

Description returns the Description field value, or zero value if nil.

func (*CopyAppResult) HasEveryoneOnTheInternet 

func (r *CopyAppResult) HasEveryoneOnTheInternet() bool

HasEveryoneOnTheInternet returns the HasEveryoneOnTheInternet field value, or zero value if nil.

func (*CopyAppResult) Id 

func (r *CopyAppResult) Id() string

Id returns the Id field value, or zero value if nil.

func (*CopyAppResult) Name 

func (r *CopyAppResult) Name() string

Name returns the Name field value.

func (*CopyAppResult) Raw added in v2.1.0 

func (r *CopyAppResult) Raw() *generated.CopyAppResponse

Raw returns the underlying generated response.

func (*CopyAppResult) TimeZone 

func (r *CopyAppResult) TimeZone() string

TimeZone returns the TimeZone field value, or zero value if nil.

func (*CopyAppResult) Updated 

func (r *CopyAppResult) Updated() string

Updated returns the Updated field value, or zero value if nil.

type CreateAppBuilder 

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

CreateAppBuilder provides a fluent API for the createApp operation. Create an app

func (*CreateAppBuilder) AllowClone 

func (b *CreateAppBuilder) AllowClone(value bool) *CreateAppBuilder

AllowClone Allow users who are not administrators to copy

func (*CreateAppBuilder) AllowExport 

func (b *CreateAppBuilder) AllowExport(value bool) *CreateAppBuilder

AllowExport Allow users who are not administrators to export data

func (*CreateAppBuilder) AssignToken 

func (b *CreateAppBuilder) AssignToken(value bool) *CreateAppBuilder

AssignToken Set to true if you would like to assign the app to the user token you used to create the application. The default is false.

func (*CreateAppBuilder) Description 

func (b *CreateAppBuilder) Description(value string) *CreateAppBuilder

Description The description for the app. If this property is left out, the app description will be blank.

func (*CreateAppBuilder) EnableAppTokens 

func (b *CreateAppBuilder) EnableAppTokens(value bool) *CreateAppBuilder

EnableAppTokens Require Application Tokens

func (*CreateAppBuilder) HideFromPublic 

func (b *CreateAppBuilder) HideFromPublic(value bool) *CreateAppBuilder

HideFromPublic Hide from public application searches

func (*CreateAppBuilder) MustBeRealmApproved 

func (b *CreateAppBuilder) MustBeRealmApproved(value bool) *CreateAppBuilder

MustBeRealmApproved Only "approved" users may access this application

func (*CreateAppBuilder) Name 

func (b *CreateAppBuilder) Name(value string) *CreateAppBuilder

Name The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this.

func (*CreateAppBuilder) Run 

func (b *CreateAppBuilder) Run(ctx context.Context) (*CreateAppResult, error)

Run executes the createApp request and returns the response data directly.

func (*CreateAppBuilder) UseIPFilter 

func (b *CreateAppBuilder) UseIPFilter(value bool) *CreateAppBuilder

UseIPFilter Only users logging in from "approved" IP addresses may access this application

func (*CreateAppBuilder) Variables 

func (b *CreateAppBuilder) Variables(values ...map[string]any) *CreateAppBuilder

Variables The app variables. A maximum of 10 variables can be inserted at a time. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)

type CreateAppJSONRequestBody 

type CreateAppJSONRequestBody = generated.CreateAppJSONRequestBody

type CreateAppMemoryInfo added in v2.2.0 

type CreateAppMemoryInfo struct {
	*generated.CreateAppMemoryInfo
}

CreateAppMemoryInfo wraps CreateAppMemoryInfo with convenience methods.

func (*CreateAppMemoryInfo) EstMemory added in v2.2.0 

func (r *CreateAppMemoryInfo) EstMemory() float32

EstMemory returns the EstMemory field value, or zero value if nil.

func (*CreateAppMemoryInfo) EstMemoryInclDependentApps added in v2.2.0 

func (r *CreateAppMemoryInfo) EstMemoryInclDependentApps() float32

EstMemoryInclDependentApps returns the EstMemoryInclDependentApps field value, or zero value if nil.

type CreateAppResponse 

type CreateAppResponse = generated.CreateAppResponse

type CreateAppResult 

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

CreateAppResult wraps CreateAppResponse with convenience methods.

func (*CreateAppResult) Created 

func (r *CreateAppResult) Created() string

Created returns the Created field value, or zero value if nil.

func (*CreateAppResult) DataClassification 

func (r *CreateAppResult) DataClassification() string

DataClassification returns the DataClassification field value, or zero value if nil.

func (*CreateAppResult) DateFormat 

func (r *CreateAppResult) DateFormat() string

DateFormat returns the DateFormat field value, or zero value if nil.

func (*CreateAppResult) Description 

func (r *CreateAppResult) Description() string

Description returns the Description field value, or zero value if nil.

func (*CreateAppResult) HasEveryoneOnTheInternet 

func (r *CreateAppResult) HasEveryoneOnTheInternet() bool

HasEveryoneOnTheInternet returns the HasEveryoneOnTheInternet field value, or zero value if nil.

func (*CreateAppResult) Id 

func (r *CreateAppResult) Id() string

Id returns the Id field value, or zero value if nil.

func (*CreateAppResult) MemoryInfo added in v2.2.0 

func (r *CreateAppResult) MemoryInfo() *CreateAppMemoryInfo

MemoryInfo returns the MemoryInfo field as a wrapped type, or nil if not set.

func (*CreateAppResult) Name 

func (r *CreateAppResult) Name() string

Name returns the Name field value.

func (*CreateAppResult) Raw added in v2.1.0 

func (r *CreateAppResult) Raw() *generated.CreateAppResponse

Raw returns the underlying generated response.

func (*CreateAppResult) SecurityProperties 

func (r *CreateAppResult) SecurityProperties() *CreateAppSecurityProperties

SecurityProperties returns the SecurityProperties field as a wrapped type, or nil if not set.

func (*CreateAppResult) TimeZone 

func (r *CreateAppResult) TimeZone() string

TimeZone returns the TimeZone field value, or zero value if nil.

func (*CreateAppResult) Updated 

func (r *CreateAppResult) Updated() string

Updated returns the Updated field value, or zero value if nil.

type CreateAppSecurityProperties 

type CreateAppSecurityProperties struct {
	*generated.CreateAppSecurityProperties
}

CreateAppSecurityProperties wraps CreateAppSecurityProperties with convenience methods.

func (*CreateAppSecurityProperties) AllowClone 

func (r *CreateAppSecurityProperties) AllowClone() bool

AllowClone returns the AllowClone field value, or zero value if nil.

func (*CreateAppSecurityProperties) AllowExport 

func (r *CreateAppSecurityProperties) AllowExport() bool

AllowExport returns the AllowExport field value, or zero value if nil.

func (*CreateAppSecurityProperties) EnableAppTokens 

func (r *CreateAppSecurityProperties) EnableAppTokens() bool

EnableAppTokens returns the EnableAppTokens field value, or zero value if nil.

func (*CreateAppSecurityProperties) HideFromPublic 

func (r *CreateAppSecurityProperties) HideFromPublic() bool

HideFromPublic returns the HideFromPublic field value, or zero value if nil.

func (*CreateAppSecurityProperties) MustBeRealmApproved 

func (r *CreateAppSecurityProperties) MustBeRealmApproved() bool

MustBeRealmApproved returns the MustBeRealmApproved field value, or zero value if nil.

func (*CreateAppSecurityProperties) UseIPFilter 

func (r *CreateAppSecurityProperties) UseIPFilter() bool

UseIPFilter returns the UseIPFilter field value, or zero value if nil.

type CreateFieldBuilder 

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

CreateFieldBuilder provides a fluent API for the createField operation. Create a field

func (*CreateFieldBuilder) Abbreviate 

func (b *CreateFieldBuilder) Abbreviate(value bool) *CreateFieldBuilder

Abbreviate Don't show the URL protocol when showing the URL.

func (*CreateFieldBuilder) AddToForms 

func (b *CreateFieldBuilder) AddToForms(value bool) *CreateFieldBuilder

AddToForms Whether the field you are adding should appear on forms. Defaults to false.

func (*CreateFieldBuilder) AllowMentions 

func (b *CreateFieldBuilder) AllowMentions(value bool) *CreateFieldBuilder

AllowMentions If someone can @mention users in the rich text field to generate an email notification.

func (*CreateFieldBuilder) AllowNewChoices 

func (b *CreateFieldBuilder) AllowNewChoices(value bool) *CreateFieldBuilder

AllowNewChoices Indicates if users can add new choices to a selection list.

func (*CreateFieldBuilder) AppearsAs 

func (b *CreateFieldBuilder) AppearsAs(value string) *CreateFieldBuilder

AppearsAs The link text, if empty, the url will be used as link text.

func (*CreateFieldBuilder) AppearsByDefault 

func (b *CreateFieldBuilder) AppearsByDefault(value bool) *CreateFieldBuilder

AppearsByDefault Indicates if the field is marked as a default in reports. Defaults to true.

func (*CreateFieldBuilder) AppendOnly 

func (b *CreateFieldBuilder) AppendOnly(value bool) *CreateFieldBuilder

AppendOnly Whether this field is append only.

func (*CreateFieldBuilder) Audited 

func (b *CreateFieldBuilder) Audited(value bool) *CreateFieldBuilder

Audited Indicates if the field is being tracked as part of Quickbase Audit Logs. You can only set this property to "true" if the app has audit logs enabled. See Enable data change logs under [Quickbase Audit Logs](https://help.quickbase.com/docs/audit-logs). Defaults to false.

func (*CreateFieldBuilder) AutoSave 

func (b *CreateFieldBuilder) AutoSave(value bool) *CreateFieldBuilder

AutoSave Whether the link field will auto save.

func (*CreateFieldBuilder) BlankIsZero 

func (b *CreateFieldBuilder) BlankIsZero(value bool) *CreateFieldBuilder

BlankIsZero Whether a blank value is treated the same as 0 in calculations within the product.

func (*CreateFieldBuilder) Bold 

func (b *CreateFieldBuilder) Bold(value bool) *CreateFieldBuilder

Bold Indicates if the field is configured to display in bold in the product. Defaults to false.

func (*CreateFieldBuilder) CarryChoices 

func (b *CreateFieldBuilder) CarryChoices(value bool) *CreateFieldBuilder

CarryChoices Whether the field should carry its multiple choice fields when copied.

func (*CreateFieldBuilder) Choices 

func (b *CreateFieldBuilder) Choices(value []string) *CreateFieldBuilder

Choices An array of entries that exist for a field that offers choices to the user. Note that these choices refer to the valid values of any records added in the future. You are allowed to remove values from the list of choices even if there are existing records with those values in this field. They will be displayed in red when users look at the data in the browser but there is no other effect. While updating a field with this property, the old choices are removed and replaced by the new choices.

func (*CreateFieldBuilder) CommaStart 

func (b *CreateFieldBuilder) CommaStart(value int) *CreateFieldBuilder

CommaStart The number of digits before commas display in the product, when applicable.

func (*CreateFieldBuilder) Comments 

func (b *CreateFieldBuilder) Comments(value string) *CreateFieldBuilder

Comments The comments entered on the field properties by an administrator.

func (*CreateFieldBuilder) CompositeFields 

func (b *CreateFieldBuilder) CompositeFields(value []any) *CreateFieldBuilder

CompositeFields An array of the fields that make up a composite field (e.g., address).

func (*CreateFieldBuilder) CoverText 

func (b *CreateFieldBuilder) CoverText(value string) *CreateFieldBuilder

CoverText An alternate user friendly text that can be used to display a link in the browser.

func (*CreateFieldBuilder) CurrencyFormat 

func (b *CreateFieldBuilder) CurrencyFormat(value string) *CreateFieldBuilder

CurrencyFormat The currency format used when displaying field values within the product.

func (*CreateFieldBuilder) CurrencySymbol 

func (b *CreateFieldBuilder) CurrencySymbol(value string) *CreateFieldBuilder

CurrencySymbol The current symbol used when displaying field values within the product.

func (*CreateFieldBuilder) DecimalPlaces 

func (b *CreateFieldBuilder) DecimalPlaces(value int) *CreateFieldBuilder

DecimalPlaces The number of decimal places displayed in the product for this field.

func (*CreateFieldBuilder) DefaultCountryCode 

func (b *CreateFieldBuilder) DefaultCountryCode(value string) *CreateFieldBuilder

DefaultCountryCode Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format.

func (*CreateFieldBuilder) DefaultDomain 

func (b *CreateFieldBuilder) DefaultDomain(value string) *CreateFieldBuilder

DefaultDomain Default email domain.

func (*CreateFieldBuilder) DefaultKind 

func (b *CreateFieldBuilder) DefaultKind(value string) *CreateFieldBuilder

DefaultKind The user default type.

func (*CreateFieldBuilder) DefaultToday 

func (b *CreateFieldBuilder) DefaultToday(value bool) *CreateFieldBuilder

DefaultToday Indicates if the field value is defaulted today for new records.

func (*CreateFieldBuilder) DefaultValue 

func (b *CreateFieldBuilder) DefaultValue(value string) *CreateFieldBuilder

DefaultValue The default value configured for a field when a new record is added.

func (*CreateFieldBuilder) DefaultValueLuid 

func (b *CreateFieldBuilder) DefaultValueLuid(value int) *CreateFieldBuilder

DefaultValueLuid Default user id value. 

func (b *CreateFieldBuilder) DisplayAsLink(value bool) *CreateFieldBuilder

DisplayAsLink Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.

func (*CreateFieldBuilder) DisplayCheckboxAsText 

func (b *CreateFieldBuilder) DisplayCheckboxAsText(value bool) *CreateFieldBuilder

DisplayCheckboxAsText Indicates whether the checkbox values will be shown as text in reports.

func (*CreateFieldBuilder) DisplayDayOfWeek 

func (b *CreateFieldBuilder) DisplayDayOfWeek(value bool) *CreateFieldBuilder

DisplayDayOfWeek Indicates whether to display the day of the week within the product.

func (*CreateFieldBuilder) DisplayEmail 

func (b *CreateFieldBuilder) DisplayEmail(value string) *CreateFieldBuilder

DisplayEmail How the email is displayed.

func (*CreateFieldBuilder) DisplayMonth 

func (b *CreateFieldBuilder) DisplayMonth(value string) *CreateFieldBuilder

DisplayMonth How to display months.

func (*CreateFieldBuilder) DisplayRelative 

func (b *CreateFieldBuilder) DisplayRelative(value bool) *CreateFieldBuilder

DisplayRelative Whether to display time as relative.

func (*CreateFieldBuilder) DisplayTime 

func (b *CreateFieldBuilder) DisplayTime(value bool) *CreateFieldBuilder

DisplayTime Indicates whether to display the time, in addition to the date.

func (*CreateFieldBuilder) DisplayTimezone 

func (b *CreateFieldBuilder) DisplayTimezone(value bool) *CreateFieldBuilder

DisplayTimezone Indicates whether to display the timezone within the product.

func (*CreateFieldBuilder) DisplayUser 

func (b *CreateFieldBuilder) DisplayUser(value string) *CreateFieldBuilder

DisplayUser The configured option for how users display within the product.

func (*CreateFieldBuilder) DoesAverage 

func (b *CreateFieldBuilder) DoesAverage(value bool) *CreateFieldBuilder

DoesAverage Whether this field averages in reports within the product.

func (*CreateFieldBuilder) DoesTotal 

func (b *CreateFieldBuilder) DoesTotal(value bool) *CreateFieldBuilder

DoesTotal Whether this field totals in reports within the product.

func (*CreateFieldBuilder) Exact 

func (b *CreateFieldBuilder) Exact(value bool) *CreateFieldBuilder

Exact Whether an exact match is required for a report link.

func (*CreateFieldBuilder) FieldHelp 

func (b *CreateFieldBuilder) FieldHelp(value string) *CreateFieldBuilder

FieldHelp The configured help text shown to users within the product.

func (*CreateFieldBuilder) FieldType 

func (b *CreateFieldBuilder) FieldType(value string) *CreateFieldBuilder

FieldType The [field types](https://help.quickbase.com/docs/field-types), click on any of the field type links for more info.

func (*CreateFieldBuilder) FindEnabled 

func (b *CreateFieldBuilder) FindEnabled(value bool) *CreateFieldBuilder

FindEnabled Indicates if the field is marked as searchable. Defaults to true.

func (*CreateFieldBuilder) Format 

func (b *CreateFieldBuilder) Format(value int) *CreateFieldBuilder

Format The format to display time.

func (*CreateFieldBuilder) Formula 

func (b *CreateFieldBuilder) Formula(value string) *CreateFieldBuilder

Formula The formula of the field as configured in Quickbase.

func (*CreateFieldBuilder) HasExtension 

func (b *CreateFieldBuilder) HasExtension(value bool) *CreateFieldBuilder

HasExtension Whether this field has a phone extension.

func (*CreateFieldBuilder) Hours24 

func (b *CreateFieldBuilder) Hours24(value bool) *CreateFieldBuilder

Hours24 Indicates whether or not to display time in the 24-hour format within the product.

func (*CreateFieldBuilder) Label 

func (b *CreateFieldBuilder) Label(value string) *CreateFieldBuilder

Label The label (name) of the field.

func (*CreateFieldBuilder) LinkText 

func (b *CreateFieldBuilder) LinkText(value string) *CreateFieldBuilder

LinkText The configured text value that replaces the URL that users see within the product.

func (*CreateFieldBuilder) MaxLength 

func (b *CreateFieldBuilder) MaxLength(value int) *CreateFieldBuilder

MaxLength The maximum number of characters allowed for entry in Quickbase for this field.

func (*CreateFieldBuilder) MaxVersions 

func (b *CreateFieldBuilder) MaxVersions(value int) *CreateFieldBuilder

MaxVersions The maximum number of versions configured for a file attachment.

func (*CreateFieldBuilder) NoWrap 

func (b *CreateFieldBuilder) NoWrap(value bool) *CreateFieldBuilder

NoWrap Indicates if the field is configured to not wrap when displayed in the product. Defaults to false.

func (*CreateFieldBuilder) NumLines 

func (b *CreateFieldBuilder) NumLines(value int) *CreateFieldBuilder

NumLines The number of lines shown in Quickbase for this text field.

func (*CreateFieldBuilder) NumberFormat 

func (b *CreateFieldBuilder) NumberFormat(value int) *CreateFieldBuilder

NumberFormat The format used for displaying numeric values in the product (decimal, separators, digit group).

func (*CreateFieldBuilder) OpenTargetIn 

func (b *CreateFieldBuilder) OpenTargetIn(value string) *CreateFieldBuilder

OpenTargetIn Indicates which target the URL should open in when a user clicks it within the product.

func (*CreateFieldBuilder) ParentFieldId 

func (b *CreateFieldBuilder) ParentFieldId(value int) *CreateFieldBuilder

ParentFieldId The id of the parent composite field, when applicable.

func (*CreateFieldBuilder) Permissions 

func (b *CreateFieldBuilder) Permissions(values ...map[string]any) *CreateFieldBuilder

Permissions Field Permissions for different roles.

func (*CreateFieldBuilder) PostTempToken 

func (b *CreateFieldBuilder) PostTempToken(value bool) *CreateFieldBuilder

PostTempToken POSTs a temporary token to the first URL when clicked by a user. [Learn more](https://help.quickbase.com/docs/post-temporary-token-from-a-quickbase-field)

func (*CreateFieldBuilder) Run 

func (b *CreateFieldBuilder) Run(ctx context.Context) (*CreateFieldResult, error)

Run executes the createField request and returns the response data directly.

func (*CreateFieldBuilder) SeeVersions 

func (b *CreateFieldBuilder) SeeVersions(value bool) *CreateFieldBuilder

SeeVersions Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.

func (*CreateFieldBuilder) SnapFieldId 

func (b *CreateFieldBuilder) SnapFieldId(value int) *CreateFieldBuilder

SnapFieldId The id of the field that is used to snapshot values from, when applicable.

func (*CreateFieldBuilder) SortAlpha 

func (b *CreateFieldBuilder) SortAlpha(value bool) *CreateFieldBuilder

SortAlpha Whether to sort alphabetically, default sort is by record ID.

func (*CreateFieldBuilder) SortAsGiven 

func (b *CreateFieldBuilder) SortAsGiven(value bool) *CreateFieldBuilder

SortAsGiven Indicates if the listed entries sort as entered vs alphabetically.

func (*CreateFieldBuilder) SourceFieldId 

func (b *CreateFieldBuilder) SourceFieldId(value int) *CreateFieldBuilder

SourceFieldId The id of the source field.

func (*CreateFieldBuilder) TargetFieldId 

func (b *CreateFieldBuilder) TargetFieldId(value int) *CreateFieldBuilder

TargetFieldId The id of the target field.

func (*CreateFieldBuilder) TargetTableId 

func (b *CreateFieldBuilder) TargetTableId(value string) *CreateFieldBuilder

TargetTableId The id of the target table.

func (*CreateFieldBuilder) TargetTableName 

func (b *CreateFieldBuilder) TargetTableName(value string) *CreateFieldBuilder

TargetTableName The field's target table name.

func (*CreateFieldBuilder) Units 

func (b *CreateFieldBuilder) Units(value string) *CreateFieldBuilder

Units The units label.

func (*CreateFieldBuilder) UseI18NFormat 

func (b *CreateFieldBuilder) UseI18NFormat(value bool) *CreateFieldBuilder

UseI18NFormat Whether phone numbers should be in E.164 standard international format

func (*CreateFieldBuilder) UseNewWindow 

func (b *CreateFieldBuilder) UseNewWindow(value bool) *CreateFieldBuilder

UseNewWindow Indicates if the file should open a new window when a user clicks it within the product.

func (*CreateFieldBuilder) VersionMode 

func (b *CreateFieldBuilder) VersionMode(value string) *CreateFieldBuilder

VersionMode Version modes for files. Keep all versions vs keep last version.

func (*CreateFieldBuilder) Width 

func (b *CreateFieldBuilder) Width(value int) *CreateFieldBuilder

Width The field's html input width in the product.

type CreateFieldJSONRequestBody 

type CreateFieldJSONRequestBody = generated.CreateFieldJSONRequestBody

type CreateFieldParams 

type CreateFieldParams = generated.CreateFieldParams

type CreateFieldPermissionsItem added in v2.2.0 

type CreateFieldPermissionsItem struct {
	*generated.CreateFieldPermissionsItem
}

CreateFieldPermissionsItem wraps CreateFieldPermissionsItem with convenience methods.

func (*CreateFieldPermissionsItem) PermissionType added in v2.2.0 

func (r *CreateFieldPermissionsItem) PermissionType() string

PermissionType returns the PermissionType field value, or zero value if nil.

func (*CreateFieldPermissionsItem) Role added in v2.2.0 

func (r *CreateFieldPermissionsItem) Role() string

Role returns the Role field value, or zero value if nil.

func (*CreateFieldPermissionsItem) RoleId added in v2.2.0 

func (r *CreateFieldPermissionsItem) RoleId() int

RoleId returns the RoleId field value, or zero value if nil.

type CreateFieldProperties 

type CreateFieldProperties struct {
	*generated.CreateFieldProperties
}

CreateFieldProperties wraps CreateFieldProperties with convenience methods.

func (*CreateFieldProperties) Abbreviate 

func (r *CreateFieldProperties) Abbreviate() bool

Abbreviate returns the Abbreviate field value, or zero value if nil.

func (*CreateFieldProperties) AllowHTML 

func (r *CreateFieldProperties) AllowHTML() bool

AllowHTML returns the AllowHTML field value, or zero value if nil.

func (*CreateFieldProperties) AllowMentions 

func (r *CreateFieldProperties) AllowMentions() bool

AllowMentions returns the AllowMentions field value, or zero value if nil.

func (*CreateFieldProperties) AllowNewChoices 

func (r *CreateFieldProperties) AllowNewChoices() bool

AllowNewChoices returns the AllowNewChoices field value, or zero value if nil.

func (*CreateFieldProperties) AppearsAs 

func (r *CreateFieldProperties) AppearsAs() string

AppearsAs returns the AppearsAs field value, or zero value if nil.

func (*CreateFieldProperties) AppendOnly 

func (r *CreateFieldProperties) AppendOnly() bool

AppendOnly returns the AppendOnly field value, or zero value if nil.

func (*CreateFieldProperties) AutoSave 

func (r *CreateFieldProperties) AutoSave() bool

AutoSave returns the AutoSave field value, or zero value if nil.

func (*CreateFieldProperties) BlankIsZero 

func (r *CreateFieldProperties) BlankIsZero() bool

BlankIsZero returns the BlankIsZero field value, or zero value if nil.

func (*CreateFieldProperties) CarryChoices 

func (r *CreateFieldProperties) CarryChoices() bool

CarryChoices returns the CarryChoices field value, or zero value if nil.

func (*CreateFieldProperties) Choices 

func (r *CreateFieldProperties) Choices() []string

Choices returns the Choices field value, or nil if not set.

func (*CreateFieldProperties) ChoicesLuid 

func (r *CreateFieldProperties) ChoicesLuid() []string

ChoicesLuid returns the ChoicesLuid field value, or nil if not set.

func (*CreateFieldProperties) CommaStart 

func (r *CreateFieldProperties) CommaStart() int

CommaStart returns the CommaStart field value, or zero value if nil.

func (*CreateFieldProperties) Comments 

func (r *CreateFieldProperties) Comments() string

Comments returns the Comments field value, or zero value if nil.

func (*CreateFieldProperties) CompositeFields 

func (r *CreateFieldProperties) CompositeFields() []*CreateFieldProperties_CompositeFields_Item

CompositeFields returns the CompositeFields field as wrapped types, or nil if not set.

func (*CreateFieldProperties) CoverText 

func (r *CreateFieldProperties) CoverText() string

CoverText returns the CoverText field value, or zero value if nil.

func (*CreateFieldProperties) CurrencyFormat 

func (r *CreateFieldProperties) CurrencyFormat() string

CurrencyFormat returns the CurrencyFormat field value as a string, or empty string if nil.

func (*CreateFieldProperties) CurrencySymbol 

func (r *CreateFieldProperties) CurrencySymbol() string

CurrencySymbol returns the CurrencySymbol field value, or zero value if nil.

func (*CreateFieldProperties) DecimalPlaces 

func (r *CreateFieldProperties) DecimalPlaces() int

DecimalPlaces returns the DecimalPlaces field value, or zero value if nil.

func (*CreateFieldProperties) DefaultCountryCode 

func (r *CreateFieldProperties) DefaultCountryCode() string

DefaultCountryCode returns the DefaultCountryCode field value, or zero value if nil.

func (*CreateFieldProperties) DefaultDomain 

func (r *CreateFieldProperties) DefaultDomain() string

DefaultDomain returns the DefaultDomain field value, or zero value if nil.

func (*CreateFieldProperties) DefaultKind 

func (r *CreateFieldProperties) DefaultKind() string

DefaultKind returns the DefaultKind field value, or zero value if nil.

func (*CreateFieldProperties) DefaultToday 

func (r *CreateFieldProperties) DefaultToday() bool

DefaultToday returns the DefaultToday field value, or zero value if nil.

func (*CreateFieldProperties) DefaultValue 

func (r *CreateFieldProperties) DefaultValue() string

DefaultValue returns the DefaultValue field value, or zero value if nil.

func (*CreateFieldProperties) DefaultValueLuid 

func (r *CreateFieldProperties) DefaultValueLuid() int

DefaultValueLuid returns the DefaultValueLuid field value, or zero value if nil. 

func (r *CreateFieldProperties) DisplayAsLink() bool

DisplayAsLink returns the DisplayAsLink field value, or zero value if nil.

func (*CreateFieldProperties) DisplayCheckboxAsText 

func (r *CreateFieldProperties) DisplayCheckboxAsText() bool

DisplayCheckboxAsText returns the DisplayCheckboxAsText field value, or zero value if nil.

func (*CreateFieldProperties) DisplayDayOfWeek 

func (r *CreateFieldProperties) DisplayDayOfWeek() bool

DisplayDayOfWeek returns the DisplayDayOfWeek field value, or zero value if nil.

func (*CreateFieldProperties) DisplayEmail 

func (r *CreateFieldProperties) DisplayEmail() string

DisplayEmail returns the DisplayEmail field value, or zero value if nil.

func (*CreateFieldProperties) DisplayMonth 

func (r *CreateFieldProperties) DisplayMonth() string

DisplayMonth returns the DisplayMonth field value, or zero value if nil.

func (*CreateFieldProperties) DisplayRelative 

func (r *CreateFieldProperties) DisplayRelative() bool

DisplayRelative returns the DisplayRelative field value, or zero value if nil.

func (*CreateFieldProperties) DisplayTime 

func (r *CreateFieldProperties) DisplayTime() bool

DisplayTime returns the DisplayTime field value, or zero value if nil.

func (*CreateFieldProperties) DisplayTimezone 

func (r *CreateFieldProperties) DisplayTimezone() bool

DisplayTimezone returns the DisplayTimezone field value, or zero value if nil.

func (*CreateFieldProperties) DisplayUser 

func (r *CreateFieldProperties) DisplayUser() string

DisplayUser returns the DisplayUser field value, or zero value if nil.

func (*CreateFieldProperties) DoesAverage 

func (r *CreateFieldProperties) DoesAverage() bool

DoesAverage returns the DoesAverage field value, or zero value if nil.

func (*CreateFieldProperties) DoesTotal 

func (r *CreateFieldProperties) DoesTotal() bool

DoesTotal returns the DoesTotal field value, or zero value if nil.

func (*CreateFieldProperties) DurationField 

func (r *CreateFieldProperties) DurationField() int

DurationField returns the DurationField field value, or zero value if nil.

func (*CreateFieldProperties) Exact 

func (r *CreateFieldProperties) Exact() bool

Exact returns the Exact field value, or zero value if nil.

func (*CreateFieldProperties) ForeignKey 

func (r *CreateFieldProperties) ForeignKey() bool

ForeignKey returns the ForeignKey field value, or zero value if nil.

func (*CreateFieldProperties) Format 

func (r *CreateFieldProperties) Format() int

Format returns the Format field value, or zero value if nil.

func (*CreateFieldProperties) Formula 

func (r *CreateFieldProperties) Formula() string

Formula returns the Formula field value, or zero value if nil.

func (*CreateFieldProperties) HasExtension 

func (r *CreateFieldProperties) HasExtension() bool

HasExtension returns the HasExtension field value, or zero value if nil.

func (*CreateFieldProperties) Hours24 

func (r *CreateFieldProperties) Hours24() bool

Hours24 returns the Hours24 field value, or zero value if nil.

func (*CreateFieldProperties) LinkText 

func (r *CreateFieldProperties) LinkText() string

LinkText returns the LinkText field value, or zero value if nil.

func (*CreateFieldProperties) LookupReferenceFieldId 

func (r *CreateFieldProperties) LookupReferenceFieldId() int

LookupReferenceFieldId returns the LookupReferenceFieldId field value, or zero value if nil.

func (*CreateFieldProperties) LookupTargetFieldId 

func (r *CreateFieldProperties) LookupTargetFieldId() int

LookupTargetFieldId returns the LookupTargetFieldId field value, or zero value if nil.

func (*CreateFieldProperties) MasterChoiceFieldId 

func (r *CreateFieldProperties) MasterChoiceFieldId() int

MasterChoiceFieldId returns the MasterChoiceFieldId field value, or zero value if nil.

func (*CreateFieldProperties) MasterChoiceTableId 

func (r *CreateFieldProperties) MasterChoiceTableId() string

MasterChoiceTableId returns the MasterChoiceTableId field value, or zero value if nil.

func (*CreateFieldProperties) MasterTableTag 

func (r *CreateFieldProperties) MasterTableTag() string

MasterTableTag returns the MasterTableTag field value, or zero value if nil.

func (*CreateFieldProperties) MaxLength 

func (r *CreateFieldProperties) MaxLength() int

MaxLength returns the MaxLength field value, or zero value if nil.

func (*CreateFieldProperties) MaxVersions 

func (r *CreateFieldProperties) MaxVersions() int

MaxVersions returns the MaxVersions field value, or zero value if nil.

func (*CreateFieldProperties) NumLines 

func (r *CreateFieldProperties) NumLines() int

NumLines returns the NumLines field value, or zero value if nil.

func (*CreateFieldProperties) NumberFormat 

func (r *CreateFieldProperties) NumberFormat() int

NumberFormat returns the NumberFormat field value, or zero value if nil.

func (*CreateFieldProperties) ParentFieldId 

func (r *CreateFieldProperties) ParentFieldId() int

ParentFieldId returns the ParentFieldId field value, or zero value if nil.

func (*CreateFieldProperties) PostTempToken 

func (r *CreateFieldProperties) PostTempToken() bool

PostTempToken returns the PostTempToken field value, or zero value if nil.

func (*CreateFieldProperties) SeeVersions 

func (r *CreateFieldProperties) SeeVersions() bool

SeeVersions returns the SeeVersions field value, or zero value if nil.

func (*CreateFieldProperties) SnapFieldId 

func (r *CreateFieldProperties) SnapFieldId() int

SnapFieldId returns the SnapFieldId field value, or zero value if nil.

func (*CreateFieldProperties) SortAlpha 

func (r *CreateFieldProperties) SortAlpha() bool

SortAlpha returns the SortAlpha field value, or zero value if nil.

func (*CreateFieldProperties) SortAsGiven 

func (r *CreateFieldProperties) SortAsGiven() bool

SortAsGiven returns the SortAsGiven field value, or zero value if nil.

func (*CreateFieldProperties) SourceFieldId 

func (r *CreateFieldProperties) SourceFieldId() int

SourceFieldId returns the SourceFieldId field value, or zero value if nil.

func (*CreateFieldProperties) StartField 

func (r *CreateFieldProperties) StartField() int

StartField returns the StartField field value, or zero value if nil.

func (*CreateFieldProperties) SummaryFunction 

func (r *CreateFieldProperties) SummaryFunction() string

SummaryFunction returns the SummaryFunction field value as a string, or empty string if nil.

func (*CreateFieldProperties) SummaryReferenceFieldId 

func (r *CreateFieldProperties) SummaryReferenceFieldId() int64

SummaryReferenceFieldId returns the SummaryReferenceFieldId field value, or zero value if nil.

func (*CreateFieldProperties) SummaryTargetFieldId 

func (r *CreateFieldProperties) SummaryTargetFieldId() int

SummaryTargetFieldId returns the SummaryTargetFieldId field value, or zero value if nil.

func (*CreateFieldProperties) TargetFieldId 

func (r *CreateFieldProperties) TargetFieldId() int

TargetFieldId returns the TargetFieldId field value, or zero value if nil.

func (*CreateFieldProperties) TargetTableId 

func (r *CreateFieldProperties) TargetTableId() string

TargetTableId returns the TargetTableId field value, or zero value if nil.

func (*CreateFieldProperties) TargetTableName 

func (r *CreateFieldProperties) TargetTableName() string

TargetTableName returns the TargetTableName field value, or zero value if nil.

func (*CreateFieldProperties) Units 

func (r *CreateFieldProperties) Units() string

Units returns the Units field value, or zero value if nil.

func (*CreateFieldProperties) UseI18NFormat 

func (r *CreateFieldProperties) UseI18NFormat() bool

UseI18NFormat returns the UseI18NFormat field value, or zero value if nil.

func (*CreateFieldProperties) UseNewWindow 

func (r *CreateFieldProperties) UseNewWindow() bool

UseNewWindow returns the UseNewWindow field value, or zero value if nil.

func (*CreateFieldProperties) VersionMode 

func (r *CreateFieldProperties) VersionMode() string

VersionMode returns the VersionMode field value as a string, or empty string if nil.

func (*CreateFieldProperties) Width 

func (r *CreateFieldProperties) Width() int

Width returns the Width field value, or zero value if nil.

func (*CreateFieldProperties) WorkWeek 

func (r *CreateFieldProperties) WorkWeek() int

WorkWeek returns the WorkWeek field value, or zero value if nil.

func (*CreateFieldProperties) XmlTag 

func (r *CreateFieldProperties) XmlTag() string

XmlTag returns the XmlTag field value, or zero value if nil.

type CreateFieldProperties_CompositeFields_Item added in v2.2.0 

type CreateFieldProperties_CompositeFields_Item struct {
	*generated.CreateFieldProperties_CompositeFields_Item
}

CreateFieldProperties_CompositeFields_Item wraps CreateFieldProperties_CompositeFields_Item with convenience methods.

type CreateFieldResponse 

type CreateFieldResponse = generated.CreateFieldResponse

type CreateFieldResult 

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

CreateFieldResult wraps CreateFieldResponse with convenience methods.

func (*CreateFieldResult) AppearsByDefault 

func (r *CreateFieldResult) AppearsByDefault() bool

AppearsByDefault returns the AppearsByDefault field value, or zero value if nil.

func (*CreateFieldResult) Audited 

func (r *CreateFieldResult) Audited() bool

Audited returns the Audited field value, or zero value if nil.

func (*CreateFieldResult) Bold 

func (r *CreateFieldResult) Bold() bool

Bold returns the Bold field value, or zero value if nil.

func (*CreateFieldResult) DoesDataCopy 

func (r *CreateFieldResult) DoesDataCopy() bool

DoesDataCopy returns the DoesDataCopy field value, or zero value if nil.

func (*CreateFieldResult) FieldHelp 

func (r *CreateFieldResult) FieldHelp() string

FieldHelp returns the FieldHelp field value, or zero value if nil.

func (*CreateFieldResult) FieldType 

func (r *CreateFieldResult) FieldType() string

FieldType returns the FieldType field value, or zero value if nil.

func (*CreateFieldResult) FindEnabled 

func (r *CreateFieldResult) FindEnabled() bool

FindEnabled returns the FindEnabled field value, or zero value if nil.

func (*CreateFieldResult) Id 

func (r *CreateFieldResult) Id() int64

Id returns the Id field value.

func (*CreateFieldResult) Label 

func (r *CreateFieldResult) Label() string

Label returns the Label field value, or zero value if nil.

func (*CreateFieldResult) Mode 

func (r *CreateFieldResult) Mode() string

Mode returns the Mode field value, or zero value if nil.

func (*CreateFieldResult) NoWrap 

func (r *CreateFieldResult) NoWrap() bool

NoWrap returns the NoWrap field value, or zero value if nil.

func (*CreateFieldResult) Permissions added in v2.2.0 

func (r *CreateFieldResult) Permissions() []*CreateFieldPermissionsItem

Permissions returns the Permissions field as wrapped types, or nil if not set.

func (*CreateFieldResult) Properties 

func (r *CreateFieldResult) Properties() *CreateFieldProperties

Properties returns the Properties field as a wrapped type, or nil if not set.

func (*CreateFieldResult) Raw added in v2.1.0 

func (r *CreateFieldResult) Raw() *generated.CreateFieldResponse

Raw returns the underlying generated response.

func (*CreateFieldResult) Required 

func (r *CreateFieldResult) Required() bool

Required returns the Required field value, or zero value if nil.

func (*CreateFieldResult) Unique 

func (r *CreateFieldResult) Unique() bool

Unique returns the Unique field value, or zero value if nil.

type CreateRelationshipBuilder 

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

CreateRelationshipBuilder provides a fluent API for the createRelationship operation. Create a relationship

func (*CreateRelationshipBuilder) Label 

func (b *CreateRelationshipBuilder) Label(value string) *CreateRelationshipBuilder

Label The label for the foreign key field.

func (*CreateRelationshipBuilder) LookupFieldIds 

func (b *CreateRelationshipBuilder) LookupFieldIds(values ...int) *CreateRelationshipBuilder

LookupFieldIds Array of field IDs in the parent table that will become lookup fields in the child table.

func (*CreateRelationshipBuilder) ParentTableId 

func (b *CreateRelationshipBuilder) ParentTableId(value string) *CreateRelationshipBuilder

ParentTableId The parent table id for the relationship.

func (*CreateRelationshipBuilder) Run 

func (b *CreateRelationshipBuilder) Run(ctx context.Context) (*CreateRelationshipResult, error)

Run executes the createRelationship request and returns the response data directly.

func (*CreateRelationshipBuilder) SummaryFields 

func (b *CreateRelationshipBuilder) SummaryFields(values ...map[string]any) *CreateRelationshipBuilder

SummaryFields Array of summary field objects which will turn into summary fields in the parent table. When you specify the 'COUNT' accumulation type, you have to specify 0 as the summaryFid (or not set it in the request). 'DISTINCT-COUNT' requires that summaryFid be set to an actual fid.

type CreateRelationshipForeignKeyField 

type CreateRelationshipForeignKeyField struct {
	*generated.CreateRelationshipForeignKeyField
}

CreateRelationshipForeignKeyField wraps CreateRelationshipForeignKeyField with convenience methods.

func (*CreateRelationshipForeignKeyField) Id 

func (r *CreateRelationshipForeignKeyField) Id() int

Id returns the Id field value, or zero value if nil.

func (*CreateRelationshipForeignKeyField) Label 

func (r *CreateRelationshipForeignKeyField) Label() string

Label returns the Label field value, or zero value if nil.

func (*CreateRelationshipForeignKeyField) Type 

func (r *CreateRelationshipForeignKeyField) Type() string

Type returns the Type field value, or zero value if nil.

type CreateRelationshipJSONRequestBody 

type CreateRelationshipJSONRequestBody = generated.CreateRelationshipJSONRequestBody

type CreateRelationshipLookupFieldsItem 

type CreateRelationshipLookupFieldsItem struct {
	*generated.CreateRelationshipLookupFieldsItem
}

CreateRelationshipLookupFieldsItem wraps CreateRelationshipLookupFieldsItem with convenience methods.

func (*CreateRelationshipLookupFieldsItem) Id 

func (r *CreateRelationshipLookupFieldsItem) Id() int

Id returns the Id field value, or zero value if nil.

func (*CreateRelationshipLookupFieldsItem) Label 

func (r *CreateRelationshipLookupFieldsItem) Label() string

Label returns the Label field value, or zero value if nil.

func (*CreateRelationshipLookupFieldsItem) Type 

func (r *CreateRelationshipLookupFieldsItem) Type() string

Type returns the Type field value, or zero value if nil.

type CreateRelationshipResponse 

type CreateRelationshipResponse = generated.CreateRelationshipResponse

type CreateRelationshipResult 

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

CreateRelationshipResult wraps CreateRelationshipResponse with convenience methods.

func (*CreateRelationshipResult) ChildTableId 

func (r *CreateRelationshipResult) ChildTableId() string

ChildTableId returns the ChildTableId field value.

func (*CreateRelationshipResult) ForeignKeyField 

func (r *CreateRelationshipResult) ForeignKeyField() *CreateRelationshipForeignKeyField

ForeignKeyField returns the ForeignKeyField field as a wrapped type, or nil if not set.

func (*CreateRelationshipResult) Id 

func (r *CreateRelationshipResult) Id() int

Id returns the Id field value.

func (*CreateRelationshipResult) IsCrossApp 

func (r *CreateRelationshipResult) IsCrossApp() bool

IsCrossApp returns the IsCrossApp field value.

func (*CreateRelationshipResult) LookupFields 

func (r *CreateRelationshipResult) LookupFields() []*CreateRelationshipLookupFieldsItem

LookupFields returns the LookupFields field as wrapped types, or nil if not set.

func (*CreateRelationshipResult) ParentTableId 

func (r *CreateRelationshipResult) ParentTableId() string

ParentTableId returns the ParentTableId field value.

func (*CreateRelationshipResult) Raw added in v2.1.0 

func (r *CreateRelationshipResult) Raw() *generated.CreateRelationshipResponse

Raw returns the underlying generated response.

func (*CreateRelationshipResult) SummaryFields 

func (r *CreateRelationshipResult) SummaryFields() []*CreateRelationshipSummaryFieldsItem

SummaryFields returns the SummaryFields field as wrapped types, or nil if not set.

type CreateRelationshipSummaryFieldsItem 

type CreateRelationshipSummaryFieldsItem struct {
	*generated.CreateRelationshipSummaryFieldsItem
}

CreateRelationshipSummaryFieldsItem wraps CreateRelationshipSummaryFieldsItem with convenience methods.

func (*CreateRelationshipSummaryFieldsItem) Id 

func (r *CreateRelationshipSummaryFieldsItem) Id() int

Id returns the Id field value, or zero value if nil.

func (*CreateRelationshipSummaryFieldsItem) Label 

func (r *CreateRelationshipSummaryFieldsItem) Label() string

Label returns the Label field value, or zero value if nil.

func (*CreateRelationshipSummaryFieldsItem) Type 

func (r *CreateRelationshipSummaryFieldsItem) Type() string

Type returns the Type field value, or zero value if nil.

type CreateSolutionBuilder 

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

CreateSolutionBuilder provides a fluent API for the createSolution operation. Create a solution

func (*CreateSolutionBuilder) Run 

func (b *CreateSolutionBuilder) Run(ctx context.Context) (*generated.CreateSolutionResponse, error)

Run executes the createSolution request and returns the response data directly.

type CreateSolutionFromRecordBuilder 

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

CreateSolutionFromRecordBuilder provides a fluent API for the createSolutionFromRecord operation. Create solution from record

func (*CreateSolutionFromRecordBuilder) FieldId 

func (b *CreateSolutionFromRecordBuilder) FieldId(value int) *CreateSolutionFromRecordBuilder

FieldId The unique identifier (fid) of the field. It needs to be a file attachment field.

func (*CreateSolutionFromRecordBuilder) RecordId 

func (b *CreateSolutionFromRecordBuilder) RecordId(value int) *CreateSolutionFromRecordBuilder

RecordId The unique identifier of the record.

func (*CreateSolutionFromRecordBuilder) Run 

func (b *CreateSolutionFromRecordBuilder) Run(ctx context.Context) (*generated.CreateSolutionFromRecordResponse, error)

Run executes the createSolutionFromRecord request and returns the response data directly.

type CreateSolutionFromRecordParams 

type CreateSolutionFromRecordParams = generated.CreateSolutionFromRecordParams

type CreateSolutionFromRecordResponse 

type CreateSolutionFromRecordResponse = generated.CreateSolutionFromRecordResponse

type CreateSolutionFromRecordResult added in v2.1.0 

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

CreateSolutionFromRecordResult wraps CreateSolutionFromRecordResponse with convenience methods.

func (*CreateSolutionFromRecordResult) Raw added in v2.1.0 

func (r *CreateSolutionFromRecordResult) Raw() *generated.CreateSolutionFromRecordResponse

Raw returns the underlying generated response.

type CreateSolutionJSONRequestBody 

type CreateSolutionJSONRequestBody = generated.CreateSolutionJSONRequestBody

type CreateSolutionParams 

type CreateSolutionParams = generated.CreateSolutionParams

type CreateSolutionResponse 

type CreateSolutionResponse = generated.CreateSolutionResponse

type CreateSolutionResult added in v2.1.0 

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

CreateSolutionResult wraps CreateSolutionResponse with convenience methods.

func (*CreateSolutionResult) Raw added in v2.1.0 

func (r *CreateSolutionResult) Raw() *generated.CreateSolutionResponse

Raw returns the underlying generated response.

type CreateTableBuilder 

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

CreateTableBuilder provides a fluent API for the createTable operation. Create a table

func (*CreateTableBuilder) AppId 

func (b *CreateTableBuilder) AppId(value string) *CreateTableBuilder

AppId The unique identifier of an app

func (*CreateTableBuilder) Description 

func (b *CreateTableBuilder) Description(value string) *CreateTableBuilder

Description The description for the table. If this value is not passed the default value is blank.

func (*CreateTableBuilder) Name 

func (b *CreateTableBuilder) Name(value string) *CreateTableBuilder

Name The name for the table.

func (*CreateTableBuilder) PluralRecordName 

func (b *CreateTableBuilder) PluralRecordName(value string) *CreateTableBuilder

PluralRecordName The plural noun for records in the table. If this value is not passed the default value is 'Records'.

func (*CreateTableBuilder) Run 

func (b *CreateTableBuilder) Run(ctx context.Context) (*CreateTableResult, error)

Run executes the createTable request and returns the response data directly.

func (*CreateTableBuilder) SingleRecordName 

func (b *CreateTableBuilder) SingleRecordName(value string) *CreateTableBuilder

SingleRecordName The singular noun for records in the table. If this value is not passed the default value is 'Record'.

type CreateTableJSONRequestBody 

type CreateTableJSONRequestBody = generated.CreateTableJSONRequestBody

type CreateTableParams 

type CreateTableParams = generated.CreateTableParams

type CreateTableResponse 

type CreateTableResponse = generated.CreateTableResponse

type CreateTableResult 

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

CreateTableResult wraps CreateTableResponse with convenience methods.

func (*CreateTableResult) Alias 

func (r *CreateTableResult) Alias() string

Alias returns the Alias field value, or zero value if nil.

func (*CreateTableResult) Created 

func (r *CreateTableResult) Created() string

Created returns the Created field value, or zero value if nil.

func (*CreateTableResult) DefaultSortFieldId 

func (r *CreateTableResult) DefaultSortFieldId() int

DefaultSortFieldId returns the DefaultSortFieldId field value, or zero value if nil.

func (*CreateTableResult) DefaultSortOrder 

func (r *CreateTableResult) DefaultSortOrder() string

DefaultSortOrder returns the DefaultSortOrder field value as a string, or empty string if nil.

func (*CreateTableResult) Description 

func (r *CreateTableResult) Description() string

Description returns the Description field value, or zero value if nil.

func (*CreateTableResult) Id 

func (r *CreateTableResult) Id() string

Id returns the Id field value, or zero value if nil.

func (*CreateTableResult) KeyFieldId 

func (r *CreateTableResult) KeyFieldId() int

KeyFieldId returns the KeyFieldId field value, or zero value if nil.

func (*CreateTableResult) Name 

func (r *CreateTableResult) Name() string

Name returns the Name field value, or zero value if nil.

func (*CreateTableResult) NextFieldId 

func (r *CreateTableResult) NextFieldId() int

NextFieldId returns the NextFieldId field value, or zero value if nil.

func (*CreateTableResult) NextRecordId 

func (r *CreateTableResult) NextRecordId() int

NextRecordId returns the NextRecordId field value, or zero value if nil.

func (*CreateTableResult) PluralRecordName 

func (r *CreateTableResult) PluralRecordName() string

PluralRecordName returns the PluralRecordName field value, or zero value if nil.

func (*CreateTableResult) Raw added in v2.1.0 

func (r *CreateTableResult) Raw() *generated.CreateTableResponse

Raw returns the underlying generated response.

func (*CreateTableResult) SingleRecordName 

func (r *CreateTableResult) SingleRecordName() string

SingleRecordName returns the SingleRecordName field value, or zero value if nil.

func (*CreateTableResult) SizeLimit 

func (r *CreateTableResult) SizeLimit() string

SizeLimit returns the SizeLimit field value, or zero value if nil.

func (*CreateTableResult) SpaceRemaining 

func (r *CreateTableResult) SpaceRemaining() string

SpaceRemaining returns the SpaceRemaining field value, or zero value if nil.

func (*CreateTableResult) SpaceUsed 

func (r *CreateTableResult) SpaceUsed() string

SpaceUsed returns the SpaceUsed field value, or zero value if nil.

func (*CreateTableResult) Updated 

func (r *CreateTableResult) Updated() string

Updated returns the Updated field value, or zero value if nil.

type DeactivateUserTokenBuilder 

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

DeactivateUserTokenBuilder provides a fluent API for the deactivateUserToken operation. Deactivate a user token

func (*DeactivateUserTokenBuilder) Run 

func (b *DeactivateUserTokenBuilder) Run(ctx context.Context) (*DeactivateUserTokenResult, error)

Run executes the deactivateUserToken request and returns the response data directly.

type DeactivateUserTokenResponse 

type DeactivateUserTokenResponse = generated.DeactivateUserTokenResponse

type DeactivateUserTokenResult 

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

DeactivateUserTokenResult wraps DeactivateUserTokenResponse with convenience methods.

func (*DeactivateUserTokenResult) Id 

func (r *DeactivateUserTokenResult) Id() int

Id returns the Id field value, or zero value if nil.

func (*DeactivateUserTokenResult) Raw added in v2.1.0 

func (r *DeactivateUserTokenResult) Raw() *generated.DeactivateUserTokenResponse

Raw returns the underlying generated response.

type DeleteAppBuilder 

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

DeleteAppBuilder provides a fluent API for the deleteApp operation. Delete an app

func (*DeleteAppBuilder) Name 

func (b *DeleteAppBuilder) Name(value string) *DeleteAppBuilder

Name To confirm application deletion we ask for application name.

func (*DeleteAppBuilder) Run 

func (b *DeleteAppBuilder) Run(ctx context.Context) (*DeleteAppResult, error)

Run executes the deleteApp request and returns the response data directly.

type DeleteAppJSONRequestBody 

type DeleteAppJSONRequestBody = generated.DeleteAppJSONRequestBody

type DeleteAppResponse 

type DeleteAppResponse = generated.DeleteAppResponse

type DeleteAppResult 

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

DeleteAppResult wraps DeleteAppResponse with convenience methods.

func (*DeleteAppResult) DeletedAppId 

func (r *DeleteAppResult) DeletedAppId() string

DeletedAppId returns the DeletedAppId field value, or zero value if nil.

func (*DeleteAppResult) Raw added in v2.1.0 

func (r *DeleteAppResult) Raw() *generated.DeleteAppResponse

Raw returns the underlying generated response.

type DeleteFieldsBuilder 

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

DeleteFieldsBuilder provides a fluent API for the deleteFields operation. Delete field(s)

func (*DeleteFieldsBuilder) FieldIds 

func (b *DeleteFieldsBuilder) FieldIds(values ...int) *DeleteFieldsBuilder

FieldIds List of field IDs to be deleted.

func (*DeleteFieldsBuilder) Run 

func (b *DeleteFieldsBuilder) Run(ctx context.Context) (*DeleteFieldsResult, error)

Run executes the deleteFields request and returns the response data directly.

type DeleteFieldsJSONRequestBody 

type DeleteFieldsJSONRequestBody = generated.DeleteFieldsJSONRequestBody

type DeleteFieldsParams 

type DeleteFieldsParams = generated.DeleteFieldsParams

type DeleteFieldsResponse 

type DeleteFieldsResponse = generated.DeleteFieldsResponse

type DeleteFieldsResult 

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

DeleteFieldsResult wraps DeleteFieldsResponse with convenience methods.

func (*DeleteFieldsResult) Raw added in v2.1.0 

func (r *DeleteFieldsResult) Raw() *generated.DeleteFieldsResponse

Raw returns the underlying generated response.

type DeleteFileBuilder 

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

DeleteFileBuilder provides a fluent API for the deleteFile operation. Delete file

func (*DeleteFileBuilder) Run 

func (b *DeleteFileBuilder) Run(ctx context.Context) (*DeleteFileResult, error)

Run executes the deleteFile request and returns the response data directly.

type DeleteFileCreator 

type DeleteFileCreator struct {
	*generated.DeleteFileCreator
}

DeleteFileCreator wraps DeleteFileCreator with convenience methods.

func (*DeleteFileCreator) Email 

func (r *DeleteFileCreator) Email() string

Email returns the Email field value, or zero value if nil.

func (*DeleteFileCreator) Id 

func (r *DeleteFileCreator) Id() string

Id returns the Id field value, or zero value if nil.

func (*DeleteFileCreator) Name 

func (r *DeleteFileCreator) Name() string

Name returns the Name field value, or zero value if nil.

func (*DeleteFileCreator) UserName 

func (r *DeleteFileCreator) UserName() string

UserName returns the UserName field value, or zero value if nil.

type DeleteFileResponse 

type DeleteFileResponse = generated.DeleteFileResponse

type DeleteFileResult 

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

DeleteFileResult wraps DeleteFileResponse with convenience methods.

func (*DeleteFileResult) Creator 

func (r *DeleteFileResult) Creator() *DeleteFileCreator

Creator returns the Creator field as a wrapped type, or nil if not set.

func (*DeleteFileResult) FileName 

func (r *DeleteFileResult) FileName() string

FileName returns the FileName field value, or zero value if nil.

func (*DeleteFileResult) Raw added in v2.1.0 

func (r *DeleteFileResult) Raw() *generated.DeleteFileResponse

Raw returns the underlying generated response.

func (*DeleteFileResult) Uploaded 

func (r *DeleteFileResult) Uploaded() string

Uploaded returns the Uploaded field value, or zero value if nil.

func (*DeleteFileResult) VersionNumber 

func (r *DeleteFileResult) VersionNumber() int

VersionNumber returns the VersionNumber field value, or zero value if nil.

type DeleteRecordsBuilder 

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

DeleteRecordsBuilder provides a fluent API for the deleteRecords operation. Delete record(s)

func (*DeleteRecordsBuilder) Run 

func (b *DeleteRecordsBuilder) Run(ctx context.Context) (*DeleteRecordsResult, error)

Run executes the deleteRecords request and returns the response data directly.

func (*DeleteRecordsBuilder) Where 

func (b *DeleteRecordsBuilder) Where(value any) *DeleteRecordsBuilder

Where The filter to delete records. To delete all records specify a filter that will include all records, for example {3.GT.0} where 3 is the ID of the Record ID field. Or supply a JSON array of Record IDs.

type DeleteRecordsResult 

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

DeleteRecordsResult wraps DeleteRecordsResponse with convenience methods.

func (*DeleteRecordsResult) NumberDeleted 

func (r *DeleteRecordsResult) NumberDeleted() int

NumberDeleted returns the NumberDeleted field value, or zero value if nil.

func (*DeleteRecordsResult) Raw added in v2.1.0 

func (r *DeleteRecordsResult) Raw() *generated.DeleteRecordsResponse

Raw returns the underlying generated response.

type DeleteRelationshipBuilder 

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

DeleteRelationshipBuilder provides a fluent API for the deleteRelationship operation. Delete a relationship

func (*DeleteRelationshipBuilder) Run 

func (b *DeleteRelationshipBuilder) Run(ctx context.Context) (*DeleteRelationshipResult, error)

Run executes the deleteRelationship request and returns the response data directly.

type DeleteRelationshipResponse 

type DeleteRelationshipResponse = generated.DeleteRelationshipResponse

type DeleteRelationshipResult 

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

DeleteRelationshipResult wraps DeleteRelationshipResponse with convenience methods.

func (*DeleteRelationshipResult) Raw added in v2.1.0 

func (r *DeleteRelationshipResult) Raw() *generated.DeleteRelationshipResponse

Raw returns the underlying generated response.

func (*DeleteRelationshipResult) RelationshipId 

func (r *DeleteRelationshipResult) RelationshipId() int

RelationshipId returns the RelationshipId field value.

type DeleteTableBuilder 

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

DeleteTableBuilder provides a fluent API for the deleteTable operation. Delete a table

func (*DeleteTableBuilder) AppId 

func (b *DeleteTableBuilder) AppId(value string) *DeleteTableBuilder

AppId The unique identifier of an app

func (*DeleteTableBuilder) Run 

func (b *DeleteTableBuilder) Run(ctx context.Context) (*DeleteTableResult, error)

Run executes the deleteTable request and returns the response data directly.

type DeleteTableParams 

type DeleteTableParams = generated.DeleteTableParams

type DeleteTableResponse 

type DeleteTableResponse = generated.DeleteTableResponse

type DeleteTableResult 

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

DeleteTableResult wraps DeleteTableResponse with convenience methods.

func (*DeleteTableResult) DeletedTableId 

func (r *DeleteTableResult) DeletedTableId() string

DeletedTableId returns the DeletedTableId field value, or zero value if nil.

func (*DeleteTableResult) Raw added in v2.1.0 

func (r *DeleteTableResult) Raw() *generated.DeleteTableResponse

Raw returns the underlying generated response.

type DeleteUserTokenBuilder 

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

DeleteUserTokenBuilder provides a fluent API for the deleteUserToken operation. Delete a user token

func (*DeleteUserTokenBuilder) Run 

func (b *DeleteUserTokenBuilder) Run(ctx context.Context) (*DeleteUserTokenResult, error)

Run executes the deleteUserToken request and returns the response data directly.

type DeleteUserTokenResponse 

type DeleteUserTokenResponse = generated.DeleteUserTokenResponse

type DeleteUserTokenResult 

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

DeleteUserTokenResult wraps DeleteUserTokenResponse with convenience methods.

func (*DeleteUserTokenResult) Id 

func (r *DeleteUserTokenResult) Id() int

Id returns the Id field value, or zero value if nil.

func (*DeleteUserTokenResult) Raw added in v2.1.0 

func (r *DeleteUserTokenResult) Raw() *generated.DeleteUserTokenResponse

Raw returns the underlying generated response.

type DenyUsersAndGroupsBuilder 

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

DenyUsersAndGroupsBuilder provides a fluent API for the denyUsersAndGroups operation. Deny and remove users from groups

func (*DenyUsersAndGroupsBuilder) AccountId 

func (b *DenyUsersAndGroupsBuilder) AccountId(value float32) *DenyUsersAndGroupsBuilder

AccountId The account id being used to deny users. If no value is specified, the first account associated with the requesting user token is chosen.

func (*DenyUsersAndGroupsBuilder) Run 

func (b *DenyUsersAndGroupsBuilder) Run(ctx context.Context) (*DenyUsersAndGroupsResult, error)

Run executes the denyUsersAndGroups request and returns the response data directly.

type DenyUsersAndGroupsJSONRequestBody 

type DenyUsersAndGroupsJSONRequestBody = generated.DenyUsersAndGroupsJSONRequestBody

type DenyUsersAndGroupsParams 

type DenyUsersAndGroupsParams = generated.DenyUsersAndGroupsParams

type DenyUsersAndGroupsResponse 

type DenyUsersAndGroupsResponse = generated.DenyUsersAndGroupsResponse

type DenyUsersAndGroupsResult 

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

DenyUsersAndGroupsResult wraps DenyUsersAndGroupsResponse with convenience methods.

func (*DenyUsersAndGroupsResult) Raw added in v2.1.0 

func (r *DenyUsersAndGroupsResult) Raw() *generated.DenyUsersAndGroupsResponse

Raw returns the underlying generated response.

type DenyUsersBuilder 

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

DenyUsersBuilder provides a fluent API for the denyUsers operation. Deny users

func (*DenyUsersBuilder) AccountId 

func (b *DenyUsersBuilder) AccountId(value float32) *DenyUsersBuilder

AccountId The account id being used to deny users. If no value is specified, the first account associated with the requesting user token is chosen.

func (*DenyUsersBuilder) Run 

func (b *DenyUsersBuilder) Run(ctx context.Context) (*DenyUsersResult, error)

Run executes the denyUsers request and returns the response data directly.

type DenyUsersJSONRequestBody 

type DenyUsersJSONRequestBody = generated.DenyUsersJSONRequestBody

type DenyUsersParams 

type DenyUsersParams = generated.DenyUsersParams

type DenyUsersResponse 

type DenyUsersResponse = generated.DenyUsersResponse

type DenyUsersResult 

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

DenyUsersResult wraps DenyUsersResponse with convenience methods.

func (*DenyUsersResult) Raw added in v2.1.0 

func (r *DenyUsersResult) Raw() *generated.DenyUsersResponse

Raw returns the underlying generated response.

type DownloadFileBuilder 

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

DownloadFileBuilder provides a fluent API for the downloadFile operation. Download file

func (*DownloadFileBuilder) Run 

func (b *DownloadFileBuilder) Run(ctx context.Context) (*generated.DownloadFileResponse, error)

Run executes the downloadFile request and returns the response data directly.

type DownloadFileResponse 

type DownloadFileResponse = generated.DownloadFileResponse

type DownloadFileResult added in v2.1.0 

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

DownloadFileResult wraps DownloadFileResponse with convenience methods.

func (*DownloadFileResult) Raw added in v2.1.0 

func (r *DownloadFileResult) Raw() *generated.DownloadFileResponse

Raw returns the underlying generated response.

type ExchangeSsoTokenBuilder 

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

ExchangeSsoTokenBuilder provides a fluent API for the exchangeSsoToken operation. Exchange an SSO token

func (*ExchangeSsoTokenBuilder) Grant_type 

func (b *ExchangeSsoTokenBuilder) Grant_type(value string) *ExchangeSsoTokenBuilder

Grant_type The value `urn:ietf:params:oauth:grant-type:token-exchange` indicates that a token exchange is being performed.

func (*ExchangeSsoTokenBuilder) Requested_token_type 

func (b *ExchangeSsoTokenBuilder) Requested_token_type(value string) *ExchangeSsoTokenBuilder

Requested_token_type An identifier for the type of the requested security token. For the RESTful API, use `urn:quickbase:params:oauth:token-type:temp_token`. For the XML or SCIM APIs use `urn:quickbase:params:oauth:token-type:temp_ticket`.

func (*ExchangeSsoTokenBuilder) Run 

func (b *ExchangeSsoTokenBuilder) Run(ctx context.Context) (*ExchangeSsoTokenResult, error)

Run executes the exchangeSsoToken request and returns the response data directly.

func (*ExchangeSsoTokenBuilder) Subject_token 

func (b *ExchangeSsoTokenBuilder) Subject_token(value string) *ExchangeSsoTokenBuilder

Subject_token A security token that represents the identity of the party on behalf of whom the request is being made. For SAML 2.0, the value should be a base64url-encoded SAML 2.0 assertion.

func (*ExchangeSsoTokenBuilder) Subject_token_type 

func (b *ExchangeSsoTokenBuilder) Subject_token_type(value string) *ExchangeSsoTokenBuilder

Subject_token_type An identifier that indicates the type of the security token in the `subject_token` parameter.

type ExchangeSsoTokenJSONRequestBody 

type ExchangeSsoTokenJSONRequestBody = generated.ExchangeSsoTokenJSONRequestBody

type ExchangeSsoTokenResponse 

type ExchangeSsoTokenResponse = generated.ExchangeSsoTokenResponse

type ExchangeSsoTokenResult 

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

ExchangeSsoTokenResult wraps ExchangeSsoTokenResponse with convenience methods.

func (*ExchangeSsoTokenResult) AccessToken 

func (r *ExchangeSsoTokenResult) AccessToken() string

AccessToken returns the AccessToken field value, or zero value if nil.

func (*ExchangeSsoTokenResult) IssuedTokenType 

func (r *ExchangeSsoTokenResult) IssuedTokenType() string

IssuedTokenType returns the IssuedTokenType field value as a string, or empty string if nil.

func (*ExchangeSsoTokenResult) Raw added in v2.1.0 

func (r *ExchangeSsoTokenResult) Raw() *generated.ExchangeSsoTokenResponse

Raw returns the underlying generated response.

func (*ExchangeSsoTokenResult) TokenType 

func (r *ExchangeSsoTokenResult) TokenType() string

TokenType returns the TokenType field value as a string, or empty string if nil.

type ExportSolutionBuilder 

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

ExportSolutionBuilder provides a fluent API for the exportSolution operation. Export a solution

func (*ExportSolutionBuilder) Run 

func (b *ExportSolutionBuilder) Run(ctx context.Context) (*generated.ExportSolutionResponse, error)

Run executes the exportSolution request and returns the response data directly.

type ExportSolutionParams 

type ExportSolutionParams = generated.ExportSolutionParams

type ExportSolutionResponse 

type ExportSolutionResponse = generated.ExportSolutionResponse

type ExportSolutionResult added in v2.1.0 

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

ExportSolutionResult wraps ExportSolutionResponse with convenience methods.

func (*ExportSolutionResult) Raw added in v2.1.0 

func (r *ExportSolutionResult) Raw() *generated.ExportSolutionResponse

Raw returns the underlying generated response.

type ExportSolutionToRecordBuilder 

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

ExportSolutionToRecordBuilder provides a fluent API for the exportSolutionToRecord operation. Export solution to record

func (*ExportSolutionToRecordBuilder) FieldId 

func (b *ExportSolutionToRecordBuilder) FieldId(value int) *ExportSolutionToRecordBuilder

FieldId The unique identifier (fid) of the field. It needs to be a file attachment field.

func (*ExportSolutionToRecordBuilder) Run 

func (b *ExportSolutionToRecordBuilder) Run(ctx context.Context) (*generated.ExportSolutionToRecordResponse, error)

Run executes the exportSolutionToRecord request and returns the response data directly.

type ExportSolutionToRecordParams 

type ExportSolutionToRecordParams = generated.ExportSolutionToRecordParams

type ExportSolutionToRecordResponse 

type ExportSolutionToRecordResponse = generated.ExportSolutionToRecordResponse

type ExportSolutionToRecordResult added in v2.1.0 

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

ExportSolutionToRecordResult wraps ExportSolutionToRecordResponse with convenience methods.

func (*ExportSolutionToRecordResult) Raw added in v2.1.0 

func (r *ExportSolutionToRecordResult) Raw() *generated.ExportSolutionToRecordResponse

Raw returns the underlying generated response.

type FieldResult 

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

FieldResult wraps GetFieldResponse with convenience methods.

func (*FieldResult) AppearsByDefault 

func (r *FieldResult) AppearsByDefault() bool

AppearsByDefault returns the AppearsByDefault field value, or zero value if nil.

func (*FieldResult) Audited 

func (r *FieldResult) Audited() bool

Audited returns the Audited field value, or zero value if nil.

func (*FieldResult) Bold 

func (r *FieldResult) Bold() bool

Bold returns the Bold field value, or zero value if nil.

func (*FieldResult) DoesDataCopy 

func (r *FieldResult) DoesDataCopy() bool

DoesDataCopy returns the DoesDataCopy field value, or zero value if nil.

func (*FieldResult) FieldHelp 

func (r *FieldResult) FieldHelp() string

FieldHelp returns the FieldHelp field value, or zero value if nil.

func (*FieldResult) FieldType 

func (r *FieldResult) FieldType() string

FieldType returns the FieldType field value, or zero value if nil.

func (*FieldResult) FindEnabled 

func (r *FieldResult) FindEnabled() bool

FindEnabled returns the FindEnabled field value, or zero value if nil.

func (*FieldResult) Id 

func (r *FieldResult) Id() int64

Id returns the Id field value.

func (*FieldResult) Label 

func (r *FieldResult) Label() string

Label returns the Label field value, or zero value if nil.

func (*FieldResult) Mode 

func (r *FieldResult) Mode() string

Mode returns the Mode field value, or zero value if nil.

func (*FieldResult) NoWrap 

func (r *FieldResult) NoWrap() bool

NoWrap returns the NoWrap field value, or zero value if nil.

func (*FieldResult) Permissions added in v2.2.0 

func (r *FieldResult) Permissions() []*GetFieldPermissionsItem

Permissions returns the Permissions field as wrapped types, or nil if not set.

func (*FieldResult) Properties 

func (r *FieldResult) Properties() *GetFieldProperties

Properties returns the Properties field as a wrapped type, or nil if not set.

func (*FieldResult) Raw added in v2.1.0 

func (r *FieldResult) Raw() *generated.GetFieldResponse

Raw returns the underlying generated response.

func (*FieldResult) Required 

func (r *FieldResult) Required() bool

Required returns the Required field value, or zero value if nil.

func (*FieldResult) Unique 

func (r *FieldResult) Unique() bool

Unique returns the Unique field value, or zero value if nil.

type FieldUsageItem 

type FieldUsageItem struct {
	*generated.GetFieldUsageItem
}

FieldUsageItem wraps GetFieldUsageItem with convenience methods.

type FieldUsageResult added in v2.1.0 

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

FieldUsageResult wraps GetFieldUsageResponse with convenience methods.

func (*FieldUsageResult) Raw added in v2.1.0 

func (r *FieldUsageResult) Raw() *generated.GetFieldUsageResponse

Raw returns the underlying generated response.

type FieldsItem 

type FieldsItem struct {
	*generated.GetFieldsItem
}

FieldsItem wraps GetFieldsItem with convenience methods.

func (*FieldsItem) AppearsByDefault 

func (r *FieldsItem) AppearsByDefault() bool

AppearsByDefault returns the AppearsByDefault field value, or zero value if nil.

func (*FieldsItem) Audited 

func (r *FieldsItem) Audited() bool

Audited returns the Audited field value, or zero value if nil.

func (*FieldsItem) Bold 

func (r *FieldsItem) Bold() bool

Bold returns the Bold field value, or zero value if nil.

func (*FieldsItem) DoesDataCopy 

func (r *FieldsItem) DoesDataCopy() bool

DoesDataCopy returns the DoesDataCopy field value, or zero value if nil.

func (*FieldsItem) FieldHelp 

func (r *FieldsItem) FieldHelp() string

FieldHelp returns the FieldHelp field value, or zero value if nil.

func (*FieldsItem) FieldType 

func (r *FieldsItem) FieldType() string

FieldType returns the FieldType field value, or zero value if nil.

func (*FieldsItem) FindEnabled 

func (r *FieldsItem) FindEnabled() bool

FindEnabled returns the FindEnabled field value, or zero value if nil.

func (*FieldsItem) Id 

func (r *FieldsItem) Id() int64

Id returns the Id field value.

func (*FieldsItem) Label 

func (r *FieldsItem) Label() string

Label returns the Label field value, or zero value if nil.

func (*FieldsItem) Mode 

func (r *FieldsItem) Mode() string

Mode returns the Mode field value, or zero value if nil.

func (*FieldsItem) NoWrap 

func (r *FieldsItem) NoWrap() bool

NoWrap returns the NoWrap field value, or zero value if nil.

func (*FieldsItem) Permissions added in v2.2.0 

func (r *FieldsItem) Permissions() []*GetFieldsItemPermissionsItem

Permissions returns the Permissions field as wrapped types, or nil if not set.

func (*FieldsItem) Properties 

func (r *FieldsItem) Properties() *GetFieldsItemProperties

Properties returns the Properties field as a wrapped type, or nil if not set.

func (*FieldsItem) Required 

func (r *FieldsItem) Required() bool

Required returns the Required field value, or zero value if nil.

func (*FieldsItem) Unique 

func (r *FieldsItem) Unique() bool

Unique returns the Unique field value, or zero value if nil.

type FieldsResult added in v2.1.0 

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

FieldsResult wraps GetFieldsResponse with convenience methods.

func (*FieldsResult) Raw added in v2.1.0 

func (r *FieldsResult) Raw() *generated.GetFieldsResponse

Raw returns the underlying generated response.

type FieldsUsageItem 

type FieldsUsageItem struct {
	*generated.GetFieldsUsageItem
}

FieldsUsageItem wraps GetFieldsUsageItem with convenience methods.

type FieldsUsageResult added in v2.1.0 

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

FieldsUsageResult wraps GetFieldsUsageResponse with convenience methods.

func (*FieldsUsageResult) Raw added in v2.1.0 

func (r *FieldsUsageResult) Raw() *generated.GetFieldsUsageResponse

Raw returns the underlying generated response.

type GenerateDocumentBuilder 

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

GenerateDocumentBuilder provides a fluent API for the generateDocument operation. Generate a document

func (*GenerateDocumentBuilder) Filename 

func (b *GenerateDocumentBuilder) Filename(value string) *GenerateDocumentBuilder

Filename File name for the downloaded file

func (*GenerateDocumentBuilder) Format 

func (b *GenerateDocumentBuilder) Format(value generated.GenerateDocumentParamsFormat) *GenerateDocumentBuilder

Format The format of the file that is returned. Default is "pdf".

func (*GenerateDocumentBuilder) Margin 

func (b *GenerateDocumentBuilder) Margin(value string) *GenerateDocumentBuilder

Margin Margin formatted as top right bottom left, separated by spaces. Add to override the value set in the template builder.

func (*GenerateDocumentBuilder) Orientation 

func (b *GenerateDocumentBuilder) Orientation(value generated.GenerateDocumentParamsOrientation) *GenerateDocumentBuilder

Orientation Page orientation. Default is "portrait". Add to override the value set in the template builder.

func (*GenerateDocumentBuilder) PageSize 

func (b *GenerateDocumentBuilder) PageSize(value generated.GenerateDocumentParamsPageSize) *GenerateDocumentBuilder

PageSize Page size. Default is "A4". Add to override the value set in the template builder.

func (*GenerateDocumentBuilder) Realm 

func (b *GenerateDocumentBuilder) Realm(value string) *GenerateDocumentBuilder

Realm Your Quickbase domain, for example demo.quickbase.com

func (*GenerateDocumentBuilder) RecordId 

func (b *GenerateDocumentBuilder) RecordId(value float32) *GenerateDocumentBuilder

RecordId The ID of the record

func (*GenerateDocumentBuilder) Run 

func (b *GenerateDocumentBuilder) Run(ctx context.Context) (*GenerateDocumentResult, error)

Run executes the generateDocument request and returns the response data directly.

func (*GenerateDocumentBuilder) Unit 

func (b *GenerateDocumentBuilder) Unit(value generated.GenerateDocumentParamsUnit) *GenerateDocumentBuilder

Unit Unit of measurement for the margin. Default is "in". Add to override the value set in the template builder.

type GenerateDocumentParams 

type GenerateDocumentParams = generated.GenerateDocumentParams

type GenerateDocumentResponse 

type GenerateDocumentResponse = generated.GenerateDocumentResponse

type GenerateDocumentResult 

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

GenerateDocumentResult wraps GenerateDocumentResponse with convenience methods.

func (*GenerateDocumentResult) ContentType 

func (r *GenerateDocumentResult) ContentType() string

ContentType returns the ContentType field value, or zero value if nil.

func (*GenerateDocumentResult) Data 

func (r *GenerateDocumentResult) Data() string

Data returns the Data field value, or zero value if nil.

func (*GenerateDocumentResult) FileName 

func (r *GenerateDocumentResult) FileName() string

FileName returns the FileName field value, or zero value if nil.

func (*GenerateDocumentResult) Raw added in v2.1.0 

func (r *GenerateDocumentResult) Raw() *generated.GenerateDocumentResponse

Raw returns the underlying generated response.

type GetAppBuilder 

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

GetAppBuilder provides a fluent API for the getApp operation. Get an app

func (*GetAppBuilder) Run 

func (b *GetAppBuilder) Run(ctx context.Context) (*AppResult, error)

Run executes the getApp request and returns the response data directly.

type GetAppEventsBuilder 

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

GetAppEventsBuilder provides a fluent API for the getAppEvents operation. Get app events

func (*GetAppEventsBuilder) Run 

func (b *GetAppEventsBuilder) Run(ctx context.Context) ([]*AppEventsItem, error)

Run executes the getAppEvents request and returns the response data directly.

type GetAppEventsItemOwner added in v2.2.0 

type GetAppEventsItemOwner struct {
	*generated.GetAppEventsItemOwner
}

GetAppEventsItemOwner wraps GetAppEventsItemOwner with convenience methods.

func (*GetAppEventsItemOwner) Email added in v2.2.0 

func (r *GetAppEventsItemOwner) Email() string

Email returns the Email field value, or zero value if nil.

func (*GetAppEventsItemOwner) Id added in v2.2.0 

func (r *GetAppEventsItemOwner) Id() string

Id returns the Id field value, or zero value if nil.

func (*GetAppEventsItemOwner) Name added in v2.2.0 

func (r *GetAppEventsItemOwner) Name() string

Name returns the Name field value, or zero value if nil.

func (*GetAppEventsItemOwner) UserName added in v2.2.0 

func (r *GetAppEventsItemOwner) UserName() string

UserName returns the UserName field value, or zero value if nil.

type GetAppEventsResponse 

type GetAppEventsResponse = generated.GetAppEventsResponse

type GetAppMemoryInfo added in v2.2.0 

type GetAppMemoryInfo struct {
	*generated.GetAppMemoryInfo
}

GetAppMemoryInfo wraps GetAppMemoryInfo with convenience methods.

func (*GetAppMemoryInfo) EstMemory added in v2.2.0 

func (r *GetAppMemoryInfo) EstMemory() float32

EstMemory returns the EstMemory field value, or zero value if nil.

func (*GetAppMemoryInfo) EstMemoryInclDependentApps added in v2.2.0 

func (r *GetAppMemoryInfo) EstMemoryInclDependentApps() float32

EstMemoryInclDependentApps returns the EstMemoryInclDependentApps field value, or zero value if nil.

type GetAppSecurityProperties added in v2.2.0 

type GetAppSecurityProperties struct {
	*generated.GetAppSecurityProperties
}

GetAppSecurityProperties wraps GetAppSecurityProperties with convenience methods.

func (*GetAppSecurityProperties) AllowClone added in v2.2.0 

func (r *GetAppSecurityProperties) AllowClone() bool

AllowClone returns the AllowClone field value, or zero value if nil.

func (*GetAppSecurityProperties) AllowExport added in v2.2.0 

func (r *GetAppSecurityProperties) AllowExport() bool

AllowExport returns the AllowExport field value, or zero value if nil.

func (*GetAppSecurityProperties) EnableAppTokens added in v2.2.0 

func (r *GetAppSecurityProperties) EnableAppTokens() bool

EnableAppTokens returns the EnableAppTokens field value, or zero value if nil.

func (*GetAppSecurityProperties) HideFromPublic added in v2.2.0 

func (r *GetAppSecurityProperties) HideFromPublic() bool

HideFromPublic returns the HideFromPublic field value, or zero value if nil.

func (*GetAppSecurityProperties) MustBeRealmApproved added in v2.2.0 

func (r *GetAppSecurityProperties) MustBeRealmApproved() bool

MustBeRealmApproved returns the MustBeRealmApproved field value, or zero value if nil.

func (*GetAppSecurityProperties) UseIPFilter added in v2.2.0 

func (r *GetAppSecurityProperties) UseIPFilter() bool

UseIPFilter returns the UseIPFilter field value, or zero value if nil.

type GetAppTablesBuilder 

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

GetAppTablesBuilder provides a fluent API for the getAppTables operation. Get tables for an app

func (*GetAppTablesBuilder) AppId 

func (b *GetAppTablesBuilder) AppId(value string) *GetAppTablesBuilder

AppId The unique identifier of an app

func (*GetAppTablesBuilder) Run 

func (b *GetAppTablesBuilder) Run(ctx context.Context) ([]*AppTablesItem, error)

Run executes the getAppTables request and returns the response data directly.

type GetAppTablesParams 

type GetAppTablesParams = generated.GetAppTablesParams

type GetAppTablesResponse 

type GetAppTablesResponse = generated.GetAppTablesResponse

type GetFieldBuilder 

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

GetFieldBuilder provides a fluent API for the getField operation. Get field

func (*GetFieldBuilder) IncludeFieldPerms 

func (b *GetFieldBuilder) IncludeFieldPerms(value bool) *GetFieldBuilder

IncludeFieldPerms Set to 'true' if you'd like to get back the custom permissions for the field(s).

func (*GetFieldBuilder) Run 

func (b *GetFieldBuilder) Run(ctx context.Context) (*FieldResult, error)

Run executes the getField request and returns the response data directly.

type GetFieldParams 

type GetFieldParams = generated.GetFieldParams

type GetFieldPermissionsItem added in v2.2.0 

type GetFieldPermissionsItem struct {
	*generated.GetFieldPermissionsItem
}

GetFieldPermissionsItem wraps GetFieldPermissionsItem with convenience methods.

func (*GetFieldPermissionsItem) PermissionType added in v2.2.0 

func (r *GetFieldPermissionsItem) PermissionType() string

PermissionType returns the PermissionType field value, or zero value if nil.

func (*GetFieldPermissionsItem) Role added in v2.2.0 

func (r *GetFieldPermissionsItem) Role() string

Role returns the Role field value, or zero value if nil.

func (*GetFieldPermissionsItem) RoleId added in v2.2.0 

func (r *GetFieldPermissionsItem) RoleId() int

RoleId returns the RoleId field value, or zero value if nil.

type GetFieldProperties added in v2.2.0 

type GetFieldProperties struct {
	*generated.GetFieldProperties
}

GetFieldProperties wraps GetFieldProperties with convenience methods.

func (*GetFieldProperties) Abbreviate added in v2.2.0 

func (r *GetFieldProperties) Abbreviate() bool

Abbreviate returns the Abbreviate field value, or zero value if nil.

func (*GetFieldProperties) AllowHTML added in v2.2.0 

func (r *GetFieldProperties) AllowHTML() bool

AllowHTML returns the AllowHTML field value, or zero value if nil.

func (*GetFieldProperties) AllowMentions added in v2.2.0 

func (r *GetFieldProperties) AllowMentions() bool

AllowMentions returns the AllowMentions field value, or zero value if nil.

func (*GetFieldProperties) AllowNewChoices added in v2.2.0 

func (r *GetFieldProperties) AllowNewChoices() bool

AllowNewChoices returns the AllowNewChoices field value, or zero value if nil.

func (*GetFieldProperties) AppearsAs added in v2.2.0 

func (r *GetFieldProperties) AppearsAs() string

AppearsAs returns the AppearsAs field value, or zero value if nil.

func (*GetFieldProperties) AppendOnly added in v2.2.0 

func (r *GetFieldProperties) AppendOnly() bool

AppendOnly returns the AppendOnly field value, or zero value if nil.

func (*GetFieldProperties) AutoSave added in v2.2.0 

func (r *GetFieldProperties) AutoSave() bool

AutoSave returns the AutoSave field value, or zero value if nil.

func (*GetFieldProperties) BlankIsZero added in v2.2.0 

func (r *GetFieldProperties) BlankIsZero() bool

BlankIsZero returns the BlankIsZero field value, or zero value if nil.

func (*GetFieldProperties) CarryChoices added in v2.2.0 

func (r *GetFieldProperties) CarryChoices() bool

CarryChoices returns the CarryChoices field value, or zero value if nil.

func (*GetFieldProperties) Choices added in v2.2.0 

func (r *GetFieldProperties) Choices() []string

Choices returns the Choices field value, or nil if not set.

func (*GetFieldProperties) ChoicesLuid added in v2.2.0 

func (r *GetFieldProperties) ChoicesLuid() []string

ChoicesLuid returns the ChoicesLuid field value, or nil if not set.

func (*GetFieldProperties) CommaStart added in v2.2.0 

func (r *GetFieldProperties) CommaStart() int

CommaStart returns the CommaStart field value, or zero value if nil.

func (*GetFieldProperties) Comments added in v2.2.0 

func (r *GetFieldProperties) Comments() string

Comments returns the Comments field value, or zero value if nil.

func (*GetFieldProperties) CompositeFields added in v2.2.0 

func (r *GetFieldProperties) CompositeFields() []*GetFieldProperties_CompositeFields_Item

CompositeFields returns the CompositeFields field as wrapped types, or nil if not set.

func (*GetFieldProperties) CoverText added in v2.2.0 

func (r *GetFieldProperties) CoverText() string

CoverText returns the CoverText field value, or zero value if nil.

func (*GetFieldProperties) CurrencyFormat added in v2.2.0 

func (r *GetFieldProperties) CurrencyFormat() string

CurrencyFormat returns the CurrencyFormat field value as a string, or empty string if nil.

func (*GetFieldProperties) CurrencySymbol added in v2.2.0 

func (r *GetFieldProperties) CurrencySymbol() string

CurrencySymbol returns the CurrencySymbol field value, or zero value if nil.

func (*GetFieldProperties) DecimalPlaces added in v2.2.0 

func (r *GetFieldProperties) DecimalPlaces() int

DecimalPlaces returns the DecimalPlaces field value, or zero value if nil.

func (*GetFieldProperties) DefaultCountryCode added in v2.2.0 

func (r *GetFieldProperties) DefaultCountryCode() string

DefaultCountryCode returns the DefaultCountryCode field value, or zero value if nil.

func (*GetFieldProperties) DefaultDomain added in v2.2.0 

func (r *GetFieldProperties) DefaultDomain() string

DefaultDomain returns the DefaultDomain field value, or zero value if nil.

func (*GetFieldProperties) DefaultKind added in v2.2.0 

func (r *GetFieldProperties) DefaultKind() string

DefaultKind returns the DefaultKind field value, or zero value if nil.

func (*GetFieldProperties) DefaultToday added in v2.2.0 

func (r *GetFieldProperties) DefaultToday() bool

DefaultToday returns the DefaultToday field value, or zero value if nil.

func (*GetFieldProperties) DefaultValue added in v2.2.0 

func (r *GetFieldProperties) DefaultValue() string

DefaultValue returns the DefaultValue field value, or zero value if nil.

func (*GetFieldProperties) DefaultValueLuid added in v2.2.0 

func (r *GetFieldProperties) DefaultValueLuid() int

DefaultValueLuid returns the DefaultValueLuid field value, or zero value if nil. 

func (r *GetFieldProperties) DisplayAsLink() bool

DisplayAsLink returns the DisplayAsLink field value, or zero value if nil.

func (*GetFieldProperties) DisplayCheckboxAsText added in v2.2.0 

func (r *GetFieldProperties) DisplayCheckboxAsText() bool

DisplayCheckboxAsText returns the DisplayCheckboxAsText field value, or zero value if nil.

func (*GetFieldProperties) DisplayDayOfWeek added in v2.2.0 

func (r *GetFieldProperties) DisplayDayOfWeek() bool

DisplayDayOfWeek returns the DisplayDayOfWeek field value, or zero value if nil.

func (*GetFieldProperties) DisplayEmail added in v2.2.0 

func (r *GetFieldProperties) DisplayEmail() string

DisplayEmail returns the DisplayEmail field value, or zero value if nil.

func (*GetFieldProperties) DisplayMonth added in v2.2.0 

func (r *GetFieldProperties) DisplayMonth() string

DisplayMonth returns the DisplayMonth field value, or zero value if nil.

func (*GetFieldProperties) DisplayRelative added in v2.2.0 

func (r *GetFieldProperties) DisplayRelative() bool

DisplayRelative returns the DisplayRelative field value, or zero value if nil.

func (*GetFieldProperties) DisplayTime added in v2.2.0 

func (r *GetFieldProperties) DisplayTime() bool

DisplayTime returns the DisplayTime field value, or zero value if nil.

func (*GetFieldProperties) DisplayTimezone added in v2.2.0 

func (r *GetFieldProperties) DisplayTimezone() bool

DisplayTimezone returns the DisplayTimezone field value, or zero value if nil.

func (*GetFieldProperties) DisplayUser added in v2.2.0 

func (r *GetFieldProperties) DisplayUser() string

DisplayUser returns the DisplayUser field value, or zero value if nil.

func (*GetFieldProperties) DoesAverage added in v2.2.0 

func (r *GetFieldProperties) DoesAverage() bool

DoesAverage returns the DoesAverage field value, or zero value if nil.

func (*GetFieldProperties) DoesTotal added in v2.2.0 

func (r *GetFieldProperties) DoesTotal() bool

DoesTotal returns the DoesTotal field value, or zero value if nil.

func (*GetFieldProperties) DurationField added in v2.2.0 

func (r *GetFieldProperties) DurationField() int

DurationField returns the DurationField field value, or zero value if nil.

func (*GetFieldProperties) Exact added in v2.2.0 

func (r *GetFieldProperties) Exact() bool

Exact returns the Exact field value, or zero value if nil.

func (*GetFieldProperties) ForeignKey added in v2.2.0 

func (r *GetFieldProperties) ForeignKey() bool

ForeignKey returns the ForeignKey field value, or zero value if nil.

func (*GetFieldProperties) Format added in v2.2.0 

func (r *GetFieldProperties) Format() int

Format returns the Format field value, or zero value if nil.

func (*GetFieldProperties) Formula added in v2.2.0 

func (r *GetFieldProperties) Formula() string

Formula returns the Formula field value, or zero value if nil.

func (*GetFieldProperties) HasExtension added in v2.2.0 

func (r *GetFieldProperties) HasExtension() bool

HasExtension returns the HasExtension field value, or zero value if nil.

func (*GetFieldProperties) Hours24 added in v2.2.0 

func (r *GetFieldProperties) Hours24() bool

Hours24 returns the Hours24 field value, or zero value if nil.

func (*GetFieldProperties) LinkText added in v2.2.0 

func (r *GetFieldProperties) LinkText() string

LinkText returns the LinkText field value, or zero value if nil.

func (*GetFieldProperties) LookupReferenceFieldId added in v2.2.0 

func (r *GetFieldProperties) LookupReferenceFieldId() int

LookupReferenceFieldId returns the LookupReferenceFieldId field value, or zero value if nil.

func (*GetFieldProperties) LookupTargetFieldId added in v2.2.0 

func (r *GetFieldProperties) LookupTargetFieldId() int

LookupTargetFieldId returns the LookupTargetFieldId field value, or zero value if nil.

func (*GetFieldProperties) MasterChoiceFieldId added in v2.2.0 

func (r *GetFieldProperties) MasterChoiceFieldId() int

MasterChoiceFieldId returns the MasterChoiceFieldId field value, or zero value if nil.

func (*GetFieldProperties) MasterChoiceTableId added in v2.2.0 

func (r *GetFieldProperties) MasterChoiceTableId() string

MasterChoiceTableId returns the MasterChoiceTableId field value, or zero value if nil.

func (*GetFieldProperties) MasterTableTag added in v2.2.0 

func (r *GetFieldProperties) MasterTableTag() string

MasterTableTag returns the MasterTableTag field value, or zero value if nil.

func (*GetFieldProperties) MaxLength added in v2.2.0 

func (r *GetFieldProperties) MaxLength() int

MaxLength returns the MaxLength field value, or zero value if nil.

func (*GetFieldProperties) MaxVersions added in v2.2.0 

func (r *GetFieldProperties) MaxVersions() int

MaxVersions returns the MaxVersions field value, or zero value if nil.

func (*GetFieldProperties) NumLines added in v2.2.0 

func (r *GetFieldProperties) NumLines() int

NumLines returns the NumLines field value, or zero value if nil.

func (*GetFieldProperties) NumberFormat added in v2.2.0 

func (r *GetFieldProperties) NumberFormat() int

NumberFormat returns the NumberFormat field value, or zero value if nil.

func (*GetFieldProperties) ParentFieldId added in v2.2.0 

func (r *GetFieldProperties) ParentFieldId() int

ParentFieldId returns the ParentFieldId field value, or zero value if nil.

func (*GetFieldProperties) PostTempToken added in v2.2.0 

func (r *GetFieldProperties) PostTempToken() bool

PostTempToken returns the PostTempToken field value, or zero value if nil.

func (*GetFieldProperties) SeeVersions added in v2.2.0 

func (r *GetFieldProperties) SeeVersions() bool

SeeVersions returns the SeeVersions field value, or zero value if nil.

func (*GetFieldProperties) SnapFieldId added in v2.2.0 

func (r *GetFieldProperties) SnapFieldId() int

SnapFieldId returns the SnapFieldId field value, or zero value if nil.

func (*GetFieldProperties) SortAlpha added in v2.2.0 

func (r *GetFieldProperties) SortAlpha() bool

SortAlpha returns the SortAlpha field value, or zero value if nil.

func (*GetFieldProperties) SortAsGiven added in v2.2.0 

func (r *GetFieldProperties) SortAsGiven() bool

SortAsGiven returns the SortAsGiven field value, or zero value if nil.

func (*GetFieldProperties) SourceFieldId added in v2.2.0 

func (r *GetFieldProperties) SourceFieldId() int

SourceFieldId returns the SourceFieldId field value, or zero value if nil.

func (*GetFieldProperties) StartField added in v2.2.0 

func (r *GetFieldProperties) StartField() int

StartField returns the StartField field value, or zero value if nil.

func (*GetFieldProperties) SummaryFunction added in v2.2.0 

func (r *GetFieldProperties) SummaryFunction() string

SummaryFunction returns the SummaryFunction field value as a string, or empty string if nil.

func (*GetFieldProperties) SummaryReferenceFieldId added in v2.2.0 

func (r *GetFieldProperties) SummaryReferenceFieldId() int64

SummaryReferenceFieldId returns the SummaryReferenceFieldId field value, or zero value if nil.

func (*GetFieldProperties) SummaryTargetFieldId added in v2.2.0 

func (r *GetFieldProperties) SummaryTargetFieldId() int

SummaryTargetFieldId returns the SummaryTargetFieldId field value, or zero value if nil.

func (*GetFieldProperties) TargetFieldId added in v2.2.0 

func (r *GetFieldProperties) TargetFieldId() int

TargetFieldId returns the TargetFieldId field value, or zero value if nil.

func (*GetFieldProperties) TargetTableId added in v2.2.0 

func (r *GetFieldProperties) TargetTableId() string

TargetTableId returns the TargetTableId field value, or zero value if nil.

func (*GetFieldProperties) TargetTableName added in v2.2.0 

func (r *GetFieldProperties) TargetTableName() string

TargetTableName returns the TargetTableName field value, or zero value if nil.

func (*GetFieldProperties) Units added in v2.2.0 

func (r *GetFieldProperties) Units() string

Units returns the Units field value, or zero value if nil.

func (*GetFieldProperties) UseI18NFormat added in v2.2.0 

func (r *GetFieldProperties) UseI18NFormat() bool

UseI18NFormat returns the UseI18NFormat field value, or zero value if nil.

func (*GetFieldProperties) UseNewWindow added in v2.2.0 

func (r *GetFieldProperties) UseNewWindow() bool

UseNewWindow returns the UseNewWindow field value, or zero value if nil.

func (*GetFieldProperties) VersionMode added in v2.2.0 

func (r *GetFieldProperties) VersionMode() string

VersionMode returns the VersionMode field value as a string, or empty string if nil.

func (*GetFieldProperties) Width added in v2.2.0 

func (r *GetFieldProperties) Width() int

Width returns the Width field value, or zero value if nil.

func (*GetFieldProperties) WorkWeek added in v2.2.0 

func (r *GetFieldProperties) WorkWeek() int

WorkWeek returns the WorkWeek field value, or zero value if nil.

func (*GetFieldProperties) XmlTag added in v2.2.0 

func (r *GetFieldProperties) XmlTag() string

XmlTag returns the XmlTag field value, or zero value if nil.

type GetFieldProperties_CompositeFields_Item added in v2.2.0 

type GetFieldProperties_CompositeFields_Item struct {
	*generated.GetFieldProperties_CompositeFields_Item
}

GetFieldProperties_CompositeFields_Item wraps GetFieldProperties_CompositeFields_Item with convenience methods.

type GetFieldResponse 

type GetFieldResponse = generated.GetFieldResponse

type GetFieldUsageBuilder 

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

GetFieldUsageBuilder provides a fluent API for the getFieldUsage operation. Get usage for a field

func (*GetFieldUsageBuilder) Run 

func (b *GetFieldUsageBuilder) Run(ctx context.Context) ([]*FieldUsageItem, error)

Run executes the getFieldUsage request and returns the response data directly.

type GetFieldUsageItemField added in v2.2.0 

type GetFieldUsageItemField struct {
	*generated.GetFieldUsageItemField
}

GetFieldUsageItemField wraps GetFieldUsageItemField with convenience methods.

func (*GetFieldUsageItemField) Id added in v2.2.0 

func (r *GetFieldUsageItemField) Id() int

Id returns the Id field value.

func (*GetFieldUsageItemField) Name added in v2.2.0 

func (r *GetFieldUsageItemField) Name() string

Name returns the Name field value.

func (*GetFieldUsageItemField) Type added in v2.2.0 

func (r *GetFieldUsageItemField) Type() string

Type returns the Type field value.

type GetFieldUsageItemUsage added in v2.2.0 

type GetFieldUsageItemUsage struct {
	*generated.GetFieldUsageItemUsage
}

GetFieldUsageItemUsage wraps GetFieldUsageItemUsage with convenience methods.

type GetFieldUsageItemUsage_Actions added in v2.2.0 

type GetFieldUsageItemUsage_Actions struct {
	*generated.GetFieldUsageItemUsage_Actions
}

GetFieldUsageItemUsage_Actions wraps GetFieldUsageItemUsage_Actions with convenience methods.

func (*GetFieldUsageItemUsage_Actions) Count added in v2.2.0 

func (r *GetFieldUsageItemUsage_Actions) Count() int

Count returns the Count field value.

type GetFieldUsageItemUsage_AppHomePages added in v2.2.0 

type GetFieldUsageItemUsage_AppHomePages struct {
	*generated.GetFieldUsageItemUsage_AppHomePages
}

GetFieldUsageItemUsage_AppHomePages wraps GetFieldUsageItemUsage_AppHomePages with convenience methods.

func (*GetFieldUsageItemUsage_AppHomePages) Count added in v2.2.0 

func (r *GetFieldUsageItemUsage_AppHomePages) Count() int

Count returns the Count field value.

type GetFieldUsageItemUsage_DefaultReports added in v2.2.0 

type GetFieldUsageItemUsage_DefaultReports struct {
	*generated.GetFieldUsageItemUsage_DefaultReports
}

GetFieldUsageItemUsage_DefaultReports wraps GetFieldUsageItemUsage_DefaultReports with convenience methods.

func (*GetFieldUsageItemUsage_DefaultReports) Count added in v2.2.0 

func (r *GetFieldUsageItemUsage_DefaultReports) Count() int

Count returns the Count field value.

type GetFieldUsageItemUsage_ExactForms added in v2.2.0 

type GetFieldUsageItemUsage_ExactForms struct {
	*generated.GetFieldUsageItemUsage_ExactForms
}

GetFieldUsageItemUsage_ExactForms wraps GetFieldUsageItemUsage_ExactForms with convenience methods.

func (*GetFieldUsageItemUsage_ExactForms) Count added in v2.2.0 

func (r *GetFieldUsageItemUsage_ExactForms) Count() int

Count returns the Count field value.

type GetFieldUsageItemUsage_Fields added in v2.2.0 

type GetFieldUsageItemUsage_Fields struct {
	*generated.GetFieldUsageItemUsage_Fields
}

GetFieldUsageItemUsage_Fields wraps GetFieldUsageItemUsage_Fields with convenience methods.

func (*GetFieldUsageItemUsage_Fields) Count added in v2.2.0 

func (r *GetFieldUsageItemUsage_Fields) Count() int

Count returns the Count field value.

type GetFieldUsageItemUsage_Forms added in v2.2.0 

type GetFieldUsageItemUsage_Forms struct {
	*generated.GetFieldUsageItemUsage_Forms
}

GetFieldUsageItemUsage_Forms wraps GetFieldUsageItemUsage_Forms with convenience methods.

func (*GetFieldUsageItemUsage_Forms) Count added in v2.2.0 

func (r *GetFieldUsageItemUsage_Forms) Count() int

Count returns the Count field value.

type GetFieldUsageItemUsage_Notifications added in v2.2.0 

type GetFieldUsageItemUsage_Notifications struct {
	*generated.GetFieldUsageItemUsage_Notifications
}

GetFieldUsageItemUsage_Notifications wraps GetFieldUsageItemUsage_Notifications with convenience methods.

func (*GetFieldUsageItemUsage_Notifications) Count added in v2.2.0 

func (r *GetFieldUsageItemUsage_Notifications) Count() int

Count returns the Count field value.

type GetFieldUsageItemUsage_PersonalReports added in v2.2.0 

type GetFieldUsageItemUsage_PersonalReports struct {
	*generated.GetFieldUsageItemUsage_PersonalReports
}

GetFieldUsageItemUsage_PersonalReports wraps GetFieldUsageItemUsage_PersonalReports with convenience methods.

func (*GetFieldUsageItemUsage_PersonalReports) Count added in v2.2.0 

func (r *GetFieldUsageItemUsage_PersonalReports) Count() int

Count returns the Count field value.

type GetFieldUsageItemUsage_Pipelines added in v2.2.0 

type GetFieldUsageItemUsage_Pipelines struct {
	*generated.GetFieldUsageItemUsage_Pipelines
}

GetFieldUsageItemUsage_Pipelines wraps GetFieldUsageItemUsage_Pipelines with convenience methods.

func (*GetFieldUsageItemUsage_Pipelines) Count added in v2.2.0 

func (r *GetFieldUsageItemUsage_Pipelines) Count() int

Count returns the Count field value.

type GetFieldUsageItemUsage_Relationships added in v2.2.0 

type GetFieldUsageItemUsage_Relationships struct {
	*generated.GetFieldUsageItemUsage_Relationships
}

GetFieldUsageItemUsage_Relationships wraps GetFieldUsageItemUsage_Relationships with convenience methods.

func (*GetFieldUsageItemUsage_Relationships) Count added in v2.2.0 

func (r *GetFieldUsageItemUsage_Relationships) Count() int

Count returns the Count field value.

type GetFieldUsageItemUsage_Reminders added in v2.2.0 

type GetFieldUsageItemUsage_Reminders struct {
	*generated.GetFieldUsageItemUsage_Reminders
}

GetFieldUsageItemUsage_Reminders wraps GetFieldUsageItemUsage_Reminders with convenience methods.

func (*GetFieldUsageItemUsage_Reminders) Count added in v2.2.0 

func (r *GetFieldUsageItemUsage_Reminders) Count() int

Count returns the Count field value.

type GetFieldUsageItemUsage_Reports added in v2.2.0 

type GetFieldUsageItemUsage_Reports struct {
	*generated.GetFieldUsageItemUsage_Reports
}

GetFieldUsageItemUsage_Reports wraps GetFieldUsageItemUsage_Reports with convenience methods.

func (*GetFieldUsageItemUsage_Reports) Count added in v2.2.0 

func (r *GetFieldUsageItemUsage_Reports) Count() int

Count returns the Count field value.

type GetFieldUsageItemUsage_Roles added in v2.2.0 

type GetFieldUsageItemUsage_Roles struct {
	*generated.GetFieldUsageItemUsage_Roles
}

GetFieldUsageItemUsage_Roles wraps GetFieldUsageItemUsage_Roles with convenience methods.

func (*GetFieldUsageItemUsage_Roles) Count added in v2.2.0 

func (r *GetFieldUsageItemUsage_Roles) Count() int

Count returns the Count field value.

type GetFieldUsageItemUsage_Webhooks added in v2.2.0 

type GetFieldUsageItemUsage_Webhooks struct {
	*generated.GetFieldUsageItemUsage_Webhooks
}

GetFieldUsageItemUsage_Webhooks wraps GetFieldUsageItemUsage_Webhooks with convenience methods.

func (*GetFieldUsageItemUsage_Webhooks) Count added in v2.2.0 

func (r *GetFieldUsageItemUsage_Webhooks) Count() int

Count returns the Count field value.

type GetFieldUsageParams 

type GetFieldUsageParams = generated.GetFieldUsageParams

type GetFieldUsageResponse 

type GetFieldUsageResponse = generated.GetFieldUsageResponse

type GetFieldsBuilder 

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

GetFieldsBuilder provides a fluent API for the getFields operation. Get fields for a table

func (*GetFieldsBuilder) IncludeFieldPerms 

func (b *GetFieldsBuilder) IncludeFieldPerms(value bool) *GetFieldsBuilder

IncludeFieldPerms Set to 'true' if you'd like to get back the custom permissions for the field(s).

func (*GetFieldsBuilder) Run 

func (b *GetFieldsBuilder) Run(ctx context.Context) ([]*FieldsItem, error)

Run executes the getFields request and returns the response data directly.

type GetFieldsItemPermissionsItem added in v2.2.0 

type GetFieldsItemPermissionsItem struct {
	*generated.GetFieldsItemPermissionsItem
}

GetFieldsItemPermissionsItem wraps GetFieldsItemPermissionsItem with convenience methods.

func (*GetFieldsItemPermissionsItem) PermissionType added in v2.2.0 

func (r *GetFieldsItemPermissionsItem) PermissionType() string

PermissionType returns the PermissionType field value, or zero value if nil.

func (*GetFieldsItemPermissionsItem) Role added in v2.2.0 

func (r *GetFieldsItemPermissionsItem) Role() string

Role returns the Role field value, or zero value if nil.

func (*GetFieldsItemPermissionsItem) RoleId added in v2.2.0 

func (r *GetFieldsItemPermissionsItem) RoleId() int

RoleId returns the RoleId field value, or zero value if nil.

type GetFieldsItemProperties added in v2.2.0 

type GetFieldsItemProperties struct {
	*generated.GetFieldsItemProperties
}

GetFieldsItemProperties wraps GetFieldsItemProperties with convenience methods.

func (*GetFieldsItemProperties) Abbreviate added in v2.2.0 

func (r *GetFieldsItemProperties) Abbreviate() bool

Abbreviate returns the Abbreviate field value, or zero value if nil.

func (*GetFieldsItemProperties) AllowHTML added in v2.2.0 

func (r *GetFieldsItemProperties) AllowHTML() bool

AllowHTML returns the AllowHTML field value, or zero value if nil.

func (*GetFieldsItemProperties) AllowMentions added in v2.2.0 

func (r *GetFieldsItemProperties) AllowMentions() bool

AllowMentions returns the AllowMentions field value, or zero value if nil.

func (*GetFieldsItemProperties) AllowNewChoices added in v2.2.0 

func (r *GetFieldsItemProperties) AllowNewChoices() bool

AllowNewChoices returns the AllowNewChoices field value, or zero value if nil.

func (*GetFieldsItemProperties) AppearsAs added in v2.2.0 

func (r *GetFieldsItemProperties) AppearsAs() string

AppearsAs returns the AppearsAs field value, or zero value if nil.

func (*GetFieldsItemProperties) AppendOnly added in v2.2.0 

func (r *GetFieldsItemProperties) AppendOnly() bool

AppendOnly returns the AppendOnly field value, or zero value if nil.

func (*GetFieldsItemProperties) AutoSave added in v2.2.0 

func (r *GetFieldsItemProperties) AutoSave() bool

AutoSave returns the AutoSave field value, or zero value if nil.

func (*GetFieldsItemProperties) BlankIsZero added in v2.2.0 

func (r *GetFieldsItemProperties) BlankIsZero() bool

BlankIsZero returns the BlankIsZero field value, or zero value if nil.

func (*GetFieldsItemProperties) CarryChoices added in v2.2.0 

func (r *GetFieldsItemProperties) CarryChoices() bool

CarryChoices returns the CarryChoices field value, or zero value if nil.

func (*GetFieldsItemProperties) Choices added in v2.2.0 

func (r *GetFieldsItemProperties) Choices() []string

Choices returns the Choices field value, or nil if not set.

func (*GetFieldsItemProperties) ChoicesLuid added in v2.2.0 

func (r *GetFieldsItemProperties) ChoicesLuid() []string

ChoicesLuid returns the ChoicesLuid field value, or nil if not set.

func (*GetFieldsItemProperties) CommaStart added in v2.2.0 

func (r *GetFieldsItemProperties) CommaStart() int

CommaStart returns the CommaStart field value, or zero value if nil.

func (*GetFieldsItemProperties) Comments added in v2.2.0 

func (r *GetFieldsItemProperties) Comments() string

Comments returns the Comments field value, or zero value if nil.

func (*GetFieldsItemProperties) CompositeFields added in v2.2.0 

func (r *GetFieldsItemProperties) CompositeFields() []*GetFieldsItemProperties_CompositeFields_Item

CompositeFields returns the CompositeFields field as wrapped types, or nil if not set.

func (*GetFieldsItemProperties) CoverText added in v2.2.0 

func (r *GetFieldsItemProperties) CoverText() string

CoverText returns the CoverText field value, or zero value if nil.

func (*GetFieldsItemProperties) CurrencyFormat added in v2.2.0 

func (r *GetFieldsItemProperties) CurrencyFormat() string

CurrencyFormat returns the CurrencyFormat field value as a string, or empty string if nil.

func (*GetFieldsItemProperties) CurrencySymbol added in v2.2.0 

func (r *GetFieldsItemProperties) CurrencySymbol() string

CurrencySymbol returns the CurrencySymbol field value, or zero value if nil.

func (*GetFieldsItemProperties) DecimalPlaces added in v2.2.0 

func (r *GetFieldsItemProperties) DecimalPlaces() int

DecimalPlaces returns the DecimalPlaces field value, or zero value if nil.

func (*GetFieldsItemProperties) DefaultCountryCode added in v2.2.0 

func (r *GetFieldsItemProperties) DefaultCountryCode() string

DefaultCountryCode returns the DefaultCountryCode field value, or zero value if nil.

func (*GetFieldsItemProperties) DefaultDomain added in v2.2.0 

func (r *GetFieldsItemProperties) DefaultDomain() string

DefaultDomain returns the DefaultDomain field value, or zero value if nil.

func (*GetFieldsItemProperties) DefaultKind added in v2.2.0 

func (r *GetFieldsItemProperties) DefaultKind() string

DefaultKind returns the DefaultKind field value, or zero value if nil.

func (*GetFieldsItemProperties) DefaultToday added in v2.2.0 

func (r *GetFieldsItemProperties) DefaultToday() bool

DefaultToday returns the DefaultToday field value, or zero value if nil.

func (*GetFieldsItemProperties) DefaultValue added in v2.2.0 

func (r *GetFieldsItemProperties) DefaultValue() string

DefaultValue returns the DefaultValue field value, or zero value if nil.

func (*GetFieldsItemProperties) DefaultValueLuid added in v2.2.0 

func (r *GetFieldsItemProperties) DefaultValueLuid() int

DefaultValueLuid returns the DefaultValueLuid field value, or zero value if nil. 

func (r *GetFieldsItemProperties) DisplayAsLink() bool

DisplayAsLink returns the DisplayAsLink field value, or zero value if nil.

func (*GetFieldsItemProperties) DisplayCheckboxAsText added in v2.2.0 

func (r *GetFieldsItemProperties) DisplayCheckboxAsText() bool

DisplayCheckboxAsText returns the DisplayCheckboxAsText field value, or zero value if nil.

func (*GetFieldsItemProperties) DisplayDayOfWeek added in v2.2.0 

func (r *GetFieldsItemProperties) DisplayDayOfWeek() bool

DisplayDayOfWeek returns the DisplayDayOfWeek field value, or zero value if nil.

func (*GetFieldsItemProperties) DisplayEmail added in v2.2.0 

func (r *GetFieldsItemProperties) DisplayEmail() string

DisplayEmail returns the DisplayEmail field value, or zero value if nil.

func (*GetFieldsItemProperties) DisplayMonth added in v2.2.0 

func (r *GetFieldsItemProperties) DisplayMonth() string

DisplayMonth returns the DisplayMonth field value, or zero value if nil.

func (*GetFieldsItemProperties) DisplayRelative added in v2.2.0 

func (r *GetFieldsItemProperties) DisplayRelative() bool

DisplayRelative returns the DisplayRelative field value, or zero value if nil.

func (*GetFieldsItemProperties) DisplayTime added in v2.2.0 

func (r *GetFieldsItemProperties) DisplayTime() bool

DisplayTime returns the DisplayTime field value, or zero value if nil.

func (*GetFieldsItemProperties) DisplayTimezone added in v2.2.0 

func (r *GetFieldsItemProperties) DisplayTimezone() bool

DisplayTimezone returns the DisplayTimezone field value, or zero value if nil.

func (*GetFieldsItemProperties) DisplayUser added in v2.2.0 

func (r *GetFieldsItemProperties) DisplayUser() string

DisplayUser returns the DisplayUser field value, or zero value if nil.

func (*GetFieldsItemProperties) DoesAverage added in v2.2.0 

func (r *GetFieldsItemProperties) DoesAverage() bool

DoesAverage returns the DoesAverage field value, or zero value if nil.

func (*GetFieldsItemProperties) DoesTotal added in v2.2.0 

func (r *GetFieldsItemProperties) DoesTotal() bool

DoesTotal returns the DoesTotal field value, or zero value if nil.

func (*GetFieldsItemProperties) DurationField added in v2.2.0 

func (r *GetFieldsItemProperties) DurationField() int

DurationField returns the DurationField field value, or zero value if nil.

func (*GetFieldsItemProperties) Exact added in v2.2.0 

func (r *GetFieldsItemProperties) Exact() bool

Exact returns the Exact field value, or zero value if nil.

func (*GetFieldsItemProperties) ForeignKey added in v2.2.0 

func (r *GetFieldsItemProperties) ForeignKey() bool

ForeignKey returns the ForeignKey field value, or zero value if nil.

func (*GetFieldsItemProperties) Format added in v2.2.0 

func (r *GetFieldsItemProperties) Format() int

Format returns the Format field value, or zero value if nil.

func (*GetFieldsItemProperties) Formula added in v2.2.0 

func (r *GetFieldsItemProperties) Formula() string

Formula returns the Formula field value, or zero value if nil.

func (*GetFieldsItemProperties) HasExtension added in v2.2.0 

func (r *GetFieldsItemProperties) HasExtension() bool

HasExtension returns the HasExtension field value, or zero value if nil.

func (*GetFieldsItemProperties) Hours24 added in v2.2.0 

func (r *GetFieldsItemProperties) Hours24() bool

Hours24 returns the Hours24 field value, or zero value if nil.

func (*GetFieldsItemProperties) LinkText added in v2.2.0 

func (r *GetFieldsItemProperties) LinkText() string

LinkText returns the LinkText field value, or zero value if nil.

func (*GetFieldsItemProperties) LookupReferenceFieldId added in v2.2.0 

func (r *GetFieldsItemProperties) LookupReferenceFieldId() int

LookupReferenceFieldId returns the LookupReferenceFieldId field value, or zero value if nil.

func (*GetFieldsItemProperties) LookupTargetFieldId added in v2.2.0 

func (r *GetFieldsItemProperties) LookupTargetFieldId() int

LookupTargetFieldId returns the LookupTargetFieldId field value, or zero value if nil.

func (*GetFieldsItemProperties) MasterChoiceFieldId added in v2.2.0 

func (r *GetFieldsItemProperties) MasterChoiceFieldId() int

MasterChoiceFieldId returns the MasterChoiceFieldId field value, or zero value if nil.

func (*GetFieldsItemProperties) MasterChoiceTableId added in v2.2.0 

func (r *GetFieldsItemProperties) MasterChoiceTableId() string

MasterChoiceTableId returns the MasterChoiceTableId field value, or zero value if nil.

func (*GetFieldsItemProperties) MasterTableTag added in v2.2.0 

func (r *GetFieldsItemProperties) MasterTableTag() string

MasterTableTag returns the MasterTableTag field value, or zero value if nil.

func (*GetFieldsItemProperties) MaxLength added in v2.2.0 

func (r *GetFieldsItemProperties) MaxLength() int

MaxLength returns the MaxLength field value, or zero value if nil.

func (*GetFieldsItemProperties) MaxVersions added in v2.2.0 

func (r *GetFieldsItemProperties) MaxVersions() int

MaxVersions returns the MaxVersions field value, or zero value if nil.

func (*GetFieldsItemProperties) NumLines added in v2.2.0 

func (r *GetFieldsItemProperties) NumLines() int

NumLines returns the NumLines field value, or zero value if nil.

func (*GetFieldsItemProperties) NumberFormat added in v2.2.0 

func (r *GetFieldsItemProperties) NumberFormat() int

NumberFormat returns the NumberFormat field value, or zero value if nil.

func (*GetFieldsItemProperties) ParentFieldId added in v2.2.0 

func (r *GetFieldsItemProperties) ParentFieldId() int

ParentFieldId returns the ParentFieldId field value, or zero value if nil.

func (*GetFieldsItemProperties) PostTempToken added in v2.2.0 

func (r *GetFieldsItemProperties) PostTempToken() bool

PostTempToken returns the PostTempToken field value, or zero value if nil.

func (*GetFieldsItemProperties) SeeVersions added in v2.2.0 

func (r *GetFieldsItemProperties) SeeVersions() bool

SeeVersions returns the SeeVersions field value, or zero value if nil.

func (*GetFieldsItemProperties) SnapFieldId added in v2.2.0 

func (r *GetFieldsItemProperties) SnapFieldId() int

SnapFieldId returns the SnapFieldId field value, or zero value if nil.

func (*GetFieldsItemProperties) SortAlpha added in v2.2.0 

func (r *GetFieldsItemProperties) SortAlpha() bool

SortAlpha returns the SortAlpha field value, or zero value if nil.

func (*GetFieldsItemProperties) SortAsGiven added in v2.2.0 

func (r *GetFieldsItemProperties) SortAsGiven() bool

SortAsGiven returns the SortAsGiven field value, or zero value if nil.

func (*GetFieldsItemProperties) SourceFieldId added in v2.2.0 

func (r *GetFieldsItemProperties) SourceFieldId() int

SourceFieldId returns the SourceFieldId field value, or zero value if nil.

func (*GetFieldsItemProperties) StartField added in v2.2.0 

func (r *GetFieldsItemProperties) StartField() int

StartField returns the StartField field value, or zero value if nil.

func (*GetFieldsItemProperties) SummaryFunction added in v2.2.0 

func (r *GetFieldsItemProperties) SummaryFunction() string

SummaryFunction returns the SummaryFunction field value as a string, or empty string if nil.

func (*GetFieldsItemProperties) SummaryReferenceFieldId added in v2.2.0 

func (r *GetFieldsItemProperties) SummaryReferenceFieldId() int64

SummaryReferenceFieldId returns the SummaryReferenceFieldId field value, or zero value if nil.

func (*GetFieldsItemProperties) SummaryTargetFieldId added in v2.2.0 

func (r *GetFieldsItemProperties) SummaryTargetFieldId() int

SummaryTargetFieldId returns the SummaryTargetFieldId field value, or zero value if nil.

func (*GetFieldsItemProperties) TargetFieldId added in v2.2.0 

func (r *GetFieldsItemProperties) TargetFieldId() int

TargetFieldId returns the TargetFieldId field value, or zero value if nil.

func (*GetFieldsItemProperties) TargetTableId added in v2.2.0 

func (r *GetFieldsItemProperties) TargetTableId() string

TargetTableId returns the TargetTableId field value, or zero value if nil.

func (*GetFieldsItemProperties) TargetTableName added in v2.2.0 

func (r *GetFieldsItemProperties) TargetTableName() string

TargetTableName returns the TargetTableName field value, or zero value if nil.

func (*GetFieldsItemProperties) Units added in v2.2.0 

func (r *GetFieldsItemProperties) Units() string

Units returns the Units field value, or zero value if nil.

func (*GetFieldsItemProperties) UseI18NFormat added in v2.2.0 

func (r *GetFieldsItemProperties) UseI18NFormat() bool

UseI18NFormat returns the UseI18NFormat field value, or zero value if nil.

func (*GetFieldsItemProperties) UseNewWindow added in v2.2.0 

func (r *GetFieldsItemProperties) UseNewWindow() bool

UseNewWindow returns the UseNewWindow field value, or zero value if nil.

func (*GetFieldsItemProperties) VersionMode added in v2.2.0 

func (r *GetFieldsItemProperties) VersionMode() string

VersionMode returns the VersionMode field value as a string, or empty string if nil.

func (*GetFieldsItemProperties) Width added in v2.2.0 

func (r *GetFieldsItemProperties) Width() int

Width returns the Width field value, or zero value if nil.

func (*GetFieldsItemProperties) WorkWeek added in v2.2.0 

func (r *GetFieldsItemProperties) WorkWeek() int

WorkWeek returns the WorkWeek field value, or zero value if nil.

func (*GetFieldsItemProperties) XmlTag added in v2.2.0 

func (r *GetFieldsItemProperties) XmlTag() string

XmlTag returns the XmlTag field value, or zero value if nil.

type GetFieldsItemProperties_CompositeFields_Item added in v2.2.0 

type GetFieldsItemProperties_CompositeFields_Item struct {
	*generated.GetFieldsItemProperties_CompositeFields_Item
}

GetFieldsItemProperties_CompositeFields_Item wraps GetFieldsItemProperties_CompositeFields_Item with convenience methods.

type GetFieldsParams 

type GetFieldsParams = generated.GetFieldsParams

type GetFieldsUsageBuilder 

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

GetFieldsUsageBuilder provides a fluent API for the getFieldsUsage operation. Get usage for all fields

func (*GetFieldsUsageBuilder) Run 

func (b *GetFieldsUsageBuilder) Run(ctx context.Context) ([]*FieldsUsageItem, error)

Run executes the getFieldsUsage request and returns the response data directly.

func (*GetFieldsUsageBuilder) Skip 

func (b *GetFieldsUsageBuilder) Skip(value int) *GetFieldsUsageBuilder

Skip The number of fields to skip from the list.

func (*GetFieldsUsageBuilder) Top 

func (b *GetFieldsUsageBuilder) Top(value int) *GetFieldsUsageBuilder

Top The maximum number of fields to return.

type GetFieldsUsageItemField added in v2.2.0 

type GetFieldsUsageItemField struct {
	*generated.GetFieldsUsageItemField
}

GetFieldsUsageItemField wraps GetFieldsUsageItemField with convenience methods.

func (*GetFieldsUsageItemField) Id added in v2.2.0 

func (r *GetFieldsUsageItemField) Id() int

Id returns the Id field value.

func (*GetFieldsUsageItemField) Name added in v2.2.0 

func (r *GetFieldsUsageItemField) Name() string

Name returns the Name field value.

func (*GetFieldsUsageItemField) Type added in v2.2.0 

func (r *GetFieldsUsageItemField) Type() string

Type returns the Type field value.

type GetFieldsUsageItemUsage added in v2.2.0 

type GetFieldsUsageItemUsage struct {
	*generated.GetFieldsUsageItemUsage
}

GetFieldsUsageItemUsage wraps GetFieldsUsageItemUsage with convenience methods.

type GetFieldsUsageItemUsage_Actions added in v2.2.0 

type GetFieldsUsageItemUsage_Actions struct {
	*generated.GetFieldsUsageItemUsage_Actions
}

GetFieldsUsageItemUsage_Actions wraps GetFieldsUsageItemUsage_Actions with convenience methods.

func (*GetFieldsUsageItemUsage_Actions) Count added in v2.2.0 

func (r *GetFieldsUsageItemUsage_Actions) Count() int

Count returns the Count field value.

type GetFieldsUsageItemUsage_AppHomePages added in v2.2.0 

type GetFieldsUsageItemUsage_AppHomePages struct {
	*generated.GetFieldsUsageItemUsage_AppHomePages
}

GetFieldsUsageItemUsage_AppHomePages wraps GetFieldsUsageItemUsage_AppHomePages with convenience methods.

func (*GetFieldsUsageItemUsage_AppHomePages) Count added in v2.2.0 

func (r *GetFieldsUsageItemUsage_AppHomePages) Count() int

Count returns the Count field value.

type GetFieldsUsageItemUsage_DefaultReports added in v2.2.0 

type GetFieldsUsageItemUsage_DefaultReports struct {
	*generated.GetFieldsUsageItemUsage_DefaultReports
}

GetFieldsUsageItemUsage_DefaultReports wraps GetFieldsUsageItemUsage_DefaultReports with convenience methods.

func (*GetFieldsUsageItemUsage_DefaultReports) Count added in v2.2.0 

func (r *GetFieldsUsageItemUsage_DefaultReports) Count() int

Count returns the Count field value.

type GetFieldsUsageItemUsage_ExactForms added in v2.2.0 

type GetFieldsUsageItemUsage_ExactForms struct {
	*generated.GetFieldsUsageItemUsage_ExactForms
}

GetFieldsUsageItemUsage_ExactForms wraps GetFieldsUsageItemUsage_ExactForms with convenience methods.

func (*GetFieldsUsageItemUsage_ExactForms) Count added in v2.2.0 

func (r *GetFieldsUsageItemUsage_ExactForms) Count() int

Count returns the Count field value.

type GetFieldsUsageItemUsage_Fields added in v2.2.0 

type GetFieldsUsageItemUsage_Fields struct {
	*generated.GetFieldsUsageItemUsage_Fields
}

GetFieldsUsageItemUsage_Fields wraps GetFieldsUsageItemUsage_Fields with convenience methods.

func (*GetFieldsUsageItemUsage_Fields) Count added in v2.2.0 

func (r *GetFieldsUsageItemUsage_Fields) Count() int

Count returns the Count field value.

type GetFieldsUsageItemUsage_Forms added in v2.2.0 

type GetFieldsUsageItemUsage_Forms struct {
	*generated.GetFieldsUsageItemUsage_Forms
}

GetFieldsUsageItemUsage_Forms wraps GetFieldsUsageItemUsage_Forms with convenience methods.

func (*GetFieldsUsageItemUsage_Forms) Count added in v2.2.0 

func (r *GetFieldsUsageItemUsage_Forms) Count() int

Count returns the Count field value.

type GetFieldsUsageItemUsage_Notifications added in v2.2.0 

type GetFieldsUsageItemUsage_Notifications struct {
	*generated.GetFieldsUsageItemUsage_Notifications
}

GetFieldsUsageItemUsage_Notifications wraps GetFieldsUsageItemUsage_Notifications with convenience methods.

func (*GetFieldsUsageItemUsage_Notifications) Count added in v2.2.0 

func (r *GetFieldsUsageItemUsage_Notifications) Count() int

Count returns the Count field value.

type GetFieldsUsageItemUsage_PersonalReports added in v2.2.0 

type GetFieldsUsageItemUsage_PersonalReports struct {
	*generated.GetFieldsUsageItemUsage_PersonalReports
}

GetFieldsUsageItemUsage_PersonalReports wraps GetFieldsUsageItemUsage_PersonalReports with convenience methods.

func (*GetFieldsUsageItemUsage_PersonalReports) Count added in v2.2.0 

func (r *GetFieldsUsageItemUsage_PersonalReports) Count() int

Count returns the Count field value.

type GetFieldsUsageItemUsage_Pipelines added in v2.2.0 

type GetFieldsUsageItemUsage_Pipelines struct {
	*generated.GetFieldsUsageItemUsage_Pipelines
}

GetFieldsUsageItemUsage_Pipelines wraps GetFieldsUsageItemUsage_Pipelines with convenience methods.

func (*GetFieldsUsageItemUsage_Pipelines) Count added in v2.2.0 

func (r *GetFieldsUsageItemUsage_Pipelines) Count() int

Count returns the Count field value.

type GetFieldsUsageItemUsage_Relationships added in v2.2.0 

type GetFieldsUsageItemUsage_Relationships struct {
	*generated.GetFieldsUsageItemUsage_Relationships
}

GetFieldsUsageItemUsage_Relationships wraps GetFieldsUsageItemUsage_Relationships with convenience methods.

func (*GetFieldsUsageItemUsage_Relationships) Count added in v2.2.0 

func (r *GetFieldsUsageItemUsage_Relationships) Count() int

Count returns the Count field value.

type GetFieldsUsageItemUsage_Reminders added in v2.2.0 

type GetFieldsUsageItemUsage_Reminders struct {
	*generated.GetFieldsUsageItemUsage_Reminders
}

GetFieldsUsageItemUsage_Reminders wraps GetFieldsUsageItemUsage_Reminders with convenience methods.

func (*GetFieldsUsageItemUsage_Reminders) Count added in v2.2.0 

func (r *GetFieldsUsageItemUsage_Reminders) Count() int

Count returns the Count field value.

type GetFieldsUsageItemUsage_Reports added in v2.2.0 

type GetFieldsUsageItemUsage_Reports struct {
	*generated.GetFieldsUsageItemUsage_Reports
}

GetFieldsUsageItemUsage_Reports wraps GetFieldsUsageItemUsage_Reports with convenience methods.

func (*GetFieldsUsageItemUsage_Reports) Count added in v2.2.0 

func (r *GetFieldsUsageItemUsage_Reports) Count() int

Count returns the Count field value.

type GetFieldsUsageItemUsage_Roles added in v2.2.0 

type GetFieldsUsageItemUsage_Roles struct {
	*generated.GetFieldsUsageItemUsage_Roles
}

GetFieldsUsageItemUsage_Roles wraps GetFieldsUsageItemUsage_Roles with convenience methods.

func (*GetFieldsUsageItemUsage_Roles) Count added in v2.2.0 

func (r *GetFieldsUsageItemUsage_Roles) Count() int

Count returns the Count field value.

type GetFieldsUsageItemUsage_Webhooks added in v2.2.0 

type GetFieldsUsageItemUsage_Webhooks struct {
	*generated.GetFieldsUsageItemUsage_Webhooks
}

GetFieldsUsageItemUsage_Webhooks wraps GetFieldsUsageItemUsage_Webhooks with convenience methods.

func (*GetFieldsUsageItemUsage_Webhooks) Count added in v2.2.0 

func (r *GetFieldsUsageItemUsage_Webhooks) Count() int

Count returns the Count field value.

type GetFieldsUsageParams 

type GetFieldsUsageParams = generated.GetFieldsUsageParams

type GetFieldsUsageResponse 

type GetFieldsUsageResponse = generated.GetFieldsUsageResponse

type GetRelationshipsBuilder 

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

GetRelationshipsBuilder provides a fluent API for the getRelationships operation. Get all relationships

func (*GetRelationshipsBuilder) Run 

func (b *GetRelationshipsBuilder) Run(ctx context.Context) (*RelationshipsResult, error)

Run executes the getRelationships request and returns the response data directly.

func (*GetRelationshipsBuilder) Skip 

func (b *GetRelationshipsBuilder) Skip(value int) *GetRelationshipsBuilder

Skip The number of relationships to skip.

type GetRelationshipsMetadata added in v2.2.0 

type GetRelationshipsMetadata struct {
	*generated.GetRelationshipsMetadata
}

GetRelationshipsMetadata wraps GetRelationshipsMetadata with convenience methods.

func (*GetRelationshipsMetadata) NumRelationships added in v2.2.0 

func (r *GetRelationshipsMetadata) NumRelationships() int

NumRelationships returns the NumRelationships field value, or zero value if nil.

func (*GetRelationshipsMetadata) Skip added in v2.2.0 

func (r *GetRelationshipsMetadata) Skip() int

Skip returns the Skip field value, or zero value if nil.

func (*GetRelationshipsMetadata) TotalRelationships added in v2.2.0 

func (r *GetRelationshipsMetadata) TotalRelationships() int

TotalRelationships returns the TotalRelationships field value, or zero value if nil.

type GetRelationshipsParams 

type GetRelationshipsParams = generated.GetRelationshipsParams

type GetRelationshipsRelationshipsItem added in v2.2.0 

type GetRelationshipsRelationshipsItem struct {
	*generated.GetRelationshipsRelationshipsItem
}

GetRelationshipsRelationshipsItem wraps GetRelationshipsRelationshipsItem with convenience methods.

func (*GetRelationshipsRelationshipsItem) ChildTableId added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem) ChildTableId() string

ChildTableId returns the ChildTableId field value.

func (*GetRelationshipsRelationshipsItem) ForeignKeyField added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem) ForeignKeyField() *GetRelationshipsRelationshipsItem_ForeignKeyField

ForeignKeyField returns the ForeignKeyField field as a wrapped type, or nil if not set.

func (*GetRelationshipsRelationshipsItem) Id added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem) Id() int

Id returns the Id field value.

func (*GetRelationshipsRelationshipsItem) IsCrossApp added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem) IsCrossApp() bool

IsCrossApp returns the IsCrossApp field value.

func (*GetRelationshipsRelationshipsItem) LookupFields added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem) LookupFields() []*GetRelationshipsRelationshipsItem_LookupFields_Item

LookupFields returns the LookupFields field as wrapped types, or nil if not set.

func (*GetRelationshipsRelationshipsItem) ParentTableId added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem) ParentTableId() string

ParentTableId returns the ParentTableId field value.

func (*GetRelationshipsRelationshipsItem) SummaryFields added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem) SummaryFields() []*GetRelationshipsRelationshipsItem_SummaryFields_Item

SummaryFields returns the SummaryFields field as wrapped types, or nil if not set.

type GetRelationshipsRelationshipsItem_ForeignKeyField added in v2.2.0 

type GetRelationshipsRelationshipsItem_ForeignKeyField struct {
	*generated.GetRelationshipsRelationshipsItem_ForeignKeyField
}

GetRelationshipsRelationshipsItem_ForeignKeyField wraps GetRelationshipsRelationshipsItem_ForeignKeyField with convenience methods.

func (*GetRelationshipsRelationshipsItem_ForeignKeyField) Id added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem_ForeignKeyField) Id() int

Id returns the Id field value, or zero value if nil.

func (*GetRelationshipsRelationshipsItem_ForeignKeyField) Label added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem_ForeignKeyField) Label() string

Label returns the Label field value, or zero value if nil.

func (*GetRelationshipsRelationshipsItem_ForeignKeyField) Type added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem_ForeignKeyField) Type() string

Type returns the Type field value, or zero value if nil.

type GetRelationshipsRelationshipsItem_LookupFields_Item added in v2.2.0 

type GetRelationshipsRelationshipsItem_LookupFields_Item struct {
	*generated.GetRelationshipsRelationshipsItem_LookupFields_Item
}

GetRelationshipsRelationshipsItem_LookupFields_Item wraps GetRelationshipsRelationshipsItem_LookupFields_Item with convenience methods.

func (*GetRelationshipsRelationshipsItem_LookupFields_Item) Id added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem_LookupFields_Item) Id() int

Id returns the Id field value, or zero value if nil.

func (*GetRelationshipsRelationshipsItem_LookupFields_Item) Label added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem_LookupFields_Item) Label() string

Label returns the Label field value, or zero value if nil.

func (*GetRelationshipsRelationshipsItem_LookupFields_Item) Type added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem_LookupFields_Item) Type() string

Type returns the Type field value, or zero value if nil.

type GetRelationshipsRelationshipsItem_SummaryFields_Item added in v2.2.0 

type GetRelationshipsRelationshipsItem_SummaryFields_Item struct {
	*generated.GetRelationshipsRelationshipsItem_SummaryFields_Item
}

GetRelationshipsRelationshipsItem_SummaryFields_Item wraps GetRelationshipsRelationshipsItem_SummaryFields_Item with convenience methods.

func (*GetRelationshipsRelationshipsItem_SummaryFields_Item) Id added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem_SummaryFields_Item) Id() int

Id returns the Id field value, or zero value if nil.

func (*GetRelationshipsRelationshipsItem_SummaryFields_Item) Label added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem_SummaryFields_Item) Label() string

Label returns the Label field value, or zero value if nil.

func (*GetRelationshipsRelationshipsItem_SummaryFields_Item) Type added in v2.2.0 

func (r *GetRelationshipsRelationshipsItem_SummaryFields_Item) Type() string

Type returns the Type field value, or zero value if nil.

type GetRelationshipsResponse 

type GetRelationshipsResponse = generated.GetRelationshipsResponse

type GetReportBuilder 

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

GetReportBuilder provides a fluent API for the getReport operation. Get a report

func (*GetReportBuilder) Run 

func (b *GetReportBuilder) Run(ctx context.Context) (*ReportResult, error)

Run executes the getReport request and returns the response data directly.

type GetReportParams 

type GetReportParams = generated.GetReportParams

type GetReportQuery added in v2.2.0 

type GetReportQuery struct {
	*generated.GetReportQuery
}

GetReportQuery wraps GetReportQuery with convenience methods.

func (*GetReportQuery) Filter added in v2.2.0 

func (r *GetReportQuery) Filter() string

Filter returns the Filter field value, or zero value if nil.

func (*GetReportQuery) FormulaFields added in v2.2.0 

func (r *GetReportQuery) FormulaFields() []*GetReportQuery_FormulaFields_Item

FormulaFields returns the FormulaFields field as wrapped types, or nil if not set.

func (*GetReportQuery) TableId added in v2.2.0 

func (r *GetReportQuery) TableId() string

TableId returns the TableId field value, or zero value if nil.

type GetReportQuery_FormulaFields_Item added in v2.2.0 

type GetReportQuery_FormulaFields_Item struct {
	*generated.GetReportQuery_FormulaFields_Item
}

GetReportQuery_FormulaFields_Item wraps GetReportQuery_FormulaFields_Item with convenience methods.

func (*GetReportQuery_FormulaFields_Item) DecimalPrecision added in v2.2.0 

func (r *GetReportQuery_FormulaFields_Item) DecimalPrecision() int

DecimalPrecision returns the DecimalPrecision field value, or zero value if nil.

func (*GetReportQuery_FormulaFields_Item) FieldType added in v2.2.0 

func (r *GetReportQuery_FormulaFields_Item) FieldType() string

FieldType returns the FieldType field value as a string, or empty string if nil.

func (*GetReportQuery_FormulaFields_Item) Formula added in v2.2.0 

func (r *GetReportQuery_FormulaFields_Item) Formula() string

Formula returns the Formula field value, or zero value if nil.

func (*GetReportQuery_FormulaFields_Item) Id added in v2.2.0 

func (r *GetReportQuery_FormulaFields_Item) Id() int

Id returns the Id field value, or zero value if nil.

func (*GetReportQuery_FormulaFields_Item) Label added in v2.2.0 

func (r *GetReportQuery_FormulaFields_Item) Label() string

Label returns the Label field value, or zero value if nil.

type GetReportResponse 

type GetReportResponse = generated.GetReportResponse

type GetRolesBuilder 

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

GetRolesBuilder provides a fluent API for the getRoles operation. Get app roles

func (*GetRolesBuilder) Run 

func (b *GetRolesBuilder) Run(ctx context.Context) ([]*RolesItem, error)

Run executes the getRoles request and returns the response data directly.

type GetRolesItemAccess added in v2.2.0 

type GetRolesItemAccess struct {
	*generated.GetRolesItemAccess
}

GetRolesItemAccess wraps GetRolesItemAccess with convenience methods.

func (*GetRolesItemAccess) Id added in v2.2.0 

func (r *GetRolesItemAccess) Id() int

Id returns the Id field value, or zero value if nil.

func (*GetRolesItemAccess) Type added in v2.2.0 

func (r *GetRolesItemAccess) Type() string

Type returns the Type field value as a string, or empty string if nil.

type GetSolutionPublicBuilder 

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

GetSolutionPublicBuilder provides a fluent API for the getSolutionPublic operation. Get solution information

func (*GetSolutionPublicBuilder) Run 

func (b *GetSolutionPublicBuilder) Run(ctx context.Context) (*generated.GetSolutionPublicResponse, error)

Run executes the getSolutionPublic request and returns the response data directly.

type GetTableBuilder 

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

GetTableBuilder provides a fluent API for the getTable operation. Get a table

func (*GetTableBuilder) AppId 

func (b *GetTableBuilder) AppId(value string) *GetTableBuilder

AppId The unique identifier of an app

func (*GetTableBuilder) Run 

func (b *GetTableBuilder) Run(ctx context.Context) (*TableResult, error)

Run executes the getTable request and returns the response data directly.

type GetTableParams 

type GetTableParams = generated.GetTableParams

type GetTableReportsBuilder 

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

GetTableReportsBuilder provides a fluent API for the getTableReports operation. Get reports for a table

func (*GetTableReportsBuilder) Run 

func (b *GetTableReportsBuilder) Run(ctx context.Context) ([]*TableReportsItem, error)

Run executes the getTableReports request and returns the response data directly.

type GetTableReportsItemQuery added in v2.2.0 

type GetTableReportsItemQuery struct {
	*generated.GetTableReportsItemQuery
}

GetTableReportsItemQuery wraps GetTableReportsItemQuery with convenience methods.

func (*GetTableReportsItemQuery) Filter added in v2.2.0 

func (r *GetTableReportsItemQuery) Filter() string

Filter returns the Filter field value, or zero value if nil.

func (*GetTableReportsItemQuery) FormulaFields added in v2.2.0 

func (r *GetTableReportsItemQuery) FormulaFields() []*GetTableReportsItemQuery_FormulaFields_Item

FormulaFields returns the FormulaFields field as wrapped types, or nil if not set.

func (*GetTableReportsItemQuery) TableId added in v2.2.0 

func (r *GetTableReportsItemQuery) TableId() string

TableId returns the TableId field value, or zero value if nil.

type GetTableReportsItemQuery_FormulaFields_Item added in v2.2.0 

type GetTableReportsItemQuery_FormulaFields_Item struct {
	*generated.GetTableReportsItemQuery_FormulaFields_Item
}

GetTableReportsItemQuery_FormulaFields_Item wraps GetTableReportsItemQuery_FormulaFields_Item with convenience methods.

func (*GetTableReportsItemQuery_FormulaFields_Item) DecimalPrecision added in v2.2.0 

func (r *GetTableReportsItemQuery_FormulaFields_Item) DecimalPrecision() int

DecimalPrecision returns the DecimalPrecision field value, or zero value if nil.

func (*GetTableReportsItemQuery_FormulaFields_Item) FieldType added in v2.2.0 

func (r *GetTableReportsItemQuery_FormulaFields_Item) FieldType() string

FieldType returns the FieldType field value as a string, or empty string if nil.

func (*GetTableReportsItemQuery_FormulaFields_Item) Formula added in v2.2.0 

func (r *GetTableReportsItemQuery_FormulaFields_Item) Formula() string

Formula returns the Formula field value, or zero value if nil.

func (*GetTableReportsItemQuery_FormulaFields_Item) Id added in v2.2.0 

func (r *GetTableReportsItemQuery_FormulaFields_Item) Id() int

Id returns the Id field value, or zero value if nil.

func (*GetTableReportsItemQuery_FormulaFields_Item) Label added in v2.2.0 

func (r *GetTableReportsItemQuery_FormulaFields_Item) Label() string

Label returns the Label field value, or zero value if nil.

type GetTableReportsParams 

type GetTableReportsParams = generated.GetTableReportsParams

type GetTableReportsResponse 

type GetTableReportsResponse = generated.GetTableReportsResponse

type GetTableResponse 

type GetTableResponse = generated.GetTableResponse

type GetTempTokenDBIDBuilder 

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

GetTempTokenDBIDBuilder provides a fluent API for the getTempTokenDBID operation. Get a temporary token for a dbid

func (*GetTempTokenDBIDBuilder) Run 

func (b *GetTempTokenDBIDBuilder) Run(ctx context.Context) (*TempTokenDBIDResult, error)

Run executes the getTempTokenDBID request and returns the response data directly.

type GetTempTokenDBIDParams 

type GetTempTokenDBIDParams = generated.GetTempTokenDBIDParams

type GetTempTokenDBIDResponse 

type GetTempTokenDBIDResponse = generated.GetTempTokenDBIDResponse

type GetTrusteesBuilder 

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

GetTrusteesBuilder provides a fluent API for the getTrustees operation. Get trustees for an app

func (*GetTrusteesBuilder) Run 

func (b *GetTrusteesBuilder) Run(ctx context.Context) (*generated.GetTrusteesResponse, error)

Run executes the getTrustees request and returns the response data directly.

type GetUsersBuilder 

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

GetUsersBuilder provides a fluent API for the getUsers operation. Get users

func (*GetUsersBuilder) AccountId 

func (b *GetUsersBuilder) AccountId(value float32) *GetUsersBuilder

AccountId The account id being used to get users. If no value is specified, the first account associated with the requesting user token is chosen.

func (*GetUsersBuilder) AppIds 

func (b *GetUsersBuilder) AppIds(values ...string) *GetUsersBuilder

AppIds When provided, the returned users will be narrowed down only to the users assigned to the app id's provided in this list. The provided app id's should belong to the same account.

func (*GetUsersBuilder) Emails 

func (b *GetUsersBuilder) Emails(values ...string) *GetUsersBuilder

Emails When provided, the returned users will be narrowed down only to the users included in this list.

func (*GetUsersBuilder) NextPageToken 

func (b *GetUsersBuilder) NextPageToken(value string) *GetUsersBuilder

NextPageToken Next page token used to get the next 'page' of results when available. When this field is empty, the first page is returned.

func (*GetUsersBuilder) Run 

func (b *GetUsersBuilder) Run(ctx context.Context) (*UsersResult, error)

Run executes the getUsers request and returns the response data directly.

type GetUsersJSONRequestBody 

type GetUsersJSONRequestBody = generated.GetUsersJSONRequestBody

type GetUsersMetadata added in v2.2.0 

type GetUsersMetadata struct {
	*generated.GetUsersMetadata
}

GetUsersMetadata wraps GetUsersMetadata with convenience methods.

func (*GetUsersMetadata) NextPageToken added in v2.2.0 

func (r *GetUsersMetadata) NextPageToken() string

NextPageToken returns the NextPageToken field value.

type GetUsersParams 

type GetUsersParams = generated.GetUsersParams

type GetUsersResponse 

type GetUsersResponse = generated.GetUsersResponse

type NoOpThrottle 

type NoOpThrottle struct{}

NoOpThrottle is a throttle that does nothing.

This is the default throttle used when proactive throttling is not enabled. The SDK will still handle 429 responses from the server with automatic retry.

func NewNoOpThrottle 

func NewNoOpThrottle() *NoOpThrottle

NewNoOpThrottle creates a no-op throttle that allows all requests immediately.

func (*NoOpThrottle) Acquire 

func (t *NoOpThrottle) Acquire(ctx context.Context) error

Acquire does nothing and returns immediately.

func (*NoOpThrottle) GetRemaining 

func (t *NoOpThrottle) GetRemaining() int

GetRemaining always returns a large number.

func (*NoOpThrottle) GetWindowCount 

func (t *NoOpThrottle) GetWindowCount() int

GetWindowCount always returns 0.

func (*NoOpThrottle) Reset 

func (t *NoOpThrottle) Reset()

Reset does nothing.

type Option 

type Option func(*Client)

Option configures a Client.

func WithAppToken 

func WithAppToken(token string) Option

WithAppToken sets an application token for XML API calls.

App tokens are only needed for the XML API when:

  • The app has "Require Application Tokens" enabled, AND
  • You're NOT using user token authentication (which bypasses app token checks)

Common scenarios requiring app tokens:

  • Using ticket auth (WithTicketAuth) with XML API methods
  • Using temp tokens (WithTempTokens) with XML API methods

The JSON API does not use app tokens - user tokens and temp tokens provide sufficient authentication. This option only affects XML API calls made via the xml sub-package.

Example: 

client, _ := quickbase.New("myrealm",
    quickbase.WithTicketAuth("user@example.com", "password"),
    quickbase.WithAppToken("your-app-token"),
)

// XML API calls will include the app token
xmlClient := xml.New(client)
roles, _ := xmlClient.GetRoleInfo(ctx, appId)

func WithBackoffMultiplier 

func WithBackoffMultiplier(m float64) Option

WithBackoffMultiplier sets the exponential backoff multiplier (default 2).

func WithBaseURL 

func WithBaseURL(url string) Option

WithBaseURL sets a custom base URL (default https://api.quickbase.com/v1).

func WithConvertDates 

func WithConvertDates(enabled bool) Option

WithConvertDates enables/disables automatic ISO date string conversion (default true).

func WithDebug 

func WithDebug(enabled bool) Option

WithDebug enables debug logging.

func WithIdleConnTimeout 

func WithIdleConnTimeout(d time.Duration) Option

WithIdleConnTimeout sets how long idle connections stay in the pool (default 90s).

func WithMaxIdleConns 

func WithMaxIdleConns(n int) Option

WithMaxIdleConns sets the maximum number of idle connections across all hosts (default 100). This controls total connection pool size.

func WithMaxIdleConnsPerHost 

func WithMaxIdleConnsPerHost(n int) Option

WithMaxIdleConnsPerHost sets maximum idle connections per host (default 6). The default of 6 matches browser standards and handles typical concurrency. For heavy batch operations, consider 10-20 alongside WithProactiveThrottle.

func WithMaxRetries 

func WithMaxRetries(n int) Option

WithMaxRetries sets the maximum number of retry attempts (default 3).

func WithMaxRetryDelay 

func WithMaxRetryDelay(d time.Duration) Option

WithMaxRetryDelay sets the maximum delay between retries (default 30s).

func WithOnRateLimit 

func WithOnRateLimit(callback func(core.RateLimitInfo)) Option

WithOnRateLimit sets a callback for rate limit events.

func WithOnRequest 

func WithOnRequest(callback func(RequestInfo)) Option

WithOnRequest sets a callback that fires after every API request completes. Use this for monitoring request latency, status codes, and errors.

Example: 

quickbase.WithOnRequest(func(info quickbase.RequestInfo) {
    log.Printf("%s %s → %d (%v)", info.Method, info.Path, info.StatusCode, info.Duration)
})

func WithOnRetry 

func WithOnRetry(callback func(RetryInfo)) Option

WithOnRetry sets a callback that fires before each retry attempt. Use this for monitoring retry behavior and debugging transient failures.

Example: 

quickbase.WithOnRetry(func(info quickbase.RetryInfo) {
    log.Printf("Retrying %s %s (attempt %d, reason: %s)", info.Method, info.Path, info.Attempt, info.Reason)
})

func WithProactiveThrottle 

func WithProactiveThrottle(requestsPer10Seconds int) Option

WithProactiveThrottle enables sliding window throttling (100 req/10s by default).

func WithReadOnly 

func WithReadOnly() Option

WithReadOnly enables read-only mode, blocking all write operations.

When enabled, any attempt to make a write request (POST, PUT, DELETE, PATCH for JSON API, or write actions for XML API) returns a core.ReadOnlyError.

This is useful for data extraction tools, reporting systems, or any context where you want to ensure the client can only read data, never modify it.

Example: 

client, _ := quickbase.New(realm,
    quickbase.WithUserToken(token),
    quickbase.WithReadOnly(),
)

// These work:
app, _ := client.GetApp(appId).Run(ctx)
fields, _ := client.GetFields(tableId).Run(ctx)

// These fail with ReadOnlyError:
_, err := client.Upsert(tableId).Data(records).Run(ctx)
// err = &core.ReadOnlyError{Method: "POST", Path: "/v1/records"}

func WithRetryDelay 

func WithRetryDelay(d time.Duration) Option

WithRetryDelay sets the initial delay between retries (default 1s).

func WithSchema 

func WithSchema(schema *core.Schema) Option

WithSchema sets the schema for table and field aliases. When configured, the client automatically:

  • Transforms table aliases to IDs in requests (from, to fields)
  • Transforms field aliases to IDs in requests (select, sortBy, groupBy, where, data)
  • Transforms field IDs to aliases in responses (unless disabled via WithSchemaOptions)
  • Unwraps { value: X } to just X in response records

func WithSchemaOptions 

func WithSchemaOptions(schema *core.Schema, opts core.SchemaOptions) Option

WithSchemaOptions sets the schema with custom options. Use this to control schema behavior, such as disabling response transformation.

Example: 

quickbase.WithSchemaOptions(schema, core.SchemaOptions{
    TransformResponses: false, // Keep field IDs in responses
})

func WithThrottle 

func WithThrottle(t Throttle) Option

WithThrottle sets a custom throttle.

func WithTimeout 

func WithTimeout(d time.Duration) Option

WithTimeout sets the request timeout (default 30s).

type PageFetcher 

type PageFetcher[T any, R PaginatedResponse[T]] func(ctx context.Context, skip int, nextToken string) (R, error)

PageFetcher is a function that fetches a page of results. For skip-based: pass skip value For token-based: pass nextPageToken

type PaginatedRequest 

type PaginatedRequest[T any, R PaginatedResponse[T]] struct {
	// contains filtered or unexported fields
}

PaginatedRequest wraps an API request with fluent pagination methods. This provides a similar API to the JavaScript SDK's PaginatedRequest class.

func NewPaginatedRequest 

func NewPaginatedRequest[T any, R PaginatedResponse[T]](
	ctx context.Context,
	fetcher PageFetcher[T, R],
	autoPaginate bool,
) *PaginatedRequest[T, R]

NewPaginatedRequest creates a new paginated request wrapper.

func (*PaginatedRequest[T, R]) All 

func (r *PaginatedRequest[T, R]) All() (R, error)

All fetches all pages and combines results into a single response.

func (*PaginatedRequest[T, R]) Execute 

func (r *PaginatedRequest[T, R]) Execute() (R, error)

Execute runs the request with default pagination behavior. If autoPaginate is enabled globally, this behaves like All(). Otherwise, it fetches only the first page.

func (*PaginatedRequest[T, R]) Iterator 

func (r *PaginatedRequest[T, R]) Iterator() iter.Seq2[T, error]

Iterator returns an iterator over all records across pages.

func (*PaginatedRequest[T, R]) NoPaginate 

func (r *PaginatedRequest[T, R]) NoPaginate() (R, error)

NoPaginate explicitly fetches only a single page (no automatic pagination).

func (*PaginatedRequest[T, R]) Paginate 

func (r *PaginatedRequest[T, R]) Paginate(opts PaginationOptions) (R, error)

Paginate fetches pages with optional limit and skip.

type PaginatedResponse 

type PaginatedResponse[T any] interface {
	GetData() []T
	GetMetadata() PaginationMetadata
}

PaginatedResponse represents a response that may have more pages.

type PaginationMetadata 

type PaginationMetadata struct {
	TotalRecords  *int
	NumRecords    *int
	Skip          *int
	NextPageToken *string
	NextToken     *string
}

PaginationMetadata contains pagination information from the response.

type PaginationOptions 

type PaginationOptions struct {
	// Limit is the maximum number of records to fetch across all pages.
	// Zero means no limit.
	Limit int
	// Skip is the starting offset for skip-based pagination.
	Skip int
}

PaginationOptions controls automatic pagination behavior.

type PaginationType 

type PaginationType string

PaginationType indicates the type of pagination a response uses. 

const (
	PaginationTypeSkip  PaginationType = "skip"
	PaginationTypeToken PaginationType = "token"
	PaginationTypeNone  PaginationType = "none"
)

func DetectPaginationType 

func DetectPaginationType(metadata PaginationMetadata) PaginationType

DetectPaginationType determines the pagination type from metadata.

type PlatformAnalyticEventSummariesBuilder 

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

PlatformAnalyticEventSummariesBuilder provides a fluent API for the platformAnalyticEventSummaries operation. Get event summaries

func (*PlatformAnalyticEventSummariesBuilder) AccountId 

func (b *PlatformAnalyticEventSummariesBuilder) AccountId(value float32) *PlatformAnalyticEventSummariesBuilder

AccountId The ID of the account to query. If no value is specified, the first account matching the provided domain is chosen.

func (*PlatformAnalyticEventSummariesBuilder) End 

func (b *PlatformAnalyticEventSummariesBuilder) End(value string) *PlatformAnalyticEventSummariesBuilder

End The end date and time of the requested summaries in ISO 8601 time format.

func (*PlatformAnalyticEventSummariesBuilder) GroupBy 

func (b *PlatformAnalyticEventSummariesBuilder) GroupBy(value string) *PlatformAnalyticEventSummariesBuilder

GroupBy How the events should be grouped.

func (*PlatformAnalyticEventSummariesBuilder) NextToken 

func (b *PlatformAnalyticEventSummariesBuilder) NextToken(value string) *PlatformAnalyticEventSummariesBuilder

NextToken A pagination token from a previous response made using the same parameters. Used to fetch the next page.

func (*PlatformAnalyticEventSummariesBuilder) Run 

func (b *PlatformAnalyticEventSummariesBuilder) Run(ctx context.Context) (*PlatformAnalyticEventSummariesResult, error)

Run executes the platformAnalyticEventSummaries request and returns the response data directly.

func (*PlatformAnalyticEventSummariesBuilder) Start 

func (b *PlatformAnalyticEventSummariesBuilder) Start(value string) *PlatformAnalyticEventSummariesBuilder

Start The start date and time of the requested summaries in ISO 8601 time format.

func (*PlatformAnalyticEventSummariesBuilder) Where 

func (b *PlatformAnalyticEventSummariesBuilder) Where(values ...map[string]any) *PlatformAnalyticEventSummariesBuilder

Where A list of items to filter events by. Only events which match ALL criteria will be included in the results.

type PlatformAnalyticEventSummariesData added in v2.2.0 

type PlatformAnalyticEventSummariesData struct {
	*generated.PlatformAnalyticEventSummariesData
}

PlatformAnalyticEventSummariesData wraps PlatformAnalyticEventSummariesData with convenience methods.

type PlatformAnalyticEventSummariesJSONRequestBody 

type PlatformAnalyticEventSummariesJSONRequestBody = generated.PlatformAnalyticEventSummariesJSONRequestBody

type PlatformAnalyticEventSummariesParams 

type PlatformAnalyticEventSummariesParams = generated.PlatformAnalyticEventSummariesParams

type PlatformAnalyticEventSummariesResponse 

type PlatformAnalyticEventSummariesResponse = generated.PlatformAnalyticEventSummariesResponse

type PlatformAnalyticEventSummariesResult 

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

PlatformAnalyticEventSummariesResult wraps PlatformAnalyticEventSummariesResponse with convenience methods.

func (*PlatformAnalyticEventSummariesResult) Raw added in v2.1.0 

func (r *PlatformAnalyticEventSummariesResult) Raw() *generated.PlatformAnalyticEventSummariesResponse

Raw returns the underlying generated response.

type PlatformAnalyticReadsBuilder 

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

PlatformAnalyticReadsBuilder provides a fluent API for the platformAnalyticReads operation. Get read summaries

func (*PlatformAnalyticReadsBuilder) Day 

func (b *PlatformAnalyticReadsBuilder) Day(value types.Date) *PlatformAnalyticReadsBuilder

Day The date for which read summaries need to be fetched. This must be date-time only, as YYYY-MM-DD, and a valid date in the past.

func (*PlatformAnalyticReadsBuilder) Run 

func (b *PlatformAnalyticReadsBuilder) Run(ctx context.Context) (*PlatformAnalyticReadsResult, error)

Run executes the platformAnalyticReads request and returns the response data directly.

type PlatformAnalyticReadsData 

type PlatformAnalyticReadsData struct {
	*generated.PlatformAnalyticReadsData
}

PlatformAnalyticReadsData wraps PlatformAnalyticReadsData with convenience methods.

type PlatformAnalyticReadsData_DailyDetailedReads added in v2.2.0 

type PlatformAnalyticReadsData_DailyDetailedReads struct {
	*generated.PlatformAnalyticReadsData_DailyDetailedReads
}

PlatformAnalyticReadsData_DailyDetailedReads wraps PlatformAnalyticReadsData_DailyDetailedReads with convenience methods.

type PlatformAnalyticReadsData_DailyDetailedReads_Reads added in v2.2.0 

type PlatformAnalyticReadsData_DailyDetailedReads_Reads struct {
	*generated.PlatformAnalyticReadsData_DailyDetailedReads_Reads
}

PlatformAnalyticReadsData_DailyDetailedReads_Reads wraps PlatformAnalyticReadsData_DailyDetailedReads_Reads with convenience methods.

func (*PlatformAnalyticReadsData_DailyDetailedReads_Reads) User added in v2.2.0 

func (r *PlatformAnalyticReadsData_DailyDetailedReads_Reads) User() int

User returns the User field value.

type PlatformAnalyticReadsData_DailyDetailedReads_Reads_Integrations added in v2.2.0 

type PlatformAnalyticReadsData_DailyDetailedReads_Reads_Integrations struct {
	*generated.PlatformAnalyticReadsData_DailyDetailedReads_Reads_Integrations
}

PlatformAnalyticReadsData_DailyDetailedReads_Reads_Integrations wraps PlatformAnalyticReadsData_DailyDetailedReads_Reads_Integrations with convenience methods.

func (*PlatformAnalyticReadsData_DailyDetailedReads_Reads_Integrations) Api added in v2.2.0 

func (r *PlatformAnalyticReadsData_DailyDetailedReads_Reads_Integrations) Api() int

Api returns the Api field value.

func (*PlatformAnalyticReadsData_DailyDetailedReads_Reads_Integrations) Eoti added in v2.2.0 

func (r *PlatformAnalyticReadsData_DailyDetailedReads_Reads_Integrations) Eoti() int

Eoti returns the Eoti field value.

func (*PlatformAnalyticReadsData_DailyDetailedReads_Reads_Integrations) Pipelines added in v2.2.0 

func (r *PlatformAnalyticReadsData_DailyDetailedReads_Reads_Integrations) Pipelines() int

Pipelines returns the Pipelines field value.

type PlatformAnalyticReadsParams 

type PlatformAnalyticReadsParams = generated.PlatformAnalyticReadsParams

type PlatformAnalyticReadsResponse 

type PlatformAnalyticReadsResponse = generated.PlatformAnalyticReadsResponse

type PlatformAnalyticReadsResult 

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

PlatformAnalyticReadsResult wraps PlatformAnalyticReadsResponse with convenience methods.

func (*PlatformAnalyticReadsResult) Raw added in v2.1.0 

func (r *PlatformAnalyticReadsResult) Raw() *generated.PlatformAnalyticReadsResponse

Raw returns the underlying generated response.

type QueryBuilder 

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

QueryBuilder provides a fluent API for building and executing RunQuery requests. It simplifies query construction by eliminating repetitive table parameter passing and providing schema-aware field resolution.

Example: 

result, err := client.Query("projects").
    Select("name", "status", "dueDate").
    Where("{'status'.EX.'Active'}").
    SortBy(quickbase.Asc("name"), quickbase.Desc("dueDate")).
    Options(100, 0).
    Run(ctx)

func (*QueryBuilder) GroupBy 

func (b *QueryBuilder) GroupBy(fields ...any) *QueryBuilder

GroupBy sets the fields to group by. Accepts field IDs (int) or aliases (string).

Example: 

GroupBy("status")               // Field alias
GroupBy(7)                      // Field ID
GroupBy("status", "assignee")   // Multiple fields

func (*QueryBuilder) Options 

func (b *QueryBuilder) Options(top, skip int) *QueryBuilder

Options sets pagination options: top (max records) and skip (offset).

Example: 

Options(100, 0)     // First 100 records
Options(50, 100)    // Records 101-150

func (*QueryBuilder) Run 

func (b *QueryBuilder) Run(ctx context.Context) ([]Record, error)

Run executes the query and returns all records as unwrapped maps. This is a convenience method that auto-unwraps records since you're opting into the Query builder's fluent API. For raw generated types, use RunRaw().

func (*QueryBuilder) RunN 

func (b *QueryBuilder) RunN(ctx context.Context, n int) ([]Record, error)

RunN executes the query and returns up to n records as unwrapped maps. This is a convenience method that auto-unwraps records.

func (*QueryBuilder) RunRaw 

func (b *QueryBuilder) RunRaw(ctx context.Context) (*RunQueryResult, error)

RunRaw executes the query and returns the result with convenience methods. Use this when you need access to the full response including metadata.

func (*QueryBuilder) Select 

func (b *QueryBuilder) Select(fields ...any) *QueryBuilder

Select specifies the fields to return. Accepts field IDs (int) or aliases (string). When schema is configured, string aliases are resolved to field IDs.

Example: 

Select("name", "status")        // Field aliases (requires schema)
Select(6, 7)                    // Field IDs (works without schema)
Select("name", 6, "status")     // Mixed (aliases require schema)

func (*QueryBuilder) Skip 

func (b *QueryBuilder) Skip(n int) *QueryBuilder

Skip sets the number of records to skip (offset).

func (*QueryBuilder) SortBy 

func (b *QueryBuilder) SortBy(sorts ...SortSpec) *QueryBuilder

SortBy sets the sort order for results. Use Asc() and Desc() helpers.

Example: 

SortBy(quickbase.Asc("name"))
SortBy(quickbase.Asc("name"), quickbase.Desc("dueDate"))
SortBy(quickbase.Asc(6), quickbase.Desc(7))

func (*QueryBuilder) Top 

func (b *QueryBuilder) Top(n int) *QueryBuilder

Top sets the maximum number of records to return.

func (*QueryBuilder) Where 

func (b *QueryBuilder) Where(query string) *QueryBuilder

Where sets the filter query string. Field aliases in the where clause are automatically resolved if schema is configured.

Example: 

Where("{'status'.EX.'Active'}")           // Using field alias
Where("{7.EX.'Active'}")                  // Using field ID
Where("{status.EX.'Active'} AND {dueDate.LT.'2024-01-01'}")

type Record 

type Record = map[string]any

Record is a friendly type alias for query result records. Field keys are either field IDs (as strings like "6") or aliases (if schema is configured). Values are unwrapped from FieldValue wrappers to their actual Go types.

func UnwrapRecord 

func UnwrapRecord(record generated.QuickbaseRecord) Record

UnwrapRecord converts a single QuickbaseRecord to map[string]any.

func UnwrapRecords 

func UnwrapRecords(records []generated.QuickbaseRecord) []Record

UnwrapRecords converts QuickbaseRecord slices to []map[string]any. This is an opt-in helper for when you want friendlier access to record data. The raw QuickbaseRecord wraps each field value in a FieldValue struct; this function extracts the actual values.

Example: 

resp, _ := client.RunQuery(ctx, body)
if resp.JSON200.Data != nil {
    records := quickbase.UnwrapRecords(*resp.JSON200.Data)
    for _, rec := range records {
        name := rec["6"] // access by field ID
    }
}

type RecordsModifiedSinceBuilder 

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

RecordsModifiedSinceBuilder provides a fluent API for the recordsModifiedSince operation. Get records modified since

func (*RecordsModifiedSinceBuilder) After 

func (b *RecordsModifiedSinceBuilder) After(value string) *RecordsModifiedSinceBuilder

After A timestamp, formatted in ISO-8601 UTC, representing the date and time to search.

func (*RecordsModifiedSinceBuilder) FieldList 

func (b *RecordsModifiedSinceBuilder) FieldList(values ...int) *RecordsModifiedSinceBuilder

FieldList List of field IDs. Each field is crawled across the entire record dependency graph to find its source record's date modified. If one is not provided, only the current table will be referenced.

func (*RecordsModifiedSinceBuilder) From 

func (b *RecordsModifiedSinceBuilder) From(value string) *RecordsModifiedSinceBuilder

From The table identifier.

func (*RecordsModifiedSinceBuilder) IncludeDetails 

func (b *RecordsModifiedSinceBuilder) IncludeDetails(value bool) *RecordsModifiedSinceBuilder

IncludeDetails When true, the individual record IDs and timestamps will be returned. If false, only the count of changes will be returned.

func (*RecordsModifiedSinceBuilder) Run 

func (b *RecordsModifiedSinceBuilder) Run(ctx context.Context) (*RecordsModifiedSinceResult, error)

Run executes the recordsModifiedSince request and returns the response data directly.

type RecordsModifiedSinceResult 

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

RecordsModifiedSinceResult wraps RecordsModifiedSinceResponse with convenience methods.

func (*RecordsModifiedSinceResult) Count 

func (r *RecordsModifiedSinceResult) Count() int

Count returns the Count field value.

func (*RecordsModifiedSinceResult) DeletesTruncated 

func (r *RecordsModifiedSinceResult) DeletesTruncated() bool

DeletesTruncated returns the DeletesTruncated field value, or zero value if nil.

func (*RecordsModifiedSinceResult) Raw added in v2.1.0 

func (r *RecordsModifiedSinceResult) Raw() *generated.RecordsModifiedSinceResponse

Raw returns the underlying generated response.

type RelationshipsResult 

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

RelationshipsResult wraps GetRelationshipsResponse with convenience methods.

func (*RelationshipsResult) Metadata 

func (r *RelationshipsResult) Metadata() *GetRelationshipsMetadata

Metadata returns the Metadata field as a wrapped type, or nil if not set.

func (*RelationshipsResult) Raw added in v2.1.0 

func (r *RelationshipsResult) Raw() *generated.GetRelationshipsResponse

Raw returns the underlying generated response.

func (*RelationshipsResult) Relationships 

func (r *RelationshipsResult) Relationships() []*GetRelationshipsRelationshipsItem

Relationships returns the Relationships field as wrapped types, or nil if not set.

type RemoveManagersFromGroupBuilder 

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

RemoveManagersFromGroupBuilder provides a fluent API for the removeManagersFromGroup operation. Remove managers

func (*RemoveManagersFromGroupBuilder) Run 

func (b *RemoveManagersFromGroupBuilder) Run(ctx context.Context) (*RemoveManagersFromGroupResult, error)

Run executes the removeManagersFromGroup request and returns the response data directly.

type RemoveManagersFromGroupJSONRequestBody 

type RemoveManagersFromGroupJSONRequestBody = generated.RemoveManagersFromGroupJSONRequestBody

type RemoveManagersFromGroupResponse 

type RemoveManagersFromGroupResponse = generated.RemoveManagersFromGroupResponse

type RemoveManagersFromGroupResult 

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

RemoveManagersFromGroupResult wraps RemoveManagersFromGroupResponse with convenience methods.

func (*RemoveManagersFromGroupResult) Raw added in v2.1.0 

func (r *RemoveManagersFromGroupResult) Raw() *generated.RemoveManagersFromGroupResponse

Raw returns the underlying generated response.

type RemoveMembersFromGroupBuilder 

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

RemoveMembersFromGroupBuilder provides a fluent API for the removeMembersFromGroup operation. Remove members

func (*RemoveMembersFromGroupBuilder) Run 

func (b *RemoveMembersFromGroupBuilder) Run(ctx context.Context) (*RemoveMembersFromGroupResult, error)

Run executes the removeMembersFromGroup request and returns the response data directly.

type RemoveMembersFromGroupJSONRequestBody 

type RemoveMembersFromGroupJSONRequestBody = generated.RemoveMembersFromGroupJSONRequestBody

type RemoveMembersFromGroupResponse 

type RemoveMembersFromGroupResponse = generated.RemoveMembersFromGroupResponse

type RemoveMembersFromGroupResult 

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

RemoveMembersFromGroupResult wraps RemoveMembersFromGroupResponse with convenience methods.

func (*RemoveMembersFromGroupResult) Raw added in v2.1.0 

func (r *RemoveMembersFromGroupResult) Raw() *generated.RemoveMembersFromGroupResponse

Raw returns the underlying generated response.

type RemoveSubgroupsFromGroupBuilder 

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

RemoveSubgroupsFromGroupBuilder provides a fluent API for the removeSubgroupsFromGroup operation. Remove child groups

func (*RemoveSubgroupsFromGroupBuilder) Run 

func (b *RemoveSubgroupsFromGroupBuilder) Run(ctx context.Context) (*RemoveSubgroupsFromGroupResult, error)

Run executes the removeSubgroupsFromGroup request and returns the response data directly.

type RemoveSubgroupsFromGroupJSONRequestBody 

type RemoveSubgroupsFromGroupJSONRequestBody = generated.RemoveSubgroupsFromGroupJSONRequestBody

type RemoveSubgroupsFromGroupResponse 

type RemoveSubgroupsFromGroupResponse = generated.RemoveSubgroupsFromGroupResponse

type RemoveSubgroupsFromGroupResult 

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

RemoveSubgroupsFromGroupResult wraps RemoveSubgroupsFromGroupResponse with convenience methods.

func (*RemoveSubgroupsFromGroupResult) Raw added in v2.1.0 

func (r *RemoveSubgroupsFromGroupResult) Raw() *generated.RemoveSubgroupsFromGroupResponse

Raw returns the underlying generated response.

type RemoveTrusteesBuilder 

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

RemoveTrusteesBuilder provides a fluent API for the removeTrustees operation. Remove trustees from an app

func (*RemoveTrusteesBuilder) Run 

func (b *RemoveTrusteesBuilder) Run(ctx context.Context) (*RemoveTrusteesResult, error)

Run executes the removeTrustees request and returns the response data directly.

type RemoveTrusteesResult 

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

RemoveTrusteesResult wraps RemoveTrusteesResponse with convenience methods.

func (*RemoveTrusteesResult) Raw added in v2.1.0 

func (r *RemoveTrusteesResult) Raw() *generated.RemoveTrusteesResponse

Raw returns the underlying generated response.

type ReportResult 

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

ReportResult wraps GetReportResponse with convenience methods.

func (*ReportResult) Description 

func (r *ReportResult) Description() string

Description returns the Description field value, or zero value if nil.

func (*ReportResult) Id 

func (r *ReportResult) Id() string

Id returns the Id field value, or zero value if nil.

func (*ReportResult) Name 

func (r *ReportResult) Name() string

Name returns the Name field value, or zero value if nil.

func (*ReportResult) Query 

func (r *ReportResult) Query() *GetReportQuery

Query returns the Query field as a wrapped type, or nil if not set.

func (*ReportResult) Raw added in v2.1.0 

func (r *ReportResult) Raw() *generated.GetReportResponse

Raw returns the underlying generated response.

func (*ReportResult) Type 

func (r *ReportResult) Type() string

Type returns the Type field value, or zero value if nil.

func (*ReportResult) UsedCount 

func (r *ReportResult) UsedCount() int

UsedCount returns the UsedCount field value, or zero value if nil.

func (*ReportResult) UsedLast 

func (r *ReportResult) UsedLast() string

UsedLast returns the UsedLast field value, or zero value if nil.

type RequestInfo 

type RequestInfo struct {
	Method      string        // HTTP method (GET, POST, etc.)
	Path        string        // URL path (e.g., /v1/apps/bqxyz123)
	StatusCode  int           // HTTP status code
	Duration    time.Duration // Total request duration
	Attempt     int           // Attempt number (1 = first try, 2+ = retries)
	Error       error         // Non-nil if request failed
	RequestBody []byte        // Request body bytes (for debugging failed requests)
}

RequestInfo contains information about a completed API request. This is passed to the OnRequest callback after each request completes.

type RetryInfo 

type RetryInfo struct {
	Method   string        // HTTP method
	Path     string        // URL path
	Attempt  int           // Which attempt is about to happen (2 = first retry)
	Reason   string        // Why we're retrying (e.g., "429", "503", "timeout")
	WaitTime time.Duration // How long we'll wait before retrying
}

RetryInfo contains information about a retry attempt. This is passed to the OnRetry callback before each retry.

type RolesItem 

type RolesItem struct {
	*generated.GetRolesItem
}

RolesItem wraps GetRolesItem with convenience methods.

func (*RolesItem) Access 

func (r *RolesItem) Access() *GetRolesItemAccess

Access returns the Access field as a wrapped type, or nil if not set.

func (*RolesItem) Id 

func (r *RolesItem) Id() int

Id returns the Id field value, or zero value if nil.

func (*RolesItem) Name 

func (r *RolesItem) Name() string

Name returns the Name field value, or zero value if nil.

type RolesResult added in v2.1.0 

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

RolesResult wraps GetRolesResponse with convenience methods.

func (*RolesResult) Raw added in v2.1.0 

func (r *RolesResult) Raw() *generated.GetRolesResponse

Raw returns the underlying generated response.

type RunFormulaBuilder 

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

RunFormulaBuilder provides a fluent API for the runFormula operation. Run a formula

func (*RunFormulaBuilder) Formula 

func (b *RunFormulaBuilder) Formula(value string) *RunFormulaBuilder

Formula The formula to run. This must be a valid Quickbase formula.

func (*RunFormulaBuilder) From 

func (b *RunFormulaBuilder) From(value string) *RunFormulaBuilder

From The unique identifier (dbid) of the table.

func (*RunFormulaBuilder) Rid 

func (b *RunFormulaBuilder) Rid(value int) *RunFormulaBuilder

Rid The record ID to run the formula against. Only necessary for formulas that are run in the context of a record. For example, the formula User() does not need a record ID.

func (*RunFormulaBuilder) Run 

func (b *RunFormulaBuilder) Run(ctx context.Context) (*RunFormulaResult, error)

Run executes the runFormula request and returns the response data directly.

type RunFormulaJSONRequestBody 

type RunFormulaJSONRequestBody = generated.RunFormulaJSONRequestBody

type RunFormulaResponse 

type RunFormulaResponse = generated.RunFormulaResponse

type RunFormulaResult 

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

RunFormulaResult wraps RunFormulaResponse with convenience methods.

func (*RunFormulaResult) Raw added in v2.1.0 

func (r *RunFormulaResult) Raw() *generated.RunFormulaResponse

Raw returns the underlying generated response.

func (*RunFormulaResult) Result 

func (r *RunFormulaResult) Result() string

Result returns the Result field value, or zero value if nil.

type RunQueryFieldsItem 

type RunQueryFieldsItem struct {
	*generated.RunQueryFieldsItem
}

RunQueryFieldsItem wraps RunQueryFieldsItem with convenience methods.

func (*RunQueryFieldsItem) Id 

func (r *RunQueryFieldsItem) Id() int

Id returns the Id field value, or zero value if nil.

func (*RunQueryFieldsItem) Label 

func (r *RunQueryFieldsItem) Label() string

Label returns the Label field value, or zero value if nil.

func (*RunQueryFieldsItem) Type 

func (r *RunQueryFieldsItem) Type() string

Type returns the Type field value, or zero value if nil.

type RunQueryMetadata 

type RunQueryMetadata struct {
	*generated.RunQueryMetadata
}

RunQueryMetadata wraps RunQueryMetadata with convenience methods.

func (*RunQueryMetadata) NumFields 

func (r *RunQueryMetadata) NumFields() int

NumFields returns the NumFields field value.

func (*RunQueryMetadata) NumRecords 

func (r *RunQueryMetadata) NumRecords() int

NumRecords returns the NumRecords field value.

func (*RunQueryMetadata) Skip 

func (r *RunQueryMetadata) Skip() int

Skip returns the Skip field value, or zero value if nil.

func (*RunQueryMetadata) Top 

func (r *RunQueryMetadata) Top() int

Top returns the Top field value, or zero value if nil.

func (*RunQueryMetadata) TotalRecords 

func (r *RunQueryMetadata) TotalRecords() int

TotalRecords returns the TotalRecords field value.

type RunQueryResult 

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

RunQueryResult wraps RunQueryResponse with convenience methods.

func (*RunQueryResult) Fields 

func (r *RunQueryResult) Fields() []*RunQueryFieldsItem

Fields returns the Fields field as wrapped types, or nil if not set.

func (*RunQueryResult) Metadata 

func (r *RunQueryResult) Metadata() *RunQueryMetadata

Metadata returns the Metadata field as a wrapped type, or nil if not set.

func (*RunQueryResult) Raw added in v2.1.0 

func (r *RunQueryResult) Raw() *generated.RunQueryResponse

Raw returns the underlying generated response.

func (*RunQueryResult) Records 

func (r *RunQueryResult) Records() []Record

Records returns the record data as unwrapped maps. Returns nil if Data is nil.

type RunReportBuilder 

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

RunReportBuilder provides a fluent API for the runReport operation. Run a report

func (*RunReportBuilder) Run 

func (b *RunReportBuilder) Run(ctx context.Context) (*RunReportResult, error)

Run executes the runReport request and returns the response data directly.

func (*RunReportBuilder) Skip 

func (b *RunReportBuilder) Skip(value int) *RunReportBuilder

Skip The number of records to skip. You can set this value when paginating through a set of results.

func (*RunReportBuilder) Top 

func (b *RunReportBuilder) Top(value int) *RunReportBuilder

Top The maximum number of records to return. You can override the default Quickbase pagination to get more or fewer results. If your requested value here exceeds the dynamic maximums, we will return a subset of results and the rest can be gathered in subsequent API calls.

type RunReportFieldsItem 

type RunReportFieldsItem struct {
	*generated.RunReportFieldsItem
}

RunReportFieldsItem wraps RunReportFieldsItem with convenience methods.

func (*RunReportFieldsItem) Id 

func (r *RunReportFieldsItem) Id() int

Id returns the Id field value, or zero value if nil.

func (*RunReportFieldsItem) Label 

func (r *RunReportFieldsItem) Label() string

Label returns the Label field value, or zero value if nil.

func (*RunReportFieldsItem) LabelOverride 

func (r *RunReportFieldsItem) LabelOverride() string

LabelOverride returns the LabelOverride field value, or zero value if nil.

func (*RunReportFieldsItem) Type 

func (r *RunReportFieldsItem) Type() string

Type returns the Type field value, or zero value if nil.

type RunReportJSONRequestBody 

type RunReportJSONRequestBody = generated.RunReportJSONRequestBody

type RunReportMetadata 

type RunReportMetadata struct {
	*generated.RunReportMetadata
}

RunReportMetadata wraps RunReportMetadata with convenience methods.

func (*RunReportMetadata) NumFields 

func (r *RunReportMetadata) NumFields() int

NumFields returns the NumFields field value.

func (*RunReportMetadata) NumRecords 

func (r *RunReportMetadata) NumRecords() int

NumRecords returns the NumRecords field value.

func (*RunReportMetadata) Skip 

func (r *RunReportMetadata) Skip() int

Skip returns the Skip field value, or zero value if nil.

func (*RunReportMetadata) Top 

func (r *RunReportMetadata) Top() int

Top returns the Top field value, or zero value if nil.

func (*RunReportMetadata) TotalRecords 

func (r *RunReportMetadata) TotalRecords() int

TotalRecords returns the TotalRecords field value.

type RunReportParams 

type RunReportParams = generated.RunReportParams

type RunReportResponse 

type RunReportResponse = generated.RunReportResponse

type RunReportResult 

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

RunReportResult wraps RunReportResponse with convenience methods.

func (*RunReportResult) Fields 

func (r *RunReportResult) Fields() []*RunReportFieldsItem

Fields returns the Fields field as wrapped types, or nil if not set.

func (*RunReportResult) Metadata 

func (r *RunReportResult) Metadata() *RunReportMetadata

Metadata returns the Metadata field as a wrapped type, or nil if not set.

func (*RunReportResult) Raw added in v2.1.0 

func (r *RunReportResult) Raw() *generated.RunReportResponse

Raw returns the underlying generated response.

func (*RunReportResult) Records 

func (r *RunReportResult) Records() []Record

Records returns the record data as unwrapped maps. Returns nil if Data is nil.

type SlidingWindowThrottle 

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

SlidingWindowThrottle implements proactive rate limiting using a sliding window algorithm.

This throttle tracks request timestamps and blocks new requests when the limit would be exceeded. It automatically waits until the oldest request exits the 10-second window before allowing new requests.

QuickBase's rate limit is 100 requests per 10 seconds per user token. Using this throttle prevents 429 errors by proactively limiting request rate.

Example: 

client, _ := quickbase.New(realm,
    quickbase.WithUserToken(token),
    quickbase.WithProactiveThrottle(100), // 100 req/10s
)

func NewSlidingWindowThrottle 

func NewSlidingWindowThrottle(requestsPer10Seconds int) *SlidingWindowThrottle

NewSlidingWindowThrottle creates a new sliding window throttle.

The requestsPer10Seconds parameter sets the maximum requests allowed per 10-second window. QuickBase's default limit is 100 requests per 10 seconds per user token. If requestsPer10Seconds is <= 0, it defaults to 100.

func (*SlidingWindowThrottle) Acquire 

func (t *SlidingWindowThrottle) Acquire(ctx context.Context) error

Acquire waits until a request slot is available.

func (*SlidingWindowThrottle) GetRemaining 

func (t *SlidingWindowThrottle) GetRemaining() int

GetRemaining returns remaining requests available in the current window.

func (*SlidingWindowThrottle) GetWindowCount 

func (t *SlidingWindowThrottle) GetWindowCount() int

GetWindowCount returns the number of requests in the current 10-second window.

func (*SlidingWindowThrottle) Reset 

func (t *SlidingWindowThrottle) Reset()

Reset clears the throttle state.

type SolutionPublicResult added in v2.1.0 

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

SolutionPublicResult wraps GetSolutionPublicResponse with convenience methods.

func (*SolutionPublicResult) Raw added in v2.1.0 

func (r *SolutionPublicResult) Raw() *generated.GetSolutionPublicResponse

Raw returns the underlying generated response.

type SortSpec 

type SortSpec struct {
	Field any                      // Field ID (int) or alias (string)
	Order generated.SortFieldOrder // ASC or DESC
}

SortSpec specifies a sort field and order, supporting both field IDs and aliases.

type TableReportsItem 

type TableReportsItem struct {
	*generated.GetTableReportsItem
}

TableReportsItem wraps GetTableReportsItem with convenience methods.

func (*TableReportsItem) Description 

func (r *TableReportsItem) Description() string

Description returns the Description field value, or zero value if nil.

func (*TableReportsItem) Id 

func (r *TableReportsItem) Id() string

Id returns the Id field value, or zero value if nil.

func (*TableReportsItem) Name 

func (r *TableReportsItem) Name() string

Name returns the Name field value, or zero value if nil.

func (*TableReportsItem) Query 

func (r *TableReportsItem) Query() *GetTableReportsItemQuery

Query returns the Query field as a wrapped type, or nil if not set.

func (*TableReportsItem) Type 

func (r *TableReportsItem) Type() string

Type returns the Type field value, or zero value if nil.

func (*TableReportsItem) UsedCount 

func (r *TableReportsItem) UsedCount() int

UsedCount returns the UsedCount field value, or zero value if nil.

func (*TableReportsItem) UsedLast 

func (r *TableReportsItem) UsedLast() string

UsedLast returns the UsedLast field value, or zero value if nil.

type TableReportsResult added in v2.1.0 

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

TableReportsResult wraps GetTableReportsResponse with convenience methods.

func (*TableReportsResult) Raw added in v2.1.0 

func (r *TableReportsResult) Raw() *generated.GetTableReportsResponse

Raw returns the underlying generated response.

type TableResult 

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

TableResult wraps GetTableResponse with convenience methods.

func (*TableResult) Alias 

func (r *TableResult) Alias() string

Alias returns the Alias field value, or zero value if nil.

func (*TableResult) Created 

func (r *TableResult) Created() string

Created returns the Created field value, or zero value if nil.

func (*TableResult) DefaultSortFieldId 

func (r *TableResult) DefaultSortFieldId() int

DefaultSortFieldId returns the DefaultSortFieldId field value, or zero value if nil.

func (*TableResult) DefaultSortOrder 

func (r *TableResult) DefaultSortOrder() string

DefaultSortOrder returns the DefaultSortOrder field value as a string, or empty string if nil.

func (*TableResult) Description 

func (r *TableResult) Description() string

Description returns the Description field value, or zero value if nil.

func (*TableResult) Id 

func (r *TableResult) Id() string

Id returns the Id field value, or zero value if nil.

func (*TableResult) KeyFieldId 

func (r *TableResult) KeyFieldId() int

KeyFieldId returns the KeyFieldId field value, or zero value if nil.

func (*TableResult) Name 

func (r *TableResult) Name() string

Name returns the Name field value, or zero value if nil.

func (*TableResult) NextFieldId 

func (r *TableResult) NextFieldId() int

NextFieldId returns the NextFieldId field value, or zero value if nil.

func (*TableResult) NextRecordId 

func (r *TableResult) NextRecordId() int

NextRecordId returns the NextRecordId field value, or zero value if nil.

func (*TableResult) PluralRecordName 

func (r *TableResult) PluralRecordName() string

PluralRecordName returns the PluralRecordName field value, or zero value if nil.

func (*TableResult) Raw added in v2.1.0 

func (r *TableResult) Raw() *generated.GetTableResponse

Raw returns the underlying generated response.

func (*TableResult) SingleRecordName 

func (r *TableResult) SingleRecordName() string

SingleRecordName returns the SingleRecordName field value, or zero value if nil.

func (*TableResult) SizeLimit 

func (r *TableResult) SizeLimit() string

SizeLimit returns the SizeLimit field value, or zero value if nil.

func (*TableResult) SpaceRemaining 

func (r *TableResult) SpaceRemaining() string

SpaceRemaining returns the SpaceRemaining field value, or zero value if nil.

func (*TableResult) SpaceUsed 

func (r *TableResult) SpaceUsed() string

SpaceUsed returns the SpaceUsed field value, or zero value if nil.

func (*TableResult) Updated 

func (r *TableResult) Updated() string

Updated returns the Updated field value, or zero value if nil.

type TempTokenDBIDResult 

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

TempTokenDBIDResult wraps GetTempTokenDBIDResponse with convenience methods.

func (*TempTokenDBIDResult) Raw added in v2.1.0 

func (r *TempTokenDBIDResult) Raw() *generated.GetTempTokenDBIDResponse

Raw returns the underlying generated response.

func (*TempTokenDBIDResult) TemporaryAuthorization 

func (r *TempTokenDBIDResult) TemporaryAuthorization() string

TemporaryAuthorization returns the TemporaryAuthorization field value, or zero value if nil.

type Throttle 

type Throttle interface {
	// Acquire blocks until a request slot is available.
	// Returns an error if the context is cancelled while waiting.
	Acquire(ctx context.Context) error

	// GetWindowCount returns the number of requests in the current window.
	GetWindowCount() int

	// GetRemaining returns remaining requests available in the current window.
	GetRemaining() int

	// Reset clears the throttle state.
	Reset()
}

Throttle is the interface for rate limiting strategies.

QuickBase enforces a rate limit of 100 requests per 10 seconds per user token. Implementing this interface allows custom throttling behavior.

The SDK provides two built-in implementations:

type TransferUserTokenBuilder 

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

TransferUserTokenBuilder provides a fluent API for the transferUserToken operation. Transfer a user token

func (*TransferUserTokenBuilder) From 

func (b *TransferUserTokenBuilder) From(value string) *TransferUserTokenBuilder

From The id of the user to transfer the user token from

func (*TransferUserTokenBuilder) Id 

func (b *TransferUserTokenBuilder) Id(value float64) *TransferUserTokenBuilder

Id The id of the user token to transfer

func (*TransferUserTokenBuilder) Run 

func (b *TransferUserTokenBuilder) Run(ctx context.Context) (*TransferUserTokenResult, error)

Run executes the transferUserToken request and returns the response data directly.

func (*TransferUserTokenBuilder) To 

func (b *TransferUserTokenBuilder) To(value string) *TransferUserTokenBuilder

To The id of the user to transfer the user token to

type TransferUserTokenJSONRequestBody 

type TransferUserTokenJSONRequestBody = generated.TransferUserTokenJSONRequestBody

type TransferUserTokenResponse 

type TransferUserTokenResponse = generated.TransferUserTokenResponse

type TransferUserTokenResult 

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

TransferUserTokenResult wraps TransferUserTokenResponse with convenience methods.

func (*TransferUserTokenResult) Active 

func (r *TransferUserTokenResult) Active() bool

Active returns the Active field value, or zero value if nil.

func (*TransferUserTokenResult) Description 

func (r *TransferUserTokenResult) Description() string

Description returns the Description field value, or zero value if nil.

func (*TransferUserTokenResult) Id 

func (r *TransferUserTokenResult) Id() int

Id returns the Id field value, or zero value if nil.

func (*TransferUserTokenResult) LastUsed 

func (r *TransferUserTokenResult) LastUsed() string

LastUsed returns the LastUsed field value, or zero value if nil.

func (*TransferUserTokenResult) Name 

func (r *TransferUserTokenResult) Name() string

Name returns the Name field value, or zero value if nil.

func (*TransferUserTokenResult) Raw added in v2.1.0 

func (r *TransferUserTokenResult) Raw() *generated.TransferUserTokenResponse

Raw returns the underlying generated response.

type TrusteesItem 

type TrusteesItem struct {
	*generated.GetTrusteesItem
}

TrusteesItem wraps GetTrusteesItem with convenience methods.

func (*TrusteesItem) Id 

func (r *TrusteesItem) Id() string

Id returns the Id field value.

func (*TrusteesItem) RoleId 

func (r *TrusteesItem) RoleId() int

RoleId returns the RoleId field value.

type TrusteesResult added in v2.1.0 

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

TrusteesResult wraps GetTrusteesResponse with convenience methods.

func (*TrusteesResult) Raw added in v2.1.0 

func (r *TrusteesResult) Raw() *generated.GetTrusteesResponse

Raw returns the underlying generated response.

type UndenyUsersBuilder 

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

UndenyUsersBuilder provides a fluent API for the undenyUsers operation. Undeny users

func (*UndenyUsersBuilder) AccountId 

func (b *UndenyUsersBuilder) AccountId(value float32) *UndenyUsersBuilder

AccountId The account id being used to undeny users. If no value is specified, the first account associated with the requesting user token is chosen.

func (*UndenyUsersBuilder) Run 

func (b *UndenyUsersBuilder) Run(ctx context.Context) (*UndenyUsersResult, error)

Run executes the undenyUsers request and returns the response data directly.

type UndenyUsersJSONRequestBody 

type UndenyUsersJSONRequestBody = generated.UndenyUsersJSONRequestBody

type UndenyUsersParams 

type UndenyUsersParams = generated.UndenyUsersParams

type UndenyUsersResponse 

type UndenyUsersResponse = generated.UndenyUsersResponse

type UndenyUsersResult 

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

UndenyUsersResult wraps UndenyUsersResponse with convenience methods.

func (*UndenyUsersResult) Raw added in v2.1.0 

func (r *UndenyUsersResult) Raw() *generated.UndenyUsersResponse

Raw returns the underlying generated response.

type UpdateAppBuilder 

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

UpdateAppBuilder provides a fluent API for the updateApp operation. Update an app

func (*UpdateAppBuilder) AllowClone 

func (b *UpdateAppBuilder) AllowClone(value bool) *UpdateAppBuilder

AllowClone Allow users who are not administrators to copy

func (*UpdateAppBuilder) AllowExport 

func (b *UpdateAppBuilder) AllowExport(value bool) *UpdateAppBuilder

AllowExport Allow users who are not administrators to export data

func (*UpdateAppBuilder) Description 

func (b *UpdateAppBuilder) Description(value string) *UpdateAppBuilder

Description The description for the app.

func (*UpdateAppBuilder) EnableAppTokens 

func (b *UpdateAppBuilder) EnableAppTokens(value bool) *UpdateAppBuilder

EnableAppTokens Require Application Tokens

func (*UpdateAppBuilder) HideFromPublic 

func (b *UpdateAppBuilder) HideFromPublic(value bool) *UpdateAppBuilder

HideFromPublic Hide from public application searches

func (*UpdateAppBuilder) MustBeRealmApproved 

func (b *UpdateAppBuilder) MustBeRealmApproved(value bool) *UpdateAppBuilder

MustBeRealmApproved Only "approved" users may access this application

func (*UpdateAppBuilder) Name 

func (b *UpdateAppBuilder) Name(value string) *UpdateAppBuilder

Name The name for the app.

func (*UpdateAppBuilder) Run 

func (b *UpdateAppBuilder) Run(ctx context.Context) (*UpdateAppResult, error)

Run executes the updateApp request and returns the response data directly.

func (*UpdateAppBuilder) UseIPFilter 

func (b *UpdateAppBuilder) UseIPFilter(value bool) *UpdateAppBuilder

UseIPFilter Only users logging in from "approved" IP addresses may access this application

func (*UpdateAppBuilder) Variables 

func (b *UpdateAppBuilder) Variables(values ...map[string]any) *UpdateAppBuilder

Variables The app variables. A maximum of 10 variables can be updated at a time. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)

type UpdateAppJSONRequestBody 

type UpdateAppJSONRequestBody = generated.UpdateAppJSONRequestBody

type UpdateAppMemoryInfo added in v2.2.0 

type UpdateAppMemoryInfo struct {
	*generated.UpdateAppMemoryInfo
}

UpdateAppMemoryInfo wraps UpdateAppMemoryInfo with convenience methods.

func (*UpdateAppMemoryInfo) EstMemory added in v2.2.0 

func (r *UpdateAppMemoryInfo) EstMemory() float32

EstMemory returns the EstMemory field value, or zero value if nil.

func (*UpdateAppMemoryInfo) EstMemoryInclDependentApps added in v2.2.0 

func (r *UpdateAppMemoryInfo) EstMemoryInclDependentApps() float32

EstMemoryInclDependentApps returns the EstMemoryInclDependentApps field value, or zero value if nil.

type UpdateAppResponse 

type UpdateAppResponse = generated.UpdateAppResponse

type UpdateAppResult 

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

UpdateAppResult wraps UpdateAppResponse with convenience methods.

func (*UpdateAppResult) AncestorId 

func (r *UpdateAppResult) AncestorId() string

AncestorId returns the AncestorId field value, or zero value if nil.

func (*UpdateAppResult) Created 

func (r *UpdateAppResult) Created() string

Created returns the Created field value, or zero value if nil.

func (*UpdateAppResult) DataClassification 

func (r *UpdateAppResult) DataClassification() string

DataClassification returns the DataClassification field value, or zero value if nil.

func (*UpdateAppResult) DateFormat 

func (r *UpdateAppResult) DateFormat() string

DateFormat returns the DateFormat field value, or zero value if nil.

func (*UpdateAppResult) Description 

func (r *UpdateAppResult) Description() string

Description returns the Description field value, or zero value if nil.

func (*UpdateAppResult) HasEveryoneOnTheInternet 

func (r *UpdateAppResult) HasEveryoneOnTheInternet() bool

HasEveryoneOnTheInternet returns the HasEveryoneOnTheInternet field value, or zero value if nil.

func (*UpdateAppResult) Id 

func (r *UpdateAppResult) Id() string

Id returns the Id field value, or zero value if nil.

func (*UpdateAppResult) MemoryInfo added in v2.2.0 

func (r *UpdateAppResult) MemoryInfo() *UpdateAppMemoryInfo

MemoryInfo returns the MemoryInfo field as a wrapped type, or nil if not set.

func (*UpdateAppResult) Name 

func (r *UpdateAppResult) Name() string

Name returns the Name field value.

func (*UpdateAppResult) Raw added in v2.1.0 

func (r *UpdateAppResult) Raw() *generated.UpdateAppResponse

Raw returns the underlying generated response.

func (*UpdateAppResult) SecurityProperties 

func (r *UpdateAppResult) SecurityProperties() *UpdateAppSecurityProperties

SecurityProperties returns the SecurityProperties field as a wrapped type, or nil if not set.

func (*UpdateAppResult) TimeZone 

func (r *UpdateAppResult) TimeZone() string

TimeZone returns the TimeZone field value, or zero value if nil.

func (*UpdateAppResult) Updated 

func (r *UpdateAppResult) Updated() string

Updated returns the Updated field value, or zero value if nil.

type UpdateAppSecurityProperties 

type UpdateAppSecurityProperties struct {
	*generated.UpdateAppSecurityProperties
}

UpdateAppSecurityProperties wraps UpdateAppSecurityProperties with convenience methods.

func (*UpdateAppSecurityProperties) AllowClone 

func (r *UpdateAppSecurityProperties) AllowClone() bool

AllowClone returns the AllowClone field value, or zero value if nil.

func (*UpdateAppSecurityProperties) AllowExport 

func (r *UpdateAppSecurityProperties) AllowExport() bool

AllowExport returns the AllowExport field value, or zero value if nil.

func (*UpdateAppSecurityProperties) EnableAppTokens 

func (r *UpdateAppSecurityProperties) EnableAppTokens() bool

EnableAppTokens returns the EnableAppTokens field value, or zero value if nil.

func (*UpdateAppSecurityProperties) HideFromPublic 

func (r *UpdateAppSecurityProperties) HideFromPublic() bool

HideFromPublic returns the HideFromPublic field value, or zero value if nil.

func (*UpdateAppSecurityProperties) MustBeRealmApproved 

func (r *UpdateAppSecurityProperties) MustBeRealmApproved() bool

MustBeRealmApproved returns the MustBeRealmApproved field value, or zero value if nil.

func (*UpdateAppSecurityProperties) UseIPFilter 

func (r *UpdateAppSecurityProperties) UseIPFilter() bool

UseIPFilter returns the UseIPFilter field value, or zero value if nil.

type UpdateFieldBuilder 

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

UpdateFieldBuilder provides a fluent API for the updateField operation. Update a field

func (*UpdateFieldBuilder) Abbreviate 

func (b *UpdateFieldBuilder) Abbreviate(value bool) *UpdateFieldBuilder

Abbreviate Don't show the URL protocol when showing the URL.

func (*UpdateFieldBuilder) AddToForms 

func (b *UpdateFieldBuilder) AddToForms(value bool) *UpdateFieldBuilder

AddToForms Whether the field you are adding should appear on forms.

func (*UpdateFieldBuilder) AllowMentions 

func (b *UpdateFieldBuilder) AllowMentions(value bool) *UpdateFieldBuilder

AllowMentions If someone can @mention users in the rich text field to generate an email notification.

func (*UpdateFieldBuilder) AllowNewChoices 

func (b *UpdateFieldBuilder) AllowNewChoices(value bool) *UpdateFieldBuilder

AllowNewChoices Indicates if users can add new choices to a selection list.

func (*UpdateFieldBuilder) AppearsAs 

func (b *UpdateFieldBuilder) AppearsAs(value string) *UpdateFieldBuilder

AppearsAs The link text, if empty, the url will be used as link text.

func (*UpdateFieldBuilder) AppearsByDefault 

func (b *UpdateFieldBuilder) AppearsByDefault(value bool) *UpdateFieldBuilder

AppearsByDefault Indicates if the field is marked as a default in reports.

func (*UpdateFieldBuilder) AppendOnly 

func (b *UpdateFieldBuilder) AppendOnly(value bool) *UpdateFieldBuilder

AppendOnly Whether this field is append only.

func (*UpdateFieldBuilder) Audited 

func (b *UpdateFieldBuilder) Audited(value bool) *UpdateFieldBuilder

Audited Indicates if the field is being tracked as part of Quickbase Audit Logs. You can only set this property to "true" if the app has audit logs enabled. See Enable data change logs under [Quickbase Audit Logs](https://help.quickbase.com/user-assistance/audit_logs.html).

func (*UpdateFieldBuilder) AutoSave 

func (b *UpdateFieldBuilder) AutoSave(value bool) *UpdateFieldBuilder

AutoSave Whether the link field will auto save.

func (*UpdateFieldBuilder) BlankIsZero 

func (b *UpdateFieldBuilder) BlankIsZero(value bool) *UpdateFieldBuilder

BlankIsZero Whether a blank value is treated the same as 0 in calculations within the product.

func (*UpdateFieldBuilder) Bold 

func (b *UpdateFieldBuilder) Bold(value bool) *UpdateFieldBuilder

Bold Indicates if the field is configured to display in bold in the product.

func (*UpdateFieldBuilder) CarryChoices 

func (b *UpdateFieldBuilder) CarryChoices(value bool) *UpdateFieldBuilder

CarryChoices Whether the field should carry its multiple choice fields when copied.

func (*UpdateFieldBuilder) Choices 

func (b *UpdateFieldBuilder) Choices(value []string) *UpdateFieldBuilder

Choices An array of entries that exist for a field that offers choices to the user. Note that these choices refer to the valid values of any records added in the future. You are allowed to remove values from the list of choices even if there are existing records with those values in this field. They will be displayed in red when users look at the data in the browser but there is no other effect. While updating a field with this property, the old choices are removed and replaced by the new choices.

func (*UpdateFieldBuilder) CommaStart 

func (b *UpdateFieldBuilder) CommaStart(value int) *UpdateFieldBuilder

CommaStart The number of digits before commas display in the product, when applicable.

func (*UpdateFieldBuilder) Comments 

func (b *UpdateFieldBuilder) Comments(value string) *UpdateFieldBuilder

Comments The comments entered on the field properties by an administrator.

func (*UpdateFieldBuilder) CompositeFields 

func (b *UpdateFieldBuilder) CompositeFields(value []any) *UpdateFieldBuilder

CompositeFields An array of the fields that make up a composite field (e.g., address).

func (*UpdateFieldBuilder) CoverText 

func (b *UpdateFieldBuilder) CoverText(value string) *UpdateFieldBuilder

CoverText An alternate user friendly text that can be used to display a link in the browser.

func (*UpdateFieldBuilder) CurrencyFormat 

func (b *UpdateFieldBuilder) CurrencyFormat(value string) *UpdateFieldBuilder

CurrencyFormat The currency format used when displaying field values within the product.

func (*UpdateFieldBuilder) CurrencySymbol 

func (b *UpdateFieldBuilder) CurrencySymbol(value string) *UpdateFieldBuilder

CurrencySymbol The current symbol used when displaying field values within the product.

func (*UpdateFieldBuilder) DecimalPlaces 

func (b *UpdateFieldBuilder) DecimalPlaces(value int) *UpdateFieldBuilder

DecimalPlaces The number of decimal places displayed in the product for this field.

func (*UpdateFieldBuilder) DefaultCountryCode 

func (b *UpdateFieldBuilder) DefaultCountryCode(value string) *UpdateFieldBuilder

DefaultCountryCode Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format.

func (*UpdateFieldBuilder) DefaultDomain 

func (b *UpdateFieldBuilder) DefaultDomain(value string) *UpdateFieldBuilder

DefaultDomain Default email domain.

func (*UpdateFieldBuilder) DefaultKind 

func (b *UpdateFieldBuilder) DefaultKind(value string) *UpdateFieldBuilder

DefaultKind The user default type.

func (*UpdateFieldBuilder) DefaultToday 

func (b *UpdateFieldBuilder) DefaultToday(value bool) *UpdateFieldBuilder

DefaultToday Indicates if the field value is defaulted today for new records.

func (*UpdateFieldBuilder) DefaultValue 

func (b *UpdateFieldBuilder) DefaultValue(value string) *UpdateFieldBuilder

DefaultValue The default value configured for a field when a new record is added.

func (*UpdateFieldBuilder) DefaultValueLuid 

func (b *UpdateFieldBuilder) DefaultValueLuid(value int) *UpdateFieldBuilder

DefaultValueLuid Default user id value. 

func (b *UpdateFieldBuilder) DisplayAsLink(value bool) *UpdateFieldBuilder

DisplayAsLink Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.

func (*UpdateFieldBuilder) DisplayCheckboxAsText 

func (b *UpdateFieldBuilder) DisplayCheckboxAsText(value bool) *UpdateFieldBuilder

DisplayCheckboxAsText Indicates whether the checkbox values will be shown as text in reports.

func (*UpdateFieldBuilder) DisplayDayOfWeek 

func (b *UpdateFieldBuilder) DisplayDayOfWeek(value bool) *UpdateFieldBuilder

DisplayDayOfWeek Indicates whether to display the day of the week within the product.

func (*UpdateFieldBuilder) DisplayEmail 

func (b *UpdateFieldBuilder) DisplayEmail(value string) *UpdateFieldBuilder

DisplayEmail How the email is displayed.

func (*UpdateFieldBuilder) DisplayMonth 

func (b *UpdateFieldBuilder) DisplayMonth(value string) *UpdateFieldBuilder

DisplayMonth How to display months.

func (*UpdateFieldBuilder) DisplayRelative 

func (b *UpdateFieldBuilder) DisplayRelative(value bool) *UpdateFieldBuilder

DisplayRelative Whether to display time as relative.

func (*UpdateFieldBuilder) DisplayTime 

func (b *UpdateFieldBuilder) DisplayTime(value bool) *UpdateFieldBuilder

DisplayTime Indicates whether to display the time, in addition to the date.

func (*UpdateFieldBuilder) DisplayTimezone 

func (b *UpdateFieldBuilder) DisplayTimezone(value bool) *UpdateFieldBuilder

DisplayTimezone Indicates whether to display the timezone within the product.

func (*UpdateFieldBuilder) DisplayUser 

func (b *UpdateFieldBuilder) DisplayUser(value string) *UpdateFieldBuilder

DisplayUser The configured option for how users display within the product.

func (*UpdateFieldBuilder) DoesAverage 

func (b *UpdateFieldBuilder) DoesAverage(value bool) *UpdateFieldBuilder

DoesAverage Whether this field averages in reports within the product.

func (*UpdateFieldBuilder) DoesTotal 

func (b *UpdateFieldBuilder) DoesTotal(value bool) *UpdateFieldBuilder

DoesTotal Whether this field totals in reports within the product.

func (*UpdateFieldBuilder) Exact 

func (b *UpdateFieldBuilder) Exact(value bool) *UpdateFieldBuilder

Exact Whether an exact match is required for a report link.

func (*UpdateFieldBuilder) FieldHelp 

func (b *UpdateFieldBuilder) FieldHelp(value string) *UpdateFieldBuilder

FieldHelp The configured help text shown to users within the product.

func (*UpdateFieldBuilder) FindEnabled 

func (b *UpdateFieldBuilder) FindEnabled(value bool) *UpdateFieldBuilder

FindEnabled Indicates if the field is marked as searchable.

func (*UpdateFieldBuilder) Format 

func (b *UpdateFieldBuilder) Format(value int) *UpdateFieldBuilder

Format The format to display time.

func (*UpdateFieldBuilder) Formula 

func (b *UpdateFieldBuilder) Formula(value string) *UpdateFieldBuilder

Formula The formula of the field as configured in Quickbase.

func (*UpdateFieldBuilder) HasExtension 

func (b *UpdateFieldBuilder) HasExtension(value bool) *UpdateFieldBuilder

HasExtension Whether this field has a phone extension.

func (*UpdateFieldBuilder) Hours24 

func (b *UpdateFieldBuilder) Hours24(value bool) *UpdateFieldBuilder

Hours24 Indicates whether or not to display time in the 24-hour format within the product.

func (*UpdateFieldBuilder) Label 

func (b *UpdateFieldBuilder) Label(value string) *UpdateFieldBuilder

Label The label (name) of the field.

func (*UpdateFieldBuilder) LinkText 

func (b *UpdateFieldBuilder) LinkText(value string) *UpdateFieldBuilder

LinkText The configured text value that replaces the URL that users see within the product.

func (*UpdateFieldBuilder) LookupReferenceFieldId 

func (b *UpdateFieldBuilder) LookupReferenceFieldId(value int) *UpdateFieldBuilder

LookupReferenceFieldId The id of the field that is the reference in the relationship for this lookup.

func (*UpdateFieldBuilder) LookupTargetFieldId 

func (b *UpdateFieldBuilder) LookupTargetFieldId(value int) *UpdateFieldBuilder

LookupTargetFieldId The id of the field that is the target on the parent table for this lookup.

func (*UpdateFieldBuilder) MaxLength 

func (b *UpdateFieldBuilder) MaxLength(value int) *UpdateFieldBuilder

MaxLength The maximum number of characters allowed for entry in Quickbase for this field.

func (*UpdateFieldBuilder) MaxVersions 

func (b *UpdateFieldBuilder) MaxVersions(value int) *UpdateFieldBuilder

MaxVersions The maximum number of versions configured for a file attachment.

func (*UpdateFieldBuilder) NoWrap 

func (b *UpdateFieldBuilder) NoWrap(value bool) *UpdateFieldBuilder

NoWrap Indicates if the field is configured to not wrap when displayed in the product.

func (*UpdateFieldBuilder) NumLines 

func (b *UpdateFieldBuilder) NumLines(value int) *UpdateFieldBuilder

NumLines The number of lines shown in Quickbase for this text field.

func (*UpdateFieldBuilder) NumberFormat 

func (b *UpdateFieldBuilder) NumberFormat(value int) *UpdateFieldBuilder

NumberFormat The format used for displaying numeric values in the product (decimal, separators, digit group).

func (*UpdateFieldBuilder) OpenTargetIn 

func (b *UpdateFieldBuilder) OpenTargetIn(value string) *UpdateFieldBuilder

OpenTargetIn Indicates which target the URL should open in when a user clicks it within the product.

func (*UpdateFieldBuilder) ParentFieldId 

func (b *UpdateFieldBuilder) ParentFieldId(value int) *UpdateFieldBuilder

ParentFieldId The id of the parent composite field, when applicable.

func (*UpdateFieldBuilder) Permissions 

func (b *UpdateFieldBuilder) Permissions(values ...map[string]any) *UpdateFieldBuilder

Permissions Field Permissions for different roles.

func (*UpdateFieldBuilder) PostTempToken 

func (b *UpdateFieldBuilder) PostTempToken(value bool) *UpdateFieldBuilder

PostTempToken POSTs a temporary token to the first URL when clicked by a user. [Learn more](https://help.quickbase.com/docs/post-temporary-token-from-a-quickbase-field)

func (*UpdateFieldBuilder) Required 

func (b *UpdateFieldBuilder) Required(value bool) *UpdateFieldBuilder

Required Indicates if the field is required (i.e. if every record must have a non-null value in this field). If you attempt to change a field from not-required to required, and the table currently contains records that have null values in that field, you will get an error indicating that there are null values of the field. In this case you need to find and update those records with null values of the field before changing the field to required.

func (*UpdateFieldBuilder) Run 

func (b *UpdateFieldBuilder) Run(ctx context.Context) (*UpdateFieldResult, error)

Run executes the updateField request and returns the response data directly.

func (*UpdateFieldBuilder) SeeVersions 

func (b *UpdateFieldBuilder) SeeVersions(value bool) *UpdateFieldBuilder

SeeVersions Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.

func (*UpdateFieldBuilder) SnapFieldId 

func (b *UpdateFieldBuilder) SnapFieldId(value int) *UpdateFieldBuilder

SnapFieldId The id of the field that is used to snapshot values from, when applicable.

func (*UpdateFieldBuilder) SortAlpha 

func (b *UpdateFieldBuilder) SortAlpha(value bool) *UpdateFieldBuilder

SortAlpha Whether to sort alphabetically, default sort is by record ID.

func (*UpdateFieldBuilder) SortAsGiven 

func (b *UpdateFieldBuilder) SortAsGiven(value bool) *UpdateFieldBuilder

SortAsGiven Indicates if the listed entries sort as entered vs alphabetically.

func (*UpdateFieldBuilder) SourceFieldId 

func (b *UpdateFieldBuilder) SourceFieldId(value int) *UpdateFieldBuilder

SourceFieldId The id of the source field.

func (*UpdateFieldBuilder) SummaryFunction 

func (b *UpdateFieldBuilder) SummaryFunction(value string) *UpdateFieldBuilder

SummaryFunction The accumulation type for the summary field.

func (*UpdateFieldBuilder) SummaryQuery 

func (b *UpdateFieldBuilder) SummaryQuery(value string) *UpdateFieldBuilder

SummaryQuery The summary query.

func (*UpdateFieldBuilder) SummaryReferenceFieldId 

func (b *UpdateFieldBuilder) SummaryReferenceFieldId(value int) *UpdateFieldBuilder

SummaryReferenceFieldId The id of the field that is the reference in the relationship for this summary.

func (*UpdateFieldBuilder) SummaryTableId 

func (b *UpdateFieldBuilder) SummaryTableId(value string) *UpdateFieldBuilder

SummaryTableId The table the summary field references fields from.

func (*UpdateFieldBuilder) SummaryTargetFieldId 

func (b *UpdateFieldBuilder) SummaryTargetFieldId(value int) *UpdateFieldBuilder

SummaryTargetFieldId The id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn't require a field selection (like count).

func (*UpdateFieldBuilder) TargetFieldId 

func (b *UpdateFieldBuilder) TargetFieldId(value int) *UpdateFieldBuilder

TargetFieldId The id of the target field.

func (*UpdateFieldBuilder) TargetTableId 

func (b *UpdateFieldBuilder) TargetTableId(value string) *UpdateFieldBuilder

TargetTableId The id of the target table.

func (*UpdateFieldBuilder) TargetTableName 

func (b *UpdateFieldBuilder) TargetTableName(value string) *UpdateFieldBuilder

TargetTableName The field's target table name.

func (*UpdateFieldBuilder) Unique 

func (b *UpdateFieldBuilder) Unique(value bool) *UpdateFieldBuilder

Unique Indicates if every record in the table must contain a unique value of this field. If you attempt to change a field from not-unique to unique, and the table currently contains records with the same value of this field, you will get an error. In this case you need to find and update those records with duplicate values of the field before changing the field to unique.

func (*UpdateFieldBuilder) Units 

func (b *UpdateFieldBuilder) Units(value string) *UpdateFieldBuilder

Units The units label.

func (*UpdateFieldBuilder) UseI18NFormat 

func (b *UpdateFieldBuilder) UseI18NFormat(value bool) *UpdateFieldBuilder

UseI18NFormat Whether phone numbers should be in E.164 standard international format

func (*UpdateFieldBuilder) UseNewWindow 

func (b *UpdateFieldBuilder) UseNewWindow(value bool) *UpdateFieldBuilder

UseNewWindow Indicates if the file should open a new window when a user clicks it within the product.

func (*UpdateFieldBuilder) VersionMode 

func (b *UpdateFieldBuilder) VersionMode(value string) *UpdateFieldBuilder

VersionMode Version modes for files. Keep all versions vs keep last version.

func (*UpdateFieldBuilder) Width 

func (b *UpdateFieldBuilder) Width(value int) *UpdateFieldBuilder

Width The field's html input width in the product.

type UpdateFieldJSONRequestBody 

type UpdateFieldJSONRequestBody = generated.UpdateFieldJSONRequestBody

type UpdateFieldParams 

type UpdateFieldParams = generated.UpdateFieldParams

type UpdateFieldPermissionsItem added in v2.2.0 

type UpdateFieldPermissionsItem struct {
	*generated.UpdateFieldPermissionsItem
}

UpdateFieldPermissionsItem wraps UpdateFieldPermissionsItem with convenience methods.

func (*UpdateFieldPermissionsItem) PermissionType added in v2.2.0 

func (r *UpdateFieldPermissionsItem) PermissionType() string

PermissionType returns the PermissionType field value, or zero value if nil.

func (*UpdateFieldPermissionsItem) Role added in v2.2.0 

func (r *UpdateFieldPermissionsItem) Role() string

Role returns the Role field value, or zero value if nil.

func (*UpdateFieldPermissionsItem) RoleId added in v2.2.0 

func (r *UpdateFieldPermissionsItem) RoleId() int

RoleId returns the RoleId field value, or zero value if nil.

type UpdateFieldProperties 

type UpdateFieldProperties struct {
	*generated.UpdateFieldProperties
}

UpdateFieldProperties wraps UpdateFieldProperties with convenience methods.

func (*UpdateFieldProperties) Abbreviate 

func (r *UpdateFieldProperties) Abbreviate() bool

Abbreviate returns the Abbreviate field value, or zero value if nil.

func (*UpdateFieldProperties) AllowHTML 

func (r *UpdateFieldProperties) AllowHTML() bool

AllowHTML returns the AllowHTML field value, or zero value if nil.

func (*UpdateFieldProperties) AllowMentions 

func (r *UpdateFieldProperties) AllowMentions() bool

AllowMentions returns the AllowMentions field value, or zero value if nil.

func (*UpdateFieldProperties) AllowNewChoices 

func (r *UpdateFieldProperties) AllowNewChoices() bool

AllowNewChoices returns the AllowNewChoices field value, or zero value if nil.

func (*UpdateFieldProperties) AppearsAs 

func (r *UpdateFieldProperties) AppearsAs() string

AppearsAs returns the AppearsAs field value, or zero value if nil.

func (*UpdateFieldProperties) AppendOnly 

func (r *UpdateFieldProperties) AppendOnly() bool

AppendOnly returns the AppendOnly field value, or zero value if nil.

func (*UpdateFieldProperties) AutoSave 

func (r *UpdateFieldProperties) AutoSave() bool

AutoSave returns the AutoSave field value, or zero value if nil.

func (*UpdateFieldProperties) BlankIsZero 

func (r *UpdateFieldProperties) BlankIsZero() bool

BlankIsZero returns the BlankIsZero field value, or zero value if nil.

func (*UpdateFieldProperties) CarryChoices 

func (r *UpdateFieldProperties) CarryChoices() bool

CarryChoices returns the CarryChoices field value, or zero value if nil.

func (*UpdateFieldProperties) Choices 

func (r *UpdateFieldProperties) Choices() []string

Choices returns the Choices field value, or nil if not set.

func (*UpdateFieldProperties) ChoicesLuid 

func (r *UpdateFieldProperties) ChoicesLuid() []string

ChoicesLuid returns the ChoicesLuid field value, or nil if not set.

func (*UpdateFieldProperties) CommaStart 

func (r *UpdateFieldProperties) CommaStart() int

CommaStart returns the CommaStart field value, or zero value if nil.

func (*UpdateFieldProperties) Comments 

func (r *UpdateFieldProperties) Comments() string

Comments returns the Comments field value, or zero value if nil.

func (*UpdateFieldProperties) CompositeFields 

func (r *UpdateFieldProperties) CompositeFields() []*UpdateFieldProperties_CompositeFields_Item

CompositeFields returns the CompositeFields field as wrapped types, or nil if not set.

func (*UpdateFieldProperties) CoverText 

func (r *UpdateFieldProperties) CoverText() string

CoverText returns the CoverText field value, or zero value if nil.

func (*UpdateFieldProperties) CurrencyFormat 

func (r *UpdateFieldProperties) CurrencyFormat() string

CurrencyFormat returns the CurrencyFormat field value as a string, or empty string if nil.

func (*UpdateFieldProperties) CurrencySymbol 

func (r *UpdateFieldProperties) CurrencySymbol() string

CurrencySymbol returns the CurrencySymbol field value, or zero value if nil.

func (*UpdateFieldProperties) DecimalPlaces 

func (r *UpdateFieldProperties) DecimalPlaces() int

DecimalPlaces returns the DecimalPlaces field value, or zero value if nil.

func (*UpdateFieldProperties) DefaultCountryCode 

func (r *UpdateFieldProperties) DefaultCountryCode() string

DefaultCountryCode returns the DefaultCountryCode field value, or zero value if nil.

func (*UpdateFieldProperties) DefaultDomain 

func (r *UpdateFieldProperties) DefaultDomain() string

DefaultDomain returns the DefaultDomain field value, or zero value if nil.

func (*UpdateFieldProperties) DefaultKind 

func (r *UpdateFieldProperties) DefaultKind() string

DefaultKind returns the DefaultKind field value, or zero value if nil.

func (*UpdateFieldProperties) DefaultToday 

func (r *UpdateFieldProperties) DefaultToday() bool

DefaultToday returns the DefaultToday field value, or zero value if nil.

func (*UpdateFieldProperties) DefaultValue 

func (r *UpdateFieldProperties) DefaultValue() string

DefaultValue returns the DefaultValue field value, or zero value if nil.

func (*UpdateFieldProperties) DefaultValueLuid 

func (r *UpdateFieldProperties) DefaultValueLuid() int

DefaultValueLuid returns the DefaultValueLuid field value, or zero value if nil. 

func (r *UpdateFieldProperties) DisplayAsLink() bool

DisplayAsLink returns the DisplayAsLink field value, or zero value if nil.

func (*UpdateFieldProperties) DisplayCheckboxAsText 

func (r *UpdateFieldProperties) DisplayCheckboxAsText() bool

DisplayCheckboxAsText returns the DisplayCheckboxAsText field value, or zero value if nil.

func (*UpdateFieldProperties) DisplayDayOfWeek 

func (r *UpdateFieldProperties) DisplayDayOfWeek() bool

DisplayDayOfWeek returns the DisplayDayOfWeek field value, or zero value if nil.

func (*UpdateFieldProperties) DisplayEmail 

func (r *UpdateFieldProperties) DisplayEmail() string

DisplayEmail returns the DisplayEmail field value, or zero value if nil.

func (*UpdateFieldProperties) DisplayMonth 

func (r *UpdateFieldProperties) DisplayMonth() string

DisplayMonth returns the DisplayMonth field value, or zero value if nil.

func (*UpdateFieldProperties) DisplayRelative 

func (r *UpdateFieldProperties) DisplayRelative() bool

DisplayRelative returns the DisplayRelative field value, or zero value if nil.

func (*UpdateFieldProperties) DisplayTime 

func (r *UpdateFieldProperties) DisplayTime() bool

DisplayTime returns the DisplayTime field value, or zero value if nil.

func (*UpdateFieldProperties) DisplayTimezone 

func (r *UpdateFieldProperties) DisplayTimezone() bool

DisplayTimezone returns the DisplayTimezone field value, or zero value if nil.

func (*UpdateFieldProperties) DisplayUser 

func (r *UpdateFieldProperties) DisplayUser() string

DisplayUser returns the DisplayUser field value, or zero value if nil.

func (*UpdateFieldProperties) DoesAverage 

func (r *UpdateFieldProperties) DoesAverage() bool

DoesAverage returns the DoesAverage field value, or zero value if nil.

func (*UpdateFieldProperties) DoesTotal 

func (r *UpdateFieldProperties) DoesTotal() bool

DoesTotal returns the DoesTotal field value, or zero value if nil.

func (*UpdateFieldProperties) DurationField 

func (r *UpdateFieldProperties) DurationField() int

DurationField returns the DurationField field value, or zero value if nil.

func (*UpdateFieldProperties) Exact 

func (r *UpdateFieldProperties) Exact() bool

Exact returns the Exact field value, or zero value if nil.

func (*UpdateFieldProperties) ForeignKey 

func (r *UpdateFieldProperties) ForeignKey() bool

ForeignKey returns the ForeignKey field value, or zero value if nil.

func (*UpdateFieldProperties) Format 

func (r *UpdateFieldProperties) Format() int

Format returns the Format field value, or zero value if nil.

func (*UpdateFieldProperties) Formula 

func (r *UpdateFieldProperties) Formula() string

Formula returns the Formula field value, or zero value if nil.

func (*UpdateFieldProperties) HasExtension 

func (r *UpdateFieldProperties) HasExtension() bool

HasExtension returns the HasExtension field value, or zero value if nil.

func (*UpdateFieldProperties) Hours24 

func (r *UpdateFieldProperties) Hours24() bool

Hours24 returns the Hours24 field value, or zero value if nil.

func (*UpdateFieldProperties) LinkText 

func (r *UpdateFieldProperties) LinkText() string

LinkText returns the LinkText field value, or zero value if nil.

func (*UpdateFieldProperties) LookupReferenceFieldId 

func (r *UpdateFieldProperties) LookupReferenceFieldId() int

LookupReferenceFieldId returns the LookupReferenceFieldId field value, or zero value if nil.

func (*UpdateFieldProperties) LookupTargetFieldId 

func (r *UpdateFieldProperties) LookupTargetFieldId() int

LookupTargetFieldId returns the LookupTargetFieldId field value, or zero value if nil.

func (*UpdateFieldProperties) MasterChoiceFieldId 

func (r *UpdateFieldProperties) MasterChoiceFieldId() int

MasterChoiceFieldId returns the MasterChoiceFieldId field value, or zero value if nil.

func (*UpdateFieldProperties) MasterChoiceTableId 

func (r *UpdateFieldProperties) MasterChoiceTableId() string

MasterChoiceTableId returns the MasterChoiceTableId field value, or zero value if nil.

func (*UpdateFieldProperties) MasterTableTag 

func (r *UpdateFieldProperties) MasterTableTag() string

MasterTableTag returns the MasterTableTag field value, or zero value if nil.

func (*UpdateFieldProperties) MaxLength 

func (r *UpdateFieldProperties) MaxLength() int

MaxLength returns the MaxLength field value, or zero value if nil.

func (*UpdateFieldProperties) MaxVersions 

func (r *UpdateFieldProperties) MaxVersions() int

MaxVersions returns the MaxVersions field value, or zero value if nil.

func (*UpdateFieldProperties) NumLines 

func (r *UpdateFieldProperties) NumLines() int

NumLines returns the NumLines field value, or zero value if nil.

func (*UpdateFieldProperties) NumberFormat 

func (r *UpdateFieldProperties) NumberFormat() int

NumberFormat returns the NumberFormat field value, or zero value if nil.

func (*UpdateFieldProperties) ParentFieldId 

func (r *UpdateFieldProperties) ParentFieldId() int

ParentFieldId returns the ParentFieldId field value, or zero value if nil.

func (*UpdateFieldProperties) PostTempToken 

func (r *UpdateFieldProperties) PostTempToken() bool

PostTempToken returns the PostTempToken field value, or zero value if nil.

func (*UpdateFieldProperties) SeeVersions 

func (r *UpdateFieldProperties) SeeVersions() bool

SeeVersions returns the SeeVersions field value, or zero value if nil.

func (*UpdateFieldProperties) SnapFieldId 

func (r *UpdateFieldProperties) SnapFieldId() int

SnapFieldId returns the SnapFieldId field value, or zero value if nil.

func (*UpdateFieldProperties) SortAlpha 

func (r *UpdateFieldProperties) SortAlpha() bool

SortAlpha returns the SortAlpha field value, or zero value if nil.

func (*UpdateFieldProperties) SortAsGiven 

func (r *UpdateFieldProperties) SortAsGiven() bool

SortAsGiven returns the SortAsGiven field value, or zero value if nil.

func (*UpdateFieldProperties) SourceFieldId 

func (r *UpdateFieldProperties) SourceFieldId() int

SourceFieldId returns the SourceFieldId field value, or zero value if nil.

func (*UpdateFieldProperties) StartField 

func (r *UpdateFieldProperties) StartField() int

StartField returns the StartField field value, or zero value if nil.

func (*UpdateFieldProperties) SummaryFunction 

func (r *UpdateFieldProperties) SummaryFunction() string

SummaryFunction returns the SummaryFunction field value as a string, or empty string if nil.

func (*UpdateFieldProperties) SummaryReferenceFieldId 

func (r *UpdateFieldProperties) SummaryReferenceFieldId() int64

SummaryReferenceFieldId returns the SummaryReferenceFieldId field value, or zero value if nil.

func (*UpdateFieldProperties) SummaryTargetFieldId 

func (r *UpdateFieldProperties) SummaryTargetFieldId() int

SummaryTargetFieldId returns the SummaryTargetFieldId field value, or zero value if nil.

func (*UpdateFieldProperties) TargetFieldId 

func (r *UpdateFieldProperties) TargetFieldId() int

TargetFieldId returns the TargetFieldId field value, or zero value if nil.

func (*UpdateFieldProperties) TargetTableId 

func (r *UpdateFieldProperties) TargetTableId() string

TargetTableId returns the TargetTableId field value, or zero value if nil.

func (*UpdateFieldProperties) TargetTableName 

func (r *UpdateFieldProperties) TargetTableName() string

TargetTableName returns the TargetTableName field value, or zero value if nil.

func (*UpdateFieldProperties) Units 

func (r *UpdateFieldProperties) Units() string

Units returns the Units field value, or zero value if nil.

func (*UpdateFieldProperties) UseI18NFormat 

func (r *UpdateFieldProperties) UseI18NFormat() bool

UseI18NFormat returns the UseI18NFormat field value, or zero value if nil.

func (*UpdateFieldProperties) UseNewWindow 

func (r *UpdateFieldProperties) UseNewWindow() bool

UseNewWindow returns the UseNewWindow field value, or zero value if nil.

func (*UpdateFieldProperties) VersionMode 

func (r *UpdateFieldProperties) VersionMode() string

VersionMode returns the VersionMode field value as a string, or empty string if nil.

func (*UpdateFieldProperties) Width 

func (r *UpdateFieldProperties) Width() int

Width returns the Width field value, or zero value if nil.

func (*UpdateFieldProperties) WorkWeek 

func (r *UpdateFieldProperties) WorkWeek() int

WorkWeek returns the WorkWeek field value, or zero value if nil.

func (*UpdateFieldProperties) XmlTag 

func (r *UpdateFieldProperties) XmlTag() string

XmlTag returns the XmlTag field value, or zero value if nil.

type UpdateFieldProperties_CompositeFields_Item added in v2.2.0 

type UpdateFieldProperties_CompositeFields_Item struct {
	*generated.UpdateFieldProperties_CompositeFields_Item
}

UpdateFieldProperties_CompositeFields_Item wraps UpdateFieldProperties_CompositeFields_Item with convenience methods.

type UpdateFieldResponse 

type UpdateFieldResponse = generated.UpdateFieldResponse

type UpdateFieldResult 

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

UpdateFieldResult wraps UpdateFieldResponse with convenience methods.

func (*UpdateFieldResult) AppearsByDefault 

func (r *UpdateFieldResult) AppearsByDefault() bool

AppearsByDefault returns the AppearsByDefault field value, or zero value if nil.

func (*UpdateFieldResult) Audited 

func (r *UpdateFieldResult) Audited() bool

Audited returns the Audited field value, or zero value if nil.

func (*UpdateFieldResult) Bold 

func (r *UpdateFieldResult) Bold() bool

Bold returns the Bold field value, or zero value if nil.

func (*UpdateFieldResult) DoesDataCopy 

func (r *UpdateFieldResult) DoesDataCopy() bool

DoesDataCopy returns the DoesDataCopy field value, or zero value if nil.

func (*UpdateFieldResult) FieldHelp 

func (r *UpdateFieldResult) FieldHelp() string

FieldHelp returns the FieldHelp field value, or zero value if nil.

func (*UpdateFieldResult) FieldType 

func (r *UpdateFieldResult) FieldType() string

FieldType returns the FieldType field value, or zero value if nil.

func (*UpdateFieldResult) FindEnabled 

func (r *UpdateFieldResult) FindEnabled() bool

FindEnabled returns the FindEnabled field value, or zero value if nil.

func (*UpdateFieldResult) Id 

func (r *UpdateFieldResult) Id() int64

Id returns the Id field value.

func (*UpdateFieldResult) Label 

func (r *UpdateFieldResult) Label() string

Label returns the Label field value, or zero value if nil.

func (*UpdateFieldResult) Mode 

func (r *UpdateFieldResult) Mode() string

Mode returns the Mode field value, or zero value if nil.

func (*UpdateFieldResult) NoWrap 

func (r *UpdateFieldResult) NoWrap() bool

NoWrap returns the NoWrap field value, or zero value if nil.

func (*UpdateFieldResult) Permissions added in v2.2.0 

func (r *UpdateFieldResult) Permissions() []*UpdateFieldPermissionsItem

Permissions returns the Permissions field as wrapped types, or nil if not set.

func (*UpdateFieldResult) Properties 

func (r *UpdateFieldResult) Properties() *UpdateFieldProperties

Properties returns the Properties field as a wrapped type, or nil if not set.

func (*UpdateFieldResult) Raw added in v2.1.0 

func (r *UpdateFieldResult) Raw() *generated.UpdateFieldResponse

Raw returns the underlying generated response.

func (*UpdateFieldResult) Required 

func (r *UpdateFieldResult) Required() bool

Required returns the Required field value, or zero value if nil.

func (*UpdateFieldResult) Unique 

func (r *UpdateFieldResult) Unique() bool

Unique returns the Unique field value, or zero value if nil.

type UpdateRelationshipBuilder 

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

UpdateRelationshipBuilder provides a fluent API for the updateRelationship operation. Update a relationship

func (*UpdateRelationshipBuilder) LookupFieldIds 

func (b *UpdateRelationshipBuilder) LookupFieldIds(values ...int) *UpdateRelationshipBuilder

LookupFieldIds An array of field IDs on the parent table that will become lookup fields on the child table.

func (*UpdateRelationshipBuilder) Run 

func (b *UpdateRelationshipBuilder) Run(ctx context.Context) (*UpdateRelationshipResult, error)

Run executes the updateRelationship request and returns the response data directly.

func (*UpdateRelationshipBuilder) SummaryFields 

func (b *UpdateRelationshipBuilder) SummaryFields(values ...map[string]any) *UpdateRelationshipBuilder

SummaryFields An array of objects, each representing a configuration of one field from the child table, that will become summary fields on the parent table. When you specify the 'COUNT' accumulation type, you have to specify 0 as the summaryFid (or not set it in the request). 'DISTINCT-COUNT' requires that summaryFid be set to an actual fid.

type UpdateRelationshipForeignKeyField 

type UpdateRelationshipForeignKeyField struct {
	*generated.UpdateRelationshipForeignKeyField
}

UpdateRelationshipForeignKeyField wraps UpdateRelationshipForeignKeyField with convenience methods.

func (*UpdateRelationshipForeignKeyField) Id 

func (r *UpdateRelationshipForeignKeyField) Id() int

Id returns the Id field value, or zero value if nil.

func (*UpdateRelationshipForeignKeyField) Label 

func (r *UpdateRelationshipForeignKeyField) Label() string

Label returns the Label field value, or zero value if nil.

func (*UpdateRelationshipForeignKeyField) Type 

func (r *UpdateRelationshipForeignKeyField) Type() string

Type returns the Type field value, or zero value if nil.

type UpdateRelationshipJSONRequestBody 

type UpdateRelationshipJSONRequestBody = generated.UpdateRelationshipJSONRequestBody

type UpdateRelationshipLookupFieldsItem 

type UpdateRelationshipLookupFieldsItem struct {
	*generated.UpdateRelationshipLookupFieldsItem
}

UpdateRelationshipLookupFieldsItem wraps UpdateRelationshipLookupFieldsItem with convenience methods.

func (*UpdateRelationshipLookupFieldsItem) Id 

func (r *UpdateRelationshipLookupFieldsItem) Id() int

Id returns the Id field value, or zero value if nil.

func (*UpdateRelationshipLookupFieldsItem) Label 

func (r *UpdateRelationshipLookupFieldsItem) Label() string

Label returns the Label field value, or zero value if nil.

func (*UpdateRelationshipLookupFieldsItem) Type 

func (r *UpdateRelationshipLookupFieldsItem) Type() string

Type returns the Type field value, or zero value if nil.

type UpdateRelationshipResponse 

type UpdateRelationshipResponse = generated.UpdateRelationshipResponse

type UpdateRelationshipResult 

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

UpdateRelationshipResult wraps UpdateRelationshipResponse with convenience methods.

func (*UpdateRelationshipResult) ChildTableId 

func (r *UpdateRelationshipResult) ChildTableId() string

ChildTableId returns the ChildTableId field value.

func (*UpdateRelationshipResult) ForeignKeyField 

func (r *UpdateRelationshipResult) ForeignKeyField() *UpdateRelationshipForeignKeyField

ForeignKeyField returns the ForeignKeyField field as a wrapped type, or nil if not set.

func (*UpdateRelationshipResult) Id 

func (r *UpdateRelationshipResult) Id() int

Id returns the Id field value.

func (*UpdateRelationshipResult) IsCrossApp 

func (r *UpdateRelationshipResult) IsCrossApp() bool

IsCrossApp returns the IsCrossApp field value.

func (*UpdateRelationshipResult) LookupFields 

func (r *UpdateRelationshipResult) LookupFields() []*UpdateRelationshipLookupFieldsItem

LookupFields returns the LookupFields field as wrapped types, or nil if not set.

func (*UpdateRelationshipResult) ParentTableId 

func (r *UpdateRelationshipResult) ParentTableId() string

ParentTableId returns the ParentTableId field value.

func (*UpdateRelationshipResult) Raw added in v2.1.0 

func (r *UpdateRelationshipResult) Raw() *generated.UpdateRelationshipResponse

Raw returns the underlying generated response.

func (*UpdateRelationshipResult) SummaryFields 

func (r *UpdateRelationshipResult) SummaryFields() []*UpdateRelationshipSummaryFieldsItem

SummaryFields returns the SummaryFields field as wrapped types, or nil if not set.

type UpdateRelationshipSummaryFieldsItem 

type UpdateRelationshipSummaryFieldsItem struct {
	*generated.UpdateRelationshipSummaryFieldsItem
}

UpdateRelationshipSummaryFieldsItem wraps UpdateRelationshipSummaryFieldsItem with convenience methods.

func (*UpdateRelationshipSummaryFieldsItem) Id 

func (r *UpdateRelationshipSummaryFieldsItem) Id() int

Id returns the Id field value, or zero value if nil.

func (*UpdateRelationshipSummaryFieldsItem) Label 

func (r *UpdateRelationshipSummaryFieldsItem) Label() string

Label returns the Label field value, or zero value if nil.

func (*UpdateRelationshipSummaryFieldsItem) Type 

func (r *UpdateRelationshipSummaryFieldsItem) Type() string

Type returns the Type field value, or zero value if nil.

type UpdateSolutionBuilder 

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

UpdateSolutionBuilder provides a fluent API for the updateSolution operation. Update a solution

func (*UpdateSolutionBuilder) Run 

func (b *UpdateSolutionBuilder) Run(ctx context.Context) (*generated.UpdateSolutionResponse, error)

Run executes the updateSolution request and returns the response data directly.

type UpdateSolutionJSONRequestBody 

type UpdateSolutionJSONRequestBody = generated.UpdateSolutionJSONRequestBody

type UpdateSolutionParams 

type UpdateSolutionParams = generated.UpdateSolutionParams

type UpdateSolutionResponse 

type UpdateSolutionResponse = generated.UpdateSolutionResponse

type UpdateSolutionResult added in v2.1.0 

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

UpdateSolutionResult wraps UpdateSolutionResponse with convenience methods.

func (*UpdateSolutionResult) Raw added in v2.1.0 

func (r *UpdateSolutionResult) Raw() *generated.UpdateSolutionResponse

Raw returns the underlying generated response.

type UpdateSolutionToRecordBuilder 

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

UpdateSolutionToRecordBuilder provides a fluent API for the updateSolutionToRecord operation. Update solution from record

func (*UpdateSolutionToRecordBuilder) FieldId 

func (b *UpdateSolutionToRecordBuilder) FieldId(value int) *UpdateSolutionToRecordBuilder

FieldId The unique identifier (fid) of the field. It needs to be a file attachment field.

func (*UpdateSolutionToRecordBuilder) RecordId 

func (b *UpdateSolutionToRecordBuilder) RecordId(value int) *UpdateSolutionToRecordBuilder

RecordId The unique identifier of the record.

func (*UpdateSolutionToRecordBuilder) Run 

func (b *UpdateSolutionToRecordBuilder) Run(ctx context.Context) (*generated.UpdateSolutionToRecordResponse, error)

Run executes the updateSolutionToRecord request and returns the response data directly.

type UpdateSolutionToRecordParams 

type UpdateSolutionToRecordParams = generated.UpdateSolutionToRecordParams

type UpdateSolutionToRecordResponse 

type UpdateSolutionToRecordResponse = generated.UpdateSolutionToRecordResponse

type UpdateSolutionToRecordResult added in v2.1.0 

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

UpdateSolutionToRecordResult wraps UpdateSolutionToRecordResponse with convenience methods.

func (*UpdateSolutionToRecordResult) Raw added in v2.1.0 

func (r *UpdateSolutionToRecordResult) Raw() *generated.UpdateSolutionToRecordResponse

Raw returns the underlying generated response.

type UpdateTableBuilder 

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

UpdateTableBuilder provides a fluent API for the updateTable operation. Update a table

func (*UpdateTableBuilder) AppId 

func (b *UpdateTableBuilder) AppId(value string) *UpdateTableBuilder

AppId The unique identifier of an app

func (*UpdateTableBuilder) Description 

func (b *UpdateTableBuilder) Description(value string) *UpdateTableBuilder

Description The description for the table. If this value is not passed the default value is blank.

func (*UpdateTableBuilder) Name 

func (b *UpdateTableBuilder) Name(value string) *UpdateTableBuilder

Name The name for the table.

func (*UpdateTableBuilder) PluralRecordName 

func (b *UpdateTableBuilder) PluralRecordName(value string) *UpdateTableBuilder

PluralRecordName The plural noun for records in the table. If this value is not passed the default value is 'Records'.

func (*UpdateTableBuilder) Run 

func (b *UpdateTableBuilder) Run(ctx context.Context) (*UpdateTableResult, error)

Run executes the updateTable request and returns the response data directly.

func (*UpdateTableBuilder) SingleRecordName 

func (b *UpdateTableBuilder) SingleRecordName(value string) *UpdateTableBuilder

SingleRecordName The singular noun for records in the table. If this value is not passed the default value is 'Record'.

type UpdateTableJSONRequestBody 

type UpdateTableJSONRequestBody = generated.UpdateTableJSONRequestBody

type UpdateTableParams 

type UpdateTableParams = generated.UpdateTableParams

type UpdateTableResponse 

type UpdateTableResponse = generated.UpdateTableResponse

type UpdateTableResult 

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

UpdateTableResult wraps UpdateTableResponse with convenience methods.

func (*UpdateTableResult) Alias 

func (r *UpdateTableResult) Alias() string

Alias returns the Alias field value, or zero value if nil.

func (*UpdateTableResult) Created 

func (r *UpdateTableResult) Created() string

Created returns the Created field value, or zero value if nil.

func (*UpdateTableResult) DefaultSortFieldId 

func (r *UpdateTableResult) DefaultSortFieldId() int

DefaultSortFieldId returns the DefaultSortFieldId field value, or zero value if nil.

func (*UpdateTableResult) DefaultSortOrder 

func (r *UpdateTableResult) DefaultSortOrder() string

DefaultSortOrder returns the DefaultSortOrder field value as a string, or empty string if nil.

func (*UpdateTableResult) Description 

func (r *UpdateTableResult) Description() string

Description returns the Description field value, or zero value if nil.

func (*UpdateTableResult) Id 

func (r *UpdateTableResult) Id() string

Id returns the Id field value, or zero value if nil.

func (*UpdateTableResult) KeyFieldId 

func (r *UpdateTableResult) KeyFieldId() int

KeyFieldId returns the KeyFieldId field value, or zero value if nil.

func (*UpdateTableResult) Name 

func (r *UpdateTableResult) Name() string

Name returns the Name field value, or zero value if nil.

func (*UpdateTableResult) NextFieldId 

func (r *UpdateTableResult) NextFieldId() int

NextFieldId returns the NextFieldId field value, or zero value if nil.

func (*UpdateTableResult) NextRecordId 

func (r *UpdateTableResult) NextRecordId() int

NextRecordId returns the NextRecordId field value, or zero value if nil.

func (*UpdateTableResult) PluralRecordName 

func (r *UpdateTableResult) PluralRecordName() string

PluralRecordName returns the PluralRecordName field value, or zero value if nil.

func (*UpdateTableResult) Raw added in v2.1.0 

func (r *UpdateTableResult) Raw() *generated.UpdateTableResponse

Raw returns the underlying generated response.

func (*UpdateTableResult) SingleRecordName 

func (r *UpdateTableResult) SingleRecordName() string

SingleRecordName returns the SingleRecordName field value, or zero value if nil.

func (*UpdateTableResult) SizeLimit 

func (r *UpdateTableResult) SizeLimit() string

SizeLimit returns the SizeLimit field value, or zero value if nil.

func (*UpdateTableResult) SpaceRemaining 

func (r *UpdateTableResult) SpaceRemaining() string

SpaceRemaining returns the SpaceRemaining field value, or zero value if nil.

func (*UpdateTableResult) SpaceUsed 

func (r *UpdateTableResult) SpaceUsed() string

SpaceUsed returns the SpaceUsed field value, or zero value if nil.

func (*UpdateTableResult) Updated 

func (r *UpdateTableResult) Updated() string

Updated returns the Updated field value, or zero value if nil.

type UpdateTrusteesBuilder 

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

UpdateTrusteesBuilder provides a fluent API for the updateTrustees operation. Update trustees of an app

func (*UpdateTrusteesBuilder) Run 

func (b *UpdateTrusteesBuilder) Run(ctx context.Context) (*UpdateTrusteesResult, error)

Run executes the updateTrustees request and returns the response data directly.

type UpdateTrusteesResult 

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

UpdateTrusteesResult wraps UpdateTrusteesResponse with convenience methods.

func (*UpdateTrusteesResult) Raw added in v2.1.0 

func (r *UpdateTrusteesResult) Raw() *generated.UpdateTrusteesResponse

Raw returns the underlying generated response.

type UpsertBuilder 

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

UpsertBuilder provides a fluent API for the upsert operation. Insert/Update record(s)

func (*UpsertBuilder) Data 

func (b *UpsertBuilder) Data(values ...any) *UpsertBuilder

Data Record data array, where each record contains key-value mappings of fields to be defined/updated and their values.

func (*UpsertBuilder) FieldsToReturn 

func (b *UpsertBuilder) FieldsToReturn(values ...int) *UpsertBuilder

FieldsToReturn Specify an array of field IDs that will return data for any updates or added record. Record ID (FID 3) is always returned if any field ID is requested.

func (*UpsertBuilder) MergeFieldId 

func (b *UpsertBuilder) MergeFieldId(value int) *UpsertBuilder

MergeFieldId The merge field id.

func (*UpsertBuilder) Run 

func (b *UpsertBuilder) Run(ctx context.Context) (*UpsertResult, error)

Run executes the upsert request and returns the response data directly.

type UpsertMetadata 

type UpsertMetadata struct {
	*generated.UpsertMetadata
}

UpsertMetadata wraps UpsertMetadata with convenience methods.

func (*UpsertMetadata) CreatedRecordIds 

func (r *UpsertMetadata) CreatedRecordIds() []int

CreatedRecordIds returns the CreatedRecordIds field value, or nil if not set.

func (*UpsertMetadata) TotalNumberOfRecordsProcessed 

func (r *UpsertMetadata) TotalNumberOfRecordsProcessed() int

TotalNumberOfRecordsProcessed returns the TotalNumberOfRecordsProcessed field value, or zero value if nil.

func (*UpsertMetadata) UnchangedRecordIds 

func (r *UpsertMetadata) UnchangedRecordIds() []int

UnchangedRecordIds returns the UnchangedRecordIds field value, or nil if not set.

func (*UpsertMetadata) UpdatedRecordIds 

func (r *UpsertMetadata) UpdatedRecordIds() []int

UpdatedRecordIds returns the UpdatedRecordIds field value, or nil if not set.

type UpsertResult 

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

UpsertResult wraps UpsertResponse with convenience methods.

func (*UpsertResult) Metadata 

func (r *UpsertResult) Metadata() *UpsertMetadata

Metadata returns the Metadata field as a wrapped type, or nil if not set.

func (*UpsertResult) Raw added in v2.1.0 

func (r *UpsertResult) Raw() *generated.UpsertResponse

Raw returns the underlying generated response.

func (*UpsertResult) Records 

func (r *UpsertResult) Records() []Record

Records returns the record data as unwrapped maps. Returns nil if Data is nil.

type UsersResult 

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

UsersResult wraps GetUsersResponse with convenience methods.

func (*UsersResult) Raw added in v2.1.0 

func (r *UsersResult) Raw() *generated.GetUsersResponse

Raw returns the underlying generated response.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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