files.com 1.0.149 → 1.0.150

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afd795469d773a6bc190d054f7d487b3f0a7a934cb4e743beb76b1d9924dd0bf
-  data.tar.gz: d7905582db02d9a9fea04c5c68a0d9cc26ef8bb4509f6457236912143e5795cf
+  metadata.gz: 940c377b195416e86507580f31199480f7c5c6584376b98aeefc79db3b3701fb
+  data.tar.gz: 11dd4c65a619afa1f88117aa742a5485fd458f296d735efd3566c225d757ce2d
 SHA512:
-  metadata.gz: fec91234ec2e70e0d59c87b2c13aa16e30df5484397d3cd303a3b27dd7494ea7b15b43444067177efb8e5f9746a1156b0a84dabd3fee444df6c3891856474172
-  data.tar.gz: 8cacc51b4d483ea38ca8d2ce44425848577c616477349a8c20830cc3e09db313103604ef051a10c76f752f99049985320e6c225680cceec02b9545f4ff2595a7
+  metadata.gz: 2194b7f45aeed071a28b319fc48180a38d232d6423f9d9c57af01627049e8559aa0a8ee0c0e0f4a36e7e947236bbc9e93b72329c0a3c57c1ddab1be21132c93b
+  data.tar.gz: a349c39f0d7c92cee235ebd0a3843e72c970017b4bdcf5d585d0d85160335f5b0cbcf08c932a4d96d607df30e129f85697e867234ff11025a62e3600577acade

data/_VERSION

@@ -1 +1 @@
-1.0.149
+1.0.150

data/docs/webhook_test.md

@@ -0,0 +1,50 @@
+# WebhookTest
+
+## Example WebhookTest Object
+
+```
+{
+  "code": 200,
+  "message": "",
+  "status": "",
+  "data": "",
+  "success": true
+}
+```
+
+* `code` (int64): Status HTTP code
+* `message` (string): Error message
+* `status` (string): Status message
+* `data`: Additional data
+* `success` (boolean): The success status of the webhook test
+* `url` (string): URL for testing the webhook.
+* `method` (string): HTTP method(GET or POST).
+* `encoding` (string): HTTP encoding method.  Can be JSON, XML, or RAW (form data).
+* `headers` (object): Additional request headers.
+* `body` (object): Additional body parameters.
+* `action` (string): action for test body
+
+
+---
+
+## Create Webhook Test
+
+```
+Files::WebhookTest.create(
+  url: "https://www.site.com/...", 
+  method: "GET", 
+  encoding: "RAW", 
+  headers: "x-test-header => testvalue", 
+  body: "test-param => testvalue", 
+  action: "test"
+)
+```
+
+### Parameters
+
+* `url` (string): Required - URL for testing the webhook.
+* `method` (string): HTTP method(GET or POST).
+* `encoding` (string): HTTP encoding method.  Can be JSON, XML, or RAW (form data).
+* `headers` (object): Additional request headers.
+* `body` (object): Additional body parameters.
+* `action` (string): action for test body

data/lib/files.com.rb

@@ -90,6 +90,7 @@ require "files.com/models/usage_snapshot"
 require "files.com/models/user"
 require "files.com/models/user_cipher_use"
 require "files.com/models/user_request"
+require "files.com/models/webhook_test"
 
 require "files.com/models/dir"
 require "files.com/models/file_utils"

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

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Files
+  class WebhookTest
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Status HTTP code
+    def code
+      @attributes[:code]
+    end
+
+    def code=(value)
+      @attributes[:code] = value
+    end
+
+    # string - Error message
+    def message
+      @attributes[:message]
+    end
+
+    def message=(value)
+      @attributes[:message] = value
+    end
+
+    # string - Status message
+    def status
+      @attributes[:status]
+    end
+
+    def status=(value)
+      @attributes[:status] = value
+    end
+
+    # Additional data
+    def data
+      @attributes[:data]
+    end
+
+    def data=(value)
+      @attributes[:data] = value
+    end
+
+    # boolean - The success status of the webhook test
+    def success
+      @attributes[:success]
+    end
+
+    def success=(value)
+      @attributes[:success] = value
+    end
+
+    # string - URL for testing the webhook.
+    def url
+      @attributes[:url]
+    end
+
+    def url=(value)
+      @attributes[:url] = value
+    end
+
+    # string - HTTP method(GET or POST).
+    def method
+      @attributes[:method]
+    end
+
+    def method=(value)
+      @attributes[:method] = value
+    end
+
+    # string - HTTP encoding method.  Can be JSON, XML, or RAW (form data).
+    def encoding
+      @attributes[:encoding]
+    end
+
+    def encoding=(value)
+      @attributes[:encoding] = value
+    end
+
+    # object - Additional request headers.
+    def headers
+      @attributes[:headers]
+    end
+
+    def headers=(value)
+      @attributes[:headers] = value
+    end
+
+    # object - Additional body parameters.
+    def body
+      @attributes[:body]
+    end
+
+    def body=(value)
+      @attributes[:body] = value
+    end
+
+    # string - action for test body
+    def action
+      @attributes[:action]
+    end
+
+    def action=(value)
+      @attributes[:action] = value
+    end
+
+    def save
+      if @attributes[:id]
+        raise NotImplementedError.new("The WebhookTest object doesn't support updates.")
+      else
+        new_obj = WebhookTest.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    end
+
+    # Parameters:
+    #   url (required) - string - URL for testing the webhook.
+    #   method - string - HTTP method(GET or POST).
+    #   encoding - string - HTTP encoding method.  Can be JSON, XML, or RAW (form data).
+    #   headers - object - Additional request headers.
+    #   body - object - Additional body parameters.
+    #   action - string - action for test body
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: url must be an String") if params.dig(:url) and !params.dig(:url).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: method must be an String") if params.dig(:method) and !params.dig(:method).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: encoding must be an String") if params.dig(:encoding) and !params.dig(:encoding).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: headers must be an Hash") if params.dig(:headers) and !params.dig(:headers).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: body must be an Hash") if params.dig(:body) and !params.dig(:body).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: url") unless params.dig(:url)
+
+      response, options = Api.send_request("/webhook_tests", :post, params, options)
+      WebhookTest.new(response.data, options)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.149
+  version: 1.0.150
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-24 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -150,6 +150,7 @@ files:
 - docs/user.md
 - docs/user_cipher_use.md
 - docs/user_request.md
+- docs/webhook_test.md
 - files.com.gemspec
 - lib/files.com.rb
 - lib/files.com/api.rb
@@ -221,6 +222,7 @@ files:
 - lib/files.com/models/user.rb
 - lib/files.com/models/user_cipher_use.rb
 - lib/files.com/models/user_request.rb
+- lib/files.com/models/webhook_test.rb
 - lib/files.com/response.rb
 - lib/files.com/sizable_io.rb
 - lib/files.com/system_profiler.rb