@uptime.app/contracts 3.0.52-rc.2 → 3.0.52

package/src/referral/referral.ts

@@ -1,76 +1,76 @@
-export interface ReferredUserPurchase {
-    /** The price the referred user paid in their currency */
-    price: number;
-    /** The currency the referred user paid in */
-    currency: string;
-    /** The price they paid in United States Dollars (USD) */
-    priceInUSD: number;
-    /** The RevenueCat transaction ID */
-    transactionId: string;
-    /** The RevenueCat original transaction ID */
-    originalTransactionId: string;
-}
-
-export interface ReferralCredit {
-    /** The unique identifier of a referral credit */
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    /** The ID of the user who shared the referral link */
-    referrerUserId: string;
-    /** If the referrer is a creator, this contains their creator ID */
-    referrerCreatorId?: string;
-    /** If the referrer is a partner of Uptime, this contains their partner ID */
-    referrerPartnerId?: string;
-    /** The unique device ID of the user who shared the referral link */
-    referrerUniqueDeviceId?: string;
-    /** The purchase the referred user made (if applicable) */
-    referredUserPurchase?: ReferredUserPurchase;
-    /** The ID of the user who clicked on the referral link and triggered the referral */
-    referredUserId?: string;
-    /** The unique device ID of the user who clicked on the referral link and triggered the referral */
-    referredUserUniqueDeviceId?: string;
-    /** The ISO 8601 UTC timestamp of the successful referral event */
-    eventTimestamp: string;
-    /** The source of the successful referral event e.g. Branch */
-    eventSource: string;
-    /** The action that triggered the successful referral event e.g. a user sign-up  */
-    eventTrigger: string;
-}
-
-export interface ReferralLink {
-    /** The unique identifier of a referral link */
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    /** The ID of the user who will share the link and be credited if it is used */
-    referrerUserId: string;
-    /** The URL of the referral deep link */
-    url: string;
-    /** The source of the referral link e.g. Branch */
-    source: string;
-    /** The action that triggers a successful referral e.g. a user sign-up  */
-    trigger: string;
-}
-
-export enum ReferralEventSource {
-    Branch = 'branch',
-    RevenueCat = 'revenue-cat'
-}
-
-/* None of these events are mututally exlusive. For example, a single premium payment could 
- * yield both a 'trial-converted' and a 'paid-subscription' referral credit, and it's possible
- * they could be attributed to different referrers, so we need to track both.
- */
-export enum ReferralEventTrigger {
-    /** A new user clicks on a deep link, downloads the Uptime app and registers. */
-    SignUp = 'sign-up',
-    /** A user clicks on a deep link and starts a trial during that session. */
-    TrialStarted = 'trial-started',
-    /** A trial-started referred user converts to premium during their trial. */
-    TrialConverted = 'trial-converted',
-    /** A user clicks a on deep link and pays for premium during that session. */
-    PaidSubscription = 'paid-subscription'
-}
+export interface ReferredUserPurchase {
+    /** The price the referred user paid in their currency */
+    price: number;
+    /** The currency the referred user paid in */
+    currency: string;
+    /** The price they paid in United States Dollars (USD) */
+    priceInUSD: number;
+    /** The RevenueCat transaction ID */
+    transactionId: string;
+    /** The RevenueCat original transaction ID */
+    originalTransactionId: string;
+}
+
+export interface ReferralCredit {
+    /** The unique identifier of a referral credit */
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    /** The ID of the user who shared the referral link */
+    referrerUserId: string;
+    /** If the referrer is a creator, this contains their creator ID */
+    referrerCreatorId?: string;
+    /** If the referrer is a partner of Uptime, this contains their partner ID */
+    referrerPartnerId?: string;
+    /** The unique device ID of the user who shared the referral link */
+    referrerUniqueDeviceId?: string;
+    /** The purchase the referred user made (if applicable) */
+    referredUserPurchase?: ReferredUserPurchase;
+    /** The ID of the user who clicked on the referral link and triggered the referral */
+    referredUserId?: string;
+    /** The unique device ID of the user who clicked on the referral link and triggered the referral */
+    referredUserUniqueDeviceId?: string;
+    /** The ISO 8601 UTC timestamp of the successful referral event */
+    eventTimestamp: string;
+    /** The source of the successful referral event e.g. Branch */
+    eventSource: string;
+    /** The action that triggered the successful referral event e.g. a user sign-up  */
+    eventTrigger: string;
+}
+
+export interface ReferralLink {
+    /** The unique identifier of a referral link */
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    /** The ID of the user who will share the link and be credited if it is used */
+    referrerUserId: string;
+    /** The URL of the referral deep link */
+    url: string;
+    /** The source of the referral link e.g. Branch */
+    source: string;
+    /** The action that triggers a successful referral e.g. a user sign-up  */
+    trigger: string;
+}
+
+export enum ReferralEventSource {
+    Branch = 'branch',
+    RevenueCat = 'revenue-cat'
+}
+
+/* None of these events are mututally exlusive. For example, a single premium payment could 
+ * yield both a 'trial-converted' and a 'paid-subscription' referral credit, and it's possible
+ * they could be attributed to different referrers, so we need to track both.
+ */
+export enum ReferralEventTrigger {
+    /** A new user clicks on a deep link, downloads the Uptime app and registers. */
+    SignUp = 'sign-up',
+    /** A user clicks on a deep link and starts a trial during that session. */
+    TrialStarted = 'trial-started',
+    /** A trial-started referred user converts to premium during their trial. */
+    TrialConverted = 'trial-converted',
+    /** A user clicks a on deep link and pays for premium during that session. */
+    PaidSubscription = 'paid-subscription'
+}

