lockstep_rails 0.3.36 → 0.3.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05bd7ba3de1568889d934bc0160f923ecf173f1fe5f357856a9fc221d07fe039
-  data.tar.gz: 4a1458573f08c1b33aa11da01487df04ca403e9bff7f9e8039f723284e47f62b
+  metadata.gz: 481ae74f941e20ac5a66c1f3b48c3ae9d9283ea53e64cbbe979eeb6b852f27a0
+  data.tar.gz: d91082889c6d59314032cc2d2a89567e5e868d98c7cbe9a5c5bb930e390bdea9
 SHA512:
-  metadata.gz: 887d60f6868d2d525de634193da364ff24a86447d3b1e5616421d7c4ccefcb3c5b55d55c64ff3be0c7ec6f9ad94e794e3951ada7e0e9ffb3eef3834c4da6824f
-  data.tar.gz: 7adadb32cc6a971a5c9e4c816cd2e12f15aa85c845a73dab446f645cb1061d9f0f38d82da34b9d30cc3c0c84c161de4170d0cb5336b7e34c1309e981a37205da
+  metadata.gz: 0edf7d1be2d8a48637a54b7f47264821fc8d76e2cce0af5b60cb8a35724c6dd89b33ac36c78ca1691ddcf4dae2a536a9dcf971d32758365ebd2f1ca1b3488f95
+  data.tar.gz: ae547b1171bbb79f663f4838689a580d6bfcbb9a1fcf1f2c5ffcacb7fa424e8db19f8fa85191829428f30bd37181e74b0267eb8f4da4338cd5f31ef0f078bdc6

data/README.md

@@ -61,6 +61,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 * Lockstep::ReportPayablesComingDueSummary
 * Lockstep::ApiKey
 * Lockstep::InvoiceAtRiskSummary
+* Lockstep::MagicLink
 
 ## ActiveModel Interfaces
 

data/app/concepts/lockstep/api_record.rb

@@ -544,6 +544,10 @@ module Lockstep
       query_builder.where(*args)
     end
 
+    def self.additional_query_params(args)
+      query_builder.additional_query_params(args)
+    end
+
     def self.execute
       query_builder.execute
     end

data/app/concepts/lockstep/client.rb

@@ -29,6 +29,13 @@ module Lockstep
       RequestStore.store[:lockstep_api_key]
     end
 
+    def self.set_internal_service_key(key)
+      RequestStore.store[:internal_service_key] = key
+    end
+
+    def internal_service_key
+      RequestStore.store[:internal_service_key]
+    end
 
     ##
     # Construct a new Lockstep API client targeting the specified server.
@@ -115,6 +122,7 @@ module Lockstep
       request["SdkType"] = 'Ruby'
       request["SdkVersion"] = '2022.4.32.0'
       request["MachineName"] = Socket.gethostname
+      request["LS-InternalService"] = internal_service_key if internal_service_key_set?
       body = body.to_json unless body.is_a?(String)
       request.body = body
 
@@ -155,6 +163,14 @@ module Lockstep
       request(:delete, path, {}, {})
     end
 
+    def post_magic_link(path, body: {}, params: {})
+      request(:post, path, body, params)
+    end
+
+    def internal_service_key_set?
+      !!internal_service_key
+    end
+
     def with_logger(&block)
       block.call
     end

data/app/concepts/lockstep/query.rb

@@ -51,6 +51,12 @@ class Lockstep::Query
     end
   end
 
+  def additional_query_params(args)
+    with_clone do
+      criteria[:additional_query_params] ||= args
+    end
+  end
+
   def convert_arg(arg)
     return arg.to_pointer if arg.is_a?(Lockstep::ApiRecord)
     return Lockstep::ApiRecord.to_date_object(arg) if arg.is_a?(Time) || arg.is_a?(Date)
@@ -198,6 +204,7 @@ class Lockstep::Query
     params.merge!({ :include => criteria[:include].join(",") }) if criteria[:include]
     params.merge!({ :order => criteria[:order].join(",") }) if criteria[:order]
     params.merge!({ :pageSize => 2 }) if criteria[:count]
+    params.merge!(criteria[:additional_query_params]) if criteria[:additional_query_params]
     params.reject! { |k, v| v.blank? }
     params
   end

data/app/models/lockstep/customer_summary.rb

@@ -3,4 +3,9 @@ class Lockstep::CustomerSummary < Lockstep::ApiRecord
   self.id_ref = "company_id"
   self.query_path = ""
   load_schema(Schema::CustomerSummary)
+
+  def self.with_report_date(report_date)
+  	additional_query_params({"reportDate": report_date})
+  end
+
 end

data/app/models/lockstep/magic_link.rb

