files.com 1.1.671 → 1.1.673
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 +67 -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/path_util.rb +1 -1
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +0 -59
- data/shared/normalization_for_comparison_test_data.json +3 -1
- data/spec/models/file_underscore_destinations_spec.rb +24 -0
- data/spec/path_util_spec.rb +5 -0
- metadata +2 -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/sftp_host_key.md
CHANGED
data/docs/share_group.md
CHANGED
|
@@ -76,21 +76,6 @@ Files::ShareGroup.create(
|
|
|
76
76
|
* `members` (array(object)): Required - A list of share group members.
|
|
77
77
|
|
|
78
78
|
|
|
79
|
-
---
|
|
80
|
-
|
|
81
|
-
## Create an export CSV of Share Group resources
|
|
82
|
-
|
|
83
|
-
```
|
|
84
|
-
Files::ShareGroup.create_export(
|
|
85
|
-
user_id: 1
|
|
86
|
-
)
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
### Parameters
|
|
90
|
-
|
|
91
|
-
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
92
|
-
|
|
93
|
-
|
|
94
79
|
---
|
|
95
80
|
|
|
96
81
|
## Update Share Group
|
|
@@ -227,15 +227,6 @@ Files::SiemHttpDestination.create(
|
|
|
227
227
|
* `destination_url` (string): Destination Url
|
|
228
228
|
|
|
229
229
|
|
|
230
|
-
---
|
|
231
|
-
|
|
232
|
-
## Create an export CSV of SIEM HTTP Destination resources
|
|
233
|
-
|
|
234
|
-
```
|
|
235
|
-
Files::SiemHttpDestination.create_export
|
|
236
|
-
```
|
|
237
|
-
|
|
238
|
-
|
|
239
230
|
---
|
|
240
231
|
|
|
241
232
|
## send_test_entry SIEM HTTP Destination
|
|
@@ -58,21 +58,3 @@ Files::SiemHttpDestinationEvent.find(id)
|
|
|
58
58
|
### Parameters
|
|
59
59
|
|
|
60
60
|
* `id` (int64): Required - Siem Http Destination Event ID.
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
---
|
|
64
|
-
|
|
65
|
-
## Create an export CSV of SIEM HTTP Destination Event resources
|
|
66
|
-
|
|
67
|
-
```
|
|
68
|
-
Files::SiemHttpDestinationEvent.create_export
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
### Parameters
|
|
72
|
-
|
|
73
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `status` or `siem_http_destination_id`.
|
|
74
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `siem_http_destination_id` or `status`. Valid field combinations are `[ siem_http_destination_id, created_at ]`, `[ status, created_at ]`, `[ siem_http_destination_id, status ]` or `[ siem_http_destination_id, status, created_at ]`.
|
|
75
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
76
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
77
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
78
|
-
* `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/site.md
CHANGED
|
@@ -543,19 +543,6 @@
|
|
|
543
543
|
* `welcome_email_enabled` (boolean): Will the welcome email be sent to new users?
|
|
544
544
|
* `welcome_screen` (string): Does the welcome screen appear?
|
|
545
545
|
* `windows_mode_ftp` (boolean): Does FTP user Windows emulation mode?
|
|
546
|
-
* `lead_cookie_code` (string):
|
|
547
|
-
* `recaptcha_token` (string):
|
|
548
|
-
* `username` (string):
|
|
549
|
-
* `password` (string):
|
|
550
|
-
* `utm_term` (string):
|
|
551
|
-
* `utm_source` (string):
|
|
552
|
-
* `utm_content` (string):
|
|
553
|
-
* `utm_medium` (string):
|
|
554
|
-
* `utm_campaign` (string):
|
|
555
|
-
* `utm_domain` (string):
|
|
556
|
-
* `gclid` (string):
|
|
557
|
-
* `plan_id` (int64):
|
|
558
|
-
* `brand` (string):
|
|
559
546
|
|
|
560
547
|
|
|
561
548
|
---
|
|
@@ -576,123 +563,6 @@ Files::Site.get_usage
|
|
|
576
563
|
```
|
|
577
564
|
|
|
578
565
|
|
|
579
|
-
---
|
|
580
|
-
|
|
581
|
-
## Show plan that will be switched to in the future. (Populated if current plan is deprecated and no longer offered beyond the current billing period.)
|
|
582
|
-
|
|
583
|
-
```
|
|
584
|
-
Files::Site.get_switch_to_plan
|
|
585
|
-
```
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
---
|
|
589
|
-
|
|
590
|
-
## Show the current billing plan of a site
|
|
591
|
-
|
|
592
|
-
```
|
|
593
|
-
Files::Site.get_plan(
|
|
594
|
-
currency: "USD"
|
|
595
|
-
)
|
|
596
|
-
```
|
|
597
|
-
|
|
598
|
-
### Parameters
|
|
599
|
-
|
|
600
|
-
* `currency` (string): Currency.
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
---
|
|
604
|
-
|
|
605
|
-
## Complete a PayPal subscription
|
|
606
|
-
|
|
607
|
-
```
|
|
608
|
-
Files::Site.get_paypal_express_info(
|
|
609
|
-
paypal_token: "[token]"
|
|
610
|
-
)
|
|
611
|
-
```
|
|
612
|
-
|
|
613
|
-
### Parameters
|
|
614
|
-
|
|
615
|
-
* `paypal_token` (string): Required - Billing token for use with paypal.
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
---
|
|
619
|
-
|
|
620
|
-
## Initiate a new PayPal subscription
|
|
621
|
-
|
|
622
|
-
```
|
|
623
|
-
Files::Site.get_paypal_express(
|
|
624
|
-
return_to_url: "https://app.files.com/...",
|
|
625
|
-
plan_id: 1
|
|
626
|
-
)
|
|
627
|
-
```
|
|
628
|
-
|
|
629
|
-
### Parameters
|
|
630
|
-
|
|
631
|
-
* `return_to_url` (string): Required - URL that paypal express forwards the user to.
|
|
632
|
-
* `plan_id` (int64): Plan ID to switch to.
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
---
|
|
636
|
-
|
|
637
|
-
## Apply a trial code to the current Mover site
|
|
638
|
-
|
|
639
|
-
```
|
|
640
|
-
Files::Site.mover_trial_code(
|
|
641
|
-
code: "TRIAL30"
|
|
642
|
-
)
|
|
643
|
-
```
|
|
644
|
-
|
|
645
|
-
### Parameters
|
|
646
|
-
|
|
647
|
-
* `code` (string): Required - Mover trial code to apply
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
---
|
|
651
|
-
|
|
652
|
-
## Create Site
|
|
653
|
-
|
|
654
|
-
```
|
|
655
|
-
Files::Site.create(
|
|
656
|
-
name: "Action Verb",
|
|
657
|
-
email: "johndoe@gmail.com",
|
|
658
|
-
lead_cookie_code: "lead_cookie_code",
|
|
659
|
-
recaptcha_token: "recaptcha_token",
|
|
660
|
-
reply_to_email: "customer-service@gmail.com",
|
|
661
|
-
phone: "+18002868372",
|
|
662
|
-
contact_name: "John Doe",
|
|
663
|
-
username: "MyUsername",
|
|
664
|
-
password: "MyNewPassword101",
|
|
665
|
-
currency: "USD",
|
|
666
|
-
language: "en",
|
|
667
|
-
plan_id: 1,
|
|
668
|
-
brand: "files"
|
|
669
|
-
)
|
|
670
|
-
```
|
|
671
|
-
|
|
672
|
-
### Parameters
|
|
673
|
-
|
|
674
|
-
* `name` (string): Required -
|
|
675
|
-
* `email` (string): Required -
|
|
676
|
-
* `lead_cookie_code` (string): Required -
|
|
677
|
-
* `recaptcha_token` (string): Required -
|
|
678
|
-
* `reply_to_email` (string):
|
|
679
|
-
* `phone` (string):
|
|
680
|
-
* `contact_name` (string):
|
|
681
|
-
* `username` (string):
|
|
682
|
-
* `password` (string):
|
|
683
|
-
* `currency` (string):
|
|
684
|
-
* `language` (string):
|
|
685
|
-
* `utm_term` (string):
|
|
686
|
-
* `utm_source` (string):
|
|
687
|
-
* `utm_content` (string):
|
|
688
|
-
* `utm_medium` (string):
|
|
689
|
-
* `utm_campaign` (string):
|
|
690
|
-
* `utm_domain` (string):
|
|
691
|
-
* `gclid` (string):
|
|
692
|
-
* `plan_id` (int64):
|
|
693
|
-
* `brand` (string):
|
|
694
|
-
|
|
695
|
-
|
|
696
566
|
---
|
|
697
567
|
|
|
698
568
|
## Update Site Settings
|
|
@@ -1059,52 +929,3 @@ Files::Site.update(
|
|
|
1059
929
|
* `ldap_password_change_confirmation` (string): Confirm new LDAP password.
|
|
1060
930
|
* `redirect_old_subdomain` (boolean): If true, and if changing the site subdomain, then create a redirect from the previous Files.com subdomain to the new Files.com subdomain.
|
|
1061
931
|
* `smtp_password` (string): Password for SMTP server.
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
---
|
|
1065
|
-
|
|
1066
|
-
## Change the current billing plan for the site
|
|
1067
|
-
|
|
1068
|
-
```
|
|
1069
|
-
Files::Site.update_plan(id,
|
|
1070
|
-
billing_frequency: 1
|
|
1071
|
-
)
|
|
1072
|
-
```
|
|
1073
|
-
|
|
1074
|
-
### Parameters
|
|
1075
|
-
|
|
1076
|
-
* `id` (int64): Required - Plan ID.
|
|
1077
|
-
* `billing_frequency` (int64): The billing frequency for the site. Must be 1 (monthly) or 12 (annual).
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
---
|
|
1081
|
-
|
|
1082
|
-
## Cancel site
|
|
1083
|
-
|
|
1084
|
-
```
|
|
1085
|
-
Files::Site.delete(
|
|
1086
|
-
reason: "Reason"
|
|
1087
|
-
)
|
|
1088
|
-
```
|
|
1089
|
-
|
|
1090
|
-
### Parameters
|
|
1091
|
-
|
|
1092
|
-
* `reason` (string): Reason the site was cancelled.
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
---
|
|
1096
|
-
|
|
1097
|
-
## Change the current billing plan for the site
|
|
1098
|
-
|
|
1099
|
-
```
|
|
1100
|
-
site = Files::Site.find(id)
|
|
1101
|
-
|
|
1102
|
-
site.update_plan(
|
|
1103
|
-
billing_frequency: 1
|
|
1104
|
-
)
|
|
1105
|
-
```
|
|
1106
|
-
|
|
1107
|
-
### Parameters
|
|
1108
|
-
|
|
1109
|
-
* `id` (int64): Required - Plan ID.
|
|
1110
|
-
* `billing_frequency` (int64): The billing frequency for the site. Must be 1 (monthly) or 12 (annual).
|
|
@@ -45,19 +45,6 @@ Files::SiteSubdomainRedirect.find(id)
|
|
|
45
45
|
* `id` (int64): Required - Site Subdomain Redirect ID.
|
|
46
46
|
|
|
47
47
|
|
|
48
|
-
---
|
|
49
|
-
|
|
50
|
-
## Create an export CSV of Site Subdomain Redirect resources
|
|
51
|
-
|
|
52
|
-
```
|
|
53
|
-
Files::SiteSubdomainRedirect.create_export
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
### Parameters
|
|
57
|
-
|
|
58
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `id`.
|
|
59
|
-
|
|
60
|
-
|
|
61
48
|
---
|
|
62
49
|
|
|
63
50
|
## Delete Site Subdomain Redirect
|
data/docs/snapshot.md
CHANGED
data/docs/sso_event.md
CHANGED
|
@@ -71,22 +71,3 @@ Files::SsoEvent.find(id)
|
|
|
71
71
|
### Parameters
|
|
72
72
|
|
|
73
73
|
* `id` (int64): Required - Sso Event ID.
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
---
|
|
77
|
-
|
|
78
|
-
## Create an export CSV of SSO Event resources
|
|
79
|
-
|
|
80
|
-
```
|
|
81
|
-
Files::SsoEvent.create_export
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
### Parameters
|
|
85
|
-
|
|
86
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `event_type`, `status` or `user_id`.
|
|
87
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `idp_uid`, `ip`, `provider`, `status`, `user_id` or `username`. Valid field combinations are `[ event_type, created_at ]`, `[ idp_uid, created_at ]`, `[ ip, created_at ]`, `[ provider, created_at ]`, `[ status, created_at ]`, `[ user_id, created_at ]`, `[ username, created_at ]`, `[ event_type, status ]`, `[ idp_uid, status ]`, `[ ip, status ]`, `[ provider, status ]`, `[ user_id, status ]`, `[ username, status ]`, `[ event_type, status, created_at ]`, `[ idp_uid, status, created_at ]`, `[ ip, status, created_at ]`, `[ provider, status, created_at ]`, `[ user_id, status, created_at ]` or `[ username, status, created_at ]`.
|
|
88
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
89
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
90
|
-
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `idp_uid`, `ip`, `provider` or `username`.
|
|
91
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
92
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|