@aptly-as/types 2.5.3 → 2.5.5

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 (109) hide show
  1. package/core/api.d.ts +13 -13
  2. package/core/api.js +1 -1
  3. package/core/app.d.ts +37 -37
  4. package/core/app.js +9 -9
  5. package/core/cloudinary.d.ts +2 -2
  6. package/core/cloudinary.js +1 -1
  7. package/core/fields.d.ts +19 -19
  8. package/core/fields.js +1 -1
  9. package/core/index.d.ts +16 -16
  10. package/core/index.js +9 -9
  11. package/core/job.d.ts +21 -21
  12. package/core/job.js +11 -11
  13. package/core/redirect.d.ts +17 -17
  14. package/core/redirect.js +12 -12
  15. package/core/scope.d.ts +124 -124
  16. package/core/scope.js +117 -117
  17. package/core/signage.d.ts +19 -19
  18. package/core/signage.js +1 -1
  19. package/core/webhook-event-data.d.ts +16 -16
  20. package/core/webhook-event-data.js +1 -1
  21. package/enums/document.d.ts +38 -38
  22. package/enums/document.js +41 -41
  23. package/enums/fields.d.ts +30 -30
  24. package/enums/fields.js +31 -31
  25. package/enums/index.d.ts +151 -150
  26. package/enums/index.js +171 -170
  27. package/enums/unit-template.d.ts +10 -10
  28. package/enums/unit-template.js +12 -12
  29. package/enums/webhook.d.ts +23 -23
  30. package/enums/webhook.js +26 -26
  31. package/error/error.d.ts +28 -28
  32. package/error/error.js +50 -50
  33. package/error/index.d.ts +1 -1
  34. package/error/index.js +1 -1
  35. package/index.d.ts +4 -4
  36. package/index.js +4 -4
  37. package/models/algorithm.d.ts +32 -32
  38. package/models/algorithm.js +15 -15
  39. package/models/app.d.ts +102 -101
  40. package/models/app.js +53 -52
  41. package/models/availability.d.ts +35 -35
  42. package/models/availability.js +1 -1
  43. package/models/booking.d.ts +57 -57
  44. package/models/booking.js +1 -1
  45. package/models/client.d.ts +10 -10
  46. package/models/client.js +1 -1
  47. package/models/department.d.ts +28 -28
  48. package/models/department.js +1 -1
  49. package/models/document.d.ts +37 -37
  50. package/models/document.js +1 -1
  51. package/models/email.d.ts +16 -16
  52. package/models/email.js +1 -1
  53. package/models/extends.d.ts +37 -37
  54. package/models/extends.js +1 -1
  55. package/models/index.d.ts +34 -34
  56. package/models/index.js +34 -34
  57. package/models/inquiry.d.ts +57 -57
  58. package/models/inquiry.js +1 -1
  59. package/models/media.d.ts +50 -50
  60. package/models/media.js +1 -1
  61. package/models/module.d.ts +19 -19
  62. package/models/module.js +1 -1
  63. package/models/note.d.ts +19 -19
  64. package/models/note.js +1 -1
  65. package/models/notification-trigger.d.ts +9 -9
  66. package/models/notification-trigger.js +1 -1
  67. package/models/option-label.d.ts +7 -7
  68. package/models/option-label.js +1 -1
  69. package/models/order.d.ts +164 -163
  70. package/models/order.js +20 -20
  71. package/models/organization.d.ts +86 -86
  72. package/models/organization.js +7 -7
  73. package/models/page.d.ts +22 -22
  74. package/models/page.js +1 -1
  75. package/models/payment.d.ts +94 -94
  76. package/models/payment.js +1 -1
  77. package/models/period.d.ts +8 -8
  78. package/models/period.js +1 -1
  79. package/models/producer.d.ts +24 -24
  80. package/models/producer.js +1 -1
  81. package/models/product-stats.d.ts +18 -18
  82. package/models/product-stats.js +1 -1
  83. package/models/product.d.ts +78 -78
  84. package/models/product.js +1 -1
  85. package/models/project.d.ts +124 -124
  86. package/models/project.js +1 -1
  87. package/models/queue-download.d.ts +19 -19
  88. package/models/queue-download.js +1 -1
  89. package/models/recommendation.d.ts +12 -12
  90. package/models/recommendation.js +1 -1
  91. package/models/supplier.d.ts +12 -12
  92. package/models/supplier.js +1 -1
  93. package/models/tag.d.ts +5 -5
  94. package/models/tag.js +1 -1
  95. package/models/unit-email.d.ts +21 -21
  96. package/models/unit-email.js +1 -1
  97. package/models/unit-template.d.ts +124 -124
  98. package/models/unit-template.js +1 -1
  99. package/models/unit.d.ts +243 -243
  100. package/models/unit.js +1 -1
  101. package/models/upsell-template.d.ts +13 -13
  102. package/models/upsell-template.js +1 -1
  103. package/models/user.d.ts +33 -33
  104. package/models/user.js +16 -16
  105. package/models/webhook-event.d.ts +43 -43
  106. package/models/webhook-event.js +1 -1
  107. package/models/webhook.d.ts +15 -15
  108. package/models/webhook.js +1 -1
  109. package/package.json +5 -5
@@ -1,124 +1,124 @@
1
- import { AptlyEmailType, AptlyProjectStatus } from '../enums/index.js';
2
- import { AptlyAlgorithm, AptlyAlgorithmPipeline, AptlyAlgorithmPipelineSchema, AptlyAlgorithmSchema } from './algorithm.js';
3
- import { AptlyAppSchema } from './app.js';
4
- import { AptlyOrganizationSchema } from './organization.js';
5
- import { AptlyModules } from '../core/index.js';
6
- import { AptlyPeriod, AptlyPeriodSchema } from './period.js';
7
- import { AptlyUserSchema } from './user.js';
8
- import { AptlyAddress, AptlyBaseSchema, AptlyHistorySchema } from './extends.js';
9
- import { AptlyDocumentSchema } from './document.js';
10
- import { AptlyUnitOptionExtraItemSchema } from './unit.js';
11
- import { AptlyMediaSrc } from './media.js';
12
- export type AptlyProject = AptlyProjectSchema<string, string>;
13
- export interface AptlyProjectSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE>, AptlyHistorySchema<ID, DATE> {
14
- organization: AptlyOrganizationSchema<ID, DATE> | ID;
15
- template?: ID | null;
16
- customers: ID[];
17
- periods: AptlyPeriodSchema<ID, DATE>[];
18
- algorithms: AptlyAlgorithmSchema<ID>[];
19
- documents: AptlyDocumentSchema<ID, DATE>[];
20
- pages: ID[];
21
- myPageText?: string;
22
- inviteText?: string;
23
- notify: AptlyProjectNotifySchema<ID, DATE>[];
24
- theme: AptlyProjectTheme;
25
- integrations: AptlyProjectIntegrationSchema<ID>[];
26
- disabledModules?: AptlyModules[];
27
- extraOptions?: AptlyUnitOptionExtraItemSchema<ID, DATE>[];
28
- gdprActive?: boolean;
29
- userFavorites?: ID[];
30
- status?: AptlyProjectStatus;
31
- number?: string;
32
- developer?: string;
33
- field?: string;
34
- address?: AptlyAddress;
35
- paymentApp?: ID | AptlyAppSchema<ID, DATE> | null;
36
- invites?: AptlyProjectInviteSchema<ID, DATE>[];
37
- created: DATE;
38
- }
39
- export type AptlyProjectPeriod = AptlyPeriod;
40
- export type AptlyProjectPeriodSchema<ID, DATE> = AptlyPeriodSchema<ID, DATE>;
41
- export type AptlyProjectAlgorithm = AptlyAlgorithm;
42
- export type AptlyProjectAlgorithmSchema<ID> = AptlyAlgorithmSchema<ID>;
43
- export type AptlyProjectAlgorithmPipeline = AptlyAlgorithmPipeline;
44
- export type AptlyProjectAlgorithmPipelineSchema<ID> = AptlyAlgorithmPipelineSchema<ID>;
45
- export interface AptlyProjectTheme {
46
- palette?: {
47
- type?: 'dark' | 'light';
48
- primary?: AptlyProjectThemePalette;
49
- secondary?: AptlyProjectThemePalette;
50
- error?: AptlyProjectThemePalette;
51
- font?: string;
52
- background?: string;
53
- confirm?: string;
54
- green?: string;
55
- yellow?: string;
56
- red?: string;
57
- cardBackground?: string;
58
- cardContrast?: string;
59
- border?: string;
60
- };
61
- fonts?: {
62
- primary?: string;
63
- secondary?: string;
64
- tertiary?: string;
65
- links?: [string];
66
- };
67
- images: {
68
- logo?: string | null;
69
- logoMedia?: AptlyMediaSrc | null;
70
- largeLogo?: string | null;
71
- hero?: string | null;
72
- heroMedia?: AptlyMediaSrc | null;
73
- fallback?: string | null;
74
- fallbackMedia?: AptlyMediaSrc | null;
75
- };
76
- contact: {
77
- name?: string;
78
- phone?: string;
79
- mail?: string;
80
- complaintEmail?: string;
81
- };
82
- }
83
- export interface AptlyProjectThemePalette {
84
- dark?: string;
85
- main?: string;
86
- mainContrast?: string;
87
- light?: string;
88
- disabled?: string;
89
- lightContrast?: string;
90
- }
91
- export type AptlyProjectIntegration = AptlyProjectIntegrationSchema<string>;
92
- export interface AptlyProjectIntegrationSchema<ID> {
93
- _id: ID;
94
- integration: ID;
95
- integrationName: string;
96
- project: string;
97
- failures: {
98
- _id: string;
99
- error: string;
100
- name: string;
101
- }[];
102
- }
103
- export type AptlyProjectNotify = AptlyProjectNotifySchema<string, string>;
104
- export interface AptlyProjectNotifySchema<ID, DATE> {
105
- _id: ID;
106
- user: AptlyUserSchema<ID, DATE> | ID;
107
- types?: AptlyEmailType[];
108
- inquiry: boolean;
109
- booking: boolean;
110
- complaint: boolean;
111
- order?: boolean;
112
- 'order-created'?: boolean;
113
- 'order-signed'?: boolean;
114
- 'order-fileReceived'?: boolean;
115
- 'unit-note-reminder'?: boolean;
116
- }
117
- export type AptlyProjectInvite = AptlyProjectInviteSchema<string, string>;
118
- export interface AptlyProjectInviteSchema<ID, DATE> {
119
- _id: ID;
120
- unit: ID;
121
- code: string;
122
- createdAt: DATE;
123
- createdBy: ID;
124
- }
1
+ import { AptlyEmailType, AptlyProjectStatus } from '../enums/index.js';
2
+ import { AptlyAlgorithm, AptlyAlgorithmPipeline, AptlyAlgorithmPipelineSchema, AptlyAlgorithmSchema } from './algorithm.js';
3
+ import { AptlyAppSchema } from './app.js';
4
+ import { AptlyOrganizationSchema } from './organization.js';
5
+ import { AptlyModules } from '../core/index.js';
6
+ import { AptlyPeriod, AptlyPeriodSchema } from './period.js';
7
+ import { AptlyUserSchema } from './user.js';
8
+ import { AptlyAddress, AptlyBaseSchema, AptlyHistorySchema } from './extends.js';
9
+ import { AptlyDocumentSchema } from './document.js';
10
+ import { AptlyUnitOptionExtraItemSchema } from './unit.js';
11
+ import { AptlyMediaSrc } from './media.js';
12
+ export type AptlyProject = AptlyProjectSchema<string, string>;
13
+ export interface AptlyProjectSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE>, AptlyHistorySchema<ID, DATE> {
14
+ organization: AptlyOrganizationSchema<ID, DATE> | ID;
15
+ template?: ID | null;
16
+ customers: ID[];
17
+ periods: AptlyPeriodSchema<ID, DATE>[];
18
+ algorithms: AptlyAlgorithmSchema<ID>[];
19
+ documents: AptlyDocumentSchema<ID, DATE>[];
20
+ pages: ID[];
21
+ myPageText?: string;
22
+ inviteText?: string;
23
+ notify: AptlyProjectNotifySchema<ID, DATE>[];
24
+ theme: AptlyProjectTheme;
25
+ integrations: AptlyProjectIntegrationSchema<ID>[];
26
+ disabledModules?: AptlyModules[];
27
+ extraOptions?: AptlyUnitOptionExtraItemSchema<ID, DATE>[];
28
+ gdprActive?: boolean;
29
+ userFavorites?: ID[];
30
+ status?: AptlyProjectStatus;
31
+ number?: string;
32
+ developer?: string;
33
+ field?: string;
34
+ address?: AptlyAddress;
35
+ paymentApp?: ID | AptlyAppSchema<ID, DATE> | null;
36
+ invites?: AptlyProjectInviteSchema<ID, DATE>[];
37
+ created: DATE;
38
+ }
39
+ export type AptlyProjectPeriod = AptlyPeriod;
40
+ export type AptlyProjectPeriodSchema<ID, DATE> = AptlyPeriodSchema<ID, DATE>;
41
+ export type AptlyProjectAlgorithm = AptlyAlgorithm;
42
+ export type AptlyProjectAlgorithmSchema<ID> = AptlyAlgorithmSchema<ID>;
43
+ export type AptlyProjectAlgorithmPipeline = AptlyAlgorithmPipeline;
44
+ export type AptlyProjectAlgorithmPipelineSchema<ID> = AptlyAlgorithmPipelineSchema<ID>;
45
+ export interface AptlyProjectTheme {
46
+ palette?: {
47
+ type?: 'dark' | 'light';
48
+ primary?: AptlyProjectThemePalette;
49
+ secondary?: AptlyProjectThemePalette;
50
+ error?: AptlyProjectThemePalette;
51
+ font?: string;
52
+ background?: string;
53
+ confirm?: string;
54
+ green?: string;
55
+ yellow?: string;
56
+ red?: string;
57
+ cardBackground?: string;
58
+ cardContrast?: string;
59
+ border?: string;
60
+ };
61
+ fonts?: {
62
+ primary?: string;
63
+ secondary?: string;
64
+ tertiary?: string;
65
+ links?: [string];
66
+ };
67
+ images: {
68
+ logo?: string | null;
69
+ logoMedia?: AptlyMediaSrc | null;
70
+ largeLogo?: string | null;
71
+ hero?: string | null;
72
+ heroMedia?: AptlyMediaSrc | null;
73
+ fallback?: string | null;
74
+ fallbackMedia?: AptlyMediaSrc | null;
75
+ };
76
+ contact: {
77
+ name?: string;
78
+ phone?: string;
79
+ mail?: string;
80
+ complaintEmail?: string;
81
+ };
82
+ }
83
+ export interface AptlyProjectThemePalette {
84
+ dark?: string;
85
+ main?: string;
86
+ mainContrast?: string;
87
+ light?: string;
88
+ disabled?: string;
89
+ lightContrast?: string;
90
+ }
91
+ export type AptlyProjectIntegration = AptlyProjectIntegrationSchema<string>;
92
+ export interface AptlyProjectIntegrationSchema<ID> {
93
+ _id: ID;
94
+ integration: ID;
95
+ integrationName: string;
96
+ project: string;
97
+ failures: {
98
+ _id: string;
99
+ error: string;
100
+ name: string;
101
+ }[];
102
+ }
103
+ export type AptlyProjectNotify = AptlyProjectNotifySchema<string, string>;
104
+ export interface AptlyProjectNotifySchema<ID, DATE> {
105
+ _id: ID;
106
+ user: AptlyUserSchema<ID, DATE> | ID;
107
+ types?: AptlyEmailType[];
108
+ inquiry: boolean;
109
+ booking: boolean;
110
+ complaint: boolean;
111
+ order?: boolean;
112
+ 'order-created'?: boolean;
113
+ 'order-signed'?: boolean;
114
+ 'order-fileReceived'?: boolean;
115
+ 'unit-note-reminder'?: boolean;
116
+ }
117
+ export type AptlyProjectInvite = AptlyProjectInviteSchema<string, string>;
118
+ export interface AptlyProjectInviteSchema<ID, DATE> {
119
+ _id: ID;
120
+ unit: ID;
121
+ code: string;
122
+ createdAt: DATE;
123
+ createdBy: ID;
124
+ }
package/models/project.js CHANGED
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,19 +1,19 @@
1
- import { AptlyQueueDownloadStatus, AptlyQueueDownloadType } from '../enums/index.js';
2
- import { AptlyDocumentSchema } from './document.js';
3
- import { AptlyMediaSchema } from './media.js';
4
- import { AptlyBaseSchema } from './extends.js';
5
- export type AptlyQueueDownload = AptlyQueueDownloadSchema<string, string>;
6
- export interface AptlyQueueDownloadSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
7
- url: string;
8
- type: AptlyQueueDownloadType;
9
- status: AptlyQueueDownloadStatus;
10
- order?: number;
11
- error?: string;
12
- organization?: ID;
13
- project?: ID;
14
- unit?: ID;
15
- product?: ID;
16
- productVariant?: ID;
17
- document?: Partial<Pick<AptlyDocumentSchema<ID, DATE>, '_type' | 'name'>> | null;
18
- media?: Partial<Pick<AptlyMediaSchema<ID, DATE>, 'name'>> | null;
19
- }
1
+ import { AptlyQueueDownloadStatus, AptlyQueueDownloadType } from '../enums/index.js';
2
+ import { AptlyDocumentSchema } from './document.js';
3
+ import { AptlyMediaSchema } from './media.js';
4
+ import { AptlyBaseSchema } from './extends.js';
5
+ export type AptlyQueueDownload = AptlyQueueDownloadSchema<string, string>;
6
+ export interface AptlyQueueDownloadSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
7
+ url: string;
8
+ type: AptlyQueueDownloadType;
9
+ status: AptlyQueueDownloadStatus;
10
+ order?: number;
11
+ error?: string;
12
+ organization?: ID;
13
+ project?: ID;
14
+ unit?: ID;
15
+ product?: ID;
16
+ productVariant?: ID;
17
+ document?: Partial<Pick<AptlyDocumentSchema<ID, DATE>, '_type' | 'name'>> | null;
18
+ media?: Partial<Pick<AptlyMediaSchema<ID, DATE>, 'name'>> | null;
19
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,12 +1,12 @@
1
- import { AptlyMediaSrcSchema } from './media.js';
2
- import { AptlyBaseSchema } from './extends.js';
3
- export type AptlyRecommendation = AptlyRecommendationSchema<string, string>;
4
- export interface AptlyRecommendationSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
5
- organization?: ID;
6
- project?: ID;
7
- title: string;
8
- color: string;
9
- text: string;
10
- image?: string | null;
11
- imageMedia?: AptlyMediaSrcSchema<ID, DATE> | null;
12
- }
1
+ import { AptlyMediaSrcSchema } from './media.js';
2
+ import { AptlyBaseSchema } from './extends.js';
3
+ export type AptlyRecommendation = AptlyRecommendationSchema<string, string>;
4
+ export interface AptlyRecommendationSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
5
+ organization?: ID;
6
+ project?: ID;
7
+ title: string;
8
+ color: string;
9
+ text: string;
10
+ image?: string | null;
11
+ imageMedia?: AptlyMediaSrcSchema<ID, DATE> | null;
12
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,12 +1,12 @@
1
- import { AptlyMediaSrc } from './media.js';
2
- import { AptlyBaseSchema } from './extends.js';
3
- export type AptlySupplier = AptlySupplierSchema<string, string>;
4
- export interface AptlySupplierSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
5
- email?: string;
6
- logo: string | null;
7
- logoMedia?: AptlyMediaSrc | null;
8
- createdBy: ID;
9
- organization?: ID;
10
- extends?: ID;
11
- created: DATE;
12
- }
1
+ import { AptlyMediaSrc } from './media.js';
2
+ import { AptlyBaseSchema } from './extends.js';
3
+ export type AptlySupplier = AptlySupplierSchema<string, string>;
4
+ export interface AptlySupplierSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
5
+ email?: string;
6
+ logo: string | null;
7
+ logoMedia?: AptlyMediaSrc | null;
8
+ createdBy: ID;
9
+ organization?: ID;
10
+ extends?: ID;
11
+ created: DATE;
12
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};
package/models/tag.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { AptlyBaseSchema } from './extends.js';
2
- export type AptlyTag = AptlyTagSchema<string, string>;
3
- export interface AptlyTagSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
4
- created: DATE;
5
- }
1
+ import { AptlyBaseSchema } from './extends.js';
2
+ export type AptlyTag = AptlyTagSchema<string, string>;
3
+ export interface AptlyTagSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
4
+ created: DATE;
5
+ }
package/models/tag.js CHANGED
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,21 +1,21 @@
1
- import { AptlyEmailType } from '../enums/index.js';
2
- import { AptlyBookingSchema } from './booking.js';
3
- import { AptlyBaseSchema } from './extends.js';
4
- import { AptlyInquirySchema } from './inquiry.js';
5
- import { AptlyOrganizationSchema } from './organization.js';
6
- import { AptlyProjectSchema } from './project.js';
7
- import { AptlyUnitSchema } from './unit.js';
8
- export type AptlyUnitEmail = AptlyUnitEmailSchema<string, string>;
9
- export interface AptlyUnitEmailSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
10
- type: AptlyEmailType;
11
- to: string[];
12
- subject: string;
13
- references: string;
14
- inReplyTo: string[];
15
- organization: ID | AptlyOrganizationSchema<ID, DATE>;
16
- project: ID | AptlyProjectSchema<ID, DATE>;
17
- unit: ID | AptlyUnitSchema<ID, DATE>;
18
- inquiry?: ID | AptlyInquirySchema<ID, DATE>;
19
- booking?: ID | AptlyBookingSchema<ID, DATE>;
20
- created: DATE;
21
- }
1
+ import { AptlyEmailType } from '../enums/index.js';
2
+ import { AptlyBookingSchema } from './booking.js';
3
+ import { AptlyBaseSchema } from './extends.js';
4
+ import { AptlyInquirySchema } from './inquiry.js';
5
+ import { AptlyOrganizationSchema } from './organization.js';
6
+ import { AptlyProjectSchema } from './project.js';
7
+ import { AptlyUnitSchema } from './unit.js';
8
+ export type AptlyUnitEmail = AptlyUnitEmailSchema<string, string>;
9
+ export interface AptlyUnitEmailSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
10
+ type: AptlyEmailType;
11
+ to: string[];
12
+ subject: string;
13
+ references: string;
14
+ inReplyTo: string[];
15
+ organization: ID | AptlyOrganizationSchema<ID, DATE>;
16
+ project: ID | AptlyProjectSchema<ID, DATE>;
17
+ unit: ID | AptlyUnitSchema<ID, DATE>;
18
+ inquiry?: ID | AptlyInquirySchema<ID, DATE>;
19
+ booking?: ID | AptlyBookingSchema<ID, DATE>;
20
+ created: DATE;
21
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};