files.com 1.1.336 → 1.1.338

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9c936c175deeddfd4894e53c06f6b2880f0660310a070c94a189ba61a798f0e0
4
- data.tar.gz: f78326fad01e92d2b6a0c9cc00470ec1071271d517d8e5c614122cd528af5d93
3
+ metadata.gz: 57058f8a29ddfe88333116f148478b441b4c55733c3f20c5f46db646a2eaf42b
4
+ data.tar.gz: 497bde049c52a4b13ebcc5a67c7d64108e05de0da223c794093b3e0401041cf6
5
5
  SHA512:
6
- metadata.gz: 3772512a57234236522aabb195c712cb07c2ac2fffeeb1435eb99eb55a26f227cc8cc9ee469e515cceb1c9a68c724b3781b32e24cca39c531d810b1b2cb80751
7
- data.tar.gz: 7117d3f81962120039bec8631244a9630e668430151d665418866787b67f107890a631010d4f6a43bc9f72fa0f988dddc0ee113e3a80f6b1c777e76960d42ea7
6
+ metadata.gz: ccb717fe0f9aa51854c1a3fcf2a65d3c868cd3a58dad9dd92a87b7e84bbda2493e07b30eb3b5c6cec18b2cc85df73b2a8b8c1af87a2a3735e841241034de7643
7
+ data.tar.gz: 0d863b2f644cc98faa842ecb87b306eb398b17857e90b2e88852639056ff11cdec5595334d88c4f9e8b07c302d42726bf395b3268ed2766ace571e5f722279bf
data/Gemfile.lock CHANGED
@@ -3,14 +3,14 @@ PATH
3
3
  specs:
4
4
  files.com (1.1.0)
5
5
  addressable (>= 2.8.0)
6
- base64 (~> 0.2.0)
6
+ base64 (~> 0.2)
7
7
  concurrent-ruby (>= 1.1.3)
8
8
  faraday (>= 1.0.1)
9
9
  faraday-multipart (>= 1.0)
10
10
  faraday-net_http_persistent (>= 2.0)
11
- logger (~> 1.6.0)
11
+ logger (~> 1.6)
12
12
  net-http-persistent (>= 4.0)
13
- ostruct (~> 0.6.0)
13
+ ostruct (~> 0.6)
14
14
 
15
15
  GEM
16
16
  remote: https://rubygems.org/
@@ -101,4 +101,4 @@ DEPENDENCIES
101
101
  rubocop
102
102
 
103
103
  BUNDLED WITH
104
- 2.5.1
104
+ 2.7.2
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.336
1
+ 1.1.338
data/docs/api_key.md CHANGED
@@ -10,6 +10,9 @@
10
10
  "created_at": "2000-01-01T01:00:00Z",
11
11
  "expires_at": "2000-01-01T01:00:00Z",
12
12
  "key": "[key]",
13
+ "aws_style_credentials": true,
14
+ "aws_access_key_id": "[aws_access_key_id]",
15
+ "aws_secret_key": "[aws_secret_key]",
13
16
  "last_use_at": "2000-01-01T01:00:00Z",
14
17
  "name": "My Main API Key",
15
18
  "permission_set": "full",
@@ -25,6 +28,9 @@
25
28
  * `created_at` (date-time): Time which API Key was created
26
29
  * `expires_at` (date-time): API Key expiration date
27
30
  * `key` (string): API Key actual key string
31
+ * `aws_style_credentials` (boolean): If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
32
+ * `aws_access_key_id` (string): AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
33
+ * `aws_secret_key` (string): AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
28
34
  * `last_use_at` (date-time): API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
29
35
  * `name` (string): Internal name for the API Key. For your use.
30
36
  * `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
@@ -90,6 +96,7 @@ Files::ApiKey.create(
90
96
  expires_at: "2000-01-01T01:00:00Z",
91
97
  permission_set: "full",
92
98
  name: "My Main API Key",
99
+ aws_style_credentials: true,
93
100
  path: "shared/docs"
94
101
  )
95
102
  ```
