swoop-common 2.1.64 → 2.1.65

package/dist/api/generated/core/exports.d.ts

@@ -72,6 +72,7 @@ export type { search } from './index';
 export type { SnapshotId } from './index';
 export type { snapshotIdParam } from './index';
 export type { sortParam } from './index';
+export type { tag } from './index';
 export type { TemplateId } from './index';
 export type { templateIdParam } from './index';
 export type { TemplateRevisionGroupId } from './index';
@@ -79,3 +80,4 @@ export type { Title } from './index';
 export { UrgencyCTA } from './index';
 export type { UserComponentInstanceField } from './index';
 export type { ValidationSchemas } from './index';
+export type { version } from './index';

package/dist/api/generated/core/index.d.ts

@@ -74,6 +74,7 @@ export type { search } from './models/search';
 export type { SnapshotId } from './models/SnapshotId';
 export type { snapshotIdParam } from './models/snapshotIdParam';
 export type { sortParam } from './models/sortParam';
+export type { tag } from './models/tag';
 export type { TemplateId } from './models/TemplateId';
 export type { templateIdParam } from './models/templateIdParam';
 export type { TemplateRevisionGroupId } from './models/TemplateRevisionGroupId';
@@ -81,6 +82,7 @@ export type { Title } from './models/Title';
 export { UrgencyCTA } from './models/UrgencyCTA';
 export type { UserComponentInstanceField } from './models/UserComponentInstanceField';
 export type { ValidationSchemas } from './models/ValidationSchemas';
+export type { version } from './models/version';
 export { ComponentService } from './services/ComponentService';
 export { CoreService } from './services/CoreService';
 export { TemplateService } from './services/TemplateService';

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

@@ -0,0 +1,4 @@
+/**
+ * the branch tag
+ */
+export type tag = string;

package/dist/api/generated/core/models/tag.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,4 @@
+/**
+ * the version of a branch
+ */
+export type version = string;

package/dist/api/generated/core/models/version.js

@@ -0,0 +1 @@
+export {};

package/dist/api/generated/itinerary/index.d.ts

@@ -74,6 +74,7 @@ export type { search } from './models/search';
 export type { SnapshotId } from './models/SnapshotId';
 export type { snapshotIdParam } from './models/snapshotIdParam';
 export type { sortParam } from './models/sortParam';
+export type { tag } from './models/tag';
 export type { TemplateId } from './models/TemplateId';
 export type { templateIdParam } from './models/templateIdParam';
 export type { TemplateRevisionGroupId } from './models/TemplateRevisionGroupId';
@@ -81,6 +82,7 @@ export type { Title } from './models/Title';
 export { UrgencyCTA } from './models/UrgencyCTA';
 export type { UserComponentInstanceField } from './models/UserComponentInstanceField';
 export type { ValidationSchemas } from './models/ValidationSchemas';
+export type { version } from './models/version';
 export { AuditService } from './services/AuditService';
 export { ItineraryService } from './services/ItineraryService';
 export { RegionService } from './services/RegionService';

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

@@ -0,0 +1,4 @@
+/**
+ * the branch tag
+ */
+export type tag = string;

package/dist/api/generated/itinerary/models/tag.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,4 @@
+/**
+ * the version of a branch
+ */
+export type version = string;

package/dist/api/generated/itinerary/models/version.js

@@ -0,0 +1 @@
+export {};

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

@@ -1,3 +1,4 @@
+import type { Branches } from '../models/Branches';
 import type { DTOItineraryCreate } from '../models/DTOItineraryCreate';
 import type { DTOItineraryRead } from '../models/DTOItineraryRead';
 import type { DTOItineraryUpdate } from '../models/DTOItineraryUpdate';
