fusionauth_client 1.31.0 → 1.34.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 797d23a1d462217a91f20bf6a6bc9176f186f9522ffbd739bd526e728c3945f4
4
- data.tar.gz: dbbe0ceeb2c7674889a8be4064b99856aa05cec8eddbb2221add95907331f1c2
3
+ metadata.gz: 835c190bdd098d984b2b2d12b509bac233d06fe3ddd9ea164547f6e36dcbb252
4
+ data.tar.gz: 6daa2a35b29cbc83750aeaf1403389d9739d5719fcc92443c7483408ad7db1c2
5
5
  SHA512:
6
- metadata.gz: faef055bf17d8ae7328cb621056531732081015b06e5b8f6dbc728af9cafe5f3793bd52858e3801022b7541b9a6e0b29350b6f544e74a9c56eb64f2f1ad772a6
7
- data.tar.gz: b80fa21d86d76e1dfd6b44b5bb4ae051d6d629a97948ad5352af3a46cf07116a3ade7883dc020cad43470dd9acde8527616b1e95438bbcd8837394fc62cbfe23
6
+ metadata.gz: e957b952ab5de83f1b2cfda1847cb5cef605b38a1696825e97f80c45fb51c218d2d27e46264edbeed0b491ddb916a6364d953170ec823930c5e9eee465cfc12d
7
+ data.tar.gz: f828049d36341da401b4cbff6b2170b649c2845e899477ea327b5c2e19be86cf76c9e7ec95c6f73a3dacb7b2401dee5b5104ec596849e153d8fc969eb1e0c7fd
data/.ruby-version CHANGED
@@ -1 +1 @@
1
- 2.5.1
1
+ 2.5.9
data/Gemfile CHANGED
@@ -13,7 +13,7 @@
13
13
  # language governing permissions and limitations under the License.
14
14
 
15
15
  source 'https://rubygems.org'
16
- ruby '2.5.1'
16
+ ruby '2.5.9'
17
17
 
18
18
  gem "rake", "12.3.3"
19
19
  gem "minitest", "5.8.3"
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- fusionauth_client (1.31.0)
4
+ fusionauth_client (1.34.0)
5
5
 
6
6
  GEM
7
7
  remote: https://rubygems.org/
@@ -21,7 +21,7 @@ DEPENDENCIES
21
21
  rake (= 12.3.3)
22
22
 
23
23
  RUBY VERSION
24
- ruby 2.5.1p57
24
+ ruby 2.5.9p229
25
25
 
26
26
  BUNDLED WITH
27
27
  2.2.5
data/build.savant CHANGED
@@ -16,13 +16,19 @@
16
16
  savantVersion = "1.0.0"
17
17
 
18
18
  pubVersion = ""
19
- project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.31.0", licenses: ["ApacheV2_0"]) {
19
+ project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.34.0", licenses: ["ApacheV2_0"]) {
20
20
  workflow {
21
- standard()
21
+ fetch {
22
+ cache()
23
+ url(url: "https://repository.savantbuild.org")
24
+ }
25
+ publish {
26
+ cache()
27
+ }
22
28
  }
23
29
 
24
30
  publishWorkflow {
25
- subversion(repository: "http://svn.inversoft.org/savant")
31
+ subversion(repository: "https://svn.savantbuild.org")
26
32
  }
27
33
 
28
34
  pubVersion = project.version.toString().replaceAll('-', '.pre.')
@@ -34,7 +40,7 @@ project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.31.0
34
40
  }
35
41
 
36
42
  // Plugins
37
- file = loadPlugin(id: "org.savantbuild.plugin:file:${savantVersion}")
43
+ file = loadPlugin(id: "org.savantbuild.plugin:file:1.0.2")
38
44
  release = loadPlugin(id: "org.savantbuild.plugin:release-git:${savantVersion}")
39
45
 
