lockstep_rails 0.3.43 → 0.3.45

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0c28af0759ac898b1b25238e030585d9ec73c7b4a2c7ee21ed5ea02aebaae4b
-  data.tar.gz: f25d065b0786c2bbd878b5d0f877a9d9448918662a63623b6cbe44139ebf2653
+  metadata.gz: 89bb1d95c176091c5ab6964c910f83d573d29a05b5e749b877ab1c16f171126a
+  data.tar.gz: 6b60815cf092ce0dfc3124350594507d72a7964a1f75faef61f2f1144a8d1a10
 SHA512:
-  metadata.gz: df28f00537fed162bff97e1b14005e78e0bf6b68a6ab706962772643b279acd5271ac85d6431608de9e76c97e4e009ea4cc1c28bda3dcc87886906cc782ac9b3
-  data.tar.gz: 94f1747651382be71963646894baa9e318d0a6233e719fd951d62130eb6378587186c887aebe4cb23f24e7a3e3e73af3204e0309d1fe9f7d59dd6812fc2ad7c5
+  metadata.gz: 2fc621b5b45579ef9e54b60bbd954f5824149b15f0f221ae6e7c288f571bf7aa1ed9fc7363f8bc4fbe1df89a238ec68b04ba528a3fc50866bc115b17c9aad65d
+  data.tar.gz: 2e3e0f2e494c2cc72452f28f75a1373e16b6d72839b0ba2c11eea4a2ccf1c31f0cc64a33b0c8315c014481a092d1abacfcaba6f5339d3faaec945e98f0122650

data/README.md

