@aptly-as/types 1.7.2 → 1.7.4

package/models/order.ts

@@ -1,66 +0,0 @@
-import { AptlyOrderStatus } from '../enums';
-import { AptlyUnitItemParamSchema } from './unit';
-import { AptlyBaseSchema } from './extends';
-
-export type AptlyOrder = AptlyOrderSchema<string, string>;
-export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
-  orderNumber: string;
-  organization: ID;
-  project: ID;
-  period: ID;
-  unit: ID;
-  signers: ID[];
-  status: AptlyOrderStatus;
-  receipt: ID;
-  attachments: ID[];
-  signage: AptlyOrderSignageSchema<ID, DATE>;
-  items: AptlyOrderItemSchema<ID, DATE>[];
-  totalCost: number;
-  pricePipeline: AptlyOrderPricePipelineItemSchema<ID>[];
-
-  /**
-   * @deprecated use createdAt
-   */
-  created: DATE;
-}
-
-export type AptlyOrderPricePipelineItem = AptlyOrderPricePipelineItemSchema<string>;
-export interface AptlyOrderPricePipelineItemSchema<ID> {
-  _id: ID;
-  label: string;
-  value: number;
-}
-
-export type AptlyOrderSignage = AptlyOrderSignageSchema<string, string>;
-export interface AptlyOrderSignageSchema<ID, DATE> {
-  hasReceivedFile: boolean;
-  signed: boolean;
-  documentId?: ID;
-  signedFile?: ID;
-  documentCreationDate?: DATE;
-  expireDate?: DATE;
-  customerSignerId?: string;
-  organizationSignerId?: string;
-  organizationSignedAt?: DATE;
-  customerSignedAt?: DATE;
-}
-
-export type AptlyOrderItem = AptlyOrderItemSchema<string, string>;
-export interface AptlyOrderItemSchema<ID, DATE> {
-  _id: ID;
-  text?: string;
-  product: ID;
-  variant: ID;
-  producer: ID;
-  params: AptlyUnitItemParamSchema<ID, DATE>[];
-  quantity: number;
-  unitCost: number;
-  pricePipeline: AptlyOrderItemPricePipelineSchema<ID>[];
-}
-
-export type AptlyOrderItemPricePipeline = AptlyOrderItemPricePipelineSchema<string>;
-export interface AptlyOrderItemPricePipelineSchema<ID> {
-  _id: ID;
-  label: string;
-  value: number;
-}

package/models/organization.ts

@@ -1,91 +0,0 @@
-import {
-  AptlyPermissionModulesModels,
-  AptlyPermissionOrganizationModels,
-  AptlyScope,
-  AptlySignageSchema
-} from '../core';
-import { AptlyUserSchema } from './user';
-import { AptlyMediaSrc } from './media';
-import { AptlyBaseSchema } from './extends';
-import { AptlyDepartmentGeneric } from './department';
-import { AptlyProducerSchema } from './producer';
-import { AptlyAppSchema } from './app';
-import { AptlyAlgorithmSchema } from './algorithm';
-
-export type AptlyOrganization = AptlyOrganizationSchema<string, string>;
-
-export interface AptlyOrganizationSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
-  slug: string;
-  logo?: string | null;
-  logoMedia?: AptlyMediaSrc | null;
-  address: {
-    visit: {
-      street: string;
-      zip: string;
-      city: string;
-    };
-    post: {
-      street: string;
-      zip: string;
-      city: string;
-    };
-  };
-  phone: string;
-  email: string;
-  algorithms: AptlyAlgorithmSchema<ID>[];
-  members: AptlyOrganizationMemberSchema<ID, DATE>[];
-  modules: AptlyPermissionModulesModels[];
-  contractSign?: AptlySignageSchema<ID, DATE>;
-  integrations: AptlyOrganizationIntegrationsSchema<ID>[];
-  invites: AptlyOrganizationInviteSchema<ID, DATE>[];
-  apps: AptlyOrganizationAppConfigSchema<ID, DATE>[];
-
-  /**
-   * @deprecated use createdAt
-   */
-  created: DATE;
-}
-
-export type AptlyOrganizationIntegrations = AptlyOrganizationIntegrationsSchema<string>;
-
-export interface AptlyOrganizationIntegrationsSchema<ID> {
-  _id: ID;
-  integration: string;
-  apiKey: string;
-  organization: string;
-}
-
-export type AptlyOrganizationMember = AptlyOrganizationMemberSchema<string, string>;
-
-export interface AptlyOrganizationMemberSchema<ID, DATE> {
-  _id: ID;
-  user: AptlyUserSchema<ID, DATE> | ID;
-  permissions: AptlyPermissionOrganizationModels[];
-  projects?: (ID | AptlyProducerSchema<ID, DATE>)[] | null;
-  departments?: (ID | AptlyDepartmentGeneric<ID, DATE>)[];
-}
-
-export type AptlyOrganizationInvite = AptlyOrganizationInviteSchema<string, string>;
-
-export interface AptlyOrganizationInviteSchema<ID, DATE> {
-  _id: ID;
-  code: string;
-  created: DATE;
-  permissions?: AptlyPermissionOrganizationModels[];
-  projects?: ID[] | null;
-  departments?: ID[] | null;
-  claim: {
-    email?: string;
-    claimed: boolean;
-    claimedBy: ID;
-    claimTime?: DATE;
-  };
-}
-
-export type AptlyOrganizationAppConfig<S extends object = object> = AptlyOrganizationAppConfigSchema<string, string, S>;
-
-export interface AptlyOrganizationAppConfigSchema<ID, DATE, S extends object = object> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
-  app: ID | AptlyAppSchema<ID, DATE>;
-  scope: AptlyScope[];
-  settings: S;
-}

