files.com 1.0.144 → 1.0.145

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7b68ed7434c312c8c341065d3bbc7440332bf1d102a24fa247fdaf3d8796b0cb
4
- data.tar.gz: f5c9c2ebf256a6b5c7472b7d815334cc3dcb3a57ac560c1cf40b6b69d1871729
3
+ metadata.gz: 0d7f071709b40ff9d28f66a27f2bd34644288f32f8670f9689b253a713a6b7de
4
+ data.tar.gz: c539eea97daa72e3b78a8d89357b29612720252f93e6e45ca402826fdc980bab
5
5
  SHA512:
6
- metadata.gz: ae3140cc85fb0d8ac7655aae5651691415f203117921b30e8c125209c726b517416d6398f2f97a0e1e9f9ca71a8a1c22a039d3f45d2ac34de0996cb92ce8bcd2
7
- data.tar.gz: 402d2e3bb8b18af1b823efdb9b5b656fb0b382edc759485e585538fbf1fc86c51521b2f004b891dcf5320224439e417475c0c80678bfd65282c9199b2251bf1c
6
+ metadata.gz: 99b22b0b16d450385db59cf93c657506d27a05abf6f55d07ebd781f56710222299b5ccda88ae58ce02f0350e3c97ce1ee1c5683866cbdefdf984e4a0223f4f58
7
+ data.tar.gz: e3e29c40f669a7e79b0aca20b6a884d805cf89c593cead44b4141be7ff19aa39a11afa55b0f80be568e31ba715a68919c3410fa7028acec8e4c32f5c73197db5
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.144
1
+ 1.0.145
@@ -21,3 +21,23 @@
21
21
  * `inbox_code` (string): InboxRegistration cookie code, if there is an associated InboxRegistration
22
22
  * `form_field_set_id` (int64): Id of associated form field set
23
23
  * `form_field_data` (string): Data for form field set with form field ids as keys and user data as values
24
+
25
+
26
+ ---
27
+
28
+ ## List Bundle Registrations
29
+
30
+ ```
31
+ Files::BundleRegistration.list(
32
+ user_id: 1,
33
+ per_page: 1,
34
+ bundle_id: 1
35
+ )
36
+ ```
37
+
38
+ ### Parameters
39
+
40
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
41
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
42
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
43
+ * `bundle_id` (int64): Required - ID of the associated Bundle
@@ -19,3 +19,21 @@
19
19
  * `email` (string): Registrant email address
20
20
  * `form_field_set_id` (int64): Id of associated form field set
21
21
  * `form_field_data` (string): Data for form field set with form field ids as keys and user data as values
22
+
23
+
24
+ ---
25
+
26
+ ## List Inbox Registrations
27
+
28
+ ```
29
+ Files::InboxRegistration.list(
30
+ per_page: 1,
31
+ folder_behavior_id: 1
32
+ )
33
+ ```
34
+
35
+ ### Parameters
36
+
37
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
38
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
39
+ * `folder_behavior_id` (int64): Required - ID of the associated Inbox.
@@ -43,5 +43,26 @@ module Files
43
43
  def form_field_data
44
44
  @attributes[:form_field_data]
45
45
  end
46
+
47
+ # Parameters:
48
+ # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
49
+ # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
50
+ # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
51
+ # bundle_id (required) - int64 - ID of the associated Bundle
52
+ def self.list(params = {}, options = {})
53
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
54
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
55
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
56
+ raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params.dig(:bundle_id) and !params.dig(:bundle_id).is_a?(Integer)
57
+ raise MissingParameterError.new("Parameter missing: bundle_id") unless params.dig(:bundle_id)
58
+
59
+ List.new(BundleRegistration, params) do
60
+ Api.send_request("/bundle_registrations", :get, params, options)
61
+ end
62
+ end
63
+
64
+ def self.all(params = {}, options = {})
65
+ list(params, options)
66
+ end
46
67
  end
47
68
  end
@@ -38,5 +38,24 @@ module Files
38
38
  def form_field_data
39
39
  @attributes[:form_field_data]
40
40
  end
41
+
42
+ # Parameters:
43
+ # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
44
+ # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
45
+ # folder_behavior_id (required) - int64 - ID of the associated Inbox.
46
+ def self.list(params = {}, options = {})
47
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
48
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
49
+ raise InvalidParameterError.new("Bad parameter: folder_behavior_id must be an Integer") if params.dig(:folder_behavior_id) and !params.dig(:folder_behavior_id).is_a?(Integer)
50
+ raise MissingParameterError.new("Parameter missing: folder_behavior_id") unless params.dig(:folder_behavior_id)
51
+
52
+ List.new(InboxRegistration, params) do
53
+ Api.send_request("/inbox_registrations", :get, params, options)
54
+ end
55
+ end
56
+
57
+ def self.all(params = {}, options = {})
58
+ list(params, options)
59
+ end
41
60
  end
42
61
  end
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.0.144
4
+ version: 1.0.145
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-03-09 00:00:00.000000000 Z
11
+ date: 2021-03-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable