files.com 1.0.231 → 1.0.232

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

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module Files
+  class As2Partner
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Id of the AS2 Partner.
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # int64 - Id of the AS2 Station associated with this partner.
+    def as2_station_id
+      @attributes[:as2_station_id]
+    end
+
+    def as2_station_id=(value)
+      @attributes[:as2_station_id] = value
+    end
+
+    # string - The partner's formal AS2 name.
+    def name
+      @attributes[:name]
+    end
+
+    def name=(value)
+      @attributes[:name] = value
+    end
+
+    # string - Public URI for sending AS2 message to.
+    def uri
+      @attributes[:uri]
+    end
+
+    def uri=(value)
+      @attributes[:uri] = value
+    end
+
+    # string - MD5 hash of public certificate used for message security.
+    def public_certificate_md5
+      @attributes[:public_certificate_md5]
+    end
+
+    def public_certificate_md5=(value)
+      @attributes[:public_certificate_md5] = value
+    end
+
+    # string
+    def public_certificate
+      @attributes[:public_certificate]
+    end
+
+    def public_certificate=(value)
+      @attributes[:public_certificate] = value
+    end
+
+    # Parameters:
+    #   name - string - AS2 Name
+    #   uri - string - URL base for AS2 responses
+    #   public_certificate - string
+    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: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: uri must be an String") if params.dig(:uri) and !params.dig(:uri).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params.dig(:public_certificate) and !params.dig(:public_certificate).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      Api.send_request("/as2_partners/#{@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_partners/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      if @attributes[:id]
+        update(@attributes)
+      else
+        new_obj = As2Partner.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    end
+
+    # Parameters:
+    #   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: 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(As2Partner, params) do
+        Api.send_request("/as2_partners", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - As2 Partner 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_partners/#{params[:id]}", :get, params, options)
+      As2Partner.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   name (required) - string - AS2 Name
+    #   uri (required) - string - URL base for AS2 responses
+    #   public_certificate (required) - string
+    #   as2_station_id (required) - int64 - Id of As2Station for this partner
+    def self.create(params = {}, options = {})
+      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: uri must be an String") if params.dig(:uri) and !params.dig(:uri).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params.dig(:public_certificate) and !params.dig(:public_certificate).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: as2_station_id must be an Integer") if params.dig(:as2_station_id) and !params.dig(:as2_station_id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: name") unless params.dig(:name)
+      raise MissingParameterError.new("Parameter missing: uri") unless params.dig(:uri)
+      raise MissingParameterError.new("Parameter missing: public_certificate") unless params.dig(:public_certificate)
+      raise MissingParameterError.new("Parameter missing: as2_station_id") unless params.dig(:as2_station_id)
+
+      response, options = Api.send_request("/as2_partners", :post, params, options)
+      As2Partner.new(response.data, options)
+    end
+
+    # Parameters:
+    #   name - string - AS2 Name
+    #   uri - string - URL base for AS2 responses
+    #   public_certificate - string
+    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: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: uri must be an String") if params.dig(:uri) and !params.dig(:uri).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params.dig(:public_certificate) and !params.dig(:public_certificate).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      response, options = Api.send_request("/as2_partners/#{params[:id]}", :patch, params, options)
+      As2Partner.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_partners/#{params[:id]}", :delete, params, options)
+      response.data
+    end
+
+    def self.destroy(id, params = {}, options = {})
+      delete(id, params, options)
+    end
+  end
+end

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

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+module Files
+  class As2Station
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Id of the AS2 Station.
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # string - The station's formal AS2 name.
+    def name
+      @attributes[:name]
+    end
+
+    def name=(value)
+      @attributes[:name] = value
+    end
+
+    # string - Public URI for sending AS2 message to.
+    def uri
+      @attributes[:uri]
+    end
+
+    def uri=(value)
+      @attributes[:uri] = value
+    end
+
+    # string - The station's AS2 domain name.
+    def domain
+      @attributes[:domain]
+    end
+
+    def domain=(value)
+      @attributes[:domain] = value
+    end
+
+    # string - Public certificate used for message security.
+    def public_certificate
+      @attributes[:public_certificate]
+    end
+
+    def public_certificate=(value)
+      @attributes[:public_certificate] = value
+    end
+
+    # string - MD5 hash of public certificate used for message security.
+    def public_certificate_md5
+      @attributes[:public_certificate_md5]
+    end
+
+    def public_certificate_md5=(value)
+      @attributes[:public_certificate_md5] = value
+    end
+
+    # string - MD5 hash of private key used for message security.
+    def private_key_md5
+      @attributes[:private_key_md5]
+    end
+
+    def private_key_md5=(value)
+      @attributes[:private_key_md5] = value
+    end
+
+    # string
+    def private_key
+      @attributes[:private_key]
+    end
+
+    def private_key=(value)
+      @attributes[:private_key] = value
+    end
+
+    # Parameters:
+    #   name - string - AS2 Name
+    #   domain - string - AS2 Domain
+    #   uri - string - URL base for AS2 responses
+    #   public_certificate - string
+    #   private_key - string
+    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: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: domain must be an String") if params.dig(:domain) and !params.dig(:domain).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: uri must be an String") if params.dig(:uri) and !params.dig(:uri).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params.dig(:public_certificate) and !params.dig(:public_certificate).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 MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      Api.send_request("/as2_stations/#{@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_stations/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      if @attributes[:id]
+        update(@attributes)
+      else
+        new_obj = As2Station.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    end
+
+    # Parameters:
+    #   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: 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(As2Station, params) do
+        Api.send_request("/as2_stations", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - As2 Station 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_stations/#{params[:id]}", :get, params, options)
+      As2Station.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   name (required) - string - AS2 Name
+    #   domain (required) - string - AS2 Domain
+    #   uri (required) - string - URL base for AS2 responses
+    #   public_certificate (required) - string
+    #   private_key (required) - string
+    def self.create(params = {}, options = {})
+      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: domain must be an String") if params.dig(:domain) and !params.dig(:domain).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: uri must be an String") if params.dig(:uri) and !params.dig(:uri).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params.dig(:public_certificate) and !params.dig(:public_certificate).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 MissingParameterError.new("Parameter missing: name") unless params.dig(:name)
+      raise MissingParameterError.new("Parameter missing: domain") unless params.dig(:domain)
+      raise MissingParameterError.new("Parameter missing: uri") unless params.dig(:uri)
+      raise MissingParameterError.new("Parameter missing: public_certificate") unless params.dig(:public_certificate)
+      raise MissingParameterError.new("Parameter missing: private_key") unless params.dig(:private_key)
+
+      response, options = Api.send_request("/as2_stations", :post, params, options)
+      As2Station.new(response.data, options)
+    end
+
+    # Parameters:
+    #   name - string - AS2 Name
+    #   domain - string - AS2 Domain
+    #   uri - string - URL base for AS2 responses
+    #   public_certificate - string
+    #   private_key - string
+    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: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: domain must be an String") if params.dig(:domain) and !params.dig(:domain).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: uri must be an String") if params.dig(:uri) and !params.dig(:uri).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params.dig(:public_certificate) and !params.dig(:public_certificate).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 MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      response, options = Api.send_request("/as2_stations/#{params[:id]}", :patch, params, options)
+      As2Station.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_stations/#{params[:id]}", :delete, params, options)
+      response.data
+    end
+
+    def self.destroy(id, params = {}, options = {})
+      delete(id, params, options)
+    end
+  end
+end

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

