particle-api-js 11.1.7 → 12.0.1

package/lib/src/types/responses.d.ts

@@ -0,0 +1,449 @@
+import type { PaginationMeta } from './common';
+export interface LoginResponse {
+    token_type: 'bearer';
+    access_token: string;
+    expires_in: number;
+    refresh_token: string;
+}
+export interface MfaRequiredResponse {
+    error: 'mfa_required';
+    error_description: string;
+    mfa_token: string;
+}
+export interface AccessTokenInfo {
+    token: string;
+    expires_at: string;
+    client: string;
+}
+export interface CurrentTokenInfo {
+    expires_at: string;
+    client_id: string;
+    scopes: string[];
+    orgs: Array<{
+        id: string;
+        slug: string;
+    }>;
+}
+export interface AccountInfo {
+    first_name?: string;
+    last_name?: string;
+    business_account?: boolean;
+    company_name?: string;
+}
+export interface MfaStatus {
+    enabled: boolean;
+}
+export interface TeamMember {
+    username: string;
+    friendly_name?: string;
+    no_mfa?: boolean;
+    scopes?: string[];
+    is_programmatic?: boolean;
+    product_id?: number | null;
+}
+export interface UserInfo {
+    username: string;
+    tos: number;
+    account_info: AccountInfo;
+    mfa: MfaStatus;
+    memberships: object[];
+    scim_provisioned: boolean;
+    no_password: boolean;
+    wifi_device_count: number;
+    cellular_device_count: number;
+}
+export interface DeviceInfo {
+    id: string;
+    name: string;
+    last_app: string | null;
+    last_heard: string | null;
+    last_handshake_at: string | null;
+    online: boolean;
+    connected: boolean;
+    platform_id: number;
+    cellular: boolean;
+    product_id: number;
+    functions?: string[];
+    variables?: Record<string, string>;
+    firmware_version?: number;
+    quarantined?: boolean;
+    groups?: string[];
+    denied?: boolean;
+    notes?: string | null;
+}
+export interface DeviceListResponse {
+    devices: DeviceInfo[];
+    meta?: PaginationMeta;
+}
+export interface DeviceVariableResponse {
+    name: string;
+    result: string | number | boolean;
+    coreInfo: {
+        name: string;
+        deviceID: string;
+        connected: boolean;
+        last_handshake_at: string;
+    };
+}
+export interface FunctionCallResponse {
+    id: string;
+    name: string;
+    connected: boolean;
+    return_value: number;
+}
+export interface ClaimResponse {
+    ok: boolean;
+    deviceID: string;
+    claimed: boolean;
+}
+export interface CompileResponse {
+    ok: boolean;
+    binary_id: string;
+    binary_url: string;
+    expires_at: string;
+    sizeInfo: string;
+}
+export interface ProductFirmwareInfo {
+    version: number;
+    title: string;
+    description?: string;
+    size: number;
+    device_count: number;
+    current: boolean;
+    uploaded_at: string;
+}
+export interface EventData {
+    data: string;
+    ttl: number;
+    published_at: string;
+    coreid: string;
+    name?: string;
+    userid?: string;
+    version?: number;
+    productID?: number;
+}
+export interface WebhookInfo {
+    id: string;
+    event: string;
+    created_at: string;
+    url: string;
+    requestType: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    name?: string | null;
+    deviceID?: string;
+    disabled?: boolean;
+}
+export interface CreateWebhookResponse {
+    ok: boolean;
+    id: string;
+    url: string;
+    event: string;
+    name: string | null;
+    created_at: string;
+    hookUrl: string;
+}
+export interface IntegrationInfo {
+    id: string;
+    event: string;
+    created_at: string;
+    integration_type: string;
+    url: string;
+    requestType: string;
+}
+export interface ProductSettings {
+    location?: object;
+    known_application?: {
+        opt_in: boolean;
+    };
+    quarantine?: boolean;
+}
+export interface ProductInfo {
+    id: number;
+    platform_id: number;
+    name: string;
+    slug: string;
+    description?: string;
+    user?: string;
+    org?: string;
+    organization_id?: string;
+    groups?: string[];
+    settings?: ProductSettings;
+    device_protection?: string;
+}
+export interface SimInfo {
+    iccid: string;
+    status: 'active' | 'inactive' | 'deactivated';
+    base_country_code?: string;
+    last_status_change_action?: string;
+    activated_on?: string;
+    device_id?: string;
+    device_name?: string;
+    carrier?: string;
+}
+export interface SimDataUsage {
+    usage_by_day: Array<{
+        date: string;
+        mbs_used: number;
+        mbs_used_cumulative: number;
+    }>;
+    quota: number;
+    used: number;
+}
+export interface OAuthClientInfo {
+    name: string;
+    type: 'installed' | 'web';
+    id: string;
+    secret?: string;
+    product_id?: number;
+}
+export interface BuildTarget {
+    platforms: number[];
+    prereleases: number[];
+    firmware_vendor: string;
+    version: string;
+}
+export interface BuildTargetsResponse {
+    targets: BuildTarget[];
+    platforms: Record<string, number>;
+    default_versions: Record<string, string>;
+}
+export interface LogicTrigger {
+    id: string;
+    type: 'Scheduled' | 'Event';
+    logic_function_id: string;
+    enabled: boolean;
+    version: number;
+    cron?: string;
+    start_at?: string;
+    end_at?: string | null;
+    last_scheduled_at?: string;
+    next_unscheduled_at?: string;
+    product_id?: number;
+    event?: string;
+}
+export interface LogicFunctionSource {
+    type: 'JavaScript';
+    code: string;
+}
+export interface LogicFunctionStats {
+    success: number;
+    failure: number;
+    timeout: number;
+}
+export interface LogicFunction {
+    id: string;
+    owner_id: string;
+    version: number;
+    enabled: boolean;
+    name: string;
+    description: string;
+    template_slug: string | null;
+    source: LogicFunctionSource;
+    created_at: string;
+    updated_at: string;
+    created_by: string;
+    updated_by: string;
+    logic_triggers: LogicTrigger[];
+    today_stats?: LogicFunctionStats;
+    org_slug?: string;
+}
+export interface LogicRun {
+    id: string;
+    owner_id: string;
+    logic_function_id: string;
+    logic_trigger_type: string;
+    logic_trigger_id: string;
+    status: 'Success' | 'Failure' | 'Timeout';
+    started_at: string;
+    finished_at: string;
+    log_filename: string;
+}
+export interface LogicRunLog {
+    level: 'Info' | 'Warning' | 'Error';
+    timestamp: string;
+    args: (string | number | boolean | object | null)[];
+}
+export interface ExecuteLogicResponse {
+    result: {
+        status: 'Success' | 'Failure';
+        logs: LogicRunLog[];
+    };
+}
+export interface LedgerScope {
+    type: 'Owner' | 'Device' | 'Product';
+    value: string;
+    name?: string;
+    not_owned?: boolean;
+}
+export interface LedgerDefinition {
+    scope: 'Owner' | 'Device' | 'Product';
+    name: string;
+    description: string;
+    direction: 'Upstream' | 'Downstream';
+    updated_at: string;
+    created_at: string;
+    archived_at: string | null;
+}
+export interface LedgerInstance {
+    name: string;
+    scope: LedgerScope;
+    size_bytes: number;
+    data: Record<string, string | number | boolean | object | null>;
+    updated_at: string;
+    created_at: string;
+    replaced_at?: string;
+}
+export interface LedgerInstanceListResponse {
+    instances: LedgerInstance[];
+    meta: PaginationMeta;
+}
+export interface LedgerVersionListResponse {
+    versions: LedgerInstance[];
+    meta: {
+        has_more: boolean;
+    };
+}
+export interface LocationGeometry {
+    type: 'Point' | 'LineString';
+    coordinates: number[] | number[][];
+}
+export interface DeviceLocationInfo {
+    device_id: string;
+    product_id: number;
+    device_name?: string;
+    groups?: string[];
+    gps_lock: boolean;
+    last_heard: string;
+    timestamps?: string[];
+    online: boolean;
+    geometry: LocationGeometry;
+}
+export interface LocationListResponse {
+    locations: DeviceLocationInfo[];
+    meta: PaginationMeta & {
+        devices_found: number;
+    };
+}
+export interface LibraryAttributes {
+    name: string;
+    version: string;
+    author: string;
+    sentence?: string;
+    paragraph?: string;
+    url?: string;
+    repository?: string;
+    architectures?: string[];
+    visibility?: string;
+    mine?: boolean;
+}
+export interface LibraryInfo {
+    id: string;
+    type: string;
+    attributes: LibraryAttributes;
+    links?: {
+        download?: string;
+    };
+}
+export interface DeviceOsVersion {
+    version: string;
+    platform_id: number;
+    release_date?: string;
+    module_version?: number;
+}
+export interface EnableMfaResponse {
+    mfa_token: string;
+    qr_url: string;
+    secret?: string;
+}
+export interface ConfirmMfaResponse {
+    enrolled: boolean;
+    tokens?: string[];
+}
+export interface CreateCustomerResponse {
+    token_type: string;
+    access_token: string;
+    expires_in: number;
+    refresh_token: string;
+}
+export interface TrackingIdentityResponse {
+    id: string;
+    email: string;
+}
+export interface ClaimCodeResponse {
+    claim_code: string;
+    device_ids: string[];
+}
+export interface SerialNumberResponse {
+    serial_number: string;
+    device_id: string;
+    platform_id?: number;
+}
+export interface ProductConfigurationResponse {
+    configuration: Record<string, string | number | boolean | object | null>;
+    [key: string]: string | number | boolean | object | null | undefined;
+}
+export interface EnvVarValue {
+    value: string;
+}
+export interface EnvVarInherited {
+    from: 'Owner' | 'Product' | 'Firmware';
+    value: string;
+}
+export interface EnvVarsOnDevice {
+    rendered: Record<string, string>;
+    last_reported_at: string;
+    development_env?: boolean;
+}
+export interface EnvVarsSnapshot {
+    own: Record<string, EnvVarValue>;
+    inherited: Record<string, EnvVarInherited>;
+    rollout_at: string | null;
+    rollout_by: string | null;
+}
+export interface EnvVarsLatest {
+    own: Record<string, EnvVarValue>;
+    inherited: Record<string, EnvVarInherited>;
+    created_at: string | null;
+    updated_at: string | null;
+    created_by: string | null;
+    updated_by: string | null;
+}
+export interface EnvVarsResponse {
+    on_device?: EnvVarsOnDevice;
+    last_snapshot: EnvVarsSnapshot | null;
+    latest: EnvVarsLatest;
+}
+export interface EnvVarsRolloutStartResponse {
+    success: boolean;
+}
+export interface EnvVarsRenderResponse {
+    env: Record<string, string>;
+    last_updated_at: string | null;
+    rollout_at: string | null;
+    rollout_by: string | null;
+}
+export interface EnvVarsRolloutChanged {
+    op: 'Changed';
+    key: string;
+    before: string;
+    after: string;
+}
+export interface EnvVarsRolloutAdded {
+    op: 'Added';
+    key: string;
+    after: string;
+}
+export interface EnvVarsRolloutRemoved {
+    op: 'Removed';
+    key: string;
+    before: string;
+}
+export type EnvVarsRolloutChange = EnvVarsRolloutChanged | EnvVarsRolloutAdded | EnvVarsRolloutRemoved;
+export interface EnvVarsRolloutDiff {
+    changes: EnvVarsRolloutChange[];
+    unchanged: Record<string, string>;
+}
+export interface EnvVarsRolloutResponse {
+    from_snapshot: EnvVarsRolloutDiff;
+    from_device?: EnvVarsRolloutDiff;
+}
+//# sourceMappingURL=responses.d.ts.map

