files.com 1.1.673 → 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/behavior.md +2 -0
- data/docs/custom_domain.md +8 -8
- data/docs/partner.md +8 -0
- data/docs/partner_channel.md +22 -0
- data/docs/partner_channel_template.md +187 -0
- data/docs/secret.md +158 -0
- data/lib/files.com/models/behavior.rb +9 -0
- data/lib/files.com/models/custom_domain.rb +8 -8
- 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/models/secret.rb +220 -0
- data/lib/files.com/version.rb +1 -1
- 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: 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/behavior.md
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
"value": {
|
|
14
14
|
"method": "GET"
|
|
15
15
|
},
|
|
16
|
+
"public_hosting_url": "example",
|
|
16
17
|
"disable_parent_folder_behavior": true,
|
|
17
18
|
"recursive": true
|
|
18
19
|
}
|
|
@@ -25,6 +26,7 @@
|
|
|
25
26
|
* `name` (string): Name for this behavior.
|
|
26
27
|
* `description` (string): Description for this behavior.
|
|
27
28
|
* `value` (object): Settings for this behavior. See the section above for an example value to provide here. Formatting is different for each Behavior type. May be sent as nested JSON or a single JSON-encoded string. If using XML encoding for the API call, this data must be sent as a JSON-encoded string.
|
|
29
|
+
* `public_hosting_url` (string): Public URL for this publicly hosted folder when the `Serve Publicly` behavior has a key configured. When a Custom Domain with `public_hosting` destination is attached to this behavior, the URL uses that domain. Otherwise it uses the site's `subdomain.hosted-by-files.com` host.
|
|
28
30
|
* `disable_parent_folder_behavior` (boolean): If true, the parent folder's behavior will be disabled for this folder and its children.
|
|
29
31
|
* `recursive` (boolean): Whether this behavior is recursive for this record. `always` behaviors are always `true`, `never` behaviors are always `false`, and `sometimes` behaviors may be either value.
|
|
30
32
|
* `attachment_file` (file): Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
|
data/docs/custom_domain.md
CHANGED
|
@@ -18,11 +18,11 @@
|
|
|
18
18
|
|
|
19
19
|
* `id` (int64): Custom Domain ID.
|
|
20
20
|
* `domain` (string): Customer-owned domain name.
|
|
21
|
-
* `destination` (string): Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `
|
|
21
|
+
* `destination` (string): Where this custom domain routes. Can be `site_alias`, `public_hosting`, `s3_endpoint`, or `unassigned` (not routing traffic). Set to `unassigned` automatically when a bound `public_hosting` folder behavior is deleted, and can be set manually via the API for any reason.
|
|
22
22
|
* `dns_status` (string): Current DNS verification status.
|
|
23
23
|
* `ssl_certificate_id` (int64): Current SSL certificate ID.
|
|
24
24
|
* `brick_managed` (boolean): Is this domain's SSL certificate automatically managed and renewed by Files.com?
|
|
25
|
-
* `folder_behavior_id` (int64): Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
|
|
25
|
+
* `folder_behavior_id` (int64): Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when `destination` becomes `unassigned`.
|
|
26
26
|
* `created_at` (date-time): When this Custom Domain was created.
|
|
27
27
|
* `updated_at` (date-time): When this Custom Domain was last updated.
|
|
28
28
|
|
|
@@ -70,8 +70,8 @@ Files::CustomDomain.create(
|
|
|
70
70
|
|
|
71
71
|
### Parameters
|
|
72
72
|
|
|
73
|
-
* `destination` (string): Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `
|
|
74
|
-
* `folder_behavior_id` (int64): Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
|
|
73
|
+
* `destination` (string): Where this custom domain routes. Can be `site_alias`, `public_hosting`, `s3_endpoint`, or `unassigned` (not routing traffic). Set to `unassigned` automatically when a bound `public_hosting` folder behavior is deleted, and can be set manually via the API for any reason.
|
|
74
|
+
* `folder_behavior_id` (int64): Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when `destination` becomes `unassigned`.
|
|
75
75
|
* `ssl_certificate_id` (int64): Current SSL certificate ID.
|
|
76
76
|
* `domain` (string): Required - Customer-owned domain name.
|
|
77
77
|
|
|
@@ -92,8 +92,8 @@ Files::CustomDomain.update(id,
|
|
|
92
92
|
### Parameters
|
|
93
93
|
|
|
94
94
|
* `id` (int64): Required - Custom Domain ID.
|
|
95
|
-
* `destination` (string): Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `
|
|
96
|
-
* `folder_behavior_id` (int64): Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
|
|
95
|
+
* `destination` (string): Where this custom domain routes. Can be `site_alias`, `public_hosting`, `s3_endpoint`, or `unassigned` (not routing traffic). Set to `unassigned` automatically when a bound `public_hosting` folder behavior is deleted, and can be set manually via the API for any reason.
|
|
96
|
+
* `folder_behavior_id` (int64): Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when `destination` becomes `unassigned`.
|
|
97
97
|
* `ssl_certificate_id` (int64): Current SSL certificate ID.
|
|
98
98
|
* `domain` (string): Customer-owned domain name.
|
|
99
99
|
|
|
@@ -129,8 +129,8 @@ custom_domain.update(
|
|
|
129
129
|
### Parameters
|
|
130
130
|
|
|
131
131
|
* `id` (int64): Required - Custom Domain ID.
|
|
132
|
-
* `destination` (string): Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `
|
|
133
|
-
* `folder_behavior_id` (int64): Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
|
|
132
|
+
* `destination` (string): Where this custom domain routes. Can be `site_alias`, `public_hosting`, `s3_endpoint`, or `unassigned` (not routing traffic). Set to `unassigned` automatically when a bound `public_hosting` folder behavior is deleted, and can be set manually via the API for any reason.
|
|
133
|
+
* `folder_behavior_id` (int64): Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when `destination` becomes `unassigned`.
|
|
134
134
|
* `ssl_certificate_id` (int64): Current SSL certificate ID.
|
|
135
135
|
* `domain` (string): Customer-owned domain name.
|
|
136
136
|
|
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.
|
data/docs/secret.md
ADDED
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
# Secret
|
|
2
|
+
|
|
3
|
+
## Example Secret Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"workspace_id": 1,
|
|
9
|
+
"name": "Production API token",
|
|
10
|
+
"description": "Used by production API integrations.",
|
|
11
|
+
"secret_type": "token",
|
|
12
|
+
"metadata": {
|
|
13
|
+
"key": "example value"
|
|
14
|
+
},
|
|
15
|
+
"value_field_names": [
|
|
16
|
+
"example"
|
|
17
|
+
],
|
|
18
|
+
"created_at": "2000-01-01T01:00:00Z",
|
|
19
|
+
"updated_at": "2000-01-01T01:00:00Z"
|
|
20
|
+
}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
* `id` (int64): Secret ID.
|
|
24
|
+
* `workspace_id` (int64): Workspace ID. 0 means the default workspace.
|
|
25
|
+
* `name` (string): Secret name.
|
|
26
|
+
* `description` (string): Internal description for your reference.
|
|
27
|
+
* `secret_type` (string): Secret type.
|
|
28
|
+
* `metadata` (object): Non-secret metadata for the Secret type.
|
|
29
|
+
* `value_field_names` (array(string)): Names of configured secret value fields. Secret values are never returned.
|
|
30
|
+
* `created_at` (date-time): Secret create date/time.
|
|
31
|
+
* `updated_at` (date-time): Secret update date/time.
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## List Secrets
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
Files::Secret.list
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Parameters
|
|
43
|
+
|
|
44
|
+
* `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.
|
|
45
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
46
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name` or `secret_type`.
|
|
47
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`, `name` or `secret_type`. Valid field combinations are `[ workspace_id, name ]`, `[ workspace_id, secret_type ]`, `[ secret_type, name ]` or `[ workspace_id, secret_type, name ]`.
|
|
48
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Show Secret
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
Files::Secret.find(id)
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Parameters
|
|
60
|
+
|
|
61
|
+
* `id` (int64): Required - Secret ID.
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## Create Secret
|
|
67
|
+
|
|
68
|
+
```
|
|
69
|
+
Files::Secret.create(
|
|
70
|
+
name: "Production API token",
|
|
71
|
+
description: "Used by production API integrations.",
|
|
72
|
+
secret_type: "token",
|
|
73
|
+
metadata: {"key":"example value"},
|
|
74
|
+
workspace_id: 0
|
|
75
|
+
)
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Parameters
|
|
79
|
+
|
|
80
|
+
* `name` (string): Required - Secret name.
|
|
81
|
+
* `description` (string): Internal description for your reference.
|
|
82
|
+
* `secret_type` (string): Required - Secret type.
|
|
83
|
+
* `metadata` (object): Non-secret metadata for the Secret type.
|
|
84
|
+
* `workspace_id` (int64): Workspace ID. 0 means the default workspace.
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## Update Secret
|
|
90
|
+
|
|
91
|
+
```
|
|
92
|
+
Files::Secret.update(id,
|
|
93
|
+
name: "Production API token",
|
|
94
|
+
description: "Used by production API integrations.",
|
|
95
|
+
secret_type: "token",
|
|
96
|
+
metadata: {"key":"example value"}
|
|
97
|
+
)
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Parameters
|
|
101
|
+
|
|
102
|
+
* `id` (int64): Required - Secret ID.
|
|
103
|
+
* `name` (string): Secret name.
|
|
104
|
+
* `description` (string): Internal description for your reference.
|
|
105
|
+
* `secret_type` (string): Secret type.
|
|
106
|
+
* `metadata` (object): Non-secret metadata for the Secret type.
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
111
|
+
## Delete Secret
|
|
112
|
+
|
|
113
|
+
```
|
|
114
|
+
Files::Secret.delete(id)
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### Parameters
|
|
118
|
+
|
|
119
|
+
* `id` (int64): Required - Secret ID.
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## Update Secret
|
|
125
|
+
|
|
126
|
+
```
|
|
127
|
+
secret = Files::Secret.find(id)
|
|
128
|
+
|
|
129
|
+
secret.update(
|
|
130
|
+
name: "Production API token",
|
|
131
|
+
description: "Used by production API integrations.",
|
|
132
|
+
secret_type: "token",
|
|
133
|
+
metadata: {"key":"example value"}
|
|
134
|
+
)
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Parameters
|
|
138
|
+
|
|
139
|
+
* `id` (int64): Required - Secret ID.
|
|
140
|
+
* `name` (string): Secret name.
|
|
141
|
+
* `description` (string): Internal description for your reference.
|
|
142
|
+
* `secret_type` (string): Secret type.
|
|
143
|
+
* `metadata` (object): Non-secret metadata for the Secret type.
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Delete Secret
|
|
149
|
+
|
|
150
|
+
```
|
|
151
|
+
secret = Files::Secret.find(id)
|
|
152
|
+
|
|
153
|
+
secret.delete
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### Parameters
|
|
157
|
+
|
|
158
|
+
* `id` (int64): Required - Secret ID.
|
|
@@ -72,6 +72,15 @@ module Files
|
|
|
72
72
|
@attributes[:value] = value
|
|
73
73
|
end
|
|
74
74
|
|
|
75
|
+
# string - Public URL for this publicly hosted folder when the `Serve Publicly` behavior has a key configured. When a Custom Domain with `public_hosting` destination is attached to this behavior, the URL uses that domain. Otherwise it uses the site's `subdomain.hosted-by-files.com` host.
|
|
76
|
+
def public_hosting_url
|
|
77
|
+
@attributes[:public_hosting_url]
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
def public_hosting_url=(value)
|
|
81
|
+
@attributes[:public_hosting_url] = value
|
|
82
|
+
end
|
|
83
|
+
|
|
75
84
|
# boolean - If true, the parent folder's behavior will be disabled for this folder and its children.
|
|
76
85
|
def disable_parent_folder_behavior
|
|
77
86
|
@attributes[:disable_parent_folder_behavior]
|
|
@@ -27,7 +27,7 @@ module Files
|
|
|
27
27
|
@attributes[:domain] = value
|
|
28
28
|
end
|
|
29
29
|
|
|
30
|
-
# string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `
|
|
30
|
+
# string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, `s3_endpoint`, or `unassigned` (not routing traffic). Set to `unassigned` automatically when a bound `public_hosting` folder behavior is deleted, and can be set manually via the API for any reason.
|
|
31
31
|
def destination
|
|
32
32
|
@attributes[:destination]
|
|
33
33
|
end
|
|
@@ -63,7 +63,7 @@ module Files
|
|
|
63
63
|
@attributes[:brick_managed] = value
|
|
64
64
|
end
|
|
65
65
|
|
|
66
|
-
# int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
|
|
66
|
+
# int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when `destination` becomes `unassigned`.
|
|
67
67
|
def folder_behavior_id
|
|
68
68
|
@attributes[:folder_behavior_id]
|
|
69
69
|
end
|
|
@@ -83,8 +83,8 @@ module Files
|
|
|
83
83
|
end
|
|
84
84
|
|
|
85
85
|
# Parameters:
|
|
86
|
-
# destination - string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `
|
|
87
|
-
# folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
|
|
86
|
+
# destination - string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, `s3_endpoint`, or `unassigned` (not routing traffic). Set to `unassigned` automatically when a bound `public_hosting` folder behavior is deleted, and can be set manually via the API for any reason.
|
|
87
|
+
# folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when `destination` becomes `unassigned`.
|
|
88
88
|
# ssl_certificate_id - int64 - Current SSL certificate ID.
|
|
89
89
|
# domain - string - Customer-owned domain name.
|
|
90
90
|
def update(params = {})
|
|
@@ -162,8 +162,8 @@ module Files
|
|
|
162
162
|
end
|
|
163
163
|
|
|
164
164
|
# Parameters:
|
|
165
|
-
# destination - string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `
|
|
166
|
-
# folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
|
|
165
|
+
# destination - string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, `s3_endpoint`, or `unassigned` (not routing traffic). Set to `unassigned` automatically when a bound `public_hosting` folder behavior is deleted, and can be set manually via the API for any reason.
|
|
166
|
+
# folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when `destination` becomes `unassigned`.
|
|
167
167
|
# ssl_certificate_id - int64 - Current SSL certificate ID.
|
|
168
168
|
# domain (required) - string - Customer-owned domain name.
|
|
169
169
|
def self.create(params = {}, options = {})
|
|
@@ -178,8 +178,8 @@ module Files
|
|
|
178
178
|
end
|
|
179
179
|
|
|
180
180
|
# Parameters:
|
|
181
|
-
# destination - string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `
|
|
182
|
-
# folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
|
|
181
|
+
# destination - string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, `s3_endpoint`, or `unassigned` (not routing traffic). Set to `unassigned` automatically when a bound `public_hosting` folder behavior is deleted, and can be set manually via the API for any reason.
|
|
182
|
+
# folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when `destination` becomes `unassigned`.
|
|
183
183
|
# ssl_certificate_id - int64 - Current SSL certificate ID.
|
|
184
184
|
# domain - string - Customer-owned domain name.
|
|
185
185
|
def self.update(id, params = {}, options = {})
|