mailinator_client 1.0.5 → 1.0.7

data/lib/mailinator_client/domains.rb

@@ -1,25 +1,3 @@
-# The MIT License (MIT)
-#
-# Copyright (c) 2024 Manybrain, Inc.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
 require "json"
 
 module MailinatorClient
@@ -83,7 +61,8 @@ module MailinatorClient
         body: body)
     end
 
-    # This endpoint creates a private domain attached to your account. 
+    # @deprecated Create Domain is deprecated in this client.
+    # This endpoint creates a private domain attached to your account.
     # Note, the domain must be unique to the system and you must have not reached your maximum number of Private Domains.
     #
     # Authentication:
@@ -113,6 +92,7 @@ module MailinatorClient
         body: body)
     end
 
+    # @deprecated Delete Domain is deprecated in this client.
     # This endpoint deletes a Private Domain
     #
     # Authentication:

data/lib/mailinator_client/error.rb

@@ -1,34 +1,20 @@
-# The MIT License (MIT)
-#
-# Copyright (c) 2024 Manybrain, Inc.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
 module MailinatorClient
   class ResponseError < StandardError
     attr_reader :code
     attr_reader :type
 
-    def initialize(code, result)
+    def initialize(code, result = nil, raw_body = nil)
+      result_hash = result.is_a?(Hash) ? result : {}
       @code = code
-      @type = result["type"]
-      super(result["message"])
+      @type = result_hash["type"] || result_hash[:type]
+
+      message = result_hash["message"] || result_hash[:message]
+      if (message.nil? || message.to_s.empty?) && !raw_body.nil?
+        message = raw_body.to_s.strip
+      end
+      message = "HTTP #{code}" if message.nil? || message.to_s.empty?
+
+      super(message)
     end
   end
 end

data/lib/mailinator_client/messages.rb

@@ -1,25 +1,3 @@
-# The MIT License (MIT)
-#
-# Copyright (c) 2024 Manybrain, Inc.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
 require "json"
 
 module MailinatorClient
@@ -40,10 +18,14 @@ module MailinatorClient
     # Parameters:
     # *  {string} domainId - The Domain name or the Domain id
     # *  {string} inbox - The Inbox name
-    # *  {number} skip - Skip this many emails in your Private Domain
-    # *  {number} limit - Number of emails to fetch from your Private Domain
-    # *  {string} sort - Sort results by ascending or descending
-    # *  {boolean} decodeSubject - true: decode encoded subjects
+    # *  {number} skip - [Optional] Skip this many emails in your Private Domain
+    # *  {number} limit - [Optional] Number of emails to fetch from your Private Domain
+    # *  {string} sort - [Optional] Sort results by ascending or descending
+    # *  {boolean} decodeSubject - [Optional] true: decode encoded subjects
+    # *  {string} cursor - [Optional] Pagination cursor for large result sets (obtained from previous response)
+    # *  {boolean} full - [Optional] Return full email content with body/attachments (true) or just metadata (false). Default: false
+    # *  {string} delete - [Optional] Auto-delete message after retrieval (e.g., "10s" = 10 seconds, "5m" = 5 minutes)
+    # *  {string} wait - [Optional] Maximum time to wait for new messages (e.g., "30s" = 30 seconds)
     #
     # Responses:
     # *  Collection of messages (https://manybrain.github.io/m8rdocs/#fetch-inbox-aka-fetch-message-summaries)
@@ -60,6 +42,10 @@ module MailinatorClient
       query_params[:limit] = params[:limit] if params.has_key?(:limit)
       query_params[:sort] = params[:sort] if params.has_key?(:sort)
       query_params[:decodeSubject] = params[:decodeSubject] if params.has_key?(:decodeSubject)
+      query_params[:cursor] = params[:cursor] if params.has_key?(:cursor)
+      query_params[:full] = params[:full] if params.has_key?(:full)
+      query_params[:delete] = params[:delete] if params.has_key?(:delete)
+      query_params[:wait] = params[:wait] if params.has_key?(:wait)
 
       path = "/domains/#{params[:domain]}/inboxes/#{params[:inbox]}"
 
@@ -81,6 +67,7 @@ module MailinatorClient
     # *  {string} domainId - The Domain name or the Domain id
     # *  {string} inbox - The Inbox name
     # *  {string} messageId - The Message id
