files.com 1.1.671 → 1.1.672
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/action_log.md +1 -21
- data/docs/action_notification_export_result.md +0 -17
- data/docs/ai_assistant_personality.md +0 -14
- data/docs/ai_task.md +0 -14
- data/docs/api_key.md +1 -27
- data/docs/api_request_log.md +1 -21
- data/docs/app.md +0 -15
- data/docs/as2_incoming_message.md +0 -18
- data/docs/as2_outgoing_message.md +0 -18
- data/docs/as2_partner.md +0 -14
- data/docs/as2_station.md +0 -14
- data/docs/automation.md +1 -22
- data/docs/automation_log.md +1 -21
- data/docs/automation_run.md +0 -19
- data/docs/bandwidth_snapshot.md +0 -18
- data/docs/behavior.md +0 -14
- data/docs/bundle.md +1 -50
- data/docs/bundle_action.md +0 -25
- data/docs/bundle_download.md +0 -23
- data/docs/bundle_notification.md +0 -19
- data/docs/bundle_recipient.md +0 -21
- data/docs/bundle_registration.md +0 -61
- data/docs/chat_session.md +2 -14
- data/docs/child_site_management_policy.md +0 -9
- data/docs/clickwrap.md +0 -13
- data/docs/custom_domain.md +0 -13
- data/docs/desktop_configuration_profile.md +0 -14
- data/docs/dns_record.md +0 -9
- data/docs/email_incoming_message.md +0 -19
- data/docs/email_log.md +1 -20
- data/docs/event_channel.md +0 -14
- data/docs/event_delivery_attempt.md +0 -14
- data/docs/event_record.md +0 -19
- data/docs/event_subscription.md +0 -14
- data/docs/event_target.md +0 -14
- data/docs/exavault_api_request_log.md +1 -21
- data/docs/expectation.md +0 -14
- data/docs/expectation_evaluation.md +0 -14
- data/docs/expectation_incident.md +0 -14
- data/docs/external_event.md +0 -18
- data/docs/file.md +2 -90
- data/docs/file_migration.md +0 -32
- data/docs/file_migration_log.md +1 -20
- data/docs/file_upload_part.md +1 -3
- data/docs/folder.md +0 -20
- data/docs/form_field_set.md +0 -15
- data/docs/ftp_action_log.md +1 -21
- data/docs/gpg_key.md +0 -21
- data/docs/group.md +0 -19
- data/docs/group_user.md +2 -22
- data/docs/history.md +0 -85
- data/docs/history_export_result.md +0 -17
- data/docs/holiday_region.md +0 -9
- data/docs/inbound_s3_log.md +1 -21
- data/docs/inbox_recipient.md +0 -19
- data/docs/inbox_registration.md +0 -57
- data/docs/inbox_upload.md +0 -18
- data/docs/invoice.md +0 -9
- data/docs/ip_address.md +0 -59
- data/docs/key_lifecycle_rule.md +0 -14
- data/docs/lock.md +0 -15
- data/docs/message.md +0 -17
- data/docs/message_comment.md +0 -18
- data/docs/message_comment_reaction.md +0 -18
- data/docs/message_reaction.md +0 -17
- data/docs/metadata_category.md +0 -13
- data/docs/notification.md +0 -20
- data/docs/outbound_connection_log.md +1 -21
- data/docs/partner.md +0 -14
- data/docs/partner_channel.md +0 -14
- data/docs/partner_site_request.md +0 -14
- data/docs/payment.md +0 -9
- data/docs/pending_work_event.md +0 -18
- data/docs/permission.md +0 -22
- data/docs/preview.md +0 -57
- data/docs/project.md +0 -9
- data/docs/public_hosting_request_log.md +1 -21
- data/docs/public_key.md +0 -21
- data/docs/remote_bandwidth_snapshot.md +0 -18
- data/docs/remote_mount_backend.md +0 -13
- data/docs/remote_server.md +0 -233
- data/docs/remote_server_credential.md +0 -15
- data/docs/request.md +0 -17
- data/docs/restore.md +0 -14
- data/docs/scheduled_export.md +0 -15
- data/docs/scim_log.md +0 -13
- data/docs/session.md +1 -232
- data/docs/settings_change.md +0 -16
- data/docs/sftp_action_log.md +1 -21
- data/docs/sftp_host_key.md +0 -9
- data/docs/share_group.md +0 -15
- data/docs/siem_http_destination.md +0 -9
- data/docs/siem_http_destination_event.md +0 -18
- data/docs/site.md +0 -179
- data/docs/site_subdomain_redirect.md +0 -13
- data/docs/snapshot.md +0 -9
- data/docs/sso_event.md +0 -19
- data/docs/sso_strategy.md +0 -406
- data/docs/sync.md +0 -14
- data/docs/sync_log.md +1 -20
- data/docs/sync_run.md +0 -21
- data/docs/usage_daily_snapshot.md +0 -18
- data/docs/usage_snapshot.md +0 -9
- data/docs/user.md +2 -49
- data/docs/user_cipher_use.md +0 -21
- data/docs/user_lifecycle_rule.md +0 -14
- data/docs/user_request.md +0 -9
- data/docs/user_security_event.md +0 -18
- data/docs/user_sftp_client_use.md +0 -15
- data/docs/web_dav_action_log.md +1 -21
- data/docs/workspace.md +0 -15
- data/lib/files.com/models/action_log.rb +0 -24
- data/lib/files.com/models/action_notification_export_result.rb +0 -12
- data/lib/files.com/models/ai_assistant_personality.rb +0 -11
- data/lib/files.com/models/ai_task.rb +0 -11
- data/lib/files.com/models/api_key.rb +5 -39
- data/lib/files.com/models/api_request_log.rb +0 -24
- data/lib/files.com/models/app.rb +0 -13
- data/lib/files.com/models/as2_incoming_message.rb +0 -19
- data/lib/files.com/models/as2_outgoing_message.rb +0 -19
- data/lib/files.com/models/as2_partner.rb +0 -11
- data/lib/files.com/models/as2_station.rb +0 -11
- data/lib/files.com/models/automation.rb +0 -30
- data/lib/files.com/models/automation_log.rb +0 -24
- data/lib/files.com/models/automation_run.rb +0 -16
- data/lib/files.com/models/bandwidth_snapshot.rb +0 -19
- data/lib/files.com/models/behavior.rb +0 -11
- data/lib/files.com/models/bundle.rb +0 -52
- data/lib/files.com/models/bundle_action.rb +0 -25
- data/lib/files.com/models/bundle_download.rb +0 -23
- data/lib/files.com/models/bundle_notification.rb +0 -15
- data/lib/files.com/models/bundle_recipient.rb +0 -27
- data/lib/files.com/models/bundle_registration.rb +0 -125
- data/lib/files.com/models/chat_session.rb +5 -11
- data/lib/files.com/models/child_site_management_policy.rb +0 -5
- data/lib/files.com/models/clickwrap.rb +0 -9
- data/lib/files.com/models/custom_domain.rb +0 -9
- data/lib/files.com/models/desktop_configuration_profile.rb +0 -11
- data/lib/files.com/models/dns_record.rb +0 -5
- data/lib/files.com/models/email_incoming_message.rb +0 -21
- data/lib/files.com/models/email_log.rb +0 -22
- data/lib/files.com/models/event_channel.rb +0 -11
- data/lib/files.com/models/event_delivery_attempt.rb +0 -11
- data/lib/files.com/models/event_record.rb +0 -21
- data/lib/files.com/models/event_subscription.rb +0 -11
- data/lib/files.com/models/event_target.rb +0 -11
- data/lib/files.com/models/exavault_api_request_log.rb +0 -24
- data/lib/files.com/models/expectation.rb +0 -11
- data/lib/files.com/models/expectation_evaluation.rb +0 -11
- data/lib/files.com/models/expectation_incident.rb +0 -11
- data/lib/files.com/models/external_event.rb +0 -19
- data/lib/files.com/models/file.rb +0 -207
- data/lib/files.com/models/file_migration.rb +0 -27
- data/lib/files.com/models/file_migration_log.rb +0 -22
- data/lib/files.com/models/file_upload_part.rb +0 -5
- data/lib/files.com/models/folder.rb +0 -69
- data/lib/files.com/models/form_field_set.rb +0 -9
- data/lib/files.com/models/ftp_action_log.rb +0 -24
- data/lib/files.com/models/gpg_key.rb +0 -21
- data/lib/files.com/models/group.rb +0 -16
- data/lib/files.com/models/group_user.rb +1 -21
- data/lib/files.com/models/history.rb +0 -94
- data/lib/files.com/models/history_export_result.rb +0 -12
- data/lib/files.com/models/holiday_region.rb +0 -5
- data/lib/files.com/models/inbound_s3_log.rb +0 -24
- data/lib/files.com/models/inbox_recipient.rb +0 -25
- data/lib/files.com/models/inbox_registration.rb +0 -121
- data/lib/files.com/models/inbox_upload.rb +0 -19
- data/lib/files.com/models/invoice.rb +0 -5
- data/lib/files.com/models/ip_address.rb +0 -37
- data/lib/files.com/models/key_lifecycle_rule.rb +0 -11
- data/lib/files.com/models/lock.rb +0 -27
- data/lib/files.com/models/message.rb +0 -12
- data/lib/files.com/models/message_comment.rb +0 -14
- data/lib/files.com/models/message_comment_reaction.rb +0 -14
- data/lib/files.com/models/message_reaction.rb +0 -12
- data/lib/files.com/models/metadata_category.rb +0 -9
- data/lib/files.com/models/notification.rb +0 -18
- data/lib/files.com/models/outbound_connection_log.rb +0 -24
- data/lib/files.com/models/partner.rb +0 -11
- data/lib/files.com/models/partner_channel.rb +0 -11
- data/lib/files.com/models/partner_site_request.rb +0 -11
- data/lib/files.com/models/payment.rb +0 -5
- data/lib/files.com/models/pending_work_event.rb +0 -19
- data/lib/files.com/models/permission.rb +0 -22
- data/lib/files.com/models/preview.rb +0 -57
- data/lib/files.com/models/project.rb +0 -5
- data/lib/files.com/models/public_hosting_request_log.rb +0 -24
- data/lib/files.com/models/public_key.rb +0 -21
- data/lib/files.com/models/remote_bandwidth_snapshot.rb +0 -19
- data/lib/files.com/models/remote_mount_backend.rb +0 -9
- data/lib/files.com/models/remote_server.rb +0 -297
- data/lib/files.com/models/remote_server_credential.rb +0 -13
- data/lib/files.com/models/request.rb +0 -12
- data/lib/files.com/models/restore.rb +0 -11
- data/lib/files.com/models/scheduled_export.rb +0 -13
- data/lib/files.com/models/scim_log.rb +0 -9
- data/lib/files.com/models/session.rb +0 -493
- data/lib/files.com/models/settings_change.rb +0 -16
- data/lib/files.com/models/sftp_action_log.rb +0 -24
- data/lib/files.com/models/sftp_host_key.rb +0 -5
- data/lib/files.com/models/share_group.rb +0 -9
- data/lib/files.com/models/siem_http_destination.rb +0 -5
- data/lib/files.com/models/siem_http_destination_event.rb +0 -19
- data/lib/files.com/models/site.rb +0 -1021
- data/lib/files.com/models/site_subdomain_redirect.rb +0 -9
- data/lib/files.com/models/snapshot.rb +0 -5
- data/lib/files.com/models/sso_event.rb +0 -21
- data/lib/files.com/models/sso_strategy.rb +0 -632
- data/lib/files.com/models/sync.rb +0 -11
- data/lib/files.com/models/sync_log.rb +0 -22
- data/lib/files.com/models/sync_run.rb +0 -21
- data/lib/files.com/models/usage_daily_snapshot.rb +0 -19
- data/lib/files.com/models/usage_snapshot.rb +0 -5
- data/lib/files.com/models/user.rb +0 -59
- data/lib/files.com/models/user_cipher_use.rb +0 -21
- data/lib/files.com/models/user_lifecycle_rule.rb +0 -11
- data/lib/files.com/models/user_request.rb +0 -5
- data/lib/files.com/models/user_security_event.rb +0 -19
- data/lib/files.com/models/user_sftp_client_use.rb +0 -9
- data/lib/files.com/models/web_dav_action_log.rb +0 -24
- data/lib/files.com/models/workspace.rb +0 -13
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +0 -59
- metadata +1 -119
- data/docs/account.md +0 -155
- data/docs/action_webhook_failure.md +0 -28
- data/docs/agent_proxy_identity.md +0 -49
- data/docs/agent_proxy_identity_endpoint.md +0 -11
- data/docs/agent_proxy_identity_result.md +0 -24
- data/docs/agent_v2_auth.md +0 -17
- data/docs/announcement.md +0 -57
- data/docs/blog_post.md +0 -57
- data/docs/bundle_recipient_registration.md +0 -39
- data/docs/certificate.md +0 -258
- data/docs/child_site.md +0 -583
- data/docs/clickwrap_acceptance.md +0 -30
- data/docs/client_log.md +0 -17
- data/docs/crash_report.md +0 -50
- data/docs/custom_domain_for_proxy.md +0 -23
- data/docs/email_preference.md +0 -108
- data/docs/email_preference_bundle_notification.md +0 -15
- data/docs/email_preference_notification.md +0 -17
- data/docs/export.md +0 -90
- data/docs/front_end_server.md +0 -111
- data/docs/frontend_metric.md +0 -34
- data/docs/inbox.md +0 -102
- data/docs/inbox_recipient_registration.md +0 -35
- data/docs/ip.md +0 -63
- data/docs/ip_abuse_entry.md +0 -47
- data/docs/label.md +0 -9
- data/docs/lead.md +0 -161
- data/docs/monitoring_stat.md +0 -38
- data/docs/monitoring_stats.md +0 -15
- data/docs/mover_package.md +0 -68
- data/docs/nps_response.md +0 -75
- data/docs/oauth_redirect.md +0 -11
- data/docs/paired_api_key.md +0 -19
- data/docs/paypal_express_info.md +0 -31
- data/docs/paypal_express_url.md +0 -11
- data/docs/plan.md +0 -107
- data/docs/public_hosting_session_pairing.md +0 -15
- data/docs/public_inbox.md +0 -121
- data/docs/public_url.md +0 -59
- data/docs/regional_migration.md +0 -0
- data/docs/release.md +0 -83
- data/docs/release_package.md +0 -19
- data/docs/revision.md +0 -40
- data/docs/safe_plan.md +0 -0
- data/docs/session_available_site.md +0 -26
- data/docs/setting.md +0 -33
- data/docs/settings.md +0 -498
- data/docs/ssl_certificate.md +0 -37
- data/docs/staging_site.md +0 -591
- data/docs/support_request.md +0 -126
- data/docs/sync_api_usage_snapshot.md +0 -23
- data/docs/sync_api_usage_snapshot_report.md +0 -71
- data/docs/sync_bandwidth_snapshot.md +0 -48
- data/docs/two_factor_authentication_method.md +0 -169
- data/docs/warning.md +0 -36
- data/docs/webauthn_sign_request.md +0 -13
- data/docs/zip_download.md +0 -32
- data/docs/zip_download_file.md +0 -45
- data/docs/zip_download_files.md +0 -23
- data/lib/files.com/models/account.rb +0 -346
- data/lib/files.com/models/action_webhook_failure.rb +0 -34
- data/lib/files.com/models/agent_proxy_identity.rb +0 -47
- data/lib/files.com/models/agent_proxy_identity_endpoint.rb +0 -17
- data/lib/files.com/models/agent_proxy_identity_result.rb +0 -27
- data/lib/files.com/models/agent_v2_auth.rb +0 -32
- data/lib/files.com/models/announcement.rb +0 -89
- data/lib/files.com/models/blog_post.rb +0 -84
- data/lib/files.com/models/bundle_recipient_registration.rb +0 -105
- data/lib/files.com/models/certificate.rb +0 -455
- data/lib/files.com/models/child_site.rb +0 -1756
- data/lib/files.com/models/clickwrap_acceptance.rb +0 -56
- data/lib/files.com/models/client_log.rb +0 -25
- data/lib/files.com/models/crash_report.rb +0 -151
- data/lib/files.com/models/custom_domain_for_proxy.rb +0 -47
- data/lib/files.com/models/email_preference.rb +0 -124
- data/lib/files.com/models/email_preference_bundle_notification.rb +0 -27
- data/lib/files.com/models/email_preference_notification.rb +0 -32
- data/lib/files.com/models/export.rb +0 -153
- data/lib/files.com/models/front_end_server.rb +0 -335
- data/lib/files.com/models/frontend_metric.rb +0 -65
- data/lib/files.com/models/inbox.rb +0 -123
- data/lib/files.com/models/inbox_recipient_registration.rb +0 -87
- data/lib/files.com/models/ip.rb +0 -82
- data/lib/files.com/models/ip_abuse_entry.rb +0 -96
- data/lib/files.com/models/label.rb +0 -22
- data/lib/files.com/models/lead.rb +0 -434
- data/lib/files.com/models/monitoring_stat.rb +0 -43
- data/lib/files.com/models/monitoring_stats.rb +0 -22
- data/lib/files.com/models/mover_package.rb +0 -80
- data/lib/files.com/models/nps_response.rb +0 -128
- data/lib/files.com/models/oauth_redirect.rb +0 -17
- data/lib/files.com/models/paired_api_key.rb +0 -37
- data/lib/files.com/models/paypal_express_info.rb +0 -67
- data/lib/files.com/models/paypal_express_url.rb +0 -17
- data/lib/files.com/models/plan.rb +0 -209
- data/lib/files.com/models/public_hosting_session_pairing.rb +0 -27
- data/lib/files.com/models/public_inbox.rb +0 -142
- data/lib/files.com/models/public_url.rb +0 -177
- data/lib/files.com/models/regional_migration.rb +0 -12
- data/lib/files.com/models/release.rb +0 -153
- data/lib/files.com/models/release_package.rb +0 -37
- data/lib/files.com/models/revision.rb +0 -53
- data/lib/files.com/models/safe_plan.rb +0 -12
- data/lib/files.com/models/session_available_site.rb +0 -47
- data/lib/files.com/models/setting.rb +0 -36
- data/lib/files.com/models/settings.rb +0 -1072
- data/lib/files.com/models/ssl_certificate.rb +0 -77
- data/lib/files.com/models/staging_site.rb +0 -1781
- data/lib/files.com/models/support_request.rb +0 -209
- data/lib/files.com/models/sync_api_usage_snapshot.rb +0 -47
- data/lib/files.com/models/sync_api_usage_snapshot_report.rb +0 -162
- data/lib/files.com/models/sync_bandwidth_snapshot.rb +0 -104
- data/lib/files.com/models/two_factor_authentication_method.rb +0 -250
- data/lib/files.com/models/warning.rb +0 -38
- data/lib/files.com/models/webauthn_sign_request.rb +0 -17
- data/lib/files.com/models/zip_download.rb +0 -73
- data/lib/files.com/models/zip_download_file.rb +0 -111
- data/lib/files.com/models/zip_download_files.rb +0 -42
data/docs/app.md
CHANGED
|
@@ -70,18 +70,3 @@ Files::App.list
|
|
|
70
70
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name` and `app_type`.
|
|
71
71
|
* `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 ]`.
|
|
72
72
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
---
|
|
76
|
-
|
|
77
|
-
## Create an export CSV of App resources
|
|
78
|
-
|
|
79
|
-
```
|
|
80
|
-
Files::App.create_export
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
### Parameters
|
|
84
|
-
|
|
85
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name` and `app_type`.
|
|
86
|
-
* `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 ]`.
|
|
87
|
-
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
|
|
@@ -101,21 +101,3 @@ Files::As2IncomingMessage.list
|
|
|
101
101
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
102
102
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
103
103
|
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
---
|
|
107
|
-
|
|
108
|
-
## Create an export CSV of AS2 Incoming Message resources
|
|
109
|
-
|
|
110
|
-
```
|
|
111
|
-
Files::As2IncomingMessage.create_export
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
### Parameters
|
|
115
|
-
|
|
116
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `created_at` or `as2_partner_id`.
|
|
117
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `as2_station_id`, `workspace_id` or `as2_partner_id`. Valid field combinations are `[ as2_station_id, created_at ]`, `[ workspace_id, created_at ]`, `[ as2_partner_id, created_at ]`, `[ workspace_id, as2_station_id ]`, `[ workspace_id, as2_partner_id ]`, `[ workspace_id, as2_station_id, created_at ]` or `[ workspace_id, as2_partner_id, created_at ]`.
|
|
118
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
119
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
120
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
121
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
@@ -93,21 +93,3 @@ Files::As2OutgoingMessage.list
|
|
|
93
93
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
94
94
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
95
95
|
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
---
|
|
99
|
-
|
|
100
|
-
## Create an export CSV of AS2 Outgoing Message resources
|
|
101
|
-
|
|
102
|
-
```
|
|
103
|
-
Files::As2OutgoingMessage.create_export
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
### Parameters
|
|
107
|
-
|
|
108
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `created_at` or `as2_partner_id`.
|
|
109
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `as2_station_id`, `workspace_id` or `as2_partner_id`. Valid field combinations are `[ as2_station_id, created_at ]`, `[ workspace_id, created_at ]`, `[ as2_partner_id, created_at ]`, `[ workspace_id, as2_station_id ]`, `[ workspace_id, as2_partner_id ]`, `[ workspace_id, as2_station_id, created_at ]` or `[ workspace_id, as2_partner_id, created_at ]`.
|
|
110
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
111
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
112
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
113
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
data/docs/as2_partner.md
CHANGED
|
@@ -117,20 +117,6 @@ Files::As2Partner.create(
|
|
|
117
117
|
* `public_certificate` (string): Required - Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.
|
|
118
118
|
|
|
119
119
|
|
|
120
|
-
---
|
|
121
|
-
|
|
122
|
-
## Create an export CSV of AS2 Partner resources
|
|
123
|
-
|
|
124
|
-
```
|
|
125
|
-
Files::As2Partner.create_export
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
### Parameters
|
|
129
|
-
|
|
130
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `as2_station_id` or `name`.
|
|
131
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `as2_station_id` and `workspace_id`. Valid field combinations are `[ workspace_id, as2_station_id ]`.
|
|
132
|
-
|
|
133
|
-
|
|
134
120
|
---
|
|
135
121
|
|
|
136
122
|
## Update AS2 Partner
|
data/docs/as2_station.md
CHANGED
|
@@ -92,20 +92,6 @@ Files::As2Station.create(
|
|
|
92
92
|
* `private_key_password` (string):
|
|
93
93
|
|
|
94
94
|
|
|
95
|
-
---
|
|
96
|
-
|
|
97
|
-
## Create an export CSV of AS2 Station resources
|
|
98
|
-
|
|
99
|
-
```
|
|
100
|
-
Files::As2Station.create_export
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
### Parameters
|
|
104
|
-
|
|
105
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
|
|
106
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
|
|
107
|
-
|
|
108
|
-
|
|
109
95
|
---
|
|
110
96
|
|
|
111
97
|
## Update AS2 Station
|
data/docs/automation.md
CHANGED
|
@@ -137,7 +137,6 @@
|
|
|
137
137
|
* `value` (object): A Hash of attributes specific to the automation type.
|
|
138
138
|
* `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
|
|
139
139
|
* `holiday_region` (string): Skip automation if there is a formal, observed holiday for this region.
|
|
140
|
-
* `cloned_from` (int64): Set to the ID of automation used as a clone template. This is an informational field only.
|
|
141
140
|
|
|
142
141
|
|
|
143
142
|
---
|
|
@@ -212,8 +211,7 @@ Files::Automation.create(
|
|
|
212
211
|
value: {"limit":"1"},
|
|
213
212
|
recurring_day: 25,
|
|
214
213
|
automation: "create_folder",
|
|
215
|
-
workspace_id: 0
|
|
216
|
-
cloned_from: 1
|
|
214
|
+
workspace_id: 0
|
|
217
215
|
)
|
|
218
216
|
```
|
|
219
217
|
|
|
@@ -253,7 +251,6 @@ Files::Automation.create(
|
|
|
253
251
|
* `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
|
254
252
|
* `automation` (string): Required - Automation type
|
|
255
253
|
* `workspace_id` (int64): Workspace ID
|
|
256
|
-
* `cloned_from` (int64): Set to the ID of automation used as a clone template. This is an informational field only.
|
|
257
254
|
|
|
258
255
|
|
|
259
256
|
---
|
|
@@ -269,24 +266,6 @@ Files::Automation.manual_run(id)
|
|
|
269
266
|
* `id` (int64): Required - Automation ID.
|
|
270
267
|
|
|
271
268
|
|
|
272
|
-
---
|
|
273
|
-
|
|
274
|
-
## Create an export CSV of Automation resources
|
|
275
|
-
|
|
276
|
-
```
|
|
277
|
-
Files::Automation.create_export
|
|
278
|
-
```
|
|
279
|
-
|
|
280
|
-
### Parameters
|
|
281
|
-
|
|
282
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name`, `automation`, `last_modified_at` or `disabled`.
|
|
283
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `last_modified_at`, `workspace_id` or `automation`. Valid field combinations are `[ disabled, last_modified_at ]`, `[ workspace_id, disabled ]`, `[ disabled, automation ]`, `[ workspace_id, last_modified_at ]`, `[ automation, last_modified_at ]`, `[ workspace_id, automation ]`, `[ workspace_id, disabled, last_modified_at ]`, `[ disabled, automation, last_modified_at ]`, `[ workspace_id, disabled, automation ]`, `[ workspace_id, automation, last_modified_at ]` or `[ workspace_id, disabled, automation, last_modified_at ]`.
|
|
284
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `last_modified_at`.
|
|
285
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `last_modified_at`.
|
|
286
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `last_modified_at`.
|
|
287
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `last_modified_at`.
|
|
288
|
-
|
|
289
|
-
|
|
290
269
|
---
|
|
291
270
|
|
|
292
271
|
## Update Automation
|
data/docs/automation_log.md
CHANGED
|
@@ -13,8 +13,7 @@
|
|
|
13
13
|
"operation": "copy",
|
|
14
14
|
"path": "example",
|
|
15
15
|
"status": "success",
|
|
16
|
-
"created_at": "2000-01-01T01:00:00Z"
|
|
17
|
-
"log_type": "example"
|
|
16
|
+
"created_at": "2000-01-01T01:00:00Z"
|
|
18
17
|
}
|
|
19
18
|
```
|
|
20
19
|
|
|
@@ -28,7 +27,6 @@
|
|
|
28
27
|
* `path` (string): File path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
29
28
|
* `status` (string): Status
|
|
30
29
|
* `created_at` (date-time): Start Time of Action
|
|
31
|
-
* `log_type` (string): Log Type
|
|
32
30
|
|
|
33
31
|
|
|
34
32
|
---
|
|
@@ -49,21 +47,3 @@ Files::AutomationLog.list
|
|
|
49
47
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`. Valid field combinations are `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ created_at ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, created_at ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, created_at ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, created_at ]`, `[ path, status ]`, `[ path, created_at ]`, `[ status, created_at ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, created_at ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, created_at ]`, `[ automation_id, path, status ]`, `[ automation_id, path, created_at ]`, `[ automation_id, status, created_at ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, created_at ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, created_at ]`, `[ automation_run_id, status, created_at ]`, `[ operation, path, status ]`, `[ operation, path, created_at ]`, `[ operation, status, created_at ]`, `[ path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, created_at ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, created_at ]`, `[ automation_id, automation_run_id, status, created_at ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, created_at ]`, `[ automation_id, operation, status, created_at ]`, `[ automation_id, path, status, created_at ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, created_at ]`, `[ automation_run_id, operation, status, created_at ]`, `[ automation_run_id, path, status, created_at ]`, `[ operation, path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, created_at ]`, `[ automation_id, automation_run_id, operation, status, created_at ]`, `[ automation_id, automation_run_id, path, status, created_at ]`, `[ automation_id, operation, path, status, created_at ]`, `[ automation_run_id, operation, path, status, created_at ]` or `[ automation_id, automation_run_id, operation, path, status, created_at ]`.
|
|
50
48
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ created_at ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, created_at ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, created_at ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, created_at ]`, `[ path, status ]`, `[ path, created_at ]`, `[ status, created_at ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, created_at ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, created_at ]`, `[ automation_id, path, status ]`, `[ automation_id, path, created_at ]`, `[ automation_id, status, created_at ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, created_at ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, created_at ]`, `[ automation_run_id, status, created_at ]`, `[ operation, path, status ]`, `[ operation, path, created_at ]`, `[ operation, status, created_at ]`, `[ path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, created_at ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, created_at ]`, `[ automation_id, automation_run_id, status, created_at ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, created_at ]`, `[ automation_id, operation, status, created_at ]`, `[ automation_id, path, status, created_at ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, created_at ]`, `[ automation_run_id, operation, status, created_at ]`, `[ automation_run_id, path, status, created_at ]`, `[ operation, path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, created_at ]`, `[ automation_id, automation_run_id, operation, status, created_at ]`, `[ automation_id, automation_run_id, path, status, created_at ]`, `[ automation_id, operation, path, status, created_at ]`, `[ automation_run_id, operation, path, status, created_at ]` or `[ automation_id, automation_run_id, operation, path, status, created_at ]`.
|
|
51
49
|
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ created_at ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, created_at ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, created_at ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, created_at ]`, `[ path, status ]`, `[ path, created_at ]`, `[ status, created_at ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, created_at ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, created_at ]`, `[ automation_id, path, status ]`, `[ automation_id, path, created_at ]`, `[ automation_id, status, created_at ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, created_at ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, created_at ]`, `[ automation_run_id, status, created_at ]`, `[ operation, path, status ]`, `[ operation, path, created_at ]`, `[ operation, status, created_at ]`, `[ path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, created_at ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, created_at ]`, `[ automation_id, automation_run_id, status, created_at ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, created_at ]`, `[ automation_id, operation, status, created_at ]`, `[ automation_id, path, status, created_at ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, created_at ]`, `[ automation_run_id, operation, status, created_at ]`, `[ automation_run_id, path, status, created_at ]`, `[ operation, path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, created_at ]`, `[ automation_id, automation_run_id, operation, status, created_at ]`, `[ automation_id, automation_run_id, path, status, created_at ]`, `[ automation_id, operation, path, status, created_at ]`, `[ automation_run_id, operation, path, status, created_at ]` or `[ automation_id, automation_run_id, operation, path, status, created_at ]`.
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
---
|
|
55
|
-
|
|
56
|
-
## Create an export CSV of Automation Log resources
|
|
57
|
-
|
|
58
|
-
```
|
|
59
|
-
Files::AutomationLog.create_export
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
### Parameters
|
|
63
|
-
|
|
64
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation_id`, `automation_run_id`, `operation`, `path`, `status` or `created_at`. Valid field combinations are `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ created_at ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, created_at ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, created_at ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, created_at ]`, `[ path, status ]`, `[ path, created_at ]`, `[ status, created_at ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, created_at ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, created_at ]`, `[ automation_id, path, status ]`, `[ automation_id, path, created_at ]`, `[ automation_id, status, created_at ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, created_at ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, created_at ]`, `[ automation_run_id, status, created_at ]`, `[ operation, path, status ]`, `[ operation, path, created_at ]`, `[ operation, status, created_at ]`, `[ path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, created_at ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, created_at ]`, `[ automation_id, automation_run_id, status, created_at ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, created_at ]`, `[ automation_id, operation, status, created_at ]`, `[ automation_id, path, status, created_at ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, created_at ]`, `[ automation_run_id, operation, status, created_at ]`, `[ automation_run_id, path, status, created_at ]`, `[ operation, path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, created_at ]`, `[ automation_id, automation_run_id, operation, status, created_at ]`, `[ automation_id, automation_run_id, path, status, created_at ]`, `[ automation_id, operation, path, status, created_at ]`, `[ automation_run_id, operation, path, status, created_at ]` or `[ automation_id, automation_run_id, operation, path, status, created_at ]`.
|
|
65
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ created_at ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, created_at ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, created_at ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, created_at ]`, `[ path, status ]`, `[ path, created_at ]`, `[ status, created_at ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, created_at ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, created_at ]`, `[ automation_id, path, status ]`, `[ automation_id, path, created_at ]`, `[ automation_id, status, created_at ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, created_at ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, created_at ]`, `[ automation_run_id, status, created_at ]`, `[ operation, path, status ]`, `[ operation, path, created_at ]`, `[ operation, status, created_at ]`, `[ path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, created_at ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, created_at ]`, `[ automation_id, automation_run_id, status, created_at ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, created_at ]`, `[ automation_id, operation, status, created_at ]`, `[ automation_id, path, status, created_at ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, created_at ]`, `[ automation_run_id, operation, status, created_at ]`, `[ automation_run_id, path, status, created_at ]`, `[ operation, path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, created_at ]`, `[ automation_id, automation_run_id, operation, status, created_at ]`, `[ automation_id, automation_run_id, path, status, created_at ]`, `[ automation_id, operation, path, status, created_at ]`, `[ automation_run_id, operation, path, status, created_at ]` or `[ automation_id, automation_run_id, operation, path, status, created_at ]`.
|
|
66
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ created_at ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, created_at ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, created_at ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, created_at ]`, `[ path, status ]`, `[ path, created_at ]`, `[ status, created_at ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, created_at ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, created_at ]`, `[ automation_id, path, status ]`, `[ automation_id, path, created_at ]`, `[ automation_id, status, created_at ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, created_at ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, created_at ]`, `[ automation_run_id, status, created_at ]`, `[ operation, path, status ]`, `[ operation, path, created_at ]`, `[ operation, status, created_at ]`, `[ path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, created_at ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, created_at ]`, `[ automation_id, automation_run_id, status, created_at ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, created_at ]`, `[ automation_id, operation, status, created_at ]`, `[ automation_id, path, status, created_at ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, created_at ]`, `[ automation_run_id, operation, status, created_at ]`, `[ automation_run_id, path, status, created_at ]`, `[ operation, path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, created_at ]`, `[ automation_id, automation_run_id, operation, status, created_at ]`, `[ automation_id, automation_run_id, path, status, created_at ]`, `[ automation_id, operation, path, status, created_at ]`, `[ automation_run_id, operation, path, status, created_at ]` or `[ automation_id, automation_run_id, operation, path, status, created_at ]`.
|
|
67
|
-
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`. Valid field combinations are `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ created_at ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, created_at ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, created_at ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, created_at ]`, `[ path, status ]`, `[ path, created_at ]`, `[ status, created_at ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, created_at ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, created_at ]`, `[ automation_id, path, status ]`, `[ automation_id, path, created_at ]`, `[ automation_id, status, created_at ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, created_at ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, created_at ]`, `[ automation_run_id, status, created_at ]`, `[ operation, path, status ]`, `[ operation, path, created_at ]`, `[ operation, status, created_at ]`, `[ path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, created_at ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, created_at ]`, `[ automation_id, automation_run_id, status, created_at ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, created_at ]`, `[ automation_id, operation, status, created_at ]`, `[ automation_id, path, status, created_at ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, created_at ]`, `[ automation_run_id, operation, status, created_at ]`, `[ automation_run_id, path, status, created_at ]`, `[ operation, path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, created_at ]`, `[ automation_id, automation_run_id, operation, status, created_at ]`, `[ automation_id, automation_run_id, path, status, created_at ]`, `[ automation_id, operation, path, status, created_at ]`, `[ automation_run_id, operation, path, status, created_at ]` or `[ automation_id, automation_run_id, operation, path, status, created_at ]`.
|
|
68
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ created_at ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, created_at ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, created_at ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, created_at ]`, `[ path, status ]`, `[ path, created_at ]`, `[ status, created_at ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, created_at ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, created_at ]`, `[ automation_id, path, status ]`, `[ automation_id, path, created_at ]`, `[ automation_id, status, created_at ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, created_at ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, created_at ]`, `[ automation_run_id, status, created_at ]`, `[ operation, path, status ]`, `[ operation, path, created_at ]`, `[ operation, status, created_at ]`, `[ path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, created_at ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, created_at ]`, `[ automation_id, automation_run_id, status, created_at ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, created_at ]`, `[ automation_id, operation, status, created_at ]`, `[ automation_id, path, status, created_at ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, created_at ]`, `[ automation_run_id, operation, status, created_at ]`, `[ automation_run_id, path, status, created_at ]`, `[ operation, path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, created_at ]`, `[ automation_id, automation_run_id, operation, status, created_at ]`, `[ automation_id, automation_run_id, path, status, created_at ]`, `[ automation_id, operation, path, status, created_at ]`, `[ automation_run_id, operation, path, status, created_at ]` or `[ automation_id, automation_run_id, operation, path, status, created_at ]`.
|
|
69
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ created_at ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, created_at ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, created_at ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, created_at ]`, `[ path, status ]`, `[ path, created_at ]`, `[ status, created_at ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, created_at ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, created_at ]`, `[ automation_id, path, status ]`, `[ automation_id, path, created_at ]`, `[ automation_id, status, created_at ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, created_at ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, created_at ]`, `[ automation_run_id, status, created_at ]`, `[ operation, path, status ]`, `[ operation, path, created_at ]`, `[ operation, status, created_at ]`, `[ path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, created_at ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, created_at ]`, `[ automation_id, automation_run_id, status, created_at ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, created_at ]`, `[ automation_id, operation, status, created_at ]`, `[ automation_id, path, status, created_at ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, created_at ]`, `[ automation_run_id, operation, status, created_at ]`, `[ automation_run_id, path, status, created_at ]`, `[ operation, path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, created_at ]`, `[ automation_id, automation_run_id, operation, status, created_at ]`, `[ automation_id, automation_run_id, path, status, created_at ]`, `[ automation_id, operation, path, status, created_at ]`, `[ automation_run_id, operation, path, status, created_at ]` or `[ automation_id, automation_run_id, operation, path, status, created_at ]`.
|
data/docs/automation_run.md
CHANGED
|
@@ -69,22 +69,3 @@ Files::AutomationRun.find(id)
|
|
|
69
69
|
### Parameters
|
|
70
70
|
|
|
71
71
|
* `id` (int64): Required - Automation Run ID.
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
---
|
|
75
|
-
|
|
76
|
-
## Create an export CSV of Automation Run resources
|
|
77
|
-
|
|
78
|
-
```
|
|
79
|
-
Files::AutomationRun.create_export(
|
|
80
|
-
user_id: 1,
|
|
81
|
-
automation_id: 1
|
|
82
|
-
)
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
### Parameters
|
|
86
|
-
|
|
87
|
-
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
88
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation_id`, `created_at` or `status`.
|
|
89
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ workspace_id, status ]`, `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
|
|
90
|
-
* `automation_id` (int64): Required - ID of the associated Automation.
|
data/docs/bandwidth_snapshot.md
CHANGED
|
@@ -45,21 +45,3 @@ Files::BandwidthSnapshot.list
|
|
|
45
45
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `logged_at`.
|
|
46
46
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
|
|
47
47
|
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `logged_at`.
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
---
|
|
51
|
-
|
|
52
|
-
## Create an export CSV of Bandwidth Snapshot resources
|
|
53
|
-
|
|
54
|
-
```
|
|
55
|
-
Files::BandwidthSnapshot.create_export
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
### Parameters
|
|
59
|
-
|
|
60
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `logged_at`.
|
|
61
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
|
|
62
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
|
|
63
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `logged_at`.
|
|
64
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
|
|
65
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `logged_at`.
|
data/docs/behavior.md
CHANGED
|
@@ -132,20 +132,6 @@ Files::Behavior.webhook_test(
|
|
|
132
132
|
* `action` (string): Action for test body.
|
|
133
133
|
|
|
134
134
|
|
|
135
|
-
---
|
|
136
|
-
|
|
137
|
-
## Create an export CSV of Behavior resources
|
|
138
|
-
|
|
139
|
-
```
|
|
140
|
-
Files::Behavior.create_export
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
### Parameters
|
|
144
|
-
|
|
145
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior`.
|
|
146
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `clickwrap_id`, `form_field_set_id`, `impacts_ui`, `remote_server_id` or `behavior`. Valid field combinations are `[ impacts_ui, behavior ]`.
|
|
147
|
-
|
|
148
|
-
|
|
149
135
|
---
|
|
150
136
|
|
|
151
137
|
## Update Behavior
|
data/docs/bundle.md
CHANGED
|
@@ -91,8 +91,7 @@
|
|
|
91
91
|
"recursive": true,
|
|
92
92
|
"path": "example"
|
|
93
93
|
}
|
|
94
|
-
]
|
|
95
|
-
"site_id": 1
|
|
94
|
+
]
|
|
96
95
|
}
|
|
97
96
|
```
|
|
98
97
|
|
|
@@ -143,7 +142,6 @@
|
|
|
143
142
|
* `dont_allow_folders_in_uploads` (boolean): Should folder uploads be prevented?
|
|
144
143
|
* `paths` (array(string)): A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
|
|
145
144
|
* `bundlepaths` (array(object)): A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
|
|
146
|
-
* `site_id` (int64): Site id
|
|
147
145
|
* `password` (string): Password for this bundle.
|
|
148
146
|
* `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
|
|
149
147
|
* `create_snapshot` (boolean): If true, create a snapshot of this bundle's contents.
|
|
@@ -194,27 +192,6 @@ Files::Bundle.find(id,
|
|
|
194
192
|
* `deleted` (boolean): If true, show a deleted Share Link.
|
|
195
193
|
|
|
196
194
|
|
|
197
|
-
---
|
|
198
|
-
|
|
199
|
-
## Show public information for a Bundle
|
|
200
|
-
|
|
201
|
-
```
|
|
202
|
-
Files::Bundle.get_info(
|
|
203
|
-
code: "abc123",
|
|
204
|
-
imported_from_file_ac: false,
|
|
205
|
-
bundle_registration_code: "abc123",
|
|
206
|
-
recipient_code: "abc123"
|
|
207
|
-
)
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
### Parameters
|
|
211
|
-
|
|
212
|
-
* `code` (string): Required - Bundle code
|
|
213
|
-
* `imported_from_file_ac` (boolean): Is bundle imported from File.ac?
|
|
214
|
-
* `bundle_registration_code` (string): Bundle registration cookie code
|
|
215
|
-
* `recipient_code` (string): Bundle recipient code
|
|
216
|
-
|
|
217
|
-
|
|
218
195
|
---
|
|
219
196
|
|
|
220
197
|
## Create Share Link
|
|
@@ -289,30 +266,6 @@ Files::Bundle.create(
|
|
|
289
266
|
* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
|
|
290
267
|
|
|
291
268
|
|
|
292
|
-
---
|
|
293
|
-
|
|
294
|
-
## List Share Links
|
|
295
|
-
|
|
296
|
-
```
|
|
297
|
-
Files::Bundle.create_export(
|
|
298
|
-
user_id: 1,
|
|
299
|
-
deleted: false
|
|
300
|
-
)
|
|
301
|
-
```
|
|
302
|
-
|
|
303
|
-
### Parameters
|
|
304
|
-
|
|
305
|
-
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
306
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
|
|
307
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code`, `group_id`, `user_id` or `bypasses_site_expiration_rules`. Valid field combinations are `[ group_id, expires_at ]` and `[ user_id, expires_at ]`.
|
|
308
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_at`.
|
|
309
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
|
|
310
|
-
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.
|
|
311
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at` and `expires_at`.
|
|
312
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
|
|
313
|
-
* `deleted` (boolean): If true, only list deleted Share Links.
|
|
314
|
-
|
|
315
|
-
|
|
316
269
|
---
|
|
317
270
|
|
|
318
271
|
## Send email(s) with a link to bundle
|
|
@@ -330,7 +283,6 @@ Files::Bundle.share(id,
|
|
|
330
283
|
* `id` (int64): Required - Bundle ID.
|
|
331
284
|
* `to` (array(string)): A list of email addresses to share this bundle with. Required unless `recipients` is used.
|
|
332
285
|
* `note` (string): Note to include in email.
|
|
333
|
-
* `method` (string): The method to use, must be email or null
|
|
334
286
|
* `recipients` (array(object)): A list of recipients to share this bundle with. Required unless `to` is used.
|
|
335
287
|
|
|
336
288
|
|
|
@@ -441,7 +393,6 @@ bundle.share(
|
|
|
441
393
|
* `id` (int64): Required - Bundle ID.
|
|
442
394
|
* `to` (array(string)): A list of email addresses to share this bundle with. Required unless `recipients` is used.
|
|
443
395
|
* `note` (string): Note to include in email.
|
|
444
|
-
* `method` (string): The method to use, must be email or null
|
|
445
396
|
* `recipients` (array(object)): A list of recipients to share this bundle with. Required unless `to` is used.
|
|
446
397
|
|
|
447
398
|
|
data/docs/bundle_action.md
CHANGED
|
@@ -79,28 +79,3 @@ Files::BundleAction.list(
|
|
|
79
79
|
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
80
80
|
* `bundle_id` (int64): Bundle ID
|
|
81
81
|
* `bundle_registration_id` (int64): Bundle Registration ID
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
---
|
|
85
|
-
|
|
86
|
-
## Create an export CSV of Bundle Action resources
|
|
87
|
-
|
|
88
|
-
```
|
|
89
|
-
Files::BundleAction.create_export(
|
|
90
|
-
user_id: 1,
|
|
91
|
-
bundle_id: 1,
|
|
92
|
-
bundle_registration_id: 1
|
|
93
|
-
)
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
### Parameters
|
|
97
|
-
|
|
98
|
-
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
99
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `created_at` or `bundle_registration_id`.
|
|
100
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `bundle_id` or `bundle_registration_id`. Valid field combinations are `[ bundle_id, created_at ]`, `[ bundle_registration_id, created_at ]`, `[ bundle_id, bundle_registration_id ]` or `[ bundle_id, bundle_registration_id, created_at ]`.
|
|
101
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
102
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
103
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
104
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
105
|
-
* `bundle_id` (int64): Bundle ID
|
|
106
|
-
* `bundle_registration_id` (int64): Bundle Registration ID
|
data/docs/bundle_download.md
CHANGED
|
@@ -59,26 +59,3 @@ Files::BundleDownload.list(
|
|
|
59
59
|
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
60
60
|
* `bundle_id` (int64): Bundle ID
|
|
61
61
|
* `bundle_registration_id` (int64): BundleRegistration ID
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
---
|
|
65
|
-
|
|
66
|
-
## List Share Link Downloads
|
|
67
|
-
|
|
68
|
-
```
|
|
69
|
-
Files::BundleDownload.create_export(
|
|
70
|
-
bundle_id: 1,
|
|
71
|
-
bundle_registration_id: 1
|
|
72
|
-
)
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
### Parameters
|
|
76
|
-
|
|
77
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `created_at`.
|
|
78
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
|
79
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
80
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
81
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
82
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
83
|
-
* `bundle_id` (int64): Bundle ID
|
|
84
|
-
* `bundle_registration_id` (int64): BundleRegistration ID
|
data/docs/bundle_notification.md
CHANGED
|
@@ -81,25 +81,6 @@ Files::BundleNotification.create(
|
|
|
81
81
|
* `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
|
|
82
82
|
|
|
83
83
|
|
|
84
|
-
---
|
|
85
|
-
|
|
86
|
-
## List Share Link Notifications
|
|
87
|
-
|
|
88
|
-
```
|
|
89
|
-
Files::BundleNotification.create_export(
|
|
90
|
-
user_id: 1,
|
|
91
|
-
bundle_id: 1
|
|
92
|
-
)
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
### Parameters
|
|
96
|
-
|
|
97
|
-
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
98
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `bundle_id`.
|
|
99
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
|
|
100
|
-
* `bundle_id` (int64): Bundle ID
|
|
101
|
-
|
|
102
|
-
|
|
103
84
|
---
|
|
104
85
|
|
|
105
86
|
## Update Share Link Notification
|
data/docs/bundle_recipient.md
CHANGED
|
@@ -21,7 +21,6 @@
|
|
|
21
21
|
* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
|
|
22
22
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
23
23
|
* `bundle_id` (int64): Bundle to share.
|
|
24
|
-
* `method` (string): The method to use, must be email or null
|
|
25
24
|
* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
|
|
26
25
|
|
|
27
26
|
|
|
@@ -70,24 +69,4 @@ Files::BundleRecipient.create(
|
|
|
70
69
|
* `name` (string): Name of recipient.
|
|
71
70
|
* `company` (string): Company of recipient.
|
|
72
71
|
* `note` (string): Note to include in email.
|
|
73
|
-
* `method` (string): The method to use, must be email or null
|
|
74
72
|
* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
---
|
|
78
|
-
|
|
79
|
-
## List Share Link Recipients
|
|
80
|
-
|
|
81
|
-
```
|
|
82
|
-
Files::BundleRecipient.create_export(
|
|
83
|
-
user_id: 1,
|
|
84
|
-
bundle_id: 1
|
|
85
|
-
)
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
### Parameters
|
|
89
|
-
|
|
90
|
-
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
91
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`.
|
|
92
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
|
93
|
-
* `bundle_id` (int64): Required - List recipients for the bundle with this ID.
|
data/docs/bundle_registration.md
CHANGED
|
@@ -37,8 +37,6 @@
|
|
|
37
37
|
* `bundle_recipient_id` (int64): Id of associated bundle recipient
|
|
38
38
|
* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
|
|
39
39
|
* `created_at` (date-time): Registration creation date/time
|
|
40
|
-
* `bundle_recipient_registration_code` (string): Bundle recipient registration code
|
|
41
|
-
* `password` (string): Public bundle password.
|
|
42
40
|
|
|
43
41
|
|
|
44
42
|
---
|
|
@@ -59,62 +57,3 @@ Files::BundleRegistration.list(
|
|
|
59
57
|
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
60
58
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `bundle_id` or `created_at`.
|
|
61
59
|
* `bundle_id` (int64): ID of the associated Bundle
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
---
|
|
65
|
-
|
|
66
|
-
## Create Bundle Registration
|
|
67
|
-
|
|
68
|
-
```
|
|
69
|
-
Files::BundleRegistration.create(
|
|
70
|
-
password: "Password",
|
|
71
|
-
company: "Action Verb",
|
|
72
|
-
email: "john.doe@files.com",
|
|
73
|
-
name: "account",
|
|
74
|
-
bundle_code: "example"
|
|
75
|
-
)
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
### Parameters
|
|
79
|
-
|
|
80
|
-
* `bundle_recipient_registration_code` (string): Bundle recipient registration code
|
|
81
|
-
* `password` (string): Public bundle password.
|
|
82
|
-
* `company` (string): Registrant company name
|
|
83
|
-
* `email` (string): Registrant email address
|
|
84
|
-
* `name` (string): Registrant name
|
|
85
|
-
* `bundle_code` (string): Required - Bundle URL code
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
---
|
|
89
|
-
|
|
90
|
-
## Update the last time any action happened in bundle under this registration
|
|
91
|
-
|
|
92
|
-
```
|
|
93
|
-
Files::BundleRegistration.last_activity(
|
|
94
|
-
bundle_registration_code: "abc123",
|
|
95
|
-
upload_in_progress: true
|
|
96
|
-
)
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
### Parameters
|
|
100
|
-
|
|
101
|
-
* `bundle_registration_code` (string): Required - Bundle registration cookie code
|
|
102
|
-
* `upload_in_progress` (boolean): Flag that indicates if current upload is going during this registration session
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
---
|
|
106
|
-
|
|
107
|
-
## List Share Link Registrations
|
|
108
|
-
|
|
109
|
-
```
|
|
110
|
-
Files::BundleRegistration.create_export(
|
|
111
|
-
user_id: 1,
|
|
112
|
-
bundle_id: 1
|
|
113
|
-
)
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
### Parameters
|
|
117
|
-
|
|
118
|
-
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
119
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `bundle_id` or `created_at`.
|
|
120
|
-
* `bundle_id` (int64): ID of the associated Bundle
|
data/docs/chat_session.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
```
|
|
6
6
|
{
|
|
7
7
|
"id": "example",
|
|
8
|
+
"title": "example",
|
|
8
9
|
"user_id": 1,
|
|
9
10
|
"ai_task_id": 1,
|
|
10
11
|
"workspace_id": 1,
|
|
@@ -22,6 +23,7 @@
|
|
|
22
23
|
```
|
|
23
24
|
|
|
24
25
|
* `id` (string): Chat Session ID.
|
|
26
|
+
* `title` (string): Short AI-generated chat title.
|
|
25
27
|
* `user_id` (int64): User ID.
|
|
26
28
|
* `ai_task_id` (int64): AI Task ID. Present when the conversation was started by an AI Task.
|
|
27
29
|
* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
|
|
@@ -57,17 +59,3 @@ Files::ChatSession.find(id)
|
|
|
57
59
|
### Parameters
|
|
58
60
|
|
|
59
61
|
* `id` (string): Required - Chat Session ID.
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
---
|
|
63
|
-
|
|
64
|
-
## Create an export CSV of Chat Session resources
|
|
65
|
-
|
|
66
|
-
```
|
|
67
|
-
Files::ChatSession.create_export
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
### Parameters
|
|
71
|
-
|
|
72
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `id`.
|
|
73
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `ai_task_id`, `user_id` or `workspace_id`.
|
|
@@ -83,15 +83,6 @@ Files::ChildSiteManagementPolicy.create(
|
|
|
83
83
|
* `description` (string): Description for this policy.
|
|
84
84
|
|
|
85
85
|
|
|
86
|
-
---
|
|
87
|
-
|
|
88
|
-
## Create an export CSV of Child Site Management Policy resources
|
|
89
|
-
|
|
90
|
-
```
|
|
91
|
-
Files::ChildSiteManagementPolicy.create_export
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
|
|
95
86
|
---
|
|
96
87
|
|
|
97
88
|
## Update Child Site Management Policy
|