mailosaur 7.2.1 → 7.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27d013e44169ed1c8b0881334b94ce03d76177c35b48202058683a271a7920a8
-  data.tar.gz: 3fd514240ac76ddfe02296e7a67b97f10b9d5fc711e1c7d321a1222cc1caef0a
+  metadata.gz: 433da61cccbbf2683597e2dca5da83d0db8d127189e1a780cb0d620994f8d625
+  data.tar.gz: 3a3d1d058f2d5a62bd728228e32d0a7c78f07e11cc755f29f295ae544ac26ca1
 SHA512:
-  metadata.gz: 173665bfe6e3ac1b5eacc99f8e4e3b8bf6e7e9487e4852be057473468b56c00c9f53d38ac95218587fd07d86301efcf98b7ce04f234c93dff5df66aa6c8db402
-  data.tar.gz: 81b04fd97abcfaf0784973d7cf9e1b627d6f28664b1c38a43133f47a001f743a128102520d764d52fba0e7ca825625219b41121feb207b5f489eff569c1dac25
+  metadata.gz: afa9cc3cdd1b0c37b5364673824ce6695c662036595c3eaca91dbc2a76c99622f729b28fa6cf3d796e834f98a908074aeb2c5c498de79ebf3669ec3b4e79d67e
+  data.tar.gz: 9a5f5e6a88e53c754032b4ef79ff59b61a859c9413f79da4b9992f6c5e7917ce56eeb8ffb3c09252a0c35775314f648fc1d8d5ffb0a9e29232c5285fbbff9bbc

data/lib/Mailosaur/models/usage_account_limit.rb

@@ -0,0 +1,16 @@
+module Mailosaur
+  module Models
+    class UsageAccountLimit < BaseModel
+      def initialize(data = {})
+        @limit = data['limit']
+        @current = data['current']
+      end
+
+      # @return [Integer] The limit.
+      attr_accessor :limit
+
+      # @return [Integer] The current usage.
+      attr_accessor :current
+    end
+  end
+end

data/lib/Mailosaur/models/usage_account_limits.rb

@@ -0,0 +1,24 @@
+module Mailosaur
+  module Models
+    class UsageAccountLimits < BaseModel
+      def initialize(data = {})
+        @servers = Mailosaur::Models::UsageAccountLimit.new(data['servers'])
+        @users = Mailosaur::Models::UsageAccountLimit.new(data['users'])
+        @email = Mailosaur::Models::UsageAccountLimit.new(data['email'])
+        @sms = Mailosaur::Models::UsageAccountLimit.new(data['sms'])
+      end
+
+      # @return [UsageAccountLimit]
+      attr_accessor :servers
+
+      # @return [UsageAccountLimit]
+      attr_accessor :users
+
+      # @return [UsageAccountLimit]
+      attr_accessor :email
+
+      # @return [UsageAccountLimit]
+      attr_accessor :sms
+    end
+  end
+end

data/lib/Mailosaur/models/usage_transaction.rb

@@ -0,0 +1,20 @@
+module Mailosaur
+  module Models
+    class UsageTransaction < BaseModel
+      def initialize(data = {})
+        @timestamp = DateTime.parse(data['timestamp'])
+        @email = data['email']
+        @sms = data['sms']
+      end
+
+      # @return [DateTime] The datetime that this transaction occurred.
+      attr_accessor :timestamp
+
+      # @return [Integer] The count of emails.
+      attr_accessor :email
+
+      # @return [Integer] The count of SMS messages.
+      attr_accessor :sms
+    end
+  end
+end

data/lib/Mailosaur/models/usage_transaction_list_result.rb

@@ -0,0 +1,13 @@
+module Mailosaur
+  module Models
+    class UsageTransactionListResult < BaseModel
+      def initialize(data = {})
+        @items = []
+        (data['items'] || []).each do |i| @items << Mailosaur::Models::UsageTransaction.new(i) end
+      end
+
+      # @return [Array<UsageTransaction>] The individual transactions the result.
+      attr_accessor :items
+    end
+  end
+end

