files.com 1.0.327 → 1.0.329

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/action_notification_export_result.md +1 -1
  4. data/docs/api_key.md +2 -2
  5. data/docs/app.md +2 -2
  6. data/docs/as2_incoming_message.md +2 -2
  7. data/docs/as2_outgoing_message.md +2 -2
  8. data/docs/as2_partner.md +12 -4
  9. data/docs/as2_station.md +1 -1
  10. data/docs/automation.md +13 -2
  11. data/docs/automation_run.md +2 -2
  12. data/docs/bandwidth_snapshot.md +2 -2
  13. data/docs/behavior.md +4 -4
  14. data/docs/bundle.md +2 -2
  15. data/docs/bundle_download.md +2 -2
  16. data/docs/bundle_notification.md +1 -1
  17. data/docs/bundle_recipient.md +2 -2
  18. data/docs/bundle_registration.md +1 -1
  19. data/docs/clickwrap.md +1 -1
  20. data/docs/dns_record.md +1 -1
  21. data/docs/external_event.md +2 -2
  22. data/docs/file_comment.md +1 -1
  23. data/docs/form_field_set.md +1 -1
  24. data/docs/group.md +2 -2
  25. data/docs/group_user.md +1 -1
  26. data/docs/history.md +10 -10
  27. data/docs/history_export_result.md +1 -1
  28. data/docs/inbox_recipient.md +2 -2
  29. data/docs/inbox_registration.md +1 -1
  30. data/docs/inbox_upload.md +2 -2
  31. data/docs/invoice.md +1 -1
  32. data/docs/ip_address.md +3 -3
  33. data/docs/lock.md +1 -1
  34. data/docs/message.md +1 -1
  35. data/docs/message_comment.md +1 -1
  36. data/docs/message_comment_reaction.md +1 -1
  37. data/docs/message_reaction.md +1 -1
  38. data/docs/notification.md +2 -2
  39. data/docs/payment.md +1 -1
  40. data/docs/permission.md +2 -2
  41. data/docs/priority.md +1 -1
  42. data/docs/project.md +1 -1
  43. data/docs/public_key.md +1 -1
  44. data/docs/remote_bandwidth_snapshot.md +2 -2
  45. data/docs/remote_server.md +1 -1
  46. data/docs/request.md +4 -4
  47. data/docs/settings_change.md +2 -2
  48. data/docs/sftp_host_key.md +1 -1
  49. data/docs/sso_strategy.md +1 -1
  50. data/docs/usage_daily_snapshot.md +2 -2
  51. data/docs/usage_snapshot.md +1 -1
  52. data/docs/user.md +2 -2
  53. data/docs/user_cipher_use.md +1 -1
  54. data/docs/user_request.md +1 -1
  55. data/lib/files.com/models/action_notification_export_result.rb +1 -1
  56. data/lib/files.com/models/api_key.rb +2 -2
  57. data/lib/files.com/models/app.rb +2 -2
  58. data/lib/files.com/models/as2_incoming_message.rb +2 -2
  59. data/lib/files.com/models/as2_outgoing_message.rb +2 -2
  60. data/lib/files.com/models/as2_partner.rb +13 -1
  61. data/lib/files.com/models/as2_station.rb +1 -1
  62. data/lib/files.com/models/automation.rb +17 -2
  63. data/lib/files.com/models/automation_run.rb +2 -2
  64. data/lib/files.com/models/bandwidth_snapshot.rb +2 -2
  65. data/lib/files.com/models/behavior.rb +4 -4
  66. data/lib/files.com/models/bundle.rb +2 -2
  67. data/lib/files.com/models/bundle_download.rb +2 -2
  68. data/lib/files.com/models/bundle_notification.rb +1 -1
  69. data/lib/files.com/models/bundle_recipient.rb +2 -2
  70. data/lib/files.com/models/bundle_registration.rb +1 -1
  71. data/lib/files.com/models/clickwrap.rb +1 -1
  72. data/lib/files.com/models/dns_record.rb +1 -1
  73. data/lib/files.com/models/external_event.rb +2 -2
  74. data/lib/files.com/models/file_comment.rb +1 -1
  75. data/lib/files.com/models/form_field_set.rb +1 -1
  76. data/lib/files.com/models/group.rb +2 -2
  77. data/lib/files.com/models/group_user.rb +1 -1
  78. data/lib/files.com/models/history.rb +10 -10
  79. data/lib/files.com/models/history_export_result.rb +1 -1
  80. data/lib/files.com/models/inbox_recipient.rb +2 -2
  81. data/lib/files.com/models/inbox_registration.rb +1 -1
  82. data/lib/files.com/models/inbox_upload.rb +2 -2
  83. data/lib/files.com/models/invoice.rb +1 -1
  84. data/lib/files.com/models/ip_address.rb +3 -3
  85. data/lib/files.com/models/lock.rb +1 -1
  86. data/lib/files.com/models/message.rb +1 -1
  87. data/lib/files.com/models/message_comment.rb +1 -1
  88. data/lib/files.com/models/message_comment_reaction.rb +1 -1
  89. data/lib/files.com/models/message_reaction.rb +1 -1
  90. data/lib/files.com/models/notification.rb +2 -2
  91. data/lib/files.com/models/payment.rb +1 -1
  92. data/lib/files.com/models/permission.rb +2 -2
  93. data/lib/files.com/models/priority.rb +1 -1
  94. data/lib/files.com/models/project.rb +1 -1
  95. data/lib/files.com/models/public_key.rb +1 -1
  96. data/lib/files.com/models/remote_bandwidth_snapshot.rb +2 -2
  97. data/lib/files.com/models/remote_server.rb +1 -1
  98. data/lib/files.com/models/request.rb +4 -4
  99. data/lib/files.com/models/settings_change.rb +2 -2
  100. data/lib/files.com/models/sftp_host_key.rb +1 -1
  101. data/lib/files.com/models/sso_strategy.rb +1 -1
  102. data/lib/files.com/models/usage_daily_snapshot.rb +2 -2
  103. data/lib/files.com/models/usage_snapshot.rb +1 -1
  104. data/lib/files.com/models/user.rb +2 -2
  105. data/lib/files.com/models/user_cipher_use.rb +1 -1
  106. data/lib/files.com/models/user_request.rb +1 -1
  107. metadata +2 -2
data/docs/inbox_upload.md CHANGED
@@ -29,9 +29,9 @@ Files::InboxUpload.list(
29
29
 
30
30
  ### Parameters
31
31
 
32
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
32
+ * `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.
33
33
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
34
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at`.
34
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at`.
35
35
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
36
36
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
37
37
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
data/docs/invoice.md CHANGED
@@ -53,7 +53,7 @@ Files::Invoice.list(
53
53
 
54
54
  ### Parameters
55
55
 
56
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
56
+ * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
57
57
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
58
58
 
59
59
 
data/docs/ip_address.md CHANGED
@@ -31,7 +31,7 @@ Files::IpAddress.list(
31
31
 
32
32
  ### Parameters
33
33
 
34
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
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.
35
35
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
36
36
 
37
37
 
@@ -47,7 +47,7 @@ Files::IpAddress.get_exavault_reserved(
47
47
 
48
48
  ### Parameters
49
49
 
50
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
50
+ * `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
51
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
52
52
 
53
53
 
@@ -63,5 +63,5 @@ Files::IpAddress.get_reserved(
63
63
 
64
64
  ### Parameters
65
65
 
66
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
66
+ * `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
67
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
data/docs/lock.md CHANGED
@@ -46,7 +46,7 @@ Files::Lock.list_for(path,
46
46
 
47
47
  ### Parameters
48
48
 
49
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
49
+ * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
50
50
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
51
51
  * `path` (string): Required - Path to operate on.
52
52
  * `include_children` (boolean): Include locks from children objects?
data/docs/message.md CHANGED
@@ -36,7 +36,7 @@ Files::Message.list(
36
36
  ### Parameters
37
37
 
38
38
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
39
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
39
+ * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
40
40
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
41
41
  * `project_id` (int64): Required - Project for which to return messages.
42
42
 
@@ -33,7 +33,7 @@ Files::MessageComment.list(
33
33
  ### Parameters
34
34
 
35
35
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
36
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
36
+ * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
37
37
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
38
38
  * `message_id` (int64): Required - Message comment to return comments for.
39
39
 
@@ -29,7 +29,7 @@ Files::MessageCommentReaction.list(
29
29
  ### Parameters
30
30
 
31
31
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
32
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
32
+ * `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.
33
33
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
34
34
  * `message_comment_id` (int64): Required - Message comment to return reactions for.
35
35
 
@@ -29,7 +29,7 @@ Files::MessageReaction.list(
29
29
  ### Parameters
30
30
 
31
31
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
32
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
32
+ * `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.
33
33
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
34
34
  * `message_id` (int64): Required - Message to return reactions for.
35
35
 
data/docs/notification.md CHANGED
@@ -76,9 +76,9 @@ Files::Notification.list(
76
76
  ### Parameters
77
77
 
78
78
  * `user_id` (int64): DEPRECATED: Show notifications for this User ID. Use `filter[user_id]` instead.
79
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
79
+ * `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
80
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
81
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `path`, `user_id` or `group_id`.
81
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[path]=desc`). Valid fields are `path`, `user_id` or `group_id`.
82
82
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
83
83
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `user_id`, `group_id` or `path`.
84
84
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
data/docs/payment.md CHANGED
@@ -53,7 +53,7 @@ Files::Payment.list(
53
53
 
54
54
  ### Parameters
55
55
 
56
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
56
+ * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
57
57
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
58
58
 
59
59
 
data/docs/permission.md CHANGED
@@ -41,9 +41,9 @@ Files::Permission.list(
41
41
 
42
42
  ### Parameters
43
43
 
44
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
44
+ * `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.
45
45
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
46
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `group_id`, `path`, `user_id` or `permission`.
46
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[group_id]=desc`). Valid fields are `group_id`, `path`, `user_id` or `permission`.
47
47
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
48
48
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
49
49
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
data/docs/priority.md CHANGED
@@ -25,6 +25,6 @@ Files::Priority.list(path,
25
25
 
26
26
  ### Parameters
27
27
 
28
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
28
+ * `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.
29
29
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
30
30
  * `path` (string): Required - The path to query for priorities
data/docs/project.md CHANGED
@@ -25,7 +25,7 @@ Files::Project.list(
25
25
 
26
26
  ### Parameters
27
27
 
28
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
28
+ * `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.
29
29
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
30
30
 
31
31
 
data/docs/public_key.md CHANGED
@@ -33,7 +33,7 @@ Files::PublicKey.list(
33
33
  ### Parameters
34
34
 
35
35
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
36
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
36
+ * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
37
37
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
38
38
 
39
39
 
@@ -31,9 +31,9 @@ Files::RemoteBandwidthSnapshot.list(
31
31
 
32
32
  ### Parameters
33
33
 
34
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
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.
35
35
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
36
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `logged_at`.
36
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[logged_at]=desc`). Valid fields are `logged_at`.
37
37
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
38
38
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
39
39
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `logged_at`.
@@ -132,7 +132,7 @@ Files::RemoteServer.list(
132
132
 
133
133
  ### Parameters
134
134
 
135
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
135
+ * `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.
136
136
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
137
137
 
138
138
 
data/docs/request.md CHANGED
@@ -37,9 +37,9 @@ Files::Request.list(
37
37
 
38
38
  ### Parameters
39
39
 
40
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
40
+ * `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.
41
41
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
42
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `destination`.
42
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[destination]=desc`). Valid fields are `destination`.
43
43
  * `mine` (boolean): Only show requests of the current user? (Defaults to true if current user is not a site admin.)
44
44
  * `path` (string): Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
45
45
 
@@ -57,9 +57,9 @@ Files::Request.get_folder(path,
57
57
 
58
58
  ### Parameters
59
59
 
60
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
60
+ * `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.
61
61
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
62
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `destination`.
62
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[destination]=desc`). Valid fields are `destination`.
63
63
  * `mine` (boolean): Only show requests of the current user? (Defaults to true if current user is not a site admin.)
64
64
  * `path` (string): Required - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
65
65
 
@@ -33,9 +33,9 @@ Files::SettingsChange.list(
33
33
 
34
34
  ### Parameters
35
35
 
36
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
36
+ * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
37
37
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
38
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `api_key_id`, `created_at` or `user_id`.
38
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[api_key_id]=desc`). Valid fields are `api_key_id`, `created_at` or `user_id`.
39
39
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
40
40
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `api_key_id` and `user_id`.
41
41
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
@@ -30,7 +30,7 @@ Files::SftpHostKey.list(
30
30
 
31
31
  ### Parameters
32
32
 
33
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
33
+ * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
34
34
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
35
35
 
36
36
 
data/docs/sso_strategy.md CHANGED
@@ -107,7 +107,7 @@ Files::SsoStrategy.list(
107
107
 
108
108
  ### Parameters
109
109
 
110
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
110
+ * `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.
111
111
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
112
112
 
113
113
 
@@ -45,9 +45,9 @@ Files::UsageDailySnapshot.list(
45
45
 
46
46
  ### Parameters
47
47
 
48
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
48
+ * `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.
49
49
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
50
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `date` and `usage_snapshot_id`.
50
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[date]=desc`). Valid fields are `date` and `usage_snapshot_id`.
51
51
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
52
52
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
53
53
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
@@ -53,5 +53,5 @@ Files::UsageSnapshot.list(
53
53
 
54
54
  ### Parameters
55
55
 
56
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
56
+ * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
57
57
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
data/docs/user.md CHANGED
@@ -151,9 +151,9 @@ Files::User.list(
151
151
 
152
152
  ### Parameters
153
153
 
154
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
154
+ * `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.
155
155
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
156
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `authenticate_until`, `active`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `company`, `name`, `site_admin`, `receive_admin_alerts`, `password_validity_days`, `ssl_required` or `not_site_admin`.
156
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[authenticate_until]=desc`). Valid fields are `authenticate_until`, `active`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `company`, `name`, `site_admin`, `receive_admin_alerts`, `password_validity_days`, `ssl_required` or `not_site_admin`.
157
157
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
158
158
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
159
159
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
@@ -35,5 +35,5 @@ Files::UserCipherUse.list(
35
35
  ### Parameters
36
36
 
37
37
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
38
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
38
+ * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
39
39
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
data/docs/user_request.md CHANGED
@@ -29,7 +29,7 @@ Files::UserRequest.list(
29
29
 
30
30
  ### Parameters
31
31
 
32
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
32
+ * `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.
33
33
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
34
34
 
35
35
 
@@ -61,7 +61,7 @@ module Files
61
61
 
62
62
  # Parameters:
63
63
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
64
- # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
64
+ # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
65
65
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
66
66
  # action_notification_export_id (required) - int64 - ID of the associated action notification export.
67
67
  def self.list(params = {}, options = {})
@@ -166,9 +166,9 @@ module Files
166
166
 
167
167
  # Parameters:
168
168
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
169
- # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
169
+ # 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.
170
170
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
171
- # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `expires_at`.
171
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[expires_at]=desc`). Valid fields are `expires_at`.
172
172
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
173
173
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
174
174
  # filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `expires_at`.
@@ -90,9 +90,9 @@ module Files
90
90
  end
91
91
 
92
92
  # Parameters:
93
- # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
93
+ # 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.
94
94
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
95
- # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `name` and `app_type`.
95
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[name]=desc`). Valid fields are `name` and `app_type`.
96
96
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
97
97
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
98
98
  # filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
@@ -185,9 +185,9 @@ module Files
185
185
  end
186
186
 
187
187
  # Parameters:
188
- # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
188
+ # 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.
189
189
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
190
- # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at` and `as2_partner_id`.
190
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `as2_partner_id`.
191
191
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
192
192
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
193
193
  # filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
@@ -165,9 +165,9 @@ module Files
165
165
  end
166
166
 
167
167
  # Parameters:
168
- # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
168
+ # 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.
169
169
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
170
- # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at` and `as2_partner_id`.
170
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `as2_partner_id`.
171
171
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
172
172
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
173
173
  # filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
@@ -54,6 +54,15 @@ module Files
54
54
  @attributes[:server_certificate] = value
55
55
  end
56
56
 
57
+ # boolean - `true` if remote server only accepts connections from dedicated IPs
58
+ def enable_dedicated_ips
59
+ @attributes[:enable_dedicated_ips]
60
+ end
61
+
62
+ def enable_dedicated_ips=(value)
63
+ @attributes[:enable_dedicated_ips] = value
64
+ end
65
+
57
66
  # string - Serial of public certificate used for message security in hex format.
58
67
  def hex_public_certificate_serial
59
68
  @attributes[:hex_public_certificate_serial]
@@ -131,6 +140,7 @@ module Files
131
140
  # uri - string - URL base for AS2 responses
132
141
  # server_certificate - string - Remote server certificate security setting
133
142
  # public_certificate - string
143
+ # enable_dedicated_ips - boolean
134
144
  def update(params = {})
135
145
  params ||= {}
136
146
  params[:id] = @attributes[:id]
@@ -169,7 +179,7 @@ module Files
169
179
  end
170
180
 
171
181
  # Parameters:
172
- # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
182
+ # 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
183
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
174
184
  def self.list(params = {}, options = {})
175
185
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
@@ -206,6 +216,7 @@ module Files
206
216
  # public_certificate (required) - string
207
217
  # as2_station_id (required) - int64 - Id of As2Station for this partner
208
218
  # server_certificate - string - Remote server certificate security setting
219
+ # enable_dedicated_ips - boolean
209
220
  def self.create(params = {}, options = {})
210
221
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
211
222
  raise InvalidParameterError.new("Bad parameter: uri must be an String") if params[:uri] and !params[:uri].is_a?(String)
@@ -226,6 +237,7 @@ module Files
226
237
  # uri - string - URL base for AS2 responses
227
238
  # server_certificate - string - Remote server certificate security setting
228
239
  # public_certificate - string
240
+ # enable_dedicated_ips - boolean
229
241
  def self.update(id, params = {}, options = {})
230
242
  params ||= {}
231
243
  params[:id] = id
@@ -196,7 +196,7 @@ module Files
196
196
  end
197
197
 
198
198
  # Parameters:
199
- # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
199
+ # 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.
200
200
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
201
201
  def self.list(params = {}, options = {})
202
202
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
@@ -153,6 +153,15 @@ module Files
153
153
  @attributes[:user_id] = value
154
154
  end
155
155
 
156
+ # array - IDs of remote sync folder behaviors to run by this Automation
157
+ def sync_ids
158
+ @attributes[:sync_ids]
159
+ end
160
+
161
+ def sync_ids=(value)
162
+ @attributes[:sync_ids] = value
163
+ end
164
+
156
165
  # array - IDs of Users for the Automation (i.e. who to Request File from)
157
166
  def user_ids
158
167
  @attributes[:user_ids]
@@ -215,6 +224,7 @@ module Files
215
224
  # destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
216
225
  # interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
217
226
  # path - string - Path on which this Automation runs. Supports globs.
227
+ # sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
218
228
  # user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
219
229
  # group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
220
230
  # schedule - object - Custom schedule for running this automation.
@@ -237,6 +247,7 @@ module Files
237
247
  raise InvalidParameterError.new("Bad parameter: destination_replace_to must be an String") if params[:destination_replace_to] and !params[:destination_replace_to].is_a?(String)
238
248
  raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
239
249
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
250
+ raise InvalidParameterError.new("Bad parameter: sync_ids must be an String") if params[:sync_ids] and !params[:sync_ids].is_a?(String)
240
251
  raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
241
252
  raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params[:group_ids] and !params[:group_ids].is_a?(String)
242
253
  raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
@@ -273,9 +284,9 @@ module Files
273
284
  end
274
285
 
275
286
  # Parameters:
276
- # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
287
+ # 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.
277
288
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
278
- # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `automation`, `disabled` or `last_modified_at`.
289
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[automation]=desc`). Valid fields are `automation`, `disabled`, `last_modified_at` or `name`.
279
290
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
280
291
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
281
292
  # filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
@@ -329,6 +340,7 @@ module Files
329
340
  # destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
330
341
  # interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
331
342
  # path - string - Path on which this Automation runs. Supports globs.
343
+ # sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
332
344
  # user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
333
345
  # group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
334
346
  # schedule - object - Custom schedule for running this automation.
@@ -347,6 +359,7 @@ module Files
347
359
  raise InvalidParameterError.new("Bad parameter: destination_replace_to must be an String") if params[:destination_replace_to] and !params[:destination_replace_to].is_a?(String)
348
360
  raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
349
361
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
362
+ raise InvalidParameterError.new("Bad parameter: sync_ids must be an String") if params[:sync_ids] and !params[:sync_ids].is_a?(String)
350
363
  raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
351
364
  raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params[:group_ids] and !params[:group_ids].is_a?(String)
352
365
  raise InvalidParameterError.new("Bad parameter: schedule must be an Hash") if params[:schedule] and !params[:schedule].is_a?(Hash)
@@ -370,6 +383,7 @@ module Files
370
383
  # destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
371
384
  # interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
372
385
  # path - string - Path on which this Automation runs. Supports globs.
386
+ # sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
373
387
  # user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
374
388
  # group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
375
389
  # schedule - object - Custom schedule for running this automation.
@@ -391,6 +405,7 @@ module Files
391
405
  raise InvalidParameterError.new("Bad parameter: destination_replace_to must be an String") if params[:destination_replace_to] and !params[:destination_replace_to].is_a?(String)
392
406
  raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
393
407
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
408
+ raise InvalidParameterError.new("Bad parameter: sync_ids must be an String") if params[:sync_ids] and !params[:sync_ids].is_a?(String)
394
409
  raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
395
410
  raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params[:group_ids] and !params[:group_ids].is_a?(String)
396
411
  raise InvalidParameterError.new("Bad parameter: schedule must be an Hash") if params[:schedule] and !params[:schedule].is_a?(Hash)
@@ -41,9 +41,9 @@ module Files
41
41
 
42
42
  # Parameters:
43
43
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
44
- # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
44
+ # 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.
45
45
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
46
- # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at` and `status`.
46
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `status`.
47
47
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
48
48
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `status`.
49
49
  # filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `status`.