root_insurance 1.7.3 → 1.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d3e7e1d0a5b7941e478e4bd4a4d886fa2879a7e
-  data.tar.gz: a8172c03a3d1189986827af0af96f06ba14e5b2b
+  metadata.gz: 75e3ae3ca5078705c6a87fa245c3acefad9dcfca
+  data.tar.gz: 8f4d396c8d8d09d664807f94c1c96b0dd838c114
 SHA512:
-  metadata.gz: 7973c2c41633550644b68ed2c44dd63455b9b0eb5f18cf13c530526553d30f4b919b9f996e4d243914e8a5f4f7873a8afad5c4600c63d8523aa594b888fcd15a
-  data.tar.gz: 3253be076498530e2a14b41839bc197a6bf35e6fe0be1e0c4150706311861997a60249d4f3b57adb957b2616d13ef61572828f2e4025b271f980f11cf4fcb83f
+  metadata.gz: ec930d343623b1626cb5bbadce8149aa25e33a50c24d9b73e3fe771b48d95dd5b747a1aa5cbd494868e0e3e5d5f86ed9b8b0d94bad3c363ba44953ae6eaa9a5d
+  data.tar.gz: aa96a45de85da0eaf866d8c9088c501fd30f3b35a380280a2057e2bfb23d2b7fd94dddd938fbf4d6e7504fd57e78b102d0ee6c93f29de43db761d1f7a4d10552

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+# 1.7.4 - Release date: 2018-16-05
+* Added claim and call documentation
+
+
 # 1.7.3 - Release date: 2018-16-05
 * One more documentation fix
 

data/lib/root_insurance/api/call.rb

@@ -1,13 +1,33 @@
 module RootInsurance::Api
   module Call
+    # List all the logged calls
+    #
+    # @return [Hash]
+    #
+    # @example
+    #   client.list_calls
     def list_calls
       get(:calls)
     end
 
+    # Get a specific call
+    #
+    # @param [String] id The unique identifier of the call
+    # @return [Hash]
+    #
+    # @example
+    #   client.get_call(id: 'd3d13c48-4dc3-4816-8d01-de3215878225')
     def get_call(id:)
       get("calls/#{id}")
     end
 
+    # List a call's events
+    #
+    # @param [String] id The unique identifier of the call
+    # @return [Hash]
+    #
+    # @example
+    #   client.list_call_events(id: 'd3d13c48-4dc3-4816-8d01-de3215878225')
     def list_call_events(id:)
       get("calls/#{id}/events")
     end

data/lib/root_insurance/api/claim.rb

@@ -2,6 +2,16 @@ require 'mimemagic'
 
 module RootInsurance::Api
   module Claim
