root_insurance 1.9.0 → 1.9.1

data/lib/root_insurance/api/policyholder.rb

@@ -1,131 +1,133 @@
-module RootInsurance::Api
-  module Policyholder
-    # Create a policy holder
-    #
-    # @param [Hash] id Hash containing policyholder's identification number, type and country. See below for details.
-    # @param [String] first_name Policyholder's legal first name.
-    # @param [String] last_name Policyholder's legal last name.
-    # @param [String] email Policyholder's contact email address. (Optional)
-    # @param [String] date_of_birth The policyholder's date of birth in the format YYYYMMDD. This field may be omitted if the policyholder's id type is +id+.
-    # @param [Hash] cellphone Hash containing policyholder's cellphone number and country. See below for details. (Optional)
-    # @param [Hash] app_data A hash containing additional custom data for the policy holder.
-    # @return [Hash]
-    #
-    ## == ID
-    # [type (string or symbol)]   Either +:id+ or +:passport+
-    # [number (string)]   The id or passport number
-    # [country (string)]   The ISO Alpha-2 country code of the country of the id/passport number.
-    #
-    ## == Cellphone
-    # [number (string)]   The cellphone number
-    # [country (string)]   The ISO Alpha-2 country code of the country of the cellphone number.
-    #
-    # @example
-    #  client.create_policy_holder(
-    #    id:         {type: :id, number: "6801015800084", country: "ZA"},
-    #    first_name: 'Erlich',
-    #    last_name:  'Bachman',
-    #    email:      'erlich@avaito.com',
-    #    app_data:   {company: 'Aviato'})
-    #
-    def create_policyholder(id:, first_name:, last_name:, email: nil, date_of_birth: nil, cellphone: nil, app_data: nil)
-      raise ArgumentError.new('id needs to be a hash') unless id.is_a? Hash
+module RootInsurance
+  module Api
+    module Policyholder
+      # Create a policy holder
+      #
+      # @param [Hash] id Hash containing policyholder's identification number, type and country. See below for details.
+      # @param [String] first_name Policyholder's legal first name.
+      # @param [String] last_name Policyholder's legal last name.
+      # @param [String] email Policyholder's contact email address. (Optional)
+      # @param [String] date_of_birth The policyholder's date of birth in the format YYYYMMDD. This field may be omitted if the policyholder's id type is +id+.
+      # @param [Hash] cellphone Hash containing policyholder's cellphone number and country. See below for details. (Optional)
+      # @param [Hash] app_data A hash containing additional custom data for the policy holder.
+      # @return [Hash]
+      #
+      ## == ID
+      # [type (string or symbol)]   Either +:id+ or +:passport+
+      # [number (string)]   The id or passport number
+      # [country (string)]   The ISO Alpha-2 country code of the country of the id/passport number.
+      #
+      ## == Cellphone
+      # [number (string)]   The cellphone number
+      # [country (string)]   The ISO Alpha-2 country code of the country of the cellphone number.
+      #
+      # @example
+      #  client.create_policy_holder(
+      #    id:         {type: :id, number: "6801015800084", country: "ZA"},
+      #    first_name: 'Erlich',
+      #    last_name:  'Bachman',
+      #    email:      'erlich@avaito.com',
+      #    app_data:   {company: 'Aviato'})
+      #
+      def create_policyholder(id:, first_name:, last_name:, email: nil, date_of_birth: nil, cellphone: nil, app_data: nil)
+        raise ArgumentError.new('id needs to be a hash') unless id.is_a? Hash
 
-      data = {
-        id:            id,
-        first_name:    first_name,
-        last_name:     last_name,
-        date_of_birth: date_of_birth,
-        email:         email,
-        cellphone:     cellphone,
-        app_data:      app_data
-      }.reject { |key, value| value.nil? }
+        data = {
+          id:            id,
+          first_name:    first_name,
+          last_name:     last_name,
+          date_of_birth: date_of_birth,
+          email:         email,
+          cellphone:     cellphone,
+          app_data:      app_data
+        }.reject { |key, value| value.nil? }
 
-      post(:policyholders, data)
-    end
+        post(:policyholders, data)
+      end
 
-    # List policy holders
-    #
-    # @param [Hash] id_number An optional ID or passport number to filter by.
-    # @param [Array<String, Symbol>, String, Symbol] included_objects An optional list, or single item, of underlying objects to include, e.g. +?include=policies+. Currently, only +policies+ is supported, which will include all policies owned by the policyholder.
-    # @return [Array<Hash>]
-    #
-    # @example
-    #   client.list_policyholders(id_number: "128ba0c0-3f6a-4f8b-9b40-e2066b02b59e", included_objects: :policies)
-    def list_policyholders(id_number: nil, included_objects: nil)
-      query = {
-        include:   format_included_objects(included_objects),
-        id_number: id_number
-      }.reject { |_, v| v.nil? }
+      # List policy holders
+      #
+      # @param [Hash] id_number An optional ID or passport number to filter by.
+      # @param [Array<String, Symbol>, String, Symbol] included_objects An optional list, or single item, of underlying objects to include, e.g. +?include=policies+. Currently, only +policies+ is supported, which will include all policies owned by the policyholder.
+      # @return [Array<Hash>]
+      #
+      # @example
+      #   client.list_policyholders(id_number: "128ba0c0-3f6a-4f8b-9b40-e2066b02b59e", included_objects: :policies)
+      def list_policyholders(id_number: nil, included_objects: nil)
+        query = {
+          include:   format_included_objects(included_objects),
+          id_number: id_number
+        }.reject { |_, v| v.nil? }
 
-      get(:policyholders, query)
-    end
+        get(:policyholders, query)
+      end
 
-    # Get a policy holder
-    #
-    # @param [String] id The unique identifier of the policy holder
-    # @param [Array<String, Symbol>, String, Symbol] included_objects An optional list, or single item, of underlying objects to include, e.g. +?include=policies+. Currently, only +policies+ is supported, which will include all policies owned by the policyholder.
-    # @return [Hash]
-    #
-    # @example
-    #   client.get_policyholder(id: "128ba0c0-3f6a-4f8b-9b40-e2066b02b59e", included_objects: :policies)
-    #
-    def get_policyholder(id:, included_objects: nil)
-      query = {
-        include:   format_included_objects(included_objects),
-      }.reject { |_, v| v.nil? }
+      # Get a policy holder
+      #
+      # @param [String] id The unique identifier of the policy holder
+      # @param [Array<String, Symbol>, String, Symbol] included_objects An optional list, or single item, of underlying objects to include, e.g. +?include=policies+. Currently, only +policies+ is supported, which will include all policies owned by the policyholder.
+      # @return [Hash]
+      #
+      # @example
+      #   client.get_policyholder(id: "128ba0c0-3f6a-4f8b-9b40-e2066b02b59e", included_objects: :policies)
+      #
+      def get_policyholder(id:, included_objects: nil)
+        query = {
+          include:   format_included_objects(included_objects),
+        }.reject { |_, v| v.nil? }
 
-      get("policyholders/#{id}", query)
-    end
+        get("policyholders/#{id}", query)
+      end
 
-    # Update a policy holder
-    #
-    # @param [String] id The unique identifier of the policy holder
-    # @param [String] email Policyholder's contact email address. (Optional)
-    # @param [Hash] cellphone Hash containing policyholder's cellphone number and country. See below for details. (Optional)
-    # @param [Hash] app_data A hash containing additional custom data for the policy holder.
-    # @return [Hash]
-    #
-    ## == Cellphone
-    # [number (string)]   The cellphone number
-    # [country (string)]   The ISO Alpha-2 country code of the country of the cellphone number.
-    #
-    # @example
-    #   client.update_policyholders(
-    #     id: 'bf1ada91-eecb-4f47-9bfa-1258bb1e0055',
-    #     cellphone: {number: '07741011337', country: 'ZA'},
-    #     app_data:  {company: 'Pied Piper'})
-    #
-    def update_policyholder(id:, email: nil, cellphone: nil, app_data: nil)
-      data = {
-        email:     email,
-        cellphone: cellphone,
-        app_data:  app_data
-      }.reject { |key, value| value.nil? }
+      # Update a policy holder
+      #
+      # @param [String] id The unique identifier of the policy holder
+      # @param [String] email Policyholder's contact email address. (Optional)
+      # @param [Hash] cellphone Hash containing policyholder's cellphone number and country. See below for details. (Optional)
+      # @param [Hash] app_data A hash containing additional custom data for the policy holder.
+      # @return [Hash]
+      #
+      ## == Cellphone
+      # [number (string)]   The cellphone number
+      # [country (string)]   The ISO Alpha-2 country code of the country of the cellphone number.
+      #
+      # @example
+      #   client.update_policyholders(
+      #     id: 'bf1ada91-eecb-4f47-9bfa-1258bb1e0055',
+      #     cellphone: {number: '07741011337', country: 'ZA'},
+      #     app_data:  {company: 'Pied Piper'})
+      #
+      def update_policyholder(id:, email: nil, cellphone: nil, app_data: nil)
+        data = {
+          email:     email,
+          cellphone: cellphone,
+          app_data:  app_data
+        }.reject { |key, value| value.nil? }
 
