lockstep_rails 0.3.22

data/app/platform_api/schema/company_fetch_result.rb

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

data/app/platform_api/schema/company_sync.rb

@@ -0,0 +1,142 @@
+class Schema::CompanySync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # This is the primary key of the Company record. For this field, you should use whatever the company'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 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
+  # company record within that financial system.
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :erp_key
+
+  # A friendly, short name of the company.
+  # @type: string
+  field :company_name
+
+  # This field indicates the type of company. It can be one of a limited number of values: `Company`,
+  # `Customer`, `Group`, `Vendor`, or `Third Party`. A company that represents both a customer and a vendor is
+  # identified as a `CustomerVendor`.
+  #             
+  # When loading data into Lockstep, you should focus on the distinction between a company that is part of
+  # your own enterprise, or a company that is external to your enterprise.
+  #             
+  # For a company that is within your enterprise, you should set this value to be `Company`.
+  #             
+  # For a company that is external to your enterprise, you should set this value to either `Customer`,
+  # `Vendor`, `Third Party`, or `CustomerVendor`.  If you don't know what value to choose, select
+  # `CustomerVendor`.
+  # @type: string
+  field :company_type
+
+  # An optional field including status codes.  Defined status codes are `Active` and `Inactive`.
+  # @type: string
+  field :company_status
+
+  # If this company has a parent company, identify the parent company's `ErpKey` value here. This value should
+  # be the original primary key or unique ID of the parent company to this company belongs. This value should
+  # match the original ErpKey field on the parent company.
+  #             
+  # If this company is not a child company, leave this field null.
+  # @type: string
+  field :parent_company_erp_key
+
+  # This flag indicates whether the company is currently active. An inactive company will be hidden from the
+  # user interface but will still be available for querying.
+  # @type: boolean
+  field :is_active
+
+  # The default currency code for transactions related to this company.  For a list of currency codes, see
+  # [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies). This will be validated by the /api/v1/currencies data set
+  # @type: string
+  field :default_currency_code
+
+  # The URL of this company's logo, if known.
+  # @type: string
+  field :company_logo_url
+
+  # The `ErpKey` of the primary contact for this company.  This value should match the `ErpKey` value of the
+  # [Importing Contacts](https://developer.lockstep.io/docs/importing-contacts) record for the contact table.
+  # @type: string
+  field :primary_contact_erp_key
+
+  # The company's primary mailing address information
+  # @type: string
+  field :address1
+
+  # The company's primary mailing address information
+  # @type: string
+  field :address2
+
+  # The company's primary mailing address information
+  # @type: string
+  field :address3
+
+  # The company's primary mailing address information
+  # @type: string
+  field :city
+
+  # The company's primary mailing address information
+  # @type: string
+  field :state_region
+
+  # The company's primary mailing address information
+  # @type: string
+  field :postal_code
+
+  # The company's primary mailing address information This will be validated by the /api/v1/countries data set
+  # @type: string
+  field :country
+
+  # The main phone number of this company.
+  # @type: string
+  field :phone_number
+
+  # The main fax number of this company.
+  # @type: string
+  field :fax_number
+
+  # 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
+
+  # The company's Tax ID number for the appropriate government for this company.
+  # @type: string
+  field :tax_id
+
+  # The Dun and Bradstreet number for this company, if known.
+  # @type: string
+  field :duns_number
+
+  # If you know the AP (accounts payable) email address of this company, fill it in here. This is the email
+  # address where you would send questions to the company if the company owed you money.
+  # @type: string
+  field :ap_email_address
+
+  # If you know the AR (accounts receivable) email address of this company, fill it in here. This is the email
+  # address where you would send questions to the company if you owed this company money.
+  # @type: string
+  field :ar_email_address
+
+
+
+end

data/app/platform_api/schema/connector_info.rb

@@ -0,0 +1,27 @@
+class Schema::ConnectorInfo < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The authorization code returned from the first step of the OAuth2 flow
+  # https://oauth.net/2/grant-types/authorization-code/
+  # @type: string
+  field :auth_code
+
+  # The realm id of the account being granted permissions to access
+  # @type: string
+  field :realm_id
+
+  # The redirect uri used for step one of the OAuth2.0 flow.
+  # @type: string
+  field :redirect_uri
+
+  # The email an email connection is being created for.
+  # @type: string
+  field :email
+
+
+
+end

data/app/platform_api/schema/constructor_info.rb

@@ -0,0 +1,128 @@
+class Schema::ConstructorInfo < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  
+  # @type: string
+  field :name
+
+  
+  field :declaring_type
+
+  
+  field :reflected_type
+
+  
+  field :module
+
+  
+  # @type: boolean
+  field :is_collectible
+
+  
+  # @type: integer
+  # @format: int32
+  field :metadata_token
+
+  
+  field :attributes
+
+  
+  field :method_implementation_flags
+
+  
+  field :calling_convention
+
+  
+  # @type: boolean
+  field :is_abstract
+
+  
+  # @type: boolean
+  field :is_constructor
+
+  
+  # @type: boolean
+  field :is_final
+
+  
+  # @type: boolean
+  field :is_hide_by_sig
+
+  
+  # @type: boolean
+  field :is_special_name
+
+  
+  # @type: boolean
+  field :is_static
+
+  
+  # @type: boolean
+  field :is_virtual
+
+  
+  # @type: boolean
+  field :is_assembly
+
+  
+  # @type: boolean
+  field :is_family
+
+  
+  # @type: boolean
+  field :is_family_and_assembly
+
+  
+  # @type: boolean
+  field :is_family_or_assembly
+
+  
+  # @type: boolean
+  field :is_private
+
+  
+  # @type: boolean
+  field :is_public
+
+  
+  # @type: boolean
+  field :is_constructed_generic_method
+
+  
+  # @type: boolean
+  field :is_generic_method
+
+  
+  # @type: boolean
+  field :is_generic_method_definition
+
+  
+  # @type: boolean
+  field :contains_generic_parameters
+
+  
+  field :method_handle
+
+  
+  # @type: boolean
+  field :is_security_critical
+
+  
+  # @type: boolean
+  field :is_security_safe_critical
+
+  
+  # @type: boolean
+  field :is_security_transparent
+
+  
+  field :member_type
+
+
+  has_many :custom_attributes, {:class_name=>"Schema::CustomAttributeData", :included=>true}
+
+end

data/app/platform_api/schema/contact.rb

@@ -0,0 +1,148 @@
+class Schema::Contact < 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/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
+
+  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=>"Contact"}}
+  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/contact_fetch_result.rb

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

data/app/platform_api/schema/contact_sync.rb

@@ -0,0 +1,109 @@
+class Schema::ContactSync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # 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".
+  #             
+  # 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. This will be validated by the /api/v1/countries data set
+  # @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
+
+
+
+end

data/app/platform_api/schema/country.rb

@@ -0,0 +1,62 @@
+class Schema::Country < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Name of the country
+  # @type: string
+  field :name
+
+  # 2 letter alphabetic code for the given country
+  # @type: string
+  field :alpha2
+
+  # 3 letter alphabetic code for the given country
+  # @type: string
+  field :alpha3
+
+  # Unique 3 digit number for the given country
+  # @type: integer
+  # @format: int32
+  field :country_code
+
+  # Region of the country
+  # @type: string
+  field :region
+
+  # Subregion of the country
+  # @type: string
+  field :sub_region
+
+  # Intermediate region of the country
+  # @type: string
+  field :intermediate_region
+
+  # Numeric code for a region
+  # @type: integer
+  # @format: int32
+  field :region_code
+
+  # Numeric code for a subregion
+  # @type: integer
+  # @format: int32
+  field :sub_region_code
+
+  # Numeric code for an intermediate region
+  # @type: integer
+  # @format: int32
+  field :intermediate_region_code
+
+  # French name of the country
+  # @type: string
+  field :french_name
+
+  # A different name for a country
+  # @type: string
+  field :aliases
+
+
+
+end

data/app/platform_api/schema/country_fetch_result.rb

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