files.com 1.0.180 → 1.0.184

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: 63d792817bc5dda505fbbb43345568f676002d923ceacdcd57077c92807740fb
4
- data.tar.gz: 96e5ab20cef1cd119fc00bcb067fdca15cf1998920d0c8e48934eb2fbaa1d883
3
+ metadata.gz: d93d686016bd4a533ab76dd1ae95415e6e3c0afcec4b65d651b698a01d4f0c9b
4
+ data.tar.gz: 97ce617042e8a47f4b75bff5e4209462b3c85af5ee0f44e970c1379c1a63ccc9
5
5
  SHA512:
6
- metadata.gz: 2d861ef902119b67bd307d797f911ce605f9e5f5b0374b9e4436c2ae5e8c898a43a4589f9a869d57ce0ef0b8c8ad24dd196a80b7da4a6557965697d9f8a71579
7
- data.tar.gz: 4876b0348fbc069e36d4f9004cf33e004ffc1986a9b8779d2d0b4128961a6c82426d45d7a7e5a1da07492f5b1bebaf7e24aeb81fd6aa1443ea688b0b0674e669
6
+ metadata.gz: 4090101741ab308d32900b57ced9e50f30a8e9af68ff36c1de63ee5663f3166da8bbea51a48156853152908172cee76fcd8279be57e61ecd92376826ee3aefc4
7
+ data.tar.gz: 89623ab716d856ba2e2bc5655716a454fc3b9ee39cd465662825e7f6575702ff8c49aaf6bc22c8e3c771727f99353c2412978a671ce129462aa8e486442ebaf7
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.180
1
+ 1.0.184
@@ -0,0 +1,28 @@
1
+
2
+
3
+ ---
4
+
5
+ ## retry Action Webhook Failure
6
+
7
+ ```
8
+ Files::ActionWebhookFailure.retry(id)
9
+ ```
10
+
11
+ ### Parameters
12
+
13
+ * `id` (int64): Required - Action Webhook Failure ID.
14
+
15
+
16
+ ---
17
+
18
+ ## retry Action Webhook Failure
19
+
20
+ ```
21
+ action_webhook_failure = Files::ActionWebhookFailure.list_for(path).first
22
+
23
+ action_webhook_failure.retry
24
+ ```
25
+
26
+ ### Parameters
27
+
28
+ * `id` (int64): Required - Action Webhook Failure ID.
data/docs/app.md CHANGED
@@ -6,6 +6,7 @@
6
6
  {
7
7
  "name": "",
8
8
  "extended_description": "",
9
+ "short_description": "",
9
10
  "documentation_links": "Important Info => http://files.test/learn-more",
10
11
  "icon_url": "",
11
12
  "logo_url": "",
@@ -26,6 +27,7 @@
26
27
 
27
28
  * `name` (string): Name of the App
28
29
  * `extended_description` (string): Long form description of the App
30
+ * `short_description` (string): Short description of the App
29
31
  * `documentation_links` (string): Collection of named links to documentation
30
32
  * `icon_url` (string): App icon
31
33
  * `logo_url` (string): Full size logo for the App
@@ -9,7 +9,12 @@
9
9
  "status": "",
10
10
  "body": "",
11
11
  "created_at": "2000-01-01T01:00:00Z",
12
- "body_url": ""
12
+ "body_url": "",
13
+ "folder_behavior_id": 1,
14
+ "successful_files": 1,
15
+ "errored_files": 1,
16
+ "bytes_synced": 1,
17
+ "remote_server_type": ""
13
18
  }
