auth0 6.2.0 → 6.4.0

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 (306) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +6 -5
  3. data/.fern/replay.lock +13 -1
  4. data/.version +1 -1
  5. data/CHANGELOG.md +13 -0
  6. data/EXAMPLES.md +44 -0
  7. data/examples/ruby-api/Gemfile.lock +1 -1
  8. data/lib/auth0/actions/client.rb +47 -6
  9. data/lib/auth0/actions/executions/client.rb +4 -1
  10. data/lib/auth0/actions/modules/client.rb +40 -6
  11. data/lib/auth0/actions/modules/versions/client.rb +19 -3
  12. data/lib/auth0/actions/triggers/bindings/client.rb +12 -2
  13. data/lib/auth0/actions/triggers/client.rb +4 -1
  14. data/lib/auth0/actions/versions/client.rb +27 -4
  15. data/lib/auth0/agents/client.rb +22 -4
  16. data/lib/auth0/anomaly/blocks/client.rb +6 -0
  17. data/lib/auth0/api/authentication_endpoints.rb +40 -0
  18. data/lib/auth0/attack_protection/bot_detection/client.rb +8 -2
  19. data/lib/auth0/attack_protection/breached_password_detection/client.rb +8 -2
  20. data/lib/auth0/attack_protection/brute_force_protection/client.rb +8 -2
  21. data/lib/auth0/attack_protection/captcha/client.rb +8 -2
  22. data/lib/auth0/attack_protection/phone_provider_protection/client.rb +8 -2
  23. data/lib/auth0/attack_protection/suspicious_ip_throttling/client.rb +8 -2
  24. data/lib/auth0/branding/client.rb +8 -2
  25. data/lib/auth0/branding/phone/providers/client.rb +31 -5
  26. data/lib/auth0/branding/phone/templates/client.rb +39 -7
  27. data/lib/auth0/branding/templates/client.rb +10 -1
  28. data/lib/auth0/branding/themes/client.rb +162 -4
  29. data/lib/auth0/client.rb +8 -8
  30. data/lib/auth0/client_grants/client.rb +28 -4
  31. data/lib/auth0/client_grants/organizations/client.rb +9 -1
  32. data/lib/auth0/clients/client.rb +46 -7
  33. data/lib/auth0/clients/connections/client.rb +11 -1
  34. data/lib/auth0/clients/credentials/client.rb +36 -7
  35. data/lib/auth0/clients/types/create_client_request_content.rb +4 -0
  36. data/lib/auth0/clients/types/update_client_request_content.rb +2 -0
  37. data/lib/auth0/connection_profiles/client.rb +30 -6
  38. data/lib/auth0/connections/client.rb +37 -4
  39. data/lib/auth0/connections/clients/client.rb +21 -2
  40. data/lib/auth0/connections/directory_provisioning/client.rb +73 -8
  41. data/lib/auth0/connections/directory_provisioning/synchronizations/client.rb +4 -1
  42. data/lib/auth0/connections/keys/client.rb +31 -8
  43. data/lib/auth0/connections/scim_configuration/client.rb +37 -6
  44. data/lib/auth0/connections/scim_configuration/tokens/client.rb +14 -2
  45. data/lib/auth0/connections/users/client.rb +6 -0
  46. data/lib/auth0/custom_domains/client.rb +43 -8
  47. data/lib/auth0/device_credentials/client.rb +25 -2
  48. data/lib/auth0/email_templates/client.rb +19 -4
  49. data/lib/auth0/emails/provider/client.rb +23 -3
  50. data/lib/auth0/event_streams/client.rb +38 -5
  51. data/lib/auth0/event_streams/deliveries/client.rb +19 -2
  52. data/lib/auth0/event_streams/redeliveries/client.rb +10 -1
  53. data/lib/auth0/events/client.rb +7 -0
  54. data/lib/auth0/experimentation/client.rb +29 -0
  55. data/lib/auth0/experimentation/experiments/client.rb +367 -0
  56. data/lib/auth0/experimentation/experiments/types/advance_ramp_request_content.rb +15 -0
  57. data/lib/auth0/experimentation/experiments/types/create_experiment_request_content.rb +27 -0
  58. data/lib/auth0/experimentation/experiments/types/list_experiments_request_parameters.rb +21 -0
  59. data/lib/auth0/experimentation/experiments/types/update_experiment_request_parameters.rb +25 -0
  60. data/lib/auth0/experimentation/experiments/types/update_experiment_status_request_content.rb +15 -0
  61. data/lib/auth0/experimentation/feature_flags/client.rb +280 -0
  62. data/lib/auth0/experimentation/feature_flags/types/create_feature_flag_request_content.rb +17 -0
  63. data/lib/auth0/experimentation/feature_flags/types/list_feature_flags_request_parameters.rb +19 -0
  64. data/lib/auth0/experimentation/feature_flags/types/update_feature_flag_request_content.rb +19 -0
  65. data/lib/auth0/experimentation/feature_flags/types/update_feature_flag_status_request_content.rb +15 -0
  66. data/lib/auth0/experimentation/feature_flags/variations/client.rb +230 -0
  67. data/lib/auth0/experimentation/feature_flags/variations/types/create_variation_request_content.rb +21 -0
  68. data/lib/auth0/experimentation/feature_flags/variations/types/update_variation_request_content.rb +23 -0
  69. data/lib/auth0/experimentation/segments/client.rb +228 -0
  70. data/lib/auth0/experimentation/segments/types/create_segment_request_content.rb +17 -0
  71. data/lib/auth0/experimentation/segments/types/list_segments_request_parameters.rb +17 -0
  72. data/lib/auth0/experimentation/segments/types/update_segment_request_content.rb +19 -0
  73. data/lib/auth0/flows/client.rb +28 -4
  74. data/lib/auth0/flows/executions/client.rb +23 -2
  75. data/lib/auth0/flows/vault/connections/client.rb +31 -4
  76. data/lib/auth0/forms/client.rb +27 -4
  77. data/lib/auth0/groups/client.rb +21 -2
  78. data/lib/auth0/groups/members/client.rb +10 -1
  79. data/lib/auth0/groups/roles/client.rb +20 -1
  80. data/lib/auth0/guardian/client.rb +77 -0
  81. data/lib/auth0/guardian/enrollments/client.rb +11 -2
  82. data/lib/auth0/guardian/factors/client.rb +21 -5
  83. data/lib/auth0/guardian/factors/duo/settings/client.rb +12 -3
  84. data/lib/auth0/guardian/factors/email/client.rb +93 -0
  85. data/lib/auth0/guardian/factors/email/types/set_email_factor_settings_request_content.rb +17 -0
  86. data/lib/auth0/guardian/factors/phone/client.rb +110 -8
  87. data/lib/auth0/guardian/factors/phone/types/set_phone_factor_settings_request_content.rb +17 -0
  88. data/lib/auth0/guardian/factors/push_notification/client.rb +48 -12
  89. data/lib/auth0/guardian/factors/sms/client.rb +32 -9
  90. data/lib/auth0/guardian/policies/client.rb +8 -2
  91. data/lib/auth0/guardian/types/set_guardian_settings_request_content.rb +17 -0
  92. data/lib/auth0/hooks/client.rb +33 -4
  93. data/lib/auth0/hooks/secrets/client.rb +38 -4
  94. data/lib/auth0/jobs/client.rb +4 -1
  95. data/lib/auth0/jobs/errors/client.rb +9 -4
  96. data/lib/auth0/jobs/users_exports/client.rb +4 -1
  97. data/lib/auth0/jobs/users_imports/client.rb +14 -6
  98. data/lib/auth0/jobs/verification_email/client.rb +4 -1
  99. data/lib/auth0/keys/custom_signing/client.rb +13 -2
  100. data/lib/auth0/keys/encryption/client.rb +33 -5
  101. data/lib/auth0/keys/network_acls/client.rb +19 -3
  102. data/lib/auth0/keys/signing/client.rb +21 -7
  103. data/lib/auth0/log_streams/client.rb +29 -7
  104. data/lib/auth0/logs/client.rb +16 -2
  105. data/lib/auth0/network_acls/client.rb +41 -4
  106. data/lib/auth0/organizations/client.rb +109 -10
  107. data/lib/auth0/organizations/client_grants/client.rb +25 -2
  108. data/lib/auth0/organizations/clients/client.rb +38 -4
  109. data/lib/auth0/organizations/connections/client.rb +37 -4
  110. data/lib/auth0/organizations/connections/types/create_organization_all_connection_request_parameters.rb +2 -0
  111. data/lib/auth0/organizations/connections/types/update_organization_connection_request_parameters.rb +2 -0
  112. data/lib/auth0/organizations/discovery_domains/client.rb +42 -5
  113. data/lib/auth0/organizations/enabled_connections/client.rb +36 -4
  114. data/lib/auth0/organizations/groups/client.rb +8 -1
  115. data/lib/auth0/organizations/groups/roles/client.rb +23 -1
  116. data/lib/auth0/organizations/invitations/client.rb +40 -3
  117. data/lib/auth0/organizations/members/client.rb +23 -1
  118. data/lib/auth0/organizations/members/effective_roles/client.rb +9 -1
  119. data/lib/auth0/organizations/members/effective_roles/sources/groups/client.rb +10 -1
  120. data/lib/auth0/organizations/members/roles/client.rb +24 -1
  121. data/lib/auth0/organizations/roles/groups/client.rb +9 -1
  122. data/lib/auth0/organizations/roles/members/client.rb +11 -1
  123. data/lib/auth0/organizations/types/search_organizations_request_parameters.rb +19 -0
  124. data/lib/auth0/prompts/client.rb +8 -2
  125. data/lib/auth0/prompts/custom_text/client.rb +20 -2
  126. data/lib/auth0/prompts/partials/client.rb +16 -2
  127. data/lib/auth0/prompts/rendering/client.rb +34 -4
  128. data/lib/auth0/rate_limit_policies/client.rb +37 -4
  129. data/lib/auth0/refresh_tokens/client.rb +25 -3
  130. data/lib/auth0/resource_servers/client.rb +102 -4
  131. data/lib/auth0/resource_servers/types/create_resource_server_request_content.rb +6 -0
  132. data/lib/auth0/resource_servers/types/search_resource_servers_request_parameters.rb +23 -0
  133. data/lib/auth0/resource_servers/types/update_resource_server_request_content.rb +6 -0
  134. data/lib/auth0/risk_assessments/settings/client.rb +8 -2
  135. data/lib/auth0/risk_assessments/settings/new_device/client.rb +8 -2
  136. data/lib/auth0/roles/client.rb +26 -4
  137. data/lib/auth0/roles/groups/client.rb +20 -1
  138. data/lib/auth0/roles/permissions/client.rb +27 -1
  139. data/lib/auth0/roles/users/client.rb +15 -1
  140. data/lib/auth0/rules/client.rb +33 -4
  141. data/lib/auth0/rules_configs/client.rb +19 -5
  142. data/lib/auth0/self_service_profiles/client.rb +23 -4
  143. data/lib/auth0/self_service_profiles/custom_text/client.rb +23 -3
  144. data/lib/auth0/self_service_profiles/sso_ticket/client.rb +10 -1
  145. data/lib/auth0/sessions/client.rb +14 -2
  146. data/lib/auth0/stats/client.rb +16 -5
  147. data/lib/auth0/supplemental_signals/client.rb +8 -2
  148. data/lib/auth0/tenants/settings/client.rb +11 -2
  149. data/lib/auth0/tenants/settings/types/update_tenant_settings_request_content.rb +2 -0
  150. data/lib/auth0/tickets/client.rb +8 -2
  151. data/lib/auth0/token_exchange_profiles/client.rb +26 -3
  152. data/lib/auth0/types/advance_ramp_response_content.rb +15 -0
  153. data/lib/auth0/types/allocation_item.rb +27 -0
  154. data/lib/auth0/types/allocation_request_item.rb +19 -0
  155. data/lib/auth0/types/{connection_deletion_behavior_enum.rb → allocation_strategy_enum.rb} +3 -3
  156. data/lib/auth0/types/anonymous_sessions.rb +10 -0
  157. data/lib/auth0/types/async_approval_notifications_channels_enum.rb +1 -0
  158. data/lib/auth0/types/authentication_flow_enum.rb +16 -0
  159. data/lib/auth0/types/client.rb +6 -0
  160. data/lib/auth0/types/client_my_organization_patch_configuration.rb +4 -0
  161. data/lib/auth0/types/client_my_organization_post_configuration.rb +4 -0
  162. data/lib/auth0/types/client_my_organization_response_configuration.rb +4 -0
  163. data/lib/auth0/types/client_oidc_backchannel_logout_initiators_enum.rb +1 -0
  164. data/lib/auth0/types/client_oidc_support_allowed_scopes_enum.rb +14 -0
  165. data/lib/auth0/types/client_oidc_support_post.rb +15 -0
  166. data/lib/auth0/types/connection_identity_provider_enum.rb +4 -13
  167. data/lib/auth0/types/connection_options_ad.rb +2 -0
  168. data/lib/auth0/types/connection_options_adfs.rb +2 -0
  169. data/lib/auth0/types/connection_options_azure_ad.rb +2 -0
  170. data/lib/auth0/types/connection_options_common_saml.rb +2 -0
  171. data/lib/auth0/types/connection_options_ping_federate.rb +2 -0
  172. data/lib/auth0/types/connection_options_saml.rb +2 -0
  173. data/lib/auth0/types/connection_properties_options.rb +4 -0
  174. data/lib/auth0/types/connection_strategy_enum.rb +4 -13
  175. data/lib/auth0/types/connection_thumbprints_sha384.rb +23 -0
  176. data/lib/auth0/types/connection_thumbprints_sha384ad.rb +23 -0
  177. data/lib/auth0/types/connection_thumbprints_sha384saml.rb +23 -0
  178. data/lib/auth0/types/create_anonymous_sessions.rb +10 -0
  179. data/lib/auth0/types/create_client_response_content.rb +6 -0
  180. data/lib/auth0/types/create_experiment_response_content.rb +45 -0
  181. data/lib/auth0/types/create_feature_flag_parameters.rb +23 -0
  182. data/lib/auth0/types/create_feature_flag_response_content.rb +23 -0
  183. data/lib/auth0/types/create_organization_all_connection_response_content.rb +2 -0
  184. data/lib/auth0/types/create_resource_server_response_content.rb +6 -0
  185. data/lib/auth0/types/create_segment_response_content.rb +21 -0
  186. data/lib/auth0/types/create_variation_response_content.rb +21 -0
  187. data/lib/auth0/types/{organization_deletion_behavior_enum.rb → default_config_enum.rb} +3 -3
  188. data/lib/auth0/types/experiment_list_item.rb +45 -0
  189. data/lib/auth0/types/experiment_status_enum.rb +15 -0
  190. data/lib/auth0/types/experiment_transition_status_enum.rb +14 -0
  191. data/lib/auth0/types/experiment_validation_error.rb +11 -0
  192. data/lib/auth0/types/feature_flag.rb +23 -0
  193. data/lib/auth0/types/feature_flag_config_param.rb +13 -0
  194. data/lib/auth0/types/feature_flag_config_param_type_enum.rb +15 -0
  195. data/lib/auth0/types/feature_flag_config_params.rb +23 -0
  196. data/lib/auth0/types/feature_flag_status_enum.rb +13 -0
  197. data/lib/auth0/types/feature_flag_type_enum.rb +12 -0
  198. data/lib/auth0/types/get_client_response_content.rb +6 -0
  199. data/lib/auth0/types/get_email_factor_settings_response_content.rb +11 -0
  200. data/lib/auth0/types/get_experiment_response_content.rb +45 -0
  201. data/lib/auth0/types/get_feature_flag_response_content.rb +23 -0
  202. data/lib/auth0/types/get_guardian_settings_response_content.rb +15 -0
  203. data/lib/auth0/types/get_organization_all_connection_response_content.rb +2 -0
  204. data/lib/auth0/types/get_phone_factor_settings_response_content.rb +11 -0
  205. data/lib/auth0/types/get_resource_server_response_content.rb +6 -0
  206. data/lib/auth0/types/get_segment_response_content.rb +21 -0
  207. data/lib/auth0/types/get_tenant_settings_response_content.rb +2 -0
  208. data/lib/auth0/types/get_variation_response_content.rb +21 -0
  209. data/lib/auth0/types/list_experiments_response_content.rb +11 -0
  210. data/lib/auth0/types/list_feature_flags_response_content.rb +11 -0
  211. data/lib/auth0/types/list_segments_response_content.rb +11 -0
  212. data/lib/auth0/types/list_variations_response_content.rb +9 -0
  213. data/lib/auth0/types/oauth_scope.rb +4 -3
  214. data/lib/auth0/types/organization_all_connection_post.rb +2 -0
  215. data/lib/auth0/types/organization_member_access_level_enum.rb +14 -0
  216. data/lib/auth0/types/organization_member_access_level_enum_with_null.rb +14 -0
  217. data/lib/auth0/types/organization_sort_field_enum.rb +13 -0
  218. data/lib/auth0/types/resource_server.rb +6 -0
  219. data/lib/auth0/types/resource_server_access_token.rb +10 -0
  220. data/lib/auth0/types/resource_server_access_token_claims_mapping.rb +10 -0
  221. data/lib/auth0/types/resource_server_access_token_custom_claims_mapping.rb +23 -0
  222. data/lib/auth0/types/resource_server_access_token_custom_claims_mapping_rule.rb +11 -0
  223. data/lib/auth0/types/resource_server_search_response.rb +55 -0
  224. data/lib/auth0/types/resource_server_sort_field_enum.rb +13 -0
  225. data/lib/auth0/types/resource_server_subject_type_authorization.rb +2 -0
  226. data/lib/auth0/types/resource_server_subject_type_authorization_anonymous_user.rb +10 -0
  227. data/lib/auth0/types/resource_server_subject_type_authorization_anonymous_user_policy_enum.rb +12 -0
  228. data/lib/auth0/types/rotate_client_secret_response_content.rb +6 -0
  229. data/lib/auth0/types/search_organization.rb +23 -0
  230. data/lib/auth0/types/{list_template_organizations_paginated_response_content.rb → search_organizations_paginated_response_content.rb} +3 -3
  231. data/lib/auth0/types/search_parser_enum.rb +12 -0
  232. data/lib/auth0/types/search_resource_servers_response_content.rb +11 -0
  233. data/lib/auth0/types/segment.rb +21 -0
  234. data/lib/auth0/types/segment_contains_expression.rb +9 -0
  235. data/lib/auth0/types/segment_ends_with_expression.rb +9 -0
  236. data/lib/auth0/types/segment_exists_expression.rb +9 -0
  237. data/lib/auth0/types/segment_match_conditions.rb +30 -0
  238. data/lib/auth0/types/segment_match_expression.rb +19 -0
  239. data/lib/auth0/types/segment_not_match_conditions.rb +30 -0
  240. data/lib/auth0/types/segment_rule.rb +11 -0
  241. data/lib/auth0/types/segment_starts_with_expression.rb +9 -0
  242. data/lib/auth0/types/segment_type_enum.rb +12 -0
  243. data/lib/auth0/types/segment_type_filter_enum.rb +12 -0
  244. data/lib/auth0/types/set_email_factor_settings_response_content.rb +11 -0
  245. data/lib/auth0/types/set_guardian_settings_response_content.rb +15 -0
  246. data/lib/auth0/types/set_phone_factor_settings_response_content.rb +11 -0
  247. data/lib/auth0/types/tenant_settings_sessions.rb +2 -0
  248. data/lib/auth0/types/tenant_settings_sessions_anonymous.rb +12 -0
  249. data/lib/auth0/types/update_anonymous_sessions.rb +10 -0
  250. data/lib/auth0/types/update_client_response_content.rb +6 -0
  251. data/lib/auth0/types/update_connection_options.rb +4 -0
  252. data/lib/auth0/types/update_experiment_response_content.rb +45 -0
  253. data/lib/auth0/types/update_experiment_status_response_content.rb +45 -0
  254. data/lib/auth0/types/update_feature_flag_parameters.rb +23 -0
  255. data/lib/auth0/types/update_feature_flag_response_content.rb +23 -0
  256. data/lib/auth0/types/update_feature_flag_status_response_content.rb +23 -0
  257. data/lib/auth0/types/update_organization_all_connection_response_content.rb +2 -0
  258. data/lib/auth0/types/update_resource_server_response_content.rb +6 -0
  259. data/lib/auth0/types/update_segment_response_content.rb +21 -0
  260. data/lib/auth0/types/update_tenant_settings_response_content.rb +2 -0
  261. data/lib/auth0/types/update_variation_overrides_map.rb +23 -0
  262. data/lib/auth0/types/update_variation_response_content.rb +21 -0
  263. data/lib/auth0/types/validate_experiment_response_content.rb +11 -0
  264. data/lib/auth0/types/variation.rb +21 -0
  265. data/lib/auth0/types/variation_overrides_map.rb +23 -0
  266. data/lib/auth0/user_attribute_profiles/client.rb +40 -6
  267. data/lib/auth0/user_blocks/client.rb +20 -2
  268. data/lib/auth0/user_grants/client.rb +17 -1
  269. data/lib/auth0/users/authentication_methods/client.rb +57 -9
  270. data/lib/auth0/users/authenticators/client.rb +3 -0
  271. data/lib/auth0/users/client.rb +75 -23
  272. data/lib/auth0/users/connected_accounts/client.rb +8 -1
  273. data/lib/auth0/users/effective_permissions/client.rb +9 -1
  274. data/lib/auth0/users/effective_permissions/sources/roles/client.rb +10 -1
  275. data/lib/auth0/users/effective_roles/client.rb +8 -1
  276. data/lib/auth0/users/effective_roles/sources/groups/client.rb +9 -1
  277. data/lib/auth0/users/enrollments/client.rb +9 -4
  278. data/lib/auth0/users/groups/client.rb +11 -1
  279. data/lib/auth0/users/identities/client.rb +17 -5
  280. data/lib/auth0/users/logs/client.rb +10 -1
  281. data/lib/auth0/users/multifactor/client.rb +9 -0
  282. data/lib/auth0/users/organizations/client.rb +9 -1
  283. data/lib/auth0/users/permissions/client.rb +27 -1
  284. data/lib/auth0/users/refresh_token/client.rb +12 -1
  285. data/lib/auth0/users/risk_assessments/client.rb +7 -0
  286. data/lib/auth0/users/roles/client.rb +21 -1
  287. data/lib/auth0/users/sessions/client.rb +12 -1
  288. data/lib/auth0/verifiable_credentials/verification/templates/client.rb +32 -4
  289. data/lib/auth0/version.rb +1 -1
  290. data/lib/auth0.rb +107 -18
  291. data/wiremock/wiremock-mappings.json +1246 -366
  292. metadata +108 -19
  293. data/lib/auth0/organization_templates/client.rb +0 -220
  294. data/lib/auth0/organization_templates/types/create_organization_template_request_content.rb +0 -35
  295. data/lib/auth0/organization_templates/types/list_organization_templates_request_parameters.rb +0 -13
  296. data/lib/auth0/organization_templates/types/list_template_organizations_request_parameters.rb +0 -15
  297. data/lib/auth0/organization_templates/types/update_organization_template_request_content.rb +0 -37
  298. data/lib/auth0/organizations/organization_template/client.rb +0 -117
  299. data/lib/auth0/types/list_organization_templates_paginated_response_content.rb +0 -11
  300. data/lib/auth0/types/organization_template.rb +0 -39
  301. data/lib/auth0/types/organization_template_allowed_strategy_enum.rb +0 -17
  302. data/lib/auth0/types/organization_template_assigned_organization.rb +0 -10
  303. data/lib/auth0/types/organization_template_role_visibility_enum.rb +0 -13
  304. data/lib/auth0/types/organization_template_role_visibility_override.rb +0 -12
  305. data/lib/auth0/types/organization_template_role_visibility_policy.rb +0 -12
  306. data/lib/auth0/types/organization_template_use_for_organization_discovery.rb +0 -12