@@ -39,30 +39,31 @@ The gem is available as open source under the terms of the [MIT License](https:/
 # Usage
 
 ### Available Records
-* Lockstep::Contact
-* Lockstep::Connection
 * Lockstep::Account
-* Lockstep::User
-* Lockstep::Note
+* Lockstep::ApiKey
+* Lockstep::AppEnrollment
+* Lockstep::Connection
+* Lockstep::Contact
+* Lockstep::CustomerSummary
+* Lockstep::FeatureFlag
 * Lockstep::Invoice
+* Lockstep::InvoiceAtRiskSummary
 * Lockstep::InvoiceSummary
-* Lockstep::CustomerSummary
+* Lockstep::MagicLink
+* Lockstep::Note
 * Lockstep::Payments
 * Lockstep::PaymentSummary
-* Lockstep::AppEnrollment
+* Lockstep::ReportApAgingHeader
 * Lockstep::ReportArAgingHeader
 * Lockstep::ReportCashflow
-* Lockstep::ReportDailySalesOutstanding
-* Lockstep::ReportRiskRate
-* Lockstep::ReportApAgingHeader
 * Lockstep::ReportDailyPayableOutstanding
+* Lockstep::ReportDailySalesOutstanding
 * Lockstep::ReportPayableComingDue
-* Lockstep::ReportPayableSummary
 * Lockstep::ReportPayablesComingDueSummary
-* Lockstep::ApiKey
-* Lockstep::InvoiceAtRiskSummary
-* Lockstep::MagicLink
-* Lockstep::FeatureFlag
+* Lockstep::ReportPayableSummary
+* Lockstep::ReportRiskRate
+* Lockstep::Status
+* Lockstep::User
 
 ## ActiveModel Interfaces
 

data/app/models/lockstep/accounting_profile.rb

@@ -0,0 +1,8 @@
+class Lockstep::AccountingProfile < Lockstep::ApiRecord
+  self.model_name_uri = 'v1/profiles/accounting'
+  self.id_ref = 'contact_id'
+  load_schema(Schema::AccountingProfile)
+
+
+  belongs_to :connection, class_name: 'Lockstep::Connection', included: true
+end

data/app/models/lockstep/magic_link.rb

@@ -3,8 +3,13 @@ class Lockstep::MagicLink < Lockstep::ApiRecord
   self.id_ref = "magicLinkId"
   self.query_path = ""
 
-  def self.generate(email_id, expiry, app_id, user_role, company_id)
-    body = {email: email_id, expiresInMinutes: expiry, applicationId: app_id, userRole: user_role, companyId: company_id}
+  def self.generate(email_id, expiry, app_id, user_role, company_id, accounting_profile_id)
+    body = { email: email_id,
+      expiresInMinutes: expiry, applicationId: app_id,
+      userRole: user_role, companyId: company_id,
+      accountingProfileId: accounting_profile_id }
+    body = body.compact
+
     resource.post_magic_link('', body: body, params: {})
   end
 end

data/app/models/lockstep/status.rb

@@ -0,0 +1,13 @@
+class Lockstep::Status
+  Lockstep::ApiRecord.model_name_uri = 'v1/Status'
+
+  def self.ping
+    resp = Lockstep::ApiRecord.resource.get('')
+    raise Lockstep::Exceptions::BadRequestError, 'Endpoint not found' if resp.code == '404'
+
+    status = JSON.parse(resp.body)
+    raise Lockstep::Exceptions::UnauthorizedError, status['errorMessage'] unless status['loggedIn']
+
+    status.deep_transform_keys!(&:underscore).deep_symbolize_keys!
+  end
+end

data/app/platform_api/schema/accounting_profile.rb

@@ -0,0 +1,108 @@
+class Schema::AccountingProfile < 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.
+  # @type: string
+  # @format: uuid
+  field :accounting_profile_id
+
+  # The ID of the company profile to which this accounting profile belongs.
+  # @type: string
+  # @format: uuid
+  field :company_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 name of the accounting profile.
+  # @type: string
+  field :name
+
+  # The type of the accounting profile.
+  # Some examples include 'AR', 'AP', 'AR+AP', 'General Accounting', 'Treasury', 'Payroll', 'Finance'
+  # @type: string
+  field :type
+
+  # The email address associated with the accounting profile.
+  # @type: string
+  # @format: email
+  field :email_address
+
+  # The phone number associated with the accounting profile.
+  # @type: string
+  field :phone
+
+  # The first line of the address.
+  # @type: string
+  field :address1
+
+  # The second line of the address.
+  # @type: string
+  field :address2
+
+  # The third line of the address.
+  # @type: string
+  field :address3
+
+  # The city of the address.
+  # @type: string
+  field :city
+
+  # The state/region of the address.
+  # @type: string
+  field :region
+
+  # The postal/zip code of the address.
+  # @type: string
+  field :postal_code
+
+  # The two character country code of the address.
+  # @type: string
+  field :country
+
+  # The ID of the primary contact with which this accounting profile is associated.
+  # @type: string
+  # @format: uuid
+  field :primary_contact_id
+
+  # The date on which this record was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID of the user who created this accounting profile.
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date on which this record was last modified.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The ID of the user who last modified this accounting profile.
+  # @type: string
+  # @format: uuid
+  field :modified_user_id
+
+  belongs_to :company, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"company_id"}
+  belongs_to :account, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_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 :notes, {:class_name=>"Lockstep::Note", :included=>true, :foreign_key=>:object_key, :polymorphic=>{:table_key=>"AccountingProfile"}}
+  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}
+
+end

data/app/platform_api/schema/accounting_profile_contact.rb

@@ -0,0 +1,56 @@
+class Schema::AccountingProfileContact < 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.
+  # @type: string
+  # @format: uuid
+  field :accounting_profile_contact_id
+
+  # The ID of the profile this contact is belongs to.
+  # @type: string
+  # @format: uuid
+  field :accounting_profile_id
+
+  # The ID of the contact that is linked to this profile.
+  # @type: string
+  # @format: uuid
+  field :contact_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 date on which this record was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID of the user who created this contact.
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date on which this record was last modified.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The ID of the user who last modified this contact.
+  # @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/accounting_profile_contact_fetch_result.rb

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

