qb

type AddRecordInput struct {
	RequestParams
	Credentials

	TableID           string                `xml:"-"`
	DisplayRecord     bool                  `xml:"disprec,int,omitempty"`
	SetCheckboxFields bool                  `xml:"fform,int,omitempty"`
	Fields            []AddRecordInputField `xml:"field"`
	IgnoreErrors      bool                  `xml:"ignoreError,int,omitempty"`
	MillisecondsInUtc bool                  `xml:"msInUTC,int,omitempty"`
}

type AddRecordInputField struct {
	ID       int    `xml:"fid,attr,omitempty"`
	FileName string `xml:"filename,attr,omitempty"`
	Label    string `xml:"name,attr,omitempty"`
	Value    string `xml:",chardata"`
}

type AddRecordOutput struct {
	ResponseParams

	RecordID int `xml:"rid" json:"record_id"`
	UpdateID int `xml:"update_id" json:"update_id"`
}

type AuthenticateInput struct {
	RequestParams

	Hours    int    `xml:"hours,omitempty"`
	Password string `xml:"password"`
	Username string `xml:"username"`
}

type AuthenticateOutput struct {
	ResponseParams

	Ticket string `xml:"ticket"`
	UserID string `xml:"userid"`
}

type AuthenticatedInput interface {
	Input
	// contains filtered or unexported methods
}

type Bool bool

type Client struct {

	// The HTTP client to use when sending requests. Defaults to
	// `http.DefaultClient`.
	HTTPClient *http.Client

	// Plugins contains the Plugin implementations.
	Plugins []Plugin
	// contains filtered or unexported fields
}

type Config interface {

	// Set sets a configuration option.
	Set(string, interface{})

	// AppID returns the dbid of the application used by default.
	AppID() string

	// AppToken returns the app token used to authenticate API requests.
	// See https://quickbase.com/api-guide/authentication_and_secure_access.html.
	AppToken() string

	// ConfigFile retuns the path to the TOML file that contains config. The
	// default path is "$HOME/.config/quickbase/config", where $HOME is
	// replaced with the user's home directory dependant on platform.
	ConfigFile() string

	// The realm host, e.g., https://MYREALM.quickbase.com/. Replace MYREALM
	// accordingly.
	RealmHost() string

	// TableID returns the dbid of the table used by default.
	TableID() string

	// Ticket returns the ticket used to authenticate API requests.
	// See https://quickbase.com/api-guide/authentication_and_secure_access.html
	Ticket() string

	// TicketFile returns the path to file continaing a cached ticket. The
	// default path is "$HOME/.config/quickbase/ticket", where $HOME is
	// replaced with the user's home directory dependant on platform.
	TicketFile() string

	// UserToken returns the user token used to authenticate API requests.
	// See https://quickbase.com/api-guide/create_user_tokens.html.
	UserToken() string
}

type Credentials struct {
	AppToken  string `xml:"apptoken,omitempty"`
	Ticket    string `xml:"ticket,omitempty"`
	UserToken string `xml:"usertoken,omitempty"`
}

type DoQueryInput struct {
	RequestParams
	Credentials

	TableID          string               `xml:"-"`
	Query            string               `xml:"query,omitempty"`
	QueryID          int                  `xml:"qid,omitempty"`
	QueryName        string               `xml:"qname,omitempty"`
	IncludeRecordIDs Bool                 `xml:"includeRids,omitempty"`
	ReturnPercentage Bool                 `xml:"returnpercentage,omitempty"`
	UseFieldIDs      Bool                 `xml:"useFids,omitempty"`
	Format           string               `xml:"fmt,omitempty"`
	FieldList        FieldList            `xml:"clist,omitempty"`
	SortList         FieldList            `xml:"slist,omitempty"`
	Options          *DoQueryInputOptions `xml:"options,omitempty"`
}

type DoQueryInputOptions struct {
	SortOrderList []string
	Limit         int
	Offset        int
	OnlyNew       bool
	Unsorted      bool
}

type DoQueryOutput struct {
	ResponseParams

	Fields  []DoQueryOutputField  `xml:"table>fields>field"`
	Records []DoQueryOutputRecord `xml:"table>records>record"`
}

type DoQueryOutputField struct {
	FieldID  int    `xml:"id,attr"`
	Type     string `xml:"field_type,attr"`
	BaseType string `xml:"base_type,attr"`
	Mode     string `xml:"mode,attr"`
	Label    string `xml:"label"`
}

type DoQueryOutputRecord struct {
	RecordID int                        `xml:"rid,attr"`
	UpdateID int                        `xml:"update_id"`
	Fields   []DoQueryOutputRecordField `xml:"f"`
}

type DoQueryOutputRecordField struct {
	FieldID int    `xml:"id,attr"`
	Value   string `xml:",chardata"`
}

