lockstep_rails 0.3.68 → 0.3.70

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30bd1402599f256e2ddbf905c1a69109c6ced07b14fcca59e0e9c89aab48bf3c
-  data.tar.gz: 314ca2d138cb0612b223857a084b259acf5d28485d30806b464fb9ca572a546a
+  metadata.gz: 24dea20381afb07c0769964a66d6654ac72b20912a5cfcb3f31b308495024752
+  data.tar.gz: e884043d30e05e7382f9d50016b0cfb37363c4a9192b2494cb99fb491f4a0b56
 SHA512:
-  metadata.gz: 5f684eb6844a106cd5fae3d4cc1a6dc3dbcdb42a2977ec630087fb40a3629784fa2b085d119da69ac8cea104034df57451f3cf9ec7f4bfeafff76afef8f8772a
-  data.tar.gz: 7b9090e647a6707cfbf5ddd7169e16552cb73dc6396fba243c5bdb5a86f594ddb099fa5759da2f26f2b0cff84dd3def96a1a3160c7061c425676eae426e0e0f6
+  metadata.gz: 9a7898f08919efef7f7b7f9047865d9cf306aac6b36b9aeedc050c05f6df70b6bd96f3996d2081fb78013c35ffbe27c2db434337737d14ba962ee398bfd42fb5
+  data.tar.gz: 782a7e8e7bd14969ce43aea26cf7576cd8d3a61366ae4b1f879ba5d5902c94fceee006ab83fe1224e21b95381baf27feb80313bd6475320e48e75abbb4e8e091

data/README.md

@@ -1,10 +1,13 @@
 # Lockstep
+
 A financial service SDK for rails for innovative accounting solutions providers.
 
 ### Who are we?
+
 Lockstep automates accounting workflows to improve your operational efficiency and cash flow. Accelerate payments through automated customer communications, enhanced collections activity management, and innovative forecasting and reporting.
 
 ### lockstep_rails
+
 lockstep_rails makes it easy to interact with lockstep.io's REST API. It adheres to the ActiveRecord pattern. LockstepRails is fully ActiveModel compliant, meaning you can use validations and Rails forms.
 
 Ruby/Rails developers should feel right at home.
@@ -12,11 +15,13 @@ Ruby/Rails developers should feel right at home.
 If you're used to `Lockstep::Contact.create(:email_address => "test@emaildomain.com")`, then this is for you.
 
 ### Features
-*   ActiveRecord-like API, almost no learning curve
-*   Validations
-*   Rails forms and scaffolds **just work**
+
+- ActiveRecord-like API, almost no learning curve
+- Validations
+- Rails forms and scaffolds **just work**
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -24,57 +29,64 @@ gem 'lockstep_rails'
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
 Or install it yourself as:
+
 ```bash
 $ gem install lockstep_rails
 ```
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 # Usage
 
 ### Available Records
-* Lockstep::Account
-* Lockstep::ApiKey
-* Lockstep::AppEnrollment
-* Lockstep::Attachment
-* Lockstep::Connection
-* Lockstep::Contact
-* Lockstep::CustomerSummary
-* Lockstep::FeatureFlag
-* Lockstep::Invoice
-* Lockstep::InvoiceAtRiskSummary
-* Lockstep::InvoiceSummary
-* Lockstep::MagicLink
-* Lockstep::Note
-* Lockstep::Payments
-* Lockstep::PaymentApplied
-* Lockstep::PaymentSummary
-* Lockstep::ReportApAgingHeader
-* Lockstep::ReportArAgingHeader
-* Lockstep::ReportCashflow
-* Lockstep::ReportDailyPayableOutstanding
-* Lockstep::ReportDailyPayableOutstandingSummary
-* Lockstep::ReportDailySalesOutstanding
-* Lockstep::ReportPayableComingDue
-* Lockstep::ReportPayablesComingDueSummary
-* Lockstep::ReportPayableSummary
-* Lockstep::ReportRiskRate
-* Lockstep::ServiceFabricPayment
-* Lockstep::Status
-* Lockstep::TranscriptionValidationRequest
-* Lockstep::User
+
+- Lockstep::Account
+- Lockstep::ApiKey
+- Lockstep::AppEnrollment
+- Lockstep::Attachment
+- Lockstep::Connection
+- Lockstep::Contact
+- Lockstep::CustomerSummary
+- Lockstep::CompanyMagicLinkSummary
+- Lockstep::FeatureFlag
+- Lockstep::Invoice
+- Lockstep::InvoiceAtRiskSummary
+- Lockstep::InvoiceSummary
+- Lockstep::MagicLink
+- Lockstep::Note
+- Lockstep::Payments
+- Lockstep::PaymentApplied
+- Lockstep::PaymentSummary
+- Lockstep::ReportApAgingHeader
+- Lockstep::ReportArAgingHeader
+- Lockstep::ReportCashflow
+- Lockstep::ReportDailyPayableOutstanding
+- Lockstep::ReportDailyPayableOutstandingSummary
+- Lockstep::ReportDailySalesOutstanding
+- Lockstep::ReportPayableComingDue
+- Lockstep::ReportPayablesComingDueSummary
+- Lockstep::ReportPayableSummary
+- Lockstep::ReportRiskRate
+- Lockstep::ServiceFabricPayment
+- Lockstep::Status
+- Lockstep::TranscriptionValidationRequest
+- Lockstep::User
+- Lockstep::WorkflowStatus
 
 ## ActiveModel Interfaces
 
 `lockstep_rails` supports the standard CRUD interface of ActiveRecord.
 
 ### Create