40
46
  target(name: "clean", description: "Cleans build directory") {
@@ -6,11 +6,10 @@
6
6
  <sourceFolder url="file://$MODULE_DIR$/lib" isTestSource="false" />
7
7
  <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
8
8
  </content>
9
- <orderEntry type="jdk" jdkName="rbenv: 2.5.1" jdkType="RUBY_SDK" />
9
+ <orderEntry type="jdk" jdkName="rbenv: 2.5.9" jdkType="RUBY_SDK" />
10
10
  <orderEntry type="sourceFolder" forTests="false" />
11
- <orderEntry type="library" scope="PROVIDED" name="bundler (v2.2.5, rbenv: 2.5.1) [gem]" level="application" />
12
- <orderEntry type="library" scope="PROVIDED" name="minitest (v5.8.3, rbenv: 2.5.1) [gem]" level="application" />
13
- <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, rbenv: 2.5.1) [gem]" level="application" />
11
+ <orderEntry type="library" scope="PROVIDED" name="bundler (v2.2.5, rbenv: 2.5.9) [gem]" level="application" />
12
+ <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, rbenv: 2.5.9) [gem]" level="application" />
14
13
  </component>
15
14
  <component name="RakeTasksCache">
16
15
  <option name="myRootTask">
@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
4
 
5
5
  Gem::Specification.new do |spec|
6
6
  spec.name = 'fusionauth_client'
7
- spec.version = '1.31.0'
7
+ spec.version = '1.34.0'
8
8
  spec.authors = ['Brian Pontarelli', 'Daniel DeGroff']
9
9
  spec.email = %w(brian@fusionauth.io daniel@fusionauth.io)
10
10
 
@@ -71,7 +71,7 @@ module FusionAuth
71
71
  # Adds a user to an existing family. The family id must be specified.
72
72
  #
73
73
  # @param family_id [string] The id of the family.
74
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to determine which user to add to the family.
74
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to determine which user to add to the family.
75
75
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
76
76
  def add_user_to_family(family_id, request)
77
77
  start.uri('/api/user/family')
@@ -98,6 +98,9 @@ module FusionAuth
98
98
  #
99
99
  # Changes a user's password using the change password Id. This usually occurs after an email has been sent to the user
100
100
  # and they clicked on a link to reset their password.
101
+ #
102
+ # As of version 1.32.2, prefer sending the changePasswordId in the request body. To do this, omit the first parameter, and set
103
+ # the value in the request body.
101
104
  #
102
105
  # @param change_password_id [string] The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated.
103
106
  # @param request [OpenStruct, Hash] The change password request that contains all of the information used to change the password.
@@ -124,10 +127,58 @@ module FusionAuth
124
127
  .go()
125
128
  end
126
129
 
130
+ #
131
+ # Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
132
+ # When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
133
+ # your password, you must obtain a Truest Token by completing a Two-Factor Step-Up authentication.
134
+ #
135
+ # An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
136
+ #
137
+ # @param change_password_id [string] The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated.
138
+ # @return [FusionAuth::ClientResponse] The ClientResponse object.
139
+ def check_change_password_using_id(change_password_id)
140
+ startAnonymous.uri('/api/user/change-password')
141
+ .url_segment(change_password_id)
142
+ .get()
143
+ .go()
144
+ end
145
+
146
+ #
147
+ # Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
148
+ # When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
149
+ # your password, you must obtain a Truest Token by completing a Two-Factor Step-Up authentication.
150
+ #
151
+ # An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
152
+ #
153
+ # @param encoded_jwt [string] The encoded JWT (access token).
154
+ # @return [FusionAuth::ClientResponse] The ClientResponse object.
155
+ def check_change_password_using_jwt(encoded_jwt)
156
+ startAnonymous.uri('/api/user/change-password')
157
+ .authorization('Bearer ' + encoded_jwt)
158
+ .get()
159
+ .go()
160
+ end
161
+
162
+ #
163
+ # Check to see if the user must obtain a Trust Request Id in order to complete a change password request.
164
+ # When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
165
+ # your password, you must obtain a Truest Request Id by completing a Two-Factor Step-Up authentication.
166
+ #
167
+ # An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
168
+ #
169
+ # @param login_id [string] The loginId of the User that you intend to change the password for.
170
+ # @return [FusionAuth::ClientResponse] The ClientResponse object.
171
+ def check_change_password_using_login_id(login_id)
172
+ start.uri('/api/user/change-password')
173
+ .url_parameter('username', login_id)
174
+ .get()
175
+ .go()
176
+ end
177
+
127
178
  #
