files.com 1.0.154 → 1.0.159

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: '0967792b1162066ca96166b1997a60b73a734adf6bb2ef293434e39e2f8db5b3'
4
- data.tar.gz: a355b8559f43c3df7df9b4a9dec34580c2f82354b74acf408d9b456ae0058d0d
3
+ metadata.gz: 59ee353bca980becced463ffab55eb6af982e055c1f3a52535a27312606ac76e
4
+ data.tar.gz: 58c06946578d59ee0af44c90b575613ca3500d75da5249665ffed66724b36ddf
5
5
  SHA512:
6
- metadata.gz: bf29c59200ad503bf470b7a39491ab111c50d0ac52368d4425b4427b9e69fbd0449ac6c77d6ac484bc6bd6b06910e0c8c4e986e6398faffe4fba74b6731620c6
7
- data.tar.gz: b9484b649c9cdfabb7924bae1421faaeabf867e5a5c4b0503a942d280c8ae400256d40e12d09d0bb9c20df6a3790481ddb7ee2b5d17eac3ca8651e710a252c9a
6
+ metadata.gz: c2a88a40b7f09c6d2efb1167d1b8b7011018d2f2af640b2fc3c7d2d901ae86e60d7cece1bfaab0afc5f08fbbd042321d05c4822c00ed21370ec0b789896741a0
7
+ data.tar.gz: cbd82ba833efb51e42ba69c22dc6784118d0141d1c368c00ebdebb3e36384373ab21c07007260bb74dfcdd2533e8d597ca0cb279c70324796eda345e8abc6315
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.154
1
+ 1.0.159
@@ -10,29 +10,25 @@
10
10
  "created_at": "2000-01-01T01:00:00Z",
11
11
  "currency": "USD",
12
12
  "download_uri": "https://url...",
13
- "invoice_line_items": [
14
- {
15
- "amount": 1.0,
16
- "created_at": "2000-01-01T01:00:00Z",
17
- "description": "Service from 2019-01-01 through 2019-12-31",
18
- "type": "invoice",
19
- "service_end_at": "2000-01-01T01:00:00Z",
20
- "service_start_at": "2000-01-01T01:00:00Z",
21
- "updated_at": "2000-01-01T01:00:00Z",
22
- "plan": "Enterprise",
23
- "site": "My site"
24
- }
25
- ],
13
+ "invoice_line_items": {
14
+ "amount": 1.0,
15
+ "created_at": "2000-01-01T01:00:00Z",
16
+ "description": "Service from 2019-01-01 through 2019-12-31",
17
+ "type": "invoice",
18
+ "service_end_at": "2000-01-01T01:00:00Z",
19
+ "service_start_at": "2000-01-01T01:00:00Z",
20
+ "updated_at": "2000-01-01T01:00:00Z",
21
+ "plan": "Enterprise",
22
+ "site": "My site"
23
+ },
26
24
  "method": "paypal",
27
- "payment_line_items": [
28
- {
29
- "amount": 1.0,
30
- "created_at": "2000-01-01T01:00:00Z",
31
- "invoice_id": 1,
32
- "payment_id": 1,
33
- "updated_at": "2000-01-01T01:00:00Z"
34
- }
35
- ],
25
+ "payment_line_items": {
26
+ "amount": 1.0,
27
+ "created_at": "2000-01-01T01:00:00Z",
28
+ "invoice_id": 1,
29
+ "payment_id": 1,
30
+ "updated_at": "2000-01-01T01:00:00Z"
31
+ },
36
32
  "payment_reversed_at": "2000-01-01T01:00:00Z",
37
33
  "payment_type": "",
38
34
  "site_name": "My Site",
@@ -47,9 +43,9 @@
47
43
  * `created_at` (date-time): Line item created at
48
44
  * `currency` (string): Line item currency
49
45
  * `download_uri` (string): Line item download uri
50
- * `invoice_line_items` (array): Associated invoice line items
46
+ * `invoice_line_items`: Associated invoice line items
51
47
  * `method` (string): Line item payment method