+    # *  {string} delete - [Optional] Auto-delete message after retrieval (e.g., "10s" = 10 seconds, "5m" = 5 minutes)
     #
     # Responses:
     # *  Message (https://manybrain.github.io/m8rdocs/#fetch-inbox-message)
@@ -94,6 +81,8 @@ module MailinatorClient
       raise ArgumentError.new("inbox is required") unless params.has_key?(:inbox)
       raise ArgumentError.new("message id is required") unless params.has_key?(:messageId)
 
+      query_params[:delete] = params[:delete] if params.has_key?(:delete)
+
       path = "/domains/#{params[:domain]}/inboxes/#{params[:inbox]}/messages/#{params[:messageId]}"
 
       @client.request(
@@ -113,6 +102,7 @@ module MailinatorClient
     # Parameters:
     # *  {string} domainId - The Domain name or the Domain id
     # *  {string} messageId - The Message id
+    # *  {string} delete - [Optional] Auto-delete message after retrieval (e.g., "10s" = 10 seconds, "5m" = 5 minutes)
     #
     # Responses:
     # *  Message (https://manybrain.github.io/m8rdocs/#fetch-message)
@@ -125,6 +115,8 @@ module MailinatorClient
       raise ArgumentError.new("domain is required") unless params.has_key?(:domain)
       raise ArgumentError.new("message id is required") unless params.has_key?(:messageId)
 
+      query_params[:delete] = params[:delete] if params.has_key?(:delete)
+
       path = "/domains/#{params[:domain]}/messages/#{params[:messageId]}"
 
       @client.request(
@@ -144,18 +136,36 @@ module MailinatorClient
     # Parameters:
     # *  {string} domainId - The Domain name or the Domain id
     # *  {string} teamSmsNumber - The Team sms number
+    # *  {number} skip - [Optional] Skip this many emails in your Private Domain
+    # *  {number} limit - [Optional] Number of emails to fetch from your Private Domain
+    # *  {string} sort - [Optional] Sort results by ascending or descending
+    # *  {boolean} decode_subject - [Optional] true: decode encoded subjects
+    # *  {string} cursor - [Optional] Pagination cursor for large result sets (obtained from previous response)
+    # *  {boolean} full - [Optional] Return full email content with body/attachments (true) or just metadata (false). Default: false
+    # *  {string} delete - [Optional] Auto-delete message after retrieval (e.g., "10s" = 10 seconds, "5m" = 5 minutes)
+    # *  {string} wait - [Optional] Maximum time to wait for new messages (e.g., "30s" = 30 seconds)
     #
     # Responses:
     # *  Collection of messages (https://manybrain.github.io/m8rdocs/#fetch-an-sms-messages)
     def fetch_sms_message(params = {})
       params = Utils.symbolize_hash_keys(params)
-      query_params = { }
+      query_params = { skip: 0, limit: 50, sort: "ascending", decode_subject: false }
       headers = {}
       body = nil
 
       raise ArgumentError.new("domain is required") unless params.has_key?(:domain)
       raise ArgumentError.new("team sms number is required") unless params.has_key?(:teamSmsNumber)
 
+      query_params[:skip] = params[:skip] if params.has_key?(:skip)
+      query_params[:limit] = params[:limit] if params.has_key?(:limit)
+      query_params[:sort] = params[:sort] if params.has_key?(:sort)
+      query_params[:decode_subject] = params[:decode_subject] if params.has_key?(:decode_subject)
+      query_params[:decode_subject] = params[:decodeSubject] if params.has_key?(:decodeSubject)
+      query_params[:cursor] = params[:cursor] if params.has_key?(:cursor)
+      query_params[:full] = params[:full] if params.has_key?(:full)
+      query_params[:delete] = params[:delete] if params.has_key?(:delete)
+      query_params[:wait] = params[:wait] if params.has_key?(:wait)
+
       path = "/domains/#{params[:domain]}/inboxes/#{params[:teamSmsNumber]}"
 
       @client.request(
@@ -298,6 +308,37 @@ module MailinatorClient
         body: body)
     end
 
+    # Retrieves all links full info found within a given email.
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} domainId - The Domain name or the Domain id
+    # *  {string} messageId - The Message id
+    #
+    # Responses:
+    # *  Collection of links full (https://manybrain.github.io/m8rdocs/#fetch-links-full)
+    def fetch_message_links_full(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("domain is required") unless params.has_key?(:domain)
+      raise ArgumentError.new("message id is required") unless params.has_key?(:messageId)
+
+      path = "/domains/#{params[:domain]}/messages/#{params[:messageId]}/linksfull"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Retrieves all links found within a given email.
     #
     # Authentication:

data/lib/mailinator_client/rules.rb

@@ -1,25 +1,3 @@
-# The MIT License (MIT)
-#
-# Copyright (c) 2024 Manybrain, Inc.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
 require "json"
 
 module MailinatorClient
@@ -31,6 +9,7 @@ module MailinatorClient
       @client = client
     end
 
+    # @deprecated Rules endpoints are deprecated in this client.
     # Creates a Rule. Note that in the examples, ":domain_id" can be one of your private domains.
     #
     # Authentication:
@@ -64,6 +43,7 @@ module MailinatorClient
         body: body)
     end
 
+    # @deprecated Rules endpoints are deprecated in this client.
     # Enables an existing Rule
     #
     # Authentication:
@@ -95,6 +75,7 @@ module MailinatorClient
         body: body)
     end
 
+    # @deprecated Rules endpoints are deprecated in this client.
     # Disables an existing Rule
     #
     # Authentication:
@@ -126,6 +107,7 @@ module MailinatorClient
         body: body)
     end
 
+    # @deprecated Rules endpoints are deprecated in this client.
     # Fetches all Rules for a Domain.
     #
     # Authentication:
@@ -155,6 +137,7 @@ module MailinatorClient
         body: body)
     end
 
+    # @deprecated Rules endpoints are deprecated in this client.
     # Fetches a specific rule for a Domain.
     #
     # Authentication:
@@ -186,6 +169,7 @@ module MailinatorClient
         body: body)
     end
 
+    # @deprecated Rules endpoints are deprecated in this client.
     # Deletes a specific rule for a Domain.
     #
     # Authentication:

data/lib/mailinator_client/stats.rb

@@ -1,25 +1,3 @@
-# The MIT License (MIT)
-#
-# Copyright (c) 2024 Manybrain, Inc.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
 require "json"
 
 module MailinatorClient
@@ -31,6 +9,29 @@ module MailinatorClient
       @client = client
     end
 
+    # Retrieves info of team
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Responses:
+    # *  Collection of team info (https://manybrain.github.io/m8rdocs/#stats-api)
+    def get_team_info()
+      query_params = { }
+      headers = {}
+      body = nil
+
+      path = "/teaminfo"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Retrieves stats of team
     #
     # Authentication:
@@ -38,7 +39,7 @@ module MailinatorClient
     # access token to call this action.
     #
     # Responses:
-    # *  Collection of team stats (https://manybrain.github.io/m8rdocs/#get-all-domains)
+    # *  Collection of team stats (https://manybrain.github.io/m8rdocs/#stats-api)
     def get_team_stats()
       query_params = { }
       headers = {}
@@ -54,14 +55,14 @@ module MailinatorClient
         body: body)
     end
 
-    # Retrieves team info
+    # Retrieves team stats
     #
     # Authentication:
     # The client must be configured with a valid api
     # access token to call this action.
     #
     # Responses:
-    # *  Team info (https://manybrain.github.io/m8rdocs/#stats-api)
+    # *  Team stats (https://manybrain.github.io/m8rdocs/#stats-api)
     def get_team(params = {})
       params = Utils.symbolize_hash_keys(params)
       query_params = { }

data/lib/mailinator_client/utils.rb

@@ -1,25 +1,3 @@
-# The MIT License (MIT)
-#
-# Copyright (c) 2024 Manybrain, Inc.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
 module MailinatorClient
   class Utils
     def self.symbolize_hash_keys(hash)

data/lib/mailinator_client/version.rb

@@ -1,25 +1,3 @@
-# The MIT License (MIT)
-#
-# Copyright (c) 2024 Manybrain, Inc.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-module MailinatorClient
-  VERSION = "1.0.5"
-end
+module MailinatorClient
+  VERSION = "1.0.7"
+end