@@ -101,6 +108,7 @@ Files::ApiKey.create(
101
108
  * `expires_at` (string): API Key expiration date
102
109
  * `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
103
110
  * `name` (string): Required - Internal name for the API Key. For your use.
111
+ * `aws_style_credentials` (boolean): If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
104
112
  * `path` (string): Folder path restriction for `office_integration` permission set API keys.
105
113
 
106
114
 
@@ -38,7 +38,7 @@
38
38
  * `end_at` (date-time): End date/time of export range.
39
39
  * `status` (string): Status of export. Will be: `building`, `ready`, or `failed`
40
40
  * `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
41
- * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
41
+ * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
42
42
  * `query_user_id` (string): Return results that are actions performed by the user indicated by this User ID
43
43
  * `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
44
44
  * `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
@@ -110,7 +110,7 @@ Files::HistoryExport.create(
110
110
  * `start_at` (string): Start date/time of export range.
111
111
  * `end_at` (string): End date/time of export range.
112
112
  * `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
113
- * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
113
+ * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
114
114
  * `query_user_id` (string): Return results that are actions performed by the user indicated by this User ID
115
115
  * `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
116
116
  * `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
@@ -48,7 +48,7 @@
48
48
  * `user_is_from_parent_site` (boolean): true if this change was performed by a user on a parent site.
49
49
  * `action` (string): What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
50
50
  * `failure_type` (string): The type of login failure, if applicable. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`
51
- * `interface` (string): Interface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
51
+ * `interface` (string): Interface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
52
52
  * `target_id` (int64): ID of the object (such as Users, or API Keys) on which the action was taken
53
53
  * `target_name` (string): Name of the User, Group or other object with a name related to this action
54
54
  * `target_permission` (string): Permission level of the action
data/docs/site.md CHANGED
@@ -162,6 +162,7 @@
162
162
  "session": {
163
163
  "id": "60525f92e859c4c3d74cb02fd176b1525901b525",
164
164
  "language": "en",
165
+ "aws_secret_key": "example",
165
166
  "login_token": "@tok-randomcode",
166
167
  "login_token_domain": "https://mysite.files.com",
167
168
  "max_dir_listing_size": 1,
data/docs/user.md CHANGED
@@ -228,6 +228,7 @@ Files::User.create(
228
228
  company: "ACME Corp.",
229
229
  notes: "Internal notes on this user.",
230
230
  office_integration_enabled: true,
231
+ partner_admin: true,
231
232
  partner_id: 1,
232
233
  password_validity_days: 1,
233
234
  readonly_site_admin: true,
@@ -282,6 +283,7 @@ Files::User.create(
282
283
  * `company` (string): User's company
283
284
  * `notes` (string): Any internal notes on the user
284
285
  * `office_integration_enabled` (boolean): Enable integration with Office for the web?
286
+ * `partner_admin` (boolean): Is this user a Partner administrator?
285
287
  * `partner_id` (int64): Partner ID if this user belongs to a Partner
286
288
  * `password_validity_days` (int64): Number of days to allow user to use the same password
287
289
  * `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
@@ -371,6 +373,7 @@ Files::User.update(id,
371
373
  company: "ACME Corp.",
372
374
  notes: "Internal notes on this user.",
373
375
  office_integration_enabled: true,
376
+ partner_admin: true,
374
377
  partner_id: 1,
375
378
  password_validity_days: 1,
376
379
  readonly_site_admin: true,
@@ -427,6 +430,7 @@ Files::User.update(id,
427
430
  * `company` (string): User's company
428
431
  * `notes` (string): Any internal notes on the user
429
432
  * `office_integration_enabled` (boolean): Enable integration with Office for the web?
433
+ * `partner_admin` (boolean): Is this user a Partner administrator?
430
434
  * `partner_id` (int64): Partner ID if this user belongs to a Partner
431
435
  * `password_validity_days` (int64): Number of days to allow user to use the same password
432
436
  * `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
@@ -541,6 +545,7 @@ user.update(
541
545
  company: "ACME Corp.",
542
546
  notes: "Internal notes on this user.",
543
547
  office_integration_enabled: true,
548
+ partner_admin: true,
544
549
  partner_id: 1,
545
550
  password_validity_days: 1,
546
551
  readonly_site_admin: true,
@@ -597,6 +602,7 @@ user.update(
597
602
  * `company` (string): User's company
598
603
  * `notes` (string): Any internal notes on the user
599
604
  * `office_integration_enabled` (boolean): Enable integration with Office for the web?
605
+ * `partner_admin` (boolean): Is this user a Partner administrator?
600
606
  * `partner_id` (int64): Partner ID if this user belongs to a Partner
601
607
  * `password_validity_days` (int64): Number of days to allow user to use the same password
602
608
  * `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
data/files.com.gemspec CHANGED
@@ -12,14 +12,14 @@ Gem::Specification.new do |s|
12
12
  s.license = "MIT"
13
13
  s.required_ruby_version = ">= 2.7"
14
14
  s.add_dependency 'addressable', ">= 2.8.0"
15
- s.add_dependency 'base64', "~> 0.2.0"
15
+ s.add_dependency 'base64', "~> 0.2"
16
16
  s.add_dependency 'concurrent-ruby', ">= 1.1.3"
17
17
  s.add_dependency 'faraday', ">= 1.0.1"
18
18
  s.add_dependency 'faraday-multipart', ">= 1.0"
19
19
  s.add_dependency 'faraday-net_http_persistent', '>= 2.0'
20
- s.add_dependency 'logger', "~> 1.6.0"
20
+ s.add_dependency 'logger', "~> 1.6"
21
21
  s.add_dependency 'net-http-persistent', ">= 4.0"
22
- s.add_dependency 'ostruct', "~> 0.6.0"
22
+ s.add_dependency 'ostruct', "~> 0.6"
23
23
 
24
24
  s.files = `find *`.split("\n").uniq.sort.reject(&:empty?)
25
25
  s.executables = [ "files", "files-console" ]
@@ -59,6 +59,33 @@ module Files
59
59
  @attributes[:key] = value
60
60
  end
61
61
 
62
+ # boolean - If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
63
+ def aws_style_credentials
64
+ @attributes[:aws_style_credentials]
65
+ end
66
+
67
+ def aws_style_credentials=(value)
68
+ @attributes[:aws_style_credentials] = value
69
+ end
70
+
71
+ # string - AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
72
+ def aws_access_key_id
73
+ @attributes[:aws_access_key_id]
74
+ end
75
+
76
+ def aws_access_key_id=(value)
77
+ @attributes[:aws_access_key_id] = value
78
+ end
79
+
80
+ # string - AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
81
+ def aws_secret_key
82
+ @attributes[:aws_secret_key]
83
+ end
84
+
85
+ def aws_secret_key=(value)
86
+ @attributes[:aws_secret_key] = value
87
+ end
88
+
62
89
  # date-time - API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
63
90
  def last_use_at
64
91
  @attributes[:last_use_at]
@@ -224,6 +251,7 @@ module Files
224
251
  # expires_at - string - API Key expiration date
225
252
  # permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
226
253
  # name (required) - string - Internal name for the API Key. For your use.
254
+ # aws_style_credentials - boolean - If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
227
255
  # path - string - Folder path restriction for `office_integration` permission set API keys.
228
256
  def self.create(params = {}, options = {})
229
257
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
@@ -63,7 +63,7 @@ module Files
63
63
  @attributes[:query_action] = value
64
64
  end
65
65
 
66
- # string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
66
+ # string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
67
67
  def query_interface
68
68
  @attributes[:query_interface]
69
69
  end
@@ -275,7 +275,7 @@ module Files
275
275
  # start_at - string - Start date/time of export range.
276
276
  # end_at - string - End date/time of export range.
277
277
  # query_action - string - Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
278
- # query_interface - string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
278
+ # query_interface - string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
279
279
  # query_user_id - string - Return results that are actions performed by the user indicated by this User ID
280
280
  # query_file_id - string - Return results that are file actions related to the file indicated by this File ID
281
281
  # query_parent_id - string - Return results that are file actions inside the parent folder specified by this folder ID
@@ -84,7 +84,7 @@ module Files
84
84
  @attributes[:failure_type]
85
85
  end
86
86
 
87
- # string - Interface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
87
+ # string - Interface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
88
88
  def interface
89
89
  @attributes[:interface]
90
90
  end
@@ -789,6 +789,7 @@ module Files
789
789
  # company - string - User's company
790
790
  # notes - string - Any internal notes on the user
791
791
  # office_integration_enabled - boolean - Enable integration with Office for the web?
792
+ # partner_admin - boolean - Is this user a Partner administrator?
792
793
  # partner_id - int64 - Partner ID if this user belongs to a Partner
793
794
  # password_validity_days - int64 - Number of days to allow user to use the same password
794
795
  # readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
@@ -959,6 +960,7 @@ module Files
959
960
  # company - string - User's company
960
961
  # notes - string - Any internal notes on the user
961
962
  # office_integration_enabled - boolean - Enable integration with Office for the web?
963
+ # partner_admin - boolean - Is this user a Partner administrator?
962
964
  # partner_id - int64 - Partner ID if this user belongs to a Partner
963
965
  # password_validity_days - int64 - Number of days to allow user to use the same password
964
966
  # readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
@@ -1078,6 +1080,7 @@ module Files
1078
1080
  # company - string - User's company
1079
1081
  # notes - string - Any internal notes on the user
1080
1082
  # office_integration_enabled - boolean - Enable integration with Office for the web?
1083
+ # partner_admin - boolean - Is this user a Partner administrator?
1081
1084
  # partner_id - int64 - Partner ID if this user belongs to a Partner
1082
1085
  # password_validity_days - int64 - Number of days to allow user to use the same password
1083
1086
  # readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.336"
4
+ VERSION = "1.1.338"
5
5
  end
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.1.336
4
+ version: 1.1.338
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
@@ -30,14 +30,14 @@ dependencies:
30
30
  requirements:
31
31
  - - "~>"
32
32
  - !ruby/object:Gem::Version
33
- version: 0.2.0
33
+ version: '0.2'
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - "~>"
39
39
  - !ruby/object:Gem::Version
40
- version: 0.2.0
40
+ version: '0.2'
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: concurrent-ruby
43
43
  requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
100
100
  requirements:
101
101
  - - "~>"
102
102
  - !ruby/object:Gem::Version
103
- version: 1.6.0
103
+ version: '1.6'
104
104
  type: :runtime
105
105
  prerelease: false
106
106
  version_requirements: !ruby/object:Gem::Requirement
107
107
  requirements:
108
108
  - - "~>"
109
109
  - !ruby/object:Gem::Version
110
- version: 1.6.0
110
+ version: '1.6'
111
111
  - !ruby/object:Gem::Dependency
112
112
  name: net-http-persistent
113
113
  requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
128
128
  requirements:
129
129
  - - "~>"
130
130
  - !ruby/object:Gem::Version
131
- version: 0.6.0
131
+ version: '0.6'
132
132
  type: :runtime
133
133
  prerelease: false
134
134
  version_requirements: !ruby/object:Gem::Requirement
135
135
  requirements:
136
136
  - - "~>"
137
137
  - !ruby/object:Gem::Version
138
- version: 0.6.0
138
+ version: '0.6'
139
139
  description: The Files.com Ruby client.
140
140
  email:
141
141
  - support@files.com