files.com 1.0.123 → 1.0.124

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b327cdd5fe83088b3b598f87178627b0fb7d721e257575bdd0b9d5f783c51495
-  data.tar.gz: 23e6a12ef8f91043bf4c769f1b8d970839c50461efb99bd5562a6f6989bc7b63
+  metadata.gz: 92873bcd3bc5aba3dbdddbccbb0773e60e9a591517dcc0e2f7d306444e9ba3fa
+  data.tar.gz: 5d9714166c704bce65ba07c790fed61e0296bce705427ad73f6c4d3dee76cff3
 SHA512:
-  metadata.gz: 7c0bbcd80eed68a5c8f534b02b40f38e926305cbb8d9302fe9213c96463d0b89eae331474d6cac3a004d531b3c09fb58ea19c1e2ab6e174cd76cd526d2aaf4f9
-  data.tar.gz: feebcff93f3bc88a96824f75238600007936d8750614862d272e6d45d97892645e8637fbe381730df2173f9a806cd06859675ce1620978313e521e101f22560b
+  metadata.gz: 2e61dae752728ff89f699fbad98f1aa9a8f70dd8bbe18492c5d60567979cc7ccf3476b27915ea0f6b96820d2b00d77f505186e0ed3ace4847f6d6d51e50faf66
+  data.tar.gz: f4b9cc0cc6b6cb5fd69a8096a65369b8472fce76f371ee7c5398db2ba8ef67bdfefe9183e0241ca9bd6f4c60d1cbcf842f1d7fe51dfbc0ce4f790323f686df23

data/_VERSION

@@ -1 +1 @@
-1.0.123
+1.0.124

data/docs/automation.md

@@ -20,7 +20,20 @@
   ],
   "group_ids": [
 
-  ]
+  ],
+  "trigger": "realtime",
+  "schedule": {
+    "days_of_week": [
+      0,
+      2,
+      4
+    ],
+    "times_of_day": [
+      "6:30",
+      "14:30"
+    ],
+    "time_zone": "Eastern Time (US & Canada)"
+  }
 }
 ```
 
@@ -37,6 +50,8 @@
 * `user_id` (int64): User ID of the Automation's creator.
 * `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
 * `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
+* `trigger` (string): How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
+* `schedule` (object): Custom schedule description for when the automation should be run.
 
 
 ---
@@ -86,13 +101,15 @@ Files::Automation.create(
   automation: "create_folder", 
   source: "source", 
   destination: "destination", 
-  interval: "year"
+  interval: "year", 
+  schedule: {"days_of_week":[0,1,3],"times_of_day":["7:30","11:30"],"time_zone":"Eastern Time (US & Canada)"}, 
+  trigger: "realtime"
 )
 ```
 
 ### Parameters
 
-* `automation` (string): Required - Type of automation.  One of: `create_folder`, `request_file`, `request_move`
+* `automation` (string): Required - Automation type
 * `source` (string): Source Path
 * `destination` (string): Destination Path
 * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
