turnkey_client 0.0.13 → 0.0.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (208) hide show
  1. checksums.yaml +4 -4
  2. data/lib/turnkey_client/api/activities_api.rb +66 -8
  3. data/lib/turnkey_client/api/api_keys_api.rb +14 -14
  4. data/lib/turnkey_client/api/app_proof_api.rb +77 -0
  5. data/lib/turnkey_client/api/authenticators_api.rb +16 -16
  6. data/lib/turnkey_client/api/boot_proof_api.rb +135 -0
  7. data/lib/turnkey_client/api/consensus_api.rb +8 -8
  8. data/lib/turnkey_client/api/default_api.rb +77 -0
  9. data/lib/turnkey_client/api/features_api.rb +8 -8
  10. data/lib/turnkey_client/api/invitations_api.rb +8 -8
  11. data/lib/turnkey_client/api/on_ramp_api.rb +77 -0
  12. data/lib/turnkey_client/api/organizations_api.rb +18 -18
  13. data/lib/turnkey_client/api/policies_api.rb +256 -24
  14. data/lib/turnkey_client/api/private_key_tags_api.rb +12 -12
  15. data/lib/turnkey_client/api/private_keys_api.rb +28 -28
  16. data/lib/turnkey_client/api/sessions_api.rb +184 -10
  17. data/lib/turnkey_client/api/signing_api.rb +12 -12
  18. data/lib/turnkey_client/api/user_auth_api.rb +310 -20
  19. data/lib/turnkey_client/api/user_recovery_api.rb +6 -6
  20. data/lib/turnkey_client/api/user_tags_api.rb +12 -12
  21. data/lib/turnkey_client/api/user_verification_api.rb +135 -0
  22. data/lib/turnkey_client/api/users_api.rb +194 -20
  23. data/lib/turnkey_client/api/wallets_api.rb +48 -48
  24. data/lib/turnkey_client/models/activity.rb +13 -1
  25. data/lib/turnkey_client/models/activity_type.rb +21 -0
  26. data/lib/turnkey_client/models/activity_v1_policy_evaluation.rb +287 -0
  27. data/lib/turnkey_client/models/address_format.rb +1 -0
  28. data/lib/turnkey_client/models/api_key.rb +1 -0
  29. data/lib/turnkey_client/models/api_key_params.rb +1 -0
  30. data/lib/turnkey_client/models/api_key_params_v2.rb +1 -0
  31. data/lib/turnkey_client/models/api_only_user_params.rb +3 -2
  32. data/lib/turnkey_client/models/app_proof.rb +255 -0
  33. data/lib/turnkey_client/models/boot_proof.rb +315 -0
  34. data/lib/turnkey_client/models/boot_proof_response.rb +210 -0
  35. data/lib/turnkey_client/models/common_v1_policy_evaluation.rb +214 -0
  36. data/lib/turnkey_client/models/create_oauth2_credential_intent.rb +240 -0
  37. data/lib/turnkey_client/models/create_oauth2_credential_request.rb +288 -0
  38. data/lib/turnkey_client/models/create_oauth2_credential_result.rb +211 -0
  39. data/lib/turnkey_client/models/create_organization_intent.rb +1 -0
  40. data/lib/turnkey_client/models/create_organization_intent_v2.rb +1 -0
  41. data/lib/turnkey_client/models/create_policy_intent_v3.rb +2 -0
  42. data/lib/turnkey_client/models/create_read_write_session_intent.rb +3 -1
  43. data/lib/turnkey_client/models/create_read_write_session_intent_v2.rb +19 -5
  44. data/lib/turnkey_client/models/create_smart_contract_interface_intent.rb +265 -0
  45. data/lib/turnkey_client/models/create_smart_contract_interface_request.rb +288 -0
  46. data/lib/turnkey_client/models/create_smart_contract_interface_result.rb +211 -0
  47. data/lib/turnkey_client/models/create_sub_organization_intent_v4.rb +2 -0
  48. data/lib/turnkey_client/models/create_sub_organization_intent_v5.rb +2 -0
  49. data/lib/turnkey_client/models/create_sub_organization_intent_v6.rb +2 -0
  50. data/lib/turnkey_client/models/create_sub_organization_intent_v7.rb +19 -4
  51. data/lib/turnkey_client/models/create_users_intent_v3.rb +213 -0
  52. data/lib/turnkey_client/models/create_users_request.rb +2 -2
  53. data/lib/turnkey_client/models/create_wallet_intent.rb +2 -1
  54. data/lib/turnkey_client/models/credential_type.rb +3 -0
  55. data/lib/turnkey_client/models/data_v1_smart_contract_interface.rb +329 -0
  56. data/lib/turnkey_client/models/delete_oauth2_credential_intent.rb +211 -0
  57. data/lib/turnkey_client/models/delete_oauth2_credential_request.rb +288 -0
  58. data/lib/turnkey_client/models/delete_oauth2_credential_result.rb +211 -0
  59. data/lib/turnkey_client/models/delete_payment_method_intent.rb +1 -0
  60. data/lib/turnkey_client/models/delete_private_keys_intent.rb +1 -0
  61. data/lib/turnkey_client/models/delete_smart_contract_interface_intent.rb +211 -0
  62. data/lib/turnkey_client/models/delete_smart_contract_interface_request.rb +288 -0
  63. data/lib/turnkey_client/models/delete_smart_contract_interface_result.rb +211 -0
  64. data/lib/turnkey_client/models/delete_sub_organization_intent.rb +1 -0
  65. data/lib/turnkey_client/models/delete_wallets_intent.rb +1 -0
  66. data/lib/turnkey_client/models/disable_auth_proxy_intent.rb +196 -0
  67. data/lib/turnkey_client/models/disable_auth_proxy_result.rb +196 -0
  68. data/lib/turnkey_client/models/email_auth_intent.rb +31 -5
  69. data/lib/turnkey_client/models/email_auth_intent_v2.rb +31 -5
  70. data/lib/turnkey_client/models/email_customization_params.rb +5 -0
  71. data/lib/turnkey_client/models/enable_auth_proxy_intent.rb +196 -0
  72. data/lib/turnkey_client/models/enable_auth_proxy_result.rb +211 -0
  73. data/lib/turnkey_client/models/feature.rb +1 -0
  74. data/lib/turnkey_client/models/feature_name.rb +1 -0
  75. data/lib/turnkey_client/models/fiat_on_ramp_blockchain_network.rb +29 -0
  76. data/lib/turnkey_client/models/fiat_on_ramp_crypto_currency.rb +29 -0
  77. data/lib/turnkey_client/models/fiat_on_ramp_currency.rb +59 -0
  78. data/lib/turnkey_client/models/fiat_on_ramp_payment_method.rb +38 -0
  79. data/lib/turnkey_client/models/fiat_on_ramp_provider.rb +27 -0
  80. data/lib/turnkey_client/models/get_activities_request.rb +3 -3
  81. data/lib/turnkey_client/models/get_activities_response.rb +1 -1
  82. data/lib/turnkey_client/models/get_activity_request.rb +2 -2
  83. data/lib/turnkey_client/models/get_api_key_request.rb +1 -1
  84. data/lib/turnkey_client/models/get_api_keys_request.rb +3 -2
  85. data/lib/turnkey_client/models/get_app_proofs_request.rb +226 -0
  86. data/lib/turnkey_client/models/get_app_proofs_response.rb +212 -0
  87. data/lib/turnkey_client/models/get_authenticator_request.rb +2 -2
  88. data/lib/turnkey_client/models/get_authenticators_request.rb +2 -2
  89. data/lib/turnkey_client/models/get_boot_proof_request.rb +226 -0
  90. data/lib/turnkey_client/models/get_latest_boot_proof_request.rb +226 -0
  91. data/lib/turnkey_client/models/get_oauth2_credential_request.rb +226 -0
  92. data/lib/turnkey_client/models/get_oauth2_credential_response.rb +210 -0
  93. data/lib/turnkey_client/models/get_oauth_providers_request.rb +3 -2
  94. data/lib/turnkey_client/models/get_oauth_providers_response.rb +1 -1
  95. data/lib/turnkey_client/models/get_organization_configs_request.rb +1 -1
  96. data/lib/turnkey_client/models/get_policies_request.rb +1 -1
  97. data/lib/turnkey_client/models/get_policies_response.rb +1 -1
  98. data/lib/turnkey_client/models/get_policy_evaluations_request.rb +226 -0
  99. data/lib/turnkey_client/models/get_policy_evaluations_response.rb +212 -0
  100. data/lib/turnkey_client/models/get_policy_request.rb +2 -2
  101. data/lib/turnkey_client/models/get_private_key_request.rb +2 -2
  102. data/lib/turnkey_client/models/get_private_keys_request.rb +1 -1
  103. data/lib/turnkey_client/models/get_private_keys_response.rb +1 -1
  104. data/lib/turnkey_client/models/get_smart_contract_interface_request.rb +226 -0
  105. data/lib/turnkey_client/models/get_smart_contract_interface_response.rb +210 -0
  106. data/lib/turnkey_client/models/get_smart_contract_interfaces_request.rb +211 -0
  107. data/lib/turnkey_client/models/get_smart_contract_interfaces_response.rb +213 -0
  108. data/lib/turnkey_client/models/get_sub_org_ids_request.rb +2 -2
  109. data/lib/turnkey_client/models/get_user_request.rb +2 -2
  110. data/lib/turnkey_client/models/get_users_request.rb +1 -1
  111. data/lib/turnkey_client/models/get_users_response.rb +1 -1
  112. data/lib/turnkey_client/models/get_verified_sub_org_ids_request.rb +2 -2
  113. data/lib/turnkey_client/models/get_wallet_account_request.rb +6 -4
  114. data/lib/turnkey_client/models/get_wallet_accounts_request.rb +15 -8
  115. data/lib/turnkey_client/models/get_wallet_accounts_response.rb +1 -1
  116. data/lib/turnkey_client/models/get_wallet_request.rb +2 -2
  117. data/lib/turnkey_client/models/get_wallets_request.rb +1 -1
  118. data/lib/turnkey_client/models/get_wallets_response.rb +1 -1
  119. data/lib/turnkey_client/models/get_whoami_request.rb +1 -1
  120. data/lib/turnkey_client/models/get_whoami_response.rb +4 -4
  121. data/lib/turnkey_client/models/init_fiat_on_ramp_intent.rb +326 -0
  122. data/lib/turnkey_client/models/init_fiat_on_ramp_request.rb +288 -0
  123. data/lib/turnkey_client/models/init_fiat_on_ramp_result.rb +236 -0
  124. data/lib/turnkey_client/models/init_otp_auth_intent.rb +28 -4
  125. data/lib/turnkey_client/models/init_otp_auth_intent_v2.rb +310 -0
  126. data/lib/turnkey_client/models/init_otp_auth_request.rb +2 -2
  127. data/lib/turnkey_client/models/init_otp_auth_result_v2.rb +211 -0
  128. data/lib/turnkey_client/models/init_otp_intent.rb +321 -0
  129. data/lib/turnkey_client/models/init_otp_request.rb +288 -0
  130. data/lib/turnkey_client/models/init_otp_result.rb +211 -0
  131. data/lib/turnkey_client/models/init_user_email_recovery_intent.rb +2 -1
  132. data/lib/turnkey_client/models/intent.rb +193 -4
  133. data/lib/turnkey_client/models/invitation_params.rb +1 -1
  134. data/lib/turnkey_client/models/list_oauth2_credentials_request.rb +211 -0
  135. data/lib/turnkey_client/models/list_oauth2_credentials_response.rb +212 -0
  136. data/lib/turnkey_client/models/list_private_key_tags_request.rb +1 -1
  137. data/lib/turnkey_client/models/list_private_key_tags_response.rb +1 -1
  138. data/lib/turnkey_client/models/list_user_tags_request.rb +1 -1
  139. data/lib/turnkey_client/models/list_user_tags_response.rb +1 -1
  140. data/lib/turnkey_client/models/oauth2_authenticate_intent.rb +278 -0
  141. data/lib/turnkey_client/models/oauth2_authenticate_request.rb +288 -0
  142. data/lib/turnkey_client/models/oauth2_authenticate_result.rb +211 -0
  143. data/lib/turnkey_client/models/oauth2_credential.rb +298 -0
  144. data/lib/turnkey_client/models/oauth2_provider.rb +27 -0
  145. data/lib/turnkey_client/models/oauth_intent.rb +18 -5
  146. data/lib/turnkey_client/models/oauth_login_intent.rb +248 -0
  147. data/lib/turnkey_client/models/oauth_login_request.rb +288 -0
  148. data/lib/turnkey_client/models/oauth_login_result.rb +211 -0
  149. data/lib/turnkey_client/models/otp_auth_intent.rb +10 -2
  150. data/lib/turnkey_client/models/otp_login_intent.rb +259 -0
  151. data/lib/turnkey_client/models/otp_login_request.rb +288 -0
  152. data/lib/turnkey_client/models/otp_login_result.rb +211 -0
  153. data/lib/turnkey_client/models/outcome.rb +31 -0
  154. data/lib/turnkey_client/models/payload_encoding.rb +2 -0
  155. data/lib/turnkey_client/models/policy.rb +2 -0
  156. data/lib/turnkey_client/models/private_key_params.rb +1 -1
  157. data/lib/turnkey_client/models/result.rb +184 -4
  158. data/lib/turnkey_client/models/root_user_params.rb +3 -2
  159. data/lib/turnkey_client/models/root_user_params_v2.rb +4 -3
  160. data/lib/turnkey_client/models/root_user_params_v3.rb +4 -3
  161. data/lib/turnkey_client/models/root_user_params_v4.rb +5 -3
  162. data/lib/turnkey_client/models/set_organization_feature_intent.rb +1 -0
  163. data/lib/turnkey_client/models/signature_scheme.rb +26 -0
  164. data/lib/turnkey_client/models/simple_client_extension_results.rb +2 -0
  165. data/lib/turnkey_client/models/smart_contract_interface.rb +329 -0
  166. data/lib/turnkey_client/models/smart_contract_interface_type.rb +27 -0
  167. data/lib/turnkey_client/models/sms_customization_params.rb +1 -0
  168. data/lib/turnkey_client/models/stamp_login_intent.rb +233 -0
  169. data/lib/turnkey_client/models/stamp_login_request.rb +288 -0
  170. data/lib/turnkey_client/models/stamp_login_result.rb +211 -0
  171. data/lib/turnkey_client/models/transaction_type.rb +1 -0
  172. data/lib/turnkey_client/models/ump_v1_policy_evaluation.rb +214 -0
  173. data/lib/turnkey_client/models/update_auth_proxy_config_intent.rb +346 -0
  174. data/lib/turnkey_client/models/update_auth_proxy_config_result.rb +206 -0
  175. data/lib/turnkey_client/models/update_oauth2_credential_intent.rb +255 -0
  176. data/lib/turnkey_client/models/update_oauth2_credential_request.rb +288 -0
  177. data/lib/turnkey_client/models/update_oauth2_credential_result.rb +211 -0
  178. data/lib/turnkey_client/models/update_policy_intent.rb +4 -0
  179. data/lib/turnkey_client/models/update_policy_intent_v2.rb +264 -0
  180. data/lib/turnkey_client/models/update_policy_request.rb +2 -2
  181. data/lib/turnkey_client/models/update_policy_result_v2.rb +211 -0
  182. data/lib/turnkey_client/models/update_private_key_tag_intent.rb +1 -0
  183. data/lib/turnkey_client/models/update_user_email_intent.rb +237 -0
  184. data/lib/turnkey_client/models/update_user_email_request.rb +288 -0
  185. data/lib/turnkey_client/models/update_user_email_result.rb +211 -0
  186. data/lib/turnkey_client/models/update_user_intent.rb +4 -1
  187. data/lib/turnkey_client/models/update_user_name_intent.rb +226 -0
  188. data/lib/turnkey_client/models/update_user_name_request.rb +288 -0
  189. data/lib/turnkey_client/models/update_user_name_result.rb +211 -0
  190. data/lib/turnkey_client/models/update_user_phone_number_intent.rb +237 -0
  191. data/lib/turnkey_client/models/update_user_phone_number_request.rb +288 -0
  192. data/lib/turnkey_client/models/update_user_phone_number_result.rb +211 -0
  193. data/lib/turnkey_client/models/update_user_tag_intent.rb +1 -0
  194. data/lib/turnkey_client/models/user.rb +3 -1
  195. data/lib/turnkey_client/models/user_params.rb +4 -3
  196. data/lib/turnkey_client/models/user_params_v2.rb +4 -3
  197. data/lib/turnkey_client/models/user_params_v3.rb +301 -0
  198. data/lib/turnkey_client/models/verify_otp_intent.rb +248 -0
  199. data/lib/turnkey_client/models/verify_otp_request.rb +288 -0
  200. data/lib/turnkey_client/models/verify_otp_result.rb +211 -0
  201. data/lib/turnkey_client/models/wallet_account.rb +24 -4
  202. data/lib/turnkey_client/models/wallet_kit_settings_params.rb +230 -0
  203. data/lib/turnkey_client/models/wallet_params.rb +2 -1
  204. data/lib/turnkey_client/version.rb +1 -1
  205. data/lib/turnkey_client.rb +93 -0
  206. data/turnkey_client-0.0.13.gem +0 -0
  207. data/turnkey_client-0.0.14.gem +0 -0
  208. metadata +99 -2
@@ -15,8 +15,66 @@ module TurnkeyClient
15
15
  def initialize(api_client = ApiClient.default)
16
16
  @api_client = api_client
17
17
  end
18
- # Create Oauth Providers
19
- # Creates Oauth providers for a specified user - BETA
18
+ # Create an OAuth 2.0 Credential
19
+ # Enable authentication for end users with an OAuth 2.0 provider
20
+ # @param body
21
+ # @param [Hash] opts the optional parameters
22
+ # @return [ActivityResponse]
23
+ def create_oauth2_credential(body, opts = {})
24
+ data, _status_code, _headers = create_oauth2_credential_with_http_info(body, opts)
25
+ data
26
+ end
27
+
28
+ # Create an OAuth 2.0 Credential
29
+ # Enable authentication for end users with an OAuth 2.0 provider
30
+ # @param body
31
+ # @param [Hash] opts the optional parameters
32
+ # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
33
+ def create_oauth2_credential_with_http_info(body, opts = {})
34
+ if @api_client.config.debugging
35
+ @api_client.config.logger.debug 'Calling API: UserAuthApi.create_oauth2_credential ...'
36
+ end
37
+ # verify the required parameter 'body' is set
38
+ if @api_client.config.client_side_validation && body.nil?
39
+ fail ArgumentError, "Missing the required parameter 'body' when calling UserAuthApi.create_oauth2_credential"
40
+ end
41
+ # resource path
42
+ local_var_path = '/public/v1/submit/create_oauth2_credential'
43
+
44
+ # query parameters
45
+ query_params = opts[:query_params] || {}
46
+
47
+ # header parameters
48
+ header_params = opts[:header_params] || {}
49
+ # HTTP header 'Accept' (if needed)
50
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
51
+ # HTTP header 'Content-Type'
52
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
53
+
54
+ # form parameters
55
+ form_params = opts[:form_params] || {}
56
+
57
+ # http body (model)
58
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
59
+
60
+ return_type = opts[:return_type] || 'ActivityResponse'
61
+
62
+ auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth']
63
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
64
+ :header_params => header_params,
65
+ :query_params => query_params,
66
+ :form_params => form_params,
67
+ :body => post_body,
68
+ :auth_names => auth_names,
69
+ :return_type => return_type)
70
+
71
+ if @api_client.config.debugging
72
+ @api_client.config.logger.debug "API called: UserAuthApi#create_oauth2_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
73
+ end
74
+ return data, status_code, headers
75
+ end
76
+ # Create Oauth providers
77
+ # Create Oauth providers for a specified user.
20
78
  # @param body
