files.com 1.1.431 → 1.1.432
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 +4 -4
- data/_VERSION +1 -1
- data/docs/automation.md +10 -2
- data/docs/automation_run.md +3 -1
- data/docs/behavior.md +3 -3
- data/docs/bundle.md +1 -1
- data/docs/gpg_key.md +14 -1
- data/docs/group.md +11 -3
- data/docs/remote_server.md +1 -1
- data/docs/remote_server_credential.md +10 -1
- data/docs/sync.md +14 -5
- data/docs/sync_run.md +4 -2
- data/docs/workspace.md +120 -0
- data/lib/files.com/models/automation.rb +17 -2
- data/lib/files.com/models/automation_run.rb +6 -1
- data/lib/files.com/models/behavior.rb +7 -8
- data/lib/files.com/models/bundle.rb +1 -1
- data/lib/files.com/models/gpg_key.rb +26 -1
- data/lib/files.com/models/group.rb +17 -2
- data/lib/files.com/models/remote_server.rb +1 -1
- data/lib/files.com/models/remote_server_credential.rb +18 -1
- data/lib/files.com/models/sync.rb +17 -2
- data/lib/files.com/models/sync_run.rb +7 -2
- data/lib/files.com/models/workspace.rb +144 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +1 -0
- metadata +3 -1
|
@@ -18,6 +18,15 @@ module Files
|
|
|
18
18
|
@attributes[:id] = value
|
|
19
19
|
end
|
|
20
20
|
|
|
21
|
+
# int64 - Workspace ID
|
|
22
|
+
def workspace_id
|
|
23
|
+
@attributes[:workspace_id]
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def workspace_id=(value)
|
|
27
|
+
@attributes[:workspace_id] = value
|
|
28
|
+
end
|
|
29
|
+
|
|
21
30
|
# boolean - Ordinarily, we will allow automation runs to run in parallel for non-scheduled automations. If this flag is `true` we will force automation runs to be serialized (run one at a time, one after another). This can resolve some issues with race conditions on remote systems at the cost of some performance.
|
|
22
31
|
def always_serialize_jobs
|
|
23
32
|
@attributes[:always_serialize_jobs]
|
|
@@ -413,6 +422,7 @@ module Files
|
|
|
413
422
|
# trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, archived_delete, copy
|
|
414
423
|
# value - object - A Hash of attributes specific to the automation type.
|
|
415
424
|
# recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
|
425
|
+
# workspace_id - int64 - Workspace ID
|
|
416
426
|
# automation - string - Automation type
|
|
417
427
|
def update(params = {})
|
|
418
428
|
params ||= {}
|
|
@@ -443,6 +453,7 @@ module Files
|
|
|
443
453
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
|
|
444
454
|
raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params[:trigger_actions] and !params[:trigger_actions].is_a?(Array)
|
|
445
455
|
raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
|
|
456
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
446
457
|
raise InvalidParameterError.new("Bad parameter: automation must be an String") if params[:automation] and !params[:automation].is_a?(String)
|
|
447
458
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
448
459
|
|
|
@@ -478,8 +489,8 @@ module Files
|
|
|
478
489
|
# Parameters:
|
|
479
490
|
# 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.
|
|
480
491
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
481
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `
|
|
482
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `last_modified_at` or `automation`. Valid field combinations are `[ disabled, last_modified_at ]`, `[ automation, disabled ]`, `[ automation, last_modified_at ]`
|
|
492
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name`, `automation`, `last_modified_at` or `disabled`.
|
|
493
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `last_modified_at`, `workspace_id` or `automation`. Valid field combinations are `[ disabled, last_modified_at ]`, `[ workspace_id, disabled ]`, `[ disabled, automation ]`, `[ workspace_id, last_modified_at ]`, `[ automation, last_modified_at ]`, `[ workspace_id, automation ]`, `[ workspace_id, disabled, last_modified_at ]`, `[ disabled, automation, last_modified_at ]`, `[ workspace_id, disabled, automation ]`, `[ workspace_id, automation, last_modified_at ]` or `[ workspace_id, disabled, automation, last_modified_at ]`.
|
|
483
494
|
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `last_modified_at`.
|
|
484
495
|
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `last_modified_at`.
|
|
485
496
|
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `last_modified_at`.
|
|
@@ -552,6 +563,7 @@ module Files
|
|
|
552
563
|
# trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, archived_delete, copy
|
|
553
564
|
# value - object - A Hash of attributes specific to the automation type.
|
|
554
565
|
# recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
|
566
|
+
# workspace_id - int64 - Workspace ID
|
|
555
567
|
# automation (required) - string - Automation type
|
|
556
568
|
def self.create(params = {}, options = {})
|
|
557
569
|
raise InvalidParameterError.new("Bad parameter: source must be an String") if params[:source] and !params[:source].is_a?(String)
|
|
@@ -579,6 +591,7 @@ module Files
|
|
|
579
591
|
raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params[:trigger_actions] and !params[:trigger_actions].is_a?(Array)
|
|
580
592
|
raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params[:value] and !params[:value].is_a?(Hash)
|
|
581
593
|
raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
|
|
594
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
582
595
|
raise InvalidParameterError.new("Bad parameter: automation must be an String") if params[:automation] and !params[:automation].is_a?(String)
|
|
583
596
|
raise MissingParameterError.new("Parameter missing: automation") unless params[:automation]
|
|
584
597
|
|
|
@@ -630,6 +643,7 @@ module Files
|
|
|
630
643
|
# trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, archived_delete, copy
|
|
631
644
|
# value - object - A Hash of attributes specific to the automation type.
|
|
632
645
|
# recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
|
646
|
+
# workspace_id - int64 - Workspace ID
|
|
633
647
|
# automation - string - Automation type
|
|
634
648
|
def self.update(id, params = {}, options = {})
|
|
635
649
|
params ||= {}
|
|
@@ -660,6 +674,7 @@ module Files
|
|
|
660
674
|
raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params[:trigger_actions] and !params[:trigger_actions].is_a?(Array)
|
|
661
675
|
raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params[:value] and !params[:value].is_a?(Hash)
|
|
662
676
|
raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
|
|
677
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
663
678
|
raise InvalidParameterError.new("Bad parameter: automation must be an String") if params[:automation] and !params[:automation].is_a?(String)
|
|
664
679
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
665
680
|
|
|
@@ -19,6 +19,11 @@ module Files
|
|
|
19
19
|
@attributes[:automation_id]
|
|
20
20
|
end
|
|
21
21
|
|
|
22
|
+
# int64 - Workspace ID.
|
|
23
|
+
def workspace_id
|
|
24
|
+
@attributes[:workspace_id]
|
|
25
|
+
end
|
|
26
|
+
|
|
22
27
|
# date-time - Automation run completion/failure date/time.
|
|
23
28
|
def completed_at
|
|
24
29
|
@attributes[:completed_at]
|
|
@@ -79,7 +84,7 @@ module Files
|
|
|
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
86
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation_id`, `created_at` or `status`.
|
|
82
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`
|
|
87
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ workspace_id, status ]`, `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
|
|
83
88
|
# automation_id (required) - int64 - ID of the associated Automation.
|
|
84
89
|
def self.list(params = {}, options = {})
|
|
85
90
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
@@ -109,7 +109,7 @@ module Files
|
|
|
109
109
|
end
|
|
110
110
|
|
|
111
111
|
# Parameters:
|
|
112
|
-
# value -
|
|
112
|
+
# value - object - This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior.
|
|
113
113
|
# attachment_file - file - Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
|
|
114
114
|
# disable_parent_folder_behavior - boolean - If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree.
|
|
115
115
|
# recursive - boolean - If `true`, behavior is treated as recursive, meaning that it impacts child folders as well.
|
|
@@ -121,7 +121,6 @@ module Files
|
|
|
121
121
|
params[:id] = @attributes[:id]
|
|
122
122
|
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
123
123
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
124
|
-
raise InvalidParameterError.new("Bad parameter: value must be an String") if params[:value] and !params[:value].is_a?(String)
|
|
125
124
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
126
125
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
127
126
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
@@ -214,7 +213,7 @@ module Files
|
|
|
214
213
|
end
|
|
215
214
|
|
|
216
215
|
# Parameters:
|
|
217
|
-
# value -
|
|
216
|
+
# value - object - This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior.
|
|
218
217
|
# attachment_file - file - Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
|
|
219
218
|
# disable_parent_folder_behavior - boolean - If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree.
|
|
220
219
|
# recursive - boolean - If `true`, behavior is treated as recursive, meaning that it impacts child folders as well.
|
|
@@ -223,7 +222,7 @@ module Files
|
|
|
223
222
|
# path (required) - string - Path where this behavior should apply.
|
|
224
223
|
# behavior (required) - string - Behavior type.
|
|
225
224
|
def self.create(params = {}, options = {})
|
|
226
|
-
raise InvalidParameterError.new("Bad parameter: value must be an
|
|
225
|
+
raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params[:value] and !params[:value].is_a?(Hash)
|
|
227
226
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
228
227
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
229
228
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
@@ -256,7 +255,7 @@ module Files
|
|
|
256
255
|
end
|
|
257
256
|
|
|
258
257
|
# Parameters:
|
|
259
|
-
# value -
|
|
258
|
+
# value - object - This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior.
|
|
260
259
|
# attachment_file - file - Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
|
|
261
260
|
# disable_parent_folder_behavior - boolean - If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree.
|
|
262
261
|
# recursive - boolean - If `true`, behavior is treated as recursive, meaning that it impacts child folders as well.
|
|
@@ -266,11 +265,11 @@ module Files
|
|
|
266
265
|
def self.update(id, params = {}, options = {})
|
|
267
266
|
params ||= {}
|
|
268
267
|
params[:id] = id
|
|
269
|
-
raise InvalidParameterError.new("Bad parameter: id must be one of String, Integer
|
|
270
|
-
raise InvalidParameterError.new("Bad parameter: value must be an
|
|
268
|
+
raise InvalidParameterError.new("Bad parameter: id must be one of Hash, String, Integer") if params[:id] and [ Hash, String, Integer ].none? { |klass| params[:id].is_a?(klass) }
|
|
269
|
+
raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params[:value] and !params[:value].is_a?(Hash)
|
|
271
270
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
272
271
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
273
|
-
raise InvalidParameterError.new("Bad parameter: attachment_delete must be one of String, Integer
|
|
272
|
+
raise InvalidParameterError.new("Bad parameter: attachment_delete must be one of Hash, String, Integer") if params[:attachment_delete] and [ Hash, String, Integer ].none? { |klass| params[:attachment_delete].is_a?(klass) }
|
|
274
273
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
275
274
|
|
|
276
275
|
response, options = Api.send_request("/behaviors/#{params[:id]}", :patch, params, options)
|
|
@@ -521,7 +521,7 @@ module Files
|
|
|
521
521
|
# 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.
|
|
522
522
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
523
523
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
|
|
524
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id,
|
|
524
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, expires_at ]`.
|
|
525
525
|
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_at`.
|
|
526
526
|
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
|
|
527
527
|
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.
|
|
@@ -18,6 +18,15 @@ module Files
|
|
|
18
18
|
@attributes[:id] = value
|
|
19
19
|
end
|
|
20
20
|
|
|
21
|
+
# int64 - Workspace ID (0 for default workspace).
|
|
22
|
+
def workspace_id
|
|
23
|
+
@attributes[:workspace_id]
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def workspace_id=(value)
|
|
27
|
+
@attributes[:workspace_id] = value
|
|
28
|
+
end
|
|
29
|
+
|
|
21
30
|
# date-time - GPG key expiration date.
|
|
22
31
|
def expires_at
|
|
23
32
|
@attributes[:expires_at]
|
|
@@ -173,6 +182,7 @@ module Files
|
|
|
173
182
|
|
|
174
183
|
# Parameters:
|
|
175
184
|
# partner_id - int64 - Partner ID who owns this GPG Key, if applicable.
|
|
185
|
+
# workspace_id - int64 - Workspace ID (0 for default workspace).
|
|
176
186
|
# public_key - string - The GPG public key
|
|
177
187
|
# private_key - string - The GPG private key
|
|
178
188
|
# private_key_password - string - The GPG private key password
|
|
@@ -183,6 +193,7 @@ module Files
|
|
|
183
193
|
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
184
194
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
185
195
|
raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
|
|
196
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
186
197
|
raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params[:public_key] and !params[:public_key].is_a?(String)
|
|
187
198
|
raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
|
|
188
199
|
raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
|
|
@@ -222,12 +233,22 @@ module Files
|
|
|
222
233
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
223
234
|
# 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.
|
|
224
235
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
225
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`
|
|
236
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name` or `expires_at`.
|
|
237
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`, `partner_id` or `expires_at`. Valid field combinations are `[ workspace_id, expires_at ]`.
|
|
238
|
+
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
|
|
239
|
+
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `expires_at`.
|
|
240
|
+
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `expires_at`.
|
|
241
|
+
# filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `expires_at`.
|
|
226
242
|
def self.list(params = {}, options = {})
|
|
227
243
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
228
244
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
229
245
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
230
246
|
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
247
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
248
|
+
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
|
|
249
|
+
raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
|
|
250
|
+
raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
|
|
251
|
+
raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
|
|
231
252
|
|
|
232
253
|
List.new(GpgKey, params) do
|
|
233
254
|
Api.send_request("/gpg_keys", :get, params, options)
|
|
@@ -257,6 +278,7 @@ module Files
|
|
|
257
278
|
# Parameters:
|
|
258
279
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
259
280
|
# partner_id - int64 - Partner ID who owns this GPG Key, if applicable.
|
|
281
|
+
# workspace_id - int64 - Workspace ID (0 for default workspace).
|
|
260
282
|
# public_key - string - The GPG public key
|
|
261
283
|
# private_key - string - The GPG private key
|
|
262
284
|
# private_key_password - string - The GPG private key password
|
|
@@ -268,6 +290,7 @@ module Files
|
|
|
268
290
|
def self.create(params = {}, options = {})
|
|
269
291
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
270
292
|
raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
|
|
293
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
271
294
|
raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params[:public_key] and !params[:public_key].is_a?(String)
|
|
272
295
|
raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
|
|
273
296
|
raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
|
|
@@ -283,6 +306,7 @@ module Files
|
|
|
283
306
|
|
|
284
307
|
# Parameters:
|
|
285
308
|
# partner_id - int64 - Partner ID who owns this GPG Key, if applicable.
|
|
309
|
+
# workspace_id - int64 - Workspace ID (0 for default workspace).
|
|
286
310
|
# public_key - string - The GPG public key
|
|
287
311
|
# private_key - string - The GPG private key
|
|
288
312
|
# private_key_password - string - The GPG private key password
|
|
@@ -292,6 +316,7 @@ module Files
|
|
|
292
316
|
params[:id] = id
|
|
293
317
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
294
318
|
raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
|
|
319
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
295
320
|
raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params[:public_key] and !params[:public_key].is_a?(String)
|
|
296
321
|
raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
|
|
297
322
|
raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
|
|
@@ -117,10 +117,20 @@ module Files
|
|
|
117
117
|
@attributes[:site_id] = value
|
|
118
118
|
end
|
|
119
119
|
|
|
120
|
+
# int64 - Workspace ID
|
|
121
|
+
def workspace_id
|
|
122
|
+
@attributes[:workspace_id]
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
def workspace_id=(value)
|
|
126
|
+
@attributes[:workspace_id] = value
|
|
127
|
+
end
|
|
128
|
+
|
|
120
129
|
# Parameters:
|
|
121
130
|
# notes - string - Group notes.
|
|
122
131
|
# user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
|
|
123
132
|
# admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
|
|
133
|
+
# workspace_id - int64 - Workspace ID
|
|
124
134
|
# ftp_permission - boolean - If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
|
|
125
135
|
# sftp_permission - boolean - If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
|
|
126
136
|
# dav_permission - boolean - If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
|
|
@@ -135,6 +145,7 @@ module Files
|
|
|
135
145
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
136
146
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
|
|
137
147
|
raise InvalidParameterError.new("Bad parameter: admin_ids must be an String") if params[:admin_ids] and !params[:admin_ids].is_a?(String)
|
|
148
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
138
149
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
|
|
139
150
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
140
151
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
@@ -171,8 +182,8 @@ module Files
|
|
|
171
182
|
# Parameters:
|
|
172
183
|
# 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.
|
|
173
184
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
174
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`
|
|
175
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
|
|
185
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `workspace_id` or `name`.
|
|
186
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `workspace_id`. Valid field combinations are `[ workspace_id, name ]`.
|
|
176
187
|
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
|
|
177
188
|
# ids - string - Comma-separated list of group ids to include in results.
|
|
178
189
|
# include_parent_site_groups - boolean - Include groups from the parent site.
|
|
@@ -213,6 +224,7 @@ module Files
|
|
|
213
224
|
# notes - string - Group notes.
|
|
214
225
|
# user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
|
|
215
226
|
# admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
|
|
227
|
+
# workspace_id - int64 - Workspace ID
|
|
216
228
|
# ftp_permission - boolean - If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
|
|
217
229
|
# sftp_permission - boolean - If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
|
|
218
230
|
# dav_permission - boolean - If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
|
|
@@ -223,6 +235,7 @@ module Files
|
|
|
223
235
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
224
236
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
|
|
225
237
|
raise InvalidParameterError.new("Bad parameter: admin_ids must be an String") if params[:admin_ids] and !params[:admin_ids].is_a?(String)
|
|
238
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
226
239
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
|
|
227
240
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
228
241
|
raise MissingParameterError.new("Parameter missing: name") unless params[:name]
|
|
@@ -235,6 +248,7 @@ module Files
|
|
|
235
248
|
# notes - string - Group notes.
|
|
236
249
|
# user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
|
|
237
250
|
# admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
|
|
251
|
+
# workspace_id - int64 - Workspace ID
|
|
238
252
|
# ftp_permission - boolean - If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
|
|
239
253
|
# sftp_permission - boolean - If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
|
|
240
254
|
# dav_permission - boolean - If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
|
|
@@ -248,6 +262,7 @@ module Files
|
|
|
248
262
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
249
263
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
|
|
250
264
|
raise InvalidParameterError.new("Bad parameter: admin_ids must be an String") if params[:admin_ids] and !params[:admin_ids].is_a?(String)
|
|
265
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
251
266
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
|
|
252
267
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
253
268
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
@@ -949,7 +949,7 @@ module Files
|
|
|
949
949
|
# 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.
|
|
950
950
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
951
951
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`.
|
|
952
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ server_type, name ]`, `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[
|
|
952
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `workspace_id`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ server_type, name ]`, `[ workspace_id, name ]`, `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]`, `[ linode_bucket, name ]`, `[ workspace_id, server_type ]` or `[ workspace_id, server_type, name ]`.
|
|
953
953
|
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
|
|
954
954
|
def self.list(params = {}, options = {})
|
|
955
955
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
@@ -18,6 +18,15 @@ module Files
|
|
|
18
18
|
@attributes[:id] = value
|
|
19
19
|
end
|
|
20
20
|
|
|
21
|
+
# int64 - Workspace ID (0 for default workspace)
|
|
22
|
+
def workspace_id
|
|
23
|
+
@attributes[:workspace_id]
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def workspace_id=(value)
|
|
27
|
+
@attributes[:workspace_id] = value
|
|
28
|
+
end
|
|
29
|
+
|
|
21
30
|
# string - Internal name for your reference
|
|
22
31
|
def name
|
|
23
32
|
@attributes[:name]
|
|
@@ -289,6 +298,7 @@ module Files
|
|
|
289
298
|
end
|
|
290
299
|
|
|
291
300
|
# Parameters:
|
|
301
|
+
# workspace_id - int64 - Workspace ID (0 for default workspace)
|
|
292
302
|
# name - string - Internal name for your reference
|
|
293
303
|
# description - string - Internal description for your reference
|
|
294
304
|
# server_type - string - Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
@@ -324,6 +334,7 @@ module Files
|
|
|
324
334
|
params[:id] = @attributes[:id]
|
|
325
335
|
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
326
336
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
337
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
327
338
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
328
339
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
329
340
|
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params[:server_type] and !params[:server_type].is_a?(String)
|
|
@@ -388,11 +399,13 @@ module Files
|
|
|
388
399
|
# Parameters:
|
|
389
400
|
# 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.
|
|
390
401
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
391
|
-
#
|
|
402
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `id`.
|
|
403
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id` and `name`. Valid field combinations are `[ workspace_id, name ]`.
|
|
392
404
|
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
|
|
393
405
|
def self.list(params = {}, options = {})
|
|
394
406
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
395
407
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
408
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
396
409
|
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
397
410
|
raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
|
|
398
411
|
|
|
@@ -422,6 +435,7 @@ module Files
|
|
|
422
435
|
end
|
|
423
436
|
|
|
424
437
|
# Parameters:
|
|
438
|
+
# workspace_id - int64 - Workspace ID (0 for default workspace)
|
|
425
439
|
# name - string - Internal name for your reference
|
|
426
440
|
# description - string - Internal description for your reference
|
|
427
441
|
# server_type - string - Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
@@ -453,6 +467,7 @@ module Files
|
|
|
453
467
|
# s3_compatible_secret_key - string - S3-compatible: Secret Key
|
|
454
468
|
# wasabi_secret_key - string - Wasabi: Secret Key
|
|
455
469
|
def self.create(params = {}, options = {})
|
|
470
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
456
471
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
457
472
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
458
473
|
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params[:server_type] and !params[:server_type].is_a?(String)
|
|
@@ -489,6 +504,7 @@ module Files
|
|
|
489
504
|
end
|
|
490
505
|
|
|
491
506
|
# Parameters:
|
|
507
|
+
# workspace_id - int64 - Workspace ID (0 for default workspace)
|
|
492
508
|
# name - string - Internal name for your reference
|
|
493
509
|
# description - string - Internal description for your reference
|
|
494
510
|
# server_type - string - Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
@@ -523,6 +539,7 @@ module Files
|
|
|
523
539
|
params ||= {}
|
|
524
540
|
params[:id] = id
|
|
525
541
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
542
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
526
543
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
527
544
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
528
545
|
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params[:server_type] and !params[:server_type].is_a?(String)
|
|
@@ -45,6 +45,15 @@ module Files
|
|
|
45
45
|
@attributes[:site_id] = value
|
|
46
46
|
end
|
|
47
47
|
|
|
48
|
+
# int64 - Workspace ID this sync belongs to
|
|
49
|
+
def workspace_id
|
|
50
|
+
@attributes[:workspace_id]
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
def workspace_id=(value)
|
|
54
|
+
@attributes[:workspace_id] = value
|
|
55
|
+
end
|
|
56
|
+
|
|
48
57
|
# int64 - User who created or owns this sync
|
|
49
58
|
def user_id
|
|
50
59
|
@attributes[:user_id]
|
|
@@ -285,6 +294,7 @@ module Files
|
|
|
285
294
|
# schedule_time_zone - string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
|
|
286
295
|
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
|
287
296
|
# schedule_times_of_day - array(string) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
|
297
|
+
# workspace_id - int64 - Workspace ID this sync belongs to
|
|
288
298
|
def update(params = {})
|
|
289
299
|
params ||= {}
|
|
290
300
|
params[:id] = @attributes[:id]
|
|
@@ -305,6 +315,7 @@ module Files
|
|
|
305
315
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
|
306
316
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
|
307
317
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
318
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
308
319
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
309
320
|
|
|
310
321
|
Api.send_request("/syncs/#{@attributes[:id]}", :patch, params, @options)
|
|
@@ -339,8 +350,8 @@ module Files
|
|
|
339
350
|
# Parameters:
|
|
340
351
|
# 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.
|
|
341
352
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
342
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`.
|
|
343
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `src_remote_server_id`
|
|
353
|
+
# 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`.
|
|
354
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`, `disabled`, `src_remote_server_id` or `dest_remote_server_id`. Valid field combinations are `[ workspace_id, disabled ]`, `[ workspace_id, src_remote_server_id ]`, `[ workspace_id, dest_remote_server_id ]`, `[ disabled, src_remote_server_id ]`, `[ disabled, dest_remote_server_id ]`, `[ workspace_id, disabled, src_remote_server_id ]` or `[ workspace_id, disabled, dest_remote_server_id ]`.
|
|
344
355
|
def self.list(params = {}, options = {})
|
|
345
356
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
346
357
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
@@ -391,6 +402,7 @@ module Files
|
|
|
391
402
|
# schedule_time_zone - string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
|
|
392
403
|
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
|
393
404
|
# schedule_times_of_day - array(string) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
|
405
|
+
# workspace_id - int64 - Workspace ID this sync belongs to
|
|
394
406
|
def self.create(params = {}, options = {})
|
|
395
407
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
396
408
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
@@ -407,6 +419,7 @@ module Files
|
|
|
407
419
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
|
408
420
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
|
409
421
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
422
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
410
423
|
|
|
411
424
|
response, options = Api.send_request("/syncs", :post, params, options)
|
|
412
425
|
Sync.new(response.data, options)
|
|
@@ -453,6 +466,7 @@ module Files
|
|
|
453
466
|
# schedule_time_zone - string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
|
|
454
467
|
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
|
455
468
|
# schedule_times_of_day - array(string) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
|
469
|
+
# workspace_id - int64 - Workspace ID this sync belongs to
|
|
456
470
|
def self.update(id, params = {}, options = {})
|
|
457
471
|
params ||= {}
|
|
458
472
|
params[:id] = id
|
|
@@ -472,6 +486,7 @@ module Files
|
|
|
472
486
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
|
473
487
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
|
474
488
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
489
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
475
490
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
476
491
|
|
|
477
492
|
response, options = Api.send_request("/syncs/#{params[:id]}", :patch, params, options)
|
|
@@ -84,6 +84,11 @@ module Files
|
|
|
84
84
|
@attributes[:site_id]
|
|
85
85
|
end
|
|
86
86
|
|
|
87
|
+
# int64 - Workspace ID
|
|
88
|
+
def workspace_id
|
|
89
|
+
@attributes[:workspace_id]
|
|
90
|
+
end
|
|
91
|
+
|
|
87
92
|
# string - Source remote server type, if any
|
|
88
93
|
def src_remote_server_type
|
|
89
94
|
@attributes[:src_remote_server_type]
|
|
@@ -118,8 +123,8 @@ module Files
|
|
|
118
123
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
119
124
|
# 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.
|
|
120
125
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
121
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `sync_id`, `created_at` or `status`.
|
|
122
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `status`, `dry_run`, `src_remote_server_type`, `dest_remote_server_type` or `sync_id`. Valid field combinations are `[ status, created_at ]`, `[ src_remote_server_type, created_at ]`, `[ dest_remote_server_type, created_at ]`, `[ sync_id, created_at ]`, `[ src_remote_server_type, status ]`, `[ dest_remote_server_type, status ]`, `[ sync_id, status ]`, `[ src_remote_server_type, status, created_at ]`, `[ dest_remote_server_type, status, created_at ]` or `[ sync_id, status, created_at ]`.
|
|
126
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `workspace_id`, `sync_id`, `created_at` or `status`.
|
|
127
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `status`, `dry_run`, `workspace_id`, `src_remote_server_type`, `dest_remote_server_type` or `sync_id`. Valid field combinations are `[ status, created_at ]`, `[ workspace_id, created_at ]`, `[ src_remote_server_type, created_at ]`, `[ dest_remote_server_type, created_at ]`, `[ sync_id, created_at ]`, `[ workspace_id, status ]`, `[ src_remote_server_type, status ]`, `[ dest_remote_server_type, status ]`, `[ sync_id, status ]`, `[ workspace_id, src_remote_server_type ]`, `[ workspace_id, dest_remote_server_type ]`, `[ workspace_id, sync_id ]`, `[ workspace_id, status, created_at ]`, `[ src_remote_server_type, status, created_at ]`, `[ dest_remote_server_type, status, created_at ]`, `[ sync_id, status, created_at ]`, `[ workspace_id, src_remote_server_type, created_at ]`, `[ workspace_id, dest_remote_server_type, created_at ]`, `[ workspace_id, sync_id, created_at ]`, `[ workspace_id, src_remote_server_type, status ]`, `[ workspace_id, dest_remote_server_type, status ]`, `[ workspace_id, sync_id, status ]`, `[ workspace_id, src_remote_server_type, status, created_at ]`, `[ workspace_id, dest_remote_server_type, status, created_at ]` or `[ workspace_id, sync_id, status, created_at ]`.
|
|
123
128
|
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
124
129
|
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
125
130
|
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|