128
179
  # Adds a comment to the user's account.
129
180
  #
130
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the user comment.
181
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the user comment.
131
182
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
132
183
  def comment_on_user(request)
133
184
  start.uri('/api/user/comment')
@@ -158,7 +209,7 @@ module FusionAuth
158
209
  # Creates an application. You can optionally specify an Id for the application, if not provided one will be generated.
159
210
  #
160
211
  # @param application_id [string] (Optional) The Id to use for the application. If not provided a secure random UUID will be generated.
161
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the application.
212
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the application.
162
213
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
163
214
  def create_application(application_id, request)
164
215
  start.uri('/api/application')
@@ -174,7 +225,7 @@ module FusionAuth
174
225
  #
175
226
  # @param application_id [string] The Id of the application to create the role on.
176
227
  # @param role_id [string] (Optional) The Id of the role. If not provided a secure random UUID will be generated.
177
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the application role.
228
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the application role.
178
229
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
179
230
  def create_application_role(application_id, role_id, request)
180
231
  start.uri('/api/application')
@@ -191,7 +242,7 @@ module FusionAuth
191
242
  # make changes to the FusionAuth database. When using the FusionAuth App web interface, any changes are automatically
192
243
  # written to the audit log. However, if you are accessing the API, you must write the audit logs yourself.
193
244
  #
194
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the audit log entry.
245
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the audit log entry.
195
246
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
196
247
  def create_audit_log(request)
197
248
  start.uri('/api/system/audit-log')
@@ -204,7 +255,7 @@ module FusionAuth
204
255
  # Creates a connector. You can optionally specify an Id for the connector, if not provided one will be generated.
205
256
  #
206
257
  # @param connector_id [string] (Optional) The Id for the connector. If not provided a secure random UUID will be generated.
207
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the connector.
258
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the connector.
208
259
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
209
260
  def create_connector(connector_id, request)
210
261
  start.uri('/api/connector')
@@ -218,7 +269,7 @@ module FusionAuth
218
269
  # Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated.
219
270
  #
220
271
  # @param consent_id [string] (Optional) The Id for the consent. If not provided a secure random UUID will be generated.
221
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the consent.
272
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the consent.
222
273
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
223
274
  def create_consent(consent_id, request)
224
275
  start.uri('/api/consent')
@@ -232,7 +283,7 @@ module FusionAuth
232
283
  # Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
233
284
  #
234
285
  # @param email_template_id [string] (Optional) The Id for the template. If not provided a secure random UUID will be generated.
235
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the email template.
286
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the email template.
236
287
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
237
288
  def create_email_template(email_template_id, request)
238
289
  start.uri('/api/email/template')
@@ -246,7 +297,7 @@ module FusionAuth
246
297
  # Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated.
247
298
  #
248
299
  # @param entity_id [string] (Optional) The Id for the Entity. If not provided a secure random UUID will be generated.
249
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the Entity.
300
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the Entity.
250
301
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
251
302
  def create_entity(entity_id, request)
252
303
  start.uri('/api/entity')
@@ -260,7 +311,7 @@ module FusionAuth
260
311
  # Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated.
261
312
  #
262
313
  # @param entity_type_id [string] (Optional) The Id for the Entity Type. If not provided a secure random UUID will be generated.
263
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the Entity Type.
314
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the Entity Type.
264
315
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
265
316
  def create_entity_type(entity_type_id, request)
266
317
  start.uri('/api/entity/type')
