mailslurp_client 17.3.0 → 17.4.0

data/lib/mailslurp_client/api/phone_controller_api.rb

@@ -151,6 +151,76 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Add phone number tags
+    # Add one or more tags to a phone number
+    # @param phone_number_id [String] 
+    # @param phone_number_tags_options [PhoneNumberTagsOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [PhoneNumberDto]
+    def add_phone_number_tags(phone_number_id, phone_number_tags_options, opts = {})
+      data, _status_code, _headers = add_phone_number_tags_with_http_info(phone_number_id, phone_number_tags_options, opts)
+      data
+    end
+
+    # Add phone number tags
+    # Add one or more tags to a phone number
+    # @param phone_number_id [String] 
+    # @param phone_number_tags_options [PhoneNumberTagsOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PhoneNumberDto, Integer, Hash)>] PhoneNumberDto data, response status code and response headers
+    def add_phone_number_tags_with_http_info(phone_number_id, phone_number_tags_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhoneControllerApi.add_phone_number_tags ...'
+      end
+      # verify the required parameter 'phone_number_id' is set
+      if @api_client.config.client_side_validation && phone_number_id.nil?
+        fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneControllerApi.add_phone_number_tags"
+      end
+      # verify the required parameter 'phone_number_tags_options' is set
+      if @api_client.config.client_side_validation && phone_number_tags_options.nil?
+        fail ArgumentError, "Missing the required parameter 'phone_number_tags_options' when calling PhoneControllerApi.add_phone_number_tags"
+      end
+      # resource path
+      local_var_path = '/phone/numbers/{phoneNumberId}/tags'.sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_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(['*/*'])
+      # 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(phone_number_tags_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'PhoneNumberDto' 
+
+      # 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: PhoneControllerApi#add_phone_number_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Add phone numbers to phone pool
     # Add one or more owned phone numbers to a pool
     # @param pool_id [String] 
@@ -1606,6 +1676,68 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get phone number tags
+    # Get tags for a specific phone number
+    # @param phone_number_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<String>]
+    def get_phone_number_tags(phone_number_id, opts = {})
+      data, _status_code, _headers = get_phone_number_tags_with_http_info(phone_number_id, opts)
+      data
+    end
+
+    # Get phone number tags
+    # Get tags for a specific phone number
+    # @param phone_number_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
+    def get_phone_number_tags_with_http_info(phone_number_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_phone_number_tags ...'
+      end
+      # verify the required parameter 'phone_number_id' is set
+      if @api_client.config.client_side_validation && phone_number_id.nil?
+        fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneControllerApi.get_phone_number_tags"
+      end
+      # resource path
+      local_var_path = '/phone/numbers/{phoneNumberId}/tags'.sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_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(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<String>' 
+
+      # 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: PhoneControllerApi#get_phone_number_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get phone numbers
     # List phone numbers for account
     # @param [Hash] opts the optional parameters
@@ -1621,6 +1753,7 @@ module MailSlurpClient
     # @option opts [DateTime] :since Filter by created at after the given timestamp
     # @option opts [DateTime] :before Filter by created at before the given timestamp
     # @option opts [String] :search Optional search filter
+    # @option opts [Array<String>] :tag Optional tags to filter by. A phone must include all provided tags
     # @option opts [Array<String>] :include Optional phoneIds to include in result
     # @option opts [Boolean] :favourite Optionally filter results for favourites only (default to false)
     # @return [PagePhoneNumberProjection]
@@ -1644,6 +1777,7 @@ module MailSlurpClient
     # @option opts [DateTime] :since Filter by created at after the given timestamp
     # @option opts [DateTime] :before Filter by created at before the given timestamp
     # @option opts [String] :search Optional search filter
+    # @option opts [Array<String>] :tag Optional tags to filter by. A phone must include all provided tags
     # @option opts [Array<String>] :include Optional phoneIds to include in result
     # @option opts [Boolean] :favourite Optionally filter results for favourites only
     # @return [Array<(PagePhoneNumberProjection, Integer, Hash)>] PagePhoneNumberProjection data, response status code and response headers
@@ -1676,6 +1810,7 @@ module MailSlurpClient
       query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
       query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
       query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+      query_params[:'tag'] = @api_client.build_collection_param(opts[:'tag'], :multi) if !opts[:'tag'].nil?
       query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :multi) if !opts[:'include'].nil?
       query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
 
@@ -2310,6 +2445,65 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get phone tags
+    # List all unique tags used by your phone numbers
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :search Optional search filter
+    # @return [Array<String>]
+    def get_phone_tags(opts = {})
+      data, _status_code, _headers = get_phone_tags_with_http_info(opts)
+      data
+    end
+
+    # Get phone tags
+    # List all unique tags used by your phone numbers
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :search Optional search filter
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
+    def get_phone_tags_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_phone_tags ...'
+      end
+      # resource path
+      local_var_path = '/phone/tags'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<String>' 
+
+      # 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: PhoneControllerApi#get_phone_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List sent TXT messages for a phone number
     # Get sent SMS messages for a phone number
     # @param phone_number_id [String] 
@@ -2686,6 +2880,76 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Remove phone number tags
+    # Remove one or more tags from a phone number
+    # @param phone_number_id [String] 
+    # @param phone_number_tags_options [PhoneNumberTagsOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [PhoneNumberDto]
+    def remove_phone_number_tags(phone_number_id, phone_number_tags_options, opts = {})
+      data, _status_code, _headers = remove_phone_number_tags_with_http_info(phone_number_id, phone_number_tags_options, opts)
+      data
+    end
+
+    # Remove phone number tags
+    # Remove one or more tags from a phone number
+    # @param phone_number_id [String] 
+    # @param phone_number_tags_options [PhoneNumberTagsOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PhoneNumberDto, Integer, Hash)>] PhoneNumberDto data, response status code and response headers
+    def remove_phone_number_tags_with_http_info(phone_number_id, phone_number_tags_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhoneControllerApi.remove_phone_number_tags ...'
+      end
+      # verify the required parameter 'phone_number_id' is set
+      if @api_client.config.client_side_validation && phone_number_id.nil?
+        fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneControllerApi.remove_phone_number_tags"
+      end
+      # verify the required parameter 'phone_number_tags_options' is set
+      if @api_client.config.client_side_validation && phone_number_tags_options.nil?
+        fail ArgumentError, "Missing the required parameter 'phone_number_tags_options' when calling PhoneControllerApi.remove_phone_number_tags"
+      end
+      # resource path
+      local_var_path = '/phone/numbers/{phoneNumberId}/tags'.sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_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(['*/*'])
+      # 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(phone_number_tags_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'PhoneNumberDto' 
+
+      # 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: PhoneControllerApi#remove_phone_number_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Search available phone numbers
     # Search available numbers for advanced provisioning
     # @param search_available_phone_numbers_options [SearchAvailablePhoneNumbersOptions] 
@@ -2953,6 +3217,76 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Set phone number tags
+    # Replace all tags on a phone number
+    # @param phone_number_id [String] 
+    # @param phone_number_tags_options [PhoneNumberTagsOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [PhoneNumberDto]
+    def set_phone_number_tags(phone_number_id, phone_number_tags_options, opts = {})
+      data, _status_code, _headers = set_phone_number_tags_with_http_info(phone_number_id, phone_number_tags_options, opts)
+      data
+    end
+
+    # Set phone number tags
+    # Replace all tags on a phone number
+    # @param phone_number_id [String] 
+    # @param phone_number_tags_options [PhoneNumberTagsOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PhoneNumberDto, Integer, Hash)>] PhoneNumberDto data, response status code and response headers
+    def set_phone_number_tags_with_http_info(phone_number_id, phone_number_tags_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhoneControllerApi.set_phone_number_tags ...'
+      end
+      # verify the required parameter 'phone_number_id' is set
+      if @api_client.config.client_side_validation && phone_number_id.nil?
+        fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneControllerApi.set_phone_number_tags"
+      end
+      # verify the required parameter 'phone_number_tags_options' is set
+      if @api_client.config.client_side_validation && phone_number_tags_options.nil?
+        fail ArgumentError, "Missing the required parameter 'phone_number_tags_options' when calling PhoneControllerApi.set_phone_number_tags"
+      end
+      # resource path
+      local_var_path = '/phone/numbers/{phoneNumberId}/tags'.sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_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(['*/*'])
+      # 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(phone_number_tags_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'PhoneNumberDto' 
+
+      # 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: PhoneControllerApi#set_phone_number_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Test sending an SMS to a number
     # Test a phone number by sending an SMS to it. NOTE this is only for internal use to check that a phone number is working. For end-to-end phone testing see https://docs.mailslurp.com/txt-sms/
     # @param phone_number_id [String] 

data/lib/mailslurp_client/models/abstract_webhook_payload.rb

@@ -15,14 +15,14 @@ require 'date'
 module MailSlurpClient
   # Abstract webhook payload. Use the correct payload type for your webhook event type in order to access all the specific properties for that event. See the `NEW_EMAIL`,`NEW_CONTACT`, `NEW_ATTACHMENT` and `EMAIL_OPENED` payloads for the properties available for those events.
   class AbstractWebhookPayload
+    attr_accessor :webhook_name
+
     attr_accessor :event_name
 
     attr_accessor :webhook_id
 
     attr_accessor :message_id
 
-    attr_accessor :webhook_name
-
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -48,20 +48,20 @@ module MailSlurpClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'webhook_name' => :'webhookName',
         :'event_name' => :'eventName',
         :'webhook_id' => :'webhookId',
-        :'message_id' => :'messageId',
-        :'webhook_name' => :'webhookName'
+        :'message_id' => :'messageId'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'webhook_name' => :'String',
         :'event_name' => :'String',
         :'webhook_id' => :'String',
-        :'message_id' => :'String',
-        :'webhook_name' => :'String'
+        :'message_id' => :'String'
       }
     end
 
@@ -86,6 +86,10 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'webhook_name')
+        self.webhook_name = attributes[:'webhook_name']
+      end
+
       if attributes.key?(:'event_name')
         self.event_name = attributes[:'event_name']
       end
@@ -97,10 +101,6 @@ module MailSlurpClient
       if attributes.key?(:'message_id')
         self.message_id = attributes[:'message_id']
       end
-
-      if attributes.key?(:'webhook_name')
-        self.webhook_name = attributes[:'webhook_name']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -148,10 +148,10 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          webhook_name == o.webhook_name &&
           event_name == o.event_name &&
           webhook_id == o.webhook_id &&
-          message_id == o.message_id &&
-          webhook_name == o.webhook_name
+          message_id == o.message_id
     end
 
     # @see the `==` method
@@ -163,7 +163,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [event_name, webhook_id, message_id, webhook_name].hash
+      [webhook_name, event_name, webhook_id, message_id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/alias_projection.rb

@@ -19,16 +19,16 @@ module MailSlurpClient
 
     attr_accessor :id
 
-    attr_accessor :email_address
-
     attr_accessor :user_id
 
-    attr_accessor :inbox_id
+    attr_accessor :email_address
 
-    attr_accessor :created_at
+    attr_accessor :inbox_id
 
     attr_accessor :updated_at
 
+    attr_accessor :created_at
+
     attr_accessor :use_threads
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -36,11 +36,11 @@ module MailSlurpClient
       {
         :'name' => :'name',
         :'id' => :'id',
-        :'email_address' => :'emailAddress',
         :'user_id' => :'userId',
+        :'email_address' => :'emailAddress',
         :'inbox_id' => :'inboxId',
-        :'created_at' => :'createdAt',
         :'updated_at' => :'updatedAt',
+        :'created_at' => :'createdAt',
         :'use_threads' => :'useThreads'
       }
     end
@@ -50,11 +50,11 @@ module MailSlurpClient
       {
         :'name' => :'String',
         :'id' => :'String',
-        :'email_address' => :'String',
         :'user_id' => :'String',
+        :'email_address' => :'String',
         :'inbox_id' => :'String',
-        :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime',
+        :'created_at' => :'DateTime',
         :'use_threads' => :'Boolean'
       }
     end
@@ -88,26 +88,26 @@ module MailSlurpClient
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'email_address')
-        self.email_address = attributes[:'email_address']
-      end
-
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
 
-      if attributes.key?(:'inbox_id')
-        self.inbox_id = attributes[:'inbox_id']
+      if attributes.key?(:'email_address')
+        self.email_address = attributes[:'email_address']
       end
 
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
+      if attributes.key?(:'inbox_id')
+        self.inbox_id = attributes[:'inbox_id']
       end
 
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
 
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
       if attributes.key?(:'use_threads')
         self.use_threads = attributes[:'use_threads']
       end
@@ -121,26 +121,26 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @email_address.nil?
-        invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
-      end
-
       if @user_id.nil?
         invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
       end
 
-      if @inbox_id.nil?
-        invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
+      if @email_address.nil?
+        invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
       end
 
-      if @created_at.nil?
-        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      if @inbox_id.nil?
+        invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
       end
 
       if @updated_at.nil?
         invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
       end
 
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -148,11 +148,11 @@ module MailSlurpClient
     # @return true if the model is valid
     def valid?
       return false if @id.nil?
-      return false if @email_address.nil?
       return false if @user_id.nil?
+      return false if @email_address.nil?
       return false if @inbox_id.nil?
-      return false if @created_at.nil?
       return false if @updated_at.nil?
+      return false if @created_at.nil?
       true
     end
 
@@ -163,11 +163,11 @@ module MailSlurpClient
       self.class == o.class &&
           name == o.name &&
           id == o.id &&
-          email_address == o.email_address &&
           user_id == o.user_id &&
+          email_address == o.email_address &&
           inbox_id == o.inbox_id &&
-          created_at == o.created_at &&
           updated_at == o.updated_at &&
+          created_at == o.created_at &&
           use_threads == o.use_threads
     end
 
@@ -180,7 +180,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, id, email_address, user_id, inbox_id, created_at, updated_at, use_threads].hash
+      [name, id, user_id, email_address, inbox_id, updated_at, created_at, use_threads].hash
     end
 
     # Builds the object from hash