smspool 0.1.1

data/lib/smspool/api/esims_api.rb

@@ -0,0 +1,637 @@
+=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 ESIMsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete eSIM
+    # @param transaction_id [String] transactionId retrieved from /esim/purchase
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def esim_delete(transaction_id, opts = {})
+      data, _status_code, _headers = esim_delete_with_http_info(transaction_id, opts)
+      data
+    end
+
+    # Delete eSIM
+    # @param transaction_id [String] transactionId retrieved from /esim/purchase
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def esim_delete_with_http_info(transaction_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ESIMsApi.esim_delete ...'
+      end
+      # verify the required parameter 'transaction_id' is set
+      if @api_client.config.client_side_validation && transaction_id.nil?
+        fail ArgumentError, "Missing the required parameter 'transaction_id' when calling ESIMsApi.esim_delete"
+      end
+      # resource path
+      local_var_path = '/esim/delete'
+
+      # 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['transactionId'] = transaction_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 => :"ESIMsApi.esim_delete",
+        :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: ESIMsApi#esim_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # View eSIM history
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :start Start page
+    # @option opts [Integer] :length Amount of rows per page
+    # @option opts [String] :search Alphanumeric search
+    # @return [Object]
+    def esim_history(opts = {})
+      data, _status_code, _headers = esim_history_with_http_info(opts)
+      data
+    end
+
+    # View eSIM history
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :start Start page
+    # @option opts [Integer] :length Amount of rows per page
+    # @option opts [String] :search Alphanumeric search
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def esim_history_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ESIMsApi.esim_history ...'
+      end
+      # resource path
+      local_var_path = '/esim/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']
+      # 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['start'] = opts[:'start'] if !opts[:'start'].nil?
+      form_params['length'] = opts[:'length'] if !opts[:'length'].nil?
+      form_params['search'] = opts[:'search'] if !opts[:'search'].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 => :"ESIMsApi.esim_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: ESIMsApi#esim_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update eSIM label
+    # Set or clear the label of one of your eSIMs. The label is returned as `label` by **View eSIM history**, so you can use it to tell your eSIMs apart.  A label can be up to 30 characters long and may only contain letters, numbers and spaces. Leave `label` out, or send it empty, to remove the label.
+    # @param transaction_id [String] transactionId retrieved from /esim/purchase
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :label The new label: letters, numbers and spaces, at most 30 characters. Empty or left out removes the label.
+    # @return [Object]
+    def esim_label_update(transaction_id, opts = {})
+      data, _status_code, _headers = esim_label_update_with_http_info(transaction_id, opts)
+      data
+    end
+
+    # Update eSIM label
+    # Set or clear the label of one of your eSIMs. The label is returned as &#x60;label&#x60; by **View eSIM history**, so you can use it to tell your eSIMs apart.  A label can be up to 30 characters long and may only contain letters, numbers and spaces. Leave &#x60;label&#x60; out, or send it empty, to remove the label.
+    # @param transaction_id [String] transactionId retrieved from /esim/purchase
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :label The new label: letters, numbers and spaces, at most 30 characters. Empty or left out removes the label.
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def esim_label_update_with_http_info(transaction_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ESIMsApi.esim_label_update ...'
+      end
+      # verify the required parameter 'transaction_id' is set
+      if @api_client.config.client_side_validation && transaction_id.nil?
+        fail ArgumentError, "Missing the required parameter 'transaction_id' when calling ESIMsApi.esim_label_update"
+      end
+      # resource path
+      local_var_path = '/esim/label/update'
+
+      # 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['transactionId'] = transaction_id
+      form_params['label'] = opts[:'label'] if !opts[:'label'].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 => :"ESIMsApi.esim_label_update",
+        :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: ESIMsApi#esim_label_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # View eSIM plans per country
+    # @param country [String] ISO 3166 country code
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def esim_plans(country, opts = {})
+      data, _status_code, _headers = esim_plans_with_http_info(country, opts)
+      data
+    end
+
+    # View eSIM plans per country
+    # @param country [String] ISO 3166 country code
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def esim_plans_with_http_info(country, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ESIMsApi.esim_plans ...'
+      end
+      # verify the required parameter 'country' is set
+      if @api_client.config.client_side_validation && country.nil?
+        fail ArgumentError, "Missing the required parameter 'country' when calling ESIMsApi.esim_plans"
+      end
+      # resource path
+      local_var_path = '/esim/plans'
+
+      # 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['country'] = country
+
+      # 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 => :"ESIMsApi.esim_plans",
+        :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: ESIMsApi#esim_plans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # View eSIM countries
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :start Start page
+    # @option opts [Integer] :length Amount of rows per page
+    # @option opts [String] :search Search query for country
+    # @return [Object]
+    def esim_pricing(opts = {})
+      data, _status_code, _headers = esim_pricing_with_http_info(opts)
+      data
+    end
+
+    # View eSIM countries
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :start Start page
+    # @option opts [Integer] :length Amount of rows per page
+    # @option opts [String] :search Search query for country
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def esim_pricing_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ESIMsApi.esim_pricing ...'
+      end
+      # resource path
+      local_var_path = '/esim/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['start'] = opts[:'start'] if !opts[:'start'].nil?
+      form_params['length'] = opts[:'length'] if !opts[:'length'].nil?
+      form_params['search'] = opts[:'search'] if !opts[:'search'].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 => :"ESIMsApi.esim_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: ESIMsApi#esim_pricing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # View eSIM profile
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :transaction_id transactionId retrieved from /esim/purchase
+    # @return [Object]
+    def esim_profile(opts = {})
+      data, _status_code, _headers = esim_profile_with_http_info(opts)
+      data
+    end
+
+    # View eSIM profile
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :transaction_id transactionId retrieved from /esim/purchase
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def esim_profile_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ESIMsApi.esim_profile ...'
+      end
+      # resource path
+      local_var_path = '/esim/profile'
+
+      # 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['transactionId'] = opts[:'transaction_id'] if !opts[:'transaction_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] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ESIMsApi.esim_profile",
+        :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: ESIMsApi#esim_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Purchase eSIM
+    # @param plan [Integer] The plan ID which is obtained from /esim/pricing
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def esim_purchase(plan, opts = {})
+      data, _status_code, _headers = esim_purchase_with_http_info(plan, opts)
+      data
+    end
+
+    # Purchase eSIM
+    # @param plan [Integer] The plan ID which is obtained from /esim/pricing
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def esim_purchase_with_http_info(plan, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ESIMsApi.esim_purchase ...'
+      end
+      # verify the required parameter 'plan' is set
+      if @api_client.config.client_side_validation && plan.nil?
+        fail ArgumentError, "Missing the required parameter 'plan' when calling ESIMsApi.esim_purchase"
+      end
+      # resource path
+      local_var_path = '/esim/purchase'
+
+      # 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['plan'] = plan
+
+      # 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 => :"ESIMsApi.esim_purchase",
+        :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: ESIMsApi#esim_purchase\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Top up eSIM
+    # @param transaction_id [String] Transaction ID retrieved from eSIM history
+    # @param plan [Integer] Topup plan retrieved from \\\&quot;Top Up Plans\\\&quot;
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def esim_topup(transaction_id, plan, opts = {})
+      data, _status_code, _headers = esim_topup_with_http_info(transaction_id, plan, opts)
+      data
+    end
+
+    # Top up eSIM
+    # @param transaction_id [String] Transaction ID retrieved from eSIM history
+    # @param plan [Integer] Topup plan retrieved from \\\&quot;Top Up Plans\\\&quot;
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def esim_topup_with_http_info(transaction_id, plan, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ESIMsApi.esim_topup ...'
+      end
+      # verify the required parameter 'transaction_id' is set
+      if @api_client.config.client_side_validation && transaction_id.nil?
+        fail ArgumentError, "Missing the required parameter 'transaction_id' when calling ESIMsApi.esim_topup"
+      end
+      # verify the required parameter 'plan' is set
+      if @api_client.config.client_side_validation && plan.nil?
+        fail ArgumentError, "Missing the required parameter 'plan' when calling ESIMsApi.esim_topup"
+      end
+      # resource path
+      local_var_path = '/esim/topup'
+
+      # 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['transactionId'] = transaction_id
+      form_params['plan'] = plan
+
+      # 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 => :"ESIMsApi.esim_topup",
+        :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: ESIMsApi#esim_topup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Top Up Plans
+    # @param plan [Integer] &#x60;plan&#x60; retrieved from eSIM history
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def esim_topup_plans(plan, opts = {})
+      data, _status_code, _headers = esim_topup_plans_with_http_info(plan, opts)
+      data
+    end
+
+    # Top Up Plans
+    # @param plan [Integer] &#x60;plan&#x60; retrieved from eSIM history
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def esim_topup_plans_with_http_info(plan, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ESIMsApi.esim_topup_plans ...'
+      end
+      # verify the required parameter 'plan' is set
+      if @api_client.config.client_side_validation && plan.nil?
+        fail ArgumentError, "Missing the required parameter 'plan' when calling ESIMsApi.esim_topup_plans"
+      end
+      # resource path
+      local_var_path = '/esim/topup_plans'
+
+      # 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['plan'] = plan
+
+      # 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 => :"ESIMsApi.esim_topup_plans",
+        :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: ESIMsApi#esim_topup_plans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end