@northern.tech/store 0.1.0

package/api/types/DeploymentAggregationTerms.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { DeploymentAggregationTerm } from "./DeploymentAggregationTerm";
+import type { DeploymentFilterTerm } from "./DeploymentFilterTerm";
+
+export type DeploymentAggregationTerms = {
+  /**
+   * Aggregation terms.
+   */
+  aggregations?: Array<DeploymentAggregationTerm>;
+  /**
+   * Filtering terms.
+   */
+  filters?: Array<DeploymentFilterTerm>;
+};

package/api/types/DeploymentAttributeProjection.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type DeploymentAttributeProjection = {
+  /**
+   * Attribute key to sort by.
+   */
+  attribute: string;
+};

package/api/types/DeploymentAuditlogs.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The deployment descriptor.
+ */
+export type DeploymentAuditlogs = {
+  name: string;
+  artifact_name: string;
+};

package/api/types/DeploymentDeployments.ts

@@ -0,0 +1,99 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { DeploymentPhase } from "./DeploymentPhase";
+import type { DeploymentStatistics } from "./DeploymentStatistics";
+import type { Filter } from "./Filter";
+
+export type DeploymentDeployments = {
+  /**
+   * Deployment identifier
+   */
+  id: string;
+  /**
+   * Name of the deployment
+   */
+  name: string;
+  /**
+   * Name of the artifact to deploy
+   */
+  artifact_name: string;
+  /**
+   * Deployment's creation date and time
+   */
+  created: string;
+  /**
+   * Deployment's completion date and time
+   */
+  finished?: string;
+  /**
+   * Status of the deployment
+   */
+  status: DeploymentDeployments.status;
+  /**
+   * Number of devices the deployment acted upon
+   */
+  device_count: number;
+  /**
+   * An array of artifact's identifiers.
+   */
+  artifacts?: Array<string>;
+  /**
+   * An array of groups the devices targeted by the deployment belong to.
+   * Available only if the user created the deployment for a group or a single device (if the device was in a static group).
+   */
+  groups?: Array<string>;
+  phases?: Array<DeploymentPhase>;
+  /**
+   * The number of times a device can retry the deployment in case of failure, defaults to 0
+   */
+  retries?: number;
+  /**
+   * A valid JSON object defining the update control map.
+   * *NOTE*: Available only in the Enterprise plan.
+   */
+  update_control_map?: Record<string, any>;
+  /**
+   * max_devices denotes a limit on a number of completed deployments (failed or successful) above which the dynamic deployment will be finished.
+   */
+  max_devices?: number;
+  /**
+   * In case of dynamic deployments this is a number of devices targeted initially (maching the filter at the moment of deployment creation).
+   */
+  initial_device_count?: number;
+  /**
+   * Flag indicating if the deployment is dynamic or not.
+   */
+  dynamic?: boolean;
+  filter?: Filter;
+  type?: DeploymentDeployments.type;
+  /**
+   * A string containing a configuration object provided
+   * with the deployment constructor.
+   */
+  configuration?: string;
+  /**
+   * The flag idicating if the autogeneration of delta artifacts is enabled for a given deployment.
+   */
+  autogenerate_delta?: boolean;
+  statistics?: DeploymentStatistics;
+};
+
+export namespace DeploymentDeployments {
+  /**
+   * Status of the deployment
+   */
+  export enum status {
+    SCHEDULED = "scheduled",
+    PENDING = "pending",
+    INPROGRESS = "inprogress",
+    FINISHED = "finished",
+  }
+
+  export enum type {
+    CONFIGURATION = "configuration",
+    SOFTWARE = "software",
+  }
+}

package/api/types/DeploymentFilterTerm.ts