@@ -26,6 +26,15 @@ module Auth0
26
26
  # @option params [String, nil] :from
27
27
  # @option params [Integer, nil] :take
28
28
  #
29
+ # @example
30
+ # client.groups.members.get(
31
+ # id: "id",
32
+ # fields: "fields",
33
+ # include_fields: true,
34
+ # from: "from",
35
+ # take: 1
36
+ # )
37
+ #
29
38
  # @return [Auth0::Types::GetGroupMembersResponseContent]
30
39
  def get(request_options: {}, **params)
31
40
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -55,7 +64,7 @@ module Auth0
55
64
  end
56
65
  code = response.code.to_i
57
66
  if code.between?(200, 299)
58
- parsed_response = Auth0::Types::GetGroupMembersResponseContent.load(response.body)
67
+ parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::GetGroupMembersResponseContent.load(response.body))
59
68
  [parsed_response, response]
60
69
  else
61
70
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -24,6 +24,13 @@ module Auth0
24
24
  # @option params [String, nil] :from
25
25
  # @option params [Integer, nil] :take
26
26
  #
27
+ # @example
28
+ # client.groups.roles.list(
29
+ # id: "id",
30
+ # from: "from",
31
+ # take: 1
32
+ # )
33
+ #
27
34
  # @return [Auth0::Types::ListGroupRolesResponseContent]
