lockstep_rails 0.3.67 → 0.3.69

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9caa7796257df2cf09f394b6ab631e4922b2a8f0c0419e5d5213b5ffc4ad878
-  data.tar.gz: cbb88f32896582f39526be39488360a836202ee7fce260a990a983a1d067c219
+  metadata.gz: be229b382111dc6ed4c5abee4d372a09cadee483567a91dee3ed187f68e816a6
+  data.tar.gz: f3c19f0557e2b586cab31dff0e04c8c1846acb354adb474fa8c061a8d847dc2d
 SHA512:
-  metadata.gz: 4ee749d754595dfaa1bea76fd3c1f477d572f13193596952a905c1fefb70d12f822f7d2f843678d4736125b2cf500339481865f6120ba3b85347ae36f91e038e
-  data.tar.gz: e5eae79797f82b4f0cee3878c2bff602456e5362ad023f1c6f08f68aefe3a62797f5d7acc3fbe0e3d5fee0dd2237f2154a276d7a9fb0e605fd6612971c30c1f4
+  metadata.gz: 14341156a0d680149d0fda239c5b3fa388512787e9c58f8fd5feaf1ba8afa2b578dfed511237d3d4c29f2b3ef70020d3b3ed52c61a299da093b6eca14f65f7bd
+  data.tar.gz: 871c9274955aa5692bc779602987f31e1fbe0d4972787b9290c610093f59db5d5d175ba2f562d59789440f4c441d33f4c64ecfd152cf320b3b4a95f3d2bbe7f6

data/README.md

@@ -46,6 +46,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 * Lockstep::Connection
 * Lockstep::Contact
 * Lockstep::CustomerSummary
+* Lockstep::CompanyMagicLinkSummary
 * Lockstep::FeatureFlag
 * Lockstep::Invoice
 * Lockstep::InvoiceAtRiskSummary

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/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/company.rb

@@ -36,7 +36,8 @@ end
   # * `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.
+  # * `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
 
@@ -243,6 +244,11 @@ end
   # @type: string
   field :company_registration_number
 
+  # An optional reference to a real company, making this a profile.
+  # @type: string
+  # @format: uuid
+  field :profile_reference_id
+
   # All invoices attached to this company.
   #             
   # To retrieve this collection, specify `Invoices` in the "Include" parameter for your query. For more information on Invoices, see [InvoiceModel](https://developer.lockstep.io/reference/get_api-v1-invoices-id).

data/app/platform_api/schema/company_magic_link_summary.rb

@@ -0,0 +1,89 @@
+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 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/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

data/app/platform_api/schema/external_connector_auth_request.rb

@@ -0,0 +1,22 @@
+class Schema::ExternalConnectorAuthRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # An array of scopes requested from 3rd-party provider.
+  # @type: array
+  field :scopes
+
+  # The URL the browser is redirected to after a user grants, or denies, permissions for Sage software.
+  # @type: string
+  field :redirect_url
+
+  # Opaque value that a secret will be tagged with on the service side when created
+  # @type: string
+  field :connection_context_id
+
+
+
+end

data/app/platform_api/schema/external_connector_token.rb

@@ -0,0 +1,36 @@
+class Schema::ExternalConnectorToken < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # ID of the token reference.
+  # @type: string
+  field :id
+
+  # When the user was authenticated.
+  # @type: string
+  # @format: date-time
+  field :authenticated_at, Types::Params::DateTime
+
+  # An array of scopes requested from 3rd-party external connector.
+  # @type: array
+  field :scopes
+
+  # When the token expires. This can be earlier if the token is revoked.
+  # @type: string
+  # @format: date-time
+  field :expires_at, Types::Params::DateTime
+
+  # External Connector ID
+  # @type: string
+  field :external_connector_id
+
+  # Connection context ID set by the product when starting onboarding with a external connector
+  # @type: string
+  field :connection_context_id
+
+
+
+end

data/app/platform_api/schema/invoice_fetch_result.rb

@@ -5,10 +5,6 @@ def self.id_ref
   nil
 end
 
-  #  For more information on Invoices, see [InvoiceModel](https://developer.lockstep.io/reference/get_api-v1-invoices-id).
-  # @type: array
-  field :records
-
   
   # @type: integer
   # @format: int32
@@ -24,6 +20,10 @@ end
   # @format: int32
   field :page_number
 
+  #  For more information on Invoices, see [InvoiceModel](https://developer.lockstep.io/reference/get_api-v1-invoices-id).
+  # @type: array
+  field :records
+
 
 
 end

data/app/platform_api/schema/journal_entry.rb

