mailslurp_client 17.1.0 → 17.3.0

data/lib/mailslurp_client/models/search_available_phone_numbers_options.rb

@@ -0,0 +1,377 @@
+=begin
+#MailSlurp API
+
+#MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. 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://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
+
+The version of the OpenAPI document: 6.5.2
+Contact: contact@mailslurp.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module MailSlurpClient
+  # Search criteria for advanced phone provisioning
+  class SearchAvailablePhoneNumbersOptions
+    attr_accessor :phone_country
+
+    attr_accessor :phone_variant
+
+    # Quality filter for advanced phone provisioning search
+    attr_accessor :quality_filter
+
+    attr_accessor :line_type
+
+    attr_accessor :carrier_name
+
+    attr_accessor :mobile_country_code
+
+    attr_accessor :mobile_network_code
+
+    attr_accessor :provider_labels
+
+    attr_accessor :limit
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'phone_country' => :'phoneCountry',
+        :'phone_variant' => :'phoneVariant',
+        :'quality_filter' => :'qualityFilter',
+        :'line_type' => :'lineType',
+        :'carrier_name' => :'carrierName',
+        :'mobile_country_code' => :'mobileCountryCode',
+        :'mobile_network_code' => :'mobileNetworkCode',
+        :'provider_labels' => :'providerLabels',
+        :'limit' => :'limit'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'phone_country' => :'String',
+        :'phone_variant' => :'String',
+        :'quality_filter' => :'String',
+        :'line_type' => :'String',
+        :'carrier_name' => :'String',
+        :'mobile_country_code' => :'String',
+        :'mobile_network_code' => :'String',
+        :'provider_labels' => :'Array<String>',
+        :'limit' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'phone_variant',
+        :'quality_filter',
+        :'line_type',
+        :'carrier_name',
+        :'mobile_country_code',
+        :'mobile_network_code',
+        :'provider_labels',
+        :'limit'
+      ])
+    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::SearchAvailablePhoneNumbersOptions` 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::SearchAvailablePhoneNumbersOptions`. 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?(:'phone_country')
+        self.phone_country = attributes[:'phone_country']
+      end
+
+      if attributes.key?(:'phone_variant')
+        self.phone_variant = attributes[:'phone_variant']
+      end
+
+      if attributes.key?(:'quality_filter')
+        self.quality_filter = attributes[:'quality_filter']
+      end
+
+      if attributes.key?(:'line_type')
+        self.line_type = attributes[:'line_type']
+      end
+
+      if attributes.key?(:'carrier_name')
+        self.carrier_name = attributes[:'carrier_name']
+      end
+
+      if attributes.key?(:'mobile_country_code')
+        self.mobile_country_code = attributes[:'mobile_country_code']
+      end
+
+      if attributes.key?(:'mobile_network_code')
+        self.mobile_network_code = attributes[:'mobile_network_code']
+      end
+
+      if attributes.key?(:'provider_labels')
+        if (value = attributes[:'provider_labels']).is_a?(Array)
+          self.provider_labels = value
+        end
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      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
+      if @phone_country.nil?
+        invalid_properties.push('invalid value for "phone_country", phone_country cannot be nil.')
+      end
+
+      if !@limit.nil? && @limit > 100
+        invalid_properties.push('invalid value for "limit", must be smaller than or equal to 100.')
+      end
+
+      if !@limit.nil? && @limit < 1
+        invalid_properties.push('invalid value for "limit", must be greater than or equal to 1.')
+      end
+
+      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?
+      return false if @phone_country.nil?
+      phone_country_validator = EnumAttributeValidator.new('String', ["US", "GB", "AU", "CA", "EE", "HK", "PL", "PT", "NL", "IL", "FI", "SE"])
+      return false unless phone_country_validator.valid?(@phone_country)
+      phone_variant_validator = EnumAttributeValidator.new('String', ["LOCAL", "MOBILE", "TOLL_FREE"])
+      return false unless phone_variant_validator.valid?(@phone_variant)
+      quality_filter_validator = EnumAttributeValidator.new('String', ["OTP", "NON_VOIP", "MOBILE_ONLY", "ANY"])
+      return false unless quality_filter_validator.valid?(@quality_filter)
+      return false if !@limit.nil? && @limit > 100
+      return false if !@limit.nil? && @limit < 1
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] phone_country Object to be assigned
+    def phone_country=(phone_country)
+      validator = EnumAttributeValidator.new('String', ["US", "GB", "AU", "CA", "EE", "HK", "PL", "PT", "NL", "IL", "FI", "SE"])
+      unless validator.valid?(phone_country)
+        fail ArgumentError, "invalid value for \"phone_country\", must be one of #{validator.allowable_values}."
+      end
+      @phone_country = phone_country
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] phone_variant Object to be assigned
+    def phone_variant=(phone_variant)
+      validator = EnumAttributeValidator.new('String', ["LOCAL", "MOBILE", "TOLL_FREE"])
+      unless validator.valid?(phone_variant)
+        fail ArgumentError, "invalid value for \"phone_variant\", must be one of #{validator.allowable_values}."
+      end
+      @phone_variant = phone_variant
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] quality_filter Object to be assigned
+    def quality_filter=(quality_filter)
+      validator = EnumAttributeValidator.new('String', ["OTP", "NON_VOIP", "MOBILE_ONLY", "ANY"])
+      unless validator.valid?(quality_filter)
+        fail ArgumentError, "invalid value for \"quality_filter\", must be one of #{validator.allowable_values}."
+      end
+      @quality_filter = quality_filter
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] limit Value to be assigned
+    def limit=(limit)
+      if !limit.nil? && limit > 100
+        fail ArgumentError, 'invalid value for "limit", must be smaller than or equal to 100.'
+      end
+
+      if !limit.nil? && limit < 1
+        fail ArgumentError, 'invalid value for "limit", must be greater than or equal to 1.'
+      end
+
+      @limit = limit
+    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 &&
+          phone_country == o.phone_country &&
+          phone_variant == o.phone_variant &&
+          quality_filter == o.quality_filter &&
+          line_type == o.line_type &&
+          carrier_name == o.carrier_name &&
+          mobile_country_code == o.mobile_country_code &&
+          mobile_network_code == o.mobile_network_code &&
+          provider_labels == o.provider_labels &&
+          limit == o.limit
+    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
+      [phone_country, phone_variant, quality_filter, line_type, carrier_name, mobile_country_code, mobile_network_code, provider_labels, limit].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/search_inboxes_options.rb

