@boatdev/sdk 1.0.1 → 1.1.0

package/src/models/DeletionOperation.ts

@@ -49,6 +49,18 @@ export interface DeletionOperation {
      * @memberof DeletionOperation
      */
     status: DeletionOperationStatusEnum;
+    /**
+     * What the background purge is doing. The target is already gone from every list, restore and fork once the operation exists. `waiting_for_uploads`: stored data is erased once the last upload URL issued for it expires (`expectedBy`). `kept_for_newer_snapshots`: a newer snapshot you kept is built on this one; its data goes when they go. `waiting_for_restore`: a sandbox is still restoring from it. `retrying`: a transient fault, retried automatically.
+     * @type {DeletionOperationStageEnum}
+     * @memberof DeletionOperation
+     */
+    stage?: DeletionOperationStageEnum;
+    /**
+     * When `waiting_for_uploads` ends.
+     * @type {Date}
+     * @memberof DeletionOperation
+     */
+    expectedBy?: Date | null;
     /**
      * 
      * @type {number}
@@ -100,6 +112,19 @@ export const DeletionOperationStatusEnum = {
 } as const;
 export type DeletionOperationStatusEnum = typeof DeletionOperationStatusEnum[keyof typeof DeletionOperationStatusEnum];
 
+/**
+ * @export
+ */
+export const DeletionOperationStageEnum = {
+    Removing: 'removing',
+    WaitingForUploads: 'waiting_for_uploads',
+    KeptForNewerSnapshots: 'kept_for_newer_snapshots',
+    WaitingForRestore: 'waiting_for_restore',
+    Retrying: 'retrying',
+    Completed: 'completed'
+} as const;
+export type DeletionOperationStageEnum = typeof DeletionOperationStageEnum[keyof typeof DeletionOperationStageEnum];
+
 
 /**
  * Check if a given object implements the DeletionOperation interface.
@@ -131,6 +156,8 @@ export function DeletionOperationFromJSONTyped(json: any, ignoreDiscriminator: b
         'targetId': json['targetId'],
         'reason': json['reason'],
         'status': json['status'],
+        'stage': json['stage'] == null ? undefined : json['stage'],
+        'expectedBy': json['expectedBy'] == null ? undefined : (new Date(json['expectedBy'])),
         'attemptCount': json['attemptCount'],
         'requestedAt': (new Date(json['requestedAt'])),
         'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
@@ -153,6 +180,8 @@ export function DeletionOperationToJSONTyped(value?: DeletionOperation | null, i
         'targetId': value['targetId'],
         'reason': value['reason'],
         'status': value['status'],
+        'stage': value['stage'],
+        'expectedBy': value['expectedBy'] == null ? value['expectedBy'] : value['expectedBy'].toISOString(),
         'attemptCount': value['attemptCount'],
         'requestedAt': value['requestedAt'].toISOString(),
         'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),

package/src/models/DeletionOperationListResponse.ts

@@ -0,0 +1,102 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { DeletionOperation } from './DeletionOperation';
+import {
+    DeletionOperationFromJSON,
+    DeletionOperationFromJSONTyped,
+    DeletionOperationToJSON,
+    DeletionOperationToJSONTyped,
+} from './DeletionOperation';
+
+/**
+ * 
+ * @export
+ * @interface DeletionOperationListResponse
+ */
+export interface DeletionOperationListResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DeletionOperationListResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {DeletionOperationListResponseTypeEnum}
+     * @memberof DeletionOperationListResponse
+     */
+    type: DeletionOperationListResponseTypeEnum;
+    /**
+     * 
+     * @type {Array<DeletionOperation>}
+     * @memberof DeletionOperationListResponse
+     */
+    operations: Array<DeletionOperation>;
+}
+
+
+/**
+ * @export
+ */
+export const DeletionOperationListResponseTypeEnum = {
+    SnapshotDeleting: 'snapshot.deleting'
+} as const;
+export type DeletionOperationListResponseTypeEnum = typeof DeletionOperationListResponseTypeEnum[keyof typeof DeletionOperationListResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the DeletionOperationListResponse interface.
+ */
+export function instanceOfDeletionOperationListResponse(value: object): value is DeletionOperationListResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('operations' in value) || value['operations'] === undefined) return false;
+    return true;
+}
+
+export function DeletionOperationListResponseFromJSON(json: any): DeletionOperationListResponse {
+    return DeletionOperationListResponseFromJSONTyped(json, false);
+}
+
+export function DeletionOperationListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeletionOperationListResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'operations': ((json['operations'] as Array<any>).map(DeletionOperationFromJSON)),
+    };
+}
+
+export function DeletionOperationListResponseToJSON(json: any): DeletionOperationListResponse {
+    return DeletionOperationListResponseToJSONTyped(json, false);
+}
+
+export function DeletionOperationListResponseToJSONTyped(value?: DeletionOperationListResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'operations': ((value['operations'] as Array<any>).map(DeletionOperationToJSON)),
+    };
+}
+

package/src/models/index.ts

@@ -33,6 +33,7 @@ export * from './CreateScopedApiKeyRequest';
 export * from './DataRetentionPolicyResponse';
 export * from './DataRetentionUpdateRequest';
 export * from './DeletionOperation';
+export * from './DeletionOperationListResponse';
 export * from './DeletionOperationResponse';
 export * from './DesktopRequest';
 export * from './DesktopResponse';

package/src/runtime.ts

@@ -447,3 +447,26 @@ export class TextApiResponse {
         return await this.raw.text();
     };
 }
+
+
+/**
+ * A body-taking call's parameters with the body's fields inline, next to the
+ * path/query/header parameters: `fork({ sandboxId, type: 'small' })` is
+ * `fork({ sandboxId, forkRequest: { type: 'small' } })`. Both shapes are accepted.
+ */
+export type FlatBody<R, K extends keyof R> = Omit<R, K> & NonNullable<R[K]>;
+
+/** Turns either call shape into the wrapped one the generated code sends. */
+export function unflattenBody<R>(input: object, bodyKey: string, paramKeys: string[], sharedKeys: string[]): R {
+    if (input == null || bodyKey in input) return input as R;
+    const params: any = {};
+    const body: any = {};
+    for (const [k, v] of Object.entries(input)) {
+        const isParam = paramKeys.indexOf(k) !== -1;
+        if (isParam) params[k] = v;
+        if (!isParam || sharedKeys.indexOf(k) !== -1) body[k] = v;
+    }
+    // No body field given: send no body, exactly like the wrapped call with the key omitted.
+    if (Object.keys(body).length > 0) params[bodyKey] = body;
+    return params as R;
+}