data/lib/Mailosaur/usage.rb

@@ -0,0 +1,41 @@
+module Mailosaur
+  class Usage
+    #
+    # Creates and initializes a new instance of the Usage class.
+    # @param client connection.
+    #
+    def initialize(conn, handle_http_error)
+      @conn = conn
+      @handle_http_error = handle_http_error
+    end
+
+    # @return [Connection] the client connection.
+    attr_reader :conn
+
+    #
+    # Retrieve account usage limits.
+    #
+    # Details the current limits and usage for your account.
+    #
+    # @return [UsageAccountLimits] operation results.
+    #
+    def limits
+      response = conn.get 'api/usage/limits'
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.load(response.body)
+      Mailosaur::Models::UsageAccountLimits.new(model)
+    end
+
+    #
+    # List account transactions. Retrieves the last 31 days of transactional usage.
+    #
+    # @return [UsageTransactionListResult] operation results.
+    #
+    def transactions
+      response = conn.get 'api/usage/transactions'
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.load(response.body)
+      Mailosaur::Models::UsageTransactionListResult.new(model)
+    end
+  end
+end

data/lib/Mailosaur/version.rb

@@ -1,3 +1,3 @@
 module Mailosaur
-    VERSION = '7.2.1'.freeze
+    VERSION = '7.3.0'.freeze
 end

data/lib/mailosaur.rb

@@ -13,6 +13,7 @@ module Mailosaur
   autoload :Files,                                              'Mailosaur/files.rb'
   autoload :Messages,                                           'Mailosaur/messages.rb'
   autoload :Servers,                                            'Mailosaur/servers.rb'
+  autoload :Usage,                                              'Mailosaur/usage.rb'
   autoload :MailosaurError,                                     'Mailosaur/mailosaur_error.rb'
 
   module Models
@@ -33,6 +34,10 @@ module Mailosaur
     autoload :ServerListResult,                                   'Mailosaur/models/server_list_result.rb'
     autoload :SpamFilterResults,                                  'Mailosaur/models/spam_filter_results.rb'
     autoload :ServerCreateOptions,                                'Mailosaur/models/server_create_options.rb'
+    autoload :UsageAccountLimits,                                 'Mailosaur/models/usage_account_limits.rb'
+    autoload :UsageAccountLimit,                                  'Mailosaur/models/usage_account_limit.rb'
+    autoload :UsageTransactionListResult,                         'Mailosaur/models/usage_transaction_list_result.rb'
+    autoload :UsageTransaction,                                   'Mailosaur/models/usage_transaction.rb'
     autoload :BaseModel,                                          'Mailosaur/models/base_model.rb'
   end
 
@@ -67,6 +72,11 @@ module Mailosaur
       @servers ||= Servers.new(connection, method(:handle_http_error))
     end
 
+    # @return [Usage] usage
+    def usage
+      @usage ||= Usage.new(connection, method(:handle_http_error))
+    end
+
     private
 
     def connection

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailosaur
 version: !ruby/object:Gem::Version
-  version: 7.2.1
+  version: 7.3.0
 platform: ruby
 authors:
 - Mailosaur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -175,8 +175,13 @@ files:
 - lib/Mailosaur/models/spam_analysis_result.rb
 - lib/Mailosaur/models/spam_assassin_rule.rb
 - lib/Mailosaur/models/spam_filter_results.rb
+- lib/Mailosaur/models/usage_account_limit.rb
+- lib/Mailosaur/models/usage_account_limits.rb
+- lib/Mailosaur/models/usage_transaction.rb
+- lib/Mailosaur/models/usage_transaction_list_result.rb
 - lib/Mailosaur/module_definition.rb
 - lib/Mailosaur/servers.rb
+- lib/Mailosaur/usage.rb
 - lib/Mailosaur/version.rb
 - lib/mailosaur.rb
 homepage: https://mailosaur.com/