files.com 1.1.651 → 1.1.653
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/group_user.md +2 -2
- data/docs/partner_channel.md +169 -0
- data/lib/files.com/models/group_user.rb +5 -5
- data/lib/files.com/models/partner_channel.rb +271 -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: c2e36b101c4d21ae256d24d2887bf8f6798707943308048a21a9b7c88f012e0a
|
|
4
|
+
data.tar.gz: 117418e3ba486489ae693ccae1c9ea3dda2403dd34d53bf3b530aab682f1993b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7ba1e5f2ada24e0c0256653e69bf8aca3ab8fd5f6a80d041963419d4fe21b22913e82fadfd40bb5fc031e5d97fe1416cc0a4de79a810514f59d01ac84a264175
|
|
7
|
+
data.tar.gz: 2fcb51b1b65cf6966a1551c69dabb834e95743aa8a7df764cad305b6bf2c00a5e3b0faa2d868885974e743d9720242aceba4c74eab1d76438548495b04fbb38a
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.653
|
data/docs/group_user.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"group_id": 1,
|
|
9
9
|
"user_id": 1,
|
|
10
10
|
"admin": true,
|
|
11
|
-
"
|
|
11
|
+
"username": "example"
|
|
12
12
|
}
|
|
13
13
|
```
|
|
14
14
|
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
* `group_id` (int64): Group ID
|
|
17
17
|
* `user_id` (int64): User ID
|
|
18
18
|
* `admin` (boolean): Is this user an administrator of this group?
|
|
19
|
-
* `
|
|
19
|
+
* `username` (string): Username of the user
|
|
20
20
|
* `id` (int64): Group User ID.
|
|
21
21
|
|
|
22
22
|
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# PartnerChannel
|
|
2
|
+
|
|
3
|
+
## Example PartnerChannel Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"workspace_id": 1,
|
|
9
|
+
"partner_id": 1,
|
|
10
|
+
"path": "claims/medical",
|
|
11
|
+
"to_partner_folder_name": "incoming",
|
|
12
|
+
"from_partner_folder_name": "outgoing",
|
|
13
|
+
"from_partner_route_path": "processing/from-partner",
|
|
14
|
+
"to_partner_route_path": "delivery/to-partner",
|
|
15
|
+
"effective_to_partner_folder_name": "incoming",
|
|
16
|
+
"effective_from_partner_folder_name": "outgoing",
|
|
17
|
+
"channel_path": "partners/acme/claims/medical",
|
|
18
|
+
"to_partner_folder_path": "partners/acme/claims/medical/incoming",
|
|
19
|
+
"from_partner_folder_path": "partners/acme/claims/medical/outgoing"
|
|
20
|
+
}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
* `id` (int64): The unique ID of the Partner Channel.
|
|
24
|
+
* `workspace_id` (int64): ID of the Workspace associated with this Partner Channel.
|
|
25
|
+
* `partner_id` (int64): ID of the Partner this Channel belongs to.
|
|
26
|
+
* `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
|
+
* `to_partner_folder_name` (string): Optional Channel-level to-Partner folder name override.
|
|
28
|
+
* `from_partner_folder_name` (string): Optional Channel-level from-Partner folder name override.
|
|
29
|
+
* `from_partner_route_path` (string): Optional route path for files uploaded by the Partner.
|
|
30
|
+
* `to_partner_route_path` (string): Optional route path for files delivered to the Partner.
|
|
31
|
+
* `effective_to_partner_folder_name` (string): Resolved to-Partner folder name after Channel override and default.
|
|
32
|
+
* `effective_from_partner_folder_name` (string): Resolved from-Partner folder name after Channel override and default.
|
|
33
|
+
* `channel_path` (string): Resolved Channel folder path.
|
|
34
|
+
* `to_partner_folder_path` (string): Resolved to-Partner folder path.
|
|
35
|
+
* `from_partner_folder_path` (string): Resolved from-Partner folder path.
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## List Partner Channels
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
Files::PartnerChannel.list
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Parameters
|
|
47
|
+
|
|
48
|
+
* `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.
|
|
49
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
50
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `path` or `partner_id`.
|
|
51
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `partner_id` and `workspace_id`. Valid field combinations are `[ workspace_id, partner_id ]`.
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Show Partner Channel
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
Files::PartnerChannel.find(id)
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Parameters
|
|
63
|
+
|
|
64
|
+
* `id` (int64): Required - Partner Channel ID.
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## Create Partner Channel
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
Files::PartnerChannel.create(
|
|
73
|
+
from_partner_folder_name: "outgoing",
|
|
74
|
+
from_partner_route_path: "processing/from-partner",
|
|
75
|
+
to_partner_folder_name: "incoming",
|
|
76
|
+
to_partner_route_path: "delivery/to-partner",
|
|
77
|
+
partner_id: 1,
|
|
78
|
+
path: "claims/medical",
|
|
79
|
+
workspace_id: 0
|
|
80
|
+
)
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Parameters
|
|
84
|
+
|
|
85
|
+
* `from_partner_folder_name` (string): Optional Channel-level from-Partner folder name override.
|
|
86
|
+
* `from_partner_route_path` (string): Optional route path for files uploaded by the Partner.
|
|
87
|
+
* `to_partner_folder_name` (string): Optional Channel-level to-Partner folder name override.
|
|
88
|
+
* `to_partner_route_path` (string): Optional route path for files delivered to the Partner.
|
|
89
|
+
* `partner_id` (int64): Required - ID of the Partner this Channel belongs to.
|
|
90
|
+
* `path` (string): Required - Channel path relative to the Partner root folder.
|
|
91
|
+
* `workspace_id` (int64): ID of the Workspace associated with this Partner Channel.
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
## Update Partner Channel
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
Files::PartnerChannel.update(id,
|
|
100
|
+
from_partner_folder_name: "outgoing",
|
|
101
|
+
from_partner_route_path: "processing/from-partner",
|
|
102
|
+
to_partner_folder_name: "incoming",
|
|
103
|
+
to_partner_route_path: "delivery/to-partner",
|
|
104
|
+
path: "claims/medical"
|
|
105
|
+
)
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Parameters
|
|
109
|
+
|
|
110
|
+
* `id` (int64): Required - Partner Channel ID.
|
|
111
|
+
* `from_partner_folder_name` (string): Optional Channel-level from-Partner folder name override.
|
|
112
|
+
* `from_partner_route_path` (string): Optional route path for files uploaded by the Partner.
|
|
113
|
+
* `to_partner_folder_name` (string): Optional Channel-level to-Partner folder name override.
|
|
114
|
+
* `to_partner_route_path` (string): Optional route path for files delivered to the Partner.
|
|
115
|
+
* `path` (string): Channel path relative to the Partner root folder.
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## Delete Partner Channel
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
Files::PartnerChannel.delete(id)
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### Parameters
|
|
127
|
+
|
|
128
|
+
* `id` (int64): Required - Partner Channel ID.
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## Update Partner Channel
|
|
134
|
+
|
|
135
|
+
```
|
|
136
|
+
partner_channel = Files::PartnerChannel.find(id)
|
|
137
|
+
|
|
138
|
+
partner_channel.update(
|
|
139
|
+
from_partner_folder_name: "outgoing",
|
|
140
|
+
from_partner_route_path: "processing/from-partner",
|
|
141
|
+
to_partner_folder_name: "incoming",
|
|
142
|
+
to_partner_route_path: "delivery/to-partner",
|
|
143
|
+
path: "claims/medical"
|
|
144
|
+
)
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Parameters
|
|
148
|
+
|
|
149
|
+
* `id` (int64): Required - Partner Channel ID.
|
|
150
|
+
* `from_partner_folder_name` (string): Optional Channel-level from-Partner folder name override.
|
|
151
|
+
* `from_partner_route_path` (string): Optional route path for files uploaded by the Partner.
|
|
152
|
+
* `to_partner_folder_name` (string): Optional Channel-level to-Partner folder name override.
|
|
153
|
+
* `to_partner_route_path` (string): Optional route path for files delivered to the Partner.
|
|
154
|
+
* `path` (string): Channel path relative to the Partner root folder.
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
## Delete Partner Channel
|
|
160
|
+
|
|
161
|
+
```
|
|
162
|
+
partner_channel = Files::PartnerChannel.find(id)
|
|
163
|
+
|
|
164
|
+
partner_channel.delete
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### Parameters
|
|
168
|
+
|
|
169
|
+
* `id` (int64): Required - Partner Channel ID.
|
|
@@ -45,13 +45,13 @@ module Files
|
|
|
45
45
|
@attributes[:admin] = value
|
|
46
46
|
end
|
|
47
47
|
|
|
48
|
-
# string -
|
|
49
|
-
def
|
|
50
|
-
@attributes[:
|
|
48
|
+
# string - Username of the user
|
|
49
|
+
def username
|
|
50
|
+
@attributes[:username]
|
|
51
51
|
end
|
|
52
52
|
|
|
53
|
-
def
|
|
54
|
-
@attributes[:
|
|
53
|
+
def username=(value)
|
|
54
|
+
@attributes[:username] = value
|
|
55
55
|
end
|
|
56
56
|
|
|
57
57
|
# int64 - Group User ID.
|
|
@@ -0,0 +1,271 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Files
|
|
4
|
+
class PartnerChannel
|
|
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.
|
|
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.
|
|
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
|
+
# int64 - ID of the Partner this Channel belongs to.
|
|
31
|
+
def partner_id
|
|
32
|
+
@attributes[:partner_id]
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
def partner_id=(value)
|
|
36
|
+
@attributes[:partner_id] = 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
|
+
# string - Resolved to-Partner folder name after Channel override and default.
|
|
85
|
+
def effective_to_partner_folder_name
|
|
86
|
+
@attributes[:effective_to_partner_folder_name]
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
def effective_to_partner_folder_name=(value)
|
|
90
|
+
@attributes[:effective_to_partner_folder_name] = value
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
# string - Resolved from-Partner folder name after Channel override and default.
|
|
94
|
+
def effective_from_partner_folder_name
|
|
95
|
+
@attributes[:effective_from_partner_folder_name]
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
def effective_from_partner_folder_name=(value)
|
|
99
|
+
@attributes[:effective_from_partner_folder_name] = value
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# string - Resolved Channel folder path.
|
|
103
|
+
def channel_path
|
|
104
|
+
@attributes[:channel_path]
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
def channel_path=(value)
|
|
108
|
+
@attributes[:channel_path] = value
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
# string - Resolved to-Partner folder path.
|
|
112
|
+
def to_partner_folder_path
|
|
113
|
+
@attributes[:to_partner_folder_path]
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
def to_partner_folder_path=(value)
|
|
117
|
+
@attributes[:to_partner_folder_path] = value
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# string - Resolved from-Partner folder path.
|
|
121
|
+
def from_partner_folder_path
|
|
122
|
+
@attributes[:from_partner_folder_path]
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
def from_partner_folder_path=(value)
|
|
126
|
+
@attributes[:from_partner_folder_path] = value
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
# Parameters:
|
|
130
|
+
# from_partner_folder_name - string - Optional Channel-level from-Partner folder name override.
|
|
131
|
+
# from_partner_route_path - string - Optional route path for files uploaded by the Partner.
|
|
132
|
+
# to_partner_folder_name - string - Optional Channel-level to-Partner folder name override.
|
|
133
|
+
# to_partner_route_path - string - Optional route path for files delivered to the Partner.
|
|
134
|
+
# path - string - Channel path relative to the Partner root folder.
|
|
135
|
+
def update(params = {})
|
|
136
|
+
params ||= {}
|
|
137
|
+
params[:id] = @attributes[:id]
|
|
138
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
139
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
140
|
+
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)
|
|
141
|
+
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
|
+
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)
|
|
143
|
+
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
|
+
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
145
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
146
|
+
|
|
147
|
+
Api.send_request("/partner_channels/#{@attributes[:id]}", :patch, params, @options)
|
|
148
|
+
end
|
|
149
|
+
|
|
150
|
+
def delete(params = {})
|
|
151
|
+
params ||= {}
|
|
152
|
+
params[:id] = @attributes[:id]
|
|
153
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
154
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
155
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
156
|
+
|
|
157
|
+
Api.send_request("/partner_channels/#{@attributes[:id]}", :delete, params, @options)
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
def destroy(params = {})
|
|
161
|
+
delete(params)
|
|
162
|
+
nil
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
def save
|
|
166
|
+
if @attributes[:id]
|
|
167
|
+
new_obj = update(@attributes)
|
|
168
|
+
else
|
|
169
|
+
new_obj = PartnerChannel.create(@attributes, @options)
|
|
170
|
+
end
|
|
171
|
+
|
|
172
|
+
@attributes = new_obj.attributes
|
|
173
|
+
true
|
|
174
|
+
end
|
|
175
|
+
|
|
176
|
+
# Parameters:
|
|
177
|
+
# 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.
|
|
178
|
+
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
179
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `path` or `partner_id`.
|
|
180
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `partner_id` and `workspace_id`. Valid field combinations are `[ workspace_id, partner_id ]`.
|
|
181
|
+
def self.list(params = {}, options = {})
|
|
182
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
183
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
184
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
185
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
186
|
+
|
|
187
|
+
List.new(PartnerChannel, params) do
|
|
188
|
+
Api.send_request("/partner_channels", :get, params, options)
|
|
189
|
+
end
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
def self.all(params = {}, options = {})
|
|
193
|
+
list(params, options)
|
|
194
|
+
end
|
|
195
|
+
|
|
196
|
+
# Parameters:
|
|
197
|
+
# id (required) - int64 - Partner Channel ID.
|
|
198
|
+
def self.find(id, params = {}, options = {})
|
|
199
|
+
params ||= {}
|
|
200
|
+
params[:id] = id
|
|
201
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
202
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
203
|
+
|
|
204
|
+
response, options = Api.send_request("/partner_channels/#{params[:id]}", :get, params, options)
|
|
205
|
+
PartnerChannel.new(response.data, options)
|
|
206
|
+
end
|
|
207
|
+
|
|
208
|
+
def self.get(id, params = {}, options = {})
|
|
209
|
+
find(id, params, options)
|
|
210
|
+
end
|
|
211
|
+
|
|
212
|
+
# Parameters:
|
|
213
|
+
# from_partner_folder_name - string - Optional Channel-level from-Partner folder name override.
|
|
214
|
+
# from_partner_route_path - string - Optional route path for files uploaded by the Partner.
|
|
215
|
+
# to_partner_folder_name - string - Optional Channel-level to-Partner folder name override.
|
|
216
|
+
# to_partner_route_path - string - Optional route path for files delivered to the Partner.
|
|
217
|
+
# partner_id (required) - int64 - ID of the Partner this Channel belongs to.
|
|
218
|
+
# path (required) - string - Channel path relative to the Partner root folder.
|
|
219
|
+
# workspace_id - int64 - ID of the Workspace associated with this Partner Channel.
|
|
220
|
+
def self.create(params = {}, options = {})
|
|
221
|
+
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)
|
|
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_route_path must be an String") if params[:to_partner_route_path] and !params[:to_partner_route_path].is_a?(String)
|
|
225
|
+
raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
|
|
226
|
+
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
227
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
228
|
+
raise MissingParameterError.new("Parameter missing: partner_id") unless params[:partner_id]
|
|
229
|
+
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
|
230
|
+
|
|
231
|
+
response, options = Api.send_request("/partner_channels", :post, params, options)
|
|
232
|
+
PartnerChannel.new(response.data, options)
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
# Parameters:
|
|
236
|
+
# from_partner_folder_name - string - Optional Channel-level from-Partner folder name override.
|
|
237
|
+
# from_partner_route_path - string - Optional route path for files uploaded by the Partner.
|
|
238
|
+
# to_partner_folder_name - string - Optional Channel-level to-Partner folder name override.
|
|
239
|
+
# to_partner_route_path - string - Optional route path for files delivered to the Partner.
|
|
240
|
+
# path - string - Channel path relative to the Partner root folder.
|
|
241
|
+
def self.update(id, params = {}, options = {})
|
|
242
|
+
params ||= {}
|
|
243
|
+
params[:id] = id
|
|
244
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
245
|
+
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)
|
|
246
|
+
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
|
+
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)
|
|
248
|
+
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
|
+
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
250
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
251
|
+
|
|
252
|
+
response, options = Api.send_request("/partner_channels/#{params[:id]}", :patch, params, options)
|
|
253
|
+
PartnerChannel.new(response.data, options)
|
|
254
|
+
end
|
|
255
|
+
|
|
256
|
+
def self.delete(id, params = {}, options = {})
|
|
257
|
+
params ||= {}
|
|
258
|
+
params[:id] = id
|
|
259
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
260
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
261
|
+
|
|
262
|
+
Api.send_request("/partner_channels/#{params[:id]}", :delete, params, options)
|
|
263
|
+
nil
|
|
264
|
+
end
|
|
265
|
+
|
|
266
|
+
def self.destroy(id, params = {}, options = {})
|
|
267
|
+
delete(id, params, options)
|
|
268
|
+
nil
|
|
269
|
+
end
|
|
270
|
+
end
|
|
271
|
+
end
|
data/lib/files.com/version.rb
CHANGED
data/lib/files.com.rb
CHANGED
|
@@ -112,6 +112,7 @@ require "files.com/models/metadata_category"
|
|
|
112
112
|
require "files.com/models/notification"
|
|
113
113
|
require "files.com/models/outbound_connection_log"
|
|
114
114
|
require "files.com/models/partner"
|
|
115
|
+
require "files.com/models/partner_channel"
|
|
115
116
|
require "files.com/models/partner_site"
|
|
116
117
|
require "files.com/models/partner_site_request"
|
|
117
118
|
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.653
|
|
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-06-
|
|
11
|
+
date: 2026-06-18 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: addressable
|
|
@@ -251,6 +251,7 @@ files:
|
|
|
251
251
|
- docs/notification.md
|
|
252
252
|
- docs/outbound_connection_log.md
|
|
253
253
|
- docs/partner.md
|
|
254
|
+
- docs/partner_channel.md
|
|
254
255
|
- docs/partner_site.md
|
|
255
256
|
- docs/partner_site_request.md
|
|
256
257
|
- docs/payment.md
|
|
@@ -391,6 +392,7 @@ files:
|
|
|
391
392
|
- lib/files.com/models/notification.rb
|
|
392
393
|
- lib/files.com/models/outbound_connection_log.rb
|
|
393
394
|
- lib/files.com/models/partner.rb
|
|
395
|
+
- lib/files.com/models/partner_channel.rb
|
|
394
396
|
- lib/files.com/models/partner_site.rb
|
|
395
397
|
- lib/files.com/models/partner_site_request.rb
|
|
396
398
|
- lib/files.com/models/payment.rb
|