smspool 0.1.1

data/lib/smspool/api/rental_api.rb

@@ -0,0 +1,1115 @@
+=begin
+#SMSPool API
+
+#Every endpoint accepts its parameters as form fields (POST) or query parameters (GET).  Authenticate with your API key from https://www.smspool.net/my/settings, either as a bearer token (`Authorization: Bearer <key>`) or as a `key` parameter.
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'cgi'
+
+module SMSPool
+  class RentalApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Order Rental
+    # @param id [Integer] Rental ID retrieved from Retrieve Rental IDs
+    # @param days [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :service_id Optional value on which service you&#39;d purchase the rental for
+    # @option opts [Integer] :create_token Create a rental token which allows you to share this specific rental
+    # @option opts [String] :city 
+    # @option opts [String] :state 
+    # @option opts [String] :zipcode 
+    # @return [Object]
+    def purchase_rental(id, days, opts = {})
+      data, _status_code, _headers = purchase_rental_with_http_info(id, days, opts)
+      data
+    end
+
+    # Order Rental
+    # @param id [Integer] Rental ID retrieved from Retrieve Rental IDs
+    # @param days [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :service_id Optional value on which service you&#39;d purchase the rental for
+    # @option opts [Integer] :create_token Create a rental token which allows you to share this specific rental
+    # @option opts [String] :city 
+    # @option opts [String] :state 
+    # @option opts [String] :zipcode 
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def purchase_rental_with_http_info(id, days, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.purchase_rental ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling RentalApi.purchase_rental"
+      end
+      # verify the required parameter 'days' is set
+      if @api_client.config.client_side_validation && days.nil?
+        fail ArgumentError, "Missing the required parameter 'days' when calling RentalApi.purchase_rental"
+      end
+      # resource path
+      local_var_path = '/purchase/rental'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['id'] = id
+      form_params['days'] = days
+      form_params['service_id'] = opts[:'service_id'] if !opts[:'service_id'].nil?
+      form_params['create_token'] = opts[:'create_token'] if !opts[:'create_token'].nil?
+      form_params['city'] = opts[:'city'] if !opts[:'city'].nil?
+      form_params['state'] = opts[:'state'] if !opts[:'state'].nil?
+      form_params['zipcode'] = opts[:'zipcode'] if !opts[:'zipcode'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.purchase_rental",
+        :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: RentalApi#purchase_rental\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Enable Auto Extend Rental
+    # @param rental_code [String] The retrieved rental code from the &#x60;Order rental&#x60; endpoint.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def rental_auto_extend(rental_code, opts = {})
+      data, _status_code, _headers = rental_auto_extend_with_http_info(rental_code, opts)
+      data
+    end
+
+    # Enable Auto Extend Rental
+    # @param rental_code [String] The retrieved rental code from the &#x60;Order rental&#x60; endpoint.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def rental_auto_extend_with_http_info(rental_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.rental_auto_extend ...'
+      end
+      # verify the required parameter 'rental_code' is set
+      if @api_client.config.client_side_validation && rental_code.nil?
+        fail ArgumentError, "Missing the required parameter 'rental_code' when calling RentalApi.rental_auto_extend"
+      end
+      # resource path
+      local_var_path = '/rental/auto_extend'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['rental_code'] = rental_code
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.rental_auto_extend",
+        :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: RentalApi#rental_auto_extend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Extend Rental
+    # @param days [Integer] 
+    # @param rental_code [String] The retrieved rental code from the &#x60;Order rental&#x60; endpoint.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def rental_extend(days, rental_code, opts = {})
+      data, _status_code, _headers = rental_extend_with_http_info(days, rental_code, opts)
+      data
+    end
+
+    # Extend Rental
+    # @param days [Integer] 
+    # @param rental_code [String] The retrieved rental code from the &#x60;Order rental&#x60; endpoint.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def rental_extend_with_http_info(days, rental_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.rental_extend ...'
+      end
+      # verify the required parameter 'days' is set
+      if @api_client.config.client_side_validation && days.nil?
+        fail ArgumentError, "Missing the required parameter 'days' when calling RentalApi.rental_extend"
+      end
+      # verify the required parameter 'rental_code' is set
+      if @api_client.config.client_side_validation && rental_code.nil?
+        fail ArgumentError, "Missing the required parameter 'rental_code' when calling RentalApi.rental_extend"
+      end
+      # resource path
+      local_var_path = '/rental/extend'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['days'] = days
+      form_params['rental_code'] = rental_code
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.rental_extend",
+        :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: RentalApi#rental_extend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Rental History
+    # Retrieve a history of all your rental actions.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def rental_history(opts = {})
+      data, _status_code, _headers = rental_history_with_http_info(opts)
+      data
+    end
+
+    # Rental History
+    # Retrieve a history of all your rental actions.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def rental_history_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.rental_history ...'
+      end
+      # resource path
+      local_var_path = '/rental/history'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.rental_history",
+        :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: RentalApi#rental_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve Rental Info
+    # Retrieve rental information
+    # @param rental_code [String] The retrieved rental code from the &#x60;Order rental&#x60; endpoint.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def rental_info(rental_code, opts = {})
+      data, _status_code, _headers = rental_info_with_http_info(rental_code, opts)
+      data
+    end
+
+    # Retrieve Rental Info
+    # Retrieve rental information
+    # @param rental_code [String] The retrieved rental code from the &#x60;Order rental&#x60; endpoint.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def rental_info_with_http_info(rental_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.rental_info ...'
+      end
+      # verify the required parameter 'rental_code' is set
+      if @api_client.config.client_side_validation && rental_code.nil?
+        fail ArgumentError, "Missing the required parameter 'rental_code' when calling RentalApi.rental_info"
+      end
+      # resource path
+      local_var_path = '/rental/info'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['rental_code'] = rental_code
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.rental_info",
+        :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: RentalApi#rental_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Refund Rental
+    # @param rental_code [String] The retrieved rental code from the &#x60;Order rental&#x60; endpoint.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def rental_refund(rental_code, opts = {})
+      data, _status_code, _headers = rental_refund_with_http_info(rental_code, opts)
+      data
+    end
+
+    # Refund Rental
+    # @param rental_code [String] The retrieved rental code from the &#x60;Order rental&#x60; endpoint.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def rental_refund_with_http_info(rental_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.rental_refund ...'
+      end
+      # verify the required parameter 'rental_code' is set
+      if @api_client.config.client_side_validation && rental_code.nil?
+        fail ArgumentError, "Missing the required parameter 'rental_code' when calling RentalApi.rental_refund"
+      end
+      # resource path
+      local_var_path = '/rental/refund'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['rental_code'] = rental_code
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.rental_refund",
+        :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: RentalApi#rental_refund\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reset Rental
+    # @param rental_code [String] The retrieved rental code from the &#x60;Order rental&#x60; endpoint.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def rental_reset(rental_code, opts = {})
+      data, _status_code, _headers = rental_reset_with_http_info(rental_code, opts)
+      data
+    end
+
+    # Reset Rental
+    # @param rental_code [String] The retrieved rental code from the &#x60;Order rental&#x60; endpoint.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def rental_reset_with_http_info(rental_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.rental_reset ...'
+      end
+      # verify the required parameter 'rental_code' is set
+      if @api_client.config.client_side_validation && rental_code.nil?
+        fail ArgumentError, "Missing the required parameter 'rental_code' when calling RentalApi.rental_reset"
+      end
+      # resource path
+      local_var_path = '/rental/reset'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['rental_code'] = rental_code
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.rental_reset",
+        :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: RentalApi#rental_reset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve Active Rentals
+    # Retrieve a history of all your rental actions.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def rental_retrieve(opts = {})
+      data, _status_code, _headers = rental_retrieve_with_http_info(opts)
+      data
+    end
+
+    # Retrieve Active Rentals
+    # Retrieve a history of all your rental actions.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def rental_retrieve_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.rental_retrieve ...'
+      end
+      # resource path
+      local_var_path = '/rental/retrieve'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.rental_retrieve",
+        :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: RentalApi#rental_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve Rental IDs
+    # Retrieve available rental products. Each listing includes `is_refundable` (`0` or `1`), `refund_within` (hours after purchase a refund is allowed; `0` when not refundable), and `refund_min_days` (minimum duration that is eligible for a refund; `0` when there is no duration floor or the rental is never refundable). Refunds also require that no messages have been received.
+    # @param type [Integer] Choose whether the rental is extendable or not with a 0 or 1
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def rental_retrieve_all(type, opts = {})
+      data, _status_code, _headers = rental_retrieve_all_with_http_info(type, opts)
+      data
+    end
+
+    # Retrieve Rental IDs
+    # Retrieve available rental products. Each listing includes &#x60;is_refundable&#x60; (&#x60;0&#x60; or &#x60;1&#x60;), &#x60;refund_within&#x60; (hours after purchase a refund is allowed; &#x60;0&#x60; when not refundable), and &#x60;refund_min_days&#x60; (minimum duration that is eligible for a refund; &#x60;0&#x60; when there is no duration floor or the rental is never refundable). Refunds also require that no messages have been received.
+    # @param type [Integer] Choose whether the rental is extendable or not with a 0 or 1
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def rental_retrieve_all_with_http_info(type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.rental_retrieve_all ...'
+      end
+      # verify the required parameter 'type' is set
+      if @api_client.config.client_side_validation && type.nil?
+        fail ArgumentError, "Missing the required parameter 'type' when calling RentalApi.rental_retrieve_all"
+      end
+      # resource path
+      local_var_path = '/rental/retrieve_all'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['type'] = type
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.rental_retrieve_all",
+        :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: RentalApi#rental_retrieve_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve your rentals
+    # List every rental on your account that was not refunded, including expired ones. For the actions taken on your rentals (activations, extensions, refunds) use **Rental History** instead.  - `rental`: the rental ID from **Retrieve Rental IDs** - `rental_code`: use it with the other rental endpoints, such as **Retrieve Rental Messages** - `expiration_date`: Unix timestamp - `source`: the pool the number comes from - `state`: the US state of the number, or `Unknown`
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def rental_retrieve_history(opts = {})
+      data, _status_code, _headers = rental_retrieve_history_with_http_info(opts)
+      data
+    end
+
+    # Retrieve your rentals
+    # List every rental on your account that was not refunded, including expired ones. For the actions taken on your rentals (activations, extensions, refunds) use **Rental History** instead.  - &#x60;rental&#x60;: the rental ID from **Retrieve Rental IDs** - &#x60;rental_code&#x60;: use it with the other rental endpoints, such as **Retrieve Rental Messages** - &#x60;expiration_date&#x60;: Unix timestamp - &#x60;source&#x60;: the pool the number comes from - &#x60;state&#x60;: the US state of the number, or &#x60;Unknown&#x60;
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def rental_retrieve_history_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.rental_retrieve_history ...'
+      end
+      # resource path
+      local_var_path = '/rental/retrieve_history'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.rental_retrieve_history",
+        :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: RentalApi#rental_retrieve_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve Rental Messages
+    # @param rental_code [String] The retrieved rental code from the &#x60;Order rental&#x60; endpoint.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def rental_retrieve_messages(rental_code, opts = {})
+      data, _status_code, _headers = rental_retrieve_messages_with_http_info(rental_code, opts)
+      data
+    end
+
+    # Retrieve Rental Messages
+    # @param rental_code [String] The retrieved rental code from the &#x60;Order rental&#x60; endpoint.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def rental_retrieve_messages_with_http_info(rental_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.rental_retrieve_messages ...'
+      end
+      # verify the required parameter 'rental_code' is set
+      if @api_client.config.client_side_validation && rental_code.nil?
+        fail ArgumentError, "Missing the required parameter 'rental_code' when calling RentalApi.rental_retrieve_messages"
+      end
+      # resource path
+      local_var_path = '/rental/retrieve_messages'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['rental_code'] = rental_code
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.rental_retrieve_messages",
+        :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: RentalApi#rental_retrieve_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve Rental Pricing
+    # @param id [Integer] The rental ID retrieved from &#x60;Retrieve Rental IDs&#x60;
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :service Service name or service ID which can be retrieved at the /service/retrieve_all endpoint
+    # @return [Object]
+    def rental_retrieve_pricing(id, opts = {})
+      data, _status_code, _headers = rental_retrieve_pricing_with_http_info(id, opts)
+      data
+    end
+
+    # Retrieve Rental Pricing
+    # @param id [Integer] The rental ID retrieved from &#x60;Retrieve Rental IDs&#x60;
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :service Service name or service ID which can be retrieved at the /service/retrieve_all endpoint
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def rental_retrieve_pricing_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.rental_retrieve_pricing ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling RentalApi.rental_retrieve_pricing"
+      end
+      # resource path
+      local_var_path = '/rental/retrieve_pricing'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['id'] = id
+      form_params['service'] = opts[:'service'] if !opts[:'service'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.rental_retrieve_pricing",
+        :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: RentalApi#rental_retrieve_pricing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve Rental Services
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :rental The rental ID retrieved from &#x60;Retrieve Rental IDs&#x60;
+    # @return [Object]
+    def rental_retrieve_services(opts = {})
+      data, _status_code, _headers = rental_retrieve_services_with_http_info(opts)
+      data
+    end
+
+    # Retrieve Rental Services
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :rental The rental ID retrieved from &#x60;Retrieve Rental IDs&#x60;
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def rental_retrieve_services_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.rental_retrieve_services ...'
+      end
+      # resource path
+      local_var_path = '/rental/retrieve_services'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['rental'] = opts[:'rental'] if !opts[:'rental'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.rental_retrieve_services",
+        :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: RentalApi#rental_retrieve_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve Rental Status
+    # @param rental_code [String] The retrieved rental code from the &#x60;Order rental&#x60; endpoint.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def rental_retrieve_status(rental_code, opts = {})
+      data, _status_code, _headers = rental_retrieve_status_with_http_info(rental_code, opts)
+      data
+    end
+
+    # Retrieve Rental Status
+    # @param rental_code [String] The retrieved rental code from the &#x60;Order rental&#x60; endpoint.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def rental_retrieve_status_with_http_info(rental_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.rental_retrieve_status ...'
+      end
+      # verify the required parameter 'rental_code' is set
+      if @api_client.config.client_side_validation && rental_code.nil?
+        fail ArgumentError, "Missing the required parameter 'rental_code' when calling RentalApi.rental_retrieve_status"
+      end
+      # resource path
+      local_var_path = '/rental/retrieve_status'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['rental_code'] = rental_code
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.rental_retrieve_status",
+        :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: RentalApi#rental_retrieve_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve rental service price
+    # Some rentals are bound to a single service. This returns the price of a rental for that service, with the custom pricing on your account applied.
+    # @param id [Integer] The rental ID retrieved from &#x60;Retrieve Rental IDs&#x60;
+    # @param service_id [Integer] The service ID retrieved from &#x60;Retrieve Rental Services&#x60;
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def rental_service_price(id, service_id, opts = {})
+      data, _status_code, _headers = rental_service_price_with_http_info(id, service_id, opts)
+      data
+    end
+
+    # Retrieve rental service price
+    # Some rentals are bound to a single service. This returns the price of a rental for that service, with the custom pricing on your account applied.
+    # @param id [Integer] The rental ID retrieved from &#x60;Retrieve Rental IDs&#x60;
+    # @param service_id [Integer] The service ID retrieved from &#x60;Retrieve Rental Services&#x60;
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def rental_service_price_with_http_info(id, service_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.rental_service_price ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling RentalApi.rental_service_price"
+      end
+      # verify the required parameter 'service_id' is set
+      if @api_client.config.client_side_validation && service_id.nil?
+        fail ArgumentError, "Missing the required parameter 'service_id' when calling RentalApi.rental_service_price"
+      end
+      # resource path
+      local_var_path = '/rental/service_price'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['id'] = id
+      form_params['service_id'] = service_id
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.rental_service_price",
+        :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: RentalApi#rental_service_price\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve Rental Stock
+    # @param id [Integer] The rental ID retrieved from &#x60;Retrieve Rental IDs&#x60;
+    # @param days [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :service_id 
+    # @return [Object]
+    def rental_stock(id, days, opts = {})
+      data, _status_code, _headers = rental_stock_with_http_info(id, days, opts)
+      data
+    end
+
+    # Retrieve Rental Stock
+    # @param id [Integer] The rental ID retrieved from &#x60;Retrieve Rental IDs&#x60;
+    # @param days [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :service_id 
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def rental_stock_with_http_info(id, days, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RentalApi.rental_stock ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling RentalApi.rental_stock"
+      end
+      # verify the required parameter 'days' is set
+      if @api_client.config.client_side_validation && days.nil?
+        fail ArgumentError, "Missing the required parameter 'days' when calling RentalApi.rental_stock"
+      end
+      # resource path
+      local_var_path = '/rental/stock'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['id'] = id
+      form_params['days'] = days
+      form_params['service_id'] = opts[:'service_id'] if !opts[:'service_id'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"RentalApi.rental_stock",
+        :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: RentalApi#rental_stock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end