lockstep_sdk 2022.10.63.0 → 2022.11.60.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba9d5a2c92fb2c8df1dfe1eb381076c1054629fa0f9d2488f9513af0161fd019
-  data.tar.gz: 53389e8077c628152038c5faf8ccb725131f3e1581454a8ea245b59967879c35
+  metadata.gz: e1eeb25332f1e77648c3c8095e5278dd4a55ca884cf75f247117bb82fa6a971d
+  data.tar.gz: 86447fcd008f763888e67b7a676109a6c699f1bea078184991973a8d14f72a5b
 SHA512:
-  metadata.gz: c8e4b59b277980e0683c8701f8478884c38fd2bec93e1b77a19f249fc5b28e13356ead3e368a64efa348b90b256e8be01763716d3811b77c7b4e7294af82738e
-  data.tar.gz: 729cf53e3c23136505313854eabfedd8cbe05bd88a01b622f00f32cef134fd4f2d488f8036a4f99db23012cefbdeb8bfaaff6eb7952ed65f36e9debce0bcc691
+  metadata.gz: 9aa52c138d3af69f0c40cecf45aad402cab415ee8bebccbed911582cfdb5bd9cafe85db0cf2b8d9564b990675e4db07834aa15b14230b20f78e615b5f1c22e12
+  data.tar.gz: 16ac85a7c7d6c94c82b879a1f21238c2130ba8115fb1c038ebb8950738a6502b29d592b6dd03fa82e48bae9e600a2d4b0150fda3ac851c17fd9ace9235423c34

data/lib/lockstep_sdk/clients/attachments_client.rb

@@ -78,8 +78,21 @@ class AttachmentsClient
     # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
     #
     # @param id [uuid] The unique ID number of the Attachment whose URI will be returned
-    def download_attachment(id:)
-        path = "/api/v1/Attachments/#{id}/download"
+    def download_attachment_url(id:)
+        path = "/api/v1/Attachments/#{id}/download-url"
+        @lockstepsdk.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Returns the Attachment file to be downloaded, based on the ID provided.
+    #
+    # An Attachment is a file that can be attached to various account attributes within Lockstep. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.
+    #
+    # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param id [uuid] The unique ID number of the Attachment whose URI will be returned
+    def download_attachment_file(id:)
+        path = "/api/v1/Attachments/#{id}/download-file"
         @lockstepsdk.request(:get, path, nil, nil)
     end
 

data/lib/lockstep_sdk/clients/financial_account_balance_history_client.rb

@@ -32,7 +32,7 @@ class FinancialAccountBalanceHistoryClient
     # A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.
     #
     # @param id [uuid] The unique Lockstep Platform ID number of this Financial Account Balance History
-    def retrieve_financial_account_balance_history(id:)
+    def retrieve_balance_history(id:)
         path = "/api/v1/FinancialAccountBalanceHistory/#{id}"
         @lockstepsdk.request(:get, path, nil, nil)
     end
@@ -46,7 +46,7 @@ class FinancialAccountBalanceHistoryClient
     #
     # @param id [uuid] The unique Lockstep Platform ID number of the Financial Account Balance History to update
     # @param body [object] A list of changes to apply to this Financial Account Balance History
-    def update_financial_account_balance_history(id:, body:)
+    def update_balance_history(id:, body:)
         path = "/api/v1/FinancialAccountBalanceHistory/#{id}"
         @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
     end
@@ -57,7 +57,7 @@ class FinancialAccountBalanceHistoryClient
     # A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.
     #
     # @param id [uuid] The unique Lockstep Platform ID number of the Financial Account Balance History to disable
-    def delete_financial_account_balance_history(id:)
+    def delete_balance_history(id:)
         path = "/api/v1/FinancialAccountBalanceHistory/#{id}"
         @lockstepsdk.request(:delete, path, nil, nil)
     end
@@ -68,7 +68,7 @@ class FinancialAccountBalanceHistoryClient
     # A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.
     #
     # @param body [FinancialAccountBalanceHistoryModel] The Financial Account Balance Histories to create
-    def create_financial_account_balance_history(body:)
+    def create_balance_history(body:)
         path = "/api/v1/FinancialAccountBalanceHistory"
         @lockstepsdk.request(:post, path, body, nil)
     end
@@ -84,7 +84,7 @@ class FinancialAccountBalanceHistoryClient
     # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
-    def query_financial_account_balance_history(filter:, order:, page_size:, page_number:)
+    def query_balance_history(filter:, order:, page_size:, page_number:)
         path = "/api/v1/FinancialAccountBalanceHistory/query"
         params = {:filter => filter, :order => order, :pageSize => page_size, :pageNumber => page_number}
         @lockstepsdk.request(:get, path, nil, params)

data/lib/lockstep_sdk/clients/invoices_client.rb

