pingram 1.0.33 → 1.0.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40cafa3ce26c9605c65945ea74595afba080c5f42b7c2b36d53239af28b1f787
-  data.tar.gz: '0293e3b14abf37454a19a01b8bf4b99a81954d1ce25de5d74c2069a1051f5de2'
+  metadata.gz: b30d37411f27d79cbd5c9541640ec5013add89c8447dad19ded7b4e4b6d3c13f
+  data.tar.gz: d30611b7e1ec201d1102b8e1e3e19288251d9d351be6f86839bdbe8165ceca70
 SHA512:
-  metadata.gz: a8ec073c59824edddeeb8513cc19aed931decce493f68977dcde7a6e76d2b2e86830dad019cece0968c3d41f0b53cc2ed43f575b63a36f6c90ec99027ed4575d
-  data.tar.gz: 20c29536635b87114a1fd455fee66ecb1338b6c92fa2d5dedd9bd89cb0117afbc626be124cbd43db4acf45960edabb72d80f303567066ecc506b380f67d818de
+  metadata.gz: 4f3d88eb47c1fb8c237a182c90da949ae67abca0e94473d14d00655179cf8c28886af268ad652bbf0190823cd765636ee6ff94ad877b9e73a264f983113dcd9f
+  data.tar.gz: 95d5fb3de513033b099218f1e3537cd69872ce1e3a5fb1b36f92c49108104836208281d9589c09f35c832c1606b3b27af320479a08250fc9deb501025cfa5632

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pingram (1.0.33)
+    pingram (1.0.34)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

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.33"
+      @user_agent = "pingram-ruby/1.0.34"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/pingram/models/user_preferences_get_response.rb

@@ -0,0 +1,222 @@
+=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 'date'
+require 'time'
+
+module Pingram
+  class UserPreferencesGETResponse < ApiModelBase
+    attr_accessor :preferences
+
+    attr_accessor :notifications
+
+    attr_accessor :sub_notifications
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'preferences' => :'preferences',
+        :'notifications' => :'notifications',
+        :'sub_notifications' => :'subNotifications'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'preferences' => :'Array<UserPreferencesGETResponsePreferencesInner>',
+        :'notifications' => :'Array<UserPreferencesGETResponseNotificationsInner>',
+        :'sub_notifications' => :'Array<UserPreferencesGETResponseSubNotificationsInner>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::UserPreferencesGETResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Pingram::UserPreferencesGETResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'preferences')
+        if (value = attributes[:'preferences']).is_a?(Array)
+          self.preferences = value
+        end
+      else
+        self.preferences = nil
+      end
+
+      if attributes.key?(:'notifications')
+        if (value = attributes[:'notifications']).is_a?(Array)
+          self.notifications = value
+        end
+      else
+        self.notifications = nil
+      end
+
+      if attributes.key?(:'sub_notifications')
+        if (value = attributes[:'sub_notifications']).is_a?(Array)
+          self.sub_notifications = value
+        end
+      else
+        self.sub_notifications = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @preferences.nil?
+        invalid_properties.push('invalid value for "preferences", preferences cannot be nil.')
+      end
+
+      if @notifications.nil?
+        invalid_properties.push('invalid value for "notifications", notifications cannot be nil.')
+      end
+
+      if @sub_notifications.nil?
+        invalid_properties.push('invalid value for "sub_notifications", sub_notifications cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @preferences.nil?
+      return false if @notifications.nil?
+      return false if @sub_notifications.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] preferences Value to be assigned
+    def preferences=(preferences)
+      if preferences.nil?
+        fail ArgumentError, 'preferences cannot be nil'
+      end
+
+      @preferences = preferences
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] notifications Value to be assigned
+    def notifications=(notifications)
+      if notifications.nil?
+        fail ArgumentError, 'notifications cannot be nil'
+      end
+
+      @notifications = notifications
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sub_notifications Value to be assigned
+    def sub_notifications=(sub_notifications)
+      if sub_notifications.nil?
+        fail ArgumentError, 'sub_notifications cannot be nil'
+      end
+
+      @sub_notifications = sub_notifications
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          preferences == o.preferences &&
+          notifications == o.notifications &&
+          sub_notifications == o.sub_notifications
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [preferences, notifications, sub_notifications].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end