@@ -276,7 +327,7 @@ module FusionAuth
276
327
  #
277
328
  # @param entity_type_id [string] The Id of the entity type to create the permission on.
278
329
  # @param permission_id [string] (Optional) The Id of the permission. If not provided a secure random UUID will be generated.
279
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the permission.
330
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the permission.
280
331
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
281
332
  def create_entity_type_permission(entity_type_id, permission_id, request)
282
333
  start.uri('/api/entity/type')
@@ -293,7 +344,7 @@ module FusionAuth
293
344
  # family, if not provided one will be generated.
294
345
  #
295
346
  # @param family_id [string] (Optional) The id for the family. If not provided a secure random UUID will be generated.
296
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the family.
347
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the family.
297
348
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
298
349
  def create_family(family_id, request)
299
350
  start.uri('/api/user/family')
@@ -307,7 +358,7 @@ module FusionAuth
307
358
  # Creates a form. You can optionally specify an Id for the form, if not provided one will be generated.
308
359
  #
309
360
  # @param form_id [string] (Optional) The Id for the form. If not provided a secure random UUID will be generated.
310
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the form.
361
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the form.
311
362
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
312
363
  def create_form(form_id, request)
313
364
  start.uri('/api/form')
@@ -321,7 +372,7 @@ module FusionAuth
321
372
  # Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated.
322
373
  #
323
374
  # @param field_id [string] (Optional) The Id for the form field. If not provided a secure random UUID will be generated.
324
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the form field.
375
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the form field.
325
376
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
326
377
  def create_form_field(field_id, request)
327
378
  start.uri('/api/form/field')
@@ -335,7 +386,7 @@ module FusionAuth
335
386
  # Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.
336
387
  #
337
388
  # @param group_id [string] (Optional) The Id for the group. If not provided a secure random UUID will be generated.
338
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the group.
389
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the group.
339
390
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
340
391
  def create_group(group_id, request)
341
392
  start.uri('/api/group')
@@ -348,7 +399,7 @@ module FusionAuth
348
399
  #
349
400
  # Creates a member in a group.
350
401
  #
351
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the group member(s).
402
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the group member(s).
352
403
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
353
404
  def create_group_members(request)
354
405
  start.uri('/api/group/member')
@@ -361,7 +412,7 @@ module FusionAuth
361
412
  # Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated.
362
413
  #
363
414
  # @param access_control_list_id [string] (Optional) The Id for the IP Access Control List. If not provided a secure random UUID will be generated.
364
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the IP Access Control List.
415
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the IP Access Control List.
365
416
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
366
417
  def create_ip_access_control_list(access_control_list_id, request)
367
418
  start.uri('/api/ip-acl')
@@ -375,7 +426,7 @@ module FusionAuth
375
426
  # Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.
376
427
  #
377
428
  # @param identity_provider_id [string] (Optional) The Id of the identity provider. If not provided a secure random UUID will be generated.
378
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the identity provider.
429
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the identity provider.
379
430
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
380
431
  def create_identity_provider(identity_provider_id, request)
381
432
  start.uri('/api/identity-provider')
@@ -389,7 +440,7 @@ module FusionAuth
389
440
  # Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated.
390
441
  #
391
442
  # @param lambda_id [string] (Optional) The Id for the lambda. If not provided a secure random UUID will be generated.
392
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the lambda.
443
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the lambda.
393
444
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
394
445
  def create_lambda(lambda_id, request)
395
446
  start.uri('/api/lambda')
@@ -403,7 +454,7 @@ module FusionAuth
403
454
  # Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated.
404
455
  #
405
456
  # @param message_template_id [string] (Optional) The Id for the template. If not provided a secure random UUID will be generated.
406
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the message template.
457
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the message template.
407
458
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
408
459
  def create_message_template(message_template_id, request)
409
460
  start.uri('/api/message/template')
@@ -417,7 +468,7 @@ module FusionAuth
417
468
  # Creates a messenger. You can optionally specify an Id for the messenger, if not provided one will be generated.