21
79
  # @param [Hash] opts the optional parameters
22
80
  # @return [ActivityResponse]
@@ -25,8 +83,8 @@ module TurnkeyClient
25
83
  data
26
84
  end
27
85
 
28
- # Create Oauth Providers
29
- # Creates Oauth providers for a specified user - BETA
86
+ # Create Oauth providers
87
+ # Create Oauth providers for a specified user.
30
88
  # @param body
31
89
  # @param [Hash] opts the optional parameters
32
90
  # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -73,8 +131,66 @@ module TurnkeyClient
73
131
  end
74
132
  return data, status_code, headers
75
133
  end
76
- # Delete Oauth Providers
77
- # Removes Oauth providers for a specified user - BETA
134
+ # Delete an OAuth 2.0 Credential
135
+ # Disable authentication for end users with an OAuth 2.0 provider
136
+ # @param body
137
+ # @param [Hash] opts the optional parameters
138
+ # @return [ActivityResponse]
139
+ def delete_oauth2_credential(body, opts = {})
140
+ data, _status_code, _headers = delete_oauth2_credential_with_http_info(body, opts)
141
+ data
142
+ end
143
+
144
+ # Delete an OAuth 2.0 Credential
145
+ # Disable authentication for end users with an OAuth 2.0 provider
146
+ # @param body
147
+ # @param [Hash] opts the optional parameters
148
+ # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
149
+ def delete_oauth2_credential_with_http_info(body, opts = {})
150
+ if @api_client.config.debugging
151
+ @api_client.config.logger.debug 'Calling API: UserAuthApi.delete_oauth2_credential ...'
152
+ end
153
+ # verify the required parameter 'body' is set
154
+ if @api_client.config.client_side_validation && body.nil?
155
+ fail ArgumentError, "Missing the required parameter 'body' when calling UserAuthApi.delete_oauth2_credential"
156
+ end
157
+ # resource path
158
+ local_var_path = '/public/v1/submit/delete_oauth2_credential'
159
+
160
+ # query parameters
161
+ query_params = opts[:query_params] || {}
162
+
163
+ # header parameters
164
+ header_params = opts[:header_params] || {}
165
+ # HTTP header 'Accept' (if needed)
166
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
167
+ # HTTP header 'Content-Type'
168
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
169
+
170
+ # form parameters
171
+ form_params = opts[:form_params] || {}
172
+
173
+ # http body (model)
174
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
175
+
176
+ return_type = opts[:return_type] || 'ActivityResponse'
177
+
178
+ auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth']
179
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
180
+ :header_params => header_params,
181
+ :query_params => query_params,
182
+ :form_params => form_params,
183
+ :body => post_body,
184
+ :auth_names => auth_names,
185
+ :return_type => return_type)
186
+
187
+ if @api_client.config.debugging
188
+ @api_client.config.logger.debug "API called: UserAuthApi#delete_oauth2_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
189
+ end
190
+ return data, status_code, headers
191
+ end
192
+ # Delete Oauth providers
193
+ # Remove Oauth providers for a specified user.
78
194
  # @param body