-      patch("policyholders/#{id}", data)
-    end
+        patch("policyholders/#{id}", data)
+      end
 
-    # List all the events which are applicable to this policy holder.
-    #
-    # @param [String] id The unique identifier of the policy holder
-    # @return [Array<Hash>]
-    #
-    # @example
-    #  client.list_policyholder_events(id: "128ba0c0-3f6a-4f8b-9b40-e2066b02b59e")
-    #
-    def list_policyholder_events(id:)
-      get("policyholders/#{id}/events")
-    end
+      # List all the events which are applicable to this policy holder.
+      #
+      # @param [String] id The unique identifier of the policy holder
+      # @return [Array<Hash>]
+      #
+      # @example
+      #  client.list_policyholder_events(id: "128ba0c0-3f6a-4f8b-9b40-e2066b02b59e")
+      #
+      def list_policyholder_events(id:)
+        get("policyholders/#{id}/events")
+      end
 
-    private
-    def format_included_objects(included_objects)
-      case included_objects
-      when String, Symbol
-        included_objects
-      when Array
-        included_objects.join(",")
+      private
+      def format_included_objects(included_objects)
+        case included_objects
+        when String, Symbol
+          included_objects
+        when Array
+          included_objects.join(",")
+        end
       end
     end
   end
-end
+end

data/lib/root_insurance/api/quote.rb

@@ -1,94 +1,95 @@
-module RootInsurance::Api
-  module Quote
-    # Create a quote
-    #
-    # @param [Hash] opts The quote details. Depending on +:type+, different options are available. Available types are: +:root_gadgets+, +:root_term+ and +:root_funeral+ See below for details
-    # @return [Hash]
-    #
-    ## == +:root_gadgets+
-    # [model_name (String)]   The model name of the gadget
-    #
-    ## == +:root_term+
-    # [cover_amount (Integer)]   Amount to cover, in cents. Should be between R100 000 and R5 000 000, inclusive.
-    # [cover_period (String or Symbol)]   Duration to cover: +:1_year+, +:2_years+, +:5_years+, +:10_years+, +:15_years+, +:20_years+ or +:whole_life+.
-    # [basic_income_per_month (Integer)]    Policyholder's basic monthly income, in cents.
-    # [education_status (String or Symbol)]    Policyholder’s education class: +:grade_12_no_matric+, +:grade_12_matric+, +:diploma_or_btech+, +:undergraduate_degree+ or +:professional_degree+
-    # [smoker (Boolean)]     Is the policyholder a smoker.
-    # [gender (String or Symbol)]    Gender of policyholder. Should be either +:male+ or +:female+.
-    # [age (Integer)]    Age of policyholder. Should be between 18 and 63, inclusive.
-    #
-    # == +:root_funeral+
-    # [cover_amount (Integer)]   Amount to cover, in cents. Should be between R10k and R50k, inclusive.
-    # [has_spouse (Boolean)]   Should a spouse also be covered.
-    # [number_of_children (Integer)]   Number of children to include in the policy. Should be between 0 and 8, inclusive
-    # [extended_family_ages (Array<Integer>)]   Ages of extended family members to cover.
-    #
-    # @example
-    #  client.create_quote(
-    #    type:       :root_gadgets,
-    #    model_name: 'iPhone 6s 64GB LTE')
-    #
-    def create_quote(opts={})
-      type = opts[:type]
-
-      case type.to_sym
-      when :root_gadgets
-        create_gadget_quote(opts)
-      when :root_term
-        create_term_quote(opts)
-      when :root_funeral
-        create_funeral_quote(opts)
-      else
-        raise ArgumentError("Unknown quote type: #{type}")
+module RootInsurance
+  module Api
+    module Quote
+      # Create a quote
+      #
+      # @param [Hash] opts The quote details. Depending on +:type+, different options are available. Available types are: +:root_gadgets+, +:root_term+ and +:root_funeral+ See below for details
+      # @return [Hash]
+      #
+      ## == +:root_gadgets+
+      # [model_name (String)]   The model name of the gadget
+      #
+      ## == +:root_term+
+      # [cover_amount (Integer)]   Amount to cover, in cents. Should be between R100 000 and R5 000 000, inclusive.
+      # [cover_period (String or Symbol)]   Duration to cover: +:1_year+, +:2_years+, +:5_years+, +:10_years+, +:15_years+, +:20_years+ or +:whole_life+.
+      # [basic_income_per_month (Integer)]    Policyholder's basic monthly income, in cents.
+      # [education_status (String or Symbol)]    Policyholder’s education class: +:grade_12_no_matric+, +:grade_12_matric+, +:diploma_or_btech+, +:undergraduate_degree+ or +:professional_degree+
+      # [smoker (Boolean)]     Is the policyholder a smoker.
+      # [gender (String or Symbol)]    Gender of policyholder. Should be either +:male+ or +:female+.
+      # [age (Integer)]    Age of policyholder. Should be between 18 and 63, inclusive.
+      #
+      # == +:root_funeral+
+      # [cover_amount (Integer)]   Amount to cover, in cents. Should be between R10k and R50k, inclusive.
+      # [has_spouse (Boolean)]   Should a spouse also be covered.
+      # [number_of_children (Integer)]   Number of children to include in the policy. Should be between 0 and 8, inclusive
+      # [extended_family_ages (Array<Integer>)]   Ages of extended family members to cover.
+      #
+      # @example
+      #  client.create_quote(
+      #    type:       :root_gadgets,
+      #    model_name: 'iPhone 6s 64GB LTE')
+      #
+      def create_quote(opts={})
+        type = opts[:type]
+        case type.to_sym
+        when :root_gadgets
+          create_gadget_quote(opts)
+        when :root_term
+          create_term_quote(opts)
+        when :root_funeral
+          create_funeral_quote(opts)
+        else
+          raise ArgumentError("Unknown quote type: #{type}")
+        end
       end
