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
@@ -55,9 +55,9 @@ module Files
55
55
  end
56
56
 
57
57
  # Parameters:
58
- # 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.
58
+ # 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.
59
59
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
60
- # 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`.
60
+ # 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`.
61
61
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
62
62
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
63
63
  # 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`.
@@ -137,9 +137,9 @@ module Files
137
137
  end
138
138
 
139
139
  # Parameters:
140
- # 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.
140
+ # 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.
141
141
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
142
- # 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 `behavior`.
142
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[behavior]=desc`). Valid fields are `behavior`.
143
143
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
144
144
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
145
145
  # filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `behavior`.
@@ -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 `behavior`.
190
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[behavior]=desc`). Valid fields are `behavior`.
191
191
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
192
192
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
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 `behavior`.
@@ -391,9 +391,9 @@ module Files
391
391
 
392
392
  # Parameters:
393
393
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
394
- # 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.
394
+ # 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.
395
395
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
396
- # 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 `code`.
396
+ # 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 `code`.
397
397
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
398
398
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
399
399
  # 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`.
@@ -30,9 +30,9 @@ module Files
30
30
  end
31
31
 
32
32
  # Parameters:
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
- # 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`.
35
+ # 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`.
36
36
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
37
37
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
38
38
  # 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`.
@@ -92,7 +92,7 @@ module Files
92
92
 
93
93
  # Parameters:
94
94
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
95
- # 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.
95
+ # 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.
96
96
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
97
97
  # bundle_id - int64 - Bundle ID to notify on
98
98
  def self.list(params = {}, options = {})
@@ -92,9 +92,9 @@ module Files
92
92
 
93
93
  # Parameters:
94
94
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
95
- # 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.
95
+ # 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.
96
96
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
97
- # 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 `has_registrations`.
97
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[has_registrations]=desc`). Valid fields are `has_registrations`.
98
98
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
99
99
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
100
100
  # filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
@@ -76,7 +76,7 @@ module Files
76
76
 
77
77
  # Parameters:
78
78
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
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
81
  # bundle_id - int64 - ID of the associated Bundle
82
82
  def self.list(params = {}, options = {})
@@ -108,7 +108,7 @@ module Files
108
108
  end
109
109
 
110
110
  # Parameters:
111
- # 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.
111
+ # 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.
112
112
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
113
113
  def self.list(params = {}, options = {})
114
114
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
@@ -30,7 +30,7 @@ module Files
30
30
  end
31
31
 
32
32
  # Parameters:
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
  def self.list(params = {}, options = {})
36
36
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
@@ -114,9 +114,9 @@ module Files
114
114
  end
115
115
 
116
116
  # Parameters:
117
- # 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.
117
+ # 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.
118
118
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
119
- # 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 `remote_server_type`, `site_id`, `folder_behavior_id`, `event_type`, `created_at` or `status`.
119
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[remote_server_type]=desc`). Valid fields are `remote_server_type`, `site_id`, `folder_behavior_id`, `event_type`, `created_at` or `status`.
120
120
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
121
121
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
122
122
  # 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`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
@@ -83,7 +83,7 @@ module Files
83
83
  end
84
84
 
85
85
  # Parameters:
86
- # 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.
86
+ # 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.
87
87
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
88
88
  # path (required) - string - Path to operate on.
89
89
  def self.list_for(path, params = {}, options = {})
@@ -124,7 +124,7 @@ module Files
124
124
 
125
125
  # Parameters:
126
126
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
127
- # 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.
127
+ # 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.
128
128
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
129
129
  def self.list(params = {}, options = {})
130
130
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
@@ -106,9 +106,9 @@ module Files
106
106
  end
107
107
 
108
108
  # Parameters:
109
- # 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.
109
+ # 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.
110
110
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
111
- # 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`.
111
+ # 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`.
112
112
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
113
113
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `name`.
114
114
  # filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name`.
@@ -113,7 +113,7 @@ module Files
113
113
 
114
114
  # Parameters:
115
115
  # user_id - int64 - User ID. If provided, will return group_users of this user.
116
- # 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.
116
+ # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
117
117
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
118
118
  # group_id - int64 - Group ID. If provided, will return group_users of this group.
119
119
  def self.list(params = {}, options = {})
@@ -78,9 +78,9 @@ module Files
78
78
  # start_at - string - Leave blank or set to a date/time to filter earlier entries.
79
79
  # end_at - string - Leave blank or set to a date/time to filter later entries.
80
80
  # display - string - Display format. Leave blank or set to `full` or `parent`.
81
- # 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.
81
+ # 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.
82
82
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
83
- # 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 `user_id` and `created_at`.
83
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[user_id]=desc`). Valid fields are `user_id` and `created_at`.
84
84
  # path (required) - string - Path to operate on.
85
85
  def self.list_for_file(path, params = {}, options = {})
86
86
  params ||= {}
@@ -103,9 +103,9 @@ module Files
103
103
  # start_at - string - Leave blank or set to a date/time to filter earlier entries.
104
104
  # end_at - string - Leave blank or set to a date/time to filter later entries.
105
105
  # display - string - Display format. Leave blank or set to `full` or `parent`.
106
- # 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.
106
+ # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
107
107
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
108
- # 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 `user_id` and `created_at`.
108
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[user_id]=desc`). Valid fields are `user_id` and `created_at`.
109
109
  # path (required) - string - Path to operate on.
110
110
  def self.list_for_folder(path, params = {}, options = {})
111
111
  params ||= {}
@@ -128,9 +128,9 @@ module Files
128
128
  # start_at - string - Leave blank or set to a date/time to filter earlier entries.
129
129
  # end_at - string - Leave blank or set to a date/time to filter later entries.
130
130
  # display - string - Display format. Leave blank or set to `full` or `parent`.
131
- # 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.
131
+ # 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.
132
132
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
133
- # 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 `user_id` and `created_at`.
133
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[user_id]=desc`). Valid fields are `user_id` and `created_at`.
134
134
  # user_id (required) - int64 - User ID.
135
135
  def self.list_for_user(user_id, params = {}, options = {})
136
136
  params ||= {}
@@ -153,9 +153,9 @@ module Files
153
153
  # start_at - string - Leave blank or set to a date/time to filter earlier entries.
154
154
  # end_at - string - Leave blank or set to a date/time to filter later entries.
155
155
  # display - string - Display format. Leave blank or set to `full` or `parent`.
156
- # 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.
156
+ # 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.
157
157
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
158
- # 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 `user_id` and `created_at`.
158
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[user_id]=desc`). Valid fields are `user_id` and `created_at`.
159
159
  def self.list_logins(params = {}, options = {})
160
160
  raise InvalidParameterError.new("Bad parameter: start_at must be an String") if params[:start_at] and !params[:start_at].is_a?(String)
161
161
  raise InvalidParameterError.new("Bad parameter: end_at must be an String") if params[:end_at] and !params[:end_at].is_a?(String)
@@ -173,9 +173,9 @@ module Files
173
173
  # start_at - string - Leave blank or set to a date/time to filter earlier entries.
174
174
  # end_at - string - Leave blank or set to a date/time to filter later entries.
175
175
  # display - string - Display format. Leave blank or set to `full` or `parent`.
176
- # 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.
176
+ # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
177
177
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
178
- # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `path`, `folder`, `user_id` or `created_at`.
178
+ # 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`, `folder`, `user_id` or `created_at`.
179
179
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
180
180
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `user_id`, `folder` or `path`.
181
181
  # 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`, `folder` or `path`.
@@ -131,7 +131,7 @@ module Files
131
131
 
132
132
  # Parameters:
133
133
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
134
- # 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.
134
+ # 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.
135
135
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
136
136
  # history_export_id (required) - int64 - ID of the associated history export.
137
137
  def self.list(params = {}, options = {})
@@ -92,9 +92,9 @@ module Files
92
92
 
93
93
  # Parameters:
94
94
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
95
- # 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.
95
+ # 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.
96
96
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
97
- # 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 `has_registrations`.
97
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[has_registrations]=desc`). Valid fields are `has_registrations`.
98
98
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
99
99
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
100
100
  # filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
@@ -65,7 +65,7 @@ module Files
65
65
  end
66
66
 
67
67
  # Parameters:
68
- # 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.
68
+ # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
69
69
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
70
70
  # folder_behavior_id - int64 - ID of the associated Inbox.
71
71
  def self.list(params = {}, options = {})
@@ -25,9 +25,9 @@ module Files
25
25
  end
26
26
 
27
27
  # Parameters:
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
- # 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`.
30
+ # 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`.
31
31
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
32
32
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
33
33
  # 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`.
@@ -80,7 +80,7 @@ module Files
80
80
  end
81
81
 
82
82
  # Parameters:
83
- # 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.
83
+ # 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.
84
84
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
85
85
  def self.list(params = {}, options = {})
86
86
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
@@ -30,7 +30,7 @@ module Files
30
30
  end
31
31
 
32
32
  # Parameters:
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
  def self.list(params = {}, options = {})
36
36
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
@@ -46,7 +46,7 @@ module Files
46
46
  end
47
47
 
48
48
  # Parameters:
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
  def self.get_exavault_reserved(params = {}, options = {})
52
52
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
@@ -58,7 +58,7 @@ module Files
58
58
  end
59
59
 
60
60
  # Parameters:
61
- # 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.
61
+ # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
62
62
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
63
63
  def self.get_reserved(params = {}, options = {})
64
64
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
@@ -141,7 +141,7 @@ module Files
141
141
  end
142
142
 
143
143
  # Parameters:
144
- # 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.
144
+ # 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.
145
145
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
146
146
  # path (required) - string - Path to operate on.
147
147
  # include_children - boolean - Include locks from children objects?
@@ -108,7 +108,7 @@ module Files
108
108
 
109
109
  # Parameters:
110
110
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
111
- # 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.
111
+ # 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.
112
112
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
113
113
  # project_id (required) - int64 - Project for which to return messages.
114
114
  def self.list(params = {}, options = {})
@@ -84,7 +84,7 @@ module Files
84
84
 
85
85
  # Parameters:
86
86
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
87
- # 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.
87
+ # 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.
88
88
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
89
89
  # message_id (required) - int64 - Message comment to return comments for.
90
90
  def self.list(params = {}, options = {})
@@ -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
  # message_comment_id (required) - int64 - Message comment to return reactions for.
67
67
  def self.list(params = {}, options = {})
@@ -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
  # message_id (required) - int64 - Message to return reactions for.
67
67
  def self.list(params = {}, options = {})
@@ -261,9 +261,9 @@ module Files
261
261
 
262
262
  # Parameters:
263
263
  # user_id - int64 - DEPRECATED: Show notifications for this User ID. Use `filter[user_id]` instead.
264
- # 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.
264
+ # 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.
265
265
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
266
- # 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`.
266
+ # 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`.
267
267
  # 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`.
268
268
  # 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`.
269
269
  # 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`.
@@ -80,7 +80,7 @@ module Files
80
80
  end
81
81
 
82
82
  # Parameters:
83
- # 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.
83
+ # 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.
84
84
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
85
85
  def self.list(params = {}, options = {})
86
86
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
@@ -105,9 +105,9 @@ module Files
105
105
  end
106
106
 
107
107
  # Parameters:
108
- # 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.
108
+ # 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.
109
109
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
110
- # 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`.
110
+ # 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`.
111
111
  # 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 ]`.
112
112
  # 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 ]`.
113
113
  # 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 ]`.
@@ -20,7 +20,7 @@ module Files
20
20
  end
21
21
 
22
22
  # Parameters:
23
- # 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.
23
+ # 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.
24
24
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
25
25
  # path (required) - string - The path to query for priorities
26
26
  def self.list(path, params = {}, options = {})
@@ -65,7 +65,7 @@ module Files
65
65
  end
66
66
 
67
67
  # Parameters:
68
- # 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.
68
+ # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
69
69
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
70
70
  def self.list(params = {}, options = {})
71
71
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
@@ -98,7 +98,7 @@ module Files
98
98
 
99
99
  # Parameters:
100
100
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
101
- # 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.
101
+ # 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.
102
102
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
103
103
  def self.list(params = {}, options = {})
104
104
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
@@ -35,9 +35,9 @@ module Files
35
35
  end
36
36
 
37
37
  # Parameters:
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).
40
- # 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`.
40
+ # 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`.
41
41
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
42
42
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
43
43
  # 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`.
@@ -751,7 +751,7 @@ module Files
751
751
  end
752
752
 
753
753
  # Parameters:
754
- # 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.
754
+ # 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.
755
755
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
756
756
  def self.list(params = {}, options = {})
757
757
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
@@ -105,9 +105,9 @@ module Files
105
105
  end
106
106
 
107
107
  # Parameters:
108
- # 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.
108
+ # 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.
109
109
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
110
- # 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`.
110
+ # 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`.
111
111
  # mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
112
112
  # path - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
113
113
  def self.list(params = {}, options = {})
@@ -126,9 +126,9 @@ module Files
126
126
  end
127
127
 
128
128
  # Parameters:
129
- # 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.
129
+ # 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.
130
130
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
131
- # 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`.
131
+ # 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`.
132
132
  # mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
133
133
  # path (required) - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
134
134
  def self.get_folder(path, params = {}, options = {})