files.com 1.0.49 → 1.0.50
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
- metadata +1 -61
- data/Gemfile.lock +0 -49
- data/docs/account.md +0 -87
- data/docs/announcement.md +0 -45
- data/docs/blog_post.md +0 -35
- data/docs/bundle_file.md +0 -17
- data/docs/bundle_public.md +0 -15
- data/docs/certificate.md +0 -250
- data/docs/crash_report.md +0 -46
- data/docs/email_feedback.md +0 -16
- data/docs/email_preference.md +0 -41
- data/docs/email_preference_notification.md +0 -17
- data/docs/inbox.md +0 -37
- data/docs/oauth_redirect.md +0 -11
- data/docs/paired_api_key.md +0 -17
- data/docs/paypal_express_info.md +0 -31
- data/docs/paypal_express_url.md +0 -11
- data/docs/plan.md +0 -145
- data/docs/plan_rate.md +0 -31
- data/docs/regional_migration.md +0 -39
- data/docs/release.md +0 -34
- data/docs/release_package.md +0 -13
- data/docs/setting.md +0 -33
- data/docs/settings.md +0 -187
- data/docs/support_request.md +0 -96
- data/docs/two_factor_authentication_method.md +0 -152
- data/docs/u2f_sign_request.md +0 -15
- data/docs/upload.md +0 -54
- data/docs/upsell.md +0 -33
- data/docs/warning.md +0 -31
- data/docs/zip_download.md +0 -27
- data/files.com-1.0.0.gem +0 -0
- data/lib/files.com/models/account.rb +0 -142
- data/lib/files.com/models/announcement.rb +0 -74
- data/lib/files.com/models/blog_post.rb +0 -49
- data/lib/files.com/models/bundle_file.rb +0 -32
- data/lib/files.com/models/bundle_public.rb +0 -27
- data/lib/files.com/models/certificate.rb +0 -452
- data/lib/files.com/models/crash_report.rb +0 -129
- data/lib/files.com/models/email_feedback.rb +0 -29
- data/lib/files.com/models/email_preference.rb +0 -46
- data/lib/files.com/models/email_preference_notification.rb +0 -32
- data/lib/files.com/models/inbox.rb +0 -54
- data/lib/files.com/models/oauth_redirect.rb +0 -17
- data/lib/files.com/models/paired_api_key.rb +0 -32
- data/lib/files.com/models/paypal_express_info.rb +0 -67
- data/lib/files.com/models/paypal_express_url.rb +0 -17
- data/lib/files.com/models/plan.rb +0 -316
- data/lib/files.com/models/plan_rate.rb +0 -39
- data/lib/files.com/models/regional_migration.rb +0 -59
- data/lib/files.com/models/release.rb +0 -41
- data/lib/files.com/models/release_package.rb +0 -22
- data/lib/files.com/models/setting.rb +0 -36
- data/lib/files.com/models/settings.rb +0 -441
- data/lib/files.com/models/support_request.rb +0 -143
- data/lib/files.com/models/two_factor_authentication_method.rb +0 -230
- data/lib/files.com/models/u2f_sign_request.rb +0 -27
- data/lib/files.com/models/upload.rb +0 -83
- data/lib/files.com/models/upsell.rb +0 -38
- data/lib/files.com/models/warning.rb +0 -34
- data/lib/files.com/models/zip_download.rb +0 -49
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3256cd93bd0c9c7a7e65addabbd6dd563cc8234f76f117a80cb201e12b5204b6
|
4
|
+
data.tar.gz: b5f0f0f40c8d36679fd72bb2a1a2219de6c2cf12b93ce2391e642c894ecd2eff
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 729e52511e0a4056ae9cd86893f52de163aebc4ababdf046b89498155966c0bc79121ab57eecaa103829f9a8395d808c8092d9fe32709d1ff432071e77bd8e76
|
7
|
+
data.tar.gz: 55d665d35dc0863f1e62c7f4ceb0dcd5a7d9c5b896230699067abad99e6ab72dd85b973891d75562602895ec72b0361c695778238a0302337c90f013bd01d909
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.50
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: files.com
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.50
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- files.com
|
@@ -63,32 +63,21 @@ extra_rdoc_files: []
|
|
63
63
|
files:
|
64
64
|
- CONTRIBUTORS
|
65
65
|
- Gemfile
|
66
|
-
- Gemfile.lock
|
67
66
|
- LICENSE
|
68
67
|
- README.md
|
69
68
|
- Rakefile
|
70
69
|
- _VERSION
|
71
70
|
- bin/files
|
72
71
|
- bin/files-console
|
73
|
-
- docs/account.md
|
74
72
|
- docs/account_line_item.md
|
75
73
|
- docs/action.md
|
76
|
-
- docs/announcement.md
|
77
74
|
- docs/api_key.md
|
78
75
|
- docs/as2_key.md
|
79
76
|
- docs/auto.md
|
80
77
|
- docs/automation.md
|
81
78
|
- docs/behavior.md
|
82
|
-
- docs/blog_post.md
|
83
79
|
- docs/bundle.md
|
84
|
-
- docs/bundle_file.md
|
85
|
-
- docs/bundle_public.md
|
86
|
-
- docs/certificate.md
|
87
|
-
- docs/crash_report.md
|
88
80
|
- docs/dns_record.md
|
89
|
-
- docs/email_feedback.md
|
90
|
-
- docs/email_preference.md
|
91
|
-
- docs/email_preference_notification.md
|
92
81
|
- docs/errors.md
|
93
82
|
- docs/file.md
|
94
83
|
- docs/file_action.md
|
@@ -102,7 +91,6 @@ files:
|
|
102
91
|
- docs/history.md
|
103
92
|
- docs/history_export.md
|
104
93
|
- docs/image.md
|
105
|
-
- docs/inbox.md
|
106
94
|
- docs/invoice.md
|
107
95
|
- docs/invoice_line_item.md
|
108
96
|
- docs/ip_address.md
|
@@ -112,68 +100,39 @@ files:
|
|
112
100
|
- docs/message_comment_reaction.md
|
113
101
|
- docs/message_reaction.md
|
114
102
|
- docs/notification.md
|
115
|
-
- docs/oauth_redirect.md
|
116
|
-
- docs/paired_api_key.md
|
117
103
|
- docs/payment.md
|
118
104
|
- docs/payment_line_item.md
|
119
|
-
- docs/paypal_express_info.md
|
120
|
-
- docs/paypal_express_url.md
|
121
105
|
- docs/permission.md
|
122
|
-
- docs/plan.md
|
123
|
-
- docs/plan_rate.md
|
124
106
|
- docs/preview.md
|
125
107
|
- docs/project.md
|
126
108
|
- docs/public_key.md
|
127
|
-
- docs/regional_migration.md
|
128
|
-
- docs/release.md
|
129
|
-
- docs/release_package.md
|
130
109
|
- docs/remote_server.md
|
131
110
|
- docs/request.md
|
132
111
|
- docs/session.md
|
133
|
-
- docs/setting.md
|
134
|
-
- docs/settings.md
|
135
112
|
- docs/site.md
|
136
113
|
- docs/sso_strategy.md
|
137
114
|
- docs/status.md
|
138
115
|
- docs/style.md
|
139
|
-
- docs/support_request.md
|
140
|
-
- docs/two_factor_authentication_method.md
|
141
|
-
- docs/u2f_sign_request.md
|
142
|
-
- docs/upload.md
|
143
|
-
- docs/upsell.md
|
144
116
|
- docs/usage_daily_snapshot.md
|
145
117
|
- docs/usage_snapshot.md
|
146
118
|
- docs/user.md
|
147
119
|
- docs/user_cipher_use.md
|
148
|
-
- docs/warning.md
|
149
|
-
- docs/zip_download.md
|
150
|
-
- files.com-1.0.0.gem
|
151
120
|
- files.com.gemspec
|
152
121
|
- lib/files.com.rb
|
153
122
|
- lib/files.com/api.rb
|
154
123
|
- lib/files.com/api_client.rb
|
155
124
|
- lib/files.com/errors.rb
|
156
125
|
- lib/files.com/list.rb
|
157
|
-
- lib/files.com/models/account.rb
|
158
126
|
- lib/files.com/models/account_line_item.rb
|
159
127
|
- lib/files.com/models/action.rb
|
160
|
-
- lib/files.com/models/announcement.rb
|
161
128
|
- lib/files.com/models/api_key.rb
|
162
129
|
- lib/files.com/models/as2_key.rb
|
163
130
|
- lib/files.com/models/auto.rb
|
164
131
|
- lib/files.com/models/automation.rb
|
165
132
|
- lib/files.com/models/behavior.rb
|
166
|
-
- lib/files.com/models/blog_post.rb
|
167
133
|
- lib/files.com/models/bundle.rb
|
168
|
-
- lib/files.com/models/bundle_file.rb
|
169
|
-
- lib/files.com/models/bundle_public.rb
|
170
|
-
- lib/files.com/models/certificate.rb
|
171
|
-
- lib/files.com/models/crash_report.rb
|
172
134
|
- lib/files.com/models/dir.rb
|
173
135
|
- lib/files.com/models/dns_record.rb
|
174
|
-
- lib/files.com/models/email_feedback.rb
|
175
|
-
- lib/files.com/models/email_preference.rb
|
176
|
-
- lib/files.com/models/email_preference_notification.rb
|
177
136
|
- lib/files.com/models/errors.rb
|
178
137
|
- lib/files.com/models/file.rb
|
179
138
|
- lib/files.com/models/file_action.rb
|
@@ -187,7 +146,6 @@ files:
|
|
187
146
|
- lib/files.com/models/history.rb
|
188
147
|
- lib/files.com/models/history_export.rb
|
189
148
|
- lib/files.com/models/image.rb
|
190
|
-
- lib/files.com/models/inbox.rb
|
191
149
|
- lib/files.com/models/invoice.rb
|
192
150
|
- lib/files.com/models/invoice_line_item.rb
|
193
151
|
- lib/files.com/models/ip_address.rb
|
@@ -197,41 +155,23 @@ files:
|
|
197
155
|
- lib/files.com/models/message_comment_reaction.rb
|
198
156
|
- lib/files.com/models/message_reaction.rb
|
199
157
|
- lib/files.com/models/notification.rb
|
200
|
-
- lib/files.com/models/oauth_redirect.rb
|
201
|
-
- lib/files.com/models/paired_api_key.rb
|
202
158
|
- lib/files.com/models/payment.rb
|
203
159
|
- lib/files.com/models/payment_line_item.rb
|
204
|
-
- lib/files.com/models/paypal_express_info.rb
|
205
|
-
- lib/files.com/models/paypal_express_url.rb
|
206
160
|
- lib/files.com/models/permission.rb
|
207
|
-
- lib/files.com/models/plan.rb
|
208
|
-
- lib/files.com/models/plan_rate.rb
|
209
161
|
- lib/files.com/models/preview.rb
|
210
162
|
- lib/files.com/models/project.rb
|
211
163
|
- lib/files.com/models/public_key.rb
|
212
|
-
- lib/files.com/models/regional_migration.rb
|
213
|
-
- lib/files.com/models/release.rb
|
214
|
-
- lib/files.com/models/release_package.rb
|
215
164
|
- lib/files.com/models/remote_server.rb
|
216
165
|
- lib/files.com/models/request.rb
|
217
166
|
- lib/files.com/models/session.rb
|
218
|
-
- lib/files.com/models/setting.rb
|
219
|
-
- lib/files.com/models/settings.rb
|
220
167
|
- lib/files.com/models/site.rb
|
221
168
|
- lib/files.com/models/sso_strategy.rb
|
222
169
|
- lib/files.com/models/status.rb
|
223
170
|
- lib/files.com/models/style.rb
|
224
|
-
- lib/files.com/models/support_request.rb
|
225
|
-
- lib/files.com/models/two_factor_authentication_method.rb
|
226
|
-
- lib/files.com/models/u2f_sign_request.rb
|
227
|
-
- lib/files.com/models/upload.rb
|
228
|
-
- lib/files.com/models/upsell.rb
|
229
171
|
- lib/files.com/models/usage_daily_snapshot.rb
|
230
172
|
- lib/files.com/models/usage_snapshot.rb
|
231
173
|
- lib/files.com/models/user.rb
|
232
174
|
- lib/files.com/models/user_cipher_use.rb
|
233
|
-
- lib/files.com/models/warning.rb
|
234
|
-
- lib/files.com/models/zip_download.rb
|
235
175
|
- lib/files.com/response.rb
|
236
176
|
- lib/files.com/system_profiler.rb
|
237
177
|
- lib/files.com/util.rb
|
data/Gemfile.lock
DELETED
@@ -1,49 +0,0 @@
|
|
1
|
-
PATH
|
2
|
-
remote: .
|
3
|
-
specs:
|
4
|
-
files.com (1.0.0)
|
5
|
-
faraday
|
6
|
-
|
7
|
-
GEM
|
8
|
-
remote: https://rubygems.org/
|
9
|
-
specs:
|
10
|
-
byebug (11.0.1)
|
11
|
-
coderay (1.1.2)
|
12
|
-
diff-lcs (1.3)
|
13
|
-
faraday (1.0.0)
|
14
|
-
multipart-post (>= 1.2, < 3)
|
15
|
-
method_source (0.9.2)
|
16
|
-
multipart-post (2.1.1)
|
17
|
-
pry (0.12.2)
|
18
|
-
coderay (~> 1.1.0)
|
19
|
-
method_source (~> 0.9.0)
|
20
|
-
pry-byebug (3.7.0)
|
21
|
-
byebug (~> 11.0)
|
22
|
-
pry (~> 0.10)
|
23
|
-
rake (12.0.0)
|
24
|
-
rspec (3.9.0)
|
25
|
-
rspec-core (~> 3.9.0)
|
26
|
-
rspec-expectations (~> 3.9.0)
|
27
|
-
rspec-mocks (~> 3.9.0)
|
28
|
-
rspec-core (3.9.1)
|
29
|
-
rspec-support (~> 3.9.1)
|
30
|
-
rspec-expectations (3.9.0)
|
31
|
-
diff-lcs (>= 1.2.0, < 2.0)
|
32
|
-
rspec-support (~> 3.9.0)
|
33
|
-
rspec-mocks (3.9.1)
|
34
|
-
diff-lcs (>= 1.2.0, < 2.0)
|
35
|
-
rspec-support (~> 3.9.0)
|
36
|
-
rspec-support (3.9.2)
|
37
|
-
|
38
|
-
PLATFORMS
|
39
|
-
ruby
|
40
|
-
|
41
|
-
DEPENDENCIES
|
42
|
-
files.com!
|
43
|
-
pry
|
44
|
-
pry-byebug
|
45
|
-
rake (~> 12.0.0)
|
46
|
-
rspec
|
47
|
-
|
48
|
-
BUNDLED WITH
|
49
|
-
2.0.2
|
data/docs/account.md
DELETED
@@ -1,87 +0,0 @@
|
|
1
|
-
# Account
|
2
|
-
|
3
|
-
## Example Account Object
|
4
|
-
|
5
|
-
```
|
6
|
-
{
|
7
|
-
"name": "account",
|
8
|
-
"address": "123 Main St",
|
9
|
-
"address_2": "Window 1",
|
10
|
-
"card_number": "xxxxxxxxxxxx1234",
|
11
|
-
"card_type": "Visa",
|
12
|
-
"city": "New York",
|
13
|
-
"company_name": "Action Verb",
|
14
|
-
"country": "US",
|
15
|
-
"created_at": "2000-01-01 01:00:00 UTC",
|
16
|
-
"currency": "USD",
|
17
|
-
"email": "john.doe@files.com",
|
18
|
-
"phone_number": "555-555-5555",
|
19
|
-
"processor_type": "Credit Card",
|
20
|
-
"state": "NY",
|
21
|
-
"updated_at": "2000-01-01 01:00:00 UTC",
|
22
|
-
"zip": "00000",
|
23
|
-
"billing_frequency": 1
|
24
|
-
}
|
25
|
-
```
|
26
|
-
|
27
|
-
* `name` (string): Account name
|
28
|
-
* `address` (string): Account address
|
29
|
-
* `address_2` (string): Account address 2
|
30
|
-
* `card_number` (string): Account payment card number
|
31
|
-
* `card_type` (string): Account payment card type
|
32
|
-
* `city` (string): Account city
|
33
|
-
* `company_name` (string): Account company name
|
34
|
-
* `country` (string): Account country
|
35
|
-
* `created_at` (date-time): Account creation date/time
|
36
|
-
* `currency` (string): Account preferred currency
|
37
|
-
* `email` (email): Account email address
|
38
|
-
* `phone_number` (string): Account phone number
|
39
|
-
* `processor_type` (string): Type of billing processor. Can be PayPal, Credit Card, or Manual
|
40
|
-
* `state` (string): Account state
|
41
|
-
* `updated_at` (date-time): Account last updated at
|
42
|
-
* `zip` (string): Account zipcode
|
43
|
-
* `billing_frequency` (int64): Account billing frequency. Either 12(yearly) or 1(monthly)
|
44
|
-
|
45
|
-
|
46
|
-
---
|
47
|
-
|
48
|
-
## Internal hidden endpoint. Subject to change. Not for public consumption
|
49
|
-
|
50
|
-
```
|
51
|
-
Files::Account.update(
|
52
|
-
name: "account",
|
53
|
-
company_name: "Action Verb",
|
54
|
-
address: "123 Main St",
|
55
|
-
address_2: "Window 1",
|
56
|
-
city: "New York",
|
57
|
-
state: "NY",
|
58
|
-
zip: "00000",
|
59
|
-
country: "US",
|
60
|
-
email: "john.doe@files.com",
|
61
|
-
phone_number: "555-555-5555",
|
62
|
-
card_number: "xxxxxxxxxxxx1234",
|
63
|
-
card_type: "Visa"
|
64
|
-
)
|
65
|
-
```
|
66
|
-
|
67
|
-
### Parameters
|
68
|
-
|
69
|
-
* `name` (string): Internal name.
|
70
|
-
* `company_name` (string): Company name.
|
71
|
-
* `address` (string): Address line 1.
|
72
|
-
* `address_2` (string): Address line 2.
|
73
|
-
* `city` (string): City.
|
74
|
-
* `state` (string): State.
|
75
|
-
* `zip` (string): Zipcode.
|
76
|
-
* `country` (string): Country.
|
77
|
-
* `email` (string): Email.
|
78
|
-
* `phone_number` (string): Primary phone number.
|
79
|
-
* `card_number` (string): Credit card number.
|
80
|
-
* `card_type` (string): Credit card type. Can be visa, master, maestro, solo, switch, american_express, or discover.
|
81
|
-
* `expiration_year` (string): Expiration year(4 digits).
|
82
|
-
* `expiration_month` (string): Expiration month(2 digits).
|
83
|
-
* `start_year` (string): Required for some cards(Switch / Solo).
|
84
|
-
* `start_month` (string): Required for some cards(Switch / Solo).
|
85
|
-
* `cvv` (string): 3 digit code on the back of the card.
|
86
|
-
* `paypal_token` (string): Token for paying with paypal.
|
87
|
-
* `paypal_payer_id` (string): Paypal payer ID for paying with paypal.
|
data/docs/announcement.md
DELETED
@@ -1,45 +0,0 @@
|
|
1
|
-
# Announcement
|
2
|
-
|
3
|
-
## Example Announcement Object
|
4
|
-
|
5
|
-
```
|
6
|
-
{
|
7
|
-
"body": "This is the body.",
|
8
|
-
"button_text": "View Blog Post",
|
9
|
-
"button_url": "https://www.files.com/blog/",
|
10
|
-
"headline": "Files.com Now Supports In-App Announcements!",
|
11
|
-
"html_body": "<p>This is the HTML version of the body.</p>",
|
12
|
-
"label": "New Feature",
|
13
|
-
"label_color": "#000000",
|
14
|
-
"publish_at": "2000-01-01 01:00:00 UTC",
|
15
|
-
"slug": "new-feature"
|
16
|
-
}
|
17
|
-
```
|
18
|
-
|
19
|
-
* `body` (string): Announcement body
|
20
|
-
* `button_text` (string): Text to go on the CTA button
|
21
|
-
* `button_url` (string): URL to link to when CTA button is clicked
|
22
|
-
* `headline` (string): Announcement headline
|
23
|
-
* `html_body` (string): Body converted to HTML
|
24
|
-
* `label` (string): Text for a label that can be added to the announcement
|
25
|
-
* `label_color` (string): Color for label on announcement
|
26
|
-
* `publish_at` (date-time): When was this announcement published?
|
27
|
-
* `slug` (string): URL slug for announcement
|
28
|
-
|
29
|
-
|
30
|
-
---
|
31
|
-
|
32
|
-
## List in-app announcements that are shown in the header of the UI
|
33
|
-
|
34
|
-
```
|
35
|
-
Files::Announcement.list(
|
36
|
-
page: 1,
|
37
|
-
per_page: 1
|
38
|
-
)
|
39
|
-
```
|
40
|
-
|
41
|
-
### Parameters
|
42
|
-
|
43
|
-
* `page` (int64): Current page number.
|
44
|
-
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
45
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
data/docs/blog_post.md
DELETED
@@ -1,35 +0,0 @@
|
|
1
|
-
# BlogPost
|
2
|
-
|
3
|
-
## Example BlogPost Object
|
4
|
-
|
5
|
-
```
|
6
|
-
{
|
7
|
-
"content": "",
|
8
|
-
"link": "2000-01-01 01:00:00 UTC",
|
9
|
-
"published_at": "2000-01-01 01:00:00 UTC",
|
10
|
-
"title": ""
|
11
|
-
}
|
12
|
-
```
|
13
|
-
|
14
|
-
* `content` (string): Blog Post's Content
|
15
|
-
* `link` (date-time): Blog Post's Permanent Link
|
16
|
-
* `published_at` (date-time): Blog Post's Published Date
|
17
|
-
* `title` (string): Blog Post's Title
|
18
|
-
|
19
|
-
|
20
|
-
---
|
21
|
-
|
22
|
-
## Show the most recent blog posts from the Files.com blog
|
23
|
-
|
24
|
-
```
|
25
|
-
Files::BlogPost.list(
|
26
|
-
page: 1,
|
27
|
-
per_page: 1
|
28
|
-
)
|
29
|
-
```
|
30
|
-
|
31
|
-
### Parameters
|
32
|
-
|
33
|
-
* `page` (int64): Current page number.
|
34
|
-
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
35
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
data/docs/bundle_file.md
DELETED
@@ -1,17 +0,0 @@
|
|
1
|
-
# BundleFile
|
2
|
-
|
3
|
-
## Example BundleFile Object
|
4
|
-
|
5
|
-
```
|
6
|
-
{
|
7
|
-
"download_uri": "",
|
8
|
-
"path": "file.txt",
|
9
|
-
"size": 1,
|
10
|
-
"type": "file"
|
11
|
-
}
|
12
|
-
```
|
13
|
-
|
14
|
-
* `download_uri` (string): Bundle file download URI
|
15
|
-
* `path` (string): File path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
16
|
-
* `size` (int64): File size
|
17
|
-
* `type` (string): Type of 'directory' or 'file'
|
data/docs/bundle_public.md
DELETED
@@ -1,15 +0,0 @@
|
|
1
|
-
# BundlePublic
|
2
|
-
|
3
|
-
## Example BundlePublic Object
|
4
|
-
|
5
|
-
```
|
6
|
-
{
|
7
|
-
"code": "CODE",
|
8
|
-
"url": "https://subdomain.files.com/f/12345678",
|
9
|
-
"description": "The public description of the bundle."
|
10
|
-
}
|
11
|
-
```
|
12
|
-
|
13
|
-
* `code` (string): Bundle code
|
14
|
-
* `url` (string): Bundle url
|
15
|
-
* `description` (string): Bundle description
|
data/docs/certificate.md
DELETED
@@ -1,250 +0,0 @@
|
|
1
|
-
# Certificate
|
2
|
-
|
3
|
-
## Example Certificate Object
|
4
|
-
|
5
|
-
```
|
6
|
-
{
|
7
|
-
"id": 1,
|
8
|
-
"certificate": "[certificate]",
|
9
|
-
"created_at": "2000-01-01 01:00:00 UTC",
|
10
|
-
"display_status": "Available",
|
11
|
-
"domains": [
|
12
|
-
|
13
|
-
],
|
14
|
-
"expires_at": "2000-01-01 01:00:00 UTC",
|
15
|
-
"brick_managed": true,
|
16
|
-
"intermediates": "[certificates]",
|
17
|
-
"ip_addresses": [
|
18
|
-
|
19
|
-
],
|
20
|
-
"issuer": "",
|
21
|
-
"name": "My Certificate",
|
22
|
-
"key_type": "RSA-4096",
|
23
|
-
"request": "[CSR]",
|
24
|
-
"status": "Available",
|
25
|
-
"subject": "my-custom-domain.com",
|
26
|
-
"updated_at": "2000-01-01 01:00:00 UTC"
|
27
|
-
}
|
28
|
-
```
|
29
|
-
|
30
|
-
* `id` (int64): Certificate ID
|
31
|
-
* `certificate` (string): Full text of SSL certificate
|
32
|
-
* `created_at` (date-time): Certificate created at
|
33
|
-
* `display_status` (string): Certificate status. (One of `Request Generated`, `New`, `Active`, `Active/Expired`, `Expired`, or `Available`)
|
34
|
-
* `domains` (array): Domains on this certificate other than files.com domains
|
35
|
-
* `expires_at` (date-time): Certificate expiration date/time
|
36
|
-
* `brick_managed` (boolean): Is this certificate automatically managed and renewed by Files.com?
|
37
|
-
* `intermediates` (string): Intermediate certificates
|
38
|
-
* `ip_addresses` (array): A list of IP addresses associated with this SSL Certificate
|
39
|
-
* `issuer` (string): X509 issuer
|
40
|
-
* `name` (string): Descriptive name of certificate
|
41
|
-
* `key_type` (string): Type of key
|
42
|
-
* `request` (string): Certificate signing request text
|
43
|
-
* `status` (string): Certificate status (Request Generated, New, Active, Active/Expired, Expired, or Available)
|
44
|
-
* `subject` (string): X509 Subject name
|
45
|
-
* `updated_at` (date-time): Certificated last updated at
|
46
|
-
* `certificate_domain` (string): Domain for certificate.
|
47
|
-
* `certificate_country` (string): Country.
|
48
|
-
* `certificate_state_or_province` (string): State or province.
|
49
|
-
* `certificate_city_or_locale` (string): City or locale.
|
50
|
-
* `certificate_company_name` (string): Company name.
|
51
|
-
* `csr_ou1` (string): Department name or organization unit 1
|
52
|
-
* `csr_ou2` (string): Department name or organization unit 2
|
53
|
-
* `csr_ou3` (string): Department name or organization unit 3
|
54
|
-
* `certificate_email_address` (string): Email address for the certificate owner.
|
55
|
-
* `key_type_confirm_given` (string): Confirms the key type.
|
56
|
-
* `private_key` (string): Certificate private key.
|
57
|
-
* `password` (string): Certificate password.
|
58
|
-
|
59
|
-
|
60
|
-
---
|
61
|
-
|
62
|
-
## List Certificates
|
63
|
-
|
64
|
-
```
|
65
|
-
Files::Certificate.list(
|
66
|
-
page: 1,
|
67
|
-
per_page: 1
|
68
|
-
)
|
69
|
-
```
|
70
|
-
|
71
|
-
### Parameters
|
72
|
-
|
73
|
-
* `page` (int64): Current page number.
|
74
|
-
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
75
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
76
|
-
|
77
|
-
|
78
|
-
---
|
79
|
-
|
80
|
-
## Show Certificate
|
81
|
-
|
82
|
-
```
|
83
|
-
Files::Certificate.find(id)
|
84
|
-
```
|
85
|
-
|
86
|
-
### Parameters
|
87
|
-
|
88
|
-
* `id` (int64): Required - Certificate ID.
|
89
|
-
|
90
|
-
|
91
|
-
---
|
92
|
-
|
93
|
-
## Create CSR or import existing SSL Certificate
|
94
|
-
|
95
|
-
```
|
96
|
-
Files::Certificate.create(
|
97
|
-
name: "Name",
|
98
|
-
certificate_domain: "domain.com",
|
99
|
-
key_type: "RSA-4096",
|
100
|
-
certificate: "[certificate]",
|
101
|
-
intermediates: "[certificates]"
|
102
|
-
)
|
103
|
-
```
|
104
|
-
|
105
|
-
### Parameters
|
106
|
-
|
107
|
-
* `name` (string): Required - Internal name of the SSL certificate.
|
108
|
-
* `certificate_domain` (string): Domain for certificate.
|
109
|
-
* `certificate_country` (string): Country.
|
110
|
-
* `certificate_state_or_province` (string): State or province.
|
111
|
-
* `certificate_city_or_locale` (string): City or locale.
|
112
|
-
* `certificate_company_name` (string): Company name.
|
113
|
-
* `csr_ou1` (string): Department name or organization unit 1
|
114
|
-
* `csr_ou2` (string): Department name or organization unit 2
|
115
|
-
* `csr_ou3` (string): Department name or organization unit 3
|
116
|
-
* `certificate_email_address` (string): Email address for the certificate owner.
|
117
|
-
* `key_type` (string): Any supported key type. Defaults to `RSA-4096`.
|
118
|
-
* `key_type_confirm_given` (string): Confirms the key type.
|
119
|
-
* `certificate` (string): The certificate. PEM or PKCS7 formats accepted.
|
120
|
-
* `private_key` (string): Certificate private key.
|
121
|
-
* `password` (string): Certificate password.
|
122
|
-
* `intermediates` (string): Intermediate certificates. PEM or PKCS7 formats accepted.
|
123
|
-
|
124
|
-
|
125
|
-
---
|
126
|
-
|
127
|
-
## Deactivate SSL Certificate
|
128
|
-
|
129
|
-
```
|
130
|
-
Files::Certificate.deactivate(id)
|
131
|
-
```
|
132
|
-
|
133
|
-
### Parameters
|
134
|
-
|
135
|
-
* `id` (int64): Required - Certificate ID.
|
136
|
-
|
137
|
-
|
138
|
-
---
|
139
|
-
|
140
|
-
## Activate SSL Certificate
|
141
|
-
|
142
|
-
```
|
143
|
-
Files::Certificate.activate(id,
|
144
|
-
replace_cert: ""
|
145
|
-
)
|
146
|
-
```
|
147
|
-
|
148
|
-
### Parameters
|
149
|
-
|
150
|
-
* `id` (int64): Required - Certificate ID.
|
151
|
-
* `replace_cert` (string): Leave blank, set to `any` or `new_ips`.
|
152
|
-
|
153
|
-
|
154
|
-
---
|
155
|
-
|
156
|
-
## Update Certificate
|
157
|
-
|
158
|
-
```
|
159
|
-
Files::Certificate.update(id,
|
160
|
-
name: "My Certificate",
|
161
|
-
intermediates: "[certificates]",
|
162
|
-
certificate: "[certificate]"
|
163
|
-
)
|
164
|
-
```
|
165
|
-
|
166
|
-
### Parameters
|
167
|
-
|
168
|
-
* `id` (int64): Required - Certificate ID.
|
169
|
-
* `name` (string): Internal certificate name.
|
170
|
-
* `intermediates` (string): Any intermediate certificates. PEM or PKCS7 formats accepted.
|
171
|
-
* `certificate` (string): The certificate. PEM or PKCS7 formats accepted.
|
172
|
-
|
173
|
-
|
174
|
-
---
|
175
|
-
|
176
|
-
## Delete Certificate
|
177
|
-
|
178
|
-
```
|
179
|
-
Files::Certificate.delete(id)
|
180
|
-
```
|
181
|
-
|
182
|
-
### Parameters
|
183
|
-
|
184
|
-
* `id` (int64): Required - Certificate ID.
|
185
|
-
|
186
|
-
|
187
|
-
---
|
188
|
-
|
189
|
-
## Deactivate SSL Certificate
|
190
|
-
|
191
|
-
```
|
192
|
-
certificate = Files::Certificate.find(1)
|
193
|
-
certificate.deactivate
|
194
|
-
```
|
195
|
-
|
196
|
-
### Parameters
|
197
|
-
|
198
|
-
* `id` (int64): Required - Certificate ID.
|
199
|
-
|
200
|
-
|
201
|
-
---
|
202
|
-
|
203
|
-
## Activate SSL Certificate
|
204
|
-
|
205
|
-
```
|
206
|
-
certificate = Files::Certificate.find(1)
|
207
|
-
certificate.activate(
|
208
|
-
replace_cert: ""
|
209
|
-
)
|
210
|
-
```
|
211
|
-
|
212
|
-
### Parameters
|
213
|
-
|
214
|
-
* `id` (int64): Required - Certificate ID.
|
215
|
-
* `replace_cert` (string): Leave blank, set to `any` or `new_ips`.
|
216
|
-
|
217
|
-
|
218
|
-
---
|
219
|
-
|
220
|
-
## Update Certificate
|
221
|
-
|
222
|
-
```
|
223
|
-
certificate = Files::Certificate.find(1)
|
224
|
-
certificate.update(
|
225
|
-
name: "My Certificate",
|
226
|
-
intermediates: "[certificates]",
|
227
|
-
certificate: "[certificate]"
|
228
|
-
)
|
229
|
-
```
|
230
|
-
|
231
|
-
### Parameters
|
232
|
-
|
233
|
-
* `id` (int64): Required - Certificate ID.
|
234
|
-
* `name` (string): Internal certificate name.
|
235
|
-
* `intermediates` (string): Any intermediate certificates. PEM or PKCS7 formats accepted.
|
236
|
-
* `certificate` (string): The certificate. PEM or PKCS7 formats accepted.
|
237
|
-
|
238
|
-
|
239
|
-
---
|
240
|
-
|
241
|
-
## Delete Certificate
|
242
|
-
|
243
|
-
```
|
244
|
-
certificate = Files::Certificate.find(1)
|
245
|
-
certificate.delete
|
246
|
-
```
|
247
|
-
|
248
|
-
### Parameters
|
249
|
-
|
250
|
-
* `id` (int64): Required - Certificate ID.
|