mailinator_client 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c153614073d679cfcc656e550cb8d2728f7083a207fbce01927fabd42b4aefb
-  data.tar.gz: 91de6200531df3ebe4a53d55052de5d703ff414e6cbb8a9bf2d62306ffaf8918
+  metadata.gz: 638fc40bb2a36464b2442cc9043ce1cc44f1c6698c40276535cc6d92261619d8
+  data.tar.gz: c734c8e2d2eddc30bae2460d4909fa7cc0182036ee57dc657eb4d1d180ef5d15
 SHA512:
-  metadata.gz: eb73f7d0316d9ed00664a6a94bf2054759b42047541fcda1288519abded67baedf1f021a6d9a70f3d6b76ca0f77fa6968c4394ea028bd55f5675ae2d01c6304f
-  data.tar.gz: e27c8a33b6d1cff75fddeef04b6b23f1306c4a46bde27c00d718c0a423c2e4c565d896e0e50695c5ef97e112ac07ec421f4b2bf56d1f0cb4f4804fcea3af5a7e
+  metadata.gz: 556e3cc614515b193e96ce8c1fcdaa45e290b7bed990ae28dd18885ae99127d1d24ee91cb81a0959c8a7685ea67b16386a505be6ec1bfc10377f14766f724749
+  data.tar.gz: e628f406a7276798b957d1481ddf90d00899f827d22a096ecf9d10724eaf83b6ea39c4292ca739162ed45c4a8f1e03284f363d950aa189bc65d3302dd7a7bb88

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/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/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/docs/webhooks.md

@@ -0,0 +1,125 @@
+# Webhooks Actions
+
+Details on the various actions that can be performed on the Webhooks resource, including the expected parameters and the potential responses.
+
+##### Contents
+
+*   [PublicWebhook](#publicwebhook)
+*   [PublicInboxWebhook](#publicinboxwebhook)
+*   [PublicCustomServiceWebhook](#publiccustomservicewebhook)
+*   [PublicCustomServiceInboxWebhook](#publiccustomserviceinboxwebhook)
+*   [PrivateWebhook](#privatewebhook)
+*   [PrivateInboxWebhook](#privateinboxwebhook)
+*   [PrivateCustomServiceWebhook](#privatecustomservicewebhook)
+*   [PrivateCustomServiceInboxWebhook](#privatecustomserviceinboxwebhook)
+
+<br/>
+
+## PublicWebhook
+
+This command will deliver the message to the :to inbox that was set into request object
+
+```ruby
+result = client.webhooks.public_webhook()
+
+puts result
+```
+
+<br/>
+
+## PublicInboxWebhook
+
+This command will deliver the message to the :inbox inbox
+Note that if the Mailinator system cannot determine the destination inbox via the URL or a "to" field in the payload, the message will be rejected.
+If the message contains a "from" and "subject" field, these will be visible on the inbox page.
+    
+
+```ruby
+result = client.webhooks.public_inbox_webhook()
+
+puts result
+```
+
+<br/>
+
+## PublicCustomServiceWebhook
+
+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.
+
+```ruby
+result = client.webhooks.public_custom_service_webhook()
+
+puts result
+```
+
+<br/>
+
+## PublicCustomServiceInboxWebhook
+
+The SMS message will arrive in the Public 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.public_custom_service_inbox_webhook()
+
+puts result
+```
+
+<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
+```