@@ -0,0 +1,37 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type DeploymentFilterTerm = {
+  /**
+   * Attribute key to compare.
+   */
+  attribute: string;
+  /**
+   * Filter matching expression.
+   */
+  value: any;
+  /**
+   * Type of filtering operation.
+   */
+  type: DeploymentFilterTerm.type;
+};
+
+export namespace DeploymentFilterTerm {
+  /**
+   * Type of filtering operation.
+   */
+  export enum type {
+    _EQ = "$eq",
+    _GT = "$gt",
+    _GTE = "$gte",
+    _IN = "$in",
+    _LT = "$lt",
+    _LTE = "$lte",
+    _NE = "$ne",
+    _NIN = "$nin",
+    _EXISTS = "$exists",
+    _REGEX = "$regex",
+  }
+}

package/api/types/DeploymentIdentifier.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Deployment identifier
+ */
+export type DeploymentIdentifier = {
+  deployment_ids?: Array<string>;
+};

package/api/types/DeploymentPhase.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type DeploymentPhase = {
+  /**
+   * Phase identifier.
+   */
+  id?: string;
+  /**
+   * Percentage of devices to update in the phase.
+   */
+  batch_size?: number;
+  /**
+   * Start date of a phase.
+   * May be undefined for the first phase of a deployment.
+   */
+  start_ts?: string;
+  /**
+   * Number of devices which already requested an update within this phase.
+   */
+  device_count?: number;
+};

package/api/types/DeploymentReporting.ts

@@ -0,0 +1,46 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type DeploymentReporting = {
+  /**
+   * Device Deployment ID.
+   */
+  id?: string;
+  tenant_id?: string;
+  device_id?: string;
+  deployment_id?: string;
+  deployment_name?: string;
+  deployment_artifact_name?: string;
+  deployment_type?: string;
+  deployment_created?: string;
+  deployment_filter_id?: string;
+  deployment_all_devices?: boolean;
+  deployment_force_installation?: boolean;
+  deployment_group?: string;
+  deployment_phased?: boolean;
+  deployment_phase_id?: string;
+  deployment_retries?: number;
+  deployment_max_devices?: number;
+  deployment_autogenerate_deta?: boolean;
+  device_created?: string;
+  device_finished?: string;
+  device_elapsed_seconds?: number;
+  device_deleted?: string;
+  device_status?: string;
+  device_is_log_available?: boolean;
+  device_retries?: number;
+  device_attempts?: number;
+  image_id?: string;
+  image_description?: string;
+  image_artifact_name?: string;
+  image_device_types?: Array<string>;
+  image_signed?: boolean;
+  image_artifact_info_format?: string;
+  image_artifact_info_version?: number;
+  image_provides?: Record<string, any>;
+  image_depends?: Record<string, any>;
+  image_clear_provides?: string;
+  image_size?: number;
+};

package/api/types/DeploymentSearchTerms.ts

@@ -0,0 +1,39 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { DeploymentAttributeProjection } from "./DeploymentAttributeProjection";
+import type { DeploymentFilterTerm } from "./DeploymentFilterTerm";
+import type { DeploymentSortTerm } from "./DeploymentSortTerm";
+
+export type DeploymentSearchTerms = {
+  /**
+   * Pagination parameter for iterating search results.
+   */
+  page?: number;
+  /**
+   * Number of devices returned per page.
+   */
+  per_page?: number;
+  /**
+   * Filtering terms.
+   */
+  filters?: Array<DeploymentFilterTerm>;
+  /**
+   * Attribute keys to sort by.
+   */
+  sort?: Array<DeploymentSortTerm>;
+  /**
+   * Restrict the attribute result to the selected attributes.
+   */
+  attributes?: Array<DeploymentAttributeProjection>;
+  /**
+   * Restrict the result to the given device IDs.
+   */
+  device_ids?: Array<string>;
+  /**
+   * Restrict the result to the given deployment IDs.
+   */
+  deployment_ids?: Array<string>;
+};

package/api/types/DeploymentSortTerm.ts

@@ -0,0 +1,25 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type DeploymentSortTerm = {
+  /**
+   * Attribute key to sort by.
+   */
+  attribute: string;
+  /**
+   * Sort order: ascending/descending.
+   */
+  order: DeploymentSortTerm.order;
+};
+
+export namespace DeploymentSortTerm {
+  /**
+   * Sort order: ascending/descending.
+   */
+  export enum order {
+    ASC = "asc",
+    DESC = "desc",
+  }
+}

package/api/types/DeploymentStatistics.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { DeploymentStatusStatistics } from "./DeploymentStatusStatistics";
+export type DeploymentStatistics = {
+  status?: DeploymentStatusStatistics;
+  /**
+   * Sum of sizes (in bytes) of all artifacts assigned to all device deployments,
+   * which are part of this deployment.
+   * If the same artifact is assigned to multiple device deployments,
+   * its size will be counted multiple times.
+   */
+  total_size?: number;
+};

package/api/types/DeploymentStatusStatistics.ts

@@ -0,0 +1,54 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type DeploymentStatusStatistics = {
+  /**
+   * Number of successful deployments.
+   */
+  success: number;
+  /**
+   * Number of pending deployments.
+   */
+  pending: number;
+  /**
+   * Number of deployments being downloaded.
+   */
+  downloading: number;
+  /**
+   * Number of deployments devices are rebooting into.
+   */
+  rebooting: number;
+  /**
+   * Number of deployments devices being installed.
+   */
+  installing: number;
+  /**
+   * Number of failed deployments.
+   */
+  failure: number;
+  /**
+   * Do not have appropriate artifact for device type.
+   */
+  noartifact: number;
+  /**
+   * Number of devices unaffected by upgrade, since they are already running the specified software version.
+   */
+  "already-installed": number;
+  /**
+   * Number of deployments aborted by user.
+   */
+  aborted: number;
+  /**
+   * Number of deployments paused before install state.
+   */
+  pause_before_installing: number;
+  /**
+   * Number of deployments paused before reboot phase.
+   */
+  pause_before_rebooting: number;
+  /**
+   * Number of deployments paused before commit phase.
+   */
+  pause_before_committing: number;
+};

package/api/types/Device.ts

@@ -0,0 +1,29 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { DeviceStatus } from "./DeviceStatus";
+export type Device = {
+  /**
+   * Device identifier.
+   */
+  id: string;
+  status: DeviceStatus;
+  created?: string;
+  started?: string;
+  finished?: string;
+  deleted?: string;
+  device_type?: string;
+  /**
+   * Availability of the device's deployment log.
+   */
+  log: boolean;
+  /**
+   * State reported by device
+   */
+  state?: string;
+  /**
+   * Additional state information
+   */
+  substate?: string;
+};

package/api/types/DeviceAggregation.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { DeviceAggregationItem } from "./DeviceAggregationItem";
+
+export type DeviceAggregation = {
+  /**
+   * Aggregation name
+   */
+  name?: string;
+  items?: Array<DeviceAggregationItem>;
+  /**
+   * Count of the documents not included in the items
+   */
+  other_count?: number;
+};

package/api/types/DeviceAggregationItem.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { DeviceAggregation } from "./DeviceAggregation";
+
+export type DeviceAggregationItem = {
+  /**
+   * Aggregation key
+   */
+  key?: string;
+  /**
+   * Aggregation count
+   */
+  count?: number;
+  aggregations?: Array<DeviceAggregation>;
+};

package/api/types/DeviceAggregationTerm.ts

@@ -0,0 +1,27 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type DeviceAggregationTerm = {
+  /**
+   * Name of the aggregation.
+   */
+  name: string;
+  /**
+   * Attribute key(s) to aggregate.
+   */
+  attribute?: string;
+  /**
+   * The scope the attribute(s) exists in.
+   */
+  scope?: string;
+  /**
+   * Number of top results to return.
+   */
+  limit?: number;
+  /**
+   * Sub-aggregation terms; it supports up to 5 nested subaggregations.
+   */
+  aggregations?: Array<DeviceAggregationTerm>;
+};