@@ -26,7 +26,7 @@ module MailSlurpClient
     # Optionally filter results for favourites only
     attr_accessor :favourite
 
-    # Optionally filter by search words partial matching ID, tags, name, and email address
+    # Optionally filter by search words partial matching name and email address
     attr_accessor :search
 
     # Optionally filter by tags. Will return inboxes that include given tags

data/lib/mailslurp_client/models/sender_projection.rb

@@ -15,27 +15,27 @@ require 'date'
 module MailSlurpClient
   # Last sender object
   class SenderProjection
+    attr_accessor :name
+
     attr_accessor :email_address
 
     attr_accessor :raw_value
 
-    attr_accessor :name
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'name' => :'name',
         :'email_address' => :'emailAddress',
-        :'raw_value' => :'rawValue',
-        :'name' => :'name'
+        :'raw_value' => :'rawValue'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'name' => :'String',
         :'email_address' => :'String',
-        :'raw_value' => :'String',
-        :'name' => :'String'
+        :'raw_value' => :'String'
       }
     end
 
@@ -60,6 +60,10 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
       if attributes.key?(:'email_address')
         self.email_address = attributes[:'email_address']
       end
@@ -67,10 +71,6 @@ module MailSlurpClient
       if attributes.key?(:'raw_value')
         self.raw_value = attributes[:'raw_value']
       end
-
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -101,9 +101,9 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          name == o.name &&
           email_address == o.email_address &&
-          raw_value == o.raw_value &&
-          name == o.name
+          raw_value == o.raw_value
     end
 
     # @see the `==` method
@@ -115,7 +115,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email_address, raw_value, name].hash
+      [name, email_address, raw_value].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/sent_email_projection.rb

@@ -14,22 +14,24 @@ require 'date'
 
 module MailSlurpClient
   class SentEmailProjection
-    attr_accessor :subject
-
     attr_accessor :id
 
-    attr_accessor :user_id
-
-    attr_accessor :inbox_id
-
-    attr_accessor :attachments
+    attr_accessor :thread_id
 
     attr_accessor :from
 
+    attr_accessor :subject
+
     attr_accessor :sender
 
     attr_accessor :recipients
 
+    attr_accessor :user_id
+
+    attr_accessor :inbox_id
+
+    attr_accessor :attachments
+
     attr_accessor :created_at
 
     attr_accessor :to
@@ -50,19 +52,18 @@ module MailSlurpClient
 
     attr_accessor :body_md5_hash
 
-    attr_accessor :thread_id
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'subject' => :'subject',
         :'id' => :'id',
-        :'user_id' => :'userId',
-        :'inbox_id' => :'inboxId',
-        :'attachments' => :'attachments',
+        :'thread_id' => :'threadId',
         :'from' => :'from',
+        :'subject' => :'subject',
         :'sender' => :'sender',
         :'recipients' => :'recipients',
+        :'user_id' => :'userId',
+        :'inbox_id' => :'inboxId',
+        :'attachments' => :'attachments',
         :'created_at' => :'createdAt',
         :'to' => :'to',
         :'cc' => :'cc',
@@ -72,22 +73,22 @@ module MailSlurpClient
         :'virtual_send' => :'virtualSend',
         :'body_excerpt' => :'bodyExcerpt',
         :'text_excerpt' => :'textExcerpt',
-        :'body_md5_hash' => :'bodyMD5Hash',
-        :'thread_id' => :'threadId'
+        :'body_md5_hash' => :'bodyMD5Hash'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'subject' => :'String',
         :'id' => :'String',
-        :'user_id' => :'String',
-        :'inbox_id' => :'String',
-        :'attachments' => :'Array<String>',
+        :'thread_id' => :'String',
         :'from' => :'String',
+        :'subject' => :'String',
         :'sender' => :'Sender',
         :'recipients' => :'EmailRecipients',
+        :'user_id' => :'String',
+        :'inbox_id' => :'String',
+        :'attachments' => :'Array<String>',
         :'created_at' => :'DateTime',
         :'to' => :'Array<String>',
         :'cc' => :'Array<String>',
@@ -97,25 +98,24 @@ module MailSlurpClient
         :'virtual_send' => :'Boolean',
         :'body_excerpt' => :'String',
         :'text_excerpt' => :'String',
-        :'body_md5_hash' => :'String',
-        :'thread_id' => :'String'
+        :'body_md5_hash' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'subject',
-        :'attachments',
+        :'thread_id',
         :'from',
+        :'subject',
         :'sender',
         :'recipients',
+        :'attachments',
         :'message_id',
         :'in_reply_to',
         :'body_excerpt',
         :'text_excerpt',
-        :'body_md5_hash',
-        :'thread_id'
+        :'body_md5_hash'
       ])
     end
 
@@ -134,12 +134,28 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'thread_id')
+        self.thread_id = attributes[:'thread_id']
+      end
+
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      end
+
       if attributes.key?(:'subject')
         self.subject = attributes[:'subject']
       end
 
-      if attributes.key?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'sender')
+        self.sender = attributes[:'sender']
+      end
+
+      if attributes.key?(:'recipients')
+        self.recipients = attributes[:'recipients']
       end
 
       if attributes.key?(:'user_id')
@@ -156,18 +172,6 @@ module MailSlurpClient
         end
       end
 
-      if attributes.key?(:'from')
-        self.from = attributes[:'from']
-      end
-
-      if attributes.key?(:'sender')
-        self.sender = attributes[:'sender']
-      end
-
-      if attributes.key?(:'recipients')
-        self.recipients = attributes[:'recipients']
-      end
-
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -213,10 +217,6 @@ module MailSlurpClient
       if attributes.key?(:'body_md5_hash')
         self.body_md5_hash = attributes[:'body_md5_hash']
       end
-
-      if attributes.key?(:'thread_id')
-        self.thread_id = attributes[:'thread_id']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -262,14 +262,15 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          subject == o.subject &&
           id == o.id &&
-          user_id == o.user_id &&
-          inbox_id == o.inbox_id &&
-          attachments == o.attachments &&
+          thread_id == o.thread_id &&
           from == o.from &&
+          subject == o.subject &&
           sender == o.sender &&
           recipients == o.recipients &&
+          user_id == o.user_id &&
+          inbox_id == o.inbox_id &&
+          attachments == o.attachments &&
           created_at == o.created_at &&
           to == o.to &&
           cc == o.cc &&
@@ -279,8 +280,7 @@ module MailSlurpClient
           virtual_send == o.virtual_send &&
           body_excerpt == o.body_excerpt &&
           text_excerpt == o.text_excerpt &&
-          body_md5_hash == o.body_md5_hash &&
-          thread_id == o.thread_id
+          body_md5_hash == o.body_md5_hash
     end
 
     # @see the `==` method
@@ -292,7 +292,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [subject, id, user_id, inbox_id, attachments, from, sender, recipients, created_at, to, cc, bcc, message_id, in_reply_to, virtual_send, body_excerpt, text_excerpt, body_md5_hash, thread_id].hash
+      [id, thread_id, from, subject, sender, recipients, user_id, inbox_id, attachments, created_at, to, cc, bcc, message_id, in_reply_to, virtual_send, body_excerpt, text_excerpt, body_md5_hash].hash
     end
 
     # Builds the object from hash