mailslurp_client 8.2.17 → 8.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 881dae0965a313cf4e679fc47e998a276e07d3061765332c5ce6e383b5b837c9
-  data.tar.gz: 37bc815bc87386f28781283cc8188d67eaff8e064017f5dcf9c13b61a6e79206
+  metadata.gz: e376f040ab4f7c4f9b8a7f2cc37d26e6e1fb7b4de17c7910fd0546b83967a31a
+  data.tar.gz: 9be17286f4a983f3916b22473627371b46c0189988f848477fae897402434fbb
 SHA512:
-  metadata.gz: 8f96ca7c6b8e8576577ab457784427bd827f6c2168ca80baf22d979107aac4ab9491643e6f06172fb002e0583ac34c58efa2796f35d800bd6717ea9216902fb5
-  data.tar.gz: 1210557bf09554f787242009ef9d604c4ce4565ec3bc0a3b72f605c484869a5707cc5e4e93f8d9fb8f5267e7e45294102f9609464ebc3197a0004cd44ea62ec0
+  metadata.gz: 50c0382af36f9a4bb707b628e80180f4882a1b75575097862f350c02fe9d29b076f5d2cfcf3bfc88e22a967f655673f889e66d0889535653723be61f0f2aa4b2
+  data.tar.gz: cfac41f0383d467211632dcbc6773b401181b9e696c93d50bed0c9209117c3dc67e1e141ca0e55aef86ff2167b577ac5585b737d4cb5e38e85325e21553914a9

data/lib/mailslurp_client.rb

@@ -27,6 +27,7 @@ require 'mailslurp_client/models/create_anonymous_alias_options'
 require 'mailslurp_client/models/create_contact_options'
 require 'mailslurp_client/models/create_domain_options'
 require 'mailslurp_client/models/create_group_options'
+require 'mailslurp_client/models/create_inbox_dto'
 require 'mailslurp_client/models/create_owned_alias_options'
 require 'mailslurp_client/models/create_template_options'
 require 'mailslurp_client/models/create_webhook_options'

data/lib/mailslurp_client/api/domain_controller_api.rb

@@ -87,17 +87,17 @@ module MailSlurpClient
     # Delete a domain. This will disable any existing inboxes that use this domain.
     # @param id [String] id
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [Array<String>]
     def delete_domain(id, opts = {})
-      delete_domain_with_http_info(id, opts)
-      nil
+      data, _status_code, _headers = delete_domain_with_http_info(id, opts)
+      data
     end
 
     # Delete a domain
     # Delete a domain. This will disable any existing inboxes that use this domain.
     # @param id [String] id
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
     def delete_domain_with_http_info(id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DomainControllerApi.delete_domain ...'
@@ -114,6 +114,8 @@ module MailSlurpClient
 
       # 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] || {}
@@ -122,7 +124,7 @@ module MailSlurpClient
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:return_type] || 'Array<String>' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['API_KEY']

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -93,6 +93,70 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Create an inbox with additional options
+    # Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
+    # @param create_inbox_dto [CreateInboxDto] createInboxDto
+    # @param [Hash] opts the optional parameters
+    # @return [Inbox]
+    def create_inbox_with_options(create_inbox_dto, opts = {})
+      data, _status_code, _headers = create_inbox_with_options_with_http_info(create_inbox_dto, opts)
+      data
+    end
+
+    # Create an inbox with additional options
+    # Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
+    # @param create_inbox_dto [CreateInboxDto] createInboxDto
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
+    def create_inbox_with_options_with_http_info(create_inbox_dto, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox_with_options ...'
+      end
+      # verify the required parameter 'create_inbox_dto' is set
+      if @api_client.config.client_side_validation && create_inbox_dto.nil?
+        fail ArgumentError, "Missing the required parameter 'create_inbox_dto' when calling InboxControllerApi.create_inbox_with_options"
+      end
+      # resource path
+      local_var_path = '/inboxes/withOptions'
+
+      # 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_inbox_dto) 
+
+      # return_type
+      return_type = opts[:return_type] || 'Inbox' 
+
+      # 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: InboxControllerApi#create_inbox_with_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete all inboxes
     # Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have.
     # @param [Hash] opts the optional parameters

data/lib/mailslurp_client/models/create_inbox_dto.rb

@@ -0,0 +1,259 @@
+=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 'date'
+
+module MailSlurpClient
+  class CreateInboxDto
+    # Optional description of an inbox for labelling purposes
+    attr_accessor :description
+
+    # Optionally specify an email address you want the inbox to have. When left blank an email address will be randomly assigned to the inbox usually ending in `@mailslurp.com`. Custom email addresses must include your own custom domain that you have configured in MailSlurp. So if your domain is `mysite.com` you can created any email address ending in `@mysite.com`. All email addresses are transformed to lowercase!
+    attr_accessor :email_address
+
+    # When, if ever, will the inbox expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. Timestamp passed as string.
+    attr_accessor :expires_at
+
+    # Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access
+    attr_accessor :favourite
+
+    # Optional name of the inbox. Displayed in the dashboard for easier search
+    attr_accessor :name
+
+    # Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
+    attr_accessor :tags
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'email_address' => :'emailAddress',
+        :'expires_at' => :'expiresAt',
+        :'favourite' => :'favourite',
+        :'name' => :'name',
+        :'tags' => :'tags'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'description' => :'String',
+        :'email_address' => :'String',
+        :'expires_at' => :'DateTime',
+        :'favourite' => :'Boolean',
+        :'name' => :'String',
+        :'tags' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::CreateInboxDto` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::CreateInboxDto`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'email_address')
+        self.email_address = attributes[:'email_address']
+      end
+
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      end
+
+      if attributes.key?(:'favourite')
+        self.favourite = attributes[:'favourite']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          description == o.description &&
+          email_address == o.email_address &&
+          expires_at == o.expires_at &&
+          favourite == o.favourite &&
+          name == o.name &&
+          tags == o.tags
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [description, email_address, expires_at, favourite, name, tags].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        MailSlurpClient.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/mailslurp_client/models/domain_dto.rb

