@aptly-as/types 2.5.3 → 2.5.4

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 +101 -101
  40. package/models/app.js +52 -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
package/models/index.js CHANGED
@@ -1,34 +1,34 @@
1
- export * from './algorithm.js';
2
- export * from './app.js';
3
- export * from './booking.js';
4
- export * from './client.js';
5
- export * from './department.js';
6
- export * from './document.js';
7
- export * from './email.js';
8
- export * from './extends.js';
9
- export * from './inquiry.js';
10
- export * from './media.js';
11
- export * from './module.js';
12
- export * from './note.js';
13
- export * from './notification-trigger.js';
14
- export * from './option-label.js';
15
- export * from './order.js';
16
- export * from './organization.js';
17
- export * from './page.js';
18
- export * from './payment.js';
19
- export * from './period.js';
20
- export * from './producer.js';
21
- export * from './product.js';
22
- export * from './product-stats.js';
23
- export * from './project.js';
24
- export * from './queue-download.js';
25
- export * from './recommendation.js';
26
- export * from './supplier.js';
27
- export * from './tag.js';
28
- export * from './unit.js';
29
- export * from './unit-template.js';
30
- export * from './unit-email.js';
31
- export * from './upsell-template.js';
32
- export * from './user.js';
33
- export * from './webhook.js';
34
- export * from './webhook-event.js';
1
+ export * from './algorithm.js';
2
+ export * from './app.js';
3
+ export * from './booking.js';
4
+ export * from './client.js';
5
+ export * from './department.js';
6
+ export * from './document.js';
7
+ export * from './email.js';
8
+ export * from './extends.js';
9
+ export * from './inquiry.js';
10
+ export * from './media.js';
11
+ export * from './module.js';
12
+ export * from './note.js';
13
+ export * from './notification-trigger.js';
14
+ export * from './option-label.js';
15
+ export * from './order.js';
16
+ export * from './organization.js';
17
+ export * from './page.js';
18
+ export * from './payment.js';
19
+ export * from './period.js';
20
+ export * from './producer.js';
21
+ export * from './product.js';
22
+ export * from './product-stats.js';
23
+ export * from './project.js';
24
+ export * from './queue-download.js';
25
+ export * from './recommendation.js';
26
+ export * from './supplier.js';
27
+ export * from './tag.js';
28
+ export * from './unit.js';
29
+ export * from './unit-template.js';
30
+ export * from './unit-email.js';
31
+ export * from './upsell-template.js';
32
+ export * from './user.js';
33
+ export * from './webhook.js';
34
+ export * from './webhook-event.js';
@@ -1,57 +1,57 @@
1
- import { AptlyInquiryParticipantRole, AptlyInquiryStatus, AptlyInquiryType } from '../enums/index.js';
2
- import { AptlySchemaFile } from '../core/index.js';
3
- import { AptlyBaseSchema } from './extends.js';
4
- import { AptlyProductSchema } from './product.js';
5
- import { AptlyUnitSchema } from './unit.js';
6
- import { AptlyOrganizationSchema } from './organization.js';
7
- import { AptlyProjectSchema } from './project.js';
8
- import { AptlyUserSchema } from './user.js';
9
- export type AptlyInquiry = AptlyInquirySchema<string, string>;
10
- export interface AptlyInquirySchema<ID, DATE> extends Pick<AptlyBaseSchema<ID, DATE>, '_id' | 'archived'> {
11
- _type: AptlyInquiryType;
12
- title: string;
13
- project: ID | AptlyProjectSchema<ID, DATE>;
14
- organization: ID | AptlyOrganizationSchema<ID, DATE>;
15
- unit: ID | AptlyUnitSchema<ID, DATE>;
16
- product?: ID | AptlyProductSchema<ID, DATE>;
17
- variant?: ID;
18
- producer?: ID;
19
- category?: ID;
20
- section?: ID;
21
- lastMessageSent: DATE;
22
- lastMessage: string;
23
- lastParticipant?: ID | AptlyUserSchema<ID, DATE>;
24
- lastMessageID?: string;
25
- lastMessageEmail?: string;
26
- status: AptlyInquiryStatus;
27
- caseNumber?: string;
28
- participants: AptlyInquiryParticipantSchema<ID, DATE>[];
29
- messages: AptlyInquiryMessageSchema<ID, DATE>[];
30
- references?: string;
31
- readAdmin?: boolean;
32
- readUnit?: boolean;
33
- }
34
- export type AptlyInquiryParticipant = AptlyInquiryParticipantSchema<string, string>;
35
- export interface AptlyInquiryParticipantSchema<ID, DATE> {
36
- _id: ID;
37
- user?: ID | AptlyUserSchema<ID, DATE>;
38
- email?: string;
39
- role: AptlyInquiryParticipantRole;
40
- readAll: boolean;
41
- }
42
- export type AptlyInquiryMessage = AptlyInquiryMessageSchema<string, string>;
43
- export interface AptlyInquiryMessageSchema<ID, DATE> {
44
- _id: ID;
45
- message: string;
46
- bodyHtml?: string;
47
- images?: string[];
48
- files: AptlySchemaFile<ID>[];
49
- author?: ID | AptlyUserSchema<ID, DATE>;
50
- email?: string;
51
- sentTime: DATE;
52
- read: {
53
- user: ID;
54
- readTime: DATE;
55
- }[];
56
- messageId?: string;
57
- }
1
+ import { AptlyInquiryParticipantRole, AptlyInquiryStatus, AptlyInquiryType } from '../enums/index.js';
2
+ import { AptlySchemaFile } from '../core/index.js';
3
+ import { AptlyBaseSchema } from './extends.js';
4
+ import { AptlyProductSchema } from './product.js';
5
+ import { AptlyUnitSchema } from './unit.js';
6
+ import { AptlyOrganizationSchema } from './organization.js';
7
+ import { AptlyProjectSchema } from './project.js';
8
+ import { AptlyUserSchema } from './user.js';
9
+ export type AptlyInquiry = AptlyInquirySchema<string, string>;
10
+ export interface AptlyInquirySchema<ID, DATE> extends Pick<AptlyBaseSchema<ID, DATE>, '_id' | 'archived'> {
11
+ _type: AptlyInquiryType;
12
+ title: string;
13
+ project: ID | AptlyProjectSchema<ID, DATE>;
14
+ organization: ID | AptlyOrganizationSchema<ID, DATE>;
15
+ unit: ID | AptlyUnitSchema<ID, DATE>;
16
+ product?: ID | AptlyProductSchema<ID, DATE>;
17
+ variant?: ID;
18
+ producer?: ID;
19
+ category?: ID;
20
+ section?: ID;
21
+ lastMessageSent: DATE;
22
+ lastMessage: string;
23
+ lastParticipant?: ID | AptlyUserSchema<ID, DATE>;
24
+ lastMessageID?: string;
25
+ lastMessageEmail?: string;
26
+ status: AptlyInquiryStatus;
27
+ caseNumber?: string;
28
+ participants: AptlyInquiryParticipantSchema<ID, DATE>[];
29
+ messages: AptlyInquiryMessageSchema<ID, DATE>[];
30
+ references?: string;
31
+ readAdmin?: boolean;
32
+ readUnit?: boolean;
33
+ }
34
+ export type AptlyInquiryParticipant = AptlyInquiryParticipantSchema<string, string>;
35
+ export interface AptlyInquiryParticipantSchema<ID, DATE> {
36
+ _id: ID;
37
+ user?: ID | AptlyUserSchema<ID, DATE>;
38
+ email?: string;
39
+ role: AptlyInquiryParticipantRole;
40
+ readAll: boolean;
41
+ }
42
+ export type AptlyInquiryMessage = AptlyInquiryMessageSchema<string, string>;
43
+ export interface AptlyInquiryMessageSchema<ID, DATE> {
44
+ _id: ID;
45
+ message: string;
46
+ bodyHtml?: string;
47
+ images?: string[];
48
+ files: AptlySchemaFile<ID>[];
49
+ author?: ID | AptlyUserSchema<ID, DATE>;
50
+ email?: string;
51
+ sentTime: DATE;
52
+ read: {
53
+ user: ID;
54
+ readTime: DATE;
55
+ }[];
56
+ messageId?: string;
57
+ }
package/models/inquiry.js CHANGED
@@ -1 +1 @@
1
- export {};
1
+ export {};
package/models/media.d.ts CHANGED
@@ -1,50 +1,50 @@
1
- import { AptlyOrganizationSchema } from './organization.js';
2
- import { AptlyBaseSchema } from './extends.js';
3
- export interface AptlyMediaSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
4
- organization: ID | AptlyOrganizationSchema<ID, DATE>;
5
- src: string;
6
- alt: string;
7
- caption?: string;
8
- title?: string;
9
- mime: string;
10
- tags: string[];
11
- width: number;
12
- height: number;
13
- albums: string[];
14
- public_id: string;
15
- asset_id: string;
16
- version: number;
17
- version_id: string;
18
- signature: string;
19
- format: string;
20
- resource_type: string;
21
- created_at: string;
22
- bytes: number;
23
- type: string;
24
- etag: string;
25
- placeholder: boolean;
26
- url: string;
27
- original_filename: string;
28
- created: DATE;
29
- updated: DATE;
30
- srcUrl?: string;
31
- uploadSignature?: string;
32
- }
33
- export interface AptlyMediaSrcArea {
34
- width: number;
35
- height: number;
36
- x: number;
37
- y: number;
38
- }
39
- export interface AptlyMediaSrcLocation {
40
- x: number;
41
- y: number;
42
- }
43
- export interface AptlyMediaSrcSchema<ID, DATE> extends Pick<AptlyMediaSchema<ID, DATE>, AptlyMediaSrcKeys> {
44
- area?: AptlyMediaSrcArea;
45
- location?: AptlyMediaSrcLocation;
46
- image?: string;
47
- }
48
- export type AptlyMediaSrcKeys = '_id' | 'name' | 'src' | 'url' | 'alt' | 'title' | 'caption' | 'mime' | 'width' | 'height';
49
- export type AptlyMediaSrc = AptlyMediaSrcSchema<string, string>;
50
- export type AptlyMedia = AptlyMediaSchema<string, string>;
1
+ import { AptlyOrganizationSchema } from './organization.js';
2
+ import { AptlyBaseSchema } from './extends.js';
3
+ export interface AptlyMediaSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
4
+ organization: ID | AptlyOrganizationSchema<ID, DATE>;
5
+ src: string;
6
+ alt: string;
7
+ caption?: string;
8
+ title?: string;
9
+ mime: string;
10
+ tags: string[];
11
+ width: number;
12
+ height: number;
13
+ albums: string[];
14
+ public_id: string;
15
+ asset_id: string;
16
+ version: number;
17
+ version_id: string;
18
+ signature: string;
19
+ format: string;
20
+ resource_type: string;
21
+ created_at: string;
22
+ bytes: number;
23
+ type: string;
24
+ etag: string;
25
+ placeholder: boolean;
26
+ url: string;
27
+ original_filename: string;
28
+ created: DATE;
29
+ updated: DATE;
30
+ srcUrl?: string;
31
+ uploadSignature?: string;
32
+ }
33
+ export interface AptlyMediaSrcArea {
34
+ width: number;
35
+ height: number;
36
+ x: number;
37
+ y: number;
38
+ }
39
+ export interface AptlyMediaSrcLocation {
40
+ x: number;
41
+ y: number;
42
+ }
43
+ export interface AptlyMediaSrcSchema<ID, DATE> extends Pick<AptlyMediaSchema<ID, DATE>, AptlyMediaSrcKeys> {
44
+ area?: AptlyMediaSrcArea;
45
+ location?: AptlyMediaSrcLocation;
46
+ image?: string;
47
+ }
48
+ export type AptlyMediaSrcKeys = '_id' | 'name' | 'src' | 'url' | 'alt' | 'title' | 'caption' | 'mime' | 'width' | 'height';
49
+ export type AptlyMediaSrc = AptlyMediaSrcSchema<string, string>;
50
+ export type AptlyMedia = AptlyMediaSchema<string, string>;
package/models/media.js CHANGED
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,19 +1,19 @@
1
- import { AptlyModules } from '../core/index.js';
2
- export type AptlyModule = AptlyModuleSchema<string, string>;
3
- export interface AptlyModuleSchema<ID, DATE> {
4
- _id: ID;
5
- name: string;
6
- description: string;
7
- featuredWeight: number;
8
- cost?: number;
9
- modules: AptlyModules[];
10
- createdAt: DATE;
11
- updatedAt: DATE;
12
- }
13
- export type AptlyModuleItem = AptlyModuleItemSchema<string, string>;
14
- export interface AptlyModuleItemSchema<ID, DATE> {
15
- _id: ID;
16
- module: ID | AptlyModuleSchema<ID, DATE>;
17
- modules: AptlyModules[];
18
- installedAt: DATE;
19
- }
1
+ import { AptlyModules } from '../core/index.js';
2
+ export type AptlyModule = AptlyModuleSchema<string, string>;
3
+ export interface AptlyModuleSchema<ID, DATE> {
4
+ _id: ID;
5
+ name: string;
6
+ description: string;
7
+ featuredWeight: number;
8
+ cost?: number;
9
+ modules: AptlyModules[];
10
+ createdAt: DATE;
11
+ updatedAt: DATE;
12
+ }
13
+ export type AptlyModuleItem = AptlyModuleItemSchema<string, string>;
14
+ export interface AptlyModuleItemSchema<ID, DATE> {
15
+ _id: ID;
16
+ module: ID | AptlyModuleSchema<ID, DATE>;
17
+ modules: AptlyModules[];
18
+ installedAt: DATE;
19
+ }
package/models/module.js CHANGED
@@ -1 +1 @@
1
- export {};
1
+ export {};
package/models/note.d.ts CHANGED
@@ -1,19 +1,19 @@
1
- import { AptlyBaseSchema } from './extends.js';
2
- import { AptlyOrganizationSchema } from './organization.js';
3
- import { AptlyProjectSchema } from './project.js';
4
- import { AptlyUnitSchema } from './unit.js';
5
- import { AptlyUserSchema } from './user.js';
6
- export type AptlyNote = AptlyNoteSchema<string, string>;
7
- export interface AptlyNoteSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
8
- content: string;
9
- organization: ID | AptlyOrganizationSchema<ID, DATE>;
10
- project: ID | AptlyProjectSchema<ID, DATE>;
11
- unit: ID | AptlyUnitSchema<ID, DATE>;
12
- users: (ID | AptlyUserSchema<ID, DATE>)[];
13
- addToReceipt: boolean;
14
- unitTemplateCategory: ID | null;
15
- unitTemplateProduct?: ID | null;
16
- reminderDate?: DATE | null;
17
- hasReminder?: boolean;
18
- author?: ID | AptlyUserSchema<ID, DATE>;
19
- }
1
+ import { AptlyBaseSchema } from './extends.js';
2
+ import { AptlyOrganizationSchema } from './organization.js';
3
+ import { AptlyProjectSchema } from './project.js';
4
+ import { AptlyUnitSchema } from './unit.js';
5
+ import { AptlyUserSchema } from './user.js';
6
+ export type AptlyNote = AptlyNoteSchema<string, string>;
7
+ export interface AptlyNoteSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
8
+ content: string;
9
+ organization: ID | AptlyOrganizationSchema<ID, DATE>;
10
+ project: ID | AptlyProjectSchema<ID, DATE>;
11
+ unit: ID | AptlyUnitSchema<ID, DATE>;
12
+ users: (ID | AptlyUserSchema<ID, DATE>)[];
13
+ addToReceipt: boolean;
14
+ unitTemplateCategory: ID | null;
15
+ unitTemplateProduct?: ID | null;
16
+ reminderDate?: DATE | null;
17
+ hasReminder?: boolean;
18
+ author?: ID | AptlyUserSchema<ID, DATE>;
19
+ }
package/models/note.js CHANGED
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,9 +1,9 @@
1
- export type AptlyNotificationTrigger = AptlyNotificationTriggerSchema<string, string>;
2
- export interface AptlyNotificationTriggerSchema<ID, DATE> {
3
- _id: ID;
4
- _type: string;
5
- period: ID;
6
- time: DATE;
7
- sent: boolean;
8
- sentTime: DATE;
9
- }
1
+ export type AptlyNotificationTrigger = AptlyNotificationTriggerSchema<string, string>;
2
+ export interface AptlyNotificationTriggerSchema<ID, DATE> {
3
+ _id: ID;
4
+ _type: string;
5
+ period: ID;
6
+ time: DATE;
7
+ sent: boolean;
8
+ sentTime: DATE;
9
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,7 +1,7 @@
1
- import { AptlyBaseSchema } from './extends.js';
2
- export type AptlyOptionLabel = AptlyOptionLabelSchema<string, string>;
3
- export interface AptlyOptionLabelSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
4
- organization?: ID;
5
- project?: ID;
6
- created: DATE;
7
- }
1
+ import { AptlyBaseSchema } from './extends.js';
2
+ export type AptlyOptionLabel = AptlyOptionLabelSchema<string, string>;
3
+ export interface AptlyOptionLabelSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
4
+ organization?: ID;
5
+ project?: ID;
6
+ created: DATE;
7
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};