lockstep_rails 0.3.73 → 0.3.74

data/app/platform_api/schema/inbound_sync_primary_contact.rb

@@ -0,0 +1,123 @@
+class Schema::InboundSyncPrimaryContact < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique identifier of this object in the Sage Network platform.
+  # @type: string
+  # @format: uuid
+  field :network_id
+
+  # This is the primary key of the Contact record. For this field, you should use whatever the contact's unique
+  # identifying number is in the originating system. Search for a unique, non-changing number within the
+  # originating financial system for this record.
+  #             
+  # Example: If you store your contact records in a database, whatever the primary key for the contact table is
+  # in the database should be the "ErpKey".
+  #             
+  # As some ERP systems don't maintain a unique key for Contacts, we also support syncing Contacts with ERP keys
+  # of the form {prefix}|{index}, for example ContactPrefix|1, ContactPrefix|2 and so on.
+  #             
+  # For this reason, please ensure that your Contact ERP keys don't otherwise contain the '|' symbol or that it
+  # is replaced by an alternate symbol if they do.
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :erp_key
+
+  # The original primary key or unique ID of the company to which this contact belongs.  This value should
+  # match the [Company ErpKey](https://developer.lockstep.io/docs/importing-companies#erpkey) field on the
+  # [CompanySyncModel](https://developer.lockstep.io/docs/importing-companies).
+  # @type: string
+  field :company_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
+  field :email_address
+
+  # The phone number of the contact.
+  # @type: string
+  field :phone
+
+  # The fax number of the contact.
+  # @type: string
+  field :fax
+
+  # The mailing address information for this contact.
+  # @type: string
+  field :address1
+
+  # The mailing address information for this contact.
+  # @type: string
+  field :address2
+
+  # The mailing address information for this contact.
+  # @type: string
+  field :address3
+
+  # The mailing address information for this contact.
+  # @type: string
+  field :city
+
+  # The mailing address information for this contact.
+  # @type: string
+  field :state_region
+
+  # The mailing address information for this contact.
+  # @type: string
+  field :postal_code
+
+  # The mailing address information for this contact.
+  # @type: string
+  field :country_code
+
+  # True if this contact is considered "active".
+  # @type: boolean
+  field :is_active
+
+  # A webpage URL for more information about this contact.
+  # @type: string
+  field :webpage_url
+
+  # If available, the URL of a photograph that shows this contact.
+  # @type: string
+  field :picture_url
+
+  # If known, the date when this record was created according to the originating financial system
+  # in which this record is maintained.  If the originating financial system does not maintain a
+  # created-date, leave this field null.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # If known, the date when this record was most recently modified according to the originating
+  # financial system in which this record is maintained.  If the originating financial system does
+  # not maintain a most-recently-modified-date, leave this field null.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # Enum defining which action to take for a model during the sync process.
+  field :on_match_action
+
+
+
+end

data/app/platform_api/schema/inbound_sync_report_data.rb

@@ -0,0 +1,25 @@
+class Schema::InboundSyncReportData < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Unique Id of this resource in system.
+  # @type: string
+  field :id
+
+  # A known resource type.
+  # @type: string
+  field :type
+
+  # Attributes of the resource to explain the object.
+  field :attributes
+
+  # Relationships of the resource.
+  field :relationships
+
+
+  has_many :errors, {:class_name=>"Schema::Error", :included=>true}
+
+end

data/app/platform_api/schema/inbound_sync_report_data_json_api_data.rb

@@ -0,0 +1,13 @@
+class Schema::InboundSyncReportDataJsonApiData < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Json API data.
+  field :data
+
+
+
+end

data/app/platform_api/schema/inbound_sync_report_summary.rb

@@ -0,0 +1,25 @@
+class Schema::InboundSyncReportSummary < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Total Created entities
+  # @type: integer
+  # @format: int32
+  field :total_created
+
+  # Total Updated entities
+  # @type: integer
+  # @format: int32
+  field :total_update
+
+  # Total Deleted entities
+  # @type: integer
+  # @format: int32
+  field :total_deleted
+
+
+
+end

data/app/platform_api/schema/invoice.rb

@@ -262,6 +262,10 @@ end
   # @type: boolean
   field :is_e_invoice
 
+  # Additional attributes that may be required by the source system.
+  # @type: object
+  field :erp_system_attributes
+
   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_line.rb

