files.com 1.1.579 → 1.1.581

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 61cb71129a9604587ea0d4b33b03dc17b492baa399cf6582b763115d3a64229a
4
- data.tar.gz: 00053cccce3be908d7eacbc6816d97a6f47a13881473cdd6172c259d995c92e5
3
+ metadata.gz: c48201f3193bbdcf48190fededfeb7f24a33c88721998f538e96eeeace9c8aa1
4
+ data.tar.gz: 5270b772c58f7f9593427e9989044831c27cf79b5d8766ea8cf6c151c7efdcb4
5
5
  SHA512:
6
- metadata.gz: 3784e0710bace937b575970cb01147518253b61b65c0c87d1d5268218aacde2d2c1a36911b17f40365a50c9d40321a41a17ba508bd41120a5307de86944f88f4
7
- data.tar.gz: e84ed4f684a08208f38fb78aac013a4897879ba63c2f9cc02ab8cf28a2e011385c63a7e4d3a4b50745713a802c58dc28d8a886404f9637bb8f252e654412d9f2
6
+ metadata.gz: 5a5dc7f29e68c49c19df6efe9d77df85e7dd89f32bca2925602df776f1a80a7dd3daa7ac27ccfa95c1cd67a37d5e96bb8e055d0a8d409b3e91e5ad5f02dda668
7
+ data.tar.gz: 43b5843c26e5bfa76da66b54af1d20aaaa199d37dd247acb19a101b92eceaddf34b30a684dcfb3fe966e0064ad01125ae060232fcde47e76d6d37c60dbda4f48
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.579
1
+ 1.1.581
data/docs/bundle.md CHANGED
@@ -75,6 +75,7 @@
75
75
  "key": "example value"
76
76
  },
77
77
  "send_one_time_password_to_recipient_at_registration": true,
78
+ "workspace_id": 1,
78
79
  "has_inbox": true,
79
80
  "dont_allow_folders_in_uploads": true,
80
81
  "paths": [
@@ -126,6 +127,7 @@
126
127
  * `watermark_attachment` (Image): Preview watermark image applied to all bundle items.
127
128
  * `watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
128
129
  * `send_one_time_password_to_recipient_at_registration` (boolean): If true, require_share_recipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
130
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
129
131
  * `has_inbox` (boolean): Does this bundle have an associated inbox?
130
132
  * `dont_allow_folders_in_uploads` (boolean): Should folder uploads be prevented?
131
133
  * `paths` (array(string)): A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
@@ -206,7 +208,8 @@ Files::Bundle.create(
206
208
  skip_name: true,
207
209
  skip_company: true,
208
210
  start_access_on_date: "2000-01-01T01:00:00Z",
209
- snapshot_id: 1
211
+ snapshot_id: 1,
212
+ workspace_id: 1
210
213
  )
211
214
  ```
212
215
 
@@ -238,6 +241,7 @@ Files::Bundle.create(
238
241
  * `skip_company` (boolean): BundleRegistrations can be saved without providing company?
239
242
  * `start_access_on_date` (string): Date when share will start to be accessible. If `nil` access granted right after create.
240
243
  * `snapshot_id` (int64): ID of the snapshot containing this bundle's contents.
244
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
241
245
  * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
242
246
 
243
247
 
@@ -291,6 +295,7 @@ Files::Bundle.update(id,
291
295
  start_access_on_date: "2000-01-01T01:00:00Z",
292
296
  skip_email: true,
293
297
  skip_name: true,
298
+ workspace_id: 1,
294
299
  user_id: 1,
295
300
  watermark_attachment_delete: false
296
301
  )
@@ -323,6 +328,7 @@ Files::Bundle.update(id,
323
328
  * `start_access_on_date` (string): Date when share will start to be accessible. If `nil` access granted right after create.
324
329
  * `skip_email` (boolean): BundleRegistrations can be saved without providing email?
325
330
  * `skip_name` (boolean): BundleRegistrations can be saved without providing name?
331
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
326
332
  * `user_id` (int64): The owning user id. Only site admins can set this.
327
333
  * `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
328
334
  * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
@@ -395,6 +401,7 @@ bundle.update(
395
401
  start_access_on_date: "2000-01-01T01:00:00Z",
396
402
  skip_email: true,
397
403
  skip_name: true,
404
+ workspace_id: 1,
398
405
  user_id: 1,
399
406
  watermark_attachment_delete: false
400
407
  )
@@ -427,6 +434,7 @@ bundle.update(
427
434
  * `start_access_on_date` (string): Date when share will start to be accessible. If `nil` access granted right after create.
428
435
  * `skip_email` (boolean): BundleRegistrations can be saved without providing email?
429
436
  * `skip_name` (boolean): BundleRegistrations can be saved without providing name?
437
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
430
438
  * `user_id` (int64): The owning user id. Only site admins can set this.
431
439
  * `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
432
440
  * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
@@ -20,6 +20,7 @@
20
20
  "bundle_code": "example",
21
21
  "bundle_id": 1,
22
22
  "bundle_recipient_id": 1,
23
+ "workspace_id": 1,
23
24
  "created_at": "2000-01-01T01:00:00Z"
24
25
  },
25
26
  "created_at": "2000-01-01T01:00:00Z",
@@ -27,6 +28,7 @@
27
28
  "path": "",
28
29
  "source": "/from_path",
29
30
  "bundle_registration_id": 1,
31
+ "workspace_id": 1,
30
32
  "bundle_registration_name": "John Doe",
31
33
  "bundle_registration_email": "john@example.com",
32
34
  "bundle_registration_ip": "127.0.0.1"
@@ -40,6 +42,7 @@
40
42
  * `path` (string): Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
41
43
  * `source` (string): The source path for this bundle action, if applicable
42
44
  * `bundle_registration_id` (int64): Identifier of the associated bundle registration
45
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
43
46
  * `bundle_registration_name` (string): Name of the registrant who performed the action
44
47
  * `bundle_registration_email` (string): Email of the registrant
45
48
  * `bundle_registration_ip` (string): IP address of the registrant
@@ -60,7 +63,7 @@ Files::BundleAction.list(
60
63
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
61
64
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
62
65
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
63
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at` and `bundle_registration_id`.
66
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `created_at` or `bundle_registration_id`.
64
67
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `bundle_id` or `bundle_registration_id`. Valid field combinations are `[ bundle_id, created_at ]`, `[ bundle_registration_id, created_at ]`, `[ bundle_id, bundle_registration_id ]` or `[ bundle_id, bundle_registration_id, created_at ]`.
65
68
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
66
69
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
@@ -19,10 +19,12 @@
19
19
  "bundle_code": "example",
20
20
  "bundle_id": 1,
21
21
  "bundle_recipient_id": 1,
22
+ "workspace_id": 1,
22
23
  "created_at": "2000-01-01T01:00:00Z"
23
24
  },
24
25
  "download_method": "file",
25
26
  "path": "a/b/test.txt",
27
+ "workspace_id": 1,
26
28
  "created_at": "2000-01-01T01:00:00Z"
27
29
  }
28
30
  ```
@@ -30,6 +32,7 @@
30
32
  * `bundle_registration` (BundleRegistration):
31
33
  * `download_method` (string): Download method (file or full_zip)
32
34
  * `path` (string): Download path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
35
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
33
36
  * `created_at` (date-time): Download date/time
34
37
 
35
38
 
@@ -48,7 +51,7 @@ Files::BundleDownload.list(
48
51
 
49
52
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
50
53
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
51
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
54
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `created_at`.
52
55
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
53
56
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
54
57
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
@@ -8,7 +8,8 @@
8
8
  "id": 1,
9
9
  "notify_on_registration": true,
10
10
  "notify_on_upload": true,
11
- "notify_user_id": 1
11
+ "notify_user_id": 1,
12
+ "workspace_id": 1
12
13
  }
13
14
  ```
14
15
 
@@ -17,6 +18,7 @@
17
18
  * `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
18
19
  * `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
19
20
  * `notify_user_id` (int64): The id of the user to notify.
21
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
20
22
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
21
23
 
22
24
 
@@ -35,7 +37,7 @@ Files::BundleNotification.list(
35
37
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
36
38
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
37
39
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
38
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`.
40
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `bundle_id`.
39
41
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
40
42
 
41
43
 
@@ -8,7 +8,8 @@
8
8
  "name": "John Doe",
9
9
  "note": "Some note.",
10
10
  "recipient": "john.doe@example.com",
11
- "sent_at": "2000-01-01T01:00:00Z"
11
+ "sent_at": "2000-01-01T01:00:00Z",
12
+ "workspace_id": 1
12
13
  }
13
14
  ```
14
15
 
@@ -17,6 +18,7 @@
17
18
  * `note` (string): A note sent to the recipient with the bundle.
18
19
  * `recipient` (string): The recipient's email address.
19
20
  * `sent_at` (date-time): When the Bundle was shared with this recipient.
21
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
20
22
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
21
23
  * `bundle_id` (int64): Bundle to share.
22
24
  * `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
@@ -38,7 +40,7 @@ Files::BundleRecipient.list(
38
40
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
39
41
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
40
42
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
41
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
43
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`.
42
44
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
43
45
  * `bundle_id` (int64): Required - List recipients for the bundle with this ID.
44
46
 
@@ -18,6 +18,7 @@
18
18
  "bundle_code": "example",
19
19
  "bundle_id": 1,
20
20
  "bundle_recipient_id": 1,
21
+ "workspace_id": 1,
21
22
  "created_at": "2000-01-01T01:00:00Z"
22
23
  }
23
24
  ```
@@ -34,6 +35,7 @@
34
35
  * `bundle_code` (string): Bundle URL code
35
36
  * `bundle_id` (int64): Id of associated bundle
36
37
  * `bundle_recipient_id` (int64): Id of associated bundle recipient
38
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
37
39
  * `created_at` (date-time): Registration creation date/time
38
40
 
39
41
 
@@ -53,5 +55,5 @@ Files::BundleRegistration.list(
53
55
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
54
56
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
55
57
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
56
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id` and `created_at`.
58
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `bundle_id` or `created_at`.
57
59
  * `bundle_id` (int64): ID of the associated Bundle
@@ -7,14 +7,18 @@
7
7
  "id": 1,
8
8
  "key_type": "gpg",
9
9
  "inactivity_days": 12,
10
- "name": "inactive gpg keys"
10
+ "apply_to_all_workspaces": true,
11
+ "name": "inactive gpg keys",
12
+ "workspace_id": 12
11
13
  }
12
14
  ```
13
15
 
14
16
  * `id` (int64): Key Lifecycle Rule ID
15
17
  * `key_type` (string): Key type for which the rule will apply (gpg or ssh).
16
18
  * `inactivity_days` (int64): Number of days of inactivity before the rule applies.
19
+ * `apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to keys in all workspaces.
17
20
  * `name` (string): Key Lifecycle Rule name
21
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
18
22
 
19
23
 
20
24
  ---
@@ -29,8 +33,8 @@ Files::KeyLifecycleRule.list
29
33
 
30
34
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
31
35
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
32
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `key_type`.
33
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `key_type`.
36
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `key_type`.
37
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
34
38
 
35
39
 
36
40
  ---
@@ -52,17 +56,21 @@ Files::KeyLifecycleRule.find(id)
52
56
 
53
57
  ```
54
58
  Files::KeyLifecycleRule.create(
59
+ apply_to_all_workspaces: true,
55
60
  key_type: "gpg",
56
61
  inactivity_days: 12,
57
- name: "inactive gpg keys"
62
+ name: "inactive gpg keys",
63
+ workspace_id: 12
58
64
  )
59
65
  ```
60
66
 
61
67
  ### Parameters
62
68
 
69
+ * `apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to keys in all workspaces.
63
70
  * `key_type` (string): Key type for which the rule will apply (gpg or ssh).
64
71
  * `inactivity_days` (int64): Number of days of inactivity before the rule applies.
65
72
  * `name` (string): Key Lifecycle Rule name
73
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
66
74
 
67
75
 
68
76
  ---
@@ -71,18 +79,22 @@ Files::KeyLifecycleRule.create(
71
79
 
72
80
  ```
73
81
  Files::KeyLifecycleRule.update(id,
82
+ apply_to_all_workspaces: true,
74
83
  key_type: "gpg",
75
84
  inactivity_days: 12,
76
- name: "inactive gpg keys"
85
+ name: "inactive gpg keys",
86
+ workspace_id: 12
77
87
  )
78
88
  ```
79
89
 
80
90
  ### Parameters
81
91
 
82
92
  * `id` (int64): Required - Key Lifecycle Rule ID.
93
+ * `apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to keys in all workspaces.
83
94
  * `key_type` (string): Key type for which the rule will apply (gpg or ssh).
84
95
  * `inactivity_days` (int64): Number of days of inactivity before the rule applies.
85
96
  * `name` (string): Key Lifecycle Rule name
97
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
86
98
 
87
99
 
88
100
  ---
@@ -106,18 +118,22 @@ Files::KeyLifecycleRule.delete(id)
106
118
  key_lifecycle_rule = Files::KeyLifecycleRule.find(id)
107
119
 
108
120
  key_lifecycle_rule.update(
121
+ apply_to_all_workspaces: true,
109
122
  key_type: "gpg",
110
123
  inactivity_days: 12,
111
- name: "inactive gpg keys"
124
+ name: "inactive gpg keys",
125
+ workspace_id: 12
112
126
  )
113
127
  ```
114
128
 
115
129
  ### Parameters
116
130
 
117
131
  * `id` (int64): Required - Key Lifecycle Rule ID.
132
+ * `apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to keys in all workspaces.
118
133
  * `key_type` (string): Key type for which the rule will apply (gpg or ssh).
119
134
  * `inactivity_days` (int64): Number of days of inactivity before the rule applies.
120
135
  * `name` (string): Key Lifecycle Rule name
136
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
121
137
 
122
138
 
123
139
  ---
data/docs/restore.md CHANGED
@@ -24,6 +24,7 @@
24
24
  "two_factor_authentication_methods_restored": 1,
25
25
  "status": "pending",
26
26
  "update_timestamps": true,
27
+ "workspace_id": 12,
27
28
  "error_messages": [
28
29
  "example"
29
30
  ]
@@ -50,6 +51,7 @@
50
51
  * `two_factor_authentication_methods_restored` (int64): Number of two factor authentication methods restored (only present for `restoration_type=users`).
51
52
  * `status` (string): Status of the restoration process.
52
53
  * `update_timestamps` (boolean): If true, we will update the last modified timestamp of restored files to today's date. If false, we might trigger File Expiration to delete the file again.
54
+ * `workspace_id` (int64): Workspace ID for a workspace-scoped restore. `0` means the default site-wide scope.
53
55
  * `error_messages` (array(string)): Error messages received while restoring files and/or directories. Only present if there were errors.
54
56
 
55
57
 
@@ -65,7 +67,7 @@ Files::Restore.list
65
67
 
66
68
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
67
69
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
68
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
70
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`.
69
71
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `restoration_type`.
70
72
 
71
73
 
@@ -80,7 +82,8 @@ Files::Restore.create(
80
82
  restoration_type: "files",
81
83
  restore_deleted_permissions: true,
82
84
  restore_in_place: true,
83
- update_timestamps: true
85
+ update_timestamps: true,
86
+ workspace_id: 12
84
87
  )
85
88
  ```
86
89
 
@@ -92,3 +95,4 @@ Files::Restore.create(
92
95
  * `restore_deleted_permissions` (boolean): If true, we will also restore any Permissions that match the same path prefix from the same dates.
93
96
  * `restore_in_place` (boolean): If true, we will restore the files in place (into their original paths). If false, we will create a new restoration folder in the root and restore files there.
94
97
  * `update_timestamps` (boolean): If true, we will update the last modified timestamp of restored files to today's date. If false, we might trigger File Expiration to delete the file again.
98
+ * `workspace_id` (int64): Workspace ID for a workspace-scoped restore. `0` means the default site-wide scope.
@@ -15,9 +15,11 @@
15
15
  "inactivity_days": 12,
16
16
  "include_folder_admins": true,
17
17
  "include_site_admins": true,
18
+ "apply_to_all_workspaces": true,
18
19
  "name": "password specific rules",
19
20
  "partner_tag": "guest",
20
21
  "site_id": 1,
22
+ "workspace_id": 12,
21
23
  "user_state": "inactive",
22
24
  "user_tag": "guest"
23
25
  }
@@ -30,9 +32,11 @@
30
32
  * `inactivity_days` (int64): Number of days of inactivity before the rule applies
31
33
  * `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
32
34
  * `include_site_admins` (boolean): If true, the rule will apply to site admins.
35
+ * `apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to users in all workspaces.
33
36
  * `name` (string): User Lifecycle Rule name
34
37
  * `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
35
38
  * `site_id` (int64): Site ID
39
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
36
40
  * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
37
41
  * `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
38
42
 
@@ -49,7 +53,8 @@ Files::UserLifecycleRule.list
49
53
 
50
54
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
51
55
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
52
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`.
56
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id` and `workspace_id`.
57
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
53
58
 
54
59
 
55
60
  ---
@@ -71,6 +76,7 @@ Files::UserLifecycleRule.find(id)
71
76
 
72
77
  ```
73
78
  Files::UserLifecycleRule.create(
79
+ apply_to_all_workspaces: true,
74
80
  authentication_method: "password",
75
81
  group_ids: [1,2,3],
76
82
  inactivity_days: 12,
@@ -79,13 +85,15 @@ Files::UserLifecycleRule.create(
79
85
  name: "password specific rules",
80
86
  partner_tag: "guest",
81
87
  user_state: "inactive",
82
- user_tag: "guest"
88
+ user_tag: "guest",
89
+ workspace_id: 12
83
90
  )
84
91
  ```
85
92
 
86
93
  ### Parameters
87
94
 
88
95
  * `action` (string): Action to take on inactive users (disable or delete)
96
+ * `apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to users in all workspaces.
89
97
  * `authentication_method` (string): User authentication method for which the rule will apply.
90
98
  * `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
91
99
  * `inactivity_days` (int64): Number of days of inactivity before the rule applies
@@ -95,6 +103,7 @@ Files::UserLifecycleRule.create(
95
103
  * `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
96
104
  * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
97
105
  * `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
106
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
98
107
 
99
108
 
100
109
  ---
@@ -103,6 +112,7 @@ Files::UserLifecycleRule.create(
103
112
 
104
113
  ```
105
114
  Files::UserLifecycleRule.update(id,
115
+ apply_to_all_workspaces: true,
106
116
  authentication_method: "password",
107
117
  group_ids: [1,2,3],
108
118
  inactivity_days: 12,
@@ -111,7 +121,8 @@ Files::UserLifecycleRule.update(id,
111
121
  name: "password specific rules",
112
122
  partner_tag: "guest",
113
123
  user_state: "inactive",
114
- user_tag: "guest"
124
+ user_tag: "guest",
125
+ workspace_id: 12
115
126
  )
116
127
  ```
117
128
 
@@ -119,6 +130,7 @@ Files::UserLifecycleRule.update(id,
119
130
 
120
131
  * `id` (int64): Required - User Lifecycle Rule ID.
121
132
  * `action` (string): Action to take on inactive users (disable or delete)
133
+ * `apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to users in all workspaces.
122
134
  * `authentication_method` (string): User authentication method for which the rule will apply.
123
135
  * `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
124
136
  * `inactivity_days` (int64): Number of days of inactivity before the rule applies
@@ -128,6 +140,7 @@ Files::UserLifecycleRule.update(id,
128
140
  * `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
129
141
  * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
130
142
  * `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
143
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
131
144
 
132
145
 
133
146
  ---
@@ -151,6 +164,7 @@ Files::UserLifecycleRule.delete(id)
151
164
  user_lifecycle_rule = Files::UserLifecycleRule.find(id)
152
165
 
153
166
  user_lifecycle_rule.update(
167
+ apply_to_all_workspaces: true,
154
168
  authentication_method: "password",
155
169
  group_ids: [1,2,3],
156
170
  inactivity_days: 12,
@@ -159,7 +173,8 @@ user_lifecycle_rule.update(
159
173
  name: "password specific rules",
160
174
  partner_tag: "guest",
161
175
  user_state: "inactive",
162
- user_tag: "guest"
176
+ user_tag: "guest",
177
+ workspace_id: 12
163
178
  )
164
179
  ```
165
180
 
@@ -167,6 +182,7 @@ user_lifecycle_rule.update(
167
182
 
168
183
  * `id` (int64): Required - User Lifecycle Rule ID.
169
184
  * `action` (string): Action to take on inactive users (disable or delete)
185
+ * `apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to users in all workspaces.
170
186
  * `authentication_method` (string): User authentication method for which the rule will apply.
171
187
  * `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
172
188
  * `inactivity_days` (int64): Number of days of inactivity before the rule applies
@@ -176,6 +192,7 @@ user_lifecycle_rule.update(
176
192
  * `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
177
193
  * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
178
194
  * `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
195
+ * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
179
196
 
180
197
 
181
198
  ---
@@ -338,6 +338,15 @@ module Files
338
338
  @attributes[:send_one_time_password_to_recipient_at_registration] = value
339
339
  end
340
340
 
341
+ # int64 - Workspace ID. `0` means the default workspace.
342
+ def workspace_id
343
+ @attributes[:workspace_id]
344
+ end
345
+
346
+ def workspace_id=(value)
347
+ @attributes[:workspace_id] = value
348
+ end
349
+
341
350
  # boolean - Does this bundle have an associated inbox?
342
351
  def has_inbox
343
352
  @attributes[:has_inbox]
@@ -472,6 +481,7 @@ module Files
472
481
  # start_access_on_date - string - Date when share will start to be accessible. If `nil` access granted right after create.
473
482
  # skip_email - boolean - BundleRegistrations can be saved without providing email?
474
483
  # skip_name - boolean - BundleRegistrations can be saved without providing name?
484
+ # workspace_id - int64 - Workspace ID. `0` means the default workspace.
475
485
  # user_id - int64 - The owning user id. Only site admins can set this.
476
486
  # watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
477
487
  # watermark_attachment_file - file - Preview watermark image applied to all bundle items.
@@ -494,6 +504,7 @@ module Files
494
504
  raise InvalidParameterError.new("Bad parameter: path_template_time_zone must be an String") if params[:path_template_time_zone] and !params[:path_template_time_zone].is_a?(String)
495
505
  raise InvalidParameterError.new("Bad parameter: permissions must be an String") if params[:permissions] and !params[:permissions].is_a?(String)
496
506
  raise InvalidParameterError.new("Bad parameter: start_access_on_date must be an String") if params[:start_access_on_date] and !params[:start_access_on_date].is_a?(String)
507
+ raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
497
508
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
498
509
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
499
510
 
@@ -601,6 +612,7 @@ module Files
601
612
  # skip_company - boolean - BundleRegistrations can be saved without providing company?
602
613
  # start_access_on_date - string - Date when share will start to be accessible. If `nil` access granted right after create.
603
614
  # snapshot_id - int64 - ID of the snapshot containing this bundle's contents.
615
+ # workspace_id - int64 - Workspace ID. `0` means the default workspace.
604
616
  # watermark_attachment_file - file - Preview watermark image applied to all bundle items.
605
617
  def self.create(params = {}, options = {})
606
618
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
@@ -619,6 +631,7 @@ module Files
619
631
  raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params[:inbox_id] and !params[:inbox_id].is_a?(Integer)
620
632
  raise InvalidParameterError.new("Bad parameter: start_access_on_date must be an String") if params[:start_access_on_date] and !params[:start_access_on_date].is_a?(String)
621
633
  raise InvalidParameterError.new("Bad parameter: snapshot_id must be an Integer") if params[:snapshot_id] and !params[:snapshot_id].is_a?(Integer)
634
+ raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
622
635
  raise MissingParameterError.new("Parameter missing: paths") unless params[:paths]
623
636
 
624
637
  response, options = Api.send_request("/bundles", :post, params, options)
@@ -669,6 +682,7 @@ module Files
669
682
  # start_access_on_date - string - Date when share will start to be accessible. If `nil` access granted right after create.
670
683
  # skip_email - boolean - BundleRegistrations can be saved without providing email?
671
684
  # skip_name - boolean - BundleRegistrations can be saved without providing name?
685
+ # workspace_id - int64 - Workspace ID. `0` means the default workspace.
672
686
  # user_id - int64 - The owning user id. Only site admins can set this.
673
687
  # watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
674
688
  # watermark_attachment_file - file - Preview watermark image applied to all bundle items.
@@ -690,6 +704,7 @@ module Files
690
704
  raise InvalidParameterError.new("Bad parameter: path_template_time_zone must be an String") if params[:path_template_time_zone] and !params[:path_template_time_zone].is_a?(String)
691
705
  raise InvalidParameterError.new("Bad parameter: permissions must be an String") if params[:permissions] and !params[:permissions].is_a?(String)
692
706
  raise InvalidParameterError.new("Bad parameter: start_access_on_date must be an String") if params[:start_access_on_date] and !params[:start_access_on_date].is_a?(String)
707
+ raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
693
708
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
694
709
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
695
710
 
@@ -44,6 +44,11 @@ module Files
44
44
  @attributes[:bundle_registration_id]
45
45
  end
46
46
 
47
+ # int64 - Workspace ID. `0` means the default workspace.
48
+ def workspace_id
49
+ @attributes[:workspace_id]
50
+ end
51
+
47
52
  # string - Name of the registrant who performed the action
48
53
  def bundle_registration_name
49
54
  @attributes[:bundle_registration_name]
@@ -63,7 +68,7 @@ module Files
63
68
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
64
69
  # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
65
70
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
66
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at` and `bundle_registration_id`.
71
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `created_at` or `bundle_registration_id`.
67
72
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `bundle_id` or `bundle_registration_id`. Valid field combinations are `[ bundle_id, created_at ]`, `[ bundle_registration_id, created_at ]`, `[ bundle_id, bundle_registration_id ]` or `[ bundle_id, bundle_registration_id, created_at ]`.
68
73
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
69
74
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
@@ -24,6 +24,11 @@ module Files
24
24
  @attributes[:path]
25
25
  end
26
26
 
27
+ # int64 - Workspace ID. `0` means the default workspace.
28
+ def workspace_id
29
+ @attributes[:workspace_id]
30
+ end
31
+
27
32
  # date-time - Download date/time
28
33
  def created_at
29
34
  @attributes[:created_at]
@@ -32,7 +37,7 @@ module Files
32
37
  # Parameters:
33
38
  # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
34
39
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
35
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
40
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `created_at`.
36
41
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
37
42
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
38
43
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
@@ -54,6 +54,15 @@ module Files
54
54
  @attributes[:notify_user_id] = value
55
55
  end
56
56
 
57
+ # int64 - Workspace ID. `0` means the default workspace.
58
+ def workspace_id
59
+ @attributes[:workspace_id]
60
+ end
61
+
62
+ def workspace_id=(value)
63
+ @attributes[:workspace_id] = value
64
+ end
65
+
57
66
  # int64 - User ID. Provide a value of `0` to operate the current session's user.
58
67
  def user_id
59
68
  @attributes[:user_id]
@@ -106,7 +115,7 @@ module Files
106
115
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
107
116
  # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
108
117
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
109
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`.
118
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `bundle_id`.
110
119
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
111
120
  def self.list(params = {}, options = {})
112
121
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
@@ -54,6 +54,15 @@ module Files
54
54
  @attributes[:sent_at] = value
55
55
  end
56
56
 
57
+ # int64 - Workspace ID. `0` means the default workspace.
58
+ def workspace_id
59
+ @attributes[:workspace_id]
60
+ end
61
+
62
+ def workspace_id=(value)
63
+ @attributes[:workspace_id] = value
64
+ end
65
+
57
66
  # int64 - User ID. Provide a value of `0` to operate the current session's user.
58
67
  def user_id
59
68
  @attributes[:user_id]
@@ -96,7 +105,7 @@ module Files
96
105
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
97
106
  # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
98
107
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
99
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
108
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`.
100
109
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
101
110
  # bundle_id (required) - int64 - List recipients for the bundle with this ID.
102
111
  def self.list(params = {}, options = {})
@@ -69,6 +69,11 @@ module Files
69
69
  @attributes[:bundle_recipient_id]
70
70
  end
71
71
 
72
+ # int64 - Workspace ID. `0` means the default workspace.
73
+ def workspace_id
74
+ @attributes[:workspace_id]
75
+ end
76
+
72
77
  # date-time - Registration creation date/time
73
78
  def created_at
74
79
  @attributes[:created_at]
@@ -78,7 +83,7 @@ module Files
78
83
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
79
84
  # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
80
85
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
81
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id` and `created_at`.
86
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `bundle_id` or `created_at`.
82
87
  # bundle_id - int64 - ID of the associated Bundle
83
88
  def self.list(params = {}, options = {})
84
89
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
@@ -36,6 +36,15 @@ module Files
36
36
  @attributes[:inactivity_days] = value
37
37
  end
38
38
 
39
+ # boolean - If true, a default-workspace rule also applies to keys in all workspaces.
40
+ def apply_to_all_workspaces
41
+ @attributes[:apply_to_all_workspaces]
42
+ end
43
+
44
+ def apply_to_all_workspaces=(value)
45
+ @attributes[:apply_to_all_workspaces] = value
46
+ end
47
+
39
48
  # string - Key Lifecycle Rule name
40
49
  def name
41
50
  @attributes[:name]
@@ -45,10 +54,21 @@ module Files
45
54
  @attributes[:name] = value
46
55
  end
47
56
 
57
+ # int64 - Workspace ID. `0` means the default workspace.
58
+ def workspace_id
59
+ @attributes[:workspace_id]
60
+ end
61
+
62
+ def workspace_id=(value)
63
+ @attributes[:workspace_id] = value
64
+ end
65
+
48
66
  # Parameters:
67
+ # apply_to_all_workspaces - boolean - If true, a default-workspace rule also applies to keys in all workspaces.
49
68
  # key_type - string - Key type for which the rule will apply (gpg or ssh).
50
69
  # inactivity_days - int64 - Number of days of inactivity before the rule applies.
51
70
  # name - string - Key Lifecycle Rule name
71
+ # workspace_id - int64 - Workspace ID. `0` means the default workspace.
52
72
  def update(params = {})
53
73
  params ||= {}
54
74
  params[:id] = @attributes[:id]
@@ -57,6 +77,7 @@ module Files
57
77
  raise InvalidParameterError.new("Bad parameter: key_type must be an String") if params[:key_type] and !params[:key_type].is_a?(String)
58
78
  raise InvalidParameterError.new("Bad parameter: inactivity_days must be an Integer") if params[:inactivity_days] and !params[:inactivity_days].is_a?(Integer)
59
79
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
80
+ raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
60
81
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
61
82
 
62
83
  Api.send_request("/key_lifecycle_rules/#{@attributes[:id]}", :patch, params, @options)
@@ -91,8 +112,8 @@ module Files
91
112
  # Parameters:
92
113
  # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
93
114
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
94
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `key_type`.
95
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `key_type`.
115
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `key_type`.
116
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
96
117
  def self.list(params = {}, options = {})
97
118
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
98
119
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -125,22 +146,27 @@ module Files
125
146
  end
126
147
 
127
148
  # Parameters:
149
+ # apply_to_all_workspaces - boolean - If true, a default-workspace rule also applies to keys in all workspaces.
128
150
  # key_type - string - Key type for which the rule will apply (gpg or ssh).
129
151
  # inactivity_days - int64 - Number of days of inactivity before the rule applies.
130
152
  # name - string - Key Lifecycle Rule name
153
+ # workspace_id - int64 - Workspace ID. `0` means the default workspace.
131
154
  def self.create(params = {}, options = {})
132
155
  raise InvalidParameterError.new("Bad parameter: key_type must be an String") if params[:key_type] and !params[:key_type].is_a?(String)
133
156
  raise InvalidParameterError.new("Bad parameter: inactivity_days must be an Integer") if params[:inactivity_days] and !params[:inactivity_days].is_a?(Integer)
134
157
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
158
+ raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
135
159
 
136
160
  response, options = Api.send_request("/key_lifecycle_rules", :post, params, options)
137
161
  KeyLifecycleRule.new(response.data, options)
138
162
  end
139
163
 
140
164
  # Parameters:
165
+ # apply_to_all_workspaces - boolean - If true, a default-workspace rule also applies to keys in all workspaces.
141
166
  # key_type - string - Key type for which the rule will apply (gpg or ssh).
142
167
  # inactivity_days - int64 - Number of days of inactivity before the rule applies.
143
168
  # name - string - Key Lifecycle Rule name
169
+ # workspace_id - int64 - Workspace ID. `0` means the default workspace.
144
170
  def self.update(id, params = {}, options = {})
145
171
  params ||= {}
146
172
  params[:id] = id
@@ -148,6 +174,7 @@ module Files
148
174
  raise InvalidParameterError.new("Bad parameter: key_type must be an String") if params[:key_type] and !params[:key_type].is_a?(String)
149
175
  raise InvalidParameterError.new("Bad parameter: inactivity_days must be an Integer") if params[:inactivity_days] and !params[:inactivity_days].is_a?(Integer)
150
176
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
177
+ raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
151
178
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
152
179
 
153
180
  response, options = Api.send_request("/key_lifecycle_rules/#{params[:id]}", :patch, params, options)
@@ -189,6 +189,15 @@ module Files
189
189
  @attributes[:update_timestamps] = value
190
190
  end
191
191
 
192
+ # int64 - Workspace ID for a workspace-scoped restore. `0` means the default site-wide scope.
193
+ def workspace_id
194
+ @attributes[:workspace_id]
195
+ end
196
+
197
+ def workspace_id=(value)
198
+ @attributes[:workspace_id] = value
199
+ end
200
+
192
201
  # array(string) - Error messages received while restoring files and/or directories. Only present if there were errors.
193
202
  def error_messages
194
203
  @attributes[:error_messages]
@@ -212,7 +221,7 @@ module Files
212
221
  # Parameters:
213
222
  # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
214
223
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
215
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
224
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`.
216
225
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `restoration_type`.
217
226
  def self.list(params = {}, options = {})
218
227
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
@@ -236,10 +245,12 @@ module Files
236
245
  # restore_deleted_permissions - boolean - If true, we will also restore any Permissions that match the same path prefix from the same dates.
237
246
  # restore_in_place - boolean - If true, we will restore the files in place (into their original paths). If false, we will create a new restoration folder in the root and restore files there.
238
247
  # update_timestamps - boolean - If true, we will update the last modified timestamp of restored files to today's date. If false, we might trigger File Expiration to delete the file again.
248
+ # workspace_id - int64 - Workspace ID for a workspace-scoped restore. `0` means the default site-wide scope.
239
249
  def self.create(params = {}, options = {})
240
250
  raise InvalidParameterError.new("Bad parameter: earliest_date must be an String") if params[:earliest_date] and !params[:earliest_date].is_a?(String)
241
251
  raise InvalidParameterError.new("Bad parameter: prefix must be an String") if params[:prefix] and !params[:prefix].is_a?(String)
242
252
  raise InvalidParameterError.new("Bad parameter: restoration_type must be an String") if params[:restoration_type] and !params[:restoration_type].is_a?(String)
253
+ raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
243
254
  raise MissingParameterError.new("Parameter missing: earliest_date") unless params[:earliest_date]
244
255
 
245
256
  response, options = Api.send_request("/restores", :post, params, options)
@@ -72,6 +72,15 @@ module Files
72
72
  @attributes[:include_site_admins] = value
73
73
  end
74
74
 
75
+ # boolean - If true, a default-workspace rule also applies to users in all workspaces.
76
+ def apply_to_all_workspaces
77
+ @attributes[:apply_to_all_workspaces]
78
+ end
79
+
80
+ def apply_to_all_workspaces=(value)
81
+ @attributes[:apply_to_all_workspaces] = value
82
+ end
83
+
75
84
  # string - User Lifecycle Rule name
76
85
  def name
77
86
  @attributes[:name]
@@ -99,6 +108,15 @@ module Files
99
108
  @attributes[:site_id] = value
100
109
  end
101
110
 
111
+ # int64 - Workspace ID. `0` means the default workspace.
112
+ def workspace_id
113
+ @attributes[:workspace_id]
114
+ end
115
+
116
+ def workspace_id=(value)
117
+ @attributes[:workspace_id] = value
118
+ end
119
+
102
120
  # string - State of the users to apply the rule to (inactive or disabled)
103
121
  def user_state
104
122
  @attributes[:user_state]
@@ -119,6 +137,7 @@ module Files
119
137
 
120
138
  # Parameters:
121
139
  # action - string - Action to take on inactive users (disable or delete)
140
+ # apply_to_all_workspaces - boolean - If true, a default-workspace rule also applies to users in all workspaces.
122
141
  # authentication_method - string - User authentication method for which the rule will apply.
123
142
  # group_ids - array(int64) - Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
124
143
  # inactivity_days - int64 - Number of days of inactivity before the rule applies
@@ -128,6 +147,7 @@ module Files
128
147
  # partner_tag - string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
129
148
  # user_state - string - State of the users to apply the rule to (inactive or disabled)
130
149
  # user_tag - string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
150
+ # workspace_id - int64 - Workspace ID. `0` means the default workspace.
131
151
  def update(params = {})
132
152
  params ||= {}
133
153
  params[:id] = @attributes[:id]
@@ -141,6 +161,7 @@ module Files
141
161
  raise InvalidParameterError.new("Bad parameter: partner_tag must be an String") if params[:partner_tag] and !params[:partner_tag].is_a?(String)
142
162
  raise InvalidParameterError.new("Bad parameter: user_state must be an String") if params[:user_state] and !params[:user_state].is_a?(String)
143
163
  raise InvalidParameterError.new("Bad parameter: user_tag must be an String") if params[:user_tag] and !params[:user_tag].is_a?(String)
164
+ raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
144
165
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
145
166
 
146
167
  Api.send_request("/user_lifecycle_rules/#{@attributes[:id]}", :patch, params, @options)
@@ -175,11 +196,13 @@ module Files
175
196
  # Parameters:
176
197
  # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
177
198
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
178
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`.
199
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id` and `workspace_id`.
200
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
179
201
  def self.list(params = {}, options = {})
180
202
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
181
203
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
182
204
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
205
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
183
206
 
184
207
  List.new(UserLifecycleRule, params) do
185
208
  Api.send_request("/user_lifecycle_rules", :get, params, options)
@@ -208,6 +231,7 @@ module Files
208
231
 
209
232
  # Parameters:
210
233
  # action - string - Action to take on inactive users (disable or delete)
234
+ # apply_to_all_workspaces - boolean - If true, a default-workspace rule also applies to users in all workspaces.
211
235
  # authentication_method - string - User authentication method for which the rule will apply.
212
236
  # group_ids - array(int64) - Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
213
237
  # inactivity_days - int64 - Number of days of inactivity before the rule applies
@@ -217,6 +241,7 @@ module Files
217
241
  # partner_tag - string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
218
242
  # user_state - string - State of the users to apply the rule to (inactive or disabled)
219
243
  # user_tag - string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
244
+ # workspace_id - int64 - Workspace ID. `0` means the default workspace.
220
245
  def self.create(params = {}, options = {})
221
246
  raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
222
247
  raise InvalidParameterError.new("Bad parameter: authentication_method must be an String") if params[:authentication_method] and !params[:authentication_method].is_a?(String)
@@ -226,6 +251,7 @@ module Files
226
251
  raise InvalidParameterError.new("Bad parameter: partner_tag must be an String") if params[:partner_tag] and !params[:partner_tag].is_a?(String)
227
252
  raise InvalidParameterError.new("Bad parameter: user_state must be an String") if params[:user_state] and !params[:user_state].is_a?(String)
228
253
  raise InvalidParameterError.new("Bad parameter: user_tag must be an String") if params[:user_tag] and !params[:user_tag].is_a?(String)
254
+ raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
229
255
 
230
256
  response, options = Api.send_request("/user_lifecycle_rules", :post, params, options)
231
257
  UserLifecycleRule.new(response.data, options)
@@ -233,6 +259,7 @@ module Files
233
259
 
234
260
  # Parameters:
235
261
  # action - string - Action to take on inactive users (disable or delete)
262
+ # apply_to_all_workspaces - boolean - If true, a default-workspace rule also applies to users in all workspaces.
236
263
  # authentication_method - string - User authentication method for which the rule will apply.
237
264
  # group_ids - array(int64) - Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
238
265
  # inactivity_days - int64 - Number of days of inactivity before the rule applies
@@ -242,6 +269,7 @@ module Files
242
269
  # partner_tag - string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
243
270
  # user_state - string - State of the users to apply the rule to (inactive or disabled)
244
271
  # user_tag - string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
272
+ # workspace_id - int64 - Workspace ID. `0` means the default workspace.
245
273
  def self.update(id, params = {}, options = {})
246
274
  params ||= {}
247
275
  params[:id] = id
@@ -254,6 +282,7 @@ module Files
254
282
  raise InvalidParameterError.new("Bad parameter: partner_tag must be an String") if params[:partner_tag] and !params[:partner_tag].is_a?(String)
255
283
  raise InvalidParameterError.new("Bad parameter: user_state must be an String") if params[:user_state] and !params[:user_state].is_a?(String)
256
284
  raise InvalidParameterError.new("Bad parameter: user_tag must be an String") if params[:user_tag] and !params[:user_tag].is_a?(String)
285
+ raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
257
286
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
258
287
 
259
288
  response, options = Api.send_request("/user_lifecycle_rules/#{params[:id]}", :patch, params, options)
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.579"
4
+ VERSION = "1.1.581"
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: files.com
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.579
4
+ version: 1.1.581
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com