lockstep_rails 0.3.52 → 0.3.54

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ae7706a51bbbb9287e03d75e1caa76fca7ccd3390e3cb2b7228da5923eea1b1
-  data.tar.gz: e0481ed5eb90dd104ed9c223fd01f476ed7a7181395f0be7706ca02537924282
+  metadata.gz: 31ab22d7d4351c3b1f713fb1efe03a5bbd97f13dc314e9e31787a011bd409ec5
+  data.tar.gz: 588543fd4a2733d41214ceeeaeb66048ba5343e438d4cc53523d824bd6e84c57
 SHA512:
-  metadata.gz: c00fbe40099a0b9a3ac3fd4da3d0af34f55e3608bc55ca0681a2bc5d1f4d47760048d7766f49bae719d887ca17afd7eea8f91ab1007393300e1d31232d249440
-  data.tar.gz: 68e6d538ec4cc70a26d63657dff6c1106a046be0993db34c78c65a794dfbd8d7806b9be246a04d8c8807bf161b0938c9a45a138ed88a98c1f4a413206742cf19
+  metadata.gz: c2355b5a47e7eb3f0e668ca4e13b8f71a89d26357c81309bee335b0cb6e0f1f20372372876c8ae95eba715101f3dd9945797c88cf024b47b277d5ff10bd8aaca
+  data.tar.gz: a35c3c45c171d1e64edba696ec00f1c343fe1e82307fc87450b2ce31b0da39c427e10f8d1a8317dc4d7b755a0afdf22644413be3b21657b3d9292ee264c1ce6a

data/README.md

@@ -63,6 +63,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 * Lockstep::ReportPayablesComingDueSummary
 * Lockstep::ReportPayableSummary
 * Lockstep::ReportRiskRate
+* Lockstep::ServiceFabricPayment
 * Lockstep::Status
 * Lockstep::TranscriptionValidationRequest
 * Lockstep::User

data/app/models/lockstep/service_fabric_payment.rb

@@ -0,0 +1,7 @@
+class Lockstep::ServiceFabricPayment < Lockstep::ApiRecord
+  self.model_name_uri = "v1/payments-acceptance/payments/"
+  self.id_ref = "end_to_end_identifier"
+  self.query_path=""
+  load_schema(Schema::SfPaymentRequest)
+
+end

data/app/platform_api/schema/account_authorisation.rb

@@ -0,0 +1,14 @@
+class Schema::AccountAuthorisation < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # A URL that can be used to complete account activation at the servicer.
+  # @type: string
+  field :activation_link
+
+
+
+end

data/app/platform_api/schema/accounting_profile.rb

@@ -5,7 +5,7 @@ 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
@@ -16,9 +16,9 @@ end
   # @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.
-  #             
+  # 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
@@ -28,7 +28,7 @@ end
   # @type: string
   field :name
 
-  # The type of the accounting profile.
+  # The type of the accounting profile.
   # Some examples include 'AR', 'AP', 'AR+AP', 'General Accounting', 'Treasury', 'Payroll', 'Finance'
   # @type: string
   field :type
@@ -70,11 +70,6 @@ end
   # @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
@@ -95,7 +90,7 @@ end
   # @format: uuid
   field :modified_user_id
 
-  belongs_to :company, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"company_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"}
   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/accounting_profile_contact.rb

@@ -21,6 +21,10 @@ end
   # @format: uuid
   field :contact_id
 
+  # Determines whether the contact is primary or secondary.
+  # @type: boolean
+  field :is_primary
+
   # 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.
   #             

data/app/platform_api/schema/accounting_profile_contact_result.rb

@@ -0,0 +1,166 @@
+class Schema::AccountingProfileContactResult < 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 :contact_id
+
+  # The ID of the company to which this contact 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 unique ID of this record as it was known in its originating financial system.
+  #             
+  # If this contact 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 name of the contact.
+  # @type: string
+  field :contact_name
+
+  # A friendly human-readable code that describes this Contact.
+  # @type: string
+  field :contact_code
+
+  # The title of the contact.
+  # @type: string
+  field :title
+
+  # The role code for the contact.
+  # @type: string
+  field :role_code
+
+  # The email address of the contact.
+  # @type: string
+  # @format: email
+  field :email_address
+
+  # The phone number of the contact.
+  # @type: string
+  field :phone
+
+  # The fax number of the contact.
+  # @type: string
+  field :fax
+
+  # 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 :state_region
+
+  # The postal/zip code of the address.
+  # @type: string
+  field :postal_code
+
+  # The two character country code of the address. This will be validated by the /api/v1/definitions/countries data set
+  # @type: string
+  field :country_code
+
+  # Flag indicating if the contact is active.
+  # @type: boolean
+  field :is_active
+
+  # The webpage url of the contact.
+  # @type: string
+  # @format: uri
+  field :webpage_url
+
+  # The picture/avatar url of the contact.
+  # @type: string
+  # @format: uri
+  field :picture_url
+
+  # 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
+
+  # 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
+
+  # Determines whether the contact is primary or secondary.
+  # @type: boolean
+  field :is_primary
+
+  # The ID of the profile this contact belongs to.
+  # @type: string
+  # @format: uuid
+  field :accounting_profile_id
+
+  # The ID of the accounting profile contact this contact matches.
+  # @type: string
+  # @format: uuid
+  field :accounting_profile_contact_id
+
+  # The Name of the profile this contact belongs to.
+  # @type: string
+  field :name
+
+  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"}
+  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=>"AccountingProfileContactResult"}}
+  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_result_fetch_result.rb

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

data/app/platform_api/schema/accounting_profile_request.rb