package/lib/src/types/responses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../src/types/responses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE/C,MAAM,WAAW,aAAa;IAC7B,UAAU,EAAE,QAAQ,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IACnC,KAAK,EAAE,cAAc,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,WAAW;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,SAAS;IACzB,OAAO,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,UAAU;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,QAAQ;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,WAAW,CAAC;IAC1B,GAAG,EAAE,SAAS,CAAC;IACf,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,WAAW,EAAE,OAAO,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,UAAU;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IAClC,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAClC,QAAQ,EAAE;QACT,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,OAAO,CAAC;QACnB,iBAAiB,EAAE,MAAM,CAAC;KAC1B,CAAC;CACF;AAED,MAAM,WAAW,oBAAoB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC7B,EAAE,EAAE,OAAO,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC/B,EAAE,EAAE,OAAO,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;IAC/C,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACrC,EAAE,EAAE,OAAO,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,eAAe;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE;QAAE,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC;IACxC,UAAU,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,OAAO;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAC;IAC9C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC5B,YAAY,EAAE,KAAK,CAAC;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,mBAAmB,EAAE,MAAM,CAAC;KAC5B,CAAC,CAAC;IACH,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,eAAe;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,WAAW,GAAG,KAAK,CAAC;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC3B,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACpC,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,YAAY;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC;IAC5B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IACnC,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,kBAAkB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,MAAM,EAAE,mBAAmB,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,YAAY,EAAE,CAAC;IAC/B,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,QAAQ;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;IAC1C,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC3B,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC;CACpD;AAED,MAAM,WAAW,oBAAoB;IACpC,MAAM,EAAE;QACP,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC;QAC9B,IAAI,EAAE,WAAW,EAAE,CAAC;KACpB,CAAC;CACF;AAED,MAAM,WAAW,WAAW;IAC3B,IAAI,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAChC,KAAK,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,UAAU,GAAG,YAAY,CAAC;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,WAAW,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC;IAChE,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,0BAA0B;IAC1C,SAAS,EAAE,cAAc,EAAE,CAAC;IAC5B,IAAI,EAAE,cAAc,CAAC;CACrB;AAED,MAAM,WAAW,yBAAyB;IACzC,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,IAAI,EAAE;QAAE,QAAQ,EAAE,OAAO,CAAA;KAAE,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,OAAO,GAAG,YAAY,CAAC;IAC7B,WAAW,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC;CACnC;AAED,MAAM,WAAW,kBAAkB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,oBAAoB;IACpC,SAAS,EAAE,kBAAkB,EAAE,CAAC;IAChC,IAAI,EAAE,cAAc,GAAG;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,CAAC;CACjD;AAED,MAAM,WAAW,iBAAiB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,iBAAiB,CAAC;IAC9B,KAAK,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9B;AAED,MAAM,WAAW,eAAe;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IAClC,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,wBAAwB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACpC,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,4BAA4B;IAC5C,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC;IACzE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACrE;AAED,MAAM,WAAW,WAAW;IAC3B,KAAK,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,eAAe;IAC/B,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,UAAU,CAAC;IACvC,KAAK,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,eAAe;IAC/B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC/B,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC3C,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,aAAa;IAC7B,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC3C,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC/B,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,aAAa,EAAE,eAAe,GAAG,IAAI,CAAC;IACtC,MAAM,EAAE,aAAa,CAAC;CACtB;AAED,MAAM,WAAW,2BAA2B;IAC3C,OAAO,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACrC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAqB;IACrC,EAAE,EAAE,SAAS,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,mBAAmB;IACnC,EAAE,EAAE,OAAO,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,qBAAqB;IACrC,EAAE,EAAE,SAAS,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,GAAG,mBAAmB,GAAG,qBAAqB,CAAC;AAEvG,MAAM,WAAW,kBAAkB;IAClC,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,sBAAsB;IACtC,aAAa,EAAE,kBAAkB,CAAC;IAClC,WAAW,CAAC,EAAE,kBAAkB,CAAC;CACjC"}

