pingram 1.0.32 → 1.0.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4114117ba84a31e9450e71f3f392387afe0ec8a566adc28515bcbfd8b547f9a
-  data.tar.gz: ca98b0bc4b882386da2281a3a372a5e3cb8583ba6ce2d6f205655f397411568d
+  metadata.gz: b30d37411f27d79cbd5c9541640ec5013add89c8447dad19ded7b4e4b6d3c13f
+  data.tar.gz: d30611b7e1ec201d1102b8e1e3e19288251d9d351be6f86839bdbe8165ceca70
 SHA512:
-  metadata.gz: 9c2cdc19a92d011e3ab1b78d9cae2b77ed36fb540424e0498fd221d904e6eef5c3e87f094ab8710eabd29df4a5bf0434d3a91e11f619315a36b1737af7ea2f67
-  data.tar.gz: 1ca7d9de2a43274787b4c8de7170985839e298f583fc6b770ab250500ecc3ebc3571d7ef029b4dba372785f34a683dd57254c5a81cf9aaf90cf219d6734cd9bb
+  metadata.gz: 4f3d88eb47c1fb8c237a182c90da949ae67abca0e94473d14d00655179cf8c28886af268ad652bbf0190823cd765636ee6ff94ad877b9e73a264f983113dcd9f
+  data.tar.gz: 95d5fb3de513033b099218f1e3537cd69872ce1e3a5fb1b36f92c49108104836208281d9589c09f35c832c1606b3b27af320479a08250fc9deb501025cfa5632

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pingram (1.0.32)
+    pingram (1.0.34)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -17,7 +17,7 @@ GEM
       ffi (>= 1.15.0)
       logger
     ffi (1.17.4-x86_64-linux-gnu)
-    io-console (0.9.3)
+    io-console (0.9.4)
     jaro_winkler (1.5.6)
     logger (1.7.0)
     method_source (1.1.0)

data/lib/pingram/api/account_api.rb

@@ -631,7 +631,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Update account billing preferences. Only account owners can change these settings.
+    # Update account billing preferences such as auto upgrade.
     # @param account_patch_request [AccountPatchRequest] 
     # @param [Hash] opts the optional parameters
     # @return [AccountGetResponse]
@@ -640,7 +640,7 @@ module Pingram
       data
     end
 
-    # Update account billing preferences. Only account owners can change these settings.
+    # Update account billing preferences such as auto upgrade.
     # @param account_patch_request [AccountPatchRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(AccountGetResponse, Integer, Hash)>] AccountGetResponse data, response status code and response headers

data/lib/pingram/api/sub_notifications_api.rb

@@ -0,0 +1,167 @@
+=begin
+#Pingram
+
+#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 SubNotificationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # This endpoint is no longer maintained and should not be used.
+    # @param notification_id [String] The notification ID
+    # @param sub_notification_id [String] The sub-notification ID
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def sub_notifications_delete_sub_notification(notification_id, sub_notification_id, opts = {})
+      sub_notifications_delete_sub_notification_with_http_info(notification_id, sub_notification_id, opts)
+      nil
+    end
+
+    # This endpoint is no longer maintained and should not be used.
+    # @param notification_id [String] The notification ID
+    # @param sub_notification_id [String] The sub-notification ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def sub_notifications_delete_sub_notification_with_http_info(notification_id, sub_notification_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SubNotificationsApi.sub_notifications_delete_sub_notification ...'
+      end
+      # verify the required parameter 'notification_id' is set
+      if @api_client.config.client_side_validation && notification_id.nil?
+        fail ArgumentError, "Missing the required parameter 'notification_id' when calling SubNotificationsApi.sub_notifications_delete_sub_notification"
+      end
+      # verify the required parameter 'sub_notification_id' is set
+      if @api_client.config.client_side_validation && sub_notification_id.nil?
+        fail ArgumentError, "Missing the required parameter 'sub_notification_id' when calling SubNotificationsApi.sub_notifications_delete_sub_notification"
+      end
+      # resource path
+      local_var_path = '/notifications/{notificationId}/subNotifications/{subNotificationId}'.sub('{' + 'notificationId' + '}', CGI.escape(notification_id.to_s)).sub('{' + 'subNotificationId' + '}', CGI.escape(sub_notification_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]
+
+      # 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 => :"SubNotificationsApi.sub_notifications_delete_sub_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: SubNotificationsApi#sub_notifications_delete_sub_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # This endpoint is no longer maintained and should not be used.
+    # @param notification_id [String] The notification ID
+    # @param sub_notification_id [String] The sub-notification ID
+    # @param sub_notification_put_request [SubNotificationPUTRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SubNotification]
+    def sub_notifications_put_sub_notification(notification_id, sub_notification_id, sub_notification_put_request, opts = {})
+      data, _status_code, _headers = sub_notifications_put_sub_notification_with_http_info(notification_id, sub_notification_id, sub_notification_put_request, opts)
+      data
+    end
+
+    # This endpoint is no longer maintained and should not be used.
+    # @param notification_id [String] The notification ID
+    # @param sub_notification_id [String] The sub-notification ID
+    # @param sub_notification_put_request [SubNotificationPUTRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SubNotification, Integer, Hash)>] SubNotification data, response status code and response headers
+    def sub_notifications_put_sub_notification_with_http_info(notification_id, sub_notification_id, sub_notification_put_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SubNotificationsApi.sub_notifications_put_sub_notification ...'
+      end
+      # verify the required parameter 'notification_id' is set
+      if @api_client.config.client_side_validation && notification_id.nil?
+        fail ArgumentError, "Missing the required parameter 'notification_id' when calling SubNotificationsApi.sub_notifications_put_sub_notification"
+      end
+      # verify the required parameter 'sub_notification_id' is set
+      if @api_client.config.client_side_validation && sub_notification_id.nil?
+        fail ArgumentError, "Missing the required parameter 'sub_notification_id' when calling SubNotificationsApi.sub_notifications_put_sub_notification"
+      end
+      # verify the required parameter 'sub_notification_put_request' is set
+      if @api_client.config.client_side_validation && sub_notification_put_request.nil?
+        fail ArgumentError, "Missing the required parameter 'sub_notification_put_request' when calling SubNotificationsApi.sub_notifications_put_sub_notification"
+      end
+      # resource path
+      local_var_path = '/notifications/{notificationId}/subNotifications/{subNotificationId}'.sub('{' + 'notificationId' + '}', CGI.escape(notification_id.to_s)).sub('{' + 'subNotificationId' + '}', CGI.escape(sub_notification_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(sub_notification_put_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SubNotification'
+
+      # 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 => :"SubNotificationsApi.sub_notifications_put_sub_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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SubNotificationsApi#sub_notifications_put_sub_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/pingram/api/user_api.rb

@@ -74,122 +74,6 @@ module Pingram
       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
@@ -322,137 +206,5 @@ module Pingram
       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

data/lib/pingram/api_client.rb

@@ -32,7 +32,7 @@ module Pingram
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "pingram-ruby/1.0.32"
+      @user_agent = "pingram-ruby/1.0.34"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/pingram/client_wrapper.rb

@@ -50,6 +50,8 @@ require_relative 'api/sender_api'
 
 require_relative 'api/sms_api'
 
+require_relative 'api/sub_notifications_api'
+
 require_relative 'api/templates_api'
 
 require_relative 'api/types_api'
@@ -132,6 +134,8 @@ module Pingram
 
       @sms = Pingram::SmsApi.new(@api_client)
 
+      @sub_notifications = Pingram::SubNotificationsApi.new(@api_client)
+
       @templates = Pingram::TemplatesApi.new(@api_client)
 
       @types = Pingram::TypesApi.new(@api_client)
@@ -273,6 +277,12 @@ module Pingram
     end
 
 
+    # @return [Pingram::SubNotificationsApi]
+    def sub_notifications
+      @sub_notifications
+    end
+
+
     # @return [Pingram::TemplatesApi]
     def templates
       @templates