files.com 1.1.688 → 1.1.689

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: 7f181535385996d0d40c60e0c3d9c14c90d769d55c9f752f8cd32c2bb17d5685
4
- data.tar.gz: a4c7317d824fa206c98d5aa4b71717ce186882bae1fa74193000f2c9226f3ab5
3
+ metadata.gz: 02404110f3cdedb4da5150380628bc677dfd3a1e12b38db8d5b900ae7ef6e023
4
+ data.tar.gz: 3f6637df82c914605a58d9d655237ee2d9627b7c909eea1458aa4fbc4e662c99
5
5
  SHA512:
6
- metadata.gz: 5738704b1affb4ad7e48767347170673d9b5729c8cc5642559c522f36aa4448d105b71a10af272c731b17675af76d2b5c6a98683a946bd73c8d11f8b25228559
7
- data.tar.gz: 78f447f46acb0a6021ec8f4d97fbbb9801c758364e9a2bbd26a90a7af295e109cb29f21c6d4952149a311a1fa53aa0b522896423cfb74ab6d90f666c1950e523
6
+ metadata.gz: 480b89ae2ecaf15a3e3e59a36fe751250dcb427487cd5a11e2b01c79b54aef7f9b3b7673e859bcc694a38d7f74851c76ac8500c12899d3b58c45d4afca32a259
7
+ data.tar.gz: 16f9dab189c8479bd155e96515434238139052250536defe9483e2fa402f95156297b25830ad197281623cecbc8b6ecd24a7383112b1e1ce720162d72404afbf
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.688
1
+ 1.1.689
@@ -0,0 +1,131 @@
1
+ # UserAdditionalEmailRecipient
2
+
3
+ ## Example UserAdditionalEmailRecipient Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "user_id": 1,
9
+ "workspace_id": 1,
10
+ "email": "user-copy@example.com",
11
+ "created_at": "2000-01-01T01:00:00Z"
12
+ }
13
+ ```
14
+
15
+ * `id` (int64): User additional email recipient ID
16
+ * `user_id` (int64): User ID
17
+ * `workspace_id` (int64): Workspace ID (0 for default workspace).
18
+ * `email` (string): Additional email recipient address
19
+ * `created_at` (date-time): Created at date/time
20
+
21
+
22
+ ---
23
+
24
+ ## List User Additional Email Recipients
25
+
26
+ ```
27
+ Files::UserAdditionalEmailRecipient.list(
28
+ user_id: 1
29
+ )
30
+ ```
31
+
32
+ ### Parameters
33
+
34
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
35
+ * `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.
36
+ * `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
37
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `email`, `user_id` or `workspace_id`.
38
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `email` and `workspace_id`. Valid field combinations are `[ workspace_id, email ]`.
39
+ * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `email`.
40
+
41
+
42
+ ---
43
+
44
+ ## Show User Additional Email Recipient
45
+
46
+ ```
47
+ Files::UserAdditionalEmailRecipient.find(id)
48
+ ```
49
+
50
+ ### Parameters
51
+
52
+ * `id` (int64): Required - User Additional Email Recipient ID.
53
+
54
+
55
+ ---
56
+
57
+ ## Create User Additional Email Recipient
58
+
59
+ ```
60
+ Files::UserAdditionalEmailRecipient.create(
61
+ user_id: 1,
62
+ email: "user-copy@example.com"
63
+ )
64
+ ```
65
+
66
+ ### Parameters
67
+
68
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
69
+ * `email` (string): Required - Additional email recipient address
70
+
71
+
72
+ ---
73
+
74
+ ## Update User Additional Email Recipient
75
+
76
+ ```
77
+ Files::UserAdditionalEmailRecipient.update(id,
78
+ email: "user-copy@example.com"
79
+ )
80
+ ```
81
+
82
+ ### Parameters
83
+
84
+ * `id` (int64): Required - User Additional Email Recipient ID.
85
+ * `email` (string): Additional email recipient address
86
+
87
+
88
+ ---
89
+
90
+ ## Delete User Additional Email Recipient
91
+
92
+ ```
93
+ Files::UserAdditionalEmailRecipient.delete(id)
94
+ ```
95
+
96
+ ### Parameters
97
+
98
+ * `id` (int64): Required - User Additional Email Recipient ID.
99
+
100
+
101
+ ---
102
+
103
+ ## Update User Additional Email Recipient
104
+
105
+ ```
106
+ user_additional_email_recipient = Files::UserAdditionalEmailRecipient.find(id)
107
+
108
+ user_additional_email_recipient.update(
109
+ email: "user-copy@example.com"
110
+ )
111
+ ```
112
+
113
+ ### Parameters
114
+
115
+ * `id` (int64): Required - User Additional Email Recipient ID.
116
+ * `email` (string): Additional email recipient address
117
+
118
+
119
+ ---
120
+
121
+ ## Delete User Additional Email Recipient
122
+
123
+ ```
124
+ user_additional_email_recipient = Files::UserAdditionalEmailRecipient.find(id)
125
+
126
+ user_additional_email_recipient.delete
127
+ ```
128
+
129
+ ### Parameters
130
+
131
+ * `id` (int64): Required - User Additional Email Recipient ID.
@@ -0,0 +1,172 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class UserAdditionalEmailRecipient
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # int64 - User additional email recipient ID
13
+ def id
14
+ @attributes[:id]
15
+ end
16
+
17
+ def id=(value)
18
+ @attributes[:id] = value
19
+ end
20
+
21
+ # int64 - User ID
22
+ def user_id
23
+ @attributes[:user_id]
24
+ end
25
+
26
+ def user_id=(value)
27
+ @attributes[:user_id] = value
28
+ end
29
+
30
+ # int64 - Workspace ID (0 for default workspace).
31
+ def workspace_id
32
+ @attributes[:workspace_id]
33
+ end
34
+
35
+ def workspace_id=(value)
36
+ @attributes[:workspace_id] = value
37
+ end
38
+
39
+ # string - Additional email recipient address
40
+ def email
41
+ @attributes[:email]
42
+ end
43
+
44
+ def email=(value)
45
+ @attributes[:email] = value
46
+ end
47
+
48
+ # date-time - Created at date/time
49
+ def created_at
50
+ @attributes[:created_at]
51
+ end
52
+
53
+ # Parameters:
54
+ # email - string - Additional email recipient address
55
+ def update(params = {})
56
+ params ||= {}
57
+ params[:id] = @attributes[:id]
58
+ raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
59
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
60
+ raise InvalidParameterError.new("Bad parameter: email must be an String") if params[:email] and !params[:email].is_a?(String)
61
+ raise MissingParameterError.new("Parameter missing: id") unless params[:id]
62
+
63
+ Api.send_request("/user_additional_email_recipients/#{@attributes[:id]}", :patch, params, @options)
64
+ end
65
+
66
+ def delete(params = {})
67
+ params ||= {}
68
+ params[:id] = @attributes[:id]
69
+ raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
70
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
71
+ raise MissingParameterError.new("Parameter missing: id") unless params[:id]
72
+
73
+ Api.send_request("/user_additional_email_recipients/#{@attributes[:id]}", :delete, params, @options)
74
+ end
75
+
76
+ def destroy(params = {})
77
+ delete(params)
78
+ nil
79
+ end
80
+
81
+ def save
82
+ if @attributes[:id]
83
+ new_obj = update(@attributes)
84
+ else
85
+ new_obj = UserAdditionalEmailRecipient.create(@attributes, @options)
86
+ end
87
+
88
+ @attributes = new_obj.attributes
89
+ true
90
+ end
91
+
92
+ # Parameters:
93
+ # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
94
+ # 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.
95
+ # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
96
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `email`, `user_id` or `workspace_id`.
97
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `email` and `workspace_id`. Valid field combinations are `[ workspace_id, email ]`.
98
+ # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `email`.
99
+ def self.list(params = {}, options = {})
100
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
101
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
102
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
103
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
104
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
105
+ raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
106
+
107
+ List.new(UserAdditionalEmailRecipient, params) do
108
+ Api.send_request("/user_additional_email_recipients", :get, params, options)
109
+ end
110
+ end
111
+
112
+ def self.all(params = {}, options = {})
113
+ list(params, options)
114
+ end
115
+
116
+ # Parameters:
117
+ # id (required) - int64 - User Additional Email Recipient ID.
118
+ def self.find(id, params = {}, options = {})
119
+ params ||= {}
120
+ params[:id] = id
121
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
122
+ raise MissingParameterError.new("Parameter missing: id") unless params[:id]
123
+
124
+ response, options = Api.send_request("/user_additional_email_recipients/#{params[:id]}", :get, params, options)
125
+ UserAdditionalEmailRecipient.new(response.data, options)
126
+ end
127
+
128
+ def self.get(id, params = {}, options = {})
129
+ find(id, params, options)
130
+ end
131
+
132
+ # Parameters:
133
+ # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
134
+ # email (required) - string - Additional email recipient address
135
+ def self.create(params = {}, options = {})
136
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
137
+ raise InvalidParameterError.new("Bad parameter: email must be an String") if params[:email] and !params[:email].is_a?(String)
138
+ raise MissingParameterError.new("Parameter missing: email") unless params[:email]
139
+
140
+ response, options = Api.send_request("/user_additional_email_recipients", :post, params, options)
141
+ UserAdditionalEmailRecipient.new(response.data, options)
142
+ end
143
+
144
+ # Parameters:
145
+ # email - string - Additional email recipient address
146
+ def self.update(id, params = {}, options = {})
147
+ params ||= {}
148
+ params[:id] = id
149
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
150
+ raise InvalidParameterError.new("Bad parameter: email must be an String") if params[:email] and !params[:email].is_a?(String)
151
+ raise MissingParameterError.new("Parameter missing: id") unless params[:id]
152
+
153
+ response, options = Api.send_request("/user_additional_email_recipients/#{params[:id]}", :patch, params, options)
154
+ UserAdditionalEmailRecipient.new(response.data, options)
155
+ end
156
+
157
+ def self.delete(id, params = {}, options = {})
158
+ params ||= {}
159
+ params[:id] = id
160
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
161
+ raise MissingParameterError.new("Parameter missing: id") unless params[:id]
162
+
163
+ Api.send_request("/user_additional_email_recipients/#{params[:id]}", :delete, params, options)
164
+ nil
165
+ end
166
+
167
+ def self.destroy(id, params = {}, options = {})
168
+ delete(id, params, options)
169
+ nil
170
+ end
171
+ end
172
+ end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.688"
4
+ VERSION = "1.1.689"
5
5
  end
data/lib/files.com.rb CHANGED
@@ -167,6 +167,7 @@ require "files.com/models/usage_by_top_level_dir"
167
167
  require "files.com/models/usage_daily_snapshot"
168
168
  require "files.com/models/usage_snapshot"
169
169
  require "files.com/models/user"
170
+ require "files.com/models/user_additional_email_recipient"
170
171
  require "files.com/models/user_cipher_use"
171
172
  require "files.com/models/user_lifecycle_rule"
172
173
  require "files.com/models/user_request"
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.688
4
+ version: 1.1.689
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-17 00:00:00.000000000 Z
11
+ date: 2026-07-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable
@@ -306,6 +306,7 @@ files:
306
306
  - docs/usage_daily_snapshot.md
307
307
  - docs/usage_snapshot.md
308
308
  - docs/user.md
309
+ - docs/user_additional_email_recipient.md
309
310
  - docs/user_cipher_use.md
310
311
  - docs/user_lifecycle_rule.md
311
312
  - docs/user_request.md
@@ -458,6 +459,7 @@ files:
458
459
  - lib/files.com/models/usage_daily_snapshot.rb
459
460
  - lib/files.com/models/usage_snapshot.rb
460
461
  - lib/files.com/models/user.rb
462
+ - lib/files.com/models/user_additional_email_recipient.rb
461
463
  - lib/files.com/models/user_cipher_use.rb
462
464
  - lib/files.com/models/user_lifecycle_rule.rb
463
465
  - lib/files.com/models/user_request.rb