lockstep_sdk 2022.14.30.0 → 2022.15.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddabc9b518b210ddca37c92a960c90ca21a66089d16b914fc350bef2bdf212af
-  data.tar.gz: 9e3749fee84c3601176781e6b27ee9d40baf5a29cfd4f4ca61ad3b6b25d8b6c1
+  metadata.gz: db7e3496b7001944a321582839b31f4372d8aead48d098015e179fe707a38615
+  data.tar.gz: 0144027ade1421e3805078360dcf3901a0c8330cfde7c34e1cff2a4119eee168
 SHA512:
-  metadata.gz: 37d4b9c701f44f46d1a753726b3a346f5c4585b1ab5778f1738eca741102e1cae5e7f56dbf47a020949ce110118a726ebeca0d7829ec434cdd097707d9ee2cc5
-  data.tar.gz: 49d36d2a323d269ce421335f788cf5fb84af268102e4dc36244ddadb60b8fbeefbe78ce1b4656e4a5d4d1e35b45cdec839569b0844de781cda829a4efcb42b6c
+  metadata.gz: d6697e4b9f8941ff2bbe82753c4174f23a1a1012c72ddffda77adc5a20b36445f6dffa8d9ba1b21cb044bc8b5e66085acce1efa9f7f44ab33a49357eb10483fe
+  data.tar.gz: f8cd7f1249bd6b879484b30fbb6859da94870c0726f9972ff7ceb7fb072c38d0e13509efa2a0a5d7b2a62aaedb3b0abed29187e266622a8d619d9fbb92e1e644

data/lib/lockstep_sdk/clients/reports_client.rb

@@ -112,8 +112,8 @@ class ReportsClient
     ##
     # Generates a Trial Balance Report for the given time range.
     #
-    # @param start_date [date-time] 
-    # @param end_date [date-time] 
+    # @param start_date [date-time] The start date of the report
+    # @param end_date [date-time] The end date of the report
     def trial_balance_report(start_date:, end_date:)
         path = "/api/v1/Reports/trial-balance"
         params = {:startDate => start_date, :endDate => end_date}

data/lib/lockstep_sdk/lockstep_api.rb

@@ -9,7 +9,7 @@
 # @author     Lockstep Network <support@lockstep.io>
 #             Manish Narayan B S <manish.n@lockstep.io>, Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
-# @version    2022.13.29
+# @version    2022.15.31
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -158,7 +158,7 @@ module lockstep_sdk
         #
         # @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
         def initialize(env)
-            @version = "2022.13.29.0"
+            @version = "2022.15.31.0"
             @env = case env
                 when "sbx"
                     "https://api.sbx.lockstep.io/"
@@ -204,6 +204,8 @@ module lockstep_sdk
         ##
         # Configure this API client to use API key authentication
         #
+        # Authentication is either via [Lockstep Platform API key](https://developer.lockstep.io/docs/api-keys) or [JWT Bearer Token](https://developer.lockstep.io/docs/jwt-bearer-tokens)
+        #
         # @param api_key [string] The API Key to use for authentication
         def with_api_key(api_key)
             @bearer_token = nil
@@ -213,6 +215,8 @@ module lockstep_sdk
         ##
         # Configure this API client to use JWT Bearer Token authentication
         #
+        # Authentication is either via [Lockstep Platform API key](https://developer.lockstep.io/docs/api-keys) or [JWT Bearer Token](https://developer.lockstep.io/docs/jwt-bearer-tokens)
+        #
         # @param bearer_token [string] The Bearer Token to use for authentication
         def with_bearer_token(bearer_token)
             @api_key = nil
@@ -258,7 +262,7 @@ module lockstep_sdk
             request["Accept"] = 'application/json'
             request["Content-Type"] = 'application/*+json'
             request["SdkType"] = 'Ruby'
-            request["SdkVersion"] = '2022.13.29.0'
+            request["SdkVersion"] = '2022.15.31.0'
             request["MachineName"] = Socket.gethostname
             request.body = body
 

data/lib/lockstep_sdk/models/contact_sync_model.rb

@@ -55,7 +55,7 @@ module LockstepSdk
         end
 
         ##
