mailslurp_client 8.0.11 → 8.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83245198988c99df04e883cfebfc95e8c2e1ccb0747d38e5a94bdc3e4ab36e01
-  data.tar.gz: b0e7062b05fd04487414ec72cc6fc908afed6719b95e6d7083136cd786a5275e
+  metadata.gz: 96ef0bbf1878c66106dbe752e220f67c273e38325535abfb146e829c980a6ef7
+  data.tar.gz: 99d0a8ca38b6c1fcbce073acd546227239c4bf733cf53fde33fb254eb4965149
 SHA512:
-  metadata.gz: 6682ead1fc274648e7d8b35088cbf0e2d66780988369ed5073d15a90547f7a002fb3453b205e672b25e97ba7761d082542054a5d1fbfaea47f0f3b24b07bcbb4
-  data.tar.gz: a51c75edc8af3aa3184ba7aa821796686bb867bd69f07176b0a671983e6fc6de1ef2316a759211a9d3d81f1807c3453dc528d4c715e457c62f4143c43f160241
+  metadata.gz: dda58967c5d1510f509addbe31e88914735d9494b00e9ef3437588a1e37b73fa9706e62636209cb72dc9bd5b6f319746bbf10aa9b68bdf73f069695bc1918b47
+  data.tar.gz: 6eea968c23cf4f25e6552639b051a8bca02d25aba7f1b29cb00534d2764ff7faa49176f73371423b1ddc7aca1451200ad719f14930d18d12d6b00216473b1ece

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 MailSlurp Email API (Provided by Pettman OÜ, Estonia)
+
+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,123 @@
+# MailSlurp Ruby Client
+
+> Create real email addresses on demand. Send and receive emails and attachments from code and tests using Ruby.
+
+MailSlurp is an email API service that lets you create real email addresses in code. You can then send and receive emails and attachments in Ruby applications and tests.
+
+## Quick links
+
+- [Method Documentation](./docs)
+- [Gem Package](https://rubygems.org/gems/mailslurp_client)
+- [Github Source](https://github.com/mailslurp/mailslurp-client-ruby)
+
+## Get started
+
+::: tip
+This section describes how to get up and running with the Ruby client.
+
+See the [examples page](https://www.mailslurp.com/examples/) for more examples and use with common frameworks such as Rails and RSpec.
+
+See the method documentation for a [list of all functions](./docs)
+:::
+
+### Create API Key
+
+First you'll need an API Key. [Create a free account](https://app.mailslurp.com) and copy the key from your dashboard.
+
+### Ruby requirements
+
+The MailSlurp client requires Ruby 2.x and the ruby-dev package. You most likely have these packages but if not: 
+
+`sudo apt-get install ruby-dev`
+
+### Install Gem
+
+```bash
+gem install mailslurp_client
+```
+
+Or in your `Gemfile`:
+
+```ruby
+gem 'mailslurp_client', '~> 7.0', '>= 7.0.8'
+```
+
+### Configure the client
+
+```ruby
+require 'mailslurp_client'
+
+# configure the mailslurp client with an API Key
+MailSlurpClient.configure do |config|
+    config.api_key['x-api-key'] = "YOUR_API_KEY_HERE"
+end
+```
+
+## Common uses
+
+MailSlurp can be used for anything email related: sending and receiving emails, creating email addresses, or testing email processes.
+
+Here are some common uses:
+
+### Create inboxes
+
+To use MailSlurp you need to create inboxes. These are email accounts that have an ID and a real email address.
+
+```ruby
+inbox_controller = MailSlurpClient::InboxControllerApi.new
+inbox = inbox_controller.create_inbox
+```
+
+In a test:
+
+```ruby
+it 'can create email addresses' do
+    inbox_controller = MailSlurpClient::InboxControllerApi.new
+    inbox = inbox_controller.create_inbox
+
+    expect(inbox.id).not_to be_nil
+    expect(inbox.email_address).to include("mailslurp.com")
+end
+```
+
+### Send emails
+
+You can send HTML emails easily with the inbox controller. First create an inbox then use its ID with the `send_email` method.
+To send attachments see the [Method Documentation](./docs).
+
+```ruby
+# create an inbox
+inbox_controller = MailSlurpClient::InboxControllerApi.new
+inbox = inbox_controller.create_inbox
+
+# send an email from the inbox
+inbox_controller.send_email(inbox.id, {
+    send_email_options: {
+        to: ["test@example.org"],
+        subject: "Test",
+        isHTML: true,
+        body: <<-HEREDOC
+          <h1>Hello!</h1>
+          <p>MailSlurp supports HTML</p>
+        HEREDOC
+    }
+})
+```
+
+### Receive emails
+
+You can use MailSlurp to wait for at least 1 unread email in an inbox and return it.
+If a timeout is exceeded it will throw an error instead:
+
+```ruby
+waitfor_controller = MailSlurpClient::WaitForControllerApi.new
+email = waitfor_controller.wait_for_latest_email({ inbox_id: inbox.id, unread_only: true })
+
+# verify email contents
+expect(email.subject).to include("Test")
+expect(email.body).to include("Your email body")
+```
+
+## SDK Documentation
+
+See the [examples page](https://www.mailslurp.com/examples/) or the full [Method Documentation](./docs) on Github.

data/SECURITY.md

@@ -0,0 +1,4 @@
+# Security
+
+This client calls the MailSlurp API endpoints. Connections should be made over secure HTTPS using your secure API Token. Do not share or commit the token if you can avoid doing so.
+To report security issues or talk with MailSlurp support please email [support@mailslurp.zendesk.com](mailto:support@mailslurp.zendesk.com).

data/SUPPORT.md

@@ -0,0 +1,4 @@
+# Support
+
+To report issues or talk with MailSlurp support please email [support@mailslurp.zendesk.com](mailto:support@mailslurp.zendesk.com).
+Alternatively you can visit our [support portal](https://mailslurp.zendesk.com) or open a ticket in the corresponding [Github repository](https://www.github.com/mailslurp).

data/lib/mailslurp_client/api/alias_controller_api.rb

@@ -0,0 +1,405 @@
+=begin
+#MailSlurp API
+
+#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.   ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository 
+
+The version of the OpenAPI document: 6.5.2
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module MailSlurpClient
+  class AliasControllerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create an email alias
+    # Create an email alias belonging to a user ID. To create anonymous aliases use the `createAnonymousAlias` method.
+    # @param create_owned_alias_options [CreateOwnedAliasOptions] createOwnedAliasOptions
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def create_alias(create_owned_alias_options, opts = {})
+      create_alias_with_http_info(create_owned_alias_options, opts)
+      nil
+    end
+
+    # Create an email alias
+    # Create an email alias belonging to a user ID. To create anonymous aliases use the `createAnonymousAlias` method.
+    # @param create_owned_alias_options [CreateOwnedAliasOptions] createOwnedAliasOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def create_alias_with_http_info(create_owned_alias_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AliasControllerApi.create_alias ...'
+      end
+      # verify the required parameter 'create_owned_alias_options' is set
+      if @api_client.config.client_side_validation && create_owned_alias_options.nil?
+        fail ArgumentError, "Missing the required parameter 'create_owned_alias_options' when calling AliasControllerApi.create_alias"
+      end
+      # resource path
+      local_var_path = '/aliases'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(create_owned_alias_options) 
+
+      # return_type
+      return_type = opts[:return_type] 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AliasControllerApi#create_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create an anonymous email alias
+    # @param create_anonymous_alias_options [CreateAnonymousAliasOptions] createAnonymousAliasOptions
+    # @param [Hash] opts the optional parameters
+    # @return [ModelAlias]
+    def create_anonymous_alias(create_anonymous_alias_options, opts = {})
+      data, _status_code, _headers = create_anonymous_alias_with_http_info(create_anonymous_alias_options, opts)
+      data
+    end
+
+    # Create an anonymous email alias
+    # @param create_anonymous_alias_options [CreateAnonymousAliasOptions] createAnonymousAliasOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ModelAlias, Integer, Hash)>] ModelAlias data, response status code and response headers
+    def create_anonymous_alias_with_http_info(create_anonymous_alias_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AliasControllerApi.create_anonymous_alias ...'
+      end
+      # verify the required parameter 'create_anonymous_alias_options' is set
+      if @api_client.config.client_side_validation && create_anonymous_alias_options.nil?
+        fail ArgumentError, "Missing the required parameter 'create_anonymous_alias_options' when calling AliasControllerApi.create_anonymous_alias"
+      end
+      # resource path
+      local_var_path = '/aliases/anonymous'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(create_anonymous_alias_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'ModelAlias' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AliasControllerApi#create_anonymous_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete an owned alias
+    # @param alias_id [String] aliasId
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_alias(alias_id, opts = {})
+      delete_alias_with_http_info(alias_id, opts)
+      nil
+    end
+
+    # Delete an owned alias
+    # @param alias_id [String] aliasId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_alias_with_http_info(alias_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AliasControllerApi.delete_alias ...'
+      end
+      # verify the required parameter 'alias_id' is set
+      if @api_client.config.client_side_validation && alias_id.nil?
+        fail ArgumentError, "Missing the required parameter 'alias_id' when calling AliasControllerApi.delete_alias"
+      end
+      # resource path
+      local_var_path = '/aliases/{aliasId}'.sub('{' + 'aliasId' + '}', CGI.escape(alias_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AliasControllerApi#delete_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get an email alias
+    # Get an email alias by ID
+    # @param alias_id [String] aliasId
+    # @param [Hash] opts the optional parameters
+    # @return [ModelAlias]
+    def get_alias(alias_id, opts = {})
+      data, _status_code, _headers = get_alias_with_http_info(alias_id, opts)
+      data
+    end
+
+    # Get an email alias
+    # Get an email alias by ID
+    # @param alias_id [String] aliasId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ModelAlias, Integer, Hash)>] ModelAlias data, response status code and response headers
+    def get_alias_with_http_info(alias_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AliasControllerApi.get_alias ...'
+      end
+      # verify the required parameter 'alias_id' is set
+      if @api_client.config.client_side_validation && alias_id.nil?
+        fail ArgumentError, "Missing the required parameter 'alias_id' when calling AliasControllerApi.get_alias"
+      end
+      # resource path
+      local_var_path = '/aliases/{aliasId}'.sub('{' + 'aliasId' + '}', CGI.escape(alias_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'ModelAlias' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AliasControllerApi#get_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all email aliases
+    # Get all email aliases in paginated form
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in alias list pagination (default to 0)
+    # @option opts [Integer] :size Optional page size in alias list pagination (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @return [PageAlias]
+    def get_aliases(opts = {})
+      data, _status_code, _headers = get_aliases_with_http_info(opts)
+      data
+    end
+
+    # Get all email aliases
+    # Get all email aliases in paginated form
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in alias list pagination
+    # @option opts [Integer] :size Optional page size in alias list pagination
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @return [Array<(PageAlias, Integer, Hash)>] PageAlias data, response status code and response headers
+    def get_aliases_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AliasControllerApi.get_aliases ...'
+      end
+      allowable_values = ["ASC", "DESC"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/aliases'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PageAlias' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AliasControllerApi#get_aliases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update an owned alias
+    # @param alias_id [String] aliasId
+    # @param create_owned_alias_options [CreateOwnedAliasOptions] createOwnedAliasOptions
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def update_alias(alias_id, create_owned_alias_options, opts = {})
+      update_alias_with_http_info(alias_id, create_owned_alias_options, opts)
+      nil
+    end
+
+    # Update an owned alias
+    # @param alias_id [String] aliasId
+    # @param create_owned_alias_options [CreateOwnedAliasOptions] createOwnedAliasOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def update_alias_with_http_info(alias_id, create_owned_alias_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AliasControllerApi.update_alias ...'
+      end
+      # verify the required parameter 'alias_id' is set
+      if @api_client.config.client_side_validation && alias_id.nil?
+        fail ArgumentError, "Missing the required parameter 'alias_id' when calling AliasControllerApi.update_alias"
+      end
+      # verify the required parameter 'create_owned_alias_options' is set
+      if @api_client.config.client_side_validation && create_owned_alias_options.nil?
+        fail ArgumentError, "Missing the required parameter 'create_owned_alias_options' when calling AliasControllerApi.update_alias"
+      end
+      # resource path
+      local_var_path = '/aliases/{aliasId}'.sub('{' + 'aliasId' + '}', CGI.escape(alias_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(create_owned_alias_options) 
+
+      # return_type
+      return_type = opts[:return_type] 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AliasControllerApi#update_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end