lockstep_sdk 2022.4.32.0 → 2022.6.49.0

data/lib/lockstep_sdk/models/batch_sync_model.rb

@@ -0,0 +1,99 @@
+#
+# Lockstep Software Development Kit 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     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # A BatchSyncModel contains a collection of records to load into the Lockstep Platform.  Data contained
+    # in this batch will be merged with your existing data.  Each record will be matched with existing data inside
+    # the Lockstep Platform using the [Identity Column](https://developer.lockstep.io/docs/identity-columns) rules.
+    # Any record that represents a new AppEnrollmentId+ErpKey will be inserted.  A record that matches an existing
+    # AppEnrollmentId+ErpKey will be updated, but only if the data has changed.
+    #
+    # A Sync process permits either a complete data file or a partial / delta data file.  Lockstep recommends
+    # using a sliding time window to avoid the risk of clock skew errors that might accidentally omit records.
+    # Best practice is to run a Sync process daily, and to export all data that has changed in the past 48 hours.
+    class BatchSyncModel
+
+        ##
+        # Initialize the BatchSyncModel using the provided prototype
+        def initialize(params = {})
+            @companies = params.dig(:companies)
+            @contacts = params.dig(:contacts)
+            @credit_memo_applications = params.dig(:credit_memo_applications)
+            @invoices = params.dig(:invoices)
+            @invoice_lines = params.dig(:invoice_lines)
+            @custom_fields = params.dig(:custom_fields)
+            @payments = params.dig(:payments)
+            @payment_applications = params.dig(:payment_applications)
+        end
+
+        ##
+        # @return [CompanySyncModel] A list of Company records to merge with your Lockstep Platform data
+        attr_accessor :companies
+
+        ##
+        # @return [ContactSyncModel] A list of Contact records to merge with your Lockstep Platform data
+        attr_accessor :contacts
+
+        ##
+        # @return [CreditMemoAppliedSyncModel] A list of CreditMemoApplied records to merge with your Lockstep Platform data
+        attr_accessor :credit_memo_applications
+
+        ##
+        # @return [InvoiceSyncModel] A list of Invoice records to merge with your Lockstep Platform data
+        attr_accessor :invoices
+
+        ##
+        # @return [InvoiceLineSyncModel] A list of InvoiceLine records to merge with your Lockstep Platform data
+        attr_accessor :invoice_lines
+
+        ##
+        # @return [CustomFieldSyncModel] A list of CustomField records to merge with your Lockstep Platform data
+        attr_accessor :custom_fields
+
+        ##
+        # @return [PaymentSyncModel] A list of Payment records to merge with your Lockstep Platform data
+        attr_accessor :payments
+
+        ##
+        # @return [PaymentAppliedSyncModel] A list of PaymentApplied records to merge with your Lockstep Platform data
+        attr_accessor :payment_applications
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'companies' => @companies,
+                'contacts' => @contacts,
+                'creditMemoApplications' => @credit_memo_applications,
+                'invoices' => @invoices,
+                'invoiceLines' => @invoice_lines,
+                'customFields' => @custom_fields,
+                'payments' => @payments,
+                'paymentApplications' => @payment_applications,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/bulk_currency_conversion_model.rb

@@ -10,7 +10,6 @@
 # @author     Manish Narayan B S <manish.n@lockstep.io>
 # @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
-# @version    2022.4
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/cashflow_report_model.rb

@@ -10,7 +10,6 @@
 # @author     Manish Narayan B S <manish.n@lockstep.io>
 # @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
-# @version    2022.4
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/code_definition_model.rb

@@ -10,7 +10,6 @@
 # @author     Manish Narayan B S <manish.n@lockstep.io>
 # @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
-# @version    2022.4
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/company_model.rb

@@ -10,7 +10,6 @@
 # @author     Manish Narayan B S <manish.n@lockstep.io>
 # @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
-# @version    2022.4
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/company_sync_model.rb

