files-com 1.6.208__py3-none-any.whl

files_sdk/models/automation.py

@@ -0,0 +1,823 @@
+import builtins  # noqa: F401
+from files_sdk.api import Api  # noqa: F401
+from files_sdk.list_obj import ListObj
+from files_sdk.error import (  # noqa: F401
+    InvalidParameterError,
+    MissingParameterError,
+    NotImplementedError,
+)
+
+
+class Automation:
+    default_attributes = {
+        "id": None,  # int64 - Automation ID
+        "workspace_id": None,  # int64 - Workspace ID
+        "always_serialize_jobs": None,  # boolean - Ordinarily, we will allow automation runs to run in parallel for non-scheduled automations. If this flag is `true` we will force automation runs to be serialized (run one at a time, one after another). This can resolve some issues with race conditions on remote systems at the cost of some performance.
+        "always_overwrite_size_matching_files": None,  # boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer.  If this flag is `true` we will overwrite the destination file always.  Note that this may cause large amounts of wasted transfer usage.  This setting has no effect unless `overwrite_files` is also set to `true`.
+        "automation": None,  # string - Automation type
+        "deleted": None,  # boolean - Indicates if the automation has been deleted.
+        "description": None,  # string - Description for the this Automation.
+        "destination_replace_from": None,  # string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
+        "destination_replace_to": None,  # string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
+        "destinations": None,  # array(string) - Destination Paths
+        "disabled": None,  # boolean - If true, this automation will not run.
+        "exclude_pattern": None,  # string - If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
+        "import_urls": None,  # array(object) - List of URLs to be imported and names to be used.
+        "flatten_destination_structure": None,  # boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
+        "group_ids": None,  # array(int64) - IDs of Groups for the Automation (i.e. who to Request File from)
+        "ignore_locked_folders": None,  # boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
+        "interval": None,  # string - If trigger is `daily`, this specifies how often to run this automation.  One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
+        "last_modified_at": None,  # date-time - Time when automation was last modified. Does not change for name or description updates.
+        "legacy_folder_matching": None,  # boolean - If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files.  This behavior no longer works and should not be used.
+        "name": None,  # string - Name for this automation.
+        "overwrite_files": None,  # boolean - If true, existing files will be overwritten with new files on Move/Copy automations.  Note: by default files will not be overwritten on Copy automations if they appear to be the same file size as the newly incoming file.  Use the `always_overwrite_size_matching_files` option in conjunction with `overwrite_files` to override this behavior and overwrite files no matter what.
+        "path": None,  # string - Path on which this Automation runs.  Supports globs, except on remote mounts. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+        "path_time_zone": None,  # string - Timezone to use when rendering timestamps in paths.
+        "recurring_day": None,  # int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
+        "retry_on_failure_interval_in_minutes": None,  # int64 - If the Automation fails, retry at this interval (in minutes).  Acceptable values are 5 through 1440 (one day).  Set to null to disable.
+        "retry_on_failure_number_of_attempts": None,  # int64 - If the Automation fails, retry at most this many times.  Maximum allowed value: 10.  Set to null to disable.
+        "schedule": None,  # object - If trigger is `custom_schedule`, Custom schedule description for when the automation should be run in json format.
+        "human_readable_schedule": None,  # string - If trigger is `custom_schedule`, Human readable Custom schedule description for when the automation should be run.
+        "schedule_days_of_week": None,  # array(int64) - If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
+        "schedule_times_of_day": None,  # array(string) - If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. Times of day in HH:MM format.
+        "schedule_time_zone": None,  # string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the automation should be run.
+        "source": None,  # string - Source path/glob.  See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
+        "legacy_sync_ids": None,  # array(int64) - IDs of remote sync folder behaviors to run by this Automation
+        "sync_ids": None,  # array(int64) - IDs of syncs to run by this Automation. This is the new way to specify syncs, and it is recommended to use this instead of `legacy_sync_ids`.
+        "trigger_actions": None,  # array(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, archived_delete, copy
+        "trigger": None,  # string - How this automation is triggered to run.
+        "user_id": None,  # int64 - User ID of the Automation's creator.
+        "user_ids": None,  # array(int64) - IDs of Users for the Automation (i.e. who to Request File from)
+        "value": None,  # object - A Hash of attributes specific to the automation type.
+        "webhook_url": None,  # string - If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
+        "holiday_region": None,  # string - If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
+    }
+
+    def __init__(self, attributes=None, options=None):
+        if not isinstance(attributes, dict):
+            attributes = {}
+        if not isinstance(options, dict):
+            options = {}
+        self.set_attributes(attributes)
+        self.options = options
+
+    def set_attributes(self, attributes):
+        for attribute, default_value in Automation.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in Automation.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    # Manually Run Automation
+    def manual_run(self, params=None):
+        if not isinstance(params, dict):
+            params = {}
+
+        if hasattr(self, "id") and self.id:
+            params["id"] = self.id
+        else:
+            raise MissingParameterError("Current object doesn't have a id")
+        if "id" not in params:
+            raise MissingParameterError("Parameter missing: id")
+        if "id" in params and not isinstance(params["id"], int):
+            raise InvalidParameterError("Bad parameter: id must be an int")
+        Api.send_request(
+            "POST",
+            "/automations/{id}/manual_run".format(id=params["id"]),
+            params,
+            self.options,
+        )
+
+    # Parameters:
+    #   source - string - Source path/glob.  See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
+    #   destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
+    #   destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
+    #   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.
+    #   interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
+    #   path - string - Path on which this Automation runs.  Supports globs, except on remote mounts.
+    #   legacy_sync_ids - string - A list of legacy sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+    #   sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+    #   user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+    #   group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+    #   schedule_days_of_week - array(int64) - If trigger is `custom_schedule`. A list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
+    #   schedule_times_of_day - array(string) - If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format.
+    #   schedule_time_zone - string - If trigger is `custom_schedule`. Time zone for the schedule.
+    #   holiday_region - string - If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
+    #   always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer.  If this flag is `true` we will overwrite the destination file always.  Note that this may cause large amounts of wasted transfer usage.  This setting has no effect unless `overwrite_files` is also set to `true`.
+    #   always_serialize_jobs - boolean - Ordinarily, we will allow automation runs to run in parallel for non-scheduled automations. If this flag is `true` we will force automation runs to be serialized (run one at a time, one after another). This can resolve some issues with race conditions on remote systems at the cost of some performance.
+    #   description - string - Description for the this Automation.
+    #   disabled - boolean - If true, this automation will not run.
+    #   exclude_pattern - string - If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
+    #   import_urls - array(object) - List of URLs to be imported and names to be used.
+    #   flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
+    #   ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
+    #   legacy_folder_matching - boolean - DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files.  This behavior no longer works and should not be used.
+    #   name - string - Name for this automation.
+    #   overwrite_files - boolean - If true, existing files will be overwritten with new files on Move/Copy automations.  Note: by default files will not be overwritten on Copy automations if they appear to be the same file size as the newly incoming file.  Use the `always_overwrite_size_matching_files` option in conjunction with `overwrite_files` to override this behavior and overwrite files no matter what.
+    #   path_time_zone - string - Timezone to use when rendering timestamps in paths.
+    #   retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes).  Acceptable values are 5 through 1440 (one day).  Set to null to disable.
+    #   retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times.  Maximum allowed value: 10.  Set to null to disable.
+    #   trigger - string - How this automation is triggered to run.
+    #   trigger_actions - array(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, archived_delete, copy
+    #   value - object - A Hash of attributes specific to the automation type.
+    #   recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
+    #   automation - string - Automation type
+    def update(self, params=None):
+        if not isinstance(params, dict):
+            params = {}
+
+        if hasattr(self, "id") and self.id:
+            params["id"] = self.id
+        else:
+            raise MissingParameterError("Current object doesn't have a id")
+        if "id" not in params:
+            raise MissingParameterError("Parameter missing: id")
+        if "id" in params and not isinstance(params["id"], int):
+            raise InvalidParameterError("Bad parameter: id must be an int")
+        if "source" in params and not isinstance(params["source"], str):
+            raise InvalidParameterError("Bad parameter: source must be an str")
+        if "destinations" in params and not isinstance(
+            params["destinations"], builtins.list
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: destinations must be an list"
+            )
+        if "destination_replace_from" in params and not isinstance(
+            params["destination_replace_from"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: destination_replace_from must be an str"
+            )
+        if "destination_replace_to" in params and not isinstance(
+            params["destination_replace_to"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: destination_replace_to must be an str"
+            )
+        if "interval" in params and not isinstance(params["interval"], str):
+            raise InvalidParameterError(
+                "Bad parameter: interval must be an str"
+            )
+        if "path" in params and not isinstance(params["path"], str):
+            raise InvalidParameterError("Bad parameter: path must be an str")
+        if "legacy_sync_ids" in params and not isinstance(
+            params["legacy_sync_ids"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: legacy_sync_ids must be an str"
+            )
+        if "sync_ids" in params and not isinstance(params["sync_ids"], str):
+            raise InvalidParameterError(
+                "Bad parameter: sync_ids must be an str"
+            )
+        if "user_ids" in params and not isinstance(params["user_ids"], str):
+            raise InvalidParameterError(
+                "Bad parameter: user_ids must be an str"
+            )
+        if "group_ids" in params and not isinstance(params["group_ids"], str):
+            raise InvalidParameterError(
+                "Bad parameter: group_ids must be an str"
+            )
+        if "schedule_days_of_week" in params and not isinstance(
+            params["schedule_days_of_week"], builtins.list
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: schedule_days_of_week must be an list"
+            )
+        if "schedule_times_of_day" in params and not isinstance(
+            params["schedule_times_of_day"], builtins.list
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: schedule_times_of_day must be an list"
+            )
+        if "schedule_time_zone" in params and not isinstance(
+            params["schedule_time_zone"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: schedule_time_zone must be an str"
+            )
+        if "holiday_region" in params and not isinstance(
+            params["holiday_region"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: holiday_region must be an str"
+            )
+        if "description" in params and not isinstance(
+            params["description"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: description must be an str"
+            )
+        if "exclude_pattern" in params and not isinstance(
+            params["exclude_pattern"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: exclude_pattern must be an str"
+            )
+        if "import_urls" in params and not isinstance(
+            params["import_urls"], builtins.list
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: import_urls must be an list"
+            )
+        if "name" in params and not isinstance(params["name"], str):
+            raise InvalidParameterError("Bad parameter: name must be an str")
+        if "path_time_zone" in params and not isinstance(
+            params["path_time_zone"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: path_time_zone must be an str"
+            )
+        if (
+            "retry_on_failure_interval_in_minutes" in params
+            and not isinstance(
+                params["retry_on_failure_interval_in_minutes"], int
+            )
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: retry_on_failure_interval_in_minutes must be an int"
+            )
+        if "retry_on_failure_number_of_attempts" in params and not isinstance(
+            params["retry_on_failure_number_of_attempts"], int
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: retry_on_failure_number_of_attempts must be an int"
+            )
+        if "trigger" in params and not isinstance(params["trigger"], str):
+            raise InvalidParameterError(
+                "Bad parameter: trigger must be an str"
+            )
+        if "trigger_actions" in params and not isinstance(
+            params["trigger_actions"], builtins.list
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: trigger_actions must be an list"
+            )
+        if "recurring_day" in params and not isinstance(
+            params["recurring_day"], int
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: recurring_day must be an int"
+            )
+        if "automation" in params and not isinstance(
+            params["automation"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: automation must be an str"
+            )
+        response, _options = Api.send_request(
+            "PATCH",
+            "/automations/{id}".format(id=params["id"]),
+            params,
+            self.options,
+        )
+        return response.data
+
+    def delete(self, params=None):
+        if not isinstance(params, dict):
+            params = {}
+
+        if hasattr(self, "id") and self.id:
+            params["id"] = self.id
+        else:
+            raise MissingParameterError("Current object doesn't have a id")
+        if "id" not in params:
+            raise MissingParameterError("Parameter missing: id")
+        if "id" in params and not isinstance(params["id"], int):
+            raise InvalidParameterError("Bad parameter: id must be an int")
+        Api.send_request(
+            "DELETE",
+            "/automations/{id}".format(id=params["id"]),
+            params,
+            self.options,
+        )
+
+    def destroy(self, params=None):
+        self.delete(params)
+
+    def save(self):
+        if hasattr(self, "id") and self.id:
+            new_obj = self.update(self.get_attributes())
+            self.set_attributes(new_obj.get_attributes())
+            return True
+        else:
+            new_obj = create(self.get_attributes(), self.options)
+            self.set_attributes(new_obj.get_attributes())
+            return True
+
+
+# Parameters:
+#   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.
+#   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+#   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name`, `automation`, `last_modified_at` or `disabled`.
+#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `last_modified_at`, `workspace_id` or `automation`. Valid field combinations are `[ disabled, last_modified_at ]`, `[ workspace_id, disabled ]`, `[ disabled, automation ]`, `[ workspace_id, last_modified_at ]`, `[ automation, last_modified_at ]`, `[ workspace_id, automation ]`, `[ workspace_id, disabled, last_modified_at ]`, `[ disabled, automation, last_modified_at ]`, `[ workspace_id, disabled, automation ]`, `[ workspace_id, automation, last_modified_at ]` or `[ workspace_id, disabled, automation, last_modified_at ]`.
+#   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `last_modified_at`.
+#   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `last_modified_at`.
+#   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `last_modified_at`.
+#   filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `last_modified_at`.
+def list(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "cursor" in params and not isinstance(params["cursor"], str):
+        raise InvalidParameterError("Bad parameter: cursor must be an str")
+    if "per_page" in params and not isinstance(params["per_page"], int):
+        raise InvalidParameterError("Bad parameter: per_page must be an int")
+    if "sort_by" in params and not isinstance(params["sort_by"], dict):
+        raise InvalidParameterError("Bad parameter: sort_by must be an dict")
+    if "filter" in params and not isinstance(params["filter"], dict):
+        raise InvalidParameterError("Bad parameter: filter must be an dict")
+    if "filter_gt" in params and not isinstance(params["filter_gt"], dict):
+        raise InvalidParameterError("Bad parameter: filter_gt must be an dict")
+    if "filter_gteq" in params and not isinstance(params["filter_gteq"], dict):
+        raise InvalidParameterError(
+            "Bad parameter: filter_gteq must be an dict"
+        )
+    if "filter_lt" in params and not isinstance(params["filter_lt"], dict):
+        raise InvalidParameterError("Bad parameter: filter_lt must be an dict")
+    if "filter_lteq" in params and not isinstance(params["filter_lteq"], dict):
+        raise InvalidParameterError(
+            "Bad parameter: filter_lteq must be an dict"
+        )
+    return ListObj(Automation, "GET", "/automations", params, options)
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+# Parameters:
+#   id (required) - int64 - Automation ID.
+def find(id, params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    params["id"] = id
+    if "id" in params and not isinstance(params["id"], int):
+        raise InvalidParameterError("Bad parameter: id must be an int")
+    if "id" not in params:
+        raise MissingParameterError("Parameter missing: id")
+    response, options = Api.send_request(
+        "GET", "/automations/{id}".format(id=params["id"]), params, options
+    )
+    return Automation(response.data, options)
+
+
+def get(id, params=None, options=None):
+    find(id, params, options)
+
+
+# Parameters:
+#   source - string - Source path/glob.  See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
+#   destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
+#   destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
+#   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.
+#   interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
+#   path - string - Path on which this Automation runs.  Supports globs, except on remote mounts.
+#   legacy_sync_ids - string - A list of legacy sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+#   sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+#   user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+#   group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+#   schedule_days_of_week - array(int64) - If trigger is `custom_schedule`. A list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
+#   schedule_times_of_day - array(string) - If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format.
+#   schedule_time_zone - string - If trigger is `custom_schedule`. Time zone for the schedule.
+#   holiday_region - string - If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
+#   always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer.  If this flag is `true` we will overwrite the destination file always.  Note that this may cause large amounts of wasted transfer usage.  This setting has no effect unless `overwrite_files` is also set to `true`.
+#   always_serialize_jobs - boolean - Ordinarily, we will allow automation runs to run in parallel for non-scheduled automations. If this flag is `true` we will force automation runs to be serialized (run one at a time, one after another). This can resolve some issues with race conditions on remote systems at the cost of some performance.
+#   description - string - Description for the this Automation.
+#   disabled - boolean - If true, this automation will not run.
+#   exclude_pattern - string - If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
+#   import_urls - array(object) - List of URLs to be imported and names to be used.
+#   flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
+#   ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
+#   legacy_folder_matching - boolean - DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files.  This behavior no longer works and should not be used.
+#   name - string - Name for this automation.
+#   overwrite_files - boolean - If true, existing files will be overwritten with new files on Move/Copy automations.  Note: by default files will not be overwritten on Copy automations if they appear to be the same file size as the newly incoming file.  Use the `always_overwrite_size_matching_files` option in conjunction with `overwrite_files` to override this behavior and overwrite files no matter what.
+#   path_time_zone - string - Timezone to use when rendering timestamps in paths.
+#   retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes).  Acceptable values are 5 through 1440 (one day).  Set to null to disable.
+#   retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times.  Maximum allowed value: 10.  Set to null to disable.
+#   trigger - string - How this automation is triggered to run.
+#   trigger_actions - array(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, archived_delete, copy
+#   value - object - A Hash of attributes specific to the automation type.
+#   recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
+#   automation (required) - string - Automation type
+#   workspace_id - int64 - Workspace ID
+def create(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "source" in params and not isinstance(params["source"], str):
+        raise InvalidParameterError("Bad parameter: source must be an str")
+    if "destinations" in params and not isinstance(
+        params["destinations"], builtins.list
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: destinations must be an list"
+        )
+    if "destination_replace_from" in params and not isinstance(
+        params["destination_replace_from"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: destination_replace_from must be an str"
+        )
+    if "destination_replace_to" in params and not isinstance(
+        params["destination_replace_to"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: destination_replace_to must be an str"
+        )
+    if "interval" in params and not isinstance(params["interval"], str):
+        raise InvalidParameterError("Bad parameter: interval must be an str")
+    if "path" in params and not isinstance(params["path"], str):
+        raise InvalidParameterError("Bad parameter: path must be an str")
+    if "legacy_sync_ids" in params and not isinstance(
+        params["legacy_sync_ids"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: legacy_sync_ids must be an str"
+        )
+    if "sync_ids" in params and not isinstance(params["sync_ids"], str):
+        raise InvalidParameterError("Bad parameter: sync_ids must be an str")
+    if "user_ids" in params and not isinstance(params["user_ids"], str):
+        raise InvalidParameterError("Bad parameter: user_ids must be an str")
+    if "group_ids" in params and not isinstance(params["group_ids"], str):
+        raise InvalidParameterError("Bad parameter: group_ids must be an str")
+    if "schedule_days_of_week" in params and not isinstance(
+        params["schedule_days_of_week"], builtins.list
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: schedule_days_of_week must be an list"
+        )
+    if "schedule_times_of_day" in params and not isinstance(
+        params["schedule_times_of_day"], builtins.list
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: schedule_times_of_day must be an list"
+        )
+    if "schedule_time_zone" in params and not isinstance(
+        params["schedule_time_zone"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: schedule_time_zone must be an str"
+        )
+    if "holiday_region" in params and not isinstance(
+        params["holiday_region"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: holiday_region must be an str"
+        )
+    if "always_overwrite_size_matching_files" in params and not isinstance(
+        params["always_overwrite_size_matching_files"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: always_overwrite_size_matching_files must be an bool"
+        )
+    if "always_serialize_jobs" in params and not isinstance(
+        params["always_serialize_jobs"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: always_serialize_jobs must be an bool"
+        )
+    if "description" in params and not isinstance(params["description"], str):
+        raise InvalidParameterError(
+            "Bad parameter: description must be an str"
+        )
+    if "disabled" in params and not isinstance(params["disabled"], bool):
+        raise InvalidParameterError("Bad parameter: disabled must be an bool")
+    if "exclude_pattern" in params and not isinstance(
+        params["exclude_pattern"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: exclude_pattern must be an str"
+        )
+    if "import_urls" in params and not isinstance(
+        params["import_urls"], builtins.list
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: import_urls must be an list"
+        )
+    if "flatten_destination_structure" in params and not isinstance(
+        params["flatten_destination_structure"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: flatten_destination_structure must be an bool"
+        )
+    if "ignore_locked_folders" in params and not isinstance(
+        params["ignore_locked_folders"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: ignore_locked_folders must be an bool"
+        )
+    if "legacy_folder_matching" in params and not isinstance(
+        params["legacy_folder_matching"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: legacy_folder_matching must be an bool"
+        )
+    if "name" in params and not isinstance(params["name"], str):
+        raise InvalidParameterError("Bad parameter: name must be an str")
+    if "overwrite_files" in params and not isinstance(
+        params["overwrite_files"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: overwrite_files must be an bool"
+        )
+    if "path_time_zone" in params and not isinstance(
+        params["path_time_zone"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: path_time_zone must be an str"
+        )
+    if "retry_on_failure_interval_in_minutes" in params and not isinstance(
+        params["retry_on_failure_interval_in_minutes"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: retry_on_failure_interval_in_minutes must be an int"
+        )
+    if "retry_on_failure_number_of_attempts" in params and not isinstance(
+        params["retry_on_failure_number_of_attempts"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: retry_on_failure_number_of_attempts must be an int"
+        )
+    if "trigger" in params and not isinstance(params["trigger"], str):
+        raise InvalidParameterError("Bad parameter: trigger must be an str")
+    if "trigger_actions" in params and not isinstance(
+        params["trigger_actions"], builtins.list
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: trigger_actions must be an list"
+        )
+    if "value" in params and not isinstance(params["value"], dict):
+        raise InvalidParameterError("Bad parameter: value must be an dict")
+    if "recurring_day" in params and not isinstance(
+        params["recurring_day"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: recurring_day must be an int"
+        )
+    if "automation" in params and not isinstance(params["automation"], str):
+        raise InvalidParameterError("Bad parameter: automation must be an str")
+    if "workspace_id" in params and not isinstance(
+        params["workspace_id"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: workspace_id must be an int"
+        )
+    if "automation" not in params:
+        raise MissingParameterError("Parameter missing: automation")
+    response, options = Api.send_request(
+        "POST", "/automations", params, options
+    )
+    return Automation(response.data, options)
+
+
+# Manually Run Automation
+def manual_run(id, params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    params["id"] = id
+    if "id" in params and not isinstance(params["id"], int):
+        raise InvalidParameterError("Bad parameter: id must be an int")
+    if "id" not in params:
+        raise MissingParameterError("Parameter missing: id")
+    Api.send_request(
+        "POST",
+        "/automations/{id}/manual_run".format(id=params["id"]),
+        params,
+        options,
+    )
+
+
+# Parameters:
+#   source - string - Source path/glob.  See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
+#   destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
+#   destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
+#   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.
+#   interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
+#   path - string - Path on which this Automation runs.  Supports globs, except on remote mounts.
+#   legacy_sync_ids - string - A list of legacy sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+#   sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+#   user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+#   group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+#   schedule_days_of_week - array(int64) - If trigger is `custom_schedule`. A list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
+#   schedule_times_of_day - array(string) - If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format.
+#   schedule_time_zone - string - If trigger is `custom_schedule`. Time zone for the schedule.
+#   holiday_region - string - If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
+#   always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer.  If this flag is `true` we will overwrite the destination file always.  Note that this may cause large amounts of wasted transfer usage.  This setting has no effect unless `overwrite_files` is also set to `true`.
+#   always_serialize_jobs - boolean - Ordinarily, we will allow automation runs to run in parallel for non-scheduled automations. If this flag is `true` we will force automation runs to be serialized (run one at a time, one after another). This can resolve some issues with race conditions on remote systems at the cost of some performance.
+#   description - string - Description for the this Automation.
+#   disabled - boolean - If true, this automation will not run.
+#   exclude_pattern - string - If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
+#   import_urls - array(object) - List of URLs to be imported and names to be used.
+#   flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
+#   ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
+#   legacy_folder_matching - boolean - DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files.  This behavior no longer works and should not be used.
+#   name - string - Name for this automation.
+#   overwrite_files - boolean - If true, existing files will be overwritten with new files on Move/Copy automations.  Note: by default files will not be overwritten on Copy automations if they appear to be the same file size as the newly incoming file.  Use the `always_overwrite_size_matching_files` option in conjunction with `overwrite_files` to override this behavior and overwrite files no matter what.
+#   path_time_zone - string - Timezone to use when rendering timestamps in paths.
+#   retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes).  Acceptable values are 5 through 1440 (one day).  Set to null to disable.
+#   retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times.  Maximum allowed value: 10.  Set to null to disable.
+#   trigger - string - How this automation is triggered to run.
+#   trigger_actions - array(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, archived_delete, copy
+#   value - object - A Hash of attributes specific to the automation type.
+#   recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
+#   automation - string - Automation type
+def update(id, params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    params["id"] = id
+    if "id" in params and not isinstance(params["id"], int):
+        raise InvalidParameterError("Bad parameter: id must be an int")
+    if "source" in params and not isinstance(params["source"], str):
+        raise InvalidParameterError("Bad parameter: source must be an str")
+    if "destinations" in params and not isinstance(
+        params["destinations"], builtins.list
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: destinations must be an list"
+        )
+    if "destination_replace_from" in params and not isinstance(
+        params["destination_replace_from"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: destination_replace_from must be an str"
+        )
+    if "destination_replace_to" in params and not isinstance(
+        params["destination_replace_to"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: destination_replace_to must be an str"
+        )
+    if "interval" in params and not isinstance(params["interval"], str):
+        raise InvalidParameterError("Bad parameter: interval must be an str")
+    if "path" in params and not isinstance(params["path"], str):
+        raise InvalidParameterError("Bad parameter: path must be an str")
+    if "legacy_sync_ids" in params and not isinstance(
+        params["legacy_sync_ids"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: legacy_sync_ids must be an str"
+        )
+    if "sync_ids" in params and not isinstance(params["sync_ids"], str):
+        raise InvalidParameterError("Bad parameter: sync_ids must be an str")
+    if "user_ids" in params and not isinstance(params["user_ids"], str):
+        raise InvalidParameterError("Bad parameter: user_ids must be an str")
+    if "group_ids" in params and not isinstance(params["group_ids"], str):
+        raise InvalidParameterError("Bad parameter: group_ids must be an str")
+    if "schedule_days_of_week" in params and not isinstance(
+        params["schedule_days_of_week"], builtins.list
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: schedule_days_of_week must be an list"
+        )
+    if "schedule_times_of_day" in params and not isinstance(
+        params["schedule_times_of_day"], builtins.list
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: schedule_times_of_day must be an list"
+        )
+    if "schedule_time_zone" in params and not isinstance(
+        params["schedule_time_zone"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: schedule_time_zone must be an str"
+        )
+    if "holiday_region" in params and not isinstance(
+        params["holiday_region"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: holiday_region must be an str"
+        )
+    if "always_overwrite_size_matching_files" in params and not isinstance(
+        params["always_overwrite_size_matching_files"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: always_overwrite_size_matching_files must be an bool"
+        )
+    if "always_serialize_jobs" in params and not isinstance(
+        params["always_serialize_jobs"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: always_serialize_jobs must be an bool"
+        )
+    if "description" in params and not isinstance(params["description"], str):
+        raise InvalidParameterError(
+            "Bad parameter: description must be an str"
+        )
+    if "disabled" in params and not isinstance(params["disabled"], bool):
+        raise InvalidParameterError("Bad parameter: disabled must be an bool")
+    if "exclude_pattern" in params and not isinstance(
+        params["exclude_pattern"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: exclude_pattern must be an str"
+        )
+    if "import_urls" in params and not isinstance(
+        params["import_urls"], builtins.list
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: import_urls must be an list"
+        )
+    if "flatten_destination_structure" in params and not isinstance(
+        params["flatten_destination_structure"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: flatten_destination_structure must be an bool"
+        )
+    if "ignore_locked_folders" in params and not isinstance(
+        params["ignore_locked_folders"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: ignore_locked_folders must be an bool"
+        )
+    if "legacy_folder_matching" in params and not isinstance(
+        params["legacy_folder_matching"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: legacy_folder_matching must be an bool"
+        )
+    if "name" in params and not isinstance(params["name"], str):
+        raise InvalidParameterError("Bad parameter: name must be an str")
+    if "overwrite_files" in params and not isinstance(
+        params["overwrite_files"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: overwrite_files must be an bool"
+        )
+    if "path_time_zone" in params and not isinstance(
+        params["path_time_zone"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: path_time_zone must be an str"
+        )
+    if "retry_on_failure_interval_in_minutes" in params and not isinstance(
+        params["retry_on_failure_interval_in_minutes"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: retry_on_failure_interval_in_minutes must be an int"
+        )
+    if "retry_on_failure_number_of_attempts" in params and not isinstance(
+        params["retry_on_failure_number_of_attempts"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: retry_on_failure_number_of_attempts must be an int"
+        )
+    if "trigger" in params and not isinstance(params["trigger"], str):
+        raise InvalidParameterError("Bad parameter: trigger must be an str")
+    if "trigger_actions" in params and not isinstance(
+        params["trigger_actions"], builtins.list
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: trigger_actions must be an list"
+        )
+    if "value" in params and not isinstance(params["value"], dict):
+        raise InvalidParameterError("Bad parameter: value must be an dict")
+    if "recurring_day" in params and not isinstance(
+        params["recurring_day"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: recurring_day must be an int"
+        )
+    if "automation" in params and not isinstance(params["automation"], str):
+        raise InvalidParameterError("Bad parameter: automation must be an str")
+    if "id" not in params:
+        raise MissingParameterError("Parameter missing: id")
+    response, options = Api.send_request(
+        "PATCH", "/automations/{id}".format(id=params["id"]), params, options
+    )
+    return Automation(response.data, options)
+
+
+def delete(id, params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    params["id"] = id
+    if "id" in params and not isinstance(params["id"], int):
+        raise InvalidParameterError("Bad parameter: id must be an int")
+    if "id" not in params:
+        raise MissingParameterError("Parameter missing: id")
+    Api.send_request(
+        "DELETE", "/automations/{id}".format(id=params["id"]), params, options
+    )
+
+
+def destroy(id, params=None, options=None):
+    delete(id, params, options)
+
+
+def new(*args, **kwargs):
+    return Automation(*args, **kwargs)