|
@@ -67,12 +67,12 @@ module Files
|
67
67
|
# Parameters:
|
68
68
|
# 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.
|
69
69
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
70
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `path`, `remote_ip`, `success` or `created_at`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ path ]`, `[ remote_ip ]`, `[ success ]`, `[ created_at ]`, `[ start_date, end_date ]`, `[ start_date, path ]`, `[ start_date, remote_ip ]`, `[ start_date, success ]`, `[ start_date, created_at ]`, `[ end_date, path ]`, `[ end_date, remote_ip ]`, `[ end_date, success ]`, `[ end_date, created_at ]`, `[ path, remote_ip ]`, `[ path, success ]`, `[ path, created_at ]`, `[ remote_ip, success ]`, `[ remote_ip, created_at ]`, `[ success, created_at ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, remote_ip ]`, `[ start_date, end_date, success ]`, `[ start_date, end_date, created_at ]`, `[ start_date, path, remote_ip ]`, `[ start_date, path, success ]`, `[ start_date, path, created_at ]`, `[ start_date, remote_ip, success ]`, `[ start_date, remote_ip, created_at ]`, `[ start_date, success, created_at ]`, `[ end_date, path, remote_ip ]`, `[ end_date, path, success ]`, `[ end_date, path, created_at ]`, `[ end_date, remote_ip, success ]`, `[ end_date, remote_ip, created_at ]`, `[ end_date, success, created_at ]`, `[ path, remote_ip, success ]`, `[ path, remote_ip, created_at ]`, `[ path, success, created_at ]`, `[ remote_ip, success, created_at ]`, `[ start_date, end_date, path, remote_ip ]`, `[ start_date, end_date, path, success ]`, `[ start_date, end_date, path, created_at ]`, `[ start_date, end_date, remote_ip, success ]`, `[ start_date, end_date, remote_ip, created_at ]`, `[ start_date, end_date, success, created_at ]`, `[ start_date, path, remote_ip, success ]`, `[ start_date, path, remote_ip, created_at ]`, `[ start_date, path, success, created_at ]`, `[ start_date, remote_ip, success, created_at ]`, `[ end_date, path, remote_ip, success ]`, `[ end_date, path, remote_ip, created_at ]`, `[ end_date, path, success, created_at ]`, `[ end_date, remote_ip, success, created_at ]`, `[ path, remote_ip, success, created_at ]`, `[ start_date, end_date, path, remote_ip, success ]`, `[ start_date, end_date, path, remote_ip, created_at ]`, `[ start_date, end_date, path, success, created_at ]`, `[ start_date, end_date, remote_ip, success, created_at ]`, `[ start_date, path, remote_ip, success, created_at ]` or `[ end_date, path, remote_ip, success, created_at ]`.
|
71
|
-
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ path ]`, `[ remote_ip ]`, `[ success ]`, `[ created_at ]`, `[ start_date, end_date ]`, `[ start_date, path ]`, `[ start_date, remote_ip ]`, `[ start_date, success ]`, `[ start_date, created_at ]`, `[ end_date, path ]`, `[ end_date, remote_ip ]`, `[ end_date, success ]`, `[ end_date, created_at ]`, `[ path, remote_ip ]`, `[ path, success ]`, `[ path, created_at ]`, `[ remote_ip, success ]`, `[ remote_ip, created_at ]`, `[ success, created_at ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, remote_ip ]`, `[ start_date, end_date, success ]`, `[ start_date, end_date, created_at ]`, `[ start_date, path, remote_ip ]`, `[ start_date, path, success ]`, `[ start_date, path, created_at ]`, `[ start_date, remote_ip, success ]`, `[ start_date, remote_ip, created_at ]`, `[ start_date, success, created_at ]`, `[ end_date, path, remote_ip ]`, `[ end_date, path, success ]`, `[ end_date, path, created_at ]`, `[ end_date, remote_ip, success ]`, `[ end_date, remote_ip, created_at ]`, `[ end_date, success, created_at ]`, `[ path, remote_ip, success ]`, `[ path, remote_ip, created_at ]`, `[ path, success, created_at ]`, `[ remote_ip, success, created_at ]`, `[ start_date, end_date, path, remote_ip ]`, `[ start_date, end_date, path, success ]`, `[ start_date, end_date, path, created_at ]`, `[ start_date, end_date, remote_ip, success ]`, `[ start_date, end_date, remote_ip, created_at ]`, `[ start_date, end_date, success, created_at ]`, `[ start_date, path, remote_ip, success ]`, `[ start_date, path, remote_ip, created_at ]`, `[ start_date, path, success, created_at ]`, `[ start_date, remote_ip, success, created_at ]`, `[ end_date, path, remote_ip, success ]`, `[ end_date, path, remote_ip, created_at ]`, `[ end_date, path, success, created_at ]`, `[ end_date, remote_ip, success, created_at ]`, `[ path, remote_ip, success, created_at ]`, `[ start_date, end_date, path, remote_ip, success ]`, `[ start_date, end_date, path, remote_ip, created_at ]`, `[ start_date, end_date, path, success, created_at ]`, `[ start_date, end_date, remote_ip, success, created_at ]`, `[ start_date, path, remote_ip, success, created_at ]` or `[ end_date, path, remote_ip, success, created_at ]`.
|
72
|
-
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ path ]`, `[ remote_ip ]`, `[ success ]`, `[ created_at ]`, `[ start_date, end_date ]`, `[ start_date, path ]`, `[ start_date, remote_ip ]`, `[ start_date, success ]`, `[ start_date, created_at ]`, `[ end_date, path ]`, `[ end_date, remote_ip ]`, `[ end_date, success ]`, `[ end_date, created_at ]`, `[ path, remote_ip ]`, `[ path, success ]`, `[ path, created_at ]`, `[ remote_ip, success ]`, `[ remote_ip, created_at ]`, `[ success, created_at ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, remote_ip ]`, `[ start_date, end_date, success ]`, `[ start_date, end_date, created_at ]`, `[ start_date, path, remote_ip ]`, `[ start_date, path, success ]`, `[ start_date, path, created_at ]`, `[ start_date, remote_ip, success ]`, `[ start_date, remote_ip, created_at ]`, `[ start_date, success, created_at ]`, `[ end_date, path, remote_ip ]`, `[ end_date, path, success ]`, `[ end_date, path, created_at ]`, `[ end_date, remote_ip, success ]`, `[ end_date, remote_ip, created_at ]`, `[ end_date, success, created_at ]`, `[ path, remote_ip, success ]`, `[ path, remote_ip, created_at ]`, `[ path, success, created_at ]`, `[ remote_ip, success, created_at ]`, `[ start_date, end_date, path, remote_ip ]`, `[ start_date, end_date, path, success ]`, `[ start_date, end_date, path, created_at ]`, `[ start_date, end_date, remote_ip, success ]`, `[ start_date, end_date, remote_ip, created_at ]`, `[ start_date, end_date, success, created_at ]`, `[ start_date, path, remote_ip, success ]`, `[ start_date, path, remote_ip, created_at ]`, `[ start_date, path, success, created_at ]`, `[ start_date, remote_ip, success, created_at ]`, `[ end_date, path, remote_ip, success ]`, `[ end_date, path, remote_ip, created_at ]`, `[ end_date, path, success, created_at ]`, `[ end_date, remote_ip, success, created_at ]`, `[ path, remote_ip, success, created_at ]`, `[ start_date, end_date, path, remote_ip, success ]`, `[ start_date, end_date, path, remote_ip, created_at ]`, `[ start_date, end_date, path, success, created_at ]`, `[ start_date, end_date, remote_ip, success, created_at ]`, `[ start_date, path, remote_ip, success, created_at ]` or `[ end_date, path, remote_ip, success, created_at ]`.
|
73
|
-
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ path ]`, `[ remote_ip ]`, `[ success ]`, `[ created_at ]`, `[ start_date, end_date ]`, `[ start_date, path ]`, `[ start_date, remote_ip ]`, `[ start_date, success ]`, `[ start_date, created_at ]`, `[ end_date, path ]`, `[ end_date, remote_ip ]`, `[ end_date, success ]`, `[ end_date, created_at ]`, `[ path, remote_ip ]`, `[ path, success ]`, `[ path, created_at ]`, `[ remote_ip, success ]`, `[ remote_ip, created_at ]`, `[ success, created_at ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, remote_ip ]`, `[ start_date, end_date, success ]`, `[ start_date, end_date, created_at ]`, `[ start_date, path, remote_ip ]`, `[ start_date, path, success ]`, `[ start_date, path, created_at ]`, `[ start_date, remote_ip, success ]`, `[ start_date, remote_ip, created_at ]`, `[ start_date, success, created_at ]`, `[ end_date, path, remote_ip ]`, `[ end_date, path, success ]`, `[ end_date, path, created_at ]`, `[ end_date, remote_ip, success ]`, `[ end_date, remote_ip, created_at ]`, `[ end_date, success, created_at ]`, `[ path, remote_ip, success ]`, `[ path, remote_ip, created_at ]`, `[ path, success, created_at ]`, `[ remote_ip, success, created_at ]`, `[ start_date, end_date, path, remote_ip ]`, `[ start_date, end_date, path, success ]`, `[ start_date, end_date, path, created_at ]`, `[ start_date, end_date, remote_ip, success ]`, `[ start_date, end_date, remote_ip, created_at ]`, `[ start_date, end_date, success, created_at ]`, `[ start_date, path, remote_ip, success ]`, `[ start_date, path, remote_ip, created_at ]`, `[ start_date, path, success, created_at ]`, `[ start_date, remote_ip, success, created_at ]`, `[ end_date, path, remote_ip, success ]`, `[ end_date, path, remote_ip, created_at ]`, `[ end_date, path, success, created_at ]`, `[ end_date, remote_ip, success, created_at ]`, `[ path, remote_ip, success, created_at ]`, `[ start_date, end_date, path, remote_ip, success ]`, `[ start_date, end_date, path, remote_ip, created_at ]`, `[ start_date, end_date, path, success, created_at ]`, `[ start_date, end_date, remote_ip, success, created_at ]`, `[ start_date, path, remote_ip, success, created_at ]` or `[ end_date, path, remote_ip, success, created_at ]`.
|
74
|
-
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ path ]`, `[ remote_ip ]`, `[ success ]`, `[ created_at ]`, `[ start_date, end_date ]`, `[ start_date, path ]`, `[ start_date, remote_ip ]`, `[ start_date, success ]`, `[ start_date, created_at ]`, `[ end_date, path ]`, `[ end_date, remote_ip ]`, `[ end_date, success ]`, `[ end_date, created_at ]`, `[ path, remote_ip ]`, `[ path, success ]`, `[ path, created_at ]`, `[ remote_ip, success ]`, `[ remote_ip, created_at ]`, `[ success, created_at ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, remote_ip ]`, `[ start_date, end_date, success ]`, `[ start_date, end_date, created_at ]`, `[ start_date, path, remote_ip ]`, `[ start_date, path, success ]`, `[ start_date, path, created_at ]`, `[ start_date, remote_ip, success ]`, `[ start_date, remote_ip, created_at ]`, `[ start_date, success, created_at ]`, `[ end_date, path, remote_ip ]`, `[ end_date, path, success ]`, `[ end_date, path, created_at ]`, `[ end_date, remote_ip, success ]`, `[ end_date, remote_ip, created_at ]`, `[ end_date, success, created_at ]`, `[ path, remote_ip, success ]`, `[ path, remote_ip, created_at ]`, `[ path, success, created_at ]`, `[ remote_ip, success, created_at ]`, `[ start_date, end_date, path, remote_ip ]`, `[ start_date, end_date, path, success ]`, `[ start_date, end_date, path, created_at ]`, `[ start_date, end_date, remote_ip, success ]`, `[ start_date, end_date, remote_ip, created_at ]`, `[ start_date, end_date, success, created_at ]`, `[ start_date, path, remote_ip, success ]`, `[ start_date, path, remote_ip, created_at ]`, `[ start_date, path, success, created_at ]`, `[ start_date, remote_ip, success, created_at ]`, `[ end_date, path, remote_ip, success ]`, `[ end_date, path, remote_ip, created_at ]`, `[ end_date, path, success, created_at ]`, `[ end_date, remote_ip, success, created_at ]`, `[ path, remote_ip, success, created_at ]`, `[ start_date, end_date, path, remote_ip, success ]`, `[ start_date, end_date, path, remote_ip, created_at ]`, `[ start_date, end_date, path, success, created_at ]`, `[ start_date, end_date, remote_ip, success, created_at ]`, `[ start_date, path, remote_ip, success, created_at ]` or `[ end_date, path, remote_ip, success, created_at ]`.
|
75
|
-
# filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ path ]`, `[ remote_ip ]`, `[ success ]`, `[ created_at ]`, `[ start_date, end_date ]`, `[ start_date, path ]`, `[ start_date, remote_ip ]`, `[ start_date, success ]`, `[ start_date, created_at ]`, `[ end_date, path ]`, `[ end_date, remote_ip ]`, `[ end_date, success ]`, `[ end_date, created_at ]`, `[ path, remote_ip ]`, `[ path, success ]`, `[ path, created_at ]`, `[ remote_ip, success ]`, `[ remote_ip, created_at ]`, `[ success, created_at ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, remote_ip ]`, `[ start_date, end_date, success ]`, `[ start_date, end_date, created_at ]`, `[ start_date, path, remote_ip ]`, `[ start_date, path, success ]`, `[ start_date, path, created_at ]`, `[ start_date, remote_ip, success ]`, `[ start_date, remote_ip, created_at ]`, `[ start_date, success, created_at ]`, `[ end_date, path, remote_ip ]`, `[ end_date, path, success ]`, `[ end_date, path, created_at ]`, `[ end_date, remote_ip, success ]`, `[ end_date, remote_ip, created_at ]`, `[ end_date, success, created_at ]`, `[ path, remote_ip, success ]`, `[ path, remote_ip, created_at ]`, `[ path, success, created_at ]`, `[ remote_ip, success, created_at ]`, `[ start_date, end_date, path, remote_ip ]`, `[ start_date, end_date, path, success ]`, `[ start_date, end_date, path, created_at ]`, `[ start_date, end_date, remote_ip, success ]`, `[ start_date, end_date, remote_ip, created_at ]`, `[ start_date, end_date, success, created_at ]`, `[ start_date, path, remote_ip, success ]`, `[ start_date, path, remote_ip, created_at ]`, `[ start_date, path, success, created_at ]`, `[ start_date, remote_ip, success, created_at ]`, `[ end_date, path, remote_ip, success ]`, `[ end_date, path, remote_ip, created_at ]`, `[ end_date, path, success, created_at ]`, `[ end_date, remote_ip, success, created_at ]`, `[ path, remote_ip, success, created_at ]`, `[ start_date, end_date, path, remote_ip, success ]`, `[ start_date, end_date, path, remote_ip, created_at ]`, `[ start_date, end_date, path, success, created_at ]`, `[ start_date, end_date, remote_ip, success, created_at ]`, `[ start_date, path, remote_ip, success, created_at ]` or `[ end_date, path, remote_ip, success, created_at ]`.
|
70
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `remote_ip`, `success` or `created_at`. Valid field combinations are `[ path ]`, `[ remote_ip ]`, `[ success ]`, `[ created_at ]`, `[ path, remote_ip ]`, `[ path, success ]`, `[ path, created_at ]`, `[ remote_ip, success ]`, `[ remote_ip, created_at ]`, `[ success, created_at ]`, `[ path, remote_ip, success ]`, `[ path, remote_ip, created_at ]`, `[ path, success, created_at ]`, `[ remote_ip, success, created_at ]` or `[ path, remote_ip, success, created_at ]`.
|
71
|
+
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ path ]`, `[ remote_ip ]`, `[ success ]`, `[ created_at ]`, `[ path, remote_ip ]`, `[ path, success ]`, `[ path, created_at ]`, `[ remote_ip, success ]`, `[ remote_ip, created_at ]`, `[ success, created_at ]`, `[ path, remote_ip, success ]`, `[ path, remote_ip, created_at ]`, `[ path, success, created_at ]`, `[ remote_ip, success, created_at ]` or `[ path, remote_ip, success, created_at ]`.
|
72
|
+
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ path ]`, `[ remote_ip ]`, `[ success ]`, `[ created_at ]`, `[ path, remote_ip ]`, `[ path, success ]`, `[ path, created_at ]`, `[ remote_ip, success ]`, `[ remote_ip, created_at ]`, `[ success, created_at ]`, `[ path, remote_ip, success ]`, `[ path, remote_ip, created_at ]`, `[ path, success, created_at ]`, `[ remote_ip, success, created_at ]` or `[ path, remote_ip, success, created_at ]`.
|
73
|
+
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`. Valid field combinations are `[ path ]`, `[ remote_ip ]`, `[ success ]`, `[ created_at ]`, `[ path, remote_ip ]`, `[ path, success ]`, `[ path, created_at ]`, `[ remote_ip, success ]`, `[ remote_ip, created_at ]`, `[ success, created_at ]`, `[ path, remote_ip, success ]`, `[ path, remote_ip, created_at ]`, `[ path, success, created_at ]`, `[ remote_ip, success, created_at ]` or `[ path, remote_ip, success, created_at ]`.
|
74
|
+
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ path ]`, `[ remote_ip ]`, `[ success ]`, `[ created_at ]`, `[ path, remote_ip ]`, `[ path, success ]`, `[ path, created_at ]`, `[ remote_ip, success ]`, `[ remote_ip, created_at ]`, `[ success, created_at ]`, `[ path, remote_ip, success ]`, `[ path, remote_ip, created_at ]`, `[ path, success, created_at ]`, `[ remote_ip, success, created_at ]` or `[ path, remote_ip, success, created_at ]`.
|
75
|
+
# filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ path ]`, `[ remote_ip ]`, `[ success ]`, `[ created_at ]`, `[ path, remote_ip ]`, `[ path, success ]`, `[ path, created_at ]`, `[ remote_ip, success ]`, `[ remote_ip, created_at ]`, `[ success, created_at ]`, `[ path, remote_ip, success ]`, `[ path, remote_ip, created_at ]`, `[ path, success, created_at ]`, `[ remote_ip, success, created_at ]` or `[ path, remote_ip, success, created_at ]`.
|
76
76
|
def self.list(params = {}, options = {})
|
77
77
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
78
78
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|