models

package
v7.2.0 Latest Latest
Warning

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

Go to latest
Published: Sep 2, 2026 License: BSD-3-Clause Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivityEvent

type ActivityEvent struct {
	// Event ID.
	Id string `json:"$id"`
	// Actor type.
	ActorType string `json:"actorType"`
	// Actor ID.
	ActorId string `json:"actorId"`
	// Actor Email.
	ActorEmail string `json:"actorEmail"`
	// Actor Name.
	ActorName string `json:"actorName"`
	// Resource parent.
	ResourceParent string `json:"resourceParent"`
	// Resource type.
	ResourceType string `json:"resourceType"`
	// Resource ID.
	ResourceId string `json:"resourceId"`
	// Resource.
	Resource string `json:"resource"`
	// Event name.
	Event string `json:"event"`
	// User agent.
	UserAgent string `json:"userAgent"`
	// IP address.
	Ip string `json:"ip"`
	// API mode when event triggered.
	Mode string `json:"mode"`
	// Location.
	Country string `json:"country"`
	// Continent code.
	ContinentCode string `json:"continentCode"`
	// City name.
	City string `json:"city"`
	// Region/state chain.
	Subdivisions string `json:"subdivisions"`
	// Internet service provider.
	Isp string `json:"isp"`
	// Autonomous System Number (ASN).
	AutonomousSystemNumber string `json:"autonomousSystemNumber"`
	// Organization that owns the ASN.
	AutonomousSystemOrganization string `json:"autonomousSystemOrganization"`
	// Connection type (e.g. cable, cellular, corporate).
	ConnectionType string `json:"connectionType"`
	// User type (e.g. residential, business, hosting).
	ConnectionUsageType string `json:"connectionUsageType"`
	// Registered organization of the IP.
	ConnectionOrganization string `json:"connectionOrganization"`
	// Log creation date in ISO 8601 format.
	Time string `json:"time"`
	// Project ID.
	ProjectId string `json:"projectId"`
	// Team ID.
	TeamId string `json:"teamId"`
	// Hostname.
	Hostname string `json:"hostname"`
	// Name of the SDK that triggered the event.
	Sdk string `json:"sdk"`
	// Version of the SDK that triggered the event.
	SdkVersion string `json:"sdkVersion"`
	// contains filtered or unexported fields
}

ActivityEvent Model

func (*ActivityEvent) Decode

func (model *ActivityEvent) Decode(value interface{}) error

func (ActivityEvent) New

func (model ActivityEvent) New(data []byte) *ActivityEvent

type ActivityEventList

type ActivityEventList struct {
	// Total number of events that matched your query.
	Total int `json:"total"`
	// List of events.
	Events []ActivityEvent `json:"events"`
	// contains filtered or unexported fields
}

ActivityEventList Model

func (*ActivityEventList) Decode

func (model *ActivityEventList) Decode(value interface{}) error

func (ActivityEventList) New

func (model ActivityEventList) New(data []byte) *ActivityEventList

type AdditionalResource

type AdditionalResource struct {
	// Resource name
	Name string `json:"name"`
	// Resource unit
	Unit string `json:"unit"`
	// Price currency
	Currency string `json:"currency"`
	// Price
	Price float64 `json:"price"`
	// Resource value
	Value int `json:"value"`
	// Description on invoice
	InvoiceDesc string `json:"invoiceDesc"`
	// contains filtered or unexported fields
}

AdditionalResource Model

func (*AdditionalResource) Decode

func (model *AdditionalResource) Decode(value interface{}) error

func (AdditionalResource) New

func (model AdditionalResource) New(data []byte) *AdditionalResource

type AlgoArgon2

type AlgoArgon2 struct {
	// Algo type.
	Type string `json:"type"`
	// 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"`
	// contains filtered or unexported fields
}

AlgoArgon2 Model

func (*AlgoArgon2) Decode

func (model *AlgoArgon2) Decode(value interface{}) error

func (AlgoArgon2) New

func (model AlgoArgon2) New(data []byte) *AlgoArgon2

type AlgoBcrypt

type AlgoBcrypt struct {
	// Algo type.
	Type string `json:"type"`
	// contains filtered or unexported fields
}

AlgoBcrypt Model

func (*AlgoBcrypt) Decode

func (model *AlgoBcrypt) Decode(value interface{}) error

func (AlgoBcrypt) New

func (model AlgoBcrypt) New(data []byte) *AlgoBcrypt

type AlgoMd5

type AlgoMd5 struct {
	// Algo type.
	Type string `json:"type"`
	// contains filtered or unexported fields
}

AlgoMD5 Model

func (*AlgoMd5) Decode

func (model *AlgoMd5) Decode(value interface{}) error

func (AlgoMd5) New

func (model AlgoMd5) New(data []byte) *AlgoMd5

type AlgoPhpass

type AlgoPhpass struct {
	// Algo type.
	Type string `json:"type"`
	// contains filtered or unexported fields
}

AlgoPHPass Model

func (*AlgoPhpass) Decode

func (model *AlgoPhpass) Decode(value interface{}) error

func (AlgoPhpass) New

func (model AlgoPhpass) New(data []byte) *AlgoPhpass

type AlgoScrypt

type AlgoScrypt struct {
	// Algo type.
	Type string `json:"type"`
	// 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"`
	// contains filtered or unexported fields
}

AlgoScrypt Model

func (*AlgoScrypt) Decode

func (model *AlgoScrypt) Decode(value interface{}) error

func (AlgoScrypt) New

func (model AlgoScrypt) New(data []byte) *AlgoScrypt

type AlgoScryptModified

type AlgoScryptModified struct {
	// Algo type.
	Type string `json:"type"`
	// 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"`
	// contains filtered or unexported fields
}

AlgoScryptModified Model

func (*AlgoScryptModified) Decode

func (model *AlgoScryptModified) Decode(value interface{}) error

func (AlgoScryptModified) New

func (model AlgoScryptModified) New(data []byte) *AlgoScryptModified

type AlgoSha

type AlgoSha struct {
	// Algo type.
	Type string `json:"type"`
	// contains filtered or unexported fields
}

AlgoSHA Model

func (*AlgoSha) Decode

func (model *AlgoSha) Decode(value interface{}) error

func (AlgoSha) New

func (model AlgoSha) New(data []byte) *AlgoSha

type App

type App struct {
	// App ID.
	Id string `json:"$id"`
	// App creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// App update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Application name.
	Name string `json:"name"`
	// Application description shown to users during OAuth2 consent.
	Description string `json:"description"`
	// Application homepage URL shown to users during OAuth2 consent.
	ClientUri string `json:"clientUri"`
	// Application logo URL shown to users during OAuth2 consent.
	LogoUri string `json:"logoUri"`
	// Application privacy policy URL shown to users during OAuth2 consent.
	PrivacyPolicyUrl string `json:"privacyPolicyUrl"`
	// Application terms of service URL shown to users during OAuth2 consent.
	TermsUrl string `json:"termsUrl"`
	// Application support or security contact emails.
	Contacts []string `json:"contacts"`
	// Application tagline shown to users during OAuth2 consent.
	Tagline string `json:"tagline"`
	// Application tags shown to users during OAuth2 consent.
	Tags []string `json:"tags"`
	// Application labels. Read-only for clients; only a server SDK using a
	// project API key can update them.
	Labels []string `json:"labels"`
	// Application image URLs shown to users during OAuth2 consent.
	Images []string `json:"images"`
	// Application support URL shown to users during OAuth2 consent.
	SupportUrl string `json:"supportUrl"`
	// Application data deletion URL shown to users during OAuth2 consent.
	DataDeletionUrl string `json:"dataDeletionUrl"`
	// List of authorized redirect URIs. These URIs can be used to redirect users
	// after they authenticate.
	RedirectUris []string `json:"redirectUris"`
	// List of authorized post-logout redirect URIs for OpenID Connect
	// RP-Initiated Logout. The logout endpoint only redirects users to URIs in
	// this list after ending their session.
	PostLogoutRedirectUris []string `json:"postLogoutRedirectUris"`
	// Whether the app is enabled or not.
	Enabled bool `json:"enabled"`
	// OAuth2 client type. `public` for SPAs, mobile, and native apps that cannot
	// keep a client secret (PKCE required); `confidential` for server-side
	// clients that authenticate with a client secret.
	Type string `json:"type"`
	// Whether this client may use the OAuth2 Device Authorization Grant (RFC
	// 8628).
	DeviceFlow bool `json:"deviceFlow"`
	// ID of team that owns the application, if owned by team. Otherwise, user ID
	// will be used.
	TeamId string `json:"teamId"`
	// ID of user who owns the application, if owned by user. Otherwise, team ID
	// will be used.
	UserId string `json:"userId"`
	// Scopes the application requests when installed on a team.
	// Organization-level and project-level scopes only.
	InstallationScopes []string `json:"installationScopes"`
	// URL users are redirected to after creating or updating an installation of
	// this application. Empty for no redirect.
	InstallationRedirectUrl string `json:"installationRedirectUrl"`
	// List of application secrets.
	Secrets []AppSecret `json:"secrets"`
	// contains filtered or unexported fields
}

App Model

func (*App) Decode

func (model *App) Decode(value interface{}) error

func (App) New

func (model App) New(data []byte) *App

type AppInstallation

type AppInstallation struct {
	// Installation ID.
	Id string `json:"$id"`
	// Installation creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Installation update time in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// ID of the installed application.
	AppId string `json:"appId"`
	// ID of the team the application is installed on.
	TeamId string `json:"teamId"`
	// Scopes granted to the application. Snapshot of the application's
	// installation scopes taken when the installation was created or last
	// updated.
	Scopes []string `json:"scopes"`
	// Authorization details granted to the application. Rich authorization
	// request (RFC 9396) style entries; the Appwrite Console stores authorized
	// project IDs here.
	AuthorizationDetails []interface{} `json:"authorizationDetails"`
	// ID of the user who created the installation.
	CreatedById string `json:"createdById"`
	// Name of the user who created the installation.
	CreatedByName string `json:"createdByName"`
	// Time an access token was last issued for the installation in ISO 8601
	// format. Null if never used.
	LastAccessedAt string `json:"lastAccessedAt"`
	// contains filtered or unexported fields
}

AppInstallation Model

func (*AppInstallation) Decode

func (model *AppInstallation) Decode(value interface{}) error

func (AppInstallation) New

func (model AppInstallation) New(data []byte) *AppInstallation

type AppInstallationList

type AppInstallationList struct {
	// Total number of installations that matched your query.
	Total int `json:"total"`
	// List of installations.
	Installations []AppInstallation `json:"installations"`
	// contains filtered or unexported fields
}

AppInstallationsList Model

func (*AppInstallationList) Decode

func (model *AppInstallationList) Decode(value interface{}) error

func (AppInstallationList) New

func (model AppInstallationList) New(data []byte) *AppInstallationList

type AppKey

type AppKey struct {
	// App key ID.
	Id string `json:"$id"`
	// App key creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// App key update time in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Application ID this app key belongs to.
	AppId string `json:"appId"`
	// App key secret.
	Secret string `json:"secret"`
	// Last few characters of the app key secret, used to help identify it.
	Hint string `json:"hint"`
	// ID of the user who created the app key.
	CreatedById string `json:"createdById"`
	// Name of the user who created the app key.
	CreatedByName string `json:"createdByName"`
	// Time the app key was last used for authentication in ISO 8601 format. Null
	// if never used.
	LastAccessedAt string `json:"lastAccessedAt"`
	// contains filtered or unexported fields
}

AppKey Model

func (*AppKey) Decode

func (model *AppKey) Decode(value interface{}) error

func (AppKey) New

func (model AppKey) New(data []byte) *AppKey

type AppKeyList

type AppKeyList struct {
	// Total number of keys that matched your query.
	Total int `json:"total"`
	// List of keys.
	Keys []AppKey `json:"keys"`
	// contains filtered or unexported fields
}

AppKeysList Model

func (*AppKeyList) Decode

func (model *AppKeyList) Decode(value interface{}) error

func (AppKeyList) New

func (model AppKeyList) New(data []byte) *AppKeyList

type AppScope

type AppScope struct {
	// Scope value as requested by apps.
	Value string `json:"value"`
	// Human-readable description of what the scope grants.
	Description string `json:"description"`
	// What the scope grants access to. One of `account`, `project`, or
	// `organization`. Only `project` and `organization` scopes are installable.
	Type string `json:"type"`
	// Scope category, used to group scopes on consent and installation screens.
	Category string `json:"category"`
	// Whether the scope is deprecated. Deprecated scopes can still be requested
	// but should not be offered for new grants.
	Deprecated bool `json:"deprecated"`
	// contains filtered or unexported fields
}

AppScope Model

func (*AppScope) Decode

func (model *AppScope) Decode(value interface{}) error

func (AppScope) New

func (model AppScope) New(data []byte) *AppScope

type AppScopeList

type AppScopeList struct {
	// Total number of scopes that matched your query.
	Total int `json:"total"`
	// List of scopes.
	Scopes []AppScope `json:"scopes"`
	// contains filtered or unexported fields
}

AppScopesList Model

func (*AppScopeList) Decode

func (model *AppScopeList) Decode(value interface{}) error

func (AppScopeList) New

func (model AppScopeList) New(data []byte) *AppScopeList

type AppSecret

type AppSecret struct {
	// Secret ID.
	Id string `json:"$id"`
	// Secret creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Secret update time in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Application ID this secret belongs to.
	AppId string `json:"appId"`
	// Always empty. The application client secret is returned only once, in the
	// response of the createSecret method.
	Secret string `json:"secret"`
	// Last few characters of the client secret, used to help identify it.
	Hint string `json:"hint"`
	// ID of the user who created the secret.
	CreatedById string `json:"createdById"`
	// Name of the user who created the secret.
	CreatedByName string `json:"createdByName"`
	// Time the secret was last used for authentication in ISO 8601 format. Null
	// if never used.
	LastAccessedAt string `json:"lastAccessedAt"`
	// contains filtered or unexported fields
}

AppSecret Model

func (*AppSecret) Decode

func (model *AppSecret) Decode(value interface{}) error

func (AppSecret) New

func (model AppSecret) New(data []byte) *AppSecret

type AppSecretList

type AppSecretList struct {
	// Total number of secrets that matched your query.
	Total int `json:"total"`
	// List of secrets.
	Secrets []AppSecret `json:"secrets"`
	// contains filtered or unexported fields
}

AppSecretsList Model

func (*AppSecretList) Decode

func (model *AppSecretList) Decode(value interface{}) error

func (AppSecretList) New

func (model AppSecretList) New(data []byte) *AppSecretList

type AppSecretPlaintext

type AppSecretPlaintext struct {
	// Secret ID.
	Id string `json:"$id"`
	// Secret creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Secret update time in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Application ID this secret belongs to.
	AppId string `json:"appId"`
	// Application client secret. Returned only when the secret is created;
	// subsequent reads always return an empty value.
	Secret string `json:"secret"`
	// Last few characters of the client secret, used to help identify it.
	Hint string `json:"hint"`
	// ID of the user who created the secret.
	CreatedById string `json:"createdById"`
	// Name of the user who created the secret.
	CreatedByName string `json:"createdByName"`
	// Time the secret was last used for authentication in ISO 8601 format. Null
	// if never used.
	LastAccessedAt string `json:"lastAccessedAt"`
	// contains filtered or unexported fields
}

AppSecretPlaintext Model

func (*AppSecretPlaintext) Decode

func (model *AppSecretPlaintext) Decode(value interface{}) error

func (AppSecretPlaintext) New

func (model AppSecretPlaintext) New(data []byte) *AppSecretPlaintext

type AppsList

type AppsList struct {
	// Total number of apps that matched your query.
	Total int `json:"total"`
	// List of apps.
	Apps []App `json:"apps"`
	// contains filtered or unexported fields
}

AppsList Model

func (*AppsList) Decode

func (model *AppsList) Decode(value interface{}) error

func (AppsList) New

func (model AppsList) New(data []byte) *AppsList

type AttributeBigint

type AttributeBigint struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// 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:"default"`
	// contains filtered or unexported fields
}

AttributeBigInt Model

func (*AttributeBigint) Decode

func (model *AttributeBigint) Decode(value interface{}) error

func (AttributeBigint) New

func (model AttributeBigint) New(data []byte) *AttributeBigint

type AttributeBoolean

type AttributeBoolean struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default bool `json:"default"`
	// contains filtered or unexported fields
}

AttributeBoolean Model

func (*AttributeBoolean) Decode

func (model *AttributeBoolean) Decode(value interface{}) error

func (AttributeBoolean) New

func (model AttributeBoolean) New(data []byte) *AttributeBoolean

type AttributeDatetime

type AttributeDatetime struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// ISO 8601 format.
	Format string `json:"format"`
	// Default value for attribute when not provided. Only null is optional
	Default string `json:"default"`
	// contains filtered or unexported fields
}

AttributeDatetime Model

func (*AttributeDatetime) Decode

func (model *AttributeDatetime) Decode(value interface{}) error

func (AttributeDatetime) New

func (model AttributeDatetime) New(data []byte) *AttributeDatetime

type AttributeEmail

type AttributeEmail struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// String format.
	Format string `json:"format"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default string `json:"default"`
	// contains filtered or unexported fields
}

AttributeEmail Model

func (*AttributeEmail) Decode

func (model *AttributeEmail) Decode(value interface{}) error

func (AttributeEmail) New

func (model AttributeEmail) New(data []byte) *AttributeEmail

type AttributeEnum

type AttributeEnum struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Array of elements in enumerated type.
	Elements []string `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:"default"`
	// contains filtered or unexported fields
}

AttributeEnum Model

func (*AttributeEnum) Decode

func (model *AttributeEnum) Decode(value interface{}) error

func (AttributeEnum) New

func (model AttributeEnum) New(data []byte) *AttributeEnum

type AttributeFloat

type AttributeFloat struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// 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:"default"`
	// contains filtered or unexported fields
}

AttributeFloat Model

func (*AttributeFloat) Decode

func (model *AttributeFloat) Decode(value interface{}) error

func (AttributeFloat) New

func (model AttributeFloat) New(data []byte) *AttributeFloat

type AttributeInteger

type AttributeInteger struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// 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:"default"`
	// contains filtered or unexported fields
}

AttributeInteger Model

func (*AttributeInteger) Decode

func (model *AttributeInteger) Decode(value interface{}) error

func (AttributeInteger) New

func (model AttributeInteger) New(data []byte) *AttributeInteger

type AttributeIp

type AttributeIp struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// String format.
	Format string `json:"format"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default string `json:"default"`
	// contains filtered or unexported fields
}

AttributeIP Model

func (*AttributeIp) Decode

func (model *AttributeIp) Decode(value interface{}) error

func (AttributeIp) New

func (model AttributeIp) New(data []byte) *AttributeIp

type AttributeLine

type AttributeLine struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default [][]float64 `json:"default"`
	// contains filtered or unexported fields
}

AttributeLine Model

func (*AttributeLine) Decode

func (model *AttributeLine) Decode(value interface{}) error

func (AttributeLine) New

func (model AttributeLine) New(data []byte) *AttributeLine

type AttributeList

type AttributeList struct {
	// Total number of attributes in the given collection.
	Total int `json:"total"`
	// List of attributes.
	Attributes []map[string]any `json:"attributes"`
	// contains filtered or unexported fields
}

AttributesList Model

func (*AttributeList) Decode

func (model *AttributeList) Decode(value interface{}) error

func (AttributeList) New

func (model AttributeList) New(data []byte) *AttributeList

type AttributeLongtext

type AttributeLongtext struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default string `json:"default"`
	// Defines whether this attribute is encrypted or not.
	Encrypt bool `json:"encrypt"`
	// contains filtered or unexported fields
}

AttributeLongtext Model

func (*AttributeLongtext) Decode

func (model *AttributeLongtext) Decode(value interface{}) error

func (AttributeLongtext) New

func (model AttributeLongtext) New(data []byte) *AttributeLongtext

type AttributeMediumtext

type AttributeMediumtext struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default string `json:"default"`
	// Defines whether this attribute is encrypted or not.
	Encrypt bool `json:"encrypt"`
	// contains filtered or unexported fields
}

AttributeMediumtext Model

func (*AttributeMediumtext) Decode

func (model *AttributeMediumtext) Decode(value interface{}) error

func (AttributeMediumtext) New

func (model AttributeMediumtext) New(data []byte) *AttributeMediumtext

type AttributeObject added in v7.2.0

type AttributeObject struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// contains filtered or unexported fields
}

AttributeObject Model

func (*AttributeObject) Decode added in v7.2.0

func (model *AttributeObject) Decode(value interface{}) error

func (AttributeObject) New added in v7.2.0

func (model AttributeObject) New(data []byte) *AttributeObject

type AttributePoint

type AttributePoint struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default []float64 `json:"default"`
	// contains filtered or unexported fields
}

AttributePoint Model

func (*AttributePoint) Decode

func (model *AttributePoint) Decode(value interface{}) error

func (AttributePoint) New

func (model AttributePoint) New(data []byte) *AttributePoint

type AttributePolygon

type AttributePolygon struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default [][][]float64 `json:"default"`
	// contains filtered or unexported fields
}

AttributePolygon Model

func (*AttributePolygon) Decode

func (model *AttributePolygon) Decode(value interface{}) error

func (AttributePolygon) New

func (model AttributePolygon) New(data []byte) *AttributePolygon

type AttributeRelationship

type AttributeRelationship struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// 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"`
	// contains filtered or unexported fields
}

AttributeRelationship Model

func (*AttributeRelationship) Decode

func (model *AttributeRelationship) Decode(value interface{}) error

func (AttributeRelationship) New

type AttributeString

type AttributeString struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Attribute size.
	Size int `json:"size"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default string `json:"default"`
	// Defines whether this attribute is encrypted or not.
	Encrypt bool `json:"encrypt"`
	// contains filtered or unexported fields
}

AttributeString Model

func (*AttributeString) Decode

func (model *AttributeString) Decode(value interface{}) error

func (AttributeString) New

func (model AttributeString) New(data []byte) *AttributeString

type AttributeText

type AttributeText struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default string `json:"default"`
	// Defines whether this attribute is encrypted or not.
	Encrypt bool `json:"encrypt"`
	// contains filtered or unexported fields
}

AttributeText Model

func (*AttributeText) Decode

func (model *AttributeText) Decode(value interface{}) error

func (AttributeText) New

func (model AttributeText) New(data []byte) *AttributeText

type AttributeUrl

type AttributeUrl struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// String format.
	Format string `json:"format"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default string `json:"default"`
	// contains filtered or unexported fields
}

AttributeURL Model

func (*AttributeUrl) Decode

func (model *AttributeUrl) Decode(value interface{}) error

func (AttributeUrl) New

func (model AttributeUrl) New(data []byte) *AttributeUrl

type AttributeVarchar

type AttributeVarchar struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Attribute size.
	Size int `json:"size"`
	// Default value for attribute when not provided. Cannot be set when attribute
	// is required.
	Default string `json:"default"`
	// Defines whether this attribute is encrypted or not.
	Encrypt bool `json:"encrypt"`
	// contains filtered or unexported fields
}

AttributeVarchar Model

func (*AttributeVarchar) Decode

func (model *AttributeVarchar) Decode(value interface{}) error

func (AttributeVarchar) New

func (model AttributeVarchar) New(data []byte) *AttributeVarchar

type AttributeVector added in v7.2.0

type AttributeVector struct {
	// Attribute Key.
	Key string `json:"key"`
	// Attribute type.
	Type string `json:"type"`
	// 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:"error"`
	// Is attribute required?
	Required bool `json:"required"`
	// Is attribute an array?
	Array bool `json:"array"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Vector dimensions.
	Size int `json:"size"`
	// contains filtered or unexported fields
}

AttributeVector Model

func (*AttributeVector) Decode added in v7.2.0

func (model *AttributeVector) Decode(value interface{}) error

func (AttributeVector) New added in v7.2.0

func (model AttributeVector) New(data []byte) *AttributeVector

type BackupArchive

type BackupArchive struct {
	// Archive ID.
	Id string `json:"$id"`
	// Archive creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Archive update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Archive policy ID.
	PolicyId string `json:"policyId"`
	// Archive size in bytes.
	Size int `json:"size"`
	// The status of the archive creation. Possible values: pending, processing,
	// uploading, completed, failed, skipped.
	Status string `json:"status"`
	// The backup start time.
	StartedAt string `json:"startedAt"`
	// Migration ID.
	MigrationId string `json:"migrationId"`
	// The services that are backed up by this archive.
	Services []string `json:"services"`
	// The resources that are backed up by this archive.
	Resources []string `json:"resources"`
	// The resource ID to backup. Set only if this archive should backup a single
	// resource.
	ResourceId string `json:"resourceId"`
	// The resource type to backup. Set only if this archive should backup a
	// single resource.
	ResourceType string `json:"resourceType"`
	// contains filtered or unexported fields
}

Archive Model

func (*BackupArchive) Decode

func (model *BackupArchive) Decode(value interface{}) error

func (BackupArchive) New

func (model BackupArchive) New(data []byte) *BackupArchive

type BackupArchiveList

type BackupArchiveList struct {
	// Total number of archives that matched your query.
	Total int `json:"total"`
	// List of archives.
	Archives []BackupArchive `json:"archives"`
	// contains filtered or unexported fields
}

BackupArchiveList Model

func (*BackupArchiveList) Decode

func (model *BackupArchiveList) Decode(value interface{}) error

func (BackupArchiveList) New

func (model BackupArchiveList) New(data []byte) *BackupArchiveList

type BackupPolicy

type BackupPolicy struct {
	// Backup policy ID.
	Id string `json:"$id"`
	// Backup policy name.
	Name string `json:"name"`
	// Policy creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Policy update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// The services that are backed up by this policy.
	Services []string `json:"services"`
	// The resources that are backed up by this policy.
	Resources []string `json:"resources"`
	// The resource ID to backup. Set only if this policy should backup a single
	// resource.
	ResourceId string `json:"resourceId"`
	// The resource type to backup. Set only if this policy should backup a single
	// resource.
	ResourceType string `json:"resourceType"`
	// How many days to keep the backup before it will be automatically deleted.
	Retention int `json:"retention"`
	// Policy backup schedule in CRON format.
	Schedule string `json:"schedule"`
	// Backup type. Possible values: full (complete database snapshot),
	// incremental (changes since last backup).
	Type string `json:"type"`
	// Is this policy enabled.
	Enabled bool `json:"enabled"`
	// contains filtered or unexported fields
}

Backup Model

func (*BackupPolicy) Decode

func (model *BackupPolicy) Decode(value interface{}) error

func (BackupPolicy) New

func (model BackupPolicy) New(data []byte) *BackupPolicy

type BackupPolicyList

type BackupPolicyList struct {
	// Total number of policies that matched your query.
	Total int `json:"total"`
	// List of policies.
	Policies []BackupPolicy `json:"policies"`
	// contains filtered or unexported fields
}

BackupPolicyList Model

func (*BackupPolicyList) Decode

func (model *BackupPolicyList) Decode(value interface{}) error

func (BackupPolicyList) New

func (model BackupPolicyList) New(data []byte) *BackupPolicyList

type BackupRestoration

type BackupRestoration struct {
	// Restoration ID.
	Id string `json:"$id"`
	// Restoration creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Restoration update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Backup archive ID.
	ArchiveId string `json:"archiveId"`
	// Backup policy ID.
	PolicyId string `json:"policyId"`
	// The status of the restoration. Possible values: pending, downloading,
	// processing, completed, failed.
	Status string `json:"status"`
	// The backup start time.
	StartedAt string `json:"startedAt"`
	// Migration ID.
	MigrationId string `json:"migrationId"`
	// The services that are backed up by this policy.
	Services []string `json:"services"`
	// The resources that are backed up by this policy.
	Resources []string `json:"resources"`
	// Optional data in key-value object.
	Options string `json:"options"`
	// contains filtered or unexported fields
}

Restoration Model

func (*BackupRestoration) Decode

func (model *BackupRestoration) Decode(value interface{}) error

func (BackupRestoration) New

func (model BackupRestoration) New(data []byte) *BackupRestoration

type BackupRestorationList

type BackupRestorationList struct {
	// Total number of restorations that matched your query.
	Total int `json:"total"`
	// List of restorations.
	Restorations []BackupRestoration `json:"restorations"`
	// contains filtered or unexported fields
}

BackupRestorationList Model

func (*BackupRestorationList) Decode

func (model *BackupRestorationList) Decode(value interface{}) error

func (BackupRestorationList) New

type BillingLimits

type BillingLimits struct {
	// Bandwidth limit
	Bandwidth int `json:"bandwidth"`
	// Storage limit
	Storage int `json:"storage"`
	// Users limit
	Users int `json:"users"`
	// Executions limit
	Executions int `json:"executions"`
	// GBHours limit
	GBHours int `json:"GBHours"`
	// Image transformations limit
	ImageTransformations int `json:"imageTransformations"`
	// Auth phone limit
	AuthPhone int `json:"authPhone"`
	// Budget limit percentage
	BudgetLimit int `json:"budgetLimit"`
	// contains filtered or unexported fields
}

Limits Model

func (*BillingLimits) Decode

func (model *BillingLimits) Decode(value interface{}) error

func (BillingLimits) New

func (model BillingLimits) New(data []byte) *BillingLimits

type BillingPlan

type BillingPlan struct {
	// Plan ID.
	Id string `json:"$id"`
	// Plan name
	Name string `json:"name"`
	// Plan description
	Desc string `json:"desc"`
	// Plan order
	Order int `json:"order"`
	// Price
	Price float64 `json:"price"`
	// Trial days
	Trial int `json:"trial"`
	// Bandwidth
	Bandwidth int `json:"bandwidth"`
	// Storage
	Storage int `json:"storage"`
	// Image Transformations
	ImageTransformations int `json:"imageTransformations"`
	// Screenshots generated
	ScreenshotsGenerated int `json:"screenshotsGenerated"`
	// Members
	Members int `json:"members"`
	// Webhooks
	Webhooks int `json:"webhooks"`
	// Maximum WAF rules per project
	WafRules int `json:"wafRules"`
	// Projects
	Projects int `json:"projects"`
	// Platforms
	Platforms int `json:"platforms"`
	// Users
	Users int `json:"users"`
	// Teams
	Teams int `json:"teams"`
	// Databases
	Databases int `json:"databases"`
	// Database reads per month
	DatabasesReads int `json:"databasesReads"`
	// Database writes per month
	DatabasesWrites int `json:"databasesWrites"`
	// Database batch size limit
	DatabasesBatchSize int `json:"databasesBatchSize"`
	// Buckets
	Buckets int `json:"buckets"`
	// File size
	FileSize int `json:"fileSize"`
	// Functions
	Functions int `json:"functions"`
	// Sites
	Sites int `json:"sites"`
	// Function executions
	Executions int `json:"executions"`
	// Rolling max executions retained per function/site
	ExecutionsRetentionCount int `json:"executionsRetentionCount"`
	// GB hours for functions
	GBHours int `json:"GBHours"`
	// Realtime connections
	Realtime int `json:"realtime"`
	// Realtime messages
	RealtimeMessages int `json:"realtimeMessages"`
	// Messages per month
	Messages int `json:"messages"`
	// Topics for messaging
	Topics int `json:"topics"`
	// SMS authentications per month
	AuthPhone int `json:"authPhone"`
	// Custom domains
	Domains int `json:"domains"`
	// Activity log days
	ActivityLogs int `json:"activityLogs"`
	// Usage history days
	UsageLogs int `json:"usageLogs"`
	// Usage log time intervals allowed for this plan (e.g. 15m, 1h, 1d).
	UsageLogsIntervals []string `json:"usageLogsIntervals"`
	// Metrics this plan only records as a total. They cannot be broken down by
	// dimension or filtered, because the stored events cover a fraction of the
	// real traffic.
	UsageAggregateOnlyMetrics []string `json:"usageAggregateOnlyMetrics"`
	// Number of days of console inactivity before a project is paused. 0 means
	// pausing is disabled.
	ProjectInactivityDays int `json:"projectInactivityDays"`
	// Alert threshold percentage
	AlertLimit int `json:"alertLimit"`
	// Additional resources
	Usage UsageBillingPlan `json:"usage"`
	// Addons
	Addons BillingPlanAddon `json:"addons"`
	// Budget cap enabled or disabled.
	BudgetCapEnabled bool `json:"budgetCapEnabled"`
	// Custom SMTP
	CustomSmtp bool `json:"customSmtp"`
	// Appwrite branding in email
	EmailBranding bool `json:"emailBranding"`
	// Does plan require payment method
	RequiresPaymentMethod bool `json:"requiresPaymentMethod"`
	// Does plan require billing address
	RequiresBillingAddress bool `json:"requiresBillingAddress"`
	// Is the billing plan available
	IsAvailable bool `json:"isAvailable"`
	// Can user change the plan themselves
	SelfService bool `json:"selfService"`
	// Does plan enable premium support
	PremiumSupport bool `json:"premiumSupport"`
	// Does plan support budget cap
	Budgeting bool `json:"budgeting"`
	// Does plan support mock numbers
	SupportsMockNumbers bool `json:"supportsMockNumbers"`
	// Does plan support organization roles
	SupportsOrganizationRoles bool `json:"supportsOrganizationRoles"`
	// Does plan support credit
	SupportsCredits bool `json:"supportsCredits"`
	// Does plan support dedicated databases.
	SupportsDedicatedDatabases bool `json:"supportsDedicatedDatabases"`
	// Does plan support blocking disposable email addresses.
	SupportsDisposableEmailValidation bool `json:"supportsDisposableEmailValidation"`
	// Does plan support requiring canonical email addresses.
	SupportsCanonicalEmailValidation bool `json:"supportsCanonicalEmailValidation"`
	// Does plan support blocking free email addresses.
	SupportsFreeEmailValidation bool `json:"supportsFreeEmailValidation"`
	// Does plan support restricting sign-ups to corporate email addresses only.
	SupportsCorporateEmailValidation bool `json:"supportsCorporateEmailValidation"`
	// Does plan support project-specific member roles.
	SupportsProjectSpecificRoles bool `json:"supportsProjectSpecificRoles"`
	// Does plan support backup policies.
	BackupsEnabled bool `json:"backupsEnabled"`
	// Whether usage addons are calculated per project.
	UsagePerProject bool `json:"usagePerProject"`
	// Supported addons for this plan
	SupportedAddons BillingPlanSupportedAddons `json:"supportedAddons"`
	// How many policies does plan support
	BackupPolicies int `json:"backupPolicies"`
	// Maximum function and site deployment size in MB
	DeploymentSize int `json:"deploymentSize"`
	// Maximum function and site deployment size in MB
	BuildSize int `json:"buildSize"`
	// Does the plan support encrypted string attributes or not.
	DatabasesAllowEncrypt bool `json:"databasesAllowEncrypt"`
	// Plan specific limits
	Limits BillingPlanLimits `json:"limits"`
	// Group of this billing plan for variants
	Group string `json:"group"`
	// Details of the program this plan is a part of.
	Program Program `json:"program"`
	// Included monthly dedicated-database compute credit in USD. Resets each
	// billing cycle with no roll-over.
	DatabaseComputeCredit float64 `json:"databaseComputeCredit"`
	// Dedicated database limits available to this plan.
	DedicatedDatabases BillingPlanDedicatedDatabaseLimits `json:"dedicatedDatabases"`
	// contains filtered or unexported fields
}

BillingPlan Model

func (*BillingPlan) Decode

func (model *BillingPlan) Decode(value interface{}) error

func (BillingPlan) New

func (model BillingPlan) New(data []byte) *BillingPlan

type BillingPlanAddon

type BillingPlanAddon struct {
	// Addon seats
	Seats BillingPlanAddonDetails `json:"seats"`
	// Addon projects
	Projects BillingPlanAddonDetails `json:"projects"`
	// contains filtered or unexported fields
}

Addon Model

func (*BillingPlanAddon) Decode

func (model *BillingPlanAddon) Decode(value interface{}) error

func (BillingPlanAddon) New

func (model BillingPlanAddon) New(data []byte) *BillingPlanAddon

type BillingPlanAddonDetails

type BillingPlanAddonDetails struct {
	// Is the addon supported in the plan?
	Supported bool `json:"supported"`
	// Addon plan included value
	PlanIncluded int `json:"planIncluded"`
	// Addon limit
	Limit int `json:"limit"`
	// Addon type
	Type string `json:"type"`
	// Price currency
	Currency string `json:"currency"`
	// Price
	Price float64 `json:"price"`
	// Resource value
	Value int `json:"value"`
	// Description on invoice
	InvoiceDesc string `json:"invoiceDesc"`
	// contains filtered or unexported fields
}

Details Model

func (*BillingPlanAddonDetails) Decode

func (model *BillingPlanAddonDetails) Decode(value interface{}) error

func (BillingPlanAddonDetails) New

type BillingPlanDedicatedDatabaseLimits

type BillingPlanDedicatedDatabaseLimits struct {
	// Minimum CPU allocation in millicores.
	MinCpu int `json:"minCpu"`
	// Maximum CPU allocation in millicores.
	MaxCpu int `json:"maxCpu"`
	// Minimum memory allocation in megabytes.
	MinMemoryMb int `json:"minMemoryMb"`
	// Maximum memory allocation in megabytes.
	MaxMemoryMb int `json:"maxMemoryMb"`
	// Minimum storage allocation in gigabytes.
	MinStorageGb int `json:"minStorageGb"`
	// Maximum storage allocation in gigabytes.
	MaxStorageGb int `json:"maxStorageGb"`
	// Maximum number of high-availability replicas per dedicated database.
	MaxReplicas int `json:"maxReplicas"`
	// Maximum number of client connections.
	MaxConnections int `json:"maxConnections"`
	// Maximum number of entries allowed in the IP allowlist.
	MaxIpAllowlistSize int `json:"maxIpAllowlistSize"`
	// Maximum number of database extensions that can be enabled.
	MaxExtensions int `json:"maxExtensions"`
	// Maximum number of days a backup can be retained.
	MaxBackupRetentionDays int `json:"maxBackupRetentionDays"`
	// Maximum number of days of point-in-time recovery data that can be retained.
	MaxPitrRetentionDays int `json:"maxPitrRetentionDays"`
	// Maximum number of rows a single SQL API query can return.
	MaxSqlApiMaxRows int `json:"maxSqlApiMaxRows"`
	// Maximum response size in bytes for a single SQL API query.
	MaxSqlApiMaxBytes int `json:"maxSqlApiMaxBytes"`
	// Maximum execution time in seconds for a single SQL API query.
	MaxSqlApiTimeoutSeconds int `json:"maxSqlApiTimeoutSeconds"`
	// Maximum number of SQL statement types that can be permitted through the SQL
	// API.
	MaxSqlApiAllowedStatements int `json:"maxSqlApiAllowedStatements"`
	// SQL statement types permitted through the SQL API.
	AllowedSqlStatements []string `json:"allowedSqlStatements"`
	// Storage classes available for dedicated databases.
	AllowedStorageClasses []string `json:"allowedStorageClasses"`
	// Replica synchronization modes available for dedicated databases.
	AllowedSyncModes []string `json:"allowedSyncModes"`
	// contains filtered or unexported fields
}

DedicatedDatabaseLimits Model

func (*BillingPlanDedicatedDatabaseLimits) Decode

func (model *BillingPlanDedicatedDatabaseLimits) Decode(value interface{}) error

func (BillingPlanDedicatedDatabaseLimits) New

type BillingPlanLimits

type BillingPlanLimits struct {
	// Credits limit per billing cycle
	Credits int `json:"credits"`
	// Daily credits limit (if applicable)
	DailyCredits int `json:"dailyCredits"`
	// contains filtered or unexported fields
}

PlanLimits Model

func (*BillingPlanLimits) Decode

func (model *BillingPlanLimits) Decode(value interface{}) error

func (BillingPlanLimits) New

func (model BillingPlanLimits) New(data []byte) *BillingPlanLimits

type BillingPlanSupportedAddons

type BillingPlanSupportedAddons struct {
	// Whether the plan supports BAA (Business Associate Agreement) addon
	Baa bool `json:"baa"`
	// Whether the plan supports Premium Geo DB addon (project-level)
	PremiumGeoDB bool `json:"premiumGeoDB"`
	// Whether the plan supports Premium Geo DB addon (organization-level)
	PremiumGeoDBOrg bool `json:"premiumGeoDBOrg"`
	// contains filtered or unexported fields
}

BillingPlanSupportedAddons Model

func (*BillingPlanSupportedAddons) Decode

func (model *BillingPlanSupportedAddons) Decode(value interface{}) error

func (BillingPlanSupportedAddons) New

type Block

type Block struct {
	// Block creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Resource type that is blocked
	ResourceType string `json:"resourceType"`
	// Resource identifier that is blocked
	ResourceId string `json:"resourceId"`
	// Block mode. full blocks reads and writes; readOnly blocks writes only.
	Mode string `json:"mode"`
	// Reason for the block. Can be null if no reason was provided.
	Reason string `json:"reason"`
	// Block expiration date in ISO 8601 format. Can be null if the block does not
	// expire.
	ExpiredAt string `json:"expiredAt"`
	// Name of the project this block applies to.
	ProjectName string `json:"projectName"`
	// Region of the project this block applies to.
	Region string `json:"region"`
	// Name of the organization that owns the project.
	OrganizationName string `json:"organizationName"`
	// ID of the organization that owns the project.
	OrganizationId string `json:"organizationId"`
	// Billing plan of the organization that owns the project.
	BillingPlan string `json:"billingPlan"`
	// contains filtered or unexported fields
}

Block Model

func (*Block) Decode

func (model *Block) Decode(value interface{}) error

func (Block) New

func (model Block) New(data []byte) *Block

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 []string `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 []string `json:"allowedFileExtensions"`
	// Compression algorithm chosen 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"`
	// Image transformations are enabled.
	Transformations bool `json:"transformations"`
	// Total size of this bucket in bytes.
	TotalSize int `json:"totalSize"`
	// contains filtered or unexported fields
}

Bucket Model

func (*Bucket) Decode

func (model *Bucket) Decode(value interface{}) error

func (Bucket) New

func (model Bucket) New(data []byte) *Bucket

type BucketList

type BucketList struct {
	// Total number of buckets that matched your query.
	Total int `json:"total"`
	// List of buckets.
	Buckets []Bucket `json:"buckets"`
	// contains filtered or unexported fields
}

BucketsList Model

func (*BucketList) Decode

func (model *BucketList) Decode(value interface{}) error

func (BucketList) New

func (model BucketList) New(data []byte) *BucketList

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 []string `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 []map[string]any `json:"attributes"`
	// Collection indexes.
	Indexes []Index `json:"indexes"`
	// Maximum document size in bytes. Returns 0 when no limit applies.
	BytesMax int `json:"bytesMax"`
	// Currently used document size in bytes based on defined attributes.
	BytesUsed int `json:"bytesUsed"`
	// contains filtered or unexported fields
}

Collection Model

func (*Collection) Decode

func (model *Collection) Decode(value interface{}) error

func (Collection) New

func (model Collection) New(data []byte) *Collection

type CollectionList

type CollectionList struct {
	// Total number of collections that matched your query.
	Total int `json:"total"`
	// List of collections.
	Collections []Collection `json:"collections"`
	// contains filtered or unexported fields
}

CollectionsList Model

func (*CollectionList) Decode

func (model *CollectionList) Decode(value interface{}) error

func (CollectionList) New

func (model CollectionList) New(data []byte) *CollectionList

type ColumnBigint

type ColumnBigint struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// 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 column when not provided. Cannot be set when column is
	// required.
	Default int `json:"default"`
	// contains filtered or unexported fields
}

ColumnBigInt Model

func (*ColumnBigint) Decode

func (model *ColumnBigint) Decode(value interface{}) error

func (ColumnBigint) New

func (model ColumnBigint) New(data []byte) *ColumnBigint

type ColumnBoolean

type ColumnBoolean struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Default value for column when not provided. Cannot be set when column is
	// required.
	Default bool `json:"default"`
	// contains filtered or unexported fields
}

ColumnBoolean Model

func (*ColumnBoolean) Decode

func (model *ColumnBoolean) Decode(value interface{}) error

func (ColumnBoolean) New

func (model ColumnBoolean) New(data []byte) *ColumnBoolean

type ColumnDatetime

type ColumnDatetime struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// ISO 8601 format.
	Format string `json:"format"`
	// Default value for column when not provided. Only null is optional
	Default string `json:"default"`
	// contains filtered or unexported fields
}

ColumnDatetime Model

func (*ColumnDatetime) Decode

func (model *ColumnDatetime) Decode(value interface{}) error

func (ColumnDatetime) New

func (model ColumnDatetime) New(data []byte) *ColumnDatetime

type ColumnEmail

type ColumnEmail struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// String format.
	Format string `json:"format"`
	// Default value for column when not provided. Cannot be set when column is
	// required.
	Default string `json:"default"`
	// contains filtered or unexported fields
}

ColumnEmail Model

func (*ColumnEmail) Decode

func (model *ColumnEmail) Decode(value interface{}) error

func (ColumnEmail) New

func (model ColumnEmail) New(data []byte) *ColumnEmail

type ColumnEnum

type ColumnEnum struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Array of elements in enumerated type.
	Elements []string `json:"elements"`
	// String format.
	Format string `json:"format"`
	// Default value for column when not provided. Cannot be set when column is
	// required.
	Default string `json:"default"`
	// contains filtered or unexported fields
}

ColumnEnum Model

func (*ColumnEnum) Decode

func (model *ColumnEnum) Decode(value interface{}) error

func (ColumnEnum) New

func (model ColumnEnum) New(data []byte) *ColumnEnum

type ColumnFloat

type ColumnFloat struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// 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 column when not provided. Cannot be set when column is
	// required.
	Default float64 `json:"default"`
	// contains filtered or unexported fields
}

ColumnFloat Model

func (*ColumnFloat) Decode

func (model *ColumnFloat) Decode(value interface{}) error

func (ColumnFloat) New

func (model ColumnFloat) New(data []byte) *ColumnFloat

type ColumnIndex

type ColumnIndex struct {
	// Index ID.
	Id string `json:"$id"`
	// Index creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Index update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Index Key.
	Key string `json:"key"`
	// Index type.
	Type string `json:"type"`
	// 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:"error"`
	// Index columns.
	Columns []string `json:"columns"`
	// Index columns length.
	Lengths []int `json:"lengths"`
	// Index orders.
	Orders []string `json:"orders"`
	// contains filtered or unexported fields
}

Index Model

func (*ColumnIndex) Decode

func (model *ColumnIndex) Decode(value interface{}) error

func (ColumnIndex) New

func (model ColumnIndex) New(data []byte) *ColumnIndex

type ColumnIndexList

type ColumnIndexList struct {
	// Total number of indexes that matched your query.
	Total int `json:"total"`
	// List of indexes.
	Indexes []ColumnIndex `json:"indexes"`
	// contains filtered or unexported fields
}

ColumnIndexesList Model

func (*ColumnIndexList) Decode

func (model *ColumnIndexList) Decode(value interface{}) error

func (ColumnIndexList) New

func (model ColumnIndexList) New(data []byte) *ColumnIndexList

type ColumnInteger

type ColumnInteger struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// 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 column when not provided. Cannot be set when column is
	// required.
	Default int `json:"default"`
	// contains filtered or unexported fields
}

ColumnInteger Model

func (*ColumnInteger) Decode

func (model *ColumnInteger) Decode(value interface{}) error

func (ColumnInteger) New

func (model ColumnInteger) New(data []byte) *ColumnInteger

type ColumnIp

type ColumnIp struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// String format.
	Format string `json:"format"`
	// Default value for column when not provided. Cannot be set when column is
	// required.
	Default string `json:"default"`
	// contains filtered or unexported fields
}

ColumnIP Model

func (*ColumnIp) Decode

func (model *ColumnIp) Decode(value interface{}) error

func (ColumnIp) New

func (model ColumnIp) New(data []byte) *ColumnIp

type ColumnLine

type ColumnLine struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Default value for column when not provided. Cannot be set when column is
	// required.
	Default [][]float64 `json:"default"`
	// contains filtered or unexported fields
}

ColumnLine Model

func (*ColumnLine) Decode

func (model *ColumnLine) Decode(value interface{}) error

func (ColumnLine) New

func (model ColumnLine) New(data []byte) *ColumnLine

type ColumnList

type ColumnList struct {
	// Total number of columns in the given table.
	Total int `json:"total"`
	// List of columns.
	Columns []interface{} `json:"columns"`
	// contains filtered or unexported fields
}

ColumnsList Model

func (*ColumnList) Decode

func (model *ColumnList) Decode(value interface{}) error

func (ColumnList) New

func (model ColumnList) New(data []byte) *ColumnList

type ColumnLongtext

type ColumnLongtext struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Default value for column when not provided. Cannot be set when column is
	// required.
	Default string `json:"default"`
	// Defines whether this column is encrypted or not.
	Encrypt bool `json:"encrypt"`
	// contains filtered or unexported fields
}

ColumnLongtext Model

func (*ColumnLongtext) Decode

func (model *ColumnLongtext) Decode(value interface{}) error

func (ColumnLongtext) New

func (model ColumnLongtext) New(data []byte) *ColumnLongtext

type ColumnMediumtext

type ColumnMediumtext struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Default value for column when not provided. Cannot be set when column is
	// required.
	Default string `json:"default"`
	// Defines whether this column is encrypted or not.
	Encrypt bool `json:"encrypt"`
	// contains filtered or unexported fields
}

ColumnMediumtext Model

func (*ColumnMediumtext) Decode

func (model *ColumnMediumtext) Decode(value interface{}) error

func (ColumnMediumtext) New

func (model ColumnMediumtext) New(data []byte) *ColumnMediumtext

type ColumnPoint

type ColumnPoint struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Default value for column when not provided. Cannot be set when column is
	// required.
	Default []float64 `json:"default"`
	// contains filtered or unexported fields
}

ColumnPoint Model

func (*ColumnPoint) Decode

func (model *ColumnPoint) Decode(value interface{}) error

func (ColumnPoint) New

func (model ColumnPoint) New(data []byte) *ColumnPoint

type ColumnPolygon

type ColumnPolygon struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Default value for column when not provided. Cannot be set when column is
	// required.
	Default [][][]float64 `json:"default"`
	// contains filtered or unexported fields
}

ColumnPolygon Model

func (*ColumnPolygon) Decode

func (model *ColumnPolygon) Decode(value interface{}) error

func (ColumnPolygon) New

func (model ColumnPolygon) New(data []byte) *ColumnPolygon

type ColumnRelationship

type ColumnRelationship struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// The ID of the related table.
	RelatedTable string `json:"relatedTable"`
	// 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"`
	// contains filtered or unexported fields
}

ColumnRelationship Model

func (*ColumnRelationship) Decode

func (model *ColumnRelationship) Decode(value interface{}) error

func (ColumnRelationship) New

func (model ColumnRelationship) New(data []byte) *ColumnRelationship

type ColumnString

type ColumnString struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Column size.
	Size int `json:"size"`
	// Default value for column when not provided. Cannot be set when column is
	// required.
	Default string `json:"default"`
	// Defines whether this column is encrypted or not.
	Encrypt bool `json:"encrypt"`
	// contains filtered or unexported fields
}

ColumnString Model

func (*ColumnString) Decode

func (model *ColumnString) Decode(value interface{}) error

func (ColumnString) New

func (model ColumnString) New(data []byte) *ColumnString

type ColumnText

type ColumnText struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Default value for column when not provided. Cannot be set when column is
	// required.
	Default string `json:"default"`
	// Defines whether this column is encrypted or not.
	Encrypt bool `json:"encrypt"`
	// contains filtered or unexported fields
}

ColumnText Model

func (*ColumnText) Decode

func (model *ColumnText) Decode(value interface{}) error

func (ColumnText) New

func (model ColumnText) New(data []byte) *ColumnText

type ColumnUrl

type ColumnUrl struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// String format.
	Format string `json:"format"`
	// Default value for column when not provided. Cannot be set when column is
	// required.
	Default string `json:"default"`
	// contains filtered or unexported fields
}

ColumnURL Model

func (*ColumnUrl) Decode

func (model *ColumnUrl) Decode(value interface{}) error

func (ColumnUrl) New

func (model ColumnUrl) New(data []byte) *ColumnUrl

type ColumnVarchar

type ColumnVarchar struct {
	// Column Key.
	Key string `json:"key"`
	// Column type.
	Type string `json:"type"`
	// Column 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 column.
	Error string `json:"error"`
	// Is column required?
	Required bool `json:"required"`
	// Is column an array?
	Array bool `json:"array"`
	// Column creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Column update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Column size.
	Size int `json:"size"`
	// Default value for column when not provided. Cannot be set when column is
	// required.
	Default string `json:"default"`
	// Defines whether this column is encrypted or not.
	Encrypt bool `json:"encrypt"`
	// contains filtered or unexported fields
}

ColumnVarchar Model

func (*ColumnVarchar) Decode

func (model *ColumnVarchar) Decode(value interface{}) error

func (ColumnVarchar) New

func (model ColumnVarchar) New(data []byte) *ColumnVarchar

type Continent

type Continent struct {
	// Continent name.
	Name string `json:"name"`
	// Continent two letter code.
	Code string `json:"code"`
	// contains filtered or unexported fields
}

Continent Model

func (*Continent) Decode

func (model *Continent) Decode(value interface{}) error

func (Continent) New

func (model Continent) New(data []byte) *Continent

type ContinentList

type ContinentList struct {
	// Total number of continents that matched your query.
	Total int `json:"total"`
	// List of continents.
	Continents []Continent `json:"continents"`
	// contains filtered or unexported fields
}

ContinentsList Model

func (*ContinentList) Decode

func (model *ContinentList) Decode(value interface{}) error

func (ContinentList) New

func (model ContinentList) New(data []byte) *ContinentList

type Country

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

Country Model

func (*Country) Decode

func (model *Country) Decode(value interface{}) error

func (Country) New

func (model Country) New(data []byte) *Country

type CountryList

type CountryList struct {
	// Total number of countries that matched your query.
	Total int `json:"total"`
	// List of countries.
	Countries []Country `json:"countries"`
	// contains filtered or unexported fields
}

CountriesList Model

func (*CountryList) Decode

func (model *CountryList) Decode(value interface{}) error

func (CountryList) New

func (model CountryList) New(data []byte) *CountryList

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"`
	// contains filtered or unexported fields
}

Currency Model

func (*Currency) Decode

func (model *Currency) Decode(value interface{}) error

func (Currency) New

func (model Currency) New(data []byte) *Currency

type CurrencyList

type CurrencyList struct {
	// Total number of currencies that matched your query.
	Total int `json:"total"`
	// List of currencies.
	Currencies []Currency `json:"currencies"`
	// contains filtered or unexported fields
}

CurrenciesList Model

func (*CurrencyList) Decode

func (model *CurrencyList) Decode(value interface{}) error

func (CurrencyList) New

func (model CurrencyList) New(data []byte) *CurrencyList

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 type.
	Type string `json:"type"`
	// Dedicated database lifecycle status. Null when the database has no valid
	// dedicated backing.
	Status string `json:"status"`
	// Underlying engine of the dedicated backing: postgresql, mysql, or mongodb.
	// A managed product (tablesdb, documentsdb, vectorsdb) reports the engine it
	// runs on, so its type and engine can differ. Null when the database has no
	// dedicated backing.
	Engine string `json:"engine"`
	// Compute specification identifier of the dedicated backing, e.g.
	// s-2vcpu-2gb. Null when the database has no dedicated backing.
	Specification string `json:"specification"`
	// Number of secondary high availability replicas, excluding the primary. Null
	// when backing configuration is unavailable.
	Replicas int `json:"replicas"`
	// Error message when the dedicated backing failed. Null when the database has
	// no dedicated backing or has not failed.
	Error string `json:"error"`
	// Container status of the dedicated backing: active or inactive. Null when
	// the database has no dedicated backing or the runtime has not reported one.
	ContainerStatus string `json:"containerStatus"`
	// Idle-lifecycle state of the dedicated backing: active, warm, cold, or
	// hibernated. Null when the database has no dedicated backing or the runtime
	// has not reported one.
	LifecycleState string `json:"lifecycleState"`
	// Database backup policies.
	Policies []BackupPolicy `json:"policies"`
	// Database backup archives.
	Archives []BackupArchive `json:"archives"`
	// contains filtered or unexported fields
}

Database Model

func (*Database) Decode

func (model *Database) Decode(value interface{}) error

func (Database) New

func (model Database) New(data []byte) *Database

type DatabaseList

type DatabaseList struct {
	// Total number of databases that matched your query.
	Total int `json:"total"`
	// List of databases.
	Databases []Database `json:"databases"`
	// contains filtered or unexported fields
}

DatabasesList Model

func (*DatabaseList) Decode

func (model *DatabaseList) Decode(value interface{}) error

func (DatabaseList) New

func (model DatabaseList) New(data []byte) *DatabaseList

type DatabaseMigration

type DatabaseMigration struct {
	// Database migration ID.
	Id string `json:"$id"`
	// Migration creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Migration update time in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Project ID that owns the migrating database.
	ProjectId string `json:"projectId"`
	// Logical database ID being migrated.
	DatabaseId string `json:"databaseId"`
	// Dedicated compute specification provisioned for the migration target.
	Specification string `json:"specification"`
	// Migration phase. Possible values: pending, provisioned, capturing,
	// backfilling, catching_up, verifying, ready_to_cutover, cutover, soaking,
	// done, failed, rolled_back.
	Phase string `json:"phase"`
	// Number of times a migration step has failed and been recorded.
	Attempt int `json:"attempt"`
	// Reason the most recent migration step failed, empty while none has.
	LastError string `json:"lastError"`
	// Number of documents still pending replication to the target.
	LagDocuments int `json:"lagDocuments"`
	// Highest source changelog sequence applied to the target so far.
	ChangelogWatermark int `json:"changelogWatermark"`
	// Time the migrated data was verified against the source in ISO 8601 format.
	VerifiedAt string `json:"verifiedAt"`
	// Time routing was flipped to the target in ISO 8601 format.
	CutoverAt string `json:"cutoverAt"`
	// Time the post-cutover soak window ends in ISO 8601 format.
	SoakUntil string `json:"soakUntil"`
	// Whether the migration cuts over automatically once ready. Set when the
	// migration is created and never changed afterwards, so it always reports
	// what was asked for.
	AutoCutover bool `json:"autoCutover"`
	// Whether a cutover has been requested and not yet attempted. Set by the
	// cutover endpoint and cleared when the attempt is made, so a cutover that
	// fails a check parks the migration again rather than retrying on its own.
	CutoverRequested bool `json:"cutoverRequested"`
	// Whether the migration is paused.
	Paused bool `json:"paused"`
	// contains filtered or unexported fields
}

DatabaseMigration Model

func (*DatabaseMigration) Decode

func (model *DatabaseMigration) Decode(value interface{}) error

func (DatabaseMigration) New

func (model DatabaseMigration) New(data []byte) *DatabaseMigration

type DatabaseMigrationList

type DatabaseMigrationList struct {
	// Total number of migrations that matched your query.
	Total int `json:"total"`
	// List of migrations.
	Migrations []DatabaseMigration `json:"migrations"`
	// contains filtered or unexported fields
}

DatabaseMigrationsList Model

func (*DatabaseMigrationList) Decode

func (model *DatabaseMigrationList) Decode(value interface{}) error

func (DatabaseMigrationList) New

type DatabaseStatus

type DatabaseStatus struct {
	// Overall health status: healthy, degraded, unhealthy, or unknown when
	// nothing could be measured.
	Health string `json:"health"`
	// Whether the database is ready to accept connections.
	Ready bool `json:"ready"`
	// Database engine: postgresql, mysql, or mongodb.
	Engine string `json:"engine"`
	// Database engine version.
	Version string `json:"version"`
	// Database uptime in seconds.
	Uptime int `json:"uptime"`
	// Connection statistics.
	Connections DatabaseStatusConnections `json:"connections"`
	// Requested replication sync mode. Possible values: async, sync, quorum.
	// Compare with effectiveSyncMode for what the primary is enforcing.
	SyncMode string `json:"syncMode"`
	// Replication sync mode the primary is actually enforcing. Null when high
	// availability is disabled or the state could not be read.
	EffectiveSyncMode string `json:"effectiveSyncMode"`
	// Whether the enforced replication is weaker than the requested syncMode.
	SyncDegraded bool `json:"syncDegraded"`
	// Number of standby acknowledgements the primary waits for before a write is
	// committed.
	SyncAcknowledgements int `json:"syncAcknowledgements"`
	// Number of standbys registered with the primary for synchronous replication.
	SyncStandbyCount int `json:"syncStandbyCount"`
	// Whether the other sync fields are an engine reading rather than a recorded
	// estimate. True when the primary answered what it is enforcing, including
	// when that answer contradicted the record, in which case the contradicted
	// values are replaced by the ones the engine reports. False when the reading
	// could not be taken: the probe did not answer, there was no engine to ask,
	// or the values describe a configuration change just applied rather than
	// anything measured. Absent when no engine was asked at all, so an unprobed
	// database is distinguishable from an unconfirmed one. False never means a
	// standby was found lagging, because it is the absence of a reading rather
	// than a negative one, so draw no conclusion about replication health from it
	// or from a response that omits it.
	SyncStateConfirmed bool `json:"syncStateConfirmed"`
	// List of database replicas and their status. Every configured member
	// appears, including one the backend has not brought up, which is reported as
	// not healthy.
	Replicas []DatabaseStatusReplica `json:"replicas"`
	// Storage volume information.
	Volumes []DatabaseStatusVolume `json:"volumes"`
	// contains filtered or unexported fields
}

Status Model

func (*DatabaseStatus) Decode

func (model *DatabaseStatus) Decode(value interface{}) error

func (DatabaseStatus) New

func (model DatabaseStatus) New(data []byte) *DatabaseStatus

type DatabaseStatusConnections

type DatabaseStatusConnections struct {
	// Current number of active connections.
	Current int `json:"current"`
	// The engine's own max_connections. On a pooled database this is the backend
	// limit the pooler multiplexes onto, not the ceiling a client pool may reach
	// — that is networkMaxConnections on the database resource.
	Max int `json:"max"`
	// contains filtered or unexported fields
}

Connections Model

func (*DatabaseStatusConnections) Decode

func (model *DatabaseStatusConnections) Decode(value interface{}) error

func (DatabaseStatusConnections) New

type DatabaseStatusReplica

type DatabaseStatusReplica struct {
	// Member index within the database. Read `role` for which member accepts
	// writes: a failover moves the primary without renumbering the indexes.
	Index int `json:"index"`
	// Member role. Possible values: primary (accepts reads and writes), replica
	// (read-only follower), unknown (placement not established; reported while a
	// transition is moving or restarting the topology, so no member can be named
	// the write target).
	Role string `json:"role"`
	// Whether the replica is healthy.
	Healthy bool `json:"healthy"`
	// Whether the engine reports this member's replication stream as up. Null
	// when no reading was taken: a primary has no stream to report, and a member
	// that is not healthy, or whose probe did not answer, has none yet. `healthy`
	// is a reachability probe of the member itself and says nothing about
	// replication, so a healthy member may still not be replicating.
	Replicating bool `json:"replicating"`
	// Replication lag in seconds (null for primary). Also null against
	// `replicating: true`, for a member that is streaming but whose engine
	// printed no numeric lag.
	LagSeconds float64 `json:"lagSeconds"`
	// contains filtered or unexported fields
}

Replica Model

func (*DatabaseStatusReplica) Decode

func (model *DatabaseStatusReplica) Decode(value interface{}) error

func (DatabaseStatusReplica) New

type DatabaseStatusVolume

type DatabaseStatusVolume struct {
	// Mount path of the volume.
	Path string `json:"path"`
	// Percentage of storage used.
	UsedPercent string `json:"usedPercent"`
	// Available storage space.
	Available string `json:"available"`
	// Whether the volume is mounted.
	Mounted bool `json:"mounted"`
	// contains filtered or unexported fields
}

Volume Model

func (*DatabaseStatusVolume) Decode

func (model *DatabaseStatusVolume) Decode(value interface{}) error

func (DatabaseStatusVolume) New

func (model DatabaseStatusVolume) New(data []byte) *DatabaseStatusVolume

type DedicatedDatabase

type DedicatedDatabase struct {
	// Dedicated database ID.
	Id string `json:"$id"`
	// Database creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Database update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Project ID that owns this database.
	ProjectId string `json:"projectId"`
	// Database display name.
	Name string `json:"name"`
	// Product API that owns this database: tablesdb, documentsdb, vectorsdb,
	// mysql, postgresql, or mongodb.
	Api string `json:"api"`
	// Database engine: postgresql, mysql, or mongodb. Null until the backing
	// reports one.
	Engine string `json:"engine"`
	// Database engine version.
	Version string `json:"version"`
	// Specification identifier.
	Specification string `json:"specification"`
	// Database backend provider. Possible values: edge.
	Backend string `json:"backend"`
	// Database hostname for connections.
	Hostname string `json:"hostname"`
	// Database port for connections. Derived from the engine when the backing has
	// not reported one yet.
	ConnectionPort int `json:"connectionPort"`
	// Database username for connections.
	ConnectionUser string `json:"connectionUser"`
	// Database password for connections.
	ConnectionPassword string `json:"connectionPassword"`
	// Committed generation of the primary connection credentials. Null until the
	// rotation contract has been initialized.
	CredentialGeneration int `json:"credentialGeneration"`
	// Full database connection string (URI format).
	ConnectionString string `json:"connectionString"`
	// Whether SSL/TLS is required for client connections.
	Ssl bool `json:"ssl"`
	// Database status. Possible values: provisioning, ready, inactive, paused,
	// failed, deleted, restoring, scaling.
	Status string `json:"status"`
	// Container status for lifecycle-managed database runtimes: active or
	// inactive.
	ContainerStatus string `json:"containerStatus"`
	// Last activity timestamp in ISO 8601 format.
	LastAccessedAt string `json:"lastAccessedAt"`
	// Display-only timestamp when the database is expected to be considered idle
	// (ISO 8601 format). Derived from last activity; lifecycle transitions are
	// driven by lifecycleState.
	IdleUntil string `json:"idleUntil"`
	// Idle-lifecycle state of the database. Possible values: active, warm, cold,
	// hibernated.
	LifecycleState string `json:"lifecycleState"`
	// Minutes of inactivity before container scales to zero.
	IdleTimeoutMinutes int `json:"idleTimeoutMinutes"`
	// CPU allocated in millicores.
	Cpu int `json:"cpu"`
	// Memory allocated in MB.
	Memory int `json:"memory"`
	// Storage allocated in GB.
	Storage int `json:"storage"`
	// Storage class. Currently always 'ssd'; DigitalOcean exposes a single
	// block-storage class.
	StorageClass string `json:"storageClass"`
	// Maximum storage allowed in GB. 0 means use system default.
	StorageMaxGb int `json:"storageMaxGb"`
	// Kubernetes node pool where the database is scheduled.
	NodePool string `json:"nodePool"`
	// Number of high availability replicas. High availability is enabled when
	// greater than 0.
	Replicas int `json:"replicas"`
	// Replication sync mode: async, sync, or quorum.
	SyncMode string `json:"syncMode"`
	// Maximum concurrent client connections. This is the limit a client pool may
	// reach; the engine's own max_connections reported by the status endpoint is
	// a smaller backend limit the pooler multiplexes onto and does not constrain
	// a client pool.
	NetworkMaxConnections int `json:"networkMaxConnections"`
	// Connection idle timeout in seconds.
	NetworkIdleTimeoutSeconds int `json:"networkIdleTimeoutSeconds"`
	// IP addresses/CIDR ranges allowed to connect.
	NetworkIPAllowlist []string `json:"networkIPAllowlist"`
	// Whether automatic backups are enabled.
	BackupEnabled bool `json:"backupEnabled"`
	// Whether point-in-time recovery is enabled.
	Pitr bool `json:"pitr"`
	// Number of days to retain PITR data.
	PitrRetentionDays int `json:"pitrRetentionDays"`
	// Whether automatic storage expansion is enabled.
	StorageAutoscaling bool `json:"storageAutoscaling"`
	// Storage usage percentage that triggers automatic expansion.
	StorageAutoscalingThresholdPercent int `json:"storageAutoscalingThresholdPercent"`
	// Maximum storage size in GB for autoscaling. 0 means no limit.
	StorageAutoscalingMaxGb int `json:"storageAutoscalingMaxGb"`
	// Day of the week for the maintenance window. Possible values: sun, mon, tue,
	// wed, thu, fri, sat.
	MaintenanceWindowDay string `json:"maintenanceWindowDay"`
	// Hour in UTC (0-23) when the maintenance window starts.
	MaintenanceWindowHourUtc int `json:"maintenanceWindowHourUtc"`
	// Whether metrics collection is enabled.
	MetricsEnabled bool `json:"metricsEnabled"`
	// Whether the SQL API sidecar is enabled for this database.
	SqlApiEnabled bool `json:"sqlApiEnabled"`
	// Statement types accepted by the SQL API. Defaults to read/write DML only;
	// DDL/DCL types (CREATE, ALTER, DROP, TRUNCATE, GRANT, REVOKE) are opt-in per
	// database. Allowed values: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER,
	// DROP, TRUNCATE, GRANT, REVOKE.
	SqlApiAllowedStatements []string `json:"sqlApiAllowedStatements"`
	// Maximum rows returned per SQL API execution. Results larger than this are
	// truncated.
	SqlApiMaxRows int `json:"sqlApiMaxRows"`
	// Maximum serialised SQL API result payload in bytes. Results larger than
	// this are truncated.
	SqlApiMaxBytes int `json:"sqlApiMaxBytes"`
	// Maximum server-side SQL API execution time in seconds before the query is
	// cancelled.
	SqlApiTimeoutSeconds int `json:"sqlApiTimeoutSeconds"`
	// Error message if status is failed.
	Error string `json:"error"`
	// contains filtered or unexported fields
}

DedicatedDatabase Model

func (*DedicatedDatabase) Decode

func (model *DedicatedDatabase) Decode(value interface{}) error

func (DedicatedDatabase) New

func (model DedicatedDatabase) New(data []byte) *DedicatedDatabase

type DedicatedDatabaseBackup added in v7.2.0

type DedicatedDatabaseBackup struct {
	// Backup ID.
	Id string `json:"$id"`
	// Backup creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Database ID this backup belongs to.
	DatabaseId string `json:"databaseId"`
	// Project ID.
	ProjectId string `json:"projectId"`
	// Backup policy ID when the backup was created by a schedule.
	PolicyId string `json:"policyId"`
	// Backup trigger. Possible values: manual, schedule.
	Trigger string `json:"trigger"`
	// Backup type. Possible values: full (complete database snapshot),
	// incremental (changes since last backup), wal (write-ahead log continuous
	// archival).
	Type string `json:"type"`
	// Backup type that was requested. Differs from `type` when the backend could
	// not run the requested type and took a different one instead, in which case
	// `fallbackReason` explains why. Empty for backups taken before the requested
	// type was recorded.
	RequestedType string `json:"requestedType"`
	// Why the backend ran a different backup type than the one requested. Empty
	// when the backup ran as requested.
	FallbackReason string `json:"fallbackReason"`
	// Backup status. Possible values: pending (queued for processing), running
	// (currently in progress), completed (successfully finished), failed
	// (encountered an error), verified (integrity check passed).
	Status string `json:"status"`
	// Backup size in bytes.
	SizeBytes int `json:"sizeBytes"`
	// Backup start time in ISO 8601 format.
	StartedAt string `json:"startedAt"`
	// Backup completion time in ISO 8601 format.
	CompletedAt string `json:"completedAt"`
	// Backup verification time in ISO 8601 format.
	VerifiedAt string `json:"verifiedAt"`
	// Backup expiration time in ISO 8601 format.
	ExpiresAt string `json:"expiresAt"`
	// Transaction-log position the backup anchors at, in the engine's own
	// notation: PostgreSQL `{walSegment}|{lsn}`, MySQL and MariaDB
	// `{binlogFile}|{offset}`, MongoDB `{seconds}|{increment}`. Empty when the
	// backup recorded no position, which is the case for backup types that carry
	// none.
	LogPosition string `json:"logPosition"`
	// Error message if backup failed.
	Error string `json:"error"`
	// contains filtered or unexported fields
}

Backup Model

func (*DedicatedDatabaseBackup) Decode added in v7.2.0

func (model *DedicatedDatabaseBackup) Decode(value interface{}) error

func (DedicatedDatabaseBackup) New added in v7.2.0

type DedicatedDatabaseBackupList added in v7.2.0

type DedicatedDatabaseBackupList struct {
	// Total number of backups.
	Total int `json:"total"`
	// List of backups.
	Backups []DedicatedDatabaseBackup `json:"backups"`
	// contains filtered or unexported fields
}

BackupList Model

func (*DedicatedDatabaseBackupList) Decode added in v7.2.0

func (model *DedicatedDatabaseBackupList) Decode(value interface{}) error

func (DedicatedDatabaseBackupList) New added in v7.2.0

type DedicatedDatabaseBackupStorage added in v7.2.0

type DedicatedDatabaseBackupStorage struct {
	// Storage provider. Possible values: s3 (Amazon S3 or S3-compatible), gcs
	// (Google Cloud Storage), azure (Azure Blob Storage).
	Provider string `json:"provider"`
	// Storage bucket or container name.
	Bucket string `json:"bucket"`
	// Storage region.
	Region string `json:"region"`
	// Object key prefix for backups.
	Prefix string `json:"prefix"`
	// Custom endpoint for S3-compatible storage.
	Endpoint string `json:"endpoint"`
	// contains filtered or unexported fields
}

BackupStorageConfig Model

func (*DedicatedDatabaseBackupStorage) Decode added in v7.2.0

func (model *DedicatedDatabaseBackupStorage) Decode(value interface{}) error

func (DedicatedDatabaseBackupStorage) New added in v7.2.0

type DedicatedDatabaseBranch added in v7.2.0

type DedicatedDatabaseBranch struct {
	// Branch identifier.
	BranchId string `json:"branchId"`
	// Branch name.
	BranchName string `json:"branchName"`
	// Kubernetes namespace where the branch is deployed.
	Namespace string `json:"namespace"`
	// Unix timestamp when the branch expires.
	ExpiresAt int `json:"expiresAt"`
	// Branch hostname for direct connections.
	Host string `json:"host"`
	// Branch port. Null until the backing reports one.
	Port int `json:"port"`
	// Advertised catalog the client connects to. MySQL/MariaDB use default;
	// Postgres uses the routing label.
	Database string `json:"database"`
	// Database username. Shared with the parent database.
	Username string `json:"username"`
	// Database password. Shared with the parent database.
	Password string `json:"password"`
	// Whether SSL is required.
	Ssl bool `json:"ssl"`
	// Database engine. Possible values: postgresql, mysql, mongodb.
	Engine string `json:"engine"`
	// Full connection string for the branch.
	ConnectionString string `json:"connectionString"`
	// contains filtered or unexported fields
}

Branch Model

func (*DedicatedDatabaseBranch) Decode added in v7.2.0

func (model *DedicatedDatabaseBranch) Decode(value interface{}) error

func (DedicatedDatabaseBranch) New added in v7.2.0

type DedicatedDatabaseBranchList added in v7.2.0

type DedicatedDatabaseBranchList struct {
	// Total number of branches.
	Total int `json:"total"`
	// List of branches.
	Branches []DedicatedDatabaseBranch `json:"branches"`
	// contains filtered or unexported fields
}