package/src/saved/saved-collection-events.ts

@@ -1,19 +1,19 @@
-import { SavedCollection } from './saved-collection';
-
-export interface SavedCollectionCreatedEvent {
-    id: string;
-    type: 'SavedCollectionCreated';
-    payload: SavedCollection;
-}
-
-export interface SavedCollectionUpdatedEvent {
-    id: string;
-    type: 'SavedCollectionUpdated';
-    payload: SavedCollection;
-}
-
-export interface SavedCollectionDeletedEvent {
-    id: string;
-    type: 'SavedCollectionDeleted';
-    payload: SavedCollection;
-}
+import { SavedCollection } from './saved-collection';
+
+export interface SavedCollectionCreatedEvent {
+    id: string;
+    type: 'SavedCollectionCreated';
+    payload: SavedCollection;
+}
+
+export interface SavedCollectionUpdatedEvent {
+    id: string;
+    type: 'SavedCollectionUpdated';
+    payload: SavedCollection;
+}
+
+export interface SavedCollectionDeletedEvent {
+    id: string;
+    type: 'SavedCollectionDeleted';
+    payload: SavedCollection;
+}

package/src/saved/saved-collection.ts

@@ -1,8 +1,8 @@
-export interface SavedCollection {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    userId: string;
-    collectionId: string;
-}
+export interface SavedCollection {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    collectionId: string;
+}

package/src/segment/segment-commands.ts