+
 You can create a record by calling `new` or `create`
 
 ```ruby
@@ -82,15 +94,18 @@ Lockstep::Contact.create(email_address: "inbox@companyemail.com")
 ```
 
 You can create records from associations as well. This will automatically association the relationship with the parent record
+
 ```ruby
 connection = Lockstep::Connection.find(company_id: "17544da8-7be8-4ee2-8c62-cbd81428c68b")
 connection.contacts.create(email_address: "inbox@companyemail.com")
 ```
 
 ### Update
+
 Similar to ActiveRecord, you can update a record by calling `update`, `update_attributes` or `update_attribute`
 
 Examples:
+
 ```ruby
 connection = Lockstep::Connection.find(company_id: "17544da8-7be8-4ee2-8c62-cbd81428c68b")
 connection.update(company_name: "New name")
@@ -103,9 +118,11 @@ connection.update_attribute(:company_name, "New name")
 ```
 
 ### Find
+
 Similar to ActiveRecord, you can find a record by calling `find`, `find_by` or `find_by_company_id`
 
 Examples:
+
 ```ruby
 connection = Lockstep::Connection.find(company_id: "17544da8-7be8-4ee2-8c62-cbd81428c68b")
 connection.update(company_name: "New name")
@@ -118,16 +135,19 @@ connection.update_attribute(:company_name, "New name")
 ```
 
 ### Where
-Similar to ActiveRecord, you can search for records by calling `where`. 
+
+Similar to ActiveRecord, you can search for records by calling `where`.
 
 Unless you are accessing the record via `first`, you will have to call `execute` to fetch the records
 
 Examples:
+
 ```ruby
 Lockstep::Connection.where(status: "Active").execute
 ```
 
 #### Chaining
+
 You can chain queries while calling where.
 
 ```ruby
@@ -135,6 +155,7 @@ Lockstep::Connection.where(status: "Active").where(default_currency_code: "USD")
 ```
 
 #### OR Query
+
 You can build an or query by calling `or`
 
 ```ruby
@@ -142,24 +163,26 @@ Lockstep::Connection.where(status: "Active").or(Lockstep::Connection.where(defau
 ```
 
 #### Advanced Queries