BranchList Model

func (*DedicatedDatabaseBranchList) Decode added in v7.2.0

func (model *DedicatedDatabaseBranchList) Decode(value interface{}) error

func (DedicatedDatabaseBranchList) New added in v7.2.0

type DedicatedDatabaseExecution added in v7.2.0

type DedicatedDatabaseExecution struct {
	// Result rows as a list of column-name => value maps. Empty for non-returning
	// statements.
	Rows []interface{} `json:"rows"`
	// Number of rows returned (for SELECT) or affected (for
	// INSERT/UPDATE/DELETE).
	RowCount int `json:"rowCount"`
	// Column metadata in result-set order.
	Columns []DedicatedDatabaseExecutionColumn `json:"columns"`
	// Server-side execution time in milliseconds.
	DurationMs int `json:"durationMs"`
	// True when the configured row or byte cap was hit and the result was
	// truncated.
	Truncated bool `json:"truncated"`
	// Serialised payload size in bytes.
	Bytes int `json:"bytes"`
	// contains filtered or unexported fields
}

Execution Model

func (*DedicatedDatabaseExecution) Decode added in v7.2.0

func (model *DedicatedDatabaseExecution) Decode(value interface{}) error

func (DedicatedDatabaseExecution) New added in v7.2.0

type DedicatedDatabaseExecutionColumn added in v7.2.0

type DedicatedDatabaseExecutionColumn struct {
	// Column name as returned by the database.
	Name string `json:"name"`
	// Engine-specific column type (e.g. int4, text, timestamptz).
	Type string `json:"type"`
	// contains filtered or unexported fields
}

ExecutionColumn Model

func (*DedicatedDatabaseExecutionColumn) Decode added in v7.2.0

func (model *DedicatedDatabaseExecutionColumn) Decode(value interface{}) error

func (DedicatedDatabaseExecutionColumn) New added in v7.2.0

type DedicatedDatabaseExtensions added in v7.2.0

type DedicatedDatabaseExtensions struct {
	// List of installed extensions.
	Installed []string `json:"installed"`
	// List of available extensions that can be installed.
	Available []string `json:"available"`
	// Curated metadata (display name, description, category) for each available
	// extension.
	Metadata []PostgresExtension `json:"metadata"`
	// contains filtered or unexported fields
}

Extensions Model

func (*DedicatedDatabaseExtensions) Decode added in v7.2.0

func (model *DedicatedDatabaseExtensions) Decode(value interface{}) error

func (DedicatedDatabaseExtensions) New added in v7.2.0

type DedicatedDatabaseList added in v7.2.0

type DedicatedDatabaseList struct {
	// Total number of databases that matched your query.
	Total int `json:"total"`
	// List of databases.
	Databases []DedicatedDatabase `json:"databases"`
	// contains filtered or unexported fields
}

DedicatedDatabasesList Model

func (*DedicatedDatabaseList) Decode added in v7.2.0

func (model *DedicatedDatabaseList) Decode(value interface{}) error

func (DedicatedDatabaseList) New added in v7.2.0

type DedicatedDatabaseMember

type DedicatedDatabaseMember struct {
	// Member identifier.
	Id string `json:"$id"`
	// Member role. Possible values: primary (accepts reads and writes), replica
	// (read-only follower), unknown (placement not established; reported while a
	// transition is moving or restarting the topology and this member has not
	// been probed, so no member can be named the write target).
	Role string `json:"role"`
	// Member pod status. Possible values: pending (configured but absent from the
	// backend topology, so nothing is bringing it up), provisioning (pod missing
	// or Pending), starting (Running but not Ready), active (Running and Ready),
	// failed (Failed phase or CrashLoopBackOff container), or the lowercased pod
	// phase reported by the cluster.
	Status string `json:"status"`
	// Whether the engine reports this member's replication stream as up. Null
	// when no reading was taken: a primary has no stream to report, and a member
	// that is not active, or whose probe did not answer, has none yet. False is a
	// reading and null is the absence of one, so the two are not interchangeable.
	// Read it beside lagSeconds before expecting a failover that names no target
	// to find a promotable standby: a member streaming at a known lag is one, and
	// a member reporting null is not evidence either way.
	Replicating bool `json:"replicating"`
	// Replication lag in seconds. Null when the lag is not known: a primary has
	// none to report, and a member the backend has not probed has none yet. Also
	// null against `replicating: true`, for a member that is streaming but whose
	// engine printed no numeric lag.
	LagSeconds float64 `json:"lagSeconds"`
	// contains filtered or unexported fields
}

Member Model

func (*DedicatedDatabaseMember) Decode

func (model *DedicatedDatabaseMember) Decode(value interface{}) error

func (DedicatedDatabaseMember) New

type DedicatedDatabaseOperation

type DedicatedDatabaseOperation struct {
	// Operation ID.
	Id string `json:"$id"`
	// Operation creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Database ID the operation ran against.
	DatabaseId string `json:"databaseId"`
	// Operation type, such as provision, update, credentials-update, restore,
	// pausing, resuming, failover, backup-create or cross-region-enable.
	Type string `json:"type"`
	// Operation status. Possible values: queued (accepted and waiting to resume),
	// running (in progress), completed (finished successfully), failed (ended in
	// an error).
	Status string `json:"status"`
	// Number of times this operation has been attempted.
	Attempts int `json:"attempts"`
	// Time the operation was requested, in ISO 8601 format.
	RequestedAt string `json:"requestedAt"`
	// Time the operation started, in ISO 8601 format.
	StartedAt string `json:"startedAt"`
	// Time the operation reached a terminal state, in ISO 8601 format.
	CompletedAt string `json:"completedAt"`
	// Machine-readable failure code. `Interrupted` marks an attempt that ended
	// before its outcome could be confirmed.
	ErrorCode string `json:"errorCode"`
	// Failure message if the operation failed.
	ErrorMessage string `json:"errorMessage"`
	// contains filtered or unexported fields
}

Operation Model

func (*DedicatedDatabaseOperation) Decode

func (model *DedicatedDatabaseOperation) Decode(value interface{}) error

func (DedicatedDatabaseOperation) New

type DedicatedDatabaseOperationList

type DedicatedDatabaseOperationList struct {
	// Total number of operations.
	Total int `json:"total"`
	// List of operations.
	Operations []DedicatedDatabaseOperation `json:"operations"`
	// contains filtered or unexported fields
}

OperationList Model

func (*DedicatedDatabaseOperationList) Decode

func (model *DedicatedDatabaseOperationList) Decode(value interface{}) error

func (DedicatedDatabaseOperationList) New

type DedicatedDatabasePITRWindows added in v7.2.0

type DedicatedDatabasePITRWindows struct {
	// Earliest available recovery point.
	Earliest string `json:"earliest"`
	// Latest available recovery point.
	Latest string `json:"latest"`
	// contains filtered or unexported fields
}

PITRWindows Model

func (*DedicatedDatabasePITRWindows) Decode added in v7.2.0

func (model *DedicatedDatabasePITRWindows) Decode(value interface{}) error

func (DedicatedDatabasePITRWindows) New added in v7.2.0

type DedicatedDatabasePooler added in v7.2.0

type DedicatedDatabasePooler struct {
	// Whether connection pooling is enabled.
	Enabled bool `json:"enabled"`
	// Connection pool mode. Possible values: transaction (releases connections
	// back to pool after each transaction), session (holds connections for the
	// entire client session).
	Mode string `json:"mode"`
	// Client-connection ceiling the pooler accepts. Enforced on MySQL and
	// MariaDB; on PostgreSQL the pooler has no client cap, so this reports the
	// database's advertised networkMaxConnections and cannot be set here.
	MaxConnections int `json:"maxConnections"`
	// Default pool size per user.
	DefaultPoolSize int `json:"defaultPoolSize"`
	// Pooler listening port.
	Port int `json:"port"`
	// Whether SELECTs are routed to HA replicas while writes and locked reads
	// stay on the primary. Active only when HA is enabled.
	ReadWriteSplitting bool `json:"readWriteSplitting"`
	// Effective CPU request applied to the pooler sidecar container (Kubernetes
	// quantity). Returns the proportional default (5% of DB CPU, floor 100m)
	// unless overridden.
	PoolerCpuRequest string `json:"poolerCpuRequest"`
	// Effective CPU limit applied to the pooler sidecar container (Kubernetes
	// quantity). Returns the proportional default (10% of DB CPU, floor 200m)
	// unless overridden.
	PoolerCpuLimit string `json:"poolerCpuLimit"`
	// Effective memory request applied to the pooler sidecar container
	// (Kubernetes quantity). Returns the proportional default (7.5% of DB memory,
	// floor 64Mi) unless overridden.
	PoolerMemoryRequest string `json:"poolerMemoryRequest"`
	// Effective memory limit applied to the pooler sidecar container (Kubernetes
	// quantity). Returns the proportional default (15% of DB memory, floor 128Mi)
	// unless overridden.
	PoolerMemoryLimit string `json:"poolerMemoryLimit"`
	// contains filtered or unexported fields
}

PoolerConfig Model

func (*DedicatedDatabasePooler) Decode added in v7.2.0

func (model *DedicatedDatabasePooler) Decode(value interface{}) error

func (DedicatedDatabasePooler) New added in v7.2.0

type DedicatedDatabaseReplicas

type DedicatedDatabaseReplicas struct {
	// Number of configured replicas. Zero means high availability is disabled.
	Replicas int `json:"replicas"`
	// Requested replication sync mode. Possible values: async (asynchronous,
	// fastest), sync (synchronous, strong consistency), quorum (quorum-based,
	// majority of replicas must confirm). This is what was asked for; compare it
	// with effectiveSyncMode for what the primary is enforcing.
	SyncMode string `json:"syncMode"`
	// Replication sync mode the primary is actually enforcing. Null when high
	// availability is disabled or the state could not be read. A value below the
	// requested syncMode means writes are being acknowledged with weaker
	// durability than configured.
	EffectiveSyncMode string `json:"effectiveSyncMode"`
	// Whether the enforced replication is weaker than the requested syncMode.
	SyncDegraded bool `json:"syncDegraded"`
	// Number of standby acknowledgements the primary waits for before a write is
	// committed. Zero means writes are acknowledged locally.
	SyncAcknowledgements int `json:"syncAcknowledgements"`
	// Number of standbys registered with the primary for synchronous replication.
	SyncStandbyCount int `json:"syncStandbyCount"`
	// Whether the other sync fields are an engine reading rather than a recorded
	// estimate. True when the primary answered what it is enforcing, including
	// when that answer contradicted the record, in which case the contradicted
	// values are replaced by the ones the engine reports. False when the reading
	// could not be taken: the probe did not answer, there was no engine to ask,
	// or the values describe a configuration change just applied rather than
	// anything measured. Absent when no engine was asked at all, so an unprobed
	// database is distinguishable from an unconfirmed one. False never means a
	// standby was found lagging, because it is the absence of a reading rather
	// than a negative one, so draw no conclusion about replication health from it
	// or from a response that omits it.
	SyncStateConfirmed bool `json:"syncStateConfirmed"`
	// Per-pod statuses for the primary and every replica.
	Members []DedicatedDatabaseMember `json:"members"`
	// contains filtered or unexported fields
}

Replicas Model

func (*DedicatedDatabaseReplicas) Decode

func (model *DedicatedDatabaseReplicas) Decode(value interface{}) error

func (DedicatedDatabaseReplicas) New

type DedicatedDatabaseRestoration added in v7.2.0

type DedicatedDatabaseRestoration struct {
	// Restoration ID.
	Id string `json:"$id"`
	// Restoration creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Database ID being restored into.
	DatabaseId string `json:"databaseId"`
	// Source database ID when restoring a backup into another database.
	SourceDatabaseId string `json:"sourceDatabaseId"`
	// Project ID.
	ProjectId string `json:"projectId"`
	// Backup ID used for restoration (null for PITR).
	BackupId string `json:"backupId"`
	// Restoration type. Possible values: backup (restore from a specific backup
	// snapshot), pitr (point-in-time recovery to a specific timestamp).
	Type string `json:"type"`
	// Restoration status. Possible values: pending (queued for processing),
	// running (currently in progress), completed (successfully finished), failed
	// (encountered an error).
	Status string `json:"status"`
	// Target time for PITR restoration in ISO 8601 format.
	TargetTime string `json:"targetTime"`
	// Restoration start time in ISO 8601 format.
	StartedAt string `json:"startedAt"`
	// Restoration completion time in ISO 8601 format.
	CompletedAt string `json:"completedAt"`
	// Error message if restoration failed.
	Error string `json:"error"`
	// contains filtered or unexported fields
}

Restoration Model

func (*DedicatedDatabaseRestoration) Decode added in v7.2.0

func (model *DedicatedDatabaseRestoration) Decode(value interface{}) error

func (DedicatedDatabaseRestoration) New added in v7.2.0

type DedicatedDatabaseRestorationList added in v7.2.0

type DedicatedDatabaseRestorationList struct {
	// Total number of restorations that matched your query.
	Total int `json:"total"`
	// List of restorations.
	Restorations []DedicatedDatabaseRestoration `json:"restorations"`
	// contains filtered or unexported fields
}

DedicatedDatabaseRestorationsList Model

func (*DedicatedDatabaseRestorationList) Decode added in v7.2.0

func (model *DedicatedDatabaseRestorationList) Decode(value interface{}) error

func (DedicatedDatabaseRestorationList) New added in v7.2.0

type DedicatedDatabaseSpecification

type DedicatedDatabaseSpecification struct {
	// Specification slug. Use this value when creating a dedicated database.
	Slug string `json:"slug"`
	// Human readable specification name.
	Name string `json:"name"`
	// Monthly price of the specification in USD.
	Price float64 `json:"price"`
	// Allocated CPU in millicores.
	Cpu int `json:"cpu"`
	// Allocated memory in MB.
	Memory int `json:"memory"`
	// Maximum number of concurrent connections.
	MaxConnections int `json:"maxConnections"`
	// Included storage in GB before overage charges apply.
	IncludedStorage int `json:"includedStorage"`
	// Included bandwidth in GB before overage charges apply.
	IncludedBandwidth int `json:"includedBandwidth"`
	// Whether the specification is available on the current plan.
	Enabled bool `json:"enabled"`
	// contains filtered or unexported fields
}

Specification Model

func (*DedicatedDatabaseSpecification) Decode

func (model *DedicatedDatabaseSpecification) Decode(value interface{}) error

func (DedicatedDatabaseSpecification) New

type DedicatedDatabaseSpecificationList

type DedicatedDatabaseSpecificationList struct {
	// List of dedicated database specifications.
	Specifications []DedicatedDatabaseSpecification `json:"specifications"`
	// Total number of specifications.
	Total int `json:"total"`
	// Overage and add-on pricing shared across all specifications.
	Pricing DedicatedDatabaseSpecificationPricing `json:"pricing"`
	// contains filtered or unexported fields
}

SpecificationList Model

func (*DedicatedDatabaseSpecificationList) Decode

func (model *DedicatedDatabaseSpecificationList) Decode(value interface{}) error

func (DedicatedDatabaseSpecificationList) New

type DedicatedDatabaseSpecificationPricing

type DedicatedDatabaseSpecificationPricing struct {
	// Price per GB of storage above the included amount, per month, in USD.
	StorageOverageRate float64 `json:"storageOverageRate"`
	// Price per GB of bandwidth above the included amount, per month, in USD.
	BandwidthOverageRate float64 `json:"bandwidthOverageRate"`
	// High availability replica price as a fraction of the specification cost.
	ReplicaRate float64 `json:"replicaRate"`
	// Point-in-time recovery price as a fraction of the specification cost.
	PitrRate float64 `json:"pitrRate"`
	// contains filtered or unexported fields
}

SpecificationPricing Model

func (*DedicatedDatabaseSpecificationPricing) Decode

func (model *DedicatedDatabaseSpecificationPricing) Decode(value interface{}) error

func (DedicatedDatabaseSpecificationPricing) New

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:"type"`
	// 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.
	SourceSize int `json:"sourceSize"`
	// The build output size in bytes.
	BuildSize int `json:"buildSize"`
	// The total size in bytes (source and build output).
	TotalSize int `json:"totalSize"`
	// The current build ID.
	BuildId string `json:"buildId"`
	// Whether the deployment should be automatically activated.
	Activate bool `json:"activate"`
	// Screenshot with light theme preference file ID.
	ScreenshotLight string `json:"screenshotLight"`
	// Screenshot with dark theme preference file ID.
	ScreenshotDark string `json:"screenshotDark"`
	// The deployment status. Possible values are "waiting", "processing",
	// "building", "ready", "canceled" and "failed".
	Status string `json:"status"`
	// The build logs.
	BuildLogs string `json:"buildLogs"`
	// The current build time in seconds.
	BuildDuration int `json:"buildDuration"`
	// 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 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
	ProviderBranch string `json:"providerBranch"`
	// The branch of the vcs repository
	ProviderBranchUrl string `json:"providerBranchUrl"`
	// contains filtered or unexported fields
}

Deployment Model

func (*Deployment) Decode

func (model *Deployment) Decode(value interface{}) error

func (Deployment) New

func (model Deployment) New(data []byte) *Deployment

type DeploymentList

type DeploymentList struct {
	// Total number of deployments that matched your query.
	Total int `json:"total"`
	// List of deployments.
	Deployments []Deployment `json:"deployments"`
	// contains filtered or unexported fields
}

DeploymentsList Model

func (*DeploymentList) Decode

func (model *DeploymentList) Decode(value interface{}) error

func (DeploymentList) New

func (model DeploymentList) New(data []byte) *DeploymentList

type DevKey

type DevKey struct {
	// Key ID.
	Id string `json:"$id"`
	// Key creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Key update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Key name.
	Name string `json:"name"`
	// Key expiration date in ISO 8601 format.
	Expire string `json:"expire"`
	// Secret key.
	Secret string `json:"secret"`
	// Most recent access date in ISO 8601 format. This attribute is only updated
	// again after 24 hours.
	AccessedAt string `json:"accessedAt"`
	// List of SDK user agents that used this key.
	Sdks []string `json:"sdks"`
	// contains filtered or unexported fields
}

DevKey Model

func (*DevKey) Decode

func (model *DevKey) Decode(value interface{}) error

func (DevKey) New

func (model DevKey) New(data []byte) *DevKey

type Document

type Document struct {
	// Document ID.
	Id string `json:"$id"`
	// Document sequence ID.
	Sequence string `json:"$sequence"`
	// 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 []string `json:"$permissions"`
	// contains filtered or unexported fields
}

Document Model

func (*Document) Decode

func (model *Document) Decode(value interface{}) error

Use this method to get response in desired type

func (Document) New

func (model Document) New(data []byte) *Document

type DocumentList

type DocumentList struct {
	// Total number of documents that matched your query.
	Total int `json:"total"`
	// List of documents.
	Documents []Document `json:"documents"`
	// contains filtered or unexported fields
}

DocumentsList Model

func (*DocumentList) Decode

func (model *DocumentList) Decode(value interface{}) error

func (DocumentList) New

func (model DocumentList) New(data []byte) *DocumentList

type EmailTemplate

type EmailTemplate struct {
	// Template type
	TemplateId string `json:"templateId"`
	// Template locale
	Locale string `json:"locale"`
	// Template message
	Message string `json:"message"`
	// Name of the sender
	SenderName string `json:"senderName"`
	// Email of the sender
	SenderEmail string `json:"senderEmail"`
	// Reply to email address
	ReplyToEmail string `json:"replyToEmail"`
	// Reply to name
	ReplyToName string `json:"replyToName"`
	// Email subject
	Subject string `json:"subject"`
	// contains filtered or unexported fields
}

EmailTemplate Model

func (*EmailTemplate) Decode

func (model *EmailTemplate) Decode(value interface{}) error

func (EmailTemplate) New

func (model EmailTemplate) New(data []byte) *EmailTemplate

type EmailTemplateList

type EmailTemplateList struct {
	// Total number of templates that matched your query.
	Total int `json:"total"`
	// List of templates.
	Templates []EmailTemplate `json:"templates"`
	// contains filtered or unexported fields
}

EmailTemplatesList Model

func (*EmailTemplateList) Decode

func (model *EmailTemplateList) Decode(value interface{}) error

func (EmailTemplateList) New

func (model EmailTemplateList) New(data []byte) *EmailTemplateList

type Embedding

type Embedding struct {
	// Embedding model used to generate embeddings.
	Model string `json:"model"`
	// Number of dimensions for each embedding vector.
	Dimension int `json:"dimension"`
	// Embedding vector values. If an error occurs, this will be an empty array.
	Embedding []float64 `json:"embedding"`
	// Error message if embedding generation fails. Empty string if no error.
	Error string `json:"error"`
	// contains filtered or unexported fields
}

Embedding Model

func (*Embedding) Decode

func (model *Embedding) Decode(value interface{}) error

func (Embedding) New

func (model Embedding) New(data []byte) *Embedding

type EmbeddingList

type EmbeddingList struct {
	// Total number of embeddings that matched your query.
	Total int `json:"total"`
	// List of embeddings.
	Embeddings []Embedding `json:"embeddings"`
	// contains filtered or unexported fields
}

EmbeddingList Model

func (*EmbeddingList) Decode

func (model *EmbeddingList) Decode(value interface{}) error

func (EmbeddingList) New

func (model EmbeddingList) New(data []byte) *EmbeddingList

type EphemeralKey

type EphemeralKey struct {
	// Key ID.
	Id string `json:"$id"`
	// Key creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Key update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Key name.
	Name string `json:"name"`
	// Key expiration date in ISO 8601 format.
	Expire string `json:"expire"`
	// Allowed permission scopes.
	Scopes []string `json:"scopes"`
	// Secret key.
	Secret string `json:"secret"`
	// Most recent access date in ISO 8601 format. This attribute is only updated
	// again after 24 hours.
	AccessedAt string `json:"accessedAt"`
	// List of SDK user agents that used this key.
	Sdks []string `json:"sdks"`
	// contains filtered or unexported fields
}

EphemeralKey Model

func (*EphemeralKey) Decode

func (model *EphemeralKey) Decode(value interface{}) error

func (EphemeralKey) New

func (model EphemeralKey) New(data []byte) *EphemeralKey

type Execution

type Execution struct {
	// Execution ID.
	Id string `json:"$id"`
	// Execution creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Execution update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Execution roles.
	Permissions []string `json:"$permissions"`
	// Function or site ID.
	ResourceId string `json:"resourceId"`
	// Execution resource type.
	ResourceType string `json:"resourceType"`
	// Deployment ID used to create the execution.
	DeploymentId string `json:"deploymentId"`
	// The trigger that caused the resource to execute. Possible values can be:
	// `http`, `schedule`, or `event`.
	Trigger string `json:"trigger"`
	// The status of the resource execution. Possible values can be: `waiting`,
	// `processing`, `completed`, `failed`, or `scheduled`.
	Status string `json:"status"`
	// HTTP request method type.
	RequestMethod string `json:"requestMethod"`
	// HTTP request path and query.
	RequestPath string `json:"requestPath"`
	// HTTP request headers as a key-value object. This will return only
	// whitelisted headers. All headers are returned if execution is created as
	// synchronous.
	RequestHeaders []Headers `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 []Headers `json:"responseHeaders"`
	// Resource 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"`
	// Resource 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"`
	// Resource(function/site) execution duration in seconds.
	Duration float64 `json:"duration"`
	// The scheduled time for execution. If left empty, execution will be queued
	// immediately.
	ScheduledAt string `json:"scheduledAt"`
	// contains filtered or unexported fields
}

Execution Model

func (*Execution) Decode

func (model *Execution) Decode(value interface{}) error

func (Execution) New

func (model Execution) New(data []byte) *Execution

type ExecutionList

type ExecutionList struct {
	// Total number of executions that matched your query.
	Total int `json:"total"`
	// List of executions.
	Executions []Execution `json:"executions"`
	// contains filtered or unexported fields
}

ExecutionsList Model

func (*ExecutionList) Decode

func (model *ExecutionList) Decode(value interface{}) error

func (ExecutionList) New

func (model ExecutionList) New(data []byte) *ExecutionList

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 []string `json:"$permissions"`
	// File name.
	Name string `json:"name"`
	// Virtual folder containing the file, with a trailing slash. Empty for the
	// bucket root.
	Folder string `json:"folder"`
	// Full virtual path of the file: the folder followed by the file name.
	Key string `json:"key"`
	// File MD5 signature.
	Signature string `json:"signature"`
	// File mime type.
	MimeType string `json:"mimeType"`
	// File original size in bytes.
	SizeOriginal int `json:"sizeOriginal"`
	// File actual stored size in bytes after compression and/or encryption.
	SizeActual int `json:"sizeActual"`
	// Total number of chunks available
	ChunksTotal int `json:"chunksTotal"`
	// Total number of chunks uploaded
	ChunksUploaded int `json:"chunksUploaded"`
	// Whether file contents are encrypted at rest.
	Encryption bool `json:"encryption"`
	// Compression algorithm used for the file. Will be one of none,
	// [gzip](https://en.wikipedia.org/wiki/Gzip), or
	// [zstd](https://en.wikipedia.org/wiki/Zstd).
	Compression string `json:"compression"`
	// contains filtered or unexported fields
}

File Model

func (*File) Decode

func (model *File) Decode(value interface{}) error