package/models/page.ts

@@ -1,34 +0,0 @@
-import { AptlyPageSectionType } from '../enums';
-import { AptlyBaseSchema } from './extends';
-
-export type AptlyPage = AptlyPageSchema<string, string>;
-export interface AptlyPageSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
-  slug: string;
-  project: ID;
-  organization: ID;
-  summary: string;
-  icon?: string;
-  upsellTemplate?: ID | null;
-  sections: AptlyPageSectionSchema<ID, DATE>[];
-
-  /**
-   * @deprecated use upsellTemplate
-   */
-  legacy?: string; // Deprecated
-  /**
-   * @deprecated use upsellTemplate
-   */
-  image?: string; // Deprecated
-  /**
-   * @deprecated connected with project pages
-   */
-  showInMenu: boolean;
-}
-
-export type AptlyPageSection = AptlyPageSectionSchema<string, string>;
-export interface AptlyPageSectionSchema<ID, VALUE = any> {
-  _id: ID;
-  name: string;
-  type: AptlyPageSectionType;
-  value: VALUE;
-}

package/models/producer.ts

@@ -1,22 +0,0 @@
-import { AptlyBaseSchema } from './extends';
-import { AptlyMediaSrc } from './media';
-
-export type AptlyProducer = AptlyProducerSchema<string, string>;
-export interface AptlyProducerSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
-  email: string;
-  logo: string | null;
-  logoMedia?: AptlyMediaSrc | null;
-  url?: string;
-  organization?: ID;
-  createdBy: ID;
-  tags: ID[];
-
-  /**
-   * @deprecated not used
-   */
-  extends: ID;
-  /**
-   * @deprecated use createdAt
-   */
-  created: DATE;
-}

package/models/product-stats.ts

@@ -1,19 +0,0 @@
-import { AptlyBaseSchema } from './extends';
-
-export type AptlyProductStats = AptlyProductStatsSchema<string, string>;
-export interface AptlyProductStatsSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name'> {
-  product: ID;
-  project: ID;
-  organization: ID;
-  producer: ID;
-  extends?: ID;
-  tags: ID[];
-  stats: {
-    likes: number;
-    inUnits: number;
-    amountInUnits: number;
-    availability: number;
-    picks: number;
-    complaints: number;
-  };
-}

package/models/product.ts

@@ -1,82 +0,0 @@
-import { AptlyBaseSchema, AptlyDBCrawlerCleaner } from './extends';
-import { AptlyMediaSrcSchema } from './media';
-import { AptlyProducerSchema } from './producer';
-
-export type AptlyProduct = AptlyProductSchema<string, string>;
-export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, AptlyBaseSchema<ID, DATE> {
-  searchableName: string;
-  organization?: ID;
-  project?: ID;
-  extends?: ID;
-  productNumber: string;
-  description: string;
-  images: AptlyProductImageSchema<ID, DATE>[];
-  variants: AptlyProductVariantSchema<ID, DATE>[];
-  url?: string;
-  color?: string;
-  colorLabel?: string;
-  series?: string;
-  style?: string;
-  width?: string;
-  height?: string;
-  length?: string;
-  material?: string;
-  unitCost?: number;
-  producer?: ID | AptlyProducerSchema<ID, DATE>;
-  supplier?: ID;
-  tags: ID[];
-  documents: ID[];
-  createdBy: ID;
-  stats?: any;
-  importID?: ID;
-  source?: string;
-
-  /**
-   * @deprecated Use name
-   */
-  title: string;
-  /**
-   * @deprecated Not used
-   */
-  likes: {
-    user: ID;
-    date: DATE;
-  }[];
-  /**
-   * @deprecated use createdAt
-   */
-  created: DATE;
-}
-
-export type AptlyProductImage = AptlyProductImageSchema<string, string>;
-export interface AptlyProductImageSchema<ID, DATE> extends AptlyMediaSrcSchema<ID, DATE> {
-  image: string;
-  description?: string;
-  featured?: boolean;
-}
-
-export type AptlyProductVariant = AptlyProductVariantSchema<string, string>;
-export interface AptlyProductVariantSchema<ID, DATE> {
-  _id: ID;
-  title: string;
-  images: AptlyProductImageSchema<ID, DATE>[];
-  documents: ID[];
-
-  name?: string;
-  description?: string;
-  productNumber?: string;
-  color?: string;
-  colorLabel?: string;
-  series?: string;
-  material?: string;
-  style?: string;
-  width?: string;
-  height?: string;
-  length?: string;
-}
-
-export type AptlyProductImport = AptlyProductImportSchema<string, string>;
-export interface AptlyProductImportSchema<ID, DATE> extends Partial<Omit<AptlyProductSchema<ID, DATE>, 'images' | 'documents'>> {
-  images: string[];
-  documents: string[];
-}