@@ -0,0 +1,101 @@
+class Schema::JournalEntry < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique ID of this record, automatically assigned by Lockstep when this record is
+  # added to the Lockstep platform.
+  #             
+  # For the ID of this record in its originating financial system, see `ErpKey`.
+  # @type: string
+  # @format: uuid
+  field :journal_entry_id
+
+  # 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 AppEnrollmentId of the application that imported this record.  For accounts
+  # with more than one financial system connected, this field identifies the originating
+  # financial system that produced this record.  This value is null if this record
+  # was not loaded from an external ERP or financial system.
+  # @type: string
+  # @format: uuid
+  field :app_enrollment_id
+
+  # The unique ID of this record as it was known in its originating financial system.
+  #             
+  # If this journal entry record was imported from a financial system, it will have the value `ErpKey`
+  # set to the original primary key number of the record as it was known in the originating financial
+  # system.  If this record was not imported, this value will be `null`.
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :erp_key
+
+  # The ERP’s identifier for this journal entry, usually has meaning to the user.
+  # May be the same value of the ERP Key.
+  # @type: string
+  field :journal_id
+
+  # Possible sources for a Journal Entry.
+  field :source
+
+  # The UTC date and time when this journal entry was posted.
+  # @type: string
+  # @format: date-time
+  field :posting_date, Types::Params::DateTime
+
+  # Possible statuses for a Journal Entry.
+  field :status
+
+  # A brief description explaining the purpose of the journal entry.
+  # @type: string
+  field :description
+
+  # An additional comment related to the entry.
+  # @type: string
+  field :comment
+
+  # Any reference number or identifier associated with the entry, such as an invoice number or purchase order.
+  # @type: string
+  field :reference_number
+
+  # The raw posting date from the source.
+  # @type: string
+  # @format: date-time
+  field :source_posting_date, Types::Params::DateTime
+
+  # The date that the journal entry was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID of the user who created the journal entry.
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date that the journal entry was last modified.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The ID of the user who last modified the journal entry.
+  # @type: string
+  # @format: uuid
+  field :modified_user_id
+
+  belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
+  belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
+
+  has_many :lines, {:class_name=>"Schema::JournalEntryLine", :included=>true}
+  has_many :attachments, {:class_name=>"Schema::Attachment", :included=>true}
+
+end

data/app/platform_api/schema/journal_entry_fetch_result.rb

@@ -0,0 +1,26 @@
+class Schema::JournalEntryFetchResult < 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::JournalEntry", :included=>true}
+
+end

data/app/platform_api/schema/journal_entry_line.rb

@@ -0,0 +1,120 @@
+class Schema::JournalEntryLine < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique ID of this record, automatically assigned by Lockstep when this record is
+  # added to the Lockstep platform.
+  #             
+  # For the ID of this record in its originating financial system, see `ErpKey`.
+  # @type: string
+  # @format: uuid
+  field :journal_entry_line_id
+
+  # The Journal Entry with which this line is associated.
+  # @type: string
+  # @format: uuid
+  field :journal_entry_id
+
+  # 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 AppEnrollmentId of the application that imported this record.  For accounts
+  # with more than one financial system connected, this field identifies the originating
+  # financial system that produced this record.  This value is null if this record
+  # was not loaded from an external ERP or financial system.
+  # @type: string
+  # @format: uuid
+  field :app_enrollment_id
+
+  # The unique ID of this record as it was known in its originating financial system.
+  #             
+  # If this journal entry record was imported from a financial system, it will have the value `ErpKey`
+  # set to the original primary key number of the record as it was known in the originating financial
+  # system.  If this record was not imported, this value will be `null`.
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :erp_key
+
+  # The Financial Account with which this line is associated.
+  # @type: string
+  # @format: uuid
+  field :financial_account_id
+
+  # The unique code/identifier assigned to each account in the chart of accounts.
+  # @type: string
+  field :account_number
+
+  # The name of the account.
+  # @type: string
+  field :account_name
+
+  # Debit to account.
+  # @type: number
+  # @format: double
+  field :debit
+
+  # Credit to account.
+  # @type: number
+  # @format: double
+  field :credit
+
+  # The transaction currency in which the entry is recorded, especially useful for multi-currency environments.
+  # @type: string
+  field :currency
+
+  # The base currency debit amount for the account.
+  # @type: number
+  # @format: double
+  field :base_debit
+
+  # The base currency credit amount for the account.
+  # @type: number
+  # @format: double
+  field :base_credit
+
+  # The base currency in which the entry is recorded, especially useful for multi-currency environments.
+  # @type: string
+  field :base_currency
+
+  # The ERP’s identifier for the user who recorded the journal entry line.
+  # @type: string
+  field :source_created_user
+
+  # A memo related to this line.
+  # @type: string
+  field :memo
+
+  # The date that the journal entry line was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID of the user who created the journal entry line.
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date that the journal entry line was last modified.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The ID of the user who last modified the journal entry line.
+  # @type: string
+  # @format: uuid
+  field :modified_user_id
+
+  belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
+  belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
+
+
+end

data/app/platform_api/schema/magic_link.rb

@@ -81,6 +81,14 @@ end
   # To retrieve this item, specify `User` in the "Include" parameter for your query.
   field :user
 
+  # The number of visits to this Magic Link
+  # @type: integer
+  # @format: int32
+  field :visits
+
+  # Possible statuses for a Magic Link.
+  field :status
+
   belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
   belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
   belongs_to :company, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"}

data/app/platform_api/schema/magic_link_summary.rb

@@ -0,0 +1,30 @@
+class Schema::MagicLinkSummary < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Group that the summary is for
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  # Total number of magic links sent
+  # @type: integer
+  # @format: int32
+  field :total_count
+
+  # Total number of magic links that failed to send
+  # @type: integer
+  # @format: int32
+  field :total_bounced
+
+  # Total number of visits across all magic links
+  # @type: integer
+  # @format: int32
+  field :total_visited
+
+
+
+end