@@ -144,6 +144,10 @@ end
   # @format: date-time
   field :source_modified_date, Types::Params::DateTime
 
+  # Additional attributes that may be required by the source system.
+  # @type: object
+  field :erp_system_attributes
+
   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/invoice_workflow_status_history.rb

@@ -21,6 +21,10 @@ end
   # @format: uuid
   field :workflow_status_id
 
+  # The workflow status name associated with the invoice workflow status history.
+  # @type: string
+  field :workflow_status_name
+
   # The GroupKey uniquely identifies a single Accounting Data Services 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/journal_entry_line.rb

@@ -97,6 +97,13 @@ end
   # @type: object
   field :dimensions
 
+  # The source object ERP key for this journal entry line.
+  # @type: string
+  field :source_object_erp_key
+
+  # The ID of the SourceObjectType for this journal entry line.
+  field :source_object_type
+
   # The date that the journal entry line was created.
   # @type: string
   # @format: date-time

data/app/platform_api/schema/journal_entry_line_sync.rb

@@ -77,6 +77,13 @@ end
   # @type: object
   field :dimensions
 
+  # The source object ERP key for this journal entry line.
+  # @type: string
+  field :source_object_erp_key
+
+  # The ID of the SourceObjectType for this journal entry line.
+  field :source_object_type
+
   # If known, the date when this record was created according to the originating financial system
   # in which this record is maintained.  If the originating financial system does not maintain a
   # created-date, leave this field null.

data/app/platform_api/schema/json_api_resource_head.rb

@@ -0,0 +1,18 @@
+class Schema::JsonApiResourceHead < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Unique Id of this resource in system.
+  # @type: string
+  field :id
+
+  # A known resource type.
+  # @type: string
+  field :type
+
+
+
+end

data/app/platform_api/schema/manifest_response.rb

@@ -0,0 +1,19 @@
+class Schema::ManifestResponse < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The status shows the response of return from requested data
+  # @type: integer
+  # @format: int32
+  field :status
+
+  # Message containing information about the sync request results.
+  # @type: string
+  field :message
+
+
+
+end

data/app/platform_api/schema/meta.rb

@@ -0,0 +1,18 @@
+class Schema::Meta < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Type of entity
+  # @type: string
+  field :type
+
+  # UniqueID for entity
+  # @type: string
+  field :id
+
+
+
+end

data/app/platform_api/schema/payment.rb

@@ -169,6 +169,10 @@ end
   # @format: date-time
   field :source_modified_date, Types::Params::DateTime
 
+  # Additional attributes that may be required by the source system.
+  # @type: object
+  field :erp_system_attributes
+
   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

@@ -102,6 +102,10 @@ end
   # The invoice associated with this applied payment.
   field :invoice
 
+  # Additional attributes that may be required by the source system.
+  # @type: object
+  field :erp_system_attributes
+
   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/relationship.rb

@@ -0,0 +1,19 @@
+class Schema::Relationship < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # All created entities
+  field :created
+
+  # All updated entities
+  field :updated
+
+  # All deleted entities
+  field :deleted
+
+
+
+end

data/app/platform_api/schema/relationship_detail.rb

@@ -0,0 +1,11 @@
+class Schema::RelationshipDetail < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+
+  has_many :data, {:class_name=>"Schema::JsonApiResourceHead", :included=>true}
+
+end

data/app/platform_api/schema/source.rb

@@ -0,0 +1,14 @@
+class Schema::Source < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Source of error's Pointer
+  # @type: string
+  field :pointer
+
+
+
+end

data/app/platform_api/schema/sync_payload.rb

@@ -0,0 +1,13 @@
+class Schema::SyncPayload < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+
+  has_many :payments, {:class_name=>"Schema::InboundPaymentSync", :included=>true}
+  has_many :invoices, {:class_name=>"Schema::InboundInvoiceSync", :included=>true}
+  has_many :companies, {:class_name=>"Schema::InboundCompanySync", :included=>true}
+
+end

data/app/platform_api/schema/sync_request.rb

@@ -84,6 +84,9 @@ end
   # @type: object
   field :details
 
+  # Inbound sync payload
+  field :payload
+
   belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
 
 

data/app/platform_api/schema/workflow_status.rb

@@ -40,6 +40,9 @@ end
   # @type: boolean
   field :promote_to_erp
 
+  # Possible sources for a Workflow Status.
+  field :status_source
+
   # The date that the workflow status was created.
   # @type: string
   # @format: date-time