agent_push_kit 0.1.0

data/lib/agent_push_kit/api/preferences_api.rb

@@ -0,0 +1,308 @@
+=begin
+#Agent Push Kit API
+
+#The complete Agent Push Kit REST API. Application event ingestion uses an organization key beginning with `apk_`. Authenticated user operations accept either an Agent Push Kit login JWT or an agent access token beginning with `apt_`.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'cgi'
+
+module AgentPushKit
+  class PreferencesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List service defaults and exact-type overrides
+    # @param organization_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<ServicePreference>]
+    def list_preferences(organization_id, opts = {})
+      data, _status_code, _headers = list_preferences_with_http_info(organization_id, opts)
+      data
+    end
+
+    # List service defaults and exact-type overrides
+    # @param organization_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<ServicePreference>, Integer, Hash)>] Array<ServicePreference> data, response status code and response headers
+    def list_preferences_with_http_info(organization_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PreferencesApi.list_preferences ...'
+      end
+      # verify the required parameter 'organization_id' is set
+      if @api_client.config.client_side_validation && organization_id.nil?
+        fail ArgumentError, "Missing the required parameter 'organization_id' when calling PreferencesApi.list_preferences"
+      end
+      # resource path
+      local_var_path = '/organizations/{organizationId}/preferences'.sub('{organizationId}', CGI.escape(organization_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] || 'Array<ServicePreference>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserOrAgent']
+
+      new_options = opts.merge(
+        :operation => :"PreferencesApi.list_preferences",
+        :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: PreferencesApi#list_preferences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Remove an exact-type override so it inherits the service default
+    # @param service_id [String] 
+    # @param type [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [InheritedResponse]
+    def remove_type_preference(service_id, type, opts = {})
+      data, _status_code, _headers = remove_type_preference_with_http_info(service_id, type, opts)
+      data
+    end
+
+    # Remove an exact-type override so it inherits the service default
+    # @param service_id [String] 
+    # @param type [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InheritedResponse, Integer, Hash)>] InheritedResponse data, response status code and response headers
+    def remove_type_preference_with_http_info(service_id, type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PreferencesApi.remove_type_preference ...'
+      end
+      # verify the required parameter 'service_id' is set
+      if @api_client.config.client_side_validation && service_id.nil?
+        fail ArgumentError, "Missing the required parameter 'service_id' when calling PreferencesApi.remove_type_preference"
+      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 PreferencesApi.remove_type_preference"
+      end
+      if @api_client.config.client_side_validation && type.to_s.length > 120
+        fail ArgumentError, 'invalid value for "type" when calling PreferencesApi.remove_type_preference, the character length must be smaller than or equal to 120.'
+      end
+
+      # resource path
+      local_var_path = '/services/{serviceId}/types/{type}/preference'.sub('{serviceId}', CGI.escape(service_id.to_s)).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] || 'InheritedResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserOrAgent']
+
+      new_options = opts.merge(
+        :operation => :"PreferencesApi.remove_type_preference",
+        :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: PreferencesApi#remove_type_preference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Enable or disable pushes for a service by default
+    # @param service_id [String] 
+    # @param set_enabled_input [SetEnabledInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [PreferenceRecord]
+    def set_service_preference(service_id, set_enabled_input, opts = {})
+      data, _status_code, _headers = set_service_preference_with_http_info(service_id, set_enabled_input, opts)
+      data
+    end
+
+    # Enable or disable pushes for a service by default
+    # @param service_id [String] 
+    # @param set_enabled_input [SetEnabledInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PreferenceRecord, Integer, Hash)>] PreferenceRecord data, response status code and response headers
+    def set_service_preference_with_http_info(service_id, set_enabled_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PreferencesApi.set_service_preference ...'
+      end
+      # verify the required parameter 'service_id' is set
+      if @api_client.config.client_side_validation && service_id.nil?
+        fail ArgumentError, "Missing the required parameter 'service_id' when calling PreferencesApi.set_service_preference"
+      end
+      # verify the required parameter 'set_enabled_input' is set
+      if @api_client.config.client_side_validation && set_enabled_input.nil?
+        fail ArgumentError, "Missing the required parameter 'set_enabled_input' when calling PreferencesApi.set_service_preference"
+      end
+      # resource path
+      local_var_path = '/services/{serviceId}/preference'.sub('{serviceId}', CGI.escape(service_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(set_enabled_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PreferenceRecord'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserOrAgent']
+
+      new_options = opts.merge(
+        :operation => :"PreferencesApi.set_service_preference",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PreferencesApi#set_service_preference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Override push delivery for one exact notification type
+    # @param service_id [String] 
+    # @param type [String] 
+    # @param set_enabled_input [SetEnabledInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [PreferenceRecord]
+    def set_type_preference(service_id, type, set_enabled_input, opts = {})
+      data, _status_code, _headers = set_type_preference_with_http_info(service_id, type, set_enabled_input, opts)
+      data
+    end
+
+    # Override push delivery for one exact notification type
+    # @param service_id [String] 
+    # @param type [String] 
+    # @param set_enabled_input [SetEnabledInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PreferenceRecord, Integer, Hash)>] PreferenceRecord data, response status code and response headers
+    def set_type_preference_with_http_info(service_id, type, set_enabled_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PreferencesApi.set_type_preference ...'
+      end
+      # verify the required parameter 'service_id' is set
+      if @api_client.config.client_side_validation && service_id.nil?
+        fail ArgumentError, "Missing the required parameter 'service_id' when calling PreferencesApi.set_type_preference"
+      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 PreferencesApi.set_type_preference"
+      end
+      if @api_client.config.client_side_validation && type.to_s.length > 120
+        fail ArgumentError, 'invalid value for "type" when calling PreferencesApi.set_type_preference, the character length must be smaller than or equal to 120.'
+      end
+
+      # verify the required parameter 'set_enabled_input' is set
+      if @api_client.config.client_side_validation && set_enabled_input.nil?
+        fail ArgumentError, "Missing the required parameter 'set_enabled_input' when calling PreferencesApi.set_type_preference"
+      end
+      # resource path
+      local_var_path = '/services/{serviceId}/types/{type}/preference'.sub('{serviceId}', CGI.escape(service_id.to_s)).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']
+      # 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(set_enabled_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PreferenceRecord'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserOrAgent']
+
+      new_options = opts.merge(
+        :operation => :"PreferencesApi.set_type_preference",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PreferencesApi#set_type_preference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end