package/api/types/DeviceAggregationTerms.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { DeviceAggregationTerm } from "./DeviceAggregationTerm";
+import type { DeviceFilterTerm } from "./DeviceFilterTerm";
+import type { GeoBoundingBoxFilter } from "./GeoBoundingBoxFilter";
+import type { GeoDistanceFilter } from "./GeoDistanceFilter";
+
+export type DeviceAggregationTerms = {
+  /**
+   * Aggregation terms.
+   */
+  aggregations?: Array<DeviceAggregationTerm>;
+  /**
+   * Filtering terms.
+   */
+  filters?: Array<DeviceFilterTerm>;
+  geo_distance_filter?: GeoDistanceFilter;
+  geo_bounding_box_filter?: GeoBoundingBoxFilter;
+};

package/api/types/DeviceAttribute.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type DeviceAttribute = {
+  /**
+   * Name of the attribute.
+   */
+  name: string;
+  /**
+   * Value of the attribute.
+   */
+  value: any;
+  /**
+   * The scope the attribute belongs to.
+   */
+  scope?: string;
+  /**
+   * Optional attributes description.
+   */
+  description?: string;
+};

package/api/types/DeviceAttributeProjection.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type DeviceAttributeProjection = {
+  /**
+   * Attribute key to sort by.
+   */
+  attribute: string;
+  /**
+   * Scope the attribute key belongs to.
+   */
+  scope?: string;
+};

package/api/types/DeviceAuditlogs.ts

@@ -0,0 +1,17 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Device descriptor.
+ */
+export type DeviceAuditlogs = {
+  /**
+   * Device ID.
+   */
+  id?: string;
+  /**
+   * Vendor-specific JSON representation of the device identity data (MACs, serial numbers, etc.).
+   */
+  identity_data: string;
+};

package/api/types/DeviceAuthEvent.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { AuthSet } from "./AuthSet";
+/**
+ * DeviceAuthEvent describes an event that relates to changes to a device's authentication data. The properties included depends on the event type: device provisioning includes the entire device with the accepted authentication set, status change events only includes the device id and the new status, and device decommissioning will only include the device id.
+ */
+export type DeviceAuthEvent = {
+  /**
+   * Device unique ID.
+   */
+  id: string;
+  /**
+   * The authentication status of the device.
+   */
+  status?: string;
+  auth_sets?: Array<AuthSet>;
+  /**
+   * The time the device was initialized in Mender.
+   */
+  created_ts?: string;
+};

package/api/types/DeviceConfiguration.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ManagementAPIConfiguration } from "./ManagementAPIConfiguration";
+export type DeviceConfiguration = {
+  id?: string;
+  configured?: ManagementAPIConfiguration;
+  reported?: ManagementAPIConfiguration;
+  /**
+   * ID of the latest configuration deployment
+   */
+  deployment_id?: string;
+  reported_ts?: string;
+  updated_ts?: string;
+};

package/api/types/DeviceDeployment.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Deployment } from "./Deployment";
+import type { DeviceWithImage } from "./DeviceWithImage";
+export type DeviceDeployment = {
+  id?: string;
+  deployment: Deployment;
+  device: DeviceWithImage;
+};

package/api/types/DeviceDeployments.ts

@@ -0,0 +1,31 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { DeviceStatus } from "./DeviceStatus";
+
+export type DeviceDeployments = {
+  /**
+   * Device identifier.
+   */
+  id: string;
+  status: DeviceStatus;
+  created?: string;
+  started?: string;
+  finished?: string;
+  deleted?: string;
+  device_type?: string;
+  /**
+   * Availability of the device's deployment log.
+   */
+  log: boolean;
+  /**
+   * State reported by device
+   */
+  state?: string;
+  /**
+   * Additional state information
+   */
+  substate?: string;
+};