lockstep_rails 0.3.51 → 0.3.53

data/app/platform_api/schema/sf_enroll_request.rb

@@ -0,0 +1,16 @@
+class Schema::SfEnrollRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Organisation request object.
+  field :organisation_request
+
+  # Company request object.
+  field :company_request
+
+
+
+end

data/app/platform_api/schema/sf_enroll_response.rb

@@ -0,0 +1,16 @@
+class Schema::SfEnrollResponse < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Organisation response object.
+  field :organisation_response
+
+  # Company response object.
+  field :company_response
+
+
+
+end

data/app/platform_api/schema/sf_organisation_request.rb

@@ -0,0 +1,38 @@
+class Schema::SfOrganisationRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Optional name of Service Fabric org
+  # @type: string
+  field :name
+
+  # This will be your GroupKey
+  # @type: string
+  field :sage_crm_id
+
+  # Your country in the ISO 3166-1 Alpha-3 format.
+  # @type: string
+  field :primary_country
+
+  # Contact email of the app administrator.
+  # Make sure you specify a valid email - you'll need it later.
+  # @type: string
+  # @format: email
+  field :admin_email
+
+  # Default language of your organisation in the ISO 639-1 format.
+  # This default value is used when a user specifies no language
+  # or if the specified language isn't supported.
+  # @type: string
+  field :default_language
+
+  # This will be your GroupKey
+  # @type: string
+  field :external_id
+
+
+
+end

data/app/platform_api/schema/sf_organisation_response.rb

@@ -0,0 +1,44 @@
+class Schema::SfOrganisationResponse < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Unique ID of the organisation.
+  # @type: string
+  field :organisation_id
+
+  # Name of the organisation.
+  # @type: string
+  field :name
+
+  # Equivalent to GroupKey.
+  # @type: string
+  field :sage_crm_id
+
+  # Contact email of the app administrator.
+  # @type: string
+  field :admin_email
+
+  # Your country in the ISO 3166-1 Alpha-3 format.
+  # @type: string
+  field :primary_country
+
+  # Default language of your organisation in the ISO 639-1 format.
+  # This default value is used when a user specifies no language or if the specified language isn't supported.
+  # Example: EN
+  # @type: string
+  field :default_language
+
+  # External ID of your organisation. The ID can contain alphanumeric characters.
+  # @type: string
+  field :external_id
+
+  # Key for signing requests. This key is only returned for the first 10 minutes after the organisation was created.
+  # @type: string
+  field :signing_key
+
+
+
+end

data/app/platform_api/schema/sf_payment_query_response.rb

@@ -0,0 +1,31 @@
+class Schema::SfPaymentQueryResponse < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The total of elements on the response (not in the current page).
+  # @type: integer
+  # @format: int32
+  field :total_elements
+
+  # The total of pages on the response.
+  # @type: integer
+  # @format: int32
+  field :total_pages
+
+  # The size of the current page.
+  # @type: integer
+  # @format: int32
+  field :size
+
+  # The page number between 0 and the totalPages property.
+  # @type: integer
+  # @format: int32
+  field :page_number
+
+
+  has_many :payments, {:class_name=>"Schema::SfPaymentResponse", :included=>true}
+
+end

data/app/platform_api/schema/sf_payment_request.rb

@@ -0,0 +1,67 @@
+class Schema::SfPaymentRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # A unique identifier assigned by the payment initiator to unambiguously identify the payment.
+  # The identifier is passed on, unchanged, throughout the entire end-to-end chain.
+  # @type: string
+  field :end_to_end_identifier
+
+  # A flag to enable or disable partial payments against this payment. False by default.
+  # @type: boolean
+  field :partial_payment
+
+  # The date when the real-world payment request was initiated
+  # (for example, date upon which an invoice was created), ISO-8601 format.
+  # If before 1st January, 1970, initiatedDateTime will be set to null.
+  # @type: string
+  # @format: date-time
+  field :initiated_date_time, Types::Params::DateTime
+
+  # Date the payment is due in ISO 8601 date format. If before 1st January, 1970, dueDate will be set to null.
+  # @type: string
+  # @format: date-time
+  field :due_date, Types::Params::DateTime
+
+  # An object that represents an amount of money in a specific currency.
+  field :instructed_amount
+
+  # An object that represents all the discounts available for a given payment.
+  field :settlement_discounts_info
+
+  # Array of payment methods which the debtor can choose from in order to pay.
+  # Primarily used to populate the PayNow options page (for example, card, PayPal, ACH).
+  # @type: array
+  field :debtor_payment_methods
+
+  # The details about the debtor receiving the payment request.
+  field :debtor_account
+
+  # The details about the creditor requesting the payment.
+  field :creditor_account
+
+  # Information supplied to enable the matching of an entry with the items that the transfer is intended to settle,
+  # such as a commercial invoice.
+  field :remittance_information
+
+  # Information related to the risk of the payment.
+  field :risk
+
+  # Success redirect url.
+  # @type: string
+  field :success_redirect_url
+
+  # Failure redirect url.
+  # @type: string
+  field :failure_redirect_url
+
+  # An arbitrary dictionary of key-value data to be sent to the payment provider. May be null or empty.
+  # @type: object
+  field :prepare_data
+
+
+
+end