@@ -0,0 +1,195 @@
+#
+# Lockstep Software Development Kit 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     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # The CompanySyncModel represents information coming into Lockstep from an external financial system or other
+    # enterprise resource planning system.  To import data from an external system, convert your original data into
+    # the CompanySyncModel format and call the [Upload Sync File API](https://developer.lockstep.io/reference/post_api-v1-sync-zip).
+    # This API retrieves all of the data you uploaded in a compressed ZIP file and imports it into the Lockstep
+    # platform.
+    #
+    # Once imported, this record will be available in the Lockstep API as a [CompanyModel](https://developer.lockstep.io/docs/companymodel).
+    #
+    # For more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data).
+    class CompanySyncModel
+
+        ##
+        # Initialize the CompanySyncModel using the provided prototype
+        def initialize(params = {})
+            @erp_key = params.dig(:erp_key)
+            @company_name = params.dig(:company_name)
+            @company_type = params.dig(:company_type)
+            @company_status = params.dig(:company_status)
+            @parent_company_erp_key = params.dig(:parent_company_erp_key)
+            @is_active = params.dig(:is_active)
+            @default_currency_code = params.dig(:default_currency_code)
+            @company_logo_url = params.dig(:company_logo_url)
+            @primary_contact_erp_key = params.dig(:primary_contact_erp_key)
+            @address1 = params.dig(:address1)
+            @address2 = params.dig(:address2)
+            @address3 = params.dig(:address3)
+            @city = params.dig(:city)
+            @state_region = params.dig(:state_region)
+            @postal_code = params.dig(:postal_code)
+            @country = params.dig(:country)
+            @phone_number = params.dig(:phone_number)
+            @fax_number = params.dig(:fax_number)
+            @created = params.dig(:created)
+            @modified = params.dig(:modified)
+            @tax_id = params.dig(:tax_id)
+            @duns_number = params.dig(:duns_number)
+            @ap_email_address = params.dig(:ap_email_address)
+            @ar_email_address = params.dig(:ar_email_address)
+        end
+
+        ##
+        # @return [String] This is the primary key of the Company record. For this field, you should use whatever the company'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 company records in a database, whatever the primary key for the company table is in the database should be the `ErpKey`. Example: If you use a financial system such as Quickbooks or Xero, look for the primary ID number of the company record within that financial system. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+        attr_accessor :erp_key
+
+        ##
+        # @return [String] A friendly, short name of the company.
+        attr_accessor :company_name
+
+        ##
+        # @return [String] This field indicates the type of company. It can be one of a limited number of values: `Company`, `Customer`, `Group`, `Vendor`, or `Third Party`. A company that represents both a customer and a vendor is identified as a `CustomerVendor`. When loading data into Lockstep, you should focus on the distinction between a company that is part of your own enterprise, or a company that is external to your enterprise. For a company that is within your enterprise, you should set this value to be `Company`. For a company that is external to your enterprise, you should set this value to either `Customer`, `Vendor`, `Third Party`, or `CustomerVendor`. If you don't know what value to choose, select `CustomerVendor`.
+        attr_accessor :company_type
+
+        ##
+        # @return [String] Either `Active` or `Inactive`.
+        attr_accessor :company_status
+
+        ##
+        # @return [String] If this company has a parent company, identify the parent company's `ErpKey` value here. This value should be the original primary key or unique ID of the parent company to this company belongs. This value should match the original ErpKey field on the parent company. If this company is not a child company, leave this field null.
+        attr_accessor :parent_company_erp_key
+
+        ##
+        # @return [Boolean] This flag indicates whether the company is currently active. An inactive company will be hidden from the user interface but will still be available for querying.
+        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
+        attr_accessor :default_currency_code
+
+        ##
+        # @return [Uri] The URL of this company's logo, if known.
+        attr_accessor :company_logo_url
+
+        ##
+        # @return [String] The `ErpKey` of the primary contact for this company. This value should match the `ErpKey` value of the [Importing Contacts](https://developer.lockstep.io/docs/importing-contacts) record for the contact table.
+        attr_accessor :primary_contact_erp_key
+
+        ##
+        # @return [String] The company's primary mailing address information
+        attr_accessor :address1
+
+        ##
+        # @return [String] The company's primary mailing address information
+        attr_accessor :address2
+
+        ##
+        # @return [String] The company's primary mailing address information
+        attr_accessor :address3
+
+        ##
+        # @return [String] The company's primary mailing address information
+        attr_accessor :city
+
+        ##
+        # @return [String] The company's primary mailing address information
+        attr_accessor :state_region
+
+        ##
+        # @return [String] The company's primary mailing address information
+        attr_accessor :postal_code
+
+        ##
+        # @return [String] The company's primary mailing address information This will be validated by the /api/v1/countries data set
+        attr_accessor :country
+
+        ##
+        # @return [Tel] The main phone number of this company.
+        attr_accessor :phone_number
+
+        ##
+        # @return [Tel] The main fax number of this company.
+        attr_accessor :fax_number
+
+        ##
+        # @return [Date-time] If known, the date when this record was created according to the originating financial system in which this record is maintained. If the originating financial system does not maintain a created-date, leave this field null.
+        attr_accessor :created
+
+        ##
+        # @return [Date-time] If known, the date when this record was most recently modified according to the originating financial system in which this record is maintained. If the originating financial system does not maintain a most-recently-modified-date, leave this field null.
+        attr_accessor :modified
+
+        ##
+        # @return [String] The company's Tax ID number for the appropriate government for this company.
+        attr_accessor :tax_id
+
+        ##
+        # @return [String] The Dun and Bradstreet number for this company, if known.
+        attr_accessor :duns_number
+
+        ##
+        # @return [Email] If you know the AP (accounts payable) email address of this company, fill it in here. This is the email address where you would send questions to the company if the company owed you money.
+        attr_accessor :ap_email_address
+
+        ##
+        # @return [Email] If you know the AR (accounts receivable) email address of this company, fill it in here. This is the email address where you would send questions to the company if you owed this company money.
+        attr_accessor :ar_email_address
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'erpKey' => @erp_key,
+                'companyName' => @company_name,
+                'companyType' => @company_type,
+                'companyStatus' => @company_status,
+                'parentCompanyErpKey' => @parent_company_erp_key,
+                'isActive' => @is_active,
+                'defaultCurrencyCode' => @default_currency_code,
+                'companyLogoUrl' => @company_logo_url,
+                'primaryContactErpKey' => @primary_contact_erp_key,
+                'address1' => @address1,
+                'address2' => @address2,
+                'address3' => @address3,
+                'city' => @city,
+                'stateRegion' => @state_region,
+                'postalCode' => @postal_code,
+                'country' => @country,
+                'phoneNumber' => @phone_number,
+                'faxNumber' => @fax_number,
+                'created' => @created,
+                'modified' => @modified,
+                'taxId' => @tax_id,
+                'dunsNumber' => @duns_number,
+                'apEmailAddress' => @ap_email_address,
+                'arEmailAddress' => @ar_email_address,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/connector_info_model.rb

@@ -10,7 +10,6 @@
 # @author     Manish Narayan B S <manish.n@lockstep.io>
 # @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
-# @version    2022.4
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/contact_model.rb

@@ -10,7 +10,6 @@
 # @author     Manish Narayan B S <manish.n@lockstep.io>
 # @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
-# @version    2022.4
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/contact_sync_model.rb

@@ -0,0 +1,177 @@
+#
+# Lockstep Software Development Kit 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     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # The ContactSyncModel represents information coming into Lockstep from an external financial system or other
+    # enterprise resource planning system.  To import data from an external system, convert your original data into
+    # the ContactSyncModel format and call the [Upload Sync File API](https://developer.lockstep.io/reference/post_api-v1-sync-zip).
+    # This API retrieves all of the data you uploaded in a compressed ZIP file and imports it into the Lockstep
+    # platform.
+    #
+    # Once imported, this record will be available in the Lockstep API as a [ContactModel](https://developer.lockstep.io/docs/contactmodel).
+    #
+    # For more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data).
+    class ContactSyncModel
+
+        ##
+        # Initialize the ContactSyncModel using the provided prototype
+        def initialize(params = {})
+            @erp_key = params.dig(:erp_key)
+            @company_erp_key = params.dig(:company_erp_key)
+            @contact_name = params.dig(:contact_name)
+            @contact_code = params.dig(:contact_code)
+            @title = params.dig(:title)
+            @role_code = params.dig(:role_code)
+            @email_address = params.dig(:email_address)
+            @phone = params.dig(:phone)
+            @fax = params.dig(:fax)
+            @address1 = params.dig(:address1)
+            @address2 = params.dig(:address2)
+            @address3 = params.dig(:address3)
+            @city = params.dig(:city)
+            @state_region = params.dig(:state_region)
+            @postal_code = params.dig(:postal_code)
+            @country_code = params.dig(:country_code)
+            @is_active = params.dig(:is_active)
+            @webpage_url = params.dig(:webpage_url)
+            @picture_url = params.dig(:picture_url)
+            @created = params.dig(:created)
+            @modified = params.dig(:modified)
+        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).
+        attr_accessor :erp_key
+
+        ##
+        # @return [String] The original primary key or unique ID of the company to which this contact belongs. This value should match the [Company ErpKey](https://developer.lockstep.io/docs/importing-companies#erpkey) field on the [CompanySyncModel](https://developer.lockstep.io/docs/importing-companies).
+        attr_accessor :company_erp_key
+
+        ##
+        # @return [String] The name of the contact.
+        attr_accessor :contact_name
+
+        ##
+        # @return [String] A friendly human-readable code that describes this Contact.
+        attr_accessor :contact_code
+
+        ##
+        # @return [String] The title of the contact.
+        attr_accessor :title
+
+        ##
+        # @return [String] The role code for the contact.
+        attr_accessor :role_code
+
+        ##
+        # @return [Email] The email address of the contact.
+        attr_accessor :email_address
+
+        ##
+        # @return [String] The phone number of the contact.
+        attr_accessor :phone
+
+        ##
+        # @return [String] The fax number of the contact.
+        attr_accessor :fax
+
+        ##
+        # @return [String] The mailing address information for this contact.
+        attr_accessor :address1
+
+        ##
+        # @return [String] The mailing address information for this contact.
+        attr_accessor :address2
+
+        ##
+        # @return [String] The mailing address information for this contact.
+        attr_accessor :address3
+
+        ##
+        # @return [String] The mailing address information for this contact.
+        attr_accessor :city
+
+        ##
+        # @return [String] The mailing address information for this contact.
+        attr_accessor :state_region
+
+        ##
+        # @return [String] The mailing address information for this contact.
+        attr_accessor :postal_code
+
+        ##
+        # @return [String] The mailing address information for this contact. This will be validated by the /api/v1/countries data set
+        attr_accessor :country_code
+
+        ##
+        # @return [Boolean] True if this contact is considered "active".
+        attr_accessor :is_active
+
+        ##
+        # @return [Uri] A webpage URL for more information about this contact.
+        attr_accessor :webpage_url
+
+        ##
+        # @return [Uri] If available, the URL of a photograph that shows this contact.
+        attr_accessor :picture_url
+
+        ##
+        # @return [Date-time] If known, the date when this record was created according to the originating financial system in which this record is maintained. If the originating financial system does not maintain a created-date, leave this field null.
+        attr_accessor :created
+
+        ##
+        # @return [Date-time] If known, the date when this record was most recently modified according to the originating financial system in which this record is maintained. If the originating financial system does not maintain a most-recently-modified-date, leave this field null.
+        attr_accessor :modified
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'erpKey' => @erp_key,
+                'companyErpKey' => @company_erp_key,
+                'contactName' => @contact_name,
+                'contactCode' => @contact_code,
+                'title' => @title,
+                'roleCode' => @role_code,
+                'emailAddress' => @email_address,
+                'phone' => @phone,
+                'fax' => @fax,
+                'address1' => @address1,
+                'address2' => @address2,
+                'address3' => @address3,
+                'city' => @city,
+                'stateRegion' => @state_region,
+                'postalCode' => @postal_code,
+                'countryCode' => @country_code,
+                'isActive' => @is_active,
+                'webpageUrl' => @webpage_url,
+                'pictureUrl' => @picture_url,
+                'created' => @created,
+                'modified' => @modified,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/country_model.rb