79
195
  # @param [Hash] opts the optional parameters
80
196
  # @return [ActivityResponse]
@@ -83,8 +199,8 @@ module TurnkeyClient
83
199
  data
84
200
  end
85
201
 
86
- # Delete Oauth Providers
87
- # Removes Oauth providers for a specified user - BETA
202
+ # Delete Oauth providers
203
+ # Remove Oauth providers for a specified user.
88
204
  # @param body
89
205
  # @param [Hash] opts the optional parameters
90
206
  # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -131,8 +247,8 @@ module TurnkeyClient
131
247
  end
132
248
  return data, status_code, headers
133
249
  end
134
- # Perform Email Auth
135
- # Authenticate a user via Email
250
+ # Perform email auth
251
+ # Authenticate a user via email.
136
252
  # @param body
137
253
  # @param [Hash] opts the optional parameters
138
254
  # @return [ActivityResponse]
@@ -141,8 +257,8 @@ module TurnkeyClient
141
257
  data
142
258
  end
143
259
 
144
- # Perform Email Auth
145
- # Authenticate a user via Email
260
+ # Perform email auth
261
+ # Authenticate a user via email.
146
262
  # @param body
147
263
  # @param [Hash] opts the optional parameters
148
264
  # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -190,7 +306,7 @@ module TurnkeyClient
190
306
  return data, status_code, headers
191
307
  end
192
308
  # Get Oauth providers
193
- # Get details about Oauth providers for a user
309
+ # Get details about Oauth providers for a user.
194
310
  # @param body
195
311
  # @param [Hash] opts the optional parameters
196
312
  # @return [GetOauthProvidersResponse]
@@ -200,7 +316,7 @@ module TurnkeyClient
200
316
  end
201
317
 
202
318
  # Get Oauth providers
203
- # Get details about Oauth providers for a user
319
+ # Get details about Oauth providers for a user.
204
320
  # @param body
205
321
  # @param [Hash] opts the optional parameters
206
322
  # @return [Array<(GetOauthProvidersResponse, Integer, Hash)>] GetOauthProvidersResponse data, response status code and response headers
@@ -248,7 +364,7 @@ module TurnkeyClient
248
364
  return data, status_code, headers
249
365
  end
250
366
  # Init OTP auth
251
- # Initiate an OTP auth activity
367
+ # Initiate an OTP auth activity.
252
368
  # @param body
253
369
  # @param [Hash] opts the optional parameters
254
370
  # @return [ActivityResponse]
@@ -258,7 +374,7 @@ module TurnkeyClient
258
374
  end
259
375
 
260
376
  # Init OTP auth
261
- # Initiate an OTP auth activity
377
+ # Initiate an OTP auth activity.
262
378
  # @param body
263
379
  # @param [Hash] opts the optional parameters
264
380
  # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -305,8 +421,66 @@ module TurnkeyClient
305
421
  end
306
422
  return data, status_code, headers
307
423
  end
