lockstep_rails 0.3.37 → 0.3.39

data/app/platform_api/schema/transaction.rb

@@ -0,0 +1,94 @@
+class Schema::Transaction < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Group account transaction is associated with.
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  # An additional reference number that is sometimes used to identify a transaction.
+  # The meaning of this field is specific to the ERP or accounting system used by the user.
+  # @type: string
+  field :reference_number
+
+  # The unique ID of the transaction record.
+  # @type: string
+  # @format: uuid
+  field :transaction_id
+
+  # The status of the transaction record.
+  #             
+  # Recognized Invoice status codes are:
+  # * `Open` - Represents an invoice that is considered open and needs more work to complete
+  # * `Closed` - Represents an invoice that is considered closed and resolved
+  #             
+  # Recognized Payment status codes are:
+  # * `Open` - Represents an payment that includes some unassigned amount that has not yet been applied to an invoice
+  # * `Closed` - Represents an payment where `UnappliedAmount` will be zero
+  # @type: string
+  field :transaction_status
+
+  # The type of the transaction record.
+  #             
+  # Recognized Invoice types are:
+  # * `AR Invoice` - Represents an invoice sent by Company to the Customer
+  # * `AP Invoice` - Represents an invoice sent by Vendor to the Company
+  # * `AR Credit Memo` - Represents a credit memo generated by Company given to Customer
+  # * `AP Credit Memo` - Represents a credit memo generated by Vendor given to Company
+  #             
+  # Recognized PaymentType values are:
+  # * `AR Payment` - A payment made by a Customer to the Company
+  # * `AP Payment` - A payment made by the Company to a Vendor
+  # @type: string
+  field :transaction_type
+
+  # Additional type categorization of the transaction.
+  # @type: string
+  field :transaction_sub_type
+
+  # The date when a transaction record was reported.
+  # @type: string
+  # @format: date-time
+  field :transaction_date, Types::Params::DateTime
+
+  # The date when a transaction record is due for payment or completion.
+  # @type: string
+  # @format: date-time
+  field :due_date, Types::Params::DateTime
+
+  # The amount of days past the due date the transaction is left un-closed.
+  # @type: integer
+  # @format: int32
+  field :days_past_due
+
+  # The total value of this transaction, inclusive or all taxes and line items.
+  # @type: number
+  # @format: double
+  field :transaction_amount
+
+  # The remaining balance of this transaction.
+  # @type: number
+  # @format: double
+  field :outstanding_amount
+
+  # The count of items associated to the transaction.
+  #             
+  # Examples:
+  # * Number of payments for an invoice.
+  # * Number of invoices a payment or credit memo is applied to.
+  # @type: integer
+  # @format: int32
+  field :transaction_detail_count
+
+  # Specific transactions have support for pdf retrieval from their respective erp. When this flag is true, an additional
+  # call to Invoices/{id}/pdf or Payments/{id}/pdf can be made to retrieve a pdf directly from the erp.
+  # @type: boolean
+  field :supports_erp_pdf_retrieval
+
+
+
+end

data/app/platform_api/schema/transaction_detail.rb

@@ -0,0 +1,78 @@
+class Schema::TransactionDetail < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Group account transaction detail is associated with.
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  # An additional reference number that is sometimes used to identify a transaction detail.
+  # The meaning of this field is specific to the ERP or accounting system used by the user.
+  # @type: string
+  field :reference_number
+
+  # The unique ID of the transaction detail record.
+  # @type: string
+  # @format: uuid
+  field :transaction_detail_id
+
+  # The unique ID of the entity applying the transaction to the transaction detail record.
+  # @type: string
+  # @format: uuid
+  field :transaction_detail_applied_id
+
+  # The unique ID of the transaction record.
+  # @type: string
+  # @format: uuid
+  field :transaction_id
+
+  # The type of the transaction detail record.
+  #             
+  # Recognized Invoice types are:
+  # * `AR Invoice` - Represents an invoice sent by Company to the Customer
+  # * `AP Invoice` - Represents an invoice sent by Vendor to the Company
+  # * `AR Credit Memo` - Represents a credit memo generated by Company given to Customer
+  # * `AP Credit Memo` - Represents a credit memo generated by Vendor given to Company
+  #             
+  # Recognized PaymentType values are:
+  # * `AR Payment` - A payment made by a Customer to the Company
+  # * `AP Payment` - A payment made by the Company to a Vendor
+  # @type: string
+  field :transaction_type
+
+  # Additional type categorization of the transaction.
+  # @type: string
+  field :transaction_sub_type
+
+  # The date when a transaction detail record was reported.
+  # @type: string
+  # @format: date-time
+  field :transaction_date, Types::Params::DateTime
+
+  # The date of the invoice associated to the transaction detail record.
+  # @type: string
+  # @format: date-time
+  field :transaction_invoice_date, Types::Params::DateTime
+
+  # The total value of this transaction detail, inclusive or all taxes and line items.
+  # @type: number
+  # @format: double
+  field :transaction_amount
+
+  # The remaining balance of this transaction detail.
+  # @type: number
+  # @format: double
+  field :outstanding_amount
+
+  # Specific transactions have support for pdf retrieval from their respective erp. When this flag is true, an additional
+  # call to Invoices/{id}/pdf or Payments/{id}/pdf can be made to retrieve a pdf directly from the erp.
+  # @type: boolean
+  field :supports_erp_pdf_retrieval
+
+
+
+end

