pingram 0.1.0

data/lib/pingram/api/user_api.rb

@@ -0,0 +1,587 @@
+=begin
+#NotificationAPI
+
+#Internal API for notification delivery and management
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'cgi'
+
+module Pingram
+  class UserApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Complete Slack OAuth flow and store access token for user
+    # @param user_id [String] User ID
+    # @param slack_oauth_request [SlackOauthRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def user_generate_slack_oauth_path(user_id, slack_oauth_request, opts = {})
+      user_generate_slack_oauth_path_with_http_info(user_id, slack_oauth_request, opts)
+      nil
+    end
+
+    # Complete Slack OAuth flow and store access token for user
+    # @param user_id [String] User ID
+    # @param slack_oauth_request [SlackOauthRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def user_generate_slack_oauth_path_with_http_info(user_id, slack_oauth_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserApi.user_generate_slack_oauth_path ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling UserApi.user_generate_slack_oauth_path"
+      end
+      # verify the required parameter 'slack_oauth_request' is set
+      if @api_client.config.client_side_validation && slack_oauth_request.nil?
+        fail ArgumentError, "Missing the required parameter 'slack_oauth_request' when calling UserApi.user_generate_slack_oauth_path"
+      end
+      # resource path
+      local_var_path = '/users/{userId}/slack-oauth'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # 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(slack_oauth_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"UserApi.user_generate_slack_oauth_path",
+        :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: UserApi#user_generate_slack_oauth_path\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get account-level metadata including logo, VAPID key, and web push status
+    # @param [Hash] opts the optional parameters
+    # @return [GetAccountMetadataResponse]
+    def user_get_account_metadata(opts = {})
+      data, _status_code, _headers = user_get_account_metadata_with_http_info(opts)
+      data
+    end
+
+    # Get account-level metadata including logo, VAPID key, and web push status
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetAccountMetadataResponse, Integer, Hash)>] GetAccountMetadataResponse data, response status code and response headers
+    def user_get_account_metadata_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserApi.user_get_account_metadata ...'
+      end
+      # resource path
+      local_var_path = '/users/account-metadata'
+
+      # 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] || 'GetAccountMetadataResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"UserApi.user_get_account_metadata",
+        :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: UserApi#user_get_account_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get list of Slack channels and users for the authenticated user
+    # @param user_id [String] User ID
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def user_get_available_slack_channels(user_id, opts = {})
+      user_get_available_slack_channels_with_http_info(user_id, opts)
+      nil
+    end
+
+    # Get list of Slack channels and users for the authenticated user
+    # @param user_id [String] User ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def user_get_available_slack_channels_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserApi.user_get_available_slack_channels ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling UserApi.user_get_available_slack_channels"
+      end
+      # resource path
+      local_var_path = '/users/{userId}/slack-channels'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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 (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"UserApi.user_get_available_slack_channels",
+        :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: UserApi#user_get_available_slack_channels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get in-app notifications for a user
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :before Timestamp or ISO date to fetch notifications before
+    # @option opts [Float] :count Number of notifications to return (default 10)
+    # @return [GetInappNotificationsResponse]
+    def user_get_in_app_notifications(opts = {})
+      data, _status_code, _headers = user_get_in_app_notifications_with_http_info(opts)
+      data
+    end
+
+    # Get in-app notifications for a user
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :before Timestamp or ISO date to fetch notifications before
+    # @option opts [Float] :count Number of notifications to return (default 10)
+    # @return [Array<(GetInappNotificationsResponse, Integer, Hash)>] GetInappNotificationsResponse data, response status code and response headers
+    def user_get_in_app_notifications_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserApi.user_get_in_app_notifications ...'
+      end
+      # resource path
+      local_var_path = '/user/inapp'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
+      query_params[:'count'] = opts[:'count'] if !opts[:'count'].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] || 'GetInappNotificationsResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"UserApi.user_get_in_app_notifications",
+        :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: UserApi#user_get_in_app_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get the count of unread in-app notifications for a user
+    # @param [Hash] opts the optional parameters
+    # @return [InappUnreadCountResponse]
+    def user_get_in_app_unread_count(opts = {})
+      data, _status_code, _headers = user_get_in_app_unread_count_with_http_info(opts)
+      data
+    end
+
+    # Get the count of unread in-app notifications for a user
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InappUnreadCountResponse, Integer, Hash)>] InappUnreadCountResponse data, response status code and response headers
+    def user_get_in_app_unread_count_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserApi.user_get_in_app_unread_count ...'
+      end
+      # resource path
+      local_var_path = '/user/inapp/unread'
+
+      # 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] || 'InappUnreadCountResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"UserApi.user_get_in_app_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: UserApi#user_get_in_app_unread_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a user by ID. All users exist implicitly, returns basic user object if not found in DB.
+    # @param user_id [String] User ID
+    # @param [Hash] opts the optional parameters
+    # @return [User]
+    def user_get_user(user_id, opts = {})
+      data, _status_code, _headers = user_get_user_with_http_info(user_id, opts)
+      data
+    end
+
+    # Get a user by ID. All users exist implicitly, returns basic user object if not found in DB.
+    # @param user_id [String] User ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
+    def user_get_user_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserApi.user_get_user ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling UserApi.user_get_user"
+      end
+      # resource path
+      local_var_path = '/users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_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] || 'User'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"UserApi.user_get_user",
+        :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: UserApi#user_get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create or update a user with the given ID. Updates lastSeenTime automatically.
+    # @param user_id [String] User ID
+    # @param post_user_request [PostUserRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [User]
+    def user_identify(user_id, post_user_request, opts = {})
+      data, _status_code, _headers = user_identify_with_http_info(user_id, post_user_request, opts)
+      data
+    end
+
+    # Create or update a user with the given ID. Updates lastSeenTime automatically.
+    # @param user_id [String] User ID
+    # @param post_user_request [PostUserRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
+    def user_identify_with_http_info(user_id, post_user_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserApi.user_identify ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling UserApi.user_identify"
+      end
+      # verify the required parameter 'post_user_request' is set
+      if @api_client.config.client_side_validation && post_user_request.nil?
+        fail ArgumentError, "Missing the required parameter 'post_user_request' when calling UserApi.user_identify"
+      end
+      # resource path
+      local_var_path = '/users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_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(post_user_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'User'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"UserApi.user_identify",
+        :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: UserApi#user_identify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Mark in-app web notifications as seen/read for a user
+    # @param in_app_notification_unread_clear_request [InAppNotificationUnreadClearRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessResponse]
+    def user_mark_in_app_notifications_as_seen(in_app_notification_unread_clear_request, opts = {})
+      data, _status_code, _headers = user_mark_in_app_notifications_as_seen_with_http_info(in_app_notification_unread_clear_request, opts)
+      data
+    end
+
+    # Mark in-app web notifications as seen/read for a user
+    # @param in_app_notification_unread_clear_request [InAppNotificationUnreadClearRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessResponse, Integer, Hash)>] SuccessResponse data, response status code and response headers
+    def user_mark_in_app_notifications_as_seen_with_http_info(in_app_notification_unread_clear_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserApi.user_mark_in_app_notifications_as_seen ...'
+      end
+      # verify the required parameter 'in_app_notification_unread_clear_request' is set
+      if @api_client.config.client_side_validation && in_app_notification_unread_clear_request.nil?
+        fail ArgumentError, "Missing the required parameter 'in_app_notification_unread_clear_request' when calling UserApi.user_mark_in_app_notifications_as_seen"
+      end
+      # resource path
+      local_var_path = '/user/inapp/unread'
+
+      # 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(in_app_notification_unread_clear_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuccessResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"UserApi.user_mark_in_app_notifications_as_seen",
+        :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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UserApi#user_mark_in_app_notifications_as_seen\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update in-app web notification status (opened, archived, clicked, etc.)
+    # @param in_app_notification_patch_request [InAppNotificationPatchRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessResponse]
+    def user_update_in_app_notification_status(in_app_notification_patch_request, opts = {})
+      data, _status_code, _headers = user_update_in_app_notification_status_with_http_info(in_app_notification_patch_request, opts)
+      data
+    end
+
+    # Update in-app web notification status (opened, archived, clicked, etc.)
+    # @param in_app_notification_patch_request [InAppNotificationPatchRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessResponse, Integer, Hash)>] SuccessResponse data, response status code and response headers
+    def user_update_in_app_notification_status_with_http_info(in_app_notification_patch_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserApi.user_update_in_app_notification_status ...'
+      end
+      # verify the required parameter 'in_app_notification_patch_request' is set
+      if @api_client.config.client_side_validation && in_app_notification_patch_request.nil?
+        fail ArgumentError, "Missing the required parameter 'in_app_notification_patch_request' when calling UserApi.user_update_in_app_notification_status"
+      end
+      # resource path
+      local_var_path = '/user/inapp'
+
+      # 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(in_app_notification_patch_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuccessResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"UserApi.user_update_in_app_notification_status",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UserApi#user_update_in_app_notification_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end