lockstep_sdk 2022.11.60.0 → 2022.13.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1eeb25332f1e77648c3c8095e5278dd4a55ca884cf75f247117bb82fa6a971d
-  data.tar.gz: 86447fcd008f763888e67b7a676109a6c699f1bea078184991973a8d14f72a5b
+  metadata.gz: 4bc0a65679a4df117c520820d1c94e5db5995b9dca57cc833e66d5e89903d87b
+  data.tar.gz: 182dd8d32fb0cf77b9bcb080bc2a66a0aace3bfb2685c9f33cd72005e341d495
 SHA512:
-  metadata.gz: 9aa52c138d3af69f0c40cecf45aad402cab415ee8bebccbed911582cfdb5bd9cafe85db0cf2b8d9564b990675e4db07834aa15b14230b20f78e615b5f1c22e12
-  data.tar.gz: 16ac85a7c7d6c94c82b879a1f21238c2130ba8115fb1c038ebb8950738a6502b29d592b6dd03fa82e48bae9e600a2d4b0150fda3ac851c17fd9ace9235423c34
+  metadata.gz: 7f4e2f25b8e60dfecaa2fa0d6e481c382e6c6ecb7e3d3606b0d45ae2fbe06512e1b8107b0efe77db92f8a6bed0cffeb47cbd9280a46afdffcffc7416eb73c3f0
+  data.tar.gz: 6e73e85365d843e4b6222101d768d273635371b131485d53315d769a24b171acb4cf3028e1617d457deaa35841f7d57b4b7b3932b2bebd5db8933b1f0e2aa8c5

data/lib/lockstep_sdk/clients/reports_client.rb

@@ -128,10 +128,13 @@ class ReportsClient
     # @param start_date [date-time] The start date of the report
     # @param end_date [date-time] The end date of the report
     # @param column_option [string] The desired column splitting of the report data. An empty string or anything unrecognized will result in only totals being displayed. Options are as follows: By Period - a column for every month/fiscal period within the reporting dates Quarterly - a column for every quarter within the reporting dates Annually - a column for every year within the reporting dates
-    # @param display_depth [ReportDepth] The desired row splitting of the report data. Options are as follows: 1 - combine all accounts by their category 2 - combine all accounts by their subcategory 3 - display all accounts
-    def income_statement_report(start_date:, end_date:, column_option:, display_depth:)
+    # @param display_depth [ReportDepth] The desired row splitting of the report data. For Income Statements, the minimum report depth is 1. Options are as follows: 1 - combine all accounts by their category 2 - combine all accounts by their subcategory 3 - display all accounts
+    # @param comparison_period [string] Add a column for historical data with the following options and use showCurrencyDifference and/or show percentageDifference to display a comparison of that historical data to the report period. Options are as follows (note for YTD the data will be compared as a percentage of YTD and showCurrencyDifference and showPercentageDifference should not be used): "PP" - previous period (will show the previous quarter or year if Quarterly or Annually is chosen for columnOption) "PY" - previous year (the same date range as the report, but for the year prior) "YTD" - year to date (the current financial year to the current period)
+    # @param show_currency_difference [boolean] A boolean to turn on a currency based difference between the reporting period and the comparison period.
+    # @param show_percentage_difference [boolean] A boolean to turn on a percent based difference between the reporting period and the comparison period.
+    def income_statement_report(start_date:, end_date:, column_option:, display_depth:, comparison_period:, show_currency_difference:, show_percentage_difference:)
         path = "/api/v1/Reports/income-statement"
-        params = {:startDate => start_date, :endDate => end_date, :columnOption => column_option, :displayDepth => display_depth}
+        params = {:startDate => start_date, :endDate => end_date, :columnOption => column_option, :displayDepth => display_depth, :comparisonPeriod => comparison_period, :showCurrencyDifference => show_currency_difference, :showPercentageDifference => show_percentage_difference}
         @lockstepsdk.request(:get, path, nil, params)
     end
 end

data/lib/lockstep_sdk/clients/sync_client.rb

@@ -90,6 +90,17 @@ class SyncClient
         @lockstepsdk.request(:get, path, nil, params)
     end
 