14
19
  ```
15
20
 
@@ -19,6 +24,11 @@
19
24
  * `body` (string): Event body
20
25
  * `created_at` (date-time): External event create date/time
21
26
  * `body_url` (string): Link to log file.
27
+ * `folder_behavior_id` (int64): Folder Behavior ID
28
+ * `successful_files` (int64): For sync events, the number of files handled successfully.
29
+ * `errored_files` (int64): For sync events, the number of files that encountered errors.
30
+ * `bytes_synced` (int64): For sync events, the total number of bytes synced.
31
+ * `remote_server_type` (string): Associated Remote Server type, if any
22
32
 
23
33
 
24
34
  ---
@@ -35,13 +45,13 @@ Files::ExternalEvent.list(
35
45
 
36
46
  * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
37
47
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
38
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `remote_server_type`, `event_type`, `created_at` or `status`.
39
- * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
40
- * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
41
- * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
42
- * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
43
- * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
44
- * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
48
+ * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `remote_server_type`, `event_type`, `created_at`, `status`, `site_id` or `folder_behavior_id`.
49
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
50
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
51
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
52
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
53
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
54
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
45
55
 
46
56
 
47
57
  ---
@@ -0,0 +1,38 @@
1
+ # FileMigration
2
+
3
+ ## Example FileMigration Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "path": "MyFolder",
9
+ "dest_path": "MyFolder",
10
+ "files_moved": 1,
11
+ "files_total": 1,
12
+ "operation": "move",
13
+ "region": "USA",
14
+ "status": "complete"
15
+ }
16
+ ```
17
+
18
+ * `id` (int64): File migration ID
19
+ * `path` (string): Source path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
20
+ * `dest_path` (string): Destination path
21
+ * `files_moved` (int64): Number of files processed
22
+ * `files_total` (int64): Total number of files to process
23
+ * `operation` (string): The type of operation
24
+ * `region` (string): Region
25
+ * `status` (string): Status
26
+
27
+
28
+ ---
29
+
30
+ ## Show File Migration
31
+
32
+ ```
33
+ Files::FileMigration.find(id)
34
+ ```
35
+
36
+ ### Parameters
37
+
38
+ * `id` (int64): Required - File Migration ID.
data/lib/files.com.rb CHANGED
@@ -31,6 +31,7 @@ require "files.com/models/account_line_item"
31
31
  require "files.com/models/action"
32
32
  require "files.com/models/action_notification_export"
33
33
  require "files.com/models/action_notification_export_result"
34
+ require "files.com/models/action_webhook_failure"
34
35
  require "files.com/models/api_key"
35
36
  require "files.com/models/app"
36
37
  require "files.com/models/as2_key"
@@ -50,6 +51,7 @@ require "files.com/models/file"
50
51
  require "files.com/models/file_action"
51
52
  require "files.com/models/file_comment"
52
53
  require "files.com/models/file_comment_reaction"
54
+ require "files.com/models/file_migration"
53
55
  require "files.com/models/file_upload_part"
54
56
  require "files.com/models/folder"
55
57
  require "files.com/models/form_field"
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class ActionWebhookFailure
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # retry Action Webhook Failure
13
+ def retry(params = {})
14
+ params ||= {}
15
+ params[:id] = @attributes[:id]
16
+ raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
17
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
18
+ raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
19
+
20
+ Api.send_request("/action_webhook_failures/#{@attributes[:id]}/retry", :post, params, @options)
21
+ end
22
+
23
+ # retry Action Webhook Failure
24
+ def self.retry(id, params = {}, options = {})
25
+ params ||= {}
26
+ params[:id] = id
27
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
28
+ raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
29
+
30
+ response, _options = Api.send_request("/action_webhook_failures/#{params[:id]}/retry", :post, params, options)
31
+ response.data
32
+ end
33
+ end
34
+ end
@@ -19,6 +19,11 @@ module Files
19
19
  @attributes[:extended_description]
20
20
  end
21
21
 
22
+ # string - Short description of the App
23
+ def short_description
24
+ @attributes[:short_description]
25
+ end
26
+
22
27
  # string - Collection of named links to documentation
23
28
  def documentation_links
24
29
  @attributes[:documentation_links]
@@ -59,6 +59,51 @@ module Files
59
59
  @attributes[:body_url] = value
60
60
  end
61
61
 
62
+ # int64 - Folder Behavior ID
63
+ def folder_behavior_id
64
+ @attributes[:folder_behavior_id]
65
+ end
66
+
67
+ def folder_behavior_id=(value)
68
+ @attributes[:folder_behavior_id] = value
69
+ end
70
+
71
+ # int64 - For sync events, the number of files handled successfully.
72
+ def successful_files
73
+ @attributes[:successful_files]
74
+ end
75
+
76
+ def successful_files=(value)
77
+ @attributes[:successful_files] = value
78
+ end
79
+
80
+ # int64 - For sync events, the number of files that encountered errors.
81
+ def errored_files
82
+ @attributes[:errored_files]
83
+ end
84
+
85
+ def errored_files=(value)
86
+ @attributes[:errored_files] = value
87
+ end
88
+
89
+ # int64 - For sync events, the total number of bytes synced.
90
+ def bytes_synced
91
+ @attributes[:bytes_synced]
92
+ end
93
+
94
+ def bytes_synced=(value)
95
+ @attributes[:bytes_synced] = value
96
+ end
97
+
98
+ # string - Associated Remote Server type, if any
99
+ def remote_server_type
100
+ @attributes[:remote_server_type]
101
+ end
102
+
103
+ def remote_server_type=(value)
104
+ @attributes[:remote_server_type] = value
105
+ end
106
+
62
107
  def save
63
108
  if @attributes[:id]
64
109
  raise NotImplementedError.new("The ExternalEvent object doesn't support updates.")
@@ -71,13 +116,13 @@ module Files
71
116
  # Parameters:
72
117
  # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
73
118
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
74
- # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `remote_server_type`, `event_type`, `created_at` or `status`.
75
- # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
76
- # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
77
- # filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
78
- # filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
79
- # filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
80
- # filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
119
+ # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `remote_server_type`, `event_type`, `created_at`, `status`, `site_id` or `folder_behavior_id`.
120
+ # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
121
+ # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
122
+ # filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
123
+ # filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
124
+ # filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
125
+ # filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
81
126
  def self.list(params = {}, options = {})
82
127
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
83
128
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
@@ -0,0 +1,68 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class FileMigration
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # int64 - File migration ID
13
+ def id
14
+ @attributes[:id]
15
+ end
16
+
17
+ # string - Source path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
18
+ def path
19
+ @attributes[:path]
20
+ end
21
+
22
+ # string - Destination path
23
+ def dest_path
24
+ @attributes[:dest_path]
25
+ end
26
+
27
+ # int64 - Number of files processed
28
+ def files_moved
29
+ @attributes[:files_moved]
30
+ end
31
+
32
+ # int64 - Total number of files to process
33
+ def files_total
34
+ @attributes[:files_total]
35
+ end
36
+
37
+ # string - The type of operation
38
+ def operation
39
+ @attributes[:operation]
40
+ end
41
+
42
+ # string - Region
43
+ def region
44
+ @attributes[:region]
45
+ end
46
+
47
+ # string - Status
48
+ def status
49
+ @attributes[:status]
50
+ end
51
+
52
+ # Parameters:
53
+ # id (required) - int64 - File Migration ID.
54
+ def self.find(id, params = {}, options = {})
55
+ params ||= {}
56
+ params[:id] = id
57
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
58
+ raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
59
+
60
+ response, options = Api.send_request("/file_migrations/#{params[:id]}", :get, params, options)
61
+ FileMigration.new(response.data, options)
62
+ end
63
+
64
+ def self.get(id, params = {}, options = {})
65
+ find(id, params, options)
66
+ end
67
+ end
68
+ end
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.0.180
4
+ version: 1.0.184
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-06-24 00:00:00.000000000 Z
11
+ date: 2021-07-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable
@@ -90,6 +90,7 @@ files:
90
90
  - docs/action.md
91
91
  - docs/action_notification_export.md
92
92
  - docs/action_notification_export_result.md
93
+ - docs/action_webhook_failure.md
93
94
  - docs/api_key.md
94
95
  - docs/app.md
95
96
  - docs/as2_key.md
@@ -109,6 +110,7 @@ files:
109
110
  - docs/file_action.md
110
111
  - docs/file_comment.md
111
112
  - docs/file_comment_reaction.md
113
+ - docs/file_migration.md
112
114
  - docs/file_upload_part.md
113
115
  - docs/file_utils.md
114
116
  - docs/folder.md
@@ -164,6 +166,7 @@ files:
164
166
  - lib/files.com/models/action.rb
165
167
  - lib/files.com/models/action_notification_export.rb
166
168
  - lib/files.com/models/action_notification_export_result.rb
169
+ - lib/files.com/models/action_webhook_failure.rb
167
170
  - lib/files.com/models/api_key.rb
168
171
  - lib/files.com/models/app.rb
169
172
  - lib/files.com/models/as2_key.rb
@@ -184,6 +187,7 @@ files:
184
187
  - lib/files.com/models/file_action.rb
185
188
  - lib/files.com/models/file_comment.rb
186
189
  - lib/files.com/models/file_comment_reaction.rb
190
+ - lib/files.com/models/file_migration.rb
187
191
  - lib/files.com/models/file_upload_part.rb
188
192
  - lib/files.com/models/file_utils.rb
189
193
  - lib/files.com/models/folder.rb