lockstep_rails 0.3.62 → 0.3.64

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9be38b7152f518344bb64998dc99c2ffbf4e0cc2bcf8bdbede10db7bf0a753ca
-  data.tar.gz: 5451642d8f5a986a6a568868b85734222a2b241e2f7f6d226a4652cedef7f8cb
+  metadata.gz: d83e57b6db6e9db14cd4f15009562ccd5d0d04efa90a70b06f5f60a58ac53f40
+  data.tar.gz: c4830314919f4710198deb5e2931808ed9b6533d727eb992ba4d1532473ff427
 SHA512:
-  metadata.gz: bb9b19ccbba26424a2eb571e622f73e8dba2f1cf913969757af232577d1449f88f031e75622a3a73c1916747988e357937af97ea77f48bf90207ff58e91fa229
-  data.tar.gz: 939add76110fce864a6fa02758e34b95124ef5db2eee221498d66266b56a11b8b9d21425a307a76cbb010ec7b9b653d401e4cf6cbfec974c94d6dd6ee06107cd
+  metadata.gz: 70ce01db3c9b2e45047839ab02ca21dc01f82a781c0b2489dc320931b3774c4d8c720aa2665cc142738dd6892ea92f53f708233fee0758f1a29fa14eab20a89c
+  data.tar.gz: 58b0d4ed3f52e6c72a1bd3d52f9b3eaf10b8cf5853e03720d9927f33fb4af2eb8e10362821cf43ea621d0d151bcf314a5975580de01b5526552e2169e506e68c

data/README.md

