@aptly-as/types 1.3.1 → 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 (58) hide show
  1. package/core/permission.d.ts +2 -2
  2. package/core/permission.ts +2 -1
  3. package/enums/document.d.ts +12 -1
  4. package/enums/document.js +12 -0
  5. package/enums/document.js.map +1 -1
  6. package/enums/document.ts +13 -2
  7. package/enums/index.d.ts +8 -0
  8. package/enums/index.js +9 -0
  9. package/enums/index.js.map +1 -1
  10. package/enums/index.ts +9 -0
  11. package/models/client.d.ts +5 -3
  12. package/models/client.ts +6 -3
  13. package/models/document.d.ts +6 -4
  14. package/models/document.ts +6 -4
  15. package/models/extends.d.ts +19 -1
  16. package/models/extends.ts +20 -1
  17. package/models/media.d.ts +10 -6
  18. package/models/media.ts +11 -6
  19. package/models/option-label.d.ts +6 -5
  20. package/models/option-label.ts +7 -5
  21. package/models/order.d.ts +6 -3
  22. package/models/order.ts +7 -3
  23. package/models/organization.d.ts +6 -5
  24. package/models/organization.ts +7 -5
  25. package/models/page.d.ts +14 -7
  26. package/models/page.ts +15 -7
  27. package/models/producer.d.ts +6 -6
  28. package/models/producer.ts +7 -6
  29. package/models/product-stats.d.ts +2 -3
  30. package/models/product-stats.ts +2 -3
  31. package/models/product.d.ts +17 -12
  32. package/models/product.ts +18 -12
  33. package/models/project.d.ts +6 -6
  34. package/models/project.ts +7 -6
  35. package/models/queue-download.d.ts +2 -4
  36. package/models/queue-download.ts +2 -5
  37. package/models/recommendation.d.ts +4 -6
  38. package/models/recommendation.ts +4 -6
  39. package/models/supplier.d.ts +6 -5
  40. package/models/supplier.ts +7 -5
  41. package/models/tag.d.ts +5 -3
  42. package/models/tag.ts +5 -3
  43. package/models/unit-email.d.ts +5 -2
  44. package/models/unit-email.js.map +1 -1
  45. package/models/unit-email.ts +5 -2
  46. package/models/unit-template.d.ts +11 -7
  47. package/models/unit-template.ts +11 -7
  48. package/models/unit.d.ts +5 -5
  49. package/models/unit.ts +6 -6
  50. package/models/upsell-template.d.ts +9 -9
  51. package/models/upsell-template.ts +10 -9
  52. package/models/user.d.ts +5 -2
  53. package/models/user.ts +6 -2
  54. package/models/webhook-event.d.ts +5 -2
  55. package/models/webhook-event.ts +6 -2
  56. package/models/webhook.d.ts +6 -4
  57. package/models/webhook.ts +7 -4
  58. package/package.json +1 -1
@@ -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,10 +1,8 @@
1
- import { AptlyDBCrawlerCleaner, AptlyHistorySchema } from './extends';
1
+ import { AptlyBaseSchema, AptlyDBCrawlerCleaner } from './extends';
2
2
  import { AptlyMediaSrcSchema } from './media';
3
+ import { AptlyProducerSchema } from './producer';
3
4
  export declare type AptlyProduct = AptlyProductSchema<string, string>;
4
- export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, AptlyHistorySchema<ID, DATE> {
5
- _id: ID;
6
- title: string;
7
- name: string;
5
+ export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, AptlyBaseSchema<ID, DATE> {
8
6
  searchableName: string;
9
7
  organization?: ID;
10
8
  project?: ID;
@@ -22,22 +20,29 @@ export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, Apt
22
20
  height?: string;
23
21
  length?: string;
24
22
  material?: string;
25
- producer?: ID;
23
+ unitCost?: number;
24
+ producer?: ID | AptlyProducerSchema<ID, DATE>;
26
25
  supplier?: ID;
27
26
  tags: ID[];
28
27
  documents: ID[];
29
- created: Date;
30
- archived: boolean;
28
+ createdBy: ID;
29
+ stats?: any;
30
+ importID?: ID;
31
+ /**
32
+ * @deprecated Use name
33
+ */
34
+ title: string;
31
35
  /**
32
36
  * @deprecated Not used
33
37
  */
34
38
  likes: {
35
39
  user: ID;
36
- date: Date;
40
+ date: DATE;
37
41
  }[];
38
- createdBy: ID;
39
- stats?: any;
40
- importID?: ID;
42
+ /**
43
+ * @deprecated use createdAt
44
+ */
45
+ created: DATE;
41
46
  }
42
47
  export declare type AptlyProductImage = AptlyProductImageSchema<string, string>;
43
48
  export interface AptlyProductImageSchema<ID, DATE> extends AptlyMediaSrcSchema<ID, DATE> {
package/models/product.ts CHANGED
@@ -1,11 +1,9 @@
1
- import { AptlyDBCrawlerCleaner, AptlyHistorySchema } from './extends';
1
+ import { AptlyBaseSchema, AptlyDBCrawlerCleaner } from './extends';
2
2
  import { AptlyMediaSrcSchema } from './media';
3
+ import { AptlyProducerSchema } from './producer';
3
4
 
4
5
  export 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;
6
+ export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, AptlyBaseSchema<ID, DATE> {
9
7
  searchableName: string;
10
8
  organization?: ID;
11
9
  project?: ID;
@@ -23,22 +21,30 @@ export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, Apt
23
21
  height?: string;
24
22
  length?: string;
25
23
  material?: string;
26
- producer?: ID;
24
+ unitCost?: number;
25
+ producer?: ID | AptlyProducerSchema<ID, DATE>;
27
26
  supplier?: ID;
28
27
  tags: ID[];
29
28
  documents: ID[];
30
- created: Date;
31
- archived: boolean;
29
+ createdBy: ID;
30
+ stats?: any;
31
+ importID?: ID;
32
+
33
+ /**
34
+ * @deprecated Use name
35
+ */
36
+ title: string;
32
37
  /**
33
38
  * @deprecated Not used
34
39
  */
35
40
  likes: {
36
41
  user: ID;
37
- date: Date;
42
+ date: DATE;
38
43
  }[];
39
- createdBy: ID;
40
- stats?: any;
41
- importID?: ID;
44
+ /**
45
+ * @deprecated use createdAt
46
+ */
47
+ created: DATE;
42
48
  }
43
49
 
44
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
- import { AptlyMediaSrc } from './media';
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
- imageMedia?: AptlyMediaSrc | null;
13
- archived?: boolean;
11
+ imageMedia?: AptlyMediaSrcSchema<ID, DATE> | null;
14
12
  }
@@ -1,15 +1,13 @@
1
- import { AptlyMediaSrc } from './media';
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
- imageMedia?: AptlyMediaSrc | null;
14
- archived?: boolean;
12
+ imageMedia?: AptlyMediaSrcSchema<ID, DATE> | null;
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,10 +1,12 @@
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';
5
+ import { AptlyMediaSrcSchema } from './media';
6
+ import { AptlyUpsellTemplateSchema } from './upsell-template';
7
+ import { AptlyProjectAlgorithmSchema, AptlyProjectPeriodSchema } from './project';
5
8
  export declare type AptlyUnitTemplateBase = AptlyUnitTemplateBaseSchema<string, string>;
6
- export interface AptlyUnitTemplateBaseSchema<ID, DATE> {
7
- _id: ID;
9
+ export interface AptlyUnitTemplateBaseSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
8
10
  _order_categories: ID[];
9
11
  categories: AptlyUnitTemplateCategorySchema<ID, DATE>[];
10
12
  }
@@ -33,7 +35,7 @@ export interface AptlyUnitTemplateCategorySchema<ID, DATE> {
33
35
  text?: string;
34
36
  isRoom: boolean;
35
37
  size?: number;
36
- upsellTemplate?: ID | null;
38
+ upsellTemplate?: AptlyUpsellTemplateSchema<ID, DATE> | ID | null;
37
39
  _order_sections: ID[];
38
40
  sections: AptlyUnitTemplateCategorySectionSchema<ID, DATE>[];
39
41
  /**
@@ -53,16 +55,18 @@ export interface AptlyUnitTemplateCategorySectionSchema<ID, DATE> {
53
55
  packages: AptlyUnitTemplateCategorySectionPackageSchema<ID, DATE>[];
54
56
  _order_products: ID[];
55
57
  products: AptlyUnitTemplateCategorySectionProductSchema<ID, DATE>[];
56
- period: ID;
58
+ period: AptlyProjectPeriodSchema<ID, DATE> | ID;
57
59
  }
58
60
  export declare type AptlyUnitTemplateCategorySectionPackage = AptlyUnitTemplateCategorySectionPackageSchema<string, string>;
59
61
  export interface AptlyUnitTemplateCategorySectionPackageSchema<ID, DATE> {
60
62
  _id: ID;
61
63
  name: string;
62
64
  standard: boolean;
63
- image?: string;
65
+ image?: string | null;
66
+ imageMedia?: AptlyMediaSrcSchema<ID, DATE> | null;
64
67
  description?: string;
65
68
  _product_order?: ID[];
69
+ products?: AptlyUnitTemplateCategorySectionProductSchema<ID, DATE>[];
66
70
  }
67
71
  export declare type AptlyUnitTemplateCategorySectionProduct = AptlyUnitTemplateCategorySectionProductSchema<string, string>;
68
72
  export interface AptlyUnitTemplateCategorySectionProductSchema<ID, DATE> {
@@ -79,7 +83,7 @@ export interface AptlyUnitTemplateCategorySectionProductSchema<ID, DATE> {
79
83
  consequenceParam?: string;
80
84
  amount: number;
81
85
  unitCost?: number;
82
- algorithm: ID;
86
+ algorithm: AptlyProjectAlgorithmSchema<ID, DATE> | ID;
83
87
  standard: boolean;
84
88
  standardVariant?: ID;
85
89
  partOfPackage?: ID;
@@ -1,14 +1,16 @@
1
- import { AptlyHistorySchema } from './extends';
1
+ import { AptlyBaseSchema, AptlyHistorySchema } from './extends';
2
2
  import {
3
3
  AptlyCategorySectionDisplayType, AptlyUnitTemplateCategorySectionProductMeasureUnitType,
4
4
  AptlyUnitTemplateCategorySectionProductParamKey
5
5
  } from '../enums';
6
6
  import { AptlyProductSchema } from './product';
7
7
  import { AptlyProducerSchema } from './producer';
8
+ import { AptlyMediaSrcSchema } from './media';
9
+ import { AptlyUpsellTemplateSchema } from './upsell-template';
10
+ import { AptlyProjectAlgorithmSchema, AptlyProjectPeriodSchema } from './project';
8
11
 
9
12
  export type AptlyUnitTemplateBase = AptlyUnitTemplateBaseSchema<string, string>;
10
- export interface AptlyUnitTemplateBaseSchema<ID, DATE> {
11
- _id: ID;
13
+ export interface AptlyUnitTemplateBaseSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
12
14
  _order_categories: ID[];
13
15
  categories: AptlyUnitTemplateCategorySchema<ID, DATE>[];
14
16
  }
@@ -41,7 +43,7 @@ export interface AptlyUnitTemplateCategorySchema<ID, DATE> {
41
43
  text?: string;
42
44
  isRoom: boolean;
43
45
  size?: number;
44
- upsellTemplate?: ID | null;
46
+ upsellTemplate?: AptlyUpsellTemplateSchema<ID, DATE> | ID | null;
45
47
  _order_sections: ID[];
46
48
  sections: AptlyUnitTemplateCategorySectionSchema<ID, DATE>[];
47
49
 
@@ -63,7 +65,7 @@ export interface AptlyUnitTemplateCategorySectionSchema<ID, DATE> {
63
65
  packages: AptlyUnitTemplateCategorySectionPackageSchema<ID, DATE>[];
64
66
  _order_products: ID[];
65
67
  products: AptlyUnitTemplateCategorySectionProductSchema<ID, DATE>[];
66
- period: ID;
68
+ period: AptlyProjectPeriodSchema<ID, DATE> | ID;
67
69
  }
68
70
 
69
71
  export type AptlyUnitTemplateCategorySectionPackage = AptlyUnitTemplateCategorySectionPackageSchema<string, string>;
@@ -71,9 +73,11 @@ export interface AptlyUnitTemplateCategorySectionPackageSchema<ID, DATE> {
71
73
  _id: ID;
72
74
  name: string;
73
75
  standard: boolean;
74
- image?: string;
76
+ image?: string | null;
77
+ imageMedia?: AptlyMediaSrcSchema<ID, DATE> | null;
75
78
  description?: string;
76
79
  _product_order?: ID[];
80
+ products?: AptlyUnitTemplateCategorySectionProductSchema<ID, DATE>[];
77
81
  }
78
82
 
79
83
  export type AptlyUnitTemplateCategorySectionProduct = AptlyUnitTemplateCategorySectionProductSchema<string, string>;
@@ -91,7 +95,7 @@ export interface AptlyUnitTemplateCategorySectionProductSchema<ID, DATE> {
91
95
  consequenceParam?: string;
92
96
  amount: number;
93
97
  unitCost?: number;
94
- algorithm: ID;
98
+ algorithm: AptlyProjectAlgorithmSchema<ID, DATE> | ID;
95
99
  standard: boolean;
96
100
  standardVariant?: ID;
97
101
  partOfPackage?: ID;
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
  }