Type Aliases
ActionTriggerType
Action
Trigger
Type
: { resource
: "device" | "bucket" | "file" | "analysis" | "action" | "am" | "user" | "financial" | "profile"; tag_key
: string; tag_value
: string; when
: "create" | "update" | "delete" } | { interval
: string } | { cron
: string; timezone
: string | Date } | { device
: string; is
: Conditionals; second_value
?: string; unlock
?: boolean; value
: string; value_type
: "string" | "number" | "boolean" | "*"; variable
: string }ActionType
ActionType: "condition" | "resource" | "interval" | "schedule" | "mqtt_topic"
ActionTypeParams
Action
Type
Params
: { script
: GenericID[]; type
: "script" } | { message
: string; subject
: string; type
: "notification" } | { message
: string; run_user
: GenericID; subject
: string; type
: "notification_run" } | { message
: string; subject
: string; to
: string; type
: "email" } | { message
: string; to
: string; type
: "sms" } | { bucket
: string; payload
: string; topic
: string; type
: "mqtt" } | { headers
: {}; type
: "post"; url
: string }ArrayBufferLike
ArrayBufferLike: ArrayBufferTypes[keyof ArrayBufferTypes]
ArrayBufferView
AxiosRequestHeaders
Axios
Request
Headers
: Record<string, string | number | boolean>AxiosResponseHeaders
Axios
Response
Headers
: Record<string, string> & { set-cookie
?: string[] }BillingAddOn
BillingAddOn: "mobile" | "custom_dns"
BillingCoupon
Billing
Coupon
: { amount_off
: number | null; applies_to
: (Exclude<BillingPlan, "free"> | BillingService | BillingAddOn)[] | null; code
: string; duration_cycles
: number | "forever" | "once"; percentage_off
: number | null; restrictions
?: { minimum_order_value
: number | null; only_first_time
: boolean } }Type declaration
amount_off: number | null
code: string
duration_cycles: number | "forever" | "once"
percentage_off: number | null
Optional restrictions?: { minimum_order_value: number | null; only_first_time: boolean }
minimum_order_value: number | null
only_first_time: boolean
BillingEditResourceAllocation
BillingInformation
Billing
Information
: { account
: GenericID; city
: string | null; comments
: string | null; company
: string; country
: string | null; payment_method
: BillingPaymentMethod | null; state
: string | null; street
: string | null; updated_at
: string; zip_code
: string | null }Type declaration
city: string | null
comments: string | null
company: string
country: string | null
state: string | null
street: string | null
updated_at: string
zip_code: string | null
BillingPaymentError
BillingPaymentError: { details: string | null; message: string | null }
Type declaration
details: string | null
message: string | null
BillingPaymentHistoryEntry
BillingPaymentHistoryEntry: { card: { brand: string | null; last4: string | null } | null; created_at: string; currency: string; invoice_number?: string | null; paid: boolean; receipt_url?: string | null; status: string; stripe_id: string; total: number }
Type declaration
card: { brand: string | null; last4: string | null } | null
created_at: string
currency: string
Optional invoice_number?: string | null
paid: boolean
Optional receipt_url?: string | null
status: string
stripe_id: string
total: number
BillingPaymentMethodBalance
BillingPaymentMethodBalance: { amount: number; currency: string }
Type declaration
amount: number
currency: string
BillingPaymentMethodCard
BillingPaymentMethodCard: { brand: string; exp_month: number; exp_year: number; funding: string; last4: string; name: string }
Type declaration
brand: string
exp_month: number
exp_year: number
funding: string
last4: string
name: string
BillingPaymentPastDue
BillingPaymentPastDue: { amount_due: number; attempt_count: number; invoice_url: string }
Type declaration
amount_due: number
attempt_count: number
invoice_url: string
BillingPlan
BillingPlan: "free" | "starter" | "scale"
BillingPlanPrices
Billing
Plan
Prices
: { name
: BillingPlan; price
: number }[]BillingProfileResourceAllocation
BillingResourceAllocation
BillingResourceAllocationServices
BillingSchedule
Type declaration
release_at: string | null
BillingService
BillingService: "input" | "output" | "analysis" | "data_records" | "sms" | "email" | "run_users" | "push_notification" | "file_storage"
BillingServicePrice
BillingServicePrice: { amount: number; price: number }
Type declaration
amount: number
price: number
BillingServiceSubscription
BillingServiceSubscription: { limit: number }
BillingServiceSubscriptionSchedule
BillingSubscription
Type declaration
current_cycle: { end: string; start: string }
processing: boolean
trial_end: string | null
upcoming_invoice_total: number
BillingSubscriptionAddOns
BillingSubscriptionSchedule
BillingSubscriptionServices
BillingSubscriptionSummary
Billing
Subscription
Summary
: { not_enough_balance
: boolean; past_due
: boolean; payment_error
: BillingPaymentError | null; processing
: boolean; schedule
: boolean }Type declaration
not_enough_balance: boolean
past_due: boolean
processing: boolean
schedule: boolean
BucketInfoImmutable
Bucket
Info
Immutable
: Omit<BucketInfoBasic, "data_retention" | "data_retention_ignore"> & { chunk_period
: ChunkPeriod; chunk_retention
: number; type
: "immutable" }BucketInfoLegacy
Bucket
Info
Legacy
: Omit<BucketInfoBasic, "chunk_period" | "chunk_retention"> & { data_retention
: string; data_retention_ignore
: []; type
: "legacy" }BucketInfoMutable
Bucket
Info
Mutable
: Omit<BucketInfoBasic, "chunk_period" | "chunk_retention" | "data_retention" | "data_retention_ignore"> & { type
: "mutable" }BufferEncoding
BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"
ChunkPeriod
ChunkPeriod: "day" | "week" | "month" | "quarter"
ConnectorQuery
Connector
Query
: Query<ConnectorInfo, "name" | "id" | "description" | "logo_url" | "install_text" | "install_end_text" | "device_annotation" | "payload_decoder" | "networks">DataQueryAggregation
Data
Query
Aggregation
: Omit<DataQueryBase, "start_date"> & { query
: "avg" | "sum"; start_date
: Date | string }DataQueryDefault
Data
Query
Default
: DataQueryBase & { details
?: boolean; ordination
?: "descending" | "ascending"; qty
?: number; query
?: "default"; skip
?: number }DataQueryFirstLast
Data
Query
First
Last
: DataQueryBase & { query
: "last_item" | "last_value" | "last_location" | "last_insert" | "first_item" | "first_value" | "first_location" | "first_insert" }DataQuerySummary
Data
Query
Summary
: DataQueryBase & { query
: "min" | "max" | "count" }DateFixed
DateFixed: { date?: string | Date }
Type declaration
Optional date?: string | Date
DateRange
DateRange: { end_date: string | Date; periodicity: "hour" | "day" | "month"; start_date: string | Date }
Type declaration
end_date: string | Date
periodicity: "hour" | "day" | "month"
start_date: string | Date
DeviceResourceView
Device
Resource
View
: ResourceTag | ResourceParam | "name" | "id" | "bucket_name" | "network_name" | "connector_name" | "connector" | "network" | "bucket" | "last_input" | "created_at" | "active"Exclude
Exclude<T, U>: T extends U ? never : T
Type Parameters
Extract
Extract<T, U>: T extends U ? T : never
Type Parameters
IteratorResult
Type Parameters
LocationGeoJSON
LocationGeoJSON: { coordinates: number[]; type: "Point" }
Type declaration
coordinates: number[]
type: "Point"
LocationLatLng
LocationLatLng: { lat: number; lng: number }
Method
Method: "get" | "GET" | "delete" | "DELETE" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH" | "purge" | "PURGE" | "link" | "LINK" | "unlink" | "UNLINK"
NetworkQuery
Network
Query
: Query<NetworkInfo, "name" | "description" | "logo_url" | "icon_url" | "banner_url" | "device_parameters" | "middleware_endpoint" | "payload_encoder" | "payload_decoder" | "serial_number" | "documentation_url" | "public" | "created_at" | "updated_at">Omit
Type Parameters
Partial
Partial<T>: { [ P in keyof T]?: T[P] }
Type Parameters
Pick
Pick<T, K>: { [ P in K]: T[P] }
Type Parameters
Record
Record<K, T>: { [ P in K]: T }
Type Parameters
Regions
Regions: "usa-1" | "env"
Required
Required<T>: { [ P in keyof T]-?: T[P] }
Type Parameters
ResourceParam
ResourceParam: `param.${string}`
ResourceTag
ResourceTag: `tags.${string}`
ResponseType
ResponseType: "arraybuffer" | "blob" | "document" | "json" | "text" | "stream"
TagTypes
TagTypes: "bucket" | "device" | "dashboard" | "action" | "analysis" | "tcore"
TagoCoreQuery
Tago
Core
Query
: Query<TagoCoreInfo, "name" | "active" | "created_at" | "updated_at" | "last_connection" | "local_ips" | "internet_ip" | "system_start_time" | "tcore_start_time" | "machine_id">TypedArray
TypedArray: Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | BigUint64Array | BigInt64Array | Float32Array | Float64Array
WithImplicitCoercion
WithImplicitCoercion<T>: T | { valueOf: any }
Type Parameters
resourceNameType
resourceNameType: "action" | "am" | "analysis" | "connector" | "dashboard" | "device" | "dictionary" | "network" | "profile" | "run" | "runuser"
widgetOverwriteOptions
widgetOverwriteOptions: "start_date" | "end_date" | "timezone"
Amount off the original value.
Only one of
amount_off
andpercentage_off
will not benull
.