files.com 1.1.674 → 1.1.675
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/partner.md +8 -0
- data/docs/partner_channel.md +22 -0
- data/docs/partner_channel_template.md +187 -0
- data/lib/files.com/models/partner.rb +15 -0
- data/lib/files.com/models/partner_channel.rb +39 -0
- data/lib/files.com/models/partner_channel_template.rb +278 -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: 61bae143d47da4121c87b0a26109d6ca0d747ba679eb22a941a02dc6b776efb0
|
|
4
|
+
data.tar.gz: bf235a9b659b1552ade1f53f776853836f4e0760a4f0eee71c828de012fa92a1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 72e0b58348864db656c3426cee0f5150147ddb51bca9f60b852695f646dafd7776e1290374960e37debb66d034763fea10efebf236e2299ec9a666b6813e4879
|
|
7
|
+
data.tar.gz: 58a619c509ed8698b00142e7a6e53dec4f2c10f893f0138d99a962790c0e9912f7df765725879c60fbb16b21e05e5d8358d3312d872a5b070b4dfd3281bc0782
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.675
|
data/docs/partner.md
CHANGED
|
@@ -20,6 +20,7 @@
|
|
|
20
20
|
2,
|
|
21
21
|
3
|
|
22
22
|
],
|
|
23
|
+
"partner_channel_template_id": 1,
|
|
23
24
|
"partnership_role": "host",
|
|
24
25
|
"responsible_group_id": 1,
|
|
25
26
|
"responsible_user_id": 1,
|
|
@@ -45,6 +46,7 @@
|
|
|
45
46
|
* `name` (string): The name of the Partner.
|
|
46
47
|
* `notes` (string): Notes about this Partner.
|
|
47
48
|
* `partner_admin_ids` (array(int64)): Array of User IDs that are Partner Admins for this Partner.
|
|
49
|
+
* `partner_channel_template_id` (int64): ID of the Partner Channel Template assigned to this Partner.
|
|
48
50
|
* `partnership_role` (string): This site's role in Partner Site relationships for this Partner. Can be `host`, `guest`, `host_and_guest`, or null.
|
|
49
51
|
* `responsible_group_id` (int64): ID of the Group responsible for this Partner.
|
|
50
52
|
* `responsible_user_id` (int64): ID of the User responsible for this Partner.
|
|
@@ -96,6 +98,7 @@ Files::Partner.create(
|
|
|
96
98
|
allow_user_creation: false,
|
|
97
99
|
cc_emails_to_responsible_party: false,
|
|
98
100
|
notes: "This is a note about the partner.",
|
|
101
|
+
partner_channel_template_id: 1,
|
|
99
102
|
responsible_group_id: 1,
|
|
100
103
|
responsible_user_id: 1,
|
|
101
104
|
tags: "example",
|
|
@@ -115,6 +118,7 @@ Files::Partner.create(
|
|
|
115
118
|
* `allow_user_creation` (boolean): Allow Partner Admins to create users.
|
|
116
119
|
* `cc_emails_to_responsible_party` (boolean): When `true`, emails sent to Partner users are copied to the responsible User or Group.
|
|
117
120
|
* `notes` (string): Notes about this Partner.
|
|
121
|
+
* `partner_channel_template_id` (int64): ID of the Partner Channel Template assigned to this Partner.
|
|
118
122
|
* `responsible_group_id` (int64): ID of the Group responsible for this Partner.
|
|
119
123
|
* `responsible_user_id` (int64): ID of the User responsible for this Partner.
|
|
120
124
|
* `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.
|
|
@@ -137,6 +141,7 @@ Files::Partner.update(id,
|
|
|
137
141
|
allow_user_creation: false,
|
|
138
142
|
cc_emails_to_responsible_party: false,
|
|
139
143
|
notes: "This is a note about the partner.",
|
|
144
|
+
partner_channel_template_id: 1,
|
|
140
145
|
responsible_group_id: 1,
|
|
141
146
|
responsible_user_id: 1,
|
|
142
147
|
tags: "example",
|
|
@@ -156,6 +161,7 @@ Files::Partner.update(id,
|
|
|
156
161
|
* `allow_user_creation` (boolean): Allow Partner Admins to create users.
|
|
157
162
|
* `cc_emails_to_responsible_party` (boolean): When `true`, emails sent to Partner users are copied to the responsible User or Group.
|
|
158
163
|
* `notes` (string): Notes about this Partner.
|
|
164
|
+
* `partner_channel_template_id` (int64): ID of the Partner Channel Template assigned to this Partner.
|
|
159
165
|
* `responsible_group_id` (int64): ID of the Group responsible for this Partner.
|
|
160
166
|
* `responsible_user_id` (int64): ID of the User responsible for this Partner.
|
|
161
167
|
* `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.
|
|
@@ -192,6 +198,7 @@ partner.update(
|
|
|
192
198
|
allow_user_creation: false,
|
|
193
199
|
cc_emails_to_responsible_party: false,
|
|
194
200
|
notes: "This is a note about the partner.",
|
|
201
|
+
partner_channel_template_id: 1,
|
|
195
202
|
responsible_group_id: 1,
|
|
196
203
|
responsible_user_id: 1,
|
|
197
204
|
tags: "example",
|
|
@@ -211,6 +218,7 @@ partner.update(
|
|
|
211
218
|
* `allow_user_creation` (boolean): Allow Partner Admins to create users.
|
|
212
219
|
* `cc_emails_to_responsible_party` (boolean): When `true`, emails sent to Partner users are copied to the responsible User or Group.
|
|
213
220
|
* `notes` (string): Notes about this Partner.
|
|
221
|
+
* `partner_channel_template_id` (int64): ID of the Partner Channel Template assigned to this Partner.
|
|
214
222
|
* `responsible_group_id` (int64): ID of the Group responsible for this Partner.
|
|
215
223
|
* `responsible_user_id` (int64): ID of the User responsible for this Partner.
|
|
216
224
|
* `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.
|
data/docs/partner_channel.md
CHANGED
|
@@ -7,11 +7,18 @@
|
|
|
7
7
|
"id": 1,
|
|
8
8
|
"workspace_id": 1,
|
|
9
9
|
"partner_id": 1,
|
|
10
|
+
"partner_channel_template_id": 1,
|
|
10
11
|
"path": "claims/medical",
|
|
11
12
|
"to_partner_folder_name": "outgoing",
|
|
12
13
|
"from_partner_folder_name": "incoming",
|
|
13
14
|
"from_partner_route_path": "processing/from-partner",
|
|
14
15
|
"to_partner_route_path": "delivery/to-partner",
|
|
16
|
+
"to_partner_managed_folder_paths": [
|
|
17
|
+
"reports/monthly"
|
|
18
|
+
],
|
|
19
|
+
"from_partner_managed_folder_paths": [
|
|
20
|
+
"claims/received"
|
|
21
|
+
],
|
|
15
22
|
"effective_to_partner_folder_name": "outgoing",
|
|
16
23
|
"effective_from_partner_folder_name": "incoming",
|
|
17
24
|
"channel_path": "partners/acme/claims/medical",
|
|
@@ -23,11 +30,14 @@
|
|
|
23
30
|
* `id` (int64): The unique ID of the Partner Channel.
|
|
24
31
|
* `workspace_id` (int64): ID of the Workspace associated with this Partner Channel.
|
|
25
32
|
* `partner_id` (int64): ID of the Partner this Channel belongs to.
|
|
33
|
+
* `partner_channel_template_id` (int64): ID of the Partner Channel Template that manages this Channel, if any.
|
|
26
34
|
* `path` (string): Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
27
35
|
* `to_partner_folder_name` (string): Optional Channel-level to-Partner folder name override.
|
|
28
36
|
* `from_partner_folder_name` (string): Optional Channel-level from-Partner folder name override.
|
|
29
37
|
* `from_partner_route_path` (string): Optional route path for files uploaded by the Partner.
|
|
30
38
|
* `to_partner_route_path` (string): Optional route path for files delivered to the Partner.
|
|
39
|
+
* `to_partner_managed_folder_paths` (array(string)): Managed folder paths inside the to-Partner folder.
|
|
40
|
+
* `from_partner_managed_folder_paths` (array(string)): Managed folder paths inside the from-Partner folder.
|
|
31
41
|
* `effective_to_partner_folder_name` (string): Resolved to-Partner folder name after Channel override and default.
|
|
32
42
|
* `effective_from_partner_folder_name` (string): Resolved from-Partner folder name after Channel override and default.
|
|
33
43
|
* `channel_path` (string): Resolved Channel folder path.
|
|
@@ -71,8 +81,10 @@ Files::PartnerChannel.find(id)
|
|
|
71
81
|
```
|
|
72
82
|
Files::PartnerChannel.create(
|
|
73
83
|
from_partner_folder_name: "incoming",
|
|
84
|
+
from_partner_managed_folder_paths: ["claims/received"],
|
|
74
85
|
from_partner_route_path: "processing/from-partner",
|
|
75
86
|
to_partner_folder_name: "outgoing",
|
|
87
|
+
to_partner_managed_folder_paths: ["reports/monthly"],
|
|
76
88
|
to_partner_route_path: "delivery/to-partner",
|
|
77
89
|
partner_id: 1,
|
|
78
90
|
path: "claims/medical",
|
|
@@ -83,8 +95,10 @@ Files::PartnerChannel.create(
|
|
|
83
95
|
### Parameters
|
|
84
96
|
|
|
85
97
|
* `from_partner_folder_name` (string): Optional Channel-level from-Partner folder name override.
|
|
98
|
+
* `from_partner_managed_folder_paths` (array(string)): Managed folder paths inside the from-Partner folder.
|
|
86
99
|
* `from_partner_route_path` (string): Optional route path for files uploaded by the Partner.
|
|
87
100
|
* `to_partner_folder_name` (string): Optional Channel-level to-Partner folder name override.
|
|
101
|
+
* `to_partner_managed_folder_paths` (array(string)): Managed folder paths inside the to-Partner folder.
|
|
88
102
|
* `to_partner_route_path` (string): Optional route path for files delivered to the Partner.
|
|
89
103
|
* `partner_id` (int64): Required - ID of the Partner this Channel belongs to.
|
|
90
104
|
* `path` (string): Required - Channel path relative to the Partner root folder.
|
|
@@ -98,8 +112,10 @@ Files::PartnerChannel.create(
|
|
|
98
112
|
```
|
|
99
113
|
Files::PartnerChannel.update(id,
|
|
100
114
|
from_partner_folder_name: "incoming",
|
|
115
|
+
from_partner_managed_folder_paths: ["claims/received"],
|
|
101
116
|
from_partner_route_path: "processing/from-partner",
|
|
102
117
|
to_partner_folder_name: "outgoing",
|
|
118
|
+
to_partner_managed_folder_paths: ["reports/monthly"],
|
|
103
119
|
to_partner_route_path: "delivery/to-partner",
|
|
104
120
|
path: "claims/medical"
|
|
105
121
|
)
|
|
@@ -109,8 +125,10 @@ Files::PartnerChannel.update(id,
|
|
|
109
125
|
|
|
110
126
|
* `id` (int64): Required - Partner Channel ID.
|
|
111
127
|
* `from_partner_folder_name` (string): Optional Channel-level from-Partner folder name override.
|
|
128
|
+
* `from_partner_managed_folder_paths` (array(string)): Managed folder paths inside the from-Partner folder.
|
|
112
129
|
* `from_partner_route_path` (string): Optional route path for files uploaded by the Partner.
|
|
113
130
|
* `to_partner_folder_name` (string): Optional Channel-level to-Partner folder name override.
|
|
131
|
+
* `to_partner_managed_folder_paths` (array(string)): Managed folder paths inside the to-Partner folder.
|
|
114
132
|
* `to_partner_route_path` (string): Optional route path for files delivered to the Partner.
|
|
115
133
|
* `path` (string): Channel path relative to the Partner root folder.
|
|
116
134
|
|
|
@@ -137,8 +155,10 @@ partner_channel = Files::PartnerChannel.find(id)
|
|
|
137
155
|
|
|
138
156
|
partner_channel.update(
|
|
139
157
|
from_partner_folder_name: "incoming",
|
|
158
|
+
from_partner_managed_folder_paths: ["claims/received"],
|
|
140
159
|
from_partner_route_path: "processing/from-partner",
|
|
141
160
|
to_partner_folder_name: "outgoing",
|
|
161
|
+
to_partner_managed_folder_paths: ["reports/monthly"],
|
|
142
162
|
to_partner_route_path: "delivery/to-partner",
|
|
143
163
|
path: "claims/medical"
|
|
144
164
|
)
|
|
@@ -148,8 +168,10 @@ partner_channel.update(
|
|
|
148
168
|
|
|
149
169
|
* `id` (int64): Required - Partner Channel ID.
|
|
150
170
|
* `from_partner_folder_name` (string): Optional Channel-level from-Partner folder name override.
|
|
171
|
+
* `from_partner_managed_folder_paths` (array(string)): Managed folder paths inside the from-Partner folder.
|
|
151
172
|
* `from_partner_route_path` (string): Optional route path for files uploaded by the Partner.
|
|
152
173
|
* `to_partner_folder_name` (string): Optional Channel-level to-Partner folder name override.
|
|
174
|
+
* `to_partner_managed_folder_paths` (array(string)): Managed folder paths inside the to-Partner folder.
|
|
153
175
|
* `to_partner_route_path` (string): Optional route path for files delivered to the Partner.
|
|
154
176
|
* `path` (string): Channel path relative to the Partner root folder.
|
|
155
177
|
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
# PartnerChannelTemplate
|
|
2
|
+
|
|
3
|
+
## Example PartnerChannelTemplate Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"workspace_id": 1,
|
|
9
|
+
"name": "Claims Template",
|
|
10
|
+
"path": "claims/medical",
|
|
11
|
+
"to_partner_folder_name": "outgoing",
|
|
12
|
+
"from_partner_folder_name": "incoming",
|
|
13
|
+
"from_partner_route_path": "processing/from-partner",
|
|
14
|
+
"to_partner_route_path": "delivery/to-partner",
|
|
15
|
+
"to_partner_managed_folder_paths": [
|
|
16
|
+
"reports/monthly"
|
|
17
|
+
],
|
|
18
|
+
"from_partner_managed_folder_paths": [
|
|
19
|
+
"claims/received"
|
|
20
|
+
],
|
|
21
|
+
"effective_to_partner_folder_name": "outgoing",
|
|
22
|
+
"effective_from_partner_folder_name": "incoming"
|
|
23
|
+
}
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
* `id` (int64): The unique ID of the Partner Channel Template.
|
|
27
|
+
* `workspace_id` (int64): ID of the Workspace associated with this Partner Channel Template.
|
|
28
|
+
* `name` (string): The name of the Partner Channel Template.
|
|
29
|
+
* `path` (string): Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
30
|
+
* `to_partner_folder_name` (string): Optional Channel-level to-Partner folder name override.
|
|
31
|
+
* `from_partner_folder_name` (string): Optional Channel-level from-Partner folder name override.
|
|
32
|
+
* `from_partner_route_path` (string): Optional route path for files uploaded by the Partner.
|
|
33
|
+
* `to_partner_route_path` (string): Optional route path for files delivered to the Partner.
|
|
34
|
+
* `to_partner_managed_folder_paths` (array(string)): Managed folder paths inside the to-Partner folder.
|
|
35
|
+
* `from_partner_managed_folder_paths` (array(string)): Managed folder paths inside the from-Partner folder.
|
|
36
|
+
* `effective_to_partner_folder_name` (string): Resolved to-Partner folder name after Template override and default.
|
|
37
|
+
* `effective_from_partner_folder_name` (string): Resolved from-Partner folder name after Template override and default.
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## List Partner Channel Templates
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
Files::PartnerChannelTemplate.list
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Parameters
|
|
49
|
+
|
|
50
|
+
* `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.
|
|
51
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
52
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
|
|
53
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Show Partner Channel Template
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
Files::PartnerChannelTemplate.find(id)
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
* `id` (int64): Required - Partner Channel Template ID.
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## Create Partner Channel Template
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
Files::PartnerChannelTemplate.create(
|
|
75
|
+
from_partner_folder_name: "incoming",
|
|
76
|
+
from_partner_managed_folder_paths: ["claims/received"],
|
|
77
|
+
from_partner_route_path: "processing/from-partner",
|
|
78
|
+
to_partner_folder_name: "outgoing",
|
|
79
|
+
to_partner_managed_folder_paths: ["reports/monthly"],
|
|
80
|
+
to_partner_route_path: "delivery/to-partner",
|
|
81
|
+
name: "Claims Template",
|
|
82
|
+
path: "claims/medical",
|
|
83
|
+
workspace_id: 0
|
|
84
|
+
)
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Parameters
|
|
88
|
+
|
|
89
|
+
* `from_partner_folder_name` (string): Optional Channel-level from-Partner folder name override.
|
|
90
|
+
* `from_partner_managed_folder_paths` (array(string)): Managed folder paths inside the from-Partner folder.
|
|
91
|
+
* `from_partner_route_path` (string): Optional route path for files uploaded by the Partner.
|
|
92
|
+
* `to_partner_folder_name` (string): Optional Channel-level to-Partner folder name override.
|
|
93
|
+
* `to_partner_managed_folder_paths` (array(string)): Managed folder paths inside the to-Partner folder.
|
|
94
|
+
* `to_partner_route_path` (string): Optional route path for files delivered to the Partner.
|
|
95
|
+
* `name` (string): Required - The name of the Partner Channel Template.
|
|
96
|
+
* `path` (string): Required - Channel path relative to the Partner root folder.
|
|
97
|
+
* `workspace_id` (int64): ID of the Workspace associated with this Partner Channel Template.
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## Update Partner Channel Template
|
|
103
|
+
|
|
104
|
+
```
|
|
105
|
+
Files::PartnerChannelTemplate.update(id,
|
|
106
|
+
from_partner_folder_name: "incoming",
|
|
107
|
+
from_partner_managed_folder_paths: ["claims/received"],
|
|
108
|
+
from_partner_route_path: "processing/from-partner",
|
|
109
|
+
to_partner_folder_name: "outgoing",
|
|
110
|
+
to_partner_managed_folder_paths: ["reports/monthly"],
|
|
111
|
+
to_partner_route_path: "delivery/to-partner",
|
|
112
|
+
name: "Claims Template",
|
|
113
|
+
path: "claims/medical"
|
|
114
|
+
)
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### Parameters
|
|
118
|
+
|
|
119
|
+
* `id` (int64): Required - Partner Channel Template ID.
|
|
120
|
+
* `from_partner_folder_name` (string): Optional Channel-level from-Partner folder name override.
|
|
121
|
+
* `from_partner_managed_folder_paths` (array(string)): Managed folder paths inside the from-Partner folder.
|
|
122
|
+
* `from_partner_route_path` (string): Optional route path for files uploaded by the Partner.
|
|
123
|
+
* `to_partner_folder_name` (string): Optional Channel-level to-Partner folder name override.
|
|
124
|
+
* `to_partner_managed_folder_paths` (array(string)): Managed folder paths inside the to-Partner folder.
|
|
125
|
+
* `to_partner_route_path` (string): Optional route path for files delivered to the Partner.
|
|
126
|
+
* `name` (string): The name of the Partner Channel Template.
|
|
127
|
+
* `path` (string): Channel path relative to the Partner root folder.
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## Delete Partner Channel Template
|
|
133
|
+
|
|
134
|
+
```
|
|
135
|
+
Files::PartnerChannelTemplate.delete(id)
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Parameters
|
|
139
|
+
|
|
140
|
+
* `id` (int64): Required - Partner Channel Template ID.
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
## Update Partner Channel Template
|
|
146
|
+
|
|
147
|
+
```
|
|
148
|
+
partner_channel_template = Files::PartnerChannelTemplate.find(id)
|
|
149
|
+
|
|
150
|
+
partner_channel_template.update(
|
|
151
|
+
from_partner_folder_name: "incoming",
|
|
152
|
+
from_partner_managed_folder_paths: ["claims/received"],
|
|
153
|
+
from_partner_route_path: "processing/from-partner",
|
|
154
|
+
to_partner_folder_name: "outgoing",
|
|
155
|
+
to_partner_managed_folder_paths: ["reports/monthly"],
|
|
156
|
+
to_partner_route_path: "delivery/to-partner",
|
|
157
|
+
name: "Claims Template",
|
|
158
|
+
path: "claims/medical"
|
|
159
|
+
)
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Parameters
|
|
163
|
+
|
|
164
|
+
* `id` (int64): Required - Partner Channel Template ID.
|
|
165
|
+
* `from_partner_folder_name` (string): Optional Channel-level from-Partner folder name override.
|
|
166
|
+
* `from_partner_managed_folder_paths` (array(string)): Managed folder paths inside the from-Partner folder.
|
|
167
|
+
* `from_partner_route_path` (string): Optional route path for files uploaded by the Partner.
|
|
168
|
+
* `to_partner_folder_name` (string): Optional Channel-level to-Partner folder name override.
|
|
169
|
+
* `to_partner_managed_folder_paths` (array(string)): Managed folder paths inside the to-Partner folder.
|
|
170
|
+
* `to_partner_route_path` (string): Optional route path for files delivered to the Partner.
|
|
171
|
+
* `name` (string): The name of the Partner Channel Template.
|
|
172
|
+
* `path` (string): Channel path relative to the Partner root folder.
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## Delete Partner Channel Template
|
|
178
|
+
|
|
179
|
+
```
|
|
180
|
+
partner_channel_template = Files::PartnerChannelTemplate.find(id)
|
|
181
|
+
|
|
182
|
+
partner_channel_template.delete
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### Parameters
|
|
186
|
+
|
|
187
|
+
* `id` (int64): Required - Partner Channel Template ID.
|
|
@@ -117,6 +117,15 @@ module Files
|
|
|
117
117
|
@attributes[:partner_admin_ids] = value
|
|
118
118
|
end
|
|
119
119
|
|
|
120
|
+
# int64 - ID of the Partner Channel Template assigned to this Partner.
|
|
121
|
+
def partner_channel_template_id
|
|
122
|
+
@attributes[:partner_channel_template_id]
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
def partner_channel_template_id=(value)
|
|
126
|
+
@attributes[:partner_channel_template_id] = value
|
|
127
|
+
end
|
|
128
|
+
|
|
120
129
|
# string - This site's role in Partner Site relationships for this Partner. Can be `host`, `guest`, `host_and_guest`, or null.
|
|
121
130
|
def partnership_role
|
|
122
131
|
@attributes[:partnership_role]
|
|
@@ -180,6 +189,7 @@ module Files
|
|
|
180
189
|
# allow_user_creation - boolean - Allow Partner Admins to create users.
|
|
181
190
|
# cc_emails_to_responsible_party - boolean - When `true`, emails sent to Partner users are copied to the responsible User or Group.
|
|
182
191
|
# notes - string - Notes about this Partner.
|
|
192
|
+
# partner_channel_template_id - int64 - ID of the Partner Channel Template assigned to this Partner.
|
|
183
193
|
# responsible_group_id - int64 - ID of the Group responsible for this Partner.
|
|
184
194
|
# responsible_user_id - int64 - ID of the User responsible for this Partner.
|
|
185
195
|
# 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.
|
|
@@ -193,6 +203,7 @@ module Files
|
|
|
193
203
|
raise InvalidParameterError.new("Bad parameter: ai_assistant_personality_id must be an Integer") if params[:ai_assistant_personality_id] and !params[:ai_assistant_personality_id].is_a?(Integer)
|
|
194
204
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
|
|
195
205
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
206
|
+
raise InvalidParameterError.new("Bad parameter: partner_channel_template_id must be an Integer") if params[:partner_channel_template_id] and !params[:partner_channel_template_id].is_a?(Integer)
|
|
196
207
|
raise InvalidParameterError.new("Bad parameter: responsible_group_id must be an Integer") if params[:responsible_group_id] and !params[:responsible_group_id].is_a?(Integer)
|
|
197
208
|
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)
|
|
198
209
|
raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
|
|
@@ -274,6 +285,7 @@ module Files
|
|
|
274
285
|
# allow_user_creation - boolean - Allow Partner Admins to create users.
|
|
275
286
|
# cc_emails_to_responsible_party - boolean - When `true`, emails sent to Partner users are copied to the responsible User or Group.
|
|
276
287
|
# notes - string - Notes about this Partner.
|
|
288
|
+
# partner_channel_template_id - int64 - ID of the Partner Channel Template assigned to this Partner.
|
|
277
289
|
# responsible_group_id - int64 - ID of the Group responsible for this Partner.
|
|
278
290
|
# responsible_user_id - int64 - ID of the User responsible for this Partner.
|
|
279
291
|
# 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.
|
|
@@ -284,6 +296,7 @@ module Files
|
|
|
284
296
|
raise InvalidParameterError.new("Bad parameter: ai_assistant_personality_id must be an Integer") if params[:ai_assistant_personality_id] and !params[:ai_assistant_personality_id].is_a?(Integer)
|
|
285
297
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
|
|
286
298
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
299
|
+
raise InvalidParameterError.new("Bad parameter: partner_channel_template_id must be an Integer") if params[:partner_channel_template_id] and !params[:partner_channel_template_id].is_a?(Integer)
|
|
287
300
|
raise InvalidParameterError.new("Bad parameter: responsible_group_id must be an Integer") if params[:responsible_group_id] and !params[:responsible_group_id].is_a?(Integer)
|
|
288
301
|
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)
|
|
289
302
|
raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
|
|
@@ -306,6 +319,7 @@ module Files
|
|
|
306
319
|
# allow_user_creation - boolean - Allow Partner Admins to create users.
|
|
307
320
|
# cc_emails_to_responsible_party - boolean - When `true`, emails sent to Partner users are copied to the responsible User or Group.
|
|
308
321
|
# notes - string - Notes about this Partner.
|
|
322
|
+
# partner_channel_template_id - int64 - ID of the Partner Channel Template assigned to this Partner.
|
|
309
323
|
# responsible_group_id - int64 - ID of the Group responsible for this Partner.
|
|
310
324
|
# responsible_user_id - int64 - ID of the User responsible for this Partner.
|
|
311
325
|
# 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.
|
|
@@ -318,6 +332,7 @@ module Files
|
|
|
318
332
|
raise InvalidParameterError.new("Bad parameter: ai_assistant_personality_id must be an Integer") if params[:ai_assistant_personality_id] and !params[:ai_assistant_personality_id].is_a?(Integer)
|
|
319
333
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
|
|
320
334
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
335
|
+
raise InvalidParameterError.new("Bad parameter: partner_channel_template_id must be an Integer") if params[:partner_channel_template_id] and !params[:partner_channel_template_id].is_a?(Integer)
|
|
321
336
|
raise InvalidParameterError.new("Bad parameter: responsible_group_id must be an Integer") if params[:responsible_group_id] and !params[:responsible_group_id].is_a?(Integer)
|
|
322
337
|
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)
|
|
323
338
|
raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
|
|
@@ -36,6 +36,15 @@ module Files
|
|
|
36
36
|
@attributes[:partner_id] = value
|
|
37
37
|
end
|
|
38
38
|
|
|
39
|
+
# int64 - ID of the Partner Channel Template that manages this Channel, if any.
|
|
40
|
+
def partner_channel_template_id
|
|
41
|
+
@attributes[:partner_channel_template_id]
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
def partner_channel_template_id=(value)
|
|
45
|
+
@attributes[:partner_channel_template_id] = value
|
|
46
|
+
end
|
|
47
|
+
|
|
39
48
|
# string - Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
40
49
|
def path
|
|
41
50
|
@attributes[:path]
|
|
@@ -81,6 +90,24 @@ module Files
|
|
|
81
90
|
@attributes[:to_partner_route_path] = value
|
|
82
91
|
end
|
|
83
92
|
|
|
93
|
+
# array(string) - Managed folder paths inside the to-Partner folder.
|
|
94
|
+
def to_partner_managed_folder_paths
|
|
95
|
+
@attributes[:to_partner_managed_folder_paths]
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
def to_partner_managed_folder_paths=(value)
|
|
99
|
+
@attributes[:to_partner_managed_folder_paths] = value
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# array(string) - Managed folder paths inside the from-Partner folder.
|
|
103
|
+
def from_partner_managed_folder_paths
|
|
104
|
+
@attributes[:from_partner_managed_folder_paths]
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
def from_partner_managed_folder_paths=(value)
|
|
108
|
+
@attributes[:from_partner_managed_folder_paths] = value
|
|
109
|
+
end
|
|
110
|
+
|
|
84
111
|
# string - Resolved to-Partner folder name after Channel override and default.
|
|
85
112
|
def effective_to_partner_folder_name
|
|
86
113
|
@attributes[:effective_to_partner_folder_name]
|
|
@@ -128,8 +155,10 @@ module Files
|
|
|
128
155
|
|
|
129
156
|
# Parameters:
|
|
130
157
|
# from_partner_folder_name - string - Optional Channel-level from-Partner folder name override.
|
|
158
|
+
# from_partner_managed_folder_paths - array(string) - Managed folder paths inside the from-Partner folder.
|
|
131
159
|
# from_partner_route_path - string - Optional route path for files uploaded by the Partner.
|
|
132
160
|
# to_partner_folder_name - string - Optional Channel-level to-Partner folder name override.
|
|
161
|
+
# to_partner_managed_folder_paths - array(string) - Managed folder paths inside the to-Partner folder.
|
|
133
162
|
# to_partner_route_path - string - Optional route path for files delivered to the Partner.
|
|
134
163
|
# path - string - Channel path relative to the Partner root folder.
|
|
135
164
|
def update(params = {})
|
|
@@ -138,8 +167,10 @@ module Files
|
|
|
138
167
|
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
139
168
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
140
169
|
raise InvalidParameterError.new("Bad parameter: from_partner_folder_name must be an String") if params[:from_partner_folder_name] and !params[:from_partner_folder_name].is_a?(String)
|
|
170
|
+
raise InvalidParameterError.new("Bad parameter: from_partner_managed_folder_paths must be an Array") if params[:from_partner_managed_folder_paths] and !params[:from_partner_managed_folder_paths].is_a?(Array)
|
|
141
171
|
raise InvalidParameterError.new("Bad parameter: from_partner_route_path must be an String") if params[:from_partner_route_path] and !params[:from_partner_route_path].is_a?(String)
|
|
142
172
|
raise InvalidParameterError.new("Bad parameter: to_partner_folder_name must be an String") if params[:to_partner_folder_name] and !params[:to_partner_folder_name].is_a?(String)
|
|
173
|
+
raise InvalidParameterError.new("Bad parameter: to_partner_managed_folder_paths must be an Array") if params[:to_partner_managed_folder_paths] and !params[:to_partner_managed_folder_paths].is_a?(Array)
|
|
143
174
|
raise InvalidParameterError.new("Bad parameter: to_partner_route_path must be an String") if params[:to_partner_route_path] and !params[:to_partner_route_path].is_a?(String)
|
|
144
175
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
145
176
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
@@ -211,16 +242,20 @@ module Files
|
|
|
211
242
|
|
|
212
243
|
# Parameters:
|
|
213
244
|
# from_partner_folder_name - string - Optional Channel-level from-Partner folder name override.
|
|
245
|
+
# from_partner_managed_folder_paths - array(string) - Managed folder paths inside the from-Partner folder.
|
|
214
246
|
# from_partner_route_path - string - Optional route path for files uploaded by the Partner.
|
|
215
247
|
# to_partner_folder_name - string - Optional Channel-level to-Partner folder name override.
|
|
248
|
+
# to_partner_managed_folder_paths - array(string) - Managed folder paths inside the to-Partner folder.
|
|
216
249
|
# to_partner_route_path - string - Optional route path for files delivered to the Partner.
|
|
217
250
|
# partner_id (required) - int64 - ID of the Partner this Channel belongs to.
|
|
218
251
|
# path (required) - string - Channel path relative to the Partner root folder.
|
|
219
252
|
# workspace_id - int64 - ID of the Workspace associated with this Partner Channel.
|
|
220
253
|
def self.create(params = {}, options = {})
|
|
221
254
|
raise InvalidParameterError.new("Bad parameter: from_partner_folder_name must be an String") if params[:from_partner_folder_name] and !params[:from_partner_folder_name].is_a?(String)
|
|
255
|
+
raise InvalidParameterError.new("Bad parameter: from_partner_managed_folder_paths must be an Array") if params[:from_partner_managed_folder_paths] and !params[:from_partner_managed_folder_paths].is_a?(Array)
|
|
222
256
|
raise InvalidParameterError.new("Bad parameter: from_partner_route_path must be an String") if params[:from_partner_route_path] and !params[:from_partner_route_path].is_a?(String)
|
|
223
257
|
raise InvalidParameterError.new("Bad parameter: to_partner_folder_name must be an String") if params[:to_partner_folder_name] and !params[:to_partner_folder_name].is_a?(String)
|
|
258
|
+
raise InvalidParameterError.new("Bad parameter: to_partner_managed_folder_paths must be an Array") if params[:to_partner_managed_folder_paths] and !params[:to_partner_managed_folder_paths].is_a?(Array)
|
|
224
259
|
raise InvalidParameterError.new("Bad parameter: to_partner_route_path must be an String") if params[:to_partner_route_path] and !params[:to_partner_route_path].is_a?(String)
|
|
225
260
|
raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
|
|
226
261
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
@@ -234,8 +269,10 @@ module Files
|
|
|
234
269
|
|
|
235
270
|
# Parameters:
|
|
236
271
|
# from_partner_folder_name - string - Optional Channel-level from-Partner folder name override.
|
|
272
|
+
# from_partner_managed_folder_paths - array(string) - Managed folder paths inside the from-Partner folder.
|
|
237
273
|
# from_partner_route_path - string - Optional route path for files uploaded by the Partner.
|
|
238
274
|
# to_partner_folder_name - string - Optional Channel-level to-Partner folder name override.
|
|
275
|
+
# to_partner_managed_folder_paths - array(string) - Managed folder paths inside the to-Partner folder.
|
|
239
276
|
# to_partner_route_path - string - Optional route path for files delivered to the Partner.
|
|
240
277
|
# path - string - Channel path relative to the Partner root folder.
|
|
241
278
|
def self.update(id, params = {}, options = {})
|
|
@@ -243,8 +280,10 @@ module Files
|
|
|
243
280
|
params[:id] = id
|
|
244
281
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
245
282
|
raise InvalidParameterError.new("Bad parameter: from_partner_folder_name must be an String") if params[:from_partner_folder_name] and !params[:from_partner_folder_name].is_a?(String)
|
|
283
|
+
raise InvalidParameterError.new("Bad parameter: from_partner_managed_folder_paths must be an Array") if params[:from_partner_managed_folder_paths] and !params[:from_partner_managed_folder_paths].is_a?(Array)
|
|
246
284
|
raise InvalidParameterError.new("Bad parameter: from_partner_route_path must be an String") if params[:from_partner_route_path] and !params[:from_partner_route_path].is_a?(String)
|
|
247
285
|
raise InvalidParameterError.new("Bad parameter: to_partner_folder_name must be an String") if params[:to_partner_folder_name] and !params[:to_partner_folder_name].is_a?(String)
|
|
286
|
+
raise InvalidParameterError.new("Bad parameter: to_partner_managed_folder_paths must be an Array") if params[:to_partner_managed_folder_paths] and !params[:to_partner_managed_folder_paths].is_a?(Array)
|
|
248
287
|
raise InvalidParameterError.new("Bad parameter: to_partner_route_path must be an String") if params[:to_partner_route_path] and !params[:to_partner_route_path].is_a?(String)
|
|
249
288
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
250
289
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
@@ -0,0 +1,278 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Files
|
|
4
|
+
class PartnerChannelTemplate
|
|
5
|
+
attr_reader :options, :attributes
|
|
6
|
+
|
|
7
|
+
def initialize(attributes = {}, options = {})
|
|
8
|
+
@attributes = attributes || {}
|
|
9
|
+
@options = options || {}
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# int64 - The unique ID of the Partner Channel Template.
|
|
13
|
+
def id
|
|
14
|
+
@attributes[:id]
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
def id=(value)
|
|
18
|
+
@attributes[:id] = value
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
# int64 - ID of the Workspace associated with this Partner Channel Template.
|
|
22
|
+
def workspace_id
|
|
23
|
+
@attributes[:workspace_id]
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def workspace_id=(value)
|
|
27
|
+
@attributes[:workspace_id] = value
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
# string - The name of the Partner Channel Template.
|
|
31
|
+
def name
|
|
32
|
+
@attributes[:name]
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
def name=(value)
|
|
36
|
+
@attributes[:name] = value
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
# string - Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
40
|
+
def path
|
|
41
|
+
@attributes[:path]
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
def path=(value)
|
|
45
|
+
@attributes[:path] = value
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# string - Optional Channel-level to-Partner folder name override.
|
|
49
|
+
def to_partner_folder_name
|
|
50
|
+
@attributes[:to_partner_folder_name]
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
def to_partner_folder_name=(value)
|
|
54
|
+
@attributes[:to_partner_folder_name] = value
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# string - Optional Channel-level from-Partner folder name override.
|
|
58
|
+
def from_partner_folder_name
|
|
59
|
+
@attributes[:from_partner_folder_name]
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
def from_partner_folder_name=(value)
|
|
63
|
+
@attributes[:from_partner_folder_name] = value
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
# string - Optional route path for files uploaded by the Partner.
|
|
67
|
+
def from_partner_route_path
|
|
68
|
+
@attributes[:from_partner_route_path]
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
def from_partner_route_path=(value)
|
|
72
|
+
@attributes[:from_partner_route_path] = value
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# string - Optional route path for files delivered to the Partner.
|
|
76
|
+
def to_partner_route_path
|
|
77
|
+
@attributes[:to_partner_route_path]
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
def to_partner_route_path=(value)
|
|
81
|
+
@attributes[:to_partner_route_path] = value
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# array(string) - Managed folder paths inside the to-Partner folder.
|
|
85
|
+
def to_partner_managed_folder_paths
|
|
86
|
+
@attributes[:to_partner_managed_folder_paths]
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
def to_partner_managed_folder_paths=(value)
|
|
90
|
+
@attributes[:to_partner_managed_folder_paths] = value
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
# array(string) - Managed folder paths inside the from-Partner folder.
|
|
94
|
+
def from_partner_managed_folder_paths
|
|
95
|
+
@attributes[:from_partner_managed_folder_paths]
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
def from_partner_managed_folder_paths=(value)
|
|
99
|
+
@attributes[:from_partner_managed_folder_paths] = value
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# string - Resolved to-Partner folder name after Template override and default.
|
|
103
|
+
def effective_to_partner_folder_name
|
|
104
|
+
@attributes[:effective_to_partner_folder_name]
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
def effective_to_partner_folder_name=(value)
|
|
108
|
+
@attributes[:effective_to_partner_folder_name] = value
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
# string - Resolved from-Partner folder name after Template override and default.
|
|
112
|
+
def effective_from_partner_folder_name
|
|
113
|
+
@attributes[:effective_from_partner_folder_name]
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
def effective_from_partner_folder_name=(value)
|
|
117
|
+
@attributes[:effective_from_partner_folder_name] = value
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# Parameters:
|
|
121
|
+
# from_partner_folder_name - string - Optional Channel-level from-Partner folder name override.
|
|
122
|
+
# from_partner_managed_folder_paths - array(string) - Managed folder paths inside the from-Partner folder.
|
|
123
|
+
# from_partner_route_path - string - Optional route path for files uploaded by the Partner.
|
|
124
|
+
# to_partner_folder_name - string - Optional Channel-level to-Partner folder name override.
|
|
125
|
+
# to_partner_managed_folder_paths - array(string) - Managed folder paths inside the to-Partner folder.
|
|
126
|
+
# to_partner_route_path - string - Optional route path for files delivered to the Partner.
|
|
127
|
+
# name - string - The name of the Partner Channel Template.
|
|
128
|
+
# path - string - Channel path relative to the Partner root folder.
|
|
129
|
+
def update(params = {})
|
|
130
|
+
params ||= {}
|
|
131
|
+
params[:id] = @attributes[:id]
|
|
132
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
133
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
134
|
+
raise InvalidParameterError.new("Bad parameter: from_partner_folder_name must be an String") if params[:from_partner_folder_name] and !params[:from_partner_folder_name].is_a?(String)
|
|
135
|
+
raise InvalidParameterError.new("Bad parameter: from_partner_managed_folder_paths must be an Array") if params[:from_partner_managed_folder_paths] and !params[:from_partner_managed_folder_paths].is_a?(Array)
|
|
136
|
+
raise InvalidParameterError.new("Bad parameter: from_partner_route_path must be an String") if params[:from_partner_route_path] and !params[:from_partner_route_path].is_a?(String)
|
|
137
|
+
raise InvalidParameterError.new("Bad parameter: to_partner_folder_name must be an String") if params[:to_partner_folder_name] and !params[:to_partner_folder_name].is_a?(String)
|
|
138
|
+
raise InvalidParameterError.new("Bad parameter: to_partner_managed_folder_paths must be an Array") if params[:to_partner_managed_folder_paths] and !params[:to_partner_managed_folder_paths].is_a?(Array)
|
|
139
|
+
raise InvalidParameterError.new("Bad parameter: to_partner_route_path must be an String") if params[:to_partner_route_path] and !params[:to_partner_route_path].is_a?(String)
|
|
140
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
141
|
+
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
142
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
143
|
+
|
|
144
|
+
Api.send_request("/partner_channel_templates/#{@attributes[:id]}", :patch, params, @options)
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
def delete(params = {})
|
|
148
|
+
params ||= {}
|
|
149
|
+
params[:id] = @attributes[:id]
|
|
150
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
151
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
152
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
153
|
+
|
|
154
|
+
Api.send_request("/partner_channel_templates/#{@attributes[:id]}", :delete, params, @options)
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
def destroy(params = {})
|
|
158
|
+
delete(params)
|
|
159
|
+
nil
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
def save
|
|
163
|
+
if @attributes[:id]
|
|
164
|
+
new_obj = update(@attributes)
|
|
165
|
+
else
|
|
166
|
+
new_obj = PartnerChannelTemplate.create(@attributes, @options)
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
@attributes = new_obj.attributes
|
|
170
|
+
true
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
# Parameters:
|
|
174
|
+
# 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.
|
|
175
|
+
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
176
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
|
|
177
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
|
|
178
|
+
def self.list(params = {}, options = {})
|
|
179
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
180
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
181
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
182
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
183
|
+
|
|
184
|
+
List.new(PartnerChannelTemplate, params) do
|
|
185
|
+
Api.send_request("/partner_channel_templates", :get, params, options)
|
|
186
|
+
end
|
|
187
|
+
end
|
|
188
|
+
|
|
189
|
+
def self.all(params = {}, options = {})
|
|
190
|
+
list(params, options)
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
# Parameters:
|
|
194
|
+
# id (required) - int64 - Partner Channel Template ID.
|
|
195
|
+
def self.find(id, params = {}, options = {})
|
|
196
|
+
params ||= {}
|
|
197
|
+
params[:id] = id
|
|
198
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
199
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
200
|
+
|
|
201
|
+
response, options = Api.send_request("/partner_channel_templates/#{params[:id]}", :get, params, options)
|
|
202
|
+
PartnerChannelTemplate.new(response.data, options)
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
def self.get(id, params = {}, options = {})
|
|
206
|
+
find(id, params, options)
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
# Parameters:
|
|
210
|
+
# from_partner_folder_name - string - Optional Channel-level from-Partner folder name override.
|
|
211
|
+
# from_partner_managed_folder_paths - array(string) - Managed folder paths inside the from-Partner folder.
|
|
212
|
+
# from_partner_route_path - string - Optional route path for files uploaded by the Partner.
|
|
213
|
+
# to_partner_folder_name - string - Optional Channel-level to-Partner folder name override.
|
|
214
|
+
# to_partner_managed_folder_paths - array(string) - Managed folder paths inside the to-Partner folder.
|
|
215
|
+
# to_partner_route_path - string - Optional route path for files delivered to the Partner.
|
|
216
|
+
# name (required) - string - The name of the Partner Channel Template.
|
|
217
|
+
# path (required) - string - Channel path relative to the Partner root folder.
|
|
218
|
+
# workspace_id - int64 - ID of the Workspace associated with this Partner Channel Template.
|
|
219
|
+
def self.create(params = {}, options = {})
|
|
220
|
+
raise InvalidParameterError.new("Bad parameter: from_partner_folder_name must be an String") if params[:from_partner_folder_name] and !params[:from_partner_folder_name].is_a?(String)
|
|
221
|
+
raise InvalidParameterError.new("Bad parameter: from_partner_managed_folder_paths must be an Array") if params[:from_partner_managed_folder_paths] and !params[:from_partner_managed_folder_paths].is_a?(Array)
|
|
222
|
+
raise InvalidParameterError.new("Bad parameter: from_partner_route_path must be an String") if params[:from_partner_route_path] and !params[:from_partner_route_path].is_a?(String)
|
|
223
|
+
raise InvalidParameterError.new("Bad parameter: to_partner_folder_name must be an String") if params[:to_partner_folder_name] and !params[:to_partner_folder_name].is_a?(String)
|
|
224
|
+
raise InvalidParameterError.new("Bad parameter: to_partner_managed_folder_paths must be an Array") if params[:to_partner_managed_folder_paths] and !params[:to_partner_managed_folder_paths].is_a?(Array)
|
|
225
|
+
raise InvalidParameterError.new("Bad parameter: to_partner_route_path must be an String") if params[:to_partner_route_path] and !params[:to_partner_route_path].is_a?(String)
|
|
226
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
227
|
+
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
228
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
229
|
+
raise MissingParameterError.new("Parameter missing: name") unless params[:name]
|
|
230
|
+
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
|
231
|
+
|
|
232
|
+
response, options = Api.send_request("/partner_channel_templates", :post, params, options)
|
|
233
|
+
PartnerChannelTemplate.new(response.data, options)
|
|
234
|
+
end
|
|
235
|
+
|
|
236
|
+
# Parameters:
|
|
237
|
+
# from_partner_folder_name - string - Optional Channel-level from-Partner folder name override.
|
|
238
|
+
# from_partner_managed_folder_paths - array(string) - Managed folder paths inside the from-Partner folder.
|
|
239
|
+
# from_partner_route_path - string - Optional route path for files uploaded by the Partner.
|
|
240
|
+
# to_partner_folder_name - string - Optional Channel-level to-Partner folder name override.
|
|
241
|
+
# to_partner_managed_folder_paths - array(string) - Managed folder paths inside the to-Partner folder.
|
|
242
|
+
# to_partner_route_path - string - Optional route path for files delivered to the Partner.
|
|
243
|
+
# name - string - The name of the Partner Channel Template.
|
|
244
|
+
# path - string - Channel path relative to the Partner root folder.
|
|
245
|
+
def self.update(id, params = {}, options = {})
|
|
246
|
+
params ||= {}
|
|
247
|
+
params[:id] = id
|
|
248
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
249
|
+
raise InvalidParameterError.new("Bad parameter: from_partner_folder_name must be an String") if params[:from_partner_folder_name] and !params[:from_partner_folder_name].is_a?(String)
|
|
250
|
+
raise InvalidParameterError.new("Bad parameter: from_partner_managed_folder_paths must be an Array") if params[:from_partner_managed_folder_paths] and !params[:from_partner_managed_folder_paths].is_a?(Array)
|
|
251
|
+
raise InvalidParameterError.new("Bad parameter: from_partner_route_path must be an String") if params[:from_partner_route_path] and !params[:from_partner_route_path].is_a?(String)
|
|
252
|
+
raise InvalidParameterError.new("Bad parameter: to_partner_folder_name must be an String") if params[:to_partner_folder_name] and !params[:to_partner_folder_name].is_a?(String)
|
|
253
|
+
raise InvalidParameterError.new("Bad parameter: to_partner_managed_folder_paths must be an Array") if params[:to_partner_managed_folder_paths] and !params[:to_partner_managed_folder_paths].is_a?(Array)
|
|
254
|
+
raise InvalidParameterError.new("Bad parameter: to_partner_route_path must be an String") if params[:to_partner_route_path] and !params[:to_partner_route_path].is_a?(String)
|
|
255
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
256
|
+
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
257
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
258
|
+
|
|
259
|
+
response, options = Api.send_request("/partner_channel_templates/#{params[:id]}", :patch, params, options)
|
|
260
|
+
PartnerChannelTemplate.new(response.data, options)
|
|
261
|
+
end
|
|
262
|
+
|
|
263
|
+
def self.delete(id, params = {}, options = {})
|
|
264
|
+
params ||= {}
|
|
265
|
+
params[:id] = id
|
|
266
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
267
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
268
|
+
|
|
269
|
+
Api.send_request("/partner_channel_templates/#{params[:id]}", :delete, params, options)
|
|
270
|
+
nil
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
def self.destroy(id, params = {}, options = {})
|
|
274
|
+
delete(id, params, options)
|
|
275
|
+
nil
|
|
276
|
+
end
|
|
277
|
+
end
|
|
278
|
+
end
|
data/lib/files.com/version.rb
CHANGED
data/lib/files.com.rb
CHANGED
|
@@ -117,6 +117,7 @@ require "files.com/models/notification"
|
|
|
117
117
|
require "files.com/models/outbound_connection_log"
|
|
118
118
|
require "files.com/models/partner"
|
|
119
119
|
require "files.com/models/partner_channel"
|
|
120
|
+
require "files.com/models/partner_channel_template"
|
|
120
121
|
require "files.com/models/partner_site"
|
|
121
122
|
require "files.com/models/partner_site_request"
|
|
122
123
|
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.675
|
|
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-07-
|
|
11
|
+
date: 2026-07-09 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: addressable
|
|
@@ -256,6 +256,7 @@ files:
|
|
|
256
256
|
- docs/outbound_connection_log.md
|
|
257
257
|
- docs/partner.md
|
|
258
258
|
- docs/partner_channel.md
|
|
259
|
+
- docs/partner_channel_template.md
|
|
259
260
|
- docs/partner_site.md
|
|
260
261
|
- docs/partner_site_request.md
|
|
261
262
|
- docs/payment.md
|
|
@@ -402,6 +403,7 @@ files:
|
|
|
402
403
|
- lib/files.com/models/outbound_connection_log.rb
|
|
403
404
|
- lib/files.com/models/partner.rb
|
|
404
405
|
- lib/files.com/models/partner_channel.rb
|
|
406
|
+
- lib/files.com/models/partner_channel_template.rb
|
|
405
407
|
- lib/files.com/models/partner_site.rb
|
|
406
408
|
- lib/files.com/models/partner_site_request.rb
|
|
407
409
|
- lib/files.com/models/payment.rb
|