sendpost_ruby_sdk 1.0.0 → 1.2.2

data/lib/sendpost_ruby_sdk/api/suppression_api.rb

@@ -0,0 +1,305 @@
+=begin
+#SendPost API
+
+#Email API and SMTP relay to not just send and measure email sending, but also alert and optimise. We provide you with tools, expertise and support needed to reliably deliver emails to your customers inboxes on time, every time.
+
+The version of the OpenAPI document: 1.0.0
+Contact: hello@sendpost.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.1
+
+=end
+
+require 'cgi'
+
+module Sendpost
+  class SuppressionApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Count Total Suppressions
+    # @param x_sub_account_api_key [String] Sub-Account API Key
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :from from date
+    # @option opts [String] :to to date
+    # @return [CountStat]
+    def count(x_sub_account_api_key, opts = {})
+      data, _status_code, _headers = count_with_http_info(x_sub_account_api_key, opts)
+      data
+    end
+
+    # Count Total Suppressions
+    # @param x_sub_account_api_key [String] Sub-Account API Key
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :from from date
+    # @option opts [String] :to to date
+    # @return [Array<(CountStat, Integer, Hash)>] CountStat data, response status code and response headers
+    def count_with_http_info(x_sub_account_api_key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SuppressionApi.count ...'
+      end
+      # verify the required parameter 'x_sub_account_api_key' is set
+      if @api_client.config.client_side_validation && x_sub_account_api_key.nil?
+        fail ArgumentError, "Missing the required parameter 'x_sub_account_api_key' when calling SuppressionApi.count"
+      end
+      # resource path
+      local_var_path = '/subaccount/suppression/count'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
+      query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'X-SubAccount-ApiKey'] = x_sub_account_api_key
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CountStat'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"SuppressionApi.count",
+        :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: SuppressionApi#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Add Email Addresses To Suppression List
+    # @param x_sub_account_api_key [String] Sub-Account API Key
+    # @param [Hash] opts the optional parameters
+    # @option opts [RSuppression] :r_suppression Suppression content
+    # @return [Array<Suppression>]
+    def create_suppressions(x_sub_account_api_key, opts = {})
+      data, _status_code, _headers = create_suppressions_with_http_info(x_sub_account_api_key, opts)
+      data
+    end
+
+    # Add Email Addresses To Suppression List
+    # @param x_sub_account_api_key [String] Sub-Account API Key
+    # @param [Hash] opts the optional parameters
+    # @option opts [RSuppression] :r_suppression Suppression content
+    # @return [Array<(Array<Suppression>, Integer, Hash)>] Array<Suppression> data, response status code and response headers
+    def create_suppressions_with_http_info(x_sub_account_api_key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SuppressionApi.create_suppressions ...'
+      end
+      # verify the required parameter 'x_sub_account_api_key' is set
+      if @api_client.config.client_side_validation && x_sub_account_api_key.nil?
+        fail ArgumentError, "Missing the required parameter 'x_sub_account_api_key' when calling SuppressionApi.create_suppressions"
+      end
+      # resource path
+      local_var_path = '/subaccount/suppression/'
+
+      # 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'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'X-SubAccount-ApiKey'] = x_sub_account_api_key
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'r_suppression'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<Suppression>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"SuppressionApi.create_suppressions",
+        :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: SuppressionApi#create_suppressions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete specific emails which are in suppression list
+    # @param x_sub_account_api_key [String] Sub-Account API Key
+    # @param [Hash] opts the optional parameters
+    # @option opts [RDSuppression] :rd_suppression Suppression content
+    # @return [Array<DeleteResponse>]
+    def delete_suppression(x_sub_account_api_key, opts = {})
+      data, _status_code, _headers = delete_suppression_with_http_info(x_sub_account_api_key, opts)
+      data
+    end
+
+    # Delete specific emails which are in suppression list
+    # @param x_sub_account_api_key [String] Sub-Account API Key
+    # @param [Hash] opts the optional parameters
+    # @option opts [RDSuppression] :rd_suppression Suppression content
+    # @return [Array<(Array<DeleteResponse>, Integer, Hash)>] Array<DeleteResponse> data, response status code and response headers
+    def delete_suppression_with_http_info(x_sub_account_api_key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SuppressionApi.delete_suppression ...'
+      end
+      # verify the required parameter 'x_sub_account_api_key' is set
+      if @api_client.config.client_side_validation && x_sub_account_api_key.nil?
+        fail ArgumentError, "Missing the required parameter 'x_sub_account_api_key' when calling SuppressionApi.delete_suppression"
+      end
+      # resource path
+      local_var_path = '/subaccount/suppression/'
+
+      # 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'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'X-SubAccount-ApiKey'] = x_sub_account_api_key
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'rd_suppression'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<DeleteResponse>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"SuppressionApi.delete_suppression",
+        :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: SuppressionApi#delete_suppression\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all suppressions
+    # @param x_sub_account_api_key [String] Sub-Account API Key
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset offset
+    # @option opts [Integer] :limit limit
+    # @option opts [String] :search search
+    # @option opts [String] :from from date
+    # @option opts [String] :to to date
+    # @return [Array<Suppression>]
+    def get_suppressions(x_sub_account_api_key, opts = {})
+      data, _status_code, _headers = get_suppressions_with_http_info(x_sub_account_api_key, opts)
+      data
+    end
+
+    # Get all suppressions
+    # @param x_sub_account_api_key [String] Sub-Account API Key
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset offset
+    # @option opts [Integer] :limit limit
+    # @option opts [String] :search search
+    # @option opts [String] :from from date
+    # @option opts [String] :to to date
+    # @return [Array<(Array<Suppression>, Integer, Hash)>] Array<Suppression> data, response status code and response headers
+    def get_suppressions_with_http_info(x_sub_account_api_key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SuppressionApi.get_suppressions ...'
+      end
+      # verify the required parameter 'x_sub_account_api_key' is set
+      if @api_client.config.client_side_validation && x_sub_account_api_key.nil?
+        fail ArgumentError, "Missing the required parameter 'x_sub_account_api_key' when calling SuppressionApi.get_suppressions"
+      end
+      # resource path
+      local_var_path = '/subaccount/suppression/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
+      query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'X-SubAccount-ApiKey'] = x_sub_account_api_key
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<Suppression>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"SuppressionApi.get_suppressions",
+        :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: SuppressionApi#get_suppressions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/sendpost_ruby_sdk/api_client.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: hello@sendpost.io
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+OpenAPI Generator version: 7.0.1
 
 =end
 

data/lib/sendpost_ruby_sdk/api_error.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: hello@sendpost.io
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+OpenAPI Generator version: 7.0.1
 
 =end
 

data/lib/sendpost_ruby_sdk/configuration.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: hello@sendpost.io
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+OpenAPI Generator version: 7.0.1
 
 =end
 
@@ -152,7 +152,7 @@ module Sendpost
       @scheme = 'https'
       @host = 'api.sendpost.io'
       @base_path = '/api/v1'
-      @server_index = 0
+      @server_index = nil
       @server_operation_index = {}
       @server_variables = {}
       @server_operation_variables = {}
@@ -200,10 +200,12 @@ module Sendpost
 
     # Returns base URL for specified operation based on server settings
     def base_url(operation = nil)
-      index = server_operation_index[operation]
-      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil
-
-      server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      if operation_server_settings.key?(operation) then
+        index = server_operation_index.fetch(operation, server_index)
+        server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      else
+        server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
+      end
     end
 
     # Gets API key (with prefix if set).
@@ -220,8 +222,8 @@ module Sendpost
 
     # Gets access_token using access_token_getter or uses the static access_token
     def access_token_with_refresh
-        return access_token if access_token_getter.nil?
-        access_token_getter.call
+      return access_token if access_token_getter.nil?
+      access_token_getter.call
     end
 
     # Gets Basic Auth token string
@@ -258,8 +260,8 @@ module Sendpost
       servers = server_settings if servers == nil
 
       # check array index out of bound
-      if (index < 0 || index >= servers.size)
-        fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
+      if (index.nil? || index < 0 || index >= servers.size)
+        fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
       end
 
       server = servers[index]

data/lib/sendpost_ruby_sdk/models/attachment.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: hello@sendpost.io
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+OpenAPI Generator version: 7.0.1
 
 =end
 
@@ -73,6 +73,7 @@ module Sendpost
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
       invalid_properties
     end
@@ -80,6 +81,7 @@ module Sendpost
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       true
     end
 
@@ -108,37 +110,30 @@ module Sendpost
     # @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)
       attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
         elsif 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) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     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)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)

data/lib/sendpost_ruby_sdk/models/city.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: hello@sendpost.io
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+OpenAPI Generator version: 7.0.1
 
 =end
 
@@ -97,6 +97,7 @@ module Sendpost
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
       invalid_properties
     end
@@ -104,6 +105,7 @@ module Sendpost
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       true
     end
 
@@ -135,37 +137,30 @@ module Sendpost
     # @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)
       attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
         elsif 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) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     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)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)

data/lib/sendpost_ruby_sdk/models/copy_to.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: hello@sendpost.io
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+OpenAPI Generator version: 7.0.1
 
 =end
 
@@ -81,6 +81,7 @@ module Sendpost
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
       invalid_properties
     end
@@ -88,6 +89,7 @@ module Sendpost
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       true
     end
 
@@ -117,37 +119,30 @@ module Sendpost
     # @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)
       attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
         elsif 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) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     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)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)