@@ -0,0 +1,10 @@
+class Lockstep::MagicLink < Lockstep::ApiRecord
+  self.model_name_uri = "v1/useraccounts/magic-links"
+  self.id_ref = "magicLinkId"
+  self.query_path = ""
+
+  def self.generate(email_id, expiry, app_id, user_role)
+    body = {email: email_id, expiresInMinutes: expiry, applicationId: app_id, userRole: user_role}
+    resource.post_magic_link('', body: body, params: {})
+  end
+end

data/app/models/lockstep/vendor_summary.rb

@@ -3,4 +3,9 @@ class Lockstep::VendorSummary < Lockstep::ApiRecord
   self.id_ref = "vendor_id"
   self.query_path = ""
   load_schema(Schema::VendorSummary)
+
+  def self.with_report_date(report_date)
+  	additional_query_params({"reportDate": report_date})
+  end
+
 end

data/app/platform_api/schema/ap_aging_header_info.rb

@@ -5,9 +5,9 @@ def self.id_ref
   nil
 end
 
-  # 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.
-  # 
+  # 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
@@ -17,43 +17,46 @@ end
   # @type: string
   field :report_bucket
 
-  # The total number of customers.
+  # The total number of vendors.
   # @type: integer
   # @format: int32
   field :total_vendors
 
-  # The total number of invoices outstanding.
+  # The total number of bills outstanding.
   # @type: integer
   # @format: int32
   field :total_bills_outstanding
 
-  # The total amount outstanding.
+  # The total amount outstanding on bills.
   # @type: number
   # @format: double
   field :total_bills_outstanding_amount
 
-  # The total credit memo amount outstanding.
+  # The total amount outstanding on credit memos.
   # @type: number
   # @format: double
   field :total_credit_memo_outstanding_amount
 
-  # The total advance payment amount.
+  # The total amount of advance payments.
   # @type: number
   # @format: double
   field :total_advance_payment_amount
 
-  # The total outstanding amount
+  # The total amount outstanding.
   # @type: number
   # @format: double
   field :total_outstanding_amount
 
-  # The total amount for AR.
+  # The total amount for AP.
   # @type: number
   # @format: double
   field :total_ap_amount
 
-  # Portion of Total AR this data represents.
+  # Portion of Total AP this data represents.
   # @type: number
   # @format: double
   field :percentage_of_total_ap
-end
+
+
+
+end

data/app/platform_api/schema/ap_header_info.rb

@@ -5,9 +5,9 @@ def self.id_ref
   nil
 end
 
-  # 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.
-  # 
+  # 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
@@ -15,15 +15,15 @@ end
 
   # The date of the report
   # @type: string
-  # @format: date
-  field :report_date
+  # @format: date-time
+  field :report_date, Types::Params::DateTime
 
   # The date of the report
   # @type: string
-  # @format: uuid
-  field :company_id
+  # @format: date-time
+  field :report_period, Types::Params::DateTime
 
-  # The total number of vendors..
+  # The total number of vendors.
   # @type: integer
   # @format: int32
   field :total_vendors

data/app/platform_api/schema/app_enrollment.rb

@@ -72,9 +72,6 @@ end
   # Data about the last successful sync associated with this enrollment
   field :last_successful_sync
 
-  # Use `ConnectorInfo` instead.
-  field :erp_info
-
   # Optional data necessary to create an app enrollment for a supported connector.
   # Only enter relevant fields for the given connector.
   field :connector_info

data/app/platform_api/schema/app_enrollment_reconnect_info.rb

@@ -0,0 +1,30 @@
+class Schema::AppEnrollmentReconnectInfo < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The OAuth authentication code.
+  # @type: string
+  field :auth_code
+
+  # The OAuth authentication code.
+  # @type: string
+  field :username
+
+  # The password for the web services account with access permissions.
+  # @type: string
+  field :password
+
+  # The access token id for the connector enrollment.
+  # @type: string
+  field :token_id
+
+  # The access token secret for the connector enrollment.
+  # @type: string
+  field :token_secret
+
+
+
+end

data/app/platform_api/schema/application.rb

@@ -78,6 +78,11 @@ end
   # @format: uuid
   field :group_key
 
+  # The B2C Client ID of the application
+  # @type: string
+  # @format: uuid
+  field :b2_c_client_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"}
 

data/app/platform_api/schema/ar_aging_header_info.rb

@@ -7,7 +7,7 @@ end
 
   # 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
@@ -27,6 +27,21 @@ end
   # @format: int32
   field :total_invoices_outstanding
 
+  # The total amount outstanding on invoices.
+  # @type: number
+  # @format: double
+  field :total_invoice_outstanding_amount
+
+  # The total amount outstanding on credit memos.
+  # @type: number
+  # @format: double
+  field :total_credit_memo_outstanding_amount
+
+  # The total amount of unapplied payments.
+  # @type: number
+  # @format: double
+  field :total_unapplied_payment_amount
+
   # The total amount outstanding.
   # @type: number
   # @format: double

