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,41 @@
1
+ class Schema::Exception < 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 :target_site
10
+
11
+
12
+ # @type: string
13
+ field :stack_trace
14
+
15
+
16
+ # @type: string
17
+ field :message
18
+
19
+
20
+ # @type: object
21
+ field :data
22
+
23
+
24
+ field :inner_exception
25
+
26
+
27
+ # @type: string
28
+ field :help_link
29
+
30
+
31
+ # @type: string
32
+ field :source
33
+
34
+
35
+ # @type: integer
36
+ # @format: int32
37
+ field :h_result
38
+
39
+
40
+
41
+ end
@@ -0,0 +1,105 @@
1
+ class Schema::FieldInfo < 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 :attributes
35
+
36
+
37
+ field :field_type
38
+
39
+
40
+ # @type: boolean
41
+ field :is_init_only
42
+
43
+
44
+ # @type: boolean
45
+ field :is_literal
46
+
47
+
48
+ # @type: boolean
49
+ field :is_not_serialized
50
+
51
+
52
+ # @type: boolean
53
+ field :is_pinvoke_impl
54
+
55
+
56
+ # @type: boolean
57
+ field :is_special_name
58
+
59
+
60
+ # @type: boolean
61
+ field :is_static
62
+
63
+
64
+ # @type: boolean
65
+ field :is_assembly
66
+
67
+
68
+ # @type: boolean
69
+ field :is_family
70
+
71
+
72
+ # @type: boolean
73
+ field :is_family_and_assembly
74
+
75
+
76
+ # @type: boolean
77
+ field :is_family_or_assembly
78
+
79
+
80
+ # @type: boolean
81
+ field :is_private
82
+
83
+
84
+ # @type: boolean
85
+ field :is_public
86
+
87
+
88
+ # @type: boolean
89
+ field :is_security_critical
90
+
91
+
92
+ # @type: boolean
93
+ field :is_security_safe_critical
94
+
95
+
96
+ # @type: boolean
97
+ field :is_security_transparent
98
+
99
+
100
+ field :field_handle
101
+
102
+
103
+ has_many :custom_attributes, {:class_name=>"Schema::CustomAttributeData", :included=>true}
104
+
105
+ end
@@ -0,0 +1,90 @@
1
+ class Schema::FinancialAccount < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # The unique identifier for the Financial Account.
9
+ # @type: string
10
+ # @format: uuid
11
+ field :financial_account_id
12
+
13
+ # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
14
+ # account will share the same GroupKey value. GroupKey values cannot be changed once created.
15
+ #
16
+ # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
17
+ # @type: string
18
+ # @format: uuid
19
+ field :group_key
20
+
21
+ # The code for the Financial Account. Can either be a general ledger or
22
+ # an account code.
23
+ # @type: string
24
+ field :code
25
+
26
+ # The External Id for the Financial Account.
27
+ # @type: string
28
+ field :erp_key
29
+
30
+ # The App Enrollment Id for the Financial Account.
31
+ # @type: string
32
+ # @format: uuid
33
+ field :app_enrollment_id
34
+
35
+ # The name of the Financial Account.
36
+ # @type: string
37
+ field :name
38
+
39
+ # The status of the Financial Account. Possible values are active,
40
+ # inactive, deleted or archived.
41
+ # @type: string
42
+ field :status
43
+
44
+ # The cashflow type for the Financial Account. Examples include cash, financing, investment
45
+ # or operation.
46
+ # @type: string
47
+ field :cashflow_type
48
+
49
+ # The description for the Financial Account.
50
+ # @type: string
51
+ field :description
52
+
53
+ # The classification for the Financial Account. Possible values are Asset, Equity,
54
+ # Expense, Liability or Revenue.
55
+ # @type: string
56
+ field :classification
57
+
58
+ # The category for the Financial Account. Examples include Current Asset, Current Liability, Common Stock
59
+ # @type: string
60
+ field :category
61
+
62
+ # The subcategory for the Financial Account. Examples include Cash, Property, Bank Loan, etc.
63
+ # @type: string
64
+ field :subcategory
65
+
66
+ # The date the FinancialAccount was created.
67
+ # @type: string
68
+ # @format: date-time
69
+ field :created, Types::Params::DateTime
70
+
71
+ # The user that has created the Financial Account.
72
+ # @type: string
73
+ # @format: uuid
74
+ field :created_user_id
75
+
76
+ # The date the Financial Account was modified.
77
+ # @type: string
78
+ # @format: date-time
79
+ field :modified, Types::Params::DateTime
80
+
81
+ # The user that has modified the Financial Account.
82
+ # @type: string
83
+ # @format: uuid
84
+ field :modified_user_id
85
+
86
+ belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
87
+ belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
88
+
89
+
90
+ end
@@ -0,0 +1,90 @@
1
+ class Schema::FinancialAccountBalanceHistory < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # The unique ID of this record, automatically assigned by Lockstep when this record is
9
+ # added to the Lockstep platform.
10
+ # @type: string
11
+ # @format: uuid
12
+ field :financial_account_balance_history_id
13
+
14
+ # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
15
+ # account will share the same GroupKey value. GroupKey values cannot be changed once created.
16
+ #
17
+ # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
18
+ # @type: string
19
+ # @format: uuid
20
+ field :group_key
21
+
22
+ # The id of the Financial Account that this balance history is for.
23
+ # @type: string
24
+ # @format: uuid
25
+ field :financial_account_id
26
+
27
+ # The AppEnrollmentId of the application that imported this record. For accounts
28
+ # with more than one financial system connected, this field identifies the originating
29
+ # financial system that produced this record. This value is null if this record
30
+ # was not loaded from an external ERP or financial system.
31
+ # @type: string
32
+ # @format: uuid
33
+ field :app_enrollment_id
34
+
35
+ # The financial year that this period falls under
36
+ # @type: integer
37
+ # @format: int32
38
+ field :financial_year
39
+
40
+ # The period number (1-12 or 1-13) that this balance history is for
41
+ # @type: integer
42
+ # @format: int32
43
+ field :period_number
44
+
45
+ # The start date of this period.
46
+ # @type: string
47
+ # @format: date-time
48
+ field :period_start_date, Types::Params::DateTime
49
+
50
+ # The end date of this period.
51
+ # @type: string
52
+ # @format: date-time
53
+ field :period_end_date, Types::Params::DateTime
54
+
55
+ # The status of this period. The status should be Closed if the books for this period have been closed,
56
+ # if not the status should be Open. The status can also be Deleted if there was a recalculation that needed
57
+ # to occur, for example due to a change in financial year settings.
58
+ # @type: string
59
+ field :status
60
+
61
+ # The current or end balance of this period.
62
+ # @type: number
63
+ # @format: double
64
+ field :balance
65
+
66
+ # The date on which this financial account balance history record was created.
67
+ # @type: string
68
+ # @format: date-time
69
+ field :created, Types::Params::DateTime
70
+
71
+ # The ID number of the user who created this financial account balance history.
72
+ # @type: string
73
+ # @format: uuid
74
+ field :created_user_id
75
+
76
+ # The date on which this financial account balance history record was modified.
77
+ # @type: string
78
+ # @format: date-time
79
+ field :modified, Types::Params::DateTime
80
+
81
+ # The ID number of the user who most recently modified this financial account balance history.
82
+ # @type: string
83
+ # @format: uuid
84
+ field :modified_user_id
85
+
86
+ belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
87
+ belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
88
+
89
+
90
+ end
@@ -0,0 +1,26 @@
1
+ class Schema::FinancialAccountBalanceHistoryFetchResult < 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::FinancialAccountBalanceHistory", :included=>true}
25
+
26
+ end
@@ -0,0 +1,26 @@
1
+ class Schema::FinancialAccountFetchResult < 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::FinancialAccount", :included=>true}
25
+
26
+ end
@@ -0,0 +1,74 @@
1
+ class Schema::FinancialYearSetting < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # The unique ID of this record, automatically assigned by Lockstep when this record is
9
+ # added to the Lockstep platform.
10
+ # @type: string
11
+ # @format: uuid
12
+ field :financial_year_setting_id
13
+
14
+ # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
15
+ # account will share the same GroupKey value. GroupKey values cannot be changed once created.
16
+ #
17
+ # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
18
+ # @type: string
19
+ # @format: uuid
20
+ field :group_key
21
+
22
+ # The AppEnrollmentId of the application that imported this record. For accounts
23
+ # with more than one financial system connected, this field identifies the originating
24
+ # financial system that produced this record. This value is null if this record
25
+ # was not loaded from an external ERP or financial system.
26
+ # @type: string
27
+ # @format: uuid
28
+ field :app_enrollment_id
29
+
30
+ # The type of financial year, either Calendar or Fiscal.
31
+ # @type: string
32
+ field :year_type
33
+
34
+ # Total number of periods in the year. For Calendar year types this should always be 12. For Fiscal year types
35
+ # this can either be 12 or 13 for a 4 week 13 period year.
36
+ # @type: integer
37
+ # @format: int32
38
+ field :total_periods
39
+
40
+ # The start date of the financial year. Should be entered in MM-DD format.
41
+ # @type: string
42
+ # @format: date
43
+ field :start_date
44
+
45
+ # The end date of the financial year. Should be entered in MM-DD format.
46
+ # @type: string
47
+ # @format: date
48
+ field :end_date
49
+
50
+ # The date on which this financial year setting record was created.
51
+ # @type: string
52
+ # @format: date-time
53
+ field :created, Types::Params::DateTime
54
+
55
+ # The ID number of the user who created this financial year setting.
56
+ # @type: string
57
+ # @format: uuid
58
+ field :created_user_id
59
+
60
+ # The date on which this financial year setting record was last modified.
61
+ # @type: string
62
+ # @format: date-time
63
+ field :modified, Types::Params::DateTime
64
+
65
+ # The ID number of the user who most recently modified this financial year setting.
66
+ # @type: string
67
+ # @format: uuid
68
+ field :modified_user_id
69
+
70
+ belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
71
+ belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
72
+
73
+
74
+ end
@@ -0,0 +1,26 @@
1
+ class Schema::FinancialYearSettingFetchResult < 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::FinancialYearSetting", :included=>true}
25
+
26
+ end
@@ -0,0 +1,25 @@
1
+ class Schema::Invite < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # The invited email address
9
+ # @type: string
10
+ field :email
11
+
12
+ # True if the invite was sent successfully
13
+ # @type: boolean
14
+ field :success
15
+
16
+ # The invited user, may be null if the user could not be invited
17
+ field :invited_user
18
+
19
+ # The error message if the invite was not successful
20
+ # @type: string
21
+ field :error_message
22
+
23
+
24
+
25
+ end
@@ -0,0 +1,18 @@
1
+ class Schema::InviteData < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # The email address of the invited user.
9
+ # @type: string
10
+ field :email
11
+
12
+ # The status of the user.
13
+ # @type: string
14
+ field :user_status
15
+
16
+
17
+
18
+ end
@@ -0,0 +1,15 @@
1
+ class Schema::InviteSubmit < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # The email address of the user to invite
9
+ # @type: string
10
+ # @format: email
11
+ field :email
12
+
13
+
14
+
15
+ end