swoop-common 2.2.21 → 2.2.31

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

@@ -0,0 +1,174 @@
+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';
+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';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class ItineraryService {
+    /**
+     * 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 a snapshot is created
+     * @throws ApiError
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    snapshotRestore(snapshotId: SnapshotId): CancelablePromise<{
+        snapshot?: DTOSnapshotRead;
+        itinerary?: DTOItineraryRead;
+    }>;
+    /**
+     * 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(enquiryId: EnquiryId): CancelablePromise<{
+        tree?: Array<Branches>;
+    }>;
+    /**
+     * Create an Itinerary on an Enquiry
+     * Creates a new itinerary on an Enquiry
+     * @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
+     * @throws ApiError
+     */
+    itineraryCreate(enquiryId: EnquiryId, requestBody: DTOItineraryCreate, error?: number): CancelablePromise<{
+        itinerary?: DTOItineraryRead;
+        tag?: BranchTag;
+        enquiryId?: EnquiryId;
+    }>;
+    /**
+     * Get Itinerary
+     * Get itinerary via ID
+     * @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(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
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
+     * @param requestBody
+     * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
+     * @returns DTOItineraryRead When a new revision is created successfully
+     * @throws ApiError
+     */
+    itineraryUpdateAsNewRevision(enquiryId: EnquiryId, tag: string, requestBody: DTOItineraryUpdate, error?: number): CancelablePromise<DTOItineraryRead>;
+    /**
+     * 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
+     * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
+     * @returns any When the fork was successful
+     * @throws ApiError
+     */
+    forkItinerary(enquiryId: EnquiryId, tag: string, version: string, error?: number): 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.
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
+     * @param version the version of a branch
+     * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
+     * @returns DTOItineraryRead The new head of the parent branch
+     * @throws ApiError
+     */
+    promoteItinerary(enquiryId: EnquiryId, tag: string, version: string, error?: number): CancelablePromise<DTOItineraryRead>;
+    /**
+     * List Regions
+     * List all regions
+     * @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 OK
+     * @throws ApiError
+     */
+    regionList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
+        data?: Array<DTORegionRead>;
+        pagination?: Pagination;
+    }>;
+    /**
+     * Create Region
+     * Create a region
+     * @param requestBody
+     * @returns DTORegionRead OK
+     * @throws ApiError
+     */
+    regionCreate(requestBody?: DTORegionCreate): CancelablePromise<DTORegionRead>;
+}

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