-        # @return [String] This is the primary key of the Contact record. For this field, you should use whatever the contact's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your contact records in a database, whatever the primary key for the contact table is in the database should be the "ErpKey". For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+        # @return [String] This is the primary key of the Contact record. For this field, you should use whatever the contact's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your contact records in a database, whatever the primary key for the contact table is in the database should be the "ErpKey". As some ERP systems don't maintain a unique key for Contacts, we also support syncing Contacts with ERP keys of the form {CompanyErpKey}|{index}, for example CompanyErpKey|1, CompanyErpKey|2 and so on. For this reason, please ensure that your Company/Contact ERP keys don't contain the '|' symbol or that it is replaced by an alternate symbol if they do. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
         attr_accessor :erp_key
 
         ##

data/lib/lockstep_sdk/models/developer_account_submit_model.rb

@@ -24,6 +24,8 @@ module LockstepSdk
         # Initialize the DeveloperAccountSubmitModel using the provided prototype
         def initialize(params = {})
             @name = params.dig(:name)
+            @first_name = params.dig(:first_name)
+            @last_name = params.dig(:last_name)
             @email = params.dig(:email)
             @company_name = params.dig(:company_name)
         end
@@ -32,6 +34,14 @@ module LockstepSdk
         # @return [String] The name of the developer.
         attr_accessor :name
 
+        ##
+        # @return [String] The first name of the person requesting the developer account.
+        attr_accessor :first_name
+
+        ##
+        # @return [String] The last name of the person requesting the developer account.
+        attr_accessor :last_name
+
         ##
         # @return [Email] The email address of the developer.
         attr_accessor :email
@@ -45,6 +55,8 @@ module LockstepSdk
         def as_json(options={})
             {
                 'name' => @name,
+                'firstName' => @first_name,
+                'lastName' => @last_name,
                 'email' => @email,
                 'companyName' => @company_name,
             }

data/lib/lockstep_sdk/models/invoice_sync_model.rb

@@ -115,7 +115,7 @@ module LockstepSdk
         attr_accessor :salesperson_code
 
         ##
-        # @return [String] A code identifying the type of this invoice. Recognized Invoice types are: * `Invoice` - Represents an invoice sent by Company to the Customer * `AP Invoice` - Represents an invoice sent by Customer to the Company * `Credit Memo` - Represents a credit memo generated by Customer given to Company
+        # @return [String] A code identifying the type of this invoice. Recognized Invoice types are: * `Invoice` - Represents an invoice sent by Company to the Customer * `AP Invoice` - Represents an invoice sent by Vendor to the Company * `Credit Memo` - Represents a credit memo generated by Company given to Customer * `AP Credit Memo` - Represents a credit memo generated by Vendor given to Company
         attr_accessor :invoice_type_code
 
         ##

data/lib/lockstep_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_sdk
 version: !ruby/object:Gem::Version
-  version: 2022.14.30.0
+  version: 2022.15.31.0
 platform: ruby
 authors:
 - Lockstep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-11 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awrence
@@ -32,7 +32,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/LockstepSdk/lockstep_api.rb
 - lib/lockstep_sdk/clients/activities_client.rb
 - lib/lockstep_sdk/clients/api_keys_client.rb
 - lib/lockstep_sdk/clients/app_enrollments_client.rb

data/lib/LockstepSdk/lockstep_api.rb