52
- * `payment_line_items` (array): Associated payment line items
48
+ * `payment_line_items`: Associated payment line items
53
49
  * `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
54
50
  * `payment_type` (string): Type of payment if applicable
55
51
  * `site_name` (string): Site name this line item is for
data/docs/automation.md CHANGED
@@ -22,7 +22,6 @@
22
22
  "time_zone": "Eastern Time (US & Canada)"
23
23
  },
24
24
  "source": "",
25
- "destination": "",
26
25
  "destinations": [
27
26
  "destination"
28
27
  ],
@@ -52,7 +51,6 @@
52
51
  * `next_process_on` (string): If trigger is `daily`, date this automation will next run.
53
52
  * `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
54
53
  * `source` (string): Source Path
55
- * `destination` (string): DEPRECATED: Destination Path
56
54
  * `destinations` (string): Destination Path
57
55
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
58
56
  * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
@@ -64,6 +62,7 @@
64
62
  * `trigger_actions` (string): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
65
63
  * `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
66
64
  * `value` (object): A Hash of attributes specific to the automation type.
65
+ * `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
67
66
 
68
67
 
69
68
  ---
@@ -112,7 +111,6 @@ Files::Automation.find(id)
112
111
  Files::Automation.create(
113
112
  automation: "create_folder",
114
113
  source: "source",
115
- destination: "destination",
116
114
  destinations: "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
117
115
  interval: "year",
118
116
  user_ids: [1,2],
@@ -129,7 +127,7 @@ Files::Automation.create(
129
127
 
130
128
  * `automation` (string): Required - Automation type
131
129
  * `source` (string): Source Path
132
- * `destination` (string): DEPRECATED: Destination Path
130
+ * `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
133
131
  * `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
134
132
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
135
133
  * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
@@ -152,7 +150,6 @@ Files::Automation.create(
152
150
  Files::Automation.update(id,
153
151
  automation: "create_folder",
154
152
  source: "source",
155
- destination: "destination",
156
153
  destinations: "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
157
154
  interval: "year",
158
155
  user_ids: [1,2],
@@ -170,7 +167,7 @@ Files::Automation.update(id,
170
167
  * `id` (int64): Required - Automation ID.
171
168
  * `automation` (string): Required - Automation type
172
169
  * `source` (string): Source Path
173
- * `destination` (string): DEPRECATED: Destination Path
170
+ * `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
174
171
  * `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
175
172
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
176
173
  * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
@@ -208,7 +205,6 @@ automation = Files::Automation.list_for(path).first
208
205
  automation.update(
209
206
  automation: "create_folder",
210
207
  source: "source",
211
- destination: "destination",
212
208
  destinations: "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
213
209
  interval: "year",
214
210
  user_ids: [1,2],
@@ -226,7 +222,7 @@ automation.update(
226
222
  * `id` (int64): Required - Automation ID.
227
223
  * `automation` (string): Required - Automation type
228
224
  * `source` (string): Source Path
229
- * `destination` (string): DEPRECATED: Destination Path
225
+ * `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
230
226
  * `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
231
227
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
232
228
  * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
data/docs/bundle.md CHANGED
@@ -20,22 +20,20 @@
20
20
  3,
21
21
  4
22
22
  ],
23
- "form_fields": [
24
- {
25
- "id": 1,
26
- "label": "Sample Label",
27
- "required": true,
28
- "help_text": "Help Text",
29
- "field_type": "text",
30
- "options_for_select": [
31
- "red",
32
- "green",
33
- "blue"
34
- ],
35
- "default_option": "red",
36
- "form_field_set_id": 1
37
- }
38
- ],
23
+ "form_fields": {
24
+ "id": 1,
25
+ "label": "Sample Label",
26
+ "required": true,
27
+ "help_text": "Help Text",
28
+ "field_type": "text",
29
+ "options_for_select": [
30
+ "red",
31
+ "green",
32
+ "blue"
33
+ ],
34
+ "default_option": "red",
35
+ "form_field_set_id": 1
36
+ },
39
37
  "skip_name": true,
40
38
  "skip_email": true,
41
39
  "skip_company": true
@@ -171,9 +169,9 @@ Files::Bundle.share(id,
171
169
  ### Parameters
172
170
 
173
171
  * `id` (int64): Required - Bundle ID.
174
- * `to` (array(string)): Required - A list of email addresses to share this bundle with.
172
+ * `to` (array(string)): A list of email addresses to share this bundle with. Required unless `recipients` is used.
175
173
  * `note` (string): Note to include in email.
176
- * `recipients` (array(object)): A list of recipients to share this bundle with.
174
+ * `recipients` (array(object)): A list of recipients to share this bundle with. Required unless `to` is used.
177
175
 
178
176
 
179
177
  ---
@@ -244,9 +242,9 @@ bundle.share(
244
242
  ### Parameters
245
243
 
246
244
  * `id` (int64): Required - Bundle ID.
247
- * `to` (array(string)): Required - A list of email addresses to share this bundle with.
245
+ * `to` (array(string)): A list of email addresses to share this bundle with. Required unless `recipients` is used.
248
246
  * `note` (string): Note to include in email.
249
- * `recipients` (array(object)): A list of recipients to share this bundle with.
247
+ * `recipients` (array(object)): A list of recipients to share this bundle with. Required unless `to` is used.
250
248
 
251
249
 
252
250
  ---
@@ -33,5 +33,12 @@ Files::BundleDownload.list(
33
33
 
34
34
  * `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.
35
35
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
36
+ * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at`.
37
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
38
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
39
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`.
40
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
41
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`.
42
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`.
36
43
  * `bundle_id` (int64): Bundle ID
37
44
  * `bundle_registration_id` (int64): BundleRegistration ID
@@ -11,8 +11,8 @@
11
11
  }
12
12
  ```
13
13
 
14
- * `event_type` (string): Type of event being recorded. Valid values: `remote_server_sync`, `lockout`, `ldap_login`, `saml_login`
15
- * `status` (string): Status of event. Valid values: `error`
14
+ * `event_type` (string): Type of event being recorded.
15
+ * `status` (string): Status of event.
16
16
  * `body` (string): Event body
17
17
  * `created_at` (date-time): External event create date/time
18
18
 
data/docs/file_comment.md CHANGED
@@ -6,18 +6,16 @@
6
6
  {
7
7
  "id": 1,
8
8
  "body": "What a great file!",
9
- "reactions": [
10
- {
11
- "id": 1,
12
- "emoji": "👍"
13
- }
14
- ]
9
+ "reactions": {
10
+ "id": 1,
11
+ "emoji": "👍"
12
+ }
15
13
  }
16
14
  ```
17
15
 
18
16
  * `id` (int64): File Comment ID
19
17
  * `body` (string): Comment body.
20
- * `reactions` (array): Reactions to this comment.
18
+ * `reactions`: Reactions to this comment.
21
19
  * `path` (string): File path.
22
20
 
23
21
 
@@ -12,22 +12,20 @@
12
12
  3,
13
13
  4
14
14
  ],
15
- "form_fields": [
16
- {
17
- "id": 1,
18
- "label": "Sample Label",
19
- "required": true,
20
- "help_text": "Help Text",
21
- "field_type": "text",
22
- "options_for_select": [
23
- "red",
24
- "green",
25
- "blue"
26
- ],
27
- "default_option": "red",
28
- "form_field_set_id": 1
29
- }
30
- ],
15
+ "form_fields": {
16
+ "id": 1,
17
+ "label": "Sample Label",
18
+ "required": true,
19
+ "help_text": "Help Text",
20
+ "field_type": "text",
21
+ "options_for_select": [
22
+ "red",
23
+ "green",
24
+ "blue"
25
+ ],
26
+ "default_option": "red",
27
+ "form_field_set_id": 1
28
+ },
31
29
  "skip_name": true,
32
30
  "skip_email": true,
33
31
  "skip_company": true
@@ -37,7 +35,7 @@
37
35
  * `id` (int64): Form field set id
38
36
  * `title` (string): Title to be displayed
39
37
  * `form_layout` (int64): Layout of the form
40
- * `form_fields` (array): Associated form fields
38
+ * `form_fields`: Associated form fields
41
39
  * `skip_name` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
42
40
  * `skip_email` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
43
41
  * `skip_company` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
@@ -86,7 +84,7 @@ Files::FormFieldSet.create(
86
84
  skip_email: true,
87
85
  skip_name: true,
88
86
  skip_company: true,
89
- form_fields: [{"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}]
87
+ form_fields: {"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}
90
88
  )
91
89
  ```
92
90
 
@@ -110,7 +108,7 @@ Files::FormFieldSet.update(id,
110
108
  skip_email: true,
111
109
  skip_name: true,
112
110
  skip_company: true,
113
- form_fields: [{"id":1,"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}]
111
+ form_fields: {"id":1,"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}
114
112
  )
115
113
  ```
116
114
 
@@ -149,7 +147,7 @@ form_field_set.update(
149
147
  skip_email: true,
150
148
  skip_name: true,
151
149
  skip_company: true,
152
- form_fields: [{"id":1,"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}]
150
+ form_fields: {"id":1,"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}
153
151
  )
154
152
  ```
155
153
 
data/docs/group.md CHANGED
@@ -21,7 +21,7 @@
21
21
 
22
22
  * `id` (int64): Group ID
23
23
  * `name` (string): Group name
24
- * `admin_ids` (array): List of user IDs who are group administrators (separated by commas)
24
+ * `admin_ids` (string): List of user IDs who are group administrators (separated by commas)
25
25
  * `notes` (string): Notes about this group
26
26
  * `user_ids` (array): List of user IDs who belong to this group (separated by commas)
27
27
  * `usernames` (array): List of usernames who belong to this group (separated by commas)
@@ -69,7 +69,7 @@ Files::InboxRecipient.create(
69
69
 
70
70
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
71
71
  * `inbox_id` (int64): Required - Inbox to share.
72
- * `recipient` (string): Required - Email addresses to share this inbox with.
72
+ * `recipient` (string): Required - Email address to share this inbox with.
73
73
  * `name` (string): Name of recipient.
74
74
  * `company` (string): Company of recipient.
75
75
  * `note` (string): Note to include in email.
data/docs/inbox_upload.md CHANGED
@@ -31,5 +31,12 @@ Files::InboxUpload.list(
31
31
 
32
32
  * `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.
33
33
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
34
+ * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at`.
35
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
36
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
37
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`.
38
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
39
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`.
40
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`.
34
41
  * `inbox_registration_id` (int64): InboxRegistration ID
35
42
  * `inbox_id` (int64): Inbox ID
data/docs/invoice.md CHANGED
@@ -10,29 +10,25 @@
10
10
  "created_at": "2000-01-01T01:00:00Z",
11
11
  "currency": "USD",
12
12
  "download_uri": "https://url...",
13
- "invoice_line_items": [
14
- {
15
- "amount": 1.0,
16
- "created_at": "2000-01-01T01:00:00Z",
17
- "description": "Service from 2019-01-01 through 2019-12-31",
18
- "type": "invoice",
19
- "service_end_at": "2000-01-01T01:00:00Z",
20
- "service_start_at": "2000-01-01T01:00:00Z",
21
- "updated_at": "2000-01-01T01:00:00Z",
22
- "plan": "Enterprise",
23
- "site": "My site"
24
- }
25
- ],
13
+ "invoice_line_items": {
14
+ "amount": 1.0,
15
+ "created_at": "2000-01-01T01:00:00Z",
16
+ "description": "Service from 2019-01-01 through 2019-12-31",
17
+ "type": "invoice",
18
+ "service_end_at": "2000-01-01T01:00:00Z",
19
+ "service_start_at": "2000-01-01T01:00:00Z",
20
+ "updated_at": "2000-01-01T01:00:00Z",
21
+ "plan": "Enterprise",
22
+ "site": "My site"
23
+ },
26
24
  "method": "paypal",
27
- "payment_line_items": [
28
- {
29
- "amount": 1.0,
30
- "created_at": "2000-01-01T01:00:00Z",
31
- "invoice_id": 1,
32
- "payment_id": 1,
33
- "updated_at": "2000-01-01T01:00:00Z"
34
- }
35
- ],
25
+ "payment_line_items": {
26
+ "amount": 1.0,
27
+ "created_at": "2000-01-01T01:00:00Z",
28
+ "invoice_id": 1,
29
+ "payment_id": 1,
30
+ "updated_at": "2000-01-01T01:00:00Z"
31
+ },
36
32
  "payment_reversed_at": "2000-01-01T01:00:00Z",
37
33
  "payment_type": "",
38
34
  "site_name": "My Site",
@@ -47,9 +43,9 @@
47
43
  * `created_at` (date-time): Line item created at
48
44
  * `currency` (string): Line item currency
49
45
  * `download_uri` (string): Line item download uri
50
- * `invoice_line_items` (array): Associated invoice line items
46
+ * `invoice_line_items`: Associated invoice line items
51
47
  * `method` (string): Line item payment method
52
- * `payment_line_items` (array): Associated payment line items
48
+ * `payment_line_items`: Associated payment line items
53
49
  * `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
54
50
  * `payment_type` (string): Type of payment if applicable
55
51
  * `site_name` (string): Site name this line item is for
data/docs/message.md CHANGED
@@ -7,25 +7,21 @@
7
7
  "id": 1,
8
8
  "subject": "Files.com Account Upgrade",
9
9
  "body": "We should upgrade our Files.com account!",
10
- "comments": [
11
- {
10
+ "comments": {
11
+ "id": 1,
12
+ "body": "What a great idea, thank you!",
13
+ "reactions": {
12
14
  "id": 1,
13
- "body": "What a great idea, thank you!",
14
- "reactions": [
15
- {
16
- "id": 1,
17
- "emoji": "👍"
18
- }
19
- ]
15
+ "emoji": "👍"
20
16
  }
21
- ]
17
+ }
22
18
  }
23
19
  ```
24
20
 
25
21
  * `id` (int64): Message ID
26
22
  * `subject` (string): Message subject.
27
23
  * `body` (string): Message body.
28
- * `comments` (array): Comments.
24
+ * `comments`: Comments.
29
25
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
30
26
  * `project_id` (int64): Project to which the message should be attached.
31
27
 
@@ -6,18 +6,16 @@
6
6
  {
7
7
  "id": 1,
8
8
  "body": "What a great idea, thank you!",
9
- "reactions": [
10
- {
11
- "id": 1,
12
- "emoji": "👍"
13
- }
14
- ]
9
+ "reactions": {
10
+ "id": 1,
11
+ "emoji": "👍"
12
+ }
15
13
  }
16
14
  ```
17
15
 
18
16
  * `id` (int64): Message Comment ID
19
17
  * `body` (string): Comment body.
20
- * `reactions` (array): Reactions to this comment.
18
+ * `reactions`: Reactions to this comment.
21
19
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
22
20
 
23
21
 
data/docs/payment.md CHANGED
@@ -10,29 +10,25 @@
10
10
  "created_at": "2000-01-01T01:00:00Z",
11
11
  "currency": "USD",
12
12
  "download_uri": "https://url...",
13
- "invoice_line_items": [
14
- {
15
- "amount": 1.0,
16
- "created_at": "2000-01-01T01:00:00Z",
17
- "description": "Service from 2019-01-01 through 2019-12-31",
18
- "type": "invoice",
19
- "service_end_at": "2000-01-01T01:00:00Z",
20
- "service_start_at": "2000-01-01T01:00:00Z",
21
- "updated_at": "2000-01-01T01:00:00Z",
22
- "plan": "Enterprise",
23
- "site": "My site"
24
- }
25
- ],
13
+ "invoice_line_items": {
14
+ "amount": 1.0,
15
+ "created_at": "2000-01-01T01:00:00Z",
16
+ "description": "Service from 2019-01-01 through 2019-12-31",
17
+ "type": "invoice",
18
+ "service_end_at": "2000-01-01T01:00:00Z",
19
+ "service_start_at": "2000-01-01T01:00:00Z",
20
+ "updated_at": "2000-01-01T01:00:00Z",
21
+ "plan": "Enterprise",
22
+ "site": "My site"
23
+ },
26
24
  "method": "paypal",
27
- "payment_line_items": [
28
- {
29
- "amount": 1.0,
30
- "created_at": "2000-01-01T01:00:00Z",
31
- "invoice_id": 1,
32
- "payment_id": 1,
33
- "updated_at": "2000-01-01T01:00:00Z"
34
- }
35
- ],
25
+ "payment_line_items": {
26
+ "amount": 1.0,
27
+ "created_at": "2000-01-01T01:00:00Z",
28
+ "invoice_id": 1,
29
+ "payment_id": 1,
30
+ "updated_at": "2000-01-01T01:00:00Z"
31
+ },
36
32
  "payment_reversed_at": "2000-01-01T01:00:00Z",
37
33
  "payment_type": "",
38
34
  "site_name": "My Site",
@@ -47,9 +43,9 @@
47
43
  * `created_at` (date-time): Line item created at
48
44
  * `currency` (string): Line item currency
49
45
  * `download_uri` (string): Line item download uri
50
- * `invoice_line_items` (array): Associated invoice line items
46
+ * `invoice_line_items`: Associated invoice line items
51
47
  * `method` (string): Line item payment method
52
- * `payment_line_items` (array): Associated payment line items
48
+ * `payment_line_items`: Associated payment line items
53
49
  * `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
54
50
  * `payment_type` (string): Type of payment if applicable
55
51
  * `site_name` (string): Site name this line item is for
data/docs/sso_strategy.md CHANGED
@@ -4,9 +4,7 @@
4
4
 
5
5
  ```
6
6
  {
7
- "protocol": [
8
- "okta"
9
- ],
7
+ "protocol": "oauth2",
10
8
  "provider": "okta",
11
9
  "label": "My Corporate SSO Provider",
12
10
  "logo_url": "https://mysite.files.com/.../logo.png",
@@ -51,7 +49,7 @@
51
49
  }
52
50
  ```
53
51
 
54
- * `protocol` (array): SSO Protocol
52
+ * `protocol` (string): SSO Protocol
55
53
  * `provider` (string): Provider name
56
54
  * `label` (string): Custom label for the SSO provider on the login page.
57
55
  * `logo_url` (string): URL holding a custom logo for the SSO provider on the login page.
data/docs/status.md CHANGED
@@ -8,16 +8,14 @@
8
8
  "message": "",
9
9
  "status": "",
10
10
  "data": "",
11
- "errors": [
12
- {
13
- "fields": [
11
+ "errors": {
12
+ "fields": [
14
13
 
15
- ],
16
- "messages": [
14
+ ],
15
+ "messages": [
17
16
 
18
- ]
19
- }
20
- ],
17
+ ]
18
+ },
21
19
  "clickwrap_id": 1,
22
20
  "clickwrap_body": ""
23
21
  }
@@ -27,6 +25,6 @@
27
25
  * `message` (string): Error message
28
26
  * `status` (string): Status message
29
27
  * `data`: Additional data
30
- * `errors` (array): A list of api errors
28
+ * `errors`: A list of api errors
31
29
  * `clickwrap_id` (int64): Required Clickwrap id
32
30
  * `clickwrap_body` (string): Required Clickwrap body
@@ -39,7 +39,7 @@ module Files
39
39
  @attributes[:download_uri]
40
40
  end
41
41
 
42
- # array - Associated invoice line items
42
+ # Associated invoice line items
43
43
  def invoice_line_items
44
44
  @attributes[:invoice_line_items]
45
45
  end
@@ -49,7 +49,7 @@ module Files
49
49
  @attributes[:method]
50
50
  end
51
51
 
52
- # array - Associated payment line items
52
+ # Associated payment line items
53
53
  def payment_line_items
54
54
  @attributes[:payment_line_items]
55
55
  end
@@ -72,15 +72,6 @@ module Files
72
72
  @attributes[:source] = value
73
73
  end
74
74
 
75
- # string - DEPRECATED: Destination Path
76
- def destination
77
- @attributes[:destination]
78
- end
79
-
80
- def destination=(value)
81
- @attributes[:destination] = value
82
- end
83
-
84
75
  # string - Destination Path
85
76
  def destinations
86
77
  @attributes[:destinations]
@@ -180,10 +171,19 @@ module Files
180
171
  @attributes[:value] = value
181
172
  end
182
173
 
174
+ # string - DEPRECATED: Destination Path. Use `destinations` instead.
175
+ def destination
176
+ @attributes[:destination]
177
+ end
178
+
179
+ def destination=(value)
180
+ @attributes[:destination] = value
181
+ end
182
+
183
183
  # Parameters:
184
184
  # automation (required) - string - Automation type
185
185
  # source - string - Source Path
186
- # destination - string - DEPRECATED: Destination Path
186
+ # destination - string - DEPRECATED: Destination Path. Use `destinations` instead.
187
187
  # destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
188
188
  # destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
189
189
  # destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
@@ -294,7 +294,7 @@ module Files
294
294
  # Parameters:
295
295
  # automation (required) - string - Automation type
296
296
  # source - string - Source Path
297
- # destination - string - DEPRECATED: Destination Path
297
+ # destination - string - DEPRECATED: Destination Path. Use `destinations` instead.
298
298
  # destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
299
299
  # destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
300
300
  # destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
@@ -332,7 +332,7 @@ module Files
332
332
  # Parameters:
333
333
  # automation (required) - string - Automation type
334
334
  # source - string - Source Path
335
- # destination - string - DEPRECATED: Destination Path
335
+ # destination - string - DEPRECATED: Destination Path. Use `destinations` instead.
336
336
  # destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
337
337
  # destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
338
338
  # destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
@@ -197,9 +197,9 @@ module Files
197
197
  # Send email(s) with a link to bundle
198
198
  #
199
199
  # Parameters:
200
- # to (required) - array(string) - A list of email addresses to share this bundle with.
200
+ # to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used.
201
201
  # note - string - Note to include in email.
202
- # recipients - array(object) - A list of recipients to share this bundle with.
202
+ # recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.
203
203
  def share(params = {})
204
204
  params ||= {}
205
205
  params[:id] = @attributes[:id]
@@ -209,7 +209,6 @@ module Files
209
209
  raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
210
210
  raise InvalidParameterError.new("Bad parameter: recipients must be an Array") if params.dig(:recipients) and !params.dig(:recipients).is_a?(Array)
211
211
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
212
- raise MissingParameterError.new("Parameter missing: to") unless params.dig(:to)
213
212
 
214
213
  Api.send_request("/bundles/#{@attributes[:id]}/share", :post, params, @options)
215
214
  end
@@ -353,9 +352,9 @@ module Files
353
352
  # Send email(s) with a link to bundle
354
353
  #
355
354
  # Parameters:
356
- # to (required) - array(string) - A list of email addresses to share this bundle with.
355
+ # to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used.
357
356
  # note - string - Note to include in email.
358
- # recipients - array(object) - A list of recipients to share this bundle with.
357
+ # recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.
359
358
  def self.share(id, params = {}, options = {})
360
359
  params ||= {}
361
360
  params[:id] = id
@@ -364,7 +363,6 @@ module Files
364
363
  raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
365
364
  raise InvalidParameterError.new("Bad parameter: recipients must be an Array") if params.dig(:recipients) and !params.dig(:recipients).is_a?(Array)
366
365
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
367
- raise MissingParameterError.new("Parameter missing: to") unless params.dig(:to)
368
366
 
369
367
  response, _options = Api.send_request("/bundles/#{params[:id]}/share", :post, params, options)
370
368
  response.data
@@ -31,11 +31,25 @@ module Files
31
31
  # Parameters:
32
32
  # 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.
33
33
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
34
+ # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at`.
35
+ # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
36
+ # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
37
+ # filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`.
38
+ # filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
39
+ # filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`.
40
+ # filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`.
34
41
  # bundle_id - int64 - Bundle ID
35
42
  # bundle_registration_id - int64 - BundleRegistration ID
36
43
  def self.list(params = {}, options = {})
37
44
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
38
45
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
46
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
47
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
48
+ raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
49
+ raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash)
50
+ raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash)
51
+ raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash)
52
+ raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash)
39
53
  raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params.dig(:bundle_id) and !params.dig(:bundle_id).is_a?(Integer)
40
54
  raise InvalidParameterError.new("Bad parameter: bundle_registration_id must be an Integer") if params.dig(:bundle_registration_id) and !params.dig(:bundle_registration_id).is_a?(Integer)
41
55
 
@@ -9,12 +9,12 @@ module Files
9
9
  @options = options || {}
10
10
  end
11
11
 
12
- # string - Type of event being recorded. Valid values: `remote_server_sync`, `lockout`, `ldap_login`, `saml_login`
12
+ # string - Type of event being recorded.
13
13
  def event_type
14
14
  @attributes[:event_type]
15
15
  end
16
16
 
17
- # string - Status of event. Valid values: `error`
17
+ # string - Status of event.
18
18
  def status
19
19
  @attributes[:status]
20
20
  end
@@ -27,7 +27,7 @@ module Files
27
27
  @attributes[:body] = value
28
28
  end
29
29
 
30
- # array - Reactions to this comment.
30
+ # Reactions to this comment.
31
31
  def reactions
32
32
  @attributes[:reactions]
33
33
  end
@@ -36,7 +36,7 @@ module Files
36
36
  @attributes[:form_layout] = value
37
37
  end
38
38
 
39
- # array - Associated form fields
39
+ # Associated form fields
40
40
  def form_fields
41
41
  @attributes[:form_fields]
42
42
  end
@@ -27,7 +27,7 @@ module Files
27
27
  @attributes[:name] = value
28
28
  end
29
29
 
30
- # array - List of user IDs who are group administrators (separated by commas)
30
+ # string - List of user IDs who are group administrators (separated by commas)
31
31
  def admin_ids
32
32
  @attributes[:admin_ids]
33
33
  end
@@ -128,7 +128,7 @@ module Files
128
128
  # Parameters:
129
129
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
130
130
  # inbox_id (required) - int64 - Inbox to share.
131
- # recipient (required) - string - Email addresses to share this inbox with.
131
+ # recipient (required) - string - Email address to share this inbox with.
132
132
  # name - string - Name of recipient.
133
133
  # company - string - Company of recipient.
134
134
  # note - string - Note to include in email.
@@ -26,11 +26,25 @@ module Files
26
26
  # Parameters:
27
27
  # 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.
28
28
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
29
+ # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at`.
30
+ # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
31
+ # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
32
+ # filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`.
33
+ # filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
34
+ # filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`.
35
+ # filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`.
29
36
  # inbox_registration_id - int64 - InboxRegistration ID
30
37
  # inbox_id - int64 - Inbox ID
31
38
  def self.list(params = {}, options = {})
32
39
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
33
40
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
41
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
42
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
43
+ raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
44
+ raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash)
45
+ raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash)
46
+ raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash)
47
+ raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash)
34
48
  raise InvalidParameterError.new("Bad parameter: inbox_registration_id must be an Integer") if params.dig(:inbox_registration_id) and !params.dig(:inbox_registration_id).is_a?(Integer)
35
49
  raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params.dig(:inbox_id) and !params.dig(:inbox_id).is_a?(Integer)
36
50
 
@@ -39,7 +39,7 @@ module Files
39
39
  @attributes[:download_uri]
40
40
  end
41
41
 
42
- # array - Associated invoice line items
42
+ # Associated invoice line items
43
43
  def invoice_line_items
44
44
  @attributes[:invoice_line_items]
45
45
  end
@@ -49,7 +49,7 @@ module Files
49
49
  @attributes[:method]
50
50
  end
51
51
 
52
- # array - Associated payment line items
52
+ # Associated payment line items
53
53
  def payment_line_items
54
54
  @attributes[:payment_line_items]
55
55
  end
@@ -36,7 +36,7 @@ module Files
36
36
  @attributes[:body] = value
37
37
  end
38
38
 
39
- # array - Comments.
39
+ # Comments.
40
40
  def comments
41
41
  @attributes[:comments]
42
42
  end
@@ -27,7 +27,7 @@ module Files
27
27
  @attributes[:body] = value
28
28
  end
29
29
 
30
- # array - Reactions to this comment.
30
+ # Reactions to this comment.
31
31
  def reactions
32
32
  @attributes[:reactions]
33
33
  end
@@ -39,7 +39,7 @@ module Files
39
39
  @attributes[:download_uri]
40
40
  end
41
41
 
42
- # array - Associated invoice line items
42
+ # Associated invoice line items
43
43
  def invoice_line_items
44
44
  @attributes[:invoice_line_items]
45
45
  end
@@ -49,7 +49,7 @@ module Files
49
49
  @attributes[:method]
50
50
  end
51
51
 
52
- # array - Associated payment line items
52
+ # Associated payment line items
53
53
  def payment_line_items
54
54
  @attributes[:payment_line_items]
55
55
  end
@@ -9,7 +9,7 @@ module Files
9
9
  @options = options || {}
10
10
  end
11
11
 
12
- # array - SSO Protocol
12
+ # string - SSO Protocol
13
13
  def protocol
14
14
  @attributes[:protocol]
15
15
  end
@@ -29,7 +29,7 @@ module Files
29
29
  @attributes[:data]
30
30
  end
31
31
 
32
- # array - A list of api errors
32
+ # A list of api errors
33
33
  def errors
34
34
  @attributes[:errors]
35
35
  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.154
4
+ version: 1.0.159
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-29 00:00:00.000000000 Z
11
+ date: 2021-04-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable