@uptime.app/contracts 3.0.18 → 3.0.19-rc.0

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-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;

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

@@ -1,20 +1,20 @@
-export interface B2BOrganisationMember {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    userId: string;
-    organisationId: string;
-    invitationId?: string;
-    /** Added Nov 2024. AppRole.B2bAdmin or AppRole.B2bMember */
-    role: string;
-    profileId?: string;
-    joinedVia?: B2BOrganisationMemberJoinedVia;
-    externalUserId?: string;
-}
-
-export enum B2BOrganisationMemberJoinedVia {
-    INVITATION = 'INVITATION',
-    PUBLIC_LINK = 'PUBLIC_LINK',
-    SSO = 'SSO',
+export interface B2BOrganisationMember {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    organisationId: string;
+    invitationId?: string;
+    /** Added Nov 2024. AppRole.B2bAdmin or AppRole.B2bMember */
+    role: string;
+    profileId?: string;
+    joinedVia?: B2BOrganisationMemberJoinedVia;
+    externalUserId?: string;
+}
+
+export enum B2BOrganisationMemberJoinedVia {
+    INVITATION = 'INVITATION',
+    PUBLIC_LINK = 'PUBLIC_LINK',
+    SSO = 'SSO',
 }

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

@@ -1,36 +1,36 @@
-export interface B2BOrganisation {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    name: string; //unique
-    owner: string; //unique
-    code?: string;
-    /** for now this will reference what to display in the home screen of the app for users that joined the organisation */
-    provider: string;
-    /** for organisations that might be different but have the same name to be displayed. Ex: HP Ireland & HP US ==> we want the displayName to be HP */
-    displayName: string;
-    /** the max amount of times the code to join an organisation can be used */
-    codeUsageLimit?: number;
-    /** the prefix to use for the url of the organisation */
-    urlPrefix?: string;
-    brandId?: string;
-    /** if the organisation provides members with the premium entitlement */
-    providesPremium?: boolean;
-    /** Introduced to allow simple creation of demo orgs for sales team. Is used in production but only for demo purposes */
-    isDemo?: boolean;
-    /** Is used in production but only for demo purposes */
-    demoLogoUrl?: string;
-    /** Any extra entitlements that are issued to members of this organisation. Not to be used provide premium - use providesPremium flag */
-    issuedEntitlements?: string[];
-    /** If the org members are not given free premium then override the standard RevenueCat offering presented to the user */
-    revenueCatOffering?: string;
-    /** Promo code to be applied when the user requests for the available stripe plans */
-    promoCode?: string;
-    /** Whether the public link can be use or not */
-    publicLinkDisabled?: boolean;
-    /** Whether the organisation can create content */
-    canCreateContent?: boolean;
-    /** Id of the Uptime LearnUpon portal the organisation's users have access to */
-    uptimeLearnUponPortalId?: string;
+export interface B2BOrganisation {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    name: string; //unique
+    owner: string; //unique
+    code?: string;
+    /** for now this will reference what to display in the home screen of the app for users that joined the organisation */
+    provider: string;
+    /** for organisations that might be different but have the same name to be displayed. Ex: HP Ireland & HP US ==> we want the displayName to be HP */
+    displayName: string;
+    /** the max amount of times the code to join an organisation can be used */
+    codeUsageLimit?: number;
+    /** the prefix to use for the url of the organisation */
+    urlPrefix?: string;
+    brandId?: string;
+    /** if the organisation provides members with the premium entitlement */
+    providesPremium?: boolean;
+    /** Introduced to allow simple creation of demo orgs for sales team. Is used in production but only for demo purposes */
+    isDemo?: boolean;
+    /** Is used in production but only for demo purposes */
+    demoLogoUrl?: string;
+    /** Any extra entitlements that are issued to members of this organisation. Not to be used provide premium - use providesPremium flag */
+    issuedEntitlements?: string[];
+    /** If the org members are not given free premium then override the standard RevenueCat offering presented to the user */
+    revenueCatOffering?: string;
+    /** Promo code to be applied when the user requests for the available stripe plans */
+    promoCode?: string;
+    /** Whether the public link can be use or not */
+    publicLinkDisabled?: boolean;
+    /** Whether the organisation can create content */
+    canCreateContent?: boolean;
+    /** Id of the Uptime LearnUpon portal the organisation's users have access to */
+    uptimeLearnUponPortalId?: string;
 }

package/src/brand/brand-events.ts

@@ -1,21 +1,21 @@
-import { Brand } from './brand';
-
-export interface BrandCreatedEvent {
-    id: string;
-    type: 'BrandCreated';
-    payload: Brand;
-}
-
-export interface BrandUpdatedEvent {
-    id: string;
-    type: 'BrandUpdated';
-    payload: Brand;
-}
-
-export interface BrandDeletedEvent {
-    id: string;
-    type: 'BrandDeleted';
-    payload: Brand;
-}
-
-export type BrandChangedEvent = BrandCreatedEvent | BrandUpdatedEvent | BrandDeletedEvent;
+import { Brand } from './brand';
+
+export interface BrandCreatedEvent {
+    id: string;
+    type: 'BrandCreated';
+    payload: Brand;
+}
+
+export interface BrandUpdatedEvent {
+    id: string;
+    type: 'BrandUpdated';
+    payload: Brand;
+}
+
+export interface BrandDeletedEvent {
+    id: string;
+    type: 'BrandDeleted';
+    payload: Brand;
+}
+
+export type BrandChangedEvent = BrandCreatedEvent | BrandUpdatedEvent | BrandDeletedEvent;

package/src/brand/brand.ts

@@ -1,28 +1,28 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-
-export interface Brand {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    name: string;
-    skinId?: string;
-    /** must unique across all brands */
-    webAppDomain?: string;
-    appName?: {
-        [K in SupportedLocale]?: string
-    };
-    welcomeHacks?: WelcomeHack[];
-    hasCustomTab?: boolean;
-    customTabLongName?: {
-        [K in SupportedLocale]?: string
-    };
-    customTabShortName?: {
-        [K in SupportedLocale]?: string
-    };
-}
-
-// In case we need to add more properties to the BrandHack interface, we can do so here.
-export interface WelcomeHack {
-    hackId: string;
+import { SupportedLocale } from '../localisation/supported-locales';
+
+export interface Brand {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    skinId?: string;
+    /** must unique across all brands */
+    webAppDomain?: string;
+    appName?: {
+        [K in SupportedLocale]?: string
+    };
+    welcomeHacks?: WelcomeHack[];
+    hasCustomTab?: boolean;
+    customTabLongName?: {
+        [K in SupportedLocale]?: string
+    };
+    customTabShortName?: {
+        [K in SupportedLocale]?: string
+    };
+}
+
+// In case we need to add more properties to the BrandHack interface, we can do so here.
+export interface WelcomeHack {
+    hackId: string;
 }