@@ -1,287 +0,0 @@
-#
-# Lockstep Platform SDK for Ruby
-#
-# (c) 2021-2022 Lockstep, Inc.
-#
-# For the full copyright and license information, please view the LICENSE
-# file that was distributed with this source code.
-#
-# @author     Lockstep Network <support@lockstep.io>
-#             Manish Narayan B S <manish.n@lockstep.io>, Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
-# @copyright  2021-2022 Lockstep, Inc.
-# @version    2022.14.30
-# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
-#
-
-require 'net/http'
-require 'openssl'
-require 'uri'
-require 'socket'
-
-project_root = File.dirname(File.absolute_path(__FILE__))
-Dir.glob(project_root + '/clients/*') {|file| require file}
-
-module LockstepSdk
-    class LockstepApi
-    
-        ##
-        # @return [String] The version number of this API client
-        attr_accessor :version
-
-        ##
-        # @return [String] The name or URL of the environment
-        attr_accessor :env 
-
-        ##
-        # @return [ActivitiesClient] Client object for Activities endpoints
-        attr_accessor :activities
-
-        ##
-        # @return [ApiKeysClient] Client object for ApiKeys endpoints
-        attr_accessor :api_keys
-
-        ##
-        # @return [AppEnrollmentsClient] Client object for AppEnrollments endpoints
-        attr_accessor :app_enrollments
-
-        ##
-        # @return [ApplicationsClient] Client object for Applications endpoints
-        attr_accessor :applications
-
-        ##
-        # @return [AttachmentsClient] Client object for Attachments endpoints
-        attr_accessor :attachments
-
-        ##
-        # @return [CodeDefinitionsClient] Client object for CodeDefinitions endpoints
-        attr_accessor :code_definitions
-
-        ##
-        # @return [CompaniesClient] Client object for Companies endpoints
-        attr_accessor :companies
-
-        ##
-        # @return [ContactsClient] Client object for Contacts endpoints
-        attr_accessor :contacts
-
-        ##
-        # @return [CreditMemoAppliedClient] Client object for CreditMemoApplied endpoints
-        attr_accessor :credit_memo_applied
-
-        ##
-        # @return [CurrenciesClient] Client object for Currencies endpoints
-        attr_accessor :currencies
-
-        ##
-        # @return [CustomFieldDefinitionsClient] Client object for CustomFieldDefinitions endpoints
-        attr_accessor :custom_field_definitions
-
-        ##
-        # @return [CustomFieldValuesClient] Client object for CustomFieldValues endpoints
-        attr_accessor :custom_field_values
-
-        ##
-        # @return [DefinitionsClient] Client object for Definitions endpoints
-        attr_accessor :definitions
-
-        ##
-        # @return [EmailsClient] Client object for Emails endpoints
-        attr_accessor :emails
-
-        ##
-        # @return [FinancialAccountClient] Client object for FinancialAccount endpoints
-        attr_accessor :financial_account
-
-        ##
-        # @return [FinancialAccountBalanceHistoryClient] Client object for FinancialAccountBalanceHistory endpoints
-        attr_accessor :financial_account_balance_history
-
-        ##
-        # @return [FinancialYearSettingsClient] Client object for FinancialYearSettings endpoints
-        attr_accessor :financial_year_settings
-
-        ##
-        # @return [InvoiceHistoryClient] Client object for InvoiceHistory endpoints
-        attr_accessor :invoice_history
-
-        ##
-        # @return [InvoicesClient] Client object for Invoices endpoints
-        attr_accessor :invoices
-
-        ##
-        # @return [LeadsClient] Client object for Leads endpoints
-        attr_accessor :leads
-
-        ##
-        # @return [NotesClient] Client object for Notes endpoints
-        attr_accessor :notes
-
-        ##
-        # @return [PaymentApplicationsClient] Client object for PaymentApplications endpoints
-        attr_accessor :payment_applications
-
-        ##
-        # @return [PaymentsClient] Client object for Payments endpoints
-        attr_accessor :payments
-
-        ##
-        # @return [ProvisioningClient] Client object for Provisioning endpoints
-        attr_accessor :provisioning
-
-        ##
-        # @return [ReportsClient] Client object for Reports endpoints
-        attr_accessor :reports
-
-        ##
-        # @return [StatusClient] Client object for Status endpoints
-        attr_accessor :status
-
-        ##
-        # @return [SyncClient] Client object for Sync endpoints
-        attr_accessor :sync
-
-        ##
-        # @return [UserAccountsClient] Client object for UserAccounts endpoints
-        attr_accessor :user_accounts
-
-        ##
-        # @return [UserRolesClient] Client object for UserRoles endpoints
-        attr_accessor :user_roles
-
-        ##
-        # @return [WebhooksClient] Client object for Webhooks endpoints
-        attr_accessor :webhooks
-
-
-        ##
-        # Construct a new API client targeting the specified server.
-        #
-        # @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
-        def initialize(env)
-            @version = "2022.14.30.0"
-            @env = case env
-                when "sbx"
-                    "https://api.sbx.lockstep.io/"
-                when "prd"
-                    "https://api.lockstep.io/"
-                else
-                    env
-                end
-                
-            # Construct all the clients
-            @activities = ActivitiesClient.new(self)
-            @api_keys = ApiKeysClient.new(self)
-            @app_enrollments = AppEnrollmentsClient.new(self)
-            @applications = ApplicationsClient.new(self)
-            @attachments = AttachmentsClient.new(self)
-            @code_definitions = CodeDefinitionsClient.new(self)
-            @companies = CompaniesClient.new(self)
-            @contacts = ContactsClient.new(self)
-            @credit_memo_applied = CreditMemoAppliedClient.new(self)
-            @currencies = CurrenciesClient.new(self)
-            @custom_field_definitions = CustomFieldDefinitionsClient.new(self)
-            @custom_field_values = CustomFieldValuesClient.new(self)
-            @definitions = DefinitionsClient.new(self)
-            @emails = EmailsClient.new(self)
-            @financial_account = FinancialAccountClient.new(self)
-            @financial_account_balance_history = FinancialAccountBalanceHistoryClient.new(self)
-            @financial_year_settings = FinancialYearSettingsClient.new(self)
-            @invoice_history = InvoiceHistoryClient.new(self)
-            @invoices = InvoicesClient.new(self)
-            @leads = LeadsClient.new(self)
-            @notes = NotesClient.new(self)
-            @payment_applications = PaymentApplicationsClient.new(self)
-            @payments = PaymentsClient.new(self)
-            @provisioning = ProvisioningClient.new(self)
-            @reports = ReportsClient.new(self)
-            @status = StatusClient.new(self)
-            @sync = SyncClient.new(self)
-            @user_accounts = UserAccountsClient.new(self)
-            @user_roles = UserRolesClient.new(self)
-            @webhooks = WebhooksClient.new(self)
-        end
-
-        ##
-        # Configure this API client to use API key authentication
-        #
-        # Authentication is either via [Lockstep Platform API key](https://developer.lockstep.io/docs/api-keys) or [JWT Bearer Token](https://developer.lockstep.io/docs/jwt-bearer-tokens)
-        #
-        # @param api_key [string] The API Key to use for authentication
-        def with_api_key(api_key)
-            @bearer_token = nil
-            @api_key = api_key
-        end
-
-        ##
-        # Configure this API client to use JWT Bearer Token authentication
-        #
-        # Authentication is either via [Lockstep Platform API key](https://developer.lockstep.io/docs/api-keys) or [JWT Bearer Token](https://developer.lockstep.io/docs/jwt-bearer-tokens)
-        #
-        # @param bearer_token [string] The Bearer Token to use for authentication
-        def with_bearer_token(bearer_token)
-            @api_key = nil
-            @bearer_token = bearer_token
-        end
-
-        ##
-        # Configure this API to use an application name
-        #
-        # @param app_name [string] The name of the application
-        def with_app_name(app_name)
-            @app_name = app_name
-        end
-
-        ##
-        # Send a request to the API and return the results
-        #
-        # Sends a request to the 
-        def request(method, path, body, params)
-        
-            url = URI(@env + path)
-            if !params.nil?  
-                url.query = URI.encode_www_form(params)
-            end
-            
-            http = Net::HTTP.new(url.host, url.port)
-            http.use_ssl = true
-            
-            request = case method
-                when :get
-                    Net::HTTP::Get.new(url)
-                when :post
-                    Net::HTTP::Post.new(url)
-                when :patch
-                    Net::HTTP::Patch.new(url)
-                when :put
-                    Net::HTTP::Put.new(url)
-                when :delete
-                    Net::HTTP::Delete.new(url)
-                end
-                
-            # Set headers and body for request
-            request["Accept"] = 'application/json'
-            request["Content-Type"] = 'application/*+json'
-            request["SdkType"] = 'Ruby'
-            request["SdkVersion"] = '2022.14.30.0'
-            request["MachineName"] = Socket.gethostname
-            request.body = body
-
-            # If there is an application name
-            if @app_name != nil
-                request["ApplicationName"] = @app_name
-            end
-
-            # Which authentication are we using?
-            if @api_key != nil 
-              request["Api-Key"] = @api_key
-            end
-            if @bearer_token != nil 
-              request["Authorization"] = 'Bearer ' + @bearer_token
-            end
-            
-            # Send the request
-            response = http.request(request)
-            response.read_body
-        end
-    end   
-end