lockstep_rails 0.3.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (174) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.md +216 -0
  4. data/Rakefile +31 -0
  5. data/app/assets/config/lockstep_rails_manifest.js +0 -0
  6. data/app/concepts/lockstep/active_records/association.rb +78 -0
  7. data/app/concepts/lockstep/api_record.rb +1118 -0
  8. data/app/concepts/lockstep/api_records/scopes.rb +20 -0
  9. data/app/concepts/lockstep/client.rb +162 -0
  10. data/app/concepts/lockstep/error.rb +50 -0
  11. data/app/concepts/lockstep/exceptions.rb +4 -0
  12. data/app/concepts/lockstep/query.rb +409 -0
  13. data/app/concepts/lockstep/query_methods.rb +75 -0
  14. data/app/concepts/lockstep/relation_array.rb +100 -0
  15. data/app/helpers/types.rb +3 -0
  16. data/app/models/lockstep/account.rb +15 -0
  17. data/app/models/lockstep/connection.rb +19 -0
  18. data/app/models/lockstep/contact.rb +9 -0
  19. data/app/models/lockstep/customer_summary.rb +6 -0
  20. data/app/models/lockstep/invoice.rb +7 -0
  21. data/app/models/lockstep/invoice_summary.rb +6 -0
  22. data/app/models/lockstep/invoices/address.rb +24 -0
  23. data/app/models/lockstep/note.rb +7 -0
  24. data/app/models/lockstep/payment.rb +7 -0
  25. data/app/models/lockstep/payment_summary.rb +6 -0
  26. data/app/models/lockstep/user.rb +10 -0
  27. data/app/platform_api/model_template.rb.erb +27 -0
  28. data/app/platform_api/schema/action_result.rb +15 -0
  29. data/app/platform_api/schema/activity.rb +141 -0
  30. data/app/platform_api/schema/activity_fetch_result.rb +26 -0
  31. data/app/platform_api/schema/activity_stream_item.rb +58 -0
  32. data/app/platform_api/schema/activity_x_ref.rb +37 -0
  33. data/app/platform_api/schema/aging.rb +24 -0
  34. data/app/platform_api/schema/api_key.rb +71 -0
  35. data/app/platform_api/schema/api_key_fetch_result.rb +26 -0
  36. data/app/platform_api/schema/app_enrollment.rb +88 -0
  37. data/app/platform_api/schema/app_enrollment_custom_field.rb +67 -0
  38. data/app/platform_api/schema/app_enrollment_custom_field_fetch_result.rb +26 -0
  39. data/app/platform_api/schema/app_enrollment_fetch_result.rb +26 -0
  40. data/app/platform_api/schema/application.rb +89 -0
  41. data/app/platform_api/schema/application_fetch_result.rb +26 -0
  42. data/app/platform_api/schema/ar_aging_header_info.rb +47 -0
  43. data/app/platform_api/schema/ar_header_info.rb +118 -0
  44. data/app/platform_api/schema/assembly.rb +68 -0
  45. data/app/platform_api/schema/at_risk_invoice_summary.rb +90 -0
  46. data/app/platform_api/schema/at_risk_invoice_summary_fetch_result.rb +26 -0
  47. data/app/platform_api/schema/attachment.rb +92 -0
  48. data/app/platform_api/schema/attachment_fetch_result.rb +26 -0
  49. data/app/platform_api/schema/attachment_header_info.rb +41 -0
  50. data/app/platform_api/schema/batch_sync.rb +18 -0
  51. data/app/platform_api/schema/bulk_currency_conversion.rb +19 -0
  52. data/app/platform_api/schema/cashflow_report.rb +35 -0
  53. data/app/platform_api/schema/code_definition.rb +58 -0
  54. data/app/platform_api/schema/code_definition_fetch_result.rb +26 -0
  55. data/app/platform_api/schema/company.rb +243 -0
  56. data/app/platform_api/schema/company_fetch_result.rb +26 -0
  57. data/app/platform_api/schema/company_sync.rb +142 -0
  58. data/app/platform_api/schema/connector_info.rb +27 -0
  59. data/app/platform_api/schema/constructor_info.rb +128 -0
  60. data/app/platform_api/schema/contact.rb +148 -0
  61. data/app/platform_api/schema/contact_fetch_result.rb +26 -0
  62. data/app/platform_api/schema/contact_sync.rb +109 -0
  63. data/app/platform_api/schema/country.rb +62 -0
  64. data/app/platform_api/schema/country_fetch_result.rb +26 -0
  65. data/app/platform_api/schema/credit_memo_applied.rb +104 -0
  66. data/app/platform_api/schema/credit_memo_applied_fetch_result.rb +26 -0
  67. data/app/platform_api/schema/credit_memo_applied_sync.rb +67 -0
  68. data/app/platform_api/schema/credit_memo_invoice.rb +77 -0
  69. data/app/platform_api/schema/currency.rb +31 -0
  70. data/app/platform_api/schema/currency_fetch_result.rb +26 -0
  71. data/app/platform_api/schema/currency_rate.rb +28 -0
  72. data/app/platform_api/schema/custom_attribute_data.rb +18 -0
  73. data/app/platform_api/schema/custom_attribute_named_argument.rb +24 -0
  74. data/app/platform_api/schema/custom_attribute_typed_argument.rb +16 -0
  75. data/app/platform_api/schema/custom_field_definition.rb +76 -0
  76. data/app/platform_api/schema/custom_field_definition_fetch_result.rb +26 -0
  77. data/app/platform_api/schema/custom_field_sync.rb +71 -0
  78. data/app/platform_api/schema/custom_field_value.rb +75 -0
  79. data/app/platform_api/schema/custom_field_value_fetch_result.rb +26 -0
  80. data/app/platform_api/schema/customer_details.rb +98 -0
  81. data/app/platform_api/schema/customer_details_payment.rb +60 -0
  82. data/app/platform_api/schema/customer_summary.rb +88 -0
  83. data/app/platform_api/schema/customer_summary_fetch_result.rb +26 -0
  84. data/app/platform_api/schema/daily_sales_outstanding_report.rb +25 -0
  85. data/app/platform_api/schema/developer_account_submit.rb +23 -0
  86. data/app/platform_api/schema/email.rb +160 -0
  87. data/app/platform_api/schema/email_fetch_result.rb +26 -0
  88. data/app/platform_api/schema/erp.rb +23 -0
  89. data/app/platform_api/schema/erp_fetch_result.rb +26 -0
  90. data/app/platform_api/schema/erp_info.rb +18 -0
  91. data/app/platform_api/schema/erp_info_data.rb +23 -0
  92. data/app/platform_api/schema/event_info.rb +59 -0
  93. data/app/platform_api/schema/exception.rb +41 -0
  94. data/app/platform_api/schema/field_info.rb +105 -0
  95. data/app/platform_api/schema/financial_account.rb +90 -0
  96. data/app/platform_api/schema/financial_account_balance_history.rb +90 -0
  97. data/app/platform_api/schema/financial_account_balance_history_fetch_result.rb +26 -0
  98. data/app/platform_api/schema/financial_account_fetch_result.rb +26 -0
  99. data/app/platform_api/schema/financial_year_setting.rb +74 -0
  100. data/app/platform_api/schema/financial_year_setting_fetch_result.rb +26 -0
  101. data/app/platform_api/schema/invite.rb +25 -0
  102. data/app/platform_api/schema/invite_data.rb +18 -0
  103. data/app/platform_api/schema/invite_submit.rb +15 -0
  104. data/app/platform_api/schema/invoice.rb +226 -0
  105. data/app/platform_api/schema/invoice_address.rb +97 -0
  106. data/app/platform_api/schema/invoice_fetch_result.rb +29 -0
  107. data/app/platform_api/schema/invoice_history.rb +188 -0
  108. data/app/platform_api/schema/invoice_history_fetch_result.rb +26 -0
  109. data/app/platform_api/schema/invoice_line.rb +142 -0
  110. data/app/platform_api/schema/invoice_line_sync.rb +208 -0
  111. data/app/platform_api/schema/invoice_payment_detail.rb +65 -0
  112. data/app/platform_api/schema/invoice_summary.rb +85 -0
  113. data/app/platform_api/schema/invoice_summary_fetch_result.rb +26 -0
  114. data/app/platform_api/schema/invoice_sync.rb +280 -0
  115. data/app/platform_api/schema/lead.rb +32 -0
  116. data/app/platform_api/schema/member_info.rb +36 -0
  117. data/app/platform_api/schema/method_base.rb +128 -0
  118. data/app/platform_api/schema/method_info.rb +137 -0
  119. data/app/platform_api/schema/module.rb +44 -0
  120. data/app/platform_api/schema/module_handle.rb +15 -0
  121. data/app/platform_api/schema/note.rb +72 -0
  122. data/app/platform_api/schema/note_fetch_result.rb +26 -0
  123. data/app/platform_api/schema/parameter_info.rb +64 -0
  124. data/app/platform_api/schema/payment.rb +147 -0
  125. data/app/platform_api/schema/payment_applied.rb +95 -0
  126. data/app/platform_api/schema/payment_applied_fetch_result.rb +26 -0
  127. data/app/platform_api/schema/payment_applied_sync.rb +74 -0
  128. data/app/platform_api/schema/payment_detail.rb +110 -0
  129. data/app/platform_api/schema/payment_detail_fetch_result.rb +26 -0
  130. data/app/platform_api/schema/payment_detail_header.rb +43 -0
  131. data/app/platform_api/schema/payment_fetch_result.rb +26 -0
  132. data/app/platform_api/schema/payment_summary.rb +79 -0
  133. data/app/platform_api/schema/payment_summary_fetch_result.rb +26 -0
  134. data/app/platform_api/schema/payment_sync.rb +112 -0
  135. data/app/platform_api/schema/problem_details.rb +31 -0
  136. data/app/platform_api/schema/property_info.rb +60 -0
  137. data/app/platform_api/schema/provisioning.rb +28 -0
  138. data/app/platform_api/schema/provisioning_finalize_request.rb +28 -0
  139. data/app/platform_api/schema/provisioning_response.rb +42 -0
  140. data/app/platform_api/schema/risk_rate.rb +57 -0
  141. data/app/platform_api/schema/runtime_field_handle.rb +13 -0
  142. data/app/platform_api/schema/runtime_method_handle.rb +13 -0
  143. data/app/platform_api/schema/runtime_type_handle.rb +13 -0
  144. data/app/platform_api/schema/state.rb +22 -0
  145. data/app/platform_api/schema/state_fetch_result.rb +26 -0
  146. data/app/platform_api/schema/status.rb +72 -0
  147. data/app/platform_api/schema/struct_layout_attribute.rb +16 -0
  148. data/app/platform_api/schema/sync_entity_result.rb +34 -0
  149. data/app/platform_api/schema/sync_request.rb +71 -0
  150. data/app/platform_api/schema/sync_request_fetch_result.rb +26 -0
  151. data/app/platform_api/schema/sync_submit.rb +15 -0
  152. data/app/platform_api/schema/test_argument_exception.rb +41 -0
  153. data/app/platform_api/schema/test_timeout_exception.rb +41 -0
  154. data/app/platform_api/schema/transfer_owner.rb +16 -0
  155. data/app/platform_api/schema/transfer_owner_submit.rb +15 -0
  156. data/app/platform_api/schema/type.rb +278 -0
  157. data/app/platform_api/schema/type_info.rb +287 -0
  158. data/app/platform_api/schema/uri.rb +15 -0
  159. data/app/platform_api/schema/user_account.rb +152 -0
  160. data/app/platform_api/schema/user_account_fetch_result.rb +26 -0
  161. data/app/platform_api/schema/user_role.rb +50 -0
  162. data/app/platform_api/schema/user_role_fetch_result.rb +26 -0
  163. data/app/platform_api/schema/webhook.rb +96 -0
  164. data/app/platform_api/schema/webhook_fetch_result.rb +26 -0
  165. data/app/platform_api/schema/webhook_history_table_storage.rb +64 -0
  166. data/app/platform_api/schema/webhook_history_table_storage_fetch_result.rb +26 -0
  167. data/app/platform_api/swagger.json +22056 -0
  168. data/config/routes.rb +2 -0
  169. data/lib/lockstep_rails/engine.rb +4 -0
  170. data/lib/lockstep_rails/version.rb +3 -0
  171. data/lib/lockstep_rails.rb +5 -0
  172. data/lib/tasks/lockstep_rails_tasks.rake +4 -0
  173. data/lib/tasks/update_api_schema.rake +159 -0
  174. metadata +230 -0
