@aptly-as/types 1.3.4 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/models/client.d.ts +5 -3
  2. package/models/client.ts +6 -3
  3. package/models/document.d.ts +6 -4
  4. package/models/document.ts +6 -4
  5. package/models/extends.d.ts +13 -0
  6. package/models/extends.ts +14 -0
  7. package/models/media.d.ts +10 -6
  8. package/models/media.ts +11 -6
  9. package/models/option-label.d.ts +6 -5
  10. package/models/option-label.ts +7 -5
  11. package/models/order.d.ts +6 -3
  12. package/models/order.ts +7 -3
  13. package/models/organization.d.ts +6 -5
  14. package/models/organization.ts +7 -5
  15. package/models/page.d.ts +14 -7
  16. package/models/page.ts +15 -7
  17. package/models/producer.d.ts +6 -6
  18. package/models/producer.ts +7 -6
  19. package/models/product-stats.d.ts +2 -3
  20. package/models/product-stats.ts +2 -3
  21. package/models/product.d.ts +15 -11
  22. package/models/product.ts +16 -11
  23. package/models/project.d.ts +6 -6
  24. package/models/project.ts +7 -6
  25. package/models/queue-download.d.ts +2 -4
  26. package/models/queue-download.ts +2 -5
  27. package/models/recommendation.d.ts +2 -4
  28. package/models/recommendation.ts +2 -4
  29. package/models/supplier.d.ts +6 -5
  30. package/models/supplier.ts +7 -5
  31. package/models/tag.d.ts +5 -3
  32. package/models/tag.ts +5 -3
  33. package/models/unit-email.d.ts +5 -2
  34. package/models/unit-email.js.map +1 -1
  35. package/models/unit-email.ts +5 -2
  36. package/models/unit-template.d.ts +2 -3
  37. package/models/unit-template.ts +2 -3
  38. package/models/unit.d.ts +5 -5
  39. package/models/unit.ts +6 -6
  40. package/models/upsell-template.d.ts +9 -9
  41. package/models/upsell-template.ts +10 -9
  42. package/models/user.d.ts +5 -2
  43. package/models/user.ts +6 -2
  44. package/models/webhook-event.d.ts +5 -2
  45. package/models/webhook-event.ts +6 -2
  46. package/models/webhook.d.ts +6 -4
  47. package/models/webhook.ts +7 -4
  48. package/package.json +1 -1