@@ -134,7 +134,7 @@ class InvoicesClient
     # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
-    def query_at_risk_invoice_summary_view(filter:, include_param:, order:, page_size:, page_number:)
+    def query_at_risk_view(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/Invoices/views/at-risk-summary"
         params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
         @lockstepsdk.request(:get, path, nil, params)

data/lib/lockstep_sdk/clients/reports_client.rb

@@ -114,8 +114,6 @@ class ReportsClient
     ##
     # Generates a Trial Balance Report for the given time range.
     #
-    # The Attachment Header report contains aggregated information about the `TotalAttachments`, `TotalArchived`, and `TotalActive` attachment classifications.
-    #
     # @param start_date [date-time] 
     # @param end_date [date-time] 
     def trial_balance_report(start_date:, end_date:)
@@ -123,4 +121,17 @@ class ReportsClient
         params = {:startDate => start_date, :endDate => end_date}
         @lockstepsdk.request(:get, path, nil, params)
     end
+
+    ##
+    # Generates an Income Statement for the given time range.
+    #
+    # @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:)
+        path = "/api/v1/Reports/income-statement"
+        params = {:startDate => start_date, :endDate => end_date, :columnOption => column_option, :displayDepth => display_depth}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
 end

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.10.63.0
+# @version    2022.11.60.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.10.63.0"
+            @version = "2022.11.60.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.10.63.0'
+            request["SdkVersion"] = '2022.11.60.0'
             request["MachineName"] = Socket.gethostname
             request.body = body
 

data/lib/lockstep_sdk/models/bulk_currency_conversion_model.rb

@@ -34,7 +34,7 @@ module LockstepSdk
         attr_accessor :date
 
         ##
-        # @return [String] The currency code This will be validated by the /api/v1/currencies data set
+        # @return [String] The currency code This will be validated by the /api/v1/definitions/currencies data set
         attr_accessor :source_currency
 
         ##

data/lib/lockstep_sdk/models/company_sync_model.rb

@@ -84,7 +84,7 @@ module LockstepSdk
         attr_accessor :is_active
 
         ##
-        # @return [String] The default currency code for transactions related to this company. For a list of currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies). This will be validated by the /api/v1/currencies data set
+        # @return [String] The default currency code for transactions related to this company. For a list of currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies). This will be validated by the /api/v1/definitions/currencies data set
         attr_accessor :default_currency_code
 
         ##
@@ -120,7 +120,7 @@ module LockstepSdk
         attr_accessor :postal_code
 
         ##
-        # @return [String] The company's primary mailing address information This will be validated by the /api/v1/countries data set
+        # @return [String] The company's primary mailing address information This will be validated by the /api/v1/definitions/countries data set
         attr_accessor :country
 
         ##

data/lib/lockstep_sdk/models/contact_model.rb

@@ -129,7 +129,7 @@ module LockstepSdk
         attr_accessor :postal_code
 
         ##
-        # @return [String] The two character country code of the address. This will be validated by the /api/v1/countries data set
+        # @return [String] The two character country code of the address. This will be validated by the /api/v1/definitions/countries data set
         attr_accessor :country_code
 
         ##

data/lib/lockstep_sdk/models/contact_sync_model.rb

@@ -117,7 +117,7 @@ module LockstepSdk
         attr_accessor :postal_code
 
         ##
-        # @return [String] The mailing address information for this contact. This will be validated by the /api/v1/countries data set
+        # @return [String] The mailing address information for this contact. This will be validated by the /api/v1/definitions/countries data set
         attr_accessor :country_code
 
         ##

data/lib/lockstep_sdk/models/financial_account_model.rb

@@ -80,7 +80,7 @@ module LockstepSdk
         attr_accessor :description
 
         ##
-        # @return [String] The classification for the Financial Account. Possible values are Asset, Equity, Expense, Liability or Revenue.
+        # @return [String] The classification for the Financial Account. Possible values are Asset, Equity, Expense, Liability or Income.
         attr_accessor :classification
 
         ##

data/lib/lockstep_sdk/models/invoice_history_model.rb

@@ -119,7 +119,7 @@ module LockstepSdk
         attr_accessor :special_terms
 
         ##
-        # @return [String] The three-character ISO 4217 currency code used for this invoice. This will be validated by the /api/v1/currencies data set
+        # @return [String] The three-character ISO 4217 currency code used for this invoice. This will be validated by the /api/v1/definitions/currencies data set
         attr_accessor :currency_code
 
         ##

data/lib/lockstep_sdk/models/invoice_line_sync_model.rb

@@ -154,7 +154,7 @@ module LockstepSdk
         attr_accessor :origin_address_postal_code
 
         ##
-        # @return [String] Origination address for this invoice line, if this line item was originated from a different address This will be validated by the /api/v1/countries data set
+        # @return [String] Origination address for this invoice line, if this line item was originated from a different address This will be validated by the /api/v1/definitions/countries data set
         attr_accessor :origin_address_country
 
         ##
@@ -190,7 +190,7 @@ module LockstepSdk
         attr_accessor :bill_to_address_postal_code
 
         ##
-        # @return [String] Billing address for this invoice line, if this line item is to be billed to a different address This will be validated by the /api/v1/countries data set
+        # @return [String] Billing address for this invoice line, if this line item is to be billed to a different address This will be validated by the /api/v1/definitions/countries data set
         attr_accessor :bill_to_address_country
 
         ##
@@ -226,7 +226,7 @@ module LockstepSdk
         attr_accessor :ship_to_address_postal_code
 
         ##
-        # @return [String] Shipping address for this invoice line, if this line item is to be shipped to a different address This will be validated by the /api/v1/countries data set
+        # @return [String] Shipping address for this invoice line, if this line item is to be shipped to a different address This will be validated by the /api/v1/definitions/countries data set
         attr_accessor :ship_to_address_country
 
         ##

data/lib/lockstep_sdk/models/invoice_sync_model.rb

@@ -133,7 +133,7 @@ module LockstepSdk
         attr_accessor :special_terms
 
         ##
-        # @return [String] The three-character ISO 4217 currency code used for this invoice. This will be validated by the /api/v1/currencies data set
+        # @return [String] The three-character ISO 4217 currency code used for this invoice. This will be validated by the /api/v1/definitions/currencies data set
         attr_accessor :currency_code
 
         ##
@@ -201,7 +201,7 @@ module LockstepSdk
         attr_accessor :origin_address_postal_code
 
         ##
-        # @return [String] The origination address for this invoice This will be validated by the /api/v1/countries data set
+        # @return [String] The origination address for this invoice This will be validated by the /api/v1/definitions/countries data set
         attr_accessor :origin_address_country
 
         ##
@@ -237,7 +237,7 @@ module LockstepSdk
         attr_accessor :bill_to_address_postal_code
 
         ##
-        # @return [String] The billing address for this invoice This will be validated by the /api/v1/countries data set
+        # @return [String] The billing address for this invoice This will be validated by the /api/v1/definitions/countries data set
         attr_accessor :bill_to_address_country
 
         ##
@@ -273,7 +273,7 @@ module LockstepSdk
         attr_accessor :ship_to_address_postal_code
 
         ##
-        # @return [String] The shipping address for this invoice This will be validated by the /api/v1/countries data set
+        # @return [String] The shipping address for this invoice This will be validated by the /api/v1/definitions/countries data set
         attr_accessor :ship_to_address_country
 
         ##

data/lib/lockstep_sdk/models/payment_model.rb

@@ -108,7 +108,7 @@ module LockstepSdk
         attr_accessor :unapplied_amount
 
         ##
-        # @return [String] The ISO 4217 currency code for this payment. For a list of ISO 4217 currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies). This will be validated by the /api/v1/currencies data set
+        # @return [String] The ISO 4217 currency code for this payment. For a list of ISO 4217 currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies). This will be validated by the /api/v1/definitions/currencies data set
         attr_accessor :currency_code
 
         ##

data/lib/lockstep_sdk/models/payment_sync_model.rb

@@ -92,7 +92,7 @@ module LockstepSdk
         attr_accessor :unapplied_amount
 
         ##
-        # @return [String] The ISO 4217 currency code for this payment. For a list of ISO 4217 currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies). This will be validated by the /api/v1/currencies data set
+        # @return [String] The ISO 4217 currency code for this payment. For a list of ISO 4217 currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies). This will be validated by the /api/v1/definitions/currencies data set
         attr_accessor :currency_code
 
         ##

data/lib/lockstep_sdk/models/user_account_model.rb

@@ -156,7 +156,7 @@ module LockstepSdk
         attr_accessor :postal_code
 
         ##
-        # @return [String] Country for this User This will be validated by the /api/v1/countries data set
+        # @return [String] Country for this User This will be validated by the /api/v1/definitions/countries data set
         attr_accessor :country
 
         ##
@@ -172,7 +172,7 @@ module LockstepSdk
         attr_accessor :b2_clast_logged_in
 
         ##
-        # @return [String] The default currency code used by this user entity. This value can be overridden for invoices in a different currency code. For a list of defined currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies) This will be validated by the /api/v1/currencies data set
+        # @return [String] The default currency code used by this user entity. This value can be overridden for invoices in a different currency code. For a list of defined currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies) This will be validated by the /api/v1/definitions/currencies data set
         attr_accessor :default_currency_code
 
         ##

data/lib/lockstep_sdk/version.rb

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

metadata

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