data/app/platform_api/schema/ar_header_info.rb

@@ -5,9 +5,9 @@ def self.id_ref
   nil
 end
 
-  # 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.
-  # 
+  # 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
@@ -20,8 +20,7 @@ end
 
   # The date of the report
   # @type: string
-  # @format: uuid
-  field :company_id
+  field :report_period
 
   # The total number of customers.
   # @type: integer
@@ -103,20 +102,50 @@ end
   # @format: double
   field :total_payment_amount_current_year
 
-  # The total amount of payments received in the last 30 days
+  # Portion of Total AR that is 90+ days Past due.
+  # @type: number
+  # @format: double
+  field :percentage_of_total_ar90_days_past_due
+
+  # The number of customers who paid within the past thirty days.
   # @type: integer
   # @format: int32
-  field :total_collected_past_thirty_days
+  field :customers_paid_past_thirty_days
+
+  # The total amount collected over the past thirty days.
+  # @type: number
+  # @format: double
+  field :amount_collected_past_thirty_days
+
+  # The amount unapplied from the payments collected over the past thirty days.
+  # @type: number
+  # @format: double
+  field :unapplied_amount_past_thirty_days
 
-  # The total amount of Invoices paid in the last 30 days
+  # The number of invoices paid over the past thirty days.
   # @type: integer
   # @format: int32
-  field :total_invoices_paid_past_thirty_days
+  field :invoices_paid_past_thirty_days
 
-  # Portion of Total AR that is 90+ days Past due.
+  # The number of customers invoiced over the the past thirty days.
+  # @type: integer
+  # @format: int32
+  field :customers_invoiced_past_thirty_days
+
+  # The total amount invoiced over the past thirty days.
   # @type: number
   # @format: double
-  field :percentage_of_total_ar90_days_past_due
+  field :amount_invoiced_past_thirty_days
+
+  # The amount outstanding on the invoices invoiced over the past thirty days.
+  # @type: number
+  # @format: double
+  field :amount_due_past_thirty_days
+
+  # The number of invoices invoiced over the past thirty days.
+  # @type: integer
+  # @format: int32
+  field :invoices_past_thirty_days
 
 
 

data/app/platform_api/schema/at_risk_invoice_summary.rb

@@ -12,7 +12,7 @@ end
 
   # 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

data/app/platform_api/schema/attachment.rb

@@ -19,33 +19,53 @@ end
   # @format: uuid
   field :group_key
 
-  # The name of the table the attachment is associated with
+  # An Attachment is connected to an existing item within the Lockstep Platform by the fields `TableKey` and
+  # `ObjectKey`.  For example, an Attachment connected to Invoice 12345 would have a `TableKey` value of
+  # `Invoice` and an `ObjectKey` value of `12345`.
+  #             
+  # The `TableKey` value contains the name of the table within the Lockstep Platform to which this Attachment
+  # is connected.
+  #             
+  # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
   # @type: string
   field :table_key
 
-  # The ID of the object the attachment is associated with
+  # An Attachment is connected to an existing item within the Lockstep Platform by the fields `TableKey` and
+  # `ObjectKey`.  For example, an Attachment connected to Invoice 12345 would have a `TableKey` value of
+  # `Invoice` and an `ObjectKey` value of `12345`.
+  #             
+  # The `ObjectKey` value contains the primary key of the record within the Lockstep Platform to which this
+  # Attachment is connected.
+  #             
+  # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
   # @type: string
   # @format: uuid
   field :object_key
 
-  # Name of the file
+  # An Attachment represents a file that was uploaded to the Lockstep Platform.  This field contains the original
+  # name of the file on disk, without its extension.
   # @type: string
   field :file_name
 
-  # Extension type of the file
+  # An Attachment represents a file that was uploaded to the Lockstep Platform.  This field contains the original
+  # extension name of the file on disk.
   # @type: string
   field :file_ext
 
-  # Corresponding AttachmentType object to describe this attachment
+  # DEPRECATED: This field is replaced by `AttachmentType`.
   # @type: string
   # @format: uuid
   field :attachment_type_id
 
-  # Flag indicating the attachment was archived
+  # A flag indicating whether this Attachment is archived (also known as hidden or deleted).  When you call
+  # [ArchiveAttachment](https://developer.lockstep.io/reference/delete_api-v1-attachments-id) this field will
+  # be set to true.
+  #             
+  # You should avoid displaying Attachments with the IsArchived field set to true in your user interface.
   # @type: boolean
   field :is_archived
 
-  # Tracks the original record for this attachment, not currently used.
+  # DEPRECATED - Do not use
   # @type: string
   # @format: uuid
   field :origin_attachment_id
@@ -76,16 +96,21 @@ end
   # @format: uuid
   field :app_enrollment_id
 
