files.com 1.1.416 → 1.1.417
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/bundle.md +1 -1
- data/docs/remote_server.md +16 -8
- data/docs/remote_server_credential.md +283 -0
- data/lib/files.com/models/bundle.rb +1 -1
- data/lib/files.com/models/remote_server.rb +23 -8
- data/lib/files.com/models/remote_server_credential.rb +577 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +1 -0
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 37d15d705dc0e5c0d72f460f960e05e9c94f31d8f30249302e47ddf0278922bd
|
|
4
|
+
data.tar.gz: 39bedc459d939661792e42bed38d0bb06bc014a6b588cbd881762c7665363b00
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 70c512edc2c15594f18723d440cb51ea153e92b010d7fe02455a6b7bbe6af4a1c02941d71138e8bde989f3511f991ccb3a225abce832b08b5b0807949a146537
|
|
7
|
+
data.tar.gz: c5144d9760ab4548304fdd13c0fe7d84d4050613297ffc6af146737e902282597f1072e237a916ac9de124d8e9320a17023fcaa756ddd28f13c9082e361aa4ad
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.417
|
data/docs/bundle.md
CHANGED
|
@@ -152,7 +152,7 @@ Files::Bundle.list(
|
|
|
152
152
|
* `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.
|
|
153
153
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
154
154
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
|
|
155
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id,
|
|
155
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, expires_at ]`.
|
|
156
156
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_at`.
|
|
157
157
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
|
|
158
158
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.
|
data/docs/remote_server.md
CHANGED
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
"max_connections": 1,
|
|
17
17
|
"pin_to_site_region": true,
|
|
18
18
|
"pinned_region": "us-east-1",
|
|
19
|
+
"remote_server_credential_id": 1,
|
|
19
20
|
"s3_bucket": "my-bucket",
|
|
20
21
|
"s3_region": "us-east-1",
|
|
21
22
|
"aws_access_key": "example",
|
|
@@ -72,11 +73,12 @@
|
|
|
72
73
|
* `remote_home_path` (string): Initial home folder on remote server
|
|
73
74
|
* `name` (string): Internal name for your reference
|
|
74
75
|
* `description` (string): Internal description for your reference
|
|
75
|
-
* `port` (int64): Port for remote server.
|
|
76
|
+
* `port` (int64): Port for remote server.
|
|
76
77
|
* `buffer_uploads` (string): If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
|
|
77
78
|
* `max_connections` (int64): Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
|
|
78
79
|
* `pin_to_site_region` (boolean): If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
|
|
79
80
|
* `pinned_region` (string): If set, all communications with this remote server are made through the provided region.
|
|
81
|
+
* `remote_server_credential_id` (int64): ID of Remote Server Credential, if applicable.
|
|
80
82
|
* `s3_bucket` (string): S3 bucket name
|
|
81
83
|
* `s3_region` (string): S3 region
|
|
82
84
|
* `aws_access_key` (string): AWS Access Key.
|
|
@@ -84,7 +86,7 @@
|
|
|
84
86
|
* `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
|
|
85
87
|
* `server_type` (string): Remote server type.
|
|
86
88
|
* `ssl` (string): Should we require SSL?
|
|
87
|
-
* `username` (string): Remote server username.
|
|
89
|
+
* `username` (string): Remote server username.
|
|
88
90
|
* `google_cloud_storage_bucket` (string): Google Cloud Storage: Bucket Name
|
|
89
91
|
* `google_cloud_storage_project_id` (string): Google Cloud Storage: Project ID
|
|
90
92
|
* `google_cloud_storage_s3_compatible_access_key` (string): Google Cloud Storage: S3-compatible Access Key.
|
|
@@ -229,6 +231,7 @@ Files::RemoteServer.create(
|
|
|
229
231
|
one_drive_account_type: "personal",
|
|
230
232
|
pin_to_site_region: true,
|
|
231
233
|
port: 1,
|
|
234
|
+
remote_server_credential_id: 1,
|
|
232
235
|
s3_bucket: "my-bucket",
|
|
233
236
|
s3_compatible_access_key: "example",
|
|
234
237
|
s3_compatible_bucket: "my-bucket",
|
|
@@ -301,7 +304,8 @@ Files::RemoteServer.create(
|
|
|
301
304
|
* `name` (string): Internal name for your reference
|
|
302
305
|
* `one_drive_account_type` (string): OneDrive: Either personal or business_other account types
|
|
303
306
|
* `pin_to_site_region` (boolean): If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
|
|
304
|
-
* `port` (int64): Port for remote server.
|
|
307
|
+
* `port` (int64): Port for remote server.
|
|
308
|
+
* `remote_server_credential_id` (int64): ID of Remote Server Credential, if applicable.
|
|
305
309
|
* `s3_bucket` (string): S3 bucket name
|
|
306
310
|
* `s3_compatible_access_key` (string): S3-compatible: Access Key
|
|
307
311
|
* `s3_compatible_bucket` (string): S3-compatible: Bucket name
|
|
@@ -312,7 +316,7 @@ Files::RemoteServer.create(
|
|
|
312
316
|
* `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
|
|
313
317
|
* `server_type` (string): Remote server type.
|
|
314
318
|
* `ssl` (string): Should we require SSL?
|
|
315
|
-
* `username` (string): Remote server username.
|
|
319
|
+
* `username` (string): Remote server username.
|
|
316
320
|
* `wasabi_access_key` (string): Wasabi: Access Key.
|
|
317
321
|
* `wasabi_bucket` (string): Wasabi: Bucket name
|
|
318
322
|
* `wasabi_region` (string): Wasabi: Region
|
|
@@ -396,6 +400,7 @@ Files::RemoteServer.update(id,
|
|
|
396
400
|
one_drive_account_type: "personal",
|
|
397
401
|
pin_to_site_region: true,
|
|
398
402
|
port: 1,
|
|
403
|
+
remote_server_credential_id: 1,
|
|
399
404
|
s3_bucket: "my-bucket",
|
|
400
405
|
s3_compatible_access_key: "example",
|
|
401
406
|
s3_compatible_bucket: "my-bucket",
|
|
@@ -469,7 +474,8 @@ Files::RemoteServer.update(id,
|
|
|
469
474
|
* `name` (string): Internal name for your reference
|
|
470
475
|
* `one_drive_account_type` (string): OneDrive: Either personal or business_other account types
|
|
471
476
|
* `pin_to_site_region` (boolean): If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
|
|
472
|
-
* `port` (int64): Port for remote server.
|
|
477
|
+
* `port` (int64): Port for remote server.
|
|
478
|
+
* `remote_server_credential_id` (int64): ID of Remote Server Credential, if applicable.
|
|
473
479
|
* `s3_bucket` (string): S3 bucket name
|
|
474
480
|
* `s3_compatible_access_key` (string): S3-compatible: Access Key
|
|
475
481
|
* `s3_compatible_bucket` (string): S3-compatible: Bucket name
|
|
@@ -480,7 +486,7 @@ Files::RemoteServer.update(id,
|
|
|
480
486
|
* `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
|
|
481
487
|
* `server_type` (string): Remote server type.
|
|
482
488
|
* `ssl` (string): Should we require SSL?
|
|
483
|
-
* `username` (string): Remote server username.
|
|
489
|
+
* `username` (string): Remote server username.
|
|
484
490
|
* `wasabi_access_key` (string): Wasabi: Access Key.
|
|
485
491
|
* `wasabi_bucket` (string): Wasabi: Bucket name
|
|
486
492
|
* `wasabi_region` (string): Wasabi: Region
|
|
@@ -581,6 +587,7 @@ remote_server.update(
|
|
|
581
587
|
one_drive_account_type: "personal",
|
|
582
588
|
pin_to_site_region: true,
|
|
583
589
|
port: 1,
|
|
590
|
+
remote_server_credential_id: 1,
|
|
584
591
|
s3_bucket: "my-bucket",
|
|
585
592
|
s3_compatible_access_key: "example",
|
|
586
593
|
s3_compatible_bucket: "my-bucket",
|
|
@@ -654,7 +661,8 @@ remote_server.update(
|
|
|
654
661
|
* `name` (string): Internal name for your reference
|
|
655
662
|
* `one_drive_account_type` (string): OneDrive: Either personal or business_other account types
|
|
656
663
|
* `pin_to_site_region` (boolean): If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
|
|
657
|
-
* `port` (int64): Port for remote server.
|
|
664
|
+
* `port` (int64): Port for remote server.
|
|
665
|
+
* `remote_server_credential_id` (int64): ID of Remote Server Credential, if applicable.
|
|
658
666
|
* `s3_bucket` (string): S3 bucket name
|
|
659
667
|
* `s3_compatible_access_key` (string): S3-compatible: Access Key
|
|
660
668
|
* `s3_compatible_bucket` (string): S3-compatible: Bucket name
|
|
@@ -665,7 +673,7 @@ remote_server.update(
|
|
|
665
673
|
* `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
|
|
666
674
|
* `server_type` (string): Remote server type.
|
|
667
675
|
* `ssl` (string): Should we require SSL?
|
|
668
|
-
* `username` (string): Remote server username.
|
|
676
|
+
* `username` (string): Remote server username.
|
|
669
677
|
* `wasabi_access_key` (string): Wasabi: Access Key.
|
|
670
678
|
* `wasabi_bucket` (string): Wasabi: Bucket name
|
|
671
679
|
* `wasabi_region` (string): Wasabi: Region
|
|
@@ -0,0 +1,283 @@
|
|
|
1
|
+
# RemoteServerCredential
|
|
2
|
+
|
|
3
|
+
## Example RemoteServerCredential Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"name": "My Credential",
|
|
9
|
+
"description": "More information or notes about this credential.",
|
|
10
|
+
"server_type": "s3",
|
|
11
|
+
"aws_access_key": "example",
|
|
12
|
+
"google_cloud_storage_s3_compatible_access_key": "example",
|
|
13
|
+
"wasabi_access_key": "example",
|
|
14
|
+
"azure_blob_storage_account": "storage-account-name",
|
|
15
|
+
"azure_files_storage_account": "storage-account-name",
|
|
16
|
+
"s3_compatible_access_key": "example",
|
|
17
|
+
"filebase_access_key": "example",
|
|
18
|
+
"cloudflare_access_key": "example",
|
|
19
|
+
"linode_access_key": "example",
|
|
20
|
+
"username": "user"
|
|
21
|
+
}
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
* `id` (int64): Remote Server Credential ID
|
|
25
|
+
* `name` (string): Internal name for your reference
|
|
26
|
+
* `description` (string): Internal description for your reference
|
|
27
|
+
* `server_type` (string): Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
28
|
+
* `aws_access_key` (string): AWS Access Key.
|
|
29
|
+
* `google_cloud_storage_s3_compatible_access_key` (string): Google Cloud Storage: S3-compatible Access Key.
|
|
30
|
+
* `wasabi_access_key` (string): Wasabi: Access Key.
|
|
31
|
+
* `azure_blob_storage_account` (string): Azure Blob Storage: Account name
|
|
32
|
+
* `azure_files_storage_account` (string): Azure Files: Storage Account name
|
|
33
|
+
* `s3_compatible_access_key` (string): S3-compatible: Access Key
|
|
34
|
+
* `filebase_access_key` (string): Filebase: Access Key.
|
|
35
|
+
* `cloudflare_access_key` (string): Cloudflare: Access Key.
|
|
36
|
+
* `linode_access_key` (string): Linode: Access Key
|
|
37
|
+
* `username` (string): Remote server username.
|
|
38
|
+
* `password` (string): Password, if needed.
|
|
39
|
+
* `private_key` (string): Private key, if needed.
|
|
40
|
+
* `private_key_passphrase` (string): Passphrase for private key if needed.
|
|
41
|
+
* `aws_secret_key` (string): AWS: secret key.
|
|
42
|
+
* `azure_blob_storage_access_key` (string): Azure Blob Storage: Access Key
|
|
43
|
+
* `azure_blob_storage_sas_token` (string): Azure Blob Storage: Shared Access Signature (SAS) token
|
|
44
|
+
* `azure_files_storage_access_key` (string): Azure File Storage: Access Key
|
|
45
|
+
* `azure_files_storage_sas_token` (string): Azure File Storage: Shared Access Signature (SAS) token
|
|
46
|
+
* `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage: applicationKey
|
|
47
|
+
* `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage: keyID
|
|
48
|
+
* `cloudflare_secret_key` (string): Cloudflare: Secret Key
|
|
49
|
+
* `filebase_secret_key` (string): Filebase: Secret Key
|
|
50
|
+
* `google_cloud_storage_credentials_json` (string): Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
|
|
51
|
+
* `google_cloud_storage_s3_compatible_secret_key` (string): Google Cloud Storage: S3-compatible secret key
|
|
52
|
+
* `linode_secret_key` (string): Linode: Secret Key
|
|
53
|
+
* `s3_compatible_secret_key` (string): S3-compatible: Secret Key
|
|
54
|
+
* `wasabi_secret_key` (string): Wasabi: Secret Key
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## List Remote Server Credentials
|
|
60
|
+
|
|
61
|
+
```
|
|
62
|
+
Files::RemoteServerCredential.list
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Parameters
|
|
66
|
+
|
|
67
|
+
* `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.
|
|
68
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
69
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
|
|
70
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## Show Remote Server Credential
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
Files::RemoteServerCredential.find(id)
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Parameters
|
|
82
|
+
|
|
83
|
+
* `id` (int64): Required - Remote Server Credential ID.
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## Create Remote Server Credential
|
|
89
|
+
|
|
90
|
+
```
|
|
91
|
+
Files::RemoteServerCredential.create(
|
|
92
|
+
name: "My Credential",
|
|
93
|
+
description: "More information or notes about this credential.",
|
|
94
|
+
server_type: "s3",
|
|
95
|
+
aws_access_key: "example",
|
|
96
|
+
azure_blob_storage_account: "storage-account-name",
|
|
97
|
+
azure_files_storage_account: "storage-account-name",
|
|
98
|
+
cloudflare_access_key: "example",
|
|
99
|
+
filebase_access_key: "example",
|
|
100
|
+
google_cloud_storage_s3_compatible_access_key: "example",
|
|
101
|
+
linode_access_key: "example",
|
|
102
|
+
s3_compatible_access_key: "example",
|
|
103
|
+
username: "user",
|
|
104
|
+
wasabi_access_key: "example"
|
|
105
|
+
)
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Parameters
|
|
109
|
+
|
|
110
|
+
* `name` (string): Internal name for your reference
|
|
111
|
+
* `description` (string): Internal description for your reference
|
|
112
|
+
* `server_type` (string): Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
113
|
+
* `aws_access_key` (string): AWS Access Key.
|
|
114
|
+
* `azure_blob_storage_account` (string): Azure Blob Storage: Account name
|
|
115
|
+
* `azure_files_storage_account` (string): Azure Files: Storage Account name
|
|
116
|
+
* `cloudflare_access_key` (string): Cloudflare: Access Key.
|
|
117
|
+
* `filebase_access_key` (string): Filebase: Access Key.
|
|
118
|
+
* `google_cloud_storage_s3_compatible_access_key` (string): Google Cloud Storage: S3-compatible Access Key.
|
|
119
|
+
* `linode_access_key` (string): Linode: Access Key
|
|
120
|
+
* `s3_compatible_access_key` (string): S3-compatible: Access Key
|
|
121
|
+
* `username` (string): Remote server username.
|
|
122
|
+
* `wasabi_access_key` (string): Wasabi: Access Key.
|
|
123
|
+
* `password` (string): Password, if needed.
|
|
124
|
+
* `private_key` (string): Private key, if needed.
|
|
125
|
+
* `private_key_passphrase` (string): Passphrase for private key if needed.
|
|
126
|
+
* `aws_secret_key` (string): AWS: secret key.
|
|
127
|
+
* `azure_blob_storage_access_key` (string): Azure Blob Storage: Access Key
|
|
128
|
+
* `azure_blob_storage_sas_token` (string): Azure Blob Storage: Shared Access Signature (SAS) token
|
|
129
|
+
* `azure_files_storage_access_key` (string): Azure File Storage: Access Key
|
|
130
|
+
* `azure_files_storage_sas_token` (string): Azure File Storage: Shared Access Signature (SAS) token
|
|
131
|
+
* `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage: applicationKey
|
|
132
|
+
* `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage: keyID
|
|
133
|
+
* `cloudflare_secret_key` (string): Cloudflare: Secret Key
|
|
134
|
+
* `filebase_secret_key` (string): Filebase: Secret Key
|
|
135
|
+
* `google_cloud_storage_credentials_json` (string): Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
|
|
136
|
+
* `google_cloud_storage_s3_compatible_secret_key` (string): Google Cloud Storage: S3-compatible secret key
|
|
137
|
+
* `linode_secret_key` (string): Linode: Secret Key
|
|
138
|
+
* `s3_compatible_secret_key` (string): S3-compatible: Secret Key
|
|
139
|
+
* `wasabi_secret_key` (string): Wasabi: Secret Key
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## Update Remote Server Credential
|
|
145
|
+
|
|
146
|
+
```
|
|
147
|
+
Files::RemoteServerCredential.update(id,
|
|
148
|
+
name: "My Credential",
|
|
149
|
+
description: "More information or notes about this credential.",
|
|
150
|
+
server_type: "s3",
|
|
151
|
+
aws_access_key: "example",
|
|
152
|
+
azure_blob_storage_account: "storage-account-name",
|
|
153
|
+
azure_files_storage_account: "storage-account-name",
|
|
154
|
+
cloudflare_access_key: "example",
|
|
155
|
+
filebase_access_key: "example",
|
|
156
|
+
google_cloud_storage_s3_compatible_access_key: "example",
|
|
157
|
+
linode_access_key: "example",
|
|
158
|
+
s3_compatible_access_key: "example",
|
|
159
|
+
username: "user",
|
|
160
|
+
wasabi_access_key: "example"
|
|
161
|
+
)
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Parameters
|
|
165
|
+
|
|
166
|
+
* `id` (int64): Required - Remote Server Credential ID.
|
|
167
|
+
* `name` (string): Internal name for your reference
|
|
168
|
+
* `description` (string): Internal description for your reference
|
|
169
|
+
* `server_type` (string): Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
170
|
+
* `aws_access_key` (string): AWS Access Key.
|
|
171
|
+
* `azure_blob_storage_account` (string): Azure Blob Storage: Account name
|
|
172
|
+
* `azure_files_storage_account` (string): Azure Files: Storage Account name
|
|
173
|
+
* `cloudflare_access_key` (string): Cloudflare: Access Key.
|
|
174
|
+
* `filebase_access_key` (string): Filebase: Access Key.
|
|
175
|
+
* `google_cloud_storage_s3_compatible_access_key` (string): Google Cloud Storage: S3-compatible Access Key.
|
|
176
|
+
* `linode_access_key` (string): Linode: Access Key
|
|
177
|
+
* `s3_compatible_access_key` (string): S3-compatible: Access Key
|
|
178
|
+
* `username` (string): Remote server username.
|
|
179
|
+
* `wasabi_access_key` (string): Wasabi: Access Key.
|
|
180
|
+
* `password` (string): Password, if needed.
|
|
181
|
+
* `private_key` (string): Private key, if needed.
|
|
182
|
+
* `private_key_passphrase` (string): Passphrase for private key if needed.
|
|
183
|
+
* `aws_secret_key` (string): AWS: secret key.
|
|
184
|
+
* `azure_blob_storage_access_key` (string): Azure Blob Storage: Access Key
|
|
185
|
+
* `azure_blob_storage_sas_token` (string): Azure Blob Storage: Shared Access Signature (SAS) token
|
|
186
|
+
* `azure_files_storage_access_key` (string): Azure File Storage: Access Key
|
|
187
|
+
* `azure_files_storage_sas_token` (string): Azure File Storage: Shared Access Signature (SAS) token
|
|
188
|
+
* `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage: applicationKey
|
|
189
|
+
* `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage: keyID
|
|
190
|
+
* `cloudflare_secret_key` (string): Cloudflare: Secret Key
|
|
191
|
+
* `filebase_secret_key` (string): Filebase: Secret Key
|
|
192
|
+
* `google_cloud_storage_credentials_json` (string): Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
|
|
193
|
+
* `google_cloud_storage_s3_compatible_secret_key` (string): Google Cloud Storage: S3-compatible secret key
|
|
194
|
+
* `linode_secret_key` (string): Linode: Secret Key
|
|
195
|
+
* `s3_compatible_secret_key` (string): S3-compatible: Secret Key
|
|
196
|
+
* `wasabi_secret_key` (string): Wasabi: Secret Key
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
---
|
|
200
|
+
|
|
201
|
+
## Delete Remote Server Credential
|
|
202
|
+
|
|
203
|
+
```
|
|
204
|
+
Files::RemoteServerCredential.delete(id)
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### Parameters
|
|
208
|
+
|
|
209
|
+
* `id` (int64): Required - Remote Server Credential ID.
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
---
|
|
213
|
+
|
|
214
|
+
## Update Remote Server Credential
|
|
215
|
+
|
|
216
|
+
```
|
|
217
|
+
remote_server_credential = Files::RemoteServerCredential.find(id)
|
|
218
|
+
|
|
219
|
+
remote_server_credential.update(
|
|
220
|
+
name: "My Credential",
|
|
221
|
+
description: "More information or notes about this credential.",
|
|
222
|
+
server_type: "s3",
|
|
223
|
+
aws_access_key: "example",
|
|
224
|
+
azure_blob_storage_account: "storage-account-name",
|
|
225
|
+
azure_files_storage_account: "storage-account-name",
|
|
226
|
+
cloudflare_access_key: "example",
|
|
227
|
+
filebase_access_key: "example",
|
|
228
|
+
google_cloud_storage_s3_compatible_access_key: "example",
|
|
229
|
+
linode_access_key: "example",
|
|
230
|
+
s3_compatible_access_key: "example",
|
|
231
|
+
username: "user",
|
|
232
|
+
wasabi_access_key: "example"
|
|
233
|
+
)
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
### Parameters
|
|
237
|
+
|
|
238
|
+
* `id` (int64): Required - Remote Server Credential ID.
|
|
239
|
+
* `name` (string): Internal name for your reference
|
|
240
|
+
* `description` (string): Internal description for your reference
|
|
241
|
+
* `server_type` (string): Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
242
|
+
* `aws_access_key` (string): AWS Access Key.
|
|
243
|
+
* `azure_blob_storage_account` (string): Azure Blob Storage: Account name
|
|
244
|
+
* `azure_files_storage_account` (string): Azure Files: Storage Account name
|
|
245
|
+
* `cloudflare_access_key` (string): Cloudflare: Access Key.
|
|
246
|
+
* `filebase_access_key` (string): Filebase: Access Key.
|
|
247
|
+
* `google_cloud_storage_s3_compatible_access_key` (string): Google Cloud Storage: S3-compatible Access Key.
|
|
248
|
+
* `linode_access_key` (string): Linode: Access Key
|
|
249
|
+
* `s3_compatible_access_key` (string): S3-compatible: Access Key
|
|
250
|
+
* `username` (string): Remote server username.
|
|
251
|
+
* `wasabi_access_key` (string): Wasabi: Access Key.
|
|
252
|
+
* `password` (string): Password, if needed.
|
|
253
|
+
* `private_key` (string): Private key, if needed.
|
|
254
|
+
* `private_key_passphrase` (string): Passphrase for private key if needed.
|
|
255
|
+
* `aws_secret_key` (string): AWS: secret key.
|
|
256
|
+
* `azure_blob_storage_access_key` (string): Azure Blob Storage: Access Key
|
|
257
|
+
* `azure_blob_storage_sas_token` (string): Azure Blob Storage: Shared Access Signature (SAS) token
|
|
258
|
+
* `azure_files_storage_access_key` (string): Azure File Storage: Access Key
|
|
259
|
+
* `azure_files_storage_sas_token` (string): Azure File Storage: Shared Access Signature (SAS) token
|
|
260
|
+
* `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage: applicationKey
|
|
261
|
+
* `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage: keyID
|
|
262
|
+
* `cloudflare_secret_key` (string): Cloudflare: Secret Key
|
|
263
|
+
* `filebase_secret_key` (string): Filebase: Secret Key
|
|
264
|
+
* `google_cloud_storage_credentials_json` (string): Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
|
|
265
|
+
* `google_cloud_storage_s3_compatible_secret_key` (string): Google Cloud Storage: S3-compatible secret key
|
|
266
|
+
* `linode_secret_key` (string): Linode: Secret Key
|
|
267
|
+
* `s3_compatible_secret_key` (string): S3-compatible: Secret Key
|
|
268
|
+
* `wasabi_secret_key` (string): Wasabi: Secret Key
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
---
|
|
272
|
+
|
|
273
|
+
## Delete Remote Server Credential
|
|
274
|
+
|
|
275
|
+
```
|
|
276
|
+
remote_server_credential = Files::RemoteServerCredential.find(id)
|
|
277
|
+
|
|
278
|
+
remote_server_credential.delete
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
### Parameters
|
|
282
|
+
|
|
283
|
+
* `id` (int64): Required - Remote Server Credential ID.
|
|
@@ -519,7 +519,7 @@ module Files
|
|
|
519
519
|
# 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.
|
|
520
520
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
521
521
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
|
|
522
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id,
|
|
522
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, expires_at ]`.
|
|
523
523
|
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_at`.
|
|
524
524
|
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
|
|
525
525
|
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.
|
|
@@ -72,7 +72,7 @@ module Files
|
|
|
72
72
|
@attributes[:description] = value
|
|
73
73
|
end
|
|
74
74
|
|
|
75
|
-
# int64 - Port for remote server.
|
|
75
|
+
# int64 - Port for remote server.
|
|
76
76
|
def port
|
|
77
77
|
@attributes[:port]
|
|
78
78
|
end
|
|
@@ -117,6 +117,15 @@ module Files
|
|
|
117
117
|
@attributes[:pinned_region] = value
|
|
118
118
|
end
|
|
119
119
|
|
|
120
|
+
# int64 - ID of Remote Server Credential, if applicable.
|
|
121
|
+
def remote_server_credential_id
|
|
122
|
+
@attributes[:remote_server_credential_id]
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
def remote_server_credential_id=(value)
|
|
126
|
+
@attributes[:remote_server_credential_id] = value
|
|
127
|
+
end
|
|
128
|
+
|
|
120
129
|
# string - S3 bucket name
|
|
121
130
|
def s3_bucket
|
|
122
131
|
@attributes[:s3_bucket]
|
|
@@ -180,7 +189,7 @@ module Files
|
|
|
180
189
|
@attributes[:ssl] = value
|
|
181
190
|
end
|
|
182
191
|
|
|
183
|
-
# string - Remote server username.
|
|
192
|
+
# string - Remote server username.
|
|
184
193
|
def username
|
|
185
194
|
@attributes[:username]
|
|
186
195
|
end
|
|
@@ -791,7 +800,8 @@ module Files
|
|
|
791
800
|
# name - string - Internal name for your reference
|
|
792
801
|
# one_drive_account_type - string - OneDrive: Either personal or business_other account types
|
|
793
802
|
# pin_to_site_region - boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
|
|
794
|
-
# port - int64 - Port for remote server.
|
|
803
|
+
# port - int64 - Port for remote server.
|
|
804
|
+
# remote_server_credential_id - int64 - ID of Remote Server Credential, if applicable.
|
|
795
805
|
# s3_bucket - string - S3 bucket name
|
|
796
806
|
# s3_compatible_access_key - string - S3-compatible: Access Key
|
|
797
807
|
# s3_compatible_bucket - string - S3-compatible: Bucket name
|
|
@@ -802,7 +812,7 @@ module Files
|
|
|
802
812
|
# 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
|
|
803
813
|
# server_type - string - Remote server type.
|
|
804
814
|
# ssl - string - Should we require SSL?
|
|
805
|
-
# username - string - Remote server username.
|
|
815
|
+
# username - string - Remote server username.
|
|
806
816
|
# wasabi_access_key - string - Wasabi: Access Key.
|
|
807
817
|
# wasabi_bucket - string - Wasabi: Bucket name
|
|
808
818
|
# wasabi_region - string - Wasabi: Region
|
|
@@ -860,6 +870,7 @@ module Files
|
|
|
860
870
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
861
871
|
raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params[:one_drive_account_type] and !params[:one_drive_account_type].is_a?(String)
|
|
862
872
|
raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params[:port] and !params[:port].is_a?(Integer)
|
|
873
|
+
raise InvalidParameterError.new("Bad parameter: remote_server_credential_id must be an Integer") if params[:remote_server_credential_id] and !params[:remote_server_credential_id].is_a?(Integer)
|
|
863
874
|
raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params[:s3_bucket] and !params[:s3_bucket].is_a?(String)
|
|
864
875
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_access_key must be an String") if params[:s3_compatible_access_key] and !params[:s3_compatible_access_key].is_a?(String)
|
|
865
876
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_bucket must be an String") if params[:s3_compatible_bucket] and !params[:s3_compatible_bucket].is_a?(String)
|
|
@@ -1009,7 +1020,8 @@ module Files
|
|
|
1009
1020
|
# name - string - Internal name for your reference
|
|
1010
1021
|
# one_drive_account_type - string - OneDrive: Either personal or business_other account types
|
|
1011
1022
|
# pin_to_site_region - boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
|
|
1012
|
-
# port - int64 - Port for remote server.
|
|
1023
|
+
# port - int64 - Port for remote server.
|
|
1024
|
+
# remote_server_credential_id - int64 - ID of Remote Server Credential, if applicable.
|
|
1013
1025
|
# s3_bucket - string - S3 bucket name
|
|
1014
1026
|
# s3_compatible_access_key - string - S3-compatible: Access Key
|
|
1015
1027
|
# s3_compatible_bucket - string - S3-compatible: Bucket name
|
|
@@ -1020,7 +1032,7 @@ module Files
|
|
|
1020
1032
|
# 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
|
|
1021
1033
|
# server_type - string - Remote server type.
|
|
1022
1034
|
# ssl - string - Should we require SSL?
|
|
1023
|
-
# username - string - Remote server username.
|
|
1035
|
+
# username - string - Remote server username.
|
|
1024
1036
|
# wasabi_access_key - string - Wasabi: Access Key.
|
|
1025
1037
|
# wasabi_bucket - string - Wasabi: Bucket name
|
|
1026
1038
|
# wasabi_region - string - Wasabi: Region
|
|
@@ -1074,6 +1086,7 @@ module Files
|
|
|
1074
1086
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
1075
1087
|
raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params[:one_drive_account_type] and !params[:one_drive_account_type].is_a?(String)
|
|
1076
1088
|
raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params[:port] and !params[:port].is_a?(Integer)
|
|
1089
|
+
raise InvalidParameterError.new("Bad parameter: remote_server_credential_id must be an Integer") if params[:remote_server_credential_id] and !params[:remote_server_credential_id].is_a?(Integer)
|
|
1077
1090
|
raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params[:s3_bucket] and !params[:s3_bucket].is_a?(String)
|
|
1078
1091
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_access_key must be an String") if params[:s3_compatible_access_key] and !params[:s3_compatible_access_key].is_a?(String)
|
|
1079
1092
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_bucket must be an String") if params[:s3_compatible_bucket] and !params[:s3_compatible_bucket].is_a?(String)
|
|
@@ -1182,7 +1195,8 @@ module Files
|
|
|
1182
1195
|
# name - string - Internal name for your reference
|
|
1183
1196
|
# one_drive_account_type - string - OneDrive: Either personal or business_other account types
|
|
1184
1197
|
# pin_to_site_region - boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
|
|
1185
|
-
# port - int64 - Port for remote server.
|
|
1198
|
+
# port - int64 - Port for remote server.
|
|
1199
|
+
# remote_server_credential_id - int64 - ID of Remote Server Credential, if applicable.
|
|
1186
1200
|
# s3_bucket - string - S3 bucket name
|
|
1187
1201
|
# s3_compatible_access_key - string - S3-compatible: Access Key
|
|
1188
1202
|
# s3_compatible_bucket - string - S3-compatible: Bucket name
|
|
@@ -1193,7 +1207,7 @@ module Files
|
|
|
1193
1207
|
# 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
|
|
1194
1208
|
# server_type - string - Remote server type.
|
|
1195
1209
|
# ssl - string - Should we require SSL?
|
|
1196
|
-
# username - string - Remote server username.
|
|
1210
|
+
# username - string - Remote server username.
|
|
1197
1211
|
# wasabi_access_key - string - Wasabi: Access Key.
|
|
1198
1212
|
# wasabi_bucket - string - Wasabi: Bucket name
|
|
1199
1213
|
# wasabi_region - string - Wasabi: Region
|
|
@@ -1250,6 +1264,7 @@ module Files
|
|
|
1250
1264
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
1251
1265
|
raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params[:one_drive_account_type] and !params[:one_drive_account_type].is_a?(String)
|
|
1252
1266
|
raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params[:port] and !params[:port].is_a?(Integer)
|
|
1267
|
+
raise InvalidParameterError.new("Bad parameter: remote_server_credential_id must be an Integer") if params[:remote_server_credential_id] and !params[:remote_server_credential_id].is_a?(Integer)
|
|
1253
1268
|
raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params[:s3_bucket] and !params[:s3_bucket].is_a?(String)
|
|
1254
1269
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_access_key must be an String") if params[:s3_compatible_access_key] and !params[:s3_compatible_access_key].is_a?(String)
|
|
1255
1270
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_bucket must be an String") if params[:s3_compatible_bucket] and !params[:s3_compatible_bucket].is_a?(String)
|
|
@@ -0,0 +1,577 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Files
|
|
4
|
+
class RemoteServerCredential
|
|
5
|
+
attr_reader :options, :attributes
|
|
6
|
+
|
|
7
|
+
def initialize(attributes = {}, options = {})
|
|
8
|
+
@attributes = attributes || {}
|
|
9
|
+
@options = options || {}
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# int64 - Remote Server Credential ID
|
|
13
|
+
def id
|
|
14
|
+
@attributes[:id]
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
def id=(value)
|
|
18
|
+
@attributes[:id] = value
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
# string - Internal name for your reference
|
|
22
|
+
def name
|
|
23
|
+
@attributes[:name]
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def name=(value)
|
|
27
|
+
@attributes[:name] = value
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
# string - Internal description for your reference
|
|
31
|
+
def description
|
|
32
|
+
@attributes[:description]
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
def description=(value)
|
|
36
|
+
@attributes[:description] = value
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
# string - Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
40
|
+
def server_type
|
|
41
|
+
@attributes[:server_type]
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
def server_type=(value)
|
|
45
|
+
@attributes[:server_type] = value
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# string - AWS Access Key.
|
|
49
|
+
def aws_access_key
|
|
50
|
+
@attributes[:aws_access_key]
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
def aws_access_key=(value)
|
|
54
|
+
@attributes[:aws_access_key] = value
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# string - Google Cloud Storage: S3-compatible Access Key.
|
|
58
|
+
def google_cloud_storage_s3_compatible_access_key
|
|
59
|
+
@attributes[:google_cloud_storage_s3_compatible_access_key]
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
def google_cloud_storage_s3_compatible_access_key=(value)
|
|
63
|
+
@attributes[:google_cloud_storage_s3_compatible_access_key] = value
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
# string - Wasabi: Access Key.
|
|
67
|
+
def wasabi_access_key
|
|
68
|
+
@attributes[:wasabi_access_key]
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
def wasabi_access_key=(value)
|
|
72
|
+
@attributes[:wasabi_access_key] = value
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# string - Azure Blob Storage: Account name
|
|
76
|
+
def azure_blob_storage_account
|
|
77
|
+
@attributes[:azure_blob_storage_account]
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
def azure_blob_storage_account=(value)
|
|
81
|
+
@attributes[:azure_blob_storage_account] = value
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# string - Azure Files: Storage Account name
|
|
85
|
+
def azure_files_storage_account
|
|
86
|
+
@attributes[:azure_files_storage_account]
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
def azure_files_storage_account=(value)
|
|
90
|
+
@attributes[:azure_files_storage_account] = value
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
# string - S3-compatible: Access Key
|
|
94
|
+
def s3_compatible_access_key
|
|
95
|
+
@attributes[:s3_compatible_access_key]
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
def s3_compatible_access_key=(value)
|
|
99
|
+
@attributes[:s3_compatible_access_key] = value
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# string - Filebase: Access Key.
|
|
103
|
+
def filebase_access_key
|
|
104
|
+
@attributes[:filebase_access_key]
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
def filebase_access_key=(value)
|
|
108
|
+
@attributes[:filebase_access_key] = value
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
# string - Cloudflare: Access Key.
|
|
112
|
+
def cloudflare_access_key
|
|
113
|
+
@attributes[:cloudflare_access_key]
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
def cloudflare_access_key=(value)
|
|
117
|
+
@attributes[:cloudflare_access_key] = value
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# string - Linode: Access Key
|
|
121
|
+
def linode_access_key
|
|
122
|
+
@attributes[:linode_access_key]
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
def linode_access_key=(value)
|
|
126
|
+
@attributes[:linode_access_key] = value
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
# string - Remote server username.
|
|
130
|
+
def username
|
|
131
|
+
@attributes[:username]
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
def username=(value)
|
|
135
|
+
@attributes[:username] = value
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
# string - Password, if needed.
|
|
139
|
+
def password
|
|
140
|
+
@attributes[:password]
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
def password=(value)
|
|
144
|
+
@attributes[:password] = value
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
# string - Private key, if needed.
|
|
148
|
+
def private_key
|
|
149
|
+
@attributes[:private_key]
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
def private_key=(value)
|
|
153
|
+
@attributes[:private_key] = value
|
|
154
|
+
end
|
|
155
|
+
|
|
156
|
+
# string - Passphrase for private key if needed.
|
|
157
|
+
def private_key_passphrase
|
|
158
|
+
@attributes[:private_key_passphrase]
|
|
159
|
+
end
|
|
160
|
+
|
|
161
|
+
def private_key_passphrase=(value)
|
|
162
|
+
@attributes[:private_key_passphrase] = value
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# string - AWS: secret key.
|
|
166
|
+
def aws_secret_key
|
|
167
|
+
@attributes[:aws_secret_key]
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
def aws_secret_key=(value)
|
|
171
|
+
@attributes[:aws_secret_key] = value
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
# string - Azure Blob Storage: Access Key
|
|
175
|
+
def azure_blob_storage_access_key
|
|
176
|
+
@attributes[:azure_blob_storage_access_key]
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
def azure_blob_storage_access_key=(value)
|
|
180
|
+
@attributes[:azure_blob_storage_access_key] = value
|
|
181
|
+
end
|
|
182
|
+
|
|
183
|
+
# string - Azure Blob Storage: Shared Access Signature (SAS) token
|
|
184
|
+
def azure_blob_storage_sas_token
|
|
185
|
+
@attributes[:azure_blob_storage_sas_token]
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
def azure_blob_storage_sas_token=(value)
|
|
189
|
+
@attributes[:azure_blob_storage_sas_token] = value
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
# string - Azure File Storage: Access Key
|
|
193
|
+
def azure_files_storage_access_key
|
|
194
|
+
@attributes[:azure_files_storage_access_key]
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
def azure_files_storage_access_key=(value)
|
|
198
|
+
@attributes[:azure_files_storage_access_key] = value
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
# string - Azure File Storage: Shared Access Signature (SAS) token
|
|
202
|
+
def azure_files_storage_sas_token
|
|
203
|
+
@attributes[:azure_files_storage_sas_token]
|
|
204
|
+
end
|
|
205
|
+
|
|
206
|
+
def azure_files_storage_sas_token=(value)
|
|
207
|
+
@attributes[:azure_files_storage_sas_token] = value
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
# string - Backblaze B2 Cloud Storage: applicationKey
|
|
211
|
+
def backblaze_b2_application_key
|
|
212
|
+
@attributes[:backblaze_b2_application_key]
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
def backblaze_b2_application_key=(value)
|
|
216
|
+
@attributes[:backblaze_b2_application_key] = value
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
# string - Backblaze B2 Cloud Storage: keyID
|
|
220
|
+
def backblaze_b2_key_id
|
|
221
|
+
@attributes[:backblaze_b2_key_id]
|
|
222
|
+
end
|
|
223
|
+
|
|
224
|
+
def backblaze_b2_key_id=(value)
|
|
225
|
+
@attributes[:backblaze_b2_key_id] = value
|
|
226
|
+
end
|
|
227
|
+
|
|
228
|
+
# string - Cloudflare: Secret Key
|
|
229
|
+
def cloudflare_secret_key
|
|
230
|
+
@attributes[:cloudflare_secret_key]
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
def cloudflare_secret_key=(value)
|
|
234
|
+
@attributes[:cloudflare_secret_key] = value
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
# string - Filebase: Secret Key
|
|
238
|
+
def filebase_secret_key
|
|
239
|
+
@attributes[:filebase_secret_key]
|
|
240
|
+
end
|
|
241
|
+
|
|
242
|
+
def filebase_secret_key=(value)
|
|
243
|
+
@attributes[:filebase_secret_key] = value
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
# string - Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
|
|
247
|
+
def google_cloud_storage_credentials_json
|
|
248
|
+
@attributes[:google_cloud_storage_credentials_json]
|
|
249
|
+
end
|
|
250
|
+
|
|
251
|
+
def google_cloud_storage_credentials_json=(value)
|
|
252
|
+
@attributes[:google_cloud_storage_credentials_json] = value
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
# string - Google Cloud Storage: S3-compatible secret key
|
|
256
|
+
def google_cloud_storage_s3_compatible_secret_key
|
|
257
|
+
@attributes[:google_cloud_storage_s3_compatible_secret_key]
|
|
258
|
+
end
|
|
259
|
+
|
|
260
|
+
def google_cloud_storage_s3_compatible_secret_key=(value)
|
|
261
|
+
@attributes[:google_cloud_storage_s3_compatible_secret_key] = value
|
|
262
|
+
end
|
|
263
|
+
|
|
264
|
+
# string - Linode: Secret Key
|
|
265
|
+
def linode_secret_key
|
|
266
|
+
@attributes[:linode_secret_key]
|
|
267
|
+
end
|
|
268
|
+
|
|
269
|
+
def linode_secret_key=(value)
|
|
270
|
+
@attributes[:linode_secret_key] = value
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
# string - S3-compatible: Secret Key
|
|
274
|
+
def s3_compatible_secret_key
|
|
275
|
+
@attributes[:s3_compatible_secret_key]
|
|
276
|
+
end
|
|
277
|
+
|
|
278
|
+
def s3_compatible_secret_key=(value)
|
|
279
|
+
@attributes[:s3_compatible_secret_key] = value
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
# string - Wasabi: Secret Key
|
|
283
|
+
def wasabi_secret_key
|
|
284
|
+
@attributes[:wasabi_secret_key]
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
def wasabi_secret_key=(value)
|
|
288
|
+
@attributes[:wasabi_secret_key] = value
|
|
289
|
+
end
|
|
290
|
+
|
|
291
|
+
# Parameters:
|
|
292
|
+
# name - string - Internal name for your reference
|
|
293
|
+
# description - string - Internal description for your reference
|
|
294
|
+
# server_type - string - Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
295
|
+
# aws_access_key - string - AWS Access Key.
|
|
296
|
+
# azure_blob_storage_account - string - Azure Blob Storage: Account name
|
|
297
|
+
# azure_files_storage_account - string - Azure Files: Storage Account name
|
|
298
|
+
# cloudflare_access_key - string - Cloudflare: Access Key.
|
|
299
|
+
# filebase_access_key - string - Filebase: Access Key.
|
|
300
|
+
# google_cloud_storage_s3_compatible_access_key - string - Google Cloud Storage: S3-compatible Access Key.
|
|
301
|
+
# linode_access_key - string - Linode: Access Key
|
|
302
|
+
# s3_compatible_access_key - string - S3-compatible: Access Key
|
|
303
|
+
# username - string - Remote server username.
|
|
304
|
+
# wasabi_access_key - string - Wasabi: Access Key.
|
|
305
|
+
# password - string - Password, if needed.
|
|
306
|
+
# private_key - string - Private key, if needed.
|
|
307
|
+
# private_key_passphrase - string - Passphrase for private key if needed.
|
|
308
|
+
# aws_secret_key - string - AWS: secret key.
|
|
309
|
+
# azure_blob_storage_access_key - string - Azure Blob Storage: Access Key
|
|
310
|
+
# azure_blob_storage_sas_token - string - Azure Blob Storage: Shared Access Signature (SAS) token
|
|
311
|
+
# azure_files_storage_access_key - string - Azure File Storage: Access Key
|
|
312
|
+
# azure_files_storage_sas_token - string - Azure File Storage: Shared Access Signature (SAS) token
|
|
313
|
+
# backblaze_b2_application_key - string - Backblaze B2 Cloud Storage: applicationKey
|
|
314
|
+
# backblaze_b2_key_id - string - Backblaze B2 Cloud Storage: keyID
|
|
315
|
+
# cloudflare_secret_key - string - Cloudflare: Secret Key
|
|
316
|
+
# filebase_secret_key - string - Filebase: Secret Key
|
|
317
|
+
# google_cloud_storage_credentials_json - string - Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
|
|
318
|
+
# google_cloud_storage_s3_compatible_secret_key - string - Google Cloud Storage: S3-compatible secret key
|
|
319
|
+
# linode_secret_key - string - Linode: Secret Key
|
|
320
|
+
# s3_compatible_secret_key - string - S3-compatible: Secret Key
|
|
321
|
+
# wasabi_secret_key - string - Wasabi: Secret Key
|
|
322
|
+
def update(params = {})
|
|
323
|
+
params ||= {}
|
|
324
|
+
params[:id] = @attributes[:id]
|
|
325
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
326
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
327
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
328
|
+
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
329
|
+
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params[:server_type] and !params[:server_type].is_a?(String)
|
|
330
|
+
raise InvalidParameterError.new("Bad parameter: aws_access_key must be an String") if params[:aws_access_key] and !params[:aws_access_key].is_a?(String)
|
|
331
|
+
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params[:azure_blob_storage_account] and !params[:azure_blob_storage_account].is_a?(String)
|
|
332
|
+
raise InvalidParameterError.new("Bad parameter: azure_files_storage_account must be an String") if params[:azure_files_storage_account] and !params[:azure_files_storage_account].is_a?(String)
|
|
333
|
+
raise InvalidParameterError.new("Bad parameter: cloudflare_access_key must be an String") if params[:cloudflare_access_key] and !params[:cloudflare_access_key].is_a?(String)
|
|
334
|
+
raise InvalidParameterError.new("Bad parameter: filebase_access_key must be an String") if params[:filebase_access_key] and !params[:filebase_access_key].is_a?(String)
|
|
335
|
+
raise InvalidParameterError.new("Bad parameter: google_cloud_storage_s3_compatible_access_key must be an String") if params[:google_cloud_storage_s3_compatible_access_key] and !params[:google_cloud_storage_s3_compatible_access_key].is_a?(String)
|
|
336
|
+
raise InvalidParameterError.new("Bad parameter: linode_access_key must be an String") if params[:linode_access_key] and !params[:linode_access_key].is_a?(String)
|
|
337
|
+
raise InvalidParameterError.new("Bad parameter: s3_compatible_access_key must be an String") if params[:s3_compatible_access_key] and !params[:s3_compatible_access_key].is_a?(String)
|
|
338
|
+
raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
|
|
339
|
+
raise InvalidParameterError.new("Bad parameter: wasabi_access_key must be an String") if params[:wasabi_access_key] and !params[:wasabi_access_key].is_a?(String)
|
|
340
|
+
raise InvalidParameterError.new("Bad parameter: password must be an String") if params[:password] and !params[:password].is_a?(String)
|
|
341
|
+
raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
|
|
342
|
+
raise InvalidParameterError.new("Bad parameter: private_key_passphrase must be an String") if params[:private_key_passphrase] and !params[:private_key_passphrase].is_a?(String)
|
|
343
|
+
raise InvalidParameterError.new("Bad parameter: aws_secret_key must be an String") if params[:aws_secret_key] and !params[:aws_secret_key].is_a?(String)
|
|
344
|
+
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_access_key must be an String") if params[:azure_blob_storage_access_key] and !params[:azure_blob_storage_access_key].is_a?(String)
|
|
345
|
+
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_sas_token must be an String") if params[:azure_blob_storage_sas_token] and !params[:azure_blob_storage_sas_token].is_a?(String)
|
|
346
|
+
raise InvalidParameterError.new("Bad parameter: azure_files_storage_access_key must be an String") if params[:azure_files_storage_access_key] and !params[:azure_files_storage_access_key].is_a?(String)
|
|
347
|
+
raise InvalidParameterError.new("Bad parameter: azure_files_storage_sas_token must be an String") if params[:azure_files_storage_sas_token] and !params[:azure_files_storage_sas_token].is_a?(String)
|
|
348
|
+
raise InvalidParameterError.new("Bad parameter: backblaze_b2_application_key must be an String") if params[:backblaze_b2_application_key] and !params[:backblaze_b2_application_key].is_a?(String)
|
|
349
|
+
raise InvalidParameterError.new("Bad parameter: backblaze_b2_key_id must be an String") if params[:backblaze_b2_key_id] and !params[:backblaze_b2_key_id].is_a?(String)
|
|
350
|
+
raise InvalidParameterError.new("Bad parameter: cloudflare_secret_key must be an String") if params[:cloudflare_secret_key] and !params[:cloudflare_secret_key].is_a?(String)
|
|
351
|
+
raise InvalidParameterError.new("Bad parameter: filebase_secret_key must be an String") if params[:filebase_secret_key] and !params[:filebase_secret_key].is_a?(String)
|
|
352
|
+
raise InvalidParameterError.new("Bad parameter: google_cloud_storage_credentials_json must be an String") if params[:google_cloud_storage_credentials_json] and !params[:google_cloud_storage_credentials_json].is_a?(String)
|
|
353
|
+
raise InvalidParameterError.new("Bad parameter: google_cloud_storage_s3_compatible_secret_key must be an String") if params[:google_cloud_storage_s3_compatible_secret_key] and !params[:google_cloud_storage_s3_compatible_secret_key].is_a?(String)
|
|
354
|
+
raise InvalidParameterError.new("Bad parameter: linode_secret_key must be an String") if params[:linode_secret_key] and !params[:linode_secret_key].is_a?(String)
|
|
355
|
+
raise InvalidParameterError.new("Bad parameter: s3_compatible_secret_key must be an String") if params[:s3_compatible_secret_key] and !params[:s3_compatible_secret_key].is_a?(String)
|
|
356
|
+
raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params[:wasabi_secret_key] and !params[:wasabi_secret_key].is_a?(String)
|
|
357
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
358
|
+
|
|
359
|
+
Api.send_request("/remote_server_credentials/#{@attributes[:id]}", :patch, params, @options)
|
|
360
|
+
end
|
|
361
|
+
|
|
362
|
+
def delete(params = {})
|
|
363
|
+
params ||= {}
|
|
364
|
+
params[:id] = @attributes[:id]
|
|
365
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
366
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
367
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
368
|
+
|
|
369
|
+
Api.send_request("/remote_server_credentials/#{@attributes[:id]}", :delete, params, @options)
|
|
370
|
+
end
|
|
371
|
+
|
|
372
|
+
def destroy(params = {})
|
|
373
|
+
delete(params)
|
|
374
|
+
nil
|
|
375
|
+
end
|
|
376
|
+
|
|
377
|
+
def save
|
|
378
|
+
if @attributes[:id]
|
|
379
|
+
new_obj = update(@attributes)
|
|
380
|
+
else
|
|
381
|
+
new_obj = RemoteServerCredential.create(@attributes, @options)
|
|
382
|
+
end
|
|
383
|
+
|
|
384
|
+
@attributes = new_obj.attributes
|
|
385
|
+
true
|
|
386
|
+
end
|
|
387
|
+
|
|
388
|
+
# Parameters:
|
|
389
|
+
# 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.
|
|
390
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
391
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
|
|
392
|
+
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
|
|
393
|
+
def self.list(params = {}, options = {})
|
|
394
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
395
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
396
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
397
|
+
raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
|
|
398
|
+
|
|
399
|
+
List.new(RemoteServerCredential, params) do
|
|
400
|
+
Api.send_request("/remote_server_credentials", :get, params, options)
|
|
401
|
+
end
|
|
402
|
+
end
|
|
403
|
+
|
|
404
|
+
def self.all(params = {}, options = {})
|
|
405
|
+
list(params, options)
|
|
406
|
+
end
|
|
407
|
+
|
|
408
|
+
# Parameters:
|
|
409
|
+
# id (required) - int64 - Remote Server Credential ID.
|
|
410
|
+
def self.find(id, params = {}, options = {})
|
|
411
|
+
params ||= {}
|
|
412
|
+
params[:id] = id
|
|
413
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
414
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
415
|
+
|
|
416
|
+
response, options = Api.send_request("/remote_server_credentials/#{params[:id]}", :get, params, options)
|
|
417
|
+
RemoteServerCredential.new(response.data, options)
|
|
418
|
+
end
|
|
419
|
+
|
|
420
|
+
def self.get(id, params = {}, options = {})
|
|
421
|
+
find(id, params, options)
|
|
422
|
+
end
|
|
423
|
+
|
|
424
|
+
# Parameters:
|
|
425
|
+
# name - string - Internal name for your reference
|
|
426
|
+
# description - string - Internal description for your reference
|
|
427
|
+
# server_type - string - Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
428
|
+
# aws_access_key - string - AWS Access Key.
|
|
429
|
+
# azure_blob_storage_account - string - Azure Blob Storage: Account name
|
|
430
|
+
# azure_files_storage_account - string - Azure Files: Storage Account name
|
|
431
|
+
# cloudflare_access_key - string - Cloudflare: Access Key.
|
|
432
|
+
# filebase_access_key - string - Filebase: Access Key.
|
|
433
|
+
# google_cloud_storage_s3_compatible_access_key - string - Google Cloud Storage: S3-compatible Access Key.
|
|
434
|
+
# linode_access_key - string - Linode: Access Key
|
|
435
|
+
# s3_compatible_access_key - string - S3-compatible: Access Key
|
|
436
|
+
# username - string - Remote server username.
|
|
437
|
+
# wasabi_access_key - string - Wasabi: Access Key.
|
|
438
|
+
# password - string - Password, if needed.
|
|
439
|
+
# private_key - string - Private key, if needed.
|
|
440
|
+
# private_key_passphrase - string - Passphrase for private key if needed.
|
|
441
|
+
# aws_secret_key - string - AWS: secret key.
|
|
442
|
+
# azure_blob_storage_access_key - string - Azure Blob Storage: Access Key
|
|
443
|
+
# azure_blob_storage_sas_token - string - Azure Blob Storage: Shared Access Signature (SAS) token
|
|
444
|
+
# azure_files_storage_access_key - string - Azure File Storage: Access Key
|
|
445
|
+
# azure_files_storage_sas_token - string - Azure File Storage: Shared Access Signature (SAS) token
|
|
446
|
+
# backblaze_b2_application_key - string - Backblaze B2 Cloud Storage: applicationKey
|
|
447
|
+
# backblaze_b2_key_id - string - Backblaze B2 Cloud Storage: keyID
|
|
448
|
+
# cloudflare_secret_key - string - Cloudflare: Secret Key
|
|
449
|
+
# filebase_secret_key - string - Filebase: Secret Key
|
|
450
|
+
# google_cloud_storage_credentials_json - string - Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
|
|
451
|
+
# google_cloud_storage_s3_compatible_secret_key - string - Google Cloud Storage: S3-compatible secret key
|
|
452
|
+
# linode_secret_key - string - Linode: Secret Key
|
|
453
|
+
# s3_compatible_secret_key - string - S3-compatible: Secret Key
|
|
454
|
+
# wasabi_secret_key - string - Wasabi: Secret Key
|
|
455
|
+
def self.create(params = {}, options = {})
|
|
456
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
457
|
+
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
458
|
+
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params[:server_type] and !params[:server_type].is_a?(String)
|
|
459
|
+
raise InvalidParameterError.new("Bad parameter: aws_access_key must be an String") if params[:aws_access_key] and !params[:aws_access_key].is_a?(String)
|
|
460
|
+
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params[:azure_blob_storage_account] and !params[:azure_blob_storage_account].is_a?(String)
|
|
461
|
+
raise InvalidParameterError.new("Bad parameter: azure_files_storage_account must be an String") if params[:azure_files_storage_account] and !params[:azure_files_storage_account].is_a?(String)
|
|
462
|
+
raise InvalidParameterError.new("Bad parameter: cloudflare_access_key must be an String") if params[:cloudflare_access_key] and !params[:cloudflare_access_key].is_a?(String)
|
|
463
|
+
raise InvalidParameterError.new("Bad parameter: filebase_access_key must be an String") if params[:filebase_access_key] and !params[:filebase_access_key].is_a?(String)
|
|
464
|
+
raise InvalidParameterError.new("Bad parameter: google_cloud_storage_s3_compatible_access_key must be an String") if params[:google_cloud_storage_s3_compatible_access_key] and !params[:google_cloud_storage_s3_compatible_access_key].is_a?(String)
|
|
465
|
+
raise InvalidParameterError.new("Bad parameter: linode_access_key must be an String") if params[:linode_access_key] and !params[:linode_access_key].is_a?(String)
|
|
466
|
+
raise InvalidParameterError.new("Bad parameter: s3_compatible_access_key must be an String") if params[:s3_compatible_access_key] and !params[:s3_compatible_access_key].is_a?(String)
|
|
467
|
+
raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
|
|
468
|
+
raise InvalidParameterError.new("Bad parameter: wasabi_access_key must be an String") if params[:wasabi_access_key] and !params[:wasabi_access_key].is_a?(String)
|
|
469
|
+
raise InvalidParameterError.new("Bad parameter: password must be an String") if params[:password] and !params[:password].is_a?(String)
|
|
470
|
+
raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
|
|
471
|
+
raise InvalidParameterError.new("Bad parameter: private_key_passphrase must be an String") if params[:private_key_passphrase] and !params[:private_key_passphrase].is_a?(String)
|
|
472
|
+
raise InvalidParameterError.new("Bad parameter: aws_secret_key must be an String") if params[:aws_secret_key] and !params[:aws_secret_key].is_a?(String)
|
|
473
|
+
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_access_key must be an String") if params[:azure_blob_storage_access_key] and !params[:azure_blob_storage_access_key].is_a?(String)
|
|
474
|
+
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_sas_token must be an String") if params[:azure_blob_storage_sas_token] and !params[:azure_blob_storage_sas_token].is_a?(String)
|
|
475
|
+
raise InvalidParameterError.new("Bad parameter: azure_files_storage_access_key must be an String") if params[:azure_files_storage_access_key] and !params[:azure_files_storage_access_key].is_a?(String)
|
|
476
|
+
raise InvalidParameterError.new("Bad parameter: azure_files_storage_sas_token must be an String") if params[:azure_files_storage_sas_token] and !params[:azure_files_storage_sas_token].is_a?(String)
|
|
477
|
+
raise InvalidParameterError.new("Bad parameter: backblaze_b2_application_key must be an String") if params[:backblaze_b2_application_key] and !params[:backblaze_b2_application_key].is_a?(String)
|
|
478
|
+
raise InvalidParameterError.new("Bad parameter: backblaze_b2_key_id must be an String") if params[:backblaze_b2_key_id] and !params[:backblaze_b2_key_id].is_a?(String)
|
|
479
|
+
raise InvalidParameterError.new("Bad parameter: cloudflare_secret_key must be an String") if params[:cloudflare_secret_key] and !params[:cloudflare_secret_key].is_a?(String)
|
|
480
|
+
raise InvalidParameterError.new("Bad parameter: filebase_secret_key must be an String") if params[:filebase_secret_key] and !params[:filebase_secret_key].is_a?(String)
|
|
481
|
+
raise InvalidParameterError.new("Bad parameter: google_cloud_storage_credentials_json must be an String") if params[:google_cloud_storage_credentials_json] and !params[:google_cloud_storage_credentials_json].is_a?(String)
|
|
482
|
+
raise InvalidParameterError.new("Bad parameter: google_cloud_storage_s3_compatible_secret_key must be an String") if params[:google_cloud_storage_s3_compatible_secret_key] and !params[:google_cloud_storage_s3_compatible_secret_key].is_a?(String)
|
|
483
|
+
raise InvalidParameterError.new("Bad parameter: linode_secret_key must be an String") if params[:linode_secret_key] and !params[:linode_secret_key].is_a?(String)
|
|
484
|
+
raise InvalidParameterError.new("Bad parameter: s3_compatible_secret_key must be an String") if params[:s3_compatible_secret_key] and !params[:s3_compatible_secret_key].is_a?(String)
|
|
485
|
+
raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params[:wasabi_secret_key] and !params[:wasabi_secret_key].is_a?(String)
|
|
486
|
+
|
|
487
|
+
response, options = Api.send_request("/remote_server_credentials", :post, params, options)
|
|
488
|
+
RemoteServerCredential.new(response.data, options)
|
|
489
|
+
end
|
|
490
|
+
|
|
491
|
+
# Parameters:
|
|
492
|
+
# name - string - Internal name for your reference
|
|
493
|
+
# description - string - Internal description for your reference
|
|
494
|
+
# server_type - string - Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
495
|
+
# aws_access_key - string - AWS Access Key.
|
|
496
|
+
# azure_blob_storage_account - string - Azure Blob Storage: Account name
|
|
497
|
+
# azure_files_storage_account - string - Azure Files: Storage Account name
|
|
498
|
+
# cloudflare_access_key - string - Cloudflare: Access Key.
|
|
499
|
+
# filebase_access_key - string - Filebase: Access Key.
|
|
500
|
+
# google_cloud_storage_s3_compatible_access_key - string - Google Cloud Storage: S3-compatible Access Key.
|
|
501
|
+
# linode_access_key - string - Linode: Access Key
|
|
502
|
+
# s3_compatible_access_key - string - S3-compatible: Access Key
|
|
503
|
+
# username - string - Remote server username.
|
|
504
|
+
# wasabi_access_key - string - Wasabi: Access Key.
|
|
505
|
+
# password - string - Password, if needed.
|
|
506
|
+
# private_key - string - Private key, if needed.
|
|
507
|
+
# private_key_passphrase - string - Passphrase for private key if needed.
|
|
508
|
+
# aws_secret_key - string - AWS: secret key.
|
|
509
|
+
# azure_blob_storage_access_key - string - Azure Blob Storage: Access Key
|
|
510
|
+
# azure_blob_storage_sas_token - string - Azure Blob Storage: Shared Access Signature (SAS) token
|
|
511
|
+
# azure_files_storage_access_key - string - Azure File Storage: Access Key
|
|
512
|
+
# azure_files_storage_sas_token - string - Azure File Storage: Shared Access Signature (SAS) token
|
|
513
|
+
# backblaze_b2_application_key - string - Backblaze B2 Cloud Storage: applicationKey
|
|
514
|
+
# backblaze_b2_key_id - string - Backblaze B2 Cloud Storage: keyID
|
|
515
|
+
# cloudflare_secret_key - string - Cloudflare: Secret Key
|
|
516
|
+
# filebase_secret_key - string - Filebase: Secret Key
|
|
517
|
+
# google_cloud_storage_credentials_json - string - Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
|
|
518
|
+
# google_cloud_storage_s3_compatible_secret_key - string - Google Cloud Storage: S3-compatible secret key
|
|
519
|
+
# linode_secret_key - string - Linode: Secret Key
|
|
520
|
+
# s3_compatible_secret_key - string - S3-compatible: Secret Key
|
|
521
|
+
# wasabi_secret_key - string - Wasabi: Secret Key
|
|
522
|
+
def self.update(id, params = {}, options = {})
|
|
523
|
+
params ||= {}
|
|
524
|
+
params[:id] = id
|
|
525
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
526
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
527
|
+
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
528
|
+
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params[:server_type] and !params[:server_type].is_a?(String)
|
|
529
|
+
raise InvalidParameterError.new("Bad parameter: aws_access_key must be an String") if params[:aws_access_key] and !params[:aws_access_key].is_a?(String)
|
|
530
|
+
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params[:azure_blob_storage_account] and !params[:azure_blob_storage_account].is_a?(String)
|
|
531
|
+
raise InvalidParameterError.new("Bad parameter: azure_files_storage_account must be an String") if params[:azure_files_storage_account] and !params[:azure_files_storage_account].is_a?(String)
|
|
532
|
+
raise InvalidParameterError.new("Bad parameter: cloudflare_access_key must be an String") if params[:cloudflare_access_key] and !params[:cloudflare_access_key].is_a?(String)
|
|
533
|
+
raise InvalidParameterError.new("Bad parameter: filebase_access_key must be an String") if params[:filebase_access_key] and !params[:filebase_access_key].is_a?(String)
|
|
534
|
+
raise InvalidParameterError.new("Bad parameter: google_cloud_storage_s3_compatible_access_key must be an String") if params[:google_cloud_storage_s3_compatible_access_key] and !params[:google_cloud_storage_s3_compatible_access_key].is_a?(String)
|
|
535
|
+
raise InvalidParameterError.new("Bad parameter: linode_access_key must be an String") if params[:linode_access_key] and !params[:linode_access_key].is_a?(String)
|
|
536
|
+
raise InvalidParameterError.new("Bad parameter: s3_compatible_access_key must be an String") if params[:s3_compatible_access_key] and !params[:s3_compatible_access_key].is_a?(String)
|
|
537
|
+
raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
|
|
538
|
+
raise InvalidParameterError.new("Bad parameter: wasabi_access_key must be an String") if params[:wasabi_access_key] and !params[:wasabi_access_key].is_a?(String)
|
|
539
|
+
raise InvalidParameterError.new("Bad parameter: password must be an String") if params[:password] and !params[:password].is_a?(String)
|
|
540
|
+
raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
|
|
541
|
+
raise InvalidParameterError.new("Bad parameter: private_key_passphrase must be an String") if params[:private_key_passphrase] and !params[:private_key_passphrase].is_a?(String)
|
|
542
|
+
raise InvalidParameterError.new("Bad parameter: aws_secret_key must be an String") if params[:aws_secret_key] and !params[:aws_secret_key].is_a?(String)
|
|
543
|
+
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_access_key must be an String") if params[:azure_blob_storage_access_key] and !params[:azure_blob_storage_access_key].is_a?(String)
|
|
544
|
+
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_sas_token must be an String") if params[:azure_blob_storage_sas_token] and !params[:azure_blob_storage_sas_token].is_a?(String)
|
|
545
|
+
raise InvalidParameterError.new("Bad parameter: azure_files_storage_access_key must be an String") if params[:azure_files_storage_access_key] and !params[:azure_files_storage_access_key].is_a?(String)
|
|
546
|
+
raise InvalidParameterError.new("Bad parameter: azure_files_storage_sas_token must be an String") if params[:azure_files_storage_sas_token] and !params[:azure_files_storage_sas_token].is_a?(String)
|
|
547
|
+
raise InvalidParameterError.new("Bad parameter: backblaze_b2_application_key must be an String") if params[:backblaze_b2_application_key] and !params[:backblaze_b2_application_key].is_a?(String)
|
|
548
|
+
raise InvalidParameterError.new("Bad parameter: backblaze_b2_key_id must be an String") if params[:backblaze_b2_key_id] and !params[:backblaze_b2_key_id].is_a?(String)
|
|
549
|
+
raise InvalidParameterError.new("Bad parameter: cloudflare_secret_key must be an String") if params[:cloudflare_secret_key] and !params[:cloudflare_secret_key].is_a?(String)
|
|
550
|
+
raise InvalidParameterError.new("Bad parameter: filebase_secret_key must be an String") if params[:filebase_secret_key] and !params[:filebase_secret_key].is_a?(String)
|
|
551
|
+
raise InvalidParameterError.new("Bad parameter: google_cloud_storage_credentials_json must be an String") if params[:google_cloud_storage_credentials_json] and !params[:google_cloud_storage_credentials_json].is_a?(String)
|
|
552
|
+
raise InvalidParameterError.new("Bad parameter: google_cloud_storage_s3_compatible_secret_key must be an String") if params[:google_cloud_storage_s3_compatible_secret_key] and !params[:google_cloud_storage_s3_compatible_secret_key].is_a?(String)
|
|
553
|
+
raise InvalidParameterError.new("Bad parameter: linode_secret_key must be an String") if params[:linode_secret_key] and !params[:linode_secret_key].is_a?(String)
|
|
554
|
+
raise InvalidParameterError.new("Bad parameter: s3_compatible_secret_key must be an String") if params[:s3_compatible_secret_key] and !params[:s3_compatible_secret_key].is_a?(String)
|
|
555
|
+
raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params[:wasabi_secret_key] and !params[:wasabi_secret_key].is_a?(String)
|
|
556
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
557
|
+
|
|
558
|
+
response, options = Api.send_request("/remote_server_credentials/#{params[:id]}", :patch, params, options)
|
|
559
|
+
RemoteServerCredential.new(response.data, options)
|
|
560
|
+
end
|
|
561
|
+
|
|
562
|
+
def self.delete(id, params = {}, options = {})
|
|
563
|
+
params ||= {}
|
|
564
|
+
params[:id] = id
|
|
565
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
566
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
567
|
+
|
|
568
|
+
Api.send_request("/remote_server_credentials/#{params[:id]}", :delete, params, options)
|
|
569
|
+
nil
|
|
570
|
+
end
|
|
571
|
+
|
|
572
|
+
def self.destroy(id, params = {}, options = {})
|
|
573
|
+
delete(id, params, options)
|
|
574
|
+
nil
|
|
575
|
+
end
|
|
576
|
+
end
|
|
577
|
+
end
|
data/lib/files.com/version.rb
CHANGED
data/lib/files.com.rb
CHANGED
|
@@ -111,6 +111,7 @@ require "files.com/models/remote_bandwidth_snapshot"
|
|
|
111
111
|
require "files.com/models/remote_mount_backend"
|
|
112
112
|
require "files.com/models/remote_server"
|
|
113
113
|
require "files.com/models/remote_server_configuration_file"
|
|
114
|
+
require "files.com/models/remote_server_credential"
|
|
114
115
|
require "files.com/models/request"
|
|
115
116
|
require "files.com/models/restore"
|
|
116
117
|
require "files.com/models/scim_log"
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: files.com
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.1.
|
|
4
|
+
version: 1.1.417
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- files.com
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2025-12-
|
|
11
|
+
date: 2025-12-17 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: addressable
|
|
@@ -236,6 +236,7 @@ files:
|
|
|
236
236
|
- docs/remote_mount_backend.md
|
|
237
237
|
- docs/remote_server.md
|
|
238
238
|
- docs/remote_server_configuration_file.md
|
|
239
|
+
- docs/remote_server_credential.md
|
|
239
240
|
- docs/request.md
|
|
240
241
|
- docs/restore.md
|
|
241
242
|
- docs/scim_log.md
|
|
@@ -351,6 +352,7 @@ files:
|
|
|
351
352
|
- lib/files.com/models/remote_mount_backend.rb
|
|
352
353
|
- lib/files.com/models/remote_server.rb
|
|
353
354
|
- lib/files.com/models/remote_server_configuration_file.rb
|
|
355
|
+
- lib/files.com/models/remote_server_credential.rb
|
|
354
356
|
- lib/files.com/models/request.rb
|
|
355
357
|
- lib/files.com/models/restore.rb
|
|
356
358
|
- lib/files.com/models/scim_log.rb
|