mailslurp_client 4.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 425d283104ec65eb164ab440b1fa03d1256a0701
+  data.tar.gz: d64d77df12dc5b3887d4c7be17f3748cc95da515
+SHA512:
+  metadata.gz: cd1072e27644b56dd5444f910b60d383b357ed43d5bb0d132aded2f0bcd66e9835195e81ca92186b3e59b155da884ad9c973cfa9cc01371826ad84a18c1d0296
+  data.tar.gz: bc2556c9292654fed1cc492d2ca678086974d78300f65530294f1d5772db386c3ee87a624a443cc04905bcfbc03a6f449604c66123e3ded3521870bc261d1a25

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    mailslurp_client (4.3.3)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.14)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.3)
+    rake (12.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  mailslurp_client!
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) MailSlurp, PettmanOU
+
+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.

data/README.md

@@ -0,0 +1,126 @@
+# mailslurp_client
+
+MailSlurpClient - the Ruby gem for the MailSlurp API
+
+For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 0.0.1-alpha
+- Package version: 4.3.3
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://www.mailslurp.com](https://www.mailslurp.com)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build mailslurp_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./mailslurp_client-4.3.3.gem
+```
+(for development, run `gem install --dev ./mailslurp_client-4.3.3.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'mailslurp_client', '~> 4.3.3'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'mailslurp_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'mailslurp_client'
+
+# Setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::CommonOperationsApi.new
+
+begin
+  #Create new email address
+  result = api_instance.create_new_email_address
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling CommonOperationsApi->create_new_email_address: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.mailslurp.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*MailSlurpClient::CommonOperationsApi* | [**create_new_email_address**](docs/CommonOperationsApi.md#create_new_email_address) | **POST** /newEmailAddress | Create new email address
+*MailSlurpClient::CommonOperationsApi* | [**send_email_simple**](docs/CommonOperationsApi.md#send_email_simple) | **POST** /sendEmail | Send an email from a random email address
+*MailSlurpClient::CommonOperationsApi* | [**wait_for_latest_email**](docs/CommonOperationsApi.md#wait_for_latest_email) | **GET** /fetchLatestEmail | Fetch inbox's latest email or if empty wait for email to arrive
+*MailSlurpClient::ExtraOperationsApi* | [**bulk_create_inboxes**](docs/ExtraOperationsApi.md#bulk_create_inboxes) | **POST** /bulk/inboxes | Bulk create Inboxes (email addresses)
+*MailSlurpClient::ExtraOperationsApi* | [**bulk_delete_inboxes**](docs/ExtraOperationsApi.md#bulk_delete_inboxes) | **DELETE** /bulk/inboxes | Bulk Delete Inboxes
+*MailSlurpClient::ExtraOperationsApi* | [**bulk_send_emails**](docs/ExtraOperationsApi.md#bulk_send_emails) | **POST** /bulk/send | Bulk Send Emails
+*MailSlurpClient::ExtraOperationsApi* | [**create_inbox**](docs/ExtraOperationsApi.md#create_inbox) | **POST** /inboxes | Create an Inbox (email address)
+*MailSlurpClient::ExtraOperationsApi* | [**create_webhook**](docs/ExtraOperationsApi.md#create_webhook) | **POST** /inboxes/{inboxId}/webhooks | Attach a WebHook URL to an inbox
+*MailSlurpClient::ExtraOperationsApi* | [**delete_email**](docs/ExtraOperationsApi.md#delete_email) | **DELETE** /emails/{emailId} | Delete Email
+*MailSlurpClient::ExtraOperationsApi* | [**delete_inbox**](docs/ExtraOperationsApi.md#delete_inbox) | **DELETE** /inboxes/{inboxId} | Delete Inbox / Email Address
+*MailSlurpClient::ExtraOperationsApi* | [**delete_webhook**](docs/ExtraOperationsApi.md#delete_webhook) | **DELETE** /inboxes/{inboxId}/webhooks/{webhookId} | Delete and disable a WebHook for an Inbox
+*MailSlurpClient::ExtraOperationsApi* | [**download_attachment**](docs/ExtraOperationsApi.md#download_attachment) | **GET** /emails/{emailId}/attachments/{attachmentId} | Get email attachment
+*MailSlurpClient::ExtraOperationsApi* | [**get_email**](docs/ExtraOperationsApi.md#get_email) | **GET** /emails/{emailId} | Get Email Content
+*MailSlurpClient::ExtraOperationsApi* | [**get_emails**](docs/ExtraOperationsApi.md#get_emails) | **GET** /inboxes/{inboxId}/emails | List Emails in an Inbox / EmailAddress
+*MailSlurpClient::ExtraOperationsApi* | [**get_inbox**](docs/ExtraOperationsApi.md#get_inbox) | **GET** /inboxes/{inboxId} | Get Inbox / EmailAddress
+*MailSlurpClient::ExtraOperationsApi* | [**get_inboxes**](docs/ExtraOperationsApi.md#get_inboxes) | **GET** /inboxes | List Inboxes / Email Addresses
+*MailSlurpClient::ExtraOperationsApi* | [**get_raw_email_contents**](docs/ExtraOperationsApi.md#get_raw_email_contents) | **GET** /emails/{emailId}/raw | Get Raw Email Content
+*MailSlurpClient::ExtraOperationsApi* | [**get_webhooks**](docs/ExtraOperationsApi.md#get_webhooks) | **GET** /inboxes/{inboxId}/webhooks | Get all WebHooks for an Inbox
+*MailSlurpClient::ExtraOperationsApi* | [**send_email**](docs/ExtraOperationsApi.md#send_email) | **POST** /inboxes/{inboxId} | Send Email
+
+
+## Documentation for Models
+
+ - [MailSlurpClient::BasicAuthOptions](docs/BasicAuthOptions.md)
+ - [MailSlurpClient::BulkSendEmailOptions](docs/BulkSendEmailOptions.md)
+ - [MailSlurpClient::CreateWebhookOptions](docs/CreateWebhookOptions.md)
+ - [MailSlurpClient::Email](docs/Email.md)
+ - [MailSlurpClient::EmailAnalysis](docs/EmailAnalysis.md)
+ - [MailSlurpClient::EmailPreview](docs/EmailPreview.md)
+ - [MailSlurpClient::Inbox](docs/Inbox.md)
+ - [MailSlurpClient::SendEmailOptions](docs/SendEmailOptions.md)
+ - [MailSlurpClient::Webhook](docs/Webhook.md)
+
+
+## Documentation for Authorization
+
+
+### API_KEY
+
+- **Type**: API key
+- **API key parameter name**: x-api-key
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/BasicAuthOptions.md

@@ -0,0 +1,9 @@
+# MailSlurpClient::BasicAuthOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** |  | 
+**password** | **String** |  | 
+
+

data/docs/BulkSendEmailOptions.md

@@ -0,0 +1,9 @@
+# MailSlurpClient::BulkSendEmailOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**inbox_ids** | **Array<String>** | Inboxes to send from | [optional] 
+**send_email_options** | [**SendEmailOptions**](SendEmailOptions.md) |  | 
+
+

data/docs/CommonOperationsApi.md

@@ -0,0 +1,166 @@
+# MailSlurpClient::CommonOperationsApi
+
+All URIs are relative to *https://api.mailslurp.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_new_email_address**](CommonOperationsApi.md#create_new_email_address) | **POST** /newEmailAddress | Create new email address
+[**send_email_simple**](CommonOperationsApi.md#send_email_simple) | **POST** /sendEmail | Send an email from a random email address
+[**wait_for_latest_email**](CommonOperationsApi.md#wait_for_latest_email) | **GET** /fetchLatestEmail | Fetch inbox's latest email or if empty wait for email to arrive
+
+
+# **create_new_email_address**
+> Inbox create_new_email_address
+
+Create new email address
+
+Returns an Inbox with an `id` and an `emailAddress`
+
+### Example
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::CommonOperationsApi.new
+
+begin
+  #Create new email address
+  result = api_instance.create_new_email_address
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling CommonOperationsApi->create_new_email_address: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Inbox**](Inbox.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **send_email_simple**
+> send_email_simple(send_email_options)
+
+Send an email from a random email address
+
+To specify an email address first create an inbox and use that with the other send email methods
+
+### Example
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::CommonOperationsApi.new
+send_email_options = MailSlurpClient::SendEmailOptions.new # SendEmailOptions | sendEmailOptions
+
+begin
+  #Send an email from a random email address
+  api_instance.send_email_simple(send_email_options)
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling CommonOperationsApi->send_email_simple: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **send_email_options** | [**SendEmailOptions**](SendEmailOptions.md)| sendEmailOptions | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+
+# **wait_for_latest_email**
+> Email wait_for_latest_email(opts)
+
+Fetch inbox's latest email or if empty wait for email to arrive
+
+Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox see the other receive methods.
+
+### Example
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::CommonOperationsApi.new
+opts = {
+  inbox_email_address: 'inbox_email_address_example', # String | Email address of the inbox we are fetching emails from
+  inbox_id: 'inbox_id_example' # String | Id of the inbox we are fetching emails from
+}
+
+begin
+  #Fetch inbox's latest email or if empty wait for email to arrive
+  result = api_instance.wait_for_latest_email(opts)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling CommonOperationsApi->wait_for_latest_email: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **inbox_email_address** | **String**| Email address of the inbox we are fetching emails from | [optional] 
+ **inbox_id** | [**String**](.md)| Id of the inbox we are fetching emails from | [optional] 
+
+### Return type
+
+[**Email**](Email.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+