data/app/platform_api/schema/accounting_profile_fetch_result.rb

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

data/app/platform_api/schema/app_enrollment_reconnect_info.rb

@@ -17,6 +17,10 @@ end
   # @type: string
   field :password
 
+  # The Realm Id for the app enrollment to reconnect.
+  # @type: string
+  field :realm_id
+
   # The access token id for the connector enrollment.
   # @type: string
   field :token_id

data/app/platform_api/schema/bulk_delete_request.rb

@@ -0,0 +1,14 @@
+class Schema::BulkDeleteRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Represents the IDs to be deleted
+  # @type: array
+  field :ids_to_delete
+
+
+
+end

data/app/platform_api/schema/delete_result.rb

@@ -0,0 +1,15 @@
+class Schema::DeleteResult < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # If the API call produced messages, this element will contain a list of user-visible
+  # text strings that contain information about what work occurred in the API.
+  # @type: array
+  field :messages
+
+
+
+end

data/app/platform_api/schema/group_account.rb

@@ -27,6 +27,10 @@ end
   # @format: uuid
   field :group_company_id
 
+  # Base Currency of the group
+  # @type: string
+  field :base_currency_code
+
   # The active status of the group
   # @type: boolean
   field :is_active

data/app/platform_api/schema/invoice.rb

@@ -201,6 +201,11 @@ end
   # @type: string
   field :preferred_delivery_method
 
+  # The Currency Rate used to get from the account's base currency to the invoice amount.
+  # @type: number
+  # @format: double
+  field :currency_rate
+
   # The Company associated to this invoice.
   # To retrieve this item, specify `Company` in the "Include" parameter for your query.
   field :company

data/app/platform_api/schema/invoice_history.rb

@@ -177,6 +177,11 @@ end
   # @format: uuid
   field :app_enrollment_id
 
+  # The Currency Rate used to get from the account's base currency to the invoice amount.
+  # @type: number
+  # @format: double
+  field :currency_rate
+
   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"}
   belongs_to :customer, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"}

data/app/platform_api/schema/invoice_sync.rb

@@ -280,6 +280,11 @@ end
   # @type: string
   field :preferred_delivery_method
 
+  # The Currency Rate used to get from the account's base currency to the invoice amount.
+  # @type: number
+  # @format: double
+  field :currency_rate
+
 
 
 end

data/app/platform_api/schema/magic_link.rb

@@ -5,13 +5,13 @@ def self.id_ref
   nil
 end
 
-  # The unique ID of this record, automatically assigned by Lockstep when this record is
+  # The unique ID of this record, automatically assigned by Lockstep when this record is
   # added to the Lockstep platform.
   # @type: string
   # @format: uuid
   field :magic_link_id
 
-  # The GroupKey uniquely identifies a single Lockstep Platform account.  All records for this
+  # 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.
   # @type: string
   # @format: uuid
@@ -62,17 +62,29 @@ end
   # @format: uuid
   field :modified_user_id
 
-  # The created magic link URL. This will only be returned upon creation of the magic link.
+  # The ID of the company associated to this magic link
+  # @type: string
+  # @format: uuid
+  field :company_id
+
+  # The ID of the accounting profile associated to this magic link
+  # @type: string
+  # @format: uuid
+  field :accounting_profile_id
+
+  # The created magic link URL. This will only be returned upon creation of the magic link.
   # All other times, this value will be `null`.
   # @type: string
   field :magic_link_url
 
-  # The user associated with this magic link.
+  # The user associated with this magic link.
   # To retrieve this item, specify `User` in the "Include" parameter for your query.
   field :user
 
   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::Connection", :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/magic_link_status.rb

@@ -0,0 +1,27 @@
+class Schema::MagicLinkStatus < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The id of the Magic link used to authenticate.
+  # @type: string
+  # @format: uuid
+  field :magic_link_id
+
+  # The id of the target company for the Magic Link
+  # @type: string
+  # @format: uuid
+  field :company_id
+
+  # The id of the accounting profile for the Magic Link
+  # @type: string
+  # @format: uuid
+  field :accounting_profile_id
+
+  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/payment.rb

