clerk-sdk-ruby 8.0.2 → 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 +2 -0
- metadata +142 -6
|
@@ -0,0 +1,115 @@
|
|
|
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 Components
|
|
10
|
+
# The group's first log, even when event filters left it out of
|
|
11
|
+
# `events`, for showing how the flow started (subject, IP,
|
|
12
|
+
# location).
|
|
13
|
+
class FirstEvent
|
|
14
|
+
|
|
15
|
+
include Crystalline::MetadataFields
|
|
16
|
+
|
|
17
|
+
# String representing the object's type. Always "log".
|
|
18
|
+
field :object, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('object'), required: true } }
|
|
19
|
+
# Unique identifier for the log event.
|
|
20
|
+
field :id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('id'), required: true } }
|
|
21
|
+
# The timestamp when the event occurred (Unix timestamp in milliseconds).
|
|
22
|
+
field :event_time, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('event_time'), required: true } }
|
|
23
|
+
# The actor that performed the action (e.g., user ID).
|
|
24
|
+
field :actor, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('actor'), required: true } }
|
|
25
|
+
# The subject of the event (e.g., user ID, resource ID).
|
|
26
|
+
field :subject, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('subject'), required: true } }
|
|
27
|
+
# The type of the log event.
|
|
28
|
+
field :type, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('type'), required: true } }
|
|
29
|
+
# Trace ID for distributed tracing (32 hex characters).
|
|
30
|
+
field :trace_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('trace_id'), required: true } }
|
|
31
|
+
# Span ID for distributed tracing (16 hex characters).
|
|
32
|
+
field :span_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('span_id'), required: true } }
|
|
33
|
+
# Context information about the environment and device where the event occurred.
|
|
34
|
+
field :event_context, Models::Components::LogContext, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('event_context'), required: true } }
|
|
35
|
+
# The kind of principal the `actor` identifies, classified when the
|
|
36
|
+
# event was recorded: `user` (an end user of your application),
|
|
37
|
+
# `dashboard_user` (a member of your Clerk Dashboard workspace),
|
|
38
|
+
# `instance_key`, `api_key`, `integration`, or `clerk_system`.
|
|
39
|
+
field :actor_type, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('actor_type') } }
|
|
40
|
+
# The source service that generated the event.
|
|
41
|
+
field :source, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('source'), required: true } }
|
|
42
|
+
# Present only when the request selected payload fields via
|
|
43
|
+
# `payload_fields`. Partial by construction: contains just the
|
|
44
|
+
# requested fields, keyed by their dot-paths, with fields absent
|
|
45
|
+
# from this event's payload omitted (an empty object when the
|
|
46
|
+
# event carries none of them). Use the single-event endpoint for
|
|
47
|
+
# the full payload.
|
|
48
|
+
field :payload, Crystalline::Nilable.new(Crystalline::Hash.new(::Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('payload') } }
|
|
49
|
+
# The impersonator that performed the action.
|
|
50
|
+
field :impersonator, Crystalline::Nilable.new(Models::Components::LogGroupImpersonator), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('impersonator') } }
|
|
51
|
+
# The client ID of the request. Set on FAPI requests, unset on BAPI requests.
|
|
52
|
+
field :client_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('client_id') } }
|
|
53
|
+
# The ID of the session the event occurred in, if any.
|
|
54
|
+
field :session_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('session_id') } }
|
|
55
|
+
# Parent span ID for hierarchical tracing.
|
|
56
|
+
field :parent_span_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('parent_span_id') } }
|
|
57
|
+
# The ID of the event group (a flow such as a sign-in) the event
|
|
58
|
+
# belongs to, e.g. a sign-in ID. Null for an event outside any group.
|
|
59
|
+
field :group_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('group_id') } }
|
|
60
|
+
# The kind of event group the event belongs to, e.g. `sign_in`. Null for an event outside any group.
|
|
61
|
+
field :group_type, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('group_type') } }
|
|
62
|
+
# When the event's group started (Unix timestamp in milliseconds). Null for an event outside any group.
|
|
63
|
+
field :group_started_at, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('group_started_at') } }
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
def initialize(object:, id:, event_time:, actor:, subject:, type:, trace_id:, span_id:, event_context:, actor_type: nil, source: nil, payload: nil, impersonator: nil, client_id: nil, session_id: nil, parent_span_id: nil, group_id: nil, group_type: nil, group_started_at: nil)
|
|
67
|
+
@object = object
|
|
68
|
+
@id = id
|
|
69
|
+
@event_time = event_time
|
|
70
|
+
@actor = actor
|
|
71
|
+
@subject = subject
|
|
72
|
+
@type = type
|
|
73
|
+
@trace_id = trace_id
|
|
74
|
+
@span_id = span_id
|
|
75
|
+
@event_context = event_context
|
|
76
|
+
@actor_type = actor_type
|
|
77
|
+
@source = source
|
|
78
|
+
@payload = payload
|
|
79
|
+
@impersonator = impersonator
|
|
80
|
+
@client_id = client_id
|
|
81
|
+
@session_id = session_id
|
|
82
|
+
@parent_span_id = parent_span_id
|
|
83
|
+
@group_id = group_id
|
|
84
|
+
@group_type = group_type
|
|
85
|
+
@group_started_at = group_started_at
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
def ==(other)
|
|
90
|
+
return false unless other.is_a? self.class
|
|
91
|
+
return false unless @object == other.object
|
|
92
|
+
return false unless @id == other.id
|
|
93
|
+
return false unless @event_time == other.event_time
|
|
94
|
+
return false unless @actor == other.actor
|
|
95
|
+
return false unless @subject == other.subject
|
|
96
|
+
return false unless @type == other.type
|
|
97
|
+
return false unless @trace_id == other.trace_id
|
|
98
|
+
return false unless @span_id == other.span_id
|
|
99
|
+
return false unless @event_context == other.event_context
|
|
100
|
+
return false unless @actor_type == other.actor_type
|
|
101
|
+
return false unless @source == other.source
|
|
102
|
+
return false unless @payload == other.payload
|
|
103
|
+
return false unless @impersonator == other.impersonator
|
|
104
|
+
return false unless @client_id == other.client_id
|
|
105
|
+
return false unless @session_id == other.session_id
|
|
106
|
+
return false unless @parent_span_id == other.parent_span_id
|
|
107
|
+
return false unless @group_id == other.group_id
|
|
108
|
+
return false unless @group_type == other.group_type
|
|
109
|
+
return false unless @group_started_at == other.group_started_at
|
|
110
|
+
true
|
|
111
|
+
end
|
|
112
|
+
end
|
|
113
|
+
end
|
|
114
|
+
end
|
|
115
|
+
end
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# typed: false
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class Clerk::Models::Components::FirstEvent
|
|
6
|
+
extend ::Crystalline::MetadataFields::ClassMethods
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class Clerk::Models::Components::FirstEvent
|
|
11
|
+
def object(); end
|
|
12
|
+
def object=(str_); end
|
|
13
|
+
def id(); end
|
|
14
|
+
def id=(str_); end
|
|
15
|
+
def event_time(); end
|
|
16
|
+
def event_time=(str_); end
|
|
17
|
+
def actor(); end
|
|
18
|
+
def actor=(str_); end
|
|
19
|
+
def subject(); end
|
|
20
|
+
def subject=(str_); end
|
|
21
|
+
def type(); end
|
|
22
|
+
def type=(str_); end
|
|
23
|
+
def trace_id(); end
|
|
24
|
+
def trace_id=(str_); end
|
|
25
|
+
def span_id(); end
|
|
26
|
+
def span_id=(str_); end
|
|
27
|
+
def event_context(); end
|
|
28
|
+
def event_context=(str_); end
|
|
29
|
+
def actor_type(); end
|
|
30
|
+
def actor_type=(str_); end
|
|
31
|
+
def source(); end
|
|
32
|
+
def source=(str_); end
|
|
33
|
+
def payload(); end
|
|
34
|
+
def payload=(str_); end
|
|
35
|
+
def impersonator(); end
|
|
36
|
+
def impersonator=(str_); end
|
|
37
|
+
def client_id(); end
|
|
38
|
+
def client_id=(str_); end
|
|
39
|
+
def session_id(); end
|
|
40
|
+
def session_id=(str_); end
|
|
41
|
+
def parent_span_id(); end
|
|
42
|
+
def parent_span_id=(str_); end
|
|
43
|
+
def group_id(); end
|
|
44
|
+
def group_id=(str_); end
|
|
45
|
+
def group_type(); end
|
|
46
|
+
def group_type=(str_); end
|
|
47
|
+
def group_started_at(); end
|
|
48
|
+
def group_started_at=(str_); end
|
|
49
|
+
end
|
|
@@ -26,9 +26,11 @@ module Clerk
|
|
|
26
26
|
field :allowed_origins, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('allowed_origins'), required: true } }
|
|
27
27
|
# The ID of the Clerk workspace that owns the instance's application. It is null when the application has no owner.
|
|
28
28
|
field :workspace_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('workspace_id'), required: true } }
|
|
29
|
+
# The maximum number of users the instance can hold. Creating a user fails with a `user_quota_exceeded` error once the instance's total user count, as returned by `GET /v1/users/count` without filters, reaches this value. It is null when the instance has no user limit.
|
|
30
|
+
field :max_allowed_users, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('max_allowed_users'), required: true } }
|
|
29
31
|
|
|
30
32
|
|
|
31
|
-
def initialize(object:, id:, environment_type:, allowed_subdomains:, subdomain_allowlist_enabled:, allowed_origins: nil, workspace_id: nil)
|
|
33
|
+
def initialize(object:, id:, environment_type:, allowed_subdomains:, subdomain_allowlist_enabled:, allowed_origins: nil, workspace_id: nil, max_allowed_users: nil)
|
|
32
34
|
@object = object
|
|
33
35
|
@id = id
|
|
34
36
|
@environment_type = environment_type
|
|
@@ -36,6 +38,7 @@ module Clerk
|
|
|
36
38
|
@subdomain_allowlist_enabled = subdomain_allowlist_enabled
|
|
37
39
|
@allowed_origins = allowed_origins
|
|
38
40
|
@workspace_id = workspace_id
|
|
41
|
+
@max_allowed_users = max_allowed_users
|
|
39
42
|
end
|
|
40
43
|
|
|
41
44
|
|
|
@@ -48,6 +51,7 @@ module Clerk
|
|
|
48
51
|
return false unless @subdomain_allowlist_enabled == other.subdomain_allowlist_enabled
|
|
49
52
|
return false unless @allowed_origins == other.allowed_origins
|
|
50
53
|
return false unless @workspace_id == other.workspace_id
|
|
54
|
+
return false unless @max_allowed_users == other.max_allowed_users
|
|
51
55
|
true
|
|
52
56
|
end
|
|
53
57
|
end
|
|
@@ -16,7 +16,7 @@ module Clerk
|
|
|
16
16
|
field :object, Models::Components::InstanceProtectObject, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('object'), required: true, 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::InstanceProtectObject, false) } }
|
|
17
17
|
# Whether Protect rules are enforced on this instance. False does not mean the instance is outside Protect — by default it is still evaluated in shadow, where rules are scored and recorded but never block.
|
|
18
18
|
field :rules_enabled, Crystalline::Boolean.new, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('rules_enabled'), required: true } }
|
|
19
|
-
|
|
19
|
+
# Whether Device Intelligence is enabled. Managed automatically or by Clerk support.
|
|
20
20
|
field :specter_enabled, Crystalline::Boolean.new, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('specter_enabled'), required: true } }
|
|
21
21
|
# Whether the instance has opted out of the Protect prerequisite checks, asserting its setup already meets the requirements.
|
|
22
22
|
field :checks_bypassed, Crystalline::Boolean.new, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('checks_bypassed'), required: true } }
|
|
@@ -19,7 +19,7 @@ module Clerk
|
|
|
19
19
|
|
|
20
20
|
field :email_address, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('email_address'), required: true } }
|
|
21
21
|
|
|
22
|
-
field :public_metadata, Crystalline::Hash.new(Symbol, ::Object), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata'), required: true } }
|
|
22
|
+
field :public_metadata, Crystalline::Hash.new(::Symbol, ::Object), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata'), required: true } }
|
|
23
23
|
|
|
24
24
|
field :status, Models::Components::InvitationStatus, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('status'), required: true, 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::InvitationStatus, false) } }
|
|
25
25
|
# Unix timestamp of creation.
|
|
@@ -19,7 +19,7 @@ module Clerk
|
|
|
19
19
|
|
|
20
20
|
field :email_address, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('email_address'), required: true } }
|
|
21
21
|
|
|
22
|
-
field :public_metadata, Crystalline::Hash.new(Symbol, ::Object), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata'), required: true } }
|
|
22
|
+
field :public_metadata, Crystalline::Hash.new(::Symbol, ::Object), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata'), required: true } }
|
|
23
23
|
|
|
24
24
|
field :status, Models::Components::StatusResponse, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('status'), required: true, 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::StatusResponse, false) } }
|
|
25
25
|
# Unix timestamp of creation.
|
|
@@ -47,7 +47,7 @@ module Clerk
|
|
|
47
47
|
@updated_at = updated_at
|
|
48
48
|
@url = url
|
|
49
49
|
unless revoked == true
|
|
50
|
-
raise ArgumentError, 'Invalid value for revoked'
|
|
50
|
+
raise ::ArgumentError, 'Invalid value for revoked'
|
|
51
51
|
end
|
|
52
52
|
@revoked = true
|
|
53
53
|
@expires_at = expires_at
|
|
@@ -7,35 +7,104 @@
|
|
|
7
7
|
module Clerk
|
|
8
8
|
module Models
|
|
9
9
|
module Components
|
|
10
|
-
|
|
10
|
+
# A log entry representing a recorded event.
|
|
11
11
|
class Log
|
|
12
12
|
|
|
13
13
|
include Crystalline::MetadataFields
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
field :
|
|
17
|
-
|
|
18
|
-
field :
|
|
19
|
-
|
|
20
|
-
field :
|
|
21
|
-
|
|
22
|
-
field :
|
|
15
|
+
# String representing the object's type. Always "log".
|
|
16
|
+
field :object, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('object'), required: true } }
|
|
17
|
+
# Unique identifier for the log event.
|
|
18
|
+
field :id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('id'), required: true } }
|
|
19
|
+
# The timestamp when the event occurred (Unix timestamp in milliseconds).
|
|
20
|
+
field :event_time, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('event_time'), required: true } }
|
|
21
|
+
# The actor that performed the action (e.g., user ID).
|
|
22
|
+
field :actor, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('actor'), required: true } }
|
|
23
|
+
# The subject of the event (e.g., user ID, resource ID).
|
|
24
|
+
field :subject, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('subject'), required: true } }
|
|
25
|
+
# The type of the log event.
|
|
26
|
+
field :type, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('type'), required: true } }
|
|
27
|
+
# Trace ID for distributed tracing (32 hex characters).
|
|
28
|
+
field :trace_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('trace_id'), required: true } }
|
|
29
|
+
# Span ID for distributed tracing (16 hex characters).
|
|
30
|
+
field :span_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('span_id'), required: true } }
|
|
31
|
+
# Context information about the environment and device where the event occurred.
|
|
32
|
+
field :event_context, Models::Components::LogContext, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('event_context'), required: true } }
|
|
33
|
+
# The kind of principal the `actor` identifies, classified when the
|
|
34
|
+
# event was recorded: `user` (an end user of your application),
|
|
35
|
+
# `dashboard_user` (a member of your Clerk Dashboard workspace),
|
|
36
|
+
# `instance_key`, `api_key`, `integration`, or `clerk_system`.
|
|
37
|
+
field :actor_type, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('actor_type') } }
|
|
38
|
+
# The source service that generated the event.
|
|
39
|
+
field :source, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('source'), required: true } }
|
|
40
|
+
# Present only when the request selected payload fields via
|
|
41
|
+
# `payload_fields`. Partial by construction: contains just the
|
|
42
|
+
# requested fields, keyed by their dot-paths, with fields absent
|
|
43
|
+
# from this event's payload omitted (an empty object when the
|
|
44
|
+
# event carries none of them). Use the single-event endpoint for
|
|
45
|
+
# the full payload.
|
|
46
|
+
field :payload, Crystalline::Nilable.new(Crystalline::Hash.new(::Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('payload') } }
|
|
47
|
+
# The impersonator that performed the action.
|
|
48
|
+
field :impersonator, Crystalline::Nilable.new(Models::Components::LogImpersonator), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('impersonator') } }
|
|
49
|
+
# The client ID of the request. Set on FAPI requests, unset on BAPI requests.
|
|
50
|
+
field :client_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('client_id') } }
|
|
51
|
+
# The ID of the session the event occurred in, if any.
|
|
52
|
+
field :session_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('session_id') } }
|
|
53
|
+
# Parent span ID for hierarchical tracing.
|
|
54
|
+
field :parent_span_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('parent_span_id') } }
|
|
55
|
+
# The ID of the event group (a flow such as a sign-in) the event
|
|
56
|
+
# belongs to, e.g. a sign-in ID. Null for an event outside any group.
|
|
57
|
+
field :group_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('group_id') } }
|
|
58
|
+
# The kind of event group the event belongs to, e.g. `sign_in`. Null for an event outside any group.
|
|
59
|
+
field :group_type, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('group_type') } }
|
|
60
|
+
# When the event's group started (Unix timestamp in milliseconds). Null for an event outside any group.
|
|
61
|
+
field :group_started_at, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('group_started_at') } }
|
|
23
62
|
|
|
24
63
|
|
|
25
|
-
def initialize(
|
|
26
|
-
@
|
|
27
|
-
@
|
|
28
|
-
@
|
|
29
|
-
@
|
|
64
|
+
def initialize(object:, id:, event_time:, actor:, subject:, type:, trace_id:, span_id:, event_context:, actor_type: nil, source: nil, payload: nil, impersonator: nil, client_id: nil, session_id: nil, parent_span_id: nil, group_id: nil, group_type: nil, group_started_at: nil)
|
|
65
|
+
@object = object
|
|
66
|
+
@id = id
|
|
67
|
+
@event_time = event_time
|
|
68
|
+
@actor = actor
|
|
69
|
+
@subject = subject
|
|
70
|
+
@type = type
|
|
71
|
+
@trace_id = trace_id
|
|
72
|
+
@span_id = span_id
|
|
73
|
+
@event_context = event_context
|
|
74
|
+
@actor_type = actor_type
|
|
75
|
+
@source = source
|
|
76
|
+
@payload = payload
|
|
77
|
+
@impersonator = impersonator
|
|
78
|
+
@client_id = client_id
|
|
79
|
+
@session_id = session_id
|
|
80
|
+
@parent_span_id = parent_span_id
|
|
81
|
+
@group_id = group_id
|
|
82
|
+
@group_type = group_type
|
|
83
|
+
@group_started_at = group_started_at
|
|
30
84
|
end
|
|
31
85
|
|
|
32
86
|
|
|
33
87
|
def ==(other)
|
|
34
88
|
return false unless other.is_a? self.class
|
|
35
|
-
return false unless @
|
|
36
|
-
return false unless @
|
|
37
|
-
return false unless @
|
|
38
|
-
return false unless @
|
|
89
|
+
return false unless @object == other.object
|
|
90
|
+
return false unless @id == other.id
|
|
91
|
+
return false unless @event_time == other.event_time
|
|
92
|
+
return false unless @actor == other.actor
|
|
93
|
+
return false unless @subject == other.subject
|
|
94
|
+
return false unless @type == other.type
|
|
95
|
+
return false unless @trace_id == other.trace_id
|
|
96
|
+
return false unless @span_id == other.span_id
|
|
97
|
+
return false unless @event_context == other.event_context
|
|
98
|
+
return false unless @actor_type == other.actor_type
|
|
99
|
+
return false unless @source == other.source
|
|
100
|
+
return false unless @payload == other.payload
|
|
101
|
+
return false unless @impersonator == other.impersonator
|
|
102
|
+
return false unless @client_id == other.client_id
|
|
103
|
+
return false unless @session_id == other.session_id
|
|
104
|
+
return false unless @parent_span_id == other.parent_span_id
|
|
105
|
+
return false unless @group_id == other.group_id
|
|
106
|
+
return false unless @group_type == other.group_type
|
|
107
|
+
return false unless @group_started_at == other.group_started_at
|
|
39
108
|
true
|
|
40
109
|
end
|
|
41
110
|
end
|
|
@@ -8,12 +8,42 @@ end
|
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
class Clerk::Models::Components::Log
|
|
11
|
-
def
|
|
12
|
-
def
|
|
13
|
-
def
|
|
14
|
-
def
|
|
15
|
-
def
|
|
16
|
-
def
|
|
17
|
-
def
|
|
18
|
-
def
|
|
11
|
+
def object(); end
|
|
12
|
+
def object=(str_); end
|
|
13
|
+
def id(); end
|
|
14
|
+
def id=(str_); end
|
|
15
|
+
def event_time(); end
|
|
16
|
+
def event_time=(str_); end
|
|
17
|
+
def actor(); end
|
|
18
|
+
def actor=(str_); end
|
|
19
|
+
def subject(); end
|
|
20
|
+
def subject=(str_); end
|
|
21
|
+
def type(); end
|
|
22
|
+
def type=(str_); end
|
|
23
|
+
def trace_id(); end
|
|
24
|
+
def trace_id=(str_); end
|
|
25
|
+
def span_id(); end
|
|
26
|
+
def span_id=(str_); end
|
|
27
|
+
def event_context(); end
|
|
28
|
+
def event_context=(str_); end
|
|
29
|
+
def actor_type(); end
|
|
30
|
+
def actor_type=(str_); end
|
|
31
|
+
def source(); end
|
|
32
|
+
def source=(str_); end
|
|
33
|
+
def payload(); end
|
|
34
|
+
def payload=(str_); end
|
|
35
|
+
def impersonator(); end
|
|
36
|
+
def impersonator=(str_); end
|
|
37
|
+
def client_id(); end
|
|
38
|
+
def client_id=(str_); end
|
|
39
|
+
def session_id(); end
|
|
40
|
+
def session_id=(str_); end
|
|
41
|
+
def parent_span_id(); end
|
|
42
|
+
def parent_span_id=(str_); end
|
|
43
|
+
def group_id(); end
|
|
44
|
+
def group_id=(str_); end
|
|
45
|
+
def group_type(); end
|
|
46
|
+
def group_type=(str_); end
|
|
47
|
+
def group_started_at(); end
|
|
48
|
+
def group_started_at=(str_); end
|
|
19
49
|
end
|
|
@@ -0,0 +1,32 @@
|
|
|
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 Components
|
|
10
|
+
# The impersonator that performed the action.
|
|
11
|
+
class LogImpersonator
|
|
12
|
+
|
|
13
|
+
include Crystalline::MetadataFields
|
|
14
|
+
|
|
15
|
+
# The user ID of the impersonator.
|
|
16
|
+
field :user_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('user_id') } }
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
def initialize(user_id: nil)
|
|
20
|
+
@user_id = user_id
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
def ==(other)
|
|
25
|
+
return false unless other.is_a? self.class
|
|
26
|
+
return false unless @user_id == other.user_id
|
|
27
|
+
true
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# typed: false
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class Clerk::Models::Components::LogImpersonator
|
|
6
|
+
extend ::Crystalline::MetadataFields::ClassMethods
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class Clerk::Models::Components::LogImpersonator
|
|
11
|
+
def user_id(); end
|
|
12
|
+
def user_id=(str_); end
|
|
13
|
+
end
|
|
@@ -0,0 +1,39 @@
|
|
|
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 Components
|
|
10
|
+
# A list of log entries with cursor-based pagination.
|
|
11
|
+
class LogList
|
|
12
|
+
|
|
13
|
+
include Crystalline::MetadataFields
|
|
14
|
+
|
|
15
|
+
# The log entries. In the grouped view (the default), each
|
|
16
|
+
# item is either an event group or a log entry outside any
|
|
17
|
+
# group, told apart by `object`. With `view=flat`, every item
|
|
18
|
+
# is a log entry.
|
|
19
|
+
field :data, Crystalline::Array.new(Crystalline::Union.new(Models::Components::Log, Models::Components::LogGroup)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('data'), required: true } }
|
|
20
|
+
# Cursor information for pagination.
|
|
21
|
+
field :cursor, Crystalline::Nilable.new(Models::Components::LogListCursor), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('cursor') } }
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
def initialize(data:, cursor: nil)
|
|
25
|
+
@data = data
|
|
26
|
+
@cursor = cursor
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
def ==(other)
|
|
31
|
+
return false unless other.is_a? self.class
|
|
32
|
+
return false unless @data == other.data
|
|
33
|
+
return false unless @cursor == other.cursor
|
|
34
|
+
true
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# typed: false
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class Clerk::Models::Components::LogList
|
|
6
|
+
extend ::Crystalline::MetadataFields::ClassMethods
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class Clerk::Models::Components::LogList
|
|
11
|
+
def data(); end
|
|
12
|
+
def data=(str_); end
|
|
13
|
+
def cursor(); end
|
|
14
|
+
def cursor=(str_); end
|
|
15
|
+
end
|
|
@@ -0,0 +1,72 @@
|
|
|
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 Components
|
|
10
|
+
# Cursor information for pagination.
|
|
11
|
+
class LogListCursor
|
|
12
|
+
|
|
13
|
+
include Crystalline::MetadataFields
|
|
14
|
+
|
|
15
|
+
# Deprecated: use next_page_status instead. If true, more results may be fetched using the starting_after cursor. True when next_page_status is "true", or when it is "unknown" and the page returned data.
|
|
16
|
+
field :has_next_page, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('has_next_page') } }
|
|
17
|
+
# Pagination status. "true" means more results exist, "false" means no more results, "unknown" means the query was time-windowed and more results may exist beyond the window.
|
|
18
|
+
field :next_page_status, Crystalline::Nilable.new(Models::Components::NextPageStatus), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('next_page_status'), 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::NextPageStatus, true) } }
|
|
19
|
+
# When true, next_page_status is "false" because event_time_after was clamped to the plan's retention floor. Extending event_time_after further back will not yield additional results.
|
|
20
|
+
field :retention_limit_reached, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('retention_limit_reached') } }
|
|
21
|
+
# The plan's log retention window, in days. Events older than this are not kept and cannot be returned at any page size.
|
|
22
|
+
field :retention_days, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('retention_days') } }
|
|
23
|
+
# The oldest timestamp this plan can return, in Unix milliseconds: `retention_days` before the time the request was served. `searched_from` is never earlier than this, whatever `event_time_after` asked for.
|
|
24
|
+
#
|
|
25
|
+
# Compare your own `event_time_after` against it to tell whether part of the range you asked for is unavailable.
|
|
26
|
+
field :retention_floor, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('retention_floor') } }
|
|
27
|
+
# Lower bound of the time range this page was actually read from, in Unix milliseconds.
|
|
28
|
+
#
|
|
29
|
+
# A request is not served by scanning the whole range you ask for. The endpoint picks a sub-window of it per request and pages through your range one sub-window at a time, which is why `next_page_status` can be `"unknown"` on a page that looks short. `searched_from` and `searched_to` are that sub-window, so you can tell where in your requested range a page sits without decoding the cursor.
|
|
30
|
+
#
|
|
31
|
+
# Never earlier than `event_time_after`, or than the plan's retention floor when that is later.
|
|
32
|
+
field :searched_from, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('searched_from') } }
|
|
33
|
+
# Upper bound of the time range this page was actually read from, in Unix milliseconds. See `searched_from`.
|
|
34
|
+
#
|
|
35
|
+
# On a first page with no `event_time_before`, this sits a few minutes ahead of the current time on purpose: events can arrive with timestamps marginally ahead of the service clock, and this is the bound the query ran with.
|
|
36
|
+
field :searched_to, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('searched_to') } }
|
|
37
|
+
# Cursor to fetch the next page of results.
|
|
38
|
+
field :starting_after, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('starting_after') } }
|
|
39
|
+
# Cursor to fetch the previous page of results.
|
|
40
|
+
field :ending_before, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('ending_before') } }
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
def initialize(has_next_page: nil, next_page_status: nil, retention_limit_reached: nil, retention_days: nil, retention_floor: nil, searched_from: nil, searched_to: nil, starting_after: nil, ending_before: nil)
|
|
44
|
+
@has_next_page = has_next_page
|
|
45
|
+
@next_page_status = next_page_status
|
|
46
|
+
@retention_limit_reached = retention_limit_reached
|
|
47
|
+
@retention_days = retention_days
|
|
48
|
+
@retention_floor = retention_floor
|
|
49
|
+
@searched_from = searched_from
|
|
50
|
+
@searched_to = searched_to
|
|
51
|
+
@starting_after = starting_after
|
|
52
|
+
@ending_before = ending_before
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
def ==(other)
|
|
57
|
+
return false unless other.is_a? self.class
|
|
58
|
+
return false unless @has_next_page == other.has_next_page
|
|
59
|
+
return false unless @next_page_status == other.next_page_status
|
|
60
|
+
return false unless @retention_limit_reached == other.retention_limit_reached
|
|
61
|
+
return false unless @retention_days == other.retention_days
|
|
62
|
+
return false unless @retention_floor == other.retention_floor
|
|
63
|
+
return false unless @searched_from == other.searched_from
|
|
64
|
+
return false unless @searched_to == other.searched_to
|
|
65
|
+
return false unless @starting_after == other.starting_after
|
|
66
|
+
return false unless @ending_before == other.ending_before
|
|
67
|
+
true
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
end
|
|
71
|
+
end
|
|
72
|
+
end
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# typed: false
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class Clerk::Models::Components::LogListCursor
|
|
6
|
+
extend ::Crystalline::MetadataFields::ClassMethods
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class Clerk::Models::Components::LogListCursor
|
|
11
|
+
def has_next_page(); end
|
|
12
|
+
def has_next_page=(str_); end
|
|
13
|
+
def next_page_status(); end
|
|
14
|
+
def next_page_status=(str_); end
|
|
15
|
+
def retention_limit_reached(); end
|
|
16
|
+
def retention_limit_reached=(str_); end
|
|
17
|
+
def retention_days(); end
|
|
18
|
+
def retention_days=(str_); end
|
|
19
|
+
def retention_floor(); end
|
|
20
|
+
def retention_floor=(str_); end
|
|
21
|
+
def searched_from(); end
|
|
22
|
+
def searched_from=(str_); end
|
|
23
|
+
def searched_to(); end
|
|
24
|
+
def searched_to=(str_); end
|
|
25
|
+
def starting_after(); end
|
|
26
|
+
def starting_after=(str_); end
|
|
27
|
+
def ending_before(); end
|
|
28
|
+
def ending_before=(str_); end
|
|
29
|
+
end
|