files.com 1.0.309 → 1.0.310

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9886b13b98ac876358ccd85138f6c84a1214f97a34e69a6bbf1f7d35c6331d3
-  data.tar.gz: ebc93bc1fe74de6f75afc8bd33cfc3c81622a72ade67e2e56cdc7456dbbd8178
+  metadata.gz: 12c67b7a784af9d5988557e0cd87992d51f7878b93653d12c556001682aba566
+  data.tar.gz: 5c858aa53da71dfd469c96a6c083bad88744ca90cced1611901ea51ebcbfeb86
 SHA512:
-  metadata.gz: e4cab9cf85e598f96212646f5726b250928351fab4eeb882c248b58b9584369d0589f25f8543659d199cf7ce5065ac6e14e882f4ba47f8280302bd4227c8c474
-  data.tar.gz: 066f28504469069ac18f54c7f557d2fb40d103e8a7a88de8d9dc122400e2655cf70f0d2f080c25ff284a544f2b43237f2432cc112433dc813c93ccd94b796300
+  metadata.gz: 566964e1c18430492ceda2f0a77a97a3ac686bd3cd5b5f5e12f82eb053b916ba2a7b38e3fced42901680e0e3298b72ddf89dcffea0b2fe96c4bbc597b3ea8b0b
+  data.tar.gz: 1bbbcdd3f8fc8f1ebd9258d57c080cbee598c96e9f8422183291b94a3862b9f1ccc8bf6f5a3662159136951cc20bb4e71ecfcd0199079da6acde24e532f1270d

data/_VERSION

@@ -1 +1 @@
-1.0.309
+1.0.310

data/docs/bundle_notification.md

@@ -0,0 +1,97 @@
+# BundleNotification
+
+## Example BundleNotification Object
+
+```
+{
+  "bundle_id": 1,
+  "id": 1,
+  "notify_on_registration": true,
+  "user_id": 1
+}
+```
+
+* `bundle_id` (int64): Bundle ID to notify on
+* `id` (int64): Bundle Notification ID
+* `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
+* `user_id` (int64): The id of the user to notify.
+
+
+---
+
+## List Bundle Notifications
+
+```
+Files::BundleNotification.list(
+  user_id: 1, 
+  per_page: 1, 
+  bundle_id: 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).
+* `bundle_id` (int64): Bundle ID to notify on
+
+
+---
+
+## Show Bundle Notification
+
+```
+Files::BundleNotification.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle Notification ID.
+
+
+---
+
+## Create Bundle Notification
+
+```
+Files::BundleNotification.create(
+  user_id: 1, 
+  notify_on_registration: true, 
+  bundle_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): Required - The id of the user to notify.
+* `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
+* `bundle_id` (int64): Required - Bundle ID to notify on
+
+
+---
+
+## Delete Bundle Notification
+
+```
+Files::BundleNotification.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle Notification ID.
+
+
+---
+
+## Delete Bundle Notification
+
+```
+bundle_notification = Files::BundleNotification.list.first
+
+bundle_notification.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle Notification ID.

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

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Files
+  class BundleNotification
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Bundle ID to notify on
+    def bundle_id
+      @attributes[:bundle_id]
+    end
+
+    def bundle_id=(value)
+      @attributes[:bundle_id] = value
+    end
+
+    # int64 - Bundle Notification ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # boolean - Triggers bundle notification when a registration action occurs for it.
+    def notify_on_registration
+      @attributes[:notify_on_registration]
+    end
+
+    def notify_on_registration=(value)
+      @attributes[:notify_on_registration] = value
+    end
+
+    # int64 - The id of the user to notify.
+    def user_id
+      @attributes[:user_id]
+    end
+
+    def user_id=(value)
+      @attributes[:user_id] = value
+    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[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/bundle_notifications/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      if @attributes[:id]
+        raise NotImplementedError.new("The BundleNotification object doesn't support updates.")
+      else
+        new_obj = BundleNotification.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).
+    #   bundle_id - int64 - Bundle ID to notify on
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
+
+      List.new(BundleNotification, params) do
+        Api.send_request("/bundle_notifications", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Bundle Notification ID.
+    def self.find(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/bundle_notifications/#{params[:id]}", :get, params, options)
+      BundleNotification.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   user_id (required) - int64 - The id of the user to notify.
+    #   notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
+    #   bundle_id (required) - int64 - Bundle ID to notify on
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: user_id") unless params[:user_id]
+      raise MissingParameterError.new("Parameter missing: bundle_id") unless params[:bundle_id]
+
+      response, options = Api.send_request("/bundle_notifications", :post, params, options)
+      BundleNotification.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[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, _options = Api.send_request("/bundle_notifications/#{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.rb

@@ -49,6 +49,7 @@ require "files.com/models/bandwidth_snapshot"
 require "files.com/models/behavior"
 require "files.com/models/bundle"
 require "files.com/models/bundle_download"
+require "files.com/models/bundle_notification"
 require "files.com/models/bundle_recipient"
 require "files.com/models/bundle_registration"
 require "files.com/models/clickwrap"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.309
+  version: 1.0.310
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
+date: 2022-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -132,6 +132,7 @@ files:
 - docs/behavior.md
 - docs/bundle.md
 - docs/bundle_download.md
+- docs/bundle_notification.md
 - docs/bundle_recipient.md
 - docs/bundle_registration.md
 - docs/clickwrap.md
@@ -215,6 +216,7 @@ files:
 - lib/files.com/models/behavior.rb
 - lib/files.com/models/bundle.rb
 - lib/files.com/models/bundle_download.rb
+- lib/files.com/models/bundle_notification.rb
 - lib/files.com/models/bundle_recipient.rb
 - lib/files.com/models/bundle_registration.rb
 - lib/files.com/models/clickwrap.rb