type EditRecordInput struct {
	RequestParams
	Credentials

	TableID           string                 `xml:"-"`
	DisplayRecord     bool                   `xml:"disprec,int,omitempty"`
	SetCheckboxFields bool                   `xml:"fform,int,omitempty"`
	Fields            []EditRecordInputField `xml:"field"`
	IgnoreError       bool                   `xml:"ignoreError,int,omitempty"`
	MillisecondsInUtc bool                   `xml:"msInUTC,int,omitempty"`
	RecordID          int                    `xml:"rid"`
	UpdateID          int                    `xml:"update_id,omitempty"`
}

type EditRecordInputField struct {
	ID       int    `xml:"fid,attr,omitempty"`
	FileName string `xml:"filename,attr,omitempty"`
	Label    string `xml:"name,attr,omitempty"`
	Value    string `xml:",chardata"`
}

type EditRecordOutput struct {
	ResponseParams

	NumFieldsChanged int `xml:"num_fields_changed" json:"num_fields_changed"`
	RecordID         int `xml:"rid" json:"record_id"`
	UpdateID         int `xml:"update_id" json:"update_id"`
}

type FieldList []int

type GetSchemaInput struct {
	RequestParams
	Credentials

	ID string `xml:"-"`
}

type GetSchemaOutput struct {
	ResponseParams

	Fields []DoQueryOutputField `xml:"table>fields>field"`
}

type HTMLOutput interface {
	Output
	// contains filtered or unexported methods
}

type ImportFromCSVInput struct {
	RequestParams
	Credentials

	TableID          string                     `xml:"-"`
	FieldList        FieldList                  `xml:"clist,omitempty"`
	OutputFieldList  FieldList                  `xml:"clist_output,omitempty"`
	MergeFieldID     int                        `xml:"mergeFieldId,omitempty"`
	DecimalAsPercent Bool                       `xml:"decimalPercent,omitempty"`
	Records          *ImportFromCSVInputRecords `xml:"records_CSV"`
	SkipFirstRow     Bool                       `xml:"skipfirst,omitempty"`
}

type ImportFromCSVInputRecords struct {
	CSV string `xml:",cdata"`
}

type ImportFromCSVOutput struct {
	ResponseParams

	NumRecordsAdded   int                         `xml:"num_recs_added"`
	NumRecordsInput   int                         `xml:"num_recs_input"`
	NumRecordsUpdated int                         `xml:"num_recs_updated"`
	Records           []ImportFromCSVOutputRecord `xml:"rids>rid,omitempty"`
}

type ImportFromCSVOutputRecord struct {
	ID       int `xml:",chardata"`
	UpdateID int `xml:"update_id,attr"`
}

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

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

type Plugin interface {

	// PreRequest is the hook that is invoked prior to the request being
	// sent to the Quick Base API.
	PreRequest(context.Context, *http.Request) context.Context

	// PostResponse is the hook invoked after the response is sent from the
	// Quick Base API. This hook is invoked whether the request was
	// successful or not.
	PostResponse(context.Context, *http.Request, *http.Response, []byte, error) context.Context
}

type RequestParams struct {
	XMLName           xml.Name `xml:"qdbapi"`
	UserData          string   `xml:"udata,omitempty"`
	MillisecondsInUTC Bool     `xml:"msInUTC,omitempty"`
}

type ResponseParams struct {
	XMLName     xml.Name `xml:"qdbapi" json:"-"`
	Action      string   `xml:"action" json:"-"`
	ErrorCode   int      `xml:"errcode" json:"-"`
	ErrorText   string   `xml:"errtext" json:"-"`
	ErrorDetail string   `xml:"errdetail" json:"-"`
	UserData    string   `xml:"udata,omitempty" json:"user_data,omitempty"`
}

type SetVariableInput struct {
	RequestParams
	Credentials

	AppID string `xml:"-"`
	Name  string `xml:"varname"`
	Value string `xml:"value"`
}

type SetVariableOutput struct {
	ResponseParams
}

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

type TicketFileError struct {
	File string
	Err  error
}

type UploadFileInput struct {
	RequestParams
	Credentials

	TableID  string                 `xml:"-"`
	Fields   []UploadFileInputField `xml:"field"`
	RecordID int                    `xml:"rid"`
}

type UploadFileInputField struct {
	ID       int    `xml:"fid,attr"`
	FileData string `xml:",chardata"`
	Name     string `xml:"filename,attr"`
}

type UploadFileOutput struct {
	ResponseParams

	Fields []UploadFileOutputField `xml:"file_fields>field" json:"fields"`
}

type UploadFileOutputField struct {
	ID  int    `xml:"id,attr" json:"field_id"`
	URL string `xml:"url" json:"url"`
}