data/app/platform_api/schema/transaction_summary_total.rb

@@ -0,0 +1,35 @@
+class Schema::TransactionSummaryTotal < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Total count of all transactions from the query request.
+  # @type: integer
+  # @format: int32
+  field :total_count
+
+  # Total value of all transactions from the query request.
+  # @type: number
+  # @format: double
+  field :total_amount
+
+  # Total outstanding amount value of all transactions from the query request.
+  # @type: number
+  # @format: double
+  field :outstanding_amount
+
+  # Total open invoice count from the query request.
+  # @type: integer
+  # @format: int32
+  field :invoice_open_count
+
+  # Total past due invoice count from the query request.
+  # @type: integer
+  # @format: int32
+  field :invoice_past_due_count
+
+
+
+end

data/app/platform_api/schema/transaction_transaction_summary_total_summary_fetch_result.rb

@@ -0,0 +1,30 @@
+class Schema::TransactionTransactionSummaryTotalSummaryFetchResult < 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
+
+  # Represents transaction summary information based on the query request within the group account.
+  field :summary
+
+
+  has_many :records, {:class_name=>"Schema::Transaction", :included=>true}
+  has_many :aging_summary, {:class_name=>"Schema::SummaryAgingTotals", :included=>true}
+
+end

data/app/platform_api/schema/user_account.rb

@@ -114,10 +114,14 @@ end
   # @type: string
   field :postal_code
 
-  # Country for this User This will be validated by the /api/v1/countries data set
+  # Country for this User This will be validated by the /api/v1/definitions/countries data set
   # @type: string
   field :country
 
+  # Time zone for this user
+  # @type: string
+  field :time_zone
+
   # Image URL for this User
   # @type: string
   field :image_url
@@ -134,7 +138,7 @@ end
   # The default currency code used by this user entity.  This value can be overridden
   # for invoices in a different currency code.
   #             
-  # For a list of defined 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
+  # For a list of defined currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies) This will be validated by the /api/v1/definitions/currencies data set
   # @type: string
   field :default_currency_code
 

data/app/platform_api/schema/user_data_response.rb

@@ -0,0 +1,19 @@
+class Schema::UserDataResponse < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Data about the user, the properties returned will depend on the requested information.
+  # @type: object
+  field :data
+
+  # The Lockstep Platform ID of the user
+  # @type: string
+  # @format: uuid
+  field :user_id
+
+
+
+end

data/app/platform_api/schema/user_group.rb

@@ -0,0 +1,30 @@
+class Schema::UserGroup < 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 name of the Permission Level for the group.
+  # @type: string
+  field :user_role
+
+  # The name of the group
+  # @type: string
+  field :group_name
+
+  # The user's status in the group
+  # @type: string
+  field :status
+
+
+
+end

data/app/platform_api/schema/user_role.rb

@@ -13,7 +13,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/vendor_summary.rb

@@ -5,20 +5,20 @@ 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
   field :group_key
 
-  # The unique ID of this company.
+  # The unique ID of this Vendor
   # @type: string
   # @format: uuid
   field :vendor_id
 
-  # The name of the company.
+  # The name of this Vendor
   # @type: string
   field :vendor_name
 
@@ -37,9 +37,25 @@ end
   field :primary_contact_id
 
   # The amount paid to this Vendor in the last 30 days
-  # @type: double
+  # @type: number
+  # @format: double
   field :amount_paid_last30
 
+  # The amount paid to this Vendor in the last 30 days
+  # @type: number
+  # @format: double
+  field :amount_paid_past_thirty_days
+
+  # The outstanding advance pay balance on payments in the last 30 days
+  # @type: number
+  # @format: double
+  field :advance_pay_last30
+
+  # The outstanding advance pay balance on payments in the last 30 days
+  # @type: number
+  # @format: double
+  field :advance_pay_past_thirty_days
+
   # The outstanding advance pay balance with this Vendor
   # @type: number
   # @format: double
@@ -50,29 +66,71 @@ end
   # @format: double
   field :amount_billed_last30
 
+  # The amount billed from this Vendor in the last 30 days
+  # @type: number
+  # @format: double
+  field :amount_billed_past_thirty_days
+
+  # The outstanding balance with this Vendor for bills in the last 30 days
+  # @type: number
+  # @format: double
+  field :amount_billed_outstanding_last30
+
+  # The outstanding balance with this Vendor for bills in the last 30 days
+  # @type: number
+  # @format: double
+  field :amount_billed_outstanding_past_thirty_days
+
   # The outstanding balance with this Vendor
   # @type: number
   # @format: double
   field :amount_billed_outstanding
 