@@ -10,7 +10,6 @@
 # @author     Manish Narayan B S <manish.n@lockstep.io>
 # @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
-# @version    2022.4
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/credit_memo_applied_model.rb

@@ -10,7 +10,6 @@
 # @author     Manish Narayan B S <manish.n@lockstep.io>
 # @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
-# @version    2022.4
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -58,11 +57,11 @@ module LockstepSdk
         attr_accessor :group_key
 
         ##
-        # @return [Uuid] The id of the invoice
+        # @return [Uuid] The Lockstep ID of the Invoice to which this credit memo was applied. This Invoice's outstanding balance was reduced by the value of the field `CreditMemoAppliedAmount` on the date `ApplyToInvoiceDate`. Example: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this credit memo to reduce the balance of the invoice PO1000578. The `InvoiceErpKey` is the Lockstep Platform ID number of Invoice `PO1000578`.
         attr_accessor :invoice_id
 
         ##
-        # @return [Uuid] The id of the credit memo invoice
+        # @return [Uuid] The Lockstep ID of the Invoice of type "Credit Memo" that was consumed in this payment application event. Example: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this credit memo to reduce the balance of the invoice PO1000578. The `CreditMemoInvoiceId` is the Lockstep Platform ID number of Invoice `CM000123`.
         attr_accessor :credit_memo_invoice_id
 
         ##
@@ -74,11 +73,11 @@ module LockstepSdk
         attr_accessor :entry_number
 
         ##
-        # @return [Date-time] Date payment applied to credit memo.
+        # @return [Date-time] The date on which this credit memo was applied to the Invoice represented by `InvoiceId`.
         attr_accessor :apply_to_invoice_date
 
         ##
-        # @return [Double] Amount applied to credit memo.
+        # @return [Double] The amount of the credit memo that was applied to the Invoice represented by `InvoiceId`.
         attr_accessor :credit_memo_applied_amount
 
         ##
@@ -110,11 +109,11 @@ module LockstepSdk
         attr_accessor :notes
 
         ##
-        # @return [CustomFieldDefinitionModel] All definitions attached to this applied Credit Memo. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @return [CustomFieldDefinitionModel] All definitions attached to this applied Credit Memo. To retrieve this collection, specify `CustomFields` in the "Include" parameter for your query.
         attr_accessor :custom_field_definitions
 
         ##
-        # @return [CustomFieldValueModel] All values attached to this Credit Memo. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @return [CustomFieldValueModel] All values attached to this Credit Memo. To retrieve this collection, specify `CustomFields` in the "Include" parameter for your query.
         attr_accessor :custom_field_values
 
         ##