+
+    # List all claims
+    #
+    # @param [String, Symbol] status Either +:open+, +:closed+, +:finalized+, +:acknowledged+ or +:all+. If omitted defaults to +:all+
+    # @param [String, Symbol] approval Either +:approved+, +:repudiated+, +:'ex-gratia'+, +:'no-claim'+, +:pending+ or +:all+. If omitted defaults to +:all+
+    # @return [Array<Hash>]
+    #
+    # @example
+    #   client.list_claims(status: :open)
+    #
     def list_claims(status: nil, approval: nil)
       query = {
         claim_status:    status,
@@ -11,10 +21,46 @@ module RootInsurance::Api
       get(:claims, query)
     end
 
+    # Get a specific claim
+    #
+    # @param [String] id The claim's id
+    # @return [Hash]
+    # @example
+    #   client.get_claim(id: 'd3d13c48-4dc3-4816-8d01-de3215878225')
+    #
     def get_claim(id:)
       get("claims/#{id}")
     end
 
+    # Open a claim
+    #
+    # @param [String] policy_id The ID of the policy under which the claim is being made. (optional)
+    # @param [String] policy_holder_id The ID of the policyholder for whom the claim is being made. (optional)
+    # @param [String] incident_type A description of the incident type. (optional)
+    # @param [String] incident_cause A description of the cause of the incident. (optional)
+    # @param [String] incident_date The date on the which the incident occured. (optional)
+    # @param [String] app_data An object containing additional custom data for the claim. (optional)
+    # @param [String] claimant Object containing claimants's first name, last name, email and/or cellphone. See below for details. (optional)
+    # @param [String] requested_amount The requested payout amount (in cents) for the claim. (optional)
+    # @return [Hash]
+    #
+    ## == Claimant
+    # [first_name (string)]   The name of the claimant
+    # [last_name (string)]   The last name of the claimant
+    # [email (string)]   The claimant's email address
+    # [cellphone (string)]   The claimant's cellphone number
+    #
+    # @example
+    #   client.open_claim(
+    #     policy_id: "8349345c-a6c5-4bf9-8ebb-6bbfc1628715",
+    #     incident_type: "Theft",
+    #     incident_cause: "Device stolen during burglary",
+    #     incident_date: "2017-10-16T10:12:02.872Z",
+    #     requested_amount: 13000000,
+    #     app_data: {
+    #       key1: "value 1"
+    #       key2: "value 2"})
+    #
     def open_claim(policy_id: nil, policy_holder_id: nil, incident_type: nil, incident_cause: nil,
                    incident_date: nil, app_data: nil, claimant: nil, requested_amount: nil)
       data = {
@@ -31,6 +77,25 @@ module RootInsurance::Api
       post(:claims, data)
     end
 
+    # Update a claim
+    #
+    # @param [String] claim_id The unique identifier of the claim.
+    # @param [String] incident_type A description of the incident type. (optional)
+    # @param [String] incident_cause A description of the cause of the incident. (optional)
+    # @param [String] incident_date The date on the which the incident occured. (optional)
+    # @param [String] app_data An object containing additional custom data for the claim. (optional)
+    # @param [String] requested_amount The requested payout amount (in cents) for the claim. (optional)
+    # @return [Hash]
+    #
+    # @example
+    #   client.update_claim(
+    #     claim_id:         "d3d13c48-4dc3-4816-8d01-de3215878225",
+    #     incident_type:    "Theft",
+    #     incident_cause:   "Device stolen during burglary",
+    #     incident_date:    "2017-10-16T10:12:02.872Z",
+    #     app_data:         {key3: "value 3"},
+    #     requested_amount: 13000000)
+    #
     def update_claim(claim_id:, incident_type: nil, incident_cause: nil, incident_date: nil,
                      app_data: nil, requested_amount: nil)
       data = {
@@ -44,23 +109,64 @@ module RootInsurance::Api
       patch("claims/#{claim_id}", data)
     end
 
+    # Link a claim and a policy
+    #
+    # @param [String] claim_id The unique identifier of the claim.
+    # @param [String] policy_id The unique identifier of the policy.
+    # @return [Hash]
+    #
+    # @example
+    #  client.link_policy_to_claim(claim_id: "d3d13c48-4dc3-4816-8d01-de3215878225", policy_id: "8349345c-a6c5-4bf9-8ebb-6bbfc1628715")
+    #
     def link_policy_to_claim(claim_id:, policy_id:)
       data = {policy_id: policy_id}
 
       post("claims/#{claim_id}/policy", data)
     end
 
+
+    # Link a claim and a policy holder
+    #
+    # @param [String] claim_id The unique identifier of the claim.
+    # @param [String] policyholder_id The unique identifier of the policy holder.
+    # @return [Hash]
+    #
+    # @example
+    #  client.link_policyholder_to_claim(claim_id: "d3d13c48-4dc3-4816-8d01-de3215878225", policyholder_id: "808f75dc-cb8a-4808-93e9-e13f8eea84de")
+    #
     def link_policyholder_to_claim(claim_id:, policyholder_id:)
       data = {policyholder_id: policyholder_id}
 
       post("claims/#{claim_id}/policyholder", data)
     end
 
+    # List all claim events
+    #
+    # @param [String] claim_id The unique identifier of the claim.
+    # @return [Array<Hash>]
+    #
+    # @example
+    #  client.list_claim_events(claim_id: "d3d13c48-4dc3-4816-8d01-de3215878225")
+    #
     def list_claim_events(id: nil, claim_id: nil)
       claim_id = claim_id || id
       get("claims/#{claim_id}/events")
     end
 
+    # Create a claim attachment
+    #
+    # The file data can be passed using either +path+, +file+, +bytes+ or +base64+.
+    #
+    # @param [String] claim_id The unique identifier of the claim
+    # @param [String] path The full path to the file's location
+    # @param [File] file instance of a File object
+    # @param [String] bytes The raw butes of the file
+    # @param [String] base64 The base64 encoded file
+    # @param [String] file_name The file's name (only required when not using +path+ or +file+)
+    # @param [String] file_type The file's mime type (only required when using +base64+)
+    # @param [String] description A description of the file
+    # @return [Hash]
+    #
     def create_claim_attachment(claim_id:, path: nil, file: nil, bytes: nil, base64: nil, file_name: nil, file_type: nil, description: '')
       data = if path
         claim_attachment_from_path(path)

data/lib/root_insurance/version.rb

@@ -1,3 +1,3 @@
 module RootInsurance
-  VERSION = "1.7.3"
+  VERSION = "1.7.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: root_insurance
 version: !ruby/object:Gem::Version
-  version: 1.7.3
+  version: 1.7.4
 platform: ruby
 authors:
 - Root Wealth