swoop-common 2.2.230 → 2.2.232

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

@@ -51,6 +51,7 @@ export type { DTOItineraryRead } from './index';
 export type { DTOItineraryUpdate } from './index';
 export type { DTOPublicSnapshotCreate } from './index';
 export type { DTOPublicSnapshotEntity } from './index';
+export type { DTOPublicSnapshotExpired } from './index';
 export type { DTOPublicSnapshotRead } from './index';
 export type { DTOPublicSnapshotUpdate } from './index';
 export type { DTORegionCreate } from './index';

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

@@ -51,6 +51,7 @@ export type { DTOItineraryRead } from './models/DTOItineraryRead';
 export type { DTOItineraryUpdate } from './models/DTOItineraryUpdate';
 export type { DTOPublicSnapshotCreate } from './models/DTOPublicSnapshotCreate';
 export type { DTOPublicSnapshotEntity } from './models/DTOPublicSnapshotEntity';
+export type { DTOPublicSnapshotExpired } from './models/DTOPublicSnapshotExpired';
 export type { DTOPublicSnapshotRead } from './models/DTOPublicSnapshotRead';
 export type { DTOPublicSnapshotUpdate } from './models/DTOPublicSnapshotUpdate';
 export type { DTORegionCreate } from './models/DTORegionCreate';

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

@@ -22,4 +22,8 @@ export type DTOPublicSnapshotCreate = {
     cxPerson?: PublicSnapshotPerson;
     isTwinCentre: IsTwinCentre;
     payments?: Array<PublicSnapShotPayment>;
+    /**
+     * Internal only - not exposed on DTOPublicSnapshotRead. No value means the link never expires.
+     */
+    validUntil?: string | null;
 };

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

@@ -26,4 +26,8 @@ export type DTOPublicSnapshotEntity = {
     cxPerson?: PublicSnapshotPerson;
     isTwinCentre: IsTwinCentre;
     payments?: Array<PublicSnapShotPayment>;
+    /**
+     * Internal only - not exposed on DTOPublicSnapshotRead. No value means the link never expires.
+     */
+    validUntil?: string | null;
 };

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

@@ -0,0 +1,8 @@
+import type { PublicSnapshotPerson } from './PublicSnapshotPerson';
+/**
+ * Returned instead of DTOPublicSnapshotRead when a "sales" snapshot's validUntil date has passed.
+ */
+export type DTOPublicSnapshotExpired = {
+    expired: boolean;
+    salesPerson?: PublicSnapshotPerson;
+};

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

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

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

@@ -26,4 +26,8 @@ export type DTOPublicSnapshotRead = {
     cxPerson?: PublicSnapshotPerson;
     isTwinCentre: IsTwinCentre;
     payments?: Array<PublicSnapShotPayment>;
+    /**
+     * Server-internal only. ReadPublicSnapshot strips this before returning a live (non-expired) response to the client - it must never reach a customer's browser.
+     */
+    validUntil?: string | null;
 };

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

@@ -1,4 +1,8 @@
 import type { Title } from './Title';
 export type DTOPublicSnapshotUpdate = {
     name?: Title;
+    /**
+     * Only meaningful for "sales" snapshots. Send an empty string to clear (never expires); omit to leave unchanged. (A JSON null is indistinguishable from an omitted field once decoded into a Go pointer, so empty string is the actual "clear" signal here.)
+     */
+    validUntil?: string | null;
 };

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

@@ -5,4 +5,8 @@ export type DTOSnapshotCreate = {
     name: Title;
     itineraryId: ItineraryId;
     enquiryId: InternalSwoopId;
+    /**
+     * No value means the link never expires.
+     */
+    validUntil?: string | null;
 };

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

@@ -9,4 +9,8 @@ export type DTOSnapshotEntity = {
     name: Title;
     itineraryId: ItineraryId;
     enquiryId: InternalSwoopId;
+    /**
+     * No value means the link never expires.
+     */
+    validUntil?: string | null;
 };

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

@@ -9,4 +9,8 @@ export type DTOSnapshotRead = {
     name: Title;
     itineraryId: ItineraryId;
     enquiryId: InternalSwoopId;
+    /**
+     * No value means the link never expires.
+     */
+    validUntil?: string | null;
 };

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

@@ -3,4 +3,8 @@ import type { Title } from './Title';
 export type DTOSnapshotUpdate = {
     name?: Title;
     itineraryId?: ItineraryId;
+    /**
+     * Only meaningful for "sales" snapshots. Send an empty string to clear (never expires); omit to leave unchanged. (A JSON null is indistinguishable from an omitted field once decoded into a Go pointer, so empty string is the actual "clear" signal here.)
+     */
+    validUntil?: string | null;
 };

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

@@ -22,6 +22,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 { DTOSnapshotUpdate } from '../models/DTOSnapshotUpdate';
 import type { DTOTemplateCreate } from '../models/DTOTemplateCreate';
 import { DTOTemplateRead } from '../models/DTOTemplateRead';
 import type { DTOTemplateUpdate } from '../models/DTOTemplateUpdate';
@@ -107,6 +108,15 @@ export declare class CoreService {
      * @throws ApiError
      */
     snapshotDelete(snapshotId: SnapshotId): CancelablePromise<void>;
+    /**
+     * Update Snapshot
+     * Updates a snapshot. Currently only used to set or clear a "sales" snapshot's validUntil date.
+     * @param snapshotId
+     * @param requestBody
+     * @returns DTOSnapshotRead When the snapshot is updated successfully
+     * @throws ApiError
+     */
+    snapshotUpdate(snapshotId: SnapshotId, requestBody: DTOSnapshotUpdate): CancelablePromise<DTOSnapshotRead>;
     /**
      * Restore Snapshot
      * Creates a new itinerary revision given the content the snapshot refers to

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

@@ -30,6 +30,7 @@ export class CoreService {
                 401: `When the client is not authorised`,
                 403: `When the snapshot is missing from the requests context`,
                 404: `If a resource does not exist`,
+                410: `When the snapshot is a "sales" document whose validUntil date has passed`,
                 500: `When an unexpected error occurs`,
             },
         });
@@ -178,6 +179,31 @@ export class CoreService {
             },
         });
     }
+    /**
+     * Update Snapshot
+     * Updates a snapshot. Currently only used to set or clear a "sales" snapshot's validUntil date.
+     * @param snapshotId
+     * @param requestBody
+     * @returns DTOSnapshotRead When the snapshot is updated successfully
+     * @throws ApiError
+     */
+    snapshotUpdate(snapshotId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/snapshot/{snapshotId}',
+            path: {
+                'snapshotId': snapshotId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `If the payload is malformed`,
+                401: `When the client is not authorised`,
+                404: `If a resource does not exist`,
+                500: `When an unexpected error occurs`,
+            },
+        });
+    }
     /**
      * Restore Snapshot
      * Creates a new itinerary revision given the content the snapshot refers to

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

@@ -19,6 +19,7 @@ export class PublicService {
                 401: `When the client is not authorised`,
                 403: `When the snapshot is missing from the requests context`,
                 404: `If a resource does not exist`,
+                410: `When the snapshot is a "sales" document whose validUntil date has passed`,
                 500: `When an unexpected error occurs`,
             },
         });

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

@@ -2,6 +2,7 @@ import type { DTOItineraryRead } from '../models/DTOItineraryRead';
 import type { DTOPublicSnapshotRead } from '../models/DTOPublicSnapshotRead';
 import type { DTOSnapshotCreate } from '../models/DTOSnapshotCreate';
 import type { DTOSnapshotRead } from '../models/DTOSnapshotRead';
+import type { DTOSnapshotUpdate } from '../models/DTOSnapshotUpdate';
 import type { Pagination } from '../models/Pagination';
 import type { SnapshotId } from '../models/SnapshotId';
 import type { CancelablePromise } from '../core/CancelablePromise';
@@ -57,6 +58,15 @@ export declare class SnapshotService {
      * @throws ApiError
      */
     static snapshotDelete(snapshotId: SnapshotId): CancelablePromise<void>;
