models

package
v0.5.3 Latest Latest
Warning

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

 Go to latest Published: Aug 2, 2023 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	SiteRoleUnlicensed                = `Unlicensed`
	SiteRoleViewer                    = `Viewer`
	SiteRoleExplorer                  = `Explorer`
	SiteRoleExplorerCanPublish        = `ExplorerCanPublish`
	SiteRoleCreator                   = `Creator`
	SiteRoleSiteAdministratorExplorer = `SiteAdministratorExplorer`
	SiteRoleSiteAdministratorCreator  = `SiteAdministratorCreator`

	ImageResolutionHigh = `high`
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Credentials 

type Credentials struct {
	Name     string `json:"name,omitempty"`
	Password string `json:"password,omitempty"`
	Site     *Site  `json:"site,omitempty"`
	User     *User  `json:"user,omitempty"`
	Token    string `json:"token,omitempty"`
}

type DataAccelerationConfig added in v0.3.0 

type DataAccelerationConfig struct {
	AccelerationEnabled *bool      `json:"accelerationEnabled,omitempty"`
	LastUpdatedAt       *time.Time `json:"lastUpdatedAt,omitempty"`
	AccelerationStatus  *string    `json:"accelerationStatus,omitempty"`
}

type Domain 

type Domain struct {
	Name *string `json:"name,omitempty"`
}

type Error 

type Error struct {
	Summary string `json:"summary,omitempty"`
	Detail  string `json:"detail,omitempty"`
	Code    string `json:"code,omitempty"`
}

func (Error) Error 

func (e Error) Error() string

func (Error) IsHttpCode added in v0.5.2 

func (e Error) IsHttpCode(httpCode int) bool

func (Error) String added in v0.5.2 

func (e Error) String() string

type ErrorBody 

type ErrorBody struct {
	Error *Error `json:"error,omitempty"`
}

func NewErrorBody 

func NewErrorBody(b []byte) (*ErrorBody, error)

func NewErrorBodyXML added in v0.3.4 

func NewErrorBodyXML(b []byte) (*ErrorBody, error)

type Filter added in v0.3.0 

type Filter map[string]any

func (Filter) String added in v0.3.0 

func (f Filter) String() string

type Group 

type Group struct {
	ID              *string `json:"id,omitempty"`
	Name            *string `json:"name,omitempty"`
	MinimumSiteRole *string `json:"minimumSiteRole,omitempty"`
	Import          *Import `json:"import,omitempty"`
}

type GroupBody 

type GroupBody struct {
	Group *Group `json:"group,omitempty"`
}

type Import 

type Import struct {
	Source           *string `json:"source,omitempty"`
	DomainName       *string `json:"domainName,omitempty"`
	SiteRole         *string `json:"siteRole,omitempty"`
	GrantLicenseMode *string `json:"grantLicenseMode,omitempty"`
}

type Owner added in v0.3.0 

type Owner struct {
	ID *string `json:"id,omitempty"`
}

type Pagination 

type Pagination struct {
	PageNumber     string `json:"pageNumber,omitempty"`
	PageSize       string `json:"pageSize,omitempty"`
	TotalAvailable string `json:"totalAvailable,omitempty"`
}

func (Pagination) GetPageNumber 

func (p Pagination) GetPageNumber() int

func (Pagination) GetPageSize 

func (p Pagination) GetPageSize() int

func (Pagination) GetTotalAvailable 

func (p Pagination) GetTotalAvailable() int

type Project added in v0.3.0 

type Project struct {
	ID *string `json:"id,omitempty"`
}

type QueryGroupBody 

type QueryGroupBody struct {
	Pagination *Pagination `json:"pagination,omitempty"`
	Groups     *struct {
		Group []Group `json:"group,omitempty"`
	} `json:"groups,omitempty"`
}

type QueryUserBody 

type QueryUserBody struct {
	Pagination *Pagination `json:"pagination,omitempty"`
	Users      *struct {
		User []User `json:"user,omitempty"`
	} `json:"users,omitempty"`
}

type QueryViewBody added in v0.3.0 

type QueryViewBody struct {
	Pagination *Pagination `json:"pagination,omitempty"`
	Views      *struct {
		View []View `json:"view,omitempty"`
	} `json:"views,omitempty"`
}

type QueryViewImageOption added in v0.4.0 

type QueryViewImageOption struct {
	MaxAge int
	Params map[string]string
}

func (*QueryViewImageOption) AddParam added in v0.4.0 

func (o *QueryViewImageOption) AddParam(key, value string)

func (*QueryViewImageOption) DeleteParam added in v0.4.0 

func (o *QueryViewImageOption) DeleteParam(key string) string

func (*QueryViewImageOption) Encode added in v0.4.0 