package/models/project.ts

@@ -1,139 +0,0 @@
-import { AptlyOrganizationSchema } from './organization';
-import { AptlyPermissionModulesModels } from '../core';
-import { AptlyUserSchema } from './user';
-import { AptlyBaseSchema } from './extends';
-import { AptlyDocumentSchema } from './document';
-import { AptlyUnitOptionExtraItemSchema } from './unit';
-import { AptlyMediaSrc } from './media';
-
-export type AptlyProject = AptlyProjectSchema<string, string>;
-export interface AptlyProjectSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
-  organization: AptlyOrganizationSchema<ID, DATE> | ID;
-  /**
-   * @deprecated dont think this is used anymore
-   */
-  customers: ID[];
-  periods: AptlyProjectPeriodSchema<ID, DATE>[];
-  algorithms: AptlyProjectAlgorithmSchema<ID>[];
-  documents: AptlyDocumentSchema<ID, DATE>[];
-  pages: ID[];
-  myPageText?: string;
-  inviteText?: string;
-  notify: AptlyProjectNotifySchema<ID, DATE>[];
-  theme: AptlyProjectTheme;
-  integrations: AptlyProjectIntegrationSchema<ID>[];
-  disabledModules?: AptlyPermissionModulesModels[];
-  extraOptions?: AptlyUnitOptionExtraItemSchema<ID, DATE>[];
-
-  /**
-   * @deprecated use createdAt
-   */
-  created: DATE;
-}
-
-export type AptlyProjectPeriod = AptlyProjectPeriodSchema<string, string>;
-export interface AptlyProjectPeriodSchema<ID, DATE> {
-  _id: ID;
-  name: string;
-  open: DATE;
-  close: DATE;
-  override?: boolean;
-}
-
-/**
- * @deprecated use AptlyAlgorithm instead
- */
-export type AptlyProjectAlgorithm = AptlyProjectAlgorithmSchema<string>;
-
-/**
- * @deprecated use AptlyAlgorithm instead
- */
-export interface AptlyProjectAlgorithmSchema<ID> {
-  _id: ID;
-  name: string;
-  pipeline: AptlyProjectAlgorithmPipelineSchema<ID>[];
-  organization?: ID;
-  project?: ID;
-}
-
-/**
- * @deprecated use AptlyAlgorithmPipeline instead
- */
-export type AptlyProjectAlgorithmPipeline = AptlyProjectAlgorithmPipelineSchema<string>;
-/**
- * @deprecated use AptlyAlgorithmPipeline instead
- */
-export interface AptlyProjectAlgorithmPipelineSchema<ID> {
-  _id: ID;
-  label: string;
-  operation: 'base' | 'add' | 'subtract' | 'multiply';
-  value: number;
-  applyTo: 'previousStep' | 'base' | 'root';
-}
-
-export interface AptlyProjectTheme {
-  palette?: {
-    primary?: AptlyProjectThemePalette;
-    secondary?: AptlyProjectThemePalette;
-    font?: string;
-    background?: string;
-    confirm?: string;
-    green?: string;
-    yellow?: string;
-    red?: string;
-    cardBackground?: string;
-    cardContrast?: string;
-    border?: string;
-  };
-  fonts?: {
-    primary?: string;
-    secondary?: string;
-    tertiary?: string;
-    links?: [string];
-  };
-  images: {
-    logo?: string | null;
-    logoMedia?: AptlyMediaSrc | null;
-    largeLogo?: string | null;
-    hero?: string | null;
-    heroMedia?: AptlyMediaSrc | null;
-    fallback?: string | null;
-    fallbackMedia?: AptlyMediaSrc | null;
-  };
-  contact: {
-    name?: string;
-    phone?: string;
-    mail?: string;
-    complaintEmail?: string;
-  };
-}
-
-export interface AptlyProjectThemePalette {
-  dark?: string;
-  main?: string;
-  mainContrast?: string;
-  light?: string;
-  disabled?: string;
-  lightContrast?: string;
-}
-
-export type AptlyProjectIntegration = AptlyProjectIntegrationSchema<string>;
-export interface AptlyProjectIntegrationSchema<ID> {
-  integration: ID;
-  integrationName: string;
-  project: string;
-
-}
-
-export type AptlyProjectNotify = AptlyProjectNotifySchema<string, string>;
-interface AptlyProjectNotifySchema<ID, DATE> {
-  _id: ID;
-  user: AptlyUserSchema<ID, DATE> | ID;
-  inquiry: boolean;
-  booking: boolean;
-  complaint: boolean;
-  order?: boolean;
-  'order-created'?: boolean;
-  'order-signed'?: boolean;
-  'order-fileReceived'?: boolean;
-}

