clerk-sdk-ruby 8.0.1 → 9.0.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.
- checksums.yaml +4 -4
- data/lib/clerk/actortokens.rb +9 -9
- data/lib/clerk/admin_portal_link_tokens.rb +18 -18
- data/lib/clerk/agenttasks.rb +9 -9
- data/lib/clerk/allowlistidentifiers.rb +13 -13
- data/lib/clerk/api_keys.rb +48 -48
- data/lib/clerk/betafeatures.rb +12 -10
- data/lib/clerk/billing.rb +68 -68
- data/lib/clerk/blocklistidentifiers.rb +13 -13
- data/lib/clerk/clients.rb +13 -13
- data/lib/clerk/directories.rb +342 -46
- data/lib/clerk/domains.rb +23 -20
- data/lib/clerk/emailaddresses.rb +37 -37
- data/lib/clerk/emailandsmstemplates.rb +5 -5
- data/lib/clerk/emailsmstemplates.rb +17 -17
- data/lib/clerk/enterpriseconnections.rb +31 -31
- data/lib/clerk/instancesettings.rb +52 -50
- data/lib/clerk/invitations.rb +166 -18
- data/lib/clerk/jwks.rb +3 -3
- data/lib/clerk/jwttemplates.rb +21 -21
- data/lib/clerk/logs.rb +683 -0
- data/lib/clerk/m2m.rb +27 -27
- data/lib/clerk/machines.rb +41 -41
- data/lib/clerk/miscellaneous.rb +2 -2
- data/lib/clerk/models/components/clerkerror.rb +1 -1
- data/lib/clerk/models/components/data.rb +27 -0
- data/lib/clerk/models/components/{type.rbi → data.rbi} +2 -2
- data/lib/clerk/models/components/directory.rb +8 -2
- data/lib/clerk/models/components/directory.rbi +2 -0
- data/lib/clerk/models/components/directorygroup.rb +44 -0
- data/lib/clerk/models/components/{directory_group.rbi → directorygroup.rbi} +4 -0
- data/lib/clerk/models/components/directorygroup_object.rb +19 -0
- data/lib/clerk/models/components/directorygroup_object.rbi +11 -0
- data/lib/clerk/models/components/directorygroupmember.rb +40 -0
- data/lib/clerk/models/components/directorygroupmember.rbi +17 -0
- data/lib/clerk/models/components/directorygroupmember_list.rb +36 -0
- data/lib/clerk/models/components/directorygroupmember_list.rbi +15 -0
- data/lib/clerk/models/components/directorygroupmember_list_cursor.rb +40 -0
- data/lib/clerk/models/components/directorygroupmember_list_cursor.rbi +17 -0
- data/lib/clerk/models/components/directorygroupmember_object.rb +19 -0
- data/lib/clerk/models/components/directorygroupmember_object.rbi +11 -0
- data/lib/clerk/models/components/directorygrouprolemapping_deleted.rb +1 -1
- data/lib/clerk/models/components/emailaddress_verification_saml_clerkerror.rb +1 -1
- data/lib/clerk/models/components/enterpriseaccount.rb +1 -1
- data/lib/clerk/models/components/enterpriseaccount_verification_oauth_clerkerror.rb +1 -1
- data/lib/clerk/models/components/enterpriseaccount_verification_saml_clerkerror.rb +1 -1
- data/lib/clerk/models/components/enterpriseconnection_idp_certificate.rb +40 -0
- data/lib/clerk/models/components/enterpriseconnection_idp_certificate.rbi +17 -0
- data/lib/clerk/models/components/enterpriseconnection_saml_connection.rb +18 -1
- data/lib/clerk/models/components/enterpriseconnection_saml_connection.rbi +8 -0
- data/lib/clerk/models/components/enterpriseconnectiontestrun.rb +1 -1
- data/lib/clerk/models/components/enterpriseconnectiontestrun_log.rb +44 -0
- data/lib/clerk/models/components/enterpriseconnectiontestrun_log.rbi +19 -0
- data/lib/clerk/models/components/externalaccountwithverification.rb +2 -2
- data/lib/clerk/models/components/externalaccountwithverification_verification_oauth_clerkerror.rb +1 -1
- data/lib/clerk/models/components/first_event.rb +115 -0
- data/lib/clerk/models/components/first_event.rbi +49 -0
- data/lib/clerk/models/components/instance.rb +5 -1
- data/lib/clerk/models/components/instance.rbi +2 -0
- data/lib/clerk/models/components/instanceprotect.rb +1 -1
- data/lib/clerk/models/components/invitation.rb +1 -1
- data/lib/clerk/models/components/invitation_revoked.rb +2 -2
- data/lib/clerk/models/components/log.rb +87 -18
- data/lib/clerk/models/components/log.rbi +38 -8
- data/lib/clerk/models/components/log_impersonator.rb +32 -0
- data/lib/clerk/models/components/log_impersonator.rbi +13 -0
- data/lib/clerk/models/components/log_list.rb +39 -0
- data/lib/clerk/models/components/log_list.rbi +15 -0
- data/lib/clerk/models/components/log_list_cursor.rb +72 -0
- data/lib/clerk/models/components/log_list_cursor.rbi +29 -0
- data/lib/clerk/models/components/logapplicationcontext.rb +36 -0
- data/lib/clerk/models/components/logapplicationcontext.rbi +15 -0
- data/lib/clerk/models/components/logbrowsercontext.rb +36 -0
- data/lib/clerk/models/components/logbrowsercontext.rbi +15 -0
- data/lib/clerk/models/components/logcontext.rb +36 -0
- data/lib/clerk/models/components/logcontext.rbi +15 -0
- data/lib/clerk/models/components/logdevicecontext.rb +60 -0
- data/lib/clerk/models/components/logdevicecontext.rbi +27 -0
- data/lib/clerk/models/components/logdomaincontext.rb +36 -0
- data/lib/clerk/models/components/logdomaincontext.rbi +15 -0
- data/lib/clerk/models/components/logenvironmentcontext.rb +44 -0
- data/lib/clerk/models/components/logenvironmentcontext.rbi +19 -0
- data/lib/clerk/models/components/loggroup.rb +89 -0
- data/lib/clerk/models/components/loggroup.rbi +37 -0
- data/lib/clerk/models/components/loggroup_impersonator.rb +32 -0
- data/lib/clerk/models/components/loggroup_impersonator.rbi +13 -0
- data/lib/clerk/models/components/loggroup_object.rb +19 -0
- data/lib/clerk/models/components/loggroup_object.rbi +11 -0
- data/lib/clerk/models/components/loglocationcontext.rb +41 -0
- data/lib/clerk/models/components/loglocationcontext.rbi +17 -0
- data/lib/clerk/models/components/logschema.rb +68 -0
- data/lib/clerk/models/components/logschema.rbi +25 -0
- data/lib/clerk/models/components/logschemafield.rb +49 -0
- data/lib/clerk/models/components/logschemafield.rbi +19 -0
- data/lib/clerk/models/components/logschemafield_type.rb +22 -0
- data/lib/clerk/models/components/logschemafield_type.rbi +11 -0
- data/lib/clerk/models/components/logwithpayload.rb +110 -0
- data/lib/clerk/models/components/logwithpayload.rbi +49 -0
- data/lib/clerk/models/components/logwithpayload_impersonator.rb +32 -0
- data/lib/clerk/models/components/logwithpayload_impersonator.rbi +13 -0
- data/lib/clerk/models/components/machine_deleted.rb +1 -1
- data/lib/clerk/models/components/machinescope_deleted.rb +1 -1
- data/lib/clerk/models/components/next_page_status.rb +21 -0
- data/lib/clerk/models/components/next_page_status.rbi +11 -0
- data/lib/clerk/models/components/oauthaccesstoken.rb +1 -1
- data/lib/clerk/models/components/oauthapplication.rb +9 -1
- data/lib/clerk/models/components/oauthapplication.rbi +4 -0
- data/lib/clerk/models/components/oauthapplicationsettings.rb +9 -1
- data/lib/clerk/models/components/oauthapplicationsettings.rbi +4 -0
- data/lib/clerk/models/components/oauthapplicationwithsecret.rb +9 -1
- data/lib/clerk/models/components/oauthapplicationwithsecret.rbi +4 -0
- data/lib/clerk/models/components/organization.rb +13 -8
- data/lib/clerk/models/components/organization.rbi +4 -2
- data/lib/clerk/models/components/organizationinvitation.rb +2 -2
- data/lib/clerk/models/components/organizationinvitationwithpublicorganizationdata.rb +2 -2
- data/lib/clerk/models/components/organizationmembership.rb +2 -2
- data/lib/clerk/models/components/organizationmembership_organization.rb +13 -8
- data/lib/clerk/models/components/organizationmembership_organization.rbi +4 -2
- data/lib/clerk/models/components/organizationwithlogo.rb +13 -8
- data/lib/clerk/models/components/organizationwithlogo.rbi +4 -2
- data/lib/clerk/models/components/role_set_migration.rb +1 -1
- data/lib/clerk/models/components/roleset.rb +1 -1
- data/lib/clerk/models/components/{type.rb → roleset_type.rb} +2 -2
- data/lib/clerk/models/components/roleset_type.rbi +11 -0
- data/lib/clerk/models/components/samlaccount.rb +1 -1
- data/lib/clerk/models/components/samlaccount_clerkerror.rb +1 -1
- data/lib/clerk/models/components/samlconnection_1.rb +6 -1
- data/lib/clerk/models/components/samlconnection_1.rbi +2 -0
- data/lib/clerk/models/components/samlconnection_2.rb +6 -1
- data/lib/clerk/models/components/samlconnection_2.rbi +2 -0
- data/lib/clerk/models/components/samlconnection_idp_certificate_1.rb +40 -0
- data/lib/clerk/models/components/samlconnection_idp_certificate_1.rbi +17 -0
- data/lib/clerk/models/components/samlconnection_idp_certificate_2.rb +40 -0
- data/lib/clerk/models/components/samlconnection_idp_certificate_2.rbi +17 -0
- data/lib/clerk/models/components/scimdirectory.rb +8 -2
- data/lib/clerk/models/components/scimdirectory.rbi +2 -0
- data/lib/clerk/models/components/scimgrouprolemapping_deleted.rb +1 -1
- data/lib/clerk/models/components/session.rb +2 -2
- data/lib/clerk/models/components/signup.rb +7 -3
- data/lib/clerk/models/components/signup.rbi +2 -0
- data/lib/clerk/models/components/signupverification.rb +1 -1
- data/lib/clerk/models/components/ssobypassallowlistpublicuserdata.rb +58 -0
- data/lib/clerk/models/components/ssobypassallowlistpublicuserdata.rbi +25 -0
- data/lib/clerk/models/components/ssobypassallowlistuser.rb +49 -0
- data/lib/clerk/models/components/ssobypassallowlistuser.rbi +21 -0
- data/lib/clerk/models/components/ssobypassallowlistuser_object.rb +19 -0
- data/lib/clerk/models/components/ssobypassallowlistuser_object.rbi +11 -0
- data/lib/clerk/models/components/user.rb +8 -4
- data/lib/clerk/models/components/user.rbi +2 -0
- data/lib/clerk/models/components/user_directory.rb +1 -1
- data/lib/clerk/models/components/{directory_group.rb → user_directory_group.rb} +1 -1
- data/lib/clerk/models/components/user_directory_group.rbi +15 -0
- data/lib/clerk/models/components/verification_from_oauth_clerkerror.rb +1 -1
- data/lib/clerk/models/components/verification_google_one_tap_clerkerror.rb +1 -1
- data/lib/clerk/models/components/waitlistentry_invitation.rb +1 -1
- data/lib/clerk/models/components.rb +37 -3
- data/lib/clerk/models/errors/apierror.rb +3 -3
- data/lib/clerk/models/errors/clerkerrors.rb +2 -2
- data/lib/clerk/models/errors/createadminportallinktoken_badrequest_error.rb +1 -1
- data/lib/clerk/models/errors/createadminportallinktoken_conflict_error.rb +1 -1
- data/lib/clerk/models/errors/createadminportallinktoken_forbidden_error.rb +1 -1
- data/lib/clerk/models/errors/createadminportallinktoken_unauthorized_error.rb +1 -1
- data/lib/clerk/models/errors/createapikey_badrequest_error.rb +1 -1
- data/lib/clerk/models/errors/createapikey_conflict_error.rb +1 -1
- data/lib/clerk/models/errors/createm2mtoken_badrequest_error.rb +1 -1
- data/lib/clerk/models/errors/createm2mtoken_conflict_error.rb +1 -1
- data/lib/clerk/models/errors/deleteapikey_badrequest_error.rb +1 -1
- data/lib/clerk/models/errors/deleteapikey_notfound_error.rb +1 -1
- data/lib/clerk/models/errors/getapikey_badrequest_error.rb +1 -1
- data/lib/clerk/models/errors/getapikey_notfound_error.rb +1 -1
- data/lib/clerk/models/errors/getapikeys_badrequest_error.rb +1 -1
- data/lib/clerk/models/errors/getapikeys_notfound_error.rb +1 -1
- data/lib/clerk/models/errors/getapikeysecret_badrequest_error.rb +1 -1
- data/lib/clerk/models/errors/getapikeysecret_notfound_error.rb +1 -1
- data/lib/clerk/models/errors/getm2mtokens_badrequest_error.rb +1 -1
- data/lib/clerk/models/errors/getm2mtokens_forbidden_error.rb +1 -1
- data/lib/clerk/models/errors/getm2mtokens_notfound_error.rb +1 -1
- data/lib/clerk/models/errors/revokeadminportallinktoken_badrequest_error.rb +1 -1
- data/lib/clerk/models/errors/revokeadminportallinktoken_forbidden_error.rb +1 -1
- data/lib/clerk/models/errors/revokeadminportallinktoken_notfound_error.rb +1 -1
- data/lib/clerk/models/errors/revokeadminportallinktoken_unauthorized_error.rb +1 -1
- data/lib/clerk/models/errors/revokeapikey_badrequest_error.rb +1 -1
- data/lib/clerk/models/errors/revokeapikey_notfound_error.rb +1 -1
- data/lib/clerk/models/errors/revokem2mtoken_badrequest_error.rb +1 -1
- data/lib/clerk/models/errors/revokem2mtoken_notfound_error.rb +1 -1
- data/lib/clerk/models/errors/updateapikey_badrequest_error.rb +1 -1
- data/lib/clerk/models/errors/updateapikey_notfound_error.rb +1 -1
- data/lib/clerk/models/errors/verifyapikey_badrequest_error.rb +1 -1
- data/lib/clerk/models/errors/verifyapikey_notfound_error.rb +1 -1
- data/lib/clerk/models/errors/verifym2mtoken_badrequest_error.rb +1 -1
- data/lib/clerk/models/errors/verifym2mtoken_notfound_error.rb +1 -1
- data/lib/clerk/models/errors/verifyoauthaccesstoken_badrequest_error.rb +1 -1
- data/lib/clerk/models/errors/verifyoauthaccesstoken_notfound_error.rb +1 -1
- data/lib/clerk/models/operations/act.rb +40 -0
- data/lib/clerk/models/operations/act.rbi +17 -0
- data/lib/clerk/models/operations/act_act.rb +36 -0
- data/lib/clerk/models/operations/act_act.rbi +15 -0
- data/lib/clerk/models/operations/actor.rb +1 -1
- data/lib/clerk/models/operations/attemptemailaddressverification_requestbody.rb +7 -1
- data/lib/clerk/models/operations/attemptemailaddressverification_requestbody.rbi +2 -0
- data/lib/clerk/models/operations/attemptphonenumberverification_requestbody.rb +7 -1
- data/lib/clerk/models/operations/attemptphonenumberverification_requestbody.rbi +2 -0
- data/lib/clerk/models/operations/clerkidpoauthaccesstoken.rb +5 -1
- data/lib/clerk/models/operations/clerkidpoauthaccesstoken.rbi +2 -0
- data/lib/clerk/models/operations/createbulkinvitations_requestbody.rb +1 -1
- data/lib/clerk/models/operations/createenterpriseconnection_saml.rb +8 -2
- data/lib/clerk/models/operations/createenterpriseconnection_saml.rbi +2 -0
- data/lib/clerk/models/operations/createinvitation_request.rb +1 -1
- data/lib/clerk/models/operations/createoauthapplication_request.rb +13 -1
- data/lib/clerk/models/operations/createoauthapplication_request.rbi +6 -0
- data/lib/clerk/models/operations/createorganization_request.rb +2 -2
- data/lib/clerk/models/operations/createorganizationinvitation_requestbody.rb +2 -2
- data/lib/clerk/models/operations/createorganizationinvitationbulk_requestbody.rb +2 -2
- data/lib/clerk/models/operations/createorganizationmembership_requestbody.rb +2 -2
- data/lib/clerk/models/operations/createsamlconnection_requestbody_1.rb +8 -2
- data/lib/clerk/models/operations/createsamlconnection_requestbody_1.rbi +2 -0
- data/lib/clerk/models/operations/createsamlconnection_requestbody_2.rb +8 -2
- data/lib/clerk/models/operations/createsamlconnection_requestbody_2.rbi +2 -0
- data/lib/clerk/models/operations/createsignintoken_request.rb +17 -2
- data/lib/clerk/models/operations/createsignintoken_request.rbi +4 -0
- data/lib/clerk/models/operations/createssobypassallowlistuser_request.rb +32 -0
- data/lib/clerk/models/operations/createssobypassallowlistuser_request.rbi +13 -0
- data/lib/clerk/models/operations/createssobypassallowlistuser_response.rb +44 -0
- data/lib/clerk/models/operations/createssobypassallowlistuser_response.rbi +19 -0
- data/lib/clerk/models/operations/createuser_request.rb +8 -4
- data/lib/clerk/models/operations/createuser_request.rbi +2 -0
- data/lib/clerk/models/operations/deleteapikey_responsebody.rb +1 -1
- data/lib/clerk/models/operations/deleteinvitation_request.rb +32 -0
- data/lib/clerk/models/operations/deleteinvitation_request.rbi +13 -0
- data/lib/clerk/models/operations/deleteinvitation_response.rb +44 -0
- data/lib/clerk/models/operations/deleteinvitation_response.rbi +19 -0
- data/lib/clerk/models/operations/deletessobypassallowlistuser_request.rb +32 -0
- data/lib/clerk/models/operations/deletessobypassallowlistuser_request.rbi +13 -0
- data/lib/clerk/models/operations/deletessobypassallowlistuser_response.rb +44 -0
- data/lib/clerk/models/operations/deletessobypassallowlistuser_response.rbi +19 -0
- data/lib/clerk/models/operations/filter_match.rb +27 -0
- data/lib/clerk/models/operations/filter_match.rbi +11 -0
- data/lib/clerk/models/operations/getdirectorygroup_request.rb +36 -0
- data/lib/clerk/models/operations/getdirectorygroup_request.rbi +15 -0
- data/lib/clerk/models/operations/getdirectorygroup_response.rb +44 -0
- data/lib/clerk/models/operations/getdirectorygroup_response.rbi +19 -0
- data/lib/clerk/models/operations/getlog_request.rb +34 -0
- data/lib/clerk/models/operations/getlog_request.rbi +13 -0
- data/lib/clerk/models/operations/getlog_response.rb +44 -0
- data/lib/clerk/models/operations/getlog_response.rbi +19 -0
- data/lib/clerk/models/operations/getlogschema_request.rb +35 -0
- data/lib/clerk/models/operations/getlogschema_request.rbi +13 -0
- data/lib/clerk/models/operations/getlogschema_response.rb +44 -0
- data/lib/clerk/models/operations/getlogschema_response.rbi +19 -0
- data/lib/clerk/models/operations/listdirectorygroupmembers_request.rb +45 -0
- data/lib/clerk/models/operations/listdirectorygroupmembers_request.rbi +19 -0
- data/lib/clerk/models/operations/listdirectorygroupmembers_response.rb +44 -0
- data/lib/clerk/models/operations/listdirectorygroupmembers_response.rbi +19 -0
- data/lib/clerk/models/operations/listinvitations_request.rb +6 -1
- data/lib/clerk/models/operations/listinvitations_request.rbi +2 -0
- data/lib/clerk/models/operations/listloggroupevents_request.rb +47 -0
- data/lib/clerk/models/operations/listloggroupevents_request.rbi +19 -0
- data/lib/clerk/models/operations/listloggroupevents_response.rb +44 -0
- data/lib/clerk/models/operations/listloggroupevents_response.rbi +19 -0
- data/lib/clerk/models/operations/listlogs_request.rb +228 -0
- data/lib/clerk/models/operations/listlogs_request.rbi +55 -0
- data/lib/clerk/models/operations/listlogs_response.rb +44 -0
- data/lib/clerk/models/operations/listlogs_response.rbi +19 -0
- data/lib/clerk/models/operations/listssobypassallowlistusers_request.rb +32 -0
- data/lib/clerk/models/operations/listssobypassallowlistusers_request.rbi +13 -0
- data/lib/clerk/models/operations/listssobypassallowlistusers_response.rb +44 -0
- data/lib/clerk/models/operations/listssobypassallowlistusers_response.rbi +19 -0
- data/lib/clerk/models/operations/mergeorganizationmetadata_requestbody.rb +2 -2
- data/lib/clerk/models/operations/mergeuser_request.rb +36 -0
- data/lib/clerk/models/operations/mergeuser_request.rbi +15 -0
- data/lib/clerk/models/operations/mergeuser_requestbody.rb +36 -0
- data/lib/clerk/models/operations/mergeuser_requestbody.rbi +15 -0
- data/lib/clerk/models/operations/mergeuser_response.rb +44 -0
- data/lib/clerk/models/operations/mergeuser_response.rbi +19 -0
- data/lib/clerk/models/operations/mergeuser_responsebody.rb +36 -0
- data/lib/clerk/models/operations/mergeuser_responsebody.rbi +15 -0
- data/lib/clerk/models/operations/refreshsession_requestbody.rb +1 -1
- data/lib/clerk/models/operations/replaceorganizationmetadata_requestbody.rb +2 -2
- data/lib/clerk/models/operations/replaceroleset_requestbody.rb +1 -1
- data/lib/clerk/models/operations/replaceusermetadata_requestbody.rb +3 -3
- data/lib/clerk/models/operations/responsebody.rb +1 -1
- data/lib/clerk/models/operations/revokesession_request.rb +5 -1
- data/lib/clerk/models/operations/revokesession_request.rbi +2 -0
- data/lib/clerk/models/operations/revokesession_requestbody.rb +36 -0
- data/lib/clerk/models/operations/revokesession_requestbody.rbi +13 -0
- data/lib/clerk/models/operations/second_factor_verification.rb +25 -0
- data/lib/clerk/models/operations/second_factor_verification.rbi +11 -0
- data/lib/clerk/models/operations/updatedirectory_requestbody.rb +8 -2
- data/lib/clerk/models/operations/updatedirectory_requestbody.rbi +2 -0
- data/lib/clerk/models/operations/updateenterpriseconnection_saml.rb +8 -2
- data/lib/clerk/models/operations/updateenterpriseconnection_saml.rbi +2 -0
- data/lib/clerk/models/operations/updateinstance_request.rb +1 -1
- data/lib/clerk/models/operations/updateinstanceoauthapplicationsettings_request.rb +9 -1
- data/lib/clerk/models/operations/updateinstanceoauthapplicationsettings_request.rbi +4 -0
- data/lib/clerk/models/operations/updateinstanceprotect_request.rb +1 -5
- data/lib/clerk/models/operations/updateinstanceprotect_request.rbi +0 -2
- data/lib/clerk/models/operations/updateoauthapplication_requestbody.rb +13 -1
- data/lib/clerk/models/operations/updateoauthapplication_requestbody.rbi +6 -0
- data/lib/clerk/models/operations/updateorganization_requestbody.rb +12 -2
- data/lib/clerk/models/operations/updateorganization_requestbody.rbi +4 -0
- data/lib/clerk/models/operations/updateorganizationmembershipmetadata_requestbody.rb +2 -2
- data/lib/clerk/models/operations/updatesamlconnection_requestbody.rb +8 -2
- data/lib/clerk/models/operations/updatesamlconnection_requestbody.rbi +2 -0
- data/lib/clerk/models/operations/updatescimdirectory_requestbody.rb +8 -2
- data/lib/clerk/models/operations/updatescimdirectory_requestbody.rbi +2 -0
- data/lib/clerk/models/operations/updatesession_request.rb +36 -0
- data/lib/clerk/models/operations/updatesession_request.rbi +15 -0
- data/lib/clerk/models/operations/updatesession_requestbody.rb +33 -0
- data/lib/clerk/models/operations/updatesession_requestbody.rbi +13 -0
- data/lib/clerk/models/operations/updatesession_response.rb +44 -0
- data/lib/clerk/models/operations/updatesession_response.rbi +19 -0
- data/lib/clerk/models/operations/updateuser_requestbody.rb +5 -1
- data/lib/clerk/models/operations/updateuser_requestbody.rbi +2 -0
- data/lib/clerk/models/operations/updateusermetadata_requestbody.rb +3 -3
- data/lib/clerk/models/operations/verifypassword_requestbody.rb +7 -1
- data/lib/clerk/models/operations/verifypassword_requestbody.rbi +2 -0
- data/lib/clerk/models/operations/verifytotp_requestbody.rb +7 -1
- data/lib/clerk/models/operations/verifytotp_requestbody.rbi +2 -0
- data/lib/clerk/models/operations/view.rb +38 -0
- data/lib/clerk/models/operations/view.rbi +11 -0
- data/lib/clerk/models/operations.rb +33 -0
- data/lib/clerk/oauthaccesstokens.rb +7 -7
- data/lib/clerk/oauthapplications.rb +37 -37
- data/lib/clerk/openapiclient.rb +3 -1
- data/lib/clerk/organizationdomains.rb +28 -28
- data/lib/clerk/organizationinvitations.rb +35 -35
- data/lib/clerk/organizationmemberships.rb +25 -25
- data/lib/clerk/organizationpermissions.rb +24 -24
- data/lib/clerk/organizationroles.rb +32 -32
- data/lib/clerk/organizations.rb +61 -61
- data/lib/clerk/phonenumbers.rb +36 -36
- data/lib/clerk/proxychecks.rb +5 -5
- data/lib/clerk/redirecturls.rb +16 -16
- data/lib/clerk/rolesets.rb +38 -38
- data/lib/clerk/samlconnections.rb +23 -23
- data/lib/clerk/scimdirectories.rb +46 -46
- data/lib/clerk/sdk_hooks/types.rb +4 -4
- data/lib/clerk/sdkconfiguration.rb +4 -4
- data/lib/clerk/sessions.rb +219 -42
- data/lib/clerk/signintokens.rb +9 -9
- data/lib/clerk/signups.rb +9 -9
- data/lib/clerk/ssobypassallowlistusers.rb +477 -0
- data/lib/clerk/templates.rb +5 -5
- data/lib/clerk/testingtokens.rb +3 -3
- data/lib/clerk/users.rb +376 -189
- data/lib/clerk/utils/forms.rb +9 -9
- data/lib/clerk/utils/headers.rb +2 -2
- data/lib/clerk/utils/query_params.rb +6 -6
- data/lib/clerk/utils/request_bodies.rb +2 -2
- data/lib/clerk/utils/retries.rb +5 -5
- data/lib/clerk/utils/security.rb +4 -4
- data/lib/clerk/utils/utils.rb +13 -13
- data/lib/clerk/waitlistentries.rb +26 -26
- data/lib/clerk/webhooks.rb +11 -11
- data/lib/clerk-sdk-ruby.rb +6 -0
- data/lib/clerk_sdk_ruby.rb +2 -0
- metadata +143 -6
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# typed: false
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class Clerk::Models::Operations::GetLogSchemaResponse
|
|
6
|
+
extend ::Crystalline::MetadataFields::ClassMethods
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class Clerk::Models::Operations::GetLogSchemaResponse
|
|
11
|
+
def content_type(); end
|
|
12
|
+
def content_type=(str_); end
|
|
13
|
+
def status_code(); end
|
|
14
|
+
def status_code=(str_); end
|
|
15
|
+
def raw_response(); end
|
|
16
|
+
def raw_response=(str_); end
|
|
17
|
+
def log_schema(); end
|
|
18
|
+
def log_schema=(str_); end
|
|
19
|
+
end
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: false
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module Clerk
|
|
8
|
+
module Models
|
|
9
|
+
module Operations
|
|
10
|
+
|
|
11
|
+
class ListDirectoryGroupMembersRequest
|
|
12
|
+
|
|
13
|
+
include Crystalline::MetadataFields
|
|
14
|
+
|
|
15
|
+
# The ID of the directory.
|
|
16
|
+
field :directory_id, ::String, { 'path_param': { 'field_name': 'directory_id', 'style': 'simple', 'explode': false } }
|
|
17
|
+
# The ID of the group, as assigned by the directory.
|
|
18
|
+
field :group_id, ::String, { 'path_param': { 'field_name': 'group_id', 'style': 'simple', 'explode': false } }
|
|
19
|
+
# A cursor for pagination. Provide the `starting_after` cursor from a previous response to fetch the next page.
|
|
20
|
+
field :starting_after, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'starting_after', 'style': 'form', 'explode': true } }
|
|
21
|
+
# Applies a limit to the number of results returned.
|
|
22
|
+
# Can be used for paginating the results together with `starting_after`.
|
|
23
|
+
field :limit, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'limit', 'style': 'form', 'explode': true } }
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
def initialize(directory_id:, group_id:, starting_after: nil, limit: 10)
|
|
27
|
+
@directory_id = directory_id
|
|
28
|
+
@group_id = group_id
|
|
29
|
+
@starting_after = starting_after
|
|
30
|
+
@limit = limit
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
def ==(other)
|
|
35
|
+
return false unless other.is_a? self.class
|
|
36
|
+
return false unless @directory_id == other.directory_id
|
|
37
|
+
return false unless @group_id == other.group_id
|
|
38
|
+
return false unless @starting_after == other.starting_after
|
|
39
|
+
return false unless @limit == other.limit
|
|
40
|
+
true
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# typed: false
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class Clerk::Models::Operations::ListDirectoryGroupMembersRequest
|
|
6
|
+
extend ::Crystalline::MetadataFields::ClassMethods
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class Clerk::Models::Operations::ListDirectoryGroupMembersRequest
|
|
11
|
+
def directory_id(); end
|
|
12
|
+
def directory_id=(str_); end
|
|
13
|
+
def group_id(); end
|
|
14
|
+
def group_id=(str_); end
|
|
15
|
+
def starting_after(); end
|
|
16
|
+
def starting_after=(str_); end
|
|
17
|
+
def limit(); end
|
|
18
|
+
def limit=(str_); end
|
|
19
|
+
end
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: false
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module Clerk
|
|
8
|
+
module Models
|
|
9
|
+
module Operations
|
|
10
|
+
|
|
11
|
+
class ListDirectoryGroupMembersResponse
|
|
12
|
+
|
|
13
|
+
include Crystalline::MetadataFields
|
|
14
|
+
|
|
15
|
+
# HTTP response content type for this operation
|
|
16
|
+
field :content_type, ::String
|
|
17
|
+
# HTTP response status code for this operation
|
|
18
|
+
field :status_code, ::Integer
|
|
19
|
+
# Raw HTTP response; suitable for custom response parsing
|
|
20
|
+
field :raw_response, ::Faraday::Response
|
|
21
|
+
# A cursor-paginated list of the members of a group.
|
|
22
|
+
field :directory_group_member_list, Crystalline::Nilable.new(Models::Components::DirectoryGroupMemberList)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
def initialize(content_type:, status_code:, raw_response:, directory_group_member_list: nil)
|
|
26
|
+
@content_type = content_type
|
|
27
|
+
@status_code = status_code
|
|
28
|
+
@raw_response = raw_response
|
|
29
|
+
@directory_group_member_list = directory_group_member_list
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
def ==(other)
|
|
34
|
+
return false unless other.is_a? self.class
|
|
35
|
+
return false unless @content_type == other.content_type
|
|
36
|
+
return false unless @status_code == other.status_code
|
|
37
|
+
return false unless @raw_response == other.raw_response
|
|
38
|
+
return false unless @directory_group_member_list == other.directory_group_member_list
|
|
39
|
+
true
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# typed: false
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class Clerk::Models::Operations::ListDirectoryGroupMembersResponse
|
|
6
|
+
extend ::Crystalline::MetadataFields::ClassMethods
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class Clerk::Models::Operations::ListDirectoryGroupMembersResponse
|
|
11
|
+
def content_type(); end
|
|
12
|
+
def content_type=(str_); end
|
|
13
|
+
def status_code(); end
|
|
14
|
+
def status_code=(str_); end
|
|
15
|
+
def raw_response(); end
|
|
16
|
+
def raw_response=(str_); end
|
|
17
|
+
def directory_group_member_list(); end
|
|
18
|
+
def directory_group_member_list=(str_); end
|
|
19
|
+
end
|
|
@@ -16,6 +16,9 @@ module Clerk
|
|
|
16
16
|
field :status, Crystalline::Nilable.new(Models::Operations::ListInvitationsStatus), { 'query_param': { 'field_name': 'status', 'style': 'form', 'explode': true } }
|
|
17
17
|
# Filter invitations based on their `email_address` or `id`
|
|
18
18
|
field :query, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'query', 'style': 'form', 'explode': true } }
|
|
19
|
+
# Returns invitations with the specified email addresses.
|
|
20
|
+
# Accepts up to 100 email addresses.
|
|
21
|
+
field :email_address, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'email_address', 'style': 'form', 'explode': true } }
|
|
19
22
|
# Whether to paginate the results.
|
|
20
23
|
# If true, the results will be paginated.
|
|
21
24
|
# If false, the results will not be paginated.
|
|
@@ -36,9 +39,10 @@ module Clerk
|
|
|
36
39
|
field :offset, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'offset', 'style': 'form', 'explode': true } }
|
|
37
40
|
|
|
38
41
|
|
|
39
|
-
def initialize(status: nil, query: nil, paginated: nil, order_by: '-created_at', limit: 10, offset: 0)
|
|
42
|
+
def initialize(status: nil, query: nil, email_address: nil, paginated: nil, order_by: '-created_at', limit: 10, offset: 0)
|
|
40
43
|
@status = status
|
|
41
44
|
@query = query
|
|
45
|
+
@email_address = email_address
|
|
42
46
|
@paginated = paginated
|
|
43
47
|
@order_by = order_by
|
|
44
48
|
@limit = limit
|
|
@@ -50,6 +54,7 @@ module Clerk
|
|
|
50
54
|
return false unless other.is_a? self.class
|
|
51
55
|
return false unless @status == other.status
|
|
52
56
|
return false unless @query == other.query
|
|
57
|
+
return false unless @email_address == other.email_address
|
|
53
58
|
return false unless @paginated == other.paginated
|
|
54
59
|
return false unless @order_by == other.order_by
|
|
55
60
|
return false unless @limit == other.limit
|
|
@@ -12,6 +12,8 @@ class Clerk::Models::Operations::ListInvitationsRequest
|
|
|
12
12
|
def status=(str_); end
|
|
13
13
|
def query(); end
|
|
14
14
|
def query=(str_); end
|
|
15
|
+
def email_address(); end
|
|
16
|
+
def email_address=(str_); end
|
|
15
17
|
def paginated(); end
|
|
16
18
|
def paginated=(str_); end
|
|
17
19
|
def order_by(); end
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: false
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module Clerk
|
|
8
|
+
module Models
|
|
9
|
+
module Operations
|
|
10
|
+
|
|
11
|
+
class ListLogGroupEventsRequest
|
|
12
|
+
|
|
13
|
+
include Crystalline::MetadataFields
|
|
14
|
+
|
|
15
|
+
# The ID of the event group, e.g. a sign-in ID.
|
|
16
|
+
field :group_id, ::String, { 'path_param': { 'field_name': 'group_id', 'style': 'simple', 'explode': false } }
|
|
17
|
+
# When the group started (Unix timestamp in milliseconds), the
|
|
18
|
+
# `started_at` of the group item. It bounds the time range searched.
|
|
19
|
+
field :started_at, ::Integer, { 'query_param': { 'field_name': 'started_at', 'style': 'form', 'explode': true } }
|
|
20
|
+
# The group's `events_cursor` from the grouped view, or the
|
|
21
|
+
# `starting_after` cursor this endpoint returned. Only forward
|
|
22
|
+
# pagination is supported.
|
|
23
|
+
field :starting_after, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'starting_after', 'style': 'form', 'explode': true } }
|
|
24
|
+
# Applies a limit to the number of results returned.
|
|
25
|
+
field :limit, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'limit', 'style': 'form', 'explode': true } }
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
def initialize(group_id:, started_at:, starting_after: nil, limit: 10)
|
|
29
|
+
@group_id = group_id
|
|
30
|
+
@started_at = started_at
|
|
31
|
+
@starting_after = starting_after
|
|
32
|
+
@limit = limit
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
def ==(other)
|
|
37
|
+
return false unless other.is_a? self.class
|
|
38
|
+
return false unless @group_id == other.group_id
|
|
39
|
+
return false unless @started_at == other.started_at
|
|
40
|
+
return false unless @starting_after == other.starting_after
|
|
41
|
+
return false unless @limit == other.limit
|
|
42
|
+
true
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# typed: false
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class Clerk::Models::Operations::ListLogGroupEventsRequest
|
|
6
|
+
extend ::Crystalline::MetadataFields::ClassMethods
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class Clerk::Models::Operations::ListLogGroupEventsRequest
|
|
11
|
+
def group_id(); end
|
|
12
|
+
def group_id=(str_); end
|
|
13
|
+
def started_at(); end
|
|
14
|
+
def started_at=(str_); end
|
|
15
|
+
def starting_after(); end
|
|
16
|
+
def starting_after=(str_); end
|
|
17
|
+
def limit(); end
|
|
18
|
+
def limit=(str_); end
|
|
19
|
+
end
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: false
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module Clerk
|
|
8
|
+
module Models
|
|
9
|
+
module Operations
|
|
10
|
+
|
|
11
|
+
class ListLogGroupEventsResponse
|
|
12
|
+
|
|
13
|
+
include Crystalline::MetadataFields
|
|
14
|
+
|
|
15
|
+
# HTTP response content type for this operation
|
|
16
|
+
field :content_type, ::String
|
|
17
|
+
# HTTP response status code for this operation
|
|
18
|
+
field :status_code, ::Integer
|
|
19
|
+
# Raw HTTP response; suitable for custom response parsing
|
|
20
|
+
field :raw_response, ::Faraday::Response
|
|
21
|
+
# A list of log entries with cursor-based pagination.
|
|
22
|
+
field :log_list, Crystalline::Nilable.new(Models::Components::LogList)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
def initialize(content_type:, status_code:, raw_response:, log_list: nil)
|
|
26
|
+
@content_type = content_type
|
|
27
|
+
@status_code = status_code
|
|
28
|
+
@raw_response = raw_response
|
|
29
|
+
@log_list = log_list
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
def ==(other)
|
|
34
|
+
return false unless other.is_a? self.class
|
|
35
|
+
return false unless @content_type == other.content_type
|
|
36
|
+
return false unless @status_code == other.status_code
|
|
37
|
+
return false unless @raw_response == other.raw_response
|
|
38
|
+
return false unless @log_list == other.log_list
|
|
39
|
+
true
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# typed: false
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class Clerk::Models::Operations::ListLogGroupEventsResponse
|
|
6
|
+
extend ::Crystalline::MetadataFields::ClassMethods
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class Clerk::Models::Operations::ListLogGroupEventsResponse
|
|
11
|
+
def content_type(); end
|
|
12
|
+
def content_type=(str_); end
|
|
13
|
+
def status_code(); end
|
|
14
|
+
def status_code=(str_); end
|
|
15
|
+
def raw_response(); end
|
|
16
|
+
def raw_response=(str_); end
|
|
17
|
+
def log_list(); end
|
|
18
|
+
def log_list=(str_); end
|
|
19
|
+
end
|
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: false
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module Clerk
|
|
8
|
+
module Models
|
|
9
|
+
module Operations
|
|
10
|
+
|
|
11
|
+
class ListLogsRequest
|
|
12
|
+
|
|
13
|
+
include Crystalline::MetadataFields
|
|
14
|
+
|
|
15
|
+
# A cursor for pagination. Provide the starting_after cursor from a previous response to fetch the next page.
|
|
16
|
+
field :starting_after, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'starting_after', 'style': 'form', 'explode': true } }
|
|
17
|
+
# A cursor for pagination. Provide the ending_before cursor from a previous response to fetch the previous page.
|
|
18
|
+
# Only with `view=flat`, since the grouped view only pages forward.
|
|
19
|
+
field :ending_before, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'ending_before', 'style': 'form', 'explode': true } }
|
|
20
|
+
# Filter logs by subject.
|
|
21
|
+
field :subject, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'subject', 'style': 'form', 'explode': true } }
|
|
22
|
+
# Filter logs by actor
|
|
23
|
+
field :actor, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'actor', 'style': 'form', 'explode': true } }
|
|
24
|
+
# Filter logs to events involving one user, as either the actor or
|
|
25
|
+
# the subject. Takes the user's ID.
|
|
26
|
+
#
|
|
27
|
+
# Returns a 422 if the value is not a user ID (use `identifier` to
|
|
28
|
+
# filter by email address, phone number, username, or web3 wallet) or
|
|
29
|
+
# if `actor`, `subject`, or `identifier` is also set.
|
|
30
|
+
field :user_id, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'user_id', 'style': 'form', 'explode': true } }
|
|
31
|
+
# Filter logs to events where the user is the actor or the subject.
|
|
32
|
+
# Takes an identifier associated with a user: an email address, phone
|
|
33
|
+
# number, username, or web3 wallet.
|
|
34
|
+
#
|
|
35
|
+
# The value must exactly match an identifier stored on a user; it is
|
|
36
|
+
# not a partial or fuzzy match. Verification status is not considered,
|
|
37
|
+
# so an identifier associated with several users matches events for
|
|
38
|
+
# all of them. If it is associated with no user in the instance, the
|
|
39
|
+
# response is an empty page, not an error.
|
|
40
|
+
#
|
|
41
|
+
# Returns a 422 if the value is a user ID (use `user_id` instead) or
|
|
42
|
+
# if `actor`, `subject`, or `user_id` is also set.
|
|
43
|
+
field :identifier, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'identifier', 'style': 'form', 'explode': true } }
|
|
44
|
+
# Filter logs by trace ID (32 hex characters).
|
|
45
|
+
field :trace_id, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'trace_id', 'style': 'form', 'explode': true } }
|
|
46
|
+
# Filter logs by event type (e.g., `sign_in.completed`). A trailing
|
|
47
|
+
# `*` matches an event-type family by prefix (e.g. `sign_in.*`
|
|
48
|
+
# matches `sign_in.created`, `sign_in.completed`, ...); the wildcard
|
|
49
|
+
# is only allowed as the last character.
|
|
50
|
+
field :type, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'type', 'style': 'form', 'explode': true } }
|
|
51
|
+
# Filter logs by client ID.
|
|
52
|
+
field :client_id, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'client_id', 'style': 'form', 'explode': true } }
|
|
53
|
+
# Filter logs to events produced by one session: the session that was
|
|
54
|
+
# authenticated on the request behind the event.
|
|
55
|
+
#
|
|
56
|
+
# This is the acting session, not the session an event is about. A
|
|
57
|
+
# sign-in creates a session on a request that had none, so
|
|
58
|
+
# `session.created` carries no `session_id` and names the new session
|
|
59
|
+
# in its payload instead. Use `payload_filter[session_id]` with a
|
|
60
|
+
# `type` to filter on that.
|
|
61
|
+
#
|
|
62
|
+
# Events with no authenticated session behind them, such as sign-in,
|
|
63
|
+
# sign-up and verification requests, or anything originating from the
|
|
64
|
+
# Backend API or a background job, carry no `session_id` and never
|
|
65
|
+
# match.
|
|
66
|
+
field :session_id, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'session_id', 'style': 'form', 'explode': true } }
|
|
67
|
+
# Filter logs by impersonator user ID.
|
|
68
|
+
field :impersonator_user_id, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'impersonator_user_id', 'style': 'form', 'explode': true } }
|
|
69
|
+
# Filter logs by the client IP address recorded on the event.
|
|
70
|
+
field :ip_address, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'ip_address', 'style': 'form', 'explode': true } }
|
|
71
|
+
# Exact-match filters on event payload fields, keyed by the field's
|
|
72
|
+
# dot-path: `payload_filter[user_id]=user_123` or
|
|
73
|
+
# `payload_filter[captcha_attempt_payload.provider]=turnstile`.
|
|
74
|
+
#
|
|
75
|
+
# Requires `type`. Fields are validated against the payload schema of
|
|
76
|
+
# that event type (discoverable via `GET /logs/schemas`); for a
|
|
77
|
+
# trailing-`*` type the valid fields are those common to every
|
|
78
|
+
# matching event type. An unknown field returns a 422 listing the
|
|
79
|
+
# allowed fields.
|
|
80
|
+
#
|
|
81
|
+
# One value per field — repeating a field is a 422. Values must parse
|
|
82
|
+
# as the field's type (a non-numeric value against an integer field
|
|
83
|
+
# is a 422) and match exactly; an event whose payload lacks the field
|
|
84
|
+
# never matches. At most 10 filters per request, paths at most 4
|
|
85
|
+
# segments deep, values at most 256 characters.
|
|
86
|
+
#
|
|
87
|
+
# Payload filters join the same `filter_match` group as the string
|
|
88
|
+
# filters above.
|
|
89
|
+
field :payload_filter, Crystalline::Nilable.new(Crystalline::Hash.new(::Symbol, ::String)), { 'query_param': { 'field_name': 'payload_filter', 'style': 'deepObject', 'explode': true } }
|
|
90
|
+
# Comma-separated payload field dot-paths to include per returned
|
|
91
|
+
# log: `payload_fields=user_id,strategy`. Requires `type`, and the
|
|
92
|
+
# fields are validated against that event type's payload schema the
|
|
93
|
+
# same way as `payload_filter` (with the same caps).
|
|
94
|
+
#
|
|
95
|
+
# Each returned log gains a `payload` object containing only the
|
|
96
|
+
# requested fields, keyed by their dot-paths, with fields absent
|
|
97
|
+
# from an event's payload omitted. Without this parameter, list
|
|
98
|
+
# responses carry no `payload` key.
|
|
99
|
+
#
|
|
100
|
+
# Not allowed together with `filter_match=any`: the fields are
|
|
101
|
+
# validated against `type`'s schema, and with `any` the type filter
|
|
102
|
+
# no longer constrains every returned row.
|
|
103
|
+
field :payload_fields, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'payload_fields', 'style': 'form', 'explode': true } }
|
|
104
|
+
# Sets a lower time boundary for the query (Unix timestamp in milliseconds).
|
|
105
|
+
# Only events on or after this timestamp are eligible to be returned.
|
|
106
|
+
#
|
|
107
|
+
# This parameter constrains the search range but does not guarantee that
|
|
108
|
+
# every matching event within the range is returned in a single response.
|
|
109
|
+
# The server may use an internal time window smaller than the requested range
|
|
110
|
+
# to keep query latency predictable. When this happens, `next_page_status`
|
|
111
|
+
# will be `"unknown"` and a continuation cursor is provided so the caller
|
|
112
|
+
# can paginate through the full range. The window that was actually read
|
|
113
|
+
# is reported as `searched_from` and `searched_to`.
|
|
114
|
+
field :event_time_after, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'event_time_after', 'style': 'form', 'explode': true } }
|
|
115
|
+
# Sets an upper time boundary for the query (Unix timestamp in milliseconds).
|
|
116
|
+
# Only events on or before this timestamp are eligible to be returned.
|
|
117
|
+
#
|
|
118
|
+
# This parameter constrains the search range but does not guarantee that
|
|
119
|
+
# every matching event within the range is returned in a single response.
|
|
120
|
+
# The server may use an internal time window smaller than the requested range
|
|
121
|
+
# to keep query latency predictable. When this happens, `next_page_status`
|
|
122
|
+
# will be `"unknown"` and a continuation cursor is provided so the caller
|
|
123
|
+
# can paginate through the full range.
|
|
124
|
+
field :event_time_before, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'event_time_before', 'style': 'form', 'explode': true } }
|
|
125
|
+
# When set to true, only returns events that are marked as end-user facing.
|
|
126
|
+
# When set to false or omitted, returns all events.
|
|
127
|
+
field :end_user_facing_only, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'query_param': { 'field_name': 'end_user_facing_only', 'style': 'form', 'explode': true } }
|
|
128
|
+
# Not allowed with `view=flat`. Group types to keep, e.g. `sign_in`,
|
|
129
|
+
# repeated for several (`group_type=sign_in&group_type=sign_up`).
|
|
130
|
+
# Drops the logs outside any group.
|
|
131
|
+
field :group_type, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'group_type', 'style': 'form', 'explode': true } }
|
|
132
|
+
# Not allowed with `view=flat`. Group statuses to keep, e.g. `failed`,
|
|
133
|
+
# repeated for several (`status=failed&status=completed`). Keeps only
|
|
134
|
+
# groups that concluded that way and drops the logs outside any
|
|
135
|
+
# group. A status is a conclusion (`completed`, `failed`), so groups
|
|
136
|
+
# that haven't concluded never match.
|
|
137
|
+
field :status, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'status', 'style': 'form', 'explode': true } }
|
|
138
|
+
# Applies a limit to the number of results returned.
|
|
139
|
+
# Can be used for paginating the results together with `starting_after` or `ending_before`.
|
|
140
|
+
# At most 100 in the grouped view (the default), and up to 500 with `view=flat`.
|
|
141
|
+
field :limit, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'limit', 'style': 'form', 'explode': true } }
|
|
142
|
+
# Controls how `subject`, `type`, `actor`, `user_id`, `identifier`,
|
|
143
|
+
# `trace_id`, `client_id`, `session_id`, `impersonator_user_id`,
|
|
144
|
+
# `ip_address`, and `payload_filter` entries
|
|
145
|
+
# are combined: `all` (default) requires every supplied filter to
|
|
146
|
+
# match; `any` returns events that match at least one of the
|
|
147
|
+
# supplied filters. `event_time_after`, `event_time_before`, and
|
|
148
|
+
# `end_user_facing_only` are always ANDed with the (possibly OR-ed)
|
|
149
|
+
# string filter group.
|
|
150
|
+
field :filter_match, Crystalline::Nilable.new(Models::Operations::FilterMatch), { 'query_param': { 'field_name': 'filter_match', 'style': 'form', 'explode': true } }
|
|
151
|
+
# `grouped`, the default, lists each event group (a flow such as a
|
|
152
|
+
# sign-in) as a single item, next to the logs that belong to no
|
|
153
|
+
# group, newest first: a group sorts by when it started, a log by
|
|
154
|
+
# when it happened. Groups and logs are told apart by `object`.
|
|
155
|
+
# `flat` lists every log on its own.
|
|
156
|
+
#
|
|
157
|
+
# Parameters that only work in one view are rejected with a 422
|
|
158
|
+
# rather than ignored:
|
|
159
|
+
# - The grouped view only pages forward: `ending_before` is not
|
|
160
|
+
# allowed, and `starting_after` takes only a cursor from a grouped
|
|
161
|
+
# page.
|
|
162
|
+
# - The flat list takes only flat cursors.
|
|
163
|
+
# - `group_type` and `status` aren't allowed with `view=flat`.
|
|
164
|
+
# - The grouped view takes a `limit` of at most 100, since each group
|
|
165
|
+
# brings its first logs along.
|
|
166
|
+
#
|
|
167
|
+
# In the grouped view, event filters keep the groups with at least
|
|
168
|
+
# one matching log, each group lists only its matching logs, and time
|
|
169
|
+
# filters pick groups by when they started.
|
|
170
|
+
field :view, Crystalline::Nilable.new(Models::Operations::View), { 'query_param': { 'field_name': 'view', 'style': 'form', 'explode': true } }
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
def initialize(starting_after: nil, ending_before: nil, subject: nil, actor: nil, user_id: nil, identifier: nil, trace_id: nil, type: nil, client_id: nil, session_id: nil, impersonator_user_id: nil, ip_address: nil, payload_filter: nil, payload_fields: nil, event_time_after: nil, event_time_before: nil, end_user_facing_only: nil, group_type: nil, status: nil, limit: 10, filter_match: Models::Operations::FilterMatch::ALL, view: Models::Operations::View::GROUPED)
|
|
174
|
+
@starting_after = starting_after
|
|
175
|
+
@ending_before = ending_before
|
|
176
|
+
@subject = subject
|
|
177
|
+
@actor = actor
|
|
178
|
+
@user_id = user_id
|
|
179
|
+
@identifier = identifier
|
|
180
|
+
@trace_id = trace_id
|
|
181
|
+
@type = type
|
|
182
|
+
@client_id = client_id
|
|
183
|
+
@session_id = session_id
|
|
184
|
+
@impersonator_user_id = impersonator_user_id
|
|
185
|
+
@ip_address = ip_address
|
|
186
|
+
@payload_filter = payload_filter
|
|
187
|
+
@payload_fields = payload_fields
|
|
188
|
+
@event_time_after = event_time_after
|
|
189
|
+
@event_time_before = event_time_before
|
|
190
|
+
@end_user_facing_only = end_user_facing_only
|
|
191
|
+
@group_type = group_type
|
|
192
|
+
@status = status
|
|
193
|
+
@limit = limit
|
|
194
|
+
@filter_match = filter_match
|
|
195
|
+
@view = view
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
def ==(other)
|
|
200
|
+
return false unless other.is_a? self.class
|
|
201
|
+
return false unless @starting_after == other.starting_after
|
|
202
|
+
return false unless @ending_before == other.ending_before
|
|
203
|
+
return false unless @subject == other.subject
|
|
204
|
+
return false unless @actor == other.actor
|
|
205
|
+
return false unless @user_id == other.user_id
|
|
206
|
+
return false unless @identifier == other.identifier
|
|
207
|
+
return false unless @trace_id == other.trace_id
|
|
208
|
+
return false unless @type == other.type
|
|
209
|
+
return false unless @client_id == other.client_id
|
|
210
|
+
return false unless @session_id == other.session_id
|
|
211
|
+
return false unless @impersonator_user_id == other.impersonator_user_id
|
|
212
|
+
return false unless @ip_address == other.ip_address
|
|
213
|
+
return false unless @payload_filter == other.payload_filter
|
|
214
|
+
return false unless @payload_fields == other.payload_fields
|
|
215
|
+
return false unless @event_time_after == other.event_time_after
|
|
216
|
+
return false unless @event_time_before == other.event_time_before
|
|
217
|
+
return false unless @end_user_facing_only == other.end_user_facing_only
|
|
218
|
+
return false unless @group_type == other.group_type
|
|
219
|
+
return false unless @status == other.status
|
|
220
|
+
return false unless @limit == other.limit
|
|
221
|
+
return false unless @filter_match == other.filter_match
|
|
222
|
+
return false unless @view == other.view
|
|
223
|
+
true
|
|
224
|
+
end
|
|
225
|
+
end
|
|
226
|
+
end
|
|
227
|
+
end
|
|
228
|
+
end
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# typed: false
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class Clerk::Models::Operations::ListLogsRequest
|
|
6
|
+
extend ::Crystalline::MetadataFields::ClassMethods
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class Clerk::Models::Operations::ListLogsRequest
|
|
11
|
+
def starting_after(); end
|
|
12
|
+
def starting_after=(str_); end
|
|
13
|
+
def ending_before(); end
|
|
14
|
+
def ending_before=(str_); end
|
|
15
|
+
def subject(); end
|
|
16
|
+
def subject=(str_); end
|
|
17
|
+
def actor(); end
|
|
18
|
+
def actor=(str_); end
|
|
19
|
+
def user_id(); end
|
|
20
|
+
def user_id=(str_); end
|
|
21
|
+
def identifier(); end
|
|
22
|
+
def identifier=(str_); end
|
|
23
|
+
def trace_id(); end
|
|
24
|
+
def trace_id=(str_); end
|
|
25
|
+
def type(); end
|
|
26
|
+
def type=(str_); end
|
|
27
|
+
def client_id(); end
|
|
28
|
+
def client_id=(str_); end
|
|
29
|
+
def session_id(); end
|
|
30
|
+
def session_id=(str_); end
|
|
31
|
+
def impersonator_user_id(); end
|
|
32
|
+
def impersonator_user_id=(str_); end
|
|
33
|
+
def ip_address(); end
|
|
34
|
+
def ip_address=(str_); end
|
|
35
|
+
def payload_filter(); end
|
|
36
|
+
def payload_filter=(str_); end
|
|
37
|
+
def payload_fields(); end
|
|
38
|
+
def payload_fields=(str_); end
|
|
39
|
+
def event_time_after(); end
|
|
40
|
+
def event_time_after=(str_); end
|
|
41
|
+
def event_time_before(); end
|
|
42
|
+
def event_time_before=(str_); end
|
|
43
|
+
def end_user_facing_only(); end
|
|
44
|
+
def end_user_facing_only=(str_); end
|
|
45
|
+
def group_type(); end
|
|
46
|
+
def group_type=(str_); end
|
|
47
|
+
def status(); end
|
|
48
|
+
def status=(str_); end
|
|
49
|
+
def limit(); end
|
|
50
|
+
def limit=(str_); end
|
|
51
|
+
def filter_match(); end
|
|
52
|
+
def filter_match=(str_); end
|
|
53
|
+
def view(); end
|
|
54
|
+
def view=(str_); end
|
|
55
|
+
end
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: false
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module Clerk
|
|
8
|
+
module Models
|
|
9
|
+
module Operations
|
|
10
|
+
|
|
11
|
+
class ListLogsResponse
|
|
12
|
+
|
|
13
|
+
include Crystalline::MetadataFields
|
|
14
|
+
|
|
15
|
+
# HTTP response content type for this operation
|
|
16
|
+
field :content_type, ::String
|
|
17
|
+
# HTTP response status code for this operation
|
|
18
|
+
field :status_code, ::Integer
|
|
19
|
+
# Raw HTTP response; suitable for custom response parsing
|
|
20
|
+
field :raw_response, ::Faraday::Response
|
|
21
|
+
# A list of log entries with cursor-based pagination.
|
|
22
|
+
field :log_list, Crystalline::Nilable.new(Models::Components::LogList)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
def initialize(content_type:, status_code:, raw_response:, log_list: nil)
|
|
26
|
+
@content_type = content_type
|
|
27
|
+
@status_code = status_code
|
|
28
|
+
@raw_response = raw_response
|
|
29
|
+
@log_list = log_list
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
def ==(other)
|
|
34
|
+
return false unless other.is_a? self.class
|
|
35
|
+
return false unless @content_type == other.content_type
|
|
36
|
+
return false unless @status_code == other.status_code
|
|
37
|
+
return false unless @raw_response == other.raw_response
|
|
38
|
+
return false unless @log_list == other.log_list
|
|
39
|
+
true
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|