api

Documentation

Overview

Package api has type definitions for box

Converted from the API docs with help from https://mholt.github.io/json-to-go/

Index

• Constants
• Variables
• type AppAuth
• type AppSettings
• type CommitUpload
• type ConfigJSON
• type CopyFile
• type CreateFolder
• type CreateSharedLink
• type Error
  • func (e *Error) Error() string
• type Event
• type Events
• type FolderItems
• type Item
  • func (i *Item) ModTime() (t time.Time)
• type ItemMini
• type Parent
• type Part
• type PreUploadCheck
• type PreUploadCheckConflict
• type PreUploadCheckResponse
• type Time
  • func (t *Time) MarshalJSON() (out []byte, err error)
  • func (t *Time) UnmarshalJSON(data []byte) error
• type UpdateFileModTime
• type UpdateFileMove
• type UploadFile
• type UploadPartResponse
• type UploadSessionRequest
• type UploadSessionResponse
• type User

Constants

const (
	ItemTypeFolder    = "folder"
	ItemTypeFile      = "file"
	ItemStatusActive  = "active"
	ItemStatusTrashed = "trashed"
	ItemStatusDeleted = "deleted"
)

Types of things in Item/ItemMini

Variables

var FileTreeChangeEventTypes = map[string]struct{}{
	"ITEM_COPY":                 {},
	"ITEM_CREATE":               {},
	"ITEM_MAKE_CURRENT_VERSION": {},
	"ITEM_MODIFY":               {},
	"ITEM_MOVE":                 {},
	"ITEM_RENAME":               {},
	"ITEM_TRASH":                {},
	"ITEM_UNDELETE_VIA_TRASH":   {},
	"ITEM_UPLOAD":               {},
}

FileTreeChangeEventTypes are the events that can require cache invalidation

var ItemFields = "" /* 134-byte string literal not displayed */

ItemFields are the fields needed for FileInfo

Types

type AppAuth

type AppAuth struct {
	PublicKeyID string `json:"publicKeyID"`
	PrivateKey  string `json:"privateKey"`
	Passphrase  string `json:"passphrase"`
}

AppAuth defines the shape of the appAuth within boxAppSettings in config.json

type AppSettings

type AppSettings struct {
	ClientID     string  `json:"clientID"`
	ClientSecret string  `json:"clientSecret"`
	AppAuth      AppAuth `json:"appAuth"`
}

AppSettings defines the shape of the boxAppSettings within box config.json

type CommitUpload

type CommitUpload struct {
	Parts      []Part `json:"parts"`
	Attributes struct {
		ContentCreatedAt  Time `json:"content_created_at"`
		ContentModifiedAt Time `json:"content_modified_at"`
	} `json:"attributes"`
}

CommitUpload is used in the Commit Upload call

type ConfigJSON

type ConfigJSON struct {
	BoxAppSettings AppSettings `json:"boxAppSettings"`
	EnterpriseID   string      `json:"enterpriseID"`
}

ConfigJSON defines the shape of a box config.json

type CopyFile

type CopyFile struct {
	Name   string `json:"name"`
	Parent Parent `json:"parent"`
}

CopyFile is the request for Copy File

type CreateFolder

type CreateFolder struct {
	Name   string `json:"name"`
	Parent Parent `json:"parent"`
}

CreateFolder is the request for Create Folder

type CreateSharedLink

type CreateSharedLink struct {
	SharedLink struct {
		URL    string `json:"url,omitempty"`
		Access string `json:"access,omitempty"`
	} `json:"shared_link"`
}

CreateSharedLink is the request for Public Link

type Error

type Error struct {
	Type        string          `json:"type"`
	Status      int             `json:"status"`
	Code        string          `json:"code"`
	ContextInfo json.RawMessage `json:"context_info"`
	HelpURL     string          `json:"help_url"`
	Message     string          `json:"message"`
	RequestID   string          `json:"request_id"`
}

Error is returned from box when things go wrong

func (*Error) Error

func (e *Error) Error() string

Error returns a string for the error and satisfies the error interface

type Event

type Event struct {
	EventType string `json:"event_type"`
	EventID   string `json:"event_id"`
	Source    Item   `json:"source"`
}

Event is an array element in the response returned from /events

type Events

type Events struct {
	ChunkSize          int64   `json:"chunk_size"`
	Entries            []Event `json:"entries"`
	NextStreamPosition int64   `json:"next_stream_position"`
}

Events is returned from /events

type FolderItems

type FolderItems struct {
	TotalCount int     `json:"total_count"`
	Entries    []Item  `json:"entries"`
	Offset     int     `json:"offset"`
	Limit      int     `json:"limit"`
	NextMarker *string `json:"next_marker,omitempty"`
	Order      []struct {
		By        string `json:"by"`
		Direction string `json:"direction"`
	} `json:"order"`
}

FolderItems is returned from the GetFolderItems call

type Item

type Item struct {
	Type              string   `json:"type"`
	ID                string   `json:"id"`
	SequenceID        int64    `json:"sequence_id,string"`
	Etag              string   `json:"etag"`
	SHA1              string   `json:"sha1"`
	Name              string   `json:"name"`
	Size              float64  `json:"size"` // box returns this in xEyy format for very large numbers - see #2261
	CreatedAt         Time     `json:"created_at"`
	ModifiedAt        Time     `json:"modified_at"`
	ContentCreatedAt  Time     `json:"content_created_at"`
	ContentModifiedAt Time     `json:"content_modified_at"`
	ItemStatus        string   `json:"item_status"` // active, trashed if the file has been moved to the trash, and deleted if the file has been permanently deleted
	Parent            ItemMini `json:"parent"`
	SharedLink        struct {
		URL    string `json:"url,omitempty"`
		Access string `json:"access,omitempty"`
	} `json:"shared_link"`
	OwnedBy struct {
		Type  string `json:"type"`
		ID    string `json:"id"`
		Name  string `json:"name"`
		Login string `json:"login"`
	} `json:"owned_by"`
}

Item describes a folder or a file as returned by Get Folder Items and others

func (*Item) ModTime

func (i *Item) ModTime() (t time.Time)

ModTime returns the modification time of the item

type ItemMini

type ItemMini struct {
	Type       string `json:"type"`
	ID         string `json:"id"`
	SequenceID int64  `json:"sequence_id,string"`
	Etag       string `json:"etag"`
	SHA1       string `json:"sha1"`
	Name       string `json:"name"`
}

ItemMini is a subset of the elements in a full Item returned by some API calls

type Parent

type Parent struct {
	ID string `json:"id"`
}

Parent defined the ID of the parent directory

type Part

type Part struct {
	PartID string `json:"part_id"`
	Offset int64  `json:"offset"`
	Size   int64  `json:"size"`
	Sha1   string `json:"sha1"`
}

Part defines the return from upload part call which are passed to commit upload also

type PreUploadCheck

type PreUploadCheck struct {
	Name   string `json:"name"`
	Parent Parent `json:"parent"`
	Size   *int64 `json:"size,omitempty"`
}

PreUploadCheck is the request for upload preflight check

type PreUploadCheckConflict

type PreUploadCheckConflict struct {
	Conflicts ItemMini `json:"conflicts"`
}

PreUploadCheckConflict is returned in the ContextInfo error field from PreUploadCheck when the error code is "item_name_in_use"

type PreUploadCheckResponse

type PreUploadCheckResponse struct {
	UploadToken string `json:"upload_token"`
	UploadURL   string `json:"upload_url"`
}

PreUploadCheckResponse is the response from upload preflight check if successful

type Time

type Time time.Time

Time represents date and time information for the box API, by using RFC3339

func (*Time) MarshalJSON

func (t *Time) MarshalJSON() (out []byte, err error)

MarshalJSON turns a Time into JSON (in UTC)

func (*Time) UnmarshalJSON

func (t *Time) UnmarshalJSON(data []byte) error

UnmarshalJSON turns JSON into a Time

type UpdateFileModTime

type UpdateFileModTime struct {
	ContentModifiedAt Time `json:"content_modified_at"`
}

UpdateFileModTime is used in Update File Info

type UpdateFileMove

type UpdateFileMove struct {
	Name   string `json:"name"`
	Parent Parent `json:"parent"`
}

UpdateFileMove is the request for Upload File to change name and parent

type UploadFile

type UploadFile struct {
	Name              string `json:"name"`
	Parent            Parent `json:"parent"`
	ContentCreatedAt  Time   `json:"content_created_at"`
	ContentModifiedAt Time   `json:"content_modified_at"`
}

UploadFile is the request for Upload File

type UploadPartResponse

type UploadPartResponse struct {
	Part Part `json:"part"`
}

UploadPartResponse is returned from the upload part call

type UploadSessionRequest

type UploadSessionRequest struct {
	FolderID string `json:"folder_id,omitempty"` // don't pass for update
	FileSize int64  `json:"file_size"`
	FileName string `json:"file_name,omitempty"` // optional for update
}

UploadSessionRequest is uses in Create Upload Session

type UploadSessionResponse

type UploadSessionResponse struct {
	TotalParts       int   `json:"total_parts"`
	PartSize         int64 `json:"part_size"`
	SessionEndpoints struct {
		ListParts  string `json:"list_parts"`
		Commit     string `json:"commit"`
		UploadPart string `json:"upload_part"`
		Status     string `json:"status"`
		Abort      string `json:"abort"`
	} `json:"session_endpoints"`
	SessionExpiresAt  Time   `json:"session_expires_at"`
	ID                string `json:"id"`
	Type              string `json:"type"`
	NumPartsProcessed int    `json:"num_parts_processed"`
}

UploadSessionResponse is returned from Create Upload Session

type User

type User struct {
	Type          string    `json:"type"`
	ID            string    `json:"id"`
	Name          string    `json:"name"`
	Login         string    `json:"login"`
	CreatedAt     time.Time `json:"created_at"`
	ModifiedAt    time.Time `json:"modified_at"`
	Language      string    `json:"language"`
	Timezone      string    `json:"timezone"`
	SpaceAmount   int64     `json:"space_amount"`
	SpaceUsed     int64     `json:"space_used"`
	MaxUploadSize int64     `json:"max_upload_size"`
	Status        string    `json:"status"`
	JobTitle      string    `json:"job_title"`
	Phone         string    `json:"phone"`
	Address       string    `json:"address"`
	AvatarURL     string    `json:"avatar_url"`
}

User is returned from /users/me