28
35
  def list(request_options: {}, **params)
29
36
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -51,7 +58,7 @@ module Auth0
51
58
  end
52
59
  code = response.code.to_i
53
60
  if code.between?(200, 299)
54
- parsed_response = Auth0::Types::ListGroupRolesResponseContent.load(response.body)
61
+ parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListGroupRolesResponseContent.load(response.body))
55
62
  [parsed_response, response]
56
63
  else
57
64
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -71,6 +78,12 @@ module Auth0
71
78
  # @option request_options [Integer] :timeout_in_seconds
72
79
  # @option params [String] :id
73
80
  #
81
+ # @example
82
+ # client.groups.roles.create(
83
+ # id: "id",
84
+ # roles: ["roles"]
85
+ # )
86
+ #
74
87
  # @return [untyped]
75
88
  def create(request_options: {}, **params)
76
89
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -108,6 +121,12 @@ module Auth0
108
121
  # @option request_options [Integer] :timeout_in_seconds
109
122
  # @option params [String] :id
110
123
  #
124
+ # @example
125
+ # client.groups.roles.delete(
126
+ # id: "id",
127
+ # roles: ["roles"]
128
+ # )
129
+ #
111
130
  # @return [untyped]
112
131
  def delete(request_options: {}, **params)
113
132
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -10,6 +10,83 @@ module Auth0
10
10
  @client = client
11
11
  end
12
12
 
13
+ # TODO: Link this endpoint to relevant documentation when available.
14
+ #
15
+ # @param request_options [Hash]
16
+ # @param _params [Hash]
17
+ # @option request_options [String] :base_url
18
+ # @option request_options [Hash{String => Object}] :additional_headers
19
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
20
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
21
+ # @option request_options [Integer] :timeout_in_seconds
22
+ #
23
+ # @example
24
+ # client.guardian.get
25
+ #
26
+ # @return [Auth0::Types::GetGuardianSettingsResponseContent]
27
+ def get(request_options: {}, **_params)
28
+ request = Auth0::Internal::JSON::Request.new(
29
+ base_url: request_options[:base_url],
30
+ method: "GET",
31
+ path: "guardian/settings",
32
+ request_options: request_options
33
+ )
34
+ begin
35
+ response = @client.send(request)
36
+ rescue Net::HTTPRequestTimeout
37
+ raise Auth0::Errors::TimeoutError
38
+ end
39
+ code = response.code.to_i
40
+ if code.between?(200, 299)
41
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetGuardianSettingsResponseContent.load(response.body))
42
+ else
43
+ error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
44
+ raise error_class.new(response.body, code: code)
45
+ end
46
+ end
47
+
48
+ # Update a tenant's guardian settings such as Remember Me
49
+ #
50
+ # @param request_options [Hash]
51
+ # @param params [Auth0::Guardian::Types::SetGuardianSettingsRequestContent]
52
+ # @option request_options [String] :base_url
53
+ # @option request_options [Hash{String => Object}] :additional_headers
54
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
55
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
56
+ # @option request_options [Integer] :timeout_in_seconds
57
+ #
58
+ # @example
59
+ # client.guardian.set(
60
+ # display_remember_me_checkbox: true,
61
+ # remember_me_default_value: true,
62
+ # mfa_session_inactivity_timeout: 1,
63
+ # mfa_session_overall_timeout: 1
64
+ # )
65
+ #
66
+ # @return [Auth0::Types::SetGuardianSettingsResponseContent]
67
+ def set(request_options: {}, **params)
68
+ params = Auth0::Internal::Types::Utils.normalize_keys(params)
69
+ request = Auth0::Internal::JSON::Request.new(
70
+ base_url: request_options[:base_url],
71
+ method: "PUT",
72
+ path: "guardian/settings",
73
+ body: Auth0::Guardian::Types::SetGuardianSettingsRequestContent.new(params).to_h,
74
+ request_options: request_options
75
+ )
76
+ begin
77
+ response = @client.send(request)
78
+ rescue Net::HTTPRequestTimeout
79
+ raise Auth0::Errors::TimeoutError
80
+ end
81
+ code = response.code.to_i
82
+ if code.between?(200, 299)
83
+ (response.body.to_s.empty? ? nil : Auth0::Types::SetGuardianSettingsResponseContent.load(response.body))
84
+ else
85
+ error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
86
+ raise error_class.new(response.body, code: code)
87
+ end
88
+ end
89
+
13
90
  # @return [Auth0::Enrollments::Client]