@@ -101,6 +118,8 @@ Files::Automation.create(
 * `path` (string): Path on which this Automation runs.  Supports globs.
 * `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` (object): Custom schedule for running this automation.
+* `trigger` (string): How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
 
 
 ---
@@ -112,14 +131,16 @@ Files::Automation.update(id,
   automation: "create_folder", 
   source: "source", 
   destination: "destination", 
-  interval: "year"
+  interval: "year", 
+  schedule: {"days_of_week":[0,1,3],"times_of_day":["7:30","11:30"],"time_zone":"Eastern Time (US & Canada)"}, 
+  trigger: "realtime"
 )
 ```
 
 ### Parameters
 
 * `id` (int64): Required - Automation ID.
-* `automation` (string): Required - Type of automation.  One of: `create_folder`, `request_file`, `request_move`
+* `automation` (string): Required - Automation type
 * `source` (string): Source Path
 * `destination` (string): Destination Path
 * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
@@ -128,6 +149,8 @@ Files::Automation.update(id,
 * `path` (string): Path on which this Automation runs.  Supports globs.
 * `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` (object): Custom schedule for running this automation.
+* `trigger` (string): How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
 
 
 ---
@@ -154,14 +177,16 @@ automation.update(
   automation: "create_folder",
   source: "source",
   destination: "destination",
-  interval: "year"
+  interval: "year",
+  schedule: {"days_of_week":[0,1,3],"times_of_day":["7:30","11:30"],"time_zone":"Eastern Time (US & Canada)"},
+  trigger: "realtime"
 )
 ```
 
 ### Parameters
 
 * `id` (int64): Required - Automation ID.
-* `automation` (string): Required - Type of automation.  One of: `create_folder`, `request_file`, `request_move`
+* `automation` (string): Required - Automation type
 * `source` (string): Source Path
 * `destination` (string): Destination Path
 * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
@@ -170,6 +195,8 @@ automation.update(
 * `path` (string): Path on which this Automation runs.  Supports globs.
 * `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` (object): Custom schedule for running this automation.
+* `trigger` (string): How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
 
 
 ---

data/docs/remote_server.md

@@ -107,6 +107,61 @@ Files::RemoteServer.find(id)
 * `id` (int64): Required - Remote Server ID.
 
 
+---
+
+## list_for_testing Remote Server
+
+```
+Files::RemoteServer.list_for_testing(
+  remote_server_id: 1, 
+  reset_authentication: true, 
+  max_connections: 1, 
+  port: 1
+)
+```
+
+### Parameters
+
+* `remote_server_id` (int64): RemoteServer ID
+* `root` (string): Remote path to list
+* `aws_access_key` (string): AWS Access Key.
+* `aws_secret_key` (string): AWS secret key.
+* `password` (string): Password if needed.
+* `private_key` (string): Private key if needed.
+* `ssl_certificate` (string): SSL client certificate.
+* `google_cloud_storage_credentials_json` (string): A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
+* `wasabi_access_key` (string): Wasabi access key.
+* `wasabi_secret_key` (string): Wasabi secret key.
+* `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage keyID.
+* `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage applicationKey.
+* `rackspace_api_key` (string): Rackspace API key from the Rackspace Cloud Control Panel.
+* `reset_authentication` (boolean): Reset authenticated account
+* `azure_blob_storage_access_key` (string): Azure Blob Storage secret key.
+* `hostname` (string): 
+* `name` (string): 
+* `max_connections` (int64): 
+* `port` (int64): 
+* `s3_bucket` (string): 
+* `s3_region` (string): 
+* `server_certificate` (string): 
+* `server_host_key` (string): 
+* `server_type` (string): 
+* `ssl` (string): 
+* `username` (string): 
+* `google_cloud_storage_bucket` (string): 
+* `google_cloud_storage_project_id` (string): 
+* `backblaze_b2_bucket` (string): 
+* `backblaze_b2_s3_endpoint` (string): 
+* `wasabi_bucket` (string): 
+* `wasabi_region` (string): 
+* `rackspace_username` (string): 
+* `rackspace_region` (string): 
+* `rackspace_container` (string): 
+* `one_drive_account_type` (string): 
+* `azure_blob_storage_account` (string): 
+* `azure_blob_storage_container` (string): 
+
+
 ---
 
 ## Create Remote Server

data/lib/files.com/models/automation.rb

@@ -126,8 +126,26 @@ module Files
       @attributes[:group_ids] = value
     end
 
+    # string - How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
+    def trigger
+      @attributes[:trigger]
+    end
+
+    def trigger=(value)
+      @attributes[:trigger] = value
+    end
+
+    # object - Custom schedule description for when the automation should be run.
+    def schedule
+      @attributes[:schedule]
+    end
+
+    def schedule=(value)
+      @attributes[:schedule] = value
+    end
+
     # Parameters:
-    #   automation (required) - string - Type of automation.  One of: `create_folder`, `request_file`, `request_move`
+    #   automation (required) - string - Automation type
     #   source - string - Source Path
     #   destination - string - Destination Path
     #   destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
@@ -136,6 +154,8 @@ module Files
     #   path - string - Path on which this Automation runs.  Supports globs.
     #   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 - object - Custom schedule for running this automation.
+    #   trigger - string - How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
     def update(params = {})
       params ||= {}
       params[:id] = @attributes[:id]
@@ -150,6 +170,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params.dig(:user_ids) and !params.dig(:user_ids).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
       raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
 
@@ -228,7 +249,7 @@ module Files
     end
 
     # Parameters:
-    #   automation (required) - string - Type of automation.  One of: `create_folder`, `request_file`, `request_move`
+    #   automation (required) - string - Automation type
     #   source - string - Source Path
     #   destination - string - Destination Path
     #   destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
@@ -237,6 +258,8 @@ module Files
     #   path - string - Path on which this Automation runs.  Supports globs.
     #   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 - object - Custom schedule for running this automation.
+    #   trigger - string - How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: source must be an String") if params.dig(:source) and !params.dig(:source).is_a?(String)
@@ -247,6 +270,8 @@ module Files
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params.dig(:user_ids) and !params.dig(:user_ids).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: schedule must be an Hash") if params.dig(:schedule) and !params.dig(:schedule).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
       raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
 
       response, options = Api.send_request("/automations", :post, params, options)
@@ -254,7 +279,7 @@ module Files
     end
 
     # Parameters:
-    #   automation (required) - string - Type of automation.  One of: `create_folder`, `request_file`, `request_move`
+    #   automation (required) - string - Automation type
     #   source - string - Source Path
     #   destination - string - Destination Path
     #   destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
@@ -263,6 +288,8 @@ module Files
     #   path - string - Path on which this Automation runs.  Supports globs.
     #   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 - object - Custom schedule for running this automation.
+    #   trigger - string - How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
     def self.update(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -276,6 +303,8 @@ module Files
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params.dig(:user_ids) and !params.dig(:user_ids).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: schedule must be an Hash") if params.dig(:schedule) and !params.dig(:schedule).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
       raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
 

data/lib/files.com/models/remote_server.rb

@@ -515,6 +515,88 @@ module Files
       find(id, params, options)
     end
 
+    # Parameters:
+    #   remote_server_id - int64 - RemoteServer ID
+    #   root - string - Remote path to list
+    #   aws_access_key - string - AWS Access Key.
+    #   aws_secret_key - string - AWS secret key.
+    #   password - string - Password if needed.
+    #   private_key - string - Private key if needed.
+    #   ssl_certificate - string - SSL client certificate.
+    #   google_cloud_storage_credentials_json - string - A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
+    #   wasabi_access_key - string - Wasabi access key.
+    #   wasabi_secret_key - string - Wasabi secret key.
+    #   backblaze_b2_key_id - string - Backblaze B2 Cloud Storage keyID.
+    #   backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
+    #   rackspace_api_key - string - Rackspace API key from the Rackspace Cloud Control Panel.
+    #   reset_authentication - boolean - Reset authenticated account
+    #   azure_blob_storage_access_key - string - Azure Blob Storage secret key.
+    #   hostname - string
+    #   name - string
+    #   max_connections - int64
+    #   port - int64
+    #   s3_bucket - string
+    #   s3_region - string
+    #   server_certificate - string
+    #   server_host_key - string
+    #   server_type - string
+    #   ssl - string
+    #   username - string
+    #   google_cloud_storage_bucket - string
+    #   google_cloud_storage_project_id - string
+    #   backblaze_b2_bucket - string
+    #   backblaze_b2_s3_endpoint - string
+    #   wasabi_bucket - string
+    #   wasabi_region - string
+    #   rackspace_username - string
+    #   rackspace_region - string
+    #   rackspace_container - string
+    #   one_drive_account_type - string
+    #   azure_blob_storage_account - string
+    #   azure_blob_storage_container - string
+    def self.list_for_testing(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: remote_server_id must be an Integer") if params.dig(:remote_server_id) and !params.dig(:remote_server_id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: root must be an String") if params.dig(:root) and !params.dig(:root).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: aws_access_key must be an String") if params.dig(:aws_access_key) and !params.dig(:aws_access_key).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: aws_secret_key must be an String") if params.dig(:aws_secret_key) and !params.dig(:aws_secret_key).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params.dig(:private_key) and !params.dig(:private_key).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: ssl_certificate must be an String") if params.dig(:ssl_certificate) and !params.dig(:ssl_certificate).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: google_cloud_storage_credentials_json must be an String") if params.dig(:google_cloud_storage_credentials_json) and !params.dig(:google_cloud_storage_credentials_json).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: wasabi_access_key must be an String") if params.dig(:wasabi_access_key) and !params.dig(:wasabi_access_key).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params.dig(:wasabi_secret_key) and !params.dig(:wasabi_secret_key).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: backblaze_b2_key_id must be an String") if params.dig(:backblaze_b2_key_id) and !params.dig(:backblaze_b2_key_id).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: backblaze_b2_application_key must be an String") if params.dig(:backblaze_b2_application_key) and !params.dig(:backblaze_b2_application_key).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: rackspace_api_key must be an String") if params.dig(:rackspace_api_key) and !params.dig(:rackspace_api_key).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: azure_blob_storage_access_key must be an String") if params.dig(:azure_blob_storage_access_key) and !params.dig(:azure_blob_storage_access_key).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params.dig(:hostname) and !params.dig(:hostname).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: max_connections must be an Integer") if params.dig(:max_connections) and !params.dig(:max_connections).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params.dig(:port) and !params.dig(:port).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params.dig(:s3_bucket) and !params.dig(:s3_bucket).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: s3_region must be an String") if params.dig(:s3_region) and !params.dig(:s3_region).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params.dig(:server_certificate) and !params.dig(:server_certificate).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params.dig(:server_host_key) and !params.dig(:server_host_key).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params.dig(:server_type) and !params.dig(:server_type).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: ssl must be an String") if params.dig(:ssl) and !params.dig(:ssl).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: username must be an String") if params.dig(:username) and !params.dig(:username).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: google_cloud_storage_bucket must be an String") if params.dig(:google_cloud_storage_bucket) and !params.dig(:google_cloud_storage_bucket).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: google_cloud_storage_project_id must be an String") if params.dig(:google_cloud_storage_project_id) and !params.dig(:google_cloud_storage_project_id).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: backblaze_b2_bucket must be an String") if params.dig(:backblaze_b2_bucket) and !params.dig(:backblaze_b2_bucket).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: backblaze_b2_s3_endpoint must be an String") if params.dig(:backblaze_b2_s3_endpoint) and !params.dig(:backblaze_b2_s3_endpoint).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: wasabi_bucket must be an String") if params.dig(:wasabi_bucket) and !params.dig(:wasabi_bucket).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: wasabi_region must be an String") if params.dig(:wasabi_region) and !params.dig(:wasabi_region).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: rackspace_username must be an String") if params.dig(:rackspace_username) and !params.dig(:rackspace_username).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: rackspace_region must be an String") if params.dig(:rackspace_region) and !params.dig(:rackspace_region).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: rackspace_container must be an String") if params.dig(:rackspace_container) and !params.dig(:rackspace_container).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params.dig(:one_drive_account_type) and !params.dig(:one_drive_account_type).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params.dig(:azure_blob_storage_account) and !params.dig(:azure_blob_storage_account).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params.dig(:azure_blob_storage_container) and !params.dig(:azure_blob_storage_container).is_a?(String)
+
+      response, options = Api.send_request("/remote_servers/list_for_testing", :get, params, options)
+      File.new(response.data, options)
+    end
+
     # Parameters:
     #   aws_access_key - string - AWS Access Key.
     #   aws_secret_key - string - AWS secret key.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.123
+  version: 1.0.124
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable