pingram 1.0.14 → 1.0.17

data/lib/pingram/api/profile_api.rb

@@ -150,5 +150,319 @@ module Pingram
       end
       return data, status_code, headers
     end
+
+    # Permanently delete the authenticated user's account
+    # @param delete_account_request [DeleteAccountRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessResponse]
+    def profile_delete_account(delete_account_request, opts = {})
+      data, _status_code, _headers = profile_delete_account_with_http_info(delete_account_request, opts)
+      data
+    end
+
+    # Permanently delete the authenticated user's account
+    # @param delete_account_request [DeleteAccountRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessResponse, Integer, Hash)>] SuccessResponse data, response status code and response headers
+    def profile_delete_account_with_http_info(delete_account_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProfileApi.profile_delete_account ...'
+      end
+      # verify the required parameter 'delete_account_request' is set
+      if @api_client.config.client_side_validation && delete_account_request.nil?
+        fail ArgumentError, "Missing the required parameter 'delete_account_request' when calling ProfileApi.profile_delete_account"
+      end
+      # resource path
+      local_var_path = '/profile/delete-account'
+
+      # 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/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(delete_account_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuccessResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"ProfileApi.profile_delete_account",
+        :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: ProfileApi#profile_delete_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Disable MFA for the authenticated user
+    # @param type [String] MFA type (e.g. SOFTWARE_TOKEN_MFA)
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessResponse]
+    def profile_disable_mfa(type, opts = {})
+      data, _status_code, _headers = profile_disable_mfa_with_http_info(type, opts)
+      data
+    end
+
+    # Disable MFA for the authenticated user
+    # @param type [String] MFA type (e.g. SOFTWARE_TOKEN_MFA)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessResponse, Integer, Hash)>] SuccessResponse data, response status code and response headers
+    def profile_disable_mfa_with_http_info(type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProfileApi.profile_disable_mfa ...'
+      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 ProfileApi.profile_disable_mfa"
+      end
+      # resource path
+      local_var_path = '/profile/mfa/{type}'.sub('{' + 'type' + '}', CGI.escape(type.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['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] || 'SuccessResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"ProfileApi.profile_disable_mfa",
+        :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: ProfileApi#profile_disable_mfa\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get MFA status for the authenticated user
+    # @param [Hash] opts the optional parameters
+    # @return [MFAStatusResponse]
+    def profile_get_mfa_status(opts = {})
+      data, _status_code, _headers = profile_get_mfa_status_with_http_info(opts)
+      data
+    end
+
+    # Get MFA status for the authenticated user
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MFAStatusResponse, Integer, Hash)>] MFAStatusResponse data, response status code and response headers
+    def profile_get_mfa_status_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProfileApi.profile_get_mfa_status ...'
+      end
+      # resource path
+      local_var_path = '/profile/mfa'
+
+      # 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] || 'MFAStatusResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"ProfileApi.profile_get_mfa_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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProfileApi#profile_get_mfa_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Start TOTP MFA setup and return QR code data
+    # @param mfa_setup_request [MFASetupRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [MFASetupResponse]
+    def profile_setup_mfa(mfa_setup_request, opts = {})
+      data, _status_code, _headers = profile_setup_mfa_with_http_info(mfa_setup_request, opts)
+      data
+    end
+
+    # Start TOTP MFA setup and return QR code data
+    # @param mfa_setup_request [MFASetupRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MFASetupResponse, Integer, Hash)>] MFASetupResponse data, response status code and response headers
+    def profile_setup_mfa_with_http_info(mfa_setup_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProfileApi.profile_setup_mfa ...'
+      end
+      # verify the required parameter 'mfa_setup_request' is set
+      if @api_client.config.client_side_validation && mfa_setup_request.nil?
+        fail ArgumentError, "Missing the required parameter 'mfa_setup_request' when calling ProfileApi.profile_setup_mfa"
+      end
+      # resource path
+      local_var_path = '/profile/mfa'
+
+      # 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/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(mfa_setup_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MFASetupResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"ProfileApi.profile_setup_mfa",
+        :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: ProfileApi#profile_setup_mfa\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Verify TOTP code and enable MFA
+    # @param mfa_verify_request [MFAVerifyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessResponse]
+    def profile_verify_mfa(mfa_verify_request, opts = {})
+      data, _status_code, _headers = profile_verify_mfa_with_http_info(mfa_verify_request, opts)
+      data
+    end
+
+    # Verify TOTP code and enable MFA
+    # @param mfa_verify_request [MFAVerifyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessResponse, Integer, Hash)>] SuccessResponse data, response status code and response headers
+    def profile_verify_mfa_with_http_info(mfa_verify_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProfileApi.profile_verify_mfa ...'
+      end
+      # verify the required parameter 'mfa_verify_request' is set
+      if @api_client.config.client_side_validation && mfa_verify_request.nil?
+        fail ArgumentError, "Missing the required parameter 'mfa_verify_request' when calling ProfileApi.profile_verify_mfa"
+      end
+      # resource path
+      local_var_path = '/profile/mfa/verify'
+
+      # 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/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(mfa_verify_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuccessResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"ProfileApi.profile_verify_mfa",
+        :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: ProfileApi#profile_verify_mfa\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/pingram/api/sms_api.rb

@@ -19,7 +19,7 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Send an SMS or MMS notification directly without templates
+    # Send an SMS or MMS directly without a template. Requires `type` and `to`. Pass `message` and/or `mediaUrls`. Optional: `from`, `schedule`.
     # @param send_sms_request [SendSmsRequest] 
     # @param [Hash] opts the optional parameters
     # @return [SendSmsResponse]
@@ -28,7 +28,7 @@ module Pingram
       data
     end
 
-    # Send an SMS or MMS notification directly without templates
+    # Send an SMS or MMS directly without a template. Requires `type` and `to`. Pass `message` and/or `mediaUrls`. Optional: `from`, `schedule`.
     # @param send_sms_request [SendSmsRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SendSmsResponse, Integer, Hash)>] SendSmsResponse data, response status code and response headers