14
91
  def enrollments
15
92
  @enrollments ||= Auth0::Guardian::Enrollments::Client.new(client: @client)
@@ -24,6 +24,9 @@ module Auth0
24
24
  # @option request_options [Hash{String => Object}] :additional_body_parameters
25
25
  # @option request_options [Integer] :timeout_in_seconds
26
26
  #
27
+ # @example
28
+ # client.guardian.enrollments.create_ticket(user_id: "user_id")
29
+ #
27
30
  # @return [Auth0::Types::CreateGuardianEnrollmentTicketResponseContent]
28
31
  def create_ticket(request_options: {}, **params)
29
32
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -41,7 +44,7 @@ module Auth0
41
44
  end
42
45
  code = response.code.to_i
43
46
  if code.between?(200, 299)
44
- Auth0::Types::CreateGuardianEnrollmentTicketResponseContent.load(response.body)
47
+ (response.body.to_s.empty? ? nil : Auth0::Types::CreateGuardianEnrollmentTicketResponseContent.load(response.body))
45
48
  else
46
49
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
47
50
  raise error_class.new(response.body, code: code)
@@ -60,6 +63,9 @@ module Auth0
60
63
  # @option request_options [Integer] :timeout_in_seconds
61
64
  # @option params [String] :id
62
65
  #
66
+ # @example
67
+ # client.guardian.enrollments.get(id: "id")
68
+ #
63
69
  # @return [Auth0::Types::GetGuardianEnrollmentResponseContent]
64
70
  def get(request_options: {}, **params)
65
71
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -76,7 +82,7 @@ module Auth0
76
82
  end
77
83
  code = response.code.to_i
78
84
  if code.between?(200, 299)
79
- Auth0::Types::GetGuardianEnrollmentResponseContent.load(response.body)
85
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetGuardianEnrollmentResponseContent.load(response.body))
80
86
  else
81
87
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
82
88
  raise error_class.new(response.body, code: code)
@@ -96,6 +102,9 @@ module Auth0
96
102
  # @option request_options [Integer] :timeout_in_seconds
97
103
  # @option params [String] :id
98
104
  #
105
+ # @example
106
+ # client.guardian.enrollments.delete(id: "id")
107
+ #
99
108
  # @return [untyped]
100
109
  def delete(request_options: {}, **params)
101
110
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -23,6 +23,9 @@ module Auth0
23
23
  # @option request_options [Hash{String => Object}] :additional_body_parameters
24
24
  # @option request_options [Integer] :timeout_in_seconds
25
25
  #
26
+ # @example
27
+ # client.guardian.factors.list
28
+ #
26
29
  # @return [Array[Auth0::Types::GuardianFactor]]
27
30
  def list(request_options: {}, **_params)