package/lib/src/types/responses.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=responses.js.map

package/lib/src/types/responses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.js","sourceRoot":"","sources":["../../../src/types/responses.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,22 +1,33 @@
 {
   "name": "particle-api-js",
-  "version": "11.1.7",
+  "version": "12.0.1",
   "description": "Particle API Client",
-  "main": "src/Particle.js",
+  "main": "lib/src/Particle.js",
+  "types": "lib/src/Particle.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/src/Particle.d.ts",
+      "require": "./lib/src/Particle.js",
+      "default": "./lib/src/Particle.js"
+    }
+  },
   "scripts": {
-    "prepare": "npm run build",
+    "compile": "tsc -p tsconfig.build.json && cp fs.js fs.d.ts lib/",
+    "prepare": "npm run compile && npm run build",
     "test": "npm run lint && npm run typecheck && npm run test:unit",
     "test:ci": "npm run test:unit -- --forbid-only && npm run coverage",
-    "test:unit": "mocha test/ -R spec",
+    "test:unit": "mocha --require tsx 'test/**/*.spec.ts' 'test/**/*.integration.ts' 'test/**/*.test.ts' -R spec",
     "test:unit:silent": "npm run test:unit > tmp/test-unit-log.txt 2>&1",
-    "test:browser": "karma start --single-run",
-    "test:watch": "npm run test:unit -- --watch",
+    "test:browser": "npm run compile:test && karma start --single-run",
+    "test:watch": "mocha --require tsx 'test/**/*.spec.ts' --watch --watch-files 'src/**/*.ts,test/**/*.ts'",
+    "compile:test": "tsc -p tsconfig.test-browser.json",
     "typecheck": "tsc",
-    "coverage": "nyc --reporter=text --include='src/**/*.js' --temp-dir=./tmp/ --check-coverage --lines 91 npm run test:unit:silent",
+    "coverage": "nyc --reporter=text --temp-dir=./tmp/ --check-coverage --lines 91 npm run test:unit:silent",
     "lint": "eslint",
-    "docs": "documentation build src/Particle.js --shallow -g -f md -o docs/api.md",
-    "build": "webpack --env mode=production",
-    "build-nomin": "webpack --env mode=development",
+    "docs": "typedoc && node scripts/postprocess-docs.js",
+    "build": "npm run compile && webpack --env mode=production",
+    "build-nomin": "npm run compile && webpack --env mode=development",
+    "prepublishOnly": "npm run test && npm run compile && npm run build",
     "preversion": "npm run test && npm run prepare",
     "reinstall": "rm -rf ./node_modules && npm i",
     "version": "npm run build && npm run docs && npm run update-changelog && git add dist/* docs/*",
@@ -50,14 +61,22 @@
     "stream-http": "^3.2.0"
   },
   "devDependencies": {
+    "@types/chai-as-promised": "^8.0.2",
+    "@types/chai-subset": "^1.3.6",
+    "@types/mocha": "^10.0.10",
     "@types/node": "^20.5.9",
+    "@types/node-fetch": "^2.6.13",
+    "@types/qs": "^6.14.0",
+    "@types/sinon": "^21.0.0",
+    "@types/sinon-chai": "^4.0.0",
     "buffer": "^6.0.3",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
-    "documentation": "^4.0.0-rc.1",
+    "chai-subset": "^1.6.0",
     "eslint": "^9.36.0",
     "eslint-config-particle": "^3.0.0",
     "events": "^3.3.0",
+    "https-proxy-agent": "^8.0.0",
     "karma": "^6.4.4",
     "karma-chai": "^0.1.0",
     "karma-cli": "^2.0.0",
@@ -65,13 +84,15 @@
     "karma-firefox-launcher": "^2.1.3",
     "karma-mocha": "^2.0.1",
     "karma-webpack": "^5.0.1",
-    "mocha": "^2.5.1",
+    "mocha": "^10.8.2",
     "nyc": "^15.1.0",
     "process": "^0.11.10",
-    "should": "^9.0.0",
-    "sinon": "^7.2.5",
+    "sinon": "^17.0.1",
     "sinon-chai": "^3.7.0",
     "terser-webpack-plugin": "^5.3.9",
+    "tsx": "^4.21.0",
+    "typedoc": "^0.28.17",
+    "typedoc-plugin-markdown": "^4.10.0",
     "typescript": "^5.9.2",
     "url": "^0.11.3",
     "webpack": "^5.88.2",