files.com 1.0.34 → 1.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95f6118254b939d113400ea9575b5f352f957de2760b911d4cbddca2daaf2e7b
-  data.tar.gz: ff0ebe62222940de1aac19014c8f88c23f3bf27a279f01982c0afb237a695849
+  metadata.gz: 19e707f4959f4ff9e8ce51199325bb0a3ecd91570dd5fcc4eabb5cac5ee39467
+  data.tar.gz: 47767a543fa853985ebd8cb03573331027a17dfefb1778558e9e617b881e22c5
 SHA512:
-  metadata.gz: 1360c574244c44858bdeb03d2b83e3d5c0f05a2f4bc313fe3d78317188dc1fd0982e69848e41b5e408c0b90766786417753185b0af1d44e7c870be8f9ab843a1
-  data.tar.gz: 1225e3cc3ac3c3a10448eea2b01ba048f0b54a6f93f6faec6114fda68cd9625365515853844d1416393012a75d0defc691b5950c69507a243e787b3d63451a85
+  metadata.gz: ccedd2cfd8b6f4eb234eec5288686c1aba531f07625d2e21d10e4ddac589498fd6397760f7872f332d28903ce9112ab4260174ed658122c46e41c066685395f3
+  data.tar.gz: a477ed676cd337a577e26c1e696c7477a5da44605901296403eb8d4f05c0864e18e3a8dd51fbd5a5fe5fc9b8114b726995c51622b5d48bd0111dc046883e3eb6

data/_VERSION

@@ -1 +1 @@
-1.0.34
+1.0.35

data/docs/as2_key.md