28
31
  request = Auth0::Internal::JSON::Request.new(
@@ -37,10 +40,12 @@ module Auth0
37
40
  raise Auth0::Errors::TimeoutError
38
41
  end
39
42
  code = response.code.to_i
40
- return if code.between?(200, 299)
41
-
42
- error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
43
- raise error_class.new(response.body, code: code)
43
+ if code.between?(200, 299)
44
+ Auth0::Internal::Types::Utils.coerce(Internal::Types::Array[Auth0::Types::GuardianFactor], (response.body.to_s.empty? ? nil : JSON.parse(response.body, symbolize_names: true)))
45
+ else
46
+ error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
47
+ raise error_class.new(response.body, code: code)
48
+ end
44
49
  end
45
50
 
46
51
  # Update the status (i.e., enabled or disabled) of a specific multi-factor authentication factor.
@@ -54,6 +59,12 @@ module Auth0
54
59
  # @option request_options [Integer] :timeout_in_seconds
55
60
  # @option params [Auth0::Types::GuardianFactorNameEnum] :name
56
61
  #
62
+ # @example
63
+ # client.guardian.factors.set(
64
+ # name: "push-notification",
65
+ # enabled: true
66
+ # )
67
+ #
57
68
  # @return [Auth0::Types::SetGuardianFactorResponseContent]
58
69
  def set(request_options: {}, **params)
59
70
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -75,13 +86,18 @@ module Auth0
75
86
  end
76
87
  code = response.code.to_i
77
88
  if code.between?(200, 299)
78
- Auth0::Types::SetGuardianFactorResponseContent.load(response.body)
89
+ (response.body.to_s.empty? ? nil : Auth0::Types::SetGuardianFactorResponseContent.load(response.body))
79
90
  else
80
91
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
81
92
  raise error_class.new(response.body, code: code)
82
93
  end
83
94
  end
84
95
 
96
+ # @return [Auth0::Email::Client]
97
+ def email
98
+ @email ||= Auth0::Guardian::Factors::Email::Client.new(client: @client)
99
+ end
100
+
85
101
  # @return [Auth0::Phone::Client]
86
102
  def phone
87
103
  @phone ||= Auth0::Guardian::Factors::Phone::Client.new(client: @client)
@@ -23,6 +23,9 @@ module Auth0
23
23
  # @option request_options [Hash{String => Object}] :additional_body_parameters
24
24
  # @option request_options [Integer] :timeout_in_seconds
25
25
  #
26
+ # @example
27
+ # client.guardian.factors.duo.settings.get
28
+ #
26
29
  # @return [Auth0::Types::GetGuardianFactorDuoSettingsResponseContent]
27
30
  def get(request_options: {}, **_params)
28
31
  request = Auth0::Internal::JSON::Request.new(
@@ -38,7 +41,7 @@ module Auth0
38
41
  end
39
42
  code = response.code.to_i
40
43
  if code.between?(200, 299)
41
- Auth0::Types::GetGuardianFactorDuoSettingsResponseContent.load(response.body)
44
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetGuardianFactorDuoSettingsResponseContent.load(response.body))
42
45
  else
43
46
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
44
47
  raise error_class.new(response.body, code: code)
@@ -55,6 +58,9 @@ module Auth0
55
58
  # @option request_options [Hash{String => Object}] :additional_body_parameters
56
59
  # @option request_options [Integer] :timeout_in_seconds
57
60
  #
61
+ # @example
62
+ # client.guardian.factors.duo.settings.set
63
+ #
58
64
  # @return [Auth0::Types::SetGuardianFactorDuoSettingsResponseContent]
59
65
  def set(request_options: {}, **params)
60
66
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -72,7 +78,7 @@ module Auth0
72
78
  end
73
79
  code = response.code.to_i
74
80
  if code.between?(200, 299)
75
- Auth0::Types::SetGuardianFactorDuoSettingsResponseContent.load(response.body)
81
+ (response.body.to_s.empty? ? nil : Auth0::Types::SetGuardianFactorDuoSettingsResponseContent.load(response.body))
76
82
  else
77
83
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
78
84
  raise error_class.new(response.body, code: code)
@@ -87,6 +93,9 @@ module Auth0
87
93
  # @option request_options [Hash{String => Object}] :additional_body_parameters
88
94
  # @option request_options [Integer] :timeout_in_seconds
89
95
  #
96
+ # @example
97
+ # client.guardian.factors.duo.settings.update
98
+ #
90
99
  # @return [Auth0::Types::UpdateGuardianFactorDuoSettingsResponseContent]
91
100
  def update(request_options: {}, **params)
92
101
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -104,7 +113,7 @@ module Auth0
104
113
  end
105
114
  code = response.code.to_i
106
115
  if code.between?(200, 299)
107
- Auth0::Types::UpdateGuardianFactorDuoSettingsResponseContent.load(response.body)
116
+ (response.body.to_s.empty? ? nil : Auth0::Types::UpdateGuardianFactorDuoSettingsResponseContent.load(response.body))
108
117
  else
109
118
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
110
119
  raise error_class.new(response.body, code: code)
@@ -0,0 +1,93 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Auth0
4
+ module Guardian
5
+ module Factors
6
+ module Email
7
+ class Client
8
+ # @param client [Auth0::Internal::Http::RawClient]
9
+ #
10
+ # @return [void]
11
+ def initialize(client:)
12
+ @client = client
13
+ end
14
+
15
+ # TODO: Link this endpoint to relevant documentation when available.
16
+ #
17
+ # @param request_options [Hash]
18
+ # @param _params [Hash]
19
+ # @option request_options [String] :base_url
20
+ # @option request_options [Hash{String => Object}] :additional_headers
21
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
22
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
23
+ # @option request_options [Integer] :timeout_in_seconds
24
+ #
25
+ # @example
26
+ # client.guardian.factors.email.get
27
+ #
28
+ # @return [Auth0::Types::GetEmailFactorSettingsResponseContent]
29
+ def get(request_options: {}, **_params)
30
+ request = Auth0::Internal::JSON::Request.new(
31
+ base_url: request_options[:base_url],
32
+ method: "GET",
33
+ path: "guardian/factors/email/settings",
34
+ request_options: request_options
35
+ )
36
+ begin
37
+ response = @client.send(request)
38
+ rescue Net::HTTPRequestTimeout
39
+ raise Auth0::Errors::TimeoutError
40
+ end
41
+ code = response.code.to_i
42
+ if code.between?(200, 299)
43
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetEmailFactorSettingsResponseContent.load(response.body))
44
+ else
45
+ error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
46
+ raise error_class.new(response.body, code: code)
47
+ end
48
+ end
49
+
50
+ # TODO: Link this endpoint to relevant documentation when available.
51
+ #
52
+ # @param request_options [Hash]
53
+ # @param params [Auth0::Guardian::Factors::Email::Types::SetEmailFactorSettingsRequestContent]
54
+ # @option request_options [String] :base_url
55
+ # @option request_options [Hash{String => Object}] :additional_headers
56
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
57
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
58
+ # @option request_options [Integer] :timeout_in_seconds
59
+ #
60
+ # @example
61
+ # client.guardian.factors.email.set(
62
+ # otp_length: 1,
63
+ # otp_expiration_time: 1
64
+ # )
65
+ #
66
+ # @return [Auth0::Types::SetEmailFactorSettingsResponseContent]
67
+ def set(request_options: {}, **params)
68
+ params = Auth0::Internal::Types::Utils.normalize_keys(params)
69
+ request = Auth0::Internal::JSON::Request.new(
70
+ base_url: request_options[:base_url],
71
+ method: "PUT",
72
+ path: "guardian/factors/email/settings",
73
+ body: Auth0::Guardian::Factors::Email::Types::SetEmailFactorSettingsRequestContent.new(params).to_h,
74
+ request_options: request_options
75
+ )
76
+ begin
77
+ response = @client.send(request)
78
+ rescue Net::HTTPRequestTimeout
79
+ raise Auth0::Errors::TimeoutError
80
+ end
81
+ code = response.code.to_i
82
+ if code.between?(200, 299)
83
+ (response.body.to_s.empty? ? nil : Auth0::Types::SetEmailFactorSettingsResponseContent.load(response.body))
84
+ else
85
+ error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
86
+ raise error_class.new(response.body, code: code)
87
+ end
88
+ end
89
+ end
90
+ end
91
+ end
92
+ end
93
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Auth0
4
+ module Guardian
5
+ module Factors
6
+ module Email
7
+ module Types
8
+ class SetEmailFactorSettingsRequestContent < Internal::Types::Model
9
+ field :otp_length, -> { Integer }, optional: false, nullable: false
10
+
11
+ field :otp_expiration_time, -> { Integer }, optional: false, nullable: false
12
+ end
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end
@@ -24,6 +24,9 @@ module Auth0
24
24
  # @option request_options [Hash{String => Object}] :additional_body_parameters
