files.com 1.0.228 → 1.0.232
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/action_notification_export_result.md +1 -1
- data/docs/api_key.md +1 -1
- data/docs/app.md +7 -7
- data/docs/as2_incoming_message.md +55 -0
- data/docs/as2_outgoing_message.md +49 -0
- data/docs/as2_partner.md +136 -0
- data/docs/as2_station.md +148 -0
- data/docs/automation.md +1 -1
- data/docs/automation_run.md +1 -1
- data/docs/bandwidth_snapshot.md +1 -1
- data/docs/behavior.md +2 -2
- data/docs/bundle.md +1 -1
- data/docs/bundle_download.md +1 -1
- data/docs/bundle_recipient.md +1 -1
- data/docs/bundle_registration.md +1 -1
- data/docs/clickwrap.md +1 -1
- data/docs/dns_record.md +1 -1
- data/docs/external_event.md +7 -7
- data/docs/file_comment.md +1 -1
- data/docs/folder.md +1 -1
- data/docs/form_field_set.md +1 -1
- data/docs/group.md +1 -1
- data/docs/group_user.md +1 -1
- data/docs/history.md +5 -5
- data/docs/history_export.md +2 -2
- data/docs/history_export_result.md +2 -2
- data/docs/inbox_recipient.md +1 -1
- data/docs/inbox_registration.md +1 -1
- data/docs/inbox_upload.md +1 -1
- data/docs/invoice.md +1 -1
- data/docs/ip_address.md +2 -2
- data/docs/lock.md +1 -1
- data/docs/message.md +1 -1
- data/docs/message_comment.md +1 -1
- data/docs/message_comment_reaction.md +1 -1
- data/docs/message_reaction.md +1 -1
- data/docs/notification.md +1 -1
- data/docs/payment.md +1 -1
- data/docs/permission.md +7 -7
- data/docs/priority.md +1 -1
- data/docs/project.md +1 -1
- data/docs/public_key.md +1 -1
- data/docs/remote_server.md +1 -1
- data/docs/request.md +2 -2
- data/docs/settings_change.md +1 -1
- data/docs/sso_strategy.md +1 -1
- data/docs/sync_job.md +1 -1
- data/docs/usage_daily_snapshot.md +7 -7
- data/docs/usage_snapshot.md +1 -1
- data/docs/user.md +7 -7
- data/docs/user_cipher_use.md +1 -1
- data/docs/user_request.md +1 -1
- data/lib/files.com/errors.rb +1 -0
- data/lib/files.com/models/action_notification_export_result.rb +1 -1
- data/lib/files.com/models/api_key.rb +1 -1
- data/lib/files.com/models/app.rb +7 -7
- data/lib/files.com/models/as2_incoming_message.rb +100 -0
- data/lib/files.com/models/as2_outgoing_message.rb +85 -0
- data/lib/files.com/models/as2_partner.rb +188 -0
- data/lib/files.com/models/as2_station.rb +217 -0
- data/lib/files.com/models/automation.rb +1 -1
- data/lib/files.com/models/automation_run.rb +1 -1
- data/lib/files.com/models/bandwidth_snapshot.rb +1 -1
- data/lib/files.com/models/behavior.rb +2 -2
- data/lib/files.com/models/bundle.rb +1 -1
- data/lib/files.com/models/bundle_download.rb +1 -1
- data/lib/files.com/models/bundle_recipient.rb +1 -1
- data/lib/files.com/models/bundle_registration.rb +1 -1
- data/lib/files.com/models/clickwrap.rb +1 -1
- data/lib/files.com/models/dns_record.rb +1 -1
- data/lib/files.com/models/external_event.rb +7 -7
- data/lib/files.com/models/file_comment.rb +1 -1
- data/lib/files.com/models/folder.rb +1 -1
- data/lib/files.com/models/form_field_set.rb +1 -1
- data/lib/files.com/models/group.rb +1 -1
- data/lib/files.com/models/group_user.rb +1 -1
- data/lib/files.com/models/history.rb +5 -5
- data/lib/files.com/models/history_export.rb +2 -2
- data/lib/files.com/models/history_export_result.rb +2 -2
- data/lib/files.com/models/inbox_recipient.rb +1 -1
- data/lib/files.com/models/inbox_registration.rb +1 -1
- data/lib/files.com/models/inbox_upload.rb +1 -1
- data/lib/files.com/models/invoice.rb +1 -1
- data/lib/files.com/models/ip_address.rb +2 -2
- data/lib/files.com/models/lock.rb +1 -1
- data/lib/files.com/models/message.rb +1 -1
- data/lib/files.com/models/message_comment.rb +1 -1
- data/lib/files.com/models/message_comment_reaction.rb +1 -1
- data/lib/files.com/models/message_reaction.rb +1 -1
- data/lib/files.com/models/notification.rb +1 -1
- data/lib/files.com/models/payment.rb +1 -1
- data/lib/files.com/models/permission.rb +7 -7
- data/lib/files.com/models/priority.rb +1 -1
- data/lib/files.com/models/project.rb +1 -1
- data/lib/files.com/models/public_key.rb +1 -1
- data/lib/files.com/models/remote_server.rb +1 -1
- data/lib/files.com/models/request.rb +2 -2
- data/lib/files.com/models/settings_change.rb +1 -1
- data/lib/files.com/models/sso_strategy.rb +1 -1
- data/lib/files.com/models/sync_job.rb +1 -1
- data/lib/files.com/models/usage_daily_snapshot.rb +7 -7
- data/lib/files.com/models/usage_snapshot.rb +1 -1
- data/lib/files.com/models/user.rb +7 -7
- data/lib/files.com/models/user_cipher_use.rb +1 -1
- data/lib/files.com/models/user_request.rb +1 -1
- data/lib/files.com.rb +4 -1
- metadata +11 -5
- data/docs/as2_key.md +0 -131
- data/lib/files.com/models/as2_key.rb +0 -176
data/docs/history.md
CHANGED
@@ -53,7 +53,7 @@ Files::History.list_for_file(path,
|
|
53
53
|
* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
|
54
54
|
* `end_at` (string): Leave blank or set to a date/time to filter later entries.
|
55
55
|
* `display` (string): Display format. Leave blank or set to `full` or `parent`.
|
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 the X-Files-Cursor-Next header.
|
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.
|
57
57
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
58
58
|
* `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`.
|
59
59
|
* `path` (string): Required - Path to operate on.
|
@@ -75,7 +75,7 @@ Files::History.list_for_folder(path,
|
|
75
75
|
* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
|
76
76
|
* `end_at` (string): Leave blank or set to a date/time to filter later entries.
|
77
77
|
* `display` (string): Display format. Leave blank or set to `full` or `parent`.
|
78
|
-
* `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 the X-Files-Cursor-Next header.
|
78
|
+
* `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
79
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
80
80
|
* `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`.
|
81
81
|
* `path` (string): Required - Path to operate on.
|
@@ -97,7 +97,7 @@ Files::History.list_for_user(user_id,
|
|
97
97
|
* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
|
98
98
|
* `end_at` (string): Leave blank or set to a date/time to filter later entries.
|
99
99
|
* `display` (string): Display format. Leave blank or set to `full` or `parent`.
|
100
|
-
* `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 the X-Files-Cursor-Next header.
|
100
|
+
* `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
101
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
102
102
|
* `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`.
|
103
103
|
* `user_id` (int64): Required - User ID.
|
@@ -119,7 +119,7 @@ Files::History.list_logins(
|
|
119
119
|
* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
|
120
120
|
* `end_at` (string): Leave blank or set to a date/time to filter later entries.
|
121
121
|
* `display` (string): Display format. Leave blank or set to `full` or `parent`.
|
122
|
-
* `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 the X-Files-Cursor-Next header.
|
122
|
+
* `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.
|
123
123
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
124
124
|
* `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`.
|
125
125
|
|
@@ -140,7 +140,7 @@ Files::History.list(
|
|
140
140
|
* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
|
141
141
|
* `end_at` (string): Leave blank or set to a date/time to filter later entries.
|
142
142
|
* `display` (string): Display format. Leave blank or set to `full` or `parent`.
|
143
|
-
* `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 the X-Files-Cursor-Next header.
|
143
|
+
* `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
144
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
145
145
|
* `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`.
|
146
146
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
|
data/docs/history_export.md
CHANGED
@@ -38,7 +38,7 @@
|
|
38
38
|
* `end_at` (date-time): End date/time of export range.
|
39
39
|
* `status` (string): Status of export. Will be: `building`, `ready`, or `failed`
|
40
40
|
* `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
|
41
|
-
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`
|
41
|
+
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
|
42
42
|
* `query_user_id` (string): Return results that are actions performed by the user indiciated by this User ID
|
43
43
|
* `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
|
44
44
|
* `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
|
@@ -110,7 +110,7 @@ Files::HistoryExport.create(
|
|
110
110
|
* `start_at` (string): Start date/time of export range.
|
111
111
|
* `end_at` (string): End date/time of export range.
|
112
112
|
* `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
|
113
|
-
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`
|
113
|
+
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
|
114
114
|
* `query_user_id` (string): Return results that are actions performed by the user indiciated by this User ID
|
115
115
|
* `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
|
116
116
|
* `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
|
@@ -43,7 +43,7 @@
|
|
43
43
|
* `username` (string): Username of the user that performed the action
|
44
44
|
* `action` (string): What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
|
45
45
|
* `failure_type` (string): The type of login failure, if applicable. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`
|
46
|
-
* `interface` (string): Inteface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`
|
46
|
+
* `interface` (string): Inteface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
|
47
47
|
* `target_id` (int64): ID of the object (such as Users, or API Keys) on which the action was taken
|
48
48
|
* `target_name` (string): Name of the User, Group or other object with a name related to this action
|
49
49
|
* `target_permission` (string): Permission level of the action
|
@@ -70,6 +70,6 @@ Files::HistoryExportResult.list(
|
|
70
70
|
### Parameters
|
71
71
|
|
72
72
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
73
|
-
* `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 the X-Files-Cursor-Next header.
|
73
|
+
* `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.
|
74
74
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
75
75
|
* `history_export_id` (int64): Required - ID of the associated history export.
|
data/docs/inbox_recipient.md
CHANGED
@@ -37,7 +37,7 @@ Files::InboxRecipient.list(
|
|
37
37
|
### Parameters
|
38
38
|
|
39
39
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
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 the X-Files-Cursor-Next header.
|
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.
|
41
41
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
42
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 `has_registrations`.
|
43
43
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
data/docs/inbox_registration.md
CHANGED
@@ -42,6 +42,6 @@ Files::InboxRegistration.list(
|
|
42
42
|
|
43
43
|
### Parameters
|
44
44
|
|
45
|
-
* `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 the X-Files-Cursor-Next header.
|
45
|
+
* `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.
|
46
46
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
47
47
|
* `folder_behavior_id` (int64): ID of the associated Inbox.
|
data/docs/inbox_upload.md
CHANGED
@@ -29,7 +29,7 @@ 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 the X-Files-Cursor-Next header.
|
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.
|
33
33
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
34
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`.
|
35
35
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
data/docs/invoice.md
CHANGED
@@ -65,7 +65,7 @@ Files::Invoice.list(
|
|
65
65
|
|
66
66
|
### Parameters
|
67
67
|
|
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 the X-Files-Cursor-Next header.
|
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.
|
69
69
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
70
70
|
|
71
71
|
|
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 the X-Files-Cursor-Next header.
|
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.
|
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,5 +47,5 @@ Files::IpAddress.get_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 the X-Files-Cursor-Next header.
|
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.
|
51
51
|
* `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 the X-Files-Cursor-Next header.
|
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.
|
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
@@ -41,7 +41,7 @@ Files::Message.list(
|
|
41
41
|
### Parameters
|
42
42
|
|
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 the X-Files-Cursor-Next header.
|
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.
|
45
45
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
46
46
|
* `project_id` (int64): Required - Project for which to return messages.
|
47
47
|
|
data/docs/message_comment.md
CHANGED
@@ -34,7 +34,7 @@ Files::MessageComment.list(
|
|
34
34
|
### Parameters
|
35
35
|
|
36
36
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
37
|
-
* `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 the X-Files-Cursor-Next header.
|
37
|
+
* `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
38
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
39
39
|
* `message_id` (int64): Required - Message comment to return comments for.
|
40
40
|
|
@@ -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 the X-Files-Cursor-Next header.
|
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.
|
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
|
|
data/docs/message_reaction.md
CHANGED
@@ -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 the X-Files-Cursor-Next header.
|
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.
|
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
@@ -51,7 +51,7 @@ Files::Notification.list(
|
|
51
51
|
### Parameters
|
52
52
|
|
53
53
|
* `user_id` (int64): DEPRECATED: Show notifications for this User ID. Use `filter[user_id]` instead.
|
54
|
-
* `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 the X-Files-Cursor-Next header.
|
54
|
+
* `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.
|
55
55
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
56
56
|
* `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`.
|
57
57
|
* `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`.
|
data/docs/payment.md
CHANGED
@@ -65,7 +65,7 @@ Files::Payment.list(
|
|
65
65
|
|
66
66
|
### Parameters
|
67
67
|
|
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 the X-Files-Cursor-Next header.
|
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.
|
69
69
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
70
70
|
|
71
71
|
|
data/docs/permission.md
CHANGED
@@ -40,15 +40,15 @@ Files::Permission.list(
|
|
40
40
|
|
41
41
|
### Parameters
|
42
42
|
|
43
|
-
* `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 the X-Files-Cursor-Next header.
|
43
|
+
* `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
44
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
45
45
|
* `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
|
-
* `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`.
|
47
|
-
* `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`.
|
48
|
-
* `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`.
|
49
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
|
50
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `group_id`, `user_id` or `path`.
|
51
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
|
46
|
+
* `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 ]`.
|
47
|
+
* `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 ]`.
|
48
|
+
* `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 ]`.
|
49
|
+
* `filter_like` (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 ]`.
|
50
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
|
51
|
+
* `filter_lteq` (object): If set, return records where the specified field is less 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 ]`.
|
52
52
|
* `path` (string): DEPRECATED: Permission path. If provided, will scope permissions to this path. Use `filter[path]` instead.
|
53
53
|
* `group_id` (string): DEPRECATED: Group ID. If provided, will scope permissions to this group. Use `filter[group_id]` instead.`
|
54
54
|
* `user_id` (string): DEPRECATED: User ID. If provided, will scope permissions to this user. Use `filter[user_id]` instead.`
|
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 the X-Files-Cursor-Next header.
|
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.
|
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 the X-Files-Cursor-Next header.
|
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.
|
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 the X-Files-Cursor-Next header.
|
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.
|
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
|
|
data/docs/remote_server.md
CHANGED
@@ -100,7 +100,7 @@ Files::RemoteServer.list(
|
|
100
100
|
|
101
101
|
### Parameters
|
102
102
|
|
103
|
-
* `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 the X-Files-Cursor-Next header.
|
103
|
+
* `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.
|
104
104
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
105
105
|
|
106
106
|
|
data/docs/request.md
CHANGED
@@ -36,7 +36,7 @@ Files::Request.list(
|
|
36
36
|
|
37
37
|
### Parameters
|
38
38
|
|
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 the X-Files-Cursor-Next header.
|
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.
|
40
40
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
41
41
|
* `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
42
|
* `mine` (boolean): Only show requests of the current user? (Defaults to true if current user is not a site admin.)
|
@@ -56,7 +56,7 @@ Files::Request.get_folder(path,
|
|
56
56
|
|
57
57
|
### Parameters
|
58
58
|
|
59
|
-
* `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 the X-Files-Cursor-Next header.
|
59
|
+
* `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
60
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
61
61
|
* `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
62
|
* `mine` (boolean): Only show requests of the current user? (Defaults to true if current user is not a site admin.)
|
data/docs/settings_change.md
CHANGED
@@ -31,7 +31,7 @@ Files::SettingsChange.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 the X-Files-Cursor-Next header.
|
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.
|
35
35
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
36
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 `api_key_id`, `created_at` or `user_id`.
|
37
37
|
* `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`.
|
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 the X-Files-Cursor-Next header.
|
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.
|
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
|
|
data/docs/sync_job.md
CHANGED
@@ -33,5 +33,5 @@ Files::SyncJob.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 the X-Files-Cursor-Next header.
|
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.
|
37
37
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
@@ -31,12 +31,12 @@ Files::UsageDailySnapshot.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 the X-Files-Cursor-Next header.
|
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.
|
35
35
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
36
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 `date` and `usage_snapshot_id`.
|
37
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
|
38
|
-
* `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`.
|
39
|
-
* `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`.
|
40
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
|
41
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `date` and `usage_snapshot_id`.
|
42
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
|
37
|
+
* `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 ]`.
|
38
|
+
* `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 ]`.
|
39
|
+
* `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 ]`.
|
40
|
+
* `filter_like` (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 ]`.
|
41
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
|
42
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
|
data/docs/usage_snapshot.md
CHANGED
@@ -49,5 +49,5 @@ Files::UsageSnapshot.list(
|
|
49
49
|
|
50
50
|
### Parameters
|
51
51
|
|
52
|
-
* `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 the X-Files-Cursor-Next header.
|
52
|
+
* `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.
|
53
53
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
data/docs/user.md
CHANGED
@@ -129,15 +129,15 @@ Files::User.list(
|
|
129
129
|
|
130
130
|
### Parameters
|
131
131
|
|
132
|
-
* `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 the X-Files-Cursor-Next header.
|
132
|
+
* `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.
|
133
133
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
134
134
|
* `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`, `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`.
|
135
|
-
* `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`.
|
136
|
-
* `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`.
|
137
|
-
* `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`.
|
138
|
-
* `filter_like` (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`.
|
139
|
-
* `filter_lt` (object): If set, return records where the specified field is less 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`.
|
140
|
-
* `filter_lteq` (object): If set, return records where the specified field is less 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`.
|
135
|
+
* `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 ]`.
|
136
|
+
* `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 ]`.
|
137
|
+
* `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 ]`.
|
138
|
+
* `filter_like` (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 ]`.
|
139
|
+
* `filter_lt` (object): If set, return records where the specified field is less 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 ]`.
|
140
|
+
* `filter_lteq` (object): If set, return records where the specified field is less 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 ]`.
|
141
141
|
* `ids` (string): comma-separated list of User IDs
|
142
142
|
* `q[username]` (string): List users matching username.
|
143
143
|
* `q[email]` (string): List users matching email.
|
data/docs/user_cipher_use.md
CHANGED
@@ -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 the X-Files-Cursor-Next header.
|
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.
|
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 the X-Files-Cursor-Next header.
|
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.
|
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
|
|
data/lib/files.com/errors.rb
CHANGED
@@ -161,6 +161,7 @@ module Files
|
|
161
161
|
class DestinationFolderLimitedError < ProcessingFailureError; end
|
162
162
|
class DestinationParentConflictError < ProcessingFailureError; end
|
163
163
|
class DestinationParentDoesNotExistError < ProcessingFailureError; end
|
164
|
+
class ExpiredPrivateKeyError < ProcessingFailureError; end
|
164
165
|
class ExpiredPublicKeyError < ProcessingFailureError; end
|
165
166
|
class ExportFailureError < ProcessingFailureError; end
|
166
167
|
class ExportNotReadyError < ProcessingFailureError; end
|
@@ -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 the X-Files-Cursor-Next header.
|
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.
|
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 = {})
|
@@ -146,7 +146,7 @@ module Files
|
|
146
146
|
|
147
147
|
# Parameters:
|
148
148
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
149
|
-
# 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 the X-Files-Cursor-Next header.
|
149
|
+
# 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.
|
150
150
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
151
151
|
# 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`.
|
152
152
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
|
data/lib/files.com/models/app.rb
CHANGED
@@ -90,15 +90,15 @@ 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 the X-Files-Cursor-Next header.
|
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.
|
94
94
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
95
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`.
|
96
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`.
|
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`.
|
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`.
|
99
|
-
# filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`.
|
100
|
-
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `name` and `app_type`.
|
101
|
-
# filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `name` and `app_type`.
|
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
|
+
# 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
|
+
# 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 ]`.
|
99
|
+
# filter_like - 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 ]`.
|
100
|
+
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
|
101
|
+
# filter_lteq - object - If set, return records where the specified field is less 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 ]`.
|
102
102
|
def self.list(params = {}, options = {})
|
103
103
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
104
104
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
@@ -0,0 +1,100 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Files
|
4
|
+
class As2IncomingMessage
|
5
|
+
attr_reader :options, :attributes
|
6
|
+
|
7
|
+
def initialize(attributes = {}, options = {})
|
8
|
+
@attributes = attributes || {}
|
9
|
+
@options = options || {}
|
10
|
+
end
|
11
|
+
|
12
|
+
# int64 - Id of the AS2 Partner.
|
13
|
+
def id
|
14
|
+
@attributes[:id]
|
15
|
+
end
|
16
|
+
|
17
|
+
# int64 - Id of the AS2 Partner associated with this message.
|
18
|
+
def as2_partner_id
|
19
|
+
@attributes[:as2_partner_id]
|
20
|
+
end
|
21
|
+
|
22
|
+
# string - UUID assigned to this message.
|
23
|
+
def uuid
|
24
|
+
@attributes[:uuid]
|
25
|
+
end
|
26
|
+
|
27
|
+
# string - Content Type header of the incoming message.
|
28
|
+
def content_type
|
29
|
+
@attributes[:content_type]
|
30
|
+
end
|
31
|
+
|
32
|
+
# object - HTTP Headers sent with this message.
|
33
|
+
def http_headers
|
34
|
+
@attributes[:http_headers]
|
35
|
+
end
|
36
|
+
|
37
|
+
# string - JSON Structure of the activity log.
|
38
|
+
def activity_log
|
39
|
+
@attributes[:activity_log]
|
40
|
+
end
|
41
|
+
|
42
|
+
# string - Result of processing. Valid values: `unable_to_find_station`, `unable_to_find_partner`, `unable_to_validate_signature`, `decrypt_fail`, `file_save_fail`, `success`
|
43
|
+
def processing_result
|
44
|
+
@attributes[:processing_result]
|
45
|
+
end
|
46
|
+
|
47
|
+
# string - AS2 TO header of message
|
48
|
+
def as2_to
|
49
|
+
@attributes[:as2_to]
|
50
|
+
end
|
51
|
+
|
52
|
+
# string - AS2 FROM header of message
|
53
|
+
def as2_from
|
54
|
+
@attributes[:as2_from]
|
55
|
+
end
|
56
|
+
|
57
|
+
# string - AS2 Message Id
|
58
|
+
def message_id
|
59
|
+
@attributes[:message_id]
|
60
|
+
end
|
61
|
+
|
62
|
+
# string - AS2 Subject Header
|
63
|
+
def subject
|
64
|
+
@attributes[:subject]
|
65
|
+
end
|
66
|
+
|
67
|
+
# string - Encrypted Payload Body Size
|
68
|
+
def body_size
|
69
|
+
@attributes[:body_size]
|
70
|
+
end
|
71
|
+
|
72
|
+
# string - Filename of the file being received.
|
73
|
+
def attachment_filename
|
74
|
+
@attributes[:attachment_filename]
|
75
|
+
end
|
76
|
+
|
77
|
+
# date-time - Message creation date/time
|
78
|
+
def created_at
|
79
|
+
@attributes[:created_at]
|
80
|
+
end
|
81
|
+
|
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.
|
84
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
85
|
+
# as2_partner_id - int64 - As2 Partner ID. If provided, will return message specific to that partner.
|
86
|
+
def self.list(params = {}, options = {})
|
87
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
88
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
89
|
+
raise InvalidParameterError.new("Bad parameter: as2_partner_id must be an Integer") if params.dig(:as2_partner_id) and !params.dig(:as2_partner_id).is_a?(Integer)
|
90
|
+
|
91
|
+
List.new(As2IncomingMessage, params) do
|
92
|
+
Api.send_request("/as2_incoming_messages", :get, params, options)
|
93
|
+
end
|
94
|
+
end
|
95
|
+
|
96
|
+
def self.all(params = {}, options = {})
|
97
|
+
list(params, options)
|
98
|
+
end
|
99
|
+
end
|
100
|
+
end
|