files.com 1.0.84 → 1.0.85

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0741a8ed2013b476c86572a9d38dc4864c23febec027a8ffe466e6d3ebdba3e1
-  data.tar.gz: e1daa596cc9143d72ee07c06765f9e889150ac759cf8607ac53bedd1086098d0
+  metadata.gz: 4f256669e61998c0d04e226d0f790790fe0727fff5a0a4ff5d91711e91b207dc
+  data.tar.gz: 13c775f7f838a326c807878ea590e4ebb326177b557ef7ab4934a8e3888e2f0d
 SHA512:
-  metadata.gz: 7b5a662c8426e5fddfe6bab29d269f9b995ff45bf32448ce970f5200abad0d7d203afdc262e1bd0bc769b24dbee7d56120b66d6761a096ead04f92fddde9eb23
-  data.tar.gz: 336b27d99c16d94398fca3557624894e98553cab0f978936d49b517c6ec5784a3f875052e206f76cd61d2d98d5a0dc9d2df0d9fdaf27ae60bfea0d34f3ce5d90
+  metadata.gz: dc7836b465ba29c3161ef92d853994f4fe186623c58bb3fa9f46e126dcbb6f34aa189a90b21d80c49cb3b8610af3e64a84dde4a017743df29357849bee536222
+  data.tar.gz: 7c09856639a412cfe9e24aad75fdf3bfdca104d7f7077126f3c4c4f9b7b192251a0fd648e11c38e720f45afc78a45bf958a38fe09c33198435c25625c2e8cdc6

data/_VERSION

@@ -1 +1 @@
-1.0.84
+1.0.85

data/docs/app.md

@@ -0,0 +1,45 @@
+# App
+
+## Example App Object
+
+```
+{
+  "name": "",
+  "extended_description": "",
+  "documentation_links": "Important Info => http://files.test/learn-more",
+  "sso_strategy_type": "",
+  "remote_server_type": "",
+  "folder_behavior_type": "",
+  "external_homepage_url": "",
+  "app_type": "",
+  "featured": true
+}
+```
+
+* `name` (string): Name of the App
+* `extended_description` (string): Long form description of the App
+* `documentation_links` (string): Collection of named links to documentation
+* `sso_strategy_type` (string): Associated SSO Strategy type, if any
+* `remote_server_type` (string): Associated Remote Server type, if any
+* `folder_behavior_type` (string): Associated Folder Behavior type, if any
+* `external_homepage_url` (string): Link to external homepage
+* `app_type` (string): The type of the App
+* `featured` (boolean): Is featured on the App listing?
+
+
+---
+
+## List Apps
+
+```
+Files::App.list(
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `page` (int64): Current page number.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.

data/lib/files.com.rb

@@ -29,6 +29,7 @@ require "files.com/list"
 require "files.com/models/account_line_item"
 require "files.com/models/action"
 require "files.com/models/api_key"
+require "files.com/models/app"
 require "files.com/models/as2_key"
 require "files.com/models/auto"
 require "files.com/models/automation"

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Files
+  class App
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - Name of the App
+    def name
+      @attributes[:name]
+    end
+
+    # string - Long form description of the App
+    def extended_description
+      @attributes[:extended_description]
+    end
+
+    # string - Collection of named links to documentation
+    def documentation_links
+      @attributes[:documentation_links]
+    end
+
+    # string - Associated SSO Strategy type, if any
+    def sso_strategy_type
+      @attributes[:sso_strategy_type]
+    end
+
+    # string - Associated Remote Server type, if any
+    def remote_server_type
+      @attributes[:remote_server_type]
+    end
+
+    # string - Associated Folder Behavior type, if any
+    def folder_behavior_type
+      @attributes[:folder_behavior_type]
+    end
+
+    # string - Link to external homepage
+    def external_homepage_url
+      @attributes[:external_homepage_url]
+    end
+
+    # string - The type of the App
+    def app_type
+      @attributes[:app_type]
+    end
+
+    # boolean - Is featured on the App listing?
+    def featured
+      @attributes[:featured]
+    end
+
+    # Parameters:
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
+
+      response, options = Api.send_request("/apps", :get, params, options)
+      response.data.map do |entity_data|
+        App.new(entity_data, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.84
+  version: 1.0.85
 platform: ruby
 authors:
 - files.com
@@ -87,6 +87,7 @@ files:
 - docs/account_line_item.md
 - docs/action.md
 - docs/api_key.md
+- docs/app.md
 - docs/as2_key.md
 - docs/auto.md
 - docs/automation.md
@@ -144,6 +145,7 @@ files:
 - lib/files.com/models/account_line_item.rb
 - lib/files.com/models/action.rb
 - lib/files.com/models/api_key.rb
+- lib/files.com/models/app.rb
 - lib/files.com/models/as2_key.rb
 - lib/files.com/models/auto.rb
 - lib/files.com/models/automation.rb