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

package/src/app-hack/app-hack-metadata.ts

@@ -1,61 +1,61 @@
-import { EnrichedHack } from '../enriched-hack/enriched-hack';
-
-export interface AppHackMetadata {
-    id: string;
-    language: string;
-    locale: string;
-    baseLocaleHackId: string;
-    v: number;
-    hackVersion: number;
-    createdAt: string;
-    updatedAt: string;
-    owner: string;
-    acl: string[];
-    /** List of catalogues ids the hack is in. ids do not have the 'catalogue:' prefix. Added in Oct 2024 */
-    catalogues: string[];
-    themeId: string;
-    title: string;
-    isHidden?: boolean;
-    editorialTags?: string[];
-    coverUrl?: string;
-    /** Added in July 2024. This is the URL of the cover image that is free to use without any copyright. */
-    copyrightFreeCoverUrl?: string;
-    description: string;
-    /** 'public' or 'private' introduced Mar 2024 */
-    shareScope: string;
-    segments: {
-        favouriteQuote: {
-            id: string;
-        };
-        inANutshell: {
-            id: string;
-        };
-        introduction: {
-            id: string;
-        };
-        insights: {id: string}[];
-        conclusion: {
-            id: string;
-        };
-        overview: {
-            id: string;
-        };
-        shareableOverview: {
-            id: string;
-        };
-        hereAreTheInsights: {
-            id: string;
-        };
-        putInAction?: {
-            id: string;
-        };
-    }
-    topics: EnrichedHack['topics'];
-    contributors?: EnrichedHack['contributors'];
-    type: string;
-    sourceData?: EnrichedHack['sourceData'];
-    profile: EnrichedHack['profile'];
-    timeSaved?: number;
-    estimatedTimeSaved?: number;
-    tenantDisplayName?: string;
-}
+import { EnrichedHack } from '../enriched-hack/enriched-hack';
+
+export interface AppHackMetadata {
+    id: string;
+    language: string;
+    locale: string;
+    baseLocaleHackId: string;
+    v: number;
+    hackVersion: number;
+    createdAt: string;
+    updatedAt: string;
+    owner: string;
+    acl: string[];
+    /** List of catalogues ids the hack is in. ids do not have the 'catalogue:' prefix. Added in Oct 2024 */
+    catalogues: string[];
+    themeId: string;
+    title: string;
+    isHidden?: boolean;
+    editorialTags?: string[];
+    coverUrl?: string;
+    /** Added in July 2024. This is the URL of the cover image that is free to use without any copyright. */
+    copyrightFreeCoverUrl?: string;
+    description: string;
+    /** 'public' or 'private' introduced Mar 2024 */
+    shareScope: string;
+    segments: {
+        favouriteQuote: {
+            id: string;
+        };
+        inANutshell: {
+            id: string;
+        };
+        introduction: {
+            id: string;
+        };
+        insights: {id: string}[];
+        conclusion: {
+            id: string;
+        };
+        overview: {
+            id: string;
+        };
+        shareableOverview: {
+            id: string;
+        };
+        hereAreTheInsights: {
+            id: string;
+        };
+        putInAction?: {
+            id: string;
+        };
+    }
+    topics: EnrichedHack['topics'];
+    contributors?: EnrichedHack['contributors'];
+    type: string;
+    sourceData?: EnrichedHack['sourceData'];
+    profile: EnrichedHack['profile'];
+    timeSaved?: number;
+    estimatedTimeSaved?: number;
+    tenantDisplayName?: string;
+}

package/src/app-hack/app-restricted-hack.ts

@@ -1,22 +1,22 @@
-import { EnrichedHack } from '../enriched-hack/enriched-hack';
-import { AppHackMetadata } from './app-hack-metadata';
-
-/**
- * Includes all of a hack's content the free users are allowed to access.
- */
-export interface AppRestrictedHack extends AppHackMetadata {
-    segments: AppHackMetadata['segments'] & {
-        // only allow access to the shareableOverview and overview segment
-        overview: EnrichedHack['segments']['overview'];
-        shareableOverview: EnrichedHack['segments']['shareableOverview'];
-    }
-    theme: EnrichedHack['theme'];
-    affiliate?: {
-        url: string;
-        name: string;
-    };
-    externalLink?: {
-        url: string;
-        type: 'Website' | 'Book' | 'Course' | 'Podcast' | 'Video' | 'Other';
-    };
-}
+import { EnrichedHack } from '../enriched-hack/enriched-hack';
+import { AppHackMetadata } from './app-hack-metadata';
+
+/**
+ * Includes all of a hack's content the free users are allowed to access.
+ */
+export interface AppRestrictedHack extends AppHackMetadata {
+    segments: AppHackMetadata['segments'] & {
+        // only allow access to the shareableOverview and overview segment
+        overview: EnrichedHack['segments']['overview'];
+        shareableOverview: EnrichedHack['segments']['shareableOverview'];
+    }
+    theme: EnrichedHack['theme'];
+    affiliate?: {
+        url: string;
+        name: string;
+    };
+    externalLink?: {
+        url: string;
+        type: 'Website' | 'Book' | 'Course' | 'Podcast' | 'Video' | 'Other';
+    };
+}

package/src/b2b-content-access/b2b-content-access.ts

@@ -1,57 +1,57 @@
-export interface B2BContentAccess {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    name: string;
-    blacklistedSubjects: string[]; //array of subjects that should
-}
-
-export interface B2BContentAccessCreatedEvent {
-    id: string;
-    type: 'B2BContentAccessCreated';
-    payload: B2BContentAccess;
-}
-
-export interface B2BContentAccessUpdatedEvent {
-    id: string;
-    type: 'B2BContentAccessUpdated';
-    payload: B2BContentAccess;
-}
-
-export interface B2BContentAccessDeletedEvent {
-    id: string;
-    type: 'B2BContentAccessDeleted';
-    payload: B2BContentAccess;
-}
-
-export declare type B2BContentAccessChangedEvent = B2BContentAccessCreatedEvent | B2BContentAccessUpdatedEvent | B2BContentAccessDeletedEvent;
-
-export interface ContentAccessB2BOrgEntry {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    b2bContentAccessId: string;
-    b2bOrgId: string;
-}
-
-export interface ContentAccessB2BOrgEntryCreatedEvent {
-    id: string;
-    type: 'ContentAccessB2BOrgEntryCreated';
-    payload: ContentAccessB2BOrgEntry;
-}
-
-export interface ContentAccessB2BOrgEntryUpdatedEvent {
-    id: string;
-    type: 'ContentAccessB2BOrgEntryUpdated';
-    payload: ContentAccessB2BOrgEntry;
-}
-
-export interface ContentAccessB2BOrgEntryDeletedEvent {
-    id: string;
-    type: 'ContentAccessB2BOrgEntryDeleted';
-    payload: ContentAccessB2BOrgEntry;
-}
-
-export type ContentAccessB2BOrgEntryChangedEvent = ContentAccessB2BOrgEntryCreatedEvent | ContentAccessB2BOrgEntryUpdatedEvent | ContentAccessB2BOrgEntryDeletedEvent;
+export interface B2BContentAccess {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    blacklistedSubjects: string[]; //array of subjects that should
+}
+
+export interface B2BContentAccessCreatedEvent {
+    id: string;
+    type: 'B2BContentAccessCreated';
+    payload: B2BContentAccess;
+}
+
+export interface B2BContentAccessUpdatedEvent {
+    id: string;
+    type: 'B2BContentAccessUpdated';
+    payload: B2BContentAccess;
+}
+
+export interface B2BContentAccessDeletedEvent {
+    id: string;
+    type: 'B2BContentAccessDeleted';
+    payload: B2BContentAccess;
+}
+
+export declare type B2BContentAccessChangedEvent = B2BContentAccessCreatedEvent | B2BContentAccessUpdatedEvent | B2BContentAccessDeletedEvent;
+
+export interface ContentAccessB2BOrgEntry {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    b2bContentAccessId: string;
+    b2bOrgId: string;
+}
+
+export interface ContentAccessB2BOrgEntryCreatedEvent {
+    id: string;
+    type: 'ContentAccessB2BOrgEntryCreated';
+    payload: ContentAccessB2BOrgEntry;
+}
+
+export interface ContentAccessB2BOrgEntryUpdatedEvent {
+    id: string;
+    type: 'ContentAccessB2BOrgEntryUpdated';
+    payload: ContentAccessB2BOrgEntry;
+}
+
+export interface ContentAccessB2BOrgEntryDeletedEvent {
+    id: string;
+    type: 'ContentAccessB2BOrgEntryDeleted';
+    payload: ContentAccessB2BOrgEntry;
+}
+
+export type ContentAccessB2BOrgEntryChangedEvent = ContentAccessB2BOrgEntryCreatedEvent | ContentAccessB2BOrgEntryUpdatedEvent | ContentAccessB2BOrgEntryDeletedEvent;

package/src/b2b-organisation/b2b-carousel.ts

@@ -1,33 +1,33 @@
-export interface B2BCarousel {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    owner: string;
-    items: B2BCarouselItem[];
-}
-
-export interface B2BCarouselItem {
-    type: 'collection' | 'hack';
-    id: string;
-}
-
-export interface B2BCarouselCreatedEvent {
-    id: string;
-    type: 'B2BCarouselCreated',
-    payload: B2BCarousel;
-}
-
-export interface B2BCarouselUpdatedEvent {
-    id: string;
-    type: 'B2BCarouselUpdated',
-    payload: B2BCarousel;
-}
-
-export interface B2BCarouselDeletedEvent {
-    id: string;
-    type: 'B2BCarouselDeleted',
-    payload: B2BCarousel;
-}
-
-export type B2BCarouselChangedEvent = B2BCarouselCreatedEvent | B2BCarouselUpdatedEvent | B2BCarouselDeletedEvent;
+export interface B2BCarousel {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    owner: string;
+    items: B2BCarouselItem[];
+}
+
+export interface B2BCarouselItem {
+    type: 'collection' | 'hack';
+    id: string;
+}
+
+export interface B2BCarouselCreatedEvent {
+    id: string;
+    type: 'B2BCarouselCreated',
+    payload: B2BCarousel;
+}
+
+export interface B2BCarouselUpdatedEvent {
+    id: string;
+    type: 'B2BCarouselUpdated',
+    payload: B2BCarousel;
+}
+
+export interface B2BCarouselDeletedEvent {
+    id: string;
+    type: 'B2BCarouselDeleted',
+    payload: B2BCarousel;
+}
+
+export type B2BCarouselChangedEvent = B2BCarouselCreatedEvent | B2BCarouselUpdatedEvent | B2BCarouselDeletedEvent;

package/src/b2b-organisation/b2b-org-idp-mapping.ts

@@ -1,28 +1,28 @@
-export interface B2BOrgIdpMapping {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    organisationId: string;
-    identityProviderId: string;
-}
-
-export interface B2BOrgIdpMappingCreatedEvent {
-    id: string;
-    type: 'B2BOrgIdpMappingCreated';
-    payload: B2BOrgIdpMapping;
-}
-
-export interface B2BOrgIdpMappingUpdatedEvent {
-    id: string;
-    type: 'B2BOrgIdpMappingUpdated';
-    payload: B2BOrgIdpMapping;
-}
-
-export interface B2BOrgIdpMappingDeletedEvent {
-    id: string;
-    type: 'B2BOrgIdpMappingDeleted';
-    payload: B2BOrgIdpMapping;
-}
-
+export interface B2BOrgIdpMapping {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    organisationId: string;
+    identityProviderId: string;
+}
+
+export interface B2BOrgIdpMappingCreatedEvent {
+    id: string;
+    type: 'B2BOrgIdpMappingCreated';
+    payload: B2BOrgIdpMapping;
+}
+
+export interface B2BOrgIdpMappingUpdatedEvent {
+    id: string;
+    type: 'B2BOrgIdpMappingUpdated';
+    payload: B2BOrgIdpMapping;
+}
+
+export interface B2BOrgIdpMappingDeletedEvent {
+    id: string;
+    type: 'B2BOrgIdpMappingDeleted';
+    payload: B2BOrgIdpMapping;
+}
+
 export type B2BOrgIdpMappingChangedEvent = B2BOrgIdpMappingCreatedEvent | B2BOrgIdpMappingUpdatedEvent | B2BOrgIdpMappingDeletedEvent;

package/src/b2b-organisation/b2b-organisation-events.ts

@@ -1,21 +1,21 @@
-import { B2BOrganisation } from './b2b-organisation';
-
-export interface B2BOrganisationCreatedEvent {
-    id: string;
-    type: 'B2BOrganisationCreated';
-    payload: B2BOrganisation;
-}
-
-export interface B2BOrganisationUpdatedEvent {
-    id: string;
-    type: 'B2BOrganisationUpdated';
-    payload: B2BOrganisation;
-}
-
-export interface B2BOrganisationDeletedEvent {
-    id: string;
-    type: 'B2BOrganisationDeleted';
-    payload: B2BOrganisation;
-}
-
-export type B2BOrganisationChangedEvent = B2BOrganisationCreatedEvent | B2BOrganisationUpdatedEvent | B2BOrganisationDeletedEvent;
+import { B2BOrganisation } from './b2b-organisation';
+
+export interface B2BOrganisationCreatedEvent {
+    id: string;
+    type: 'B2BOrganisationCreated';
+    payload: B2BOrganisation;
+}
+
+export interface B2BOrganisationUpdatedEvent {
+    id: string;
+    type: 'B2BOrganisationUpdated';
+    payload: B2BOrganisation;
+}
+
+export interface B2BOrganisationDeletedEvent {
+    id: string;
+    type: 'B2BOrganisationDeleted';
+    payload: B2BOrganisation;
+}
+
+export type B2BOrganisationChangedEvent = B2BOrganisationCreatedEvent | B2BOrganisationUpdatedEvent | B2BOrganisationDeletedEvent;

package/src/b2b-organisation/b2b-organisation-group-events.ts

@@ -0,0 +1,21 @@
+import { B2BOrganisationGroup } from './b2b-organisation-group';
+
+export interface B2BOrganisationGroupCreatedEvent {
+    id: string;
+    type: 'B2BOrganisationGroupCreated';
+    payload: B2BOrganisationGroup;
+}
+
+export interface B2BOrganisationGroupUpdatedEvent {
+    id: string;
+    type: 'B2BOrganisationGroupUpdated';
+    payload: B2BOrganisationGroup;
+}
+
+export interface B2BOrganisationGroupDeletedEvent {
+    id: string;
+    type: 'B2BOrganisationGroupDeleted';
+    payload: B2BOrganisationGroup;
+}
+
+export type B2BOrganisationGroupChangedEvent = B2BOrganisationGroupCreatedEvent | B2BOrganisationGroupUpdatedEvent | B2BOrganisationGroupDeletedEvent;

package/src/b2b-organisation/b2b-organisation-group-membership-events.ts

@@ -0,0 +1,21 @@
+import { B2BGroupMembership } from './b2b-organisation-group-membership';
+
+export interface B2BGroupMembershipCreatedEvent {
+    id: string;
+    type: 'B2BGroupMembershipCreated';
+    payload: B2BGroupMembership;
+}
+
+export interface B2BGroupMembershipUpdatedEvent {
+    id: string;
+    type: 'B2BGroupMembershipUpdated';
+    payload: B2BGroupMembership;
+}
+
+export interface B2BGroupMembershipDeletedEvent {
+    id: string;
+    type: 'B2BGroupMembershipDeleted';
+    payload: B2BGroupMembership;
+}
+
+export type B2BGroupMembershipChangedEvent = B2BGroupMembershipCreatedEvent | B2BGroupMembershipUpdatedEvent | B2BGroupMembershipDeletedEvent;

package/src/b2b-organisation/b2b-organisation-group-membership.ts

@@ -0,0 +1,9 @@
+export interface B2BGroupMembership {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    groupId: string;
+    memberId: string;
+    userId: string;
+}

package/src/b2b-organisation/b2b-organisation-group.ts

@@ -0,0 +1,15 @@
+export interface B2BOrganisationGroup {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    type: B2BOrganisationGroupType;
+    name: string;
+    owner: string;
+    //TBC criteria?:
+}
+
+export enum B2BOrganisationGroupType {
+    STATIC = 'STATIC',
+    DYNAMIC = 'DYNAMIC'
+}

package/src/b2b-organisation/b2b-organisation-invitation.ts