package/models/queue-download.ts

@@ -1,21 +0,0 @@
-import { AptlyQueueDownloadStatus, AptlyQueueDownloadType } from '../enums/index';
-import { AptlyDocumentSchema } from './document';
-import { AptlyMediaSchema } from './media';
-import { AptlyBaseSchema } from './extends';
-
-export type AptlyQueueDownload = AptlyQueueDownloadSchema<string, string>;
-export interface AptlyQueueDownloadSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
-  url: string;
-  type: AptlyQueueDownloadType;
-  status: AptlyQueueDownloadStatus;
-  error?: string;
-
-  organization?: ID;
-  project?: ID;
-  unit?: ID;
-  product?: ID;
-  productVariant?: ID;
-
-  document?: Partial<Pick<AptlyDocumentSchema<ID, DATE>, '_type' | 'name'>> | null;
-  media?: Partial<Pick<AptlyMediaSchema<ID, DATE>, 'name'>> | null;
-}

package/models/recommendation.ts

@@ -1,13 +0,0 @@
-import { AptlyMediaSrcSchema } from './media';
-import { AptlyBaseSchema } from './extends';
-
-export type AptlyRecommendation = AptlyRecommendationSchema<string, string>;
-export interface AptlyRecommendationSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
-  organization?: ID;
-  project?: ID;
-  title: string;
-  color: string;
-  text: string;
-  image?: string | null;
-  imageMedia?: AptlyMediaSrcSchema<ID, DATE> | null;
-}

package/models/supplier.ts

@@ -1,17 +0,0 @@
-import { AptlyMediaSrc } from './media';
-import { AptlyBaseSchema } from './extends';
-
-export type AptlySupplier = AptlySupplierSchema<string, string>;
-export interface AptlySupplierSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
-  email?: string;
-  logo: string | null;
-  logoMedia?: AptlyMediaSrc | null;
-  createdBy: ID;
-  organization?: ID;
-  extends?: ID;
-
-  /**
-   * @deprecated use createdAt
-   */
-  created: DATE;
-}

package/models/tag.ts

@@ -1,9 +0,0 @@
-import { AptlyBaseSchema } from './extends';
-
-export type AptlyTag = AptlyTagSchema<string, string>;
-export interface AptlyTagSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
-  /**
-   * @deprecated use createdAt
-   */
-  created: DATE;
-}

package/models/unit-email.ts

@@ -1,39 +0,0 @@
-import { AptlyOrganizationSchema } from './organization';
-import { AptlyProjectSchema } from './project';
-import { AptlyUnitSchema } from './unit';
-import { AptlyInquirySchema } from './inquiry';
-import { AptlyBookingSchema } from './booking';
-import { AptlyBaseSchema } from './extends';
-
-export type AptlyUnitEmail = AptlyUnitEmailSchema<string, string>;
-export interface AptlyUnitEmailSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
-  type: AptlyUnitEmailType;
-  to: string[];
-  subject: string;
-  references: string;
-  inReplyTo: string[];
-
-  organization: ID | AptlyOrganizationSchema<ID, DATE>;
-  project: ID | AptlyProjectSchema<ID, DATE>;
-  unit: ID | AptlyUnitSchema<ID, DATE>;
-
-  inquiry?: ID | AptlyInquirySchema<ID, DATE>;
-  booking?: ID | AptlyBookingSchema<ID, DATE>;
-
-  /**
-   * @deprecated use createdAt
-   */
-  created: DATE;
-}
-
-export enum AptlyUnitEmailType {
-  Inquiry = 'inquiry',
-  Invite = 'invite',
-  NewOwner = 'new-owner',
-  PeriodOpen = 'period-open',
-  PeriodClose = 'period-close',
-  BookingConfirm = 'booking-confirm',
-  BookingCancel = 'booking-cancel',
-  OrderCreated = 'order-created',
-  OrderSigned = 'order-signed',
-}