zyphr 0.1.0

data/lib/zyphr/api/inbox_api.rb

@@ -0,0 +1,650 @@
+=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 InboxApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Archive a notification
+    # Archive a specific in-app notification.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [MarkInboxReadRequest] :mark_inbox_read_request 
+    # @return [InboxNotificationResponse]
+    def archive_inbox_notification(id, opts = {})
+      data, _status_code, _headers = archive_inbox_notification_with_http_info(id, opts)
+      data
+    end
+
+    # Archive a notification
+    # Archive a specific in-app notification.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [MarkInboxReadRequest] :mark_inbox_read_request 
+    # @return [Array<(InboxNotificationResponse, Integer, Hash)>] InboxNotificationResponse data, response status code and response headers
+    def archive_inbox_notification_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxApi.archive_inbox_notification ...'
+      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 InboxApi.archive_inbox_notification"
+      end
+      # resource path
+      local_var_path = '/inbox/{id}/archive'.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']
+      # 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(opts[:'mark_inbox_read_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InboxNotificationResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InboxApi.archive_inbox_notification",
+        :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: InboxApi#archive_inbox_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a notification
+    # Permanently delete an in-app notification.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :subscriber_id 
+    # @option opts [String] :external_id 
+    # @return [nil]
+    def delete_inbox_notification(id, opts = {})
+      delete_inbox_notification_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete a notification
+    # Permanently delete an in-app notification.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :subscriber_id 
+    # @option opts [String] :external_id 
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_inbox_notification_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxApi.delete_inbox_notification ...'
+      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 InboxApi.delete_inbox_notification"
+      end
+      # resource path
+      local_var_path = '/inbox/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'subscriber_id'] = opts[:'subscriber_id'] if !opts[:'subscriber_id'].nil?
+      query_params[:'external_id'] = opts[:'external_id'] if !opts[:'external_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InboxApi.delete_inbox_notification",
+        :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: InboxApi#delete_inbox_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a notification
+    # Get a specific in-app notification by ID.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :subscriber_id 
+    # @option opts [String] :external_id 
+    # @return [InboxNotificationResponse]
+    def get_inbox_notification(id, opts = {})
+      data, _status_code, _headers = get_inbox_notification_with_http_info(id, opts)
+      data
+    end
+
+    # Get a notification
+    # Get a specific in-app notification by ID.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :subscriber_id 
+    # @option opts [String] :external_id 
+    # @return [Array<(InboxNotificationResponse, Integer, Hash)>] InboxNotificationResponse data, response status code and response headers
+    def get_inbox_notification_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxApi.get_inbox_notification ...'
+      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 InboxApi.get_inbox_notification"
+      end
+      # resource path
+      local_var_path = '/inbox/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'subscriber_id'] = opts[:'subscriber_id'] if !opts[:'subscriber_id'].nil?
+      query_params[:'external_id'] = opts[:'external_id'] if !opts[:'external_id'].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] || 'InboxNotificationResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InboxApi.get_inbox_notification",
+        :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: InboxApi#get_inbox_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get unread notification count
+    # Get the count of unread in-app notifications for a subscriber.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :subscriber_id 
+    # @option opts [String] :external_id 
+    # @return [UnreadCountResponse]
+    def get_unread_count(opts = {})
+      data, _status_code, _headers = get_unread_count_with_http_info(opts)
+      data
+    end
+
+    # Get unread notification count
+    # Get the count of unread in-app notifications for a subscriber.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :subscriber_id 
+    # @option opts [String] :external_id 
+    # @return [Array<(UnreadCountResponse, Integer, Hash)>] UnreadCountResponse data, response status code and response headers
+    def get_unread_count_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxApi.get_unread_count ...'
+      end
+      # resource path
+      local_var_path = '/inbox/unread-count'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'subscriber_id'] = opts[:'subscriber_id'] if !opts[:'subscriber_id'].nil?
+      query_params[:'external_id'] = opts[:'external_id'] if !opts[:'external_id'].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] || 'UnreadCountResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InboxApi.get_unread_count",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InboxApi#get_unread_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List inbox notifications
+    # Retrieve in-app notifications for a subscriber. Requires subscriber_id or external_id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :subscriber_id Subscriber ID
+    # @option opts [String] :external_id Subscriber external ID
+    # @option opts [String] :category Filter by notification category
+    # @option opts [Boolean] :include_read  (default to false)
+    # @option opts [Boolean] :include_archived  (default to false)
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [Integer] :offset  (default to 0)
+    # @option opts [String] :cursor Cursor for pagination
+    # @return [InboxListResponse]
+    def list_inbox(opts = {})
+      data, _status_code, _headers = list_inbox_with_http_info(opts)
+      data
+    end
+
+    # List inbox notifications
+    # Retrieve in-app notifications for a subscriber. Requires subscriber_id or external_id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :subscriber_id Subscriber ID
+    # @option opts [String] :external_id Subscriber external ID
+    # @option opts [String] :category Filter by notification category
+    # @option opts [Boolean] :include_read  (default to false)
+    # @option opts [Boolean] :include_archived  (default to false)
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [Integer] :offset  (default to 0)
+    # @option opts [String] :cursor Cursor for pagination
+    # @return [Array<(InboxListResponse, Integer, Hash)>] InboxListResponse data, response status code and response headers
+    def list_inbox_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxApi.list_inbox ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InboxApi.list_inbox, must be smaller than or equal to 100.'
+      end
+
+      # resource path
+      local_var_path = '/inbox'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'subscriber_id'] = opts[:'subscriber_id'] if !opts[:'subscriber_id'].nil?
+      query_params[:'external_id'] = opts[:'external_id'] if !opts[:'external_id'].nil?
+      query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
+      query_params[:'include_read'] = opts[:'include_read'] if !opts[:'include_read'].nil?
+      query_params[:'include_archived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].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] || 'InboxListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InboxApi.list_inbox",
+        :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: InboxApi#list_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Mark all notifications as read
+    # Mark all unread in-app notifications as read for a subscriber. Optionally filter by category.
+    # @param mark_all_inbox_read_request [MarkAllInboxReadRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [MarkAllReadResponse]
+    def mark_all_inbox_read(mark_all_inbox_read_request, opts = {})
+      data, _status_code, _headers = mark_all_inbox_read_with_http_info(mark_all_inbox_read_request, opts)
+      data
+    end
+
+    # Mark all notifications as read
+    # Mark all unread in-app notifications as read for a subscriber. Optionally filter by category.
+    # @param mark_all_inbox_read_request [MarkAllInboxReadRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MarkAllReadResponse, Integer, Hash)>] MarkAllReadResponse data, response status code and response headers
+    def mark_all_inbox_read_with_http_info(mark_all_inbox_read_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxApi.mark_all_inbox_read ...'
+      end
+      # verify the required parameter 'mark_all_inbox_read_request' is set
+      if @api_client.config.client_side_validation && mark_all_inbox_read_request.nil?
+        fail ArgumentError, "Missing the required parameter 'mark_all_inbox_read_request' when calling InboxApi.mark_all_inbox_read"
+      end
+      # resource path
+      local_var_path = '/inbox/read-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/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(mark_all_inbox_read_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MarkAllReadResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InboxApi.mark_all_inbox_read",
+        :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: InboxApi#mark_all_inbox_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Mark notification as read
+    # Mark a specific in-app notification as read.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [MarkInboxReadRequest] :mark_inbox_read_request 
+    # @return [InboxNotificationResponse]
+    def mark_inbox_read(id, opts = {})
+      data, _status_code, _headers = mark_inbox_read_with_http_info(id, opts)
+      data
+    end
+
+    # Mark notification as read
+    # Mark a specific in-app notification as read.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [MarkInboxReadRequest] :mark_inbox_read_request 
+    # @return [Array<(InboxNotificationResponse, Integer, Hash)>] InboxNotificationResponse data, response status code and response headers
+    def mark_inbox_read_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxApi.mark_inbox_read ...'
+      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 InboxApi.mark_inbox_read"
+      end
+      # resource path
+      local_var_path = '/inbox/{id}/read'.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']
+      # 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(opts[:'mark_inbox_read_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InboxNotificationResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InboxApi.mark_inbox_read",
+        :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: InboxApi#mark_inbox_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send batch in-app notifications
+    # Send in-app notifications to multiple subscribers in a single request (max 100).
+    # @param send_batch_in_app_request [SendBatchInAppRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SendBatchInAppResponse]
+    def send_batch_in_app(send_batch_in_app_request, opts = {})
+      data, _status_code, _headers = send_batch_in_app_with_http_info(send_batch_in_app_request, opts)
+      data
+    end
+
+    # Send batch in-app notifications
+    # Send in-app notifications to multiple subscribers in a single request (max 100).
+    # @param send_batch_in_app_request [SendBatchInAppRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SendBatchInAppResponse, Integer, Hash)>] SendBatchInAppResponse data, response status code and response headers
+    def send_batch_in_app_with_http_info(send_batch_in_app_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxApi.send_batch_in_app ...'
+      end
+      # verify the required parameter 'send_batch_in_app_request' is set
+      if @api_client.config.client_side_validation && send_batch_in_app_request.nil?
+        fail ArgumentError, "Missing the required parameter 'send_batch_in_app_request' when calling InboxApi.send_batch_in_app"
+      end
+      # resource path
+      local_var_path = '/inbox/send/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_in_app_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SendBatchInAppResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InboxApi.send_batch_in_app",
+        :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: InboxApi#send_batch_in_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send an in-app notification
+    # Create and deliver an in-app notification to a subscriber. Checks subscriber preferences before delivery.
+    # @param send_in_app_request [SendInAppRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SendInAppResponse]
+    def send_in_app(send_in_app_request, opts = {})
+      data, _status_code, _headers = send_in_app_with_http_info(send_in_app_request, opts)
+      data
+    end
+
+    # Send an in-app notification
+    # Create and deliver an in-app notification to a subscriber. Checks subscriber preferences before delivery.
+    # @param send_in_app_request [SendInAppRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SendInAppResponse, Integer, Hash)>] SendInAppResponse data, response status code and response headers
+    def send_in_app_with_http_info(send_in_app_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxApi.send_in_app ...'
+      end
+      # verify the required parameter 'send_in_app_request' is set
+      if @api_client.config.client_side_validation && send_in_app_request.nil?
+        fail ArgumentError, "Missing the required parameter 'send_in_app_request' when calling InboxApi.send_in_app"
+      end
+      # resource path
+      local_var_path = '/inbox/send'
+
+      # 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_in_app_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SendInAppResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InboxApi.send_in_app",
+        :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: InboxApi#send_in_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end