@@ -1,75 +1,75 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-import { SegmentType } from './segment';
-
-export interface StandaloneSegmentCard {
-    markdown: string;
-}
-
-export interface StandaloneSegmentAction {
-    title: string;
-    cards: StandaloneSegmentCard[];
-}
-
-export interface StandaloneSegmentSection {
-    heading?: string;
-    cards: StandaloneSegmentCard[];
-}
-
-export interface CommandSegment {
-    type: SegmentType;
-    // @deprecated use hackTitle, hackType and hackContributors
-    source?: {
-        id: string;
-        type: string;
-        contributors: {
-            name: string;
-        }[];
-        title: string;
-    };
-    hackCoverUrl?: string;
-    hackId: string;
-    hackTitle: string;
-    hackType: 'book' | 'course' | 'documentary' | 'podcast' | 'original';
-    hackContributors: {
-        name: string;
-    }[];
-    locale: SupportedLocale;
-}
-export interface StandaloneSegment extends CommandSegment {
-    title?: string;
-    keywords?: string[];
-    sections: StandaloneSegmentSection[];
-    actions?: StandaloneSegmentAction[];
-    textSummary?: string;
-}
-
-export interface CompositeSegment extends CommandSegment {
-    subSegments: StandaloneSegment[];
-}
-
-export interface CreateSegmentCommand {
-    id: string;
-    type: 'CreateSegment';
-    payload: (CompositeSegment | StandaloneSegment) & {
-        /** if no voice ids are specified then all voices are generated */
-        voiceIds?: string[];
-    }
-}
-
-export interface UpdateSegmentCommand {
-    id: string;
-    type: 'UpdateSegment';
-    payload: (CompositeSegment | StandaloneSegment) & {
-        segmentId: string;
-        /** if no voice ids are specified then all voices are generated */
-        voiceIds?: string[];
-    };
-}
-
-export interface DeleteSegmentCommand {
-    id: string;
-    type: 'DeleteSegment';
-    payload: {
-        segmentId: string;
-    };
-}
+import { SupportedLocale } from '../localisation/supported-locales';
+import { SegmentType } from './segment';
+
+export interface StandaloneSegmentCard {
+    markdown: string;
+}
+
+export interface StandaloneSegmentAction {
+    title: string;
+    cards: StandaloneSegmentCard[];
+}
+
+export interface StandaloneSegmentSection {
+    heading?: string;
+    cards: StandaloneSegmentCard[];
+}
+
+export interface CommandSegment {
+    type: SegmentType;
+    // @deprecated use hackTitle, hackType and hackContributors
+    source?: {
+        id: string;
+        type: string;
+        contributors: {
+            name: string;
+        }[];
+        title: string;
+    };
+    hackCoverUrl?: string;
+    hackId: string;
+    hackTitle: string;
+    hackType: 'book' | 'course' | 'documentary' | 'podcast' | 'original';
+    hackContributors: {
+        name: string;
+    }[];
+    locale: SupportedLocale;
+}
+export interface StandaloneSegment extends CommandSegment {
+    title?: string;
+    keywords?: string[];
+    sections: StandaloneSegmentSection[];
+    actions?: StandaloneSegmentAction[];
+    textSummary?: string;
+}
+
+export interface CompositeSegment extends CommandSegment {
+    subSegments: StandaloneSegment[];
+}
+
+export interface CreateSegmentCommand {
+    id: string;
+    type: 'CreateSegment';
+    payload: (CompositeSegment | StandaloneSegment) & {
+        /** if no voice ids are specified then all voices are generated */
+        voiceIds?: string[];
+    }
+}
+
+export interface UpdateSegmentCommand {
+    id: string;
+    type: 'UpdateSegment';
+    payload: (CompositeSegment | StandaloneSegment) & {
+        segmentId: string;
+        /** if no voice ids are specified then all voices are generated */
+        voiceIds?: string[];
+    };
+}
+
+export interface DeleteSegmentCommand {
+    id: string;
+    type: 'DeleteSegment';
+    payload: {
+        segmentId: string;
+    };
+}

package/src/segment/segment-events.ts

@@ -1,42 +1,42 @@
-import { Segment } from './segment';
-import { SegmentWithVoice } from './segment-with-voice';
-
-export interface SegmentCreatedEvent {
-    id: string;
-    type: 'SegmentCreated';
-    payload: Segment;
-}
-
-export interface SegmentUpdatedEvent {
-    id: string;
-    type: 'SegmentUpdated';
-    payload: Segment;
-}
-
-export interface SegmentDeletedEvent {
-    id: string;
-    type: 'SegmentDeleted';
-    payload: Segment;
-}
-
-export type SegmentChangedEvent = SegmentCreatedEvent | SegmentUpdatedEvent | SegmentDeletedEvent;
-
-export interface SegmentWithVoiceCreatedEvent {
-    id: string;
-    type: 'SegmentWithVoiceCreated';
-    payload: SegmentWithVoice;
-}
-
-export interface SegmentWithVoiceUpdatedEvent {
-    id: string;
-    type: 'SegmentWithVoiceUpdated';
-    payload: SegmentWithVoice;
-}
-
-export interface SegmentWithVoiceDeletedEvent {
-    id: string;
-    type: 'SegmentWithVoiceDeleted';
-    payload: SegmentWithVoice;
-}
-
-export type SegmentWithVoiceChangedEvent = SegmentWithVoiceCreatedEvent | SegmentWithVoiceUpdatedEvent | SegmentWithVoiceDeletedEvent;
+import { Segment } from './segment';
+import { SegmentWithVoice } from './segment-with-voice';
+
+export interface SegmentCreatedEvent {
+    id: string;
+    type: 'SegmentCreated';
+    payload: Segment;
+}
+
+export interface SegmentUpdatedEvent {
+    id: string;
+    type: 'SegmentUpdated';
+    payload: Segment;
+}
+
+export interface SegmentDeletedEvent {
+    id: string;
+    type: 'SegmentDeleted';
+    payload: Segment;
+}
+
+export type SegmentChangedEvent = SegmentCreatedEvent | SegmentUpdatedEvent | SegmentDeletedEvent;
+
+export interface SegmentWithVoiceCreatedEvent {
+    id: string;
+    type: 'SegmentWithVoiceCreated';
+    payload: SegmentWithVoice;
+}
+
+export interface SegmentWithVoiceUpdatedEvent {
+    id: string;
+    type: 'SegmentWithVoiceUpdated';
+    payload: SegmentWithVoice;
+}
+
+export interface SegmentWithVoiceDeletedEvent {
+    id: string;
+    type: 'SegmentWithVoiceDeleted';
+    payload: SegmentWithVoice;
+}
+
+export type SegmentWithVoiceChangedEvent = SegmentWithVoiceCreatedEvent | SegmentWithVoiceUpdatedEvent | SegmentWithVoiceDeletedEvent;

package/src/segment/segment-with-voice.ts

@@ -1,8 +1,8 @@
-import { Segment } from './segment';
-
-// a segment with audio in a single voice, because having all voices in one segment would make the entity very large
-// the only difference is that it includes a voiceIdAndLanguage field, which can be used as a range key to find the segment for a specific voice
-// segmentsWithVoice may point to default or non-default voices
-export interface SegmentWithVoice extends Segment {
-    voiceIdAndLanguage: string;
-}
+import { Segment } from './segment';
+
+// a segment with audio in a single voice, because having all voices in one segment would make the entity very large
+// the only difference is that it includes a voiceIdAndLanguage field, which can be used as a range key to find the segment for a specific voice
+// segmentsWithVoice may point to default or non-default voices
+export interface SegmentWithVoice extends Segment {
+    voiceIdAndLanguage: string;
+}

package/src/segment/segment.ts

