Skip to content

Commit ca5da5b

Browse files
author
Stytch Codegen Bot
committed
Release user device history
1 parent b62b9dc commit ca5da5b

31 files changed

Lines changed: 608 additions & 11 deletions

File tree

‎stytch/src/main/kotlin/com/stytch/java/b2b/api/organizations/Organizations.kt‎

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -162,23 +162,35 @@ public interface Organizations {
162162
): CompletableFuture<StytchResult<DeleteResponse>>
163163

164164
/**
165-
* Search for Organizations. If you send a request with no body params, no filtering will be applied and the endpoint will
166-
* return all Organizations. All fuzzy search filters require a minimum of three characters.
165+
*
166+
* **Warning**: This endpoint is not recommended for use in login flows. Scaling issues may occur, as search performance
167+
* may vary from ~150 milliseconds to 9 seconds depending on query complexity and rate limits are set to 100
168+
* requests/second.
169+
*
170+
* Search across your Organizations. Returns an array of Organization objects.
167171
*/
168172
public suspend fun search(data: SearchRequest): StytchResult<SearchResponse>
169173

170174
/**
171-
* Search for Organizations. If you send a request with no body params, no filtering will be applied and the endpoint will
172-
* return all Organizations. All fuzzy search filters require a minimum of three characters.
175+
*
176+
* **Warning**: This endpoint is not recommended for use in login flows. Scaling issues may occur, as search performance
177+
* may vary from ~150 milliseconds to 9 seconds depending on query complexity and rate limits are set to 100
178+
* requests/second.
179+
*
180+
* Search across your Organizations. Returns an array of Organization objects.
173181
*/
174182
public fun search(
175183
data: SearchRequest,
176184
callback: (StytchResult<SearchResponse>) -> Unit,
177185
)
178186

179187
/**
180-
* Search for Organizations. If you send a request with no body params, no filtering will be applied and the endpoint will
181-
* return all Organizations. All fuzzy search filters require a minimum of three characters.
188+
*
189+
* **Warning**: This endpoint is not recommended for use in login flows. Scaling issues may occur, as search performance
190+
* may vary from ~150 milliseconds to 9 seconds depending on query complexity and rate limits are set to 100
191+
* requests/second.
192+
*
193+
* Search across your Organizations. Returns an array of Organization objects.
182194
*/
183195
public fun searchCompletable(data: SearchRequest): CompletableFuture<StytchResult<SearchResponse>>
184196

‎stytch/src/main/kotlin/com/stytch/java/b2b/api/organizationsmembers/OrganizationsMembers.kt‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -241,21 +241,31 @@ public interface Members {
241241
): CompletableFuture<StytchResult<DeleteTOTPResponse>>
242242

243243
/**
244+
*
245+
* **Warning**: This endpoint is not recommended for use in login flows. Scaling issues may occur, as search performance
246+
* may vary from ~150 milliseconds to 9 seconds depending on query complexity and rate limits are set to 100
247+
* requests/second.
248+
*
244249
* Search for Members within specified Organizations. An array with at least one `organization_id` is required. Submitting
245250
* an empty `query` returns all non-deleted Members within the specified Organizations.
246251
*
247-
* *All fuzzy search filters require a minimum of three characters.
252+
* All fuzzy search filters require a minimum of three characters.
248253
*/
249254
public suspend fun search(
250255
data: SearchRequest,
251256
methodOptions: SearchRequestOptions? = null,
252257
): StytchResult<SearchResponse>
253258

