swoop-common 2.2.4 → 2.2.6

package/README.md

@@ -1,4 +1,4 @@
-# Swoop Library
+.# Swoop Library
 
 This library is used for rendering **Swoop itinerary templates**.
 It provides tools for defining **custom field types**, registering **custom components**,

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

@@ -3,7 +3,6 @@ export { CancelablePromise, CancelError } from './index';
 export type { Amendment } from './index';
 export type { AssignedPassenger } from './index';
 export type { AssignedTravellerGroup } from './index';
-export type { B64StringQueryParam } from './index';
 export { BookingStatus } from './index';
 export type { Branches } from './index';
 export type { BranchId } from './index';

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

@@ -5,7 +5,6 @@ export type { OpenAPIConfig } from './core/OpenAPI';
 export type { Amendment } from './models/Amendment';
 export type { AssignedPassenger } from './models/AssignedPassenger';
 export type { AssignedTravellerGroup } from './models/AssignedTravellerGroup';
-export type { B64StringQueryParam } from './models/B64StringQueryParam';
 export { BookingStatus } from './models/BookingStatus';
 export type { Branches } from './models/Branches';
 export type { BranchId } from './models/BranchId';
@@ -97,7 +96,6 @@ export { UrgencyCTA } from './models/UrgencyCTA';
 export type { UserComponentInstanceField } from './models/UserComponentInstanceField';
 export type { ValidationSchemas } from './models/ValidationSchemas';
 export type { VersionPathParam } from './models/VersionPathParam';
-export { AuditService } from './services/AuditService';
 export { ComponentService } from './services/ComponentService';
 export { CoreService } from './services/CoreService';
 export { ItineraryService } from './services/ItineraryService';

package/dist/api/generated/core/index.js

@@ -13,7 +13,6 @@ export { Meals } from './models/Meals';
 export { OrderQueryParam } from './models/OrderQueryParam';
 export { OrgId } from './models/OrgId';
 export { UrgencyCTA } from './models/UrgencyCTA';
-export { AuditService } from './services/AuditService';
 export { ComponentService } from './services/ComponentService';
 export { CoreService } from './services/CoreService';
 export { ItineraryService } from './services/ItineraryService';

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

@@ -1,4 +1,4 @@
 /**
  * List of fields to sort by, this requires the order query param
  */
-export type SortQueryParam = any[];
+export type SortQueryParam = Array<string>;

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

@@ -1,7 +1,7 @@
 import type { SwooperHighlights } from './SwooperHighlights';
 export type SwooperPersonalInfo = {
-    highlights?: SwooperHighlights;
-    interests?: Array<string>;
-    dayToDay?: string;
-    startedInTravel?: number;
+    highlights: SwooperHighlights;
+    interests: Array<string>;
+    dayToDay: string;
+    startedInTravel: number;
 };

package/dist/api/generated/core/services/ComponentService.d.ts

@@ -15,12 +15,12 @@ export declare class ComponentService {
      * @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 component given the parameters used
+     * @returns any Paginated response of components
      * @throws ApiError
      */
-    static componentList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
-        data?: Array<DTOComponentRead>;
+    static componentList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: Array<string>, search?: Array<string>, on?: Array<string>): CancelablePromise<{
         pagination?: Pagination;
+        data?: Array<DTOComponentRead>;
     }>;
     /**
      * Create a Component
@@ -69,8 +69,8 @@ export declare class ComponentService {
      * Directly update component state. This does not create a new revision
      * @param componentId Id of a component
      * @param state The publishing state of the component
-     * @returns any OK
+     * @returns DTOComponentRead When the state was updated successfully
      * @throws ApiError
      */
-    static componentStateUpdate(componentId: ComponentId, state: ComponentState): CancelablePromise<any>;
+    static componentStateUpdate(componentId: ComponentId, state: ComponentState): CancelablePromise<DTOComponentRead>;
 }

package/dist/api/generated/core/services/ComponentService.js

@@ -10,7 +10,7 @@ export class ComponentService {
      * @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 component given the parameters used
+     * @returns any Paginated response of components
      * @throws ApiError
      */
     static componentList(page, limit, order, sort, search, on) {
@@ -26,10 +26,9 @@ export class ComponentService {
                 'on': on,
             },
             errors: {
-                400: `If the filter options or query parameters contain invalid values`,
-                401: `Unauthorized - Missing or invalid Authorization header`,
-                403: `Forbidden - The client is authenticated but not authorized to access this resource`,
-                500: `When an internal server error occurs when listing all related component`,
+                400: `If the payload is malformed`,
+                401: `When the client is not authorised`,
+                500: `When an unexpected error occurs`,
             },
         });
     }
