files.com 1.0.231 → 1.0.235

data/docs/as2_key.md

@@ -1,131 +0,0 @@
-# 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, 
-  per_page: 1
-)
-```
-
-### Parameters
-
-* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
-* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
-* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-
-
----
-
-## 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.list.first
-
-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.list.first
-
-as2_key.delete
-```
-
-### Parameters
-
-* `id` (int64): Required - As2 Key ID.

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

@@ -1,176 +0,0 @@
-# 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 - int64 - User ID.  Provide a value of `0` to operate the current session's user.
-    #   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
-    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-    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: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
-
-      List.new(As2Key, params) do
-        Api.send_request("/as2_keys", :get, params, options)
-      end
-    end
-
-    def self.all(params = {}, options = {})
-      list(params, options)
-    end
-
-    # Parameters:
-    #   id (required) - int64 - 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 - int64 - 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