files.com 1.1.736 → 1.1.738
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
- data/docs/automation.md +1 -12
- data/docs/partner.md +15 -1
- data/docs/partner_connection.md +19 -0
- data/docs/partner_site_request.md +3 -1
- data/lib/files.com/models/automation.rb +1 -16
- data/lib/files.com/models/partner.rb +14 -1
- data/lib/files.com/models/partner_connection.rb +37 -0
- data/lib/files.com/models/partner_site_request.rb +2 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +1 -0
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: cb2509356926a0a3708b056408eb442fcf63abef3977fe8b3c963ea2e8596f32
|
|
4
|
+
data.tar.gz: 4e7513f71151a43f87cb6abbf0cea63cb91df61d7cdf8a087ba345b310125a8d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: '0329c8d20a9c7292d430307b2fa03b364a4c8e9ca8ab27ca20abfc5c49c8e6eb9a575194a3c5e8fea1e0d0d15a707bf39d97a16fa6fb786753666279f730f6b0'
|
|
7
|
+
data.tar.gz: 1cfa331c574d3c657794298f1a92f09171a8e11be7e8cc5d223f6266082a8845ea55e31b70306bc143723eba9e321182af38c9152eba11cba40672ad78f6d4ba
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.738
|
data/docs/automation.md
CHANGED
|
@@ -102,10 +102,6 @@
|
|
|
102
102
|
],
|
|
103
103
|
"schedule_time_zone": "Eastern Time (US & Canada)",
|
|
104
104
|
"source": "example",
|
|
105
|
-
"legacy_sync_ids": [
|
|
106
|
-
1,
|
|
107
|
-
2
|
|
108
|
-
],
|
|
109
105
|
"sync_ids": [
|
|
110
106
|
1,
|
|
111
107
|
2
|
|
@@ -164,8 +160,7 @@
|
|
|
164
160
|
* `schedule_times_of_day` (array(string)): Times of day to run in HH:MM format (24-hour). For `custom_schedule`, run at these times on specified days of week. For `daily`, run at these times on the scheduled interval date.
|
|
165
161
|
* `schedule_time_zone` (string): Time zone for the schedule. If not set, times are interpreted as UTC.
|
|
166
162
|
* `source` (string): Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
|
|
167
|
-
* `
|
|
168
|
-
* `sync_ids` (array(int64)): IDs of syncs to run by this Automation. This is the new way to specify syncs, and it is recommended to use this instead of `legacy_sync_ids`.
|
|
163
|
+
* `sync_ids` (array(int64)): IDs of Syncs to run by this Automation.
|
|
169
164
|
* `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, copy, move, archived_delete, update, read, destroy
|
|
170
165
|
* `trigger` (string): How this automation is triggered to run.
|
|
171
166
|
* `user_id` (int64): User ID of the Automation's creator.
|
|
@@ -229,7 +224,6 @@ Files::Automation.create(
|
|
|
229
224
|
destination_replace_to: "example",
|
|
230
225
|
interval: "year",
|
|
231
226
|
path: "example",
|
|
232
|
-
legacy_sync_ids: [1,2],
|
|
233
227
|
sync_ids: [1,2],
|
|
234
228
|
user_ids: [1,2],
|
|
235
229
|
group_ids: [1,2],
|
|
@@ -271,7 +265,6 @@ Files::Automation.create(
|
|
|
271
265
|
* `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
|
272
266
|
* `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
|
273
267
|
* `path` (string): Path on which this Automation runs. Supports globs, except on remote mounts.
|
|
274
|
-
* `legacy_sync_ids` (string): A list of legacy sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
275
268
|
* `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
276
269
|
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
277
270
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
@@ -345,7 +338,6 @@ Files::Automation.update(id,
|
|
|
345
338
|
destination_replace_to: "example",
|
|
346
339
|
interval: "year",
|
|
347
340
|
path: "example",
|
|
348
|
-
legacy_sync_ids: [1,2],
|
|
349
341
|
sync_ids: [1,2],
|
|
350
342
|
user_ids: [1,2],
|
|
351
343
|
group_ids: [1,2],
|
|
@@ -387,7 +379,6 @@ Files::Automation.update(id,
|
|
|
387
379
|
* `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
|
388
380
|
* `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
|
389
381
|
* `path` (string): Path on which this Automation runs. Supports globs, except on remote mounts.
|
|
390
|
-
* `legacy_sync_ids` (string): A list of legacy sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
391
382
|
* `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
392
383
|
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
393
384
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
@@ -479,7 +470,6 @@ automation.update(
|
|
|
479
470
|
destination_replace_to: "example",
|
|
480
471
|
interval: "year",
|
|
481
472
|
path: "example",
|
|
482
|
-
legacy_sync_ids: [1,2],
|
|
483
473
|
sync_ids: [1,2],
|
|
484
474
|
user_ids: [1,2],
|
|
485
475
|
group_ids: [1,2],
|
|
@@ -521,7 +511,6 @@ automation.update(
|
|
|
521
511
|
* `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
|
522
512
|
* `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
|
523
513
|
* `path` (string): Path on which this Automation runs. Supports globs, except on remote mounts.
|
|
524
|
-
* `legacy_sync_ids` (string): A list of legacy sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
525
514
|
* `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
526
515
|
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
527
516
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
data/docs/partner.md
CHANGED
|
@@ -10,6 +10,15 @@
|
|
|
10
10
|
"allow_providing_gpg_keys": false,
|
|
11
11
|
"allow_user_creation": false,
|
|
12
12
|
"cc_emails_to_responsible_party": false,
|
|
13
|
+
"connections": [
|
|
14
|
+
{
|
|
15
|
+
"id": 1,
|
|
16
|
+
"role": "guest",
|
|
17
|
+
"site_id": 2,
|
|
18
|
+
"site_name": "Acme Site",
|
|
19
|
+
"mount_path": "_/Sites/2"
|
|
20
|
+
}
|
|
21
|
+
],
|
|
13
22
|
"id": 1,
|
|
14
23
|
"ai_assistant_personality_id": 1,
|
|
15
24
|
"workspace_id": 1,
|
|
@@ -41,6 +50,7 @@
|
|
|
41
50
|
* `allow_providing_gpg_keys` (boolean): Allow Partner Admins to provide GPG keys.
|
|
42
51
|
* `allow_user_creation` (boolean): Allow Partner Admins to create users.
|
|
43
52
|
* `cc_emails_to_responsible_party` (boolean): When `true`, emails sent to Partner users are copied to the responsible User or Group.
|
|
53
|
+
* `connections` (array(object)): Approved Connected Sites relationships for this Partner, in both directions. Empty when this Partner has no connections. Read-only.
|
|
44
54
|
* `id` (int64): The unique ID of the Partner.
|
|
45
55
|
* `ai_assistant_personality_id` (int64): AI Assistant Personality ID assigned to this Partner, if any. Users in the Partner inherit it unless a direct per-user assignment overrides it.
|
|
46
56
|
* `workspace_id` (int64): ID of the Workspace associated with this Partner.
|
|
@@ -48,7 +58,7 @@
|
|
|
48
58
|
* `notes` (string): Notes about this Partner.
|
|
49
59
|
* `partner_admin_ids` (array(int64)): Array of User IDs that are Partner Admins for this Partner.
|
|
50
60
|
* `partner_channel_template_id` (int64): ID of the Partner Channel Template assigned to this Partner.
|
|
51
|
-
* `partnership_role` (string): This site's role
|
|
61
|
+
* `partnership_role` (string): This site's role for this Partner in Connected Sites relationships. `host` is a Partner this site configured. `guest` is a Partner created by approving another site's connection request; it has no root folder and cannot hold users, permissions, or Partner Channels, or host a connection. `host_and_guest` is a configured Partner that is also the guest side of a connection. Promote a `guest` Partner by setting this to `host_and_guest` together with a `root_folder`.
|
|
52
62
|
* `responsible_group_id` (int64): ID of the Group responsible for this Partner.
|
|
53
63
|
* `responsible_user_id` (int64): ID of the User responsible for this Partner.
|
|
54
64
|
* `root_folder` (string): The root folder path for this Partner.
|
|
@@ -151,6 +161,7 @@ Files::Partner.update(id,
|
|
|
151
161
|
show_partner_channel_home_page: false,
|
|
152
162
|
tags: "example",
|
|
153
163
|
name: "Acme Corp",
|
|
164
|
+
partnership_role: "host",
|
|
154
165
|
root_folder: "/AcmeCorp"
|
|
155
166
|
)
|
|
156
167
|
```
|
|
@@ -172,6 +183,7 @@ Files::Partner.update(id,
|
|
|
172
183
|
* `show_partner_channel_home_page` (boolean): Show Partner users a simplified home page built from this Partner's Channels.
|
|
173
184
|
* `tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
174
185
|
* `name` (string): The name of the Partner.
|
|
186
|
+
* `partnership_role` (string): This site's role for this Partner in Connected Sites relationships. `host` is a Partner this site configured. `guest` is a Partner created by approving another site's connection request; it has no root folder and cannot hold users, permissions, or Partner Channels, or host a connection. `host_and_guest` is a configured Partner that is also the guest side of a connection. Promote a `guest` Partner by setting this to `host_and_guest` together with a `root_folder`.
|
|
175
187
|
* `root_folder` (string): The root folder path for this Partner.
|
|
176
188
|
|
|
177
189
|
|
|
@@ -210,6 +222,7 @@ partner.update(
|
|
|
210
222
|
show_partner_channel_home_page: false,
|
|
211
223
|
tags: "example",
|
|
212
224
|
name: "Acme Corp",
|
|
225
|
+
partnership_role: "host",
|
|
213
226
|
root_folder: "/AcmeCorp"
|
|
214
227
|
)
|
|
215
228
|
```
|
|
@@ -231,6 +244,7 @@ partner.update(
|
|
|
231
244
|
* `show_partner_channel_home_page` (boolean): Show Partner users a simplified home page built from this Partner's Channels.
|
|
232
245
|
* `tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
233
246
|
* `name` (string): The name of the Partner.
|
|
247
|
+
* `partnership_role` (string): This site's role for this Partner in Connected Sites relationships. `host` is a Partner this site configured. `guest` is a Partner created by approving another site's connection request; it has no root folder and cannot hold users, permissions, or Partner Channels, or host a connection. `host_and_guest` is a configured Partner that is also the guest side of a connection. Promote a `guest` Partner by setting this to `host_and_guest` together with a `root_folder`.
|
|
234
248
|
* `root_folder` (string): The root folder path for this Partner.
|
|
235
249
|
|
|
236
250
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# PartnerConnection
|
|
2
|
+
|
|
3
|
+
## Example PartnerConnection Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"role": "guest",
|
|
9
|
+
"site_id": 2,
|
|
10
|
+
"site_name": "Acme Site",
|
|
11
|
+
"mount_path": "_/Sites/2"
|
|
12
|
+
}
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
* `id` (int64): Relationship ID used with DELETE /partner_sites/:id to disconnect.
|
|
16
|
+
* `role` (string): This Partner's role in this connection. A host shares local files with the connected site; a guest accesses files shared by the connected site.
|
|
17
|
+
* `site_id` (int64): ID of the connected site.
|
|
18
|
+
* `site_name` (string): Name of the connected site.
|
|
19
|
+
* `mount_path` (string): File API path to the connected Host's mount on this site when role is guest. Null when role is host. File access remains subject to the caller's permissions and the Host Partner's grants.
|
|
@@ -94,13 +94,15 @@ Files::PartnerSiteRequest.reject(
|
|
|
94
94
|
|
|
95
95
|
```
|
|
96
96
|
Files::PartnerSiteRequest.approve(
|
|
97
|
-
pairing_key: "pairing_key"
|
|
97
|
+
pairing_key: "pairing_key",
|
|
98
|
+
partner_id: 1
|
|
98
99
|
)
|
|
99
100
|
```
|
|
100
101
|
|
|
101
102
|
### Parameters
|
|
102
103
|
|
|
103
104
|
* `pairing_key` (string): Required - Pairing key for the partner site request
|
|
105
|
+
* `partner_id` (int64): ID of an existing Partner on this site, with the host role, that represents the requesting organization. The connection binds to that Partner and makes it host_and_guest. When omitted, a guest Partner named after the host site is created.
|
|
104
106
|
|
|
105
107
|
|
|
106
108
|
---
|
|
@@ -342,16 +342,7 @@ module Files
|
|
|
342
342
|
@attributes[:source] = value
|
|
343
343
|
end
|
|
344
344
|
|
|
345
|
-
# array(int64) - IDs of
|
|
346
|
-
def legacy_sync_ids
|
|
347
|
-
@attributes[:legacy_sync_ids]
|
|
348
|
-
end
|
|
349
|
-
|
|
350
|
-
def legacy_sync_ids=(value)
|
|
351
|
-
@attributes[:legacy_sync_ids] = value
|
|
352
|
-
end
|
|
353
|
-
|
|
354
|
-
# array(int64) - IDs of syncs to run by this Automation. This is the new way to specify syncs, and it is recommended to use this instead of `legacy_sync_ids`.
|
|
345
|
+
# array(int64) - IDs of Syncs to run by this Automation.
|
|
355
346
|
def sync_ids
|
|
356
347
|
@attributes[:sync_ids]
|
|
357
348
|
end
|
|
@@ -456,7 +447,6 @@ module Files
|
|
|
456
447
|
# destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
|
457
448
|
# interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
|
458
449
|
# path - string - Path on which this Automation runs. Supports globs, except on remote mounts.
|
|
459
|
-
# legacy_sync_ids - string - A list of legacy sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
460
450
|
# sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
461
451
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
462
452
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
@@ -497,7 +487,6 @@ module Files
|
|
|
497
487
|
raise InvalidParameterError.new("Bad parameter: destination_replace_to must be an String") if params[:destination_replace_to] and !params[:destination_replace_to].is_a?(String)
|
|
498
488
|
raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
|
|
499
489
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
500
|
-
raise InvalidParameterError.new("Bad parameter: legacy_sync_ids must be an String") if params[:legacy_sync_ids] and !params[:legacy_sync_ids].is_a?(String)
|
|
501
490
|
raise InvalidParameterError.new("Bad parameter: sync_ids must be an String") if params[:sync_ids] and !params[:sync_ids].is_a?(String)
|
|
502
491
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
|
|
503
492
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params[:group_ids] and !params[:group_ids].is_a?(String)
|
|
@@ -605,7 +594,6 @@ module Files
|
|
|
605
594
|
# destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
|
606
595
|
# interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
|
607
596
|
# path - string - Path on which this Automation runs. Supports globs, except on remote mounts.
|
|
608
|
-
# legacy_sync_ids - string - A list of legacy sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
609
597
|
# sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
610
598
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
611
599
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
@@ -643,7 +631,6 @@ module Files
|
|
|
643
631
|
raise InvalidParameterError.new("Bad parameter: destination_replace_to must be an String") if params[:destination_replace_to] and !params[:destination_replace_to].is_a?(String)
|
|
644
632
|
raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
|
|
645
633
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
646
|
-
raise InvalidParameterError.new("Bad parameter: legacy_sync_ids must be an String") if params[:legacy_sync_ids] and !params[:legacy_sync_ids].is_a?(String)
|
|
647
634
|
raise InvalidParameterError.new("Bad parameter: sync_ids must be an String") if params[:sync_ids] and !params[:sync_ids].is_a?(String)
|
|
648
635
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
|
|
649
636
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params[:group_ids] and !params[:group_ids].is_a?(String)
|
|
@@ -706,7 +693,6 @@ module Files
|
|
|
706
693
|
# destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
|
707
694
|
# interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
|
708
695
|
# path - string - Path on which this Automation runs. Supports globs, except on remote mounts.
|
|
709
|
-
# legacy_sync_ids - string - A list of legacy sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
710
696
|
# sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
711
697
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
712
698
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
@@ -746,7 +732,6 @@ module Files
|
|
|
746
732
|
raise InvalidParameterError.new("Bad parameter: destination_replace_to must be an String") if params[:destination_replace_to] and !params[:destination_replace_to].is_a?(String)
|
|
747
733
|
raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
|
|
748
734
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
749
|
-
raise InvalidParameterError.new("Bad parameter: legacy_sync_ids must be an String") if params[:legacy_sync_ids] and !params[:legacy_sync_ids].is_a?(String)
|
|
750
735
|
raise InvalidParameterError.new("Bad parameter: sync_ids must be an String") if params[:sync_ids] and !params[:sync_ids].is_a?(String)
|
|
751
736
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
|
|
752
737
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params[:group_ids] and !params[:group_ids].is_a?(String)
|
|
@@ -63,6 +63,15 @@ module Files
|
|
|
63
63
|
@attributes[:cc_emails_to_responsible_party] = value
|
|
64
64
|
end
|
|
65
65
|
|
|
66
|
+
# array(object) - Approved Connected Sites relationships for this Partner, in both directions. Empty when this Partner has no connections. Read-only.
|
|
67
|
+
def connections
|
|
68
|
+
@attributes[:connections]
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
def connections=(value)
|
|
72
|
+
@attributes[:connections] = value
|
|
73
|
+
end
|
|
74
|
+
|
|
66
75
|
# int64 - The unique ID of the Partner.
|
|
67
76
|
def id
|
|
68
77
|
@attributes[:id]
|
|
@@ -126,7 +135,7 @@ module Files
|
|
|
126
135
|
@attributes[:partner_channel_template_id] = value
|
|
127
136
|
end
|
|
128
137
|
|
|
129
|
-
# string - This site's role
|
|
138
|
+
# string - This site's role for this Partner in Connected Sites relationships. `host` is a Partner this site configured. `guest` is a Partner created by approving another site's connection request; it has no root folder and cannot hold users, permissions, or Partner Channels, or host a connection. `host_and_guest` is a configured Partner that is also the guest side of a connection. Promote a `guest` Partner by setting this to `host_and_guest` together with a `root_folder`.
|
|
130
139
|
def partnership_role
|
|
131
140
|
@attributes[:partnership_role]
|
|
132
141
|
end
|
|
@@ -204,6 +213,7 @@ module Files
|
|
|
204
213
|
# show_partner_channel_home_page - boolean - Show Partner users a simplified home page built from this Partner's Channels.
|
|
205
214
|
# tags - string - Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
206
215
|
# name - string - The name of the Partner.
|
|
216
|
+
# partnership_role - string - This site's role for this Partner in Connected Sites relationships. `host` is a Partner this site configured. `guest` is a Partner created by approving another site's connection request; it has no root folder and cannot hold users, permissions, or Partner Channels, or host a connection. `host_and_guest` is a configured Partner that is also the guest side of a connection. Promote a `guest` Partner by setting this to `host_and_guest` together with a `root_folder`.
|
|
207
217
|
# root_folder - string - The root folder path for this Partner.
|
|
208
218
|
def update(params = {})
|
|
209
219
|
params ||= {}
|
|
@@ -218,6 +228,7 @@ module Files
|
|
|
218
228
|
raise InvalidParameterError.new("Bad parameter: responsible_user_id must be an Integer") if params[:responsible_user_id] and !params[:responsible_user_id].is_a?(Integer)
|
|
219
229
|
raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
|
|
220
230
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
231
|
+
raise InvalidParameterError.new("Bad parameter: partnership_role must be an String") if params[:partnership_role] and !params[:partnership_role].is_a?(String)
|
|
221
232
|
raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
|
|
222
233
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
223
234
|
|
|
@@ -336,6 +347,7 @@ module Files
|
|
|
336
347
|
# show_partner_channel_home_page - boolean - Show Partner users a simplified home page built from this Partner's Channels.
|
|
337
348
|
# tags - string - Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
338
349
|
# name - string - The name of the Partner.
|
|
350
|
+
# partnership_role - string - This site's role for this Partner in Connected Sites relationships. `host` is a Partner this site configured. `guest` is a Partner created by approving another site's connection request; it has no root folder and cannot hold users, permissions, or Partner Channels, or host a connection. `host_and_guest` is a configured Partner that is also the guest side of a connection. Promote a `guest` Partner by setting this to `host_and_guest` together with a `root_folder`.
|
|
339
351
|
# root_folder - string - The root folder path for this Partner.
|
|
340
352
|
def self.update(id, params = {}, options = {})
|
|
341
353
|
params ||= {}
|
|
@@ -349,6 +361,7 @@ module Files
|
|
|
349
361
|
raise InvalidParameterError.new("Bad parameter: responsible_user_id must be an Integer") if params[:responsible_user_id] and !params[:responsible_user_id].is_a?(Integer)
|
|
350
362
|
raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
|
|
351
363
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
364
|
+
raise InvalidParameterError.new("Bad parameter: partnership_role must be an String") if params[:partnership_role] and !params[:partnership_role].is_a?(String)
|
|
352
365
|
raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
|
|
353
366
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
354
367
|
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Files
|
|
4
|
+
class PartnerConnection
|
|
5
|
+
attr_reader :options, :attributes
|
|
6
|
+
|
|
7
|
+
def initialize(attributes = {}, options = {})
|
|
8
|
+
@attributes = attributes || {}
|
|
9
|
+
@options = options || {}
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# int64 - Relationship ID used with DELETE /partner_sites/:id to disconnect.
|
|
13
|
+
def id
|
|
14
|
+
@attributes[:id]
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
# string - This Partner's role in this connection. A host shares local files with the connected site; a guest accesses files shared by the connected site.
|
|
18
|
+
def role
|
|
19
|
+
@attributes[:role]
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
# int64 - ID of the connected site.
|
|
23
|
+
def site_id
|
|
24
|
+
@attributes[:site_id]
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# string - Name of the connected site.
|
|
28
|
+
def site_name
|
|
29
|
+
@attributes[:site_name]
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# string - File API path to the connected Host's mount on this site when role is guest. Null when role is host. File access remains subject to the caller's permissions and the Host Partner's grants.
|
|
33
|
+
def mount_path
|
|
34
|
+
@attributes[:mount_path]
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
@@ -154,8 +154,10 @@ module Files
|
|
|
154
154
|
|
|
155
155
|
# Parameters:
|
|
156
156
|
# pairing_key (required) - string - Pairing key for the partner site request
|
|
157
|
+
# partner_id - int64 - ID of an existing Partner on this site, with the host role, that represents the requesting organization. The connection binds to that Partner and makes it host_and_guest. When omitted, a guest Partner named after the host site is created.
|
|
157
158
|
def self.approve(params = {}, options = {})
|
|
158
159
|
raise InvalidParameterError.new("Bad parameter: pairing_key must be an String") if params[:pairing_key] and !params[:pairing_key].is_a?(String)
|
|
160
|
+
raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
|
|
159
161
|
raise MissingParameterError.new("Parameter missing: pairing_key") unless params[:pairing_key]
|
|
160
162
|
|
|
161
163
|
Api.send_request("/partner_site_requests/approve", :post, params, options)
|
data/lib/files.com/version.rb
CHANGED
data/lib/files.com.rb
CHANGED
|
@@ -122,6 +122,7 @@ require "files.com/models/outbound_connection_log"
|
|
|
122
122
|
require "files.com/models/partner"
|
|
123
123
|
require "files.com/models/partner_channel"
|
|
124
124
|
require "files.com/models/partner_channel_template"
|
|
125
|
+
require "files.com/models/partner_connection"
|
|
125
126
|
require "files.com/models/partner_site"
|
|
126
127
|
require "files.com/models/partner_site_request"
|
|
127
128
|
require "files.com/models/payment"
|
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.1.
|
|
4
|
+
version: 1.1.738
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- files.com
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-09-
|
|
11
|
+
date: 2026-09-20 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: addressable
|
|
@@ -261,6 +261,7 @@ files:
|
|
|
261
261
|
- docs/partner.md
|
|
262
262
|
- docs/partner_channel.md
|
|
263
263
|
- docs/partner_channel_template.md
|
|
264
|
+
- docs/partner_connection.md
|
|
264
265
|
- docs/partner_site.md
|
|
265
266
|
- docs/partner_site_request.md
|
|
266
267
|
- docs/payment.md
|
|
@@ -413,6 +414,7 @@ files:
|
|
|
413
414
|
- lib/files.com/models/partner.rb
|
|
414
415
|
- lib/files.com/models/partner_channel.rb
|
|
415
416
|
- lib/files.com/models/partner_channel_template.rb
|
|
417
|
+
- lib/files.com/models/partner_connection.rb
|
|
416
418
|
- lib/files.com/models/partner_site.rb
|
|
417
419
|
- lib/files.com/models/partner_site_request.rb
|
|
418
420
|
- lib/files.com/models/payment.rb
|