@@ -69,9 +68,10 @@ export class ComponentService {
                 'componentId': componentId,
             },
             errors: {
-                401: `Missing or invalid Authorization header`,
-                403: `The client is authenticated but not authorized to access this resource`,
-                404: `If a resource is not found`,
+                400: `If the payload is malformed`,
+                401: `Unauthorized - Missing or invalid Authorization header`,
+                403: `Forbidden - The client is authenticated but not authorized to access this resource`,
+                404: `If a resource does not exist`,
                 500: `Internal Server Error`,
             },
         });
@@ -97,8 +97,8 @@ export class ComponentService {
                 400: `If the payload is malformed`,
                 401: `Unauthorized - Missing or invalid Authorization header`,
                 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
-                404: `When the component id to create a new revision from is not found`,
-                500: `When an internal server error occurs updating a component as a new revision`,
+                404: `If a resource does not exist`,
+                500: `Internal Server Error`,
             },
         });
     }
@@ -123,8 +123,8 @@ export class ComponentService {
                 400: `If the payload is malformed`,
                 401: `Unauthorized - Missing or invalid Authorization header`,
                 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
-                404: `When the component id to update is not found`,
-                500: `When an internal server error occurs updating a component`,
+                404: `If a resource does not exist`,
+                500: `Internal Server Error`,
             },
         });
     }
@@ -143,11 +143,11 @@ export class ComponentService {
                 'componentId': componentId,
             },
             errors: {
-                400: `When the component 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`,
                 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
-                404: `Not Found`,
-                500: `When the component fails to delete due to an internal server error`,
+                404: `If a resource does not exist`,
+                500: `Internal Server Error`,
             },
         });
     }
@@ -156,7 +156,7 @@ export class ComponentService {
      * Directly update component state. This does not create a new revision
      * @param componentId Id of a component
      * @param state The publishing state of the component
-     * @returns any OK
+     * @returns DTOComponentRead When the state was updated successfully
      * @throws ApiError
      */
     static componentStateUpdate(componentId, state) {
@@ -170,9 +170,11 @@ export class ComponentService {
                 'state': state,
             },
             errors: {
+                400: `If the payload is malformed`,
                 401: `Unauthorized - Missing or invalid Authorization header`,
                 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
-                404: `Not Found`,
+                404: `If a resource does not exist`,
+                500: `Internal Server Error`,
             },
         });
     }

package/dist/api/generated/core/services/CoreService.d.ts

@@ -19,33 +19,23 @@ import type { DTOTemplateCreate } from '../models/DTOTemplateCreate';
 import { DTOTemplateRead } from '../models/DTOTemplateRead';
 import type { DTOTemplateUpdate } from '../models/DTOTemplateUpdate';
 import type { EnquiryId } from '../models/EnquiryId';