@@ -166,6 +166,14 @@ if you wish, you can always write raw [Searchlight](https://developer.lockstep.i
 Lockstep::Connection.where("isActive is true OR default_currency_code in ('USD', 'INR')").execute
 ```
 
+### 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
+
+You can also destroy multiple objects at once by calling it on the model class and passing an array of relevant ids
+
+Lockstep::Connection.destroy_all(id: ["17544da8-7be8-4ee2-8c62-cbd81428c68b"])
+
 ### Count
 You can fetch the count of available records by calling `count`
 

data/app/concepts/lockstep/api_record.rb

@@ -572,13 +572,6 @@ module Lockstep
       obj
     end
 
-    # Replaced with a batch destroy_all method.
-    # def self.destroy_all(all)
-    #   all.each do |object|
-    #     object.destroy
-    #   end
-    # end
-
     def self.class_attributes
       @class_attributes ||= {}
     end
@@ -678,7 +671,8 @@ module Lockstep
       @attributes.merge!(results)
       @attributes.merge!(@unsaved_attributes)
 
-      merge_relations
+      # commenting for now as its a duplicate call
+      # merge_relations
       @unsaved_attributes = {}
 
       create_setters_and_getters!
@@ -821,6 +815,18 @@ module Lockstep
       false
     end
 
+    def self.destroy_all(id: [])
+      id.each_slice(100) do |sliced_ids|
+        resp = resource.delete('', body: { 'idsToDelete' => sliced_ids })
+        return false unless resp.code.to_s == '200'
+        # TODO: Since this could fail for certain IDs return deleted_ids in batch
+      end
+      
+      @attributes = {}
+      @unsaved_attributes = {}
+      return true
+    end
+
     def reload
       return false if new?
 

data/app/concepts/lockstep/client.rb

@@ -159,8 +159,8 @@ module Lockstep
       request(:put, path, body, params)
     end
 
-    def delete(path)
-      request(:delete, path, {}, {})
+    def delete(path, body: {})
+      request(:delete, path, body, {})
     end
 
     def post_magic_link(path, body: {}, params: {})

data/app/models/lockstep/connection.rb

@@ -3,7 +3,7 @@ class Lockstep::Connection < Lockstep::ApiRecord
   self.id_ref = 'company_id'
   load_schema(Schema::Company)
 
-  enum company_type: %w[Customer Vendor Group Company]
+  enum company_type: ['Customer', 'Vendor', 'Group', 'Company', 'Third Party'].freeze
 
   has_many :contacts, class_name: 'Lockstep::Contact', included: true
   belongs_to :created_user, class_name: 'Lockstep::User', foreign_key: :created_user_id, primary_key: :user_id

data/app/models/lockstep/magic_link.rb

@@ -1,7 +1,8 @@
 class Lockstep::MagicLink < Lockstep::ApiRecord
   self.model_name_uri = "v1/useraccounts/magic-links"
-  self.id_ref = "magicLinkId"
+  self.id_ref = "magic_link_id"
   self.query_path = nil
+  load_schema(Schema::MagicLink)
 
   def self.generate(email_id, expiry, app_id, user_role, company_id, accounting_profile_id)
     body = { email: email_id,

data/app/platform_api/schema/cashflow_report.rb

@@ -10,7 +10,11 @@ end
   # @format: int32
   field :timeframe
 
-  # Amount of payments collected based in the timeframe
+  # The base currency code of the group.
+  # @type: string
+  field :base_currency_code
+
+  # Amount of payments collected based in the timeframe in the group's base currency
   # @type: number
   # @format: double
   field :payments_collected
@@ -20,7 +24,7 @@ end
   # @format: int32
   field :payments_collected_count
 
-  # Amount of invoices billed based in the timeframe
+  # Amount of invoices billed based in the timeframe in the group's base currency
   # @type: number
   # @format: double
   field :invoices_billed

data/app/platform_api/schema/company_sync.rb

@@ -15,7 +15,7 @@ end
   # 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
+  # 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).

data/app/platform_api/schema/credit_memo_applied.rb

@@ -50,6 +50,13 @@ end
   # @type: string
   field :erp_key
 
+  # Possible statuses for a record that supports ERP write.
+  field :erp_write_status
+
+  # The name of the ErpWriteStatus for this credit memo application
+  # @type: string
+  field :erp_write_status_name
+
   # Reference number for the applied credit memo.
   # @type: integer
   # @format: int32
@@ -93,6 +100,11 @@ end
   # @format: uuid
   field :app_enrollment_id
 
+  # The date on which this record was last modified in source ERP.
+  # @type: string
+  # @format: date-time
+  field :source_modified_date, Types::Params::DateTime
+
   # The credit memo invoice associated with this applied credit memo
   field :credit_memo_invoice
 

data/app/platform_api/schema/email_reply_generator_request.rb

@@ -0,0 +1,23 @@
+class Schema::EmailReplyGeneratorRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The date associated with the email
+  # @type: string
+  # @format: date-time
+  field :date, Types::Params::DateTime
+
+  # The body associated with the email
+  # @type: string
+  field :body
+
+  # The subject associated with the email
+  # @type: string
+  field :subject
+
+
+
+end

data/app/platform_api/schema/email_reply_generator_response.rb

@@ -0,0 +1,16 @@
+class Schema::EmailReplyGeneratorResponse < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The id for this request in the GMS system
+  # @type: string
+  # @format: uuid
+  field :message_id
+
+
+  has_many :suggestions, {:class_name=>"Schema::EmailReplyGeneratorSuggestions", :included=>true}
+
+end

data/app/platform_api/schema/email_reply_generator_suggestions.rb

@@ -0,0 +1,18 @@
+class Schema::EmailReplyGeneratorSuggestions < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The kind of reply generated by the GMS Api
+  # @type: string
+  field :kind
+
+  # The body of the reply generated by the GMS Api
+  # @type: string
+  field :body
+
+
+
+end

data/app/platform_api/schema/financial_account_balance_history.rb

@@ -63,6 +63,13 @@ end
   # @format: double
   field :balance
 
+  # Financial Account Balance Types
+  field :balance_type
+
+  # The name of the BalanceType for this record.
+  # @type: string
+  field :balance_type_name
+
   # The date on which this financial account balance history record was created.
   # @type: string
   # @format: date-time

data/app/platform_api/schema/financial_account_balance_history_sync.rb

@@ -15,7 +15,7 @@ end
   # 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
+  # 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.
   # @type: string
   field :financial_account_erp_key
@@ -51,6 +51,9 @@ end
   # @format: double
   field :balance
 
+  # The balance type of this period. If left null, the balance type will be determined by the balance.
+  field :balance_type
+
 
 
 end

data/app/platform_api/schema/invoice.rb

@@ -226,6 +226,18 @@ end
   # @format: double
   field :base_currency_outstanding_balance_amount
 
+  # Possible statuses for a record that supports ERP write.
+  field :erp_write_status
+
+  # The name of the ErpWriteStatus for this Invoice
+  # @type: string
+  field :erp_write_status_name
+
+  # The date on which this record was last modified in source ERP.
+  # @type: string
+  # @format: date-time
+  field :source_modified_date, Types::Params::DateTime
+
   # 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_line.rb

@@ -133,6 +133,18 @@ end
   # @format: uuid
   field :app_enrollment_id
 
+  # Possible statuses for a record that supports ERP write.
+  field :erp_write_status
+
+  # The name of the ErpWriteStatus for this Invoice
+  # @type: string
+  field :erp_write_status_name
+
+  # The date on which this record was last modified in source ERP.
+  # @type: string
+  # @format: date-time
+  field :source_modified_date, Types::Params::DateTime
+
   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/notification_data.rb

@@ -0,0 +1,36 @@
+class Schema::NotificationData < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The id of the subscription due to which this notification has been sent
+  # @type: string
+  field :subscription_id
+
+  # The client application identifier
+  # @type: string
+  field :application_id
+
+  # Application unique identifier for this company
+  # @type: string
+  # @format: uuid
+  field :external_id
+
+  # Unknown
+  # @type: string
+  field :network_id
+
+  # expirationDateTime if the subscription has one
+  # @type: string
+  # @format: date-time
+  field :expiration_date_time, Types::Params::DateTime
+
+  # Specific info about this event
+  # @type: object
+  field :service_attributes
+
+
+
+end

data/app/platform_api/schema/payables_coming_due.rb

@@ -5,12 +5,6 @@ def self.id_ref
   nil
 end
 
-  # This model represents all the payables that are
-  # either already due or due within this date.
-  # @type: string
-  # @format: date-time
-  field :due_date, Types::Params::DateTime
-
   # 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.
   #             
@@ -19,19 +13,19 @@ end
   # @format: uuid
   field :group_key
 
-  # Name for this company
-  # @type: string
-  field :vendor_name
+  # Number of bills due for this time period
+  # @type: integer
+  # @format: int32
+  field :number_of_bills_due
 
   # The unique Lockstep Id for the Vendor
   # @type: string
   # @format: uuid
   field :vendor_id
 
-  # Number of bills due for this time period
-  # @type: integer
-  # @format: int32
-  field :number_of_bills_due
+  # Name for this company
+  # @type: string
+  field :vendor_name
 
   # Primary Contact for this company
   # @type: string
@@ -51,6 +45,12 @@ end
   # @format: double
   field :total_amount_due
 
+  # This model represents all the payables that are
+  # either already due or due within this date.
+  # @type: string
+  # @format: date-time
+  field :due_date, Types::Params::DateTime
+
 
 
 end

data/app/platform_api/schema/payment.rb

@@ -36,6 +36,13 @@ end
   # @type: string
   field :erp_key
 
+  # Possible statuses for a record that supports ERP write.
+  field :erp_write_status
+
+  # The name of the ErpWriteStatus for this Payment
+  # @type: string
+  field :erp_write_status_name
+
   # The type of payment, AR Payment or AP Payment.
   #             
   # Recognized PaymentType values are:
@@ -94,6 +101,10 @@ end
   # @type: string
   field :currency_code
 
+  # The Bank account id for the company to which this payment belongs.
+  # @type: string
+  field :bank_account_id
+
   # Reference code for the payment for the given Erp system.
   # @type: string
   field :reference_code
@@ -154,6 +165,11 @@ end
   # @type: string
   field :service_fabric_status
 
+  # The date on which this record was last modified in source ERP.
+  # @type: string
+  # @format: date-time
+  field :source_modified_date, Types::Params::DateTime
+
   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_applied.rb

@@ -41,6 +41,13 @@ end
   # @type: string
   field :erp_key
 
+  # Possible statuses for a record that supports ERP write.
+  field :erp_write_status
+
+  # The name of the ErpWriteStatus for this payment application
+  # @type: string
+  field :erp_write_status_name
+
   # The entry number of this payment application.  This is often a journal entry number, confirmation code,
   # or other identifying field for this payment application.
   # @type: integer
@@ -85,6 +92,11 @@ end
   # @format: uuid
   field :app_enrollment_id
 
+  # The date on which this record was last modified in source ERP.
+  # @type: string
+  # @format: date-time
+  field :source_modified_date, Types::Params::DateTime
+
   # The payment associated with this applied payment
   field :payment
 

data/app/platform_api/schema/payment_detail.rb

@@ -43,6 +43,13 @@ end
   # @type: string
   field :email
 
+  # Possible statuses for a record that supports ERP write.
+  field :erp_write_status
+
+  # The name of the ErpWriteStatus for this payment
+  # @type: string
+  field :erp_write_status_name
+
   # The currency code of the payment.
   # @type: string
   field :currency_code

data/app/platform_api/schema/payment_sync.rb

@@ -126,6 +126,10 @@ end
   # @format: double
   field :base_currency_unapplied_amount
 
+  # Bank account id for the payment.
+  # @type: string
+  field :bank_account_id
+
 
 
 end

data/app/platform_api/schema/sf_notification.rb

@@ -0,0 +1,39 @@
+class Schema::SfNotification < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Notification ID
+  # @type: string
+  # @format: uuid
+  field :id
+
+  # Source of the Notification
+  # @type: string
+  field :source
+
+  # Version of Notification
+  # @type: string
+  field :spec_version
+
+  # Describes event from Source
+  # @type: string
+  field :type
+
+  # The ID of the type in question (ex. NewPayment type would have the subject be a PaymentId)
+  # @type: string
+  # @format: uuid
+  field :subject
+
+  # RFC 2046 format content type
+  # @type: string
+  field :data_content_type
+
+  # Extra information about the event
+  field :data
+
+
+
+end

data/app/platform_api/schema/sync_entity_result.rb

@@ -34,6 +34,10 @@ end
   # @type: object
   field :errors
 
+  # The records that were skipped during sync keyed by ERP key
+  # @type: object
+  field :skips
+
 
 
 end