@@ -0,0 +1,378 @@
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class ItineraryService {
+    /**
+     * 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, content) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/audit/copyClipboard/{itineraryId}',
+            path: {
+                'itineraryId': itineraryId,
+            },
+            query: {
+                'content': content,
+            },
+            errors: {
+                400: `When the content query b64 string is invalid`,
+                401: `Unauthorized - Missing or invalid Authorization header`,
+            },
+        });
+    }
+    /**
+     * 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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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`,
+            },
+        });
+    }
+    /**
+     * 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(enquiryId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/itinerary/{enquiryId}/tree',
+            path: {
+                'enquiryId': enquiryId,
+            },
+            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 itineraries`,
+                503: `Service Unavailable - The server is temporarily unable to handle the request`,
+            },
+        });
+    }
+    /**
+     * Create an Itinerary on an Enquiry
+     * Creates a new itinerary on an Enquiry
+     * @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
+     * @throws ApiError
+     */
+    itineraryCreate(enquiryId, requestBody, error) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/itinerary/create/{enquiryId}',
+            path: {
+                'enquiryId': enquiryId,
+            },
+            query: {
+                'error': error,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `If the payload is malformed`,
+                401: `Unauthorized - Missing or invalid Authorization header`,
+                404: `the customer linked via enquiryId does not exist or has been deleted or a referenced traveller group or traveller ID was not found`,
+                422: `An itinerary meets CRM 'late' criteria but 'isLateBookingConfirmed' is false`,
+                500: `When an internal server error occurs when creating a itinerary entity`,
+                503: `Service Unavailable - The server is temporarily unable to handle the request`,
+            },
+        });
+    }
+    /**
+     * Get Itinerary
+     * Get itinerary via ID
+     * @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(enquiryId, tag, version) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/itinerary/{enquiryId}/{tag}/{version}',
+            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`,
+            },
+        });
+    }
+    /**
+     * Update Itinerary as New Revision
+     * 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
+     * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
+     * @returns DTOItineraryRead When a new revision is created successfully
+     * @throws ApiError
+     */
+    itineraryUpdateAsNewRevision(enquiryId, tag, requestBody, error) {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/itinerary/{enquiryId}/{tag}',
+            path: {
+                'enquiryId': enquiryId,
+                'tag': tag,
+            },
+            query: {
+                'error': error,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            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, or the customer linked via enquiryId does not exist, or has been deleted or a referenced traveller group or traveller ID was not found`,
+                422: `An itinerary meets CRM 'late' criteria but 'isLateBookingConfirmed' is false`,
+                500: `When an internal server error occurs updating an itinerary as a new revision`,
+            },
+        });
+    }
+    /**
+     * 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
+     * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
+     * @returns any When the fork was successful
+     * @throws ApiError
+     */
+    forkItinerary(enquiryId, tag, version, error) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/itinerary/fork/{enquiryId}/{tag}/{version}',
+            path: {
+                'enquiryId': enquiryId,
+                'tag': tag,
+                'version': version,
+            },
+            query: {
+                'error': error,
+            },
+            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, or the customer linked via enquiryId does not exist, or has been deleted or a referenced traveller group or traveller ID was not found`,
+                422: `An itinerary meets CRM 'late' criteria but 'isLateBookingConfirmed' is false`,
+                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
+     * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
+     * @returns DTOItineraryRead The new head of the parent branch
+     * @throws ApiError
+     */
+    promoteItinerary(enquiryId, tag, version, error) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/itinerary/promote/{enquiryId}/{tag}/{version}',
+            path: {
+                'enquiryId': enquiryId,
+                'tag': tag,
+                'version': version,
+            },
+            query: {
+                'error': error,
+            },
+            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, or the customer linked via enquiryId does not exist, or has been deleted or a referenced traveller group or traveller ID was not found`,
+                422: `An itinerary meets CRM 'late' criteria but 'isLateBookingConfirmed' is false`,
+                500: `When an internal server error occurs updating an itinerary as a new revision`,
+            },
+        });
+    }
+    /**
+     * List Regions
+     * List all regions
+     * @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 OK
+     * @throws ApiError
+     */
+    regionList(page, limit, order, sort, search, on) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/region',
+            query: {
+                '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 regions`,
+                503: `Service Unavailable - The server is temporarily unable to handle the request`,
+            },
+        });
+    }
+    /**
+     * Create Region
+     * Create a region
+     * @param requestBody
+     * @returns DTORegionRead OK
+     * @throws ApiError
+     */
+    regionCreate(requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/region',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `If the payload is malformed`,
+                401: `Unauthorized - Missing or invalid Authorization header`,
+                500: `When an internal server error occurs when creating a region entity`,
+                503: `Service Unavailable - The server is temporarily unable to handle the request`,
+            },
+        });
+    }
+}

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

@@ -0,0 +1,30 @@
+import type { DTORegionCreate } from '../models/DTORegionCreate';
+import type { DTORegionRead } from '../models/DTORegionRead';
+import type { Pagination } from '../models/Pagination';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class RegionService {
+    /**
+     * List Regions
+     * List all regions
+     * @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 OK
+     * @throws ApiError
+     */
+    static regionList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
+        data?: Array<DTORegionRead>;
+        pagination?: Pagination;
+    }>;
+    /**
+     * Create Region
+     * Create a region
+     * @param requestBody
+     * @returns DTORegionRead OK
+     * @throws ApiError
+     */
+    static regionCreate(requestBody?: DTORegionCreate): CancelablePromise<DTORegionRead>;
+}

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

@@ -0,0 +1,57 @@
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class RegionService {
+    /**
+     * List Regions
+     * List all regions
+     * @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 OK
+     * @throws ApiError
+     */
+    static regionList(page, limit, order, sort, search, on) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/region',
+            query: {
+                '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 regions`,
+                503: `Service Unavailable - The server is temporarily unable to handle the request`,
+            },
+        });
+    }
+    /**
+     * Create Region
+     * Create a region
+     * @param requestBody
+     * @returns DTORegionRead OK
+     * @throws ApiError
+     */
+    static regionCreate(requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/region',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `If the payload is malformed`,
+                401: `Unauthorized - Missing or invalid Authorization header`,
+                500: `When an internal server error occurs when creating a region entity`,
+                503: `Service Unavailable - The server is temporarily unable to handle the request`,
+            },
+        });
+    }
+}