zyphr 0.1.0

data/lib/zyphr/api/push_api.rb

@@ -0,0 +1,644 @@
+=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 PushApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get push notification details
+    # Get a specific push notification message with delivery events.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [PushDetailResponse]
+    def get_push(id, opts = {})
+      data, _status_code, _headers = get_push_with_http_info(id, opts)
+      data
+    end
+
+    # Get push notification details
+    # Get a specific push notification message with delivery events.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PushDetailResponse, Integer, Hash)>] PushDetailResponse data, response status code and response headers
+    def get_push_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PushApi.get_push ...'
+      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 PushApi.get_push"
+      end
+      # resource path
+      local_var_path = '/push/{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] || 'PushDetailResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PushApi.get_push",
+        :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: PushApi#get_push\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get push notification statistics
+    # Get aggregated push notification statistics for the workspace.
+    # @param [Hash] opts the optional parameters
+    # @return [PushStatsResponse]
+    def get_push_stats(opts = {})
+      data, _status_code, _headers = get_push_stats_with_http_info(opts)
+      data
+    end
+
+    # Get push notification statistics
+    # Get aggregated push notification statistics for the workspace.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PushStatsResponse, Integer, Hash)>] PushStatsResponse data, response status code and response headers
+    def get_push_stats_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PushApi.get_push_stats ...'
+      end
+      # resource path
+      local_var_path = '/push/stats'
+
+      # 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] || 'PushStatsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PushApi.get_push_stats",
+        :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: PushApi#get_push_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List topics for a device
+    # Get all push notification topics a specific device is subscribed to.
+    # @param id [String] Device ID
+    # @param [Hash] opts the optional parameters
+    # @return [DevicePushTopicListResponse]
+    def list_device_push_topics(id, opts = {})
+      data, _status_code, _headers = list_device_push_topics_with_http_info(id, opts)
+      data
+    end
+
+    # List topics for a device
+    # Get all push notification topics a specific device is subscribed to.
+    # @param id [String] Device ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DevicePushTopicListResponse, Integer, Hash)>] DevicePushTopicListResponse data, response status code and response headers
+    def list_device_push_topics_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PushApi.list_device_push_topics ...'
+      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 PushApi.list_device_push_topics"
+      end
+      # resource path
+      local_var_path = '/push/devices/{id}/topics'.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] || 'DevicePushTopicListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PushApi.list_device_push_topics",
+        :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: PushApi#list_device_push_topics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List push notifications
+    # List push notification messages for the workspace with optional filtering.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :user_id Filter by subscriber/user ID
+    # @option opts [String] :device_id Filter by device ID
+    # @option opts [String] :status Filter by message status
+    # @option opts [Integer] :limit Maximum number of results (default to 50)
+    # @option opts [Integer] :offset Number of results to skip (default to 0)
+    # @return [PushListResponse]
+    def list_push(opts = {})
+      data, _status_code, _headers = list_push_with_http_info(opts)
+      data
+    end
+
+    # List push notifications
+    # List push notification messages for the workspace with optional filtering.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :user_id Filter by subscriber/user ID
+    # @option opts [String] :device_id Filter by device ID
+    # @option opts [String] :status Filter by message status
+    # @option opts [Integer] :limit Maximum number of results (default to 50)
+    # @option opts [Integer] :offset Number of results to skip (default to 0)
+    # @return [Array<(PushListResponse, Integer, Hash)>] PushListResponse data, response status code and response headers
+    def list_push_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PushApi.list_push ...'
+      end
+      allowable_values = ["pending", "queued", "sent", "delivered", "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 = '/push'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'user_id'] = opts[:'user_id'] if !opts[:'user_id'].nil?
+      query_params[:'device_id'] = opts[:'device_id'] if !opts[:'device_id'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'PushListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PushApi.list_push",
+        :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: PushApi#list_push\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List devices subscribed to a topic
+    # Get all devices subscribed to a push notification topic with pagination.
+    # @param key [String] Topic key
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Maximum number of results (default to 100)
+    # @option opts [Integer] :offset Number of results to skip (default to 0)
+    # @return [PushTopicDeviceListResponse]
+    def list_push_topic_devices(key, opts = {})
+      data, _status_code, _headers = list_push_topic_devices_with_http_info(key, opts)
+      data
+    end
+
+    # List devices subscribed to a topic
+    # Get all devices subscribed to a push notification topic with pagination.
+    # @param key [String] Topic key
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Maximum number of results (default to 100)
+    # @option opts [Integer] :offset Number of results to skip (default to 0)
+    # @return [Array<(PushTopicDeviceListResponse, Integer, Hash)>] PushTopicDeviceListResponse data, response status code and response headers
+    def list_push_topic_devices_with_http_info(key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PushApi.list_push_topic_devices ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling PushApi.list_push_topic_devices"
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PushApi.list_push_topic_devices, must be smaller than or equal to 1000.'
+      end
+
+      # resource path
+      local_var_path = '/push/topics/{key}/devices'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'PushTopicDeviceListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PushApi.list_push_topic_devices",
+        :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: PushApi#list_push_topic_devices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send a push notification
+    # Send a push notification to a specific device, multiple devices, all devices for a subscriber, or to a topic. Supports scheduling via `send_at` or `delay`. 
+    # @param send_push_request [SendPushRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SendPushResponse]
+    def send_push(send_push_request, opts = {})
+      data, _status_code, _headers = send_push_with_http_info(send_push_request, opts)
+      data
+    end
+
+    # Send a push notification
+    # Send a push notification to a specific device, multiple devices, all devices for a subscriber, or to a topic. Supports scheduling via &#x60;send_at&#x60; or &#x60;delay&#x60;. 
+    # @param send_push_request [SendPushRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SendPushResponse, Integer, Hash)>] SendPushResponse data, response status code and response headers
+    def send_push_with_http_info(send_push_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PushApi.send_push ...'
+      end
+      # verify the required parameter 'send_push_request' is set
+      if @api_client.config.client_side_validation && send_push_request.nil?
+        fail ArgumentError, "Missing the required parameter 'send_push_request' when calling PushApi.send_push"
+      end
+      # resource path
+      local_var_path = '/push'
+
+      # 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_push_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SendPushResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PushApi.send_push",
+        :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: PushApi#send_push\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send push notification to a topic
+    # Send a push notification to all devices subscribed to a topic.
+    # @param key [String] Topic key
+    # @param send_push_to_topic_request [SendPushToTopicRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SendPushToTopicResponse]
+    def send_push_to_topic(key, send_push_to_topic_request, opts = {})
+      data, _status_code, _headers = send_push_to_topic_with_http_info(key, send_push_to_topic_request, opts)
+      data
+    end
+
+    # Send push notification to a topic
+    # Send a push notification to all devices subscribed to a topic.
+    # @param key [String] Topic key
+    # @param send_push_to_topic_request [SendPushToTopicRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SendPushToTopicResponse, Integer, Hash)>] SendPushToTopicResponse data, response status code and response headers
+    def send_push_to_topic_with_http_info(key, send_push_to_topic_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PushApi.send_push_to_topic ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling PushApi.send_push_to_topic"
+      end
+      # verify the required parameter 'send_push_to_topic_request' is set
+      if @api_client.config.client_side_validation && send_push_to_topic_request.nil?
+        fail ArgumentError, "Missing the required parameter 'send_push_to_topic_request' when calling PushApi.send_push_to_topic"
+      end
+      # resource path
+      local_var_path = '/push/topics/{key}/send'.sub('{' + 'key' + '}', CGI.escape(key.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(send_push_to_topic_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SendPushToTopicResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PushApi.send_push_to_topic",
+        :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: PushApi#send_push_to_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Subscribe devices to a push topic
+    # Subscribe one or more devices to a push notification topic. Maximum 100 devices per request.
+    # @param key [String] Topic key
+    # @param subscribe_push_topic_request [SubscribePushTopicRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [PushTopicSubscribeResponse]
+    def subscribe_push_topic(key, subscribe_push_topic_request, opts = {})
+      data, _status_code, _headers = subscribe_push_topic_with_http_info(key, subscribe_push_topic_request, opts)
+      data
+    end
+
+    # Subscribe devices to a push topic
+    # Subscribe one or more devices to a push notification topic. Maximum 100 devices per request.
+    # @param key [String] Topic key
+    # @param subscribe_push_topic_request [SubscribePushTopicRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PushTopicSubscribeResponse, Integer, Hash)>] PushTopicSubscribeResponse data, response status code and response headers
+    def subscribe_push_topic_with_http_info(key, subscribe_push_topic_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PushApi.subscribe_push_topic ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling PushApi.subscribe_push_topic"
+      end
+      # verify the required parameter 'subscribe_push_topic_request' is set
+      if @api_client.config.client_side_validation && subscribe_push_topic_request.nil?
+        fail ArgumentError, "Missing the required parameter 'subscribe_push_topic_request' when calling PushApi.subscribe_push_topic"
+      end
+      # resource path
+      local_var_path = '/push/topics/{key}/subscribe'.sub('{' + 'key' + '}', CGI.escape(key.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(subscribe_push_topic_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PushTopicSubscribeResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PushApi.subscribe_push_topic",
+        :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: PushApi#subscribe_push_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Unsubscribe devices from a push topic
+    # Unsubscribe one or more devices from a push notification topic. Maximum 100 devices per request.
+    # @param key [String] Topic key
+    # @param subscribe_push_topic_request [SubscribePushTopicRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [PushTopicUnsubscribeResponse]
+    def unsubscribe_push_topic(key, subscribe_push_topic_request, opts = {})
+      data, _status_code, _headers = unsubscribe_push_topic_with_http_info(key, subscribe_push_topic_request, opts)
+      data
+    end
+
+    # Unsubscribe devices from a push topic
+    # Unsubscribe one or more devices from a push notification topic. Maximum 100 devices per request.
+    # @param key [String] Topic key
+    # @param subscribe_push_topic_request [SubscribePushTopicRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PushTopicUnsubscribeResponse, Integer, Hash)>] PushTopicUnsubscribeResponse data, response status code and response headers
+    def unsubscribe_push_topic_with_http_info(key, subscribe_push_topic_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PushApi.unsubscribe_push_topic ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling PushApi.unsubscribe_push_topic"
+      end
+      # verify the required parameter 'subscribe_push_topic_request' is set
+      if @api_client.config.client_side_validation && subscribe_push_topic_request.nil?
+        fail ArgumentError, "Missing the required parameter 'subscribe_push_topic_request' when calling PushApi.unsubscribe_push_topic"
+      end
+      # resource path
+      local_var_path = '/push/topics/{key}/unsubscribe'.sub('{' + 'key' + '}', CGI.escape(key.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(subscribe_push_topic_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PushTopicUnsubscribeResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PushApi.unsubscribe_push_topic",
+        :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: PushApi#unsubscribe_push_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end