package
0.2.8
Repository: https://github.com/quickbase/quickbase-cli.git
Documentation: pkg.go.dev

# Functions

DirExists returns true if dirname exists and is a directory.
FileExists returns true if filename exists and is a file.
Filepath is a cross-platform solution for generating filepaths.
MaskUserToken masks user tokens in a byte slice.
MaskUserTokenString masks user tokens in a string.
New returns a new Client.
NewAddressCityValue returns a new Value of the FieldAddressCity type.
NewAddressCountryValue returns a new Value of the FieldAddressCountry type.
NewAddressPostalCodeValue returns a new Value of the FieldAddressPostalCode type.
NewAddressStateRegionValue returns a new Value of the FieldAddressStateRegion type.
NewAddressStreet1Value returns a new Value of the FieldAddressStreet1 type.
NewAddressStreet2Value returns a new Value of the FieldAddressStreet2 type.
NewAddressValue returns a new Value of the FieldAddress type.
NewCheckboxValue returns a new Value of the FieldCheckbox type.
NewCheckboxValueFromString returns a new Value of the FieldCheckbox type given a passed string.
NewConfig returns a new config.
NewDateTimeValue returns a new Value of the FieldDateTime type.
NewDateTimeValueFromString returns a new Value of the FieldDate type, parsing the passed string into a time.Time.
NewDateValue returns a new Value of the FieldDate type.
NewDateValueFromString returns a new Value of the FieldDate type, parsing the passed string into a time.Time.
NewDurationValue returns a new Value of the FieldDuration type.
NewDurationValueFromFloat64 returns a new Value of the FieldDuration type, converting the passed float64 into a duration.
NewDurationValueFromString returns a new Value of the FieldDuration type given a passed string.
NewEmailAddressValue returns a new Value of the FieldEmailAddress type.
NewFileAttachmentValue returns a new Value of the FieldFileAttachment type.
NewFromProfile returns a new Client, initializing the config from the passed profile.
NewiCalendarValue returns a new Value of the FieldiCalendar type.
NewListUserValue returns a new Value of the FieldUserList type.
NewListUserValueFromString returns a new Value of the FieldUserList type given a passed string.
NewMultiSelectTextValue returns a new Value of the FieldMultiSelectText type.
NewMultiSelectTextValueFromString returns a new Value of the FieldMultiSelectText type given a string with a comma-separated list of values.
NewNumericCurrencyValue returns a new Value of the FieldNumericCurrency type.
NewNumericCurrencyValueFromString returns a new Value of the FieldNumericCurrency type given a string.
NewNumericPercentValue returns a new Value of the FieldNumericPercent type.
NewNumericPercentValueFromString returns a new Value of the FieldNumericPercent type given a string.
NewNumericRatingValue returns a new Value of the FieldNumericRating type.
NewNumericRatingValueFromString returns a new Value of the FieldNumericRating type given a string.
NewNumericValue returns a new Value of the FieldNumeric type.
NewNumericValueFromString returns a new Value of the FieldNumeric type given a string.
NewPhoneNumberValue returns a new Value of the FieldPhoneNumber type.
NewPredecessorValue returns a new Value of the FieldPredecessor type.
NewRecordIDValue returns a new Value of the FieldRecordID type.
NewRecordIDValueFromString returns a new Value of the FieldRecordID type.
NewReportLinkValue returns a new Value of the FieldReportLink type.
NewRichTextValue returns a new Value of the FieldRichText type.
NewTextMultiLineValue returns a new Value of the FieldTextMultiLine type.
NewTextMultipleChoiceValue returns a new Value of the FieldTextMultipleChoice type.
NewTextValue returns a new Value of the FieldText type.
NewTimeOfDayValue returns a new Value of the FieldTimeOfDay type.
NewTimeOfDayValueFromString returns a new Value of the FieldDate type, parsing the passed string into a time.Time.
NewURLValue returns a new Value of the FieldURL type.
NewURLValueFromString returns a new Value of the FieldURL type.
NewUserValue returns a new Value of the FieldUser type.
NewUserValueFromString returns a new Value of the FieldUser type given a passed string.
NewValueFromString returns a new *Value from a string given the Quick Base field type.
NewvCardValue returns a new Value of the FieldvCard type.
NoValidation always returns a nil error.
ParseList parses a string into a string slice.
ReadConfigFile reads and parses the configuration file.
ReadInConfig reads in configuration from the config file.
TableAlias converts a label to a table alias.
ValidateHostname validates the passed hostname.
ValidateNotEmptyFn returns a function that validates a string isn't empty.
WriteConfigFile writes a configuration file.

