models

package
v0.0.1-rc.1 Latest Latest
Warning

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

Go to latest
Published: Jul 3, 2024 License: BSD-3-Clause Imports: 0 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AlgoArgon2

type AlgoArgon2 struct {
	// Algo type.
	Type string `json:"xtype"`
	// Memory used to compute hash.
	MemoryCost int `json:"memoryCost"`
	// Amount of time consumed to compute hash
	TimeCost int `json:"timeCost"`
	// Number of threads used to compute hash.
	Threads int `json:"threads"`
}

AlgoArgon2 Model

type AlgoBcrypt

type AlgoBcrypt struct {
	// Algo type.
	Type string `json:"xtype"`
}

AlgoBcrypt Model

type AlgoMd5

type AlgoMd5 struct {
	// Algo type.
	Type string `json:"xtype"`
}

AlgoMD5 Model

type AlgoPhpass

type AlgoPhpass struct {
	// Algo type.
	Type string `json:"xtype"`
}

AlgoPHPass Model

type AlgoScrypt

type AlgoScrypt struct {
	// Algo type.
	Type string `json:"xtype"`
	// CPU complexity of computed hash.
	CostCpu int `json:"costCpu"`
	// Memory complexity of computed hash.
	CostMemory int `json:"costMemory"`
	// Parallelization of computed hash.
	CostParallel int `json:"costParallel"`
	// Length used to compute hash.
	Length int `json:"length"`
}

AlgoScrypt Model

type AlgoScryptModified

type AlgoScryptModified struct {
	// Algo type.
	Type string `json:"xtype"`
	// Salt used to compute hash.
	Salt string `json:"salt"`
	// Separator used to compute hash.
	SaltSeparator string `json:"saltSeparator"`
	// Key used to compute hash.
	SignerKey string `json:"signerKey"`
}

AlgoScryptModified Model

type AlgoSha

type AlgoSha struct {
	// Algo type.
	Type string `json:"xtype"`
}

AlgoSHA Model

type AttributeBoolean

type AttributeBoolean struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"xtype"`
	// Attribute status. Possible values: `available`, `processing`, `deleting`,
	// `stuck`, or `failed`
	Status string `json:"status"`
	// Error message. Displays error generated on failure of creating or deleting
	// an attribute.
	Error string `json:"xerror"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default bool `json:"xdefault"`
}

AttributeBoolean Model

type AttributeDatetime

type AttributeDatetime struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"xtype"`
	// Attribute status. Possible values: `available`, `processing`, `deleting`,
	// `stuck`, or `failed`
	Status string `json:"status"`
	// Error message. Displays error generated on failure of creating or deleting
	// an attribute.
	Error string `json:"xerror"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// ISO 8601 format.
	Format string `json:"format"`
	// Default value for attribute when not provided. Only null is optional
	Default string `json:"xdefault"`
}

AttributeDatetime Model

type AttributeEmail

type AttributeEmail struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"xtype"`
	// Attribute status. Possible values: `available`, `processing`, `deleting`,
	// `stuck`, or `failed`
	Status string `json:"status"`
	// Error message. Displays error generated on failure of creating or deleting
	// an attribute.
	Error string `json:"xerror"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// String format.
	Format string `json:"format"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default string `json:"xdefault"`
}

AttributeEmail Model

type AttributeEnum

type AttributeEnum struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"xtype"`
	// Attribute status. Possible values: `available`, `processing`, `deleting`,
	// `stuck`, or `failed`
	Status string `json:"status"`
	// Error message. Displays error generated on failure of creating or deleting
	// an attribute.
	Error string `json:"xerror"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Array of elements in enumerated type.
	Elements []interface{} `json:"elements"`
	// String format.
	Format string `json:"format"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default string `json:"xdefault"`
}

AttributeEnum Model

type AttributeFloat

type AttributeFloat struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"xtype"`
	// Attribute status. Possible values: `available`, `processing`, `deleting`,
	// `stuck`, or `failed`
	Status string `json:"status"`
	// Error message. Displays error generated on failure of creating or deleting
	// an attribute.
	Error string `json:"xerror"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Minimum value to enforce for new documents.
	Min float64 `json:"min"`
	// Maximum value to enforce for new documents.
	Max float64 `json:"max"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default float64 `json:"xdefault"`
}

AttributeFloat Model

type AttributeInteger

type AttributeInteger struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"xtype"`
	// Attribute status. Possible values: `available`, `processing`, `deleting`,
	// `stuck`, or `failed`
	Status string `json:"status"`
	// Error message. Displays error generated on failure of creating or deleting
	// an attribute.
	Error string `json:"xerror"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Minimum value to enforce for new documents.
	Min int `json:"min"`
	// Maximum value to enforce for new documents.
	Max int `json:"max"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default int `json:"xdefault"`
}

AttributeInteger Model

type AttributeIp

type AttributeIp struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"xtype"`
	// Attribute status. Possible values: `available`, `processing`, `deleting`,
	// `stuck`, or `failed`
	Status string `json:"status"`
	// Error message. Displays error generated on failure of creating or deleting
	// an attribute.
	Error string `json:"xerror"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// String format.
	Format string `json:"format"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default string `json:"xdefault"`
}

AttributeIP Model

type AttributeList

type AttributeList struct {
	// Total number of attributes in the given collection.
	Total int `json:"total"`
	// List of attributes.
	Attributes []interface{} `json:"attributes"`
}

AttributesList Model

type AttributeRelationship

type AttributeRelationship struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"xtype"`
	// Attribute status. Possible values: `available`, `processing`, `deleting`,
	// `stuck`, or `failed`
	Status string `json:"status"`
	// Error message. Displays error generated on failure of creating or deleting
	// an attribute.
	Error string `json:"xerror"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// The ID of the related collection.
	RelatedCollection string `json:"relatedCollection"`
	// The type of the relationship.
	RelationType string `json:"relationType"`
	// Is the relationship two-way?
	TwoWay bool `json:"twoWay"`
	// The key of the two-way relationship.
	TwoWayKey string `json:"twoWayKey"`
	// How deleting the parent document will propagate to child documents.
	OnDelete string `json:"onDelete"`
	// Whether this is the parent or child side of the relationship
	Side string `json:"side"`
}

AttributeRelationship Model

type AttributeString

type AttributeString struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"xtype"`
	// Attribute status. Possible values: `available`, `processing`, `deleting`,
	// `stuck`, or `failed`
	Status string `json:"status"`
	// Error message. Displays error generated on failure of creating or deleting
	// an attribute.
	Error string `json:"xerror"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute size.
	Size int `json:"size"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default string `json:"xdefault"`
}

AttributeString Model

type AttributeUrl

type AttributeUrl struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"xtype"`
	// Attribute status. Possible values: `available`, `processing`, `deleting`,
	// `stuck`, or `failed`
	Status string `json:"status"`
	// Error message. Displays error generated on failure of creating or deleting
	// an attribute.
	Error string `json:"xerror"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// String format.
	Format string `json:"format"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default string `json:"xdefault"`
}

AttributeURL Model

type Bucket

type Bucket struct {
	// Bucket ID.
	Id string `json:"$id"`
	// Bucket creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Bucket update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Bucket permissions. [Learn more about
	// permissions](https://appwrite.io/docs/permissions).
	Permissions []interface{} `json:"$permissions"`
	// Whether file-level security is enabled. [Learn more about
	// permissions](https://appwrite.io/docs/permissions).
	FileSecurity bool `json:"fileSecurity"`
	// Bucket name.
	Name string `json:"name"`
	// Bucket enabled.
	Enabled bool `json:"enabled"`
	// Maximum file size supported.
	MaximumFileSize int `json:"maximumFileSize"`
	// Allowed file extensions.
	AllowedFileExtensions []interface{} `json:"allowedFileExtensions"`
	// Compression algorithm choosen for compression. Will be one of none,
	// [gzip](https://en.wikipedia.org/wiki/Gzip), or
	// [zstd](https://en.wikipedia.org/wiki/Zstd).
	Compression string `json:"compression"`
	// Bucket is encrypted.
	Encryption bool `json:"encryption"`
	// Virus scanning is enabled.
	Antivirus bool `json:"antivirus"`
}

Bucket Model

type BucketList

type BucketList struct {
	// Total number of buckets documents that matched your query.
	Total int `json:"total"`
	// List of buckets.
	Buckets []interface{} `json:"buckets"`
}

BucketsList Model

type Build

type Build struct {
	// Build ID.
	Id string `json:"$id"`
	// The deployment that created this build.
	DeploymentId string `json:"deploymentId"`
	// The build status. There are a few different types and each one means
	// something different. \nFailed - The deployment build has failed. More
	// details can usually be found in buildStderr\nReady - The deployment build
	// was successful and the deployment is ready to be deployed\nProcessing - The
	// deployment is currently waiting to have a build triggered\nBuilding - The
	// deployment is currently being built
	Status string `json:"status"`
	// The stdout of the build.
	Stdout string `json:"stdout"`
	// The stderr of the build.
	Stderr string `json:"stderr"`
	// The deployment creation date in ISO 8601 format.
	StartTime string `json:"startTime"`
	// The time the build was finished in ISO 8601 format.
	EndTime string `json:"endTime"`
	// The build duration in seconds.
	Duration int `json:"duration"`
	// The code size in bytes.
	Size int `json:"size"`
}

Build Model

type Collection

type Collection struct {
	// Collection ID.
	Id string `json:"$id"`
	// Collection creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Collection update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Collection permissions. [Learn more about
	// permissions](https://appwrite.io/docs/permissions).
	Permissions []interface{} `json:"$permissions"`
	// Database ID.
	DatabaseId string `json:"databaseId"`
	// Collection name.
	Name string `json:"name"`
	// Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the
	// collection is inaccessible to users, but remains accessible to Server SDKs
	// using API keys.
	Enabled bool `json:"enabled"`
	// Whether document-level permissions are enabled. [Learn more about
	// permissions](https://appwrite.io/docs/permissions).
	DocumentSecurity bool `json:"documentSecurity"`
	// Collection attributes.
	Attributes []interface{} `json:"attributes"`
	// Collection indexes.
	Indexes []interface{} `json:"indexes"`
}

Collection Model

type CollectionList

type CollectionList struct {
	// Total number of collections documents that matched your query.
	Total int `json:"total"`
	// List of collections.
	Collections []interface{} `json:"collections"`
}

CollectionsList Model

type Continent

type Continent struct {
	// Continent name.
	Name string `json:"name"`
	// Continent two letter code.
	Code string `json:"code"`
}

Continent Model

type ContinentList

type ContinentList struct {
	// Total number of continents documents that matched your query.
	Total int `json:"total"`
	// List of continents.
	Continents []interface{} `json:"continents"`
}

ContinentsList Model

type Country

type Country struct {
	// Country name.
	Name string `json:"name"`
	// Country two-character ISO 3166-1 alpha code.
	Code string `json:"code"`
}

Country Model

type CountryList

type CountryList struct {
	// Total number of countries documents that matched your query.
	Total int `json:"total"`
	// List of countries.
	Countries []interface{} `json:"countries"`
}

CountriesList Model

type Currency

type Currency struct {
	// Currency symbol.
	Symbol string `json:"symbol"`
	// Currency name.
	Name string `json:"name"`
	// Currency native symbol.
	SymbolNative string `json:"symbolNative"`
	// Number of decimal digits.
	DecimalDigits int `json:"decimalDigits"`
	// Currency digit rounding.
	Rounding float64 `json:"rounding"`
	// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217)
	// three-character format.
	Code string `json:"code"`
	// Currency plural name
	NamePlural string `json:"namePlural"`
}

Currency Model

type CurrencyList

type CurrencyList struct {
	// Total number of currencies documents that matched your query.
	Total int `json:"total"`
	// List of currencies.
	Currencies []interface{} `json:"currencies"`
}

CurrenciesList Model

type Database

type Database struct {
	// Database ID.
	Id string `json:"$id"`
	// Database name.
	Name string `json:"name"`
	// Database creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Database update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the
	// database is inaccessible to users, but remains accessible to Server SDKs
	// using API keys.
	Enabled bool `json:"enabled"`
}

Database Model

type DatabaseList

type DatabaseList struct {
	// Total number of databases documents that matched your query.
	Total int `json:"total"`
	// List of databases.
	Databases []interface{} `json:"databases"`
}

DatabasesList Model

type Deployment

type Deployment struct {
	// Deployment ID.
	Id string `json:"$id"`
	// Deployment creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Deployment update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Type of deployment.
	Type string `json:"xtype"`
	// Resource ID.
	ResourceId string `json:"resourceId"`
	// Resource type.
	ResourceType string `json:"resourceType"`
	// The entrypoint file to use to execute the deployment code.
	Entrypoint string `json:"entrypoint"`
	// The code size in bytes.
	Size int `json:"size"`
	// The current build ID.
	BuildId string `json:"buildId"`
	// Whether the deployment should be automatically activated.
	Activate bool `json:"activate"`
	// The deployment status. Possible values are "processing", "building",
	// "waiting", "ready", and "failed".
	Status string `json:"status"`
	// The build logs.
	BuildLogs string `json:"buildLogs"`
	// The current build time in seconds.
	BuildTime int `json:"buildTime"`
	// The name of the vcs provider repository
	ProviderRepositoryName string `json:"providerRepositoryName"`
	// The name of the vcs provider repository owner
	ProviderRepositoryOwner string `json:"providerRepositoryOwner"`
	// The url of the vcs provider repository
	ProviderRepositoryUrl string `json:"providerRepositoryUrl"`
	// The branch of the vcs repository
	ProviderBranch string `json:"providerBranch"`
	// The commit hash of the vcs commit
	ProviderCommitHash string `json:"providerCommitHash"`
	// The url of vcs commit author
	ProviderCommitAuthorUrl string `json:"providerCommitAuthorUrl"`
	// The name of vcs commit author
	ProviderCommitAuthor string `json:"providerCommitAuthor"`
	// The commit message
	ProviderCommitMessage string `json:"providerCommitMessage"`
	// The url of the vcs commit
	ProviderCommitUrl string `json:"providerCommitUrl"`
	// The branch of the vcs repository
	ProviderBranchUrl string `json:"providerBranchUrl"`
}

Deployment Model

type DeploymentList

type DeploymentList struct {
	// Total number of deployments documents that matched your query.
	Total int `json:"total"`
	// List of deployments.
	Deployments []interface{} `json:"deployments"`
}

DeploymentsList Model

type Document

type Document struct {
	// Document ID.
	Id string `json:"$id"`
	// Collection ID.
	CollectionId string `json:"$collectionId"`
	// Database ID.
	DatabaseId string `json:"$databaseId"`
	// Document creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Document update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Document permissions. [Learn more about
	// permissions](https://appwrite.io/docs/permissions).
	Permissions []interface{} `json:"$permissions"`
	// contains filtered or unexported fields
}

Document Model

type DocumentList

type DocumentList struct {
	// Total number of documents documents that matched your query.
	Total int `json:"total"`
	// List of documents.
	Documents []interface{} `json:"documents"`
}

DocumentsList Model

type Execution

type Execution struct {
	// Execution ID.
	Id string `json:"$id"`
	// Execution creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Execution upate date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Execution roles.
	Permissions []interface{} `json:"$permissions"`
	// Function ID.
	FunctionId string `json:"functionId"`
	// The trigger that caused the function to execute. Possible values can be:
	// `http`, `schedule`, or `event`.
	Trigger string `json:"trigger"`
	// The status of the function execution. Possible values can be: `waiting`,
	// `processing`, `completed`, or `failed`.
	Status string `json:"status"`
	// HTTP request method type.
	RequestMethod string `json:"requestMethod"`
	// HTTP request path and query.
	RequestPath string `json:"requestPath"`
	// HTTP response headers as a key-value object. This will return only
	// whitelisted headers. All headers are returned if execution is created as
	// synchronous.
	RequestHeaders []interface{} `json:"requestHeaders"`
	// HTTP response status code.
	ResponseStatusCode int `json:"responseStatusCode"`
	// HTTP response body. This will return empty unless execution is created as
	// synchronous.
	ResponseBody string `json:"responseBody"`
	// HTTP response headers as a key-value object. This will return only
	// whitelisted headers. All headers are returned if execution is created as
	// synchronous.
	ResponseHeaders []interface{} `json:"responseHeaders"`
	// Function logs. Includes the last 4,000 characters. This will return an
	// empty string unless the response is returned using an API key or as part of
	// a webhook payload.
	Logs string `json:"logs"`
	// Function errors. Includes the last 4,000 characters. This will return an
	// empty string unless the response is returned using an API key or as part of
	// a webhook payload.
	Errors string `json:"errors"`
	// Function execution duration in seconds.
	Duration float64 `json:"duration"`
}

Execution Model

type ExecutionList

type ExecutionList struct {
	// Total number of executions documents that matched your query.
	Total int `json:"total"`
	// List of executions.
	Executions []interface{} `json:"executions"`
}

ExecutionsList Model

type File

type File struct {
	// File ID.
	Id string `json:"$id"`
	// Bucket ID.
	BucketId string `json:"bucketId"`
	// File creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// File update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// File permissions. [Learn more about
	// permissions](https://appwrite.io/docs/permissions).
	Permissions []interface{} `json:"$permissions"`
	// File name.
	Name string `json:"name"`
	// File MD5 signature.
	Signature string `json:"signature"`
	// File mime type.
	MimeType string `json:"mimeType"`
	// File original size in bytes.
	SizeOriginal int `json:"sizeOriginal"`
	// Total number of chunks available
	ChunksTotal int `json:"chunksTotal"`
	// Total number of chunks uploaded
	ChunksUploaded int `json:"chunksUploaded"`
}

File Model

type FileList

type FileList struct {
	// Total number of files documents that matched your query.
	Total int `json:"total"`
	// List of files.
	Files []interface{} `json:"files"`
}

FilesList Model

type Function

type Function struct {
	// Function ID.
	Id string `json:"$id"`
	// Function creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Function update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Execution permissions.
	Execute []interface{} `json:"execute"`
	// Function name.
	Name string `json:"name"`
	// Function enabled.
	Enabled bool `json:"enabled"`
	// Is the function deployed with the latest configuration? This is set to
	// false if you've changed an environment variables, entrypoint, commands, or
	// other settings that needs redeploy to be applied. When the value is false,
	// redeploy the function to update it with the latest configuration.
	Live bool `json:"live"`
	// Whether executions will be logged. When set to false, executions will not
	// be logged, but will reduce resource used by your Appwrite project.
	Logging bool `json:"logging"`
	// Function execution runtime.
	Runtime string `json:"runtime"`
	// Function's active deployment ID.
	Deployment string `json:"deployment"`
	// Allowed permission scopes.
	Scopes []interface{} `json:"scopes"`
	// Function variables.
	Vars []interface{} `json:"vars"`
	// Function trigger events.
	Events []interface{} `json:"events"`
	// Function execution schedult in CRON format.
	Schedule string `json:"schedule"`
	// Function execution timeout in seconds.
	Timeout int `json:"timeout"`
	// The entrypoint file used to execute the deployment.
	Entrypoint string `json:"entrypoint"`
	// The build command used to build the deployment.
	Commands string `json:"commands"`
	// Version of Open Runtimes used for the function.
	Version string `json:"version"`
	// Function VCS (Version Control System) installation id.
	InstallationId string `json:"installationId"`
	// VCS (Version Control System) Repository ID
	ProviderRepositoryId string `json:"providerRepositoryId"`
	// VCS (Version Control System) branch name
	ProviderBranch string `json:"providerBranch"`
	// Path to function in VCS (Version Control System) repository
	ProviderRootDirectory string `json:"providerRootDirectory"`
	// Is VCS (Version Control System) connection is in silent mode? When in
	// silence mode, no comments will be posted on the repository pull or merge
	// requests
	ProviderSilentMode bool `json:"providerSilentMode"`
}

Function Model

type FunctionList

type FunctionList struct {
	// Total number of functions documents that matched your query.
	Total int `json:"total"`
	// List of functions.
	Functions []interface{} `json:"functions"`
}

FunctionsList Model

type Headers

type Headers struct {
	// Header name.
	Name string `json:"name"`
	// Header value.
	Value string `json:"value"`
}

Headers Model

type HealthAntivirus

type HealthAntivirus struct {
	// Antivirus version.
	Version string `json:"version"`
	// Antivirus status. Possible values can are: `disabled`, `offline`, `online`
	Status string `json:"status"`
}

HealthAntivirus Model

type HealthCertificate

type HealthCertificate struct {
	// Certificate name
	Name string `json:"name"`
	// Subject SN
	SubjectSN string `json:"subjectSN"`
	// Issuer organisation
	IssuerOrganisation string `json:"issuerOrganisation"`
	// Valid from
	ValidFrom string `json:"validFrom"`
	// Valid to
	ValidTo string `json:"validTo"`
	// Signature type SN
	SignatureTypeSN string `json:"signatureTypeSN"`
}

HealthCertificate Model

type HealthQueue

type HealthQueue struct {
	// Amount of actions in the queue.
	Size int `json:"size"`
}

HealthQueue Model

type HealthStatus

type HealthStatus struct {
	// Name of the service.
	Name string `json:"name"`
	// Duration in milliseconds how long the health check took.
	Ping int `json:"ping"`
	// Service status. Possible values can are: `pass`, `fail`
	Status string `json:"status"`
}

HealthStatus Model

type HealthTime

type HealthTime struct {
	// Current unix timestamp on trustful remote server.
	RemoteTime int `json:"remoteTime"`
	// Current unix timestamp of local server where Appwrite runs.
	LocalTime int `json:"localTime"`
	// Difference of unix remote and local timestamps in milliseconds.
	Diff int `json:"diff"`
}

HealthTime Model

type Identity

type Identity struct {
	// Identity ID.
	Id string `json:"$id"`
	// Identity creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Identity update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// User ID.
	UserId string `json:"userId"`
	// Identity Provider.
	Provider string `json:"provider"`
	// ID of the User in the Identity Provider.
	ProviderUid string `json:"providerUid"`
	// Email of the User in the Identity Provider.
	ProviderEmail string `json:"providerEmail"`
	// Identity Provider Access Token.
	ProviderAccessToken string `json:"providerAccessToken"`
	// The date of when the access token expires in ISO 8601 format.
	ProviderAccessTokenExpiry string `json:"providerAccessTokenExpiry"`
	// Identity Provider Refresh Token.
	ProviderRefreshToken string `json:"providerRefreshToken"`
}

Identity Model

type IdentityList

type IdentityList struct {
	// Total number of identities documents that matched your query.
	Total int `json:"total"`
	// List of identities.
	Identities []interface{} `json:"identities"`
}

IdentitiesList Model

type Index

type Index struct {
	// Index Key.
	Key string `json:"key"`
	// Index type.
	Type string `json:"xtype"`
	// Index status. Possible values: `available`, `processing`, `deleting`,
	// `stuck`, or `failed`
	Status string `json:"status"`
	// Error message. Displays error generated on failure of creating or deleting
	// an index.
	Error string `json:"xerror"`
	// Index attributes.
	Attributes []interface{} `json:"attributes"`
	// Index orders.
	Orders []interface{} `json:"orders"`
}

Index Model

type IndexList

type IndexList struct {
	// Total number of indexes documents that matched your query.
	Total int `json:"total"`
	// List of indexes.
	Indexes []interface{} `json:"indexes"`
}

IndexesList Model

type Jwt

type Jwt struct {
	// JWT encoded string.
	Jwt string `json:"jwt"`
}

JWT Model

type Language

type Language struct {
	// Language name.
	Name string `json:"name"`
	// Language two-character ISO 639-1 codes.
	Code string `json:"code"`
	// Language native name.
	NativeName string `json:"nativeName"`
}

Language Model

type LanguageList

type LanguageList struct {
	// Total number of languages documents that matched your query.
	Total int `json:"total"`
	// List of languages.
	Languages []interface{} `json:"languages"`
}

LanguagesList Model

type Locale

type Locale struct {
	// User IP address.
	Ip string `json:"ip"`
	// Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1)
	// two-character format
	CountryCode string `json:"countryCode"`
	// Country name. This field support localization.
	Country string `json:"country"`
	// Continent code. A two character continent code "AF" for Africa, "AN" for
	// Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC"
	// for Oceania, and "SA" for South America.
	ContinentCode string `json:"continentCode"`
	// Continent name. This field support localization.
	Continent string `json:"continent"`
	// True if country is part of the European Union.
	Eu bool `json:"eu"`
	// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217)
	// three-character format
	Currency string `json:"currency"`
}

Locale Model

type LocaleCode

type LocaleCode struct {
	// Locale codes in [ISO
	// 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
	Code string `json:"code"`
	// Locale name
	Name string `json:"name"`
}

LocaleCode Model

type LocaleCodeList

type LocaleCodeList struct {
	// Total number of localeCodes documents that matched your query.
	Total int `json:"total"`
	// List of localeCodes.
	LocaleCodes []interface{} `json:"localeCodes"`
}

LocaleCodesList Model

type Log

type Log struct {
	// Event name.
	Event string `json:"event"`
	// User ID.
	UserId string `json:"userId"`
	// User Email.
	UserEmail string `json:"userEmail"`
	// User Name.
	UserName string `json:"userName"`
	// API mode when event triggered.
	Mode string `json:"mode"`
	// IP session in use when the session was created.
	Ip string `json:"ip"`
	// Log creation date in ISO 8601 format.
	Time string `json:"time"`
	// Operating system code name. View list of [available
	// options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json).
	OsCode string `json:"osCode"`
	// Operating system name.
	OsName string `json:"osName"`
	// Operating system version.
	OsVersion string `json:"osVersion"`
	// Client type.
	ClientType string `json:"clientType"`
	// Client code name. View list of [available
	// options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json).
	ClientCode string `json:"clientCode"`
	// Client name.
	ClientName string `json:"clientName"`
	// Client version.
	ClientVersion string `json:"clientVersion"`
	// Client engine name.
	ClientEngine string `json:"clientEngine"`
	// Client engine name.
	ClientEngineVersion string `json:"clientEngineVersion"`
	// Device name.
	DeviceName string `json:"deviceName"`
	// Device brand name.
	DeviceBrand string `json:"deviceBrand"`
	// Device model name.
	DeviceModel string `json:"deviceModel"`
	// Country two-character ISO 3166-1 alpha code.
	CountryCode string `json:"countryCode"`
	// Country name.
	CountryName string `json:"countryName"`
}

Log Model

type LogList

type LogList struct {
	// Total number of logs documents that matched your query.
	Total int `json:"total"`
	// List of logs.
	Logs []interface{} `json:"logs"`
}

LogsList Model

type Membership

type Membership struct {
	// Membership ID.
	Id string `json:"$id"`
	// Membership creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Membership update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// User ID.
	UserId string `json:"userId"`
	// User name.
	UserName string `json:"userName"`
	// User email address.
	UserEmail string `json:"userEmail"`
	// Team ID.
	TeamId string `json:"teamId"`
	// Team name.
	TeamName string `json:"teamName"`
	// Date, the user has been invited to join the team in ISO 8601 format.
	Invited string `json:"invited"`
	// Date, the user has accepted the invitation to join the team in ISO 8601
	// format.
	Joined string `json:"joined"`
	// User confirmation status, true if the user has joined the team or false
	// otherwise.
	Confirm bool `json:"confirm"`
	// Multi factor authentication status, true if the user has MFA enabled or
	// false otherwise.
	Mfa bool `json:"mfa"`
	// User list of roles
	Roles []interface{} `json:"roles"`
}

Membership Model

type MembershipList

type MembershipList struct {
	// Total number of memberships documents that matched your query.
	Total int `json:"total"`
	// List of memberships.
	Memberships []interface{} `json:"memberships"`
}

MembershipsList Model

type Message

type Message struct {
	// Message ID.
	Id string `json:"$id"`
	// Message creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Message update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Message provider type.
	ProviderType string `json:"providerType"`
	// Topic IDs set as recipients.
	Topics []interface{} `json:"topics"`
	// User IDs set as recipients.
	Users []interface{} `json:"users"`
	// Target IDs set as recipients.
	Targets []interface{} `json:"targets"`
	// The scheduled time for message.
	ScheduledAt string `json:"scheduledAt"`
	// The time when the message was delivered.
	DeliveredAt string `json:"deliveredAt"`
	// Delivery errors if any.
	DeliveryErrors []interface{} `json:"deliveryErrors"`
	// Number of recipients the message was delivered to.
	DeliveredTotal int `json:"deliveredTotal"`
	// Data of the message.
	Data interface{} `json:"data"`
	// Status of delivery.
	Status string `json:"status"`
}

Message Model

type MessageList

type MessageList struct {
	// Total number of messages documents that matched your query.
	Total int `json:"total"`
	// List of messages.
	Messages []interface{} `json:"messages"`
}

MessageList Model

type MfaChallenge

type MfaChallenge struct {
	// Token ID.
	Id string `json:"$id"`
	// Token creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// User ID.
	UserId string `json:"userId"`
	// Token expiration date in ISO 8601 format.
	Expire string `json:"expire"`
}

MFAChallenge Model

type MfaFactors

type MfaFactors struct {
	// Can TOTP be used for MFA challenge for this account.
	Totp bool `json:"totp"`
	// Can phone (SMS) be used for MFA challenge for this account.
	Phone bool `json:"phone"`
	// Can email be used for MFA challenge for this account.
	Email bool `json:"email"`
	// Can recovery code be used for MFA challenge for this account.
	RecoveryCode bool `json:"recoveryCode"`
}

MFAFactors Model

type MfaRecoveryCodes

type MfaRecoveryCodes struct {
	// Recovery codes.
	RecoveryCodes []interface{} `json:"recoveryCodes"`
}

MFARecoveryCodes Model

type MfaType

type MfaType struct {
	// Secret token used for TOTP factor.
	Secret string `json:"secret"`
	// URI for authenticator apps.
	Uri string `json:"uri"`
}

MFAType Model

type Phone

type Phone struct {
	// Phone code.
	Code string `json:"code"`
	// Country two-character ISO 3166-1 alpha code.
	CountryCode string `json:"countryCode"`
	// Country name.
	CountryName string `json:"countryName"`
}

Phone Model

type PhoneList

type PhoneList struct {
	// Total number of phones documents that matched your query.
	Total int `json:"total"`
	// List of phones.
	Phones []interface{} `json:"phones"`
}

PhonesList Model

type Preferences

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

Preferences Model

type Provider

type Provider struct {
	// Provider ID.
	Id string `json:"$id"`
	// Provider creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Provider update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// The name for the provider instance.
	Name string `json:"name"`
	// The name of the provider service.
	Provider string `json:"provider"`
	// Is provider enabled?
	Enabled bool `json:"enabled"`
	// Type of provider.
	Type string `json:"xtype"`
	// Provider credentials.
	Credentials interface{} `json:"credentials"`
	// Provider options.
	Options interface{} `json:"options"`
}

Provider Model

type ProviderList

type ProviderList struct {
	// Total number of providers documents that matched your query.
	Total int `json:"total"`
	// List of providers.
	Providers []interface{} `json:"providers"`
}

ProviderList Model

type Runtime

type Runtime struct {
	// Runtime ID.
	Id string `json:"$id"`
	// Runtime Name.
	Name string `json:"name"`
	// Runtime version.
	Version string `json:"version"`
	// Base Docker image used to build the runtime.
	Base string `json:"base"`
	// Image name of Docker Hub.
	Image string `json:"image"`
	Logo string `json:"logo"`
	// List of supported architectures.
	Supports []interface{} `json:"supports"`
}

Runtime Model

type RuntimeList

type RuntimeList struct {
	// Total number of runtimes documents that matched your query.
	Total int `json:"total"`
	// List of runtimes.
	Runtimes []interface{} `json:"runtimes"`
}

RuntimesList Model

type Session

type Session struct {
	// Session ID.
	Id string `json:"$id"`
	// Session creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Session update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// User ID.
	UserId string `json:"userId"`
	// Session expiration date in ISO 8601 format.
	Expire string `json:"expire"`
	// Session Provider.
	Provider string `json:"provider"`
	// Session Provider User ID.
	ProviderUid string `json:"providerUid"`
	// Session Provider Access Token.
	ProviderAccessToken string `json:"providerAccessToken"`
	// The date of when the access token expires in ISO 8601 format.
	ProviderAccessTokenExpiry string `json:"providerAccessTokenExpiry"`
	// Session Provider Refresh Token.
	ProviderRefreshToken string `json:"providerRefreshToken"`
	// IP in use when the session was created.
	Ip string `json:"ip"`
	// Operating system code name. View list of [available
	// options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json).
	OsCode string `json:"osCode"`
	// Operating system name.
	OsName string `json:"osName"`
	// Operating system version.
	OsVersion string `json:"osVersion"`
	// Client type.
	ClientType string `json:"clientType"`
	// Client code name. View list of [available
	// options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json).
	ClientCode string `json:"clientCode"`
	// Client name.
	ClientName string `json:"clientName"`
	// Client version.
	ClientVersion string `json:"clientVersion"`
	// Client engine name.
	ClientEngine string `json:"clientEngine"`
	// Client engine name.
	ClientEngineVersion string `json:"clientEngineVersion"`
	// Device name.
	DeviceName string `json:"deviceName"`
	// Device brand name.
	DeviceBrand string `json:"deviceBrand"`
	// Device model name.
	DeviceModel string `json:"deviceModel"`
	// Country two-character ISO 3166-1 alpha code.
	CountryCode string `json:"countryCode"`
	// Country name.
	CountryName string `json:"countryName"`
	// Returns true if this the current user session.
	Current bool `json:"current"`
	// Returns a list of active session factors.
	Factors []interface{} `json:"factors"`
	// Secret used to authenticate the user. Only included if the request was made
	// with an API key
	Secret string `json:"secret"`
	// Most recent date in ISO 8601 format when the session successfully passed
	// MFA challenge.
	MfaUpdatedAt string `json:"mfaUpdatedAt"`
}

Session Model

type SessionList

type SessionList struct {
	// Total number of sessions documents that matched your query.
	Total int `json:"total"`
	// List of sessions.
	Sessions []interface{} `json:"sessions"`
}

SessionsList Model

type Subscriber

type Subscriber struct {
	// Subscriber ID.
	Id string `json:"$id"`
	// Subscriber creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Subscriber update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Target ID.
	TargetId string `json:"targetId"`
	// Target.
	Target interface{} `json:"target"`
	// Topic ID.
	UserId string `json:"userId"`
	// User Name.
	UserName string `json:"userName"`
	// Topic ID.
	TopicId string `json:"topicId"`
	// The target provider type. Can be one of the following: `email`, `sms` or
	// `push`.
	ProviderType string `json:"providerType"`
}

Subscriber Model

type SubscriberList

type SubscriberList struct {
	// Total number of subscribers documents that matched your query.
	Total int `json:"total"`
	// List of subscribers.
	Subscribers []interface{} `json:"subscribers"`
}

SubscriberList Model

type Target

type Target struct {
	// Target ID.
	Id string `json:"$id"`
	// Target creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Target update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Target Name.
	Name string `json:"name"`
	// User ID.
	UserId string `json:"userId"`
	// Provider ID.
	ProviderId string `json:"providerId"`
	// The target provider type. Can be one of the following: `email`, `sms` or
	// `push`.
	ProviderType string `json:"providerType"`
	// The target identifier.
	Identifier string `json:"identifier"`
}

Target Model

type TargetList

type TargetList struct {
	// Total number of targets documents that matched your query.
	Total int `json:"total"`
	// List of targets.
	Targets []interface{} `json:"targets"`
}

TargetList Model

type Team

type Team struct {
	// Team ID.
	Id string `json:"$id"`
	// Team creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Team update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Team name.
	Name string `json:"name"`
	// Total number of team members.
	Total int `json:"total"`
	// Team preferences as a key-value object
	Prefs interface{} `json:"prefs"`
}

Team Model

type TeamList

type TeamList struct {
	// Total number of teams documents that matched your query.
	Total int `json:"total"`
	// List of teams.
	Teams []interface{} `json:"teams"`
}

TeamsList Model

type Token

type Token struct {
	// Token ID.
	Id string `json:"$id"`
	// Token creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// User ID.
	UserId string `json:"userId"`
	// Token secret key. This will return an empty string unless the response is
	// returned using an API key or as part of a webhook payload.
	Secret string `json:"secret"`
	// Token expiration date in ISO 8601 format.
	Expire string `json:"expire"`
	// Security phrase of a token. Empty if security phrase was not requested when
	// creating a token. It includes randomly generated phrase which is also sent
	// in the external resource such as email.
	Phrase string `json:"phrase"`
}

Token Model

type Topic

type Topic struct {
	// Topic ID.
	Id string `json:"$id"`
	// Topic creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Topic update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// The name of the topic.
	Name string `json:"name"`
	// Total count of email subscribers subscribed to the topic.
	EmailTotal int `json:"emailTotal"`
	// Total count of SMS subscribers subscribed to the topic.
	SmsTotal int `json:"smsTotal"`
	// Total count of push subscribers subscribed to the topic.
	PushTotal int `json:"pushTotal"`
	// Subscribe permissions.
	Subscribe []interface{} `json:"subscribe"`
}

Topic Model

type TopicList

type TopicList struct {
	// Total number of topics documents that matched your query.
	Total int `json:"total"`
	// List of topics.
	Topics []interface{} `json:"topics"`
}

TopicList Model

type User

type User struct {
	// User ID.
	Id string `json:"$id"`
	// User creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// User update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// User name.
	Name string `json:"name"`
	// Hashed user password.
	Password string `json:"password"`
	// Password hashing algorithm.
	Hash string `json:"hash"`
	// Password hashing algorithm configuration.
	HashOptions interface{} `json:"hashOptions"`
	// User registration date in ISO 8601 format.
	Registration string `json:"registration"`
	// User status. Pass `true` for enabled and `false` for disabled.
	Status bool `json:"status"`
	// Labels for the user.
	Labels []interface{} `json:"labels"`
	// Password update time in ISO 8601 format.
	PasswordUpdate string `json:"passwordUpdate"`
	// User email address.
	Email string `json:"email"`
	// User phone number in E.164 format.
	Phone string `json:"phone"`
	// Email verification status.
	EmailVerification bool `json:"emailVerification"`
	// Phone verification status.
	PhoneVerification bool `json:"phoneVerification"`
	// Multi factor authentication status.
	Mfa bool `json:"mfa"`
	// User preferences as a key-value object
	Prefs interface{} `json:"prefs"`
	// A user-owned message receiver. A single user may have multiple e.g. emails,
	// phones, and a browser. Each target is registered with a single provider.
	Targets []interface{} `json:"targets"`
	// Most recent access date in ISO 8601 format. This attribute is only updated
	// again after 24 hours.
	AccessedAt string `json:"accessedAt"`
}

User Model

type UserList

type UserList struct {
	// Total number of users documents that matched your query.
	Total int `json:"total"`
	// List of users.
	Users []interface{} `json:"users"`
}

UsersList Model

type Variable

type Variable struct {
	// Variable ID.
	Id string `json:"$id"`
	// Variable creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Variable creation date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Variable key.
	Key string `json:"key"`
	// Variable value.
	Value string `json:"value"`
	// Service to which the variable belongs. Possible values are "project",
	// "function"
	ResourceType string `json:"resourceType"`
	// ID of resource to which the variable belongs. If resourceType is "project",
	// it is empty. If resourceType is "function", it is ID of the function.
	ResourceId string `json:"resourceId"`
}

Variable Model

type VariableList

type VariableList struct {
	// Total number of variables documents that matched your query.
	Total int `json:"total"`
	// List of variables.
	Variables []interface{} `json:"variables"`
}

VariablesList Model

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL