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,287 @@
1
+ class Schema::TypeInfo < 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
+ # @type: boolean
14
+ field :is_collectible
15
+
16
+
17
+ # @type: integer
18
+ # @format: int32
19
+ field :metadata_token
20
+
21
+
22
+ # @type: boolean
23
+ field :is_interface
24
+
25
+
26
+ field :member_type
27
+
28
+
29
+ # @type: string
30
+ field :namespace
31
+
32
+
33
+ # @type: string
34
+ field :assembly_qualified_name
35
+
36
+
37
+ # @type: string
38
+ field :full_name
39
+
40
+
41
+ field :assembly
42
+
43
+
44
+ field :module
45
+
46
+
47
+ # @type: boolean
48
+ field :is_nested
49
+
50
+
51
+ field :declaring_type
52
+
53
+
54
+ field :declaring_method
55
+
56
+
57
+ field :reflected_type
58
+
59
+
60
+ field :underlying_system_type
61
+
62
+
63
+ # @type: boolean
64
+ field :is_type_definition
65
+
66
+
67
+ # @type: boolean
68
+ field :is_array
69
+
70
+
71
+ # @type: boolean
72
+ field :is_by_ref
73
+
74
+
75
+ # @type: boolean
76
+ field :is_pointer
77
+
78
+
79
+ # @type: boolean
80
+ field :is_constructed_generic_type
81
+
82
+
83
+ # @type: boolean
84
+ field :is_generic_parameter
85
+
86
+
87
+ # @type: boolean
88
+ field :is_generic_type_parameter
89
+
90
+
91
+ # @type: boolean
92
+ field :is_generic_method_parameter
93
+
94
+
95
+ # @type: boolean
96
+ field :is_generic_type
97
+
98
+
99
+ # @type: boolean
100
+ field :is_generic_type_definition
101
+
102
+
103
+ # @type: boolean
104
+ field :is_sz_array
105
+
106
+
107
+ # @type: boolean
108
+ field :is_variable_bound_array
109
+
110
+
111
+ # @type: boolean
112
+ field :is_by_ref_like
113
+
114
+
115
+ # @type: boolean
116
+ field :has_element_type
117
+
118
+
119
+ # @type: integer
120
+ # @format: int32
121
+ field :generic_parameter_position
122
+
123
+
124
+ field :generic_parameter_attributes
125
+
126
+
127
+ field :attributes
128
+
129
+
130
+ # @type: boolean
131
+ field :is_abstract
132
+
133
+
134
+ # @type: boolean
135
+ field :is_import
136
+
137
+
138
+ # @type: boolean
139
+ field :is_sealed
140
+
141
+
142
+ # @type: boolean
143
+ field :is_special_name
144
+
145
+
146
+ # @type: boolean
147
+ field :is_class
148
+
149
+
150
+ # @type: boolean
151
+ field :is_nested_assembly
152
+
153
+
154
+ # @type: boolean
155
+ field :is_nested_fam_and_assem
156
+
157
+
158
+ # @type: boolean
159
+ field :is_nested_family
160
+
161
+
162
+ # @type: boolean
163
+ field :is_nested_fam_or_assem
164
+
165
+
166
+ # @type: boolean
167
+ field :is_nested_private
168
+
169
+
170
+ # @type: boolean
171
+ field :is_nested_public
172
+
173
+
174
+ # @type: boolean
175
+ field :is_not_public
176
+
177
+
178
+ # @type: boolean
179
+ field :is_public
180
+
181
+
182
+ # @type: boolean
183
+ field :is_auto_layout
184
+
185
+
186
+ # @type: boolean
187
+ field :is_explicit_layout
188
+
189
+
190
+ # @type: boolean
191
+ field :is_layout_sequential
192
+
193
+
194
+ # @type: boolean
195
+ field :is_ansi_class
196
+
197
+
198
+ # @type: boolean
199
+ field :is_auto_class
200
+
201
+
202
+ # @type: boolean
203
+ field :is_unicode_class
204
+
205
+
206
+ # @type: boolean
207
+ field :is_com_object
208
+
209
+
210
+ # @type: boolean
211
+ field :is_contextful
212
+
213
+
214
+ # @type: boolean
215
+ field :is_enum
216
+
217
+
218
+ # @type: boolean
219
+ field :is_marshal_by_ref
220
+
221
+
222
+ # @type: boolean
223
+ field :is_primitive
224
+
225
+
226
+ # @type: boolean
227
+ field :is_value_type
228
+
229
+
230
+ # @type: boolean
231
+ field :is_signature_type
232
+
233
+
234
+ # @type: boolean
235
+ field :is_security_critical
236
+
237
+
238
+ # @type: boolean
239
+ field :is_security_safe_critical
240
+
241
+
242
+ # @type: boolean
243
+ field :is_security_transparent
244
+
245
+
246
+ field :struct_layout_attribute
247
+
248
+
249
+ field :type_initializer
250
+
251
+
252
+ field :type_handle
253
+
254
+
255
+ # @type: string
256
+ # @format: uuid
257
+ field :guid
258
+
259
+
260
+ field :base_type
261
+
262
+
263
+ # @type: boolean
264
+ field :is_serializable
265
+
266
+
267
+ # @type: boolean
268
+ field :contains_generic_parameters
269
+
270
+
271
+ # @type: boolean
272
+ field :is_visible
273
+
274
+
275
+ has_many :custom_attributes, {:class_name=>"Schema::CustomAttributeData", :included=>true}
276
+ has_many :generic_type_arguments, {:class_name=>"Schema::Type", :included=>true}
277
+ has_many :generic_type_parameters, {:class_name=>"Schema::Type", :included=>true}
278
+ has_many :declared_constructors, {:class_name=>"Schema::ConstructorInfo", :included=>true}
279
+ has_many :declared_events, {:class_name=>"Schema::EventInfo", :included=>true}
280
+ has_many :declared_fields, {:class_name=>"Schema::FieldInfo", :included=>true}
281
+ has_many :declared_members, {:class_name=>"Schema::MemberInfo", :included=>true}
282
+ has_many :declared_methods, {:class_name=>"Schema::MethodInfo", :included=>true}
283
+ has_many :declared_nested_types, {:class_name=>"Schema::TypeInfo", :included=>true}
284
+ has_many :declared_properties, {:class_name=>"Schema::PropertyInfo", :included=>true}
285
+ has_many :implemented_interfaces, {:class_name=>"Schema::Type", :included=>true}
286
+
287
+ end
@@ -0,0 +1,15 @@
1
+ class Schema::Uri < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # Represents the download link
9
+ # @type: string
10
+ # @format: uri
11
+ field :download_link
12
+
13
+
14
+
15
+ end
@@ -0,0 +1,152 @@
1
+ class Schema::UserAccount < 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
+ #
11
+ # This record provides a link to the user's Azure AD B2C OID.
12
+ # @type: string
13
+ # @format: uuid
14
+ field :user_id
15
+
16
+ # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
17
+ # account will share the same GroupKey value. GroupKey values cannot be changed once created.
18
+ #
19
+ # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
20
+ # @type: string
21
+ # @format: uuid
22
+ field :group_key
23
+
24
+ # The full name of the user
25
+ # @type: string
26
+ field :user_name
27
+
28
+ # The email of the user
29
+ # @type: string
30
+ # @format: email
31
+ field :email
32
+
33
+ # The status of the user's account
34
+ # @type: string
35
+ field :status
36
+
37
+ # The date that the user account was created
38
+ # @type: string
39
+ # @format: date-time
40
+ field :created, Types::Params::DateTime
41
+
42
+ # The ID of the user who created the user account
43
+ # @type: string
44
+ # @format: uuid
45
+ field :created_user_id
46
+
47
+ # The date the user account was last modified
48
+ # @type: string
49
+ # @format: date-time
50
+ field :modified, Types::Params::DateTime
51
+
52
+ # The ID of the user who last modified the user account
53
+ # @type: string
54
+ # @format: uuid
55
+ field :modified_user_id
56
+
57
+ # The name of the user who last modified the user account
58
+ # @type: string
59
+ field :modified_user_name
60
+
61
+ # The ID of the user in Azure B2C
62
+ # @type: string
63
+ # @format: uuid
64
+ field :b2_c_user_id
65
+
66
+ # The id of the Permission Level for the user.
67
+ # @type: string
68
+ # @format: uuid
69
+ field :user_role
70
+
71
+ # The date timestamp when the invite was sent to the user.
72
+ # @type: string
73
+ # @format: date-time
74
+ field :invite_sent, Types::Params::DateTime
75
+
76
+ # The phone number of the user.
77
+ # @type: string
78
+ field :phone_number
79
+
80
+ # The fax number of the user.
81
+ # @type: string
82
+ field :fax_number
83
+
84
+ # The title of the user; free text field
85
+ # @type: string
86
+ field :title
87
+
88
+ # FK to the CodeDefinition table; CodeType = 'AccountingRole'
89
+ # @type: string
90
+ # @format: uuid
91
+ field :accounting_role_code_def_id
92
+
93
+ # Address Line 1 for this User
94
+ # @type: string
95
+ field :address1
96
+
97
+ # Address Line 2 for this User
98
+ # @type: string
99
+ field :address2
100
+
101
+ # Address Line 3 for this User
102
+ # @type: string
103
+ field :address3
104
+
105
+ # City for this User
106
+ # @type: string
107
+ field :city
108
+
109
+ # Region ("state" in the US) for this User
110
+ # @type: string
111
+ field :state_region
112
+
113
+ # Postal Code this User
114
+ # @type: string
115
+ field :postal_code
116
+
117
+ # Country for this User This will be validated by the /api/v1/countries data set
118
+ # @type: string
119
+ field :country
120
+
121
+ # Image URL for this User
122
+ # @type: string
123
+ field :image_url
124
+
125
+ # Description for this User.
126
+ # @type: string
127
+ field :description
128
+
129
+ # Last date time user logged into Azure B2C.
130
+ # @type: string
131
+ # @format: date-time
132
+ field :b2_c_last_logged_in, Types::Params::DateTime
133
+
134
+ # The default currency code used by this user entity. This value can be overridden
135
+ # for invoices in a different currency code.
136
+ #
137
+ # 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
138
+ # @type: string
139
+ field :default_currency_code
140
+
141
+ # Accounting role definition for this User.
142
+ # To retrieve this collection, specify `AccountingRole` in the "Include" parameter for your query.
143
+ field :accounting_role_code_definition
144
+
145
+ belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
146
+ belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
147
+
148
+ has_many :notes, {:class_name=>"Lockstep::Note", :included=>true, :foreign_key=>:object_key, :polymorphic=>{:table_key=>"UserAccount"}}
149
+ has_many :attachments, {:class_name=>"Schema::Attachment", :included=>true}
150
+ has_many :custom_field_values, {:class_name=>"Schema::CustomFieldValue", :included=>true}
151
+
152
+ end
@@ -0,0 +1,26 @@
1
+ class Schema::UserAccountFetchResult < 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::UserAccount", :included=>true}
25
+
26
+ end
@@ -0,0 +1,50 @@
1
+ class Schema::UserRole < 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 :user_role_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 name of the user role
23
+ # @type: string
24
+ field :user_role_name
25
+
26
+ # The date that the user role was created
27
+ # @type: string
28
+ # @format: date-time
29
+ field :created, Types::Params::DateTime
30
+
31
+ # The ID of the user who created the user role
32
+ # @type: string
33
+ # @format: uuid
34
+ field :created_user_id
35
+
36
+ # The date the user role was last modified
37
+ # @type: string
38
+ # @format: date-time
39
+ field :modified, Types::Params::DateTime
40
+
41
+ # The ID of the user who last modified the user role
42
+ # @type: string
43
+ # @format: uuid
44
+ field :modified_user_id
45
+
46
+ belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
47
+ belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
48
+
49
+
50
+ end
@@ -0,0 +1,26 @@
1
+ class Schema::UserRoleFetchResult < 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::UserRole", :included=>true}
25
+
26
+ end
@@ -0,0 +1,96 @@
1
+ class Schema::Webhook < 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 :webhook_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
+ # A name for the webhook subscription.
23
+ # @type: string
24
+ field :name
25
+
26
+ # The status of the webhook (Active, Inactive, Errored).
27
+ # @type: string
28
+ field :status_code
29
+
30
+ # When the StatusCode is set to Errored a message is supplied for why it was errored.
31
+ # @type: string
32
+ field :status_message
33
+
34
+ # An secret set during webhook creation that can be used to verify that the notification
35
+ # is coming from the Lockstep API.
36
+ # @type: string
37
+ field :client_secret
38
+
39
+ # The format of the content to be returned in the webhook notifications. Options TBD.
40
+ # @type: string
41
+ field :request_content_type
42
+
43
+ # The HTTP Method to be used on the callback URL for use in notifications (GET, POST, PATCH, PUT).
44
+ # @type: string
45
+ field :callback_http_method
46
+
47
+ # The URL where the notification will be sent via the method set in CallbackHttpMethod.
48
+ #
49
+ # When creating a webhook, the Lockstep API will make a call to this url via the method
50
+ # set in the CallbackHttpMethod property with a query parameter of "code" set to an encoded
51
+ # string. To successfully create the webhook, the call must return a successful status code
52
+ # with the query parameter's value as the plain text content.
53
+ # @type: string
54
+ # @format: uri
55
+ field :callback_url
56
+
57
+ # The expiration date for the given webhook subscription. Once the expiration date passes,
58
+ # notifications will no longer be sent to the callback url.
59
+ # @type: string
60
+ # @format: date-time
61
+ field :expiration_date, Types::Params::DateTime
62
+
63
+ # The amount of times a notification should be retried before marking the webhook as errored.
64
+ # @type: integer
65
+ # @format: int32
66
+ field :retry_count
67
+
68
+ # The date this webhook was created
69
+ # @type: string
70
+ # @format: date-time
71
+ field :created, Types::Params::DateTime
72
+
73
+ # The ID of the user who created this webhook
74
+ # @type: string
75
+ # @format: uuid
76
+ field :created_user_id
77
+
78
+ # The date this webhook was last modified
79
+ # @type: string
80
+ # @format: date-time
81
+ field :modified, Types::Params::DateTime
82
+
83
+ # The ID of the user who last modified this webhook
84
+ # @type: string
85
+ # @format: uuid
86
+ field :modified_user_id
87
+
88
+ # The partition key used for the webhook callback history
89
+ # @type: string
90
+ field :partition_key
91
+
92
+ belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
93
+ belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
94
+
95
+
96
+ end
@@ -0,0 +1,26 @@
1
+ class Schema::WebhookFetchResult < 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::Webhook", :included=>true}
25
+
26
+ end