mailslurp_client 11.4.0 → 11.5.0

data/lib/mailslurp_client/models/email_preview.rb

@@ -33,7 +33,7 @@ module MailSlurpClient
     # ID of the email
     attr_accessor :id
 
-    # Has the email been viewed ever
+    # Has the email been viewed ever. This means viewed in the dashboard or requested via the full email entity endpoints
     attr_accessor :read
 
     # The subject line of the email message

data/lib/mailslurp_client/models/email_projection.rb

@@ -35,6 +35,8 @@ module MailSlurpClient
 
     attr_accessor :subject
 
+    attr_accessor :team_access
+
     attr_accessor :to
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -50,6 +52,7 @@ module MailSlurpClient
         :'inbox_id' => :'inboxId',
         :'read' => :'read',
         :'subject' => :'subject',
+        :'team_access' => :'teamAccess',
         :'to' => :'to'
       }
     end
@@ -67,6 +70,7 @@ module MailSlurpClient
         :'inbox_id' => :'String',
         :'read' => :'Boolean',
         :'subject' => :'String',
+        :'team_access' => :'Boolean',
         :'to' => :'Array<String>'
       }
     end
@@ -138,6 +142,10 @@ module MailSlurpClient
         self.subject = attributes[:'subject']
       end
 
+      if attributes.key?(:'team_access')
+        self.team_access = attributes[:'team_access']
+      end
+
       if attributes.key?(:'to')
         if (value = attributes[:'to']).is_a?(Array)
           self.to = value
@@ -193,6 +201,7 @@ module MailSlurpClient
           inbox_id == o.inbox_id &&
           read == o.read &&
           subject == o.subject &&
+          team_access == o.team_access &&
           to == o.to
     end
 
@@ -205,7 +214,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attachments, bcc, body_md5_hash, cc, created_at, from, id, inbox_id, read, subject, to].hash
+      [attachments, bcc, body_md5_hash, cc, created_at, from, id, inbox_id, read, subject, team_access, to].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/inbox.rb

@@ -21,7 +21,7 @@ module MailSlurpClient
     # Description of an inbox for labelling and searching purposes
     attr_accessor :description
 
-    # The inbox's email address. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
+    # The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
     attr_accessor :email_address
 
     # Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.
@@ -36,9 +36,15 @@ module MailSlurpClient
     # Name of the inbox. Displayed in the dashboard for easier search
     attr_accessor :name
 
+    # Is the inbox readOnly for the caller. Read only means can not be deleted or modified.
+    attr_accessor :read_only
+
     # 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
 
+    # Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it.
+    attr_accessor :team_access
+
     # ID of user that inbox belongs to
     attr_accessor :user_id
 
@@ -52,7 +58,9 @@ module MailSlurpClient
         :'favourite' => :'favourite',
         :'id' => :'id',
         :'name' => :'name',
+        :'read_only' => :'readOnly',
         :'tags' => :'tags',
+        :'team_access' => :'teamAccess',
         :'user_id' => :'userId'
       }
     end
@@ -67,7 +75,9 @@ module MailSlurpClient
         :'favourite' => :'Boolean',
         :'id' => :'String',
         :'name' => :'String',
+        :'read_only' => :'Boolean',
         :'tags' => :'Array<String>',
+        :'team_access' => :'Boolean',
         :'user_id' => :'String'
       }
     end
@@ -121,12 +131,20 @@ module MailSlurpClient
         self.name = attributes[:'name']
       end
 
+      if attributes.key?(:'read_only')
+        self.read_only = attributes[:'read_only']
+      end
+
       if attributes.key?(:'tags')
         if (value = attributes[:'tags']).is_a?(Array)
           self.tags = value
         end
       end
 
+      if attributes.key?(:'team_access')
+        self.team_access = attributes[:'team_access']
+      end
+
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
@@ -157,7 +175,9 @@ module MailSlurpClient
           favourite == o.favourite &&
           id == o.id &&
           name == o.name &&
+          read_only == o.read_only &&
           tags == o.tags &&
+          team_access == o.team_access &&
           user_id == o.user_id
     end
 
@@ -170,7 +190,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_at, description, email_address, expires_at, favourite, id, name, tags, user_id].hash
+      [created_at, description, email_address, expires_at, favourite, id, name, read_only, tags, team_access, user_id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/inbox_projection.rb

@@ -26,6 +26,8 @@ module MailSlurpClient
 
     attr_accessor :tags
 
+    attr_accessor :team_access
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -34,7 +36,8 @@ module MailSlurpClient
         :'favourite' => :'favourite',
         :'id' => :'id',
         :'name' => :'name',
-        :'tags' => :'tags'
+        :'tags' => :'tags',
+        :'team_access' => :'teamAccess'
       }
     end
 
@@ -46,7 +49,8 @@ module MailSlurpClient
         :'favourite' => :'Boolean',
         :'id' => :'String',
         :'name' => :'String',
-        :'tags' => :'Array<String>'
+        :'tags' => :'Array<String>',
+        :'team_access' => :'Boolean'
       }
     end
 
@@ -96,6 +100,10 @@ module MailSlurpClient
           self.tags = value
         end
       end
+
+      if attributes.key?(:'team_access')
+        self.team_access = attributes[:'team_access']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -136,7 +144,8 @@ module MailSlurpClient
           favourite == o.favourite &&
           id == o.id &&
           name == o.name &&
-          tags == o.tags
+          tags == o.tags &&
+          team_access == o.team_access
     end
 
     # @see the `==` method
@@ -148,7 +157,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_at, email_address, favourite, id, name, tags].hash
+      [created_at, email_address, favourite, id, name, tags, team_access].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/organization_inbox_projection.rb

@@ -0,0 +1,279 @@
+=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 OrganizationInboxProjection
+    # When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`.
+    attr_accessor :created_at
+
+    # The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
+    attr_accessor :email_address
+
+    # Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering
+    attr_accessor :favourite
+
+    # ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically.
+    attr_accessor :id
+
+    # Name of the inbox. Displayed in the dashboard for easier search
+    attr_accessor :name
+
+    # Is the inbox readOnly for the caller. Read only means can not be deleted or modified.
+    attr_accessor :read_only
+
+    # 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
+
+    # Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it.
+    attr_accessor :team_access
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'created_at' => :'createdAt',
+        :'email_address' => :'emailAddress',
+        :'favourite' => :'favourite',
+        :'id' => :'id',
+        :'name' => :'name',
+        :'read_only' => :'readOnly',
+        :'tags' => :'tags',
+        :'team_access' => :'teamAccess'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'created_at' => :'DateTime',
+        :'email_address' => :'String',
+        :'favourite' => :'Boolean',
+        :'id' => :'String',
+        :'name' => :'String',
+        :'read_only' => :'Boolean',
+        :'tags' => :'Array<String>',
+        :'team_access' => :'Boolean'
+      }
+    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::OrganizationInboxProjection` 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::OrganizationInboxProjection`. 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?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'email_address')
+        self.email_address = attributes[:'email_address']
+      end
+
+      if attributes.key?(:'favourite')
+        self.favourite = attributes[:'favourite']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'read_only')
+        self.read_only = attributes[:'read_only']
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.key?(:'team_access')
+        self.team_access = attributes[:'team_access']
+      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 &&
+          created_at == o.created_at &&
+          email_address == o.email_address &&
+          favourite == o.favourite &&
+          id == o.id &&
+          name == o.name &&
+          read_only == o.read_only &&
+          tags == o.tags &&
+          team_access == o.team_access
+    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
+      [created_at, email_address, favourite, id, name, read_only, tags, team_access].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