files.com 1.1.253 → 1.1.254
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/bundle_notification.md +7 -1
- data/docs/bundle_recipient.md +5 -0
- data/lib/files.com/models/bundle_notification.rb +13 -0
- data/lib/files.com/models/bundle_recipient.rb +13 -0
- data/lib/files.com/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3974055c632b326ea859daaf03104aa9b6d227771e50bf66e2a95c61e4dadb93
|
4
|
+
data.tar.gz: acd9ec08e008f20cb50975aa1998a1aa25e778f15c3df61935d591c2ad9422e9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 78288326d35c1f0236daaa107b1d020780122d0434b6fb487fc789720d0a90ae38911811b8f406da0dd34faf9763749dfa8ff950115e00d80402538da47f2776
|
7
|
+
data.tar.gz: 5100483123b00f4abade43f0dce6eb58955596f9ced5b33c0e2f7ee2c281fe1d1c4c7262320eb403bfba2ff98f54e4a49d2c94c46b01ec033626b366b3acbe44
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.1.
|
1
|
+
1.1.254
|
data/docs/bundle_notification.md
CHANGED
@@ -17,6 +17,7 @@
|
|
17
17
|
* `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
|
18
18
|
* `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
|
19
19
|
* `notify_user_id` (int64): The id of the user to notify.
|
20
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
20
21
|
|
21
22
|
|
22
23
|
---
|
@@ -24,11 +25,14 @@
|
|
24
25
|
## List Bundle Notifications
|
25
26
|
|
26
27
|
```
|
27
|
-
Files::BundleNotification.list
|
28
|
+
Files::BundleNotification.list(
|
29
|
+
user_id: 1
|
30
|
+
)
|
28
31
|
```
|
29
32
|
|
30
33
|
### Parameters
|
31
34
|
|
35
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
32
36
|
* `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.
|
33
37
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
34
38
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`.
|
@@ -54,6 +58,7 @@ Files::BundleNotification.find(id)
|
|
54
58
|
|
55
59
|
```
|
56
60
|
Files::BundleNotification.create(
|
61
|
+
user_id: 1,
|
57
62
|
bundle_id: 1,
|
58
63
|
notify_user_id: 1,
|
59
64
|
notify_on_registration: true,
|
@@ -63,6 +68,7 @@ Files::BundleNotification.create(
|
|
63
68
|
|
64
69
|
### Parameters
|
65
70
|
|
71
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
66
72
|
* `bundle_id` (int64): Required - Bundle ID to notify on
|
67
73
|
* `notify_user_id` (int64): The id of the user to notify.
|
68
74
|
* `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
|
data/docs/bundle_recipient.md
CHANGED
@@ -17,6 +17,7 @@
|
|
17
17
|
* `note` (string): A note sent to the recipient with the bundle.
|
18
18
|
* `recipient` (string): The recipient's email address.
|
19
19
|
* `sent_at` (date-time): When the Bundle was shared with this recipient.
|
20
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
20
21
|
* `bundle_id` (int64): Bundle to share.
|
21
22
|
* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
|
22
23
|
|
@@ -27,12 +28,14 @@
|
|
27
28
|
|
28
29
|
```
|
29
30
|
Files::BundleRecipient.list(
|
31
|
+
user_id: 1,
|
30
32
|
bundle_id: 1
|
31
33
|
)
|
32
34
|
```
|
33
35
|
|
34
36
|
### Parameters
|
35
37
|
|
38
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
36
39
|
* `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.
|
37
40
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
38
41
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
|
@@ -46,6 +49,7 @@ Files::BundleRecipient.list(
|
|
46
49
|
|
47
50
|
```
|
48
51
|
Files::BundleRecipient.create(
|
52
|
+
user_id: 1,
|
49
53
|
bundle_id: 1,
|
50
54
|
recipient: "johndoe@gmail.com",
|
51
55
|
name: "John Smith",
|
@@ -57,6 +61,7 @@ Files::BundleRecipient.create(
|
|
57
61
|
|
58
62
|
### Parameters
|
59
63
|
|
64
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
60
65
|
* `bundle_id` (int64): Required - Bundle to share.
|
61
66
|
* `recipient` (string): Required - Email addresses to share this bundle with.
|
62
67
|
* `name` (string): Name of recipient.
|
@@ -54,6 +54,15 @@ module Files
|
|
54
54
|
@attributes[:notify_user_id] = value
|
55
55
|
end
|
56
56
|
|
57
|
+
# int64 - User ID. Provide a value of `0` to operate the current session's user.
|
58
|
+
def user_id
|
59
|
+
@attributes[:user_id]
|
60
|
+
end
|
61
|
+
|
62
|
+
def user_id=(value)
|
63
|
+
@attributes[:user_id] = value
|
64
|
+
end
|
65
|
+
|
57
66
|
# Parameters:
|
58
67
|
# notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
|
59
68
|
# notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
|
@@ -94,11 +103,13 @@ module Files
|
|
94
103
|
end
|
95
104
|
|
96
105
|
# Parameters:
|
106
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
97
107
|
# 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.
|
98
108
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
99
109
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`.
|
100
110
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
|
101
111
|
def self.list(params = {}, options = {})
|
112
|
+
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
102
113
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
103
114
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
104
115
|
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
@@ -130,11 +141,13 @@ module Files
|
|
130
141
|
end
|
131
142
|
|
132
143
|
# Parameters:
|
144
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
133
145
|
# bundle_id (required) - int64 - Bundle ID to notify on
|
134
146
|
# notify_user_id - int64 - The id of the user to notify.
|
135
147
|
# notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
|
136
148
|
# notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
|
137
149
|
def self.create(params = {}, options = {})
|
150
|
+
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
138
151
|
raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
|
139
152
|
raise InvalidParameterError.new("Bad parameter: notify_user_id must be an Integer") if params[:notify_user_id] and !params[:notify_user_id].is_a?(Integer)
|
140
153
|
raise MissingParameterError.new("Parameter missing: bundle_id") unless params[:bundle_id]
|
@@ -54,6 +54,15 @@ module Files
|
|
54
54
|
@attributes[:sent_at] = value
|
55
55
|
end
|
56
56
|
|
57
|
+
# int64 - User ID. Provide a value of `0` to operate the current session's user.
|
58
|
+
def user_id
|
59
|
+
@attributes[:user_id]
|
60
|
+
end
|
61
|
+
|
62
|
+
def user_id=(value)
|
63
|
+
@attributes[:user_id] = value
|
64
|
+
end
|
65
|
+
|
57
66
|
# int64 - Bundle to share.
|
58
67
|
def bundle_id
|
59
68
|
@attributes[:bundle_id]
|
@@ -84,12 +93,14 @@ module Files
|
|
84
93
|
end
|
85
94
|
|
86
95
|
# Parameters:
|
96
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
87
97
|
# 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.
|
88
98
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
89
99
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
|
90
100
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
91
101
|
# bundle_id (required) - int64 - List recipients for the bundle with this ID.
|
92
102
|
def self.list(params = {}, options = {})
|
103
|
+
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
93
104
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
94
105
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
95
106
|
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
@@ -107,6 +118,7 @@ module Files
|
|
107
118
|
end
|
108
119
|
|
109
120
|
# Parameters:
|
121
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
110
122
|
# bundle_id (required) - int64 - Bundle to share.
|
111
123
|
# recipient (required) - string - Email addresses to share this bundle with.
|
112
124
|
# name - string - Name of recipient.
|
@@ -114,6 +126,7 @@ module Files
|
|
114
126
|
# note - string - Note to include in email.
|
115
127
|
# share_after_create - boolean - Set to true to share the link with the recipient upon creation.
|
116
128
|
def self.create(params = {}, options = {})
|
129
|
+
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
117
130
|
raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
|
118
131
|
raise InvalidParameterError.new("Bad parameter: recipient must be an String") if params[:recipient] and !params[:recipient].is_a?(String)
|
119
132
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
data/lib/files.com/version.rb
CHANGED
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.254
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- files.com
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-05-
|
11
|
+
date: 2025-05-12 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: addressable
|