+    ##
+    # Cancels a Sync process for an Application if the request is still being processed within the Application. This does not cancel Sync processes which have already proceeded to completion within the Application, or Sync processes outside of Applications such as from a Zip file or Batch Import.
+    #
+    # A Sync task represents an action performed by an Application for a particular account.  An Application can provide many different tasks as part of their capabilities.  Sync tasks are executed in the background and will continue running after they are created.  Use one of the creation APIs to request execution of a task. To check on the progress of the task, call GetSync or QuerySync.
+    #
+    # @param id [uuid] The unique ID number of the Sync task to cancel
+    def cancel_sync(id:)
+        path = "/api/v1/Sync/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
     ##
     # Queries Sync tasks for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
     #

data/lib/lockstep_sdk/lockstep_api.rb

@@ -10,7 +10,7 @@
 # @author     Manish Narayan B S <manish.n@lockstep.io>
 # @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
-# @version    2022.11.60.0
+# @version    2022.13.29.0
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -159,7 +159,7 @@ module LockstepSdk
         #
         # @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
         def initialize(env)
-            @version = "2022.11.60.0"
+            @version = "2022.13.29.0"
             @env = case env
                 when "sbx"
                     "https://api.sbx.lockstep.io/"
@@ -259,7 +259,7 @@ module LockstepSdk
             request["Accept"] = 'application/json'
             request["Content-Type"] = 'application/*+json'
             request["SdkType"] = 'Ruby'
-            request["SdkVersion"] = '2022.11.60.0'
+            request["SdkVersion"] = '2022.13.29.0'
             request["MachineName"] = Socket.gethostname
             request.body = body
 

data/lib/lockstep_sdk/models/company_model.rb

@@ -48,6 +48,7 @@ module LockstepSdk
             @state_region = params.dig(:state_region)
             @postal_code = params.dig(:postal_code)
             @country = params.dig(:country)
+            @time_zone = params.dig(:time_zone)
             @phone_number = params.dig(:phone_number)
             @fax_number = params.dig(:fax_number)
             @created = params.dig(:created)
@@ -149,6 +150,10 @@ module LockstepSdk
         # @return [String] Address info
         attr_accessor :country
 
+        ##
+        # @return [String] Time zone
+        attr_accessor :time_zone
+
         ##
         # @return [String] Phone number
         attr_accessor :phone_number
@@ -264,6 +269,7 @@ module LockstepSdk
                 'stateRegion' => @state_region,
                 'postalCode' => @postal_code,
                 'country' => @country,
+                'timeZone' => @time_zone,
                 'phoneNumber' => @phone_number,
                 'faxNumber' => @fax_number,
                 'created' => @created,

data/lib/lockstep_sdk/models/user_account_model.rb

@@ -53,6 +53,7 @@ module LockstepSdk
             @state_region = params.dig(:state_region)
             @postal_code = params.dig(:postal_code)
             @country = params.dig(:country)
+            @time_zone = params.dig(:time_zone)
             @image_url = params.dig(:image_url)
             @description = params.dig(:description)
             @b2_clast_logged_in = params.dig(:b2_clast_logged_in)
@@ -159,6 +160,10 @@ module LockstepSdk
         # @return [String] Country for this User This will be validated by the /api/v1/definitions/countries data set
         attr_accessor :country
 
+        ##
+        # @return [String] Time zone for this user
+        attr_accessor :time_zone
+
         ##
         # @return [String] Image URL for this User
         attr_accessor :image_url
@@ -219,6 +224,7 @@ module LockstepSdk
                 'stateRegion' => @state_region,
                 'postalCode' => @postal_code,
                 'country' => @country,
+                'timeZone' => @time_zone,
                 'imageURL' => @image_url,
                 'description' => @description,
                 'b2CLastLoggedIn' => @b2_clast_logged_in,

data/lib/lockstep_sdk/version.rb

@@ -1,3 +1,3 @@
 module LockstepSdk
-    VERSION = "2022.11.60.0"
+    VERSION = "2022.13.29.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_sdk
 version: !ruby/object:Gem::Version
-  version: 2022.11.60.0
+  version: 2022.13.29.0
 platform: ruby
 authors:
 - Lockstep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-21 00:00:00.000000000 Z
+date: 2022-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awrence