@@ -28,18 +29,14 @@ export declare class ItineraryService {
      */
     snapshotCreate(requestBody: DTOSnapshotCreate): CancelablePromise<DTOSnapshotRead>;
     /**
-     * List Snapshots
-     * List all available snapshots
+     * List Snapshots relating to a specific enquiry id
+     * List all available snapshots relating to a specific enquiry id
      * @param enquiryId Enquiry Id
-     * @param page Pagination, starting at page 1
-     * @param limit Number of items per page
-     * @param sort List of fields to sort by
      * @returns any The list of all snapshots given the parameters used
      * @throws ApiError
      */
-    snapshotList(enquiryId: string, page?: number, limit?: number, sort?: any[]): CancelablePromise<{
-        data?: Array<DTOSnapshotRead>;
-        pagination?: Pagination;
+    snapshotList(enquiryId: string): CancelablePromise<{
+        snapshots?: Array<DTOSnapshotRead>;
     }>;
     /**
      * Get Snapshot va ID
@@ -48,7 +45,10 @@ export declare class ItineraryService {
      * @returns any OK
      * @throws ApiError
      */
-    snapshotGet(snapshotId: SnapshotId): CancelablePromise<any>;
+    snapshotGet(snapshotId: SnapshotId): CancelablePromise<{
+        snapshot?: DTOSnapshotRead;
+        itinerary?: DTOItineraryRead;
+    }>;
     /**
      * Delete Snapshot via ID
      * Deletes a specific snapshot given its Id
@@ -64,55 +64,69 @@ export declare class ItineraryService {
      * @returns any When a snapshot is restored as the latest version
      * @throws ApiError
      */
-    snapshotRestore(snapshotId: SnapshotId): CancelablePromise<any>;
+    snapshotRestore(snapshotId: SnapshotId): CancelablePromise<{
+        snapshot?: DTOSnapshotRead;
+        itinerary?: DTOItineraryRead;
+    }>;
     /**
-     * List Itineraries
-     * List all itineraries
-     * @param page Pagination, starting at page 1
-     * @param limit Number of items per page
-     * @param search Search term
-     * @param sort List of fields to sort by
-     * @param enquiryId Filter itineraries via enquiryId
-     * @returns any The list of all itineraries given the parameters used
+     * List Tree view of Itineraries
+     * List all itineraries in a tree view for a specific enquiry id
+     * @param enquiryId Enquiry Id
+     * @returns any The tree list view of all itineraries given the parameters used
      * @throws ApiError
      */
-    itineraryList(page?: number, limit?: number, search?: string, sort?: any[], enquiryId?: string): CancelablePromise<{
-        data?: Array<DTOItineraryRead>;
-        pagination?: Pagination;
+    itineraryList(enquiryId: string): CancelablePromise<{
+        tree?: Array<Branches>;
     }>;
     /**
-     * Create an Itinerary
-     * Creates a new itinerary
+     * Create an Itinerary on an Enquiry
+     * Creates a new itinerary on an Enquiry
+     * @param enquiryId Enquiry Id
      * @param requestBody
      * @returns DTOItineraryRead When a itinerary is created
      * @throws ApiError
      */
-    itineraryCreate(requestBody: DTOItineraryCreate): CancelablePromise<DTOItineraryRead>;
+    itineraryCreate(enquiryId: string, requestBody: DTOItineraryCreate): CancelablePromise<DTOItineraryRead>;
     /**
      * Get Itinerary
      * Get itinerary via ID
-     * @param itineraryId Itinerary id
-     * @returns any OK
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
+     * @param version the version of a branch
+     * @returns any The corresponding itinerary that matches the enquiry id, tag, and version
      * @throws ApiError
      */
-    itineraryGet(itineraryId: ItineraryId): CancelablePromise<any>;
+    itineraryGet(enquiryId: string, tag: string, version: string): CancelablePromise<any>;
     /**
      * Update Itinerary as New Revision
-     * Updates an itinerary as a new revision
-     * @param itineraryId Itinerary id
+     * Updates an itinerary as a new revision on the latest version of a branch
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
      * @param requestBody
      * @returns DTOItineraryRead When a new revision is created successfully
      * @throws ApiError
      */
-    itineraryUpdateAsNewRevision(itineraryId: ItineraryId, requestBody: DTOItineraryUpdate): CancelablePromise<DTOItineraryRead>;
+    itineraryUpdateAsNewRevision(enquiryId: string, tag: string, requestBody: DTOItineraryUpdate): CancelablePromise<DTOItineraryRead>;
     /**
-     * Delete Itinerary via ID
-     * Deletes a specific itinerary given its Id
-     * @param itineraryId Itinerary id
-     * @returns void
+     * Fork an Itinerary
+     * this will create a new sub branch off the corresponding itinerary (enquiry id/tag/version)
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
+     * @param version the version of a branch
+     * @returns DTOItineraryRead When the fork was successful
+     * @throws ApiError
+     */
+    forkItinerary(enquiryId: string, 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.
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
+     * @param version the version of a branch
+     * @returns DTOItineraryRead The new head of the parent branch
      * @throws ApiError
      */
-    itineraryDelete(itineraryId: ItineraryId): CancelablePromise<void>;
+    promoteItinerary(enquiryId: string, tag: string, version: string): CancelablePromise<DTOItineraryRead>;
     /**
      * Sync Itinerary
      * Sync an itinerary with swoop

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

@@ -35,7 +35,7 @@ export class ItineraryService {
     snapshotCreate(requestBody) {
         return __request(OpenAPI, {
             method: 'POST',
-            url: '/snapshots',
+            url: '/snapshot',
             body: requestBody,
             mediaType: 'application/json',
             errors: {
@@ -47,23 +47,17 @@ export class ItineraryService {
         });
     }
     /**
-     * List Snapshots
-     * List all available snapshots
+     * List Snapshots relating to a specific enquiry id
+     * List all available snapshots relating to a specific enquiry id
      * @param enquiryId Enquiry Id
-     * @param page Pagination, starting at page 1
-     * @param limit Number of items per page
-     * @param sort List of fields to sort by
      * @returns any The list of all snapshots given the parameters used
      * @throws ApiError
      */
-    snapshotList(enquiryId, page, limit, sort) {
+    snapshotList(enquiryId) {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/snapshots',
+            url: '/snapshot/view/{enquiryId}',
             query: {
-                'page': page,
-                'limit': limit,
-                'sort': sort,
                 'enquiryId': enquiryId,
             },
             errors: {
@@ -84,7 +78,7 @@ export class ItineraryService {
     snapshotGet(snapshotId) {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/snapshots/{snapshotId}',
+            url: '/snapshot/{snapshotId}',
             path: {
                 'snapshotId': snapshotId,
             },
@@ -105,7 +99,7 @@ export class ItineraryService {
     snapshotDelete(snapshotId) {
         return __request(OpenAPI, {
             method: 'DELETE',
-            url: '/snapshots/{snapshotId}',
+            url: '/snapshot/{snapshotId}',
             path: {
                 'snapshotId': snapshotId,
             },
@@ -127,7 +121,7 @@ export class ItineraryService {
     snapshotRestore(snapshotId) {
         return __request(OpenAPI, {
             method: 'PUT',
-            url: '/snapshots/restore/{snapshotId}',
+            url: '/snapshot/restore/{snapshotId}',
             path: {
                 'snapshotId': snapshotId,
             },
@@ -141,25 +135,17 @@ export class ItineraryService {
         });
     }
     /**
-     * List Itineraries
-     * List all itineraries
-     * @param page Pagination, starting at page 1
-     * @param limit Number of items per page
-     * @param search Search term
-     * @param sort List of fields to sort by
-     * @param enquiryId Filter itineraries via enquiryId
-     * @returns any The list of all itineraries given the parameters used
+     * List Tree view of Itineraries
+     * List all itineraries in a tree view for a specific enquiry id
+     * @param enquiryId Enquiry Id
+     * @returns any The tree list view of all itineraries given the parameters used
      * @throws ApiError
      */
-    itineraryList(page, limit, search, sort, enquiryId) {
+    itineraryList(enquiryId) {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/itineraries',
+            url: '/itinerary/{enquiryId}/tree',
             query: {
-                'page': page,
-                'limit': limit,
-                'search': search,
-                'sort': sort,
                 'enquiryId': enquiryId,
             },
             errors: {
@@ -171,16 +157,20 @@ export class ItineraryService {
         });
     }
     /**
-     * Create an Itinerary
-     * Creates a new itinerary
+     * Create an Itinerary on an Enquiry
+     * Creates a new itinerary on an Enquiry
+     * @param enquiryId Enquiry Id
      * @param requestBody
      * @returns DTOItineraryRead When a itinerary is created
      * @throws ApiError
      */
-    itineraryCreate(requestBody) {
+    itineraryCreate(enquiryId, requestBody) {
         return __request(OpenAPI, {
             method: 'POST',
-            url: '/itineraries',
+            url: '/itinerary/create/{enquiryId}',
+            query: {
+                'enquiryId': enquiryId,
+            },
             body: requestBody,
             mediaType: 'application/json',
             errors: {
@@ -194,69 +184,104 @@ export class ItineraryService {
     /**
      * Get Itinerary
      * Get itinerary via ID
-     * @param itineraryId Itinerary id
-     * @returns any OK
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
+     * @param version the version of a branch
+     * @returns any The corresponding itinerary that matches the enquiry id, tag, and version
      * @throws ApiError
      */
-    itineraryGet(itineraryId) {
+    itineraryGet(enquiryId, tag, version) {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/itineraries/{itineraryId}',
-            path: {
-                'itineraryId': itineraryId,
+            url: '/itinerary/{enquiryId}/{tag}/{version}',
+            query: {
+                'enquiryId': enquiryId,
+                'tag': tag,
+                'version': version,
             },
             errors: {
                 401: `Unauthorized - Missing or invalid Authorization header`,
-                404: `If the itinerary does not exist`,
+                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`,
             },
         });
     }
     /**
      * Update Itinerary as New Revision
-     * Updates an itinerary as a new revision
-     * @param itineraryId Itinerary id
+     * Updates an itinerary as a new revision on the latest version of a branch
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
      * @param requestBody
      * @returns DTOItineraryRead When a new revision is created successfully
      * @throws ApiError
      */
-    itineraryUpdateAsNewRevision(itineraryId, requestBody) {
+    itineraryUpdateAsNewRevision(enquiryId, tag, requestBody) {
         return __request(OpenAPI, {
-            method: 'PATCH',
-            url: '/itineraries/{itineraryId}',
-            path: {
-                'itineraryId': itineraryId,
+            method: 'PUT',
+            url: '/itinerary/{enquiryId}/{tag}',
+            query: {
+                'enquiryId': enquiryId,
+                'tag': tag,
             },
             body: requestBody,
             mediaType: 'application/json',
             errors: {
                 400: `If the payload is malformed`,
                 401: `Unauthorized - Missing or invalid Authorization header`,
-                404: `When the itinerary id to create a new revision from is not found`,
+                404: `When the itinerary enquiry id and tag do not exists`,
                 500: `When an internal server error occurs updating an itinerary as a new revision`,
-                503: `Service Unavailable - The server is temporarily unable to handle the request`,
             },
         });
     }
     /**
-     * Delete Itinerary via ID
-     * Deletes a specific itinerary given its Id
-     * @param itineraryId Itinerary id
-     * @returns void
+     * Fork an Itinerary
+     * this will create a new sub branch off the corresponding itinerary (enquiry id/tag/version)
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
+     * @param version the version of a branch
+     * @returns DTOItineraryRead When the fork was successful
      * @throws ApiError
      */
-    itineraryDelete(itineraryId) {
+    forkItinerary(enquiryId, tag, version) {
         return __request(OpenAPI, {
-            method: 'DELETE',
-            url: '/itineraries/{itineraryId}',
-            path: {
-                'itineraryId': itineraryId,
+            method: 'POST',
+            url: '/itinerary/fork/{enquiryId}/{tag}/{version}',
+            query: {
+                'enquiryId': enquiryId,
+                'tag': tag,
+                'version': version,
             },
             errors: {
-                400: `When the itinerary doesn't exist in the first place, or when a before hook fails before deleting the item`,
+                400: `If the payload is malformed`,
                 401: `Unauthorized - Missing or invalid Authorization header`,
-                500: `When the itinerary fails to delete due to an internal server error`,
-                503: `Service Unavailable - The server is temporarily unable to handle the request`,
+                404: `When the itinerary enquiry id and tag do not exists`,
+                500: `When an internal server error occurs updating an itinerary as a new revision`,
+            },
+        });
+    }
+    /**
+     * 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.
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
+     * @param version the version of a branch
+     * @returns DTOItineraryRead The new head of the parent branch
+     * @throws ApiError
+     */
+    promoteItinerary(enquiryId, tag, version) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/itinerary/promote/{enquiryId}/{tag}/{version}',
+            query: {
+                'enquiryId': enquiryId,
+                'tag': tag,
+                'version': version,
+            },
+            errors: {
+                400: `If the payload is malformed`,
+                401: `Unauthorized - Missing or invalid Authorization header`,
+                404: `When the itinerary enquiry id and tag do not exists`,
+                500: `When an internal server error occurs updating an itinerary as a new revision`,
             },
         });
     }
@@ -295,7 +320,7 @@ export class ItineraryService {
     regionList(page, limit, sort) {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/regions',
+            url: '/region',
             query: {
                 'page': page,
                 'limit': limit,
@@ -319,7 +344,7 @@ export class ItineraryService {
     regionCreate(requestBody) {
         return __request(OpenAPI, {
             method: 'POST',
-            url: '/regions',
+            url: '/region',
             body: requestBody,
             mediaType: 'application/json',
             errors: {

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

@@ -13,7 +13,7 @@ export class RegionService {
     static regionList(page, limit, sort) {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/regions',
+            url: '/region',
             query: {
                 'page': page,
                 'limit': limit,
@@ -37,7 +37,7 @@ export class RegionService {
     static regionCreate(requestBody) {
         return __request(OpenAPI, {
             method: 'POST',
-            url: '/regions',
+            url: '/region',
             body: requestBody,
             mediaType: 'application/json',
             errors: {

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

@@ -1,6 +1,6 @@
+import type { DTOItineraryRead } from '../models/DTOItineraryRead';
 import type { DTOSnapshotCreate } from '../models/DTOSnapshotCreate';
 import type { DTOSnapshotRead } from '../models/DTOSnapshotRead';
-import type { Pagination } from '../models/Pagination';
 import type { SnapshotId } from '../models/SnapshotId';
 import type { CancelablePromise } from '../core/CancelablePromise';
 export declare class SnapshotService {
@@ -13,18 +13,14 @@ export declare class SnapshotService {
      */
     static snapshotCreate(requestBody: DTOSnapshotCreate): CancelablePromise<DTOSnapshotRead>;
     /**
-     * List Snapshots
-     * List all available snapshots
+     * List Snapshots relating to a specific enquiry id
+     * List all available snapshots relating to a specific enquiry id
      * @param enquiryId Enquiry Id
-     * @param page Pagination, starting at page 1
-     * @param limit Number of items per page
-     * @param sort List of fields to sort by
      * @returns any The list of all snapshots given the parameters used
      * @throws ApiError
      */
-    static snapshotList(enquiryId: string, page?: number, limit?: number, sort?: any[]): CancelablePromise<{
-        data?: Array<DTOSnapshotRead>;
-        pagination?: Pagination;
+    static snapshotList(enquiryId: string): CancelablePromise<{
+        snapshots?: Array<DTOSnapshotRead>;
     }>;
     /**
      * Get Snapshot va ID
@@ -33,7 +29,10 @@ export declare class SnapshotService {
      * @returns any OK
      * @throws ApiError
      */
-    static snapshotGet(snapshotId: SnapshotId): CancelablePromise<any>;
+    static snapshotGet(snapshotId: SnapshotId): CancelablePromise<{
+        snapshot?: DTOSnapshotRead;
+        itinerary?: DTOItineraryRead;
+    }>;
     /**
      * Delete Snapshot via ID
      * Deletes a specific snapshot given its Id
@@ -49,5 +48,8 @@ export declare class SnapshotService {
      * @returns any When a snapshot is restored as the latest version
      * @throws ApiError
      */
-    static snapshotRestore(snapshotId: SnapshotId): CancelablePromise<any>;
+    static snapshotRestore(snapshotId: SnapshotId): CancelablePromise<{
+        snapshot?: DTOSnapshotRead;
+        itinerary?: DTOItineraryRead;
+    }>;
 }

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

@@ -11,7 +11,7 @@ export class SnapshotService {
     static snapshotCreate(requestBody) {
         return __request(OpenAPI, {
             method: 'POST',
-            url: '/snapshots',
+            url: '/snapshot',
             body: requestBody,
             mediaType: 'application/json',
             errors: {
@@ -23,23 +23,17 @@ export class SnapshotService {
         });
     }
     /**
-     * List Snapshots
-     * List all available snapshots
+     * List Snapshots relating to a specific enquiry id
+     * List all available snapshots relating to a specific enquiry id
      * @param enquiryId Enquiry Id
-     * @param page Pagination, starting at page 1
-     * @param limit Number of items per page
-     * @param sort List of fields to sort by
      * @returns any The list of all snapshots given the parameters used
      * @throws ApiError
      */
-    static snapshotList(enquiryId, page, limit, sort) {
+    static snapshotList(enquiryId) {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/snapshots',
+            url: '/snapshot/view/{enquiryId}',
             query: {
-                'page': page,
-                'limit': limit,
-                'sort': sort,
                 'enquiryId': enquiryId,
             },
             errors: {
@@ -60,7 +54,7 @@ export class SnapshotService {
     static snapshotGet(snapshotId) {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/snapshots/{snapshotId}',
+            url: '/snapshot/{snapshotId}',
             path: {
                 'snapshotId': snapshotId,
             },
@@ -81,7 +75,7 @@ export class SnapshotService {
     static snapshotDelete(snapshotId) {
         return __request(OpenAPI, {
             method: 'DELETE',
-            url: '/snapshots/{snapshotId}',
+            url: '/snapshot/{snapshotId}',
             path: {
                 'snapshotId': snapshotId,
             },
@@ -103,7 +97,7 @@ export class SnapshotService {
     static snapshotRestore(snapshotId) {
         return __request(OpenAPI, {
             method: 'PUT',
-            url: '/snapshots/restore/{snapshotId}',
+            url: '/snapshot/restore/{snapshotId}',
             path: {
                 'snapshotId': snapshotId,
             },

package/package.json

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