files.com 1.1.670 → 1.1.671
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/account.md +155 -0
- data/docs/action_log.md +21 -1
- data/docs/action_notification_export_result.md +17 -0
- data/docs/action_webhook_failure.md +28 -0
- data/docs/agent_proxy_identity.md +49 -0
- data/docs/agent_proxy_identity_endpoint.md +11 -0
- data/docs/agent_proxy_identity_result.md +24 -0
- data/docs/agent_v2_auth.md +17 -0
- data/docs/ai_assistant_personality.md +14 -0
- data/docs/ai_task.md +14 -0
- data/docs/announcement.md +57 -0
- data/docs/api_key.md +27 -1
- data/docs/api_request_log.md +21 -1
- data/docs/app.md +15 -0
- data/docs/as2_incoming_message.md +18 -0
- data/docs/as2_outgoing_message.md +18 -0
- data/docs/as2_partner.md +14 -0
- data/docs/as2_station.md +14 -0
- data/docs/automation.md +22 -1
- data/docs/automation_log.md +21 -1
- data/docs/automation_run.md +19 -0
- data/docs/bandwidth_snapshot.md +18 -0
- data/docs/behavior.md +14 -0
- data/docs/blog_post.md +57 -0
- data/docs/bundle.md +50 -1
- data/docs/bundle_action.md +25 -0
- data/docs/bundle_download.md +23 -0
- data/docs/bundle_notification.md +19 -0
- data/docs/bundle_recipient.md +21 -0
- data/docs/bundle_recipient_registration.md +39 -0
- data/docs/bundle_registration.md +61 -0
- data/docs/certificate.md +258 -0
- data/docs/chat_session.md +14 -0
- data/docs/child_site.md +583 -0
- data/docs/child_site_management_policy.md +9 -0
- data/docs/clickwrap.md +13 -0
- data/docs/clickwrap_acceptance.md +30 -0
- data/docs/client_log.md +17 -0
- data/docs/crash_report.md +50 -0
- data/docs/custom_domain.md +13 -0
- data/docs/custom_domain_for_proxy.md +23 -0
- data/docs/desktop_configuration_profile.md +14 -0
- data/docs/dns_record.md +9 -0
- data/docs/email_incoming_message.md +19 -0
- data/docs/email_log.md +20 -1
- data/docs/email_preference.md +108 -0
- data/docs/email_preference_bundle_notification.md +15 -0
- data/docs/email_preference_notification.md +17 -0
- data/docs/event_channel.md +14 -0
- data/docs/event_delivery_attempt.md +14 -0
- data/docs/event_record.md +19 -0
- data/docs/event_subscription.md +14 -0
- data/docs/event_target.md +14 -0
- data/docs/exavault_api_request_log.md +21 -1
- data/docs/expectation.md +14 -0
- data/docs/expectation_evaluation.md +14 -0
- data/docs/expectation_incident.md +14 -0
- data/docs/export.md +90 -0
- data/docs/external_event.md +18 -0
- data/docs/file.md +90 -2
- data/docs/file_migration.md +32 -0
- data/docs/file_migration_log.md +20 -1
- data/docs/file_upload_part.md +3 -1
- data/docs/folder.md +20 -0
- data/docs/form_field_set.md +15 -0
- data/docs/front_end_server.md +111 -0
- data/docs/frontend_metric.md +34 -0
- data/docs/ftp_action_log.md +21 -1
- data/docs/gpg_key.md +21 -0
- data/docs/group.md +19 -0
- data/docs/group_user.md +22 -2
- data/docs/history.md +85 -0
- data/docs/history_export_result.md +17 -0
- data/docs/holiday_region.md +9 -0
- data/docs/inbound_s3_log.md +21 -1
- data/docs/inbox.md +102 -0
- data/docs/inbox_recipient.md +19 -0
- data/docs/inbox_recipient_registration.md +35 -0
- data/docs/inbox_registration.md +57 -0
- data/docs/inbox_upload.md +18 -0
- data/docs/invoice.md +9 -0
- data/docs/ip.md +63 -0
- data/docs/ip_abuse_entry.md +47 -0
- data/docs/ip_address.md +59 -0
- data/docs/key_lifecycle_rule.md +14 -0
- data/docs/label.md +9 -0
- data/docs/lead.md +161 -0
- data/docs/lock.md +15 -0
- data/docs/message.md +17 -0
- data/docs/message_comment.md +18 -0
- data/docs/message_comment_reaction.md +18 -0
- data/docs/message_reaction.md +17 -0
- data/docs/metadata_category.md +13 -0
- data/docs/monitoring_stat.md +38 -0
- data/docs/monitoring_stats.md +15 -0
- data/docs/mover_package.md +68 -0
- data/docs/notification.md +20 -0
- data/docs/nps_response.md +75 -0
- data/docs/oauth_redirect.md +11 -0
- data/docs/outbound_connection_log.md +21 -1
- data/docs/paired_api_key.md +19 -0
- data/docs/partner.md +14 -0
- data/docs/partner_channel.md +14 -0
- data/docs/partner_site_request.md +14 -0
- data/docs/payment.md +9 -0
- data/docs/paypal_express_info.md +31 -0
- data/docs/paypal_express_url.md +11 -0
- data/docs/pending_work_event.md +18 -0
- data/docs/permission.md +22 -0
- data/docs/plan.md +107 -0
- data/docs/preview.md +57 -0
- data/docs/project.md +9 -0
- data/docs/public_hosting_request_log.md +21 -1
- data/docs/public_hosting_session_pairing.md +15 -0
- data/docs/public_inbox.md +121 -0
- data/docs/public_key.md +21 -0
- data/docs/public_url.md +59 -0
- data/docs/regional_migration.md +0 -0
- data/docs/release.md +83 -0
- data/docs/release_package.md +19 -0
- data/docs/remote_bandwidth_snapshot.md +18 -0
- data/docs/remote_mount_backend.md +13 -0
- data/docs/remote_server.md +233 -0
- data/docs/remote_server_credential.md +15 -0
- data/docs/request.md +17 -0
- data/docs/restore.md +14 -0
- data/docs/revision.md +40 -0
- data/docs/safe_plan.md +0 -0
- data/docs/scheduled_export.md +15 -0
- data/docs/scim_log.md +13 -0
- data/docs/session.md +232 -1
- data/docs/session_available_site.md +26 -0
- data/docs/setting.md +33 -0
- data/docs/settings.md +498 -0
- data/docs/settings_change.md +16 -0
- data/docs/sftp_action_log.md +21 -1
- data/docs/sftp_host_key.md +9 -0
- data/docs/share_group.md +15 -0
- data/docs/siem_http_destination.md +9 -0
- data/docs/siem_http_destination_event.md +18 -0
- data/docs/site.md +179 -0
- data/docs/site_subdomain_redirect.md +13 -0
- data/docs/snapshot.md +9 -0
- data/docs/ssl_certificate.md +37 -0
- data/docs/sso_event.md +19 -0
- data/docs/sso_strategy.md +406 -0
- data/docs/staging_site.md +591 -0
- data/docs/support_request.md +126 -0
- data/docs/sync.md +14 -0
- data/docs/sync_api_usage_snapshot.md +23 -0
- data/docs/sync_api_usage_snapshot_report.md +71 -0
- data/docs/sync_bandwidth_snapshot.md +48 -0
- data/docs/sync_log.md +20 -1
- data/docs/sync_run.md +21 -0
- data/docs/two_factor_authentication_method.md +169 -0
- data/docs/usage_daily_snapshot.md +18 -0
- data/docs/usage_snapshot.md +9 -0
- data/docs/user.md +49 -2
- data/docs/user_cipher_use.md +21 -0
- data/docs/user_lifecycle_rule.md +14 -0
- data/docs/user_request.md +9 -0
- data/docs/user_security_event.md +18 -0
- data/docs/user_sftp_client_use.md +15 -0
- data/docs/warning.md +36 -0
- data/docs/web_dav_action_log.md +21 -1
- data/docs/webauthn_sign_request.md +13 -0
- data/docs/workspace.md +15 -0
- data/docs/zip_download.md +32 -0
- data/docs/zip_download_file.md +45 -0
- data/docs/zip_download_files.md +23 -0
- data/lib/files.com/models/account.rb +346 -0
- data/lib/files.com/models/action_log.rb +24 -0
- data/lib/files.com/models/action_notification_export_result.rb +12 -0
- data/lib/files.com/models/action_webhook_failure.rb +34 -0
- data/lib/files.com/models/agent_proxy_identity.rb +47 -0
- data/lib/files.com/models/agent_proxy_identity_endpoint.rb +17 -0
- data/lib/files.com/models/agent_proxy_identity_result.rb +27 -0
- data/lib/files.com/models/agent_v2_auth.rb +32 -0
- data/lib/files.com/models/ai_assistant_personality.rb +11 -0
- data/lib/files.com/models/ai_task.rb +11 -0
- data/lib/files.com/models/announcement.rb +89 -0
- data/lib/files.com/models/api_key.rb +39 -5
- data/lib/files.com/models/api_request_log.rb +24 -0
- data/lib/files.com/models/app.rb +13 -0
- data/lib/files.com/models/as2_incoming_message.rb +19 -0
- data/lib/files.com/models/as2_outgoing_message.rb +19 -0
- data/lib/files.com/models/as2_partner.rb +11 -0
- data/lib/files.com/models/as2_station.rb +11 -0
- data/lib/files.com/models/automation.rb +30 -0
- data/lib/files.com/models/automation_log.rb +24 -0
- data/lib/files.com/models/automation_run.rb +16 -0
- data/lib/files.com/models/bandwidth_snapshot.rb +19 -0
- data/lib/files.com/models/behavior.rb +11 -0
- data/lib/files.com/models/blog_post.rb +84 -0
- data/lib/files.com/models/bundle.rb +52 -0
- data/lib/files.com/models/bundle_action.rb +25 -0
- data/lib/files.com/models/bundle_download.rb +23 -0
- data/lib/files.com/models/bundle_notification.rb +15 -0
- data/lib/files.com/models/bundle_recipient.rb +27 -0
- data/lib/files.com/models/bundle_recipient_registration.rb +105 -0
- data/lib/files.com/models/bundle_registration.rb +125 -0
- data/lib/files.com/models/certificate.rb +455 -0
- data/lib/files.com/models/chat_session.rb +11 -0
- data/lib/files.com/models/child_site.rb +1756 -0
- data/lib/files.com/models/child_site_management_policy.rb +5 -0
- data/lib/files.com/models/clickwrap.rb +9 -0
- data/lib/files.com/models/clickwrap_acceptance.rb +56 -0
- data/lib/files.com/models/client_log.rb +25 -0
- data/lib/files.com/models/crash_report.rb +151 -0
- data/lib/files.com/models/custom_domain.rb +9 -0
- data/lib/files.com/models/custom_domain_for_proxy.rb +47 -0
- data/lib/files.com/models/desktop_configuration_profile.rb +11 -0
- data/lib/files.com/models/dns_record.rb +5 -0
- data/lib/files.com/models/email_incoming_message.rb +21 -0
- data/lib/files.com/models/email_log.rb +22 -0
- data/lib/files.com/models/email_preference.rb +124 -0
- data/lib/files.com/models/email_preference_bundle_notification.rb +27 -0
- data/lib/files.com/models/email_preference_notification.rb +32 -0
- data/lib/files.com/models/event_channel.rb +11 -0
- data/lib/files.com/models/event_delivery_attempt.rb +11 -0
- data/lib/files.com/models/event_record.rb +21 -0
- data/lib/files.com/models/event_subscription.rb +11 -0
- data/lib/files.com/models/event_target.rb +11 -0
- data/lib/files.com/models/exavault_api_request_log.rb +24 -0
- data/lib/files.com/models/expectation.rb +11 -0
- data/lib/files.com/models/expectation_evaluation.rb +11 -0
- data/lib/files.com/models/expectation_incident.rb +11 -0
- data/lib/files.com/models/export.rb +153 -0
- data/lib/files.com/models/external_event.rb +19 -0
- data/lib/files.com/models/file.rb +207 -0
- data/lib/files.com/models/file_migration.rb +27 -0
- data/lib/files.com/models/file_migration_log.rb +22 -0
- data/lib/files.com/models/file_upload_part.rb +5 -0
- data/lib/files.com/models/folder.rb +69 -0
- data/lib/files.com/models/form_field_set.rb +9 -0
- data/lib/files.com/models/front_end_server.rb +335 -0
- data/lib/files.com/models/frontend_metric.rb +65 -0
- data/lib/files.com/models/ftp_action_log.rb +24 -0
- data/lib/files.com/models/gpg_key.rb +21 -0
- data/lib/files.com/models/group.rb +16 -0
- data/lib/files.com/models/group_user.rb +21 -1
- data/lib/files.com/models/history.rb +94 -0
- data/lib/files.com/models/history_export_result.rb +12 -0
- data/lib/files.com/models/holiday_region.rb +5 -0
- data/lib/files.com/models/inbound_s3_log.rb +24 -0
- data/lib/files.com/models/inbox.rb +123 -0
- data/lib/files.com/models/inbox_recipient.rb +25 -0
- data/lib/files.com/models/inbox_recipient_registration.rb +87 -0
- data/lib/files.com/models/inbox_registration.rb +121 -0
- data/lib/files.com/models/inbox_upload.rb +19 -0
- data/lib/files.com/models/invoice.rb +5 -0
- data/lib/files.com/models/ip.rb +82 -0
- data/lib/files.com/models/ip_abuse_entry.rb +96 -0
- data/lib/files.com/models/ip_address.rb +37 -0
- data/lib/files.com/models/key_lifecycle_rule.rb +11 -0
- data/lib/files.com/models/label.rb +22 -0
- data/lib/files.com/models/lead.rb +434 -0
- data/lib/files.com/models/lock.rb +27 -0
- data/lib/files.com/models/message.rb +12 -0
- data/lib/files.com/models/message_comment.rb +14 -0
- data/lib/files.com/models/message_comment_reaction.rb +14 -0
- data/lib/files.com/models/message_reaction.rb +12 -0
- data/lib/files.com/models/metadata_category.rb +9 -0
- data/lib/files.com/models/monitoring_stat.rb +43 -0
- data/lib/files.com/models/monitoring_stats.rb +22 -0
- data/lib/files.com/models/mover_package.rb +80 -0
- data/lib/files.com/models/notification.rb +18 -0
- data/lib/files.com/models/nps_response.rb +128 -0
- data/lib/files.com/models/oauth_redirect.rb +17 -0
- data/lib/files.com/models/outbound_connection_log.rb +24 -0
- data/lib/files.com/models/paired_api_key.rb +37 -0
- data/lib/files.com/models/partner.rb +11 -0
- data/lib/files.com/models/partner_channel.rb +11 -0
- data/lib/files.com/models/partner_site_request.rb +11 -0
- data/lib/files.com/models/payment.rb +5 -0
- data/lib/files.com/models/paypal_express_info.rb +67 -0
- data/lib/files.com/models/paypal_express_url.rb +17 -0
- data/lib/files.com/models/pending_work_event.rb +19 -0
- data/lib/files.com/models/permission.rb +22 -0
- data/lib/files.com/models/plan.rb +209 -0
- data/lib/files.com/models/preview.rb +57 -0
- data/lib/files.com/models/project.rb +5 -0
- data/lib/files.com/models/public_hosting_request_log.rb +24 -0
- data/lib/files.com/models/public_hosting_session_pairing.rb +27 -0
- data/lib/files.com/models/public_inbox.rb +142 -0
- data/lib/files.com/models/public_key.rb +21 -0
- data/lib/files.com/models/public_url.rb +177 -0
- data/lib/files.com/models/regional_migration.rb +12 -0
- data/lib/files.com/models/release.rb +153 -0
- data/lib/files.com/models/release_package.rb +37 -0
- data/lib/files.com/models/remote_bandwidth_snapshot.rb +19 -0
- data/lib/files.com/models/remote_mount_backend.rb +9 -0
- data/lib/files.com/models/remote_server.rb +297 -0
- data/lib/files.com/models/remote_server_credential.rb +13 -0
- data/lib/files.com/models/request.rb +12 -0
- data/lib/files.com/models/restore.rb +11 -0
- data/lib/files.com/models/revision.rb +53 -0
- data/lib/files.com/models/safe_plan.rb +12 -0
- data/lib/files.com/models/scheduled_export.rb +13 -0
- data/lib/files.com/models/scim_log.rb +9 -0
- data/lib/files.com/models/session.rb +493 -0
- data/lib/files.com/models/session_available_site.rb +47 -0
- data/lib/files.com/models/setting.rb +36 -0
- data/lib/files.com/models/settings.rb +1072 -0
- data/lib/files.com/models/settings_change.rb +16 -0
- data/lib/files.com/models/sftp_action_log.rb +24 -0
- data/lib/files.com/models/sftp_host_key.rb +5 -0
- data/lib/files.com/models/share_group.rb +9 -0
- data/lib/files.com/models/siem_http_destination.rb +5 -0
- data/lib/files.com/models/siem_http_destination_event.rb +19 -0
- data/lib/files.com/models/site.rb +1021 -0
- data/lib/files.com/models/site_subdomain_redirect.rb +9 -0
- data/lib/files.com/models/snapshot.rb +5 -0
- data/lib/files.com/models/ssl_certificate.rb +77 -0
- data/lib/files.com/models/sso_event.rb +21 -0
- data/lib/files.com/models/sso_strategy.rb +632 -0
- data/lib/files.com/models/staging_site.rb +1781 -0
- data/lib/files.com/models/support_request.rb +209 -0
- data/lib/files.com/models/sync.rb +11 -0
- data/lib/files.com/models/sync_api_usage_snapshot.rb +47 -0
- data/lib/files.com/models/sync_api_usage_snapshot_report.rb +162 -0
- data/lib/files.com/models/sync_bandwidth_snapshot.rb +104 -0
- data/lib/files.com/models/sync_log.rb +22 -0
- data/lib/files.com/models/sync_run.rb +21 -0
- data/lib/files.com/models/two_factor_authentication_method.rb +250 -0
- data/lib/files.com/models/usage_daily_snapshot.rb +19 -0
- data/lib/files.com/models/usage_snapshot.rb +5 -0
- data/lib/files.com/models/user.rb +59 -0
- data/lib/files.com/models/user_cipher_use.rb +21 -0
- data/lib/files.com/models/user_lifecycle_rule.rb +11 -0
- data/lib/files.com/models/user_request.rb +5 -0
- data/lib/files.com/models/user_security_event.rb +19 -0
- data/lib/files.com/models/user_sftp_client_use.rb +9 -0
- data/lib/files.com/models/warning.rb +38 -0
- data/lib/files.com/models/web_dav_action_log.rb +24 -0
- data/lib/files.com/models/webauthn_sign_request.rb +17 -0
- data/lib/files.com/models/workspace.rb +13 -0
- data/lib/files.com/models/zip_download.rb +73 -0
- data/lib/files.com/models/zip_download_file.rb +111 -0
- data/lib/files.com/models/zip_download_files.rb +42 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +59 -0
- metadata +120 -2
|
@@ -159,5 +159,17 @@ module Files
|
|
|
159
159
|
def self.all(params = {}, options = {})
|
|
160
160
|
list(params, options)
|
|
161
161
|
end
|
|
162
|
+
|
|
163
|
+
# Parameters:
|
|
164
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
165
|
+
# history_export_id (required) - int64 - ID of the associated history export.
|
|
166
|
+
def self.create_export(params = {}, options = {})
|
|
167
|
+
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
168
|
+
raise InvalidParameterError.new("Bad parameter: history_export_id must be an Integer") if params[:history_export_id] and !params[:history_export_id].is_a?(Integer)
|
|
169
|
+
raise MissingParameterError.new("Parameter missing: history_export_id") unless params[:history_export_id]
|
|
170
|
+
|
|
171
|
+
response, options = Api.send_request("/history_export_results/create_export", :post, params, options)
|
|
172
|
+
Export.new(response.data, options)
|
|
173
|
+
end
|
|
162
174
|
end
|
|
163
175
|
end
|
|
@@ -30,5 +30,10 @@ module Files
|
|
|
30
30
|
Api.send_request("/holiday_regions/supported", :get, params, options)
|
|
31
31
|
end
|
|
32
32
|
end
|
|
33
|
+
|
|
34
|
+
def self.supported_create_export(params = {}, options = {})
|
|
35
|
+
response, options = Api.send_request("/holiday_regions/supported/create_export", :post, params, options)
|
|
36
|
+
Export.new(response.data, options)
|
|
37
|
+
end
|
|
33
38
|
end
|
|
34
39
|
end
|
|
@@ -64,6 +64,11 @@ module Files
|
|
|
64
64
|
@attributes[:created_at]
|
|
65
65
|
end
|
|
66
66
|
|
|
67
|
+
# string - Log Type
|
|
68
|
+
def log_type
|
|
69
|
+
@attributes[:log_type]
|
|
70
|
+
end
|
|
71
|
+
|
|
67
72
|
# Parameters:
|
|
68
73
|
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
69
74
|
# per_page - int64 - Number of records to show per page. (Max: 2000, 1,000 or less is recommended).
|
|
@@ -91,5 +96,24 @@ module Files
|
|
|
91
96
|
def self.all(params = {}, options = {})
|
|
92
97
|
list(params, options)
|
|
93
98
|
end
|
|
99
|
+
|
|
100
|
+
# Parameters:
|
|
101
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `operation`, `status`, `path`, `client_ip` or `created_at`. Valid field combinations are `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, created_at ]`.
|
|
102
|
+
# 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 `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, created_at ]`.
|
|
103
|
+
# 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 `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, created_at ]`.
|
|
104
|
+
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `operation`, `status`, `path` or `client_ip`. Valid field combinations are `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, created_at ]`.
|
|
105
|
+
# 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 `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, created_at ]`.
|
|
106
|
+
# 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 `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, created_at ]`.
|
|
107
|
+
def self.create_export(params = {}, options = {})
|
|
108
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
109
|
+
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
|
|
110
|
+
raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
|
|
111
|
+
raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
|
|
112
|
+
raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
|
|
113
|
+
raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
|
|
114
|
+
|
|
115
|
+
response, options = Api.send_request("/inbound_s3_logs/create_export", :post, params, options)
|
|
116
|
+
Export.new(response.data, options)
|
|
117
|
+
end
|
|
94
118
|
end
|
|
95
119
|
end
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Files
|
|
4
|
+
class Inbox
|
|
5
|
+
attr_reader :options, :attributes
|
|
6
|
+
|
|
7
|
+
def initialize(attributes = {}, options = {})
|
|
8
|
+
@attributes = attributes || {}
|
|
9
|
+
@options = options || {}
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# string - Inbox title
|
|
13
|
+
def title
|
|
14
|
+
@attributes[:title]
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
# string - User description
|
|
18
|
+
def description
|
|
19
|
+
@attributes[:description]
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
# string - Text that will be shown to the users on the Inbox. Use this field to provide custom instructions.
|
|
23
|
+
def help_text
|
|
24
|
+
@attributes[:help_text]
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# string - Unique key for inbox
|
|
28
|
+
def key
|
|
29
|
+
@attributes[:key]
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# boolean - Show this inbox on site login page?
|
|
33
|
+
def show_on_login_page
|
|
34
|
+
@attributes[:show_on_login_page]
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# boolean - Is this inbox password protected?
|
|
38
|
+
def has_password
|
|
39
|
+
@attributes[:has_password]
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# boolean - Does this inbox require registration?
|
|
43
|
+
def require_registration
|
|
44
|
+
@attributes[:require_registration]
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# boolean - Should folder uploads be prevented?
|
|
48
|
+
def dont_allow_folders_in_uploads
|
|
49
|
+
@attributes[:dont_allow_folders_in_uploads]
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# string - Legal text that must be agreed to prior to accessing Inbox.
|
|
53
|
+
def clickwrap_body
|
|
54
|
+
@attributes[:clickwrap_body]
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# FormFieldSet - Custom Form to use
|
|
58
|
+
def form_field_set
|
|
59
|
+
@attributes[:form_field_set]
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
# boolean - Notify senders on successful uploads via email
|
|
63
|
+
def notify_senders_on_successful_uploads_via_email
|
|
64
|
+
@attributes[:notify_senders_on_successful_uploads_via_email]
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# boolean - Notify senders on successful uploads via web
|
|
68
|
+
def notify_senders_on_successful_uploads_via_web
|
|
69
|
+
@attributes[:notify_senders_on_successful_uploads_via_web]
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
# boolean - allow/disallow whitelist
|
|
73
|
+
def allow_whitelisting
|
|
74
|
+
@attributes[:allow_whitelisting]
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
# array(string) - A list of emails and domain names for whitelisting
|
|
78
|
+
def whitelist
|
|
79
|
+
@attributes[:whitelist]
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# boolean - This will disable the upload URL and can only be done if uploads via email are enabled
|
|
83
|
+
def disable_web_upload
|
|
84
|
+
@attributes[:disable_web_upload]
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# string - inbound email address to the inbox
|
|
88
|
+
def inbound_email_address
|
|
89
|
+
@attributes[:inbound_email_address]
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
# Parameters:
|
|
93
|
+
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
94
|
+
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
95
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
|
|
96
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `allow_whitelisting`.
|
|
97
|
+
def self.list(params = {}, options = {})
|
|
98
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
99
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
100
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
101
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
102
|
+
|
|
103
|
+
List.new(Inbox, params) do
|
|
104
|
+
Api.send_request("/inboxes", :get, params, options)
|
|
105
|
+
end
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
def self.all(params = {}, options = {})
|
|
109
|
+
list(params, options)
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
# Parameters:
|
|
113
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
|
|
114
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `allow_whitelisting`.
|
|
115
|
+
def self.create_export(params = {}, options = {})
|
|
116
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
117
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
118
|
+
|
|
119
|
+
response, options = Api.send_request("/inboxes/create_export", :post, params, options)
|
|
120
|
+
Export.new(response.data, options)
|
|
121
|
+
end
|
|
122
|
+
end
|
|
123
|
+
end
|
|
@@ -63,6 +63,15 @@ module Files
|
|
|
63
63
|
@attributes[:inbox_id] = value
|
|
64
64
|
end
|
|
65
65
|
|
|
66
|
+
# string - The method to use, must be email or null
|
|
67
|
+
def method
|
|
68
|
+
@attributes[:method]
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
def method=(value)
|
|
72
|
+
@attributes[:method] = value
|
|
73
|
+
end
|
|
74
|
+
|
|
66
75
|
# boolean - Set to true to share the link with the recipient upon creation.
|
|
67
76
|
def share_after_create
|
|
68
77
|
@attributes[:share_after_create]
|
|
@@ -112,6 +121,7 @@ module Files
|
|
|
112
121
|
# name - string - Name of recipient.
|
|
113
122
|
# company - string - Company of recipient.
|
|
114
123
|
# note - string - Note to include in email.
|
|
124
|
+
# method - string - The method to use, must be email or null
|
|
115
125
|
# share_after_create - boolean - Set to true to share the link with the recipient upon creation.
|
|
116
126
|
def self.create(params = {}, options = {})
|
|
117
127
|
raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params[:inbox_id] and !params[:inbox_id].is_a?(Integer)
|
|
@@ -119,11 +129,26 @@ module Files
|
|
|
119
129
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
120
130
|
raise InvalidParameterError.new("Bad parameter: company must be an String") if params[:company] and !params[:company].is_a?(String)
|
|
121
131
|
raise InvalidParameterError.new("Bad parameter: note must be an String") if params[:note] and !params[:note].is_a?(String)
|
|
132
|
+
raise InvalidParameterError.new("Bad parameter: method must be an String") if params[:method] and !params[:method].is_a?(String)
|
|
122
133
|
raise MissingParameterError.new("Parameter missing: inbox_id") unless params[:inbox_id]
|
|
123
134
|
raise MissingParameterError.new("Parameter missing: recipient") unless params[:recipient]
|
|
124
135
|
|
|
125
136
|
response, options = Api.send_request("/inbox_recipients", :post, params, options)
|
|
126
137
|
InboxRecipient.new(response.data, options)
|
|
127
138
|
end
|
|
139
|
+
|
|
140
|
+
# Parameters:
|
|
141
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
|
|
142
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
|
143
|
+
# inbox_id (required) - int64 - List recipients for the inbox with this ID.
|
|
144
|
+
def self.create_export(params = {}, options = {})
|
|
145
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
146
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
147
|
+
raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params[:inbox_id] and !params[:inbox_id].is_a?(Integer)
|
|
148
|
+
raise MissingParameterError.new("Parameter missing: inbox_id") unless params[:inbox_id]
|
|
149
|
+
|
|
150
|
+
response, options = Api.send_request("/inbox_recipients/create_export", :post, params, options)
|
|
151
|
+
Export.new(response.data, options)
|
|
152
|
+
end
|
|
128
153
|
end
|
|
129
154
|
end
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Files
|
|
4
|
+
class InboxRecipientRegistration
|
|
5
|
+
attr_reader :options, :attributes
|
|
6
|
+
|
|
7
|
+
def initialize(attributes = {}, options = {})
|
|
8
|
+
@attributes = attributes || {}
|
|
9
|
+
@options = options || {}
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# string - The inbox recipient registration code. Use this to register for the inbox.
|
|
13
|
+
def code
|
|
14
|
+
@attributes[:code]
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
def code=(value)
|
|
18
|
+
@attributes[:code] = value
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
# string - If the recipient has already registered for this inbox, this is their registration code to get the inbox contents.
|
|
22
|
+
def inbox_registration_code
|
|
23
|
+
@attributes[:inbox_registration_code]
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def inbox_registration_code=(value)
|
|
27
|
+
@attributes[:inbox_registration_code] = value
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
# string - The recipient's email address.
|
|
31
|
+
def recipient
|
|
32
|
+
@attributes[:recipient]
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
def recipient=(value)
|
|
36
|
+
@attributes[:recipient] = value
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
# string - The recipient's name.
|
|
40
|
+
def name
|
|
41
|
+
@attributes[:name]
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
def name=(value)
|
|
45
|
+
@attributes[:name] = value
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# string - The recipient's company.
|
|
49
|
+
def company
|
|
50
|
+
@attributes[:company]
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
def company=(value)
|
|
54
|
+
@attributes[:company] = value
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# string - Inbox recipient code
|
|
58
|
+
def inbox_recipient_code
|
|
59
|
+
@attributes[:inbox_recipient_code]
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
def inbox_recipient_code=(value)
|
|
63
|
+
@attributes[:inbox_recipient_code] = value
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
def save
|
|
67
|
+
if @attributes[:id]
|
|
68
|
+
raise NotImplementedError.new("The InboxRecipientRegistration object doesn't support updates.")
|
|
69
|
+
else
|
|
70
|
+
new_obj = InboxRecipientRegistration.create(@attributes, @options)
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
@attributes = new_obj.attributes
|
|
74
|
+
true
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
# Parameters:
|
|
78
|
+
# inbox_recipient_code (required) - string - Inbox recipient code
|
|
79
|
+
def self.create(params = {}, options = {})
|
|
80
|
+
raise InvalidParameterError.new("Bad parameter: inbox_recipient_code must be an String") if params[:inbox_recipient_code] and !params[:inbox_recipient_code].is_a?(String)
|
|
81
|
+
raise MissingParameterError.new("Parameter missing: inbox_recipient_code") unless params[:inbox_recipient_code]
|
|
82
|
+
|
|
83
|
+
response, options = Api.send_request("/inbox_recipient_registrations", :post, params, options)
|
|
84
|
+
InboxRecipientRegistration.new(response.data, options)
|
|
85
|
+
end
|
|
86
|
+
end
|
|
87
|
+
end
|
|
@@ -14,61 +14,143 @@ module Files
|
|
|
14
14
|
@attributes[:code]
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
+
def code=(value)
|
|
18
|
+
@attributes[:code] = value
|
|
19
|
+
end
|
|
20
|
+
|
|
17
21
|
# string - Registrant name
|
|
18
22
|
def name
|
|
19
23
|
@attributes[:name]
|
|
20
24
|
end
|
|
21
25
|
|
|
26
|
+
def name=(value)
|
|
27
|
+
@attributes[:name] = value
|
|
28
|
+
end
|
|
29
|
+
|
|
22
30
|
# string - Registrant company name
|
|
23
31
|
def company
|
|
24
32
|
@attributes[:company]
|
|
25
33
|
end
|
|
26
34
|
|
|
35
|
+
def company=(value)
|
|
36
|
+
@attributes[:company] = value
|
|
37
|
+
end
|
|
38
|
+
|
|
27
39
|
# string - Registrant email address
|
|
28
40
|
def email
|
|
29
41
|
@attributes[:email]
|
|
30
42
|
end
|
|
31
43
|
|
|
44
|
+
def email=(value)
|
|
45
|
+
@attributes[:email] = value
|
|
46
|
+
end
|
|
47
|
+
|
|
32
48
|
# string - Registrant IP Address
|
|
33
49
|
def ip
|
|
34
50
|
@attributes[:ip]
|
|
35
51
|
end
|
|
36
52
|
|
|
53
|
+
def ip=(value)
|
|
54
|
+
@attributes[:ip] = value
|
|
55
|
+
end
|
|
56
|
+
|
|
37
57
|
# string - Clickwrap text that was shown to the registrant
|
|
38
58
|
def clickwrap_body
|
|
39
59
|
@attributes[:clickwrap_body]
|
|
40
60
|
end
|
|
41
61
|
|
|
62
|
+
def clickwrap_body=(value)
|
|
63
|
+
@attributes[:clickwrap_body] = value
|
|
64
|
+
end
|
|
65
|
+
|
|
42
66
|
# int64 - Id of associated form field set
|
|
43
67
|
def form_field_set_id
|
|
44
68
|
@attributes[:form_field_set_id]
|
|
45
69
|
end
|
|
46
70
|
|
|
71
|
+
def form_field_set_id=(value)
|
|
72
|
+
@attributes[:form_field_set_id] = value
|
|
73
|
+
end
|
|
74
|
+
|
|
47
75
|
# object - Data for form field set with form field ids as keys and user data as values
|
|
48
76
|
def form_field_data
|
|
49
77
|
@attributes[:form_field_data]
|
|
50
78
|
end
|
|
51
79
|
|
|
80
|
+
def form_field_data=(value)
|
|
81
|
+
@attributes[:form_field_data] = value
|
|
82
|
+
end
|
|
83
|
+
|
|
52
84
|
# int64 - Id of associated inbox
|
|
53
85
|
def inbox_id
|
|
54
86
|
@attributes[:inbox_id]
|
|
55
87
|
end
|
|
56
88
|
|
|
89
|
+
def inbox_id=(value)
|
|
90
|
+
@attributes[:inbox_id] = value
|
|
91
|
+
end
|
|
92
|
+
|
|
57
93
|
# int64 - Id of associated inbox recipient
|
|
58
94
|
def inbox_recipient_id
|
|
59
95
|
@attributes[:inbox_recipient_id]
|
|
60
96
|
end
|
|
61
97
|
|
|
98
|
+
def inbox_recipient_id=(value)
|
|
99
|
+
@attributes[:inbox_recipient_id] = value
|
|
100
|
+
end
|
|
101
|
+
|
|
62
102
|
# string - Title of associated inbox
|
|
63
103
|
def inbox_title
|
|
64
104
|
@attributes[:inbox_title]
|
|
65
105
|
end
|
|
66
106
|
|
|
107
|
+
def inbox_title=(value)
|
|
108
|
+
@attributes[:inbox_title] = value
|
|
109
|
+
end
|
|
110
|
+
|
|
67
111
|
# date-time - Registration creation date/time
|
|
68
112
|
def created_at
|
|
69
113
|
@attributes[:created_at]
|
|
70
114
|
end
|
|
71
115
|
|
|
116
|
+
# string - Inbox URL code
|
|
117
|
+
def inbox_code
|
|
118
|
+
@attributes[:inbox_code]
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
def inbox_code=(value)
|
|
122
|
+
@attributes[:inbox_code] = value
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
# string - Inbox recipient registration code
|
|
126
|
+
def inbox_recipient_registration_code
|
|
127
|
+
@attributes[:inbox_recipient_registration_code]
|
|
128
|
+
end
|
|
129
|
+
|
|
130
|
+
def inbox_recipient_registration_code=(value)
|
|
131
|
+
@attributes[:inbox_recipient_registration_code] = value
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
# string - Inbox password
|
|
135
|
+
def password
|
|
136
|
+
@attributes[:password]
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
def password=(value)
|
|
140
|
+
@attributes[:password] = value
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
def save
|
|
144
|
+
if @attributes[:id]
|
|
145
|
+
raise NotImplementedError.new("The InboxRegistration object doesn't support updates.")
|
|
146
|
+
else
|
|
147
|
+
new_obj = InboxRegistration.create(@attributes, @options)
|
|
148
|
+
end
|
|
149
|
+
|
|
150
|
+
@attributes = new_obj.attributes
|
|
151
|
+
true
|
|
152
|
+
end
|
|
153
|
+
|
|
72
154
|
# Parameters:
|
|
73
155
|
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
74
156
|
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
@@ -86,5 +168,44 @@ module Files
|
|
|
86
168
|
def self.all(params = {}, options = {})
|
|
87
169
|
list(params, options)
|
|
88
170
|
end
|
|
171
|
+
|
|
172
|
+
# Parameters:
|
|
173
|
+
# inbox_code (required) - string - Inbox URL code
|
|
174
|
+
# inbox_recipient_registration_code - string - Inbox recipient registration code
|
|
175
|
+
# password - string - Inbox password
|
|
176
|
+
# name - string - Registrant name
|
|
177
|
+
# company - string - Registrant company name
|
|
178
|
+
# email - string - Registrant email address
|
|
179
|
+
def self.create(params = {}, options = {})
|
|
180
|
+
raise InvalidParameterError.new("Bad parameter: inbox_code must be an String") if params[:inbox_code] and !params[:inbox_code].is_a?(String)
|
|
181
|
+
raise InvalidParameterError.new("Bad parameter: inbox_recipient_registration_code must be an String") if params[:inbox_recipient_registration_code] and !params[:inbox_recipient_registration_code].is_a?(String)
|
|
182
|
+
raise InvalidParameterError.new("Bad parameter: password must be an String") if params[:password] and !params[:password].is_a?(String)
|
|
183
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
184
|
+
raise InvalidParameterError.new("Bad parameter: company must be an String") if params[:company] and !params[:company].is_a?(String)
|
|
185
|
+
raise InvalidParameterError.new("Bad parameter: email must be an String") if params[:email] and !params[:email].is_a?(String)
|
|
186
|
+
raise MissingParameterError.new("Parameter missing: inbox_code") unless params[:inbox_code]
|
|
187
|
+
|
|
188
|
+
response, options = Api.send_request("/inbox_registrations", :post, params, options)
|
|
189
|
+
InboxRegistration.new(response.data, options)
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
# Parameters:
|
|
193
|
+
# inbox_registration_code (required) - string - Inbox registration cookie code
|
|
194
|
+
def self.last_activity(params = {}, options = {})
|
|
195
|
+
raise InvalidParameterError.new("Bad parameter: inbox_registration_code must be an String") if params[:inbox_registration_code] and !params[:inbox_registration_code].is_a?(String)
|
|
196
|
+
raise MissingParameterError.new("Parameter missing: inbox_registration_code") unless params[:inbox_registration_code]
|
|
197
|
+
|
|
198
|
+
Api.send_request("/inbox_registrations/last_activity", :post, params, options)
|
|
199
|
+
nil
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
# Parameters:
|
|
203
|
+
# folder_behavior_id - int64 - ID of the associated Inbox. This is required if the user is not a site admin.
|
|
204
|
+
def self.create_export(params = {}, options = {})
|
|
205
|
+
raise InvalidParameterError.new("Bad parameter: folder_behavior_id must be an Integer") if params[:folder_behavior_id] and !params[:folder_behavior_id].is_a?(Integer)
|
|
206
|
+
|
|
207
|
+
response, options = Api.send_request("/inbox_registrations/create_export", :post, params, options)
|
|
208
|
+
Export.new(response.data, options)
|
|
209
|
+
end
|
|
89
210
|
end
|
|
90
211
|
end
|
|
@@ -51,5 +51,24 @@ module Files
|
|
|
51
51
|
def self.all(params = {}, options = {})
|
|
52
52
|
list(params, options)
|
|
53
53
|
end
|
|
54
|
+
|
|
55
|
+
# Parameters:
|
|
56
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
|
|
57
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `folder_behavior_id` or `inbox_registration_id`. Valid field combinations are `[ folder_behavior_id, created_at ]`, `[ inbox_registration_id, created_at ]`, `[ folder_behavior_id, inbox_registration_id ]` or `[ folder_behavior_id, inbox_registration_id, created_at ]`.
|
|
58
|
+
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
59
|
+
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
60
|
+
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
61
|
+
# filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
62
|
+
def self.create_export(params = {}, options = {})
|
|
63
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
64
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
65
|
+
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
|
|
66
|
+
raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
|
|
67
|
+
raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
|
|
68
|
+
raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
|
|
69
|
+
|
|
70
|
+
response, options = Api.send_request("/inbox_uploads/create_export", :post, params, options)
|
|
71
|
+
Export.new(response.data, options)
|
|
72
|
+
end
|
|
54
73
|
end
|
|
55
74
|
end
|
|
@@ -113,5 +113,10 @@ module Files
|
|
|
113
113
|
def self.get(id, params = {}, options = {})
|
|
114
114
|
find(id, params, options)
|
|
115
115
|
end
|
|
116
|
+
|
|
117
|
+
def self.create_export(params = {}, options = {})
|
|
118
|
+
response, options = Api.send_request("/invoices/create_export", :post, params, options)
|
|
119
|
+
Export.new(response.data, options)
|
|
120
|
+
end
|
|
116
121
|
end
|
|
117
122
|
end
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Files
|
|
4
|
+
class Ip
|
|
5
|
+
attr_reader :options, :attributes
|
|
6
|
+
|
|
7
|
+
def initialize(attributes = {}, options = {})
|
|
8
|
+
@attributes = attributes || {}
|
|
9
|
+
@options = options || {}
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# string - Private IP of the server.
|
|
13
|
+
def ip
|
|
14
|
+
@attributes[:ip]
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
# string - Public IP of the server.
|
|
18
|
+
def external_ip
|
|
19
|
+
@attributes[:external_ip]
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
# boolean - Flag to signal to other systems to use this config
|
|
23
|
+
def assigned
|
|
24
|
+
@attributes[:assigned]
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# SslCertificate - SSL certificate information for the site associated with this IP, if available.
|
|
28
|
+
def site
|
|
29
|
+
@attributes[:site]
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# boolean
|
|
33
|
+
def ftp_enabled
|
|
34
|
+
@attributes[:ftp_enabled]
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# boolean
|
|
38
|
+
def sftp_enabled
|
|
39
|
+
@attributes[:sftp_enabled]
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# string - Which SFTP host key to use.
|
|
43
|
+
def sftp_host_key_type
|
|
44
|
+
@attributes[:sftp_host_key_type]
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# string - SFTP Host Key private key if using a custom key.
|
|
48
|
+
def sftp_host_key_private_key
|
|
49
|
+
@attributes[:sftp_host_key_private_key]
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# int64 - Site Id
|
|
53
|
+
def site_id
|
|
54
|
+
@attributes[:site_id]
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# string - A message to show users when they connect via FTP or SFTP.
|
|
58
|
+
def motd_text
|
|
59
|
+
@attributes[:motd_text]
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
# boolean - Show message to users connecting via FTP
|
|
63
|
+
def motd_use_for_ftp
|
|
64
|
+
@attributes[:motd_use_for_ftp]
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# boolean - Show message to users connecting via SFTP
|
|
68
|
+
def motd_use_for_sftp
|
|
69
|
+
@attributes[:motd_use_for_sftp]
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
# array(object) - Active Custom Domains for the site associated with this IP, with their attached SSL certificate content.
|
|
73
|
+
def custom_domains
|
|
74
|
+
@attributes[:custom_domains]
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
# string - Pair type for General Use Public IPs
|
|
78
|
+
def pair_type
|
|
79
|
+
@attributes[:pair_type]
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
end
|