-import type { ItineraryId } from '../models/ItineraryId';
 import type { Pagination } from '../models/Pagination';
 import type { SnapshotId } from '../models/SnapshotId';
 import type { SwooperId } from '../models/SwooperId';
 import type { TemplateId } from '../models/TemplateId';
 import { CancelablePromise } from '../core/CancelablePromise';
 export declare class CoreService {
-    /**
-     * Audit a Copy to Clipboard
-     * Audits when a user copies something to their clipboard
-     * @param itineraryId Itinerary Id
-     * @param content Base64 encoding of the copied content
-     * @returns void
-     * @throws ApiError
-     */
-    auditCopyClipboard(itineraryId: ItineraryId, content: string): CancelablePromise<void>;
     /**
      * Create a Snapshot
      * Creates a new snapshot. A snapshot is a reference to a specific itinerary revision group id.
      * @param requestBody
-     * @returns DTOSnapshotRead When the entity is created
+     * @returns DTOSnapshotRead When the snapshot is created
      * @throws ApiError
      */
     snapshotCreate(requestBody: DTOSnapshotCreate): CancelablePromise<DTOSnapshotRead>;
     /**
      * List Snapshots
-     * List all available snapshots relating to the query params
+     * Get a paginated response of available snapshots
      * @param enquiryId
      * @param page Pagination, starting at page 1
      * @param limit Number of items per page
@@ -53,17 +43,18 @@ export declare class CoreService {
      * @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
+     * @returns any Paginated response of snapshots
      * @throws ApiError
      */
-    snapshotList(enquiryId?: string, page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
-        snapshots?: Array<DTOSnapshotRead>;
+    snapshotList(enquiryId?: string, page?: number, limit?: number, order?: 'asc' | 'desc', sort?: Array<string>, search?: Array<string>, on?: Array<string>): CancelablePromise<{
+        pagination?: Pagination;
+        data?: Array<DTOSnapshotRead>;
     }>;
     /**
      * Get Snapshot va ID
      * Returns the specific snapshot given its Id
      * @param snapshotId
-     * @returns any OK
+     * @returns any A object containing the snapshot entity and the itinerary associated with it
      * @throws ApiError
      */
     snapshotGet(snapshotId: SnapshotId): CancelablePromise<{
@@ -82,7 +73,7 @@ export declare class CoreService {
      * 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
+     * @returns any When a snapshot is restored as the latest version. A object containing the snapshot entity and the itinerary associated with it.
      * @throws ApiError
      */
     snapshotRestore(snapshotId: SnapshotId): CancelablePromise<{
@@ -93,7 +84,7 @@ export declare class CoreService {
      * 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
+     * @returns any The tree list view of all itineraries. This response is not paginated.
      * @throws ApiError
      */
     itineraryList(enquiryId: EnquiryId): CancelablePromise<{
@@ -105,7 +96,7 @@ export declare class CoreService {
      * @param enquiryId Enquiry Id
      * @param requestBody
      * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
-     * @returns any When a itinerary is created
+     * @returns any When a itinerary is created an object containing the tag, enquiry id, and the associated itinerary is returned.
      * @throws ApiError
      */
     itineraryCreate(enquiryId: EnquiryId, requestBody: DTOItineraryCreate, error?: number): CancelablePromise<{
@@ -169,18 +160,18 @@ export declare class CoreService {
      * @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 OK
+     * @returns any Paginated response of regions
      * @throws ApiError
      */
-    regionList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
-        data?: Array<DTORegionRead>;
+    regionList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: Array<string>, search?: Array<string>, on?: Array<string>): CancelablePromise<{
         pagination?: Pagination;
+        data?: Array<DTORegionRead>;
     }>;
     /**
      * Create Region
      * Create a region
      * @param requestBody
-     * @returns DTORegionRead OK
+     * @returns DTORegionRead When a region is created
      * @throws ApiError
      */
     regionCreate(requestBody?: DTORegionCreate): CancelablePromise<DTORegionRead>;
@@ -193,12 +184,12 @@ export declare class CoreService {
      * @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 templates given the parameters used
+     * @returns any Paginated response of templates
      * @throws ApiError
      */
-    templateList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
-        data?: Array<DTOTemplateRead>;
+    templateList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: Array<string>, search?: Array<string>, on?: Array<string>): CancelablePromise<{
         pagination?: Pagination;
+        data?: Array<DTOTemplateRead>;
     }>;
     /**
      * Create a Template
@@ -242,12 +233,12 @@ export declare class CoreService {
      * @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 component given the parameters used
+     * @returns any Paginated response of components
      * @throws ApiError
      */
-    componentList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
-        data?: Array<DTOComponentRead>;
+    componentList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: Array<string>, search?: Array<string>, on?: Array<string>): CancelablePromise<{
         pagination?: Pagination;
+        data?: Array<DTOComponentRead>;
     }>;
     /**
      * Create a Component
@@ -296,10 +287,10 @@ export declare class CoreService {
      * Directly update component state. This does not create a new revision
      * @param componentId Id of a component
      * @param state The publishing state of the component
-     * @returns any OK
+     * @returns DTOComponentRead When the state was updated successfully
      * @throws ApiError
      */
-    componentStateUpdate(componentId: ComponentId, state: ComponentState): CancelablePromise<any>;
+    componentStateUpdate(componentId: ComponentId, state: ComponentState): CancelablePromise<DTOComponentRead>;
     /**
      * List Swoopers
      * List all swoopers
@@ -309,12 +300,12 @@ export declare class CoreService {
      * @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 OK
+     * @returns any Paginated response of swoopers
      * @throws ApiError
      */
-    swooperList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
-        data?: Array<DTOSwooperRead>;
+    swooperList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: Array<string>, search?: Array<string>, on?: Array<string>): CancelablePromise<{
         pagination?: Pagination;
+        data?: Array<DTOTemplateRead>;
     }>;
     /**
      * Create Swooper