mailinator_client 1.0.4 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3e1ec11068d686d886639d80e6a17e17fd991341367ad61f929990d61724ffa
-  data.tar.gz: 07e57ad2cb1d9ebf07bcf785b5a61ee5e8627225eac1cff501d65767e5ad1edf
+  metadata.gz: d61079f915251b975bf65147de21720b5fb852cc9c7bf332b1683180c0dfaec2
+  data.tar.gz: 10a01b3d925703e33ac2b9273bd3c47d3e25488e0ae432fa39e8e758a9a97d48
 SHA512:
-  metadata.gz: 9900dcb42cd529cf13e37ebf6cec0a3f06a6a31d5efd712f460d39c243ac55606d40ba2b186d9a80d373142bef38e6e0400b61f58051f2755e2e4c716b528eff
-  data.tar.gz: b31c3de9304ed10adebb2e21a1693be58bc0141c79bf741538b235650e0a4b740dc69c029d4b3653088ea663870ed9c7d9ec58f9bfc38236ac8f25691351383f
+  metadata.gz: ae1050498f67e632586b7ff037d9f37785119370819012c872a49aa30012cd02edd5e5715cf6979b3353442b4599d14f05797727c20792790f5903f942223a6a
+  data.tar.gz: a782fc068b13f790c1974c48542435b73ce270edcec4f6087fe366e97c7e6cf7a3590a45d1b1fe3598de2c200d1d16d22f86cfd9cb722aa7c2b46dc40d822d9a

data/docs/authenticators.md