-  # The date the attachment was created
+  # The date the attachment was created.
   # @type: string
   # @format: date-time
   field :created, Types::Params::DateTime
 
-  # Id of the user who made the file
+  # The unique ID of the [UserAccount](https://developer.lockstep.io/docs/useraccountmodel) of the user
+  # who created this Attachment.
   # @type: string
   # @format: uuid
   field :created_user_id
 
+  # A text string describing the type of this Attachment.
+  # @type: string
+  field :attachment_type
+
   belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
 
 

data/app/platform_api/schema/batch_sync.rb

@@ -14,5 +14,8 @@ end
   has_many :custom_fields, {:class_name=>"Schema::CustomFieldSync", :included=>true}
   has_many :payments, {:class_name=>"Schema::PaymentSync", :included=>true}
   has_many :payment_applications, {:class_name=>"Schema::PaymentAppliedSync", :included=>true}
+  has_many :financial_year_settings, {:class_name=>"Schema::FinancialYearSettingSync", :included=>true}
+  has_many :financial_accounts, {:class_name=>"Schema::FinancialAccountSync", :included=>true}
+  has_many :financial_account_balance_histories, {:class_name=>"Schema::FinancialAccountBalanceHistorySync", :included=>true}
 
 end

data/app/platform_api/schema/bulk_currency_conversion.rb

@@ -10,7 +10,7 @@ end
   # @format: date
   field :date
 
-  # The currency code This will be validated by the /api/v1/currencies data set
+  # The currency code This will be validated by the /api/v1/definitions/currencies data set
   # @type: string
   field :source_currency
 

data/app/platform_api/schema/company.rb

@@ -101,30 +101,6 @@ end
   # @type: string
   field :address3
 
-  # Corporate Address info
-  # @type: string
-  field :corp_city
-
-  # Corporate Address info
-  # @type: string
-  field :corp_state
-
-  # Corporate Address info
-  # @type: string
-  field :corp_postal_code
-
-  # Corporate Address info
-  # @type: string
-  field :corp_country
-
-  # Corporate phone number
-  # @type: string
-  field :corp_phone
-
-  # Corporate fax number
-  # @type: string
-  field :corp_fax
-
   # Address info
   # @type: string
   field :city
@@ -141,6 +117,10 @@ end
   # @type: string
   field :country
 
+  # Time zone
+  # @type: string
+  field :time_zone
+
   # Phone number
   # @type: string
   field :phone_number
@@ -191,6 +171,10 @@ end
   # @format: email
   field :ar_email_address
 
+  # Indicates the preferred invoice delivery method. Examples include Print, Email, Fax
+  # @type: string
+  field :preferred_delivery_method
+
   # For companies that use a custom domain name for their email system, this is
   # the domain name used by this company.  If this value is known, new emails that
   # come in from this domain will be connected to this company.
@@ -218,6 +202,15 @@ end
   # @format: uuid
   field :app_enrollment_id
 
+  # Company Email Address
+  # @type: string
+  # @format: email
+  field :email_address
+
+  # The public url slug for the Company.
+  # @type: string
+  field :public_url_slug
+
   # 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_details.rb

@@ -0,0 +1,98 @@
+class Schema::CompanyDetails < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # 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 unique ID of this company
+  # @type: string
+  # @format: uuid
+  field :customer_id
+
+  # The unique ID of this company
+  # @type: string
+  field :name
+
+  # Company address info
+  # @type: string
+  field :address1
+
+  # Company address info
+  # @type: string
+  field :address2
+
+  # Company address info
+  # @type: string
+  field :address3
+
+  # Company address info
+  # @type: string
+  field :city
+
+  # Company address info
+  # @type: string
+  field :state
+
+  # Company address info
+  # @type: string
+  field :postal_code
+
+  # Company address country
+  # @type: string
+  field :country
+
+  # Company phone number
+  # @type: string
+  field :phone_number
+
+  # Company fax number
+  # @type: string
+  field :fax_number
+
+  # Company email address
+  # @type: string
+  field :email
+
+  # Company primary contact id
+  # @type: string
+  # @format: uuid
+  field :contact_id
+
+  # Company primary contact name
+  # @type: string
+  field :contact_name
+
+  # Company primary contact email address
+  # @type: string
+  field :contact_email
+
+  # Company number of outstanding invoices
+  # @type: integer
+  # @format: int32
+  field :outstanding_invoices
+
+  # Company total outstanding invoice amount
+  # @type: number
+  # @format: double
+  field :outstanding_amount
+
+  # Company total past due amount
+  # @type: number
+  # @format: double
+  field :amount_past_due
+
+  belongs_to :customer, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"}
+  belongs_to :connection, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"}
+
+  has_many :payments, {:class_name=>"Schema::CompanyDetailsPayment", :included=>true}
+
+end