data/app/platform_api/schema/sf_payment_response.rb

@@ -0,0 +1,132 @@
+class Schema::SfPaymentResponse < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique identifier of the payment.
+  # @type: string
+  field :payment_id
+
+  # Date the orginal request was created in ISO 8601 date format.
+  # @type: string
+  # @format: date-time
+  field :create_date_time, Types::Params::DateTime
+
+  # The payment status
+  # Values: "UNAUTHORISED" "PENDING" "PAID" "PAID_OFFLINE" "FAILED" "CANCELLED" "REJECTED" "REFUNDED" "PARTIALLY" "PARTIALLY_REFUNDED"
+  # @type: string
+  field :status
+
+  # A boolean field indicating whether the payment is in a state that can be cancelled.
+  # All PENDING payments can be cancelled, but other statuses are provider-dependent.
+  # @type: boolean
+  field :cancellable
+
+  # Date the request was last updated in ISO 8601 date format.
+  # @type: string
+  # @format: date-time
+  field :update_date_time, Types::Params::DateTime
+
+  # The date when the real-world payment request was initiated
+  # (for example, date upon which an invoice was created), ISO-8601 format.
+  # If before 1st January, 1970, initiatedDateTime will be set to null.
+  # @type: string
+  # @format: date-time
+  field :initiated_date_time, Types::Params::DateTime
+
+  # Date the payment is due in ISO 8601 date format. If before 1st January, 1970, dueDate will be set to null.
+  # @type: string
+  # @format: date-time
+  field :due_date, Types::Params::DateTime
+
+  # The method that was used to pay an invoice outside of Payments Acceptance.
+  # Values: "CASH" "CHEQUE" "DIRECT_CREDIT" "DIRECT_DEBIT" "CARD" "VOUCHER" "CREDIT_NOTE" "UNKNOWN" "OTHER"
+  # @type: string
+  field :offline_method
+
+  # A free text field for describing offline payment methods not covered by the offlineMethod property.
+  # Should only be used with the OTHER offline method.
+  # @type: string
+  field :other_offline_method
+
+  # Unique identifier assigned by the payment initiator to unambiguously identify the payment.
+  # The identifier is passed on, unchanged, throughout the entire end-to-end chain.
+  # @type: string
+  field :end_to_end_identifier
+
+  # An object that represents an amount of money in a specific currency.
+  field :instructed_amount
+
+  # The fee levied by the payment provider for the payment, in minor units of the invoice currency.
+  # This will only be available for paid or partially paid invoices.
+  # Not all providers will be able to provide fee information, so this field may be null even for paid invoices.
+  # Where provided, this field will be non-negative.
+  # @type: integer
+  # @format: int32
+  field :fee
+
+  # Net amount and fees as converted into servicer account currency.
+  field :reporting_amount
+
+  # Amount of the payment that has been paid until now.
+  # @type: integer
+  # @format: int32
+  field :paid_to_date
+
+  # Amount of the payment still outstanding (excluding fees/charges). Maximum value is instructed amount.
+  # @type: string
+  field :outstanding_amount
+
+  # Amount of the payment that has been refunded. Maximum value is instructed amount.
+  # @type: string
+  field :refunded_amount
+
+  # Array of payment methods which the debtor can choose from in order to pay.
+  # Primarily used to populate the PayNow options page (for example, card, PayPal, ACH).
+  # @type: array
+  field :debtor_payment_methods
+
+  # Details about the creditor requesting the payment.
+  field :creditor_account
+
+  # The details about the debtor receiving the payment request.
+  field :debtor_account
+
+  # Information supplied to enable the matching of an entry with the items that the transfer is intended to settle,
+  # such as a commercial invoice.
+  field :remittance_information
+
+  # Information related to the risk of the payment.
+  field :risk
+
+  # Base64 encoded strings that when decoded, can be added to html emails to provider markup in supported email clients.
+  field :metadata
+
+  # Flag of whether this is a partial payment
+  # @type: boolean
+  field :partial_payment
+
+  # The type of the payment.
+  # Values: "INVOICE" "STATEMENT" "PAY_ON_ACCOUNT"
+  # @type: string
+  field :type
+
+  # The payment session ID returned in the POST /payments/{paymentId}/prepare response.
+  # When the prepare response includes a paymentSessionId it is mandatory to include it as part of this payload.
+  # Otherwise, the request will fail with a 400 error.
+  # @type: string
+  field :payment_session_id
+
+  # The redirect uri for the payment.
+  # @type: string
+  field :redirect_uri
+
+  # An arbitrary dictionary of key-value data to be sent to the payment provider. May be null or empty.
+  # @type: object
+  field :prepare_data
+
+
+
+end

data/app/platform_api/schema/sf_servicer_response.rb

@@ -0,0 +1,58 @@
+class Schema::SfServicerResponse < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique identifier for servicer.
+  # @type: string
+  field :servicer_id
+
+  # Name of the servicer organisation.
+  # @type: string
+  field :name
+
+  # URL for the dashboard of the servicer.
+  # @type: string
+  field :dashboard_url
+
+  # Items Enum: "card" "direct-debit"
+  # An array of payment types supported by the provider in the companys country.
+  # @type: array
+  field :capabilities
+
+  # Whether this provider supports an OAuth style flow for linking accounts.
+  # @type: boolean
+  field :account_linking_supported
+
+  # Whether this provider supports direct creation of an account without user intervention.
+  # @type: boolean
+  field :account_creation_supported
+
+  # Boolean field indicating whether the servicer supports reusable payment instruments
+  # (for example, card tokens and direct debit mandates).
+  # @type: boolean
+  field :payment_instruments_supported
+
+  # An integer >= 0 indicating the ordering of the provider. Lower numbers mean a higher priority.
+  # @type: integer
+  # @format: int32
+  field :rank
+
+  # Countries where this Servicer operates.
+  # @type: array
+  field :operating_countries
+
+  # Enum: "AUTH_CODE" "CLIENT_REFERRAL"
+  # Represents an oauth type
+  # @type: string
+  field :oauth_type
+
+  # Endpoint for the given connector API.
+  # @type: string
+  field :api_endpoint
+
+
+
+end

data/app/platform_api/schema/sf_servicers_auth_request.rb

@@ -0,0 +1,32 @@
+class Schema::SfServicersAuthRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique identifier of the servicer to integrate with.
+  # @type: string
+  field :servicer_id
+
+  # Enum: "signup" "login"
+  # The initial integration page to display. This may be ignored, depending on the integration.
+  # @type: string
+  field :landing_page_type
+
+  # An optional field specifing the URI that the browser will be redirected to at the end of the OAuth flow.
+  # If not specified, the browser will be redirected to the Payments Acceptance Service marketplace UI.
+  # @type: string
+  field :success_redirect_uri
+
+  # An optional field that the browser will be redirect to at the end of the OAuth flow.
+  # If a success redirect URI is included but no failure URI, the browser will be redirected
+  # to the success URI in case of errors. A failureReason query parameters will be included
+  # in case of errors; see above for possible values. Including a failure URI but no
+  # success URI will generate a 400 error.
+  # @type: string
+  field :failure_redirect_uri
+
+
+
+end

data/app/platform_api/schema/sf_servicers_auth_response.rb

@@ -0,0 +1,14 @@
+class Schema::SfServicersAuthResponse < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # A URL that can be used to complete this integration.
+  # @type: string
+  field :url
+
+
+
+end

data/app/platform_api/schema/sf_submit_payment_info.rb

@@ -0,0 +1,55 @@
+class Schema::SfSubmitPaymentInfo < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique identifier of the payment submission transaction.
+  # @type: string
+  field :payment_submission_id
+
+  # The unique identifier of the payment.
+  # @type: string
+  field :payment_id
+
+  # Date the original request was created in ISO 8601 date format.
+  # @type: string
+  # @format: date-time
+  field :create_date_time, Types::Params::DateTime
+
+  # Enum: "SUCCEEDED" "PENDING" "DECLINED" "FAILED" "SUBMITTED" "PROCESSING" "DISPUTED" "CANCELLED" "UNKNOWN"
+  # Status of the payment submission.
+  # @type: string
+  field :status
+
+  # Payment method used.
+  # @type: string
+  field :payment_method_used
+
+  # Reason why the payment submission failed or was rejected.
+  # @type: string
+  field :failure_reason
+
+  # An object that represents an amount of money in a specific currency.
+  field :instructed_amount
+
+  # The fee levied by the payment provider for the payment submission, in minor units of the invoice currency.
+  # Not all providers will be able to provide fee information, so this field may be null even for successful payments.
+  # Where provided, this field will be non-negative.
+  # @type: integer
+  # @format: int32
+  field :fee
+
+  # Net amount and fees as converted into servicer account currency.
+  field :reporting_amount
+
+  # The details about the debtor receiving the payment request.
+  field :debtor_account
+
+  # The details about the creditor requesting the payment.
+  field :creditor_account
+
+
+
+end