@@ -63,7 +63,7 @@ module Files
       @attributes[:query_action] = value
     end
 
-    # string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`
+    # string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
     def query_interface
       @attributes[:query_interface]
     end
@@ -273,7 +273,7 @@ module Files
     #   start_at - string - Start date/time of export range.
     #   end_at - string - End date/time of export range.
     #   query_action - string - Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
-    #   query_interface - string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`
+    #   query_interface - string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
     #   query_user_id - string - Return results that are actions performed by the user indiciated by this User ID
     #   query_file_id - string - Return results that are file actions related to the file indicated by this File ID
     #   query_parent_id - string - Return results that are file actions inside the parent folder specified by this folder ID

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

@@ -74,7 +74,7 @@ module Files
       @attributes[:failure_type]
     end
 
-    # string - Inteface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`
+    # string - Inteface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
     def interface
       @attributes[:interface]
     end

data/lib/files.com.rb

@@ -34,7 +34,10 @@ require "files.com/models/action_notification_export_result"
 require "files.com/models/action_webhook_failure"
 require "files.com/models/api_key"
 require "files.com/models/app"
-require "files.com/models/as2_key"
+require "files.com/models/as2_incoming_message"
+require "files.com/models/as2_outgoing_message"
+require "files.com/models/as2_partner"
+require "files.com/models/as2_station"
 require "files.com/models/auto"
 require "files.com/models/automation"
 require "files.com/models/automation_run"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.231
+  version: 1.0.232
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2022-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -93,7 +93,10 @@ files:
 - docs/action_webhook_failure.md
 - docs/api_key.md
 - docs/app.md
-- docs/as2_key.md
+- docs/as2_incoming_message.md
+- docs/as2_outgoing_message.md
+- docs/as2_partner.md
+- docs/as2_station.md
 - docs/auto.md
 - docs/automation.md
 - docs/automation_run.md
@@ -171,7 +174,10 @@ files:
 - lib/files.com/models/action_webhook_failure.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/as2_incoming_message.rb
+- lib/files.com/models/as2_outgoing_message.rb
+- lib/files.com/models/as2_partner.rb
+- lib/files.com/models/as2_station.rb
 - lib/files.com/models/auto.rb
 - lib/files.com/models/automation.rb
 - lib/files.com/models/automation_run.rb
@@ -269,7 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Files.com Ruby client.

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.