zyphr 0.1.0

data/lib/zyphr/api/sms_api.rb

@@ -0,0 +1,605 @@
+=begin
+#Zyphr API
+
+#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.  ## Authentication  All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:  ``` X-API-Key: zy_live_xxxxxxxxxxxx ```  API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production.  ## Rate Limiting  The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:  - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets  ## Errors  All errors follow a consistent format:  ```json {   \"error\": {     \"code\": \"error_code\",     \"message\": \"Human readable message\",     \"details\": {}   },   \"meta\": {     \"request_id\": \"req_xxxx\"   } } ```
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@zyphr.dev
+Generated by: https://openapi-generator.tech
+Generator version: 7.12.0
+
+=end
+
+require 'cgi'
+
+module Zyphr
+  class SMSApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete SMS configuration
+    # Remove the SMS provider configuration for the workspace.
+    # @param [Hash] opts the optional parameters
+    # @return [SmsConfigDeleteResponse]
+    def delete_sms_config(opts = {})
+      data, _status_code, _headers = delete_sms_config_with_http_info(opts)
+      data
+    end
+
+    # Delete SMS configuration
+    # Remove the SMS provider configuration for the workspace.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SmsConfigDeleteResponse, Integer, Hash)>] SmsConfigDeleteResponse data, response status code and response headers
+    def delete_sms_config_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.delete_sms_config ...'
+      end
+      # resource path
+      local_var_path = '/sms/config'
+
+      # 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] || 'SmsConfigDeleteResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.delete_sms_config",
+        :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: SMSApi#delete_sms_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get SMS message details
+    # Get detailed information about a specific SMS message.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [SmsDetailResponse]
+    def get_sms(id, opts = {})
+      data, _status_code, _headers = get_sms_with_http_info(id, opts)
+      data
+    end
+
+    # Get SMS message details
+    # Get detailed information about a specific SMS message.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SmsDetailResponse, Integer, Hash)>] SmsDetailResponse data, response status code and response headers
+    def get_sms_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.get_sms ...'
+      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 SMSApi.get_sms"
+      end
+      # resource path
+      local_var_path = '/sms/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['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] || 'SmsDetailResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.get_sms",
+        :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: SMSApi#get_sms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get SMS configuration
+    # Get the current SMS provider configuration for the workspace.
+    # @param [Hash] opts the optional parameters
+    # @return [SmsConfigResponse]
+    def get_sms_config(opts = {})
+      data, _status_code, _headers = get_sms_config_with_http_info(opts)
+      data
+    end
+
+    # Get SMS configuration
+    # Get the current SMS provider configuration for the workspace.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SmsConfigResponse, Integer, Hash)>] SmsConfigResponse data, response status code and response headers
+    def get_sms_config_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.get_sms_config ...'
+      end
+      # resource path
+      local_var_path = '/sms/config'
+
+      # 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] || 'SmsConfigResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.get_sms_config",
+        :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: SMSApi#get_sms_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List SMS messages
+    # List SMS messages for the workspace with optional filtering and pagination.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :per_page  (default to 25)
+    # @option opts [String] :status 
+    # @option opts [String] :search Search by phone number or message body
+    # @return [SmsListResponse]
+    def list_sms(opts = {})
+      data, _status_code, _headers = list_sms_with_http_info(opts)
+      data
+    end
+
+    # List SMS messages
+    # List SMS messages for the workspace with optional filtering and pagination.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :per_page  (default to 25)
+    # @option opts [String] :status 
+    # @option opts [String] :search Search by phone number or message body
+    # @return [Array<(SmsListResponse, Integer, Hash)>] SmsListResponse data, response status code and response headers
+    def list_sms_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.list_sms ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling SMSApi.list_sms, must be smaller than or equal to 100.'
+      end
+
+      allowable_values = ["queued", "sending", "sent", "delivered", "undelivered", "failed"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/sms'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['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] || 'SmsListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.list_sms",
+        :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: SMSApi#list_sms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send batch SMS messages
+    # Send SMS messages to multiple recipients (up to 100) in a single request.
+    # @param send_batch_sms_request [SendBatchSmsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SendBatchSmsResponse]
+    def send_batch_sms(send_batch_sms_request, opts = {})
+      data, _status_code, _headers = send_batch_sms_with_http_info(send_batch_sms_request, opts)
+      data
+    end
+
+    # Send batch SMS messages
+    # Send SMS messages to multiple recipients (up to 100) in a single request.
+    # @param send_batch_sms_request [SendBatchSmsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SendBatchSmsResponse, Integer, Hash)>] SendBatchSmsResponse data, response status code and response headers
+    def send_batch_sms_with_http_info(send_batch_sms_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.send_batch_sms ...'
+      end
+      # verify the required parameter 'send_batch_sms_request' is set
+      if @api_client.config.client_side_validation && send_batch_sms_request.nil?
+        fail ArgumentError, "Missing the required parameter 'send_batch_sms_request' when calling SMSApi.send_batch_sms"
+      end
+      # resource path
+      local_var_path = '/sms/batch'
+
+      # 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(send_batch_sms_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SendBatchSmsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.send_batch_sms",
+        :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: SMSApi#send_batch_sms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send an SMS message
+    # Send a single SMS text message. Supports subscriber preference checks and scheduling.
+    # @param send_sms_request [SendSmsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SendSmsResponse]
+    def send_sms(send_sms_request, opts = {})
+      data, _status_code, _headers = send_sms_with_http_info(send_sms_request, opts)
+      data
+    end
+
+    # Send an SMS message
+    # Send a single SMS text message. Supports subscriber preference checks and scheduling.
+    # @param send_sms_request [SendSmsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SendSmsResponse, Integer, Hash)>] SendSmsResponse data, response status code and response headers
+    def send_sms_with_http_info(send_sms_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.send_sms ...'
+      end
+      # verify the required parameter 'send_sms_request' is set
+      if @api_client.config.client_side_validation && send_sms_request.nil?
+        fail ArgumentError, "Missing the required parameter 'send_sms_request' when calling SMSApi.send_sms"
+      end
+      # resource path
+      local_var_path = '/sms'
+
+      # 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(send_sms_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SendSmsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.send_sms",
+        :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: SMSApi#send_sms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send a test SMS
+    # Send a test SMS message to verify the provider configuration is working.
+    # @param send_test_sms_request [SendTestSmsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SendTestSmsResponse]
+    def send_test_sms(send_test_sms_request, opts = {})
+      data, _status_code, _headers = send_test_sms_with_http_info(send_test_sms_request, opts)
+      data
+    end
+
+    # Send a test SMS
+    # Send a test SMS message to verify the provider configuration is working.
+    # @param send_test_sms_request [SendTestSmsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SendTestSmsResponse, Integer, Hash)>] SendTestSmsResponse data, response status code and response headers
+    def send_test_sms_with_http_info(send_test_sms_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.send_test_sms ...'
+      end
+      # verify the required parameter 'send_test_sms_request' is set
+      if @api_client.config.client_side_validation && send_test_sms_request.nil?
+        fail ArgumentError, "Missing the required parameter 'send_test_sms_request' when calling SMSApi.send_test_sms"
+      end
+      # resource path
+      local_var_path = '/sms/test'
+
+      # 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(send_test_sms_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SendTestSmsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.send_test_sms",
+        :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: SMSApi#send_test_sms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create or update SMS configuration
+    # Set up or update the SMS provider configuration (Twilio) for the workspace. Automatically verifies credentials.
+    # @param upsert_sms_config_request [UpsertSmsConfigRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SmsConfigResponse]
+    def upsert_sms_config(upsert_sms_config_request, opts = {})
+      data, _status_code, _headers = upsert_sms_config_with_http_info(upsert_sms_config_request, opts)
+      data
+    end
+
+    # Create or update SMS configuration
+    # Set up or update the SMS provider configuration (Twilio) for the workspace. Automatically verifies credentials.
+    # @param upsert_sms_config_request [UpsertSmsConfigRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SmsConfigResponse, Integer, Hash)>] SmsConfigResponse data, response status code and response headers
+    def upsert_sms_config_with_http_info(upsert_sms_config_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.upsert_sms_config ...'
+      end
+      # verify the required parameter 'upsert_sms_config_request' is set
+      if @api_client.config.client_side_validation && upsert_sms_config_request.nil?
+        fail ArgumentError, "Missing the required parameter 'upsert_sms_config_request' when calling SMSApi.upsert_sms_config"
+      end
+      # resource path
+      local_var_path = '/sms/config'
+
+      # 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(upsert_sms_config_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SmsConfigResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.upsert_sms_config",
+        :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: SMSApi#upsert_sms_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Verify SMS configuration
+    # Verify the SMS provider credentials are valid and working.
+    # @param [Hash] opts the optional parameters
+    # @return [VerifySmsConfigResponse]
+    def verify_sms_config(opts = {})
+      data, _status_code, _headers = verify_sms_config_with_http_info(opts)
+      data
+    end
+
+    # Verify SMS configuration
+    # Verify the SMS provider credentials are valid and working.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(VerifySmsConfigResponse, Integer, Hash)>] VerifySmsConfigResponse data, response status code and response headers
+    def verify_sms_config_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.verify_sms_config ...'
+      end
+      # resource path
+      local_var_path = '/sms/config/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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'VerifySmsConfigResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.verify_sms_config",
+        :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: SMSApi#verify_sms_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end