@@ -1,45 +1,45 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-
-export interface B2BInvitation {
-    id: string;
-    v: number;
-    updatedAt: string;
-    createdAt: string;
-    /** userId */
-    createdBy: string;
-    /** @deprecated */
-    name?: string;
-    /** @deprecated */
-    lastName?: string;
-    email: string;
-    code: string;
-    /** AppRole.B2bAdmin or AppRole.B2bMember. If not defined then treat as AppRole.B2bMember */
-    role?: string;
-    organisationId: string;
-    locale: SupportedLocale;
-}
-
-export interface B2BInvitationEventPayload {
-    id: string;
-    v: number;
-    createdAt: string;
-    /** userId */
-    createdBy: string;
-    updatedAt: string;
-    organisationId: string;
-    /** AppRole.B2bAdmin or AppRole.B2bMember. If not defined then treat as AppRole.B2bMember */
-    role?: string;
-    locale: SupportedLocale;
-}
-
-export interface B2BOrganisationInvitationCreatedEvent {
-    id: string;
-    type: 'B2BOrganisationInvitationCreated',
-    payload: B2BInvitationEventPayload;
-}
-
-export interface B2BOrganisationInvitationDeletedEvent {
-    id: string;
-    type: 'B2BOrganisationInvitationDeleted',
-    payload: B2BInvitationEventPayload;
-}
+import { SupportedLocale } from '../localisation/supported-locales';
+
+export interface B2BInvitation {
+    id: string;
+    v: number;
+    updatedAt: string;
+    createdAt: string;
+    /** userId */
+    createdBy: string;
+    /** @deprecated */
+    name?: string;
+    /** @deprecated */
+    lastName?: string;
+    email: string;
+    code: string;
+    /** AppRole.B2bAdmin or AppRole.B2bMember. If not defined then treat as AppRole.B2bMember */
+    role?: string;
+    organisationId: string;
+    locale: SupportedLocale;
+}
+
+export interface B2BInvitationEventPayload {
+    id: string;
+    v: number;
+    createdAt: string;
+    /** userId */
+    createdBy: string;
+    updatedAt: string;
+    organisationId: string;
+    /** AppRole.B2bAdmin or AppRole.B2bMember. If not defined then treat as AppRole.B2bMember */
+    role?: string;
+    locale: SupportedLocale;
+}
+
+export interface B2BOrganisationInvitationCreatedEvent {
+    id: string;
+    type: 'B2BOrganisationInvitationCreated',
+    payload: B2BInvitationEventPayload;
+}
+
+export interface B2BOrganisationInvitationDeletedEvent {
+    id: string;
+    type: 'B2BOrganisationInvitationDeleted',
+    payload: B2BInvitationEventPayload;
+}

package/src/b2b-organisation/b2b-organisation-member-events.ts

@@ -1,21 +1,21 @@
-import { B2BOrganisationMember } from './b2b-organisation-member';
-
-export interface B2BOrganisationMemberCreatedEvent {
-    id: string;
-    type: 'B2BOrganisationMemberCreated';
-    payload: B2BOrganisationMember;
-}
-
-export interface B2BOrganisationMemberUpdatedEvent {
-    id: string;
-    type: 'B2BOrganisationMemberUpdated';
-    payload: B2BOrganisationMember;
-}
-
-export interface B2BOrganisationMemberDeletedEvent {
-    id: string;
-    type: 'B2BOrganisationMemberDeleted';
-    payload: B2BOrganisationMember;
-}
-
-export type B2BOrganisationMemberChangedEvent = B2BOrganisationMemberCreatedEvent | B2BOrganisationMemberUpdatedEvent | B2BOrganisationMemberDeletedEvent;
+import { B2BOrganisationMember } from './b2b-organisation-member';
+
+export interface B2BOrganisationMemberCreatedEvent {
+    id: string;
+    type: 'B2BOrganisationMemberCreated';
+    payload: B2BOrganisationMember;
+}
+
+export interface B2BOrganisationMemberUpdatedEvent {
+    id: string;
+    type: 'B2BOrganisationMemberUpdated';
+    payload: B2BOrganisationMember;
+}
+
+export interface B2BOrganisationMemberDeletedEvent {
+    id: string;
+    type: 'B2BOrganisationMemberDeleted';
+    payload: B2BOrganisationMember;
+}
+
+export type B2BOrganisationMemberChangedEvent = B2BOrganisationMemberCreatedEvent | B2BOrganisationMemberUpdatedEvent | B2BOrganisationMemberDeletedEvent;