data/app/platform_api/schema/status.rb

@@ -70,6 +70,14 @@ end
   # @type: boolean
   field :onboarding_scheduled
 
+  # Base Currency of the group
+  # @type: string
+  field :base_currency_code
+
+  # Country code of the group
+  # @type: string
+  field :country_code
+
   # The id of the Magic link used to authenticate.
   # @type: string
   # @format: uuid
@@ -83,15 +91,18 @@ end
   # Magic link information about the user
   field :magic_link
 
+  # Information allowing Lockstep to offer direct support to the user
+  field :support_access
+
+  # True if the user is being impersonated by the Lockstep support team.
+  # @type: boolean
+  field :is_impersonated
+
   # Statuses for the dependencies of this api.
   # OK if the dependency is working.
   # @type: object
   field :dependencies
 
-  # Base Currency of the group
-  # @type: string
-  field :base_currency_code
-
 
   has_many :user_groups, {:class_name=>"Schema::UserGroup", :included=>true}
 

data/app/platform_api/schema/support_access.rb

@@ -0,0 +1,19 @@
+class Schema::SupportAccess < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The code required to assist the user.
+  # @type: string
+  field :code
+
+  # The UTC date and time when the support access will expire.
+  # @type: string
+  # @format: date-time
+  field :expires_at, Types::Params::DateTime
+
+
+
+end

data/app/platform_api/schema/support_access_request.rb

@@ -0,0 +1,15 @@
+class Schema::SupportAccessRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The UTC date and time when support access should expire.
+  # @type: string
+  # @format: date-time
+  field :expires_at, Types::Params::DateTime
+
+
+
+end

data/app/platform_api/schema/sync_request.rb

@@ -36,18 +36,21 @@ end
   # @type: string
   field :operation_type_name
 
-  # The name of the OperationType for this SyncRequest
-  # @type: integer
-  # @format: int32
+  # Possible operation types for a SyncRequest
   field :operation_type
 
   # Message containing information about the sync request results
   # @type: string
   field :process_result_message
 
+  # The number of times this Sync Request has failed
+  # @type: integer
+  # @format: int32
+  field :failure_count
+
   # A boolean indicating whether a sync from an ERP system should process all the data from the ERP
   # as opposed to just the delta of changes since the previous sync run
-  # @type: string
+  # @type: boolean
   field :run_full_sync
 
   # The AppEnrollmentId of the AppEnrollment object that executed this sync request

data/app/platform_api/schema/transaction.rb

@@ -10,6 +10,10 @@ end
   # @format: uuid
   field :group_key
 
+  # The base currency code of the group.
+  # @type: string
+  field :base_currency_code
+
   # 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
@@ -65,6 +69,10 @@ end
   # @format: int32
   field :days_past_due
 
+  # The currency code of the transaction.
+  # @type: string
+  field :currency_code
+
   # The total value of this transaction, inclusive or all taxes and line items.
   # @type: number
   # @format: double
@@ -75,6 +83,16 @@ end
   # @format: double
   field :outstanding_amount
 
+  # The total value of this transaction, inclusive or all taxes and line items in the group's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_transaction_amount
+
+  # The remaining balance of this transaction in the group's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_outstanding_amount
+
   # The count of items associated to the transaction.
   #             
   # Examples:

data/app/platform_api/schema/transaction_detail.rb

@@ -10,6 +10,10 @@ end
   # @format: uuid
   field :group_key
 
+  # The base currency code of the group.
+  # @type: string
+  field :base_currency_code
+
   # 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
@@ -58,6 +62,10 @@ end
   # @format: date-time
   field :transaction_invoice_date, Types::Params::DateTime
 
+  # The currency code of the transaction.
+  # @type: string
+  field :currency_code
+
   # The total value of this transaction detail, inclusive or all taxes and line items.
   # @type: number
   # @format: double
@@ -68,6 +76,16 @@ end
   # @format: double
   field :outstanding_amount
 
+  # The total value of this transaction detail, inclusive or all taxes and line items in the group's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_transaction_amount
+
+  # The remaining balance of this transaction detail in the group's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_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