254259
/**
260+
*
261+
* **Warning**: This endpoint is not recommended for use in login flows. Scaling issues may occur, as search performance
262+
* may vary from ~150 milliseconds to 9 seconds depending on query complexity and rate limits are set to 100
263+
* requests/second.
264+
*
255265
* Search for Members within specified Organizations. An array with at least one `organization_id` is required. Submitting
256266
* an empty `query` returns all non-deleted Members within the specified Organizations.
257267
*
258-
* *All fuzzy search filters require a minimum of three characters.
268+
* All fuzzy search filters require a minimum of three characters.
259269
*/
260270
public fun search(
261271
data: SearchRequest,
@@ -264,10 +274,15 @@ public interface Members {
264274
)
265275

266276
/**
277+
*
278+
* **Warning**: This endpoint is not recommended for use in login flows. Scaling issues may occur, as search performance
279+
* may vary from ~150 milliseconds to 9 seconds depending on query complexity and rate limits are set to 100
280+
* requests/second.
281+
*
267282
* Search for Members within specified Organizations. An array with at least one `organization_id` is required. Submitting
268283
* an empty `query` returns all non-deleted Members within the specified Organizations.
269284
*
270-
* *All fuzzy search filters require a minimum of three characters.
285+
* All fuzzy search filters require a minimum of three characters.
271286
*/
272287
public fun searchCompletable(
273288
data: SearchRequest,

‎stytch/src/main/kotlin/com/stytch/java/b2b/models/discoveryintermediatesessions/DiscoveryIntermediateSessions.kt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import com.stytch.java.b2b.models.organizations.Member
1313
import com.stytch.java.b2b.models.organizations.Organization
1414
import com.stytch.java.b2b.models.sessions.MemberSession
1515
import com.stytch.java.b2b.models.sessions.PrimaryRequired
16+
import com.stytch.java.consumer.models.devicehistory.DeviceInfo
1617

1718
@JsonClass(generateAdapter = false)
1819
public enum class ExchangeRequestLocale {
@@ -113,6 +114,13 @@ public data class ExchangeRequest
113114
*/
114115
@Json(name = "locale")
115116
val locale: ExchangeRequestLocale? = null,
117+
/**
118+
* If the `telemetry_id` is passed, as part of this request, Stytch will call the
119+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) and store the associated fingerprints
120+
* and IPGEO information for the Member. Your workspace must be enabled for Device Fingerprinting to use this feature.
121+
*/
122+
@Json(name = "telemetry_id")
123+
val telemetryId: String? = null,
116124
)
117125

118126
/**
@@ -194,4 +202,11 @@ public data class ExchangeResponse
194202
*/
195203
@Json(name = "primary_required")
196204
val primaryRequired: PrimaryRequired? = null,
205+
/**
206+
* If a valid `telemetry_id` was passed in the request and the
207+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the `member_device`
208+
* response field will contain information about the member's device attributes.
209+
*/
210+
@Json(name = "member_device")
211+
val memberDevice: DeviceInfo? = null,
197212
)

‎stytch/src/main/kotlin/com/stytch/java/b2b/models/discoveryorganizations/DiscoveryOrganizations.kt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import com.stytch.java.b2b.models.organizations.Member
1515
import com.stytch.java.b2b.models.organizations.Organization
1616
import com.stytch.java.b2b.models.sessions.MemberSession
1717
import com.stytch.java.b2b.models.sessions.PrimaryRequired
18+
import com.stytch.java.consumer.models.devicehistory.DeviceInfo
1819

1920
@JsonClass(generateAdapter = false)
2021
public enum class CreateRequestFirstPartyConnectedAppsAllowedType {
@@ -283,6 +284,13 @@ public data class CreateRequest
283284
*/
284285
@Json(name = "allowed_third_party_connected_apps")
285286
val allowedThirdPartyConnectedApps: List<String>? = emptyList(),
287+
/**
288+
* If the `telemetry_id` is passed, as part of this request, Stytch will call the
289+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) and store the associated fingerprints
290+
* and IPGEO information for the Member. Your workspace must be enabled for Device Fingerprinting to use this feature.
291+
*/
292+
@Json(name = "telemetry_id")
293+
val telemetryId: String? = null,
286294
)
287295

288296
/**
@@ -364,6 +372,13 @@ public data class CreateResponse
364372
*/
365373
@Json(name = "primary_required")
366374
val primaryRequired: PrimaryRequired? = null,
375+
/**
376+
* If a valid `telemetry_id` was passed in the request and the
377+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the `member_device`
378+
* response field will contain information about the member's device attributes.
379+
*/
380+
@Json(name = "member_device")
381+
val memberDevice: DeviceInfo? = null,
367382
)
368383

369384
/**

‎stytch/src/main/kotlin/com/stytch/java/b2b/models/magiclinks/MagicLinks.kt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import com.stytch.java.b2b.models.organizations.Member
1313
import com.stytch.java.b2b.models.organizations.Organization
1414
import com.stytch.java.b2b.models.sessions.MemberSession
1515
import com.stytch.java.b2b.models.sessions.PrimaryRequired
16+
import com.stytch.java.consumer.models.devicehistory.DeviceInfo
1617

1718
@JsonClass(generateAdapter = false)
1819
public enum class AuthenticateRequestLocale {
@@ -115,6 +116,13 @@ public data class AuthenticateRequest
115116
*/
116117
@Json(name = "intermediate_session_token")
117118
val intermediateSessionToken: String? = null,
119+
/**
120+
* If the `telemetry_id` is passed, as part of this request, Stytch will call the
121+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) and store the associated fingerprints
122+
* and IPGEO information for the Member. Your workspace must be enabled for Device Fingerprinting to use this feature.
123+
*/
124+
@Json(name = "telemetry_id")
125+
val telemetryId: String? = null,
118126
)
119127

120128
/**
@@ -209,4 +217,11 @@ public data class AuthenticateResponse
209217
val mfaRequired: MfaRequired? = null,
210218
@Json(name = "primary_required")
211219
val primaryRequired: PrimaryRequired? = null,
220+
/**
221+
* If a valid `telemetry_id` was passed in the request and the
222+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the `member_device`
223+
* response field will contain information about the member's device attributes.
224+
*/
225+
@Json(name = "member_device")
226+
val memberDevice: DeviceInfo? = null,
212227
)

‎stytch/src/main/kotlin/com/stytch/java/b2b/models/oauth/OAuth.kt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import com.stytch.java.b2b.models.organizations.Member
1313
import com.stytch.java.b2b.models.organizations.Organization
1414
import com.stytch.java.b2b.models.sessions.MemberSession
1515
import com.stytch.java.b2b.models.sessions.PrimaryRequired
16+
import com.stytch.java.consumer.models.devicehistory.DeviceInfo
1617
import java.time.Instant
1718

1819
@JsonClass(generateAdapter = false)
@@ -151,6 +152,13 @@ public data class AuthenticateRequest
151152
*/
152153
@Json(name = "intermediate_session_token")
153154
val intermediateSessionToken: String? = null,
155+
/**
156+
* If the `telemetry_id` is passed, as part of this request, Stytch will call the
157+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) and store the associated fingerprints
158+
* and IPGEO information for the Member. Your workspace must be enabled for Device Fingerprinting to use this feature.
159+
*/
160+
@Json(name = "telemetry_id")
161+
val telemetryId: String? = null,
154162
)
155163

156164
/**
@@ -263,4 +271,11 @@ public data class AuthenticateResponse
263271
*/
264272
@Json(name = "primary_required")
265273
val primaryRequired: PrimaryRequired? = null,
274+
/**
275+
* If a valid `telemetry_id` was passed in the request and the
276+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the `member_device`
277+
* response field will contain information about the member's device attributes.
278+
*/
279+
@Json(name = "member_device")
280+
val memberDevice: DeviceInfo? = null,
266281
)

‎stytch/src/main/kotlin/com/stytch/java/b2b/models/otpemail/OTPEmail.kt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import com.stytch.java.b2b.models.organizations.Member
1313
import com.stytch.java.b2b.models.organizations.Organization
1414
import com.stytch.java.b2b.models.sessions.MemberSession
1515
import com.stytch.java.b2b.models.sessions.PrimaryRequired
16+
import com.stytch.java.consumer.models.devicehistory.DeviceInfo
1617

1718
@JsonClass(generateAdapter = false)
1819
public enum class AuthenticateRequestLocale {
@@ -133,6 +134,13 @@ public data class AuthenticateRequest
133134
*/
134135
@Json(name = "locale")
135136
val locale: AuthenticateRequestLocale? = null,
137+
/**
138+
* If the `telemetry_id` is passed, as part of this request, Stytch will call the
139+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) and store the associated fingerprints
140+
* and IPGEO information for the Member. Your workspace must be enabled for Device Fingerprinting to use this feature.
141+
*/
142+
@Json(name = "telemetry_id")
143+
val telemetryId: String? = null,
136144
)
137145

138146
/**
@@ -222,6 +230,13 @@ public data class AuthenticateResponse
222230
val mfaRequired: MfaRequired? = null,
223231
@Json(name = "primary_required")
224232
val primaryRequired: PrimaryRequired? = null,
233+
/**
234+
* If a valid `telemetry_id` was passed in the request and the
235+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the `member_device`
236+
* response field will contain information about the member's device attributes.
237+
*/
238+
@Json(name = "member_device")
239+
val memberDevice: DeviceInfo? = null,
225240
)
226241

