Documentation
¶
Index ¶
- type ActivityEvent
- type ActivityEventList
- type AlgoArgon2
- type AlgoBcrypt
- type AlgoMd5
- type AlgoPhpass
- type AlgoScrypt
- type AlgoScryptModified
- type AlgoSha
- type AttributeBigint
- type AttributeBoolean
- type AttributeDatetime
- type AttributeEmail
- type AttributeEnum
- type AttributeFloat
- type AttributeInteger
- type AttributeIp
- type AttributeLine
- type AttributeList
- type AttributeLongtext
- type AttributeMediumtext
- type AttributePoint
- type AttributePolygon
- type AttributeRelationship
- type AttributeString
- type AttributeText
- type AttributeUrl
- type AttributeVarchar
- type AuthProvider
- type BackupArchive
- type BackupArchiveList
- type BackupPolicy
- type BackupPolicyList
- type BackupRestoration
- type BackupRestorationList
- type BillingLimits
- type Block
- type Bucket
- type BucketList
- type Collection
- type CollectionList
- type ColumnBigint
- type ColumnBoolean
- type ColumnDatetime
- type ColumnEmail
- type ColumnEnum
- type ColumnFloat
- type ColumnIndex
- type ColumnIndexList
- type ColumnInteger
- type ColumnIp
- type ColumnLine
- type ColumnList
- type ColumnLongtext
- type ColumnMediumtext
- type ColumnPoint
- type ColumnPolygon
- type ColumnRelationship
- type ColumnString
- type ColumnText
- type ColumnUrl
- type ColumnVarchar
- type Continent
- type ContinentList
- type Country
- type CountryList
- type Currency
- type CurrencyList
- type Database
- type DatabaseList
- type Deployment
- type DeploymentList
- type DevKey
- type Document
- type DocumentList
- type EmailTemplate
- type EmailTemplateList
- type EphemeralKey
- type Execution
- type ExecutionList
- type File
- type FileList
- type Framework
- type FrameworkAdapter
- type FrameworkList
- type Function
- type FunctionList
- type Headers
- type HealthAntivirus
- type HealthCertificate
- type HealthQueue
- type HealthStatus
- type HealthStatusList
- type HealthTime
- type Identity
- type IdentityList
- type Index
- type IndexList
- type Jwt
- type Key
- type KeyList
- type Language
- type LanguageList
- type Locale
- type LocaleCode
- type LocaleCodeList
- type Log
- type LogList
- type Membership
- type MembershipList
- type Message
- type MessageList
- type MfaChallenge
- type MfaFactors
- type MfaRecoveryCodes
- type MfaType
- type MockNumber
- type MockNumberList
- type Model
- type OAuth2Amazon
- type OAuth2Apple
- type OAuth2Auth0
- type OAuth2Authentik
- type OAuth2Autodesk
- type OAuth2Bitbucket
- type OAuth2Bitly
- type OAuth2Box
- type OAuth2Dailymotion
- type OAuth2Discord
- type OAuth2Disqus
- type OAuth2Dropbox
- type OAuth2Etsy
- type OAuth2Facebook
- type OAuth2Figma
- type OAuth2FusionAuth
- type OAuth2Github
- type OAuth2Gitlab
- type OAuth2Google
- type OAuth2Keycloak
- type OAuth2Kick
- type OAuth2Linkedin
- type OAuth2Microsoft
- type OAuth2Notion
- type OAuth2Oidc
- type OAuth2Okta
- type OAuth2Paypal
- type OAuth2Podio
- type OAuth2ProviderList
- type OAuth2Salesforce
- type OAuth2Slack
- type OAuth2Spotify
- type OAuth2Stripe
- type OAuth2Tradeshift
- type OAuth2Twitch
- type OAuth2WordPress
- type OAuth2X
- type OAuth2Yahoo
- type OAuth2Yandex
- type OAuth2Zoho
- type OAuth2Zoom
- type Phone
- type PhoneList
- type PlatformAndroid
- type PlatformApple
- type PlatformLinux
- type PlatformList
- type PlatformWeb
- type PlatformWindows
- type PolicyList
- type PolicyMembershipPrivacy
- type PolicyPasswordDictionary
- type PolicyPasswordHistory
- type PolicyPasswordPersonalData
- type PolicySessionAlert
- type PolicySessionDuration
- type PolicySessionInvalidation
- type PolicySessionLimit
- type PolicyUserLimit
- type Preferences
- type Project
- type Provider
- type ProviderList
- type ProxyRule
- type ProxyRuleList
- type ResourceToken
- type ResourceTokenList
- type Row
- type RowList
- type Runtime
- type RuntimeList
- type Session
- type SessionList
- type Site
- type SiteList
- type Specification
- type SpecificationList
- type Subscriber
- type SubscriberList
- type Table
- type TableList
- type Target
- type TargetList
- type Team
- type TeamList
- type Token
- type Topic
- type TopicList
- type Transaction
- type TransactionList
- type User
- type UserList
- type Variable
- type VariableList
- type Webhook
- type WebhookList
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"`
// User type.
UserType string `json:"userType"`
// User ID.
UserId string `json:"userId"`
// User Email.
UserEmail string `json:"userEmail"`
// User Name.
UserName string `json:"userName"`
// 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"`
// 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"`
// 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
}
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 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
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
type AttributeBigint ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *AttributeBigint) Decode(value interface{}) error
func (AttributeBigint) New ¶ added in v3.1.0
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 []interface{} `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 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 []interface{} `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 []interface{} `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 ¶
func (model AttributeRelationship) New(data []byte) *AttributeRelationship
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 AuthProvider ¶
type AuthProvider struct {
// Auth Provider.
Key string `json:"key"`
// Auth Provider name.
Name string `json:"name"`
// OAuth 2.0 application ID.
AppId string `json:"appId"`
// OAuth 2.0 application secret. Might be JSON string if provider requires
// extra configuration. This property is write-only and always returned empty.
Secret string `json:"secret"`
// Auth Provider is active and can be used to create session.
Enabled bool `json:"enabled"`
// contains filtered or unexported fields
}
AuthProvider Model
func (*AuthProvider) Decode ¶
func (model *AuthProvider) Decode(value interface{}) error
func (AuthProvider) New ¶
func (model AuthProvider) New(data []byte) *AuthProvider
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"`
// 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 ¶
func (model BackupRestorationList) New(data []byte) *BackupRestorationList
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
}
BillingLimits Model
func (*BillingLimits) Decode ¶
func (model *BillingLimits) Decode(value interface{}) error
func (BillingLimits) New ¶
func (model BillingLimits) New(data []byte) *BillingLimits
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"`
// 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
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
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 ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *ColumnBigint) Decode(value interface{}) error
func (ColumnBigint) New ¶ added in v3.1.0
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
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 []interface{} `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 []interface{} `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 []interface{} `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
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
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
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
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"`
// Database backup policies.
Policies []Index `json:"policies"`
// Database backup archives.
Archives []Collection `json:"archives"`
// contains filtered or unexported fields
}
Database Model
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 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
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
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 ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *EmailTemplate) Decode(value interface{}) error
func (EmailTemplate) New ¶ added in v3.1.0
func (model EmailTemplate) New(data []byte) *EmailTemplate
type EmailTemplateList ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *EmailTemplateList) Decode(value interface{}) error
func (EmailTemplateList) New ¶ added in v3.1.0
func (model EmailTemplateList) New(data []byte) *EmailTemplateList
type EphemeralKey ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *EphemeralKey) Decode(value interface{}) error
func (EphemeralKey) New ¶ added in v3.1.0
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 ID.
FunctionId string `json:"functionId"`
// Function's deployment ID used to create the execution.
DeploymentId string `json:"deploymentId"`
// The trigger that caused the function to execute. Possible values can be:
// `http`, `schedule`, or `event`.
Trigger string `json:"trigger"`
// The status of the function execution. Possible values can be: `waiting`,
// `processing`, `completed`, `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"`
// Function logs. Includes the last 4,000 characters. This will return an
// empty string unless the response is returned using an API key or as part of
// a webhook payload.
Logs string `json:"logs"`
// Function errors. Includes the last 4,000 characters. This will return an
// empty string unless the response is returned using an API key or as part of
// a webhook payload.
Errors string `json:"errors"`
// 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
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"`
// File MD5 signature.
Signature string `json:"signature"`
// File mime type.
MimeType string `json:"mimeType"`
// File original size in bytes.
SizeOriginal int `json:"sizeOriginal"`
// Total number of chunks available
ChunksTotal int `json:"chunksTotal"`
// Total number of chunks uploaded
ChunksUploaded int `json:"chunksUploaded"`
// 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
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
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
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"`
// Machine specification for deployment builds.
BuildSpecification string `json:"buildSpecification"`
// Machine specification for executions.
RuntimeSpecification string `json:"runtimeSpecification"`
// contains filtered or unexported fields
}
Function Model
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
type HealthAntivirus ¶
type HealthAntivirus struct {
// Antivirus version.
Version string `json:"version"`
// Antivirus status. Possible values are: `disabled`, `offline`, `online`
Status string `json:"status"`
// contains filtered or unexported fields
}
HealthAntivirus Model
func (*HealthAntivirus) Decode ¶
func (model *HealthAntivirus) Decode(value interface{}) error
func (HealthAntivirus) New ¶
func (model HealthAntivirus) New(data []byte) *HealthAntivirus
type HealthCertificate ¶
type HealthCertificate struct {
// Certificate name
Name string `json:"name"`
// Subject SN
SubjectSN string `json:"subjectSN"`
// Issuer organisation
IssuerOrganisation string `json:"issuerOrganisation"`
// Valid from
ValidFrom string `json:"validFrom"`
// Valid to
ValidTo string `json:"validTo"`
// Signature type SN
SignatureTypeSN string `json:"signatureTypeSN"`
// contains filtered or unexported fields
}
HealthCertificate Model
func (*HealthCertificate) Decode ¶
func (model *HealthCertificate) Decode(value interface{}) error
func (HealthCertificate) New ¶
func (model HealthCertificate) New(data []byte) *HealthCertificate
type HealthQueue ¶
type HealthQueue struct {
// Amount of actions in the queue.
Size int `json:"size"`
// contains filtered or unexported fields
}
HealthQueue Model
func (*HealthQueue) Decode ¶
func (model *HealthQueue) Decode(value interface{}) error
func (HealthQueue) New ¶
func (model HealthQueue) New(data []byte) *HealthQueue
type HealthStatus ¶
type HealthStatus struct {
// Name of the service.
Name string `json:"name"`
// Duration in milliseconds how long the health check took.
Ping int `json:"ping"`
// Service status. Possible values are: `pass`, `fail`
Status string `json:"status"`
// contains filtered or unexported fields
}
HealthStatus Model
func (*HealthStatus) Decode ¶
func (model *HealthStatus) Decode(value interface{}) error
func (HealthStatus) New ¶
func (model HealthStatus) New(data []byte) *HealthStatus
type HealthStatusList ¶
type HealthStatusList struct {
// Total number of statuses that matched your query.
Total int `json:"total"`
// List of statuses.
Statuses []HealthStatus `json:"statuses"`
// contains filtered or unexported fields
}
StatusList Model
func (*HealthStatusList) Decode ¶
func (model *HealthStatusList) Decode(value interface{}) error
func (HealthStatusList) New ¶
func (model HealthStatusList) New(data []byte) *HealthStatusList
type HealthTime ¶
type HealthTime struct {
// Current unix timestamp on trustful remote server.
RemoteTime int `json:"remoteTime"`
// Current unix timestamp of local server where Appwrite runs.
LocalTime int `json:"localTime"`
// Difference of unix remote and local timestamps in milliseconds.
Diff int `json:"diff"`
// contains filtered or unexported fields
}
HealthTime Model
func (*HealthTime) Decode ¶
func (model *HealthTime) Decode(value interface{}) error
func (HealthTime) New ¶
func (model HealthTime) New(data []byte) *HealthTime
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
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
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
type Jwt ¶
type Jwt struct {
// JWT encoded string.
Jwt string `json:"jwt"`
// contains filtered or unexported fields
}
JWT Model
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
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
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
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"`
// contains filtered or unexported fields
}
Locale Model
type LocaleCode ¶
type LocaleCode struct {
// Locale codes in [ISO
// 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
Code string `json:"code"`
// Locale name
Name string `json:"name"`
// 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,
// 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
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
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"`
// 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
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 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"`
// 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
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 ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *MockNumberList) Decode(value interface{}) error
func (MockNumberList) New ¶ added in v3.1.0
func (model MockNumberList) New(data []byte) *MockNumberList
type OAuth2Amazon ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Amazon) Decode(value interface{}) error
func (OAuth2Amazon) New ¶ added in v3.1.0
func (model OAuth2Amazon) New(data []byte) *OAuth2Amazon
type OAuth2Apple ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Apple) Decode(value interface{}) error
func (OAuth2Apple) New ¶ added in v3.1.0
func (model OAuth2Apple) New(data []byte) *OAuth2Apple
type OAuth2Auth0 ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Auth0) Decode(value interface{}) error
func (OAuth2Auth0) New ¶ added in v3.1.0
func (model OAuth2Auth0) New(data []byte) *OAuth2Auth0
type OAuth2Authentik ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Authentik) Decode(value interface{}) error
func (OAuth2Authentik) New ¶ added in v3.1.0
func (model OAuth2Authentik) New(data []byte) *OAuth2Authentik
type OAuth2Autodesk ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Autodesk) Decode(value interface{}) error
func (OAuth2Autodesk) New ¶ added in v3.1.0
func (model OAuth2Autodesk) New(data []byte) *OAuth2Autodesk
type OAuth2Bitbucket ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Bitbucket) Decode(value interface{}) error
func (OAuth2Bitbucket) New ¶ added in v3.1.0
func (model OAuth2Bitbucket) New(data []byte) *OAuth2Bitbucket
type OAuth2Bitly ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Bitly) Decode(value interface{}) error
func (OAuth2Bitly) New ¶ added in v3.1.0
func (model OAuth2Bitly) New(data []byte) *OAuth2Bitly
type OAuth2Box ¶ added in v3.1.0
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
type OAuth2Dailymotion ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Dailymotion) Decode(value interface{}) error
func (OAuth2Dailymotion) New ¶ added in v3.1.0
func (model OAuth2Dailymotion) New(data []byte) *OAuth2Dailymotion
type OAuth2Discord ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Discord) Decode(value interface{}) error
func (OAuth2Discord) New ¶ added in v3.1.0
func (model OAuth2Discord) New(data []byte) *OAuth2Discord
type OAuth2Disqus ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Disqus) Decode(value interface{}) error
func (OAuth2Disqus) New ¶ added in v3.1.0
func (model OAuth2Disqus) New(data []byte) *OAuth2Disqus
type OAuth2Dropbox ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Dropbox) Decode(value interface{}) error
func (OAuth2Dropbox) New ¶ added in v3.1.0
func (model OAuth2Dropbox) New(data []byte) *OAuth2Dropbox
type OAuth2Etsy ¶ added in v3.1.0
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"`
SharedSecret string `json:"sharedSecret"`
// contains filtered or unexported fields
}
OAuth2Etsy Model
func (*OAuth2Etsy) Decode ¶ added in v3.1.0
func (model *OAuth2Etsy) Decode(value interface{}) error
func (OAuth2Etsy) New ¶ added in v3.1.0
func (model OAuth2Etsy) New(data []byte) *OAuth2Etsy
type OAuth2Facebook ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Facebook) Decode(value interface{}) error
func (OAuth2Facebook) New ¶ added in v3.1.0
func (model OAuth2Facebook) New(data []byte) *OAuth2Facebook
type OAuth2Figma ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Figma) Decode(value interface{}) error
func (OAuth2Figma) New ¶ added in v3.1.0
func (model OAuth2Figma) New(data []byte) *OAuth2Figma
type OAuth2FusionAuth ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2FusionAuth) Decode(value interface{}) error
func (OAuth2FusionAuth) New ¶ added in v3.1.0
func (model OAuth2FusionAuth) New(data []byte) *OAuth2FusionAuth
type OAuth2Github ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Github) Decode(value interface{}) error
func (OAuth2Github) New ¶ added in v3.1.0
func (model OAuth2Github) New(data []byte) *OAuth2Github
type OAuth2Gitlab ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Gitlab) Decode(value interface{}) error
func (OAuth2Gitlab) New ¶ added in v3.1.0
func (model OAuth2Gitlab) New(data []byte) *OAuth2Gitlab
type OAuth2Google ¶ added in v3.1.0
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"`
// contains filtered or unexported fields
}
OAuth2Google Model
func (*OAuth2Google) Decode ¶ added in v3.1.0
func (model *OAuth2Google) Decode(value interface{}) error
func (OAuth2Google) New ¶ added in v3.1.0
func (model OAuth2Google) New(data []byte) *OAuth2Google
type OAuth2Keycloak ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Keycloak) Decode(value interface{}) error
func (OAuth2Keycloak) New ¶ added in v3.1.0
func (model OAuth2Keycloak) New(data []byte) *OAuth2Keycloak
type OAuth2Kick ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Kick) Decode(value interface{}) error
func (OAuth2Kick) New ¶ added in v3.1.0
func (model OAuth2Kick) New(data []byte) *OAuth2Kick
type OAuth2Linkedin ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Linkedin) Decode(value interface{}) error
func (OAuth2Linkedin) New ¶ added in v3.1.0
func (model OAuth2Linkedin) New(data []byte) *OAuth2Linkedin
type OAuth2Microsoft ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Microsoft) Decode(value interface{}) error
func (OAuth2Microsoft) New ¶ added in v3.1.0
func (model OAuth2Microsoft) New(data []byte) *OAuth2Microsoft
type OAuth2Notion ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Notion) Decode(value interface{}) error
func (OAuth2Notion) New ¶ added in v3.1.0
func (model OAuth2Notion) New(data []byte) *OAuth2Notion
type OAuth2Oidc ¶ added in v3.1.0
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"`
// contains filtered or unexported fields
}
OAuth2Oidc Model
func (*OAuth2Oidc) Decode ¶ added in v3.1.0
func (model *OAuth2Oidc) Decode(value interface{}) error
func (OAuth2Oidc) New ¶ added in v3.1.0
func (model OAuth2Oidc) New(data []byte) *OAuth2Oidc
type OAuth2Okta ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Okta) Decode(value interface{}) error
func (OAuth2Okta) New ¶ added in v3.1.0
func (model OAuth2Okta) New(data []byte) *OAuth2Okta
type OAuth2Paypal ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Paypal) Decode(value interface{}) error
func (OAuth2Paypal) New ¶ added in v3.1.0
func (model OAuth2Paypal) New(data []byte) *OAuth2Paypal
type OAuth2Podio ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Podio) Decode(value interface{}) error
func (OAuth2Podio) New ¶ added in v3.1.0
func (model OAuth2Podio) New(data []byte) *OAuth2Podio
type OAuth2ProviderList ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2ProviderList) Decode(value interface{}) error
func (OAuth2ProviderList) New ¶ added in v3.1.0
func (model OAuth2ProviderList) New(data []byte) *OAuth2ProviderList
type OAuth2Salesforce ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Salesforce) Decode(value interface{}) error
func (OAuth2Salesforce) New ¶ added in v3.1.0
func (model OAuth2Salesforce) New(data []byte) *OAuth2Salesforce
type OAuth2Slack ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Slack) Decode(value interface{}) error
func (OAuth2Slack) New ¶ added in v3.1.0
func (model OAuth2Slack) New(data []byte) *OAuth2Slack
type OAuth2Spotify ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Spotify) Decode(value interface{}) error
func (OAuth2Spotify) New ¶ added in v3.1.0
func (model OAuth2Spotify) New(data []byte) *OAuth2Spotify
type OAuth2Stripe ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Stripe) Decode(value interface{}) error
func (OAuth2Stripe) New ¶ added in v3.1.0
func (model OAuth2Stripe) New(data []byte) *OAuth2Stripe
type OAuth2Tradeshift ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Tradeshift) Decode(value interface{}) error
func (OAuth2Tradeshift) New ¶ added in v3.1.0
func (model OAuth2Tradeshift) New(data []byte) *OAuth2Tradeshift
type OAuth2Twitch ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Twitch) Decode(value interface{}) error
func (OAuth2Twitch) New ¶ added in v3.1.0
func (model OAuth2Twitch) New(data []byte) *OAuth2Twitch
type OAuth2WordPress ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2WordPress) Decode(value interface{}) error
func (OAuth2WordPress) New ¶ added in v3.1.0
func (model OAuth2WordPress) New(data []byte) *OAuth2WordPress
type OAuth2X ¶ added in v3.1.0
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
type OAuth2Yahoo ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Yahoo) Decode(value interface{}) error
func (OAuth2Yahoo) New ¶ added in v3.1.0
func (model OAuth2Yahoo) New(data []byte) *OAuth2Yahoo
type OAuth2Yandex ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Yandex) Decode(value interface{}) error
func (OAuth2Yandex) New ¶ added in v3.1.0
func (model OAuth2Yandex) New(data []byte) *OAuth2Yandex
type OAuth2Zoho ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Zoho) Decode(value interface{}) error
func (OAuth2Zoho) New ¶ added in v3.1.0
func (model OAuth2Zoho) New(data []byte) *OAuth2Zoho
type OAuth2Zoom ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *OAuth2Zoom) Decode(value interface{}) error
func (OAuth2Zoom) New ¶ added in v3.1.0
func (model OAuth2Zoom) New(data []byte) *OAuth2Zoom
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
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
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 PolicyList ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *PolicyList) Decode(value interface{}) error
func (PolicyList) New ¶ added in v3.1.0
func (model PolicyList) New(data []byte) *PolicyList
type PolicyMembershipPrivacy ¶ added in v3.1.0
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"`
// contains filtered or unexported fields
}
PolicyMembershipPrivacy Model
func (*PolicyMembershipPrivacy) Decode ¶ added in v3.1.0
func (model *PolicyMembershipPrivacy) Decode(value interface{}) error
func (PolicyMembershipPrivacy) New ¶ added in v3.1.0
func (model PolicyMembershipPrivacy) New(data []byte) *PolicyMembershipPrivacy
type PolicyPasswordDictionary ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *PolicyPasswordDictionary) Decode(value interface{}) error
func (PolicyPasswordDictionary) New ¶ added in v3.1.0
func (model PolicyPasswordDictionary) New(data []byte) *PolicyPasswordDictionary
type PolicyPasswordHistory ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *PolicyPasswordHistory) Decode(value interface{}) error
func (PolicyPasswordHistory) New ¶ added in v3.1.0
func (model PolicyPasswordHistory) New(data []byte) *PolicyPasswordHistory
type PolicyPasswordPersonalData ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *PolicyPasswordPersonalData) Decode(value interface{}) error
func (PolicyPasswordPersonalData) New ¶ added in v3.1.0
func (model PolicyPasswordPersonalData) New(data []byte) *PolicyPasswordPersonalData
type PolicySessionAlert ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *PolicySessionAlert) Decode(value interface{}) error
func (PolicySessionAlert) New ¶ added in v3.1.0
func (model PolicySessionAlert) New(data []byte) *PolicySessionAlert
type PolicySessionDuration ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *PolicySessionDuration) Decode(value interface{}) error
func (PolicySessionDuration) New ¶ added in v3.1.0
func (model PolicySessionDuration) New(data []byte) *PolicySessionDuration
type PolicySessionInvalidation ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *PolicySessionInvalidation) Decode(value interface{}) error
func (PolicySessionInvalidation) New ¶ added in v3.1.0
func (model PolicySessionInvalidation) New(data []byte) *PolicySessionInvalidation
type PolicySessionLimit ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *PolicySessionLimit) Decode(value interface{}) error
func (PolicySessionLimit) New ¶ added in v3.1.0
func (model PolicySessionLimit) New(data []byte) *PolicySessionLimit
type PolicyUserLimit ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *PolicyUserLimit) Decode(value interface{}) error
func (PolicyUserLimit) New ¶ added in v3.1.0
func (model PolicyUserLimit) New(data []byte) *PolicyUserLimit
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 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 description.
Description string `json:"description"`
// Project team ID.
TeamId string `json:"teamId"`
// Project logo file ID.
Logo string `json:"logo"`
// Project website URL.
Url string `json:"url"`
// Company legal name.
LegalName string `json:"legalName"`
// Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1)
// two-character format.
LegalCountry string `json:"legalCountry"`
// State name.
LegalState string `json:"legalState"`
// City name.
LegalCity string `json:"legalCity"`
// Company Address.
LegalAddress string `json:"legalAddress"`
// Company Tax ID.
LegalTaxId string `json:"legalTaxId"`
// Session duration in seconds.
AuthDuration int `json:"authDuration"`
// Max users allowed. 0 is unlimited.
AuthLimit int `json:"authLimit"`
// Max sessions allowed per user. 100 maximum.
AuthSessionsLimit int `json:"authSessionsLimit"`
// Max allowed passwords in the history list per user. Max passwords limit
// allowed in history is 20. Use 0 for disabling password history.
AuthPasswordHistory int `json:"authPasswordHistory"`
// Whether or not to check user's password against most commonly used
// passwords.
AuthPasswordDictionary bool `json:"authPasswordDictionary"`
// Whether or not to check the user password for similarity with their
// personal data.
AuthPersonalDataCheck bool `json:"authPersonalDataCheck"`
// Whether or not to disallow disposable email addresses during signup and
// email updates.
AuthDisposableEmails bool `json:"authDisposableEmails"`
// Whether or not to require canonical email addresses during signup and email
// updates.
AuthCanonicalEmails bool `json:"authCanonicalEmails"`
// Whether or not to disallow free email addresses during signup and email
// updates.
AuthFreeEmails bool `json:"authFreeEmails"`
// An array of mock numbers and their corresponding verification codes (OTPs).
AuthMockNumbers []MockNumber `json:"authMockNumbers"`
// Whether or not to send session alert emails to users.
AuthSessionAlerts bool `json:"authSessionAlerts"`
// Whether or not to show user names in the teams membership response.
AuthMembershipsUserName bool `json:"authMembershipsUserName"`
// Whether or not to show user emails in the teams membership response.
AuthMembershipsUserEmail bool `json:"authMembershipsUserEmail"`
// Whether or not to show user MFA status in the teams membership response.
AuthMembershipsMfa bool `json:"authMembershipsMfa"`
// Whether or not to show user IDs in the teams membership response.
AuthMembershipsUserId bool `json:"authMembershipsUserId"`
// Whether or not to show user phone numbers in the teams membership response.
AuthMembershipsUserPhone bool `json:"authMembershipsUserPhone"`
// Whether or not all existing sessions should be invalidated on password
// change
AuthInvalidateSessions bool `json:"authInvalidateSessions"`
// List of Auth Providers.
OAuthProviders []AuthProvider `json:"oAuthProviders"`
// List of Platforms.
Platforms []interface{} `json:"platforms"`
// List of Webhooks.
Webhooks []Webhook `json:"webhooks"`
// List of API Keys.
Keys []Key `json:"keys"`
// 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"`
// Email/Password auth method status
AuthEmailPassword bool `json:"authEmailPassword"`
// Magic URL auth method status
AuthUsersAuthMagicURL bool `json:"authUsersAuthMagicURL"`
// Email (OTP) auth method status
AuthEmailOtp bool `json:"authEmailOtp"`
// Anonymous auth method status
AuthAnonymous bool `json:"authAnonymous"`
// Invites auth method status
AuthInvites bool `json:"authInvites"`
// JWT auth method status
AuthJWT bool `json:"authJWT"`
// Phone auth method status
AuthPhone bool `json:"authPhone"`
// Account service status
ServiceStatusForAccount bool `json:"serviceStatusForAccount"`
// Avatars service status
ServiceStatusForAvatars bool `json:"serviceStatusForAvatars"`
// Databases (legacy) service status
ServiceStatusForDatabases bool `json:"serviceStatusForDatabases"`
// TablesDB service status
ServiceStatusForTablesdb bool `json:"serviceStatusForTablesdb"`
// Locale service status
ServiceStatusForLocale bool `json:"serviceStatusForLocale"`
// Health service status
ServiceStatusForHealth bool `json:"serviceStatusForHealth"`
// Project service status
ServiceStatusForProject bool `json:"serviceStatusForProject"`
// Storage service status
ServiceStatusForStorage bool `json:"serviceStatusForStorage"`
// Teams service status
ServiceStatusForTeams bool `json:"serviceStatusForTeams"`
// Users service status
ServiceStatusForUsers bool `json:"serviceStatusForUsers"`
// VCS service status
ServiceStatusForVcs bool `json:"serviceStatusForVcs"`
// Sites service status
ServiceStatusForSites bool `json:"serviceStatusForSites"`
// Functions service status
ServiceStatusForFunctions bool `json:"serviceStatusForFunctions"`
// Proxy service status
ServiceStatusForProxy bool `json:"serviceStatusForProxy"`
// GraphQL service status
ServiceStatusForGraphql bool `json:"serviceStatusForGraphql"`
// Migrations service status
ServiceStatusForMigrations bool `json:"serviceStatusForMigrations"`
// Messaging service status
ServiceStatusForMessaging bool `json:"serviceStatusForMessaging"`
// REST protocol status
ProtocolStatusForRest bool `json:"protocolStatusForRest"`
// GraphQL protocol status
ProtocolStatusForGraphql bool `json:"protocolStatusForGraphql"`
// Websocket protocol status
ProtocolStatusForWebsocket bool `json:"protocolStatusForWebsocket"`
// Project region
Region string `json:"region"`
// Billing limits reached
BillingLimits BillingLimits `json:"billingLimits"`
// 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"`
// contains filtered or unexported fields
}
Project Model
type Provider ¶
type Provider struct {
// Provider ID.
Id string `json:"$id"`
// Provider creation time in ISO 8601 format.
CreatedAt string `json:"$createdAt"`
// Provider update date in ISO 8601 format.
UpdatedAt string `json:"$updatedAt"`
// The name for the provider instance.
Name string `json:"name"`
// The name of the provider service.
Provider string `json:"provider"`
// Is provider enabled?
Enabled bool `json:"enabled"`
// Type of provider.
Type string `json:"type"`
// Provider credentials.
Credentials interface{} `json:"credentials"`
// Provider options.
Options interface{} `json:"options"`
// contains filtered or unexported fields
}
Provider Model
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 ProxyRule ¶ added in v3.1.0
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
type ProxyRuleList ¶ added in v3.1.0
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 ¶ added in v3.1.0
func (model *ProxyRuleList) Decode(value interface{}) error
func (ProxyRuleList) New ¶ added in v3.1.0
func (model ProxyRuleList) New(data []byte) *ProxyRuleList
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
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
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"`
// Name of the logo image.
Logo string `json:"logo"`
// List of supported architectures.
Supports []string `json:"supports"`
// contains filtered or unexported fields
}
Runtime Model
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
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"`
// 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"`
// 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
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
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
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
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
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
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
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
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
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
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 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"`
// 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
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
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
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 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
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
¶
- activityEvent.go
- activityEventList.go
- algoArgon2.go
- algoBcrypt.go
- algoMd5.go
- algoPhpass.go
- algoScrypt.go
- algoScryptModified.go
- algoSha.go
- attributeBigint.go
- attributeBoolean.go
- attributeDatetime.go
- attributeEmail.go
- attributeEnum.go
- attributeFloat.go
- attributeInteger.go
- attributeIp.go
- attributeLine.go
- attributeList.go
- attributeLongtext.go
- attributeMediumtext.go
- attributePoint.go
- attributePolygon.go
- attributeRelationship.go
- attributeString.go
- attributeText.go
- attributeUrl.go
- attributeVarchar.go
- authProvider.go
- backupArchive.go
- backupArchiveList.go
- backupPolicy.go
- backupPolicyList.go
- backupRestoration.go
- backupRestorationList.go
- billingLimits.go
- block.go
- bucket.go
- bucketList.go
- collection.go
- collectionList.go
- columnBigint.go
- columnBoolean.go
- columnDatetime.go
- columnEmail.go
- columnEnum.go
- columnFloat.go
- columnIndex.go
- columnIndexList.go
- columnInteger.go
- columnIp.go
- columnLine.go
- columnList.go
- columnLongtext.go
- columnMediumtext.go
- columnPoint.go
- columnPolygon.go
- columnRelationship.go
- columnString.go
- columnText.go
- columnUrl.go
- columnVarchar.go
- continent.go
- continentList.go
- country.go
- countryList.go
- currency.go
- currencyList.go
- database.go
- databaseList.go
- deployment.go
- deploymentList.go
- devKey.go
- document.go
- documentList.go
- emailTemplate.go
- emailTemplateList.go
- ephemeralKey.go
- execution.go
- executionList.go
- file.go
- fileList.go
- framework.go
- frameworkAdapter.go
- frameworkList.go
- function.go
- functionList.go
- headers.go
- healthAntivirus.go
- healthCertificate.go
- healthQueue.go
- healthStatus.go
- healthStatusList.go
- healthTime.go
- identity.go
- identityList.go
- index.go
- indexList.go
- jwt.go
- key.go
- keyList.go
- language.go
- languageList.go
- locale.go
- localeCode.go
- localeCodeList.go
- log.go
- logList.go
- membership.go
- membershipList.go
- message.go
- messageList.go
- mfaChallenge.go
- mfaFactors.go
- mfaRecoveryCodes.go
- mfaType.go
- mockNumber.go
- mockNumberList.go
- model_interface.go
- oAuth2Amazon.go
- oAuth2Apple.go
- oAuth2Auth0.go
- oAuth2Authentik.go
- oAuth2Autodesk.go
- oAuth2Bitbucket.go
- oAuth2Bitly.go
- oAuth2Box.go
- oAuth2Dailymotion.go
- oAuth2Discord.go
- oAuth2Disqus.go
- oAuth2Dropbox.go
- oAuth2Etsy.go
- oAuth2Facebook.go
- oAuth2Figma.go
- oAuth2FusionAuth.go
- oAuth2Github.go
- oAuth2Gitlab.go
- oAuth2Google.go
- oAuth2Keycloak.go
- oAuth2Kick.go
- oAuth2Linkedin.go
- oAuth2Microsoft.go
- oAuth2Notion.go
- oAuth2Oidc.go
- oAuth2Okta.go
- oAuth2Paypal.go
- oAuth2Podio.go
- oAuth2ProviderList.go
- oAuth2Salesforce.go
- oAuth2Slack.go
- oAuth2Spotify.go
- oAuth2Stripe.go
- oAuth2Tradeshift.go
- oAuth2Twitch.go
- oAuth2WordPress.go
- oAuth2X.go
- oAuth2Yahoo.go
- oAuth2Yandex.go
- oAuth2Zoho.go
- oAuth2Zoom.go
- phone.go
- phoneList.go
- platformAndroid.go
- platformApple.go
- platformLinux.go
- platformList.go
- platformWeb.go
- platformWindows.go
- policyList.go
- policyMembershipPrivacy.go
- policyPasswordDictionary.go
- policyPasswordHistory.go
- policyPasswordPersonalData.go
- policySessionAlert.go
- policySessionDuration.go
- policySessionInvalidation.go
- policySessionLimit.go
- policyUserLimit.go
- preferences.go
- project.go
- provider.go
- providerList.go
- proxyRule.go
- proxyRuleList.go
- resourceToken.go
- resourceTokenList.go
- row.go
- rowList.go
- runtime.go
- runtimeList.go
- session.go
- sessionList.go
- site.go
- siteList.go
- specification.go
- specificationList.go
- subscriber.go
- subscriberList.go
- table.go
- tableList.go
- target.go
- targetList.go
- team.go
- teamList.go
- token.go
- topic.go
- topicList.go
- transaction.go
- transactionList.go
- user.go
- userList.go
- variable.go
- variableList.go
- webhook.go
- webhookList.go