418
469
  #
419
470
  # @param messenger_id [string] (Optional) The Id for the messenger. If not provided a secure random UUID will be generated.
420
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the messenger.
471
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the messenger.
421
472
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
422
473
  def create_messenger(messenger_id, request)
423
474
  start.uri('/api/messenger')
@@ -431,7 +482,7 @@ module FusionAuth
431
482
  # Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated.
432
483
  #
433
484
  # @param tenant_id [string] (Optional) The Id for the tenant. If not provided a secure random UUID will be generated.
434
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the tenant.
485
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the tenant.
435
486
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
436
487
  def create_tenant(tenant_id, request)
437
488
  start.uri('/api/tenant')
@@ -445,7 +496,7 @@ module FusionAuth
445
496
  # Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated.
446
497
  #
447
498
  # @param theme_id [string] (Optional) The Id for the theme. If not provided a secure random UUID will be generated.
448
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the theme.
499
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the theme.
449
500
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
450
501
  def create_theme(theme_id, request)
451
502
  start.uri('/api/theme')
@@ -459,7 +510,7 @@ module FusionAuth
459
510
  # Creates a user. You can optionally specify an Id for the user, if not provided one will be generated.
460
511
  #
461
512
  # @param user_id [string] (Optional) The Id for the user. If not provided a secure random UUID will be generated.
462
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the user.
513
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the user.
463
514
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
464
515
  def create_user(user_id, request)
465
516
  start.uri('/api/user')
@@ -474,7 +525,7 @@ module FusionAuth
474
525
  # that the user action can be applied to any user.
475
526
  #
476
527
  # @param user_action_id [string] (Optional) The Id for the user action. If not provided a secure random UUID will be generated.
477
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the user action.
528
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the user action.
478
529
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
479
530
  def create_user_action(user_action_id, request)
480
531
  start.uri('/api/user-action')
@@ -489,7 +540,7 @@ module FusionAuth
489
540
  # successfully. Anytime after that the user action reason can be used.
490
541
  #
491
542
  # @param user_action_reason_id [string] (Optional) The Id for the user action reason. If not provided a secure random UUID will be generated.
492
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the user action reason.
543
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the user action reason.
493
544
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
494
545
  def create_user_action_reason(user_action_reason_id, request)
495
546
  start.uri('/api/user-action-reason')
@@ -516,7 +567,7 @@ module FusionAuth
516
567
  #
517
568
  # Link an external user from a 3rd party identity provider to a FusionAuth user.
518
569
  #
519
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to link the FusionAuth user.
570
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to link the FusionAuth user.
520
571
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
521
572
  def create_user_link(request)
522
573
  start.uri('/api/identity-provider/link')
@@ -529,7 +580,7 @@ module FusionAuth
529
580
  # Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
530
581
  #
531
582
  # @param webhook_id [string] (Optional) The Id for the webhook. If not provided a secure random UUID will be generated.
532
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the webhook.
583
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the webhook.
533
584
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
534
585
  def create_webhook(webhook_id, request)
535
586
  start.uri('/api/webhook')
@@ -933,7 +984,7 @@ module FusionAuth
933
984
  # with the tenant and everything under the tenant (applications, users, etc).
934
985
  #
935
986
  # @param tenant_id [string] The Id of the tenant to delete.
936
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to delete the user.
987
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to delete the user.
937
988
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
938
989
  def delete_tenant_with_request(tenant_id, request)
939
990
  start.uri('/api/tenant')
@@ -1016,7 +1067,7 @@ module FusionAuth
1016
1067
  # with the user.
1017
1068
  #
1018
1069
  # @param user_id [string] The Id of the user to delete (required).
1019
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to delete the user.
1070
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to delete the user.
1020
1071
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
1021
1072
  def delete_user_with_request(user_id, request)
1022
1073
  start.uri('/api/user')
@@ -1257,7 +1308,7 @@ module FusionAuth
1257
1308
  # Generate a new RSA or EC key pair or an HMAC secret.
