mailinator_client 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c153614073d679cfcc656e550cb8d2728f7083a207fbce01927fabd42b4aefb
-  data.tar.gz: 91de6200531df3ebe4a53d55052de5d703ff414e6cbb8a9bf2d62306ffaf8918
+  metadata.gz: a3e1ec11068d686d886639d80e6a17e17fd991341367ad61f929990d61724ffa
+  data.tar.gz: 07e57ad2cb1d9ebf07bcf785b5a61ee5e8627225eac1cff501d65767e5ad1edf
 SHA512:
-  metadata.gz: eb73f7d0316d9ed00664a6a94bf2054759b42047541fcda1288519abded67baedf1f021a6d9a70f3d6b76ca0f77fa6968c4394ea028bd55f5675ae2d01c6304f
-  data.tar.gz: e27c8a33b6d1cff75fddeef04b6b23f1306c4a46bde27c00d718c0a423c2e4c565d896e0e50695c5ef97e112ac07ec421f4b2bf56d1f0cb4f4804fcea3af5a7e
+  metadata.gz: 9900dcb42cd529cf13e37ebf6cec0a3f06a6a31d5efd712f460d39c243ac55606d40ba2b186d9a80d373142bef38e6e0400b61f58051f2755e2e4c716b528eff
+  data.tar.gz: b31c3de9304ed10adebb2e21a1693be58bc0141c79bf741538b235650e0a4b740dc69c029d4b3653088ea663870ed9c7d9ec58f9bfc38236ac8f25691351383f

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Manybrain, Inc.
+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

data/README.md

@@ -45,6 +45,9 @@ The ``Client()`` initializer takes the following arguments:
 
 Each of the following is a method on the client object, and returns a wrapper for the actions against that particular resource. See each resource documentation file for more information.
 