227242
/**

‎stytch/src/main/kotlin/com/stytch/java/b2b/models/otpsms/OTPSms.kt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import com.squareup.moshi.JsonClass
1111
import com.stytch.java.b2b.models.organizations.Member
1212
import com.stytch.java.b2b.models.organizations.Organization
1313
import com.stytch.java.b2b.models.sessions.MemberSession
14+
import com.stytch.java.consumer.models.devicehistory.DeviceInfo
1415

1516
@JsonClass(generateAdapter = false)
1617
public enum class SendRequestLocale {
@@ -132,6 +133,13 @@ public data class AuthenticateRequest
132133
val setMfaEnrollment: String? = null,
133134
@Json(name = "set_default_mfa")
134135
val setDefaultMfa: Boolean? = null,
136+
/**
137+
* If the `telemetry_id` is passed, as part of this request, Stytch will call the
138+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) and store the associated fingerprints
139+
* and IPGEO information for the Member. Your workspace must be enabled for Device Fingerprinting to use this feature.
140+
*/
141+
@Json(name = "telemetry_id")
142+
val telemetryId: String? = null,
135143
)
136144

137145
/**
@@ -183,6 +191,13 @@ public data class AuthenticateResponse
183191
*/
184192
@Json(name = "member_session")
185193
val memberSession: MemberSession? = null,
194+
/**
195+
* If a valid `telemetry_id` was passed in the request and the
196+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the `member_device`
197+
* response field will contain information about the member's device attributes.
198+
*/
199+
@Json(name = "member_device")
200+
val memberDevice: DeviceInfo? = null,
186201
)
187202

188203
/**

‎stytch/src/main/kotlin/com/stytch/java/b2b/models/passwords/Passwords.kt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import com.stytch.java.b2b.models.organizations.Member
1313
import com.stytch.java.b2b.models.organizations.Organization
1414
import com.stytch.java.b2b.models.sessions.MemberSession
1515
import com.stytch.java.b2b.models.sessions.PrimaryRequired
16+
import com.stytch.java.consumer.models.devicehistory.DeviceInfo
1617
import com.stytch.java.consumer.models.passwords.Argon2Config
1718
import com.stytch.java.consumer.models.passwords.MD5Config
1819
import com.stytch.java.consumer.models.passwords.PBKDF2Config
@@ -203,6 +204,13 @@ public data class AuthenticateRequest
203204
*/
204205
@Json(name = "intermediate_session_token")
205206
val intermediateSessionToken: String? = null,
207+
/**
208+
* If the `telemetry_id` is passed, as part of this request, Stytch will call the
209+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) and store the associated fingerprints
210+
* and IPGEO information for the Member. Your workspace must be enabled for Device Fingerprinting to use this feature.
211+
*/
212+
@Json(name = "telemetry_id")
213+
val telemetryId: String? = null,
206214
)
207215

208216
/**
@@ -287,6 +295,13 @@ public data class AuthenticateResponse
287295
*/
288296
@Json(name = "primary_required")
289297
val primaryRequired: PrimaryRequired? = null,
298+
/**
299+
* If a valid `telemetry_id` was passed in the request and the
300+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the `member_device`
301+
* response field will contain information about the member's device attributes.
302+
*/
303+
@Json(name = "member_device")
304+
val memberDevice: DeviceInfo? = null,
290305
)
291306

292307
/**

‎stytch/src/main/kotlin/com/stytch/java/b2b/models/passwordsemail/PasswordsEmail.kt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import com.stytch.java.b2b.models.organizations.Organization
1414
import com.stytch.java.b2b.models.sessions.MemberSession
1515
import com.stytch.java.b2b.models.sessions.PrimaryRequired
1616
import com.stytch.java.common.methodoptions.Authorization
17+
import com.stytch.java.consumer.models.devicehistory.DeviceInfo
1718

1819
@JsonClass(generateAdapter = false)
1920
public enum class ResetRequestLocale {
@@ -219,6 +220,13 @@ public data class ResetRequest
219220
*/
220221
@Json(name = "intermediate_session_token")
221222
val intermediateSessionToken: String? = null,
223+
/**
224+
* If the `telemetry_id` is passed, as part of this request, Stytch will call the
225+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) and store the associated fingerprints
226+
* and IPGEO information for the Member. Your workspace must be enabled for Device Fingerprinting to use this feature.
227+
*/
228+
@Json(name = "telemetry_id")
229+
val telemetryId: String? = null,
222230
)
223231

224232
/**
@@ -308,6 +316,13 @@ public data class ResetResponse
308316
*/
309317
@Json(name = "primary_required")
310318
val primaryRequired: PrimaryRequired? = null,
319+
/**
320+
* If a valid `telemetry_id` was passed in the request and the
321+
* [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the `member_device`
322+
* response field will contain information about the member's device attributes.
323+
*/
324+
@Json(name = "member_device")
325+
val memberDevice: DeviceInfo? = null,
311326
)
312327

313328
/**

0 commit comments

Comments
 (0)