@@ -0,0 +1,71 @@
+# Authenticators Actions
+
+Details on the various actions that can be performed on the Authenticators resource, including the expected parameters and the potential responses.
+
+##### Contents
+
+*   [InstantTOTP2FACode](#instanttotp2facode)
+*   [GetAuthenticators](#getauthenticators)
+*   [GetAuthenticatorsById](#getauthenticatorsbyid)
+*   [GetAuthenticator](#getauthenticator)
+*   [GetAuthenticatorById](#getauthenticatorbyid)
+
+<br/>
+
+## InstantTOTP2FACode
+
+Instant TOTP 2FA code
+
+```ruby
+result = client.authenticators.instant_totp_2fa_code()
+
+puts result
+```
+
+<br/>
+
+## GetAuthenticators
+
+Fetch Authenticators
+
+```ruby
+result = client.authenticators.get_authenticators()
+
+puts result
+```
+
+<br/>
+
+## GetAuthenticatorsById
+
+Fetch the TOTP 2FA code from one of your saved Keys
+
+```ruby
+result = client.authenticators.get_authenticators_by_id()
+
+puts result
+```
+
+<br/>
+
+## GetAuthenticator
+
+Fetch Authenticator
+
+```ruby
+result = client.authenticators.get_authenticator()
+
+puts result
+```
+
+<br/>
+
+## GetAuthenticatorById
+
+Fetch Authenticator By Id
+
+```ruby
+result = client.authenticators.get_authenticator_by_id()
+
+puts result
+```

data/docs/messages.md

@@ -12,6 +12,7 @@ Details on the various actions that can be performed on the Messages resource, i
 *   [FetchMessageAttachments](#fetchmessageattachments)
 *   [FetchInboxMessageAttachment](#fetchinboxmessageattachment)
 *   [FetchMessageAttachment](#fetchmessageattachment)
+*   [FetchMessageLinksFull](#fetchmessagelinksfull)
 *   [FetchMessageLinks](#fetchmessagelinks)
 *   [FetchInboxMessageLinks](#fetchinboxmessagelinks)
 *   [DeleteAllDomainMessages](#deletealldomainmessages)
@@ -38,7 +39,11 @@ result = client.messages.fetch_inbox(
   skip: my_skip
   limit: my_limit
   sort: my_sort
-  decodeSubject: my_decode_subject)
+  decodeSubject: my_decode_subject,
+  cursor: my_cursor,
+  full: my_full,
+  delete: my_delete,
+  wait: my_wait)
 
 puts result
 ```
@@ -67,7 +72,8 @@ Retrieves a specific message by id
 ```ruby
 result = client.messages.fetch_message(
   domainId: my_domain_id
-  messageId: my_message_id)
+  messageId: my_message_id,
+  delete: my_delete)
 
 puts result
 ```
@@ -151,6 +157,19 @@ puts result
 
 <br/>
 
+## FetchMessageLinksFull
+
+Retrieves all links full found within a given email
+
+```ruby
+result = client.messages.fetch_message_links_full(
+  domainId: my_domain_id
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
 
 ## FetchMessageLinks
 

data/docs/stats.md

@@ -4,11 +4,24 @@ Details on the various actions that can be performed on the Stats resource, incl
 
 ##### Contents
 
+*   [GetTeamInfo](#getteaminfo)
 *   [GetTeamStats](#getteamstats)
 *   [GetTeam](#getteam)
 
 <br/>
 
+## GetTeamInfo
+
+Retrieves info of team
+
+```ruby
+result = client.stats.get_team_info()
+
+puts result
+```
+
+<br/>
+
 ## GetTeamStats
 
 Retrieves stats of team

data/docs/webhooks.md

@@ -0,0 +1,69 @@
+# Webhooks Actions
+
+Details on the various actions that can be performed on the Webhooks resource, including the expected parameters and the potential responses.
+
+##### Contents
+
+*   [PrivateWebhook](#privatewebhook)
+*   [PrivateInboxWebhook](#privateinboxwebhook)
+*   [PrivateCustomServiceWebhook](#privatecustomservicewebhook)
+*   [PrivateCustomServiceInboxWebhook](#privatecustomserviceinboxwebhook)
+
+<br/>
+
+## PrivateWebhook
+
+This command will Webhook messages into your Private Domain
+The incoming Webhook will arrive in the inbox designated by the "to" field in the incoming request payload.
+Webhooks into your Private System do NOT use your regular API Token.
+This is because a typical use case is to enter the Webhook URL into 3rd-party systems(i.e.Twilio, Zapier, IFTTT, etc) and you should never give out your API Token.
+Check your Team Settings where you can create "Webhook Tokens" designed for this purpose.
+    
+```ruby
+result = client.webhooks.private_webhook()
+
+puts result
+```
+
+<br/>
+
+## PrivatePublicInboxWebhook
+
+This command will deliver the message to the :inbox inbox
+Incoming Webhooks are delivered to Mailinator inboxes and from that point onward are not notably different than other messages in the system (i.e. emails). 
+As normal, Mailinator will list all messages in the Inbox page and via the Inbox API calls. 
+If the incoming JSON payload does not contain a "from" or "subject", then dummy values will be inserted in these fields.
+You may retrieve such messages via the Web Interface, the API, or the Rule System
+
+```ruby
+result = client.webhooks.private_inbox_webhook()
+
+puts result
+```
+
+<br/>
+
+## PrivateCustomServiceWebhook
+
+If you have a Twilio account which receives incoming SMS messages. You may direct those messages through this facility to inject those messages into the Mailinator system.
+Mailinator intends to apply specific mappings for certain services that commonly publish webhooks.
+If you test incoming Messages to SMS numbers via Twilio, you may use this endpoint to correctly map "to", "from", and "subject" of those messages to the Mailinator system.By default, the destination inbox is the Twilio phone number.
+    
+```ruby
+result = client.webhooks.private_custom_service_webhook()
+
+puts result
+```
+
+<br/>
+
+## PrivateCustomServiceInboxWebhook
+
+The SMS message will arrive in the Private Mailinator inbox corresponding to the Twilio Phone Number. (only the digits, if a plus sign precedes the number it will be removed) 
+If you wish the message to arrive in a different inbox, you may append the destination inbox to the URL.
+        
+```ruby
+result = client.webhooks.private_custom_service_inbox_webhook()
+
+puts result
+```

data/lib/mailinator_client/authenticators.rb

@@ -0,0 +1,165 @@
+# 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
+
+  # Class containing all the actions for the Authenticators Resource
+  class Authenticators
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Instant TOTP 2FA code
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} totpSecretKey - totp secret key
+    #
+    # Responses:
+    # *  Instant TOTP 2FA Code info (https://manybrain.github.io/m8rdocs/#instant-totp-2fa-code)
+    def instant_totp_2fa_code(params = {})
+      query_params = {}
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("totpSecretKey is required") unless params.has_key?(:totpSecretKey)
+
+      path = "/totp/#{params[:totpSecretKey]}"
+
+      response = @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Fetch Authenticators
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Responses:
+    # *  Collection of passcodes (https://manybrain.github.io/m8rdocs/#fetch-authenticators)
+    def get_authenticators()
+      query_params = {}
+      headers = {}
+      body = nil
+
+      path = "/authenticators"
+
+      response = @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+    
+    # Fetch the TOTP 2FA code from one of your saved Keys
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} id - authenticator id
+    #
+    # Responses:
+    # *  Authenticator (https://manybrain.github.io/m8rdocs/#fetch-authenticators-by-id)
+    def get_authenticators_by_id(params = {})
+      query_params = {}
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("id is required") unless params.has_key?(:id)
+
+      path = "/authenticators/#{params[:id]}"
+
+      response = @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+    
+    # Fetch Authenticator
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Responses:
+    # *  Collection of passcodes (https://manybrain.github.io/m8rdocs/#fetch-authenticator)
+    def get_authenticator()
+      query_params = {}
+      headers = {}
+      body = nil
+
+      path = "/authenticator"
+
+      response = @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Fetch Authenticator By Id
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} id - authenticator id
+    #
+    # Responses:
+    # *  Authenticator (https://manybrain.github.io/m8rdocs/#fetch-authenticator-by-id)
+    def get_authenticator_by_id(params = {})
+      query_params = {}
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("id is required") unless params.has_key?(:id)
+
+      path = "/authenticator/#{params[:id]}"
+
+      response = @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+    
+  end
+end

data/lib/mailinator_client/client.rb

@@ -72,7 +72,9 @@ module MailinatorClient
       response = HTTParty.send(method, path,
         query: Utils.fix_query_arrays(options[:query]),
         body: options[:body] && options[:body].to_json(),
-        headers: headers)
+        headers: headers,
+        timeout: 125
+      )
 
       result = response.parsed_response
       if response.code >= 400

data/lib/mailinator_client/messages.rb

@@ -40,10 +40,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 +64,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]}"
 
@@ -113,6 +121,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 +134,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(
@@ -298,6 +309,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/stats.rb

@@ -31,6 +31,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 +61,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 +77,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/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module MailinatorClient
-  VERSION = "1.0.4"
+  VERSION = "1.0.6"
 end

data/lib/mailinator_client/webhooks.rb

@@ -0,0 +1,172 @@
+# 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
+
+  # Class containing all the actions for the Webhooks Resource
+  class Webhooks
+
+    def initialize(client)
+      @client = client
+    end
+
+    # This command will Webhook messages into your Private Domain
+    # The incoming Webhook will arrive in the inbox designated by the "to" field in the incoming request payload.
+    # Webhooks into your Private System do NOT use your regular API Token.
+    # This is because a typical use case is to enter the Webhook URL into 3rd-party systems(i.e.Twilio, Zapier, IFTTT, etc) and you should never give out your API Token.
+    # Check your Team Settings where you can create "Webhook Tokens" designed for this purpose.
+    #
+    # Parameters:
+    # *  {string} whToken - webhook token
+    # *  {string} webhook - The Webhook object
+    #
+    # Responses:
+    # *  PrivateWebhookResponse (https://manybrain.github.io/m8rdocs/#private-webhook)
+    def private_webhook(params = {})
+      query_params = { whtoken: "" }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("whToken is required") unless params.has_key?(:whToken)
+      raise ArgumentError.new("webhook is required") unless params.has_key?(:webhook)
+      
+      query_params[:whtoken] = params[:whToken] if params.has_key?(:whToken)
+
+      path = "/domains/private/webhook"
+      
+      response = @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+    
+    # This command will deliver the message to the :inbox inbox
+    # Incoming Webhooks are delivered to Mailinator inboxes and from that point onward are not notably different than other messages in the system (i.e. emails). 
+    # As normal, Mailinator will list all messages in the Inbox page and via the Inbox API calls. 
+    # If the incoming JSON payload does not contain a "from" or "subject", then dummy values will be inserted in these fields.
+    # You may retrieve such messages via the Web Interface, the API, or the Rule System
+    #
+    # Parameters:
+    # *  {string} whToken - webhook token
+    # *  {string} inbox - inbox
+    # *  {string} webhook - The Webhook object
+    #
+    # Responses:
+    # *  PrivateWebhookResponse (https://manybrain.github.io/m8rdocs/#private-inbox-webhook)
+    def private_inbox_webhook(params = {})
+      query_params = { whtoken: "" }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("whToken is required") unless params.has_key?(:whToken)
+      raise ArgumentError.new("inbox is required") unless params.has_key?(:inbox)
+      raise ArgumentError.new("webhook is required") unless params.has_key?(:webhook)
+
+      body = params[:webhook] if params.has_key?(:webhook)
+
+      query_params[:whtoken] = params[:whToken] if params.has_key?(:whToken)
+
+      path = "/domains/private/webhook/#{params[:inbox]}"
+
+      response = @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+    
+    # If you have a Twilio account which receives incoming SMS messages. You may direct those messages through this facility to inject those messages into the Mailinator system.
+    # Mailinator intends to apply specific mappings for certain services that commonly publish webhooks.
+    # If you test incoming Messages to SMS numbers via Twilio, you may use this endpoint to correctly map "to", "from", and "subject" of those messages to the Mailinator system.By default, the destination inbox is the Twilio phone number.
+    #
+    # Parameters:
+    # *  {string} whToken - webhook token
+    # *  {string} customService - custom service name
+    # *  {string} webhook - The Webhook object
+    #
+    # Responses:
+    # *  PrivateWebhookResponse (https://manybrain.github.io/m8rdocs/#private-custom-service-webhook)
+    def private_custom_service_webhook(params = {})
+      query_params = { whtoken: "" }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("whToken is required") unless params.has_key?(:whToken)
+      raise ArgumentError.new("customService is required") unless params.has_key?(:customService)
+      raise ArgumentError.new("webhook is required") unless params.has_key?(:webhook)
+
+      body = params[:webhook] if params.has_key?(:webhook)
+      
+      query_params[:whtoken] = params[:whToken] if params.has_key?(:whToken)
+
+      path = "/domains/private/#{params[:customService]}"
+
+      response = @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # The SMS message will arrive in the Private Mailinator inbox corresponding to the Twilio Phone Number. (only the digits, if a plus sign precedes the number it will be removed) 
+    # If you wish the message to arrive in a different inbox, you may append the destination inbox to the URL.
+    #
+    # Parameters:
+    # *  {string} whToken - webhook token
+    # *  {string} inbox - inbox
+    # *  {string} customService - custom service name
+    # *  {string} webhook - The Webhook object
+    #
+    # Responses:
+    # *  PrivateWebhookResponse (https://manybrain.github.io/m8rdocs/#private-custom-service-inbox-webhook)
+    def private_custom_service_inbox_webhook(params = {})
+      query_params = { whtoken: "" }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("whToken is required") unless params.has_key?(:whToken)
+      raise ArgumentError.new("customService is required") unless params.has_key?(:customService)
+      raise ArgumentError.new("inbox is required") unless params.has_key?(:inbox)
+      raise ArgumentError.new("webhook is required") unless params.has_key?(:webhook)
+
+      body = params[:webhook] if params.has_key?(:webhook)
+      
+      query_params[:whtoken] = params[:whToken] if params.has_key?(:whToken)
+
+      path = "/domains/private/#{params[:customService]}/#{params[:inbox]}"
+
+      response = @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+    
+  end
+end

data/test/mailinator_client_api_test.rb

@@ -119,17 +119,36 @@ class MailinatorClientApiTest < MiniTest::Test
       assert response != nil, "Expected post message response to not be nil"
       assert response["status"] == "ok", "Expected post message response to be ok"
 
-      response = client.messages.fetch_inbox(domain:@domainName, inbox: @inboxAll, skip: 0, limit: 50, sort: "ascending", decodeSubject: false)
+      response = client.messages.fetch_inbox(domain:@domainName, inbox: @inboxAll, skip: 0, limit: 1, sort: "ascending", decodeSubject: false)
       assert response != nil, "Expected fetch inbox response to not be nil"
       assert response["msgs"] != nil, "Expected response fetch inbox messages to not be nil"
       @message = response["msgs"][0]
       @messageId = @message["id"]
 
+      response = client.messages.fetch_inbox(domain:@domainName, inbox: @inboxAll, limit: 1, cursor: response["cursor"])
+      assert response != nil, "Expected fetch inbox response to not be nil"
+      assert response["msgs"] != nil, "Expected response fetch inbox messages to not be nil"
+
+      response = client.messages.fetch_inbox(domain:@domainName, inbox: @inboxAll, limit: 1, full: true)
+      assert response != nil, "Expected fetch inbox response to not be nil"
+      assert response["msgs"] != nil, "Expected response fetch inbox messages to not be nil"
+
+      response = client.messages.fetch_inbox(domain:@domainName, inbox: @inboxAll, limit: 1, delete: "1m")
+      assert response != nil, "Expected fetch inbox response to not be nil"
+      assert response["msgs"] != nil, "Expected response fetch inbox messages to not be nil"
+      
+      response = client.messages.fetch_inbox(domain:@domainName, inbox: @inboxAll, limit: 1, wait: "1m")
+      assert response != nil, "Expected fetch inbox response to not be nil"
+      assert response["msgs"] != nil, "Expected response fetch inbox messages to not be nil"
+      
       response = client.messages.fetch_inbox_message(domain:@domainName, inbox: @inboxAll, messageId: @messageId)
       assert response != nil, "Expected fetch inbox message response to not be nil"
 
       response = client.messages.fetch_message(domain:@domainName, messageId: @messageId)
       assert response != nil, "Expected fetch message response to not be nil"
+      
+      response = client.messages.fetch_message(domain:@domainName, messageId: @messageId, delete: "10s")
+      assert response != nil, "Expected fetch message response to not be nil"
 
       response = client.messages.fetch_sms_message(domain:@domainName, teamSmsNumber: @teamSMSNumber)
       assert response != nil, "Expected fetch sms message response to not be nil"
@@ -146,6 +165,10 @@ class MailinatorClientApiTest < MiniTest::Test
       response = client.messages.fetch_message_attachment(domain:@domainName, messageId: @messageIdWithAttachment, attachmentId: @attachmentId)
       assert response != nil, "Expected fetch message attachment response to not be nil"
 
+      response = client.messages.fetch_message_links_full(domain:@domainName, messageId: @messageId)
+      assert response != nil, "Expected fetch message links full response to not be nil"
+      assert response["links"] != nil, "Expected fetch message links links full response to not be nil"
+
       response = client.messages.fetch_message_links(domain:@domainName, messageId: @messageId)
       assert response != nil, "Expected fetch message links response to not be nil"
       assert response["links"] != nil, "Expected fetch message links links response to not be nil"
@@ -184,6 +207,10 @@ class MailinatorClientApiTest < MiniTest::Test
       assert response != nil, "Expected delete all domain messages response to not be nil"
       assert response["status"] == "ok", "Expected delete all domain messages response to be ok"
 
+      response = client.stats.get_team_info
+      assert response != nil, "Expected response to not be nil"
+      assert response != nil, "Expected response team info to not be nil"
+
       response = client.stats.get_team_stats
       assert response != nil, "Expected response to not be nil"
       assert response["stats"] != nil, "Expected response stats to not be nil"
@@ -199,19 +226,6 @@ class MailinatorClientApiTest < MiniTest::Test
       }
 
       clientWithoutAuthToken = MailinatorClient::Client.new()
-      response = clientWithoutAuthToken.webhooks.public_webhook(webhook:webhook)
-      assert response != nil, "Expected public webhook response to not be nil"
-      assert response["status"] == "ok", "Expected public webhook response to be ok"
-      
-      response = clientWithoutAuthToken.webhooks.public_inbox_webhook(inbox: @webhookInbox, webhook:webhook)
-      assert response != nil, "Expected public inbox webhook response to not be nil"
-      assert response["status"] == "ok", "Expected public inbox webhook response to be ok"
-
-      response = clientWithoutAuthToken.webhooks.public_custom_service_webhook(customService: @webhookCustomService, webhook:webhook)
-      #assert response != nil, "Expected public custom service webhook response to not be nil"
-      
-      response = clientWithoutAuthToken.webhooks.public_custom_service_inbox_webhook(customService: @webhookCustomService, inbox: @webhookInbox, webhook:webhook)
-      #assert response != nil, "Expected public custom service inbox webhook response to not be nil"
       
       response = clientWithoutAuthToken.webhooks.private_webhook(whToken: @webhookTokenPrivateDomain, webhook:webhook)
       assert response != nil, "Expected private webhook status response to not be nil"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailinator_client
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.6
 platform: ruby
 authors:
 - Marian Melnychuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-23 00:00:00.000000000 Z
+date: 2025-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -81,11 +81,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- docs/authenticators.md
 - docs/domains.md
 - docs/messages.md
 - docs/rules.md
 - docs/stats.md
+- docs/webhooks.md
 - lib/mailinator_client.rb
+- lib/mailinator_client/authenticators.rb
 - lib/mailinator_client/client.rb
 - lib/mailinator_client/domains.rb
 - lib/mailinator_client/error.rb
@@ -94,6 +97,7 @@ files:
 - lib/mailinator_client/stats.rb
 - lib/mailinator_client/utils.rb
 - lib/mailinator_client/version.rb
+- lib/mailinator_client/webhooks.rb
 - mailinator_client.gemspec
 - test/mailinator_client_api_test.rb
 - test/test_helper.rb
@@ -116,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Provides a simple ruby wrapper around the Mailinator REST API