swoop-common 2.1.65 → 2.1.66

package/dist/api/generated/core/models/enquiryIdParam.d.ts

@@ -1,4 +1,5 @@
+import type { EnquiryId } from './EnquiryId';
 /**
  * Enquiry Id
  */
-export type enquiryIdParam = string;
+export type enquiryIdParam = EnquiryId;

package/dist/api/generated/itinerary/models/enquiryIdParam.d.ts

@@ -1,4 +1,5 @@
+import type { EnquiryId } from './EnquiryId';
 /**
  * Enquiry Id
  */
-export type enquiryIdParam = string;
+export type enquiryIdParam = EnquiryId;

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

@@ -6,6 +6,7 @@ import type { DTORegionCreate } from '../models/DTORegionCreate';
 import type { DTORegionRead } from '../models/DTORegionRead';
 import type { DTOSnapshotCreate } from '../models/DTOSnapshotCreate';
 import type { DTOSnapshotRead } from '../models/DTOSnapshotRead';
+import type { EnquiryId } from '../models/EnquiryId';
 import type { ItineraryId } from '../models/ItineraryId';
 import type { Pagination } from '../models/Pagination';
 import type { SnapshotId } from '../models/SnapshotId';
@@ -35,7 +36,7 @@ export declare class ItineraryService {
      * @returns any The list of all snapshots given the parameters used
      * @throws ApiError
      */
-    snapshotList(enquiryId: string): CancelablePromise<{
+    snapshotList(enquiryId: EnquiryId): CancelablePromise<{
         snapshots?: Array<DTOSnapshotRead>;
     }>;
     /**
@@ -75,7 +76,7 @@ export declare class ItineraryService {
      * @returns any The tree list view of all itineraries given the parameters used
      * @throws ApiError
      */
-    itineraryList(enquiryId: string): CancelablePromise<{
+    itineraryList(enquiryId: EnquiryId): CancelablePromise<{
         tree?: Array<Branches>;
     }>;
     /**
@@ -86,7 +87,7 @@ export declare class ItineraryService {
      * @returns DTOItineraryRead When a itinerary is created
      * @throws ApiError
      */
-    itineraryCreate(enquiryId: string, requestBody: DTOItineraryCreate): CancelablePromise<DTOItineraryRead>;
+    itineraryCreate(enquiryId: EnquiryId, requestBody: DTOItineraryCreate): CancelablePromise<DTOItineraryRead>;
     /**
      * Get Itinerary
      * Get itinerary via ID
@@ -96,7 +97,7 @@ export declare class ItineraryService {
      * @returns any The corresponding itinerary that matches the enquiry id, tag, and version
      * @throws ApiError
      */
-    itineraryGet(enquiryId: string, tag: string, version: string): CancelablePromise<any>;
+    itineraryGet(enquiryId: EnquiryId, tag: string, version: string): CancelablePromise<any>;
     /**
      * Update Itinerary as New Revision
      * Updates an itinerary as a new revision on the latest version of a branch
@@ -106,7 +107,7 @@ export declare class ItineraryService {
      * @returns DTOItineraryRead When a new revision is created successfully
      * @throws ApiError
      */
-    itineraryUpdateAsNewRevision(enquiryId: string, tag: string, requestBody: DTOItineraryUpdate): CancelablePromise<DTOItineraryRead>;
+    itineraryUpdateAsNewRevision(enquiryId: EnquiryId, tag: string, requestBody: DTOItineraryUpdate): CancelablePromise<DTOItineraryRead>;
     /**
      * Fork an Itinerary
      * this will create a new sub branch off the corresponding itinerary (enquiry id/tag/version)
@@ -116,7 +117,7 @@ export declare class ItineraryService {
      * @returns DTOItineraryRead When the fork was successful
      * @throws ApiError
      */
-    forkItinerary(enquiryId: string, tag: string, version: string): CancelablePromise<DTOItineraryRead>;
+    forkItinerary(enquiryId: EnquiryId, tag: string, version: string): CancelablePromise<DTOItineraryRead>;
     /**
      * Promote an Itinerary
      * This will take itinerary that matches the enquiry id, tag, and version to create a new revision on the head of it's parent branch. This will delete the old sub branch that is being promoted as will exist as the new main head of its parent. Promotions of any tag will always promote into the main branch.
@@ -126,7 +127,7 @@ export declare class ItineraryService {
      * @returns DTOItineraryRead The new head of the parent branch
      * @throws ApiError
      */
-    promoteItinerary(enquiryId: string, tag: string, version: string): CancelablePromise<DTOItineraryRead>;
+    promoteItinerary(enquiryId: EnquiryId, tag: string, version: string): CancelablePromise<DTOItineraryRead>;
     /**
      * Sync Itinerary
      * Sync an itinerary with swoop

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

@@ -57,7 +57,7 @@ export class ItineraryService {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/snapshot/view/{enquiryId}',
-            query: {
+            path: {
                 'enquiryId': enquiryId,
             },
             errors: {
@@ -83,9 +83,10 @@ export class ItineraryService {
                 'snapshotId': snapshotId,
             },
             errors: {
+                400: `If the payload is malformed`,
                 401: `Unauthorized - Missing or invalid Authorization header`,
                 404: `If the snapshot does not exist`,
-                503: `Service Unavailable - The server is temporarily unable to handle the request`,
+                500: `When an internal server error occurs when reading snapshot`,
             },
         });
     }
@@ -106,6 +107,7 @@ export class ItineraryService {
             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`,
             },
@@ -145,7 +147,7 @@ export class ItineraryService {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/itinerary/{enquiryId}/tree',
-            query: {
+            path: {
                 'enquiryId': enquiryId,
             },
             errors: {
@@ -168,7 +170,7 @@ export class ItineraryService {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/itinerary/create/{enquiryId}',
-            query: {
+            path: {
                 'enquiryId': enquiryId,
             },
             body: requestBody,
@@ -194,12 +196,13 @@ export class ItineraryService {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/itinerary/{enquiryId}/{tag}/{version}',
-            query: {
+            path: {
                 'enquiryId': enquiryId,
                 'tag': tag,
                 'version': version,
             },
             errors: {
+                400: `If the payload is malformed`,
                 401: `Unauthorized - Missing or invalid Authorization header`,
                 404: `If the itinerary does not exist as it does not match the enquiry id, tag, and version`,
                 503: `Service Unavailable - The server is temporarily unable to handle the request`,
@@ -219,7 +222,7 @@ export class ItineraryService {
         return __request(OpenAPI, {
             method: 'PUT',
             url: '/itinerary/{enquiryId}/{tag}',
-            query: {
+            path: {
                 'enquiryId': enquiryId,
                 'tag': tag,
             },
@@ -246,7 +249,7 @@ export class ItineraryService {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/itinerary/fork/{enquiryId}/{tag}/{version}',
-            query: {
+            path: {
                 'enquiryId': enquiryId,
                 'tag': tag,
                 'version': version,
@@ -272,7 +275,7 @@ export class ItineraryService {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/itinerary/promote/{enquiryId}/{tag}/{version}',
-            query: {
+            path: {
                 'enquiryId': enquiryId,
                 'tag': tag,
                 'version': version,

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

@@ -1,6 +1,7 @@
 import type { DTOItineraryRead } from '../models/DTOItineraryRead';
 import type { DTOSnapshotCreate } from '../models/DTOSnapshotCreate';
 import type { DTOSnapshotRead } from '../models/DTOSnapshotRead';
+import type { EnquiryId } from '../models/EnquiryId';
 import type { SnapshotId } from '../models/SnapshotId';
 import type { CancelablePromise } from '../core/CancelablePromise';
 export declare class SnapshotService {
@@ -19,7 +20,7 @@ export declare class SnapshotService {
      * @returns any The list of all snapshots given the parameters used
      * @throws ApiError
      */
-    static snapshotList(enquiryId: string): CancelablePromise<{
+    static snapshotList(enquiryId: EnquiryId): CancelablePromise<{
         snapshots?: Array<DTOSnapshotRead>;
     }>;
     /**

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

@@ -33,7 +33,7 @@ export class SnapshotService {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/snapshot/view/{enquiryId}',
-            query: {
+            path: {
                 'enquiryId': enquiryId,
             },
             errors: {
@@ -59,9 +59,10 @@ export class SnapshotService {
                 'snapshotId': snapshotId,
             },
             errors: {
+                400: `If the payload is malformed`,
                 401: `Unauthorized - Missing or invalid Authorization header`,
                 404: `If the snapshot does not exist`,
-                503: `Service Unavailable - The server is temporarily unable to handle the request`,
+                500: `When an internal server error occurs when reading snapshot`,
             },
         });
     }
@@ -82,6 +83,7 @@ export class SnapshotService {
             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`,
             },

package/package.json

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