files.com 1.0.92

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (136) hide show
  1. checksums.yaml +7 -0
  2. data/CONTRIBUTORS +4 -0
  3. data/Gemfile +12 -0
  4. data/Gemfile.lock +82 -0
  5. data/LICENSE +21 -0
  6. data/README.md +119 -0
  7. data/Rakefile +12 -0
  8. data/SECURITY.md +24 -0
  9. data/_VERSION +1 -0
  10. data/bin/files +8 -0
  11. data/bin/files-console +16 -0
  12. data/docs/account_line_item.md +41 -0
  13. data/docs/action.md +37 -0
  14. data/docs/api_key.md +202 -0
  15. data/docs/app.md +59 -0
  16. data/docs/as2_key.md +133 -0
  17. data/docs/auto.md +11 -0
  18. data/docs/automation.md +190 -0
  19. data/docs/behavior.md +208 -0
  20. data/docs/bundle.md +252 -0
  21. data/docs/bundle_download.md +35 -0
  22. data/docs/clickwrap.md +143 -0
  23. data/docs/dns_record.md +35 -0
  24. data/docs/errors.md +17 -0
  25. data/docs/file.md +204 -0
  26. data/docs/file_action.md +126 -0
  27. data/docs/file_comment.md +116 -0
  28. data/docs/file_comment_reaction.md +62 -0
  29. data/docs/file_part_upload.md +37 -0
  30. data/docs/file_utils.md +4 -0
  31. data/docs/folder.md +90 -0
  32. data/docs/group.md +153 -0
  33. data/docs/group_user.md +124 -0
  34. data/docs/history.md +171 -0
  35. data/docs/history_export.md +174 -0
  36. data/docs/image.md +13 -0
  37. data/docs/invoice.md +72 -0
  38. data/docs/invoice_line_item.md +27 -0
  39. data/docs/ip_address.md +55 -0
  40. data/docs/lock.md +98 -0
  41. data/docs/message.md +147 -0
  42. data/docs/message_comment.md +132 -0
  43. data/docs/message_comment_reaction.md +94 -0
  44. data/docs/message_reaction.md +94 -0
  45. data/docs/notification.md +177 -0
  46. data/docs/payment.md +72 -0
  47. data/docs/payment_line_item.md +19 -0
  48. data/docs/permission.md +95 -0
  49. data/docs/preview.md +19 -0
  50. data/docs/project.md +121 -0
  51. data/docs/public_ip_address.md +13 -0
  52. data/docs/public_key.md +133 -0
  53. data/docs/remote_server.md +356 -0
  54. data/docs/request.md +100 -0
  55. data/docs/session.md +78 -0
  56. data/docs/site.md +448 -0
  57. data/docs/sso_strategy.md +114 -0
  58. data/docs/status.md +21 -0
  59. data/docs/style.md +93 -0
  60. data/docs/usage_daily_snapshot.md +45 -0
  61. data/docs/usage_snapshot.md +53 -0
  62. data/docs/user.md +535 -0
  63. data/docs/user_cipher_use.md +41 -0
  64. data/docs/user_request.md +93 -0
  65. data/files.com.gemspec +22 -0
  66. data/lib/files.com.rb +184 -0
  67. data/lib/files.com/api.rb +38 -0
  68. data/lib/files.com/api_client.rb +340 -0
  69. data/lib/files.com/errors.rb +41 -0
  70. data/lib/files.com/list.rb +95 -0
  71. data/lib/files.com/models/account_line_item.rb +82 -0
  72. data/lib/files.com/models/action.rb +77 -0
  73. data/lib/files.com/models/api_key.rb +270 -0
  74. data/lib/files.com/models/app.rb +106 -0
  75. data/lib/files.com/models/as2_key.rb +179 -0
  76. data/lib/files.com/models/auto.rb +17 -0
  77. data/lib/files.com/models/automation.rb +304 -0
  78. data/lib/files.com/models/behavior.rb +266 -0
  79. data/lib/files.com/models/bundle.rb +371 -0
  80. data/lib/files.com/models/bundle_download.rb +49 -0
  81. data/lib/files.com/models/clickwrap.rb +197 -0
  82. data/lib/files.com/models/dir.rb +3 -0
  83. data/lib/files.com/models/dns_record.rb +51 -0
  84. data/lib/files.com/models/errors.rb +22 -0
  85. data/lib/files.com/models/file.rb +968 -0
  86. data/lib/files.com/models/file_action.rb +126 -0
  87. data/lib/files.com/models/file_comment.rb +146 -0
  88. data/lib/files.com/models/file_comment_reaction.rb +100 -0
  89. data/lib/files.com/models/file_part_upload.rb +82 -0
  90. data/lib/files.com/models/file_utils.rb +118 -0
  91. data/lib/files.com/models/folder.rb +357 -0
  92. data/lib/files.com/models/group.rb +208 -0
  93. data/lib/files.com/models/group_user.rb +171 -0
  94. data/lib/files.com/models/history.rb +228 -0
  95. data/lib/files.com/models/history_export.rb +353 -0
  96. data/lib/files.com/models/image.rb +22 -0
  97. data/lib/files.com/models/invoice.rb +117 -0
  98. data/lib/files.com/models/invoice_line_item.rb +57 -0
  99. data/lib/files.com/models/ip_address.rb +66 -0
  100. data/lib/files.com/models/lock.rb +173 -0
  101. data/lib/files.com/models/message.rb +201 -0
  102. data/lib/files.com/models/message_comment.rb +165 -0
  103. data/lib/files.com/models/message_comment_reaction.rb +128 -0
  104. data/lib/files.com/models/message_reaction.rb +128 -0
  105. data/lib/files.com/models/notification.rb +263 -0
  106. data/lib/files.com/models/payment.rb +117 -0
  107. data/lib/files.com/models/payment_line_item.rb +37 -0
  108. data/lib/files.com/models/permission.rb +172 -0
  109. data/lib/files.com/models/preview.rb +37 -0
  110. data/lib/files.com/models/project.rb +140 -0
  111. data/lib/files.com/models/public_ip_address.rb +22 -0
  112. data/lib/files.com/models/public_key.rb +179 -0
  113. data/lib/files.com/models/remote_server.rb +680 -0
  114. data/lib/files.com/models/request.rb +179 -0
  115. data/lib/files.com/models/session.rb +247 -0
  116. data/lib/files.com/models/site.rb +733 -0
  117. data/lib/files.com/models/sso_strategy.rb +227 -0
  118. data/lib/files.com/models/status.rb +37 -0
  119. data/lib/files.com/models/style.rb +131 -0
  120. data/lib/files.com/models/usage_daily_snapshot.rb +66 -0
  121. data/lib/files.com/models/usage_snapshot.rb +96 -0
  122. data/lib/files.com/models/user.rb +876 -0
  123. data/lib/files.com/models/user_cipher_use.rb +63 -0
  124. data/lib/files.com/models/user_request.rb +127 -0
  125. data/lib/files.com/response.rb +25 -0
  126. data/lib/files.com/sizable_io.rb +32 -0
  127. data/lib/files.com/system_profiler.rb +56 -0
  128. data/lib/files.com/util.rb +106 -0
  129. data/lib/files.com/version.rb +5 -0
  130. data/spec/list_spec.rb +214 -0
  131. data/spec/models/file_spec.rb +68 -0
  132. data/spec/models/folder_spec.rb +40 -0
  133. data/spec/spec_helper.rb +36 -0
  134. data/test.sh +8 -0
  135. data/test/test.rb +75 -0
  136. metadata +235 -0
