files.com 1.0.360 → 1.0.362
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.md +2 -0
- data/docs/share_group.md +148 -0
- data/docs/share_group_member.md +15 -0
- data/lib/files.com/models/bundle.rb +9 -0
- data/lib/files.com/models/share_group.rb +188 -0
- data/lib/files.com/models/share_group_member.rb +27 -0
- data/lib/files.com.rb +2 -0
- metadata +6 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 18af8443937174bf0ae7a46ef866b8f1a4a56db9ea14d449a036e47ebde0b88f
|
4
|
+
data.tar.gz: 79de26b29faf547c955b519ee4fe457f04f7a1826276ab2b31b9d95925a27520
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ab240292eba5d2bccb31b038e37123f3c6772445637299cb61d4f804276eb4ccfec8d3b3ef28659bc63b68fdd2b78b5842929276d5d699d09688158175598e23
|
7
|
+
data.tar.gz: df112f9a21749c530de41bb66978db1b183bf8a2874205bdb47e73c3143ec6b865c6a3d0f1680706c68389905c252b7f3e2c5a119e0021aa8813700de89da320
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.362
|
data/docs/bundle.md
CHANGED
@@ -13,6 +13,7 @@
|
|
13
13
|
"preview_only": true,
|
14
14
|
"require_registration": true,
|
15
15
|
"require_share_recipient": true,
|
16
|
+
"require_logout": true,
|
16
17
|
"clickwrap_body": "[Legal text]",
|
17
18
|
"form_field_set": {
|
18
19
|
"id": 1,
|
@@ -65,6 +66,7 @@
|
|
65
66
|
* `preview_only` (boolean): DEPRECATED: Restrict users to previewing files only. Use `permissions` instead.
|
66
67
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
67
68
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
69
|
+
* `require_logout` (boolean): If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
|
68
70
|
* `clickwrap_body` (string): Legal text that must be agreed to prior to accessing Bundle.
|
69
71
|
* `form_field_set` (FormFieldSet): Custom Form to use
|
70
72
|
* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
|
data/docs/share_group.md
ADDED
@@ -0,0 +1,148 @@
|
|
1
|
+
# ShareGroup
|
2
|
+
|
3
|
+
## Example ShareGroup Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"name": "Test group 1",
|
9
|
+
"notes": "This group is defined for testing purposes",
|
10
|
+
"user_id": 1,
|
11
|
+
"share_group_members": [
|
12
|
+
{
|
13
|
+
"name": "John Doe",
|
14
|
+
"company": "Acme Ltd",
|
15
|
+
"email": "johndoe@gmail.com"
|
16
|
+
}
|
17
|
+
]
|
18
|
+
}
|
19
|
+
```
|
20
|
+
|
21
|
+
* `id` (int64): Share Group ID
|
22
|
+
* `name` (string): Name of the share group
|
23
|
+
* `notes` (string): Additional notes of the share group
|
24
|
+
* `user_id` (int64): Owner User ID
|
25
|
+
* `share_group_members` (array): A list of share group members
|
26
|
+
* `members` (array(object)): A list of share group members.
|
27
|
+
|
28
|
+
|
29
|
+
---
|
30
|
+
|
31
|
+
## List Share Groups
|
32
|
+
|
33
|
+
```
|
34
|
+
Files::ShareGroup.list(
|
35
|
+
user_id: 1,
|
36
|
+
per_page: 1
|
37
|
+
)
|
38
|
+
```
|
39
|
+
|
40
|
+
### Parameters
|
41
|
+
|
42
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
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
|
+
|
46
|
+
|
47
|
+
---
|
48
|
+
|
49
|
+
## Show Share Group
|
50
|
+
|
51
|
+
```
|
52
|
+
Files::ShareGroup.find(id)
|
53
|
+
```
|
54
|
+
|
55
|
+
### Parameters
|
56
|
+
|
57
|
+
* `id` (int64): Required - Share Group ID.
|
58
|
+
|
59
|
+
|
60
|
+
---
|
61
|
+
|
62
|
+
## Create Share Group
|
63
|
+
|
64
|
+
```
|
65
|
+
Files::ShareGroup.create(
|
66
|
+
user_id: 1,
|
67
|
+
notes: "This group is defined for testing purposes",
|
68
|
+
name: "Test group 1",
|
69
|
+
members: [{"name":"John Doe","company":"Acme Ltd","email":"johndoe@gmail.com"}]
|
70
|
+
)
|
71
|
+
```
|
72
|
+
|
73
|
+
### Parameters
|
74
|
+
|
75
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
76
|
+
* `notes` (string): Additional notes of the share group
|
77
|
+
* `name` (string): Required - Name of the share group
|
78
|
+
* `members` (array(object)): Required - A list of share group members.
|
79
|
+
|
80
|
+
|
81
|
+
---
|
82
|
+
|
83
|
+
## Update Share Group
|
84
|
+
|
85
|
+
```
|
86
|
+
Files::ShareGroup.update(id,
|
87
|
+
notes: "This group is defined for testing purposes",
|
88
|
+
name: "Test group 1",
|
89
|
+
members: [{"name":"John Doe","company":"Acme Ltd","email":"johndoe@gmail.com"}]
|
90
|
+
)
|
91
|
+
```
|
92
|
+
|
93
|
+
### Parameters
|
94
|
+
|
95
|
+
* `id` (int64): Required - Share Group ID.
|
96
|
+
* `notes` (string): Additional notes of the share group
|
97
|
+
* `name` (string): Name of the share group
|
98
|
+
* `members` (array(object)): A list of share group members.
|
99
|
+
|
100
|
+
|
101
|
+
---
|
102
|
+
|
103
|
+
## Delete Share Group
|
104
|
+
|
105
|
+
```
|
106
|
+
Files::ShareGroup.delete(id)
|
107
|
+
```
|
108
|
+
|
109
|
+
### Parameters
|
110
|
+
|
111
|
+
* `id` (int64): Required - Share Group ID.
|
112
|
+
|
113
|
+
|
114
|
+
---
|
115
|
+
|
116
|
+
## Update Share Group
|
117
|
+
|
118
|
+
```
|
119
|
+
share_group = Files::ShareGroup.list.first
|
120
|
+
|
121
|
+
share_group.update(
|
122
|
+
notes: "This group is defined for testing purposes",
|
123
|
+
name: "Test group 1",
|
124
|
+
members: [{"name":"John Doe","company":"Acme Ltd","email":"johndoe@gmail.com"}]
|
125
|
+
)
|
126
|
+
```
|
127
|
+
|
128
|
+
### Parameters
|
129
|
+
|
130
|
+
* `id` (int64): Required - Share Group ID.
|
131
|
+
* `notes` (string): Additional notes of the share group
|
132
|
+
* `name` (string): Name of the share group
|
133
|
+
* `members` (array(object)): A list of share group members.
|
134
|
+
|
135
|
+
|
136
|
+
---
|
137
|
+
|
138
|
+
## Delete Share Group
|
139
|
+
|
140
|
+
```
|
141
|
+
share_group = Files::ShareGroup.list.first
|
142
|
+
|
143
|
+
share_group.delete
|
144
|
+
```
|
145
|
+
|
146
|
+
### Parameters
|
147
|
+
|
148
|
+
* `id` (int64): Required - Share Group ID.
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# ShareGroupMember
|
2
|
+
|
3
|
+
## Example ShareGroupMember Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"name": "John Doe",
|
8
|
+
"company": "Acme Ltd",
|
9
|
+
"email": "johndoe@gmail.com"
|
10
|
+
}
|
11
|
+
```
|
12
|
+
|
13
|
+
* `name` (string): Name of the share group member
|
14
|
+
* `company` (string): Company of the share group member
|
15
|
+
* `email` (string): Email of the share group member
|
@@ -90,6 +90,15 @@ module Files
|
|
90
90
|
@attributes[:require_share_recipient] = value
|
91
91
|
end
|
92
92
|
|
93
|
+
# boolean - If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
|
94
|
+
def require_logout
|
95
|
+
@attributes[:require_logout]
|
96
|
+
end
|
97
|
+
|
98
|
+
def require_logout=(value)
|
99
|
+
@attributes[:require_logout] = value
|
100
|
+
end
|
101
|
+
|
93
102
|
# string - Legal text that must be agreed to prior to accessing Bundle.
|
94
103
|
def clickwrap_body
|
95
104
|
@attributes[:clickwrap_body]
|
@@ -0,0 +1,188 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Files
|
4
|
+
class ShareGroup
|
5
|
+
attr_reader :options, :attributes
|
6
|
+
|
7
|
+
def initialize(attributes = {}, options = {})
|
8
|
+
@attributes = attributes || {}
|
9
|
+
@options = options || {}
|
10
|
+
end
|
11
|
+
|
12
|
+
# int64 - Share Group ID
|
13
|
+
def id
|
14
|
+
@attributes[:id]
|
15
|
+
end
|
16
|
+
|
17
|
+
def id=(value)
|
18
|
+
@attributes[:id] = value
|
19
|
+
end
|
20
|
+
|
21
|
+
# string - Name of the share group
|
22
|
+
def name
|
23
|
+
@attributes[:name]
|
24
|
+
end
|
25
|
+
|
26
|
+
def name=(value)
|
27
|
+
@attributes[:name] = value
|
28
|
+
end
|
29
|
+
|
30
|
+
# string - Additional notes of the share group
|
31
|
+
def notes
|
32
|
+
@attributes[:notes]
|
33
|
+
end
|
34
|
+
|
35
|
+
def notes=(value)
|
36
|
+
@attributes[:notes] = value
|
37
|
+
end
|
38
|
+
|
39
|
+
# int64 - Owner User ID
|
40
|
+
def user_id
|
41
|
+
@attributes[:user_id]
|
42
|
+
end
|
43
|
+
|
44
|
+
def user_id=(value)
|
45
|
+
@attributes[:user_id] = value
|
46
|
+
end
|
47
|
+
|
48
|
+
# array - A list of share group members
|
49
|
+
def share_group_members
|
50
|
+
@attributes[:share_group_members]
|
51
|
+
end
|
52
|
+
|
53
|
+
def share_group_members=(value)
|
54
|
+
@attributes[:share_group_members] = value
|
55
|
+
end
|
56
|
+
|
57
|
+
# array(object) - A list of share group members.
|
58
|
+
def members
|
59
|
+
@attributes[:members]
|
60
|
+
end
|
61
|
+
|
62
|
+
def members=(value)
|
63
|
+
@attributes[:members] = value
|
64
|
+
end
|
65
|
+
|
66
|
+
# Parameters:
|
67
|
+
# notes - string - Additional notes of the share group
|
68
|
+
# name - string - Name of the share group
|
69
|
+
# members - array(object) - A list of share group members.
|
70
|
+
def update(params = {})
|
71
|
+
params ||= {}
|
72
|
+
params[:id] = @attributes[:id]
|
73
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
74
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
75
|
+
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
76
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
77
|
+
raise InvalidParameterError.new("Bad parameter: members must be an Array") if params[:members] and !params[:members].is_a?(Array)
|
78
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
79
|
+
|
80
|
+
Api.send_request("/share_groups/#{@attributes[:id]}", :patch, params, @options)
|
81
|
+
end
|
82
|
+
|
83
|
+
def delete(params = {})
|
84
|
+
params ||= {}
|
85
|
+
params[:id] = @attributes[:id]
|
86
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
87
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
88
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
89
|
+
|
90
|
+
Api.send_request("/share_groups/#{@attributes[:id]}", :delete, params, @options)
|
91
|
+
end
|
92
|
+
|
93
|
+
def destroy(params = {})
|
94
|
+
delete(params)
|
95
|
+
end
|
96
|
+
|
97
|
+
def save
|
98
|
+
if @attributes[:id]
|
99
|
+
update(@attributes)
|
100
|
+
else
|
101
|
+
new_obj = ShareGroup.create(@attributes, @options)
|
102
|
+
@attributes = new_obj.attributes
|
103
|
+
end
|
104
|
+
end
|
105
|
+
|
106
|
+
# Parameters:
|
107
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
108
|
+
# 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.
|
109
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
110
|
+
def self.list(params = {}, options = {})
|
111
|
+
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
112
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
113
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
114
|
+
|
115
|
+
List.new(ShareGroup, params) do
|
116
|
+
Api.send_request("/share_groups", :get, params, options)
|
117
|
+
end
|
118
|
+
end
|
119
|
+
|
120
|
+
def self.all(params = {}, options = {})
|
121
|
+
list(params, options)
|
122
|
+
end
|
123
|
+
|
124
|
+
# Parameters:
|
125
|
+
# id (required) - int64 - Share Group ID.
|
126
|
+
def self.find(id, params = {}, options = {})
|
127
|
+
params ||= {}
|
128
|
+
params[:id] = id
|
129
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
130
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
131
|
+
|
132
|
+
response, options = Api.send_request("/share_groups/#{params[:id]}", :get, params, options)
|
133
|
+
ShareGroup.new(response.data, options)
|
134
|
+
end
|
135
|
+
|
136
|
+
def self.get(id, params = {}, options = {})
|
137
|
+
find(id, params, options)
|
138
|
+
end
|
139
|
+
|
140
|
+
# Parameters:
|
141
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
142
|
+
# notes - string - Additional notes of the share group
|
143
|
+
# name (required) - string - Name of the share group
|
144
|
+
# members (required) - array(object) - A list of share group members.
|
145
|
+
def self.create(params = {}, options = {})
|
146
|
+
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
147
|
+
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
148
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
149
|
+
raise InvalidParameterError.new("Bad parameter: members must be an Array") if params[:members] and !params[:members].is_a?(Array)
|
150
|
+
raise MissingParameterError.new("Parameter missing: name") unless params[:name]
|
151
|
+
raise MissingParameterError.new("Parameter missing: members") unless params[:members]
|
152
|
+
|
153
|
+
response, options = Api.send_request("/share_groups", :post, params, options)
|
154
|
+
ShareGroup.new(response.data, options)
|
155
|
+
end
|
156
|
+
|
157
|
+
# Parameters:
|
158
|
+
# notes - string - Additional notes of the share group
|
159
|
+
# name - string - Name of the share group
|
160
|
+
# members - array(object) - A list of share group members.
|
161
|
+
def self.update(id, params = {}, options = {})
|
162
|
+
params ||= {}
|
163
|
+
params[:id] = id
|
164
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
165
|
+
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
166
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
167
|
+
raise InvalidParameterError.new("Bad parameter: members must be an Array") if params[:members] and !params[:members].is_a?(Array)
|
168
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
169
|
+
|
170
|
+
response, options = Api.send_request("/share_groups/#{params[:id]}", :patch, params, options)
|
171
|
+
ShareGroup.new(response.data, options)
|
172
|
+
end
|
173
|
+
|
174
|
+
def self.delete(id, params = {}, options = {})
|
175
|
+
params ||= {}
|
176
|
+
params[:id] = id
|
177
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
178
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
179
|
+
|
180
|
+
response, _options = Api.send_request("/share_groups/#{params[:id]}", :delete, params, options)
|
181
|
+
response.data
|
182
|
+
end
|
183
|
+
|
184
|
+
def self.destroy(id, params = {}, options = {})
|
185
|
+
delete(id, params, options)
|
186
|
+
end
|
187
|
+
end
|
188
|
+
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Files
|
4
|
+
class ShareGroupMember
|
5
|
+
attr_reader :options, :attributes
|
6
|
+
|
7
|
+
def initialize(attributes = {}, options = {})
|
8
|
+
@attributes = attributes || {}
|
9
|
+
@options = options || {}
|
10
|
+
end
|
11
|
+
|
12
|
+
# string - Name of the share group member
|
13
|
+
def name
|
14
|
+
@attributes[:name]
|
15
|
+
end
|
16
|
+
|
17
|
+
# string - Company of the share group member
|
18
|
+
def company
|
19
|
+
@attributes[:company]
|
20
|
+
end
|
21
|
+
|
22
|
+
# string - Email of the share group member
|
23
|
+
def email
|
24
|
+
@attributes[:email]
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
data/lib/files.com.rb
CHANGED
@@ -99,6 +99,8 @@ require "files.com/models/request"
|
|
99
99
|
require "files.com/models/session"
|
100
100
|
require "files.com/models/settings_change"
|
101
101
|
require "files.com/models/sftp_host_key"
|
102
|
+
require "files.com/models/share_group"
|
103
|
+
require "files.com/models/share_group_member"
|
102
104
|
require "files.com/models/site"
|
103
105
|
require "files.com/models/snapshot"
|
104
106
|
require "files.com/models/sso_strategy"
|
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.
|
4
|
+
version: 1.0.362
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- files.com
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-06-
|
11
|
+
date: 2023-06-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: addressable
|
@@ -182,6 +182,8 @@ files:
|
|
182
182
|
- docs/session.md
|
183
183
|
- docs/settings_change.md
|
184
184
|
- docs/sftp_host_key.md
|
185
|
+
- docs/share_group.md
|
186
|
+
- docs/share_group_member.md
|
185
187
|
- docs/site.md
|
186
188
|
- docs/snapshot.md
|
187
189
|
- docs/sso_strategy.md
|
@@ -268,6 +270,8 @@ files:
|
|
268
270
|
- lib/files.com/models/session.rb
|
269
271
|
- lib/files.com/models/settings_change.rb
|
270
272
|
- lib/files.com/models/sftp_host_key.rb
|
273
|
+
- lib/files.com/models/share_group.rb
|
274
|
+
- lib/files.com/models/share_group_member.rb
|
271
275
|
- lib/files.com/models/site.rb
|
272
276
|
- lib/files.com/models/snapshot.rb
|
273
277
|
- lib/files.com/models/sso_strategy.rb
|