25
25
  # @option request_options [Integer] :timeout_in_seconds
26
26
  #
27
+ # @example
28
+ # client.guardian.factors.phone.get_message_types
29
+ #
27
30
  # @return [Auth0::Types::GetGuardianFactorPhoneMessageTypesResponseContent]
28
31
  def get_message_types(request_options: {}, **_params)
29
32
  request = Auth0::Internal::JSON::Request.new(
@@ -39,7 +42,7 @@ module Auth0
39
42
  end
40
43
  code = response.code.to_i
41
44
  if code.between?(200, 299)
42
- Auth0::Types::GetGuardianFactorPhoneMessageTypesResponseContent.load(response.body)
45
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetGuardianFactorPhoneMessageTypesResponseContent.load(response.body))
43
46
  else
44
47
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
45
48
  raise error_class.new(response.body, code: code)
@@ -58,6 +61,9 @@ module Auth0
58
61
  # @option request_options [Hash{String => Object}] :additional_body_parameters
59
62
  # @option request_options [Integer] :timeout_in_seconds
60
63
  #
64
+ # @example
65
+ # client.guardian.factors.phone.set_message_types(message_types: ["sms"])
66
+ #
61
67
  # @return [Auth0::Types::SetGuardianFactorPhoneMessageTypesResponseContent]
62
68
  def set_message_types(request_options: {}, **params)
63
69
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -75,7 +81,7 @@ module Auth0
75
81
  end
76
82
  code = response.code.to_i
77
83
  if code.between?(200, 299)
78
- Auth0::Types::SetGuardianFactorPhoneMessageTypesResponseContent.load(response.body)
84
+ (response.body.to_s.empty? ? nil : Auth0::Types::SetGuardianFactorPhoneMessageTypesResponseContent.load(response.body))
79
85
  else
80
86
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
81
87
  raise error_class.new(response.body, code: code)
@@ -95,6 +101,9 @@ module Auth0
95
101
  # @option request_options [Hash{String => Object}] :additional_body_parameters
96
102
  # @option request_options [Integer] :timeout_in_seconds
97
103
  #
104
+ # @example
105
+ # client.guardian.factors.phone.get_twilio_provider
106
+ #
98
107
  # @return [Auth0::Types::GetGuardianFactorsProviderPhoneTwilioResponseContent]
99
108
  def get_twilio_provider(request_options: {}, **_params)
100
109
  request = Auth0::Internal::JSON::Request.new(
@@ -110,7 +119,7 @@ module Auth0
110
119
  end
111
120
  code = response.code.to_i
112
121
  if code.between?(200, 299)
113
- Auth0::Types::GetGuardianFactorsProviderPhoneTwilioResponseContent.load(response.body)
122
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetGuardianFactorsProviderPhoneTwilioResponseContent.load(response.body))
114
123
  else
115
124
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
116
125
  raise error_class.new(response.body, code: code)
@@ -130,6 +139,9 @@ module Auth0
130
139
  # @option request_options [Hash{String => Object}] :additional_body_parameters
131
140
  # @option request_options [Integer] :timeout_in_seconds
132
141
  #
142
+ # @example
143
+ # client.guardian.factors.phone.set_twilio_provider
144
+ #
133
145
  # @return [Auth0::Types::SetGuardianFactorsProviderPhoneTwilioResponseContent]
134
146
  def set_twilio_provider(request_options: {}, **params)
135
147
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -147,7 +159,7 @@ module Auth0
147
159
  end
148
160
  code = response.code.to_i
149
161
  if code.between?(200, 299)
150
- Auth0::Types::SetGuardianFactorsProviderPhoneTwilioResponseContent.load(response.body)
162
+ (response.body.to_s.empty? ? nil : Auth0::Types::SetGuardianFactorsProviderPhoneTwilioResponseContent.load(response.body))
151
163
  else
152
164
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
153
165
  raise error_class.new(response.body, code: code)
@@ -164,6 +176,9 @@ module Auth0
164
176
  # @option request_options [Hash{String => Object}] :additional_body_parameters
165
177
  # @option request_options [Integer] :timeout_in_seconds
166
178
  #
179
+ # @example
180
+ # client.guardian.factors.phone.get_selected_provider
181
+ #
167
182
  # @return [Auth0::Types::GetGuardianFactorsProviderPhoneResponseContent]
168
183
  def get_selected_provider(request_options: {}, **_params)
169
184
  request = Auth0::Internal::JSON::Request.new(
@@ -179,7 +194,7 @@ module Auth0
179
194
  end
180
195
  code = response.code.to_i
181
196
  if code.between?(200, 299)
182
- Auth0::Types::GetGuardianFactorsProviderPhoneResponseContent.load(response.body)
197
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetGuardianFactorsProviderPhoneResponseContent.load(response.body))
183
198
  else