424
+ # List OAuth 2.0 Credentials
425
+ # List all OAuth 2.0 credentials within an organization.
426
+ # @param body
427
+ # @param [Hash] opts the optional parameters
428
+ # @return [ListOauth2CredentialsResponse]
429
+ def list_oauth2_credentials(body, opts = {})
430
+ data, _status_code, _headers = list_oauth2_credentials_with_http_info(body, opts)
431
+ data
432
+ end
433
+
434
+ # List OAuth 2.0 Credentials
435
+ # List all OAuth 2.0 credentials within an organization.
436
+ # @param body
437
+ # @param [Hash] opts the optional parameters
438
+ # @return [Array<(ListOauth2CredentialsResponse, Integer, Hash)>] ListOauth2CredentialsResponse data, response status code and response headers
439
+ def list_oauth2_credentials_with_http_info(body, opts = {})
440
+ if @api_client.config.debugging
441
+ @api_client.config.logger.debug 'Calling API: UserAuthApi.list_oauth2_credentials ...'
442
+ end
443
+ # verify the required parameter 'body' is set
444
+ if @api_client.config.client_side_validation && body.nil?
445
+ fail ArgumentError, "Missing the required parameter 'body' when calling UserAuthApi.list_oauth2_credentials"
446
+ end
447
+ # resource path
448
+ local_var_path = '/public/v1/query/list_oauth2_credentials'
449
+
450
+ # query parameters
451
+ query_params = opts[:query_params] || {}
452
+
453
+ # header parameters
454
+ header_params = opts[:header_params] || {}
455
+ # HTTP header 'Accept' (if needed)
456
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
457
+ # HTTP header 'Content-Type'
458
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
459
+
460
+ # form parameters
461
+ form_params = opts[:form_params] || {}
462
+
463
+ # http body (model)
464
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
465
+
466
+ return_type = opts[:return_type] || 'ListOauth2CredentialsResponse'
467
+
468
+ auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth']
469
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
470
+ :header_params => header_params,
471
+ :query_params => query_params,
472
+ :form_params => form_params,
473
+ :body => post_body,
474
+ :auth_names => auth_names,
475
+ :return_type => return_type)
476
+
477
+ if @api_client.config.debugging
478
+ @api_client.config.logger.debug "API called: UserAuthApi#list_oauth2_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
479
+ end
480
+ return data, status_code, headers
481
+ end
308
482
  # Oauth
309
- # Authenticate a user with an Oidc token (Oauth) - BETA
483
+ # Authenticate a user with an OIDC token (Oauth).
310
484
  # @param body
311
485
  # @param [Hash] opts the optional parameters
312
486
  # @return [ActivityResponse]
@@ -316,7 +490,7 @@ module TurnkeyClient
316
490
  end
317
491
 
318
492
  # Oauth
319
- # Authenticate a user with an Oidc token (Oauth) - BETA
493
+ # Authenticate a user with an OIDC token (Oauth).
320
494
  # @param body
321
495
  # @param [Hash] opts the optional parameters
322
496
  # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -363,8 +537,66 @@ module TurnkeyClient
363
537
  end
364
538
  return data, status_code, headers
365
539
  end
540
+ # OAuth 2.0 authentication
541
+ # Authenticate a user with an OAuth 2.0 provider and receive an OIDC token to use with the LoginWithOAuth or CreateSubOrganization activities
542
+ # @param body
543
+ # @param [Hash] opts the optional parameters
544
+ # @return [ActivityResponse]
545
+ def oauth2_authenticate(body, opts = {})
546
+ data, _status_code, _headers = oauth2_authenticate_with_http_info(body, opts)
547
+ data
548
+ end
549
+
550
+ # OAuth 2.0 authentication
551
+ # Authenticate a user with an OAuth 2.0 provider and receive an OIDC token to use with the LoginWithOAuth or CreateSubOrganization activities
552
+ # @param body
553
+ # @param [Hash] opts the optional parameters
554
+ # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
555
+ def oauth2_authenticate_with_http_info(body, opts = {})
556
+ if @api_client.config.debugging
557
+ @api_client.config.logger.debug 'Calling API: UserAuthApi.oauth2_authenticate ...'
558
+ end
559
+ # verify the required parameter 'body' is set
560
+ if @api_client.config.client_side_validation && body.nil?
561
+ fail ArgumentError, "Missing the required parameter 'body' when calling UserAuthApi.oauth2_authenticate"
562
+ end
563
+ # resource path
564
+ local_var_path = '/public/v1/submit/oauth2_authenticate'
565
+
566
+ # query parameters
567
+ query_params = opts[:query_params] || {}
568
+
569
+ # header parameters
570
+ header_params = opts[:header_params] || {}
571
+ # HTTP header 'Accept' (if needed)
572
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
573
+ # HTTP header 'Content-Type'
574
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
575
+
576
+ # form parameters
577
+ form_params = opts[:form_params] || {}
578
+
579
+ # http body (model)
580
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
581
+
582
+ return_type = opts[:return_type] || 'ActivityResponse'
583
+
584
+ auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth']
585
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
586
+ :header_params => header_params,
587
+ :query_params => query_params,
588
+ :form_params => form_params,
589
+ :body => post_body,
590
+ :auth_names => auth_names,
591
+ :return_type => return_type)
592
+
593
+ if @api_client.config.debugging
594
+ @api_client.config.logger.debug "API called: UserAuthApi#oauth2_authenticate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
595
+ end
596
+ return data, status_code, headers
597
+ end
366
598
  # OTP auth
367
- # Authenticate a user with an OTP code sent via email or SMS
599
+ # Authenticate a user with an OTP code sent via email or SMS.
368
600
  # @param body
369
601
  # @param [Hash] opts the optional parameters
370
602
  # @return [ActivityResponse]
@@ -374,7 +606,7 @@ module TurnkeyClient
374
606
  end
375
607
 
376
608
  # OTP auth
377
- # Authenticate a user with an OTP code sent via email or SMS
609
+ # Authenticate a user with an OTP code sent via email or SMS.
378
610
  # @param body
379
611
  # @param [Hash] opts the optional parameters
380
612
  # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -421,5 +653,63 @@ module TurnkeyClient
421
653
  end
422
654
  return data, status_code, headers
423
655
  end
656
+ # Update an OAuth 2.0 Credential
657
+ # Update an OAuth 2.0 provider credential
658
+ # @param body
659
+ # @param [Hash] opts the optional parameters
660
+ # @return [ActivityResponse]
661
+ def update_oauth2_credential(body, opts = {})
662
+ data, _status_code, _headers = update_oauth2_credential_with_http_info(body, opts)
663
+ data
664
+ end
665
+
666
+ # Update an OAuth 2.0 Credential
667
+ # Update an OAuth 2.0 provider credential
668
+ # @param body
669
+ # @param [Hash] opts the optional parameters
670
+ # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
671
+ def update_oauth2_credential_with_http_info(body, opts = {})
672
+ if @api_client.config.debugging
673
+ @api_client.config.logger.debug 'Calling API: UserAuthApi.update_oauth2_credential ...'
674
+ end
675
+ # verify the required parameter 'body' is set
676
+ if @api_client.config.client_side_validation && body.nil?
677
+ fail ArgumentError, "Missing the required parameter 'body' when calling UserAuthApi.update_oauth2_credential"
678
+ end
679
+ # resource path
680
+ local_var_path = '/public/v1/submit/update_oauth2_credential'
681
+
682
+ # query parameters
683
+ query_params = opts[:query_params] || {}
684
+
685
+ # header parameters
686
+ header_params = opts[:header_params] || {}
687
+ # HTTP header 'Accept' (if needed)
688
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
689
+ # HTTP header 'Content-Type'
690
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
691
+
692
+ # form parameters
693
+ form_params = opts[:form_params] || {}
694
+
695
+ # http body (model)
696
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
697
+
698
+ return_type = opts[:return_type] || 'ActivityResponse'
699
+
700
+ auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth']
701
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
702
+ :header_params => header_params,
703
+ :query_params => query_params,
704
+ :form_params => form_params,
705
+ :body => post_body,
706
+ :auth_names => auth_names,
707
+ :return_type => return_type)
708
+
709
+ if @api_client.config.debugging
710
+ @api_client.config.logger.debug "API called: UserAuthApi#update_oauth2_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
711
+ end
712
+ return data, status_code, headers
713
+ end
424
714
  end
425
715
  end
@@ -15,8 +15,8 @@ module TurnkeyClient
15
15
  def initialize(api_client = ApiClient.default)
16
16
  @api_client = api_client
17
17
  end
18
- # Init Email Recovery
19
- # Initializes a new email recovery
18
+ # Init email recovery
19
+ # Initialize a new email recovery.
20
20
  # @param body
21
21
  # @param [Hash] opts the optional parameters
22
22
  # @return [ActivityResponse]
@@ -25,8 +25,8 @@ module TurnkeyClient
25
25
  data
26
26
  end
27
27
 
28
- # Init Email Recovery
29
- # Initializes a new email recovery
28
+ # Init email recovery
29
+ # Initialize a new email recovery.
30
30
  # @param body
31
31
  # @param [Hash] opts the optional parameters
32
32
  # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -74,7 +74,7 @@ module TurnkeyClient
74
74
  return data, status_code, headers
75
75
  end
76
76
  # Recover a user
77
- # Completes the process of recovering a user by adding an authenticator
77
+ # Complete the process of recovering a user by adding an authenticator.
78
78
  # @param body
79
79
  # @param [Hash] opts the optional parameters
80
80
  # @return [ActivityResponse]
@@ -84,7 +84,7 @@ module TurnkeyClient
84
84
  end
85
85
 
86
86
  # Recover a user
87
- # Completes the process of recovering a user by adding an authenticator
87
+ # Complete the process of recovering a user by adding an authenticator.
88
88
  # @param body
89
89
  # @param [Hash] opts the optional parameters
90
90
  # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -15,7 +15,7 @@ module TurnkeyClient
15
15
  def initialize(api_client = ApiClient.default)
16
16
  @api_client = api_client
17
17
  end
18
- # Create User Tag
18
+ # Create user tag
19
19
  # Create a user tag and add it to users.
20
20
  # @param body
21
21
  # @param [Hash] opts the optional parameters
@@ -25,7 +25,7 @@ module TurnkeyClient
25
25
  data
26
26
  end
27
27
 
28
- # Create User Tag
28
+ # Create user tag
29
29
  # Create a user tag and add it to users.
30
30
  # @param body
31
31
  # @param [Hash] opts the optional parameters
@@ -73,8 +73,8 @@ module TurnkeyClient
73
73
  end
74
74
  return data, status_code, headers
75
75
  end
76
- # Delete User Tags
77
- # Delete User Tags within an Organization
76
+ # Delete user tags
77
+ # Delete user tags within an organization.
78
78
  # @param body
79
79
  # @param [Hash] opts the optional parameters
80
80
  # @return [ActivityResponse]
@@ -83,8 +83,8 @@ module TurnkeyClient
83
83
  data
84
84
  end
85
85
 
86
- # Delete User Tags
87
- # Delete User Tags within an Organization
86
+ # Delete user tags
87
+ # Delete user tags within an organization.
88
88
  # @param body
89
89
  # @param [Hash] opts the optional parameters
90
90
  # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -131,8 +131,8 @@ module TurnkeyClient
131
131
  end
132
132
  return data, status_code, headers
133
133
  end
134
- # List User Tags
135
- # List all User Tags within an Organization
134
+ # List user tags
135
+ # List all user tags within an organization.
136
136
  # @param body
137
137
  # @param [Hash] opts the optional parameters
138
138
  # @return [ListUserTagsResponse]
@@ -141,8 +141,8 @@ module TurnkeyClient
141
141
  data
142
142
  end
143
143
 