+    /**
+     * Update Snapshot
+     * Updates a snapshot. Currently only used to set or clear a "sales" snapshot's validUntil date.
+     * @param snapshotId
+     * @param requestBody
+     * @returns DTOSnapshotRead When the snapshot is updated successfully
+     * @throws ApiError
+     */
+    static snapshotUpdate(snapshotId: SnapshotId, requestBody: DTOSnapshotUpdate): CancelablePromise<DTOSnapshotRead>;
     /**
      * Restore Snapshot
      * Creates a new itinerary revision given the content the snapshot refers to

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

@@ -19,6 +19,7 @@ export class SnapshotService {
                 401: `When the client is not authorised`,
                 403: `When the snapshot is missing from the requests context`,
                 404: `If a resource does not exist`,
+                410: `When the snapshot is a "sales" document whose validUntil date has passed`,
                 500: `When an unexpected error occurs`,
             },
         });
@@ -122,6 +123,31 @@ export class SnapshotService {
             },
         });
     }
+    /**
+     * Update Snapshot
+     * Updates a snapshot. Currently only used to set or clear a "sales" snapshot's validUntil date.
+     * @param snapshotId
+     * @param requestBody
+     * @returns DTOSnapshotRead When the snapshot is updated successfully
+     * @throws ApiError
+     */
+    static snapshotUpdate(snapshotId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/snapshot/{snapshotId}',
+            path: {
+                'snapshotId': snapshotId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `If the payload is malformed`,
+                401: `When the client is not authorised`,
+                404: `If a resource does not exist`,
+                500: `When an unexpected error occurs`,
+            },
+        });
+    }
     /**
      * Restore Snapshot
      * Creates a new itinerary revision given the content the snapshot refers to

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

@@ -48,6 +48,10 @@ export type { EnquiryPersonSwoop } from './index';
 export type { EnquiryPerson_jsonldSwoop } from './index';
 export type { EnquiryStatusSwoop } from './index';
 export type { EnquiryStatus_jsonldSwoop } from './index';
+export type { EnquirySubmission_jsonld_readSwoop } from './index';
+export { EnquirySubmission_jsonld_writeSwoop } from './index';
+export type { EnquirySubmission_readSwoop } from './index';
+export { EnquirySubmission_writeSwoop } from './index';
 export type { ExchangeRateSwoop } from './index';
 export type { ExchangeRate_jsonldSwoop } from './index';
 export type { HydraCollectionBaseSchemaSwoop } from './index';

package/dist/api/generated/swoop/exports.js

@@ -1,2 +1,3 @@
 // GENERATED FILE DO NOT EDIT //
-export {};
+export { EnquirySubmission_jsonld_writeSwoop } from './index';
+export { EnquirySubmission_writeSwoop } from './index';

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

@@ -52,6 +52,10 @@ export type { EnquiryPerson as EnquiryPersonSwoop } from './models/EnquiryPerson
 export type { EnquiryPerson_jsonld as EnquiryPerson_jsonldSwoop } from './models/EnquiryPerson_jsonld';
 export type { EnquiryStatus as EnquiryStatusSwoop } from './models/EnquiryStatus';
 export type { EnquiryStatus_jsonld as EnquiryStatus_jsonldSwoop } from './models/EnquiryStatus_jsonld';
+export type { EnquirySubmission_jsonld_read as EnquirySubmission_jsonld_readSwoop } from './models/EnquirySubmission_jsonld_read';
+export { EnquirySubmission_jsonld_write as EnquirySubmission_jsonld_writeSwoop } from './models/EnquirySubmission_jsonld_write';
+export type { EnquirySubmission_read as EnquirySubmission_readSwoop } from './models/EnquirySubmission_read';
+export { EnquirySubmission_write as EnquirySubmission_writeSwoop } from './models/EnquirySubmission_write';
 export type { ExchangeRate as ExchangeRateSwoop } from './models/ExchangeRate';
 export type { ExchangeRate_jsonld as ExchangeRate_jsonldSwoop } from './models/ExchangeRate_jsonld';
 export type { HydraCollectionBaseSchema as HydraCollectionBaseSchemaSwoop } from './models/HydraCollectionBaseSchema';

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

@@ -5,4 +5,6 @@
 export { ApiError } from './core/ApiError';
 export { CancelablePromise, CancelError } from './core/CancelablePromise';
 export { OpenAPI } from './core/OpenAPI';
+export { EnquirySubmission_jsonld_write as EnquirySubmission_jsonld_writeSwoop } from './models/EnquirySubmission_jsonld_write';
+export { EnquirySubmission_write as EnquirySubmission_writeSwoop } from './models/EnquirySubmission_write';
 export { SwoopService } from './services/SwoopService';

package/dist/api/generated/swoop/models/EnquirySubmission_jsonld_read.d.ts

@@ -0,0 +1,4 @@
+import type { HydraItemBaseSchema } from './HydraItemBaseSchema';
+export type EnquirySubmission_jsonld_read = (HydraItemBaseSchema & {
+    id?: string | null;
+});

package/dist/api/generated/swoop/models/EnquirySubmission_jsonld_read.js

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

package/dist/api/generated/swoop/models/EnquirySubmission_jsonld_write.d.ts

@@ -0,0 +1,29 @@
+export type EnquirySubmission_jsonld_write = {
+    /**
+     * The region the enquiry belongs to
+     */
+    region: EnquirySubmission_jsonld_write.region;
+    name: string;
+    email: string;
+    phone?: string | null;
+    timezone?: string | null;
+    message?: string | null;
+    /**
+     * ntag aliases to tag the enquiry with
+     */
+    tags?: Array<string>;
+    /**
+     * URL of the page the enquiry was submitted from
+     */
+    referral_url?: string | null;
+};
+export declare namespace EnquirySubmission_jsonld_write {
+    /**
+     * The region the enquiry belongs to
+     */
+    enum region {
+        ANTARCTICA = "antarctica",
+        ARCTIC = "arctic",
+        PATAGONIA = "patagonia"
+    }
+}