184
199
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
185
200
  raise error_class.new(response.body, code: code)
@@ -194,6 +209,9 @@ module Auth0
194
209
  # @option request_options [Hash{String => Object}] :additional_body_parameters
195
210
  # @option request_options [Integer] :timeout_in_seconds
196
211
  #
212
+ # @example
213
+ # client.guardian.factors.phone.set_provider(provider: "auth0")
214
+ #
197
215
  # @return [Auth0::Types::SetGuardianFactorsProviderPhoneResponseContent]
198
216
  def set_provider(request_options: {}, **params)
199
217
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -211,7 +229,82 @@ module Auth0
211
229
  end
212
230
  code = response.code.to_i
213
231
  if code.between?(200, 299)
214
- Auth0::Types::SetGuardianFactorsProviderPhoneResponseContent.load(response.body)
232
+ (response.body.to_s.empty? ? nil : Auth0::Types::SetGuardianFactorsProviderPhoneResponseContent.load(response.body))
233
+ else
234
+ error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
235
+ raise error_class.new(response.body, code: code)
236
+ end
237
+ end
238
+
239
+ # TODO: Link this endpoint to relevant documentation when available.
240
+ #
241
+ # @param request_options [Hash]
242
+ # @param _params [Hash]
243
+ # @option request_options [String] :base_url
244
+ # @option request_options [Hash{String => Object}] :additional_headers
245
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
246
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
247
+ # @option request_options [Integer] :timeout_in_seconds
248
+ #
249
+ # @example
250
+ # client.guardian.factors.phone.get
251
+ #
252
+ # @return [Auth0::Types::GetPhoneFactorSettingsResponseContent]
253
+ def get(request_options: {}, **_params)
254
+ request = Auth0::Internal::JSON::Request.new(
255
+ base_url: request_options[:base_url],
256
+ method: "GET",
257
+ path: "guardian/factors/phone/settings",
258
+ request_options: request_options
259
+ )
260
+ begin
261
+ response = @client.send(request)
262
+ rescue Net::HTTPRequestTimeout
263
+ raise Auth0::Errors::TimeoutError
264
+ end
265
+ code = response.code.to_i
266
+ if code.between?(200, 299)
267
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetPhoneFactorSettingsResponseContent.load(response.body))
268
+ else
269
+ error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
270
+ raise error_class.new(response.body, code: code)
271
+ end
272
+ end
273
+
274
+ # TODO: Link this endpoint to relevant documentation when available.
275
+ #
276
+ # @param request_options [Hash]
277
+ # @param params [Auth0::Guardian::Factors::Phone::Types::SetPhoneFactorSettingsRequestContent]
278
+ # @option request_options [String] :base_url
279
+ # @option request_options [Hash{String => Object}] :additional_headers
280
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
281
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
282
+ # @option request_options [Integer] :timeout_in_seconds
283
+ #
284
+ # @example
285
+ # client.guardian.factors.phone.set(
286
+ # otp_length: 1,
287
+ # otp_expiration_time: 1
288
+ # )
289
+ #
290
+ # @return [Auth0::Types::SetPhoneFactorSettingsResponseContent]
291
+ def set(request_options: {}, **params)
292
+ params = Auth0::Internal::Types::Utils.normalize_keys(params)
293
+ request = Auth0::Internal::JSON::Request.new(
294
+ base_url: request_options[:base_url],
295
+ method: "PUT",
296
+ path: "guardian/factors/phone/settings",
297
+ body: Auth0::Guardian::Factors::Phone::Types::SetPhoneFactorSettingsRequestContent.new(params).to_h,
298
+ request_options: request_options
299
+ )
300
+ begin
301
+ response = @client.send(request)
302
+ rescue Net::HTTPRequestTimeout
303
+ raise Auth0::Errors::TimeoutError
304
+ end
305
+ code = response.code.to_i
306
+ if code.between?(200, 299)
307
+ (response.body.to_s.empty? ? nil : Auth0::Types::SetPhoneFactorSettingsResponseContent.load(response.body))
215
308
  else
216
309
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
217
310
  raise error_class.new(response.body, code: code)
@@ -229,6 +322,9 @@ module Auth0
229
322
  # @option request_options [Hash{String => Object}] :additional_body_parameters
230
323
  # @option request_options [Integer] :timeout_in_seconds
231
324
  #
325
+ # @example
326
+ # client.guardian.factors.phone.get_templates
327
+ #
232
328
  # @return [Auth0::Types::GetGuardianFactorPhoneTemplatesResponseContent]
233
329
  def get_templates(request_options: {}, **_params)
234
330
  request = Auth0::Internal::JSON::Request.new(
@@ -244,7 +340,7 @@ module Auth0
244
340
  end
245
341
  code = response.code.to_i
246
342
  if code.between?(200, 299)
247
- Auth0::Types::GetGuardianFactorPhoneTemplatesResponseContent.load(response.body)
343
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetGuardianFactorPhoneTemplatesResponseContent.load(response.body))
248
344
  else
249
345
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
250
346
  raise error_class.new(response.body, code: code)
@@ -261,6 +357,12 @@ module Auth0
261
357
  # @option request_options [Hash{String => Object}] :additional_body_parameters
262
358
  # @option request_options [Integer] :timeout_in_seconds
263
359
  #
360
+ # @example
361
+ # client.guardian.factors.phone.set_templates(
362
+ # enrollment_message: "enrollment_message",
363
+ # verification_message: "verification_message"
364
+ # )
365
+ #
264
366
  # @return [Auth0::Types::SetGuardianFactorPhoneTemplatesResponseContent]
265
367
  def set_templates(request_options: {}, **params)
266
368
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -278,7 +380,7 @@ module Auth0
278
380
  end
279
381
  code = response.code.to_i
280
382
  if code.between?(200, 299)
281
- Auth0::Types::SetGuardianFactorPhoneTemplatesResponseContent.load(response.body)
383
+ (response.body.to_s.empty? ? nil : Auth0::Types::SetGuardianFactorPhoneTemplatesResponseContent.load(response.body))
282
384
  else
283
385
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
284
386
  raise error_class.new(response.body, code: code)
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Auth0
4
+ module Guardian
5
+ module Factors
6
+ module Phone
7
+ module Types
8
+ class SetPhoneFactorSettingsRequestContent < Internal::Types::Model
9
+ field :otp_length, -> { Integer }, optional: false, nullable: false
10
+
11
+ field :otp_expiration_time, -> { Integer }, optional: false, nullable: false
12
+ end
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end