144
- # List User Tags
145
- # List all User Tags within an Organization
144
+ # List user tags
145
+ # List all user tags within an organization.
146
146
  # @param body
147
147
  # @param [Hash] opts the optional parameters
148
148
  # @return [Array<(ListUserTagsResponse, Integer, Hash)>] ListUserTagsResponse data, response status code and response headers
@@ -189,7 +189,7 @@ module TurnkeyClient
189
189
  end
190
190
  return data, status_code, headers
191
191
  end
192
- # Update User Tag
192
+ # Update user tag
193
193
  # Update human-readable name or associated users. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.
194
194
  # @param body
195
195
  # @param [Hash] opts the optional parameters
@@ -199,7 +199,7 @@ module TurnkeyClient
199
199
  data
200
200
  end
201
201
 
202
- # Update User Tag
202
+ # Update user tag
203
203
  # Update human-readable name or associated users. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.
204
204
  # @param body
205
205
  # @param [Hash] opts the optional parameters
@@ -0,0 +1,135 @@
1
+ =begin
2
+ #API Reference
3
+
4
+ #Review our [API Introduction](../api-introduction) to get started.
5
+
6
+ OpenAPI spec version: 1.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ =end
10
+
11
+ module TurnkeyClient
12
+ class UserVerificationApi
13
+ attr_accessor :api_client
14
+
15
+ def initialize(api_client = ApiClient.default)
16
+ @api_client = api_client
17
+ end
18
+ # Init generic OTP
19
+ # Initiate a generic OTP activity.
20
+ # @param body
21
+ # @param [Hash] opts the optional parameters
22
+ # @return [ActivityResponse]
23
+ def init_otp(body, opts = {})
24
+ data, _status_code, _headers = init_otp_with_http_info(body, opts)
25
+ data
26
+ end
27
+
28
+ # Init generic OTP
29
+ # Initiate a generic OTP activity.
30
+ # @param body
31
+ # @param [Hash] opts the optional parameters
32
+ # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
33
+ def init_otp_with_http_info(body, opts = {})
34
+ if @api_client.config.debugging
35
+ @api_client.config.logger.debug 'Calling API: UserVerificationApi.init_otp ...'
36
+ end
37
+ # verify the required parameter 'body' is set
38
+ if @api_client.config.client_side_validation && body.nil?
39
+ fail ArgumentError, "Missing the required parameter 'body' when calling UserVerificationApi.init_otp"
40
+ end
41
+ # resource path
42
+ local_var_path = '/public/v1/submit/init_otp'
43
+
44
+ # query parameters
45
+ query_params = opts[:query_params] || {}
46
+
47
+ # header parameters
48
+ header_params = opts[:header_params] || {}
49
+ # HTTP header 'Accept' (if needed)
50
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
51
+ # HTTP header 'Content-Type'
52
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
53
+
54
+ # form parameters
55
+ form_params = opts[:form_params] || {}
56
+
57
+ # http body (model)
58
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
59
+
60
+ return_type = opts[:return_type] || 'ActivityResponse'
61
+
62
+ auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth']
63
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
64
+ :header_params => header_params,
65
+ :query_params => query_params,
66
+ :form_params => form_params,
67
+ :body => post_body,
68
+ :auth_names => auth_names,
69
+ :return_type => return_type)
70
+
71
+ if @api_client.config.debugging
72
+ @api_client.config.logger.debug "API called: UserVerificationApi#init_otp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
73
+ end
74
+ return data, status_code, headers
75
+ end
76
+ # Verify generic OTP
77
+ # Verify a generic OTP.
78
+ # @param body
79
+ # @param [Hash] opts the optional parameters
80
+ # @return [ActivityResponse]
81
+ def verify_otp(body, opts = {})
82
+ data, _status_code, _headers = verify_otp_with_http_info(body, opts)
83
+ data
84
+ end
85
+
86
+ # Verify generic OTP
87
+ # Verify a generic OTP.
88
+ # @param body
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
91
+ def verify_otp_with_http_info(body, opts = {})
92
+ if @api_client.config.debugging
93
+ @api_client.config.logger.debug 'Calling API: UserVerificationApi.verify_otp ...'
94
+ end
95
+ # verify the required parameter 'body' is set
96
+ if @api_client.config.client_side_validation && body.nil?
97
+ fail ArgumentError, "Missing the required parameter 'body' when calling UserVerificationApi.verify_otp"
98
+ end
99
+ # resource path
100
+ local_var_path = '/public/v1/submit/verify_otp'
101
+
102
+ # query parameters
103
+ query_params = opts[:query_params] || {}
104
+
105
+ # header parameters
106
+ header_params = opts[:header_params] || {}
107
+ # HTTP header 'Accept' (if needed)
108
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
109
+ # HTTP header 'Content-Type'
110
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
111
+
112
+ # form parameters
113
+ form_params = opts[:form_params] || {}
114
+
115
+ # http body (model)
116
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
117
+
118
+ return_type = opts[:return_type] || 'ActivityResponse'
119
+
120
+ auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth']
121
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
122
+ :header_params => header_params,
123
+ :query_params => query_params,
124
+ :form_params => form_params,
125
+ :body => post_body,
126
+ :auth_names => auth_names,
127
+ :return_type => return_type)
128
+
129
+ if @api_client.config.debugging
130
+ @api_client.config.logger.debug "API called: UserVerificationApi#verify_otp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
131
+ end
132
+ return data, status_code, headers
133
+ end
134
+ end
135
+ end