@@ -17,22 +17,29 @@ module MailSlurpClient
   class DomainDto
     attr_accessor :created_at
 
+    # DNS records for DKIM approval
+    attr_accessor :dkim_tokens
+
+    # Custom domain name
     attr_accessor :domain
 
     attr_accessor :id
 
+    # Whether domain has been verified or not. If the domain is not verified after 72 hours there is most likely an issue with the domains DNS records.
     attr_accessor :is_verified
 
     attr_accessor :updated_at
 
     attr_accessor :user_id
 
+    # A TXT record that you must place in the DNS settings of the domain to complete domain verification
     attr_accessor :verification_token
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'created_at' => :'createdAt',
+        :'dkim_tokens' => :'dkimTokens',
         :'domain' => :'domain',
         :'id' => :'id',
         :'is_verified' => :'isVerified',
@@ -46,6 +53,7 @@ module MailSlurpClient
     def self.openapi_types
       {
         :'created_at' => :'DateTime',
+        :'dkim_tokens' => :'Array<String>',
         :'domain' => :'String',
         :'id' => :'String',
         :'is_verified' => :'Boolean',
@@ -80,6 +88,12 @@ module MailSlurpClient
         self.created_at = attributes[:'created_at']
       end
 
+      if attributes.key?(:'dkim_tokens')
+        if (value = attributes[:'dkim_tokens']).is_a?(Array)
+          self.dkim_tokens = value
+        end
+      end
+
       if attributes.key?(:'domain')
         self.domain = attributes[:'domain']
       end
@@ -113,18 +127,10 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
-      if @domain.nil?
-        invalid_properties.push('invalid value for "domain", domain cannot be nil.')
-      end
-
       if @id.nil?
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @is_verified.nil?
-        invalid_properties.push('invalid value for "is_verified", is_verified cannot be nil.')
-      end
-
       if @updated_at.nil?
         invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
       end
@@ -133,10 +139,6 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
       end
 
-      if @verification_token.nil?
-        invalid_properties.push('invalid value for "verification_token", verification_token cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -144,12 +146,9 @@ module MailSlurpClient
     # @return true if the model is valid
     def valid?
       return false if @created_at.nil?
-      return false if @domain.nil?
       return false if @id.nil?
-      return false if @is_verified.nil?
       return false if @updated_at.nil?
       return false if @user_id.nil?
-      return false if @verification_token.nil?
       true
     end
 
@@ -159,6 +158,7 @@ module MailSlurpClient
       return true if self.equal?(o)
       self.class == o.class &&
           created_at == o.created_at &&
+          dkim_tokens == o.dkim_tokens &&
           domain == o.domain &&
           id == o.id &&
           is_verified == o.is_verified &&
@@ -176,7 +176,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_at, domain, id, is_verified, updated_at, user_id, verification_token].hash
+      [created_at, dkim_tokens, domain, id, is_verified, updated_at, user_id, verification_token].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module MailSlurpClient
-  VERSION = '8.2.17'
+  VERSION = '8.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 8.2.17
+  version: 8.3.0
 platform: ruby
 authors:
 - mailslurp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2020-12-08 00:00:00.000000000 Z
 dependencies: []
 description: Create emails addresses in Ruby then send and receive real emails and
   attachments. See https://www.mailslurp.com/docs/ruby/ for full Ruby documentation.
@@ -51,6 +51,7 @@ files:
 - lib/mailslurp_client/models/create_contact_options.rb
 - lib/mailslurp_client/models/create_domain_options.rb
 - lib/mailslurp_client/models/create_group_options.rb
+- lib/mailslurp_client/models/create_inbox_dto.rb
 - lib/mailslurp_client/models/create_owned_alias_options.rb
 - lib/mailslurp_client/models/create_template_options.rb
 - lib/mailslurp_client/models/create_webhook_options.rb