func (o *QueryViewImageOption) Encode() string

func (*QueryViewImageOption) GetMaxAge added in v0.4.0 

func (o *QueryViewImageOption) GetMaxAge() int

func (*QueryViewImageOption) SetMaxAge added in v0.4.0 

func (o *QueryViewImageOption) SetMaxAge(age int)

type QueryWorkbookBody added in v0.3.0 

type QueryWorkbookBody struct {
	Pagination *Pagination `json:"pagination,omitempty"`
	Workbooks  *struct {
		Workbook []Workbook `json:"workbook,omitempty"`
	} `json:"workbooks,omitempty"`
}

type SignInBody 

type SignInBody struct {
	Credentials *Credentials `json:"credentials,omitempty"`
}

type Site 

type Site struct {
	ID         *string `json:"id,omitempty"`
	ContentUrl *string `json:"contentUrl,omitempty"`
}

type SwitchSiteBody 

type SwitchSiteBody struct {
	Site *Site `json:"site,omitempty"`
}

type Tag added in v0.3.0 

type Tag struct {
	Label string `json:"label,omitempty"`
}

type TagBody added in v0.3.0 

type TagBody struct {
	Tags *struct {
		Tag []Tag `json:"tag,omitempty"`
	} `json:"tags,omitempty"`
}

type Usage added in v0.3.0 

type Usage struct {
	TotalViewCount *string `json:"totalViewCount,omitempty"`
}

type User 

type User struct {
	ID                 *string    `json:"id,omitempty"`
	ExternalAuthUserID *string    `json:"externalAuthUserId,omitempty"`
	Name               *string    `json:"name,omitempty"`
	FullName           *string    `json:"fullName,omitempty"`
	Email              *string    `json:"email,omitempty"`
	Password           *string    `json:"password,omitempty"`
	AuthSetting        *string    `json:"authSetting,omitempty"`
	LastLogin          *time.Time `json:"lastLogin,omitempty"`
	SiteRole           *string    `json:"siteRole,omitempty"`
	Locale             *string    `json:"locale,omitempty"`
	Language           *string    `json:"language,omitempty"`
	Domain             *Domain    `json:"domain,omitempty"`
}

type UserBody 

type UserBody struct {
	User   *User   `json:"user,omitempty"`
	Domain *Domain `json:"domain,omitempty"`
}

type View added in v0.3.0 

type View struct {
	ID          *string    `json:"id,omitempty"`
	Name        *string    `json:"name,omitempty"`
	ContentUrl  *string    `json:"contentUrl,omitempty"`
	CreatedAt   *time.Time `json:"createdAt,omitempty"`
	UpdatedAt   *time.Time `json:"updatedAt,omitempty"`
	ViewUrlName *string    `json:"viewUrlName,omitempty"`
	Workbook    *Workbook  `json:"workbook,omitempty"`
	Owner       *Owner     `json:"owner,omitempty"`
	Project     *Project   `json:"project,omitempty"`
	Usage       *Usage     `json:"usage,omitempty"`
	Tags        *struct {
		Tag []Tag `json:"tag,omitempty"`
	} `json:"tags,omitempty"`
}

type ViewBody added in v0.3.0 

type ViewBody struct {
	View *View `json:"view,omitempty"`
}

type Workbook added in v0.3.0 

type Workbook struct {
	ID                     *string                 `json:"id,omitempty"`
	Name                   *string                 `json:"name,omitempty"`
	Description            *string                 `json:"description,omitempty"`
	WebpageUrl             *string                 `json:"webpageUrl,omitempty"`
	ContentUrl             *string                 `json:"contentUrl,omitempty"`
	ShowTabs               *string                 `json:"showTabs,omitempty"`
	Size                   *string                 `json:"size,omitempty"`
	CreatedAt              *time.Time              `json:"createdAt,omitempty"`
	DefaultViewID          *string                 `json:"defaultViewId,omitempty"`
	UpdatedAt              *time.Time              `json:"updatedAt,omitempty"`
	EncryptExtracts        *string                 `json:"encryptExtracts,omitempty"`
	Project                *Project                `json:"project,omitempty"`
	Owner                  *Owner                  `json:"owner,omitempty"`
	DataAccelerationConfig *DataAccelerationConfig `json:"dataAccelerationConfig,omitempty"`
	Tags                   *struct {
		Tag []Tag `json:"tag,omitempty"`
	} `json:"tags,omitempty"`
	Views *struct {
		View []View `json:"view,omitempty"`
	} `json:"views,omitempty"`
}

type WorkbookBody added in v0.3.0 

type WorkbookBody struct {
	Workbook *Workbook `json:"workbook,omitempty"`
}

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.