@@ -0,0 +1,131 @@
+# As2Key
+
+## Example As2Key Object
+
+```
+{
+  "id": 1,
+  "as2_partnership_name": "Test",
+  "created_at": "2000-01-01T01:00:00Z",
+  "fingerprint": "cf:cb:d3:26:52:6c:55:88:83:17:13:cf:e7:70:eb:1b:32:37:38:c0"
+}
+```
+
+* `id` (int64): AS2 Key ID
+* `as2_partnership_name` (string): AS2 Partnership Name
+* `created_at` (date-time): AS2 Key created at date/time
+* `fingerprint` (string): Public key fingerprint
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `public_key` (string): Actual contents of Public key.
+
+
+---
+
+## List As2 Keys
+
+```
+Files::As2Key.list(
+  user_id: 1, 
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `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.
+
+
+---
+
+## Show As2 Key
+
+```
+Files::As2Key.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - As2 Key ID.
+
+
+---
+
+## Create As2 Key
+
+```
+Files::As2Key.create(
+  user_id: 1, 
+  as2_partnership_name: "Test", 
+  public_key: "public_key"
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `as2_partnership_name` (string): Required - AS2 Partnership Name
+* `public_key` (string): Required - Actual contents of Public key.
+
+
+---
+
+## Update As2 Key
+
+```
+Files::As2Key.update(id, 
+  as2_partnership_name: "Test"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - As2 Key ID.
+* `as2_partnership_name` (string): Required - AS2 Partnership Name
+
+
+---
+
+## Delete As2 Key
+
+```
+Files::As2Key.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - As2 Key ID.
+
+
+---
+
+## Update As2 Key
+
+```
+as2_key = Files::As2Key.find(1)
+as2_key.update(
+  as2_partnership_name: "Test"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - As2 Key ID.
+* `as2_partnership_name` (string): Required - AS2 Partnership Name
+
+
+---
+
+## Delete As2 Key
+
+```
+as2_key = Files::As2Key.find(1)
+as2_key.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - As2 Key ID.

data/lib/files.com.rb

@@ -27,6 +27,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/as2_key"
 require "files.com/models/auto"
 require "files.com/models/automation"
 require "files.com/models/behavior"

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

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module Files
+  class As2Key
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - AS2 Key ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # string - AS2 Partnership Name
+    def as2_partnership_name
+      @attributes[:as2_partnership_name]
+    end
+
+    def as2_partnership_name=(value)
+      @attributes[:as2_partnership_name] = value
+    end
+
+    # date-time - AS2 Key created at date/time
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # string - Public key fingerprint
+    def fingerprint
+      @attributes[:fingerprint]
+    end
+
+    def fingerprint=(value)
+      @attributes[:fingerprint] = value
+    end
+
+    # int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    def user_id
+      @attributes[:user_id]
+    end
+
+    def user_id=(value)
+      @attributes[:user_id] = value
+    end
+
+    # string - Actual contents of Public key.
+    def public_key
+      @attributes[:public_key]
+    end
+
+    def public_key=(value)
+      @attributes[:public_key] = value
+    end
+
+    # Parameters:
+    #   as2_partnership_name (required) - string - AS2 Partnership Name
+    def update(params = {})
+      params ||= {}
+      params[:id] = @attributes[:id]
+      raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: as2_partnership_name must be an String") if params.dig(:as2_partnership_name) and !params.dig(:as2_partnership_name).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+      raise MissingParameterError.new("Parameter missing: as2_partnership_name") unless params.dig(:as2_partnership_name)
+
+      Api.send_request("/as2_keys/#{@attributes[:id]}", :patch, params, @options)
+    end
+
+    def delete(params = {})
+      params ||= {}
+      params[:id] = @attributes[:id]
+      raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      Api.send_request("/as2_keys/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      if @attributes[:id]
+        update(@attributes)
+      else
+        new_obj = As2Key.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    end
+
+    # Parameters:
+    #   user_id - integer - User ID.  Provide a value of `0` to operate the current session's user.
+    #   page - integer - Current page number.
+    #   per_page - integer - 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: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
+      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("/as2_keys", :get, params, options)
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - integer - As2 Key ID.
+    def self.find(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      response, options = Api.send_request("/as2_keys/#{params[:id]}", :get, params, options)
+      As2Key.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   user_id - integer - User ID.  Provide a value of `0` to operate the current session's user.
+    #   as2_partnership_name (required) - string - AS2 Partnership Name
+    #   public_key (required) - string - Actual contents of Public key.
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: as2_partnership_name must be an String") if params.dig(:as2_partnership_name) and !params.dig(:as2_partnership_name).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params.dig(:public_key) and !params.dig(:public_key).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: as2_partnership_name") unless params.dig(:as2_partnership_name)
+      raise MissingParameterError.new("Parameter missing: public_key") unless params.dig(:public_key)
+
+      response, options = Api.send_request("/as2_keys", :post, params, options)
+      As2Key.new(response.data, options)
+    end
+
+    # Parameters:
+    #   as2_partnership_name (required) - string - AS2 Partnership Name
+    def self.update(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: as2_partnership_name must be an String") if params.dig(:as2_partnership_name) and !params.dig(:as2_partnership_name).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+      raise MissingParameterError.new("Parameter missing: as2_partnership_name") unless params.dig(:as2_partnership_name)
+
+      response, options = Api.send_request("/as2_keys/#{params[:id]}", :patch, params, options)
+      As2Key.new(response.data, options)
+    end
+
+    def self.delete(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      response, _options = Api.send_request("/as2_keys/#{params[:id]}", :delete, params, options)
+      response.data
+    end
+
+    def self.destroy(id, params = {}, options = {})
+      delete(id, params, options)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.34
+  version: 1.0.35
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-07 00:00:00.000000000 Z
+date: 2020-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -75,6 +75,7 @@ files:
 - docs/action.md
 - docs/announcement.md
 - docs/api_key.md
+- docs/as2_key.md
 - docs/auto.md
 - docs/automation.md
 - docs/behavior.md
@@ -158,6 +159,7 @@ files:
 - lib/files.com/models/action.rb
 - lib/files.com/models/announcement.rb
 - lib/files.com/models/api_key.rb
+- lib/files.com/models/as2_key.rb
 - lib/files.com/models/auto.rb
 - lib/files.com/models/automation.rb
 - lib/files.com/models/behavior.rb