func (File) New

func (model File) New(data []byte) *File

type FileList

type FileList struct {
	// Total number of files that matched your query.
	Total int `json:"total"`
	// List of files.
	Files []File `json:"files"`
	// contains filtered or unexported fields
}

FilesList Model

func (*FileList) Decode

func (model *FileList) Decode(value interface{}) error

func (FileList) New

func (model FileList) New(data []byte) *FileList

type Framework

type Framework struct {
	// Framework key.
	Key string `json:"key"`
	// Framework Name.
	Name string `json:"name"`
	// Default runtime version.
	BuildRuntime string `json:"buildRuntime"`
	// List of supported runtime versions.
	Runtimes []string `json:"runtimes"`
	// List of supported adapters.
	Adapters []FrameworkAdapter `json:"adapters"`
	// contains filtered or unexported fields
}

Framework Model

func (*Framework) Decode

func (model *Framework) Decode(value interface{}) error

func (Framework) New

func (model Framework) New(data []byte) *Framework

type FrameworkAdapter

type FrameworkAdapter struct {
	// Adapter key.
	Key string `json:"key"`
	// Default command to download dependencies.
	InstallCommand string `json:"installCommand"`
	// Default command to build site into output directory.
	BuildCommand string `json:"buildCommand"`
	// Default output directory of build.
	OutputDirectory string `json:"outputDirectory"`
	// Name of fallback file to use instead of 404 page. If null, Appwrite 404
	// page will be displayed.
	FallbackFile string `json:"fallbackFile"`
	// contains filtered or unexported fields
}

FrameworkAdapter Model

func (*FrameworkAdapter) Decode

func (model *FrameworkAdapter) Decode(value interface{}) error

func (FrameworkAdapter) New

func (model FrameworkAdapter) New(data []byte) *FrameworkAdapter

type FrameworkList

type FrameworkList struct {
	// Total number of frameworks that matched your query.
	Total int `json:"total"`
	// List of frameworks.
	Frameworks []Framework `json:"frameworks"`
	// contains filtered or unexported fields
}

FrameworksList Model

func (*FrameworkList) Decode

func (model *FrameworkList) Decode(value interface{}) error

func (FrameworkList) New

func (model FrameworkList) New(data []byte) *FrameworkList

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 []string `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"`
	// When disabled, executions will exclude logs and errors, and will be
	// slightly faster.
	Logging bool `json:"logging"`
	// Function execution and build runtime.
	Runtime string `json:"runtime"`
	// How many days to keep the non-active deployments before they will be
	// automatically deleted.
	DeploymentRetention int `json:"deploymentRetention"`
	// Function's active deployment ID.
	DeploymentId string `json:"deploymentId"`
	// Active deployment creation date in ISO 8601 format.
	DeploymentCreatedAt string `json:"deploymentCreatedAt"`
	// Function's latest deployment ID.
	LatestDeploymentId string `json:"latestDeploymentId"`
	// Latest deployment creation date in ISO 8601 format.
	LatestDeploymentCreatedAt string `json:"latestDeploymentCreatedAt"`
	// Status of latest deployment. Possible values are "waiting", "processing",
	// "building", "ready", and "failed".
	LatestDeploymentStatus string `json:"latestDeploymentStatus"`
	// Allowed permission scopes.
	Scopes []string `json:"scopes"`
	// Function variables.
	Vars []Variable `json:"vars"`
	// Function trigger events.
	Events []string `json:"events"`
	// Function execution schedule 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"`
	// List of branch name patterns that trigger automatic deployments. Supports
	// glob wildcards. Empty list deploys on all branches.
	ProviderBranches []string `json:"providerBranches"`
	// List of file path patterns that trigger automatic deployments. Supports
	// glob wildcards. Empty list deploys on all file changes.
	ProviderPaths []string `json:"providerPaths"`
	// Machine specification for deployment builds.
	BuildSpecification string `json:"buildSpecification"`
	// Machine specification for executions.
	RuntimeSpecification string `json:"runtimeSpecification"`
	// contains filtered or unexported fields
}

Function Model

func (*Function) Decode

func (model *Function) Decode(value interface{}) error

func (Function) New

func (model Function) New(data []byte) *Function

type FunctionList

type FunctionList struct {
	// Total number of functions that matched your query.
	Total int `json:"total"`
	// List of functions.
	Functions []Function `json:"functions"`
	// contains filtered or unexported fields
}

FunctionsList Model

func (*FunctionList) Decode

func (model *FunctionList) Decode(value interface{}) error

func (FunctionList) New

func (model FunctionList) New(data []byte) *FunctionList

type Headers

type Headers struct {
	// Header name.
	Name string `json:"name"`
	// Header value.
	Value string `json:"value"`
	// contains filtered or unexported fields
}

Headers Model

func (*Headers) Decode

func (model *Headers) Decode(value interface{}) error

func (Headers) New

func (model Headers) New(data []byte) *Headers

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"`
	// contains filtered or unexported fields
}

Identity Model

func (*Identity) Decode

func (model *Identity) Decode(value interface{}) error

func (Identity) New

func (model Identity) New(data []byte) *Identity

type IdentityList

type IdentityList struct {
	// Total number of identities that matched your query.
	Total int `json:"total"`
	// List of identities.
	Identities []Identity `json:"identities"`
	// contains filtered or unexported fields
}

IdentitiesList Model

func (*IdentityList) Decode

func (model *IdentityList) Decode(value interface{}) error

func (IdentityList) New

func (model IdentityList) New(data []byte) *IdentityList

type Index

type Index struct {
	// Index ID.
	Id string `json:"$id"`
	// Index creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Index update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Index key.
	Key string `json:"key"`
	// Index type.
	Type string `json:"type"`
	// 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:"error"`
	// Index attributes.
	Attributes []string `json:"attributes"`
	// Index attributes length.
	Lengths []int `json:"lengths"`
	// Index orders.
	Orders []string `json:"orders"`
	// contains filtered or unexported fields
}

Index Model

func (*Index) Decode

func (model *Index) Decode(value interface{}) error

func (Index) New

func (model Index) New(data []byte) *Index

type IndexList

type IndexList struct {
	// Total number of indexes that matched your query.
	Total int `json:"total"`
	// List of indexes.
	Indexes []Index `json:"indexes"`
	// contains filtered or unexported fields
}

IndexesList Model

func (*IndexList) Decode

func (model *IndexList) Decode(value interface{}) error

func (IndexList) New

func (model IndexList) New(data []byte) *IndexList

type Insight

type Insight struct {
	// Insight ID.
	Id string `json:"$id"`
	// Insight creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Insight update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Parent report ID. Insights always belong to a report.
	ReportId string `json:"reportId"`
	// Insight type. One of databaseIndex (legacy), tablesDBIndex,
	// documentsDBIndex, vectorsDBIndex, databasePerformance, sitePerformance,
	// siteAccessibility, siteSeo, functionPerformance. The index types are
	// engine-specific so each CTA can pair the right service+method
	// (databases.createIndex, tablesDB.createIndex, documentsDB.createIndex, or
	// vectorsDB.createIndex).
	Type string `json:"type"`
	// Insight severity. One of info, warning, critical.
	Severity string `json:"severity"`
	// Insight status. One of active, dismissed.
	Status string `json:"status"`
	// Type of the resource the insight is about. Plural noun, e.g. databases,
	// sites, functions.
	ResourceType string `json:"resourceType"`
	// ID of the resource the insight is about.
	ResourceId string `json:"resourceId"`
	// Plural noun for the parent resource that contains the insight's resource,
	// e.g. an insight about a column index on a table → resourceType=indexes,
	// parentResourceType=tables. Empty when the resource has no parent.
	ParentResourceType string `json:"parentResourceType"`
	// ID of the parent resource. Empty when the resource has no parent.
	ParentResourceId string `json:"parentResourceId"`
	// Insight title.
	Title string `json:"title"`
	// Short markdown summary describing the insight.
	Summary string `json:"summary"`
	// List of call-to-action buttons attached to this insight.
	Ctas []InsightCTA `json:"ctas"`
	// Time the insight was analyzed in ISO 8601 format.
	AnalyzedAt string `json:"analyzedAt"`
	// Time the insight was dismissed in ISO 8601 format. Empty when not
	// dismissed.
	DismissedAt string `json:"dismissedAt"`
	// User ID that dismissed the insight. Empty when not dismissed.
	DismissedBy string `json:"dismissedBy"`
	// contains filtered or unexported fields
}

Insight Model

func (*Insight) Decode

func (model *Insight) Decode(value interface{}) error

func (Insight) New

func (model Insight) New(data []byte) *Insight

type InsightCTA

type InsightCTA struct {
	// Human-readable label for the CTA, used in UI.
	Label string `json:"label"`
	// Public API service (SDK namespace) the client should invoke. Must match the
	// engine that owns the resource — for index suggestions: databases
	// (legacy), tablesDB, documentsDB, or vectorsDB.
	Service string `json:"service"`
	// Public API method on the chosen service the client should invoke when this
	// CTA is triggered.
	Method string `json:"method"`
	// Parameter map the client should pass to the service method when this CTA is
	// triggered. Keys match the target API's parameter names (e.g.
	// databaseId/tableId/columns for tablesDB, databaseId/collectionId/attributes
	// for the legacy Databases API).
	Params interface{} `json:"params"`
	// contains filtered or unexported fields
}

InsightCTA Model

func (*InsightCTA) Decode

func (model *InsightCTA) Decode(value interface{}) error

func (InsightCTA) New

func (model InsightCTA) New(data []byte) *InsightCTA

type InsightList

type InsightList struct {
	// Total number of insights that matched your query.
	Total int `json:"total"`
	// List of insights.
	Insights []Insight `json:"insights"`
	// contains filtered or unexported fields
}

InsightsList Model

func (*InsightList) Decode

func (model *InsightList) Decode(value interface{}) error

func (InsightList) New

func (model InsightList) New(data []byte) *InsightList

type Jwt

type Jwt struct {
	// JWT encoded string.
	Jwt string `json:"jwt"`
	// contains filtered or unexported fields
}

JWT Model

func (*Jwt) Decode

func (model *Jwt) Decode(value interface{}) error

func (Jwt) New

func (model Jwt) New(data []byte) *Jwt

type Key

type Key struct {
	// Key ID.
	Id string `json:"$id"`
	// Key creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Key update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Key name.
	Name string `json:"name"`
	// Key expiration date in ISO 8601 format.
	Expire string `json:"expire"`
	// Allowed permission scopes.
	Scopes []string `json:"scopes"`
	// Secret key.
	Secret string `json:"secret"`
	// Most recent access date in ISO 8601 format. This attribute is only updated
	// again after 24 hours.
	AccessedAt string `json:"accessedAt"`
	// List of SDK user agents that used this key.
	Sdks []string `json:"sdks"`
	// contains filtered or unexported fields
}

Key Model

func (*Key) Decode

func (model *Key) Decode(value interface{}) error

func (Key) New

func (model Key) New(data []byte) *Key

type KeyList

type KeyList struct {
	// Total number of keys that matched your query.
	Total int `json:"total"`
	// List of keys.
	Keys []Key `json:"keys"`
	// contains filtered or unexported fields
}

APIKeysList Model

func (*KeyList) Decode

func (model *KeyList) Decode(value interface{}) error

func (KeyList) New

func (model KeyList) New(data []byte) *KeyList

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"`
	// contains filtered or unexported fields
}

Language Model

func (*Language) Decode

func (model *Language) Decode(value interface{}) error

func (Language) New

func (model Language) New(data []byte) *Language

type LanguageList

type LanguageList struct {
	// Total number of languages that matched your query.
	Total int `json:"total"`
	// List of languages.
	Languages []Language `json:"languages"`
	// contains filtered or unexported fields
}

LanguagesList Model

func (*LanguageList) Decode

func (model *LanguageList) Decode(value interface{}) error

func (LanguageList) New

func (model LanguageList) New(data []byte) *LanguageList

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"`
	// City
	City string `json:"city"`
	// Name of timezone
	TimeZone string `json:"timeZone"`
	// Postal code
	PostalCode string `json:"postalCode"`
	// Latitude
	Latitude float64 `json:"latitude"`
	// Longitude
	Longitude float64 `json:"longitude"`
	// Autonomous System Number (ASN) of the IP
	AutonomousSystemNumber string `json:"autonomousSystemNumber"`
	// Organization that owns the ASN
	AutonomousSystemOrganization string `json:"autonomousSystemOrganization"`
	// Internet service provider of the IP
	Isp string `json:"isp"`
	// Connection type of the IP (e.g. cable, cellular, corporate)
	ConnectionType string `json:"connectionType"`
	// User type classification of the IP (e.g. residential, business, hosting)
	ConnectionUsageType string `json:"connectionUsageType"`
	// Registered organization of the IP
	ConnectionOrganization string `json:"connectionOrganization"`
	// contains filtered or unexported fields
}

Locale Model

func (*Locale) Decode

func (model *Locale) Decode(value interface{}) error

func (Locale) New

func (model Locale) New(data []byte) *Locale

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"`
	// contains filtered or unexported fields
}

LocaleCode Model

func (*LocaleCode) Decode

func (model *LocaleCode) Decode(value interface{}) error

func (LocaleCode) New

func (model LocaleCode) New(data []byte) *LocaleCode

type LocaleCodeList

type LocaleCodeList struct {
	// Total number of localeCodes that matched your query.
	Total int `json:"total"`
	// List of localeCodes.
	LocaleCodes []LocaleCode `json:"localeCodes"`
	// contains filtered or unexported fields
}

LocaleCodesList Model

func (*LocaleCodeList) Decode

func (model *LocaleCodeList) Decode(value interface{}) error

func (LocaleCodeList) New

func (model LocaleCodeList) New(data []byte) *LocaleCodeList

type Log

type Log struct {
	// Event name.
	Event string `json:"event"`
	// User ID of the actor recorded for this log. During impersonation, this is
	// the original impersonator, not the impersonated target user.
	UserId string `json:"userId"`
	// User email of the actor recorded for this log. During impersonation, this
	// is the original impersonator.
	UserEmail string `json:"userEmail"`
	// User name of the actor recorded for this log. During impersonation, this is
	// the original impersonator.
	UserName string `json:"userName"`
	// API mode when event triggered.
	Mode string `json:"mode"`
	// User type who triggered the audit log. Possible values: user, admin, guest,
	// hidden, keyProject, keyAccount, keyOrganization.
	UserType string `json:"userType"`
	// 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"`
	// contains filtered or unexported fields
}

Log Model

func (*Log) Decode

func (model *Log) Decode(value interface{}) error

func (Log) New

func (model Log) New(data []byte) *Log

type LogList

type LogList struct {
	// Total number of logs that matched your query.
	Total int `json:"total"`
	// List of logs.
	Logs []Log `json:"logs"`
	// contains filtered or unexported fields
}

LogsList Model

func (*LogList) Decode

func (model *LogList) Decode(value interface{}) error

func (LogList) New

func (model LogList) New(data []byte) *LogList

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. Hide this attribute by toggling membership privacy in the
	// Console.
	UserName string `json:"userName"`
	// User email address. Hide this attribute by toggling membership privacy in
	// the Console.
	UserEmail string `json:"userEmail"`
	// User phone number. Hide this attribute by toggling membership privacy in
	// the Console.
	UserPhone string `json:"userPhone"`
	// 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. Hide this attribute by toggling membership privacy in the
	// Console.
	Mfa bool `json:"mfa"`
	// Most recent access date in ISO 8601 format. Show this attribute by toggling
	// membership privacy in the Console.
	UserAccessedAt string `json:"userAccessedAt"`
	// User list of roles
	Roles []string `json:"roles"`
	// contains filtered or unexported fields
}

Membership Model

func (*Membership) Decode

func (model *Membership) Decode(value interface{}) error

func (Membership) New

func (model Membership) New(data []byte) *Membership

type MembershipList

type MembershipList struct {
	// Total number of memberships that matched your query.
	Total int `json:"total"`
	// List of memberships.
	Memberships []Membership `json:"memberships"`
	// contains filtered or unexported fields
}

MembershipsList Model

func (*MembershipList) Decode

func (model *MembershipList) Decode(value interface{}) error

func (MembershipList) New

func (model MembershipList) New(data []byte) *MembershipList

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 []string `json:"topics"`
	// User IDs set as recipients.
	Users []string `json:"users"`
	// Target IDs set as recipients.
	Targets []string `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 []string `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"`
	// contains filtered or unexported fields
}

Message Model

func (*Message) Decode

func (model *Message) Decode(value interface{}) error

func (Message) New

func (model Message) New(data []byte) *Message

type MessageList

type MessageList struct {
	// Total number of messages that matched your query.
	Total int `json:"total"`
	// List of messages.
	Messages []Message `json:"messages"`
	// contains filtered or unexported fields
}

MessageList Model

func (*MessageList) Decode

func (model *MessageList) Decode(value interface{}) error

func (MessageList) New

func (model MessageList) New(data []byte) *MessageList

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"`
	// contains filtered or unexported fields
}

MFAChallenge Model

func (*MfaChallenge) Decode

func (model *MfaChallenge) Decode(value interface{}) error

func (MfaChallenge) New

func (model MfaChallenge) New(data []byte) *MfaChallenge

type MfaChallengeSecret

type MfaChallengeSecret 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"`
	// Challenge code to be delivered to the end user through a custom channel.
	Code string `json:"code"`
	// contains filtered or unexported fields
}

MFAChallengeSecret Model

func (*MfaChallengeSecret) Decode

func (model *MfaChallengeSecret) Decode(value interface{}) error

func (MfaChallengeSecret) New

func (model MfaChallengeSecret) New(data []byte) *MfaChallengeSecret

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"`
	// Can custom factor be used for MFA challenge for this account.
	Custom bool `json:"custom"`
	// contains filtered or unexported fields
}

MFAFactors Model

func (*MfaFactors) Decode

func (model *MfaFactors) Decode(value interface{}) error

func (MfaFactors) New

func (model MfaFactors) New(data []byte) *MfaFactors

type MfaRecoveryCodes

type MfaRecoveryCodes struct {
	// Recovery codes.
	RecoveryCodes []string `json:"recoveryCodes"`
	// contains filtered or unexported fields
}

MFARecoveryCodes Model

func (*MfaRecoveryCodes) Decode

func (model *MfaRecoveryCodes) Decode(value interface{}) error

func (MfaRecoveryCodes) New

func (model MfaRecoveryCodes) New(data []byte) *MfaRecoveryCodes

type MfaType

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

MFAType Model

func (*MfaType) Decode

func (model *MfaType) Decode(value interface{}) error

func (MfaType) New

func (model MfaType) New(data []byte) *MfaType

type MockNumber

type MockNumber struct {
	// Mock phone number for testing phone authentication. Useful for testing
	// phone authentication without sending an SMS.
	Number string `json:"number"`
	// Mock OTP for the number.
	Otp string `json:"otp"`
	// Attribute creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Attribute update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// contains filtered or unexported fields
}

MockNumber Model

func (*MockNumber) Decode

func (model *MockNumber) Decode(value interface{}) error

func (MockNumber) New

func (model MockNumber) New(data []byte) *MockNumber

type MockNumberList

type MockNumberList struct {
	// Total number of mockNumbers that matched your query.
	Total int `json:"total"`
	// List of mockNumbers.
	MockNumbers []MockNumber `json:"mockNumbers"`
	// contains filtered or unexported fields
}

MockNumbersList Model

func (*MockNumberList) Decode

func (model *MockNumberList) Decode(value interface{}) error

func (MockNumberList) New

func (model MockNumberList) New(data []byte) *MockNumberList

type Model

type Model interface {
	Decode(value interface{}) error
}

type OAuth2Amazon

type OAuth2Amazon struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Amazon OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Amazon OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Amazon Model

func (*OAuth2Amazon) Decode

func (model *OAuth2Amazon) Decode(value interface{}) error

func (OAuth2Amazon) New

func (model OAuth2Amazon) New(data []byte) *OAuth2Amazon

type OAuth2Apple

type OAuth2Apple struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Apple OAuth2 service ID.
	ServiceId string `json:"serviceId"`
	// Apple OAuth2 key ID.
	KeyId string `json:"keyId"`
	// Apple OAuth2 team ID.
	TeamId string `json:"teamId"`
	// Apple OAuth2 .p8 private key file contents. The secret key wrapped by the
	// PEM markers is 200 characters long.
	P8File string `json:"p8File"`
	// contains filtered or unexported fields
}

OAuth2Apple Model

func (*OAuth2Apple) Decode

func (model *OAuth2Apple) Decode(value interface{}) error

func (OAuth2Apple) New

func (model OAuth2Apple) New(data []byte) *OAuth2Apple

type OAuth2Appwrite

type OAuth2Appwrite struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Appwrite OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Appwrite OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Appwrite Model

func (*OAuth2Appwrite) Decode

func (model *OAuth2Appwrite) Decode(value interface{}) error

func (OAuth2Appwrite) New

func (model OAuth2Appwrite) New(data []byte) *OAuth2Appwrite

type OAuth2Auth0

type OAuth2Auth0 struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Auth0 OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Auth0 OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// Auth0 OAuth2 endpoint domain.
	Endpoint string `json:"endpoint"`
	// contains filtered or unexported fields
}

OAuth2Auth0 Model

func (*OAuth2Auth0) Decode

func (model *OAuth2Auth0) Decode(value interface{}) error

func (OAuth2Auth0) New

func (model OAuth2Auth0) New(data []byte) *OAuth2Auth0

type OAuth2Authentik

type OAuth2Authentik struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Authentik OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Authentik OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// Authentik OAuth2 endpoint domain.
	Endpoint string `json:"endpoint"`
	// contains filtered or unexported fields
}

OAuth2Authentik Model

func (*OAuth2Authentik) Decode

func (model *OAuth2Authentik) Decode(value interface{}) error

func (OAuth2Authentik) New

func (model OAuth2Authentik) New(data []byte) *OAuth2Authentik

type OAuth2Autodesk

type OAuth2Autodesk struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Autodesk OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Autodesk OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Autodesk Model

func (*OAuth2Autodesk) Decode

func (model *OAuth2Autodesk) Decode(value interface{}) error

func (OAuth2Autodesk) New

func (model OAuth2Autodesk) New(data []byte) *OAuth2Autodesk

type OAuth2Bitbucket

type OAuth2Bitbucket struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Bitbucket OAuth2 key.
	Key string `json:"key"`
	// Bitbucket OAuth2 secret.
	Secret string `json:"secret"`
	// contains filtered or unexported fields
}

OAuth2Bitbucket Model

func (*OAuth2Bitbucket) Decode

func (model *OAuth2Bitbucket) Decode(value interface{}) error

func (OAuth2Bitbucket) New

func (model OAuth2Bitbucket) New(data []byte) *OAuth2Bitbucket

type OAuth2Bitly

type OAuth2Bitly struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Bitly OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Bitly OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Bitly Model

func (*OAuth2Bitly) Decode

func (model *OAuth2Bitly) Decode(value interface{}) error

func (OAuth2Bitly) New

func (model OAuth2Bitly) New(data []byte) *OAuth2Bitly

type OAuth2Box

type OAuth2Box struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Box OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Box OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Box Model

func (*OAuth2Box) Decode

func (model *OAuth2Box) Decode(value interface{}) error

func (OAuth2Box) New

func (model OAuth2Box) New(data []byte) *OAuth2Box

type OAuth2Cloudflare added in v7.2.0

type OAuth2Cloudflare struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Cloudflare OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Cloudflare OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Cloudflare Model

func (*OAuth2Cloudflare) Decode added in v7.2.0

func (model *OAuth2Cloudflare) Decode(value interface{}) error

func (OAuth2Cloudflare) New added in v7.2.0

func (model OAuth2Cloudflare) New(data []byte) *OAuth2Cloudflare

type OAuth2Dailymotion

type OAuth2Dailymotion struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Dailymotion OAuth2 API key.
	ApiKey string `json:"apiKey"`
	// Dailymotion OAuth2 API secret.
	ApiSecret string `json:"apiSecret"`
	// contains filtered or unexported fields
}

OAuth2Dailymotion Model

func (*OAuth2Dailymotion) Decode

func (model *OAuth2Dailymotion) Decode(value interface{}) error

func (OAuth2Dailymotion) New

func (model OAuth2Dailymotion) New(data []byte) *OAuth2Dailymotion

type OAuth2Discord

type OAuth2Discord struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Discord OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Discord OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Discord Model

func (*OAuth2Discord) Decode

func (model *OAuth2Discord) Decode(value interface{}) error

func (OAuth2Discord) New

func (model OAuth2Discord) New(data []byte) *OAuth2Discord

type OAuth2Disqus

type OAuth2Disqus struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Disqus OAuth2 public key.
	PublicKey string `json:"publicKey"`
	// Disqus OAuth2 secret key.
	SecretKey string `json:"secretKey"`
	// contains filtered or unexported fields
}

OAuth2Disqus Model

func (*OAuth2Disqus) Decode

func (model *OAuth2Disqus) Decode(value interface{}) error

func (OAuth2Disqus) New

func (model OAuth2Disqus) New(data []byte) *OAuth2Disqus

type OAuth2Dropbox

type OAuth2Dropbox struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Dropbox OAuth2 app key.
	AppKey string `json:"appKey"`
	// Dropbox OAuth2 app secret.
	AppSecret string `json:"appSecret"`
	// contains filtered or unexported fields
}

OAuth2Dropbox Model

func (*OAuth2Dropbox) Decode

func (model *OAuth2Dropbox) Decode(value interface{}) error

func (OAuth2Dropbox) New

func (model OAuth2Dropbox) New(data []byte) *OAuth2Dropbox

type OAuth2Etsy

type OAuth2Etsy struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Etsy OAuth2 keystring.
	KeyString string `json:"keyString"`
	// Etsy OAuth2 shared secret.
	SharedSecret string `json:"sharedSecret"`
	// contains filtered or unexported fields
}

OAuth2Etsy Model

func (*OAuth2Etsy) Decode

func (model *OAuth2Etsy) Decode(value interface{}) error

func (OAuth2Etsy) New

func (model OAuth2Etsy) New(data []byte) *OAuth2Etsy

type OAuth2Facebook

type OAuth2Facebook struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Facebook OAuth2 app ID.
	AppId string `json:"appId"`
	// Facebook OAuth2 app secret.
	AppSecret string `json:"appSecret"`
	// contains filtered or unexported fields
}

OAuth2Facebook Model

func (*OAuth2Facebook) Decode

func (model *OAuth2Facebook) Decode(value interface{}) error

func (OAuth2Facebook) New

func (model OAuth2Facebook) New(data []byte) *OAuth2Facebook

type OAuth2Figma

type OAuth2Figma struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Figma OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Figma OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Figma Model

func (*OAuth2Figma) Decode

func (model *OAuth2Figma) Decode(value interface{}) error

func (OAuth2Figma) New

func (model OAuth2Figma) New(data []byte) *OAuth2Figma

type OAuth2FusionAuth

type OAuth2FusionAuth struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// FusionAuth OAuth2 client ID.
	ClientId string `json:"clientId"`
	// FusionAuth OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// FusionAuth OAuth2 endpoint domain.
	Endpoint string `json:"endpoint"`
	// contains filtered or unexported fields
}

OAuth2FusionAuth Model

func (*OAuth2FusionAuth) Decode

func (model *OAuth2FusionAuth) Decode(value interface{}) error

func (OAuth2FusionAuth) New

func (model OAuth2FusionAuth) New(data []byte) *OAuth2FusionAuth

type OAuth2Github

type OAuth2Github struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// GitHub OAuth2 client ID. For GitHub Apps, use the "App ID" when both an App
	// ID and client ID are available.
	ClientId string `json:"clientId"`
	// GitHub OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2GitHub Model

func (*OAuth2Github) Decode

func (model *OAuth2Github) Decode(value interface{}) error

func (OAuth2Github) New

func (model OAuth2Github) New(data []byte) *OAuth2Github

type OAuth2Gitlab

type OAuth2Gitlab struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// GitLab OAuth2 application ID.
	ApplicationId string `json:"applicationId"`
	// GitLab OAuth2 secret.
	Secret string `json:"secret"`
	// GitLab OAuth2 endpoint URL. Defaults to https://gitlab.com for self-hosted
	// instances.
	Endpoint string `json:"endpoint"`
	// contains filtered or unexported fields
}

OAuth2Gitlab Model

func (*OAuth2Gitlab) Decode

func (model *OAuth2Gitlab) Decode(value interface{}) error

func (OAuth2Gitlab) New

func (model OAuth2Gitlab) New(data []byte) *OAuth2Gitlab

type OAuth2Google

type OAuth2Google struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Google OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Google OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// Google OAuth2 prompt values.
	Prompt []string `json:"prompt"`
	// contains filtered or unexported fields
}

OAuth2Google Model

func (*OAuth2Google) Decode

func (model *OAuth2Google) Decode(value interface{}) error

func (OAuth2Google) New

func (model OAuth2Google) New(data []byte) *OAuth2Google

type OAuth2HuggingFace added in v7.2.0

type OAuth2HuggingFace struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Hugging Face OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Hugging Face OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2HuggingFace Model

func (*OAuth2HuggingFace) Decode added in v7.2.0

func (model *OAuth2HuggingFace) Decode(value interface{}) error

func (OAuth2HuggingFace) New added in v7.2.0

func (model OAuth2HuggingFace) New(data []byte) *OAuth2HuggingFace

type OAuth2Keycloak

type OAuth2Keycloak struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Keycloak OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Keycloak OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// Keycloak OAuth2 endpoint domain.
	Endpoint string `json:"endpoint"`
	// Keycloak OAuth2 realm name.
	RealmName string `json:"realmName"`
	// contains filtered or unexported fields
}

OAuth2Keycloak Model

func (*OAuth2Keycloak) Decode

func (model *OAuth2Keycloak) Decode(value interface{}) error

func (OAuth2Keycloak) New

func (model OAuth2Keycloak) New(data []byte) *OAuth2Keycloak

type OAuth2Kick

type OAuth2Kick struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Kick OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Kick OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Kick Model

func (*OAuth2Kick) Decode

func (model *OAuth2Kick) Decode(value interface{}) error

func (OAuth2Kick) New

func (model OAuth2Kick) New(data []byte) *OAuth2Kick

type OAuth2Linkedin

type OAuth2Linkedin struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// LinkedIn OAuth2 client ID.
	ClientId string `json:"clientId"`
	// LinkedIn OAuth2 primary client secret.
	PrimaryClientSecret string `json:"primaryClientSecret"`
	// contains filtered or unexported fields
}

OAuth2Linkedin Model

func (*OAuth2Linkedin) Decode

func (model *OAuth2Linkedin) Decode(value interface{}) error

func (OAuth2Linkedin) New

func (model OAuth2Linkedin) New(data []byte) *OAuth2Linkedin

type OAuth2Microsoft

type OAuth2Microsoft struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Microsoft OAuth2 application ID.
	ApplicationId string `json:"applicationId"`
	// Microsoft OAuth2 application secret.
	ApplicationSecret string `json:"applicationSecret"`
	// Microsoft Entra ID tenant identifier. Use 'common', 'organizations',
	// 'consumers' or a specific tenant ID.
	Tenant string `json:"tenant"`
	// contains filtered or unexported fields
}

OAuth2Microsoft Model

func (*OAuth2Microsoft) Decode

func (model *OAuth2Microsoft) Decode(value interface{}) error

func (OAuth2Microsoft) New

func (model OAuth2Microsoft) New(data []byte) *OAuth2Microsoft

type OAuth2Notion

type OAuth2Notion struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Notion OAuth2 client ID.
	OauthClientId string `json:"oauthClientId"`
	// Notion OAuth2 client secret.
	OauthClientSecret string `json:"oauthClientSecret"`
	// contains filtered or unexported fields
}

OAuth2Notion Model

func (*OAuth2Notion) Decode

func (model *OAuth2Notion) Decode(value interface{}) error

func (OAuth2Notion) New

func (model OAuth2Notion) New(data []byte) *OAuth2Notion

type OAuth2Oidc

type OAuth2Oidc struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// OpenID Connect OAuth2 client ID.
	ClientId string `json:"clientId"`
	// OpenID Connect OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// OpenID Connect well-known configuration URL. When set, authorization,
	// token, and user info endpoints can be discovered automatically.
	WellKnownURL string `json:"wellKnownURL"`
	// OpenID Connect authorization endpoint URL.
	AuthorizationURL string `json:"authorizationURL"`
	// OpenID Connect token endpoint URL.
	TokenURL string `json:"tokenURL"`
	// OpenID Connect user info endpoint URL.
	UserInfoURL string `json:"userInfoURL"`
	// OpenID Connect prompt values controlling the authentication and consent
	// screens.
	Prompt []string `json:"prompt"`
	// Maximum authentication age in seconds. When set, the user must have
	// authenticated within this many seconds.
	MaxAge int `json:"maxAge"`
	// contains filtered or unexported fields
}

OAuth2Oidc Model

func (*OAuth2Oidc) Decode

func (model *OAuth2Oidc) Decode(value interface{}) error

func (OAuth2Oidc) New

func (model OAuth2Oidc) New(data []byte) *OAuth2Oidc

type OAuth2Okta

type OAuth2Okta struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Okta OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Okta OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// Okta OAuth2 domain.
	Domain string `json:"domain"`
	// Okta OAuth2 authorization server ID.
	AuthorizationServerId string `json:"authorizationServerId"`
	// contains filtered or unexported fields
}

OAuth2Okta Model

func (*OAuth2Okta) Decode

func (model *OAuth2Okta) Decode(value interface{}) error

func (OAuth2Okta) New

func (model OAuth2Okta) New(data []byte) *OAuth2Okta

type OAuth2Paypal

type OAuth2Paypal struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// PayPal OAuth2 client ID.
	ClientId string `json:"clientId"`
	// PayPal OAuth2 secret key.
	SecretKey string `json:"secretKey"`
	// contains filtered or unexported fields
}

OAuth2Paypal Model

func (*OAuth2Paypal) Decode

func (model *OAuth2Paypal) Decode(value interface{}) error

func (OAuth2Paypal) New

func (model OAuth2Paypal) New(data []byte) *OAuth2Paypal

type OAuth2Podio

type OAuth2Podio struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Podio OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Podio OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Podio Model

func (*OAuth2Podio) Decode

func (model *OAuth2Podio) Decode(value interface{}) error

func (OAuth2Podio) New

func (model OAuth2Podio) New(data []byte) *OAuth2Podio

type OAuth2ProviderList

type OAuth2ProviderList struct {
	// Total number of OAuth2 providers in the given project.
	Total int `json:"total"`
	// List of OAuth2 providers.
	Providers []interface{} `json:"providers"`
	// contains filtered or unexported fields
}

OAuth2ProvidersList Model

func (*OAuth2ProviderList) Decode

func (model *OAuth2ProviderList) Decode(value interface{}) error

func (OAuth2ProviderList) New

func (model OAuth2ProviderList) New(data []byte) *OAuth2ProviderList

type OAuth2Resend added in v7.2.0

type OAuth2Resend struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Resend OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Resend OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Resend Model

func (*OAuth2Resend) Decode added in v7.2.0

func (model *OAuth2Resend) Decode(value interface{}) error

func (OAuth2Resend) New added in v7.2.0

func (model OAuth2Resend) New(data []byte) *OAuth2Resend

type OAuth2Salesforce

type OAuth2Salesforce struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Salesforce OAuth2 consumer key.
	CustomerKey string `json:"customerKey"`
	// Salesforce OAuth2 consumer secret.
	CustomerSecret string `json:"customerSecret"`
	// contains filtered or unexported fields
}

OAuth2Salesforce Model

func (*OAuth2Salesforce) Decode

func (model *OAuth2Salesforce) Decode(value interface{}) error

func (OAuth2Salesforce) New

func (model OAuth2Salesforce) New(data []byte) *OAuth2Salesforce

type OAuth2Slack

type OAuth2Slack struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Slack OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Slack OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Slack Model

func (*OAuth2Slack) Decode

func (model *OAuth2Slack) Decode(value interface{}) error

func (OAuth2Slack) New

func (model OAuth2Slack) New(data []byte) *OAuth2Slack

type OAuth2Spotify

type OAuth2Spotify struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Spotify OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Spotify OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Spotify Model

func (*OAuth2Spotify) Decode

func (model *OAuth2Spotify) Decode(value interface{}) error

func (OAuth2Spotify) New

func (model OAuth2Spotify) New(data []byte) *OAuth2Spotify

type OAuth2Stripe

type OAuth2Stripe struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Stripe OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Stripe OAuth2 API secret key.
	ApiSecretKey string `json:"apiSecretKey"`
	// contains filtered or unexported fields
}

OAuth2Stripe Model

func (*OAuth2Stripe) Decode

func (model *OAuth2Stripe) Decode(value interface{}) error

func (OAuth2Stripe) New

func (model OAuth2Stripe) New(data []byte) *OAuth2Stripe

type OAuth2Tradeshift

type OAuth2Tradeshift struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Tradeshift OAuth2 client ID.
	Oauth2ClientId string `json:"oauth2ClientId"`
	// Tradeshift OAuth2 client secret.
	Oauth2ClientSecret string `json:"oauth2ClientSecret"`
	// contains filtered or unexported fields
}

OAuth2Tradeshift Model

func (*OAuth2Tradeshift) Decode

func (model *OAuth2Tradeshift) Decode(value interface{}) error

func (OAuth2Tradeshift) New

func (model OAuth2Tradeshift) New(data []byte) *OAuth2Tradeshift

type OAuth2Twitch

type OAuth2Twitch struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Twitch OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Twitch OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Twitch Model

func (*OAuth2Twitch) Decode

func (model *OAuth2Twitch) Decode(value interface{}) error

func (OAuth2Twitch) New

func (model OAuth2Twitch) New(data []byte) *OAuth2Twitch

type OAuth2WordPress

type OAuth2WordPress struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// WordPress OAuth2 client ID.
	ClientId string `json:"clientId"`
	// WordPress OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2WordPress Model

func (*OAuth2WordPress) Decode

func (model *OAuth2WordPress) Decode(value interface{}) error

func (OAuth2WordPress) New

func (model OAuth2WordPress) New(data []byte) *OAuth2WordPress

type OAuth2X

type OAuth2X struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// X OAuth2 customer key.
	CustomerKey string `json:"customerKey"`
	// X OAuth2 secret key.
	SecretKey string `json:"secretKey"`
	// contains filtered or unexported fields
}

OAuth2X Model

func (*OAuth2X) Decode

func (model *OAuth2X) Decode(value interface{}) error

func (OAuth2X) New

func (model OAuth2X) New(data []byte) *OAuth2X

type OAuth2Yahoo

type OAuth2Yahoo struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Yahoo OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Yahoo OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Yahoo Model

func (*OAuth2Yahoo) Decode

func (model *OAuth2Yahoo) Decode(value interface{}) error

func (OAuth2Yahoo) New

func (model OAuth2Yahoo) New(data []byte) *OAuth2Yahoo

type OAuth2Yandex

type OAuth2Yandex struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Yandex OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Yandex OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Yandex Model

func (*OAuth2Yandex) Decode

func (model *OAuth2Yandex) Decode(value interface{}) error

func (OAuth2Yandex) New

func (model OAuth2Yandex) New(data []byte) *OAuth2Yandex

type OAuth2Zoho

type OAuth2Zoho struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Zoho OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Zoho OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Zoho Model

func (*OAuth2Zoho) Decode

func (model *OAuth2Zoho) Decode(value interface{}) error

func (OAuth2Zoho) New

func (model OAuth2Zoho) New(data []byte) *OAuth2Zoho

type OAuth2Zoom

type OAuth2Zoom struct {
	// OAuth2 provider ID.
	Id string `json:"$id"`
	// OAuth2 provider is active and can be used to create sessions.
	Enabled bool `json:"enabled"`
	// Zoom OAuth2 client ID.
	ClientId string `json:"clientId"`
	// Zoom OAuth2 client secret.
	ClientSecret string `json:"clientSecret"`
	// contains filtered or unexported fields
}

OAuth2Zoom Model

func (*OAuth2Zoom) Decode

func (model *OAuth2Zoom) Decode(value interface{}) error

func (OAuth2Zoom) New

func (model OAuth2Zoom) New(data []byte) *OAuth2Zoom

type Oauth2Approve

type Oauth2Approve struct {
	// URL the end user should be redirected to after the grant is approved,
	// carrying the authorization `code` and/or `id_token` along with the original
	// `state`.
	RedirectUrl string `json:"redirectUrl"`
	// contains filtered or unexported fields
}

OAuth2Approve Model

func (*Oauth2Approve) Decode

func (model *Oauth2Approve) Decode(value interface{}) error

func (Oauth2Approve) New

func (model Oauth2Approve) New(data []byte) *Oauth2Approve

type Oauth2Authorize

type Oauth2Authorize struct {
	// OAuth2 grant ID. Set when the user must give explicit consent; pass it to
	// the approve or reject endpoint. Empty when a redirect URL is returned
	// instead.
	GrantId string `json:"grantId"`
	// URL the end user should be redirected to when the flow can complete without
	// consent. Empty when consent is still required.
	RedirectUrl string `json:"redirectUrl"`
	// contains filtered or unexported fields
}

OAuth2Authorize Model

func (*Oauth2Authorize) Decode

func (model *Oauth2Authorize) Decode(value interface{}) error

func (Oauth2Authorize) New

func (model Oauth2Authorize) New(data []byte) *Oauth2Authorize

type Oauth2Consent

type Oauth2Consent struct {
	// Consent ID.
	Id string `json:"$id"`
	// Consent creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Consent update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// ID of the user the consent belongs to.
	UserId string `json:"userId"`
	// ID of the registered app the consent was given to. Empty for URL-form
	// (CIMD) clients.
	AppId string `json:"appId"`
	// Client ID metadata document URL of the client the consent was given to.
	// Empty for registered apps.
	CimdUrl string `json:"cimdUrl"`
	// OAuth2 scopes the user consented to.
	Scopes []string `json:"scopes"`
	// RFC 8707 resource indicators the user consented to.
	Resources []string `json:"resources"`
	// Authorization details the user consented to, as a JSON string. Each entry
	// has a `type` plus project-defined fields.
	AuthorizationDetails string `json:"authorizationDetails"`
	// Consent expiration time in ISO 8601 format. Empty when the consent has no
	// token-bound expiry yet.
	Expire string `json:"expire"`
	// contains filtered or unexported fields
}

OAuth2Consent Model

func (*Oauth2Consent) Decode

func (model *Oauth2Consent) Decode(value interface{}) error

func (Oauth2Consent) New

func (model Oauth2Consent) New(data []byte) *Oauth2Consent

type Oauth2ConsentList

type Oauth2ConsentList struct {
	// Total number of consents that matched your query.
	Total int `json:"total"`
	// List of consents.
	Consents []Oauth2Consent `json:"consents"`
	// contains filtered or unexported fields
}

OAuth2ConsentsList Model

func (*Oauth2ConsentList) Decode

func (model *Oauth2ConsentList) Decode(value interface{}) error

func (Oauth2ConsentList) New

func (model Oauth2ConsentList) New(data []byte) *Oauth2ConsentList

type Oauth2ConsentToken

type Oauth2ConsentToken struct {
	// Token family ID.
	Id string `json:"$id"`
	// Token creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Token update date in ISO 8601 format. Refreshing the token family updates
	// this.
	UpdatedAt string `json:"$updatedAt"`
	// ID of the consent the token family was issued under.
	ConsentId string `json:"consentId"`
	// ID of the user the token family belongs to.
	UserId string `json:"userId"`
	// ID of the registered app the token family was issued to. Empty for URL-form
	// (CIMD) clients.
	AppId string `json:"appId"`
	// Client ID metadata document URL of the client the token family was issued
	// to. Empty for registered apps.
	CimdUrl string `json:"cimdUrl"`
	// OAuth2 scopes granted on the token family.
	Scopes []string `json:"scopes"`
	// RFC 8707 resource indicators granted on the token family.
	Resources []string `json:"resources"`
	// Authorization details granted on the token family, as a JSON string. Each
	// entry has a `type` plus project-defined fields.
	AuthorizationDetails string `json:"authorizationDetails"`
	// Expiration time of the current access token of this family in ISO 8601
	// format.
	Expire string `json:"expire"`
	// contains filtered or unexported fields
}

OAuth2ConsentToken Model

func (*Oauth2ConsentToken) Decode

func (model *Oauth2ConsentToken) Decode(value interface{}) error

func (Oauth2ConsentToken) New

func (model Oauth2ConsentToken) New(data []byte) *Oauth2ConsentToken

type Oauth2ConsentTokenList

type Oauth2ConsentTokenList struct {
	// Total number of tokens that matched your query.
	Total int `json:"total"`
	// List of tokens.
	Tokens []Oauth2ConsentToken `json:"tokens"`
	// contains filtered or unexported fields
}

OAuth2ConsentTokensList Model

func (*Oauth2ConsentTokenList) Decode

func (model *Oauth2ConsentTokenList) Decode(value interface{}) error

func (Oauth2ConsentTokenList) New

type Oauth2DeviceAuthorization

type Oauth2DeviceAuthorization struct {
	// Device verification code used by the client to poll the token endpoint.
	DeviceCode string `json:"device_code"`
	// Short code the end user enters on the verification page.
	UserCode string `json:"user_code"`
	// URL where the end user enters the user code.
	VerificationUri string `json:"verification_uri"`
	// Verification URL with the user code prefilled as a query parameter.
	VerificationUriComplete string `json:"verification_uri_complete"`
	// Lifetime of the device code and user code in seconds.
	ExpiresIn int `json:"expires_in"`
	// Minimum polling interval for the token endpoint in seconds.
	Interval int `json:"interval"`
	// contains filtered or unexported fields
}

OAuth2DeviceAuthorization Model

func (*Oauth2DeviceAuthorization) Decode

func (model *Oauth2DeviceAuthorization) Decode(value interface{}) error

func (Oauth2DeviceAuthorization) New

type Oauth2Grant

type Oauth2Grant struct {
	// Grant ID.
	Id string `json:"$id"`
	// Grant creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Grant update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// ID of the user the grant belongs to.
	UserId string `json:"userId"`
	// ID of the OAuth2 client (app) the grant was requested for.
	AppId string `json:"appId"`
	// Requested OAuth2 scopes the user is being asked to consent to.
	Scopes []string `json:"scopes"`
	// Requested RFC 8707 resource indicators the user is being asked to consent
	// to.
	Resources []string `json:"resources"`
	// Requested authorization_details the user is being asked to consent to, as a
	// JSON string. Each entry has a `type` plus project-defined fields.
	AuthorizationDetails string `json:"authorizationDetails"`
	// OIDC prompt directive the consent screen should honor. Space-separated list
	// of: login, consent, select_account.
	Prompt string `json:"prompt"`
	// Redirect URI the user will be sent to after the flow completes.
	RedirectUri string `json:"redirectUri"`
	// Unix timestamp of when the user last authenticated.
	AuthTime int `json:"authTime"`
	// Grant expiration time in ISO 8601 format.
	Expire string `json:"expire"`
	// contains filtered or unexported fields
}

OAuth2Grant Model

func (*Oauth2Grant) Decode

func (model *Oauth2Grant) Decode(value interface{}) error

func (Oauth2Grant) New

func (model Oauth2Grant) New(data []byte) *Oauth2Grant

type Oauth2Organization

type Oauth2Organization struct {
	// Organization ID.
	Id string `json:"$id"`
	// contains filtered or unexported fields
}

OAuth2Organization Model

func (*Oauth2Organization) Decode

func (model *Oauth2Organization) Decode(value interface{}) error

func (Oauth2Organization) New

func (model Oauth2Organization) New(data []byte) *Oauth2Organization

type Oauth2OrganizationList

type Oauth2OrganizationList struct {
	// Total number of organizations that matched your query.
	Total int `json:"total"`
	// List of organizations.
	Organizations []Oauth2Organization `json:"organizations"`
	// contains filtered or unexported fields
}

OAuth2AccessibleOrganizationsList Model

func (*Oauth2OrganizationList) Decode

func (model *Oauth2OrganizationList) Decode(value interface{}) error

func (Oauth2OrganizationList) New

type Oauth2PAR

type Oauth2PAR struct {
	// Authorization request handle to pass to the authorize endpoint.
	RequestUri string `json:"request_uri"`
	// Lifetime of the authorization request handle in seconds.
	ExpiresIn int `json:"expires_in"`
	// contains filtered or unexported fields
}

OAuth2PAR Model

func (*Oauth2PAR) Decode

func (model *Oauth2PAR) Decode(value interface{}) error

func (Oauth2PAR) New

func (model Oauth2PAR) New(data []byte) *Oauth2PAR

type Oauth2Project

type Oauth2Project struct {
	// Project ID.
	Id string `json:"$id"`
	// Region ID the project is deployed in.
	Region string `json:"region"`
	// API endpoint of the region the project is deployed in. Empty when the
	// region has no public hostname configured.
	Endpoint string `json:"endpoint"`
	// contains filtered or unexported fields
}

OAuth2Project Model

func (*Oauth2Project) Decode

func (model *Oauth2Project) Decode(value interface{}) error

func (Oauth2Project) New

func (model Oauth2Project) New(data []byte) *Oauth2Project

type Oauth2ProjectList

type Oauth2ProjectList struct {
	// Total number of projects that matched your query.
	Total int `json:"total"`
	// List of projects.
	Projects []Oauth2Project `json:"projects"`
	// contains filtered or unexported fields
}

OAuth2AccessibleProjectsList Model

func (*Oauth2ProjectList) Decode

func (model *Oauth2ProjectList) Decode(value interface{}) error

func (Oauth2ProjectList) New

func (model Oauth2ProjectList) New(data []byte) *Oauth2ProjectList

type Oauth2Reject

type Oauth2Reject struct {
	// URL the end user should be redirected to after the grant is rejected,
	// carrying an `access_denied` error.
	RedirectUrl string `json:"redirectUrl"`
	// contains filtered or unexported fields
}

OAuth2Reject Model

func (*Oauth2Reject) Decode

func (model *Oauth2Reject) Decode(value interface{}) error

func (Oauth2Reject) New

func (model Oauth2Reject) New(data []byte) *Oauth2Reject

type Oauth2Token

type Oauth2Token struct {
	// OAuth2 access token.
	AccessToken string `json:"access_token"`
	// OAuth2 token type.
	TokenType string `json:"token_type"`
	// Access token lifetime in seconds.
	ExpiresIn int `json:"expires_in"`
	// OAuth2 refresh token.
	RefreshToken string `json:"refresh_token"`
	// Space-separated scopes granted to the access token.
	Scope string `json:"scope"`
	// Granted RFC 9396 authorization details as a JSON string.
	AuthorizationDetails string `json:"authorization_details"`
	// OpenID Connect ID token. Returned when the `openid` scope is granted.
	IdToken string `json:"id_token"`
	// contains filtered or unexported fields
}

OAuth2Token Model

func (*Oauth2Token) Decode

func (model *Oauth2Token) Decode(value interface{}) error

func (Oauth2Token) New

func (model Oauth2Token) New(data []byte) *Oauth2Token

type Organization

type Organization 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 Preferences `json:"prefs"`
	// Project budget limit. Null when no budget is set.
	BillingBudget int `json:"billingBudget"`
	// Project budget limit
	BudgetAlerts []int `json:"budgetAlerts"`
	// Organization's billing plan ID.
	BillingPlan string `json:"billingPlan"`
	// Organization's billing plan ID.
	BillingPlanId string `json:"billingPlanId"`
	// Organization's billing plan.
	BillingPlanDetails BillingPlan `json:"billingPlanDetails"`
	// Billing email set for the organization.
	BillingEmail string `json:"billingEmail"`
	// Billing cycle start date.
	BillingStartDate string `json:"billingStartDate"`
	// Current invoice cycle start date.
	BillingCurrentInvoiceDate string `json:"billingCurrentInvoiceDate"`
	// Next invoice cycle start date.
	BillingNextInvoiceDate string `json:"billingNextInvoiceDate"`
	// Start date of trial.
	BillingTrialStartDate string `json:"billingTrialStartDate"`
	// Number of trial days.
	BillingTrialDays int `json:"billingTrialDays"`
	// Current active aggregation id.
	BillingAggregationId string `json:"billingAggregationId"`
	// Current active aggregation id.
	BillingInvoiceId string `json:"billingInvoiceId"`
	// Default payment method.
	PaymentMethodId string `json:"paymentMethodId"`
	// Default payment method.
	BillingAddressId string `json:"billingAddressId"`
	// Backup payment method.
	BackupPaymentMethodId string `json:"backupPaymentMethodId"`
	// Team status.
	Status string `json:"status"`
	// Remarks on team status.
	Remarks string `json:"remarks"`
	// Organization agreements
	AgreementBAA string `json:"agreementBAA"`
	// Program manager's name.
	ProgramManagerName string `json:"programManagerName"`
	// Program manager's calendar link.
	ProgramManagerCalendar string `json:"programManagerCalendar"`
	// Program's discord channel name.
	ProgramDiscordChannelName string `json:"programDiscordChannelName"`
	// Program's discord channel URL.
	ProgramDiscordChannelUrl string `json:"programDiscordChannelUrl"`
	// Billing limits reached
	BillingLimits BillingLimits `json:"billingLimits"`
	// Billing plan selected for downgrade.
	BillingPlanDowngrade string `json:"billingPlanDowngrade"`
	// Tax Id
	BillingTaxId string `json:"billingTaxId"`
	// Marked for deletion
	MarkedForDeletion bool `json:"markedForDeletion"`
	// Product with which the organization is associated (appwrite or imagine)
	Platform string `json:"platform"`
	// Selected projects
	Projects []string `json:"projects"`
	// contains filtered or unexported fields
}

Organization Model

func (*Organization) Decode

func (model *Organization) Decode(value interface{}) error

func (Organization) New

func (model Organization) New(data []byte) *Organization

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"`
	// contains filtered or unexported fields
}

Phone Model

func (*Phone) Decode

func (model *Phone) Decode(value interface{}) error

func (Phone) New

func (model Phone) New(data []byte) *Phone

type PhoneList

type PhoneList struct {
	// Total number of phones that matched your query.
	Total int `json:"total"`
	// List of phones.
	Phones []Phone `json:"phones"`
	// contains filtered or unexported fields
}

PhonesList Model

func (*PhoneList) Decode

func (model *PhoneList) Decode(value interface{}) error

func (PhoneList) New

func (model PhoneList) New(data []byte) *PhoneList

type PlatformAndroid

type PlatformAndroid struct {
	// Platform ID.
	Id string `json:"$id"`
	// Platform creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Platform update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Platform name.
	Name string `json:"name"`
	// Platform type. Possible values are: windows, apple, android, linux, web.
	Type string `json:"type"`
	// Android application ID.
	ApplicationId string `json:"applicationId"`
	// contains filtered or unexported fields
}

PlatformAndroid Model

func (*PlatformAndroid) Decode

func (model *PlatformAndroid) Decode(value interface{}) error

func (PlatformAndroid) New

func (model PlatformAndroid) New(data []byte) *PlatformAndroid

type PlatformApple

type PlatformApple struct {
	// Platform ID.
	Id string `json:"$id"`
	// Platform creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Platform update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Platform name.
	Name string `json:"name"`
	// Platform type. Possible values are: windows, apple, android, linux, web.
	Type string `json:"type"`
	// Apple bundle identifier.
	BundleIdentifier string `json:"bundleIdentifier"`
	// contains filtered or unexported fields
}

PlatformApple Model

func (*PlatformApple) Decode

func (model *PlatformApple) Decode(value interface{}) error

func (PlatformApple) New

func (model PlatformApple) New(data []byte) *PlatformApple

type PlatformLinux

type PlatformLinux struct {
	// Platform ID.
	Id string `json:"$id"`
	// Platform creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Platform update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Platform name.
	Name string `json:"name"`
	// Platform type. Possible values are: windows, apple, android, linux, web.
	Type string `json:"type"`
	// Linux package name.
	PackageName string `json:"packageName"`
	// contains filtered or unexported fields
}

PlatformLinux Model

func (*PlatformLinux) Decode

func (model *PlatformLinux) Decode(value interface{}) error

func (PlatformLinux) New

func (model PlatformLinux) New(data []byte) *PlatformLinux

type PlatformList

type PlatformList struct {
	// Total number of platforms in the given project.
	Total int `json:"total"`
	// List of platforms.
	Platforms []interface{} `json:"platforms"`
	// contains filtered or unexported fields
}

PlatformsList Model

func (*PlatformList) Decode

func (model *PlatformList) Decode(value interface{}) error

func (PlatformList) New

func (model PlatformList) New(data []byte) *PlatformList

type PlatformWeb

type PlatformWeb struct {
	// Platform ID.
	Id string `json:"$id"`
	// Platform creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Platform update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Platform name.
	Name string `json:"name"`
	// Platform type. Possible values are: windows, apple, android, linux, web.
	Type string `json:"type"`
	// Web app hostname. Empty string for other platforms.
	Hostname string `json:"hostname"`
	// contains filtered or unexported fields
}

PlatformWeb Model

func (*PlatformWeb) Decode

func (model *PlatformWeb) Decode(value interface{}) error

func (PlatformWeb) New

func (model PlatformWeb) New(data []byte) *PlatformWeb

type PlatformWindows

type PlatformWindows struct {
	// Platform ID.
	Id string `json:"$id"`
	// Platform creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Platform update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Platform name.
	Name string `json:"name"`
	// Platform type. Possible values are: windows, apple, android, linux, web.
	Type string `json:"type"`
	// Windows package identifier name.
	PackageIdentifierName string `json:"packageIdentifierName"`
	// contains filtered or unexported fields
}

PlatformWindows Model

func (*PlatformWindows) Decode

func (model *PlatformWindows) Decode(value interface{}) error

func (PlatformWindows) New

func (model PlatformWindows) New(data []byte) *PlatformWindows

type PolicyDenyAliasedEmail

type PolicyDenyAliasedEmail struct {
	// Policy ID.
	Id string `json:"$id"`
	// Whether the deny aliased email policy is enabled.
	Enabled bool `json:"enabled"`
	// contains filtered or unexported fields
}

PolicyDenyAliasedEmail Model

func (*PolicyDenyAliasedEmail) Decode

func (model *PolicyDenyAliasedEmail) Decode(value interface{}) error

func (PolicyDenyAliasedEmail) New

type PolicyDenyCorporateEmail

type PolicyDenyCorporateEmail struct {
	// Policy ID.
	Id string `json:"$id"`
	// Whether the deny non-corporate email policy is enabled.
	Enabled bool `json:"enabled"`
	// contains filtered or unexported fields
}

PolicyDenyCorporateEmail Model

func (*PolicyDenyCorporateEmail) Decode

func (model *PolicyDenyCorporateEmail) Decode(value interface{}) error

func (PolicyDenyCorporateEmail) New

type PolicyDenyDisposableEmail

type PolicyDenyDisposableEmail struct {
	// Policy ID.
	Id string `json:"$id"`
	// Whether the deny disposable email policy is enabled.
	Enabled bool `json:"enabled"`
	// contains filtered or unexported fields
}

PolicyDenyDisposableEmail Model

func (*PolicyDenyDisposableEmail) Decode

func (model *PolicyDenyDisposableEmail) Decode(value interface{}) error

func (PolicyDenyDisposableEmail) New

type PolicyDenyFreeEmail

type PolicyDenyFreeEmail struct {
	// Policy ID.
	Id string `json:"$id"`
	// Whether the deny free email policy is enabled.
	Enabled bool `json:"enabled"`
	// contains filtered or unexported fields
}

PolicyDenyFreeEmail Model

func (*PolicyDenyFreeEmail) Decode

func (model *PolicyDenyFreeEmail) Decode(value interface{}) error

func (PolicyDenyFreeEmail) New

func (model PolicyDenyFreeEmail) New(data []byte) *PolicyDenyFreeEmail

type PolicyList

type PolicyList struct {
	// Total number of policies in the given project.
	Total int `json:"total"`
	// List of policies.
	Policies []interface{} `json:"policies"`
	// contains filtered or unexported fields
}

PoliciesList Model

func (*PolicyList) Decode

func (model *PolicyList) Decode(value interface{}) error

func (PolicyList) New

func (model PolicyList) New(data []byte) *PolicyList

type PolicyMembershipPrivacy

type PolicyMembershipPrivacy struct {
	// Policy ID.
	Id string `json:"$id"`
	// Whether user ID is visible in memberships.
	UserId bool `json:"userId"`
	// Whether user email is visible in memberships.
	UserEmail bool `json:"userEmail"`
	// Whether user phone is visible in memberships.
	UserPhone bool `json:"userPhone"`
	// Whether user name is visible in memberships.
	UserName bool `json:"userName"`
	// Whether user MFA status is visible in memberships.
	UserMFA bool `json:"userMFA"`
	// Whether user last access time is visible in memberships.
	UserAccessedAt bool `json:"userAccessedAt"`
	// contains filtered or unexported fields
}

PolicyMembershipPrivacy Model

func (*PolicyMembershipPrivacy) Decode

func (model *PolicyMembershipPrivacy) Decode(value interface{}) error

func (PolicyMembershipPrivacy) New

type PolicyMfaFactors

type PolicyMfaFactors struct {
	// Policy ID.
	Id string `json:"$id"`
	// Whether TOTP can be used to complete an MFA challenge.
	Totp bool `json:"totp"`
	// Whether email can be used to complete an MFA challenge.
	Email bool `json:"email"`
	// Whether phone (SMS) can be used to complete an MFA challenge.
	Phone bool `json:"phone"`
	// Whether the custom factor can be used to complete an MFA challenge.
	Custom bool `json:"custom"`
	// contains filtered or unexported fields
}

PolicyMFAFactors Model

func (*PolicyMfaFactors) Decode

func (model *PolicyMfaFactors) Decode(value interface{}) error

func (PolicyMfaFactors) New

func (model PolicyMfaFactors) New(data []byte) *PolicyMfaFactors

type PolicyPasswordDictionary

type PolicyPasswordDictionary struct {
	// Policy ID.
	Id string `json:"$id"`
	// Whether password dictionary policy is enabled.
	Enabled bool `json:"enabled"`
	// contains filtered or unexported fields
}

PolicyPasswordDictionary Model

func (*PolicyPasswordDictionary) Decode

func (model *PolicyPasswordDictionary) Decode(value interface{}) error

func (PolicyPasswordDictionary) New

type PolicyPasswordHistory

type PolicyPasswordHistory struct {
	// Policy ID.
	Id string `json:"$id"`
	// Password history length. A value of 0 means the policy is disabled.
	Total int `json:"total"`
	// contains filtered or unexported fields
}

PolicyPasswordHistory Model

func (*PolicyPasswordHistory) Decode

func (model *PolicyPasswordHistory) Decode(value interface{}) error

func (PolicyPasswordHistory) New

type PolicyPasswordPersonalData

type PolicyPasswordPersonalData struct {
	// Policy ID.
	Id string `json:"$id"`
	// Whether password personal data policy is enabled.
	Enabled bool `json:"enabled"`
	// contains filtered or unexported fields
}

PolicyPasswordPersonalData Model

func (*PolicyPasswordPersonalData) Decode

func (model *PolicyPasswordPersonalData) Decode(value interface{}) error

func (PolicyPasswordPersonalData) New

type PolicyPasswordStrength

type PolicyPasswordStrength struct {
	// Policy ID.
	Id string `json:"$id"`
	// Minimum password length required for user passwords.
	Min int `json:"min"`
	// Whether passwords must include at least one uppercase letter.
	Uppercase bool `json:"uppercase"`
	// Whether passwords must include at least one lowercase letter.
	Lowercase bool `json:"lowercase"`
	// Whether passwords must include at least one number.
	Number bool `json:"number"`
	// Whether passwords must include at least one symbol.
	Symbols bool `json:"symbols"`
	// contains filtered or unexported fields
}

PolicyPasswordStrength Model

func (*PolicyPasswordStrength) Decode

func (model *PolicyPasswordStrength) Decode(value interface{}) error

func (PolicyPasswordStrength) New

type PolicySessionAlert

type PolicySessionAlert struct {
	// Policy ID.
	Id string `json:"$id"`
	// Whether session alert policy is enabled.
	Enabled bool `json:"enabled"`
	// contains filtered or unexported fields
}

PolicySessionAlert Model

func (*PolicySessionAlert) Decode

func (model *PolicySessionAlert) Decode(value interface{}) error

func (PolicySessionAlert) New

func (model PolicySessionAlert) New(data []byte) *PolicySessionAlert

type PolicySessionDuration

type PolicySessionDuration struct {
	// Policy ID.
	Id string `json:"$id"`
	// Session duration in seconds.
	Duration int `json:"duration"`
	// contains filtered or unexported fields
}

PolicySessionDuration Model

func (*PolicySessionDuration) Decode

func (model *PolicySessionDuration) Decode(value interface{}) error

func (PolicySessionDuration) New

type PolicySessionInvalidation

type PolicySessionInvalidation struct {
	// Policy ID.
	Id string `json:"$id"`
	// Whether session invalidation policy is enabled.
	Enabled bool `json:"enabled"`
	// contains filtered or unexported fields
}

PolicySessionInvalidation Model

func (*PolicySessionInvalidation) Decode

func (model *PolicySessionInvalidation) Decode(value interface{}) error

func (PolicySessionInvalidation) New

type PolicySessionLimit

type PolicySessionLimit struct {
	// Policy ID.
	Id string `json:"$id"`
	// Maximum number of sessions allowed per user. A value of 0 means the policy
	// is disabled.
	Total int `json:"total"`
	// contains filtered or unexported fields
}

PolicySessionLimit Model

func (*PolicySessionLimit) Decode

func (model *PolicySessionLimit) Decode(value interface{}) error

func (PolicySessionLimit) New

func (model PolicySessionLimit) New(data []byte) *PolicySessionLimit

type PolicyUserLimit

type PolicyUserLimit struct {
	// Policy ID.
	Id string `json:"$id"`
	// Maximum number of users allowed in the project. A value of 0 means the
	// policy is disabled.
	Total int `json:"total"`
	// contains filtered or unexported fields
}

PolicyUserLimit Model

func (*PolicyUserLimit) Decode

func (model *PolicyUserLimit) Decode(value interface{}) error

func (PolicyUserLimit) New

func (model PolicyUserLimit) New(data []byte) *PolicyUserLimit

type PostgresExtension added in v7.2.0

type PostgresExtension struct {
	// Extension key used with CREATE EXTENSION.
	Key string `json:"key"`
	// Human-readable extension name.
	Name string `json:"name"`
	// Short description of what the extension provides.
	Description string `json:"description"`
	// Category the extension belongs to.
	Category string `json:"category"`
	// contains filtered or unexported fields
}

PostgresExtension Model

func (*PostgresExtension) Decode added in v7.2.0

func (model *PostgresExtension) Decode(value interface{}) error

func (PostgresExtension) New added in v7.2.0

func (model PostgresExtension) New(data []byte) *PostgresExtension

type Preferences

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

Preferences Model

func (*Preferences) Decode

func (model *Preferences) Decode(value interface{}) error

Use this method to get response in desired type

func (Preferences) New

func (model Preferences) New(data []byte) *Preferences

type Presence

type Presence struct {
	// Presence ID.
	Id string `json:"$id"`
	// Presence creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Presence update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Presence permissions. [Learn more about
	// permissions](https://appwrite.io/docs/permissions).
	Permissions []string `json:"$permissions"`
	// User ID.
	UserId string `json:"userId"`
	// Presence status.
	Status string `json:"status"`
	// Presence source.
	Source string `json:"source"`
	// Presence expiry date in ISO 8601 format.
	ExpiresAt string `json:"expiresAt"`
	// Presence metadata.
	Metadata interface{} `json:"metadata"`
	// contains filtered or unexported fields
}

Presence Model

func (*Presence) Decode

func (model *Presence) Decode(value interface{}) error

func (Presence) New

func (model Presence) New(data []byte) *Presence

type PresenceList

type PresenceList struct {
	// Total number of presences that matched your query.
	Total int `json:"total"`
	// List of presences.
	Presences []Presence `json:"presences"`
	// contains filtered or unexported fields
}

PresencesList Model

func (*PresenceList) Decode

func (model *PresenceList) Decode(value interface{}) error

func (PresenceList) New

func (model PresenceList) New(data []byte) *PresenceList

type Program

type Program struct {
	// Program ID
	Id string `json:"$id"`
	// Program title
	Title string `json:"title"`
	// Program description
	Description string `json:"description"`
	// Program tag for highlighting on console
	Tag string `json:"tag"`
	// Program icon for highlighting on console
	Icon string `json:"icon"`
	// URL for more information on this program
	Url string `json:"url"`
	// Whether this program is active
	Active bool `json:"active"`
	// Whether this program is external
	External bool `json:"external"`
	// Billing plan ID that this is program is associated with.
	BillingPlanId string `json:"billingPlanId"`
	// contains filtered or unexported fields
}

Program Model

func (*Program) Decode

func (model *Program) Decode(value interface{}) error

func (Program) New

func (model Program) New(data []byte) *Program

type Project

type Project struct {
	// Project ID.
	Id string `json:"$id"`
	// Project creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Project update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Project name.
	Name string `json:"name"`
	// Project team ID.
	TeamId string `json:"teamId"`
	// Project region
	Region string `json:"region"`
	// Deprecated since 1.9.5: List of dev keys.
	DevKeys []DevKey `json:"devKeys"`
	// Status for custom SMTP
	SmtpEnabled bool `json:"smtpEnabled"`
	// SMTP sender name
	SmtpSenderName string `json:"smtpSenderName"`
	// SMTP sender email
	SmtpSenderEmail string `json:"smtpSenderEmail"`
	// SMTP reply to name
	SmtpReplyToName string `json:"smtpReplyToName"`
	// SMTP reply to email
	SmtpReplyToEmail string `json:"smtpReplyToEmail"`
	// SMTP server host name
	SmtpHost string `json:"smtpHost"`
	// SMTP server port
	SmtpPort int `json:"smtpPort"`
	// SMTP server username
	SmtpUsername string `json:"smtpUsername"`
	// SMTP server password. This property is write-only and always returned
	// empty.
	SmtpPassword string `json:"smtpPassword"`
	// SMTP server secure protocol
	SmtpSecure string `json:"smtpSecure"`
	// Number of times the ping was received for this project.
	PingCount int `json:"pingCount"`
	// Last ping datetime in ISO 8601 format.
	PingedAt string `json:"pingedAt"`
	// Labels for the project.
	Labels []string `json:"labels"`
	// Project status
	Status string `json:"status"`
	// Stage progress (completed or skipped) with timestamps and actor types,
	// keyed by stage id.
	Onboarding interface{} `json:"onboarding"`
	// List of auth methods.
	AuthMethods []ProjectAuthMethod `json:"authMethods"`
	// List of services.
	Services []ProjectService `json:"services"`
	// List of protocols.
	Protocols []ProjectProtocol `json:"protocols"`
	// Project blocks information
	Blocks []Block `json:"blocks"`
	// Last time the project was accessed via console. Used with plan's
	// projectInactivityDays to determine if project is paused.
	ConsoleAccessedAt string `json:"consoleAccessedAt"`
	// Whether WAF enforcement is enabled for the project.
	WafEnabled bool `json:"wafEnabled"`
	// Billing limits reached
	BillingLimits BillingLimits `json:"billingLimits"`
	// OAuth2 server status
	OAuth2ServerEnabled bool `json:"oAuth2ServerEnabled"`
	// OAuth2 server authorization URL
	OAuth2ServerAuthorizationUrl string `json:"oAuth2ServerAuthorizationUrl"`
	// OAuth2 server allowed scopes
	OAuth2ServerScopes []string `json:"oAuth2ServerScopes"`
	// OAuth2 server scopes used when an authorization request omits the scope
	// parameter
	OAuth2ServerDefaultScopes []string `json:"oAuth2ServerDefaultScopes"`
	// Scopes an application may request when installed on a team
	OAuth2ServerInstallationScopes []string `json:"oAuth2ServerInstallationScopes"`
	// OAuth2 server accepted RFC 9396 authorization_details types
	OAuth2ServerAuthorizationDetailsTypes []string `json:"oAuth2ServerAuthorizationDetailsTypes"`
	// OAuth2 server access token duration in seconds for confidential clients
	OAuth2ServerAccessTokenDuration int `json:"oAuth2ServerAccessTokenDuration"`
	// OAuth2 server refresh token duration in seconds for confidential clients
	OAuth2ServerRefreshTokenDuration int `json:"oAuth2ServerRefreshTokenDuration"`
	// OAuth2 server access token duration in seconds for public clients (SPAs,
	// mobile, native)
	OAuth2ServerPublicAccessTokenDuration int `json:"oAuth2ServerPublicAccessTokenDuration"`
	// OAuth2 server refresh token duration in seconds for public clients (SPAs,
	// mobile, native)
	OAuth2ServerPublicRefreshTokenDuration int `json:"oAuth2ServerPublicRefreshTokenDuration"`
	// OAuth2 server access token duration in seconds for app installation access
	// tokens
	OAuth2ServerInstallationAccessTokenDuration int `json:"oAuth2ServerInstallationAccessTokenDuration"`
	// When enabled, PKCE is required for confidential clients (server-side flows
	// using client_secret). PKCE is always required for public clients regardless
	// of this setting.
	OAuth2ServerConfidentialPkce bool `json:"oAuth2ServerConfidentialPkce"`
	// URL to your application page where users enter the device flow user code.
	// Empty when the Device Authorization Grant is not configured.
	OAuth2ServerVerificationUrl string `json:"oAuth2ServerVerificationUrl"`
	// Number of characters in the device flow user code, excluding the formatting
	// separator.
	OAuth2ServerUserCodeLength int `json:"oAuth2ServerUserCodeLength"`
	// Character set for device flow user codes: `numeric`, `alphabetic`, or
	// `alphanumeric`.
	OAuth2ServerUserCodeFormat string `json:"oAuth2ServerUserCodeFormat"`
	// Lifetime in seconds of device flow device codes and user codes.
	OAuth2ServerDeviceCodeDuration int `json:"oAuth2ServerDeviceCodeDuration"`
	// OAuth2 server discovery URL
	OAuth2ServerDiscoveryUrl string `json:"oAuth2ServerDiscoveryUrl"`
	// contains filtered or unexported fields
}

Project Model

func (*Project) Decode

func (model *Project) Decode(value interface{}) error

func (Project) New

func (model Project) New(data []byte) *Project

type ProjectAuthMethod

type ProjectAuthMethod struct {
	// Auth method ID.
	Id string `json:"$id"`
	// Auth method status.
	Enabled bool `json:"enabled"`
	// contains filtered or unexported fields
}

ProjectAuthMethod Model

func (*ProjectAuthMethod) Decode

func (model *ProjectAuthMethod) Decode(value interface{}) error

func (ProjectAuthMethod) New

func (model ProjectAuthMethod) New(data []byte) *ProjectAuthMethod

type ProjectList

type ProjectList struct {
	// Total number of projects that matched your query.
	Total int `json:"total"`
	// List of projects.
	Projects []Project `json:"projects"`
	// contains filtered or unexported fields
}

ProjectsList Model

func (*ProjectList) Decode

func (model *ProjectList) Decode(value interface{}) error

func (ProjectList) New

func (model ProjectList) New(data []byte) *ProjectList

type ProjectProtocol

type ProjectProtocol struct {
	// Protocol ID.
	Id string `json:"$id"`
	// Protocol status.
	Enabled bool `json:"enabled"`
	// contains filtered or unexported fields
}

ProjectProtocol Model

func (*ProjectProtocol) Decode

func (model *ProjectProtocol) Decode(value interface{}) error

func (ProjectProtocol) New

func (model ProjectProtocol) New(data []byte) *ProjectProtocol

type ProjectService

type ProjectService struct {
	// Service ID.
	Id string `json:"$id"`
	// Service status.
	Enabled bool `json:"enabled"`
	// contains filtered or unexported fields
}

ProjectService Model

func (*ProjectService) Decode

func (model *ProjectService) Decode(value interface{}) error

func (ProjectService) New

func (model ProjectService) New(data []byte) *ProjectService

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:"type"`
	// Provider credentials.
	Credentials interface{} `json:"credentials"`
	// Provider options.
	Options interface{} `json:"options"`
	// contains filtered or unexported fields
}

Provider Model

func (*Provider) Decode

func (model *Provider) Decode(value interface{}) error

func (Provider) New

func (model Provider) New(data []byte) *Provider

type ProviderList

type ProviderList struct {
	// Total number of providers that matched your query.
	Total int `json:"total"`
	// List of providers.
	Providers []Provider `json:"providers"`
	// contains filtered or unexported fields
}

ProviderList Model

func (*ProviderList) Decode

func (model *ProviderList) Decode(value interface{}) error

func (ProviderList) New

func (model ProviderList) New(data []byte) *ProviderList

type ProxyInvalidation

type ProxyInvalidation struct {
	// Domain name.
	Domain string `json:"domain"`
	// Invalidation type. Possible values are "tag", "path", or "all".
	Type string `json:"type"`
	// Invalidated reference. Depending on type this is a cache tag name, a URL
	// path, or empty when type is all.
	Reference string `json:"reference"`
	// Invalidation status.
	Status string `json:"status"`
	// contains filtered or unexported fields
}

Invalidation Model

func (*ProxyInvalidation) Decode

func (model *ProxyInvalidation) Decode(value interface{}) error

func (ProxyInvalidation) New

func (model ProxyInvalidation) New(data []byte) *ProxyInvalidation

type ProxyRule

type ProxyRule struct {
	// Rule ID.
	Id string `json:"$id"`
	// Rule creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Rule update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Domain name.
	Domain string `json:"domain"`
	// Action definition for the rule. Possible values are "api", "deployment", or
	// "redirect"
	Type string `json:"type"`
	// Defines how the rule was created. Possible values are "manual" or
	// "deployment"
	Trigger string `json:"trigger"`
	// URL to redirect to. Used if type is "redirect"
	RedirectUrl string `json:"redirectUrl"`
	// Status code to apply during redirect. Used if type is "redirect"
	RedirectStatusCode int `json:"redirectStatusCode"`
	// ID of deployment. Used if type is "deployment"
	DeploymentId string `json:"deploymentId"`
	// Type of deployment. Possible values are "function", "site". Used if rule's
	// type is "deployment".
	DeploymentResourceType string `json:"deploymentResourceType"`
	// ID of deployment's resource (site or function ID). Used if type is
	// "deployment"
	DeploymentResourceId string `json:"deploymentResourceId"`
	// Name of Git branch that updates rule. Used if type is "deployment"
	DeploymentVcsProviderBranch string `json:"deploymentVcsProviderBranch"`
	// Domain verification status. Possible values are "unverified", "verifying",
	// "verified"
	Status string `json:"status"`
	// Logs from rule verification or certificate generation. Certificate
	// generation logs are prioritized if both are available.
	Logs string `json:"logs"`
	// Certificate auto-renewal date in ISO 8601 format.
	RenewAt string `json:"renewAt"`
	// contains filtered or unexported fields
}

Rule Model

func (*ProxyRule) Decode

func (model *ProxyRule) Decode(value interface{}) error

func (ProxyRule) New

func (model ProxyRule) New(data []byte) *ProxyRule

type ProxyRuleList

type ProxyRuleList struct {
	// Total number of rules that matched your query.
	Total int `json:"total"`
	// List of rules.
	Rules []ProxyRule `json:"rules"`
	// contains filtered or unexported fields
}

RuleList Model

func (*ProxyRuleList) Decode

func (model *ProxyRuleList) Decode(value interface{}) error

func (ProxyRuleList) New

func (model ProxyRuleList) New(data []byte) *ProxyRuleList

type Report

type Report struct {
	// Report ID.
	Id string `json:"$id"`
	// Report creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Report update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// ID of the third-party app that submitted the report.
	AppId string `json:"appId"`
	// Analyzer that produced this report. e.g. lighthouse, audit,
	// databaseAnalyzer.
	Type string `json:"type"`
	// Short, human-readable title for the report.
	Title string `json:"title"`
	// Markdown summary describing the report.
	Summary string `json:"summary"`
	// Plural noun describing what the report analyzes, e.g. databases, sites,
	// urls.
	TargetType string `json:"targetType"`
	// Free-form target identifier (URL for lighthouse, resource ID for db).
	Target string `json:"target"`
	// Categories covered by the report, e.g. performance, accessibility.
	Categories []string `json:"categories"`
	// Insights nested under this report.
	Insights []Insight `json:"insights"`
	// Time the report was analyzed in ISO 8601 format.
	AnalyzedAt string `json:"analyzedAt"`
	// contains filtered or unexported fields
}

Report Model

func (*Report) Decode

func (model *Report) Decode(value interface{}) error

func (Report) New

func (model Report) New(data []byte) *Report

type ReportList

type ReportList struct {
	// Total number of reports that matched your query.
	Total int `json:"total"`
	// List of reports.
	Reports []Report `json:"reports"`
	// contains filtered or unexported fields
}

ReportsList Model

func (*ReportList) Decode

func (model *ReportList) Decode(value interface{}) error

func (ReportList) New

func (model ReportList) New(data []byte) *ReportList

type ResourceToken

type ResourceToken struct {
	// Token ID.
	Id string `json:"$id"`
	// Token creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Resource ID.
	ResourceId string `json:"resourceId"`
	// Resource type.
	ResourceType string `json:"resourceType"`
	// Token expiration date in ISO 8601 format.
	Expire string `json:"expire"`
	// JWT encoded string.
	Secret string `json:"secret"`
	// Most recent access date in ISO 8601 format. This attribute is only updated
	// again after 24 hours.
	AccessedAt string `json:"accessedAt"`
	// contains filtered or unexported fields
}

ResourceToken Model

func (*ResourceToken) Decode

func (model *ResourceToken) Decode(value interface{}) error

func (ResourceToken) New

func (model ResourceToken) New(data []byte) *ResourceToken

type ResourceTokenList

type ResourceTokenList struct {
	// Total number of tokens that matched your query.
	Total int `json:"total"`
	// List of tokens.
	Tokens []ResourceToken `json:"tokens"`
	// contains filtered or unexported fields
}

ResourceTokensList Model

func (*ResourceTokenList) Decode

func (model *ResourceTokenList) Decode(value interface{}) error

func (ResourceTokenList) New

func (model ResourceTokenList) New(data []byte) *ResourceTokenList

type Row

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

Row Model

func (*Row) Decode

func (model *Row) Decode(value interface{}) error

Use this method to get response in desired type

func (Row) New

func (model Row) New(data []byte) *Row

type RowList

type RowList struct {
	// Total number of rows that matched your query.
	Total int `json:"total"`
	// List of rows.
	Rows []Row `json:"rows"`
	// contains filtered or unexported fields
}

RowsList Model

func (*RowList) Decode

func (model *RowList) Decode(value interface{}) error

func (RowList) New

func (model RowList) New(data []byte) *RowList

type Runtime

type Runtime struct {
	// Runtime ID.
	Id string `json:"$id"`
	// Parent runtime key.
	Key string `json:"key"`
	// 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 []string `json:"supports"`
	// contains filtered or unexported fields
}

Runtime Model

func (*Runtime) Decode

func (model *Runtime) Decode(value interface{}) error

func (Runtime) New

func (model Runtime) New(data []byte) *Runtime

type RuntimeList

type RuntimeList struct {
	// Total number of runtimes that matched your query.
	Total int `json:"total"`
	// List of runtimes.
	Runtimes []Runtime `json:"runtimes"`
	// contains filtered or unexported fields
}

RuntimesList Model

func (*RuntimeList) Decode

func (model *RuntimeList) Decode(value interface{}) error

func (RuntimeList) New

func (model RuntimeList) New(data []byte) *RuntimeList

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 []string `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"`
	// contains filtered or unexported fields
}

Session Model

func (*Session) Decode

func (model *Session) Decode(value interface{}) error

func (Session) New

func (model Session) New(data []byte) *Session

type SessionList

type SessionList struct {
	// Total number of sessions that matched your query.
	Total int `json:"total"`
	// List of sessions.
	Sessions []Session `json:"sessions"`
	// contains filtered or unexported fields
}

SessionsList Model

func (*SessionList) Decode

func (model *SessionList) Decode(value interface{}) error

func (SessionList) New

func (model SessionList) New(data []byte) *SessionList

type Site

type Site struct {
	// Site ID.
	Id string `json:"$id"`
	// Site creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Site update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Site name.
	Name string `json:"name"`
	// Site enabled.
	Enabled bool `json:"enabled"`
	// Is the site 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 site to update it with the latest configuration.
	Live bool `json:"live"`
	// When disabled, request logs will exclude logs and errors, and site
	// responses will be slightly faster.
	Logging bool `json:"logging"`
	// Site framework.
	Framework string `json:"framework"`
	// How many days to keep the non-active deployments before they will be
	// automatically deleted.
	DeploymentRetention int `json:"deploymentRetention"`
	// Site's active deployment ID.
	DeploymentId string `json:"deploymentId"`
	// Active deployment creation date in ISO 8601 format.
	DeploymentCreatedAt string `json:"deploymentCreatedAt"`
	// Screenshot of active deployment with light theme preference file ID.
	DeploymentScreenshotLight string `json:"deploymentScreenshotLight"`
	// Screenshot of active deployment with dark theme preference file ID.
	DeploymentScreenshotDark string `json:"deploymentScreenshotDark"`
	// Site's latest deployment ID.
	LatestDeploymentId string `json:"latestDeploymentId"`
	// Latest deployment creation date in ISO 8601 format.
	LatestDeploymentCreatedAt string `json:"latestDeploymentCreatedAt"`
	// Status of latest deployment. Possible values are "waiting", "processing",
	// "building", "ready", and "failed".
	LatestDeploymentStatus string `json:"latestDeploymentStatus"`
	// Allowed permission scopes.
	Scopes []string `json:"scopes"`
	// Site variables.
	Vars []Variable `json:"vars"`
	// Site request timeout in seconds.
	Timeout int `json:"timeout"`
	// The install command used to install the site dependencies.
	InstallCommand string `json:"installCommand"`
	// The build command used to build the site.
	BuildCommand string `json:"buildCommand"`
	// Custom command to use when starting site runtime.
	StartCommand string `json:"startCommand"`
	// The directory where the site build output is located.
	OutputDirectory string `json:"outputDirectory"`
	// Site 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 site 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"`
	// List of branch name patterns that trigger automatic deployments. Supports
	// glob wildcards. Empty list deploys on all branches.
	ProviderBranches []string `json:"providerBranches"`
	// List of file path patterns that trigger automatic deployments. Supports
	// glob wildcards. Empty list deploys on all file changes.
	ProviderPaths []string `json:"providerPaths"`
	// Machine specification for deployment builds.
	BuildSpecification string `json:"buildSpecification"`
	// Machine specification for SSR executions.
	RuntimeSpecification string `json:"runtimeSpecification"`
	// Site build runtime.
	BuildRuntime string `json:"buildRuntime"`
	// Site framework adapter.
	Adapter string `json:"adapter"`
	// Name of fallback file to use instead of 404 page. If null, Appwrite 404
	// page will be displayed.
	FallbackFile string `json:"fallbackFile"`
	// contains filtered or unexported fields
}

Site Model

func (*Site) Decode

func (model *Site) Decode(value interface{}) error

func (Site) New

func (model Site) New(data []byte) *Site

type SiteList

type SiteList struct {
	// Total number of sites that matched your query.
	Total int `json:"total"`
	// List of sites.
	Sites []Site `json:"sites"`
	// contains filtered or unexported fields
}

SitesList Model

func (*SiteList) Decode

func (model *SiteList) Decode(value interface{}) error

func (SiteList) New

func (model SiteList) New(data []byte) *SiteList

type Specification

type Specification struct {
	// Memory size in MB.
	Memory int `json:"memory"`
	// Number of CPUs.
	Cpus float64 `json:"cpus"`
	// Is size enabled.
	Enabled bool `json:"enabled"`
	// Size slug.
	Slug string `json:"slug"`
	// contains filtered or unexported fields
}

Specification Model

func (*Specification) Decode

func (model *Specification) Decode(value interface{}) error

func (Specification) New

func (model Specification) New(data []byte) *Specification

type SpecificationList

type SpecificationList struct {
	// Total number of specifications that matched your query.
	Total int `json:"total"`
	// List of specifications.
	Specifications []Specification `json:"specifications"`
	// contains filtered or unexported fields
}

SpecificationsList Model

func (*SpecificationList) Decode

func (model *SpecificationList) Decode(value interface{}) error

func (SpecificationList) New

func (model SpecificationList) New(data []byte) *SpecificationList

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 Target `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"`
	// contains filtered or unexported fields
}

Subscriber Model

func (*Subscriber) Decode

func (model *Subscriber) Decode(value interface{}) error

func (Subscriber) New

func (model Subscriber) New(data []byte) *Subscriber

type SubscriberList

type SubscriberList struct {
	// Total number of subscribers that matched your query.
	Total int `json:"total"`
	// List of subscribers.
	Subscribers []Subscriber `json:"subscribers"`
	// contains filtered or unexported fields
}

SubscriberList Model

func (*SubscriberList) Decode

func (model *SubscriberList) Decode(value interface{}) error

func (SubscriberList) New

func (model SubscriberList) New(data []byte) *SubscriberList

type Table

type Table struct {
	// Table ID.
	Id string `json:"$id"`
	// Table creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Table update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Table permissions. [Learn more about
	// permissions](https://appwrite.io/docs/permissions).
	Permissions []string `json:"$permissions"`
	// Database ID.
	DatabaseId string `json:"databaseId"`
	// Table name.
	Name string `json:"name"`
	// Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is
	// inaccessible to users, but remains accessible to Server SDKs using API
	// keys.
	Enabled bool `json:"enabled"`
	// Whether row-level permissions are enabled. [Learn more about
	// permissions](https://appwrite.io/docs/permissions).
	RowSecurity bool `json:"rowSecurity"`
	// Table columns.
	Columns []interface{} `json:"columns"`
	// Table indexes.
	Indexes []ColumnIndex `json:"indexes"`
	// Maximum row size in bytes. Returns 0 when no limit applies.
	BytesMax int `json:"bytesMax"`
	// Currently used row size in bytes based on defined columns.
	BytesUsed int `json:"bytesUsed"`
	// contains filtered or unexported fields
}

Table Model

func (*Table) Decode

func (model *Table) Decode(value interface{}) error

func (Table) New

func (model Table) New(data []byte) *Table

type TableList

type TableList struct {
	// Total number of tables that matched your query.
	Total int `json:"total"`
	// List of tables.
	Tables []Table `json:"tables"`
	// contains filtered or unexported fields
}

TablesList Model

func (*TableList) Decode

func (model *TableList) Decode(value interface{}) error

func (TableList) New

func (model TableList) New(data []byte) *TableList

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"`
	// Is the target expired.
	Expired bool `json:"expired"`
	// contains filtered or unexported fields
}

Target Model

func (*Target) Decode

func (model *Target) Decode(value interface{}) error

func (Target) New

func (model Target) New(data []byte) *Target

type TargetList

type TargetList struct {
	// Total number of targets that matched your query.
	Total int `json:"total"`
	// List of targets.
	Targets []Target `json:"targets"`
	// contains filtered or unexported fields
}

TargetList Model

func (*TargetList) Decode

func (model *TargetList) Decode(value interface{}) error

func (TargetList) New

func (model TargetList) New(data []byte) *TargetList

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 Preferences `json:"prefs"`
	// contains filtered or unexported fields
}

Team Model

func (*Team) Decode

func (model *Team) Decode(value interface{}) error

func (Team) New

func (model Team) New(data []byte) *Team

type TeamList

type TeamList struct {
	// Total number of teams that matched your query.
	Total int `json:"total"`
	// List of teams.
	Teams []Team `json:"teams"`
	// contains filtered or unexported fields
}

TeamsList Model

func (*TeamList) Decode

func (model *TeamList) Decode(value interface{}) error

func (TeamList) New

func (model TeamList) New(data []byte) *TeamList

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"`
	// contains filtered or unexported fields
}

Token Model

func (*Token) Decode

func (model *Token) Decode(value interface{}) error

func (Token) New

func (model Token) New(data []byte) *Token

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 []string `json:"subscribe"`
	// contains filtered or unexported fields
}

Topic Model

func (*Topic) Decode

func (model *Topic) Decode(value interface{}) error

func (Topic) New

func (model Topic) New(data []byte) *Topic

type TopicList

type TopicList struct {
	// Total number of topics that matched your query.
	Total int `json:"total"`
	// List of topics.
	Topics []Topic `json:"topics"`
	// contains filtered or unexported fields
}

TopicList Model

func (*TopicList) Decode

func (model *TopicList) Decode(value interface{}) error

func (TopicList) New

func (model TopicList) New(data []byte) *TopicList

type Transaction

type Transaction struct {
	// Transaction ID.
	Id string `json:"$id"`
	// Transaction creation time in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Transaction update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Current status of the transaction. One of: pending, committing, committed,
	// rolled_back, failed.
	Status string `json:"status"`
	// Number of operations in the transaction.
	Operations int `json:"operations"`
	// Expiration time in ISO 8601 format.
	ExpiresAt string `json:"expiresAt"`
	// contains filtered or unexported fields
}

Transaction Model

func (*Transaction) Decode

func (model *Transaction) Decode(value interface{}) error

func (Transaction) New

func (model Transaction) New(data []byte) *Transaction

type TransactionList

type TransactionList struct {
	// Total number of transactions that matched your query.
	Total int `json:"total"`
	// List of transactions.
	Transactions []Transaction `json:"transactions"`
	// contains filtered or unexported fields
}

TransactionList Model

func (*TransactionList) Decode

func (model *TransactionList) Decode(value interface{}) error

func (TransactionList) New

func (model TransactionList) New(data []byte) *TransactionList

type UsageBillingPlan

type UsageBillingPlan struct {
	// Bandwidth additional resources
	Bandwidth AdditionalResource `json:"bandwidth"`
	// Executions additional resources
	Executions AdditionalResource `json:"executions"`
	// Member additional resources
	Member AdditionalResource `json:"member"`
	// Realtime additional resources
	Realtime AdditionalResource `json:"realtime"`
	// Realtime messages additional resources
	RealtimeMessages AdditionalResource `json:"realtimeMessages"`
	// Realtime bandwidth additional resources
	RealtimeBandwidth AdditionalResource `json:"realtimeBandwidth"`
	// Storage additional resources
	Storage AdditionalResource `json:"storage"`
	// User additional resources
	Users AdditionalResource `json:"users"`
	// GBHour additional resources
	GBHours AdditionalResource `json:"GBHours"`
	// Image transformation additional resources
	ImageTransformations AdditionalResource `json:"imageTransformations"`
	// Credits additional resources
	Credits AdditionalResource `json:"credits"`
	// contains filtered or unexported fields
}

UsageBillingPlan Model

func (*UsageBillingPlan) Decode

func (model *UsageBillingPlan) Decode(value interface{}) error

func (UsageBillingPlan) New

func (model UsageBillingPlan) New(data []byte) *UsageBillingPlan

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 []string `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"`
	// Canonical form of the user email address.
	EmailCanonical string `json:"emailCanonical"`
	// Whether the user email is from a free email provider.
	EmailIsFree bool `json:"emailIsFree"`
	// Whether the user email is from a disposable email provider.
	EmailIsDisposable bool `json:"emailIsDisposable"`
	// Whether the user email is from a corporate domain.
	EmailIsCorporate bool `json:"emailIsCorporate"`
	// Whether the user email is in its canonical form.
	EmailIsCanonical bool `json:"emailIsCanonical"`
	// Phone verification status.
	PhoneVerification bool `json:"phoneVerification"`
	// Multi factor authentication status.
	Mfa bool `json:"mfa"`
	// User preferences as a key-value object
	Prefs Preferences `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 []Target `json:"targets"`
	// Most recent access date in ISO 8601 format. This attribute is only updated
	// again after 24 hours.
	AccessedAt string `json:"accessedAt"`
	// Whether the user can impersonate other users.
	Impersonator bool `json:"impersonator"`
	// ID of the original actor performing the impersonation. Present only when
	// the current request is impersonating another user. Internal audit logs
	// attribute the action to this user, while the impersonated target is
	// recorded only in internal audit payload data.
	ImpersonatorUserId string `json:"impersonatorUserId"`
	// contains filtered or unexported fields
}

User Model

func (*User) Decode

func (model *User) Decode(value interface{}) error

func (User) New

func (model User) New(data []byte) *User

type UserList

type UserList struct {
	// Total number of users that matched your query.
	Total int `json:"total"`
	// List of users.
	Users []User `json:"users"`
	// contains filtered or unexported fields
}

UsersList Model

func (*UserList) Decode

func (model *UserList) Decode(value interface{}) error

func (UserList) New

func (model UserList) New(data []byte) *UserList

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"`
	// Variable secret flag. Secret variables can only be updated or deleted, but
	// never read.
	Secret bool `json:"secret"`
	// 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"`
	// contains filtered or unexported fields
}

Variable Model

func (*Variable) Decode

func (model *Variable) Decode(value interface{}) error

func (Variable) New

func (model Variable) New(data []byte) *Variable

type VariableList

type VariableList struct {
	// Total number of variables that matched your query.
	Total int `json:"total"`
	// List of variables.
	Variables []Variable `json:"variables"`
	// contains filtered or unexported fields
}

VariablesList Model

func (*VariableList) Decode

func (model *VariableList) Decode(value interface{}) error

func (VariableList) New

func (model VariableList) New(data []byte) *VariableList

type VectorsdbCollection added in v7.2.0

type VectorsdbCollection 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 []string `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 []map[string]any `json:"attributes"`
	// Collection indexes.
	Indexes []Index `json:"indexes"`
	// Maximum document size in bytes. Returns 0 when no limit applies.
	BytesMax int `json:"bytesMax"`
	// Currently used document size in bytes based on defined attributes.
	BytesUsed int `json:"bytesUsed"`
	// Embedding dimension.
	Dimension int `json:"dimension"`
	// contains filtered or unexported fields
}

VectorsDBCollection Model

func (*VectorsdbCollection) Decode added in v7.2.0

func (model *VectorsdbCollection) Decode(value interface{}) error

func (VectorsdbCollection) New added in v7.2.0

func (model VectorsdbCollection) New(data []byte) *VectorsdbCollection

type VectorsdbCollectionList added in v7.2.0

type VectorsdbCollectionList struct {
	// Total number of collections that matched your query.
	Total int `json:"total"`
	// List of collections.
	Collections []VectorsdbCollection `json:"collections"`
	// contains filtered or unexported fields
}

VectorsDBCollectionsList Model

func (*VectorsdbCollectionList) Decode added in v7.2.0

func (model *VectorsdbCollectionList) Decode(value interface{}) error

func (VectorsdbCollectionList) New added in v7.2.0

type Webhook

type Webhook struct {
	// Webhook ID.
	Id string `json:"$id"`
	// Webhook creation date in ISO 8601 format.
	CreatedAt string `json:"$createdAt"`
	// Webhook update date in ISO 8601 format.
	UpdatedAt string `json:"$updatedAt"`
	// Webhook name.
	Name string `json:"name"`
	// Webhook URL endpoint.
	Url string `json:"url"`
	// Webhook trigger events.
	Events []string `json:"events"`
	// Indicates if SSL / TLS certificate verification is enabled.
	Tls bool `json:"tls"`
	// HTTP basic authentication username.
	AuthUsername string `json:"authUsername"`
	// HTTP basic authentication password.
	AuthPassword string `json:"authPassword"`
	// Signature key which can be used to validate incoming webhook payloads. Only
	// returned on creation and secret rotation.
	Secret string `json:"secret"`
	// Indicates if this webhook is enabled.
	Enabled bool `json:"enabled"`
	// Webhook error logs from the most recent failure.
	Logs string `json:"logs"`
	// Number of consecutive failed webhook attempts.
	Attempts int `json:"attempts"`
	// contains filtered or unexported fields
}

Webhook Model

func (*Webhook) Decode

func (model *Webhook) Decode(value interface{}) error

func (Webhook) New

func (model Webhook) New(data []byte) *Webhook

type WebhookList

type WebhookList struct {
	// Total number of webhooks that matched your query.
	Total int `json:"total"`
	// List of webhooks.
	Webhooks []Webhook `json:"webhooks"`
	// contains filtered or unexported fields
}

WebhooksList Model

func (*WebhookList) Decode

func (model *WebhookList) Decode(value interface{}) error

func (WebhookList) New

func (model WebhookList) New(data []byte) *WebhookList

Source Files

Jump to

Keyboard shortcuts

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