@@ -0,0 +1,19 @@
1
+ # Preview
2
+
3
+ ## Example Preview Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "status": "complete",
9
+ "download_uri": "https://mysite.files.com/...",
10
+ "type": "complete",
11
+ "size": 1024
12
+ }
13
+ ```
14
+
15
+ * `id` (int64): Preview ID
16
+ * `status` (string): Preview status. Can be invalid, not_generated, generating, complete, or file_too_large
17
+ * `download_uri` (string): Link to download preview
18
+ * `type` (string): Preview status. Can be invalid, not_generated, generating, complete, or file_too_large
19
+ * `size` (int64): Preview size
@@ -0,0 +1,121 @@
1
+ # Project
2
+
3
+ ## Example Project Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "global_access": "none"
9
+ }
10
+ ```
11
+
12
+ * `id` (int64): Project ID
13
+ * `global_access` (string): Global access settings
14
+
15
+
16
+ ---
17
+
18
+ ## List Projects
19
+
20
+ ```
21
+ Files::Project.list(
22
+ page: 1,
23
+ per_page: 1
24
+ )
25
+ ```
26
+
27
+ ### Parameters
28
+
29
+ * `page` (int64): Current page number.
30
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
31
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
32
+
33
+
34
+ ---
35
+
36
+ ## Show Project
37
+
38
+ ```
39
+ Files::Project.find(id)
40
+ ```
41
+
42
+ ### Parameters
43
+
44
+ * `id` (int64): Required - Project ID.
45
+
46
+
47
+ ---
48
+
49
+ ## Create Project
50
+
51
+ ```
52
+ Files::Project.create(
53
+ global_access: "global_access"
54
+ )
55
+ ```
56
+
57
+ ### Parameters
58
+
59
+ * `global_access` (string): Required - Global permissions. Can be: `none`, `anyone_with_read`, `anyone_with_full`.
60
+
61
+
62
+ ---
63
+
64
+ ## Update Project
65
+
66
+ ```
67
+ Files::Project.update(id,
68
+ global_access: "global_access"
69
+ )
70
+ ```
71
+
72
+ ### Parameters
73
+
74
+ * `id` (int64): Required - Project ID.
75
+ * `global_access` (string): Required - Global permissions. Can be: `none`, `anyone_with_read`, `anyone_with_full`.
76
+
77
+
78
+ ---
79
+
80
+ ## Delete Project
81
+
82
+ ```
83
+ Files::Project.delete(id)
84
+ ```
85
+
86
+ ### Parameters
87
+
88
+ * `id` (int64): Required - Project ID.
89
+
90
+
91
+ ---
92
+
93
+ ## Update Project
94
+
95
+ ```
96
+ project = Files::Project.list_for(path).first
97
+
98
+ project.update(
99
+ global_access: "global_access"
100
+ )
101
+ ```
102
+
103
+ ### Parameters
104
+
105
+ * `id` (int64): Required - Project ID.
106
+ * `global_access` (string): Required - Global permissions. Can be: `none`, `anyone_with_read`, `anyone_with_full`.
107
+
108
+
109
+ ---
110
+
111
+ ## Delete Project
112
+
113
+ ```
114
+ project = Files::Project.list_for(path).first
115
+
116
+ project.delete
117
+ ```
118
+
119
+ ### Parameters
120
+
121
+ * `id` (int64): Required - Project ID.
@@ -0,0 +1,13 @@
1
+ # PublicIpAddress
2
+
3
+ ## Example PublicIpAddress Object
4
+
5
+ ```
6
+ {
7
+ "ip_address": "1.1.1.1",
8
+ "server_name": "server-1"
9
+ }
10
+ ```
11
+
12
+ * `ip_address` (string): The public IP address.
13
+ * `server_name` (string): The name of the frontend server.
@@ -0,0 +1,133 @@
1
+ # PublicKey
2
+
3
+ ## Example PublicKey Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "title": "My public key",
9
+ "created_at": "2000-01-01T01:00:00Z",
10
+ "fingerprint": "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8"
11
+ }
12
+ ```
13
+
14
+ * `id` (int64): Public key ID
15
+ * `title` (string): Public key title
16
+ * `created_at` (date-time): Public key created at date/time
17
+ * `fingerprint` (string): Public key fingerprint
18
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
19
+ * `public_key` (string): Actual contents of SSH key.
20
+
21
+
22
+ ---
23
+
24
+ ## List Public Keys
25
+
26
+ ```
27
+ Files::PublicKey.list(
28
+ user_id: 1,
29
+ page: 1,
30
+ per_page: 1
31
+ )
32
+ ```
33
+
34
+ ### Parameters
35
+
36
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
37
+ * `page` (int64): Current page number.
38
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
39
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
40
+
41
+
42
+ ---
43
+
44
+ ## Show Public Key
45
+
46
+ ```
47
+ Files::PublicKey.find(id)
48
+ ```
49
+
50
+ ### Parameters
51
+
52
+ * `id` (int64): Required - Public Key ID.
53
+
54
+
55
+ ---
56
+
57
+ ## Create Public Key
58
+
59
+ ```
60
+ Files::PublicKey.create(
61
+ user_id: 1,
62
+ title: "My Main Key",
63
+ public_key: "public_key"
64
+ )
65
+ ```
66
+
67
+ ### Parameters
68
+
69
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
70
+ * `title` (string): Required - Internal reference for key.
71
+ * `public_key` (string): Required - Actual contents of SSH key.
72
+
73
+
74
+ ---
75
+
76
+ ## Update Public Key
77
+
78
+ ```
79
+ Files::PublicKey.update(id,
80
+ title: "My Main Key"
81
+ )
82
+ ```
83
+
84
+ ### Parameters
85
+
86
+ * `id` (int64): Required - Public Key ID.
87
+ * `title` (string): Required - Internal reference for key.
88
+
89
+
90
+ ---
91
+
92
+ ## Delete Public Key
93
+
94
+ ```
95
+ Files::PublicKey.delete(id)
96
+ ```
97
+
98
+ ### Parameters
99
+
100
+ * `id` (int64): Required - Public Key ID.
101
+
102
+
103
+ ---
104
+
105
+ ## Update Public Key
106
+
107
+ ```
108
+ public_key = Files::PublicKey.list_for(path).first
109
+
110
+ public_key.update(
111
+ title: "My Main Key"
112
+ )
113
+ ```
114
+
115
+ ### Parameters
116
+
117
+ * `id` (int64): Required - Public Key ID.
118
+ * `title` (string): Required - Internal reference for key.
119
+
120
+
121
+ ---
122
+
123
+ ## Delete Public Key
124
+
125
+ ```
126
+ public_key = Files::PublicKey.list_for(path).first
127
+
128
+ public_key.delete
129
+ ```
130
+
131
+ ### Parameters
132
+
133
+ * `id` (int64): Required - Public Key ID.
@@ -0,0 +1,356 @@
1
+ # RemoteServer
2
+
3
+ ## Example RemoteServer Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "authentication_method": "password",
9
+ "hostname": "remote-server.com",
10
+ "name": "My Remote server",
11
+ "port": 1,
12
+ "max_connections": 1,
13
+ "s3_bucket": "my-bucket",
14
+ "s3_region": "us-east-1",
15
+ "server_certificate": "[certificate]",
16
+ "server_host_key": "[public key]",
17
+ "server_type": "s3",
18
+ "ssl": "always",
19
+ "username": "user",
20
+ "google_cloud_storage_bucket": "my-bucket",
21
+ "google_cloud_storage_project_id": "my-project",
22
+ "backblaze_b2_s3_endpoint": "s3.us-west-001.backblazeb2.com",
23
+ "backblaze_b2_bucket": "my-bucket",
24
+ "wasabi_bucket": "us-west-1",
25
+ "wasabi_region": "my-bucket",
26
+ "rackspace_username": "rackspaceuser",
27
+ "rackspace_region": "dfw",
28
+ "rackspace_container": "my-container",
29
+ "auth_setup_link": "auth/:provider",
30
+ "auth_status": "in_setup",
31
+ "auth_account_name": "me@example.com",
32
+ "one_drive_account_type": "personal",
33
+ "azure_blob_storage_account": "storage-account-name",
34
+ "azure_blob_storage_container": "container-name"
35
+ }
36
+ ```
37
+
38
+ * `id` (int64): Remote server ID
39
+ * `authentication_method` (string): Type of authentication method
40
+ * `hostname` (string): Hostname or IP address
41
+ * `name` (string): Internal name for your reference
42
+ * `port` (int64): Port for remote server. Not needed for S3.
43
+ * `max_connections` (int64): Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
44
+ * `s3_bucket` (string): S3 bucket name
45
+ * `s3_region` (string): S3 region
46
+ * `server_certificate` (string): Remote server certificate
47
+ * `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
48
+ * `server_type` (string): Remote server type.
49
+ * `ssl` (string): Should we require SSL?
50
+ * `username` (string): Remote server username. Not needed for S3 buckets.
51
+ * `google_cloud_storage_bucket` (string): Google Cloud Storage bucket name
52
+ * `google_cloud_storage_project_id` (string): Google Cloud Project ID
53
+ * `backblaze_b2_s3_endpoint` (string): Backblaze B2 Cloud Storage S3 Endpoint
54
+ * `backblaze_b2_bucket` (string): Backblaze B2 Cloud Storage Bucket name
55
+ * `wasabi_bucket` (string): Wasabi region
56
+ * `wasabi_region` (string): Wasabi Bucket name
57
+ * `rackspace_username` (string): Rackspace username used to login to the Rackspace Cloud Control Panel.
58
+ * `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
59
+ * `rackspace_container` (string): The name of the container (top level directory) where files will sync.
60
+ * `auth_setup_link` (string): Returns link to login with an Oauth provider
61
+ * `auth_status` (string): Either `in_setup` or `complete`
62
+ * `auth_account_name` (string): Describes the authorized account
63
+ * `one_drive_account_type` (string): Either personal or business_other account types
64
+ * `azure_blob_storage_account` (string): Azure Blob Storage Account name
65
+ * `azure_blob_storage_container` (string): Azure Blob Storage Container name
66
+ * `aws_access_key` (string): AWS Access Key.
67
+ * `aws_secret_key` (string): AWS secret key.
68
+ * `password` (string): Password if needed.
69
+ * `private_key` (string): Private key if needed.
70
+ * `google_cloud_storage_credentials_json` (string): A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
71
+ * `wasabi_access_key` (string): Wasabi access key.
72
+ * `wasabi_secret_key` (string): Wasabi secret key.
73
+ * `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage keyID.
74
+ * `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage applicationKey.
75
+ * `rackspace_api_key` (string): Rackspace API key from the Rackspace Cloud Control Panel.
76
+ * `reset_authentication` (boolean): Reset authenticated account
77
+ * `azure_blob_storage_access_key` (string): Azure Blob Storage secret key.
78
+
79
+
80
+ ---
81
+
82
+ ## List Remote Servers
83
+
84
+ ```
85
+ Files::RemoteServer.list(
86
+ page: 1,
87
+ per_page: 1
88
+ )
89
+ ```
90
+
91
+ ### Parameters
92
+
93
+ * `page` (int64): Current page number.
94
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
95
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
96
+
97
+
98
+ ---
99
+
100
+ ## Show Remote Server
101
+
102
+ ```
103
+ Files::RemoteServer.find(id)
104
+ ```
105
+
106
+ ### Parameters
107
+
108
+ * `id` (int64): Required - Remote Server ID.
109
+
110
+
111
+ ---
112
+
113
+ ## Create Remote Server
114
+
115
+ ```
116
+ Files::RemoteServer.create(
117
+ reset_authentication: true,
118
+ hostname: "remote-server.com",
119
+ name: "My Remote server",
120
+ max_connections: 1,
121
+ port: 1,
122
+ s3_bucket: "my-bucket",
123
+ s3_region: "us-east-1",
124
+ server_certificate: "[certificate]",
125
+ server_host_key: "[public key]",
126
+ server_type: "s3",
127
+ ssl: "always",
128
+ username: "user",
129
+ google_cloud_storage_bucket: "my-bucket",
130
+ google_cloud_storage_project_id: "my-project",
131
+ backblaze_b2_bucket: "my-bucket",
132
+ backblaze_b2_s3_endpoint: "s3.us-west-001.backblazeb2.com",
133
+ wasabi_bucket: "us-west-1",
134
+ wasabi_region: "my-bucket",
135
+ rackspace_username: "rackspaceuser",
136
+ rackspace_region: "dfw",
137
+ rackspace_container: "my-container",
138
+ one_drive_account_type: "personal",
139
+ azure_blob_storage_account: "storage-account-name",
140
+ azure_blob_storage_container: "container-name"
141
+ )
142
+ ```
143
+
144
+ ### Parameters
145
+
146
+ * `aws_access_key` (string): AWS Access Key.
147
+ * `aws_secret_key` (string): AWS secret key.
148
+ * `password` (string): Password if needed.
149
+ * `private_key` (string): Private key if needed.
150
+ * `google_cloud_storage_credentials_json` (string): A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
151
+ * `wasabi_access_key` (string): Wasabi access key.
152
+ * `wasabi_secret_key` (string): Wasabi secret key.
153
+ * `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage keyID.
154
+ * `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage applicationKey.
155
+ * `rackspace_api_key` (string): Rackspace API key from the Rackspace Cloud Control Panel.
156
+ * `reset_authentication` (boolean): Reset authenticated account
157
+ * `azure_blob_storage_access_key` (string): Azure Blob Storage secret key.
158
+ * `hostname` (string): Hostname or IP address
159
+ * `name` (string): Internal name for your reference
160
+ * `max_connections` (int64): Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
161
+ * `port` (int64): Port for remote server. Not needed for S3.
162
+ * `s3_bucket` (string): S3 bucket name
163
+ * `s3_region` (string): S3 region
164
+ * `server_certificate` (string): Remote server certificate
165
+ * `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
166
+ * `server_type` (string): Remote server type.
167
+ * `ssl` (string): Should we require SSL?
168
+ * `username` (string): Remote server username. Not needed for S3 buckets.
169
+ * `google_cloud_storage_bucket` (string): Google Cloud Storage bucket name
170
+ * `google_cloud_storage_project_id` (string): Google Cloud Project ID
171
+ * `backblaze_b2_bucket` (string): Backblaze B2 Cloud Storage Bucket name
172
+ * `backblaze_b2_s3_endpoint` (string): Backblaze B2 Cloud Storage S3 Endpoint
173
+ * `wasabi_bucket` (string): Wasabi region
174
+ * `wasabi_region` (string): Wasabi Bucket name
175
+ * `rackspace_username` (string): Rackspace username used to login to the Rackspace Cloud Control Panel.
176
+ * `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
177
+ * `rackspace_container` (string): The name of the container (top level directory) where files will sync.
178
+ * `one_drive_account_type` (string): Either personal or business_other account types
179
+ * `azure_blob_storage_account` (string): Azure Blob Storage Account name
180
+ * `azure_blob_storage_container` (string): Azure Blob Storage Container name
181
+
182
+
183
+ ---
184
+
185
+ ## Update Remote Server
186
+
187
+ ```
188
+ Files::RemoteServer.update(id,
189
+ reset_authentication: true,
190
+ hostname: "remote-server.com",
191
+ name: "My Remote server",
192
+ max_connections: 1,
193
+ port: 1,
194
+ s3_bucket: "my-bucket",
195
+ s3_region: "us-east-1",
196
+ server_certificate: "[certificate]",
197
+ server_host_key: "[public key]",
198
+ server_type: "s3",
199
+ ssl: "always",
200
+ username: "user",
201
+ google_cloud_storage_bucket: "my-bucket",
202
+ google_cloud_storage_project_id: "my-project",
203
+ backblaze_b2_bucket: "my-bucket",
204
+ backblaze_b2_s3_endpoint: "s3.us-west-001.backblazeb2.com",
205
+ wasabi_bucket: "us-west-1",
206
+ wasabi_region: "my-bucket",
207
+ rackspace_username: "rackspaceuser",
208
+ rackspace_region: "dfw",
209
+ rackspace_container: "my-container",
210
+ one_drive_account_type: "personal",
211
+ azure_blob_storage_account: "storage-account-name",
212
+ azure_blob_storage_container: "container-name"
213
+ )
214
+ ```
215
+
216
+ ### Parameters
217
+
218
+ * `id` (int64): Required - Remote Server ID.
219
+ * `aws_access_key` (string): AWS Access Key.
220
+ * `aws_secret_key` (string): AWS secret key.
221
+ * `password` (string): Password if needed.
222
+ * `private_key` (string): Private key if needed.
223
+ * `google_cloud_storage_credentials_json` (string): A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
224
+ * `wasabi_access_key` (string): Wasabi access key.
225
+ * `wasabi_secret_key` (string): Wasabi secret key.
226
+ * `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage keyID.
227
+ * `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage applicationKey.
228
+ * `rackspace_api_key` (string): Rackspace API key from the Rackspace Cloud Control Panel.
229
+ * `reset_authentication` (boolean): Reset authenticated account
230
+ * `azure_blob_storage_access_key` (string): Azure Blob Storage secret key.
231
+ * `hostname` (string): Hostname or IP address
232
+ * `name` (string): Internal name for your reference
233
+ * `max_connections` (int64): Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
234
+ * `port` (int64): Port for remote server. Not needed for S3.
235
+ * `s3_bucket` (string): S3 bucket name
236
+ * `s3_region` (string): S3 region
237
+ * `server_certificate` (string): Remote server certificate
238
+ * `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
239
+ * `server_type` (string): Remote server type.
240
+ * `ssl` (string): Should we require SSL?
241
+ * `username` (string): Remote server username. Not needed for S3 buckets.
242
+ * `google_cloud_storage_bucket` (string): Google Cloud Storage bucket name
243
+ * `google_cloud_storage_project_id` (string): Google Cloud Project ID
244
+ * `backblaze_b2_bucket` (string): Backblaze B2 Cloud Storage Bucket name
245
+ * `backblaze_b2_s3_endpoint` (string): Backblaze B2 Cloud Storage S3 Endpoint
246
+ * `wasabi_bucket` (string): Wasabi region
247
+ * `wasabi_region` (string): Wasabi Bucket name
248
+ * `rackspace_username` (string): Rackspace username used to login to the Rackspace Cloud Control Panel.
249
+ * `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
250
+ * `rackspace_container` (string): The name of the container (top level directory) where files will sync.
251
+ * `one_drive_account_type` (string): Either personal or business_other account types
252
+ * `azure_blob_storage_account` (string): Azure Blob Storage Account name
253
+ * `azure_blob_storage_container` (string): Azure Blob Storage Container name
254
+
255
+
256
+ ---
257
+
258
+ ## Delete Remote Server
259
+
260
+ ```
261
+ Files::RemoteServer.delete(id)
262
+ ```
263
+
264
+ ### Parameters
265
+
266
+ * `id` (int64): Required - Remote Server ID.
267
+
268
+
269
+ ---
270
+
271
+ ## Update Remote Server
272
+
273
+ ```
274
+ remote_server = Files::RemoteServer.list_for(path).first
275
+
276
+ remote_server.update(
277
+ reset_authentication: true,
278
+ hostname: "remote-server.com",
279
+ name: "My Remote server",
280
+ max_connections: 1,
281
+ port: 1,
282
+ s3_bucket: "my-bucket",
283
+ s3_region: "us-east-1",
284
+ server_certificate: "[certificate]",
285
+ server_host_key: "[public key]",
286
+ server_type: "s3",
287
+ ssl: "always",
288
+ username: "user",
289
+ google_cloud_storage_bucket: "my-bucket",
290
+ google_cloud_storage_project_id: "my-project",
291
+ backblaze_b2_bucket: "my-bucket",
292
+ backblaze_b2_s3_endpoint: "s3.us-west-001.backblazeb2.com",
293
+ wasabi_bucket: "us-west-1",
294
+ wasabi_region: "my-bucket",
295
+ rackspace_username: "rackspaceuser",
296
+ rackspace_region: "dfw",
297
+ rackspace_container: "my-container",
298
+ one_drive_account_type: "personal",
299
+ azure_blob_storage_account: "storage-account-name",
300
+ azure_blob_storage_container: "container-name"
301
+ )
302
+ ```
303
+
304
+ ### Parameters
305
+
306
+ * `id` (int64): Required - Remote Server ID.
307
+ * `aws_access_key` (string): AWS Access Key.
308
+ * `aws_secret_key` (string): AWS secret key.
309
+ * `password` (string): Password if needed.
310
+ * `private_key` (string): Private key if needed.
311
+ * `google_cloud_storage_credentials_json` (string): A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
312
+ * `wasabi_access_key` (string): Wasabi access key.
313
+ * `wasabi_secret_key` (string): Wasabi secret key.
314
+ * `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage keyID.
315
+ * `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage applicationKey.
316
+ * `rackspace_api_key` (string): Rackspace API key from the Rackspace Cloud Control Panel.
317
+ * `reset_authentication` (boolean): Reset authenticated account
318
+ * `azure_blob_storage_access_key` (string): Azure Blob Storage secret key.
319
+ * `hostname` (string): Hostname or IP address
320
+ * `name` (string): Internal name for your reference
321
+ * `max_connections` (int64): Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
322
+ * `port` (int64): Port for remote server. Not needed for S3.
323
+ * `s3_bucket` (string): S3 bucket name
324
+ * `s3_region` (string): S3 region
325
+ * `server_certificate` (string): Remote server certificate
326
+ * `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
327
+ * `server_type` (string): Remote server type.
328
+ * `ssl` (string): Should we require SSL?
329
+ * `username` (string): Remote server username. Not needed for S3 buckets.
330
+ * `google_cloud_storage_bucket` (string): Google Cloud Storage bucket name
331
+ * `google_cloud_storage_project_id` (string): Google Cloud Project ID
332
+ * `backblaze_b2_bucket` (string): Backblaze B2 Cloud Storage Bucket name
333
+ * `backblaze_b2_s3_endpoint` (string): Backblaze B2 Cloud Storage S3 Endpoint
334
+ * `wasabi_bucket` (string): Wasabi region
335
+ * `wasabi_region` (string): Wasabi Bucket name
336
+ * `rackspace_username` (string): Rackspace username used to login to the Rackspace Cloud Control Panel.
337
+ * `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
338
+ * `rackspace_container` (string): The name of the container (top level directory) where files will sync.
339
+ * `one_drive_account_type` (string): Either personal or business_other account types
340
+ * `azure_blob_storage_account` (string): Azure Blob Storage Account name
341
+ * `azure_blob_storage_container` (string): Azure Blob Storage Container name
342
+
343
+
344
+ ---
345
+
346
+ ## Delete Remote Server
347
+
348
+ ```
349
+ remote_server = Files::RemoteServer.list_for(path).first
350
+
351
+ remote_server.delete
352
+ ```
353
+
354
+ ### Parameters
355
+
356
+ * `id` (int64): Required - Remote Server ID.