mailslurp_client 5.0.0 → 7.0.7

data/Gemfile.lock

@@ -1,79 +0,0 @@
-PATH
-  remote: .
-  specs:
-    mailslurp_client (5.0.0)
-      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/docs/CommonOperationsApi.md

@@ -1,499 +0,0 @@
-# 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
-[**delete_email**](CommonOperationsApi.md#delete_email) | **DELETE** /deleteEmail | Delete an email
-[**delete_email_address**](CommonOperationsApi.md#delete_email_address) | **DELETE** /deleteEmailAddress | Delete email address and its emails
-[**empty_inbox**](CommonOperationsApi.md#empty_inbox) | **DELETE** /emptyInbox | Delete all emails in an inbox
-[**send_email_simple**](CommonOperationsApi.md#send_email_simple) | **POST** /sendEmail | Send an email from a random email address
-[**wait_for_email_count**](CommonOperationsApi.md#wait_for_email_count) | **GET** /waitForEmailCount | Wait for and return count number of emails 
-[**wait_for_latest_email**](CommonOperationsApi.md#wait_for_latest_email) | **GET** /waitForLatestEmail | Fetch inbox's latest email or if empty wait for email to arrive
-[**wait_for_matching_email**](CommonOperationsApi.md#wait_for_matching_email) | **POST** /waitForMatchingEmails | Wait or return list of emails that match simple matching patterns
-[**wait_for_nth_email**](CommonOperationsApi.md#wait_for_nth_email) | **GET** /waitForNthEmail | Wait for or fetch the email with a given index in the inbox specified
-
-
-# **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
-
-
-
-# **delete_email**
-> delete_email(email_id)
-
-Delete an email
-
-Deletes an email
-
-### 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
-email_id = 'email_id_example' # String | emailId
-
-begin
-  #Delete an email
-  api_instance.delete_email(email_id)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->delete_email: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **email_id** | [**String**](.md)| emailId | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-
-# **delete_email_address**
-> delete_email_address(inbox_id)
-
-Delete email address and its emails
-
-Deletes an inbox
-
-### 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
-inbox_id = 'inbox_id_example' # String | inboxId
-
-begin
-  #Delete email address and its emails
-  api_instance.delete_email_address(inbox_id)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->delete_email_address: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **inbox_id** | [**String**](.md)| inboxId | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-
-# **empty_inbox**
-> empty_inbox(inbox_id)
-
-Delete all emails in an inbox
-
-Deletes all emails
-
-### 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
-inbox_id = 'inbox_id_example' # String | inboxId
-
-begin
-  #Delete all emails in an inbox
-  api_instance.empty_inbox(inbox_id)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->empty_inbox: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **inbox_id** | [**String**](.md)| inboxId | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-
-# **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_email_count**
-> Array<EmailPreview> wait_for_email_count(opts)
-
-Wait for and return count number of emails 
-
-Will only wait if count is greater that the found emails in given inbox.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 = {
-  count: 56, # Integer | Number of emails to wait for. Must be greater that 1
-  inbox_id: 'inbox_id_example', # String | Id of the inbox we are fetching emails from
-  timeout: 56 # Integer | Max milliseconds to wait
-}
-
-begin
-  #Wait for and return count number of emails 
-  result = api_instance.wait_for_email_count(opts)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->wait_for_email_count: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **count** | **Integer**| Number of emails to wait for. Must be greater that 1 | [optional] 
- **inbox_id** | [**String**](.md)| Id of the inbox we are fetching emails from | [optional] 
- **timeout** | **Integer**| Max milliseconds to wait | [optional] 
-
-### Return type
-
-[**Array<EmailPreview>**](EmailPreview.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **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_id: 'inbox_id_example', # String | Id of the inbox we are fetching emails from
-  timeout: 56 # Integer | Max milliseconds to wait
-}
-
-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_id** | [**String**](.md)| Id of the inbox we are fetching emails from | [optional] 
- **timeout** | **Integer**| Max milliseconds to wait | [optional] 
-
-### Return type
-
-[**Email**](Email.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **wait_for_matching_email**
-> Array<EmailPreview> wait_for_matching_email(match_options, opts)
-
-Wait or return list of emails that match simple matching patterns
-
-Results must also meet provided count. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM.
-
-### 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
-match_options = MailSlurpClient::MatchOptions.new # MatchOptions | matchOptions
-opts = {
-  count: 56, # Integer | Number of emails to wait for. Must be greater that 1
-  inbox_id: 'inbox_id_example', # String | Id of the inbox we are fetching emails from
-  timeout: 56 # Integer | Max milliseconds to wait
-}
-
-begin
-  #Wait or return list of emails that match simple matching patterns
-  result = api_instance.wait_for_matching_email(match_options, opts)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->wait_for_matching_email: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **match_options** | [**MatchOptions**](MatchOptions.md)| matchOptions | 
- **count** | **Integer**| Number of emails to wait for. Must be greater that 1 | [optional] 
- **inbox_id** | [**String**](.md)| Id of the inbox we are fetching emails from | [optional] 
- **timeout** | **Integer**| Max milliseconds to wait | [optional] 
-
-### Return type
-
-[**Array<EmailPreview>**](EmailPreview.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **wait_for_nth_email**
-> Email wait_for_nth_email(opts)
-
-Wait for or fetch the email with a given index in the inbox specified
-
-### 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_id: 'inbox_id_example', # String | Id of the inbox we are fetching emails from
-  index: 56, # Integer | Zero based index of the email to wait for
-  timeout: 56 # Integer | Max milliseconds to wait
-}
-
-begin
-  #Wait for or fetch the email with a given index in the inbox specified
-  result = api_instance.wait_for_nth_email(opts)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->wait_for_nth_email: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **inbox_id** | [**String**](.md)| Id of the inbox we are fetching emails from | [optional] 
- **index** | **Integer**| Zero based index of the email to wait for | [optional] 
- **timeout** | **Integer**| Max milliseconds to wait | [optional] 
-
-### Return type
-
-[**Email**](Email.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-