files.com 1.1.56 → 1.1.58
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/bundle_action.md +58 -0
- data/docs/exavault_api_request_log.md +2 -0
- data/lib/files.com/models/bundle_action.rb +64 -0
- data/lib/files.com/models/exavault_api_request_log.rb +5 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +1 -0
- metadata +3 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 948523e774c915cb425a1e647fe90a8e9c9fb27025be60b99e4ce38575dba0c5
|
4
|
+
data.tar.gz: 78e8bfc8a77e89a81a4958e453f1490ecc7d0c4e4b41f7a16366dda58822087c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0df0cdf920ed758bee09414d82cfefb74cba9d8e4ca816d95d47bb9c9915880c91ec9d6d8db8f0f2e2d7d70aab2235c507249d9824dd57df80957850ba16ca84
|
7
|
+
data.tar.gz: 5ba379033b66c3d2dd84562b3291e703d30f18bfa2575020425479459992a155f32343a823c841ba5702c8c9ba2dc70c3b8ec81006c16ebbe55c70e33c36eb19
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.1.
|
1
|
+
1.1.58
|
@@ -0,0 +1,58 @@
|
|
1
|
+
# BundleAction
|
2
|
+
|
3
|
+
## Example BundleAction Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"action": "create",
|
8
|
+
"bundle_registration": {
|
9
|
+
"code": "abc123",
|
10
|
+
"name": "account",
|
11
|
+
"company": "Action Verb",
|
12
|
+
"email": "john.doe@files.com",
|
13
|
+
"ip": "10.1.1.1",
|
14
|
+
"inbox_code": "abc123",
|
15
|
+
"clickwrap_body": "example",
|
16
|
+
"form_field_set_id": 1,
|
17
|
+
"form_field_data": {
|
18
|
+
"key": "example value"
|
19
|
+
},
|
20
|
+
"bundle_code": "example",
|
21
|
+
"bundle_id": 1,
|
22
|
+
"bundle_recipient_id": 1,
|
23
|
+
"created_at": "2000-01-01T01:00:00Z"
|
24
|
+
},
|
25
|
+
"when": "2000-01-01T01:00:00Z",
|
26
|
+
"destination": "/to_path",
|
27
|
+
"path": "",
|
28
|
+
"source": "/from_path"
|
29
|
+
}
|
30
|
+
```
|
31
|
+
|
32
|
+
* `action` (string): Type of action
|
33
|
+
* `bundle_registration` (BundleRegistration): Object that contains bundle registration information
|
34
|
+
* `when` (date-time): Action occurrence date/time
|
35
|
+
* `destination` (string): The destination path for this bundle action, if applicable
|
36
|
+
* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
37
|
+
* `source` (string): The source path for this bundle action, if applicable
|
38
|
+
|
39
|
+
|
40
|
+
---
|
41
|
+
|
42
|
+
## List Bundle Actions
|
43
|
+
|
44
|
+
```
|
45
|
+
Files::BundleAction.list(
|
46
|
+
per_page: 1,
|
47
|
+
bundle_id: 1,
|
48
|
+
bundle_registration_id: 1
|
49
|
+
)
|
50
|
+
```
|
51
|
+
|
52
|
+
### Parameters
|
53
|
+
|
54
|
+
* `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.
|
55
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
56
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[bundle_registration_id]=desc`). Valid fields are `bundle_registration_id` and `created_at`.
|
57
|
+
* `bundle_id` (int64): Bundle ID
|
58
|
+
* `bundle_registration_id` (int64): BundleRegistration ID
|
@@ -13,6 +13,7 @@
|
|
13
13
|
"error_message": "example",
|
14
14
|
"user_agent": "example",
|
15
15
|
"response_code": 1,
|
16
|
+
"success": true,
|
16
17
|
"duration_ms": 1
|
17
18
|
}
|
18
19
|
```
|
@@ -26,6 +27,7 @@
|
|
26
27
|
* `error_message` (string): Error message, if applicable
|
27
28
|
* `user_agent` (string): User-Agent
|
28
29
|
* `response_code` (int64): HTTP Response Code
|
30
|
+
* `success` (boolean): `false` if HTTP Response Code is 4xx or 5xx
|
29
31
|
* `duration_ms` (int64): Duration (in milliseconds)
|
30
32
|
|
31
33
|
|
@@ -0,0 +1,64 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Files
|
4
|
+
class BundleAction
|
5
|
+
attr_reader :options, :attributes
|
6
|
+
|
7
|
+
def initialize(attributes = {}, options = {})
|
8
|
+
@attributes = attributes || {}
|
9
|
+
@options = options || {}
|
10
|
+
end
|
11
|
+
|
12
|
+
# string - Type of action
|
13
|
+
def action
|
14
|
+
@attributes[:action]
|
15
|
+
end
|
16
|
+
|
17
|
+
# BundleRegistration - Object that contains bundle registration information
|
18
|
+
def bundle_registration
|
19
|
+
@attributes[:bundle_registration]
|
20
|
+
end
|
21
|
+
|
22
|
+
# date-time - Action occurrence date/time
|
23
|
+
def when
|
24
|
+
@attributes[:when]
|
25
|
+
end
|
26
|
+
|
27
|
+
# string - The destination path for this bundle action, if applicable
|
28
|
+
def destination
|
29
|
+
@attributes[:destination]
|
30
|
+
end
|
31
|
+
|
32
|
+
# string - Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
33
|
+
def path
|
34
|
+
@attributes[:path]
|
35
|
+
end
|
36
|
+
|
37
|
+
# string - The source path for this bundle action, if applicable
|
38
|
+
def source
|
39
|
+
@attributes[:source]
|
40
|
+
end
|
41
|
+
|
42
|
+
# Parameters:
|
43
|
+
# 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.
|
44
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
45
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[bundle_registration_id]=desc`). Valid fields are `bundle_registration_id` and `created_at`.
|
46
|
+
# bundle_id - int64 - Bundle ID
|
47
|
+
# bundle_registration_id - int64 - BundleRegistration ID
|
48
|
+
def self.list(params = {}, options = {})
|
49
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
50
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
51
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
52
|
+
raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
|
53
|
+
raise InvalidParameterError.new("Bad parameter: bundle_registration_id must be an Integer") if params[:bundle_registration_id] and !params[:bundle_registration_id].is_a?(Integer)
|
54
|
+
|
55
|
+
List.new(BundleAction, params) do
|
56
|
+
Api.send_request("/bundle_actions", :get, params, options)
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
def self.all(params = {}, options = {})
|
61
|
+
list(params, options)
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
data/lib/files.com/version.rb
CHANGED
data/lib/files.com.rb
CHANGED
@@ -51,6 +51,7 @@ require "files.com/models/automation_run"
|
|
51
51
|
require "files.com/models/bandwidth_snapshot"
|
52
52
|
require "files.com/models/behavior"
|
53
53
|
require "files.com/models/bundle"
|
54
|
+
require "files.com/models/bundle_action"
|
54
55
|
require "files.com/models/bundle_download"
|
55
56
|
require "files.com/models/bundle_notification"
|
56
57
|
require "files.com/models/bundle_path"
|
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.
|
4
|
+
version: 1.1.58
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- files.com
|
@@ -133,6 +133,7 @@ files:
|
|
133
133
|
- docs/bandwidth_snapshot.md
|
134
134
|
- docs/behavior.md
|
135
135
|
- docs/bundle.md
|
136
|
+
- docs/bundle_action.md
|
136
137
|
- docs/bundle_download.md
|
137
138
|
- docs/bundle_notification.md
|
138
139
|
- docs/bundle_path.md
|
@@ -230,6 +231,7 @@ files:
|
|
230
231
|
- lib/files.com/models/bandwidth_snapshot.rb
|
231
232
|
- lib/files.com/models/behavior.rb
|
232
233
|
- lib/files.com/models/bundle.rb
|
234
|
+
- lib/files.com/models/bundle_action.rb
|
233
235
|
- lib/files.com/models/bundle_download.rb
|
234
236
|
- lib/files.com/models/bundle_notification.rb
|
235
237
|
- lib/files.com/models/bundle_path.rb
|