@@ -0,0 +1,26 @@
1
+ class Schema::PaymentFetchResult < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+
9
+ # @type: integer
10
+ # @format: int32
11
+ field :total_count
12
+
13
+
14
+ # @type: integer
15
+ # @format: int32
16
+ field :page_size
17
+
18
+
19
+ # @type: integer
20
+ # @format: int32
21
+ field :page_number
22
+
23
+
24
+ has_many :records, {:class_name=>"Schema::Payment", :included=>true}
25
+
26
+ end
@@ -0,0 +1,79 @@
1
+ class Schema::PaymentSummary < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
9
+ # account will share the same GroupKey value. GroupKey values cannot be changed once created.
10
+ #
11
+ # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
12
+ # @type: string
13
+ # @format: uuid
14
+ field :group_key
15
+
16
+ # The id of the payment
17
+ # @type: string
18
+ # @format: uuid
19
+ field :payment_id
20
+
21
+ # Memo or reference text (ex. memo field on a check).
22
+ # @type: string
23
+ field :memo_text
24
+
25
+ # Reference code for the payment for the given Erp system.
26
+ # @type: string
27
+ field :reference_code
28
+
29
+ # The type of payment, Payment or AP Payment.
30
+ # @type: string
31
+ field :payment_type
32
+
33
+ # The date of this payment.
34
+ # @type: string
35
+ # @format: date
36
+ field :payment_date
37
+
38
+ # Total amount of this payment.
39
+ # @type: number
40
+ # @format: double
41
+ field :payment_amount
42
+
43
+ # Unapplied balance of this payment.
44
+ # @type: number
45
+ # @format: double
46
+ field :unapplied_amount
47
+
48
+ # The number of invoices associated to this payment.
49
+ # @type: integer
50
+ # @format: int32
51
+ field :invoice_count
52
+
53
+ # The number of payments applied to this payment.
54
+ # @type: number
55
+ # @format: double
56
+ field :total_payments_applied
57
+
58
+ # The reference codes of the invoices associated to this payment.
59
+ # @type: array
60
+ field :invoice_list
61
+
62
+ # The ids of the invoices associated to this payment.
63
+ # @type: array
64
+ field :invoice_id_list
65
+
66
+ # The name of the customer for this payment.
67
+ # @type: string
68
+ field :customer_name
69
+
70
+ # The id of the customer for this payment.
71
+ # @type: string
72
+ # @format: uuid
73
+ field :customer_id
74
+
75
+ belongs_to :customer, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"}
76
+ belongs_to :connection, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"}
77
+
78
+
79
+ end
@@ -0,0 +1,26 @@
1
+ class Schema::PaymentSummaryFetchResult < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+
9
+ # @type: integer
10
+ # @format: int32
11
+ field :total_count
12
+
13
+
14
+ # @type: integer
15
+ # @format: int32
16
+ field :page_size
17
+
18
+
19
+ # @type: integer
20
+ # @format: int32
21
+ field :page_number
22
+
23
+
24
+ has_many :records, {:class_name=>"Schema::PaymentSummary", :included=>true}
25
+
26
+ end
@@ -0,0 +1,112 @@
1
+ class Schema::PaymentSync < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # This is the primary key of the Payment record. For this field, you should use whatever the payment's unique
9
+ # identifying number is in the originating system. Search for a unique, non-changing number within the
10
+ # originating financial system for this record.
11
+ #
12
+ # Example: If you store your payment records in a database, whatever the primary key for the payment table is
13
+ # in the database should be the "ErpKey".
14
+ #
15
+ # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
16
+ # @type: string
17
+ field :erp_key
18
+
19
+ # The original primary key or unique ID of the company to which this payment belongs. This value should
20
+ # match the [Company ErpKey](https://developer.lockstep.io/docs/importing-companies#erpkey) field on the
21
+ # [CompanySyncModel](https://developer.lockstep.io/docs/importing-companies).
22
+ # @type: string
23
+ field :company_erp_key
24
+
25
+ # The type of payment, cash or check.
26
+ #
27
+ # Recognized PaymentType values are:
28
+ # * `Cash` - A cash payment or other direct transfer.
29
+ # * `Check` - A check payment.
30
+ # @type: string
31
+ field :payment_type
32
+
33
+ # Cash, check, credit card, wire transfer.
34
+ #
35
+ # Recognized TenderType values are:
36
+ # * `Cash` - A cash payment or other direct transfer.
37
+ # * `Check` - A check payment.
38
+ # * `Credit Card` - A payment made via a credit card.
39
+ # * `Wire Transfer` - A payment made via wire transfer from another financial institution.
40
+ # @type: string
41
+ field :tender_type
42
+
43
+ # True if this payment includes some unassigned amount that has not yet been applied to an invoice. If this
44
+ # value is true, the field `UnappliedAmount` will be nonzero.
45
+ # @type: boolean
46
+ field :is_open
47
+
48
+ # Memo or reference text (ex. memo field on a check).
49
+ # @type: string
50
+ field :memo_text
51
+
52
+ # The date when this payment was received. This typically is the date when an accounting employee recorded
53
+ # that they received notification that the payment had occurred, whether they were notified by email, postal
54
+ # mail, or financial transaction notification.
55
+ # @type: string
56
+ # @format: date-time
57
+ field :payment_date, Types::Params::DateTime
58
+
59
+ # The date when a payment was posted to a ledger. This date is often determined by a company's accounting
60
+ # practices and may be different than the date when the payment was received. This date may be affected by
61
+ # issues such as temporary holds on funds transferred, bank holidays, or other actions.
62
+ # @type: string
63
+ # @format: date-time
64
+ field :post_date, Types::Params::DateTime
65
+
66
+ # Total amount of this payment.
67
+ # @type: number
68
+ # @format: double
69
+ field :payment_amount
70
+
71
+ # Unapplied balance of this payment. If this amount is nonzero, the field `IsOpen` will be true.
72
+ # @type: number
73
+ # @format: double
74
+ field :unapplied_amount
75
+
76
+ # The ISO 4217 currency code for this payment.
77
+ #
78
+ # For a list of ISO 4217 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
79
+ # @type: string
80
+ field :currency_code
81
+
82
+ # If known, the date when this record was created according to the originating financial system
83
+ # in which this record is maintained. If the originating financial system does not maintain a
84
+ # created-date, leave this field null.
85
+ # @type: string
86
+ # @format: date-time
87
+ field :created, Types::Params::DateTime
88
+
89
+ # If known, the date when this record was most recently modified according to the originating
90
+ # financial system in which this record is maintained. If the originating financial system does
91
+ # not maintain a most-recently-modified-date, leave this field null.
92
+ # @type: string
93
+ # @format: date-time
94
+ field :modified, Types::Params::DateTime
95
+
96
+ # A reference code for the payment for the given financial or ERP system. This can be any value that the
97
+ # originating system uses to designate the payment, such as a confirmation number or tracking number, that
98
+ # is different from the `ErpKey` value.
99
+ # @type: string
100
+ field :reference_code
101
+
102
+ # True if this payment was voided.
103
+ # @type: boolean
104
+ field :is_voided
105
+
106
+ # True if this payment is in dispute.
107
+ # @type: boolean
108
+ field :in_dispute
109
+
110
+
111
+
112
+ end
@@ -0,0 +1,31 @@
1
+ class Schema::ProblemDetails < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+
9
+ # @type: string
10
+ field :type
11
+
12
+
13
+ # @type: string
14
+ field :title
15
+
16
+
17
+ # @type: integer
18
+ # @format: int32
19
+ field :status
20
+
21
+
22
+ # @type: string
23
+ field :detail
24
+
25
+
26
+ # @type: string
27
+ field :instance
28
+
29
+
30
+
31
+ end
@@ -0,0 +1,60 @@
1
+ class Schema::PropertyInfo < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+
9
+ # @type: string
10
+ field :name
11
+
12
+
13
+ field :declaring_type
14
+
15
+
16
+ field :reflected_type
17
+
18
+
19
+ field :module
20
+
21
+
22
+ # @type: boolean
23
+ field :is_collectible
24
+
25
+
26
+ # @type: integer
27
+ # @format: int32
28
+ field :metadata_token
29
+
30
+
31
+ field :member_type
32
+
33
+
34
+ field :property_type
35
+
36
+
37
+ field :attributes
38
+
39
+
40
+ # @type: boolean
41
+ field :is_special_name
42
+
43
+
44
+ # @type: boolean
45
+ field :can_read
46
+
47
+
48
+ # @type: boolean
49
+ field :can_write
50
+
51
+
52
+ field :get_method
53
+
54
+
55
+ field :set_method
56
+
57
+
58
+ has_many :custom_attributes, {:class_name=>"Schema::CustomAttributeData", :included=>true}
59
+
60
+ end
@@ -0,0 +1,28 @@
1
+ class Schema::Provisioning < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # The full name of the new user
9
+ # @type: string
10
+ field :full_name
11
+
12
+ # The time zone of the new user
13
+ # @type: string
14
+ field :time_zone
15
+
16
+ # The default currency of the new user
17
+ # @type: string
18
+ field :default_currency
19
+
20
+ # The information necessary to enroll the user in their ERP
21
+ field :erp
22
+
23
+ # The company information for the new user and group
24
+ field :company
25
+
26
+
27
+
28
+ end
@@ -0,0 +1,28 @@
1
+ class Schema::ProvisioningFinalizeRequest < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # The full name of the user
9
+ # @type: string
10
+ field :full_name
11
+
12
+ # The time zone of the user
13
+ # @type: string
14
+ field :time_zone
15
+
16
+ # The default currency of the user
17
+ # @type: string
18
+ field :default_currency
19
+
20
+ # The company information for the user and group
21
+ field :company
22
+
23
+ # Optional connector information needed to enroll user to their email connector
24
+ field :email_connector
25
+
26
+
27
+
28
+ end
@@ -0,0 +1,42 @@
1
+ class Schema::ProvisioningResponse < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # If provisioning is successful, contains the username of the created user.
9
+ # @type: string
10
+ field :user_name
11
+
12
+ # If provisioning is successful, contains subscription account name of created user.
13
+ # @type: string
14
+ field :account_name
15
+
16
+ # If provisioning is successful, contains the unique identifier of the created user.
17
+ # @type: string
18
+ # @format: uuid
19
+ field :user_id
20
+
21
+ # If provisioning is successful, contains the group key of the created user.
22
+ # @type: string
23
+ # @format: uuid
24
+ field :group_key
25
+
26
+ # If provisioning is successful, contains the app enrollment id of the created app enrollment.
27
+ # @type: string
28
+ # @format: uuid
29
+ field :app_enrollment_id
30
+
31
+ # if provisioning is successful, contains the sync request id of the sync that was started for the app enrollment.
32
+ # @type: string
33
+ # @format: uuid
34
+ field :sync_request_id
35
+
36
+ # The error message(s).
37
+ # @type: string
38
+ field :error_message
39
+
40
+
41
+
42
+ end
@@ -0,0 +1,57 @@
1
+ class Schema::RiskRate < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
9
+ # account will share the same GroupKey value. GroupKey values cannot be changed once created.
10
+ #
11
+ # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
12
+ # @type: string
13
+ # @format: uuid
14
+ field :group_key
15
+
16
+ # The month the risk rate was calculated for
17
+ # @type: string
18
+ # @format: date-time
19
+ field :report_period, Types::Params::DateTime
20
+
21
+ # The string name of the month the risk rate was calculated for
22
+ # @type: string
23
+ field :invoice_month_name
24
+
25
+ # The count of all invoices in the calculation month
26
+ # @type: integer
27
+ # @format: int32
28
+ field :total_invoice_count
29
+
30
+ # The sum of the total amount for invoices in the calculation month
31
+ # @type: number
32
+ # @format: double
33
+ field :total_invoice_amount
34
+
35
+ # The count of open invoices over 90 days from the calculation month
36
+ # @type: integer
37
+ # @format: int32
38
+ field :at_risk_count
39
+
40
+ # The sum of the outstanding balance of open invoices over 90 days from the calculation month
41
+ # @type: number
42
+ # @format: double
43
+ field :at_risk_amount
44
+
45
+ # The percentage of all open invoices for the calculation month that are over 90 days based on count
46
+ # @type: number
47
+ # @format: double
48
+ field :at_risk_count_percentage
49
+
50
+ # The percentage of all open invoices for the calculation month that are over 90 days based on outstanding balance
51
+ # @type: number
52
+ # @format: double
53
+ field :at_risk_percentage
54
+
55
+
56
+
57
+ end
@@ -0,0 +1,13 @@
1
+ class Schema::RuntimeFieldHandle < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+
9
+ field :value
10
+
11
+
12
+
13
+ end
@@ -0,0 +1,13 @@
1
+ class Schema::RuntimeMethodHandle < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+
9
+ field :value
10
+
11
+
12
+
13
+ end
@@ -0,0 +1,13 @@
1
+ class Schema::RuntimeTypeHandle < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+
9
+ field :value
10
+
11
+
12
+
13
+ end
@@ -0,0 +1,22 @@
1
+ class Schema::State < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # Name of the state
9
+ # @type: string
10
+ field :name
11
+
12
+ # 2 letter alphabetic code for the given state
13
+ # @type: string
14
+ field :alpha2
15
+
16
+ # A different name for a state
17
+ # @type: string
18
+ field :aliases
19
+
20
+
21
+
22
+ end
@@ -0,0 +1,26 @@
1
+ class Schema::StateFetchResult < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+
9
+ # @type: integer
10
+ # @format: int32
11
+ field :total_count
12
+
13
+
14
+ # @type: integer
15
+ # @format: int32
16
+ field :page_size
17
+
18
+
19
+ # @type: integer
20
+ # @format: int32
21
+ field :page_number
22
+
23
+
24
+ has_many :records, {:class_name=>"Schema::State", :included=>true}
25
+
26
+ end
@@ -0,0 +1,72 @@
1
+ class Schema::Status < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # If authentication is successful, contains the username of the logged-in user.
9
+ # @type: string
10
+ field :user_name
11
+
12
+ # If authentication is successful, contains subscription account name of logged-in user.
13
+ # @type: string
14
+ field :account_name
15
+
16
+ # If authentication is successful, contains subscription account company id of logged-in user.
17
+ # @type: string
18
+ # @format: uuid
19
+ field :account_company_id
20
+
21
+ # If authentication is successful, contains the unique identifier of the logged-in user.
22
+ # @type: string
23
+ # @format: uuid
24
+ field :user_id
25
+
26
+ # If authentication is successful, contains the group key of the logged-in user.
27
+ # @type: string
28
+ # @format: uuid
29
+ field :group_key
30
+
31
+ # Returns true if authentication for this API was successful.
32
+ # @type: boolean
33
+ field :logged_in
34
+
35
+ # The error message.
36
+ # @type: string
37
+ field :error_message
38
+
39
+ # The set of roles for this user.
40
+ # @type: array
41
+ field :roles
42
+
43
+ # Date and time user has last logged into Azure B2C.
44
+ # @type: string
45
+ # @format: date-time
46
+ field :last_logged_in, Types::Params::DateTime
47
+
48
+ # The id of the API key used to authenticate.
49
+ # @type: string
50
+ # @format: uuid
51
+ field :api_key_id
52
+
53
+ # If authentication is successful, contains the user status of the logged-in user.
54
+ # @type: string
55
+ field :user_status
56
+
57
+ # The environment currently being used
58
+ # @type: string
59
+ field :environment
60
+
61
+ # The version currently being used
62
+ # @type: string
63
+ field :version
64
+
65
+ # Statuses for the dependencies of this api.
66
+ # OK if the dependency is working.
67
+ # @type: object
68
+ field :dependencies
69
+
70
+
71
+
72
+ end
@@ -0,0 +1,16 @@
1
+ class Schema::StructLayoutAttribute < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+
9
+ field :type_id
10
+
11
+
12
+ field :value
13
+
14
+
15
+
16
+ end