swoop-common 2.2.21 → 2.2.26

package/dist/api/generated/itinerary/services/SnapshotService.d.ts

@@ -0,0 +1,61 @@
+import type { DTOItineraryRead } from '../models/DTOItineraryRead';
+import type { DTOSnapshotCreate } from '../models/DTOSnapshotCreate';
+import type { DTOSnapshotRead } from '../models/DTOSnapshotRead';
+import type { SnapshotId } from '../models/SnapshotId';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class SnapshotService {
+    /**
+     * Create a Snapshot
+     * Creates a new snapshot. A snapshot is a reference to a specific itinerary revision group id.
+     * @param requestBody
+     * @returns DTOSnapshotRead When a snapshot is created
+     * @throws ApiError
+     */
+    static snapshotCreate(requestBody: DTOSnapshotCreate): CancelablePromise<DTOSnapshotRead>;
+    /**
+     * List Snapshots
+     * List all available snapshots relating to the query params
+     * @param enquiryId
+     * @param page Pagination, starting at page 1
+     * @param limit Number of items per page
+     * @param order Order the sort query parameter values either by ascending or descending order
+     * @param sort List of fields to sort by, this requires the order query param
+     * @param search The search strings to apply to the on query parameter values
+     * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
+     * @returns any The list of all snapshots given the parameters used
+     * @throws ApiError
+     */
+    static snapshotList(enquiryId?: string, page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
+        snapshots?: Array<DTOSnapshotRead>;
+    }>;
+    /**
+     * Get Snapshot va ID
+     * Returns the specific snapshot given its Id
+     * @param snapshotId
+     * @returns any OK
+     * @throws ApiError
+     */
+    static snapshotGet(snapshotId: SnapshotId): CancelablePromise<{
+        snapshot?: DTOSnapshotRead;
+        itinerary?: DTOItineraryRead;
+    }>;
+    /**
+     * Delete Snapshot via ID
+     * Deletes a specific snapshot given its Id
+     * @param snapshotId
+     * @returns void
+     * @throws ApiError
+     */
+    static snapshotDelete(snapshotId: SnapshotId): CancelablePromise<void>;
+    /**
+     * Restore Snapshot
+     * Creates a new itinerary revision given the content the snapshot refers to
+     * @param snapshotId
+     * @returns any When a snapshot is restored as the latest version
+     * @throws ApiError
+     */
+    static snapshotRestore(snapshotId: SnapshotId): CancelablePromise<{
+        snapshot?: DTOSnapshotRead;
+        itinerary?: DTOItineraryRead;
+    }>;
+}

package/dist/api/generated/itinerary/services/SnapshotService.js

@@ -0,0 +1,128 @@
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class SnapshotService {
+    /**
+     * Create a Snapshot
+     * Creates a new snapshot. A snapshot is a reference to a specific itinerary revision group id.
+     * @param requestBody
+     * @returns DTOSnapshotRead When a snapshot is created
+     * @throws ApiError
+     */
+    static snapshotCreate(requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/snapshot',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `If the payload is malformed`,
+                401: `Unauthorized - Missing or invalid Authorization header`,
+                404: `If the entity does not exists`,
+                500: `When an internal server error occurs when creating a snapshot entity`,
+                503: `Service Unavailable - The server is temporarily unable to handle the request`,
+            },
+        });
+    }
+    /**
+     * List Snapshots
+     * List all available snapshots relating to the query params
+     * @param enquiryId
+     * @param page Pagination, starting at page 1
+     * @param limit Number of items per page
+     * @param order Order the sort query parameter values either by ascending or descending order
+     * @param sort List of fields to sort by, this requires the order query param
+     * @param search The search strings to apply to the on query parameter values
+     * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
+     * @returns any The list of all snapshots given the parameters used
+     * @throws ApiError
+     */
+    static snapshotList(enquiryId, page, limit, order, sort, search, on) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/snapshot',
+            query: {
+                'enquiryId': enquiryId,
+                'page': page,
+                'limit': limit,
+                'order': order,
+                'sort': sort,
+                'search': search,
+                'on': on,
+            },
+            errors: {
+                400: `If the filter options or query parameters contain invalid values`,
+                401: `Unauthorized - Missing or invalid Authorization header`,
+                500: `When an internal server error occurs when listing all related snapshots`,
+                503: `Service Unavailable - The server is temporarily unable to handle the request`,
+            },
+        });
+    }
+    /**
+     * Get Snapshot va ID
+     * Returns the specific snapshot given its Id
+     * @param snapshotId
+     * @returns any OK
+     * @throws ApiError
+     */
+    static snapshotGet(snapshotId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/snapshot/{snapshotId}',
+            path: {
+                'snapshotId': snapshotId,
+            },
+            errors: {
+                400: `If the payload is malformed`,
+                401: `Unauthorized - Missing or invalid Authorization header`,
+                404: `If the snapshot does not exist`,
+                500: `When an internal server error occurs when reading snapshot`,
+            },
+        });
+    }
+    /**
+     * Delete Snapshot via ID
+     * Deletes a specific snapshot given its Id
+     * @param snapshotId
+     * @returns void
+     * @throws ApiError
+     */
+    static snapshotDelete(snapshotId) {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/snapshot/{snapshotId}',
+            path: {
+                'snapshotId': snapshotId,
+            },
+            errors: {
+                400: `When the snapshot doesn't exist in the first place, or when a before hook fails before deleting the item`,
+                401: `Unauthorized - Missing or invalid Authorization header`,
+                404: `If the snapshot to delete to does not exist`,
+                500: `When the snapshot fails to delete due to an internal server error`,
+                503: `Service Unavailable - The server is temporarily unable to handle the request`,
+            },
+        });
+    }
+    /**
+     * Restore Snapshot
+     * Creates a new itinerary revision given the content the snapshot refers to
+     * @param snapshotId
+     * @returns any When a snapshot is restored as the latest version
+     * @throws ApiError
+     */
+    static snapshotRestore(snapshotId) {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/snapshot/restore/{snapshotId}',
+            path: {
+                'snapshotId': snapshotId,
+            },
+            errors: {
+                400: `If the payload is malformed`,
+                401: `Unauthorized - Missing or invalid Authorization header`,
+                404: `If the entity does not exists`,
+                500: `When the snapshot fails to restore due to an internal server error`,
+                503: `Service Unavailable - The server is temporarily unable to handle the request`,
+            },
+        });
+    }
+}

package/dist/api/generated/swoop/core/request.js

@@ -237,6 +237,8 @@ export const catchErrorCodes = (options, result) => {
 };
 const unwrapHydra = (json) => {
     const context = json["@context"];
+    if (context == '/api/contexts/Departure')
+        return json["member"];
     // Do nothing if not hydra
     if (!context || typeof context !== "object")
         return json;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swoop-common",
-  "version": "2.2.21",
+  "version": "2.2.26",
   "main": "dist/api/index.js",
   "types": "dist/api/index.d.ts",
   "exports": {