files.com 1.1.578 → 1.1.580

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: f7a9474aee1909f849b815061c17af151a30f2662eee30489e4144688d992aa7
4
- data.tar.gz: 8416c7681a8c315c1798fb4ac93cd86b353d18acf2f5544c62cc2fb8343265aa
3
+ metadata.gz: 002ed959b272f6bc16ef15e87004a3cd07856bbc91ec7ab25e09040365f17f41
4
+ data.tar.gz: 2da93319f0f835b7a9bcaf9883c309aea0fdf887d5efd6d7fa3f16231a791136
5
5
  SHA512:
6
- metadata.gz: 1d7903b3044aaca5a613b6c41abc3637365709316eacecf62fd2e6b08b4f80346ca88151d5449649f23df03ff662d0761e0e883d3b97326487e6a55441846eca
7
- data.tar.gz: 4180d08f7740fa8e084f565a1124b96819f731b79136b69bac31e9686aa6373097321dca93fd30d1f406688ee99db8a898620a23e33362ae5ec655051e5b623c
6
+ metadata.gz: 07706c0c3ddc84b6c37e5b0b91adc4b74710d705742c4cfc89f2d5975195c984b5aad0486f682f359b6eed3b6341ad65860433b323cea4c41a3e444816daf73c
7
+ data.tar.gz: c1a4c6b99e881b08bdf7ff9128f3f4efb11743abebba2405b2d3beb711b5add8cf9627831db3c665e79d0814b290a395136d3a4b0e2a6cf37ae41b92eac539ad
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.578
1
+ 1.1.580
@@ -44,6 +44,7 @@
44
44
  * `skip_company` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
45
45
  * `in_use` (boolean): Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
46
46
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
47
+ * `workspace_id` (int64): Workspace ID
47
48
 
48
49
 
49
50
  ---
@@ -84,6 +85,7 @@ Files::FormFieldSet.find(id)
84
85
  Files::FormFieldSet.create(
85
86
  user_id: 1,
86
87
  title: "Sample Form Title",
88
+ workspace_id: 1,
87
89
  skip_email: false,
88
90
  skip_name: false,
89
91
  skip_company: false,
@@ -95,6 +97,7 @@ Files::FormFieldSet.create(
95
97
 
96
98
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
97
99
  * `title` (string): Title to be displayed
100
+ * `workspace_id` (int64): Workspace ID
98
101
  * `skip_email` (boolean): Skip validating form email
99
102
  * `skip_name` (boolean): Skip validating form name
100
103
  * `skip_company` (boolean): Skip validating company
@@ -108,6 +111,7 @@ Files::FormFieldSet.create(
108
111
  ```
109
112
  Files::FormFieldSet.update(id,
110
113
  title: "Sample Form Title",
114
+ workspace_id: 1,
111
115
  skip_email: false,
112
116
  skip_name: false,
113
117
  skip_company: false,
@@ -119,6 +123,7 @@ Files::FormFieldSet.update(id,
119
123
 
120
124
  * `id` (int64): Required - Form Field Set ID.
121
125
  * `title` (string): Title to be displayed
126
+ * `workspace_id` (int64): Workspace ID
122
127
  * `skip_email` (boolean): Skip validating form email
123
128
  * `skip_name` (boolean): Skip validating form name
124
129
  * `skip_company` (boolean): Skip validating company
@@ -147,6 +152,7 @@ form_field_set = Files::FormFieldSet.find(id)
147
152
 
148
153
  form_field_set.update(
149
154
  title: "Sample Form Title",
155
+ workspace_id: 1,
150
156
  skip_email: false,
151
157
  skip_name: false,
152
158
  skip_company: false,
@@ -158,6 +164,7 @@ form_field_set.update(
158
164
 
159
165
  * `id` (int64): Required - Form Field Set ID.
160
166
  * `title` (string): Title to be displayed
167
+ * `workspace_id` (int64): Workspace ID
161
168
  * `skip_email` (boolean): Skip validating form email
162
169
  * `skip_name` (boolean): Skip validating form name
163
170
  * `skip_company` (boolean): Skip validating company
@@ -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
  ---
@@ -90,8 +90,18 @@ module Files
90
90
  @attributes[:user_id] = value
91
91
  end
92
92
 
93
+ # int64 - Workspace ID
94
+ def workspace_id
95
+ @attributes[:workspace_id]
96
+ end
97
+
98
+ def workspace_id=(value)
99
+ @attributes[:workspace_id] = value
100
+ end
101
+
93
102
  # Parameters:
94
103
  # title - string - Title to be displayed
104
+ # workspace_id - int64 - Workspace ID
95
105
  # skip_email - boolean - Skip validating form email
96
106
  # skip_name - boolean - Skip validating form name
97
107
  # skip_company - boolean - Skip validating company
@@ -102,6 +112,7 @@ module Files
102
112
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
103
113
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
104
114
  raise InvalidParameterError.new("Bad parameter: title must be an String") if params[:title] and !params[:title].is_a?(String)
115
+ raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
105
116
  raise InvalidParameterError.new("Bad parameter: form_fields must be an Array") if params[:form_fields] and !params[:form_fields].is_a?(Array)
106
117
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
107
118
 
@@ -171,6 +182,7 @@ module Files
171
182
  # Parameters:
172
183
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
173
184
  # title - string - Title to be displayed
185
+ # workspace_id - int64 - Workspace ID
174
186
  # skip_email - boolean - Skip validating form email
175
187
  # skip_name - boolean - Skip validating form name
176
188
  # skip_company - boolean - Skip validating company
@@ -178,6 +190,7 @@ module Files
178
190
  def self.create(params = {}, options = {})
179
191
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
180
192
  raise InvalidParameterError.new("Bad parameter: title must be an String") if params[:title] and !params[:title].is_a?(String)
193
+ raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
181
194
  raise InvalidParameterError.new("Bad parameter: form_fields must be an Array") if params[:form_fields] and !params[:form_fields].is_a?(Array)
182
195
 
183
196
  response, options = Api.send_request("/form_field_sets", :post, params, options)
@@ -186,6 +199,7 @@ module Files
186
199
 
187
200
  # Parameters:
188
201
  # title - string - Title to be displayed
202
+ # workspace_id - int64 - Workspace ID
189
203
  # skip_email - boolean - Skip validating form email
190
204
  # skip_name - boolean - Skip validating form name
191
205
  # skip_company - boolean - Skip validating company
@@ -195,6 +209,7 @@ module Files
195
209
  params[:id] = id
196
210
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
197
211
  raise InvalidParameterError.new("Bad parameter: title must be an String") if params[:title] and !params[:title].is_a?(String)
212
+ raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
198
213
  raise InvalidParameterError.new("Bad parameter: form_fields must be an Array") if params[:form_fields] and !params[:form_fields].is_a?(Array)
199
214
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
200
215
 
@@ -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.578"
4
+ VERSION = "1.1.580"
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: files.com
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.578
4
+ version: 1.1.580
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-03-19 00:00:00.000000000 Z
11
+ date: 2026-03-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable