Module: TurnkeyClient

Defined in:
lib/turnkey_client/version.rb,
lib/turnkey_client.rb,
lib/turnkey_client/api_error.rb,
lib/turnkey_client/api_client.rb,
lib/turnkey_client/models/user.rb,
lib/turnkey_client/models/vote.rb,
lib/turnkey_client/models/curve.rb,
lib/turnkey_client/api/users_api.rb,
lib/turnkey_client/configuration.rb,
lib/turnkey_client/models/effect.rb,
lib/turnkey_client/models/intent.rb,
lib/turnkey_client/models/policy.rb,
lib/turnkey_client/models/result.rb,
lib/turnkey_client/models/v1_tag.rb,
lib/turnkey_client/models/wallet.rb,
lib/turnkey_client/models/api_key.rb,
lib/turnkey_client/models/feature.rb,
lib/turnkey_client/api/signing_api.rb,
lib/turnkey_client/api/wallets_api.rb,
lib/turnkey_client/models/activity.rb,
lib/turnkey_client/models/operator.rb,
lib/turnkey_client/models/selector.rb,
lib/turnkey_client/models/tag_type.rb,
lib/turnkey_client/api/api_keys_api.rb,
lib/turnkey_client/api/features_api.rb,
lib/turnkey_client/api/policies_api.rb,
lib/turnkey_client/api/sessions_api.rb,
lib/turnkey_client/api/consensus_api.rb,
lib/turnkey_client/api/user_auth_api.rb,
lib/turnkey_client/api/user_tags_api.rb,
lib/turnkey_client/models/pagination.rb,
lib/turnkey_client/api/activities_api.rb,
lib/turnkey_client/models/access_type.rb,
lib/turnkey_client/models/attestation.rb,
lib/turnkey_client/models/path_format.rb,
lib/turnkey_client/models/private_key.rb,
lib/turnkey_client/models/selector_v2.rb,
lib/turnkey_client/models/user_params.rb,
lib/turnkey_client/api/invitations_api.rb,
lib/turnkey_client/models/feature_name.rb,
lib/turnkey_client/api/private_keys_api.rb,
lib/turnkey_client/models/activity_type.rb,
lib/turnkey_client/models/authenticator.rb,
lib/turnkey_client/models/hash_function.rb,
lib/turnkey_client/models/wallet_params.rb,
lib/turnkey_client/models/wallet_result.rb,
lib/turnkey_client/api/organizations_api.rb,
lib/turnkey_client/api/user_recovery_api.rb,
lib/turnkey_client/models/address_format.rb,
lib/turnkey_client/models/api_key_params.rb,
lib/turnkey_client/models/user_params_v2.rb,
lib/turnkey_client/models/wallet_account.rb,
lib/turnkey_client/api/authenticators_api.rb,
lib/turnkey_client/models/activity_status.rb,
lib/turnkey_client/models/credential_type.rb,
lib/turnkey_client/models/data_v1_address.rb,
lib/turnkey_client/models/get_user_request.rb,
lib/turnkey_client/models/payload_encoding.rb,
lib/turnkey_client/models/root_user_params.rb,
lib/turnkey_client/models/transaction_type.rb,
lib/turnkey_client/api/private_key_tags_api.rb,
lib/turnkey_client/models/activity_response.rb,
lib/turnkey_client/models/email_auth_intent.rb,
lib/turnkey_client/models/email_auth_result.rb,
lib/turnkey_client/models/get_user_response.rb,
lib/turnkey_client/models/get_users_request.rb,
lib/turnkey_client/models/invitation_params.rb,
lib/turnkey_client/models/mnemonic_language.rb,
lib/turnkey_client/models/email_auth_request.rb,
lib/turnkey_client/models/get_policy_request.rb,
lib/turnkey_client/models/get_users_response.rb,
lib/turnkey_client/models/get_wallet_request.rb,
lib/turnkey_client/models/get_whoami_request.rb,
lib/turnkey_client/models/private_key_params.rb,
lib/turnkey_client/models/private_key_result.rb,
lib/turnkey_client/models/update_user_intent.rb,
lib/turnkey_client/models/update_user_result.rb,
lib/turnkey_client/models/activity_v1_address.rb,
lib/turnkey_client/models/create_users_intent.rb,
lib/turnkey_client/models/create_users_result.rb,
lib/turnkey_client/models/delete_users_intent.rb,
lib/turnkey_client/models/delete_users_result.rb,
lib/turnkey_client/models/get_api_key_request.rb,
lib/turnkey_client/models/get_policy_response.rb,
lib/turnkey_client/models/get_wallet_response.rb,
lib/turnkey_client/models/get_wallets_request.rb,
lib/turnkey_client/models/get_whoami_response.rb,
lib/turnkey_client/models/recover_user_intent.rb,
lib/turnkey_client/models/recover_user_result.rb,
lib/turnkey_client/models/update_user_request.rb,
lib/turnkey_client/models/api_only_user_params.rb,
lib/turnkey_client/models/authenticator_params.rb,
lib/turnkey_client/models/create_policy_intent.rb,
lib/turnkey_client/models/create_policy_result.rb,
lib/turnkey_client/models/create_users_request.rb,
lib/turnkey_client/models/create_wallet_intent.rb,
lib/turnkey_client/models/create_wallet_result.rb,
lib/turnkey_client/models/delete_policy_intent.rb,
lib/turnkey_client/models/delete_policy_result.rb,
lib/turnkey_client/models/delete_users_request.rb,
lib/turnkey_client/models/export_wallet_intent.rb,
lib/turnkey_client/models/export_wallet_result.rb,
lib/turnkey_client/models/get_activity_request.rb,
lib/turnkey_client/models/get_api_key_response.rb,
lib/turnkey_client/models/get_api_keys_request.rb,
lib/turnkey_client/models/get_policies_request.rb,
lib/turnkey_client/models/get_wallets_response.rb,
lib/turnkey_client/models/import_wallet_intent.rb,
lib/turnkey_client/models/import_wallet_result.rb,
lib/turnkey_client/models/recover_user_request.rb,
lib/turnkey_client/models/update_policy_intent.rb,
lib/turnkey_client/models/update_policy_result.rb,
lib/turnkey_client/models/create_policy_request.rb,
lib/turnkey_client/models/create_wallet_request.rb,
lib/turnkey_client/models/delete_policy_request.rb,
lib/turnkey_client/models/export_wallet_request.rb,
lib/turnkey_client/models/get_api_keys_response.rb,
lib/turnkey_client/models/get_policies_response.rb,
lib/turnkey_client/models/import_wallet_request.rb,
lib/turnkey_client/models/update_policy_request.rb,
lib/turnkey_client/models/wallet_account_params.rb,
lib/turnkey_client/models/create_api_keys_intent.rb,
lib/turnkey_client/models/create_api_keys_result.rb,
lib/turnkey_client/models/create_user_tag_intent.rb,
lib/turnkey_client/models/create_user_tag_result.rb,
lib/turnkey_client/models/create_users_intent_v2.rb,
lib/turnkey_client/models/delete_api_keys_intent.rb,
lib/turnkey_client/models/delete_api_keys_result.rb,
lib/turnkey_client/models/get_activities_request.rb,
lib/turnkey_client/models/list_user_tags_request.rb,
lib/turnkey_client/models/reject_activity_intent.rb,
lib/turnkey_client/models/update_user_tag_intent.rb,
lib/turnkey_client/models/update_user_tag_result.rb,
lib/turnkey_client/models/approve_activity_intent.rb,
lib/turnkey_client/models/authenticator_params_v2.rb,
lib/turnkey_client/models/authenticator_transport.rb,
lib/turnkey_client/models/create_api_keys_request.rb,
lib/turnkey_client/models/create_policy_intent_v2.rb,
lib/turnkey_client/models/create_policy_intent_v3.rb,
lib/turnkey_client/models/create_user_tag_request.rb,
lib/turnkey_client/models/delete_api_keys_request.rb,
lib/turnkey_client/models/delete_user_tags_intent.rb,
lib/turnkey_client/models/delete_user_tags_result.rb,
lib/turnkey_client/models/get_activities_response.rb,
lib/turnkey_client/models/get_private_key_request.rb,
lib/turnkey_client/models/get_sub_org_ids_request.rb,
lib/turnkey_client/models/list_user_tags_response.rb,
lib/turnkey_client/models/reject_activity_request.rb,
lib/turnkey_client/models/sign_raw_payload_intent.rb,
lib/turnkey_client/models/sign_raw_payload_result.rb,
lib/turnkey_client/models/sign_transaction_intent.rb,
lib/turnkey_client/models/sign_transaction_result.rb,
lib/turnkey_client/models/update_user_tag_request.rb,
lib/turnkey_client/models/accept_invitation_intent.rb,
lib/turnkey_client/models/accept_invitation_result.rb,
lib/turnkey_client/models/approve_activity_request.rb,
lib/turnkey_client/models/delete_invitation_intent.rb,
lib/turnkey_client/models/delete_invitation_result.rb,
lib/turnkey_client/models/delete_user_tags_request.rb,
lib/turnkey_client/models/get_private_key_response.rb,
lib/turnkey_client/models/get_private_keys_request.rb,
lib/turnkey_client/models/get_sub_org_ids_response.rb,
lib/turnkey_client/models/sign_raw_payload_request.rb,
lib/turnkey_client/models/sign_transaction_request.rb,
lib/turnkey_client/models/create_invitations_intent.rb,
lib/turnkey_client/models/create_invitations_result.rb,
lib/turnkey_client/models/delete_invitation_request.rb,
lib/turnkey_client/models/export_private_key_intent.rb,
lib/turnkey_client/models/export_private_key_result.rb,
lib/turnkey_client/models/get_authenticator_request.rb,
lib/turnkey_client/models/get_private_keys_response.rb,
lib/turnkey_client/models/import_private_key_intent.rb,
lib/turnkey_client/models/import_private_key_result.rb,
lib/turnkey_client/models/init_import_wallet_intent.rb,
lib/turnkey_client/models/init_import_wallet_result.rb,
lib/turnkey_client/models/set_payment_method_intent.rb,
lib/turnkey_client/models/set_payment_method_result.rb,
lib/turnkey_client/models/update_root_quorum_intent.rb,
lib/turnkey_client/models/update_root_quorum_result.rb,
lib/turnkey_client/models/create_invitations_request.rb,
lib/turnkey_client/models/create_organization_intent.rb,
lib/turnkey_client/models/create_organization_result.rb,
lib/turnkey_client/models/create_private_keys_intent.rb,
lib/turnkey_client/models/create_private_keys_result.rb,
lib/turnkey_client/models/delete_organization_intent.rb,
lib/turnkey_client/models/delete_organization_result.rb,
lib/turnkey_client/models/disable_private_key_intent.rb,
lib/turnkey_client/models/disable_private_key_result.rb,
lib/turnkey_client/models/email_customization_params.rb,
lib/turnkey_client/models/export_private_key_request.rb,
lib/turnkey_client/models/external_data_v1_timestamp.rb,
lib/turnkey_client/models/get_authenticator_response.rb,
lib/turnkey_client/models/get_authenticators_request.rb,
lib/turnkey_client/models/import_private_key_request.rb,
lib/turnkey_client/models/init_import_wallet_request.rb,
lib/turnkey_client/models/sign_raw_payload_intent_v2.rb,
lib/turnkey_client/models/sign_transaction_intent_v2.rb,
lib/turnkey_client/models/update_root_quorum_request.rb,
lib/turnkey_client/models/accept_invitation_intent_v2.rb,
lib/turnkey_client/models/create_private_keys_request.rb,
lib/turnkey_client/models/external_data_v1_credential.rb,
lib/turnkey_client/models/get_authenticators_response.rb,
lib/turnkey_client/models/get_wallet_accounts_request.rb,
lib/turnkey_client/models/activate_billing_tier_intent.rb,
lib/turnkey_client/models/activate_billing_tier_result.rb,
lib/turnkey_client/models/create_api_only_users_intent.rb,
lib/turnkey_client/models/create_api_only_users_result.rb,
lib/turnkey_client/models/create_authenticators_intent.rb,
lib/turnkey_client/models/create_authenticators_result.rb,
lib/turnkey_client/models/delete_authenticators_intent.rb,
lib/turnkey_client/models/delete_authenticators_result.rb,
lib/turnkey_client/models/delete_payment_method_intent.rb,
lib/turnkey_client/models/delete_payment_method_result.rb,
lib/turnkey_client/models/export_wallet_account_intent.rb,
lib/turnkey_client/models/export_wallet_account_result.rb,
lib/turnkey_client/models/get_wallet_accounts_response.rb,
lib/turnkey_client/models/set_payment_method_intent_v2.rb,
lib/turnkey_client/models/create_authenticators_request.rb,
lib/turnkey_client/models/create_organization_intent_v2.rb,
lib/turnkey_client/models/create_private_key_tag_intent.rb,
lib/turnkey_client/models/create_private_key_tag_result.rb,
lib/turnkey_client/models/create_private_keys_intent_v2.rb,
lib/turnkey_client/models/create_private_keys_result_v2.rb,
lib/turnkey_client/models/create_wallet_accounts_intent.rb,
lib/turnkey_client/models/create_wallet_accounts_result.rb,
lib/turnkey_client/models/delete_authenticators_request.rb,
lib/turnkey_client/models/export_wallet_account_request.rb,
lib/turnkey_client/models/list_private_key_tags_request.rb,
lib/turnkey_client/models/update_allowed_origins_intent.rb,
lib/turnkey_client/models/update_allowed_origins_result.rb,
lib/turnkey_client/models/update_private_key_tag_intent.rb,
lib/turnkey_client/models/update_private_key_tag_result.rb,
lib/turnkey_client/models/create_private_key_tag_request.rb,
lib/turnkey_client/models/create_sub_organization_intent.rb,
lib/turnkey_client/models/create_sub_organization_result.rb,
lib/turnkey_client/models/create_wallet_accounts_request.rb,
lib/turnkey_client/models/delete_private_key_tags_intent.rb,
lib/turnkey_client/models/delete_private_key_tags_result.rb,
lib/turnkey_client/models/init_import_private_key_intent.rb,
lib/turnkey_client/models/init_import_private_key_result.rb,
lib/turnkey_client/models/list_private_key_tags_response.rb,
lib/turnkey_client/models/update_private_key_tag_request.rb,
lib/turnkey_client/models/create_authenticators_intent_v2.rb,
lib/turnkey_client/models/create_sub_organization_request.rb,
lib/turnkey_client/models/delete_private_key_tags_request.rb,
lib/turnkey_client/models/init_import_private_key_request.rb,
lib/turnkey_client/models/init_user_email_recovery_intent.rb,
lib/turnkey_client/models/init_user_email_recovery_result.rb,
lib/turnkey_client/models/set_organization_feature_intent.rb,
lib/turnkey_client/models/set_organization_feature_result.rb,
lib/turnkey_client/models/simple_client_extension_results.rb,
lib/turnkey_client/models/init_user_email_recovery_request.rb,
lib/turnkey_client/models/set_organization_feature_request.rb,
lib/turnkey_client/models/create_sub_organization_intent_v2.rb,
lib/turnkey_client/models/create_sub_organization_intent_v3.rb,
lib/turnkey_client/models/create_sub_organization_intent_v4.rb,
lib/turnkey_client/models/create_sub_organization_result_v3.rb,
lib/turnkey_client/models/create_sub_organization_result_v4.rb,
lib/turnkey_client/models/authenticator_attestation_response.rb,
lib/turnkey_client/models/remove_organization_feature_intent.rb,
lib/turnkey_client/models/remove_organization_feature_result.rb,
lib/turnkey_client/models/remove_organization_feature_request.rb,
lib/turnkey_client/models/public_key_credential_with_attestation.rb,
lib/turnkey_client/models/cred_props_authentication_extensions_client_outputs.rb

Overview

#API Reference

#Review our [API Introduction](../api-introduction) to get started.

OpenAPI spec version: 1.0

Generated by: github.com/swagger-api/swagger-codegen.git

Defined Under Namespace

Classes: APIKeysApi, AcceptInvitationIntent, AcceptInvitationIntentV2, AcceptInvitationResult, AccessType, ActivateBillingTierIntent, ActivateBillingTierResult, ActivitiesApi, Activity, ActivityResponse, ActivityStatus, ActivityType, ActivityV1Address, AddressFormat, ApiClient, ApiError, ApiKey, ApiKeyParams, ApiOnlyUserParams, ApproveActivityIntent, ApproveActivityRequest, Attestation, Authenticator, AuthenticatorAttestationResponse, AuthenticatorParams, AuthenticatorParamsV2, AuthenticatorTransport, AuthenticatorsApi, Configuration, ConsensusApi, CreateApiKeysIntent, CreateApiKeysRequest, CreateApiKeysResult, CreateApiOnlyUsersIntent, CreateApiOnlyUsersResult, CreateAuthenticatorsIntent, CreateAuthenticatorsIntentV2, CreateAuthenticatorsRequest, CreateAuthenticatorsResult, CreateInvitationsIntent, CreateInvitationsRequest, CreateInvitationsResult, CreateOrganizationIntent, CreateOrganizationIntentV2, CreateOrganizationResult, CreatePolicyIntent, CreatePolicyIntentV2, CreatePolicyIntentV3, CreatePolicyRequest, CreatePolicyResult, CreatePrivateKeyTagIntent, CreatePrivateKeyTagRequest, CreatePrivateKeyTagResult, CreatePrivateKeysIntent, CreatePrivateKeysIntentV2, CreatePrivateKeysRequest, CreatePrivateKeysResult, CreatePrivateKeysResultV2, CreateSubOrganizationIntent, CreateSubOrganizationIntentV2, CreateSubOrganizationIntentV3, CreateSubOrganizationIntentV4, CreateSubOrganizationRequest, CreateSubOrganizationResult, CreateSubOrganizationResultV3, CreateSubOrganizationResultV4, CreateUserTagIntent, CreateUserTagRequest, CreateUserTagResult, CreateUsersIntent, CreateUsersIntentV2, CreateUsersRequest, CreateUsersResult, CreateWalletAccountsIntent, CreateWalletAccountsRequest, CreateWalletAccountsResult, CreateWalletIntent, CreateWalletRequest, CreateWalletResult, CredPropsAuthenticationExtensionsClientOutputs, CredentialType, Curve, DataV1Address, DeleteApiKeysIntent, DeleteApiKeysRequest, DeleteApiKeysResult, DeleteAuthenticatorsIntent, DeleteAuthenticatorsRequest, DeleteAuthenticatorsResult, DeleteInvitationIntent, DeleteInvitationRequest, DeleteInvitationResult, DeleteOrganizationIntent, DeleteOrganizationResult, DeletePaymentMethodIntent, DeletePaymentMethodResult, DeletePolicyIntent, DeletePolicyRequest, DeletePolicyResult, DeletePrivateKeyTagsIntent, DeletePrivateKeyTagsRequest, DeletePrivateKeyTagsResult, DeleteUserTagsIntent, DeleteUserTagsRequest, DeleteUserTagsResult, DeleteUsersIntent, DeleteUsersRequest, DeleteUsersResult, DisablePrivateKeyIntent, DisablePrivateKeyResult, Effect, EmailAuthIntent, EmailAuthRequest, EmailAuthResult, EmailCustomizationParams, ExportPrivateKeyIntent, ExportPrivateKeyRequest, ExportPrivateKeyResult, ExportWalletAccountIntent, ExportWalletAccountRequest, ExportWalletAccountResult, ExportWalletIntent, ExportWalletRequest, ExportWalletResult, ExternalDataV1Credential, ExternalDataV1Timestamp, Feature, FeatureName, FeaturesApi, GetActivitiesRequest, GetActivitiesResponse, GetActivityRequest, GetApiKeyRequest, GetApiKeyResponse, GetApiKeysRequest, GetApiKeysResponse, GetAuthenticatorRequest, GetAuthenticatorResponse, GetAuthenticatorsRequest, GetAuthenticatorsResponse, GetPoliciesRequest, GetPoliciesResponse, GetPolicyRequest, GetPolicyResponse, GetPrivateKeyRequest, GetPrivateKeyResponse, GetPrivateKeysRequest, GetPrivateKeysResponse, GetSubOrgIdsRequest, GetSubOrgIdsResponse, GetUserRequest, GetUserResponse, GetUsersRequest, GetUsersResponse, GetWalletAccountsRequest, GetWalletAccountsResponse, GetWalletRequest, GetWalletResponse, GetWalletsRequest, GetWalletsResponse, GetWhoamiRequest, GetWhoamiResponse, HashFunction, ImportPrivateKeyIntent, ImportPrivateKeyRequest, ImportPrivateKeyResult, ImportWalletIntent, ImportWalletRequest, ImportWalletResult, InitImportPrivateKeyIntent, InitImportPrivateKeyRequest, InitImportPrivateKeyResult, InitImportWalletIntent, InitImportWalletRequest, InitImportWalletResult, InitUserEmailRecoveryIntent, InitUserEmailRecoveryRequest, InitUserEmailRecoveryResult, Intent, InvitationParams, InvitationsApi, ListPrivateKeyTagsRequest, ListPrivateKeyTagsResponse, ListUserTagsRequest, ListUserTagsResponse, MnemonicLanguage, Operator, OrganizationsApi, Pagination, PathFormat, PayloadEncoding, PoliciesApi, Policy, PrivateKey, PrivateKeyParams, PrivateKeyResult, PrivateKeyTagsApi, PrivateKeysApi, PublicKeyCredentialWithAttestation, RecoverUserIntent, RecoverUserRequest, RecoverUserResult, RejectActivityIntent, RejectActivityRequest, RemoveOrganizationFeatureIntent, RemoveOrganizationFeatureRequest, RemoveOrganizationFeatureResult, Result, RootUserParams, Selector, SelectorV2, SessionsApi, SetOrganizationFeatureIntent, SetOrganizationFeatureRequest, SetOrganizationFeatureResult, SetPaymentMethodIntent, SetPaymentMethodIntentV2, SetPaymentMethodResult, SignRawPayloadIntent, SignRawPayloadIntentV2, SignRawPayloadRequest, SignRawPayloadResult, SignTransactionIntent, SignTransactionIntentV2, SignTransactionRequest, SignTransactionResult, SigningApi, SimpleClientExtensionResults, TagType, TransactionType, UpdateAllowedOriginsIntent, UpdateAllowedOriginsResult, UpdatePolicyIntent, UpdatePolicyRequest, UpdatePolicyResult, UpdatePrivateKeyTagIntent, UpdatePrivateKeyTagRequest, UpdatePrivateKeyTagResult, UpdateRootQuorumIntent, UpdateRootQuorumRequest, UpdateRootQuorumResult, UpdateUserIntent, UpdateUserRequest, UpdateUserResult, UpdateUserTagIntent, UpdateUserTagRequest, UpdateUserTagResult, User, UserAuthApi, UserParams, UserParamsV2, UserRecoveryApi, UserTagsApi, UsersApi, V1Tag, Vote, Wallet, WalletAccount, WalletAccountParams, WalletParams, WalletResult, WalletsApi

Constant Summary collapse

VERSION = 
'0.0.4'

Class Method Summary collapse

Class Method Details

.configure {|config| ... } ⇒ Object

Customize default settings for the SDK using block.

TurnkeyClient.configure do |config|
  config.api_public_key = "xxx"
  config.api_private_key = "xxx"
end

Yields:

  • (config) 


287
288
289
290
291
 
# File 'lib/turnkey_client.rb', line 287

def configure
  config = Configuration.default
  yield(config)
  ApiClient.new(config)
end