swoop-common 2.1.66 → 2.1.67

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

@@ -1,4 +1,5 @@
 import type { Branches } from '../models/Branches';
+import type { BranchTag } from '../models/BranchTag';
 import type { DTOItineraryCreate } from '../models/DTOItineraryCreate';
 import type { DTOItineraryRead } from '../models/DTOItineraryRead';
 import type { DTOItineraryUpdate } from '../models/DTOItineraryUpdate';
@@ -84,10 +85,14 @@ export declare class ItineraryService {
      * Creates a new itinerary on an Enquiry
      * @param enquiryId Enquiry Id
      * @param requestBody
-     * @returns DTOItineraryRead When a itinerary is created
+     * @returns any When a itinerary is created
      * @throws ApiError
      */
-    itineraryCreate(enquiryId: EnquiryId, requestBody: DTOItineraryCreate): CancelablePromise<DTOItineraryRead>;
+    itineraryCreate(enquiryId: EnquiryId, requestBody: DTOItineraryCreate): CancelablePromise<{
+        itinerary?: DTOItineraryRead;
+        tag?: BranchTag;
+        enquiryId?: EnquiryId;
+    }>;
     /**
      * Get Itinerary
      * Get itinerary via ID
@@ -114,10 +119,14 @@ export declare class ItineraryService {
      * @param enquiryId Enquiry Id
      * @param tag the branch tag
      * @param version the version of a branch
-     * @returns DTOItineraryRead When the fork was successful
+     * @returns any When the fork was successful
      * @throws ApiError
      */
-    forkItinerary(enquiryId: EnquiryId, tag: string, version: string): CancelablePromise<DTOItineraryRead>;
+    forkItinerary(enquiryId: EnquiryId, tag: string, version: string): CancelablePromise<{
+        itinerary?: DTOItineraryRead;
+        tag?: BranchTag;
+        enquiryId?: EnquiryId;
+    }>;
     /**
      * 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.
@@ -129,13 +138,15 @@ export declare class ItineraryService {
      */
     promoteItinerary(enquiryId: EnquiryId, tag: string, version: string): CancelablePromise<DTOItineraryRead>;
     /**
-     * Sync Itinerary
-     * Sync an itinerary with swoop
-     * @param itineraryId Itinerary id
-     * @returns DTOItineraryRead When an itinerary has been posted to pub/sub successfully
+     * Fake Sync Itinerary
+     * Fakes an error when syncing itinerary
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
+     * @param version the version of a branch
+     * @returns void
      * @throws ApiError
      */
-    syncItinerary(itineraryId: ItineraryId): CancelablePromise<DTOItineraryRead>;
+    fakeSyncItinerary(enquiryId: EnquiryId, tag: string, version: string): CancelablePromise<void>;
     /**
      * List Regions
      * List all regions

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

@@ -41,6 +41,7 @@ export class ItineraryService {
             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`,
             },
@@ -130,7 +131,7 @@ export class ItineraryService {
             errors: {
                 400: `If the payload is malformed`,
                 401: `Unauthorized - Missing or invalid Authorization header`,
-                404: `If the snapshot or itinerary to restore to does not exist`,
+                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`,
             },
@@ -163,7 +164,7 @@ export class ItineraryService {
      * Creates a new itinerary on an Enquiry
      * @param enquiryId Enquiry Id
      * @param requestBody
-     * @returns DTOItineraryRead When a itinerary is created
+     * @returns any When a itinerary is created
      * @throws ApiError
      */
     itineraryCreate(enquiryId, requestBody) {
@@ -242,7 +243,7 @@ export class ItineraryService {
      * @param enquiryId Enquiry Id
      * @param tag the branch tag
      * @param version the version of a branch
-     * @returns DTOItineraryRead When the fork was successful
+     * @returns any When the fork was successful
      * @throws ApiError
      */
     forkItinerary(enquiryId, tag, version) {
@@ -289,25 +290,27 @@ export class ItineraryService {
         });
     }
     /**
-     * Sync Itinerary
-     * Sync an itinerary with swoop
-     * @param itineraryId Itinerary id
-     * @returns DTOItineraryRead When an itinerary has been posted to pub/sub successfully
+     * Fake Sync Itinerary
+     * Fakes an error when syncing itinerary
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
+     * @param version the version of a branch
+     * @returns void
      * @throws ApiError
      */
-    syncItinerary(itineraryId) {
+    fakeSyncItinerary(enquiryId, tag, version) {
         return __request(OpenAPI, {
             method: 'POST',
-            url: '/sync/{itineraryId}',
+            url: '/itinerary/fake/sync/{enquiryId}/{tag}/{version}',
             path: {
-                'itineraryId': itineraryId,
+                'enquiryId': enquiryId,
+                'tag': tag,
+                'version': version,
             },
             errors: {
-                400: `When the itinerary to sync does not exist`,
+                400: `The faked error`,
                 401: `Unauthorized - Missing or invalid Authorization header`,
-                404: `Related entity not found`,
                 500: `When an internal server error occurs whilst syncing`,
-                503: `Service Unavailable - The server is temporarily unable to handle the request`,
             },
         });
     }

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

@@ -17,6 +17,7 @@ export class SnapshotService {
             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`,
             },
@@ -106,7 +107,7 @@ export class SnapshotService {
             errors: {
                 400: `If the payload is malformed`,
                 401: `Unauthorized - Missing or invalid Authorization header`,
-                404: `If the snapshot or itinerary to restore to does not exist`,
+                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/package.json

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