# Constants

AccumulationType* constants contain valid accumulation types for summary fields.
AccumulationType* constants contain valid accumulation types for summary fields.
AccumulationType* constants contain valid accumulation types for summary fields.
AccumulationType* constants contain valid accumulation types for summary fields.
AccumulationType* constants contain valid accumulation types for summary fields.
AccumulationType* constants contain valid accumulation types for summary fields.
AccumulationType* constants contain valid accumulation types for summary fields.
AccumulationType* constants contain valid accumulation types for summary fields.
ConfigFilename is the name of the configuration file.
EnvPrefix is the prefix for environment variables containing configuration.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Field* constants contain the Quick Base field types.
Format* constants contain common format strings.
Format* constants contain common format strings.
Format* constants contain common format strings.
Option* constants contain CLI options.
Option* constants contain CLI options.
Option* constants contain CLI options.
Option* constants contain CLI options.
Option* constants contain CLI options.
Option* constants contain CLI options.
Option* constants contain CLI options.
Option* constants contain CLI options.
SortBy* constants model values used in the the order property.
SortBy* constants model values used in the the order property.

# Variables

ErrInvalidType is an invalid field type error.
Version is the application version, set through ldflags.

# Structs

App models an app.
Client makes requests to the Quick Base API.
CloneUserTokenInput models the input sent to POST /v1/usertoken/clone.
CloneUserTokenOutput models the output returned by POST /v1/usertoken/clone.
CloneUserTokenOutputApp models the apps property.
Config contains configuration for the client.
ConfigFileProfile models the configuration for a profile.
CopyAppInput models the input sent to POST /v1/apps/{appId}/copy.
CopyAppInputProperties models the properties property.
CopyAppOutput models the output returned by POST /v1/apps/{appId}/copy.
CreateAppInput models the input sent to POST /v1/apps.
CreateAppOutput models the output returned by POST /v1/apps.
CreateFieldInput models the input sent to POST /v1/fields?tableId={tableId}.
CreateFieldInputProperties models the "properties" property.
CreateFieldOutput models the output returned by POST /v1/fields?tableId={tableId}.
CreateFieldOutputProperties models the "properties" property.
CreateFileInput models the XML API request sent to API_UploadFile See https://help.quickbase.com/api-guide/index.html#uploadfile.html.
CreateFileInputField models the field element.
CreateFileOutput models the XML API response returned by API_UploadFile See https://help.quickbase.com/api-guide/index.html#uploadfile.html.
CreateFileOutputField models the file_fields element.
CreatePageInput models the XML API request sent to API_AddReplaceDBPage See https://help.quickbase.com/api-guide/index.html#add_replace_dbpage.html.
CreatePageInputBody models the pagebody element.
CreatePageOutput models the XML API response returned by API_AddReplaceDBPage See https://help.quickbase.com/api-guide/index.html#add_replace_dbpage.html.
CreateRelationshipInput models the input sent to POST /v1/tables/{tableId}/relationship.
CreateRelationshipInputForeignKeyField models the summaryFields property.
CreateRelationshipOutput models the output returned by POST /v1/tables/{tableId}/relationship.
CreateTableInput models the input sent to POST /v1/tables?appId={appId}.
CreateTableOutput models the output returned by POST /v1/tables?appId={appId}.
Date models a Quickbase date.
DeactivateUserTokenInput models the input sent to POST /v1/usertoken/deactivate.
DeactivateUserTokenOutput models the output returned by POST /v1/usertoken/deactivate.
DeleteAppInput models the input sent to DELETE /v1/apps/{appId}.
DeleteAppOutput models the output returned by DELETE /v1/apps/{appId}.
DeleteFieldsInput models the input sent to DELETE v1/fields?tableId={tableId}.
DeleteFieldsOutput models the output returned by DELETE v1/fields?tableId={tableId}.
DeleteFileInput models the input sent to DELETE /v1/files/{tableId}/{recordId}/{fieldId}/{versionNumber}.
DeleteFileOutput models the output returned by DELETE /v1/files/{tableId}/{recordId}/{fieldId}/{versionNumber}.
DeleteFileOutputCreator models the creator object.
DeleteRecordsInput models the input sent to DELETE /v1/records.
DeleteRecordsOutput models the output returned by DELETE /v1/records.
DeleteRelationshipInput models the input sent to DELETE /v1/tables/{tableId}/relationship/{relationshipId} See https://developer.quickbase.com/operation/deleteRelationship.
DeleteRelationshipOutput models the output returned by DELETE /v1/tables/{tableId}/relationship/{relationshipId} See https://developer.quickbase.com/operation/deleteRelationship.
DeleteTableInput models the input sent to DELETE /v1/tables/{tableId}?appId={appId}.
DeleteTableOutput models the output returned by DELETE /v1/tables/{tableId}?appId={appId}.
DeleteUserTokenInput models the input sent to DELETE /v1/usertoken.
DeleteUserTokenOutput models the output returned by DELETE /v1/usertoken.
ErrorProperties contains properties returned during errors.
Field models a field.
FieldPermission models the permissions properties.
FieldProperties models field properties.
File models a file attachment.
FileCreator models the "version.creator" property.
FileVersion models the "version" property.
GetAppInput models the input sent to GET /v1/apps/{appId}.
GetAppOutput models the output returned by GET /v1/apps/{appId}.
GetFieldInput models the input sent to GET /v1/fields/{fieldId}?tableId={tableId}.
GetFieldOutput models the output returned by GET /v1/fields/{fieldId}?tableId={tableId}.
GetFieldOutputProperties models the "properties" property.
GetPageInput models the XML API request sent to API_GetDBPage See https://help.quickbase.com/api-guide/index.html#get_db_page.html.
GetPageOutput models the XML API response returned by API_GetDBPage See https://help.quickbase.com/api-guide/index.html#get_db_page.html.
GetReportInput models the input sent to GET /v1/reports/{reportId}?tableId={tableId}.
GetReportOutput models the output returned by GET /v1/reports/{reportId}?tableId={tableId}.
GetTableInput models the input sent to GET /v1/tables/{tableId}?appId={appId}s.
GetTableOutput models the output returned by GET /v1/tables/{tableId}?appId={appId}.
GetVariableInput models the XML API request sent to API_GetDBvar See https://help.quickbase.com/api-guide/index.html#getdbvar.html.
GetVariableOutput models the XML API response returned by API_GetDBvar.
InsertRecordsInput models the input sent to POST /v1/records.
InsertRecordsInputData models the data property.
InsertRecordsOutput models the output returned by POST /v1/records.
InsertRecordsOutputMetadata models the metadata property.
ListAppEventsInput models the input sent to GET /v1/apps/{appId}/events.
ListAppEventsOutput models the output returned by GET /v1/apps/{appId}/events.
ListAppEventsOutputEvent models the event object.
ListAppsInput models the XML API request sent to API_GrantedDBs.
ListAppsOutput models the XML API response returned by API_GrantedDBs.
ListAppsOutputDatabases modesl the databases propertie.
ListFieldsInput models the input sent to GET /v1/fields?tableId={tableId}.
ListFieldsOutput models the output returned by GET /v1/fields?tableId={tableId}.
ListFieldsOutputField models the field object.
ListFieldsOutputFieldProperties models the field object properties.
ListRelationshipsInput models the input sent to GET /v1/tables/{tableId}/relationships.
ListRelationshipsOutput models the output returned by GET /v1/tables/{tableId}/relationships.
ListRelationshipsOutputMetadata models the metadata property.
ListReportsInput models the input sent to GET /v1/reports?tableId={tableId}.
ListReportsOutput models the input sent to GET /v1/reports?tableId={tableId}.
ListTablesInput models the input sent to GET /v1/tables?appId={appId}.
ListTablesOutput models the input sent to GET /v1/tables?appId={appId}.
ListTablesOutputTable models the table object.
QueryRecordsInput models the input sent to POST /v1/records/query.
QueryRecordsInputGroupBy models the groupBy objects.
QueryRecordsInputOptions models the options object.
QueryRecordsInputSortBy models the sortBy objects.
QueryRecordsOutput models the output returned by POST /v1/records/query.
Record models a record in Quick Base.
Records models output that returns records.
RecordsData models objects in the data array.
RecordsField models objects in the fields array.
RecordsMetadata models the metadata object.
Relationship models a relationship.
RelationshipField models fields in relationship output.
RelationshipSummaryField models summary fields in relationship input/output.
Report models the report object.
ReportProperties models the properties object.
ReportPropertiesBubbles models the bubbles object.
ReportPropertiesCategories models the categories object.
ReportPropertiesColumn models the columnProperties object.
ReportPropertiesCrosstab models the crosstabs object.
ReportPropertiesDataSource models the dataSource object.
ReportPropertiesGoal models the goal object.
ReportPropertiesRange models the range object.
ReportPropertiesSeries models the series object.
ReportPropertiesSortBy models the sortBy object.
ReportPropertiesSummmarize models the summmarize object.
ReportQuery models the query object.
ReportQueryFormulaFields models the formulaFields.
ReportQueryGroupBy models the sortBy object.
ReportQuerySortBy models the sortBy object.
ReportWithDescripton is a Report with a Description property.
RunFormulaInput models the input sent to POST /v1/formula/run.
RunFormulaOutput models the output returned by POST /v1/formula/run.
RunReportInput models the input sent to POST /v1/reports/{reportId}/run?tableId={tableId}.
RunReportOutput models the output returned by POST /v1/reports/{reportId}/run?tableId={tableId}.
SetVariableInput models a request sent to API_SetDBvar via the XML API.
SetVariableOutput models the XML API response returned by API_SetDBvar See https://help.quickbase.com/api-guide/index.html#setdbvar.html.
Timestamp models a Quickbase timestamp.
UpdateAppInput models the input sent to POST /v1/apps/{appId}.
UpdateAppOutput models the output returned by POST /v1/apps/{appId}.
UpdateFieldInput models the input sent to POST /v1/fields/{fieldId}?tableId={tableId}.
UpdateFieldInputProperties models the "properties" property.
UpdateFieldOutput models the output returned by POST /v1/fields/{fieldId}?tableId={tableId}.
UpdatePageInput models the XML API request sent to API_AddReplaceDBPage See https://help.quickbase.com/api-guide/index.html#add_replace_dbpage.html.
UpdatePageInputBody models the pagebody element.
UpdatePageOutput models the XML API response returned by API_AddReplaceDBPage See https://help.quickbase.com/api-guide/index.html#add_replace_dbpage.html.
UpdateRelationshipInput models the input sent to POST /v1/tables/{tableId}/relationship/{relationshipId}.
UpdateRelationshipOutput models the output returned by POST /v1/tables/{tableId}/relationship/{relationshipId}.
UpdateTableInput models the input sent to POST /v1/tables/{tableId}?appId={appId}.
UpdateTableOutput models the output returned by POST /v1/tables/{tableId}?appId={appId}.
User models a user in Quick Base.
Value models the value of fields in Quick Base.
Variable models a variable.
XMLCredentialParameters models XML API credentials parameters and implements XMLInput.
XMLRequestParameters models common XML API request parameters.
XMLResponseParameters models common XML API response parameters and implements Output.

# Interfaces

ConfigIface is implemented by structs used to configure the cleint.
Input models the payload of API requests.
Output models the payload of API responses.
Plugin is implemented by plugins that intercept the HTTP request and response when consuming the Quick Base API.
XMLInput is implemented by requests to the XML API.

# Type aliases

ConfigFile models the configuration file.
ValidateStringFn validates a string.