@@ -0,0 +1,108 @@
+class Schema::AccountingProfileRequest < 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 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
+
+  # The ID of the primary contact that is linked to this profile.
+  # @type: string
+  # @format: uuid
+  field :primary_contact_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"}
+  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=>"AccountingProfileRequest"}}
+  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/address.rb

@@ -0,0 +1,38 @@
+class Schema::Address < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Address line 1.
+  # @type: string
+  field :address_line1
+
+  # Address line 2.
+  # @type: string
+  field :address_line2
+
+  # Address line 3.
+  # @type: string
+  field :address_line3
+
+  # Address line 4.
+  # @type: string
+  field :address_line4
+
+  # Subdivision of a country. For example, state, county, or region.
+  # @type: string
+  field :country_subdivision
+
+  # Postal/zip code.
+  # @type: string
+  field :postal_code
+
+  # Country in the ISO 3166-1 Alpha-3 format.
+  # @type: string
+  field :country
+
+
+
+end

data/app/platform_api/schema/amount.rb

@@ -0,0 +1,20 @@
+class Schema::Amount < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Net amount of the payment after fees have been deducted by the servicer(s) involved.
+  # @type: number
+  # @format: double
+  field :net_amount
+
+  # Total fee amount applied to this payment by the servicer(s) involved.
+  # @type: number
+  # @format: double
+  field :fee
+
+
+
+end

data/app/platform_api/schema/ap_header_info.rb

@@ -13,6 +13,10 @@ end
   # @format: uuid
   field :group_key
 
+  # The base currency code of the group account
+  # @type: string
+  field :base_currency_code
+
   # The date of the report
   # @type: string
   # @format: date-time

data/app/platform_api/schema/app_enrollment.rb

@@ -58,6 +58,10 @@ end
   # @type: boolean
   field :sync_schedule_is_active
 
+  # Flag indicating if the App Enrollment is currently being deleted from the Platform.
+  # @type: boolean
+  field :is_deleted
+
   # The Application to which this AppEnrollment belongs.  Contains general name, description,
   # logo, and other metadata about this application.
   #             

data/app/platform_api/schema/app_enrollment_reconnect_info.rb

@@ -9,7 +9,7 @@ end
   # @type: string
   field :auth_code
 
-  # The OAuth authentication code.
+  # The username for the web services account with access permissions.
   # @type: string
   field :username
 
@@ -29,6 +29,10 @@ end
   # @type: string
   field :token_secret
 
+  # The OAuth redirect uri.
+  # @type: string
+  field :redirect_uri
+
 
 
 end

data/app/platform_api/schema/application.rb

@@ -29,18 +29,12 @@ end
 
   # The URL to visit for more information about this application
   # @type: string
-  # @format: uri
   field :project_url
 
   # The URL for the icon for this application
   # @type: string
-  # @format: uri
   field :icon_url
 
-  # The description of the price for this application
-  # @type: string
-  field :price_terms
-
   # The ID of the user who created this application
   # @type: string
   # @format: uuid
@@ -65,11 +59,6 @@ end
   # @type: boolean
   field :is_active
 
-  # URL to the Wiki for the Application
-  # @type: string
-  # @format: uri
-  field :wiki_url
-
   # 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.
   #             

data/app/platform_api/schema/ar_header_info.rb

@@ -13,6 +13,10 @@ end
   # @format: uuid
   field :group_key
 
+  # The base currency code of the group account
+  # @type: string
+  field :base_currency_code
+
   # The date of the report
   # @type: string
   # @format: date

data/app/platform_api/schema/at_risk_invoice_summary.rb

@@ -51,6 +51,10 @@ end
   # @format: date
   field :payment_due_date
 
+  # The currency code of the invoice
+  # @type: string
+  field :currency_code
+
   # The total amount of the Invoice.
   # @type: number
   # @format: double
@@ -61,6 +65,20 @@ end
   # @format: double
   field :outstanding_balance
 
+  # The currency code of the group.
+  # @type: string
+  field :base_currency_code
+
+  # The total amount of the Invoice in the group's currency.
+  # @type: number
+  # @format: double
+  field :base_currency_invoice_amount
+
+  # The remaining balance value of this invoice in the group's currency.
+  # @type: number
+  # @format: double
+  field :base_currency_outstanding_balance
+
   # A code identifying the type of this Invoice.
   # @type: string
   field :invoice_type_code

data/app/platform_api/schema/attachment.rb

@@ -52,11 +52,6 @@ end
   # @type: string
   field :file_ext
 
-  # DEPRECATED: This field is replaced by `AttachmentType`.
-  # @type: string
-  # @format: uuid
-  field :attachment_type_id
-
   # 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.
@@ -65,19 +60,6 @@ end
   # @type: boolean
   field :is_archived
 
-  # DEPRECATED - Do not use
-  # @type: string
-  # @format: uuid
-  field :origin_attachment_id
-
-  # Flag for if LS clients can see this file
-  # @type: boolean
-  field :view_internal
-
-  # Flag for if Vendors and customers can see this file
-  # @type: boolean
-  field :view_external
-
   # The unique ID of this record as it was known in its originating financial system.
   #             
   # If this company record was imported from a financial system, it will have the value `ErpKey`

data/app/platform_api/schema/attachment_link.rb

@@ -0,0 +1,59 @@
+class Schema::AttachmentLink < 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 an attachment record, automatically assigned by Lockstep when this record is
+  # added to the Lockstep platform.
+  # @type: string
+  # @format: uuid
+  field :attachment_id
+
+  # 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
+
+  # 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 date the Attachment Link was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The unique ID of the [UserAccount](https://developer.lockstep.io/docs/useraccountmodel) of the user
+  # who created this Attachment Link.
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
+
+
+end