@@ -134,6 +134,11 @@ end
   # @type: boolean
   field :in_dispute
 
+  # The Currency Rate used to get from the account's base currency to the payment amount.
+  # @type: number
+  # @format: double
+  field :currency_rate
+
   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"}
   belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}

data/app/platform_api/schema/payment_sync.rb

@@ -108,6 +108,11 @@ end
   # @type: boolean
   field :in_dispute
 
+  # The Currency Rate used to get from the account's base currency to the payment amount.
+  # @type: number
+  # @format: double
+  field :currency_rate
+
 
 
 end

data/app/platform_api/schema/status.rb

@@ -9,6 +9,10 @@ end
   # @type: string
   field :user_name
 
+  # If authentication is successful, contains the email address of the logged-in user.
+  # @type: string
+  field :email_address
+
   # If authentication is successful, contains subscription account name of logged-in user.
   # @type: string
   field :account_name
@@ -71,11 +75,23 @@ end
   # @format: uuid
   field :magic_link_id
 
+  # The id of the target company for the Magic Link
+  # @type: string
+  # @format: uuid
+  field :magic_link_company_id
+
+  # Magic link information about the user
+  field :magic_link
+
   # Statuses for the dependencies of this api.
   # OK if the dependency is working.
   # @type: object
   field :dependencies
 
+  # Base Currency of the group
+  # @type: string
+  field :base_currency_code
+
 
   has_many :user_groups, {:class_name=>"Schema::UserGroup", :included=>true}
 

data/app/platform_api/schema/sync_request.rb

@@ -32,6 +32,15 @@ end
   # @type: string
   field :status_code
 
+  # The name of the OperationType for this SyncRequest
+  # @type: string
+  field :operation_type_name
+
+  # The name of the OperationType for this SyncRequest
+  # @type: integer
+  # @format: int32
+  field :operation_type
+
   # Message containing information about the sync request results
   # @type: string
   field :process_result_message

data/app/platform_api/schema/transcription_request_submit.rb

@@ -0,0 +1,30 @@
+class Schema::TranscriptionRequestSubmit < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The base64 string of document content
+  # @type: string
+  field :file_content
+
+  # The location of the file provided
+  # @type: string
+  field :file_url
+
+  # The location of the file provided
+  # @type: string
+  field :file_content_url
+
+  # The name of the file provided
+  # @type: string
+  field :file_name
+
+  # The type of LockstepApi2.Models.TranscriptionRequestSubmit.InvoiceTypeCode requested to transcribe content to.
+  # @type: string
+  field :invoice_type_code
+
+
+
+end

data/app/platform_api/schema/transcription_validation_request.rb

@@ -0,0 +1,53 @@
+class Schema::TranscriptionValidationRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique identifier of the transcription validation request.
+  # @type: string
+  # @format: uuid
+  field :transcription_validation_request_id
+
+  # Group account transcription validation request is associated with.
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  # A code identifying the status of this transcription validation request.
+  #             
+  # Recognized Transcription Validation Request status codes are:
+  # * `New` - Represents a transcription validation request that is considered new and needs work to complete
+  # * `In Progress` - Represents a transcription validation request that is currently being worked on
+  # * `Failed` - Represents a transcription validation request that could not complete the validation process
+  # * `Complete` - Represents a transcription validation request that is considered complete and does not need any further work
+  # @type: string
+  field :status_code
+
+  # The date on which this transcription validation request was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID number of the user who created this transcription validation request.
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date on which this transcription validation request was last modified.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The ID number of the user who most recently modified this transcription validation request.
+  # @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 :items, {:class_name=>"Schema::TranscriptionValidationRequestItem", :included=>true}
+
+end

data/app/platform_api/schema/transcription_validation_request_fetch_result.rb

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