+  # The number of bills received from this Vendor in the last 30 days
+  # @type: integer
+  # @format: int32
+  field :bill_count_last30
+
+  # The number of bills received from this Vendor in the last 30 days
+  # @type: integer
+  # @format: int32
+  field :bill_count_past_thirty_days
+
+  # The number of bills from this Vendor that were paid in full in the last 30 days
+  # @type: integer
+  # @format: int32
+  field :paid_bill_count_last30
+
+  # The number of bills from this Vendor that were paid in full in the last 30 days
+  # @type: integer
+  # @format: int32
+  field :paid_bill_count_past_thirty_days
+
   # The number of open bills with this Vendor
   # @type: integer
   # @format: int32
   field :open_bill_count
 
-  # The number of bills paid to this Vendor in the last 30 days
+  # The number of bills paid to this Vendor
   # @type: integer
   # @format: int32
   field :paid_bill_count
 
-  # The total count of open bills and those paid in the last 30 days
+  # The total count of open and closed bills.
   # @type: integer
   # @format: int32
   field :total_bill_count
 
+  # The days payabale outstanding.
+  # @type: number
+  # @format: double
+  field :dpo
+
+  # The modified date of the Vendor
+  # @type: string
+  # @format: date-time
+  field :modified, 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"}
 
 
 end

data/app/platform_api/schema/vendor_summary_fetch_result.rb

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

data/app/platform_api/schema/view_box_settings.rb

@@ -0,0 +1,30 @@
+class Schema::ViewBoxSettings < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # ViewBox minX setting for this Company's logo.
+  # @type: number
+  # @format: double
+  field :logo_view_box_min_x
+
+  # ViewBox minY setting for this Company's logo.
+  # @type: number
+  # @format: double
+  field :logo_view_box_min_y
+
+  # ViewBox width setting for this Company's logo.
+  # @type: number
+  # @format: double
+  field :logo_view_box_width
+
+  # ViewBox height setting for this Company's logo.
+  # @type: number
+  # @format: double
+  field :logo_view_box_height
+
+
+
+end

data/app/platform_api/schema/webhook.rb

@@ -36,7 +36,7 @@ end
   # @type: string
   field :client_secret
 
-  # The format of the content to be returned in the webhook notifications. Options TBD.
+  # The format of the content to be returned in the webhook notifications. Current options are 'Full' or 'Id'.
   # @type: string
   field :request_content_type
 
@@ -60,7 +60,10 @@ end
   # @format: date-time
   field :expiration_date, Types::Params::DateTime
 
-  # The amount of times a notification should be retried before marking the webhook as errored.
+  # The amount of consecutive failed notifications, not including the current attempt, before marking the webhook as
+  # errored (i.e. if the value is set to 0, the webhook will be marked errored on the first failure, if the value
+  # is set to 1 the webhook will be marked errored on the second failure, and so on). Use -1 to never mark the webhook
+  # as errored due to failures.
   # @type: integer
   # @format: int32
   field :retry_count
@@ -92,5 +95,6 @@ end
   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 :webhook_rules, {:class_name=>"Schema::WebhookRule", :included=>true}
 
 end

data/app/platform_api/schema/webhook_history_table_storage.rb

@@ -59,6 +59,18 @@ end
   # @format: date-time
   field :timestamp, Types::Params::DateTime
 
+  # The records sent with the webhook.
+  # @type: string
+  field :records
+
+  # The request message sent with the webhook.
+  # @type: string
+  field :request_message
+
+  # The response received back from the webhook.
+  # @type: string
+  field :response_message
+
 
 
 end

data/app/platform_api/schema/webhook_rule.rb

@@ -0,0 +1,79 @@
+class Schema::WebhookRule < 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 :webhook_rule_id
+
+  # The unique Webhook ID that will be used to fire the webhook for this rule.
+  # @type: string
+  # @format: uuid
+  field :webhook_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
+
+  # A Webhook rule is setup to be fired based on `TableKey` and `EventType`.
+  # For example, a Webhook setup for when an Invoice is Created would have a `TableKey` value of
+  # `Invoice` and an `EventType` value of `I` (Insert).
+  #             
+  # The `TableKey` value contains the name of the table within the Lockstep Platform to which this metadata
+  # 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
+
+  # A Webhook rule is setup to be fired based on `TableKey` and `EventType`.
+  # For example, a Webhook setup for when an Invoice is Created would have a `TableKey` value of
+  # `Invoice` and an `EventType` value of `I` (Insert).
+  #             
+  # The `EventType` value is one of the following:
+  # - I (Insert)
+  # - D (Delete)
+  # - U (Update)
+  #             
+  # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
+  # @type: string
+  field :event_type
+
+  # An optional Searchlight filter for this webhook rule. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+  # @type: string
+  field :filter
+
+  # The date this webhook rule was created
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID of the user who created this webhook rule
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date this webhook rule was last modified
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The ID of the user who last modified this webhook rule
+  # @type: string
+  # @format: uuid
+  field :modified_user_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"}
+
+
+end

data/app/platform_api/schema/webhook_rule_fetch_result.rb

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