-    end
 
-    # List available gadget models
-    #
-    # @return [Array<Hash>]
-    #
-    # @example
-    #   client.list_gadget_models
-    #
-    def list_gadget_models
-      get('gadgets/models')
-    end
+      # List available gadget models
+      #
+      # @return [Array<Hash>]
+      #
+      # @example
+      #   client.list_gadget_models
+      #
+      def list_gadget_models
+        get('gadgets/models')
+      end
 
-    private
-    def create_gadget_quote(opts)
-      data = {
-        type:       :root_gadgets,
-        model_name: opts[:model_name]
-      }
+      private
 
-      post(:quotes, data)
-    end
+      def create_gadget_quote(opts)
+        data = {
+          type:       :root_gadgets,
+          model_name: opts[:model_name]
+        }
 
-    def create_term_quote(opts)
-      data = {
-        type:             :root_term,
-        cover_amount:     opts[:cover_amount],
-        cover_period:     opts[:cover_period],
-        education_status: opts[:education_status],
-        smoker:           opts[:smoker],
-        gender:           opts[:gender],
-        age:              opts[:age],
-        basic_income_per_month: opts[:basic_income_per_month],
-      }
+        post(:quotes, data)
+      end
 
-      post(:quotes, data)
-    end
+      def create_term_quote(opts)
+        data = {
+          type:             :root_term,
+          cover_amount:     opts[:cover_amount],
+          cover_period:     opts[:cover_period],
+          education_status: opts[:education_status],
+          smoker:           opts[:smoker],
+          gender:           opts[:gender],
+          age:              opts[:age],
+          basic_income_per_month: opts[:basic_income_per_month],
+        }
 
-    def create_funeral_quote(opts)
-      data = {
-        type:                 :root_funeral,
-        cover_amount:         opts[:cover_amount],
-        has_spouse:           opts[:has_spouse],
-        number_of_children:   opts[:number_of_children],
-        extended_family_ages: opts[:extended_family_ages]
-      }
+        post(:quotes, data)
+      end
 
-      post(:quotes, data)
+      def create_funeral_quote(opts)
+        data = {
+          type:                 :root_funeral,
+          cover_amount:         opts[:cover_amount],
+          has_spouse:           opts[:has_spouse],
+          number_of_children:   opts[:number_of_children],
+          extended_family_ages: opts[:extended_family_ages]
+        }
+        post(:quotes, data)
+      end
     end
   end
 end

data/lib/root_insurance/version.rb

@@ -1,3 +1,3 @@
 module RootInsurance
-  VERSION = "1.9.0"
+  VERSION = "1.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: root_insurance
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.9.1
 platform: ruby
 authors:
 - Root Wealth
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-01 00:00:00.000000000 Z
+date: 2018-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -170,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Root Insurance API client