+
 [Searchlight](https://developer.lockstep.io/docs/querying-with-searchlight) supports building complex comparisons in the query.
 
-| Suffice      | Searchlight Query     | Example                                           |
-|--------------|-----------------------|---------------------------------------------------|
-| _eq          | Equals                | where(name_eq: "Test Name")                       |
-| _gt          | Greater Than          | where(amount_gt: 100)                             |
-| _ge          | Greater Than Or Equal | where(amount_ge: 100)                             |
-| _lt          | Less Than             | where(amount_lt: 100)                             |
-| _le          | Less Than Or Equal    | where(amount_le: 100)                             |
-| _ne          | Not Equal             | where(name_ne: "tak")                             |
-| _in          | IN                    | where(name_in: ["tik", "tok"])                    |
-| _contains    | CONTAINS              | where(name_contains: "kit")                       |
-| _starts_with | STARTSWITH            | where(name_starts_with: "tik")                    |
-| _ends_with   | ENDSWITH              | where(name_ends_with: "tok")                      |
-| _is          | IS                    | where(name_is: nil) where(name_is: "NOT NULL")    |
+| Suffice       | Searchlight Query     | Example                                        |
+| ------------- | --------------------- | ---------------------------------------------- |
+| \_eq          | Equals                | where(name_eq: "Test Name")                    |
+| \_gt          | Greater Than          | where(amount_gt: 100)                          |
+| \_ge          | Greater Than Or Equal | where(amount_ge: 100)                          |
+| \_lt          | Less Than             | where(amount_lt: 100)                          |
+| \_le          | Less Than Or Equal    | where(amount_le: 100)                          |
+| \_ne          | Not Equal             | where(name_ne: "tak")                          |
+| \_in          | IN                    | where(name_in: ["tik", "tok"])                 |
+| \_contains    | CONTAINS              | where(name_contains: "kit")                    |
+| \_starts_with | STARTSWITH            | where(name_starts_with: "tik")                 |
+| \_ends_with   | ENDSWITH              | where(name_ends_with: "tok")                   |
+| \_is          | IS                    | where(name_is: nil) where(name_is: "NOT NULL") |
 
 #### Searchlight Queries
-Using the rails standard queries generates searchlight compatible queries. 
+
+Using the rails standard queries generates searchlight compatible queries.
 if you wish, you can always write raw [Searchlight](https://developer.lockstep.io/docs/querying-with-searchlight) queries by passing a string in the where block
 
 ```ruby
@@ -167,6 +190,7 @@ Lockstep::Connection.where("isActive is true OR default_currency_code in ('USD',
 ```
 
 ### Destroy and Destroy all
+
 You can destroy a single object by calling destroy method on one object
 Lockstep::Connection.find(company_id: "17544da8-7be8-4ee2-8c62-cbd81428c68b").destroy
 
@@ -175,6 +199,7 @@ You can also destroy multiple objects at once by calling it on the model class a
 Lockstep::Connection.destroy_all(id: ["17544da8-7be8-4ee2-8c62-cbd81428c68b"])
 
 ### Count
+
 You can fetch the count of available records by calling `count`
 
 ```ruby
@@ -184,12 +209,16 @@ Lockstep::Connection.count
 Lockstep::Connection.where(status: "Active").count
 # 100
 ```
+
 ### With Count
+
 ```ruby
 records , count = Lockstep::Connection.where(status: "active").with_count(true).execute
 # records get the records for the query and the with count if used will return the total number of records present for that query.
 ```
+
 ### Limit
+
 You can limit the number of records being fetched by passing `limit`
 
 The default limit is 200.
@@ -201,6 +230,7 @@ Lockstep::Connection.where(status: "Active").limit(100).execute
 ```
 
 ### Pagination
+
 You can paginate the records by passing the `page`
 
 ```ruby
@@ -210,11 +240,13 @@ Lockstep::Connection.where(status: "Active").limit(100).page(2).execute
 ```
 
 ## Adding relationships with ActiveRecord
+
 If you would like to link the `Lockstep::ApiRecord` with an `ActiveRecord::Base`, you can do so by including `Lockstep::ActiveRecords::Association`
 
 This gives you access to 2 methods for defining relationships
-* lockstep_has_many
-* lockstep_belongs_to
+
+- lockstep_has_many
+- lockstep_belongs_to
 
 ```ruby
 class User < ActiveRecord::Base
@@ -222,11 +254,12 @@ class User < ActiveRecord::Base
 
   lockstep_has_many :connections, class_name: "Lockstep::Connection", primary_key: 'company_id', foreign_key: "lockstep_company_id"
   lockstep_belongs_to :account, class_name: "Lockstep::Account", primary_key: 'company_id', foreign_key: "lockstep_company_id"
-  
+
 end
 ```
 
 #### Loader
+
 You could define your own loader for fetching the records by passing a `loader` Proc
 
 ```ruby
@@ -235,7 +268,7 @@ class User < ActiveRecord::Base
 
   lockstep_has_many :connections, class_name: "Lockstep::Connection", loader: -> (record) { Lockstep::Connection.where(is_active: true).where(company_id: record.lockstep_company_id) }
   lockstep_belongs_to :account, class_name: "Lockstep::Account", loader: -> (record) { Lockstep::Account.where(is_active: true).first }
-  
+
 end
 ```
 

data/app/models/lockstep/company_magic_link_summary.rb

@@ -0,0 +1,6 @@
+class Lockstep::CompanyMagicLinkSummary < Lockstep::ApiRecord
+  self.model_name_uri = "v1/Companies/views/magic-link-summary"
+  self.id_ref = "company_id"
+  self.query_path = ""
+  load_schema(Schema::CompanyMagicLinkSummary)
+end

data/app/models/lockstep/invoice.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 class Lockstep::Invoice < Lockstep::ApiRecord
-  self.model_name_uri = "v1/Invoices"
-  self.id_ref = "invoice_id"
+  self.model_name_uri = 'v1/Invoices'
+  self.id_ref = 'invoice_id'
   load_schema(Schema::Invoice)
 
-  belongs_to :connection, class_name: "Lockstep::Connection", foreign_key: :customer_id
+  belongs_to :connection, class_name: 'Lockstep::Connection', foreign_key: :customer_id
+
+  scope :einvoices, -> { include_object(:customer, :lines) }
+  scope :received_einvoices, -> { einvoices.where(invoice_type_code: 'AP E-Invoice') }
 end

data/app/models/lockstep/workflow_status.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Lockstep::WorkflowStatus < Lockstep::ApiRecord
+  self.model_name_uri = '/v1/workflow-statuses/'
+  self.id_ref = 'id'
+
+  load_schema(Schema::WorkflowStatus)
+end

data/app/platform_api/schema/application.rb

@@ -79,5 +79,6 @@ end
   has_many :attachments, {:class_name=>"Schema::Attachment", :included=>true}
   has_many :custom_field_definitions, {:class_name=>"Schema::CustomFieldDefinition", :included=>true}
   has_many :custom_field_values, {:class_name=>"Schema::CustomFieldValue", :included=>true}
+  has_many :enrollments, {:class_name=>"Schema::AppEnrollment", :included=>true}
 
 end

data/app/platform_api/schema/batch_sync.rb

@@ -27,5 +27,7 @@ end
   has_many :financial_accounts, {:class_name=>"Schema::FinancialAccountSync", :included=>true}
   has_many :financial_account_balance_histories, {:class_name=>"Schema::FinancialAccountBalanceHistorySync", :included=>true}
   has_many :base_currencies, {:class_name=>"Schema::BaseCurrencySync", :included=>true}
+  has_many :journal_entries, {:class_name=>"Schema::JournalEntrySync", :included=>true}
+  has_many :journal_entry_lines, {:class_name=>"Schema::JournalEntryLineSync", :included=>true}
 
 end

data/app/platform_api/schema/company_magic_link_summary.rb

@@ -0,0 +1,93 @@
+class Schema::CompanyMagicLinkSummary < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique id for this company
+  # @type: string
+  # @format: uuid
+  field :company_id
+
+  # The short name of the company.
+  # @type: string
+  field :company_name
+
+  # 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.
+  #
+  # * `Company` - This record represents a company that is part of the organization of the account holder.
+  # * `Customer` - This record represents a business entity that purchases things from the account holder.
+  # * `Group` - Only one record of type `GROUP` exists in each account.  Contains your account profile.
+  # * `Vendor` - This record represents a business entity that sells things to the account holder.
+  # * `Third Party` - This record represents a business entity that is neither a customer nor vendor.
+  # * `CustomerVendor` - Both a customer and a vendor.
+  # * `CompanyProfile` - Profile for a Company, each Company should have at most 1 profile, used only for Profile Management.
+  # @type: string
+  field :company_type
+
+  # The GroupKey uniquely identifies a single Lockstep Platform account.  All records for this
+  # account will share the same GroupKey value.  GroupKey values cannot be changed once created.
+  #
+  # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  # The name of the primary contact for this company
+  # @type: string
+  field :primary_contact_name
+
+  # The email of the primary contact for this company
+  # @type: string
+  field :primary_contact_email_address
+
+  # The point of contact for this company
+  # @type: string
+  field :point_of_contact
+
+  # The total outstanding amount for this company
+  # @type: integer
+  # @format: int32
+  field :outstanding_amount
+
+  # The total number of open invoices for this company
+  # @type: integer
+  # @format: int32
+  field :total_open_invoices
+
+  # The total number of invoices that are past due for this company
+  # @type: integer
+  # @format: int32
+  field :past_due
+
+  # Total number of visits for all magic links sent for this company
+  # @type: integer
+  # @format: int32
+  field :total_visits
+
+  # Total number of sent links for this company
+  # @type: integer
+  # @format: int32
+  field :links_sent
+
+  # Created date of the most recent magic link made for this company
+  # @type: string
+  # @format: date-time
+  field :latest_magic_link_date, Types::Params::DateTime
+
+  # Id of the most recent magic link made for this company
+  # @type: string
+  # @format: uuid
+  field :latest_magic_link_id
+
+  # Possible statuses for a Magic Link.
+  field :latest_magic_link_status
+
+  belongs_to :company, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"}
+  belongs_to :account, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"}
+
+
+end

data/app/platform_api/schema/company_magic_link_summary_fetch_result.rb

@@ -0,0 +1,26 @@
+class Schema::CompanyMagicLinkSummaryFetchResult < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  
+  # @type: integer
+  # @format: int32
+  field :total_count
+
+  
+  # @type: integer
+  # @format: int32
+  field :page_size
+
+  
+  # @type: integer
+  # @format: int32
+  field :page_number
+
+
+  has_many :records, {:class_name=>"Schema::CompanyMagicLinkSummary", :included=>true}
+
+end

data/app/platform_api/schema/company_sync.rb

@@ -8,6 +8,11 @@ end
   # Indicates what action to take when an existing object has been found during the sync process.
   field :on_match_action
 
+  # The unique identifier of this object in the Sage Network platform.
+  # @type: string
+  # @format: uuid
+  field :network_id
+
   # 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.
@@ -49,6 +54,11 @@ end
   # @type: string
   field :parent_company_erp_key
 
+  # The network id of the parent Company.
+  # @type: string
+  # @format: uuid
+  field :parent_company_network_id
+
   # 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.
   # @type: boolean
@@ -68,6 +78,11 @@ end
   # @type: string
   field :primary_contact_erp_key
 
+  # The network id of the primary Contact.
+  # @type: string
+  # @format: uuid
+  field :primary_contact_network_id
+
   # The company's primary mailing address information
   # @type: string
   field :address1

data/app/platform_api/schema/contact_sync.rb

@@ -8,6 +8,11 @@ end
   # Indicates what action to take when an existing object has been found during the sync process.
   field :on_match_action
 
+  # The unique identifier of this object in the Sage Network platform.
+  # @type: string
+  # @format: uuid
+  field :network_id
+
   # 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.
@@ -31,6 +36,11 @@ end
   # @type: string
   field :company_erp_key
 
+  # The network id of the related Company.
+  # @type: string
+  # @format: uuid
+  field :company_network_id
+
   # The name of the contact.
   # @type: string
   field :contact_name

data/app/platform_api/schema/directory_company.rb

@@ -0,0 +1,72 @@
+class Schema::DirectoryCompany < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The field indicates the dataset type used to generate the directory company.
+  field :data_set
+
+  # Unique identifier of this record based on the dataset.
+  # <remarks>
+  # Examples of this would be:
+  #     * DataSet = Siren, Identifier = string
+  #     * DataSet = Siret, Identifier = string
+  # </remarks>
+  # @type: string
+  field :id
+
+  # This field indicates the type of company.
+  # @type: string
+  field :company_type
+
+  # The name of the directory company entity.
+  # @type: string
+  field :name
+
+  # Address info
+  # @type: string
+  field :address1
+
+  # Address info
+  # @type: string
+  field :address2
+
+  # Address info
+  # @type: string
+  field :address3
+
+  # Address info
+  # @type: string
+  field :city
+
+  # Address info
+  # @type: string
+  field :country
+
+  # Address info
+  # @type: string
+  field :postal_code
+
+  # Phone number
+  # @type: string
+  field :phone_number
+
+  # Email address
+  # @type: string
+  field :email_address
+
+  # The date this directory company entity was created
+  # @type: string
+  # @format: date-time
+  field :created_date_time, Types::Params::DateTime
+
+  # The date this directory company entity was modified
+  # @type: string
+  # @format: date-time
+  field :modified_date_time, Types::Params::DateTime
+
+
+
+end

data/app/platform_api/schema/external_connector.rb

@@ -0,0 +1,30 @@
+class Schema::ExternalConnector < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # External Connector ID
+  # @type: string
+  field :id
+
+  # External connector name
+  # @type: string
+  field :name
+
+  # URL to start onboarding with the given external connector
+  # @type: string
+  field :onboarding_url
+
+  # Information about the external connector.
+  # @type: string
+  field :description
+
+  # Categories external connector is associated with
+  # @type: array
+  field :categories
+
+
+
+end

data/app/platform_api/schema/external_connector_auth.rb

@@ -0,0 +1,14 @@
+class Schema::ExternalConnectorAuth < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The URL to open a browser with. This begins the user authentication process driven by a provider.
+  # @type: string
+  field :authentication_url
+
+
+
+end