@@ -1,82 +1,82 @@
-export interface SegmentVoice {
-    id: string;
-    language: string;
-    name: string;
-    countryCode: string;
-    speechProvider: string;
-}
-
-export interface Segment {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    hackId: string;
-    type: SegmentType;
-    title: string;
-    sections: SegmentSection[];
-    keywords: string[];
-    actions: SegmentAction[];
-    speech: SegmentSpeech[];
-    textSummary?: string;
-    lastUpdatedFromPendingSegmentId?: string;
-    hackType: string;
-    /** use @uptime.app/text-to-speech-contracts */
-    locale: string;
-}
-
-export type SegmentType =
-    'overview' | 'favourite-quote' | 'in-a-nutshell' |
-    'introduction' | 'here-are-the-insights' |
-    'insight-one' | 'insight-two' | 'insight-three' |
-    'put-in-action' | 'conclusion' |
-    'shareable-overview' | 'download-app-to-see-more';
-
-export type CardType = 'hack-cover' | 'action';
-
-export interface SegmentAction {
-    title: string;
-    cards: SegmentTextCard[];
-}
-
-export interface SegmentTextCard {
-    id: string;
-    markdown: string;
-    segmentType: SegmentType;
-    cardType?: CardType;
-    isTitle?: boolean;
-    speech?: TextCardSpeech[];
-}
-
-export interface SegmentSection {
-    heading?: string;
-    cards: SegmentTextCard[];
-}
-
-export interface SegmentSpeech {
-    voice: SegmentVoice;
-    withHeading: {
-        url: string;
-        lengthSeconds: number;
-    };
-    withoutHeading: {
-        url: string;
-        lengthSeconds: number;
-    };
-}
-
-export interface TextCardSpeech {
-    voiceId: string;
-    withHeading: {
-        timestamps: {
-            startsAt: number;
-            endsAt: number;
-        };
-    };
-    withoutHeading: {
-        timestamps: {
-            startsAt: number;
-            endsAt: number;
-        };
-    };
-}
+export interface SegmentVoice {
+    id: string;
+    language: string;
+    name: string;
+    countryCode: string;
+    speechProvider: string;
+}
+
+export interface Segment {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    hackId: string;
+    type: SegmentType;
+    title: string;
+    sections: SegmentSection[];
+    keywords: string[];
+    actions: SegmentAction[];
+    speech: SegmentSpeech[];
+    textSummary?: string;
+    lastUpdatedFromPendingSegmentId?: string;
+    hackType: string;
+    /** use @uptime.app/text-to-speech-contracts */
+    locale: string;
+}
+
+export type SegmentType =
+    'overview' | 'favourite-quote' | 'in-a-nutshell' |
+    'introduction' | 'here-are-the-insights' |
+    'insight-one' | 'insight-two' | 'insight-three' |
+    'put-in-action' | 'conclusion' |
+    'shareable-overview' | 'download-app-to-see-more';
+
+export type CardType = 'hack-cover' | 'action';
+
+export interface SegmentAction {
+    title: string;
+    cards: SegmentTextCard[];
+}
+
+export interface SegmentTextCard {
+    id: string;
+    markdown: string;
+    segmentType: SegmentType;
+    cardType?: CardType;
+    isTitle?: boolean;
+    speech?: TextCardSpeech[];
+}
+
+export interface SegmentSection {
+    heading?: string;
+    cards: SegmentTextCard[];
+}
+
+export interface SegmentSpeech {
+    voice: SegmentVoice;
+    withHeading: {
+        url: string;
+        lengthSeconds: number;
+    };
+    withoutHeading: {
+        url: string;
+        lengthSeconds: number;
+    };
+}
+
+export interface TextCardSpeech {
+    voiceId: string;
+    withHeading: {
+        timestamps: {
+            startsAt: number;
+            endsAt: number;
+        };
+    };
+    withoutHeading: {
+        timestamps: {
+            startsAt: number;
+            endsAt: number;
+        };
+    };
+}

package/src/service-simulator/mock-request-response.ts

@@ -1,17 +1,17 @@
-import { Context } from '../message-bus/context';
-
-export interface SetMockResponseRequest<T = any> {
-    transactionId: string;
-    mockedResponse: T;
-    isErrorResponse?: boolean;
-    matchRequest?: T;
-}
-
-export interface InternalLambdaRequest<T = any> {
-    context: Context;
-    payload: T;
-}
-
-export interface DeleteMockResponseRequest {
-    transactionId: string;
-}
+import { Context } from '../message-bus/context';
+
+export interface SetMockResponseRequest<T = any> {
+    transactionId: string;
+    mockedResponse: T;
+    isErrorResponse?: boolean;
+    matchRequest?: T;
+}
+
+export interface InternalLambdaRequest<T = any> {
+    context: Context;
+    payload: T;
+}
+
+export interface DeleteMockResponseRequest {
+    transactionId: string;
+}