Envelope class

Constructors

Envelope({required Object? data, required int cost, required int creditsRemaining, required int rateLimitLimit, required int rateLimitRemaining, required int rateLimitReset, required EnvelopeMeteringEnum metering, required String requestId})

Returns a new Envelope instance.

Properties

cost ↔ int

Credits this call costs.

getter/setter pair

creditsRemaining ↔ int

Wallet balance after the call. Unchanged while metering is preview.

getter/setter pair

data ↔ Object?

The payload. An array on list routes, an object on single-entity routes.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

metering ↔ EnvelopeMeteringEnum

Whether cost was actually deducted.

getter/setter pair

rateLimitLimit ↔ int

Ceiling for the current window. Also returned as X-RateLimit-Limit.

getter/setter pair

rateLimitRemaining ↔ int

Calls left in the current window for this key. Also returned as X-RateLimit-Remaining.

getter/setter pair

rateLimitReset ↔ int

Unix seconds at which the window resets to full ceiling. Also returned as X-RateLimit-Reset.

getter/setter pair

requestId ↔ String

Also returned in the x-request-id header.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override

Static Methods

fromJson(dynamic value) → Envelope?

Returns a new Envelope instance and imports its values from value if it's a Map, null otherwise.

listFromJson(dynamic json, {bool growable = false}) → List<Envelope>

mapFromJson(dynamic json) → Map<String, Envelope>

mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<Envelope>>

Constants

requiredKeys → const Set<String>

The list of required keys that must be present in a JSON.