Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Classes

Interfaces

Type Aliases

Variables

Type Aliases

ActionTriggerType: { 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: "condition" | "resource" | "interval" | "schedule" | "mqtt_topic"
ActionTypeParams: { 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: ArrayBufferTypes[keyof ArrayBufferTypes]
ArrayBufferView: TypedArray | DataView
AxiosRequestHeaders: Record<string, string | number | boolean>
AxiosResponseHeaders: Record<string, string> & { set-cookie?: string[] }
BillingAddOn: "mobile" | "custom_dns"
BillingAddOnPrices: { name: BillingAddOn; price: number }[]
BillingAllServicePrices: Record<BillingService, BillingServicePrice[]>
BillingCoupon: { 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

    Amount off the original value.

    Only one of amount_off and percentage_off will not be null.

  • applies_to: (Exclude<BillingPlan, "free"> | BillingService | BillingAddOn)[] | null

    Services, plans, and add-ons the coupon is applicable to. Applies to everything when null.

  • code: string

    Coupon promotional code (if customer-facing) or coupon name.

  • duration_cycles: number | "forever" | "once"

    Duration cycles for the coupon.

    Number is months, once means the coupon is only valid for one purchase or one billing.

  • percentage_off: number | null

    Percentage off the original value.

    Only one of amount_off and percentage_off will not be null.

  • Optional restrictions?: { minimum_order_value: number | null; only_first_time: boolean }

    Restrictions for coupon usage.

    • minimum_order_value: number | null

      Minimum value of the purchase so this coupon is applicable.

    • only_first_time: boolean

      Whether the coupon can only be used on the first purchase.

BillingEditResourceAllocation: Partial<Omit<BillingProfileResourceAllocation, "updated_at">>[]
BillingEditSubscription: { addons?: Partial<BillingSubscriptionAddOns>; coupon?: string; plan?: BillingPlan; services?: Partial<BillingSubscriptionServices> }

Type declaration

  • Optional addons?: Partial<BillingSubscriptionAddOns>

    New add-ons in the account's subscription.

    Only one of plan, services and addons is accepted.

  • Optional coupon?: string

    Coupon code.

  • Optional plan?: BillingPlan

    New account plan.

    Only one of plan, services and addons is accepted.

  • Optional services?: Partial<BillingSubscriptionServices>

    New limits for each service in the account's subscription.

    Only one of plan, services and addons is accepted.

BillingInformation: { 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

  • account: GenericID

    Account ID.

  • city: string | null

    City registered in account's billing information.

  • comments: string | null

    Extra information to be attached to the invoice for tax and other purposes.

  • company: string

    Company registered in account's billing information.

  • country: string | null

    Country registered in account's billing information.

  • payment_method: BillingPaymentMethod | null

    Payment method registered in account's billing information.

  • state: string | null

    State registered in account's billing information.

  • street: string | null

    Street address registered in account's billing information.

  • updated_at: string

    Timestamp when the billing information was last updated.

  • zip_code: string | null

    Zip code registered in account's billing information.

BillingPaymentError: { details: string | null; message: string | null }

Type declaration

  • details: string | null

    More details on the payment error.

  • message: string | null

    Payment error message.

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

    Information for the credit card used to pay the invoice.

  • created_at: string

    Timestamp for when the invoice was created.

  • currency: string

    Currency used for the invoice.

  • Optional invoice_number?: string | null

    Number of the invoice in Stripe for identification.

    May be null if Stripe does not provide it at the moment of the request.

  • paid: boolean

    Whether the invoice was paid.

  • Optional receipt_url?: string | null

    URL to download the invoice and receipt on Stripe.

    May be null if Stripe does not provide it at the moment of the request.

  • status: string

    Payment status of the invoice.

  • stripe_id: string

    Stripe ID for the history entry. Used for pagination.

  • total: number

    Total cost of the invoice.

BillingPaymentMethod: { balance?: BillingPaymentMethodBalance; card: BillingPaymentMethodCard | null; coupon?: BillingCoupon }

Type declaration

BillingPaymentMethodBalance: { amount: number; currency: string }

Type declaration

  • amount: number

    Amount of credit in balance.

  • currency: string

    Currency of the credit balance.

BillingPaymentMethodCard: { brand: string; exp_month: number; exp_year: number; funding: string; last4: string; name: string }

Type declaration

  • brand: string

    Credit card brand.

  • exp_month: number

    Credit card's expiration month.

  • exp_year: number

    Credit card's expiration year.

  • funding: string

    Credit card funding type.

  • last4: string

    Credit card's last four digits.

  • name: string

    Name on the credit card.

BillingPaymentPastDue: { amount_due: number; attempt_count: number; invoice_url: string }

Type declaration

  • amount_due: number

    Amount due that was not paid in a recurring payment.

  • attempt_count: number

    Amount of attempts for the retried recurring payment.

  • invoice_url: string

    URL for the invoice related to the failed recurring payment.

BillingPlan: "free" | "starter" | "scale"
BillingPlanPrices: { name: BillingPlan; price: number }[]
BillingPrices: { addons: BillingAddOnPrices; plans: BillingPlanPrices } & BillingAllServicePrices
BillingProfileResourceAllocation: { profile: GenericID; updated_at: string } & BillingResourceAllocationServices
BillingResourceAllocation: BillingProfileResourceAllocation[]
BillingResourceAllocationServices: Record<BillingService, number>
BillingSchedule: { account: GenericID; release_at: string | null; subscription?: BillingSubscriptionSchedule }

Type declaration

  • account: GenericID

    Account ID.

  • release_at: string | null

    When the schedule will be applied to the subscription.

  • Optional subscription?: BillingSubscriptionSchedule

    Scheduled subscription changes.

BillingService: "input" | "output" | "analysis" | "data_records" | "sms" | "email" | "run_users" | "push_notification" | "file_storage"
BillingServicePrice: { amount: number; price: number }

Type declaration

  • amount: number

    Amount available in the service tier.

  • price: number

    Price for the service tier.

BillingServiceSubscription: { limit: number }

Type declaration

  • limit: number
BillingServiceSubscriptionSchedule: Record<BillingService, BillingServiceSubscription & { proportional_change?: number }>
BillingSubscription: { account: GenericID; addons: BillingSubscriptionAddOns; current_cycle: { end: string; start: string }; past_due?: BillingPaymentPastDue; payment_error?: BillingPaymentError; plan: BillingPlan; processing: boolean; services: BillingSubscriptionServices; trial_end: string | null; upcoming_invoice_total: number }

Type declaration

  • account: GenericID

    Account ID.

  • addons: BillingSubscriptionAddOns

    Add-ons in the account's subscription.

  • current_cycle: { end: string; start: string }

    Current cycle for the account's subscription.

    • end: string

      Date when the current cycle ends.

    • start: string

      Date when the current cycle started.

  • Optional past_due?: BillingPaymentPastDue

    Past due information for recurring payment errors.

  • Optional payment_error?: BillingPaymentError

    Payment errors in the account's subscription.

  • plan: BillingPlan

    Account plan.

  • processing: boolean

    Whether changes are still being processed and awaiting response from Stripe.

  • services: BillingSubscriptionServices

    Limits for each service in the account's subscription.

  • trial_end: string | null

    Timestamp when the trial for the subscription ends if the subscription has a trial active.

  • upcoming_invoice_total: number

    Value of the upcoming invoice.

BillingSubscriptionAddOns: Record<BillingAddOn, GenericID[]>
BillingSubscriptionSchedule: { addons?: Partial<BillingSubscriptionAddOns>; plan?: BillingPlan; services?: BillingServiceSubscriptionSchedule }

Type declaration

BillingSubscriptionServices: Record<BillingService, BillingServiceSubscription>
BillingSubscriptionSummary: { not_enough_balance: boolean; past_due: boolean; payment_error: BillingPaymentError | null; processing: boolean; schedule: boolean }

Type declaration

  • not_enough_balance: boolean

    Whether the subscription does not have enough account balance for the next recurring payment without a credit card on record.

  • past_due: boolean

    Whether the subscription has a failing recurring payment.

  • payment_error: BillingPaymentError | null

    Payment errors in the account's subscription.

  • processing: boolean

    Whether the subscription has an operation still being processed.

  • schedule: boolean

    Whether the subscription has scheduled downgrades.

BucketInfoImmutable: Omit<BucketInfoBasic, "data_retention" | "data_retention_ignore"> & { chunk_period: ChunkPeriod; chunk_retention: number; type: "immutable" }
BucketInfoLegacy: Omit<BucketInfoBasic, "chunk_period" | "chunk_retention"> & { data_retention: string; data_retention_ignore: []; type: "legacy" }
deprecated
BucketInfoMutable: Omit<BucketInfoBasic, "chunk_period" | "chunk_retention" | "data_retention" | "data_retention_ignore"> & { type: "mutable" }
BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"
ChunkPeriod: "day" | "week" | "month" | "quarter"
ConnectorQuery: Query<ConnectorInfo, "name" | "id" | "description" | "logo_url" | "install_text" | "install_end_text" | "device_annotation" | "payload_decoder" | "networks">
DataQueryAggregation: Omit<DataQueryBase, "start_date"> & { query: "avg" | "sum"; start_date: Date | string }
DataQueryDefault: DataQueryBase & { details?: boolean; ordination?: "descending" | "ascending"; qty?: number; query?: "default"; skip?: number }
DataQueryFirstLast: DataQueryBase & { query: "last_item" | "last_value" | "last_location" | "last_insert" | "first_item" | "first_value" | "first_location" | "first_insert" }
DataQuerySummary: DataQueryBase & { query: "min" | "max" | "count" }
DateFixed: { date?: string | Date }

Type declaration

  • Optional date?: string | Date

    Timestamp for fetching the hourly statistics in a day.

DateRange: { end_date: string | Date; periodicity: "hour" | "day" | "month"; start_date: string | Date }

Type declaration

  • end_date: string | Date

    End date for fetching statistics in a interval.

  • periodicity: "hour" | "day" | "month"

    Periodicity of the statistics to fetch.

    default

    "hour"

  • start_date: string | Date

    Starting date for fetching statistics in a interval.

DeviceResourceView: ResourceTag | ResourceParam | "name" | "id" | "bucket_name" | "network_name" | "connector_name" | "connector" | "network" | "bucket" | "last_input" | "created_at" | "active"
EmailWithHTML: EmailBase & EmailHTML
EmailWithRawText: EmailBase & EmailRawText
Exclude<T, U>: T extends U ? never : T

Exclude from T those types that are assignable to U

Type Parameters

  • T

  • U

Extract<T, U>: T extends U ? T : never

Extract from T those types that are assignable to U

Type Parameters

  • T

  • U

FileURL: string
IteratorResult<T, TReturn>: IteratorYieldResult<T> | IteratorReturnResult<TReturn>

Type Parameters

  • T

  • TReturn = any

LocationGeoJSON: { coordinates: number[]; type: "Point" }

Type declaration

  • coordinates: number[]
  • type: "Point"
LocationLatLng: { lat: number; lng: number }

Type declaration

  • lat: number
  • lng: number
Method: "get" | "GET" | "delete" | "DELETE" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH" | "purge" | "PURGE" | "link" | "LINK" | "unlink" | "UNLINK"
NetworkQuery: 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<T, K>: Pick<T, Exclude<keyof T, K>>

Construct a type with the properties of T except for those in type K.

Type Parameters

  • T

  • K extends keyof any

Partial<T>: { [ P in keyof T]?: T[P] }

Make all properties in T optional

Type Parameters

  • T

Pick<T, K>: { [ P in K]: T[P] }

From T, pick a set of properties whose keys are in the union K

Type Parameters

  • T

  • K extends keyof T

Record<K, T>: { [ P in K]: T }

Construct a type with a set of properties K of type T

Type Parameters

  • K extends keyof any

  • T

Regions: "usa-1" | "env"
Required<T>: { [ P in keyof T]-?: T[P] }

Make all properties in T required

Type Parameters

  • T

ResourceParam: `param.${string}`
ResourceTag: `tags.${string}`
ResponseType: "arraybuffer" | "blob" | "document" | "json" | "text" | "stream"
Scope: (Data | DeviceCreateInfo | { input_form_button_id: string } | MQTTResourceAction)[]
TagTypes: "bucket" | "device" | "dashboard" | "action" | "analysis" | "tcore"
TagoCoreClusterQuery: Query<TagoCoreClusterInfo, "name" | "created_at" | "updated_at">
TagoCoreQuery: Query<TagoCoreInfo, "name" | "active" | "created_at" | "updated_at" | "last_connection" | "local_ips" | "internet_ip" | "system_start_time" | "tcore_start_time" | "machine_id">
TypedArray: Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | BigUint64Array | BigInt64Array | Float32Array | Float64Array
WithImplicitCoercion<T>: T | { valueOf: any }

Type Parameters

  • T

resourceNameType: "action" | "am" | "analysis" | "connector" | "dashboard" | "device" | "dictionary" | "network" | "profile" | "run" | "runuser"
widgetOverwriteOptions: "start_date" | "end_date" | "timezone"

Variables

SharedArrayBuffer: SharedArrayBufferConstructor