1258
1309
  #
1259
1310
  # @param key_id [string] (Optional) The Id for the key. If not provided a secure random UUID will be generated.
1260
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the key.
1311
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the key.
1261
1312
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
1262
1313
  def generate_key(key_id, request)
1263
1314
  start.uri('/api/key/generate')
@@ -1339,7 +1390,7 @@ module FusionAuth
1339
1390
  # Import an existing RSA or EC key pair or an HMAC secret.
1340
1391
  #
1341
1392
  # @param key_id [string] (Optional) The Id for the key. If not provided a secure random UUID will be generated.
1342
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the key.
1393
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the key.
1343
1394
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
1344
1395
  def import_key(key_id, request)
1345
1396
  start.uri('/api/key/import')
@@ -1482,7 +1533,7 @@ module FusionAuth
1482
1533
  # The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the
1483
1534
  # client and revoke the refresh token stored. This API takes the refresh token in the JSON body.
1484
1535
  #
1485
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to logout the user.
1536
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to logout the user.
1486
1537
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
1487
1538
  def logout_with_request(request)
1488
1539
  startAnonymous.uri('/api/logout')
@@ -3483,7 +3534,7 @@ module FusionAuth
3483
3534
  #
3484
3535
  # Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
3485
3536
  #
3486
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to send the code.
3537
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to send the code.
3487
3538
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
3488
3539
  # @deprecated This method has been renamed to send_two_factor_code_for_enable_disable, use that method instead.
3489
3540
  def send_two_factor_code(request)
@@ -3496,7 +3547,7 @@ module FusionAuth
3496
3547
  #
3497
3548
  # Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
3498
3549
  #
3499
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to send the code.
3550
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to send the code.
3500
3551
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
3501
3552
  def send_two_factor_code_for_enable_disable(request)
3502
3553
  start.uri('/api/two-factor/send')
@@ -3591,7 +3642,7 @@ module FusionAuth
3591
3642
  # Updates an API key by given id
3592
3643
  #
3593
3644
  # @param api_key_id [string] The Id of the API key to update.
3594
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the API Key.
3645
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the API Key.
3595
3646
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
3596
3647
  def update_api_key(api_key_id, request)
3597
3648
  start.uri('/api/api-key')
@@ -3985,7 +4036,7 @@ module FusionAuth
3985
4036
  # Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity.
3986
4037
  #
3987
4038
  # @param entity_id [string] The Id of the Entity that the User/Entity is being granted access to.
3988
- # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the Entity Grant.
4039
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the Entity Grant.
3989
4040
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
3990
4041
  def upsert_entity_grant(entity_id, request)
3991
4042
  start.uri('/api/entity')
metadata CHANGED
@@ -1,15 +1,15 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: fusionauth_client
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.31.0
4
+ version: 1.34.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Brian Pontarelli
8
8
  - Daniel DeGroff
9
- autorequire:
9
+ autorequire:
10
10
  bindir: exe
11
11
  cert_chain: []
12
- date: 2021-11-19 00:00:00.000000000 Z
12
+ date: 2022-02-22 00:00:00.000000000 Z
13
13
  dependencies: []
14
14
  description: This library contains the Ruby client library that helps you connect
15
15
  your application to FusionAuth.
@@ -37,7 +37,7 @@ licenses:
37
37
  - Apache-2.0
38
38
  metadata:
39
39
  allowed_push_host: https://rubygems.org
40
- post_install_message:
40
+ post_install_message:
41
41
  rdoc_options: []
42
42
  require_paths:
43
43
  - lib
@@ -52,8 +52,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
52
52
  - !ruby/object:Gem::Version
53
53
  version: '0'
54
54
  requirements: []
55
- rubygems_version: 3.1.4
56
- signing_key:
55
+ rubygems_version: 3.3.5
56
+ signing_key:
57
57
  specification_version: 4
58
58
  summary: The Ruby client library for FusionAuth
59
59
  test_files: []