+* [authenticators](docs/authenticators.md)  
+  Contains all of the actions that can be performed against the set of [Authenticators](https://manybrain.github.io/m8rdocs/#authenticators-api) that the currently authenticated user has access to - such as listing the authenticators.
+
 * [domains](docs/domains.md)  
   Contains all of the actions that can be performed against the set of [Domains](https://manybrain.github.io/m8rdocs/#domains-api) that the currently authenticated user has access to - such as listing the domains.
 
@@ -56,6 +59,9 @@ Each of the following is a method on the client object, and returns a wrapper fo
 
 * [messages](docs/messages.md)  
   Contains all of the actions that can be performed against the set of [Messages](https://manybrain.github.io/m8rdocs/#message-api) that the currently authenticated user has access to - such as listing the messages or injecting a new message.
+  
+* [webhooks](docs/webhooks.md)  
+  Contains all of the actions that can be performed against the set of [Webhooks](https://manybrain.github.io/m8rdocs/#webhooks-api) that the currently user has access to - such as listing the webhooks.
 
 <br/>
 
@@ -92,10 +98,16 @@ Most of the tests require env variables with valid values. Visit tests source co
 * `MAILINATOR_TEST_MESSAGE_WITH_ATTACHMENT_ID` - existing message id within inbox (see above) within private domain (see above); see also https://manybrain.github.io/m8rdocs/#fetch-message
 * `MAILINATOR_TEST_ATTACHMENT_ID` - existing message id within inbox (see above) within private domain (see above); see also https://manybrain.github.io/m8rdocs/#fetch-message
 * `MAILINATOR_TEST_DELETE_DOMAIN` - don't use it unless you are 100% sure what you are doing
+* `MAILINATOR_TEST_WEBHOOKTOKEN_PRIVATEDOMAIN` - private domain for webhook token
+* `MAILINATOR_TEST_WEBHOOKTOKEN_CUSTOMSERVICE` - custom service for webhook token
+* `MAILINATOR_TEST_AUTH_SECRET` - authenticator secret
+* `MAILINATOR_TEST_AUTH_ID` - authenticator id
+* `MAILINATOR_TEST_WEBHOOK_INBOX` - inbox for webhook
+* `MAILINATOR_TEST_WEBHOOK_CUSTOMSERVICE` - custom service for webhook
 
 
 *****
 
-Copyright (c) 2020 Manybrain, Inc
+Copyright (c) 2024 Manybrain, Inc
 
 <https://www.mailinator.com/>

data/docs/domains.md

@@ -6,6 +6,8 @@ Details on the various actions that can be performed on the Domains resource, in
 
 *   [GetDomains](#getdomains)
 *   [GetDomain](#getdomain)
+*   [CreateDomain](#createdomain)
+*   [DeleteDomain](#deletedomain)
 
 <br/>
 
@@ -30,3 +32,27 @@ result = client.domains.get_domain(domainId: my_domain_id)
 
 puts result
 ```
+
+<br/>
+
+## CreateDomain
+
+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.
+
+```ruby
+result = client.domains.create_domain(domainId: my_domain_id)
+
+puts result
+```
+
+<br/>
+
+## DeleteDomain
+
+This endpoint deletes a Private Domain
+
+```ruby
+result = client.domains.delete_domain(domainId: my_domain_id)
+
+puts result
+```

data/docs/messages.md

@@ -5,15 +5,25 @@ Details on the various actions that can be performed on the Messages resource, i
 ##### Contents
 
 *   [FetchInbox](#fetchinbox)
+*   [FetchInboxMessage](#fetchinboxmessage)
 *   [FetchMessage](#fetchmessage)
 *   [FetchSMSMessage](#fetchsmsmessage)
-*   [FetchAttachments](#fetchattachments)
-*   [FetchAttachment](#fetchattachment)
+*   [FetchInboxMessageAttachments](#fetchinboxmessageattachments)
+*   [FetchMessageAttachments](#fetchmessageattachments)
+*   [FetchInboxMessageAttachment](#fetchinboxmessageattachment)
+*   [FetchMessageAttachment](#fetchmessageattachment)
 *   [FetchMessageLinks](#fetchmessagelinks)
+*   [FetchInboxMessageLinks](#fetchinboxmessagelinks)
 *   [DeleteAllDomainMessages](#deletealldomainmessages)
 *   [DeleteAllInboxMessages](#deleteallinboxmessages)
 *   [DeleteMessage](#deletemessage)
-*   [InjectMessage](#injectmessage)
+*   [PostMessage](#postmessage)
+*   [FetchMessageSmtpLog](#fetchmessagesmtplog)
+*   [FetchInboxMessageSmtpLog](#fetchinboxmessagesmtplog)
+*   [FetchMessageRaw](#fetchmessageraw)
+*   [FetchInboxMessageRaw](#fetchinboxmessageraw)
+*   [FetchLatestMessages](#fetchlatestmessages)
+*   [FetchLatestInboxMessages](#fetchlatestinboxmessages)
 
 <br/>
 
@@ -35,12 +45,12 @@ puts result
 
 <br/>
 
-## FetchMessage
+## FetchInboxMessage
 
-Retrieves a specific message by id
+Retrieves a specific message by id for specific inbox
 
 ```ruby
-result = client.messages.fetch_inbox(
+result = client.messages.fetch_inbox_message(
   domainId: my_domain_id
   inbox: my_inbox
   messageId: my_message_id)
@@ -50,6 +60,19 @@ puts result
 
 <br/>
 
+## FetchMessage
+
+Retrieves a specific message by id
+
+```ruby
+result = client.messages.fetch_message(
+  domainId: my_domain_id
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
 
 ## FetchSMSMessage
 
@@ -67,12 +90,12 @@ puts result
 <br/>
 
 
-## FetchAttachments
+## FetchInboxMessageAttachments
 
-Retrieves a list of attachments for a message
+Retrieves a list of attachments for a message for specific inbox
 
 ```ruby
-result = client.messages.fetch_attachments(
+result = client.messages.fetch_inbox_message_attachments(
   domainId: my_domain_id
   inbox: my_inbox
   messageId: my_message_id)
@@ -82,13 +105,27 @@ puts result
 
 <br/>
 
+## FetchMessageAttachments
 
-## FetchAttachment
+Retrieves a list of attachments for a message
 
-Retrieves a specific attachment
+```ruby
+result = client.messages.fetch_message_attachments(
+  domainId: my_domain_id
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+
+## FetchInboxMessageAttachment
+
+Retrieves a specific attachment for specific inbox
 
 ```ruby
-result = client.messages.fetch_attachment(
+result = client.messages.fetch_inbox_message_attachment(
   domainId: my_domain_id
   inbox: my_inbox
   messageId: my_message_id
@@ -99,6 +136,21 @@ puts result
 
 <br/>
 
+## FetchMessageAttachment
+
+Retrieves a specific attachment
+
+```ruby
+result = client.messages.fetch_message_attachment(
+  domainId: my_domain_id
+  messageId: my_message_id
+  attachmentId: my_attachment_id)
+
+puts result
+```
+
+<br/>
+
 
 ## FetchMessageLinks
 
@@ -106,6 +158,20 @@ Retrieves all links found within a given email
 
 ```ruby
 result = client.messages.fetch_message_links(
+  domainId: my_domain_id
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+## FetchInboxMessageLinks
+
+Retrieves all links found within a given email for specific inbox
+
+```ruby
+result = client.messages.fetch_inbox_message_links(
   domainId: my_domain_id
   inbox: my_inbox
   messageId: my_message_id)
@@ -162,15 +228,105 @@ puts result
 <br/>
 
 
-## InjectMessage
+## PostMessage
 
 Deliver a JSON message into your private domain
 
 ```ruby
-result = client.messages.inject_message(
+result = client.messages.post_message(
   domainId: my_domain_id
   inbox: my_inbox
   messageToPost: my_message_to_post)
 
 puts result
 ```
+
+<br/>
+
+
+## FetchMessageSmtpLog
+
+Retrieves all smtp log found within a given email
+
+```ruby
+result = client.messages.fetch_message_smtp_log(
+  domainId: my_domain_id
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+## FetchInboxMessageSmtpLog
+
+Retrieves all smtp log found within a given email for specific inbox
+
+```ruby
+result = client.messages.fetch_inbox_message_smtp_log(
+  domainId: my_domain_id
+  inbox: my_inbox
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+
+## FetchMessageRaw
+
+Retrieves all raw data found within a given email
+
+```ruby
+result = client.messages.fetch_message_raw(
+  domainId: my_domain_id
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+## FetchInboxMessageLinks
+
+Retrieves all raw data found within a given email for specific inbox
+
+```ruby
+result = client.messages.fetch_inbox_message_raw(
+  domainId: my_domain_id
+  inbox: my_inbox
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+
+## FetchLatestMessages
+
+That fetches the latest 5 FULL messages
+
+```ruby
+result = client.messages.fetch_latest_messages(
+  domainId: my_domain_id
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+## FetchLatestInboxMessages
+
+That fetches the latest 5 FULL messages for specific inbox
+
+```ruby
+result = client.messages.fetch_latest_inbox_messages(
+  domainId: my_domain_id
+  inbox: my_inbox
+  messageId: my_message_id)
+
+puts result
+```

data/lib/mailinator_client/client.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Manybrain, Inc.
+# 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
@@ -23,6 +23,7 @@
 require "httparty"
 
 module MailinatorClient
+  require_relative 'version'
   # Mailinator API
   #
   # User API for accessing Mailinator data
@@ -31,7 +32,11 @@ module MailinatorClient
 
     def initialize(options = {})
       @auth_token = options.fetch(:auth_token, nil)
-      @url        = "https://mailinator.com/api/v2"
+      @url        = "https://api.mailinator.com/api/v2"
+    end
+
+    def authenticators
+      @authenticators ||= Authenticators.new(self)
     end
 
     def domains
@@ -50,12 +55,17 @@ module MailinatorClient
       @rules ||= Rules.new(self)
     end
 
+    def webhooks
+      @webhooks ||= Webhooks.new(self)
+    end
+
     def request(options = {})
       headers = options.fetch(:headers, {})
       method  = options.fetch(:method, :get)
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
+      headers["User-Agent"]   = "Mailinator SDK - Ruby V#{MailinatorClient::VERSION}"
       headers["Authorization"]  = @auth_token if @auth_token
       path = @url + options.fetch(:path, "")
 

data/lib/mailinator_client/domains.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Manybrain, Inc.
+# 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
@@ -83,5 +83,64 @@ module MailinatorClient
         body: body)
     end
 
+    # 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:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} domainId - The Domain name
+    #
+    # Responses:
+    # *  Status (https://manybrain.github.io/m8rdocs/#create-domain)
+    def create_domain(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)
+
+      path = "/domains/#{params[:domainId]}"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # This endpoint deletes a Private Domain
+    #
+    # 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
+    #
+    # Responses:
+    # *  Status (https://manybrain.github.io/m8rdocs/#delete-domain)
+    def delete_domain(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)
+
+      path = "/domains/#{params[:domainId]}"
+
+      @client.request(
+        method: :delete,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
   end
 end

data/lib/mailinator_client/error.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Manybrain, Inc.
+# 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

data/lib/mailinator_client/messages.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Manybrain, Inc.
+# 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
@@ -71,7 +71,7 @@ module MailinatorClient
         body: body)
     end
 
-    # Retrieves a specific message by id.
+    # Retrieves a specific message by id for specific inbox.
     #
     # Authentication:
     # The client must be configured with a valid api
@@ -83,8 +83,8 @@ module MailinatorClient
     # *  {string} messageId - The Message id
     #
     # Responses:
-    # *  Message (https://manybrain.github.io/m8rdocs/#fetch-message)
-    def fetch_message(params = {})
+    # *  Message (https://manybrain.github.io/m8rdocs/#fetch-inbox-message)
+    def fetch_inbox_message(params = {})
       params = Utils.symbolize_hash_keys(params)
       query_params = { }
       headers = {}
@@ -104,6 +104,37 @@ module MailinatorClient
         body: body)
     end
 
+    # Retrieves a specific message by id.
+    #
+    # 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:
+    # *  Message (https://manybrain.github.io/m8rdocs/#fetch-message)
+    def fetch_message(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]}"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Retrieves a specific SMS message by sms number.
     #
     # Authentication:
@@ -112,7 +143,6 @@ module MailinatorClient
     #
     # Parameters:
     # *  {string} domainId - The Domain name or the Domain id
-    # *  {string} inbox - The Inbox name
     # *  {string} teamSmsNumber - The Team sms number
     #
     # Responses:
@@ -124,10 +154,9 @@ module MailinatorClient
       body = nil
 
       raise ArgumentError.new("domain is required") unless params.has_key?(:domain)
-      raise ArgumentError.new("inbox is required") unless params.has_key?(:inbox)
       raise ArgumentError.new("team sms number is required") unless params.has_key?(:teamSmsNumber)
 
-      path = "/domains/#{params[:domain]}/inboxes/#{params[:inbox]}/#{params[:teamSmsNumber]}"
+      path = "/domains/#{params[:domain]}/inboxes/#{params[:teamSmsNumber]}"
 
       @client.request(
         method: :get,
@@ -137,7 +166,7 @@ module MailinatorClient
         body: body)
     end
 
-    # Retrieves a list of attachments for a message. Note attachments are expected to be in Email format.
+    # Retrieves a list of attachments for a message for specific inbox. Note attachments are expected to be in Email format.
     #
     # Authentication:
     # The client must be configured with a valid api
@@ -149,8 +178,8 @@ module MailinatorClient
     # *  {string} messageId - The Message id
     #
     # Responses:
-    # *  Collection of attachments (https://manybrain.github.io/m8rdocs/#fetch-list-of-attachments)
-    def fetch_attachments(params = {})
+    # *  Collection of attachments (https://manybrain.github.io/m8rdocs/#fetch-inbox-message-list-of-attachments)
+    def fetch_inbox_message_attachments(params = {})
       params = Utils.symbolize_hash_keys(params)
       query_params = { }
       headers = {}
@@ -170,8 +199,38 @@ module MailinatorClient
         body: body)
     end
 
+    # Retrieves a list of attachments for a message. Note attachments are expected to be in Email format.
+    #
+    # 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 attachments (https://manybrain.github.io/m8rdocs/#fetch-list-of-attachments)
+    def fetch_message_attachments(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { }
+      headers = {}
+      body = nil
 
-    # Retrieves a specific attachment.
+      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]}/attachments"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Retrieves a specific attachment for specific inbox.
     #
     # Authentication:
     # The client must be configured with a valid api
@@ -184,8 +243,8 @@ module MailinatorClient
     # *  {string} attachmentId - The Attachment id
     #
     # Responses:
-    # *  Attachment (https://manybrain.github.io/m8rdocs/#fetch-attachment)
-    def fetch_attachment(params = {})
+    # *  Attachment (https://manybrain.github.io/m8rdocs/#fetch-inbox-message-attachment)
+    def fetch_inbox_message_attachment(params = {})
       params = Utils.symbolize_hash_keys(params)
       query_params = { }
       headers = {}
@@ -206,6 +265,39 @@ module MailinatorClient
         body: body)
     end
 
+    # Retrieves a specific attachment.
+    #
+    # 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
+    # *  {string} attachmentId - The Attachment id
+    #
+    # Responses:
+    # *  Attachment (https://manybrain.github.io/m8rdocs/#fetch-attachment)
+    def fetch_message_attachment(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)
+      raise ArgumentError.new("attachment id is required") unless params.has_key?(:attachmentId)
+
+      path = "/domains/#{params[:domain]}/messages/#{params[:messageId]}/attachments/#{params[:attachmentId]}"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Retrieves all links found within a given email.
     #
     # Authentication:
@@ -214,7 +306,6 @@ module MailinatorClient
     #
     # Parameters:
     # *  {string} domainId - The Domain name or the Domain id
-    # *  {string} inbox - The Inbox name
     # *  {string} messageId - The Message id
     #
     # Responses:
@@ -225,6 +316,38 @@ module MailinatorClient
       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]}/links"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Retrieves all links found within a given email for specific inbox.
+    #
+    # 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} inbox - The Inbox name
+    # *  {string} messageId - The Message id
+    #
+    # Responses:
+    # *  Collection of links (https://manybrain.github.io/m8rdocs/#fetch-inbox-message-links)
+    def fetch_inbox_message_links(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("inbox is required") unless params.has_key?(:inbox)
       raise ArgumentError.new("message id is required") unless params.has_key?(:messageId)
@@ -344,8 +467,8 @@ module MailinatorClient
     # *  {string} messageToPost - The Message object (https://manybrain.github.io/m8rdocs/#inject-a-message-http-post-messages)
     #
     # Responses:
-    # *  Status, Id and RulesToFired info (https://manybrain.github.io/m8rdocs/#fetch-an-sms-messages)
-    def inject_message(params = {})
+    # *  Status, Id and RulesToFired info (https://manybrain.github.io/m8rdocs/#post-message)
+    def post_message(params = {})
       params = Utils.symbolize_hash_keys(params)
       query_params = { }
       headers = {}
@@ -367,5 +490,193 @@ module MailinatorClient
         body: body)
     end
 
+    # Retrieves all smtp log 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 smtp logs (https://manybrain.github.io/m8rdocs/#fetch-message-smtp-log)
+    def fetch_message_smtp_log(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]}/smtplog"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Retrieves all smtp log found within a given email for specific inbox.
+    #
+    # 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} inbox - The Inbox name
+    # *  {string} messageId - The Message id
+    #
+    # Responses:
+    # *  Collection of smtp log (https://manybrain.github.io/m8rdocs/#fetch-inbox-message-smtp-log)
+    def fetch_inbox_message_smtp_log(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("inbox is required") unless params.has_key?(:inbox)
+      raise ArgumentError.new("message id is required") unless params.has_key?(:messageId)
+
+      path = "/domains/#{params[:domain]}/inboxes/#{params[:inbox]}/messages/#{params[:messageId]}/smtplog"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Retrieves all raw data 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:
+    # *  Raw Data (https://manybrain.github.io/m8rdocs/#fetch-message-raw)
+    def fetch_message_raw(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]}/raw"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Retrieves all raw data found within a given email for specific inbox.
+    #
+    # 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} inbox - The Inbox name
+    # *  {string} messageId - The Message id
+    #
+    # Responses:
+    # *  Raw Data (https://manybrain.github.io/m8rdocs/#fetch-inbox-message-raw)
+    def fetch_inbox_message_raw(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("inbox is required") unless params.has_key?(:inbox)
+      raise ArgumentError.new("message id is required") unless params.has_key?(:messageId)
+
+      path = "/domains/#{params[:domain]}/inboxes/#{params[:inbox]}/messages/#{params[:messageId]}/raw"
+      
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # That fetches the latest 5 FULL messages.
+    #
+    # 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
+    #
+    # Responses:
+    # *  Collection of latest messages (https://manybrain.github.io/m8rdocs/#fetch-latest-messages)
+    def fetch_latest_messages(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("domain is required") unless params.has_key?(:domain)
+
+      path = "/domains/#{params[:domain]}/messages/*"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # That fetches the latest 5 FULL messages for specific inbox.
+    #
+    # 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} inbox - The Inbox name
+    #
+    # Responses:
+    # *  Collection of latest messages (https://manybrain.github.io/m8rdocs/#fetch-latest-inbox-messages)
+    def fetch_latest_inbox_messages(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("inbox is required") unless params.has_key?(:inbox)
+
+      path = "/domains/#{params[:domain]}/inboxes/#{params[:inbox]}/messages/*"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+    
   end
 end

data/lib/mailinator_client/rules.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Manybrain, Inc.
+# 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

data/lib/mailinator_client/stats.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Manybrain, Inc.
+# 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

data/lib/mailinator_client/utils.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Manybrain, Inc.
+# 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

data/lib/mailinator_client/version.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Manybrain, Inc.
+# 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
@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module MailinatorClient
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/lib/mailinator_client.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Manybrain, Inc.
+# 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
@@ -23,10 +23,12 @@
 require_relative "mailinator_client/version"
 require_relative "mailinator_client/error"
 require_relative "mailinator_client/utils"
+require_relative "mailinator_client/authenticators"
 require_relative "mailinator_client/domains"
 require_relative "mailinator_client/stats"
 require_relative "mailinator_client/messages"
 require_relative "mailinator_client/rules"
+require_relative "mailinator_client/webhooks"
 require_relative "mailinator_client/client"
 
 module MailinatorClient

data/test/mailinator_client_api_test.rb

@@ -11,12 +11,33 @@ class MailinatorClientApiTest < MiniTest::Test
       @messageIdWithAttachment = "MAILINATOR_TEST_MESSAGE_WITH_ATTACHMENT_ID"
       @attachmentId = "MAILINATOR_TEST_ATTACHMENT_ID"
       @deleteDomain = "MAILINATOR_TEST_DELETE_DOMAIN"
+      @webhookTokenPrivateDomain= "MAILINATOR_TEST_WEBHOOKTOKEN_PRIVATEDOMAIN"
+      @webhookTokenCustomService = "MAILINATOR_TEST_WEBHOOKTOKEN_CUSTOMSERVICE"
+      @authSecret = "MAILINATOR_TEST_AUTH_SECRET"
+      @authId = "MAILINATOR_TEST_AUTH_ID"
+      @webhookInbox = "MAILINATOR_TEST_WEBHOOK_INBOX"
+      @webhookCustomService = "MAILINATOR_TEST_WEBHOOK_CUSTOMSERVICE"
     end
 
     it "should correctly do manipulation with mailinator data" do
 
       client = MailinatorClient::Client.new(auth_token: @auth_token)
 
+      response = client.authenticators.instant_totp_2fa_code(totpSecretKey: @authSecret)
+      assert response != nil, "Expected instant totp 2fa code response to not be nil"
+      
+      response = client.authenticators.get_authenticators()
+      assert response != nil, "Expected get authenticators response to not be nil"
+      
+      response = client.authenticators.get_authenticators_by_id(id: @authId)
+      assert response != nil, "Expected get authenticators by id response to not be nil"
+      
+      response = client.authenticators.get_authenticator()
+      assert response != nil, "Expected get authenticator response to not be nil"
+      
+      response = client.authenticators.get_authenticator_by_id(id: @authId)
+      assert response != nil, "Expected get authenticator by id response to not be nil"
+
       response = client.domains.get_domains
       assert response != nil, "Expected get domains response to not be nil"
       assert response["domains"] != nil, "Expected response domains to not be nil"
@@ -24,13 +45,24 @@ class MailinatorClientApiTest < MiniTest::Test
       @domainId = @domain["_id"]
       @domainName = @domain["name"]
       
-      response = client.domains.get_domain(domainId:@domainId)
+      response = client.domains.get_domain(domainId:@domainName)
       assert response != nil, "Expected get domain response to not be nil"
 
+      @domainNameToAdd = "testruby.testinator.com"
+
+      response = client.domains.create_domain(domainId:@domainNameToAdd)
+      assert response != nil, "Expected create domain response to not be nil"
+      #assert response["status"] == "ok", "Expected create domain response to be ok"
+
+      response = client.domains.delete_domain(domainId:@domainNameToAdd)
+      assert response != nil, "Expected delete domain response to not be nil"
+      #assert response["status"] == "ok", "Expected delete domain response to be ok"
+      
+      random_string = SecureRandom.hex(4)
       ruleToPost = {
-        name:        "RuleName",
+        name:        "RuleName_RubyTest_#{random_string}",
         priority:    15,
-        description: "Description",
+        description: "Description_RubyTest_#{random_string}",
         conditions: [
           {
             operation: "PREFIX",
@@ -52,54 +84,94 @@ class MailinatorClientApiTest < MiniTest::Test
         ]
       }
 
-      response = client.rules.create_rule(domainId:@domainId, ruleToPost: ruleToPost)
+      response = client.rules.create_rule(domainId:@domainName, ruleToPost: ruleToPost)
       assert response != nil, "Expected get create rule response to not be nil"
       assert response["_id"] != nil, "Expected response rule id to not be nil"
 
-      response = client.rules.get_all_rules(domainId:@domainId)
+      response = client.rules.get_all_rules(domainId:@domainName)
       assert response != nil, "Expected get all rules response to not be nil"
       assert response["rules"] != nil, "Expected response rules to not be nil"
       @rule = response["rules"][0]
       @ruleId = @rule["_id"]
 
-      response = client.rules.enable_rule(domainId:@domainId, ruleId: @ruleId)
+      response = client.rules.enable_rule(domainId:@domainName, ruleId: @ruleId)
       assert response != nil, "Expected enable rule response to not be nil"
       assert response["status"] == "ok", "Expected enable rule response to be ok"
 
-      response = client.rules.disable_rule(domainId:@domainId, ruleId: @ruleId)
+      response = client.rules.disable_rule(domainId:@domainName, ruleId: @ruleId)
       assert response != nil, "Expected disable rule response to not be nil"
       assert response["status"] == "ok", "Expected disable rule response to be ok"
 
-      response = client.rules.get_rule(domainId:@domainId, ruleId: @ruleId)
+      response = client.rules.get_rule(domainId:@domainName, ruleId: @ruleId)
       assert response != nil, "Expected disable rule response to not be nil"
-      assert response["_id"] != nil, "Expected get rule response to not be nil"
+      assert response["_id"] != nil, "Expected get rule response id to not be nil"
 
       response = client.rules.delete_rule(domainId:@deleteDomain, ruleId: @ruleId)
       assert response != nil, "Expected delete rule response to not be nil"
       assert response["status"] == "ok", "Expected delete rule response to be ok"
 
+      messageToPost = {
+        subject:"Testing ruby message",
+        from:"test_email_ruby@test.com", 
+        text:"I love Ruby!"
+      }
+      response = client.messages.post_message(domain:@domainName, inbox: @inboxAll, messageToPost: messageToPost)
+      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)
       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_message(domain:@domainName, inbox: @inboxAll, messageId: @messageId)
+      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_sms_message(domain:@domainName, inbox: @inboxAll, teamSmsNumber: @teamSMSNumber)
+      response = client.messages.fetch_sms_message(domain:@domainName, teamSmsNumber: @teamSMSNumber)
       assert response != nil, "Expected fetch sms message response to not be nil"
 
-      response = client.messages.fetch_attachments(domain:@domainName, inbox: @inbox, messageId: @messageIdWithAttachment)
-      assert response != nil, "Expected fetch attachments response to not be nil"
+      response = client.messages.fetch_inbox_message_attachments(domain:@domainName, inbox: @inbox, messageId: @messageIdWithAttachment)
+      assert response != nil, "Expected fetch inbox message attachments response to not be nil"
+
+      response = client.messages.fetch_message_attachments(domain:@domainName, messageId: @messageIdWithAttachment)
+      assert response != nil, "Expected fetch message attachments response to not be nil"
 
-      response = client.messages.fetch_attachment(domain:@domainName, inbox: @inbox, messageId: @messageIdWithAttachment, attachmentId: @attachmentId)
-      assert response != nil, "Expected fetch attachment response to not be nil"
+      response = client.messages.fetch_inbox_message_attachment(domain:@domainName, inbox: @inbox, messageId: @messageIdWithAttachment, attachmentId: @attachmentId)
+      assert response != nil, "Expected fetch inbox message attachment response to not be nil"
 
-      response = client.messages.fetch_message_links(domain:@domainName, inbox: @inboxAll, messageId: @messageId)
+      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(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"
+      
+      response = client.messages.fetch_inbox_message_links(domain:@domainName, inbox: @inboxAll, messageId: @messageId)
+      assert response != nil, "Expected fetch inbox message links response to not be nil"
+      assert response["links"] != nil, "Expected fetch inbox message links links response to not be nil"
 
+      response = client.messages.fetch_message_smtp_log(domain:@domainName, messageId: @messageId)
+      assert response != nil, "Expected fetch message smtp log response to not be nil"
+      
+      response = client.messages.fetch_inbox_message_smtp_log(domain:@domainName, inbox: @inboxAll, messageId: @messageId)
+      assert response != nil, "Expected fetch inbox message smtp log response to not be nil"
+      
+      response = client.messages.fetch_message_raw(domain:@domainName, messageId: @messageId)
+      assert response != nil, "Expected fetch message raw response to not be nil"
+      
+      response = client.messages.fetch_inbox_message_raw(domain:@domainName, inbox: @inboxAll, messageId: @messageId)
+      assert response != nil, "Expected fetch inbox message raw response to not be nil"
+      
+      response = client.messages.fetch_latest_messages(domain:@domainName)
+      assert response != nil, "Expected fetch latest messages response to not be nil"
+      
+      response = client.messages.fetch_latest_inbox_messages(domain:@domainName, inbox: @inboxAll)
+      assert response != nil, "Expected fetch latest inbox message response to not be nil"
+      
       response = client.messages.delete_message(domain:@deleteDomain, inbox: @inbox, messageId: @messageId)
       assert response != nil, "Expected delete message response to not be nil"
       assert response["status"] == "ok", "Expected delete message response to be ok"
@@ -112,21 +184,49 @@ 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"
 
-      messageToPost = {
-        subject:"Testing ruby message",
-        from:"test_email_ruby@test.com", 
-        text:"I love Ruby!"
-      }
-      response = client.messages.inject_message(domain:@domainName, inbox: @inboxAll, messageToPost: messageToPost)
-      assert response != nil, "Expected inject message response to not be nil"
-      assert response["status"] == "ok", "Expected inject message response to be ok"
-
       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"
 
       response = client.stats.get_team
       assert response != nil, "Expected response to not be nil"
+
+      webhook = {
+        from:"MyMailinatorRubyTest",
+        subject:"testing message",
+        text:"hello world",
+        to:"jack"
+      }
+
+      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"
+      assert response["status"] == "ok", "Expected private webhook response to be ok"
+
+      response = clientWithoutAuthToken.webhooks.private_inbox_webhook(whToken: @webhookTokenPrivateDomain, inbox: @webhookInbox, webhook:webhook)
+      assert response != nil, "Expected private inbox webhook response to not be nil"
+      assert response["status"] == "ok", "Expected private inbox webhook response to be ok"
+
+      response = clientWithoutAuthToken.webhooks.private_custom_service_webhook(whToken: @webhookTokenPrivateDomain, customService: @webhookCustomService, webhook:webhook)
+      #assert response != nil, "Expected private custom service webhook response to not be nil"
+      
+      response = clientWithoutAuthToken.webhooks.private_custom_service_inbox_webhook(whToken: @webhookTokenPrivateDomain, customService: @webhookCustomService, inbox: @webhookInbox, webhook:webhook)
+      #assert response != nil, "Expected private custom service inbox webhook response to not be nil"
+      
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailinator_client
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Marian Melnychuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2024-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Provides a simple ruby wrapper around the Mailinator REST API