@unofficialbox/box-open-sdk 0.4.0 → 0.4.1
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.
- package/dist/cjs/models/schemas/ai.js +3 -0
- package/dist/cjs/models/schemas/ai_studio.js +3 -0
- package/dist/cjs/models/schemas/app_item_associations.js +3 -0
- package/dist/cjs/models/schemas/archives.js +3 -0
- package/dist/cjs/models/schemas/authorization.js +3 -0
- package/dist/cjs/models/schemas/automate_workflows.js +3 -0
- package/dist/cjs/models/schemas/avatars.js +3 -0
- package/dist/cjs/models/schemas/chunked_uploads.js +3 -0
- package/dist/cjs/models/schemas/classifications.js +3 -0
- package/dist/cjs/models/schemas/collaboration_allowlist_entries.js +3 -0
- package/dist/cjs/models/schemas/collaboration_allowlist_exempt_targets.js +3 -0
- package/dist/cjs/models/schemas/collections.js +3 -0
- package/dist/cjs/models/schemas/comments.js +3 -0
- package/dist/cjs/models/schemas/device_pinners.js +3 -0
- package/dist/cjs/models/schemas/docgen.js +3 -0
- package/dist/cjs/models/schemas/docgen_template.js +3 -0
- package/dist/cjs/models/schemas/email_aliases.js +3 -0
- package/dist/cjs/models/schemas/enterprise_configurations.js +3 -0
- package/dist/cjs/models/schemas/events.js +3 -0
- package/dist/cjs/models/schemas/external_users.js +3 -0
- package/dist/cjs/models/schemas/file_requests.js +3 -0
- package/dist/cjs/models/schemas/file_version_legal_holds.js +3 -0
- package/dist/cjs/models/schemas/file_version_retentions.js +3 -0
- package/dist/cjs/models/schemas/file_versions.js +3 -0
- package/dist/cjs/models/schemas/files.js +3 -0
- package/dist/cjs/models/schemas/folder_locks.js +3 -0
- package/dist/cjs/models/schemas/folders.js +3 -0
- package/dist/cjs/models/schemas/groups.js +3 -0
- package/dist/cjs/models/schemas/hub_collaborations.js +3 -0
- package/dist/cjs/models/schemas/hub_document.js +3 -0
- package/dist/cjs/models/schemas/hub_items.js +3 -0
- package/dist/cjs/models/schemas/hubs.js +3 -0
- package/dist/cjs/models/schemas/integration_mappings.js +3 -0
- package/dist/cjs/models/schemas/invites.js +3 -0
- package/dist/cjs/models/schemas/legal_hold_policies.js +3 -0
- package/dist/cjs/models/schemas/legal_hold_policy_assignments.js +3 -0
- package/dist/cjs/models/schemas/list_collaborations.js +3 -0
- package/dist/cjs/models/schemas/memberships.js +3 -0
- package/dist/cjs/models/schemas/metadata_cascade_policies.js +3 -0
- package/dist/cjs/models/schemas/metadata_taxonomies.js +3 -0
- package/dist/cjs/models/schemas/metadata_templates.js +3 -0
- package/dist/cjs/models/schemas/notes.js +3 -0
- package/dist/cjs/models/schemas/query.js +3 -0
- package/dist/cjs/models/schemas/recent_items.js +3 -0
- package/dist/cjs/models/schemas/retention_policies.js +3 -0
- package/dist/cjs/models/schemas/retention_policy_assignments.js +3 -0
- package/dist/cjs/models/schemas/search.js +3 -0
- package/dist/cjs/models/schemas/session_termination.js +3 -0
- package/dist/cjs/models/schemas/shared_links_folders.js +3 -0
- package/dist/cjs/models/schemas/shield_information_barrier_reports.js +3 -0
- package/dist/cjs/models/schemas/shield_information_barrier_segment_members.js +3 -0
- package/dist/cjs/models/schemas/shield_information_barrier_segment_restrictions.js +3 -0
- package/dist/cjs/models/schemas/shield_information_barrier_segments.js +3 -0
- package/dist/cjs/models/schemas/shield_information_barriers.js +3 -0
- package/dist/cjs/models/schemas/shield_lists.js +3 -0
- package/dist/cjs/models/schemas/sign_requests.js +3 -0
- package/dist/cjs/models/schemas/sign_templates.js +3 -0
- package/dist/cjs/models/schemas/skills.js +3 -0
- package/dist/cjs/models/schemas/storage_policies.js +3 -0
- package/dist/cjs/models/schemas/storage_policy_assignments.js +3 -0
- package/dist/cjs/models/schemas/task_assignments.js +3 -0
- package/dist/cjs/models/schemas/tasks.js +3 -0
- package/dist/cjs/models/schemas/terms_of_service_user_statuses.js +3 -0
- package/dist/cjs/models/schemas/terms_of_services.js +3 -0
- package/dist/cjs/models/schemas/transfer.js +3 -0
- package/dist/cjs/models/schemas/trashed_files.js +3 -0
- package/dist/cjs/models/schemas/trashed_folders.js +3 -0
- package/dist/cjs/models/schemas/trashed_items.js +3 -0
- package/dist/cjs/models/schemas/trashed_web_links.js +3 -0
- package/dist/cjs/models/schemas/uploads.js +3 -0
- package/dist/cjs/models/schemas/user_collaborations.js +3 -0
- package/dist/cjs/models/schemas/users.js +3 -0
- package/dist/cjs/models/schemas/web_links.js +3 -0
- package/dist/cjs/models/schemas/webhooks.js +3 -0
- package/dist/cjs/models/schemas/workflows.js +3 -0
- package/dist/cjs/models/schemas/zip_downloads.js +3 -0
- package/dist/cjs/models/schemas.js +90 -0
- package/dist/esm/models/schemas/ai.js +2 -0
- package/dist/esm/models/schemas/ai_studio.js +2 -0
- package/dist/esm/models/schemas/app_item_associations.js +2 -0
- package/dist/esm/models/schemas/archives.js +2 -0
- package/dist/esm/models/schemas/authorization.js +2 -0
- package/dist/esm/models/schemas/automate_workflows.js +2 -0
- package/dist/esm/models/schemas/avatars.js +2 -0
- package/dist/esm/models/schemas/chunked_uploads.js +2 -0
- package/dist/esm/models/schemas/classifications.js +2 -0
- package/dist/esm/models/schemas/collaboration_allowlist_entries.js +2 -0
- package/dist/esm/models/schemas/collaboration_allowlist_exempt_targets.js +2 -0
- package/dist/esm/models/schemas/collections.js +2 -0
- package/dist/esm/models/schemas/comments.js +2 -0
- package/dist/esm/models/schemas/device_pinners.js +2 -0
- package/dist/esm/models/schemas/docgen.js +2 -0
- package/dist/esm/models/schemas/docgen_template.js +2 -0
- package/dist/esm/models/schemas/email_aliases.js +2 -0
- package/dist/esm/models/schemas/enterprise_configurations.js +2 -0
- package/dist/esm/models/schemas/events.js +2 -0
- package/dist/esm/models/schemas/external_users.js +2 -0
- package/dist/esm/models/schemas/file_requests.js +2 -0
- package/dist/esm/models/schemas/file_version_legal_holds.js +2 -0
- package/dist/esm/models/schemas/file_version_retentions.js +2 -0
- package/dist/esm/models/schemas/file_versions.js +2 -0
- package/dist/esm/models/schemas/files.js +2 -0
- package/dist/esm/models/schemas/folder_locks.js +2 -0
- package/dist/esm/models/schemas/folders.js +2 -0
- package/dist/esm/models/schemas/groups.js +2 -0
- package/dist/esm/models/schemas/hub_collaborations.js +2 -0
- package/dist/esm/models/schemas/hub_document.js +2 -0
- package/dist/esm/models/schemas/hub_items.js +2 -0
- package/dist/esm/models/schemas/hubs.js +2 -0
- package/dist/esm/models/schemas/integration_mappings.js +2 -0
- package/dist/esm/models/schemas/invites.js +2 -0
- package/dist/esm/models/schemas/legal_hold_policies.js +2 -0
- package/dist/esm/models/schemas/legal_hold_policy_assignments.js +2 -0
- package/dist/esm/models/schemas/list_collaborations.js +2 -0
- package/dist/esm/models/schemas/memberships.js +2 -0
- package/dist/esm/models/schemas/metadata_cascade_policies.js +2 -0
- package/dist/esm/models/schemas/metadata_taxonomies.js +2 -0
- package/dist/esm/models/schemas/metadata_templates.js +2 -0
- package/dist/esm/models/schemas/notes.js +2 -0
- package/dist/esm/models/schemas/query.js +2 -0
- package/dist/esm/models/schemas/recent_items.js +2 -0
- package/dist/esm/models/schemas/retention_policies.js +2 -0
- package/dist/esm/models/schemas/retention_policy_assignments.js +2 -0
- package/dist/esm/models/schemas/search.js +2 -0
- package/dist/esm/models/schemas/session_termination.js +2 -0
- package/dist/esm/models/schemas/shared_links_folders.js +2 -0
- package/dist/esm/models/schemas/shield_information_barrier_reports.js +2 -0
- package/dist/esm/models/schemas/shield_information_barrier_segment_members.js +2 -0
- package/dist/esm/models/schemas/shield_information_barrier_segment_restrictions.js +2 -0
- package/dist/esm/models/schemas/shield_information_barrier_segments.js +2 -0
- package/dist/esm/models/schemas/shield_information_barriers.js +2 -0
- package/dist/esm/models/schemas/shield_lists.js +2 -0
- package/dist/esm/models/schemas/sign_requests.js +2 -0
- package/dist/esm/models/schemas/sign_templates.js +2 -0
- package/dist/esm/models/schemas/skills.js +2 -0
- package/dist/esm/models/schemas/storage_policies.js +2 -0
- package/dist/esm/models/schemas/storage_policy_assignments.js +2 -0
- package/dist/esm/models/schemas/task_assignments.js +2 -0
- package/dist/esm/models/schemas/tasks.js +2 -0
- package/dist/esm/models/schemas/terms_of_service_user_statuses.js +2 -0
- package/dist/esm/models/schemas/terms_of_services.js +2 -0
- package/dist/esm/models/schemas/transfer.js +2 -0
- package/dist/esm/models/schemas/trashed_files.js +2 -0
- package/dist/esm/models/schemas/trashed_folders.js +2 -0
- package/dist/esm/models/schemas/trashed_items.js +2 -0
- package/dist/esm/models/schemas/trashed_web_links.js +2 -0
- package/dist/esm/models/schemas/uploads.js +2 -0
- package/dist/esm/models/schemas/user_collaborations.js +2 -0
- package/dist/esm/models/schemas/users.js +2 -0
- package/dist/esm/models/schemas/web_links.js +2 -0
- package/dist/esm/models/schemas/webhooks.js +2 -0
- package/dist/esm/models/schemas/workflows.js +2 -0
- package/dist/esm/models/schemas/zip_downloads.js +2 -0
- package/dist/esm/models/schemas.js +76 -1
- package/dist/types/models/schemas/ai.d.ts +240 -0
- package/dist/types/models/schemas/ai_studio.d.ts +172 -0
- package/dist/types/models/schemas/app_item_associations.d.ts +34 -0
- package/dist/types/models/schemas/archives.d.ts +27 -0
- package/dist/types/models/schemas/authorization.d.ts +43 -0
- package/dist/types/models/schemas/automate_workflows.d.ts +29 -0
- package/dist/types/models/schemas/avatars.d.ts +11 -0
- package/dist/types/models/schemas/chunked_uploads.d.ts +47 -0
- package/dist/types/models/schemas/classifications.d.ts +66 -0
- package/dist/types/models/schemas/collaboration_allowlist_entries.d.ts +21 -0
- package/dist/types/models/schemas/collaboration_allowlist_exempt_targets.d.ts +19 -0
- package/dist/types/models/schemas/collections.d.ts +15 -0
- package/dist/types/models/schemas/comments.d.ts +33 -0
- package/dist/types/models/schemas/device_pinners.d.ts +20 -0
- package/dist/types/models/schemas/docgen.d.ts +40 -0
- package/dist/types/models/schemas/docgen_template.d.ts +29 -0
- package/dist/types/models/schemas/email_aliases.d.ts +14 -0
- package/dist/types/models/schemas/enterprise_configurations.d.ts +251 -0
- package/dist/types/models/schemas/events.d.ts +71 -0
- package/dist/types/models/schemas/external_users.d.ts +16 -0
- package/dist/types/models/schemas/file_requests.d.ts +41 -0
- package/dist/types/models/schemas/file_version_legal_holds.d.ts +16 -0
- package/dist/types/models/schemas/file_version_retentions.d.ts +17 -0
- package/dist/types/models/schemas/file_versions.d.ts +32 -0
- package/dist/types/models/schemas/files.d.ts +27 -0
- package/dist/types/models/schemas/folder_locks.d.ts +27 -0
- package/dist/types/models/schemas/folders.d.ts +28 -0
- package/dist/types/models/schemas/groups.d.ts +42 -0
- package/dist/types/models/schemas/hub_collaborations.d.ts +57 -0
- package/dist/types/models/schemas/hub_document.d.ts +67 -0
- package/dist/types/models/schemas/hub_items.d.ts +46 -0
- package/dist/types/models/schemas/hubs.d.ts +43 -0
- package/dist/types/models/schemas/integration_mappings.d.ts +83 -0
- package/dist/types/models/schemas/invites.d.ts +19 -0
- package/dist/types/models/schemas/legal_hold_policies.d.ts +43 -0
- package/dist/types/models/schemas/legal_hold_policy_assignments.d.ts +43 -0
- package/dist/types/models/schemas/list_collaborations.d.ts +14 -0
- package/dist/types/models/schemas/memberships.d.ts +29 -0
- package/dist/types/models/schemas/metadata_cascade_policies.d.ts +29 -0
- package/dist/types/models/schemas/metadata_taxonomies.d.ts +60 -0
- package/dist/types/models/schemas/metadata_templates.d.ts +71 -0
- package/dist/types/models/schemas/notes.d.ts +13 -0
- package/dist/types/models/schemas/query.d.ts +62 -0
- package/dist/types/models/schemas/recent_items.d.ts +25 -0
- package/dist/types/models/schemas/retention_policies.d.ts +60 -0
- package/dist/types/models/schemas/retention_policy_assignments.d.ts +47 -0
- package/dist/types/models/schemas/search.d.ts +98 -0
- package/dist/types/models/schemas/session_termination.d.ts +10 -0
- package/dist/types/models/schemas/shared_links_folders.d.ts +11 -0
- package/dist/types/models/schemas/shield_information_barrier_reports.d.ts +27 -0
- package/dist/types/models/schemas/shield_information_barrier_segment_members.d.ts +24 -0
- package/dist/types/models/schemas/shield_information_barrier_segment_restrictions.d.ts +24 -0
- package/dist/types/models/schemas/shield_information_barrier_segments.d.ts +26 -0
- package/dist/types/models/schemas/shield_information_barriers.d.ts +31 -0
- package/dist/types/models/schemas/shield_lists.d.ts +88 -0
- package/dist/types/models/schemas/sign_requests.d.ts +136 -0
- package/dist/types/models/schemas/sign_templates.d.ts +90 -0
- package/dist/types/models/schemas/skills.d.ts +120 -0
- package/dist/types/models/schemas/storage_policies.d.ts +12 -0
- package/dist/types/models/schemas/storage_policy_assignments.d.ts +34 -0
- package/dist/types/models/schemas/task_assignments.d.ts +17 -0
- package/dist/types/models/schemas/tasks.d.ts +37 -0
- package/dist/types/models/schemas/terms_of_service_user_statuses.d.ts +27 -0
- package/dist/types/models/schemas/terms_of_services.d.ts +27 -0
- package/dist/types/models/schemas/transfer.d.ts +4 -0
- package/dist/types/models/schemas/trashed_files.d.ts +49 -0
- package/dist/types/models/schemas/trashed_folders.d.ts +47 -0
- package/dist/types/models/schemas/trashed_items.d.ts +1 -0
- package/dist/types/models/schemas/trashed_web_links.d.ts +41 -0
- package/dist/types/models/schemas/uploads.d.ts +28 -0
- package/dist/types/models/schemas/user_collaborations.d.ts +26 -0
- package/dist/types/models/schemas/users.d.ts +98 -0
- package/dist/types/models/schemas/web_links.d.ts +20 -0
- package/dist/types/models/schemas/webhooks.d.ts +37 -0
- package/dist/types/models/schemas/workflows.d.ts +93 -0
- package/dist/types/models/schemas/zip_downloads.d.ts +29 -0
- package/dist/types/models/schemas.d.ts +136 -3535
- package/package.json +1 -1
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import type { RetentionPolicyDispositionAction, RetentionPolicyMaxExtensionLengthResponse, RetentionPolicyType, UserBase, UserMini } from '../schemas.js';
|
|
2
|
+
export interface RetentionPolicies {
|
|
3
|
+
entries?: Array<RetentionPolicy>;
|
|
4
|
+
limit?: number;
|
|
5
|
+
next_marker?: string | null;
|
|
6
|
+
}
|
|
7
|
+
export interface RetentionPolicy {
|
|
8
|
+
id: string;
|
|
9
|
+
type: RetentionPolicyType;
|
|
10
|
+
policy_name?: string;
|
|
11
|
+
retention_length?: string;
|
|
12
|
+
disposition_action?: RetentionPolicyDispositionAction;
|
|
13
|
+
max_extension_length?: RetentionPolicyMaxExtensionLengthResponse;
|
|
14
|
+
description?: string;
|
|
15
|
+
policy_type?: RetentionPolicyPolicyType;
|
|
16
|
+
retention_type?: RetentionPolicyRetentionType;
|
|
17
|
+
status?: RetentionPolicyStatus;
|
|
18
|
+
created_by?: UserMini;
|
|
19
|
+
created_at?: string;
|
|
20
|
+
modified_at?: string;
|
|
21
|
+
can_owner_extend_retention?: boolean;
|
|
22
|
+
are_owners_notified?: boolean;
|
|
23
|
+
custom_notification_recipients?: Array<UserMini>;
|
|
24
|
+
assignment_counts?: RetentionPolicyAssignmentCounts;
|
|
25
|
+
}
|
|
26
|
+
export type RetentionPolicyMaxExtensionLengthRequest = unknown;
|
|
27
|
+
export type RetentionPolicyPolicyType = "finite" | "indefinite" | (string & {});
|
|
28
|
+
export type RetentionPolicyRetentionType = "modifiable" | "non_modifiable" | (string & {});
|
|
29
|
+
export type RetentionPolicyStatus = "active" | "retired" | (string & {});
|
|
30
|
+
export interface RetentionPolicyAssignmentCounts {
|
|
31
|
+
enterprise?: number;
|
|
32
|
+
folder?: number;
|
|
33
|
+
metadata_template?: number;
|
|
34
|
+
}
|
|
35
|
+
export type PostRetentionLength = unknown;
|
|
36
|
+
export interface CreateRetentionPolicyRequest {
|
|
37
|
+
policy_name: string;
|
|
38
|
+
description?: string;
|
|
39
|
+
policy_type: RetentionPolicyPolicyType;
|
|
40
|
+
disposition_action: RetentionPolicyDispositionAction;
|
|
41
|
+
retention_length?: PostRetentionLength;
|
|
42
|
+
retention_type?: RetentionPolicyRetentionType;
|
|
43
|
+
can_owner_extend_retention?: boolean;
|
|
44
|
+
max_extension_length?: RetentionPolicyMaxExtensionLengthRequest;
|
|
45
|
+
are_owners_notified?: boolean;
|
|
46
|
+
custom_notification_recipients?: Array<UserMini>;
|
|
47
|
+
}
|
|
48
|
+
export type PutIdDispositionAction = unknown;
|
|
49
|
+
export interface UpdateRetentionPolicyRequest {
|
|
50
|
+
policy_name?: string | null;
|
|
51
|
+
description?: string | null;
|
|
52
|
+
disposition_action?: PutIdDispositionAction;
|
|
53
|
+
retention_type?: string | null;
|
|
54
|
+
retention_length?: PostRetentionLength;
|
|
55
|
+
status?: string | null;
|
|
56
|
+
can_owner_extend_retention?: boolean | null;
|
|
57
|
+
max_extension_length?: RetentionPolicyMaxExtensionLengthRequest;
|
|
58
|
+
are_owners_notified?: boolean | null;
|
|
59
|
+
custom_notification_recipients?: Array<UserBase> | null;
|
|
60
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import type { FileMini, RetentionPolicyMini, UserMini } from '../schemas.js';
|
|
2
|
+
export interface FilesUnderRetention {
|
|
3
|
+
limit?: number;
|
|
4
|
+
next_marker?: string | null;
|
|
5
|
+
prev_marker?: string | null;
|
|
6
|
+
entries?: Array<FileMini>;
|
|
7
|
+
}
|
|
8
|
+
export interface RetentionPolicyAssignment {
|
|
9
|
+
id: string;
|
|
10
|
+
type: RetentionPolicyAssignmentType;
|
|
11
|
+
retention_policy?: RetentionPolicyMini;
|
|
12
|
+
assigned_to?: RetentionPolicyAssignmentAssignedTo;
|
|
13
|
+
filter_fields?: Array<RetentionPolicyAssignmentFilterFields> | null;
|
|
14
|
+
assigned_by?: UserMini;
|
|
15
|
+
assigned_at?: string;
|
|
16
|
+
start_date_field?: string;
|
|
17
|
+
}
|
|
18
|
+
export interface RetentionPolicyAssignments {
|
|
19
|
+
entries?: Array<RetentionPolicyAssignment>;
|
|
20
|
+
limit?: number;
|
|
21
|
+
next_marker?: string | null;
|
|
22
|
+
}
|
|
23
|
+
export type RetentionPolicyAssignmentType = "retention_policy_assignment" | (string & {});
|
|
24
|
+
export type AssignedToType = "folder" | "enterprise" | "metadata_template" | (string & {});
|
|
25
|
+
export interface RetentionPolicyAssignmentAssignedTo {
|
|
26
|
+
id?: string | null;
|
|
27
|
+
type?: AssignedToType;
|
|
28
|
+
}
|
|
29
|
+
export interface RetentionPolicyAssignmentFilterFields {
|
|
30
|
+
field?: string | null;
|
|
31
|
+
value?: string | null;
|
|
32
|
+
}
|
|
33
|
+
export type AssignToType = "enterprise" | "folder" | "metadata_template" | (string & {});
|
|
34
|
+
export interface CreateRetentionPolicyAssignmentRequestAssignTo {
|
|
35
|
+
type: AssignToType;
|
|
36
|
+
id?: string | null;
|
|
37
|
+
}
|
|
38
|
+
export interface PostFilterFields {
|
|
39
|
+
field?: string;
|
|
40
|
+
value?: string;
|
|
41
|
+
}
|
|
42
|
+
export interface CreateRetentionPolicyAssignmentRequest {
|
|
43
|
+
policy_id: string;
|
|
44
|
+
assign_to: CreateRetentionPolicyAssignmentRequestAssignTo;
|
|
45
|
+
filter_fields?: Array<PostFilterFields>;
|
|
46
|
+
start_date_field?: string;
|
|
47
|
+
}
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import type { FileFull, FolderFull, WebLink } from '../schemas.js';
|
|
2
|
+
export interface MetadataFieldFilterDateRange {
|
|
3
|
+
lt?: string;
|
|
4
|
+
gt?: string;
|
|
5
|
+
}
|
|
6
|
+
export interface MetadataFieldFilterFloatRange {
|
|
7
|
+
lt?: number;
|
|
8
|
+
gt?: number;
|
|
9
|
+
}
|
|
10
|
+
export interface MetadataFilter {
|
|
11
|
+
scope?: MetadataFilterScope;
|
|
12
|
+
templateKey?: string;
|
|
13
|
+
filters?: Record<string, MetadataFilterValue>;
|
|
14
|
+
}
|
|
15
|
+
export type MetadataFilterValue = unknown;
|
|
16
|
+
export interface MetadataQuery {
|
|
17
|
+
from: string;
|
|
18
|
+
query?: string;
|
|
19
|
+
query_params?: Record<string, unknown>;
|
|
20
|
+
ancestor_folder_id: string;
|
|
21
|
+
order_by?: Array<MetadataQueryOrderBy>;
|
|
22
|
+
limit?: number;
|
|
23
|
+
marker?: string;
|
|
24
|
+
fields?: Array<string>;
|
|
25
|
+
}
|
|
26
|
+
export type MetadataQueryResultItem = (FileFull & {
|
|
27
|
+
type: "file";
|
|
28
|
+
}) | (FolderFull & {
|
|
29
|
+
type: "folder";
|
|
30
|
+
}) | {
|
|
31
|
+
type: string;
|
|
32
|
+
[key: string]: unknown;
|
|
33
|
+
};
|
|
34
|
+
export interface MetadataQueryResults {
|
|
35
|
+
entries?: Array<MetadataQueryResultItem>;
|
|
36
|
+
limit?: number;
|
|
37
|
+
next_marker?: string;
|
|
38
|
+
}
|
|
39
|
+
export type SearchResultItem = (FileFull & {
|
|
40
|
+
type: "file";
|
|
41
|
+
}) | (FolderFull & {
|
|
42
|
+
type: "folder";
|
|
43
|
+
}) | (WebLink & {
|
|
44
|
+
type: "web_link";
|
|
45
|
+
}) | {
|
|
46
|
+
type: string;
|
|
47
|
+
[key: string]: unknown;
|
|
48
|
+
};
|
|
49
|
+
export interface SearchResults {
|
|
50
|
+
total_count?: number;
|
|
51
|
+
limit?: number;
|
|
52
|
+
offset?: number;
|
|
53
|
+
type: SearchResultsType;
|
|
54
|
+
entries?: Array<SearchResultItem>;
|
|
55
|
+
}
|
|
56
|
+
export type SearchResultsResponse = (SearchResults & {
|
|
57
|
+
type: "search_results_items";
|
|
58
|
+
}) | (SearchResultsWithSharedLinks & {
|
|
59
|
+
type: "search_results_with_shared_links";
|
|
60
|
+
}) | {
|
|
61
|
+
type: string;
|
|
62
|
+
[key: string]: unknown;
|
|
63
|
+
};
|
|
64
|
+
export interface SearchResultsWithSharedLinks {
|
|
65
|
+
total_count?: number;
|
|
66
|
+
limit?: number;
|
|
67
|
+
offset?: number;
|
|
68
|
+
type: SearchResultsWithSharedLinksType;
|
|
69
|
+
entries?: Array<SearchResultWithSharedLink>;
|
|
70
|
+
}
|
|
71
|
+
export interface SearchResultWithSharedLink {
|
|
72
|
+
accessible_via_shared_link?: string;
|
|
73
|
+
item?: SearchResultWithSharedLinkItem;
|
|
74
|
+
type?: string;
|
|
75
|
+
}
|
|
76
|
+
export type SearchResultWithSharedLinkItem = (FileFull & {
|
|
77
|
+
type: "file";
|
|
78
|
+
}) | (FolderFull & {
|
|
79
|
+
type: "folder";
|
|
80
|
+
}) | (WebLink & {
|
|
81
|
+
type: "web_link";
|
|
82
|
+
}) | {
|
|
83
|
+
type: string;
|
|
84
|
+
[key: string]: unknown;
|
|
85
|
+
};
|
|
86
|
+
export type MetadataFilterScope = "global" | "enterprise" | "enterprise_{enterprise_id}" | (string & {});
|
|
87
|
+
export type OrderByDirection = "ASC" | "DESC" | "asc" | "desc" | (string & {});
|
|
88
|
+
export interface MetadataQueryOrderBy {
|
|
89
|
+
field_key?: string;
|
|
90
|
+
direction?: OrderByDirection;
|
|
91
|
+
}
|
|
92
|
+
export type SearchResultsType = "search_results_items" | (string & {});
|
|
93
|
+
export type SearchResultsWithSharedLinksType = "search_results_with_shared_links" | (string & {});
|
|
94
|
+
export type GetScope = "user_content" | "enterprise_content" | (string & {});
|
|
95
|
+
export type GetContentTypes = "name" | "description" | "file_content" | "comments" | "tags" | (string & {});
|
|
96
|
+
export type GetType = "file" | "folder" | "web_link" | (string & {});
|
|
97
|
+
export type GetTrashContent = "non_trashed_only" | "trashed_only" | "all_items" | (string & {});
|
|
98
|
+
export type GetSort = "modified_at" | "relevance" | (string & {});
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export interface SessionTerminationMessage {
|
|
2
|
+
message?: string;
|
|
3
|
+
}
|
|
4
|
+
export interface CreateUserTerminateSessionsRequest {
|
|
5
|
+
user_ids: Array<string>;
|
|
6
|
+
user_logins: Array<string>;
|
|
7
|
+
}
|
|
8
|
+
export interface CreateGroupTerminateSessionsRequest {
|
|
9
|
+
group_ids: Array<string>;
|
|
10
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { SharedLinkAccess, UpdateFileAddSharedLinkRequestSharedLinkPermissions } from '../schemas.js';
|
|
2
|
+
export interface PutFolderIdUpdateSharedLinkSharedLink {
|
|
3
|
+
access?: SharedLinkAccess;
|
|
4
|
+
password?: string;
|
|
5
|
+
vanity_name?: string;
|
|
6
|
+
unshared_at?: string;
|
|
7
|
+
permissions?: UpdateFileAddSharedLinkRequestSharedLinkPermissions;
|
|
8
|
+
}
|
|
9
|
+
export interface UpdateFolderUpdateSharedLinkRequest {
|
|
10
|
+
shared_link?: PutFolderIdUpdateSharedLinkSharedLink;
|
|
11
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { ShieldInformationBarrierBase, UserBase } from '../schemas.js';
|
|
2
|
+
export interface ShieldInformationBarrierReference {
|
|
3
|
+
shield_information_barrier?: ShieldInformationBarrierBase;
|
|
4
|
+
}
|
|
5
|
+
export interface ShieldInformationBarrierReport {
|
|
6
|
+
id?: string;
|
|
7
|
+
type?: ShieldInformationBarrierReportType;
|
|
8
|
+
shield_information_barrier?: ShieldInformationBarrierReference;
|
|
9
|
+
status?: ShieldInformationBarrierReportStatus;
|
|
10
|
+
details?: ShieldInformationBarrierReportDetails;
|
|
11
|
+
created_at?: string;
|
|
12
|
+
created_by?: UserBase;
|
|
13
|
+
updated_at?: string;
|
|
14
|
+
}
|
|
15
|
+
export interface ShieldInformationBarrierReportDetails {
|
|
16
|
+
details?: ShieldInformationBarrierReportDetailsDetails;
|
|
17
|
+
}
|
|
18
|
+
export interface ShieldInformationBarrierReports {
|
|
19
|
+
limit?: number;
|
|
20
|
+
next_marker?: string | null;
|
|
21
|
+
entries?: Array<ShieldInformationBarrierReport>;
|
|
22
|
+
}
|
|
23
|
+
export type ShieldInformationBarrierReportType = "shield_information_barrier_report" | (string & {});
|
|
24
|
+
export type ShieldInformationBarrierReportStatus = "pending" | "error" | "done" | "cancelled" | (string & {});
|
|
25
|
+
export interface ShieldInformationBarrierReportDetailsDetails {
|
|
26
|
+
folder_id?: string;
|
|
27
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { ShieldInformationBarrierBase, ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment, UserBase } from '../schemas.js';
|
|
2
|
+
export interface ShieldInformationBarrierSegmentMember {
|
|
3
|
+
id?: string;
|
|
4
|
+
type?: ShieldInformationBarrierSegmentMemberType;
|
|
5
|
+
user?: UserBase;
|
|
6
|
+
shield_information_barrier?: ShieldInformationBarrierBase;
|
|
7
|
+
shield_information_barrier_segment?: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
|
|
8
|
+
created_at?: string;
|
|
9
|
+
created_by?: UserBase;
|
|
10
|
+
updated_at?: string;
|
|
11
|
+
updated_by?: UserBase;
|
|
12
|
+
}
|
|
13
|
+
export interface ShieldInformationBarrierSegmentMembers {
|
|
14
|
+
limit?: number;
|
|
15
|
+
next_marker?: string | null;
|
|
16
|
+
entries?: Array<ShieldInformationBarrierSegmentMember>;
|
|
17
|
+
}
|
|
18
|
+
export type ShieldInformationBarrierSegmentMemberType = "shield_information_barrier_segment_member" | (string & {});
|
|
19
|
+
export interface CreateShieldInformationBarrierSegmentMemberRequest {
|
|
20
|
+
type?: ShieldInformationBarrierSegmentMemberType;
|
|
21
|
+
shield_information_barrier?: ShieldInformationBarrierBase;
|
|
22
|
+
shield_information_barrier_segment: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
|
|
23
|
+
user: UserBase;
|
|
24
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { ShieldInformationBarrierBase, ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment, UserBase } from '../schemas.js';
|
|
2
|
+
export interface ShieldInformationBarrierSegmentRestriction {
|
|
3
|
+
type?: ShieldInformationBarrierSegmentRestrictionType;
|
|
4
|
+
id?: string;
|
|
5
|
+
shield_information_barrier_segment: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
|
|
6
|
+
restricted_segment: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
|
|
7
|
+
shield_information_barrier?: ShieldInformationBarrierBase;
|
|
8
|
+
created_at?: string;
|
|
9
|
+
created_by?: UserBase;
|
|
10
|
+
updated_at?: string;
|
|
11
|
+
updated_by?: UserBase;
|
|
12
|
+
}
|
|
13
|
+
export interface ShieldInformationBarrierSegmentRestrictions {
|
|
14
|
+
limit?: number;
|
|
15
|
+
next_marker?: string | null;
|
|
16
|
+
entries?: Array<ShieldInformationBarrierSegmentRestriction>;
|
|
17
|
+
}
|
|
18
|
+
export type ShieldInformationBarrierSegmentRestrictionType = "shield_information_barrier_segment_restriction" | (string & {});
|
|
19
|
+
export interface CreateShieldInformationBarrierSegmentRestrictionRequest {
|
|
20
|
+
type: ShieldInformationBarrierSegmentRestrictionType;
|
|
21
|
+
shield_information_barrier?: ShieldInformationBarrierBase;
|
|
22
|
+
shield_information_barrier_segment: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
|
|
23
|
+
restricted_segment: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
|
|
24
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import type { ShieldInformationBarrierBase, ShieldInformationBarrierSegmentType, UserBase } from '../schemas.js';
|
|
2
|
+
export interface ShieldInformationBarrierSegment {
|
|
3
|
+
id?: string;
|
|
4
|
+
type?: ShieldInformationBarrierSegmentType;
|
|
5
|
+
shield_information_barrier?: ShieldInformationBarrierBase;
|
|
6
|
+
name?: string;
|
|
7
|
+
description?: string;
|
|
8
|
+
created_at?: string;
|
|
9
|
+
created_by?: UserBase;
|
|
10
|
+
updated_at?: string;
|
|
11
|
+
updated_by?: UserBase;
|
|
12
|
+
}
|
|
13
|
+
export interface ShieldInformationBarrierSegments {
|
|
14
|
+
limit?: number;
|
|
15
|
+
next_marker?: string | null;
|
|
16
|
+
entries?: Array<ShieldInformationBarrierSegment>;
|
|
17
|
+
}
|
|
18
|
+
export interface UpdateShieldInformationBarrierSegmentRequest {
|
|
19
|
+
name?: string;
|
|
20
|
+
description?: string | null;
|
|
21
|
+
}
|
|
22
|
+
export interface CreateShieldInformationBarrierSegmentRequest {
|
|
23
|
+
shield_information_barrier: ShieldInformationBarrierBase;
|
|
24
|
+
name: string;
|
|
25
|
+
description?: string;
|
|
26
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { EnterpriseType, ShieldInformationBarrierType, UserBase } from '../schemas.js';
|
|
2
|
+
export interface EnterpriseBase {
|
|
3
|
+
id?: string;
|
|
4
|
+
type?: EnterpriseType;
|
|
5
|
+
}
|
|
6
|
+
export interface ShieldInformationBarrier {
|
|
7
|
+
id?: string;
|
|
8
|
+
type?: ShieldInformationBarrierType;
|
|
9
|
+
enterprise?: EnterpriseBase;
|
|
10
|
+
status?: ShieldInformationBarrierStatus;
|
|
11
|
+
created_at?: string;
|
|
12
|
+
created_by?: UserBase;
|
|
13
|
+
updated_at?: string;
|
|
14
|
+
updated_by?: UserBase;
|
|
15
|
+
enabled_at?: string;
|
|
16
|
+
enabled_by?: UserBase;
|
|
17
|
+
}
|
|
18
|
+
export interface ShieldInformationBarriers {
|
|
19
|
+
limit?: number;
|
|
20
|
+
next_marker?: string | null;
|
|
21
|
+
entries?: Array<ShieldInformationBarrier>;
|
|
22
|
+
}
|
|
23
|
+
export type ShieldInformationBarrierStatus = "draft" | "pending" | "disabled" | "enabled" | "invalid" | (string & {});
|
|
24
|
+
export type PostChangeStatusStatus = "pending" | "disabled" | (string & {});
|
|
25
|
+
export interface CreateChangeStatusRequest {
|
|
26
|
+
id: string;
|
|
27
|
+
status: PostChangeStatusStatus;
|
|
28
|
+
}
|
|
29
|
+
export interface CreateShieldInformationBarrierRequest {
|
|
30
|
+
enterprise: EnterpriseBase;
|
|
31
|
+
}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import type { EnterpriseReference } from '../schemas.js';
|
|
2
|
+
export interface ShieldList {
|
|
3
|
+
id: string;
|
|
4
|
+
type: string;
|
|
5
|
+
name: string;
|
|
6
|
+
enterprise: EnterpriseReference;
|
|
7
|
+
description?: string;
|
|
8
|
+
created_at: string;
|
|
9
|
+
updated_at: string;
|
|
10
|
+
content: ShieldListContent;
|
|
11
|
+
}
|
|
12
|
+
export interface ShieldListMini {
|
|
13
|
+
id: string;
|
|
14
|
+
type: ShieldListMiniType;
|
|
15
|
+
name: string;
|
|
16
|
+
content: ShieldListMiniContent;
|
|
17
|
+
}
|
|
18
|
+
export type ShieldListContent = (ShieldListContentCountry & {
|
|
19
|
+
type: "country";
|
|
20
|
+
}) | (ShieldListContentDomain & {
|
|
21
|
+
type: "domain";
|
|
22
|
+
}) | (ShieldListContentEmail & {
|
|
23
|
+
type: "email";
|
|
24
|
+
}) | (ShieldListContentIp & {
|
|
25
|
+
type: "ip";
|
|
26
|
+
}) | (ShieldListContentIntegration & {
|
|
27
|
+
type: "integration";
|
|
28
|
+
}) | {
|
|
29
|
+
type: string;
|
|
30
|
+
[key: string]: unknown;
|
|
31
|
+
};
|
|
32
|
+
export interface ShieldListContentCountry {
|
|
33
|
+
type: ShieldListContentCountryType;
|
|
34
|
+
country_codes: Array<string>;
|
|
35
|
+
}
|
|
36
|
+
export interface ShieldListContentDomain {
|
|
37
|
+
type: ShieldListContentDomainType;
|
|
38
|
+
domains: Array<string>;
|
|
39
|
+
}
|
|
40
|
+
export interface ShieldListContentEmail {
|
|
41
|
+
type: ShieldListContentEmailType;
|
|
42
|
+
email_addresses: Array<string>;
|
|
43
|
+
}
|
|
44
|
+
export interface ShieldListContentIntegration {
|
|
45
|
+
type: ShieldListContentIntegrationType;
|
|
46
|
+
integrations: Array<ShieldListContentIntegrationIntegrations>;
|
|
47
|
+
}
|
|
48
|
+
export interface ShieldListContentIp {
|
|
49
|
+
type: ShieldListContentIpType;
|
|
50
|
+
ip_addresses: Array<string>;
|
|
51
|
+
}
|
|
52
|
+
export type ShieldListContentRequest = (ShieldListContentCountry & {
|
|
53
|
+
type: "country";
|
|
54
|
+
}) | (ShieldListContentDomain & {
|
|
55
|
+
type: "domain";
|
|
56
|
+
}) | (ShieldListContentEmail & {
|
|
57
|
+
type: "email";
|
|
58
|
+
}) | (ShieldListContentIp & {
|
|
59
|
+
type: "ip";
|
|
60
|
+
}) | {
|
|
61
|
+
type: string;
|
|
62
|
+
[key: string]: unknown;
|
|
63
|
+
};
|
|
64
|
+
export interface ShieldLists {
|
|
65
|
+
entries?: Array<ShieldListMini>;
|
|
66
|
+
}
|
|
67
|
+
export interface ShieldListsCreate {
|
|
68
|
+
name: string;
|
|
69
|
+
description?: string;
|
|
70
|
+
content: ShieldListContentRequest;
|
|
71
|
+
}
|
|
72
|
+
export interface ShieldListsUpdate {
|
|
73
|
+
name: string;
|
|
74
|
+
description?: string;
|
|
75
|
+
content: ShieldListContentRequest;
|
|
76
|
+
}
|
|
77
|
+
export type ShieldListMiniType = "shield_list" | (string & {});
|
|
78
|
+
export interface ShieldListMiniContent {
|
|
79
|
+
type?: string;
|
|
80
|
+
}
|
|
81
|
+
export type ShieldListContentCountryType = "country" | (string & {});
|
|
82
|
+
export type ShieldListContentDomainType = "domain" | (string & {});
|
|
83
|
+
export type ShieldListContentEmailType = "email" | (string & {});
|
|
84
|
+
export type ShieldListContentIntegrationType = "integration" | (string & {});
|
|
85
|
+
export interface ShieldListContentIntegrationIntegrations {
|
|
86
|
+
id?: string;
|
|
87
|
+
}
|
|
88
|
+
export type ShieldListContentIpType = "ip" | (string & {});
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
import type { FileBase, FileMini, FolderMini, SignRequestCreateSignerRole, SignRequestSignerInputContentType, SignRequestSignerInputValidation } from '../schemas.js';
|
|
2
|
+
export interface SignRequest {
|
|
3
|
+
is_document_preparation_needed?: boolean;
|
|
4
|
+
redirect_url?: string | null;
|
|
5
|
+
declined_redirect_url?: string | null;
|
|
6
|
+
are_text_signatures_enabled?: boolean;
|
|
7
|
+
email_subject?: string | null;
|
|
8
|
+
email_message?: string | null;
|
|
9
|
+
are_reminders_enabled?: boolean;
|
|
10
|
+
name?: string;
|
|
11
|
+
prefill_tags?: Array<SignRequestPrefillTag>;
|
|
12
|
+
days_valid?: number | null;
|
|
13
|
+
external_id?: string | null;
|
|
14
|
+
template_id?: string | null;
|
|
15
|
+
external_system_name?: string | null;
|
|
16
|
+
request_flow?: string | null;
|
|
17
|
+
type?: SignRequestType;
|
|
18
|
+
source_files?: Array<FileBase>;
|
|
19
|
+
signers?: Array<SignRequestSigner>;
|
|
20
|
+
signature_color?: string | null;
|
|
21
|
+
id?: string;
|
|
22
|
+
prepare_url?: string | null;
|
|
23
|
+
signing_log?: FileMini;
|
|
24
|
+
status?: SignRequestStatus;
|
|
25
|
+
sign_files?: SignRequestSignFiles;
|
|
26
|
+
auto_expire_at?: string | null;
|
|
27
|
+
parent_folder?: FolderMini;
|
|
28
|
+
collaborator_level?: string | null;
|
|
29
|
+
short_id?: string;
|
|
30
|
+
created_at?: string;
|
|
31
|
+
finished_at?: string | null;
|
|
32
|
+
error_code?: string | null;
|
|
33
|
+
sender_email?: string | null;
|
|
34
|
+
sender_id?: number | null;
|
|
35
|
+
}
|
|
36
|
+
export interface SignRequestCancelRequest {
|
|
37
|
+
reason?: string;
|
|
38
|
+
}
|
|
39
|
+
export interface SignRequestCreateRequest {
|
|
40
|
+
is_document_preparation_needed?: boolean;
|
|
41
|
+
redirect_url?: string | null;
|
|
42
|
+
declined_redirect_url?: string | null;
|
|
43
|
+
are_text_signatures_enabled?: boolean;
|
|
44
|
+
email_subject?: string | null;
|
|
45
|
+
email_message?: string | null;
|
|
46
|
+
are_reminders_enabled?: boolean;
|
|
47
|
+
name?: string;
|
|
48
|
+
prefill_tags?: Array<SignRequestPrefillTag>;
|
|
49
|
+
days_valid?: number | null;
|
|
50
|
+
external_id?: string | null;
|
|
51
|
+
template_id?: string | null;
|
|
52
|
+
external_system_name?: string | null;
|
|
53
|
+
request_flow?: string | null;
|
|
54
|
+
source_files?: Array<FileBase> | null;
|
|
55
|
+
signature_color?: SignRequestCreateRequestSignatureColor | null;
|
|
56
|
+
signers: Array<SignRequestCreateSigner>;
|
|
57
|
+
parent_folder?: FolderMini;
|
|
58
|
+
}
|
|
59
|
+
export interface SignRequestCreateSigner {
|
|
60
|
+
email?: string | null;
|
|
61
|
+
role?: SignRequestCreateSignerRole;
|
|
62
|
+
is_in_person?: boolean;
|
|
63
|
+
order?: number;
|
|
64
|
+
embed_url_external_user_id?: string | null;
|
|
65
|
+
redirect_url?: string | null;
|
|
66
|
+
declined_redirect_url?: string | null;
|
|
67
|
+
login_required?: boolean | null;
|
|
68
|
+
verification_phone_number?: string | null;
|
|
69
|
+
password?: string | null;
|
|
70
|
+
signer_group_id?: string | null;
|
|
71
|
+
suppress_notifications?: boolean | null;
|
|
72
|
+
language?: string | null;
|
|
73
|
+
}
|
|
74
|
+
export interface SignRequestPrefillTag {
|
|
75
|
+
document_tag_id?: string | null;
|
|
76
|
+
text_value?: string | null;
|
|
77
|
+
checkbox_value?: boolean | null;
|
|
78
|
+
date_value?: string | null;
|
|
79
|
+
}
|
|
80
|
+
export interface SignRequests {
|
|
81
|
+
limit?: number;
|
|
82
|
+
next_marker?: string | null;
|
|
83
|
+
entries?: Array<SignRequest>;
|
|
84
|
+
}
|
|
85
|
+
export interface SignRequestSigner {
|
|
86
|
+
email: string | null;
|
|
87
|
+
role?: SignRequestCreateSignerRole;
|
|
88
|
+
is_in_person?: boolean;
|
|
89
|
+
order?: number;
|
|
90
|
+
embed_url_external_user_id?: string | null;
|
|
91
|
+
redirect_url?: string | null;
|
|
92
|
+
declined_redirect_url?: string | null;
|
|
93
|
+
login_required?: boolean | null;
|
|
94
|
+
verification_phone_number?: string | null;
|
|
95
|
+
password?: string | null;
|
|
96
|
+
signer_group_id?: string | null;
|
|
97
|
+
suppress_notifications?: boolean | null;
|
|
98
|
+
language?: string | null;
|
|
99
|
+
has_viewed_document?: boolean;
|
|
100
|
+
signer_decision?: SignRequestSignerSignerDecision | null;
|
|
101
|
+
inputs?: Array<SignRequestSignerInput>;
|
|
102
|
+
embed_url?: string | null;
|
|
103
|
+
iframeable_embed_url?: string | null;
|
|
104
|
+
attachments?: Array<SignRequestSignerAttachment> | null;
|
|
105
|
+
}
|
|
106
|
+
export interface SignRequestSignerAttachment {
|
|
107
|
+
id?: string | null;
|
|
108
|
+
name?: string | null;
|
|
109
|
+
}
|
|
110
|
+
export interface SignRequestSignerInput {
|
|
111
|
+
document_tag_id?: string | null;
|
|
112
|
+
text_value?: string | null;
|
|
113
|
+
checkbox_value?: boolean | null;
|
|
114
|
+
date_value?: string | null;
|
|
115
|
+
type?: SignRequestSignerInputType;
|
|
116
|
+
content_type?: SignRequestSignerInputContentType;
|
|
117
|
+
page_index: number;
|
|
118
|
+
read_only?: boolean;
|
|
119
|
+
validation?: SignRequestSignerInputValidation | null;
|
|
120
|
+
reason?: string | null;
|
|
121
|
+
is_validated?: boolean | null;
|
|
122
|
+
}
|
|
123
|
+
export type SignRequestType = "sign-request" | (string & {});
|
|
124
|
+
export type SignRequestStatus = "converting" | "created" | "sent" | "viewed" | "signed" | "cancelled" | "declined" | "error" | "error_converting" | "error_sending" | "expired" | "finalizing" | "error_finalizing" | (string & {});
|
|
125
|
+
export interface SignRequestSignFiles {
|
|
126
|
+
files?: Array<FileMini>;
|
|
127
|
+
is_ready_for_download?: boolean;
|
|
128
|
+
}
|
|
129
|
+
export type SignRequestCreateRequestSignatureColor = "blue" | "black" | "red" | (string & {});
|
|
130
|
+
export type SignerDecisionType = "signed" | "declined" | (string & {});
|
|
131
|
+
export interface SignRequestSignerSignerDecision {
|
|
132
|
+
type?: SignerDecisionType;
|
|
133
|
+
finalized_at?: string;
|
|
134
|
+
additional_info?: string | null;
|
|
135
|
+
}
|
|
136
|
+
export type SignRequestSignerInputType = "signature" | "date" | "text" | "checkbox" | "radio" | "dropdown" | (string & {});
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import type { FileMini, FolderMini, SignRequestCreateSignerRole, SignRequestSignerInputContentType, SignRequestSignerInputEmailValidationValidationType, SignRequestSignerInputValidation } from '../schemas.js';
|
|
2
|
+
export interface SignTemplate {
|
|
3
|
+
type?: SignTemplateType;
|
|
4
|
+
id?: string;
|
|
5
|
+
name?: string | null;
|
|
6
|
+
email_subject?: string | null;
|
|
7
|
+
email_message?: string | null;
|
|
8
|
+
days_valid?: number | null;
|
|
9
|
+
parent_folder?: FolderMini;
|
|
10
|
+
source_files?: Array<FileMini>;
|
|
11
|
+
are_fields_locked?: boolean;
|
|
12
|
+
are_options_locked?: boolean;
|
|
13
|
+
are_recipients_locked?: boolean;
|
|
14
|
+
are_email_settings_locked?: boolean;
|
|
15
|
+
are_files_locked?: boolean;
|
|
16
|
+
signers?: Array<TemplateSigner>;
|
|
17
|
+
additional_info?: SignTemplateAdditionalInfo;
|
|
18
|
+
ready_sign_link?: SignTemplateReadySignLink | null;
|
|
19
|
+
custom_branding?: SignTemplateCustomBranding | null;
|
|
20
|
+
request_flow?: string | null;
|
|
21
|
+
}
|
|
22
|
+
export interface SignTemplates {
|
|
23
|
+
limit?: number;
|
|
24
|
+
next_marker?: string | null;
|
|
25
|
+
prev_marker?: string | null;
|
|
26
|
+
entries?: Array<SignTemplate>;
|
|
27
|
+
}
|
|
28
|
+
export interface TemplateSigner {
|
|
29
|
+
inputs?: Array<TemplateSignerInput>;
|
|
30
|
+
email?: string | null;
|
|
31
|
+
role?: SignRequestCreateSignerRole;
|
|
32
|
+
is_in_person?: boolean;
|
|
33
|
+
order?: number;
|
|
34
|
+
signer_group_id?: string | null;
|
|
35
|
+
label?: string | null;
|
|
36
|
+
public_id?: string;
|
|
37
|
+
is_password_required?: boolean | null;
|
|
38
|
+
is_phone_number_required?: boolean | null;
|
|
39
|
+
login_required?: boolean | null;
|
|
40
|
+
}
|
|
41
|
+
export interface TemplateSignerInput {
|
|
42
|
+
document_tag_id?: string | null;
|
|
43
|
+
text_value?: string | null;
|
|
44
|
+
checkbox_value?: boolean | null;
|
|
45
|
+
date_value?: string | null;
|
|
46
|
+
type?: TemplateSignerInputType;
|
|
47
|
+
content_type?: SignRequestSignerInputContentType;
|
|
48
|
+
is_required?: boolean;
|
|
49
|
+
page_index: number;
|
|
50
|
+
document_id?: string | null;
|
|
51
|
+
dropdown_choices?: Array<string> | null;
|
|
52
|
+
group_id?: string | null;
|
|
53
|
+
coordinates?: TemplateSignerInputCoordinates;
|
|
54
|
+
dimensions?: TemplateSignerInputDimensions;
|
|
55
|
+
label?: string | null;
|
|
56
|
+
read_only?: boolean;
|
|
57
|
+
validation?: SignRequestSignerInputValidation | null;
|
|
58
|
+
}
|
|
59
|
+
export type SignTemplateType = "sign-template" | (string & {});
|
|
60
|
+
export type AdditionalInfoNonEditable = "email_subject" | "email_message" | "name" | "days_valid" | "signers" | "source_files" | (string & {});
|
|
61
|
+
export interface AdditionalInfoRequired {
|
|
62
|
+
signers?: Array<Array<SignRequestSignerInputEmailValidationValidationType>>;
|
|
63
|
+
}
|
|
64
|
+
export interface SignTemplateAdditionalInfo {
|
|
65
|
+
non_editable?: Array<AdditionalInfoNonEditable>;
|
|
66
|
+
required?: AdditionalInfoRequired;
|
|
67
|
+
}
|
|
68
|
+
export interface SignTemplateReadySignLink {
|
|
69
|
+
url?: string;
|
|
70
|
+
name?: string | null;
|
|
71
|
+
instructions?: string | null;
|
|
72
|
+
folder_id?: string | null;
|
|
73
|
+
is_notification_disabled?: boolean;
|
|
74
|
+
is_active?: boolean;
|
|
75
|
+
}
|
|
76
|
+
export interface SignTemplateCustomBranding {
|
|
77
|
+
company_name?: string | null;
|
|
78
|
+
logo_uri?: string | null;
|
|
79
|
+
branding_color?: string | null;
|
|
80
|
+
email_footer_text?: string | null;
|
|
81
|
+
}
|
|
82
|
+
export type TemplateSignerInputType = "signature" | "date" | "text" | "checkbox" | "attachment" | "radio" | "dropdown" | (string & {});
|
|
83
|
+
export interface TemplateSignerInputCoordinates {
|
|
84
|
+
x?: number;
|
|
85
|
+
y?: number;
|
|
86
|
+
}
|
|
87
|
+
export interface TemplateSignerInputDimensions {
|
|
88
|
+
width?: number;
|
|
89
|
+
height?: number;
|
|
90
|
+
}
|