package/dist/api/generated/swoop/models/EnquirySubmission_jsonld_write.js

@@ -0,0 +1,12 @@
+export var EnquirySubmission_jsonld_write;
+(function (EnquirySubmission_jsonld_write) {
+    /**
+     * The region the enquiry belongs to
+     */
+    let region;
+    (function (region) {
+        region["ANTARCTICA"] = "antarctica";
+        region["ARCTIC"] = "arctic";
+        region["PATAGONIA"] = "patagonia";
+    })(region = EnquirySubmission_jsonld_write.region || (EnquirySubmission_jsonld_write.region = {}));
+})(EnquirySubmission_jsonld_write || (EnquirySubmission_jsonld_write = {}));

package/dist/api/generated/swoop/models/EnquirySubmission_read.d.ts

@@ -0,0 +1,3 @@
+export type EnquirySubmission_read = {
+    id?: string | null;
+};

package/dist/api/generated/swoop/models/EnquirySubmission_read.js

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

package/dist/api/generated/swoop/models/EnquirySubmission_write.d.ts

@@ -0,0 +1,29 @@
+export type EnquirySubmission_write = {
+    /**
+     * The region the enquiry belongs to
+     */
+    region: EnquirySubmission_write.region;
+    name: string;
+    email: string;
+    phone?: string | null;
+    timezone?: string | null;
+    message?: string | null;
+    /**
+     * ntag aliases to tag the enquiry with
+     */
+    tags?: Array<string>;
+    /**
+     * URL of the page the enquiry was submitted from
+     */
+    referral_url?: string | null;
+};
+export declare namespace EnquirySubmission_write {
+    /**
+     * The region the enquiry belongs to
+     */
+    enum region {
+        ANTARCTICA = "antarctica",
+        ARCTIC = "arctic",
+        PATAGONIA = "patagonia"
+    }
+}

package/dist/api/generated/swoop/models/EnquirySubmission_write.js

@@ -0,0 +1,12 @@
+export var EnquirySubmission_write;
+(function (EnquirySubmission_write) {
+    /**
+     * The region the enquiry belongs to
+     */
+    let region;
+    (function (region) {
+        region["ANTARCTICA"] = "antarctica";
+        region["ARCTIC"] = "arctic";
+        region["PATAGONIA"] = "patagonia";
+    })(region = EnquirySubmission_write.region || (EnquirySubmission_write.region = {}));
+})(EnquirySubmission_write || (EnquirySubmission_write = {}));

package/dist/api/generated/swoop/services/SwoopService.d.ts

@@ -13,6 +13,8 @@ import type { DayByDayType } from '../models/DayByDayType';
 import type { Departure } from '../models/Departure';
 import type { Enquiry } from '../models/Enquiry';
 import type { EnquiryStatus } from '../models/EnquiryStatus';
+import type { EnquirySubmission_read } from '../models/EnquirySubmission_read';
+import type { EnquirySubmission_write } from '../models/EnquirySubmission_write';
 import type { ExchangeRate } from '../models/ExchangeRate';
 import type { IbAudit_read } from '../models/IbAudit_read';
 import type { IbAudit_write } from '../models/IbAudit_write';
@@ -234,6 +236,14 @@ export declare class SwoopService {
     enquiryStatusesGetCollection(region?: string): CancelablePromise<{
         enquiryStatuses?: Array<EnquiryStatus>;
     }>;
+    /**
+     * Creates a EnquirySubmission resource.
+     * Creates a EnquirySubmission resource.
+     * @param requestBody The new EnquirySubmission resource
+     * @returns EnquirySubmission_read EnquirySubmission resource created
+     * @throws ApiError
+     */
+    enquirySubmissionPost(requestBody: EnquirySubmission_write): CancelablePromise<EnquirySubmission_read>;
     /**
      * Retrieves the collection of ExchangeRate resources.
      * Retrieves the collection of ExchangeRate resources.

package/dist/api/generated/swoop/services/SwoopService.js

@@ -331,6 +331,25 @@ export class SwoopService {
             },
         });
     }
+    /**
+     * Creates a EnquirySubmission resource.
+     * Creates a EnquirySubmission resource.
+     * @param requestBody The new EnquirySubmission resource
+     * @returns EnquirySubmission_read EnquirySubmission resource created
+     * @throws ApiError
+     */
+    enquirySubmissionPost(requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/enquiry-submission',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Invalid input`,
+                422: `Validation Error`,
+            },
+        });
+    }
     /**
      * Retrieves the collection of ExchangeRate resources.
      * Retrieves the collection of ExchangeRate resources.

package/package.json

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