@@ -1,11 +1,13 @@
1
- export interface AptlyUserClientSchema<ID, DATE> {
2
- _id: ID;
1
+ import { AptlyBaseSchema } from './extends';
2
+ export interface AptlyUserClientSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'archived'> {
3
3
  user: ID;
4
4
  subject: string;
5
5
  clientId: string;
6
6
  clientSecret?: string;
7
7
  permissions: any;
8
+ /**
9
+ * @deprecated use createdAt
10
+ */
8
11
  created: DATE;
9
- name: string;
10
12
  }
11
13
  export declare type AptlyUserClient = AptlyUserClientSchema<string, string>;
package/models/client.ts CHANGED
@@ -1,11 +1,14 @@
1
- export interface AptlyUserClientSchema<ID, DATE> {
2
- _id: ID;
1
+ import { AptlyBaseSchema } from './extends';
2
+
3
+ export interface AptlyUserClientSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'archived'> {
3
4
  user: ID;
4
5
  subject: string;
5
6
  clientId: string;
6
7
  clientSecret?: string;
7
8
  permissions: any;
9
+ /**
10
+ * @deprecated use createdAt
11
+ */
8
12
  created: DATE;
9
- name: string;
10
13
  }
11
14
  export type AptlyUserClient = AptlyUserClientSchema<string, string>;
@@ -1,10 +1,9 @@
1
1
  import { AptlyDocumentType } from '../enums';
2
+ import { AptlyBaseSchema } from './extends';
2
3
  export declare type AptlyDocument = AptlyDocumentSchema<string, string>;
3
- export interface AptlyDocumentSchema<ID, DATE> {
4
- _id: ID;
4
+ export interface AptlyDocumentSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'archived'> {
5
5
  mime: string;
6
6
  _type: AptlyDocumentType;
7
- name: string;
8
7
  data: string;
9
8
  organization?: string;
10
9
  project?: string;
@@ -12,7 +11,6 @@ export interface AptlyDocumentSchema<ID, DATE> {
12
11
  product?: string;
13
12
  text?: string;
14
13
  size: number;
15
- created: DATE;
16
14
  thirdPartyUploader: string | null;
17
15
  thirdPartyId: string | null;
18
16
  external_url?: string;
@@ -20,6 +18,10 @@ export interface AptlyDocumentSchema<ID, DATE> {
20
18
  boligmappaStatus?: AptlyDocumentSchemaBoligmappaStatusSchema<ID, DATE>[];
21
19
  chunks?: ID[];
22
20
  isPasswordProtected?: boolean;
21
+ /**
22
+ * @deprecated use createdAt
23
+ */
24
+ created: DATE;
23
25
  }
24
26
  export declare type AptlyDocumentSchemaBoligmappaStatus = AptlyDocumentSchemaBoligmappaStatusSchema<string, string>;
25
27
  export interface AptlyDocumentSchemaBoligmappaStatusSchema<ID, DATE> {
@@ -1,12 +1,11 @@
1
1
  import { AptlyDocumentType } from '../enums';
2
+ import { AptlyBaseSchema } from './extends';
2
3
 
3
4
 
4
5
  export type AptlyDocument = AptlyDocumentSchema<string, string>;
5
- export interface AptlyDocumentSchema<ID, DATE> {
6
- _id: ID;
6
+ export interface AptlyDocumentSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'archived'> {
7
7
  mime: string;
8
8
  _type: AptlyDocumentType;
9
- name: string;
10
9
  data: string;
11
10
  organization?: string;
12
11
  project?: string;
@@ -14,7 +13,6 @@ export interface AptlyDocumentSchema<ID, DATE> {
14
13
  product?: string;
15
14
  text?: string;
16
15
  size: number;
17
- created: DATE;
18
16
  thirdPartyUploader: string | null;
19
17
  thirdPartyId: string | null;
20
18
  external_url?: string;
@@ -22,6 +20,10 @@ export interface AptlyDocumentSchema<ID, DATE> {
22
20
  boligmappaStatus?: AptlyDocumentSchemaBoligmappaStatusSchema<ID, DATE>[];
23
21
  chunks?: ID[];
24
22
  isPasswordProtected?: boolean;
23
+ /**
24
+ * @deprecated use createdAt
25
+ */
26
+ created: DATE;
25
27
  }
26
28
 
27
29
  export type AptlyDocumentSchemaBoligmappaStatus = AptlyDocumentSchemaBoligmappaStatusSchema<string, string>;
@@ -1,8 +1,21 @@
1
1
  import { AptlyUserSchema } from './user';
2
2
  import { AptlyHistoryType } from '../enums';
3
+ export interface AptlyBaseSchema<ID, DATE> {
4
+ _id: ID;
5
+ name: string;
6
+ archived: boolean;
7
+ createdAt: DATE;
8
+ updatedAt: DATE;
9
+ }
3
10
  export declare type AptlyHistory = AptlyHistorySchema<string, string>;
4
11
  export interface AptlyHistorySchema<ID, DATE> {
12
+ /**
13
+ * @deprecated not used in v2
14
+ */
5
15
  locked: boolean;
16
+ /**
17
+ * @deprecated use updatedAt
18
+ */
6
19
  lastChange: DATE;
7
20
  history: AptlyHistoryHistorySchema<ID, DATE>[];
8
21
  }
package/models/extends.ts CHANGED
@@ -1,9 +1,23 @@
1
1
  import { AptlyUserSchema } from './user';
2
2
  import { AptlyHistoryType } from '../enums';
3
3
 
4
+ export interface AptlyBaseSchema<ID, DATE> {
5
+ _id: ID;
6
+ name: string;
7
+ archived: boolean;
8
+ createdAt: DATE;
9
+ updatedAt: DATE;
10
+ }
11
+
4
12
  export type AptlyHistory = AptlyHistorySchema<string, string>;
5
13
  export interface AptlyHistorySchema<ID, DATE> {
14
+ /**
15
+ * @deprecated not used in v2
16
+ */
6
17
  locked: boolean;
18
+ /**
19
+ * @deprecated use updatedAt
20
+ */
7
21
  lastChange: DATE;
8
22
  history: AptlyHistoryHistorySchema<ID, DATE>[];
9
23
  }
package/models/media.d.ts CHANGED
@@ -1,12 +1,8 @@
1
1
  import { AptlyOrganizationSchema } from './organization';
2
- export interface AptlyMediaSchema<ID, DATE> {
3
- _id: ID;
4
- archived: boolean;
5
- created: DATE;
6
- updated: DATE;
2
+ import { AptlyBaseSchema } from './extends';
3
+ export interface AptlyMediaSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
7
4
  organization: ID | AptlyOrganizationSchema<ID, DATE>;
8
5
  src: string;
9
- name: string;
10
6
  alt: string;
11
7
  caption?: string;
12
8
  title?: string;
@@ -29,6 +25,14 @@ export interface AptlyMediaSchema<ID, DATE> {
29
25
  placeholder: boolean;
30
26
  url: string;
31
27
  original_filename: string;
28
+ /**
29
+ * @deprecated use createdAt
30
+ */
31
+ created: DATE;
32
+ /**
33
+ * @deprecated use updatedAt
34
+ */
35
+ updated: DATE;
32
36
  srcUrl?: string;
33
37
  uploadSignature?: string;
34
38
  }
package/models/media.ts CHANGED
@@ -1,14 +1,10 @@
1
1
  import { AptlyOrganizationSchema } from './organization';
2
+ import { AptlyBaseSchema } from './extends';
2
3
 
3
- export interface AptlyMediaSchema<ID, DATE> {
4
+ export interface AptlyMediaSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
4
5
  // Aptly data
5
- _id: ID;
6
- archived: boolean;
7
- created: DATE;
8
- updated: DATE;
9
6
  organization: ID | AptlyOrganizationSchema<ID, DATE>;
10
7
  src: string;
11
- name: string;
12
8
  alt: string;
13
9
  caption?: string;
14
10
  title?: string;
@@ -34,6 +30,15 @@ export interface AptlyMediaSchema<ID, DATE> {
34
30
  url: string;
35
31
  original_filename: string;
36
32
 
33
+ /**
34
+ * @deprecated use createdAt
35
+ */
36
+ created: DATE;
37
+ /**
38
+ * @deprecated use updatedAt
39
+ */
40
+ updated: DATE;
41
+
37
42
  // Aptly recognize help values
38
43
  srcUrl?: string; // Recognize image if uploaded with url.
39
44
  uploadSignature?: string; // Recognize images with buffer content
@@ -1,9 +1,10 @@
1
+ import { AptlyBaseSchema } from './extends';
1
2
  export declare type AptlyOptionLabel = AptlyOptionLabelSchema<string, string>;
2
- export interface AptlyOptionLabelSchema<ID, DATE> {
3
- _id: ID;
4
- name: string;
5
- created: DATE;
3
+ export interface AptlyOptionLabelSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
6
4
  organization?: string;
7
5
  project?: string;
8
- archived?: boolean;
6
+ /**
7
+ * @deprecated use createdAt
8
+ */
9
+ created: DATE;
9
10
  }
@@ -1,10 +1,12 @@
1
+ import { AptlyBaseSchema } from './extends';
1
2
 
2
3
  export type AptlyOptionLabel = AptlyOptionLabelSchema<string, string>;
3
- export interface AptlyOptionLabelSchema<ID, DATE> {
4
- _id: ID;
5
- name: string;
6
- created: DATE;
4
+ export interface AptlyOptionLabelSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
7
5
  organization?: string;
8
6
  project?: string;
9
- archived?: boolean;
7
+
8
+ /**
9
+ * @deprecated use createdAt
10
+ */
11
+ created: DATE;
10
12
  }
package/models/order.d.ts CHANGED
@@ -1,10 +1,9 @@
1
1
  import { AptlyOrderStatus } from '../enums';
2
2
  import { AptlyUnitItemParamSchema } from './unit';
3
+ import { AptlyBaseSchema } from './extends';
3
4
  export declare type AptlyOrder = AptlyOrderSchema<string, string>;
4
- export interface AptlyOrderSchema<ID, DATE> {
5
- _id: ID;
5
+ export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
6
6
  orderNumber: string;
7
- created: DATE;
8
7
  organization: ID;
9
8
  project: ID;
10
9
  period: ID;
@@ -17,6 +16,10 @@ export interface AptlyOrderSchema<ID, DATE> {
17
16
  items: AptlyOrderItemSchema<ID, DATE>[];
18
17
  totalCost: number;
19
18
  pricePipeline: AptlyOrderPricePipelineItemSchema<ID>[];
19
+ /**
20
+ * @deprecated use createdAt
21
+ */
22
+ created: DATE;
20
23
  }
21
24
  export declare type AptlyOrderPricePipelineItem = AptlyOrderPricePipelineItemSchema<string>;
22
25
  export interface AptlyOrderPricePipelineItemSchema<ID> {
package/models/order.ts CHANGED
@@ -1,11 +1,10 @@
1
1
  import { AptlyOrderStatus } from '../enums';
2
2
  import { AptlyUnitItemParamSchema } from './unit';
3
+ import { AptlyBaseSchema } from './extends';
3
4
 
4
5
  export type AptlyOrder = AptlyOrderSchema<string, string>;
5
- export interface AptlyOrderSchema<ID, DATE> {
6
- _id: ID;
6
+ export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
7
7
  orderNumber: string;
8
- created: DATE;
9
8
  organization: ID;
10
9
  project: ID;
11
10
  period: ID;
@@ -18,6 +17,11 @@ export interface AptlyOrderSchema<ID, DATE> {
18
17
  items: AptlyOrderItemSchema<ID, DATE>[];
19
18
  totalCost: number;
20
19
  pricePipeline: AptlyOrderPricePipelineItemSchema<ID>[];
20
+
21
+ /**
22
+ * @deprecated use createdAt
23
+ */
24
+ created: DATE;
21
25
  }
22
26
 
23
27
  export type AptlyOrderPricePipelineItem = AptlyOrderPricePipelineItemSchema<string>;
@@ -2,10 +2,9 @@ import { AptlyPermissionModulesModels, AptlyPermissionOrganizationModels } from
2
2
  import { AptlySignageSchema } from '../core/signage';
3
3
  import { AptlyUserSchema } from './user';
4
4
  import { AptlyMediaSrc } from './media';
5
+ import { AptlyBaseSchema } from './extends';
5
6
  export declare type AptlyOrganization = AptlyOrganizationSchema<string, string>;
6
- export interface AptlyOrganizationSchema<ID, DATE> {
7
- _id: ID;
8
- name: string;
7
+ export interface AptlyOrganizationSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
9
8
  slug: string;
10
9
  logo?: string | null;
11
10
  logoMedia?: AptlyMediaSrc | null;
@@ -23,12 +22,14 @@ export interface AptlyOrganizationSchema<ID, DATE> {
23
22
  };
24
23
  phone: string;
25
24
  email: string;
26
- created: DATE;
27
- archived: boolean;
28
25
  members: AptlyOrganizationMemberSchema<ID, DATE>[];
29
26
  modules: AptlyPermissionModulesModels[];
30
27
  contractSign?: AptlySignageSchema<ID, DATE>;
31
28
  integrations: AptlyOrganizationIntegrationsSchema<ID>[];
29
+ /**
30
+ * @deprecated use createdAt
31
+ */
32
+ created: DATE;
32
33
  }
33
34
  export declare type AptlyOrganizationIntegrations = AptlyOrganizationIntegrationsSchema<string>;
34
35
  export interface AptlyOrganizationIntegrationsSchema<ID> {
@@ -2,11 +2,10 @@ import { AptlyPermissionModulesModels, AptlyPermissionOrganizationModels } from
2
2
  import { AptlySignageSchema } from '../core/signage';
3
3
  import { AptlyUserSchema } from './user';
4
4
  import { AptlyMediaSrc } from './media';
5
+ import { AptlyBaseSchema } from './extends';
5
6
 
6
7
  export type AptlyOrganization = AptlyOrganizationSchema<string, string>;
7
- export interface AptlyOrganizationSchema<ID, DATE> {
8
- _id: ID;
9
- name: string;
8
+ export interface AptlyOrganizationSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
10
9
  slug: string;
11
10
  logo?: string | null;
12
11
  logoMedia?: AptlyMediaSrc | null;
@@ -24,12 +23,15 @@ export interface AptlyOrganizationSchema<ID, DATE> {
24
23
  };
25
24
  phone: string;
26
25
  email: string;
27
- created: DATE;
28
- archived: boolean;
29
26
  members: AptlyOrganizationMemberSchema<ID, DATE>[];
30
27
  modules: AptlyPermissionModulesModels[];
31
28
  contractSign?: AptlySignageSchema<ID, DATE>;
32
29
  integrations: AptlyOrganizationIntegrationsSchema<ID>[];
30
+
31
+ /**
32
+ * @deprecated use createdAt
33
+ */
34
+ created: DATE;
33
35
  }
34
36
 
35
37
  export type AptlyOrganizationIntegrations = AptlyOrganizationIntegrationsSchema<string>;
package/models/page.d.ts CHANGED
@@ -1,19 +1,26 @@
1
1
  import { AptlyPageSectionType } from '../enums';
2
+ import { AptlyBaseSchema } from './extends';
2
3
  export declare type AptlyPage = AptlyPageSchema<string, string>;
3
- export interface AptlyPageSchema<ID, DATE> {
4
- _id: ID;
4
+ export interface AptlyPageSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
5
5
  slug: string;
6
- name: string;
7
6
  project: ID;
8
7
  organization: ID;
9
- showInMenu: boolean;
10
8
  summary: string;
11
9
  icon?: string;
12
- legacy?: string;
13
- image?: string;
14
10
  upsellTemplate?: ID | null;
15
11
  sections: AptlyPageSectionSchema<ID, DATE>[];
16
- archived?: boolean;
12
+ /**
13
+ * @deprecated use upsellTemplate
14
+ */
15
+ legacy?: string;
16
+ /**
17
+ * @deprecated use upsellTemplate
18
+ */
19
+ image?: string;
20
+ /**
21
+ * @deprecated connected with project pages
22
+ */
23
+ showInMenu: boolean;
17
24
  }
18
25
  export declare type AptlyPageSection = AptlyPageSectionSchema<string, string>;
19
26
  export interface AptlyPageSectionSchema<ID, DATE, VALUE = any> {
package/models/page.ts CHANGED
@@ -1,20 +1,28 @@
1
1
  import { AptlyPageSectionType } from '../enums';
2
+ import { AptlyBaseSchema } from './extends';
2
3
 
3
4
  export type AptlyPage = AptlyPageSchema<string, string>;
4
- export interface AptlyPageSchema<ID, DATE> {
5
- _id: ID;
5
+ export interface AptlyPageSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
6
6
  slug: string;
7
- name: string;
8
7
  project: ID;
9
8
  organization: ID;
10
- showInMenu: boolean;
11
9
  summary: string;
12
10
  icon?: string;
13
- legacy?: string; // Deprecated
14
- image?: string; // Deprecated
15
11
  upsellTemplate?: ID | null;
16
12
  sections: AptlyPageSectionSchema<ID, DATE>[];
17
- archived?: boolean;
13
+
14
+ /**
15
+ * @deprecated use upsellTemplate
16
+ */
17
+ legacy?: string; // Deprecated
18
+ /**
19
+ * @deprecated use upsellTemplate
20
+ */
21
+ image?: string; // Deprecated
22
+ /**
23
+ * @deprecated connected with project pages
24
+ */
25
+ showInMenu: boolean;
18
26
  }
19
27
 
20
28
  export type AptlyPageSection = AptlyPageSectionSchema<string, string>;
@@ -1,20 +1,20 @@
1
- import { AptlyHistorySchema } from './extends';
1
+ import { AptlyBaseSchema } from './extends';
2
2
  import { AptlyMediaSrc } from './media';
3
3
  export declare type AptlyProducer = AptlyProducerSchema<string, string>;
4
- export interface AptlyProducerSchema<ID, DATE> extends AptlyHistorySchema<ID, DATE> {
5
- _id: ID;
6
- name: string;
4
+ export interface AptlyProducerSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
7
5
  email: string;
8
6
  logo: string | null;
9
7
  logoMedia?: AptlyMediaSrc | null;
10
8
  url?: string;
11
- created: DATE;
12
9
  organization?: ID;
13
- archived: boolean;
14
10
  createdBy: ID;
15
11
  tags: ID[];
16
12
  /**
17
13
  * @deprecated not used
18
14
  */
19
15
  extends: ID;
16
+ /**
17
+ * @deprecated use createdAt
18
+ */
19
+ created: DATE;
20
20
  }
@@ -1,21 +1,22 @@
1
- import { AptlyHistorySchema } from './extends';
1
+ import { AptlyBaseSchema } from './extends';
2
2
  import { AptlyMediaSrc } from './media';
3
3
 
4
4
  export type AptlyProducer = AptlyProducerSchema<string, string>;
5
- export interface AptlyProducerSchema<ID, DATE> extends AptlyHistorySchema<ID, DATE> {
6
- _id: ID;
7
- name: string;
5
+ export interface AptlyProducerSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
8
6
  email: string;
9
7
  logo: string | null;
10
8
  logoMedia?: AptlyMediaSrc | null;
11
9
  url?: string;
12
- created: DATE;
13
10
  organization?: ID;
14
- archived: boolean;
15
11
  createdBy: ID;
16
12
  tags: ID[];
13
+
17
14
  /**
18
15
  * @deprecated not used
19
16
  */
20
17
  extends: ID;
18
+ /**
19
+ * @deprecated use createdAt
20
+ */
21
+ created: DATE;
21
22
  }
@@ -1,11 +1,10 @@
1
+ import { AptlyBaseSchema } from './extends';
1
2
  export declare type AptlyProductStats = AptlyProductStatsSchema<string, string>;
2
- export interface AptlyProductStatsSchema<ID, DATE> {
3
- _id: ID;
3
+ export interface AptlyProductStatsSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name'> {
4
4
  product: ID;
5
5
  project: ID;
6
6
  organization: ID;
7
7
  producer: ID;
8
- archived: boolean;
9
8
  extends?: ID;
10
9
  tags: ID[];
11
10
  stats: {
@@ -1,12 +1,11 @@
1
+ import { AptlyBaseSchema } from './extends';
1
2
 
2
3
  export type AptlyProductStats = AptlyProductStatsSchema<string, string>;
3
- export interface AptlyProductStatsSchema<ID, DATE> {
4
- _id: ID;
4
+ export interface AptlyProductStatsSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name'> {
5
5
  product: ID;
6
6
  project: ID;
7
7
  organization: ID;
8
8
  producer: ID;
9
- archived: boolean;
10
9
  extends?: ID;
11
10
  tags: ID[];
12
11
  stats: {
@@ -1,11 +1,8 @@
1
- import { AptlyDBCrawlerCleaner, AptlyHistorySchema } from './extends';
1
+ import { AptlyBaseSchema, AptlyDBCrawlerCleaner } from './extends';
2
2
  import { AptlyMediaSrcSchema } from './media';
3
3
  import { AptlyProducerSchema } from './producer';
4
4
  export declare type AptlyProduct = AptlyProductSchema<string, string>;
5
- export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, AptlyHistorySchema<ID, DATE> {
6
- _id: ID;
7
- title: string;
8
- name: string;
5
+ export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, AptlyBaseSchema<ID, DATE> {
9
6
  searchableName: string;
10
7
  organization?: ID;
11
8
  project?: ID;
@@ -23,22 +20,29 @@ export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, Apt
23
20
  height?: string;
24
21
  length?: string;
25
22
  material?: string;
23
+ unitCost?: number;
26
24
  producer?: ID | AptlyProducerSchema<ID, DATE>;
27
25
  supplier?: ID;
28
26
  tags: ID[];
29
27
  documents: ID[];
30
- created: Date;
31
- archived: boolean;
28
+ createdBy: ID;
29
+ stats?: any;
30
+ importID?: ID;
31
+ /**
32
+ * @deprecated Use name
33
+ */
34
+ title: string;
32
35
  /**
33
36
  * @deprecated Not used
34
37
  */
35
38
  likes: {
36
39
  user: ID;
37
- date: Date;
40
+ date: DATE;
38
41
  }[];
39
- createdBy: ID;
40
- stats?: any;
41
- importID?: ID;
42
+ /**
43
+ * @deprecated use createdAt
44
+ */
45
+ created: DATE;
42
46
  }
43
47
  export declare type AptlyProductImage = AptlyProductImageSchema<string, string>;
44
48
  export interface AptlyProductImageSchema<ID, DATE> extends AptlyMediaSrcSchema<ID, DATE> {
package/models/product.ts CHANGED
@@ -1,12 +1,9 @@
1
- import { AptlyDBCrawlerCleaner, AptlyHistorySchema } from './extends';
1
+ import { AptlyBaseSchema, AptlyDBCrawlerCleaner } from './extends';
2
2
  import { AptlyMediaSrcSchema } from './media';
3
3
  import { AptlyProducerSchema } from './producer';
4
4
 
5
5
  export type AptlyProduct = AptlyProductSchema<string, string>;
6
- export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, AptlyHistorySchema<ID, DATE> {
7
- _id: ID;
8
- title: string;
9
- name: string;
6
+ export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, AptlyBaseSchema<ID, DATE> {
10
7
  searchableName: string;
11
8
  organization?: ID;
12
9
  project?: ID;
@@ -24,22 +21,30 @@ export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, Apt
24
21
  height?: string;
25
22
  length?: string;
26
23
  material?: string;
24
+ unitCost?: number;
27
25
  producer?: ID | AptlyProducerSchema<ID, DATE>;
28
26
  supplier?: ID;
29
27
  tags: ID[];
30
28
  documents: ID[];
31
- created: Date;
32
- archived: boolean;
29
+ createdBy: ID;
30
+ stats?: any;
31
+ importID?: ID;
32
+
33
+ /**
34
+ * @deprecated Use name
35
+ */
36
+ title: string;
33
37
  /**
34
38
  * @deprecated Not used
35
39
  */
36
40
  likes: {
37
41
  user: ID;
38
- date: Date;
42
+ date: DATE;
39
43
  }[];
40
- createdBy: ID;
41
- stats?: any;
42
- importID?: ID;
44
+ /**
45
+ * @deprecated use createdAt
46
+ */
47
+ created: DATE;
43
48
  }
44
49
 
45
50
  export type AptlyProductImage = AptlyProductImageSchema<string, string>;
@@ -1,14 +1,12 @@
1
1
  import { AptlyOrganizationSchema } from './organization';
2
2
  import { AptlyPermissionModulesModels } from '../core';
3
3
  import { AptlyUserSchema } from './user';
4
- import { AptlyHistorySchema } from './extends';
4
+ import { AptlyBaseSchema } from './extends';
5
5
  import { AptlyDocumentSchema } from './document';
6
6
  import { AptlyUnitOptionExtraItemSchema } from './unit';
7
7
  import { AptlyMediaSrc } from './media';
8
8
  export declare type AptlyProject = AptlyProjectSchema<string, string>;
9
- export interface AptlyProjectSchema<ID, DATE> extends AptlyHistorySchema<ID, DATE> {
10
- _id: ID;
11
- name: string;
9
+ export interface AptlyProjectSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
12
10
  organization: AptlyOrganizationSchema<ID, DATE> | ID;
13
11
  /**
14
12
  * @deprecated dont think this is used anymore
@@ -18,8 +16,6 @@ export interface AptlyProjectSchema<ID, DATE> extends AptlyHistorySchema<ID, DAT
18
16
  algorithms: AptlyProjectAlgorithmSchema<ID, DATE>[];
19
17
  documents: AptlyDocumentSchema<ID, DATE>[];
20
18
  pages: ID[];
21
- created: Date;
22
- archived: false;
23
19
  myPageText?: string;
24
20
  inviteText?: string;
25
21
  notify: AptlyProjectNotifySchema<ID, DATE>[];
@@ -27,6 +23,10 @@ export interface AptlyProjectSchema<ID, DATE> extends AptlyHistorySchema<ID, DAT
27
23
  integrations: AptlyProjectIntegrationSchema<ID>[];
28
24
  disabledModules?: AptlyPermissionModulesModels[];
29
25
  extraOptions?: AptlyUnitOptionExtraItemSchema<ID, DATE>[];
26
+ /**
27
+ * @deprecated use createdAt
28
+ */
29
+ created: DATE;
30
30
  }
31
31
  export declare type AptlyProjectPeriod = AptlyProjectPeriodSchema<string, string>;
32
32
  export interface AptlyProjectPeriodSchema<ID, DATE> {
package/models/project.ts CHANGED
@@ -1,15 +1,13 @@
1
1
  import { AptlyOrganizationSchema } from './organization';
2
2
  import { AptlyPermissionModulesModels } from '../core';
3
3
  import { AptlyUserSchema } from './user';
4
- import { AptlyHistorySchema } from './extends';
4
+ import { AptlyBaseSchema } from './extends';
5
5
  import { AptlyDocumentSchema } from './document';
6
6
  import { AptlyUnitOptionExtraItemSchema } from './unit';
7
7
  import { AptlyMediaSrc } from './media';
8
8
 
9
9
  export type AptlyProject = AptlyProjectSchema<string, string>;
10
- export interface AptlyProjectSchema<ID, DATE> extends AptlyHistorySchema<ID, DATE> {
11
- _id: ID;
12
- name: string;
10
+ export interface AptlyProjectSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
13
11
  organization: AptlyOrganizationSchema<ID, DATE> | ID;
14
12
  /**
15
13
  * @deprecated dont think this is used anymore
@@ -19,8 +17,6 @@ export interface AptlyProjectSchema<ID, DATE> extends AptlyHistorySchema<ID, DAT
19
17
  algorithms: AptlyProjectAlgorithmSchema<ID, DATE>[];
20
18
  documents: AptlyDocumentSchema<ID, DATE>[];
21
19
  pages: ID[];
22
- created: Date;
23
- archived: false;
24
20
  myPageText?: string;
25
21
  inviteText?: string;
26
22
  notify: AptlyProjectNotifySchema<ID, DATE>[];
@@ -28,6 +24,11 @@ export interface AptlyProjectSchema<ID, DATE> extends AptlyHistorySchema<ID, DAT
28
24
  integrations: AptlyProjectIntegrationSchema<ID>[];
29
25
  disabledModules?: AptlyPermissionModulesModels[];
30
26
  extraOptions?: AptlyUnitOptionExtraItemSchema<ID, DATE>[];
27
+
28
+ /**
29
+ * @deprecated use createdAt
30
+ */
31
+ created: DATE;
31
32
  }
32
33
 
33
34
  export type AptlyProjectPeriod = AptlyProjectPeriodSchema<string, string>;
@@ -1,9 +1,9 @@
1
1
  import { AptlyQueueDownloadStatus, AptlyQueueDownloadType } from '../enums/index';
2
2
  import { AptlyDocumentSchema } from './document';
3
3
  import { AptlyMediaSchema } from './media';
4
+ import { AptlyBaseSchema } from './extends';
4
5
  export declare type AptlyQueueDownload = AptlyQueueDownloadSchema<string, string>;
5
- export interface AptlyQueueDownloadSchema<ID, DATE> {
6
- _id: ID;
6
+ export interface AptlyQueueDownloadSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
7
7
  url: string;
8
8
  type: AptlyQueueDownloadType;
9
9
  status: AptlyQueueDownloadStatus;
@@ -15,6 +15,4 @@ export interface AptlyQueueDownloadSchema<ID, DATE> {
15
15
  productVariant?: ID;
16
16
  document?: Partial<Pick<AptlyDocumentSchema<ID, DATE>, '_type' | 'name'>> | null;
17
17
  media?: Partial<Pick<AptlyMediaSchema<ID, DATE>, 'name'>> | null;
18
- createdAt: DATE;
19
- updatedAt: DATE;
20
18
  }
@@ -1,10 +1,10 @@
1
1
  import { AptlyQueueDownloadStatus, AptlyQueueDownloadType } from '../enums/index';
2
2
  import { AptlyDocumentSchema } from './document';
3
3
  import { AptlyMediaSchema } from './media';
4
+ import { AptlyBaseSchema } from './extends';
4
5
 
5
6
  export type AptlyQueueDownload = AptlyQueueDownloadSchema<string, string>;
6
- export interface AptlyQueueDownloadSchema<ID, DATE> {
7
- _id: ID;
7
+ export interface AptlyQueueDownloadSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
8
8
  url: string;
9
9
  type: AptlyQueueDownloadType;
10
10
  status: AptlyQueueDownloadStatus;
@@ -18,7 +18,4 @@ export interface AptlyQueueDownloadSchema<ID, DATE> {
18
18
 
19
19
  document?: Partial<Pick<AptlyDocumentSchema<ID, DATE>, '_type' | 'name'>> | null;
20
20
  media?: Partial<Pick<AptlyMediaSchema<ID, DATE>, 'name'>> | null;
21
-
22
- createdAt: DATE;
23
- updatedAt: DATE;
24
21
  }
@@ -1,14 +1,12 @@
1
1
  import { AptlyMediaSrcSchema } from './media';
2
+ import { AptlyBaseSchema } from './extends';
2
3
  export declare type AptlyRecommendation = AptlyRecommendationSchema<string, string>;
3
- export interface AptlyRecommendationSchema<ID, DATE> {
4
- _id: ID;
4
+ export interface AptlyRecommendationSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
5
5
  organization?: ID;
6
6
  project?: ID;
7
7
  title: string;
8
- name: string;
9
8
  color: string;
10
9
  text: string;
11
10
  image?: string | null;
12
11
  imageMedia?: AptlyMediaSrcSchema<ID, DATE> | null;
13
- archived?: boolean;
14
12
  }
@@ -1,15 +1,13 @@
1
1
  import { AptlyMediaSrcSchema } from './media';
2
+ import { AptlyBaseSchema } from './extends';
2
3
 
3
4
  export type AptlyRecommendation = AptlyRecommendationSchema<string, string>;
4
- export interface AptlyRecommendationSchema<ID, DATE> {
5
- _id: ID;
5
+ export interface AptlyRecommendationSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
6
6
  organization?: ID;
7
7
  project?: ID;
8
8
  title: string;
9
- name: string;
10
9
  color: string;
11
10
  text: string;
12
11
  image?: string | null;
13
12
  imageMedia?: AptlyMediaSrcSchema<ID, DATE> | null;
14
- archived?: boolean;
15
13
  }
@@ -1,14 +1,15 @@
1
1
  import { AptlyMediaSrc } from './media';
2
+ import { AptlyBaseSchema } from './extends';
2
3
  export declare type AptlySupplier = AptlySupplierSchema<string, string>;
3
- export interface AptlySupplierSchema<ID, DATE> {
4
- _id: ID;
5
- name: string;
4
+ export interface AptlySupplierSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
6
5
  email?: string;
7
6
  logo: string | null;
8
7
  logoMedia?: AptlyMediaSrc | null;
9
- created: DATE;
10
- archived: boolean;
11
8
  createdBy: ID;
12
9
  organization?: ID;
13
10
  extends?: ID;
11
+ /**
12
+ * @deprecated use createdAt
13
+ */
14
+ created: DATE;
14
15
  }
@@ -1,15 +1,17 @@
1
1
  import { AptlyMediaSrc } from './media';
2
+ import { AptlyBaseSchema } from './extends';
2
3
 
3
4
  export type AptlySupplier = AptlySupplierSchema<string, string>;
4
- export interface AptlySupplierSchema<ID, DATE> {
5
- _id: ID;
6
- name: string;
5
+ export interface AptlySupplierSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
7
6
  email?: string;
8
7
  logo: string | null;
9
8
  logoMedia?: AptlyMediaSrc | null;
10
- created: DATE;
11
- archived: boolean;
12
9
  createdBy: ID;
13
10
  organization?: ID;
14
11
  extends?: ID;
12
+
13
+ /**
14
+ * @deprecated use createdAt
15
+ */
16
+ created: DATE;
15
17
  }
package/models/tag.d.ts CHANGED
@@ -1,6 +1,8 @@
1
+ import { AptlyBaseSchema } from './extends';
1
2
  export declare type AptlyTag = AptlyTagSchema<string, string>;
2
- export interface AptlyTagSchema<ID, DATE> {
3
- _id: ID;
4
- name: string;
3
+ export interface AptlyTagSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
4
+ /**
5
+ * @deprecated use createdAt
6
+ */
5
7
  created: DATE;
6
8
  }
package/models/tag.ts CHANGED
@@ -1,7 +1,9 @@
1
+ import { AptlyBaseSchema } from './extends';
1
2
 
2
3
  export type AptlyTag = AptlyTagSchema<string, string>;
3
- export interface AptlyTagSchema<ID, DATE> {
4
- _id: ID;
5
- name: string;
4
+ export interface AptlyTagSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
5
+ /**
6
+ * @deprecated use createdAt
7
+ */
6
8
  created: DATE;
7
9
  }
@@ -3,9 +3,9 @@ import { AptlyProjectSchema } from './project';
3
3
  import { AptlyUnitSchema } from './unit';
4
4
  import { AptlyInquirySchema } from './inquiry';
5
5
  import { AptlyBookingSchema } from './booking';
6
+ import { AptlyBaseSchema } from './extends';
6
7
  export declare type AptlyUnitEmail = AptlyUnitEmailSchema<string, string>;
7
- export interface AptlyUnitEmailSchema<ID, DATE> {
8
- _id: ID;
8
+ export interface AptlyUnitEmailSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
9
9
  type: AptlyUnitEmailType;
10
10
  to: string[];
11
11
  subject: string;
@@ -16,6 +16,9 @@ export interface AptlyUnitEmailSchema<ID, DATE> {
16
16
  unit: ID | AptlyUnitSchema<ID, DATE>;
17
17
  inquiry?: ID | AptlyInquirySchema<ID, DATE>;
18
18
  booking?: ID | AptlyBookingSchema<ID, DATE>;
19
+ /**
20
+ * @deprecated use createdAt
21
+ */
19
22
  created: DATE;
20
23
  }
21
24
  export declare enum AptlyUnitEmailType {
@@ -1 +1 @@
1
- {"version":3,"file":"unit-email.js","sourceRoot":"","sources":["unit-email.ts"],"names":[],"mappings":";;AAyBA,IAAY,kBAUX;AAVD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;IACjB,4CAAsB,CAAA;IACtB,gDAA0B,CAAA;IAC1B,kDAA4B,CAAA;IAC5B,wDAAkC,CAAA;IAClC,sDAAgC,CAAA;IAChC,oDAA8B,CAAA;IAC9B,kDAA4B,CAAA;AAC9B,CAAC,EAVW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAU7B"}
1
+ {"version":3,"file":"unit-email.js","sourceRoot":"","sources":["unit-email.ts"],"names":[],"mappings":";;AA4BA,IAAY,kBAUX;AAVD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;IACjB,4CAAsB,CAAA;IACtB,gDAA0B,CAAA;IAC1B,kDAA4B,CAAA;IAC5B,wDAAkC,CAAA;IAClC,sDAAgC,CAAA;IAChC,oDAA8B,CAAA;IAC9B,kDAA4B,CAAA;AAC9B,CAAC,EAVW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAU7B"}
@@ -3,10 +3,10 @@ import { AptlyProjectSchema } from './project';
3
3
  import { AptlyUnitSchema } from './unit';
4
4
  import { AptlyInquirySchema } from './inquiry';
5
5
  import { AptlyBookingSchema } from './booking';
6
+ import { AptlyBaseSchema } from './extends';
6
7
 
7
8
  export type AptlyUnitEmail = AptlyUnitEmailSchema<string, string>;
8
- export interface AptlyUnitEmailSchema<ID, DATE> {
9
- _id: ID;
9
+ export interface AptlyUnitEmailSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
10
10
  type: AptlyUnitEmailType;
11
11
  to: string[];
12
12
  subject: string;
@@ -20,6 +20,9 @@ export interface AptlyUnitEmailSchema<ID, DATE> {
20
20
  inquiry?: ID | AptlyInquirySchema<ID, DATE>;
21
21
  booking?: ID | AptlyBookingSchema<ID, DATE>;
22
22
 
23
+ /**
24
+ * @deprecated use createdAt
25
+ */
23
26
  created: DATE;
24
27
  }
25
28
 
@@ -1,4 +1,4 @@
1
- import { AptlyHistorySchema } from './extends';
1
+ import { AptlyBaseSchema, AptlyHistorySchema } from './extends';
2
2
  import { AptlyCategorySectionDisplayType, AptlyUnitTemplateCategorySectionProductMeasureUnitType, AptlyUnitTemplateCategorySectionProductParamKey } from '../enums';
3
3
  import { AptlyProductSchema } from './product';
4
4
  import { AptlyProducerSchema } from './producer';
@@ -6,8 +6,7 @@ import { AptlyMediaSrcSchema } from './media';
6
6
  import { AptlyUpsellTemplateSchema } from './upsell-template';
7
7
  import { AptlyProjectAlgorithmSchema, AptlyProjectPeriodSchema } from './project';
8
8
  export declare type AptlyUnitTemplateBase = AptlyUnitTemplateBaseSchema<string, string>;
9
- export interface AptlyUnitTemplateBaseSchema<ID, DATE> {
10
- _id: ID;
9
+ export interface AptlyUnitTemplateBaseSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
11
10
  _order_categories: ID[];
12
11
  categories: AptlyUnitTemplateCategorySchema<ID, DATE>[];
13
12
  }
@@ -1,4 +1,4 @@
1
- import { AptlyHistorySchema } from './extends';
1
+ import { AptlyBaseSchema, AptlyHistorySchema } from './extends';
2
2
  import {
3
3
  AptlyCategorySectionDisplayType, AptlyUnitTemplateCategorySectionProductMeasureUnitType,
4
4
  AptlyUnitTemplateCategorySectionProductParamKey
@@ -10,8 +10,7 @@ import { AptlyUpsellTemplateSchema } from './upsell-template';
10
10
  import { AptlyProjectAlgorithmSchema, AptlyProjectPeriodSchema } from './project';
11
11
 
12
12
  export type AptlyUnitTemplateBase = AptlyUnitTemplateBaseSchema<string, string>;
13
- export interface AptlyUnitTemplateBaseSchema<ID, DATE> {
14
- _id: ID;
13
+ export interface AptlyUnitTemplateBaseSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
15
14
  _order_categories: ID[];
16
15
  categories: AptlyUnitTemplateCategorySchema<ID, DATE>[];
17
16
  }
package/models/unit.d.ts CHANGED
@@ -6,8 +6,6 @@ import { AptlyUserSchema } from './user';
6
6
  import { AptlyOrganizationSchema } from './organization';
7
7
  export declare type AptlyUnit = AptlyUnitSchema<string, string>;
8
8
  export interface AptlyUnitSchema<ID, DATE> extends AptlyUnitTemplateBaseSchema<ID, DATE>, AptlyUnitEditData, AptlyHistorySchema<ID, DATE> {
9
- _id: ID;
10
- name: string;
11
9
  status: AptlyUnitStatus;
12
10
  rooms: AptlyUnitRoomSchema<ID>[];
13
11
  selectedOptions: AptlyUnitOptionSchema<ID, DATE>[];
@@ -29,10 +27,8 @@ export interface AptlyUnitSchema<ID, DATE> extends AptlyUnitTemplateBaseSchema<I
29
27
  organization: AptlyOrganizationSchema<ID, DATE> | ID;
30
28
  project: AptlyProjectSchema<ID, DATE> | ID;
31
29
  users: (AptlyUserSchema<ID, DATE> | ID)[];
32
- unitTemplate: AptlyUnitTemplateSchema<ID, DATE>;
30
+ unitTemplate: ID | AptlyUnitTemplateSchema<ID, DATE>;
33
31
  confirmedPeriods: AptlyUnitConfirmedPeriodSchema<ID, DATE>[];
34
- created: DATE;
35
- archived: boolean;
36
32
  queueInvites: string[];
37
33
  invites: AptlyUnitInviteSchema<ID, DATE>[];
38
34
  /**
@@ -43,6 +39,10 @@ export interface AptlyUnitSchema<ID, DATE> extends AptlyUnitTemplateBaseSchema<I
43
39
  integrations: AptlyUnitIntegrationSchema<ID>[];
44
40
  handoverDate?: DATE | null;
45
41
  tree: any[];
42
+ /**
43
+ * @deprecated use createdAt
44
+ */
45
+ created: DATE;
46
46
  }
47
47
  export declare type AptlyUnitOverridePeriod = AptlyUnitOverridePeriodSchema<string, string>;
48
48
  export interface AptlyUnitOverridePeriodSchema<ID, DATE> {
package/models/unit.ts CHANGED
@@ -7,8 +7,6 @@ import { AptlyOrganizationSchema } from './organization';
7
7
 
8
8
  export type AptlyUnit = AptlyUnitSchema<string, string>;
9
9
  export interface AptlyUnitSchema<ID, DATE> extends AptlyUnitTemplateBaseSchema<ID, DATE>, AptlyUnitEditData, AptlyHistorySchema<ID, DATE> {
10
- _id: ID;
11
- name: string;
12
10
  status: AptlyUnitStatus;
13
11
  rooms: AptlyUnitRoomSchema<ID>[];
14
12
  selectedOptions: AptlyUnitOptionSchema<ID, DATE>[];
@@ -31,10 +29,8 @@ export interface AptlyUnitSchema<ID, DATE> extends AptlyUnitTemplateBaseSchema<I
31
29
  organization: AptlyOrganizationSchema<ID, DATE> | ID;
32
30
  project: AptlyProjectSchema<ID, DATE> | ID;
33
31
  users: (AptlyUserSchema<ID, DATE> | ID)[];
34
- unitTemplate: AptlyUnitTemplateSchema<ID, DATE>;
32
+ unitTemplate: ID | AptlyUnitTemplateSchema<ID, DATE>;
35
33
  confirmedPeriods: AptlyUnitConfirmedPeriodSchema<ID, DATE>[];
36
- created: DATE;
37
- archived: boolean;
38
34
  queueInvites: string[];
39
35
  invites: AptlyUnitInviteSchema<ID, DATE>[];
40
36
  /**
@@ -45,8 +41,12 @@ export interface AptlyUnitSchema<ID, DATE> extends AptlyUnitTemplateBaseSchema<I
45
41
  integrations: AptlyUnitIntegrationSchema<ID>[];
46
42
  handoverDate?: DATE | null;
47
43
 
48
-
49
44
  tree: any[];
45
+
46
+ /**
47
+ * @deprecated use createdAt
48
+ */
49
+ created: DATE;
50
50
  }
51
51
 
52
52
  export type AptlyUnitOverridePeriod = AptlyUnitOverridePeriodSchema<string, string>;
@@ -1,12 +1,6 @@
1
- import { AptlyHistorySchema } from './extends';
1
+ import { AptlyBaseSchema } from './extends';
2
2
  export declare type AptlyUpsellTemplate = AptlyUpsellTemplateSchema<string, string>;
3
- export interface AptlyUpsellTemplateSchema<ID, DATE> extends AptlyHistorySchema<ID, DATE> {
4
- _id: ID;
5
- name: string;
6
- /**
7
- * @deprecated not used.. Only for frontend
8
- */
9
- description: string;
3
+ export interface AptlyUpsellTemplateSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
10
4
  image?: string | null;
11
5
  imageMedia?: string | null;
12
6
  videoEmbed?: string;
@@ -14,6 +8,12 @@ export interface AptlyUpsellTemplateSchema<ID, DATE> extends AptlyHistorySchema<
14
8
  links: ID[];
15
9
  organization?: ID;
16
10
  project?: ID;
11
+ /**
12
+ * @deprecated use createdAt
13
+ */
17
14
  created: DATE;
18
- archived: boolean;
15
+ /**
16
+ * @deprecated not used.. Only for frontend
17
+ */
18
+ description: string;
19
19
  }
@@ -1,13 +1,7 @@
1
- import { AptlyHistorySchema } from './extends';
1
+ import { AptlyBaseSchema } from './extends';
2
2
 
3
3
  export type AptlyUpsellTemplate = AptlyUpsellTemplateSchema<string, string>;
4
- export interface AptlyUpsellTemplateSchema<ID, DATE> extends AptlyHistorySchema<ID, DATE> {
5
- _id: ID;
6
- name: string;
7
- /**
8
- * @deprecated not used.. Only for frontend
9
- */
10
- description: string;
4
+ export interface AptlyUpsellTemplateSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
11
5
  image?: string | null;
12
6
  imageMedia?: string | null;
13
7
  videoEmbed?: string;
@@ -15,6 +9,13 @@ export interface AptlyUpsellTemplateSchema<ID, DATE> extends AptlyHistorySchema<
15
9
  links: ID[];
16
10
  organization?: ID;
17
11
  project?: ID;
12
+
13
+ /**
14
+ * @deprecated use createdAt
15
+ */
18
16
  created: DATE;
19
- archived: boolean;
17
+ /**
18
+ * @deprecated not used.. Only for frontend
19
+ */
20
+ description: string;
20
21
  }
package/models/user.d.ts CHANGED
@@ -1,6 +1,6 @@
1
+ import { AptlyBaseSchema } from './extends';
1
2
  export declare type AptlyUser = AptlyUserSchema<string, string>;
2
- export interface AptlyUserSchema<ID, DATE> {
3
- _id: ID;
3
+ export interface AptlyUserSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'archived' | 'name'> {
4
4
  email: string;
5
5
  fullName: string;
6
6
  firstName?: string;
@@ -10,5 +10,8 @@ export interface AptlyUserSchema<ID, DATE> {
10
10
  gdpr: boolean;
11
11
  phone: string;
12
12
  synced: DATE;
13
+ /**
14
+ * @deprecated use createdAt
15
+ */
13
16
  created: DATE;
14
17
  }
package/models/user.ts CHANGED
@@ -1,7 +1,7 @@
1
+ import { AptlyBaseSchema } from './extends';
1
2
 
2
3
  export type AptlyUser = AptlyUserSchema<string, string>;
3
- export interface AptlyUserSchema<ID, DATE> {
4
- _id: ID;
4
+ export interface AptlyUserSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'archived' | 'name'> {
5
5
  email: string;
6
6
  fullName: string;
7
7
  firstName?: string;
@@ -11,5 +11,9 @@ export interface AptlyUserSchema<ID, DATE> {
11
11
  gdpr: boolean;
12
12
  phone: string;
13
13
  synced: DATE;
14
+
15
+ /**
16
+ * @deprecated use createdAt
17
+ */
14
18
  created: DATE;
15
19
  }
@@ -1,8 +1,8 @@
1
1
  import { AptlyWebhookEventStatus, AptlyWebhookType } from '../enums';
2
+ import { AptlyBaseSchema } from './extends';
2
3
  declare type ServerKeys = 'run' | 'organization' | 'project' | 'status' | 'url' | 'headers' | 'responses';
3
4
  export declare type AptlyWebhookEvent<T = unknown> = Omit<AptlyWebhookEventSchema<string, string, T>, ServerKeys>;
4
- export interface AptlyWebhookEventSchema<ID, DATE, DATA = unknown> {
5
- _id: ID;
5
+ export interface AptlyWebhookEventSchema<ID, DATE, DATA = unknown> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
6
6
  specversion: string;
7
7
  type: AptlyWebhookType;
8
8
  source: string;
@@ -20,6 +20,9 @@ export interface AptlyWebhookEventSchema<ID, DATE, DATA = unknown> {
20
20
  url: string;
21
21
  headers: AptlyWebhookEventHeaders;
22
22
  responses: AptlyWebhookEventResponseSchema<ID, DATE>[];
23
+ /**
24
+ * @deprecated use createdAt
25
+ */
23
26
  created: DATE;
24
27
  }
25
28
  export declare type AptlyWebhookEventResponse<DATA = any> = AptlyWebhookEventResponseSchema<string, string, DATA>;
@@ -1,9 +1,9 @@
1
1
  import { AptlyWebhookEventStatus, AptlyWebhookType } from '../enums';
2
+ import { AptlyBaseSchema } from './extends';
2
3
 
3
4
  type ServerKeys = 'run' | 'organization' | 'project' | 'status' | 'url' | 'headers' | 'responses';
4
5
  export type AptlyWebhookEvent<T = unknown> = Omit<AptlyWebhookEventSchema<string, string, T>, ServerKeys>;
5
- export interface AptlyWebhookEventSchema<ID, DATE, DATA = unknown> {
6
- _id: ID;
6
+ export interface AptlyWebhookEventSchema<ID, DATE, DATA = unknown> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
7
7
  specversion: string;
8
8
  type: AptlyWebhookType;
9
9
  source: string;
@@ -22,6 +22,10 @@ export interface AptlyWebhookEventSchema<ID, DATE, DATA = unknown> {
22
22
  url: string;
23
23
  headers: AptlyWebhookEventHeaders;
24
24
  responses: AptlyWebhookEventResponseSchema<ID, DATE>[];
25
+
26
+ /**
27
+ * @deprecated use createdAt
28
+ */
25
29
  created: DATE;
26
30
  }
27
31
 
@@ -1,15 +1,17 @@
1
1
  import { AptlyWebhookStatus, AptlyWebhookType } from '../enums';
2
- export interface AptlyWebhookSchema<ID, DATE> {
3
- _id: ID;
2
+ import { AptlyBaseSchema } from './extends';
3
+ export interface AptlyWebhookSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
4
4
  organization: ID;
5
5
  user?: ID;
6
6
  project?: ID;
7
- name: string;
8
- created: DATE;
9
7
  status: AptlyWebhookStatus;
10
8
  url: string;
11
9
  types: AptlyWebhookType[];
12
10
  secret?: string;
13
11
  state?: string;
12
+ /**
13
+ * @deprecated use createdAt
14
+ */
15
+ created: DATE;
14
16
  }
15
17
  export declare type AptlyWebhook = AptlyWebhookSchema<string, string>;
package/models/webhook.ts CHANGED
@@ -1,17 +1,20 @@
1
1
  import { AptlyWebhookStatus, AptlyWebhookType } from '../enums';
2
+ import { AptlyBaseSchema } from './extends';
2
3
 
3
- export interface AptlyWebhookSchema<ID, DATE> {
4
- _id: ID;
4
+ export interface AptlyWebhookSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
5
5
  organization: ID;
6
6
  user?: ID;
7
7
  project?: ID;
8
- name: string;
9
- created: DATE;
10
8
  status: AptlyWebhookStatus;
11
9
 
12
10
  url: string;
13
11
  types: AptlyWebhookType[];
14
12
  secret?: string;
15
13
  state?: string;
14
+
15
+ /**
16
+ * @deprecated use createdAt
17
+ */
18
+ created: DATE;
16
19
  }
17
20
  export type AptlyWebhook = AptlyWebhookSchema<string, string>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aptly-as/types",
3
- "version": "1.3.4",
3
+ "version": "1.4.0",
4
4
  "description": "Aptly types and enums",
5
5
  "main": "./index.js",
6
6
  "types": "./index.d.ts",