swoop-common 2.2.230 → 2.2.231

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';
@@ -125,6 +126,7 @@ export type { SwoopError } from './index';
 export type { SwoopSyncComponentInstance } from './index';
 export type { SwoopSyncError } from './index';
 export type { SwoopSyncErrorMsg } from './index';
+export type { SwoopSyncSuccess } from './index';
 export type { TagPathParam } from './index';
 export type { TemplateId } from './index';
 export type { TemplateIdPathParam } 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';
@@ -125,6 +126,7 @@ export type { SwoopError } from './models/SwoopError';
 export type { SwoopSyncComponentInstance } from './models/SwoopSyncComponentInstance';
 export type { SwoopSyncError } from './models/SwoopSyncError';
 export type { SwoopSyncErrorMsg } from './models/SwoopSyncErrorMsg';
+export type { SwoopSyncSuccess } from './models/SwoopSyncSuccess';
 export type { TagPathParam } from './models/TagPathParam';
 export type { TemplateId } from './models/TemplateId';
 export type { TemplateIdPathParam } from './models/TemplateIdPathParam';

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/models/SwoopSyncSuccess.d.ts

@@ -0,0 +1,6 @@
+export type SwoopSyncSuccess = {
+    /**
+     * Whether the itinerary currently meets the CRM's late-booking criteria, computed regardless of the isLateBookingConfirmed value that was sent. Absent when the CRM does not yet report this field, which must be treated as unknown (not false).
+     */
+    isLate?: boolean;
+};

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

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

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/package.json

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