files.com 1.0.342 → 1.0.344

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: f7458797b6e16bae6a2cc875ce51e4260071662654c0409f1c4c6a2e52a13c6e
4
- data.tar.gz: cd8927cc6fd7e377d235023f9619ddebd85c799cac5456349f168b2290eff83f
3
+ metadata.gz: e998a43775abe983b4df5de11fb0710b77851d07597a6c4bc6a3a6b793d134a5
4
+ data.tar.gz: b0a613d4e127e3f74abeb0d5f7f27d10934045f738094f1df5a742960e4ab615
5
5
  SHA512:
6
- metadata.gz: b5cf369b8c58189785b6cad2660067ca1a558cdf29468558e6ab790639511568ea1b292c8a6a958ae3f4453251737e77f1c60920722868ef26902d9048ceb548
7
- data.tar.gz: 1e2e6db344b59a26fdbda10284151f02e9e9ba275c561b100b5136a02561bd87cdabf21c93586e5bab375edfe2a3219136a9527156227787178240dc39ac7dd5
6
+ metadata.gz: 41ea84db12136eee0a9294684b77e908ca408c99b0931b827e716106676aec34cb79728ee3249408583e88effce42be3ae8290bc01cf8d0ce384cb8a4f873dbe
7
+ data.tar.gz: c96ab2737e8c509b2f44289c69b2d36ff25240c68bdfc8dafd7d6b7f254fc4b34e147ca935da89bcecd8342f1e2eaa0ec5aa4e123c30ce18e08ab49f62b442d6
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.342
1
+ 1.0.344
@@ -38,9 +38,9 @@ Files::AutomationRun.list(
38
38
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
39
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.
40
40
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
41
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `status`.
42
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
41
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[automation_id]=desc`). Valid fields are `automation_id`, `created_at` or `status`.
43
42
  * `automation_id` (int64): Required - ID of the associated Automation.
43
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `automation_id`. Valid field combinations are `[ automation_id, status ]`.
44
44
 
45
45
 
46
46
  ---
data/docs/behavior.md CHANGED
@@ -17,7 +17,7 @@
17
17
  ```
18
18
 
19
19
  * `id` (int64): Folder behavior ID
20
- * `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
20
+ * `path` (string): Folder path. Note that Behavior paths cannot be updated once initially set. You will need to remove and re-create the behavior on the new path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
21
21
  * `attachment_url` (string): URL for attached file
22
22
  * `behavior` (string): Behavior type.
23
23
  * `name` (string): Name for this behavior.
data/docs/folder.md CHANGED
@@ -75,7 +75,7 @@ Files::Folder.list_for(path,
75
75
  * `cursor` (string): Send cursor 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 or the X-Files-Cursor-Prev header.
76
76
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
77
77
  * `path` (string): Required - Path to operate on.
78
- * `filter` (string): If specified, will filter folders/files list by this string. Wildcards of `*` and `?` are acceptable here.
78
+ * `filter` (string): If specified, will filter folders/files list by name. Ignores text before last `/`. Wildcards of `*` and `?` are acceptable here.
79
79
  * `preview_size` (string): Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
80
80
  * `sort_by` (object): Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`. Valid directions are `asc` and `desc`. Defaults to `{"path":"asc"}`.
81
81
  * `search` (string): If `search_all` is `true`, provide the search string here. Otherwise, this parameter acts like an alias of `filter`.
@@ -43,16 +43,16 @@ module Files
43
43
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
44
44
  # 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.
45
45
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
46
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `status`.
47
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
46
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[automation_id]=desc`). Valid fields are `automation_id`, `created_at` or `status`.
48
47
  # automation_id (required) - int64 - ID of the associated Automation.
48
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `automation_id`. Valid field combinations are `[ automation_id, status ]`.
49
49
  def self.list(params = {}, options = {})
50
50
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
51
51
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
52
52
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
53
53
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
54
- raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
55
54
  raise InvalidParameterError.new("Bad parameter: automation_id must be an Integer") if params[:automation_id] and !params[:automation_id].is_a?(Integer)
55
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
56
56
  raise MissingParameterError.new("Parameter missing: automation_id") unless params[:automation_id]
57
57
 
58
58
  List.new(AutomationRun, params) do
@@ -18,7 +18,7 @@ module Files
18
18
  @attributes[:id] = value
19
19
  end
20
20
 
21
- # string - Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
21
+ # string - Folder path. Note that Behavior paths cannot be updated once initially set. You will need to remove and re-create the behavior on the new path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
22
22
  def path
23
23
  @attributes[:path]
24
24
  end
@@ -326,7 +326,7 @@ module Files
326
326
  # cursor - string - Send cursor 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 or the X-Files-Cursor-Prev header.
327
327
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
328
328
  # path (required) - string - Path to operate on.
329
- # filter - string - If specified, will filter folders/files list by this string. Wildcards of `*` and `?` are acceptable here.
329
+ # filter - string - If specified, will filter folders/files list by name. Ignores text before last `/`. Wildcards of `*` and `?` are acceptable here.
330
330
  # preview_size - string - Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
331
331
  # sort_by - object - Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`. Valid directions are `asc` and `desc`. Defaults to `{"path":"asc"}`.
332
332
  # search - string - If `search_all` is `true`, provide the search string here. Otherwise, this parameter acts like an alias of `filter`.
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.342
4
+ version: 1.0.344
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-04-24 00:00:00.000000000 Z
11
+ date: 2023-04-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable