balena-sdk
Version:
The Balena JavaScript SDK
723 lines (722 loc) • 123 kB
TypeScript
import type { InjectedDependenciesParam, InjectedOptionsParam } from '..';
declare const _default: (deps: InjectedDependenciesParam, opts: InjectedOptionsParam) => {
application: {
_getId: (slugOrUuidOrId: string | number) => Promise<number>;
getDashboardUrl(id: number): string;
getAll<T extends import("pinejs-client-core").ODataOptionsWithoutCount<import("..").Application["Read"]>>(options?: T, context?: "directly_accessible"): Promise<import("pinejs-client-core").OptionsToResponse<import("..").Application["Read"], T, undefined>>;
getAllDirectlyAccessible<T extends import("pinejs-client-core").ODataOptionsWithoutCount<import("..").Application["Read"]>>(options?: T): Promise<import("pinejs-client-core").OptionsToResponse<import("..").Application["Read"], T, undefined>>;
getAllByOrganization<T extends import("pinejs-client-core").ODataOptionsWithoutCount<import("..").Application["Read"]>>(orgHandleOrId: number | string, options?: T): Promise<import("pinejs-client-core").OptionsToResponse<import("..").Application["Read"], T, undefined>>;
get<T extends import("pinejs-client-core").ODataOptionsWithoutCount<import("..").Application["Read"]>>(slugOrUuidOrId: string | number, options?: T, context?: "directly_accessible"): Promise<import("pinejs-client-core").OptionsToResponse<import("..").Application["Read"], T, undefined>[number]>;
getDirectlyAccessible<T extends import("pinejs-client-core").ODataOptionsWithoutCount<import("..").Application["Read"]>>(slugOrUuidOrId: string | number, options?: T): Promise<import("pinejs-client-core").OptionsToResponse<import("..").Application["Read"], T, undefined>[number]>;
getWithDeviceServiceDetails<T extends import("pinejs-client-core").ODataOptionsWithoutCount<import("..").Application["Read"]>>(slugOrUuidOrId: string | number, options?: T): Promise<import("pinejs-client-core").OptionsToResponse<{
created_at: import("@balena/sbvr-types").Types["Date Time"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
actor: {
__id: import("..").Actor["Read"]["id"];
} | [import("..").Actor["Read"]];
should_track_latest_release: import("@balena/sbvr-types").Types["Boolean"]["Read"];
is_of__class: "fleet" | "block" | "app";
organization: {
__id: import("..").Organization["Read"]["id"];
} | [import("..").Organization["Read"]];
app_name: import("@balena/sbvr-types").Types["Text"]["Read"];
slug: import("@balena/sbvr-types").Types["Short Text"]["Read"];
is_for__device_type: {
__id: import("..").DeviceType["Read"]["id"];
} | [import("..").DeviceType["Read"]];
should_be_running__release: {
__id: import("..").Release["Read"]["id"];
} | [import("..").Release["Read"]] | [] | null;
application_type: {
__id: import("..").ApplicationType["Read"]["id"];
} | [import("..").ApplicationType["Read"]];
is_host: import("@balena/sbvr-types").Types["Boolean"]["Read"];
is_archived: import("@balena/sbvr-types").Types["Boolean"]["Read"];
uuid: import("@balena/sbvr-types").Types["Text"]["Read"];
is_public: import("@balena/sbvr-types").Types["Boolean"]["Read"];
is_accessible_by_support_until__date: import("@balena/sbvr-types").Types["Date Time"]["Read"] | null;
is_discoverable: import("@balena/sbvr-types").Types["Boolean"]["Read"];
is_stored_at__repository_url: import("@balena/sbvr-types").Types["Text"]["Read"] | null;
application__has__env_var_name?: Array<import("..").ApplicationEnvironmentVariable["Read"]>;
application_environment_variable?: Array<import("..").ApplicationEnvironmentVariable["Read"]>;
application__has__config_var_name?: Array<import("..").ApplicationConfigVariable["Read"]>;
application_config_variable?: Array<import("..").ApplicationConfigVariable["Read"]>;
application__has__service_name?: Array<import("..").Service["Read"]>;
service?: Array<import("..").Service["Read"]>;
application__has__tag_key?: Array<import("..").ApplicationTag["Read"]>;
application_tag?: Array<import("..").ApplicationTag["Read"]>;
application__has__domain?: Array<import("..").ApplicationDomainMapping["Read"]>;
application_domain_mapping?: Array<import("..").ApplicationDomainMapping["Read"]>;
application__has__build_var_name?: Array<import("..").BuildEnvironmentVariable["Read"]>;
build_environment_variable?: Array<import("..").BuildEnvironmentVariable["Read"]>;
owns__device?: Array<import("..").Device["Read"]>;
owns__release?: Array<import("..").Release["Read"]>;
owns__public_device?: Array<import("..").PublicDevice["Read"]>;
team__grants_access_to__application?: Array<import("..").TeamApplicationAccess["Read"]>;
team_application_access?: Array<import("..").TeamApplicationAccess["Read"]>;
is_accessible_by__team?: Array<import("..").TeamApplicationAccess["Read"]>;
user__is_member_of__application?: Array<import("..").UserIsMemberOfApplication["Read"]>;
user_application_membership?: Array<import("..").UserIsMemberOfApplication["Read"]>;
includes__user?: Array<import("..").UserIsMemberOfApplication["Read"]>;
includes__user__is_member_of__application?: Array<import("..").UserIsMemberOfApplication["Read"]>;
includes__user_application_membership?: Array<import("..").UserIsMemberOfApplication["Read"]>;
invitee__is_invited_to__application?: Array<import("..").InviteeIsInvitedToApplication["Read"]>;
application_invite?: Array<import("..").InviteeIsInvitedToApplication["Read"]>;
invitee?: Array<import("..").InviteeIsInvitedToApplication["Read"]>;
is_directly_accessible_by__user?: Array<import("..").UserHasDirectAccessToApplication["Read"]>;
can_use__application_as_host?: Array<import("..").ApplicationCanUseApplicationAsHost["Read"]>;
}, import("../util").MergePineOptions<{
created_at: import("@balena/sbvr-types").Types["Date Time"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
actor: {
__id: import("..").Actor["Read"]["id"];
} | [import("..").Actor["Read"]];
should_track_latest_release: import("@balena/sbvr-types").Types["Boolean"]["Read"];
is_of__class: "fleet" | "block" | "app";
organization: {
__id: import("..").Organization["Read"]["id"];
} | [import("..").Organization["Read"]];
app_name: import("@balena/sbvr-types").Types["Text"]["Read"];
slug: import("@balena/sbvr-types").Types["Short Text"]["Read"];
is_for__device_type: {
__id: import("..").DeviceType["Read"]["id"];
} | [import("..").DeviceType["Read"]];
should_be_running__release: {
__id: import("..").Release["Read"]["id"];
} | [import("..").Release["Read"]] | [] | null;
application_type: {
__id: import("..").ApplicationType["Read"]["id"];
} | [import("..").ApplicationType["Read"]];
is_host: import("@balena/sbvr-types").Types["Boolean"]["Read"];
is_archived: import("@balena/sbvr-types").Types["Boolean"]["Read"];
uuid: import("@balena/sbvr-types").Types["Text"]["Read"];
is_public: import("@balena/sbvr-types").Types["Boolean"]["Read"];
is_accessible_by_support_until__date: import("@balena/sbvr-types").Types["Date Time"]["Read"] | null;
is_discoverable: import("@balena/sbvr-types").Types["Boolean"]["Read"];
is_stored_at__repository_url: import("@balena/sbvr-types").Types["Text"]["Read"] | null;
application__has__env_var_name?: Array<import("..").ApplicationEnvironmentVariable["Read"]>;
application_environment_variable?: Array<import("..").ApplicationEnvironmentVariable["Read"]>;
application__has__config_var_name?: Array<import("..").ApplicationConfigVariable["Read"]>;
application_config_variable?: Array<import("..").ApplicationConfigVariable["Read"]>;
application__has__service_name?: Array<import("..").Service["Read"]>;
service?: Array<import("..").Service["Read"]>;
application__has__tag_key?: Array<import("..").ApplicationTag["Read"]>;
application_tag?: Array<import("..").ApplicationTag["Read"]>;
application__has__domain?: Array<import("..").ApplicationDomainMapping["Read"]>;
application_domain_mapping?: Array<import("..").ApplicationDomainMapping["Read"]>;
application__has__build_var_name?: Array<import("..").BuildEnvironmentVariable["Read"]>;
build_environment_variable?: Array<import("..").BuildEnvironmentVariable["Read"]>;
owns__device?: Array<import("..").Device["Read"]>;
owns__release?: Array<import("..").Release["Read"]>;
owns__public_device?: Array<import("..").PublicDevice["Read"]>;
team__grants_access_to__application?: Array<import("..").TeamApplicationAccess["Read"]>;
team_application_access?: Array<import("..").TeamApplicationAccess["Read"]>;
is_accessible_by__team?: Array<import("..").TeamApplicationAccess["Read"]>;
user__is_member_of__application?: Array<import("..").UserIsMemberOfApplication["Read"]>;
user_application_membership?: Array<import("..").UserIsMemberOfApplication["Read"]>;
includes__user?: Array<import("..").UserIsMemberOfApplication["Read"]>;
includes__user__is_member_of__application?: Array<import("..").UserIsMemberOfApplication["Read"]>;
includes__user_application_membership?: Array<import("..").UserIsMemberOfApplication["Read"]>;
invitee__is_invited_to__application?: Array<import("..").InviteeIsInvitedToApplication["Read"]>;
application_invite?: Array<import("..").InviteeIsInvitedToApplication["Read"]>;
invitee?: Array<import("..").InviteeIsInvitedToApplication["Read"]>;
is_directly_accessible_by__user?: Array<import("..").UserHasDirectAccessToApplication["Read"]>;
can_use__application_as_host?: Array<import("..").ApplicationCanUseApplicationAsHost["Read"]>;
}, {
readonly $expand: {
readonly owns__device: {
readonly $expand: {
readonly image_install: {
readonly $select: readonly ["id", "download_progress", "status", "install_date"];
readonly $filter: {
readonly status: {
readonly $ne: "deleted";
};
};
readonly $expand: {
readonly installs__image: {
readonly $select: readonly ["id"];
readonly $expand: {
readonly is_a_build_of__service: {
readonly $select: readonly ["id", "service_name"];
};
};
};
readonly is_provided_by__release: {
readonly $select: readonly ["id", "commit", "raw_version"];
readonly $expand: {
readonly belongs_to__application: {
readonly $select: readonly ["slug"];
};
};
};
};
};
};
};
};
}, T>, string | number> & {
owns__device: import("..").DeviceWithServiceDetails[];
}>;
getAppByName<T extends import("pinejs-client-core").ODataOptionsWithoutCount<import("..").Application["Read"]>>(appName: string, options?: T, context?: "directly_accessible"): Promise<import("pinejs-client-core").OptionsToResponse<import("..").Application["Read"], T, undefined>[number]>;
has: (slugOrUuidOrId: string | number) => Promise<boolean>;
hasAny: () => Promise<boolean>;
create({ name, uuid, applicationClass, deviceType, organization, }: {
name: string;
uuid?: string;
applicationClass?: "app" | "fleet" | "block";
deviceType: string;
organization: number | string;
}): Promise<import("pinejs-client-core/node_modules/@balena/abstract-sql-to-typescript", { with: { "resolution-mode": "import" } }).PickDeferred<{
created_at: import("@balena/sbvr-types").Types["Date Time"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
actor: {
__id: import("..").Actor["Read"]["id"];
} | [import("..").Actor["Read"]];
should_track_latest_release: import("@balena/sbvr-types").Types["Boolean"]["Read"];
is_of__class: "fleet" | "block" | "app";
organization: {
__id: import("..").Organization["Read"]["id"];
} | [import("..").Organization["Read"]];
app_name: import("@balena/sbvr-types").Types["Text"]["Read"];
slug: import("@balena/sbvr-types").Types["Short Text"]["Read"];
is_for__device_type: {
__id: import("..").DeviceType["Read"]["id"];
} | [import("..").DeviceType["Read"]];
should_be_running__release: {
__id: import("..").Release["Read"]["id"];
} | [import("..").Release["Read"]] | [] | null;
application_type: {
__id: import("..").ApplicationType["Read"]["id"];
} | [import("..").ApplicationType["Read"]];
is_host: import("@balena/sbvr-types").Types["Boolean"]["Read"];
is_archived: import("@balena/sbvr-types").Types["Boolean"]["Read"];
uuid: import("@balena/sbvr-types").Types["Text"]["Read"];
is_public: import("@balena/sbvr-types").Types["Boolean"]["Read"];
is_accessible_by_support_until__date: import("@balena/sbvr-types").Types["Date Time"]["Read"] | null;
is_discoverable: import("@balena/sbvr-types").Types["Boolean"]["Read"];
is_stored_at__repository_url: import("@balena/sbvr-types").Types["Text"]["Read"] | null;
application__has__env_var_name?: Array<import("..").ApplicationEnvironmentVariable["Read"]>;
application_environment_variable?: Array<import("..").ApplicationEnvironmentVariable["Read"]>;
application__has__config_var_name?: Array<import("..").ApplicationConfigVariable["Read"]>;
application_config_variable?: Array<import("..").ApplicationConfigVariable["Read"]>;
application__has__service_name?: Array<import("..").Service["Read"]>;
service?: Array<import("..").Service["Read"]>;
application__has__tag_key?: Array<import("..").ApplicationTag["Read"]>;
application_tag?: Array<import("..").ApplicationTag["Read"]>;
application__has__domain?: Array<import("..").ApplicationDomainMapping["Read"]>;
application_domain_mapping?: Array<import("..").ApplicationDomainMapping["Read"]>;
application__has__build_var_name?: Array<import("..").BuildEnvironmentVariable["Read"]>;
build_environment_variable?: Array<import("..").BuildEnvironmentVariable["Read"]>;
owns__device?: Array<import("..").Device["Read"]>;
owns__release?: Array<import("..").Release["Read"]>;
owns__public_device?: Array<import("..").PublicDevice["Read"]>;
team__grants_access_to__application?: Array<import("..").TeamApplicationAccess["Read"]>;
team_application_access?: Array<import("..").TeamApplicationAccess["Read"]>;
is_accessible_by__team?: Array<import("..").TeamApplicationAccess["Read"]>;
user__is_member_of__application?: Array<import("..").UserIsMemberOfApplication["Read"]>;
user_application_membership?: Array<import("..").UserIsMemberOfApplication["Read"]>;
includes__user?: Array<import("..").UserIsMemberOfApplication["Read"]>;
includes__user__is_member_of__application?: Array<import("..").UserIsMemberOfApplication["Read"]>;
includes__user_application_membership?: Array<import("..").UserIsMemberOfApplication["Read"]>;
invitee__is_invited_to__application?: Array<import("..").InviteeIsInvitedToApplication["Read"]>;
application_invite?: Array<import("..").InviteeIsInvitedToApplication["Read"]>;
invitee?: Array<import("..").InviteeIsInvitedToApplication["Read"]>;
is_directly_accessible_by__user?: Array<import("..").UserHasDirectAccessToApplication["Read"]>;
can_use__application_as_host?: Array<import("..").ApplicationCanUseApplicationAsHost["Read"]>;
}>>;
remove: (slugOrUuidOrIdOrIds: string | number | number[]) => Promise<void>;
rename: (slugOrUuidOrId: string | number, newAppName: string) => Promise<void>;
restart: (slugOrUuidOrId: string | number) => Promise<void>;
generateProvisioningKey: ({ slugOrUuidOrId, keyExpiryDate, keyName, keyDescription, }: {
slugOrUuidOrId: string | number;
keyExpiryDate: string | null;
keyName?: string;
keyDescription?: string;
}) => Promise<string>;
purge: (appId: number) => Promise<void>;
shutdown: (appId: number, options?: {
force?: boolean;
}) => Promise<void>;
reboot: (appId: number, options?: {
force?: boolean;
}) => Promise<void>;
willTrackNewReleases: (slugOrUuidOrId: string | number) => Promise<boolean>;
isTrackingLatestRelease: (slugOrUuidOrId: string | number) => Promise<boolean>;
pinToRelease: (slugOrUuidOrId: string | number, fullReleaseHash: string) => Promise<void>;
getTargetReleaseHash: (slugOrUuidOrId: string | number) => Promise<string | undefined>;
trackLatestRelease: (slugOrUuidOrId: string | number) => Promise<void>;
enableDeviceUrls: (slugOrUuidOrId: string | number) => Promise<void>;
disableDeviceUrls: (slugOrUuidOrId: string | number) => Promise<void>;
grantSupportAccess(slugOrUuidOrId: string | number, expiryTimestamp: number): Promise<void>;
revokeSupportAccess: (slugOrUuidOrId: string | number) => Promise<void>;
tags: {
getAllByApplication: <O extends import("pinejs-client-core").ODataOptionsWithoutCount<{
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
tag_key: import("@balena/sbvr-types").Types["Short Text"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
value: import("@balena/sbvr-types").Types["Text"]["Read"];
}>>(parentParam: string | number | Record<string, unknown>, options?: O | undefined) => Promise<import("pinejs-client-core").OptionsToResponse<{
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
tag_key: import("@balena/sbvr-types").Types["Short Text"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
value: import("@balena/sbvr-types").Types["Text"]["Read"];
}, O, undefined>>;
set: (parentParam: string | number | Record<string, unknown>, key: string, value: string) => Promise<void>;
remove: (parentParam: string | number | Record<string, unknown>, key: string) => Promise<void>;
};
configVar: {
getAllByApplication: <O extends import("pinejs-client-core").ODataOptionsWithoutCount<{
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
name: import("@balena/sbvr-types").Types["Short Text"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
value: import("@balena/sbvr-types").Types["Text"]["Read"];
}>>(parentParam: string | number | Record<string, unknown>, options?: O | undefined) => Promise<import("pinejs-client-core").OptionsToResponse<{
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
name: import("@balena/sbvr-types").Types["Short Text"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
value: import("@balena/sbvr-types").Types["Text"]["Read"];
}, O, undefined>>;
get: (parentParam: string | number | Record<string, unknown>, key: string) => Promise<string | undefined>;
set: (parentParam: string | number | Record<string, unknown>, key: string, value: string) => Promise<void>;
remove: (parentParam: string | number | Record<string, unknown>, key: string) => Promise<void>;
};
envVar: {
getAllByApplication: <O extends import("pinejs-client-core").ODataOptionsWithoutCount<{
created_at: import("@balena/sbvr-types").Types["Date Time"]["Read"];
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
name: import("@balena/sbvr-types").Types["Short Text"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
value: import("@balena/sbvr-types").Types["Text"]["Read"];
}>>(parentParam: string | number | Record<string, unknown>, options?: O | undefined) => Promise<import("pinejs-client-core").OptionsToResponse<{
created_at: import("@balena/sbvr-types").Types["Date Time"]["Read"];
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
name: import("@balena/sbvr-types").Types["Short Text"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
value: import("@balena/sbvr-types").Types["Text"]["Read"];
}, O, undefined>>;
get: (parentParam: string | number | Record<string, unknown>, key: string) => Promise<string | undefined>;
set: (parentParam: string | number | Record<string, unknown>, key: string, value: string) => Promise<void>;
remove: (parentParam: string | number | Record<string, unknown>, key: string) => Promise<void>;
};
buildVar: {
getAllByApplication: <O extends import("pinejs-client-core").ODataOptionsWithoutCount<{
created_at: import("@balena/sbvr-types").Types["Date Time"]["Read"];
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
name: import("@balena/sbvr-types").Types["Short Text"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
value: import("@balena/sbvr-types").Types["Text"]["Read"];
}>>(parentParam: string | number | Record<string, unknown>, options?: O | undefined) => Promise<import("pinejs-client-core").OptionsToResponse<{
created_at: import("@balena/sbvr-types").Types["Date Time"]["Read"];
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
name: import("@balena/sbvr-types").Types["Short Text"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
value: import("@balena/sbvr-types").Types["Text"]["Read"];
}, O, undefined>>;
get: (parentParam: string | number | Record<string, unknown>, key: string) => Promise<string | undefined>;
set: (parentParam: string | number | Record<string, unknown>, key: string, value: string) => Promise<void>;
remove: (parentParam: string | number | Record<string, unknown>, key: string) => Promise<void>;
};
membership: {
get<T extends import("pinejs-client-core").ODataOptionsWithoutCount<{
user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
is_member_of__application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
application_membership_role: {
__id: import("..").ApplicationMembershipRole["Read"]["id"];
} | [import("..").ApplicationMembershipRole["Read"]];
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
includes__user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
}>>(membershipId: number | import("pinejs-client-core").ResourceAlternateKey<Pick<{
user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
is_member_of__application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
application_membership_role: {
__id: import("..").ApplicationMembershipRole["Read"]["id"];
} | [import("..").ApplicationMembershipRole["Read"]];
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
includes__user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
}, "user" | "is_member_of__application">>, options?: T): Promise<import("pinejs-client-core").OptionsToResponse<{
user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
is_member_of__application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
application_membership_role: {
__id: import("..").ApplicationMembershipRole["Read"]["id"];
} | [import("..").ApplicationMembershipRole["Read"]];
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
includes__user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
}, T, undefined>[number]>;
getAllByApplication<T extends import("pinejs-client-core").ODataOptionsWithoutCount<{
user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
is_member_of__application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
application_membership_role: {
__id: import("..").ApplicationMembershipRole["Read"]["id"];
} | [import("..").ApplicationMembershipRole["Read"]];
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
includes__user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
}>>(slugOrUuidOrId: number | string, options?: T): Promise<import("pinejs-client-core").OptionsToResponse<{
user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
is_member_of__application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
application_membership_role: {
__id: import("..").ApplicationMembershipRole["Read"]["id"];
} | [import("..").ApplicationMembershipRole["Read"]];
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
includes__user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
}, T, undefined>>;
getAllByUser<T extends import("pinejs-client-core").ODataOptionsWithoutCount<{
user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
is_member_of__application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
application_membership_role: {
__id: import("..").ApplicationMembershipRole["Read"]["id"];
} | [import("..").ApplicationMembershipRole["Read"]];
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
includes__user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
}>>(usernameOrId: number | string, options?: T): Promise<import("pinejs-client-core").OptionsToResponse<{
user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
is_member_of__application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
application_membership_role: {
__id: import("..").ApplicationMembershipRole["Read"]["id"];
} | [import("..").ApplicationMembershipRole["Read"]];
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
includes__user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
}, T, undefined>>;
create({ application, username, roleName, }: import("./application-membership").ApplicationMembershipCreationOptions): Promise<import("pinejs-client-core/node_modules/@balena/abstract-sql-to-typescript", { with: { "resolution-mode": "import" } }).PickDeferred<{
user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
is_member_of__application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
application_membership_role: {
__id: import("..").ApplicationMembershipRole["Read"]["id"];
} | [import("..").ApplicationMembershipRole["Read"]];
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
includes__user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
}>>;
changeRole(idOrUniqueKey: number | import("pinejs-client-core").ResourceAlternateKey<Pick<{
user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
is_member_of__application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
application_membership_role: {
__id: import("..").ApplicationMembershipRole["Read"]["id"];
} | [import("..").ApplicationMembershipRole["Read"]];
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
includes__user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
}, "user" | "is_member_of__application">>, roleName: import("..").ApplicationMembershipRole["Read"]["name"]): Promise<void>;
remove(idOrUniqueKey: number | import("pinejs-client-core").ResourceAlternateKey<Pick<{
user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
is_member_of__application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
application_membership_role: {
__id: import("..").ApplicationMembershipRole["Read"]["id"];
} | [import("..").ApplicationMembershipRole["Read"]];
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
includes__user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]];
}, "user" | "is_member_of__application">>): Promise<void>;
};
invite: {
getAll<T extends import("pinejs-client-core").ODataOptionsWithoutCount<{
invitee: {
__id: import("..").Invitee["Read"]["id"];
} | [import("..").Invitee["Read"]];
is_invited_to__application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
application_membership_role: {
__id: import("..").ApplicationMembershipRole["Read"]["id"];
} | [import("..").ApplicationMembershipRole["Read"]];
message: import("@balena/sbvr-types").Types["Text"]["Read"] | null;
is_created_by__user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]] | [] | null;
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
}>>(options?: T): Promise<import("pinejs-client-core").OptionsToResponse<{
invitee: {
__id: import("..").Invitee["Read"]["id"];
} | [import("..").Invitee["Read"]];
is_invited_to__application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
application_membership_role: {
__id: import("..").ApplicationMembershipRole["Read"]["id"];
} | [import("..").ApplicationMembershipRole["Read"]];
message: import("@balena/sbvr-types").Types["Text"]["Read"] | null;
is_created_by__user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]] | [] | null;
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
}, T, undefined>>;
getAllByApplication<T extends import("pinejs-client-core").ODataOptionsWithoutCount<{
invitee: {
__id: import("..").Invitee["Read"]["id"];
} | [import("..").Invitee["Read"]];
is_invited_to__application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
application_membership_role: {
__id: import("..").ApplicationMembershipRole["Read"]["id"];
} | [import("..").ApplicationMembershipRole["Read"]];
message: import("@balena/sbvr-types").Types["Text"]["Read"] | null;
is_created_by__user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]] | [] | null;
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
}>>(slugOrUuidOrId: number | string, options?: T): Promise<import("pinejs-client-core").OptionsToResponse<{
invitee: {
__id: import("..").Invitee["Read"]["id"];
} | [import("..").Invitee["Read"]];
is_invited_to__application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
application_membership_role: {
__id: import("..").ApplicationMembershipRole["Read"]["id"];
} | [import("..").ApplicationMembershipRole["Read"]];
message: import("@balena/sbvr-types").Types["Text"]["Read"] | null;
is_created_by__user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]] | [] | null;
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
}, T, undefined>>;
create(slugOrUuidOrId: string | number, { invitee, roleName, message }: import("./application-invite").ApplicationInviteOptions): Promise<import("pinejs-client-core/node_modules/@balena/abstract-sql-to-typescript", { with: { "resolution-mode": "import" } }).PickDeferred<{
invitee: {
__id: import("..").Invitee["Read"]["id"];
} | [import("..").Invitee["Read"]];
is_invited_to__application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
application_membership_role: {
__id: import("..").ApplicationMembershipRole["Read"]["id"];
} | [import("..").ApplicationMembershipRole["Read"]];
message: import("@balena/sbvr-types").Types["Text"]["Read"] | null;
is_created_by__user: {
__id: import("..").User["Read"]["id"];
} | [import("..").User["Read"]] | [] | null;
application: {
__id: import("..").Application["Read"]["id"];
} | [import("..").Application["Read"]];
}>>;
revoke(id: number): Promise<void>;
accept(invitationToken: string): Promise<void>;
};
};
device: {
getSupervisorTargetState: (uuidOrId: string | number, version?: 2 | 3) => Promise<import("../types/device-state").DeviceState>;
getSupervisorTargetStateForApp: (slugOrUuidOrId: string | number, release?: string | number) => Promise<import("../types/device-state").DeviceStateV3>;
generateUniqueKey(): string;
register(applicationSlugOrUuidOrId: string | number, uuid: string, deviceTypeSlug?: string): Promise<{
id: number;
uuid: string;
api_key: string;
}>;
generateDeviceKey: (uuidOrId: string | number, keyName?: string, keyDescription?: string, keyExpiryDate?: string) => Promise<string>;
hasDeviceUrl: (uuidOrId: string | number) => Promise<boolean>;
getDeviceUrl: (uuidOrId: string | number) => Promise<string>;
enableDeviceUrl: (uuidOrIdOrArray: string | string[] | number | number[]) => Promise<void>;
disableDeviceUrl: (uuidOrIdOrArray: string | string[] | number | number[]) => Promise<void>;
enableLocalMode(uuidOrId: string | number): Promise<void>;
disableLocalMode: (uuidOrId: string | number) => Promise<void>;
isInLocalMode: (uuidOrId: string | number) => Promise<boolean>;
getLocalModeSupport: (device: import("../../typings/utils").AtLeast<import("..").Device["Read"], typeof import("../util/local-mode").LOCAL_MODE_SUPPORT_PROPERTIES[number]>) => {
supported: boolean;
message: string;
};
enableLockOverride: (uuidOrId: string | number) => Promise<void>;
disableLockOverride: (uuidOrId: string | number) => Promise<void>;
hasLockOverride: (uuidOrId: string | number) => Promise<boolean>;
getStatus(uuidOrId: string | number): Promise<string>;
getProgress(uuidOrId: string | number): Promise<number | null>;
grantSupportAccess(uuidOrIdOrArray: string | string[] | number | number[], expiryTimestamp: number): Promise<void>;
revokeSupportAccess: (uuidOrIdOrArray: string | string[] | number | number[]) => Promise<void>;
getOsVersion: (device: import("../../typings/utils").AtLeast<import("..").Device["Read"], "os_variant" | "os_version">) => string;
isTrackingApplicationRelease: (uuidOrId: string | number) => Promise<boolean>;
getTargetReleaseHash: (uuidOrId: string | number) => Promise<string | undefined>;
pinToRelease: (uuidOrIdOrArray: string | string[] | number | number[], fullReleaseHashOrId: string | number) => Promise<void>;
trackApplicationRelease: (uuidOrIdOrArray: string | string[] | number | number[]) => Promise<void>;
pinToSupervisorRelease: (uuidOrIdOrArray: string | string[] | number | number[], supervisorVersionOrId: string | number) => Promise<void>;
_checkOsUpdateTarget({ uuid, is_of__device_type, os_version, os_variant, }: Pick<import("..").Device["Read"], "uuid" | "os_version" | "os_variant"> & {
is_of__device_type: [Pick<import("..").DeviceType["Read"], "slug">];
}, targetOsRelease: Pick<import("./os").OsVersion, "raw_version" | "basedOnVersion">, mode: "start" | "pin"): void;
startOsUpdate: {
(uuidOrUuids: string, targetOsVersion: string, options?: {
runDetached?: boolean;
}): Promise<import("..").OsUpdateActionResult>;
(uuidOrUuids: string[], targetOsVersion: string, options?: {
runDetached?: boolean;
}): Promise<Record<string, import("..").OsUpdateActionResult>>;
};
pinToOsRelease(uuidOrIdOrArray: string | string[] | number | number[], osVersionOrId: string | number): Promise<void>;
tags: {
getAllByApplication<T extends import("pinejs-client-core").ODataOptionsWithoutCount<import("..").DeviceTag["Read"]>>(slugOrUuidOrId: string | number, options?: T): Promise<import("pinejs-client-core").OptionsToResponse<import("..").DeviceTag["Read"], T, undefined>>;
getAllByDevice: <O extends import("pinejs-client-core").ODataOptionsWithoutCount<{
device: {
__id: import("..").Device["Read"]["id"];
} | [import("..").Device["Read"]];
tag_key: import("@balena/sbvr-types").Types["Short Text"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
value: import("@balena/sbvr-types").Types["Text"]["Read"];
}>>(parentParam: string | number | Record<string, unknown>, options?: O | undefined) => Promise<import("pinejs-client-core").OptionsToResponse<{
device: {
__id: import("..").Device["Read"]["id"];
} | [import("..").Device["Read"]];
tag_key: import("@balena/sbvr-types").Types["Short Text"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
value: import("@balena/sbvr-types").Types["Text"]["Read"];
}, O, undefined>>;
set: (parentParam: string | number | Record<string, unknown>, key: string, value: string) => Promise<void>;
remove: (parentParam: string | number | Record<string, unknown>, key: string) => Promise<void>;
};
configVar: {
getAllByDevice: <O extends import("pinejs-client-core").ODataOptionsWithoutCount<{
device: {
__id: import("..").Device["Read"]["id"];
} | [import("..").Device["Read"]];
name: import("@balena/sbvr-types").Types["Short Text"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
value: import("@balena/sbvr-types").Types["Text"]["Read"];
}>>(parentParam: string | number | Record<string, unknown>, options?: O | undefined) => Promise<import("pinejs-client-core").OptionsToResponse<{
device: {
__id: import("..").Device["Read"]["id"];
} | [import("..").Device["Read"]];
name: import("@balena/sbvr-types").Types["Short Text"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
value: import("@balena/sbvr-types").Types["Text"]["Read"];
}, O, undefined>>;
getAllByApplication<T extends import("pinejs-client-core").ODataOptionsWithoutCount<import("..").DeviceConfigVariable["Read"]>>(slugOrUuidOrId: string | number, options?: T): Promise<import("pinejs-client-core").OptionsToResponse<import("..").DeviceConfigVariable["Read"], T, undefined>>;
get: (parentParam: string | number | Record<string, unknown>, key: string) => Promise<string | undefined>;
set: (parentParam: string | number | Record<string, unknown>, key: string, value: string) => Promise<void>;
remove: (parentParam: string | number | Record<string, unknown>, key: string) => Promise<void>;
};
envVar: {
getAllByDevice: <O extends import("pinejs-client-core").ODataOptionsWithoutCount<{
created_at: import("@balena/sbvr-types").Types["Date Time"]["Read"];
device: {
__id: import("..").Device["Read"]["id"];
} | [import("..").Device["Read"]];
name: import("@balena/sbvr-types").Types["Short Text"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
value: import("@balena/sbvr-types").Types["Text"]["Read"];
}>>(parentParam: string | number | Record<string, unknown>, options?: O | undefined) => Promise<import("pinejs-client-core").OptionsToResponse<{
created_at: import("@balena/sbvr-types").Types["Date Time"]["Read"];
device: {
__id: import("..").Device["Read"]["id"];
} | [import("..").Device["Read"]];
name: import("@balena/sbvr-types").Types["Short Text"]["Read"];
id: import("@balena/sbvr-types").Types["Integer"]["Read"];
value: import("@balena/sbvr-types").Types["Text"]["Read"];
}, O, undefined>>;
getAllByApplication<T extends import("pinejs-client-core").ODataOptionsWithoutCount<import("..").DeviceEnvironmentVariable["Read"]>>(slugOrUuidOrId: string | number, options?: T): Promise<import("pinejs-client-core").OptionsToResponse<import("..").DeviceEnvironmentVariable["Read"], T, undefined>>;
get: (parentParam: string | number | Record<string, unknown>, key: string) => Promise<string | undefined>;
set: (parentParam: string | number | Record<string, unknown>, key: string, value: string) => Promise<void>;
remove: (parentParam: string | number | Record<string, unknown>, key: string) => Promise<void>;
};
serviceVar: {