@noresponse/node 4.0.0 → 5.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.
Files changed (203) hide show
  1. package/CHANGELOG.md +39 -0
  2. package/README.md +9 -9
  3. package/dist/commonjs/client.d.ts +2 -2
  4. package/dist/commonjs/client.js +2 -2
  5. package/dist/commonjs/funcs/accounts-list-assessments.d.ts +1 -1
  6. package/dist/commonjs/funcs/accounts-list-assessments.js +1 -1
  7. package/dist/commonjs/funcs/assessments-create.d.ts +1 -1
  8. package/dist/commonjs/funcs/assessments-create.js +1 -1
  9. package/dist/commonjs/funcs/assessments-get.d.ts +1 -1
  10. package/dist/commonjs/funcs/assessments-get.js +1 -1
  11. package/dist/commonjs/funcs/assessments-query.d.ts +1 -1
  12. package/dist/commonjs/funcs/assessments-query.js +1 -1
  13. package/dist/commonjs/funcs/integrations-list.d.ts +1 -1
  14. package/dist/commonjs/funcs/integrations-list.js +1 -1
  15. package/dist/commonjs/funcs/key-usage-record.d.ts +2 -2
  16. package/dist/commonjs/funcs/key-usage-record.js +2 -2
  17. package/dist/commonjs/funcs/webhook-endpoints-list-deliveries.d.ts +1 -1
  18. package/dist/commonjs/funcs/webhook-endpoints-list-deliveries.js +1 -1
  19. package/dist/commonjs/funcs/webhook-endpoints-list.d.ts +1 -1
  20. package/dist/commonjs/funcs/webhook-endpoints-list.js +1 -1
  21. package/dist/commonjs/index.d.ts +1 -1
  22. package/dist/commonjs/index.d.ts.map +1 -1
  23. package/dist/commonjs/issued-credential.d.ts +1 -1
  24. package/dist/commonjs/issued-credential.js +1 -1
  25. package/dist/commonjs/key-usage.js +2 -2
  26. package/dist/commonjs/lib/config.d.ts +2 -2
  27. package/dist/commonjs/lib/config.js +2 -2
  28. package/dist/commonjs/models/account-decisions-by-flow.d.ts +2 -2
  29. package/dist/commonjs/models/account-decisions-by-flow.d.ts.map +1 -1
  30. package/dist/commonjs/models/account-decisions-by-flow.js +8 -3
  31. package/dist/commonjs/models/account-decisions-by-flow.js.map +1 -1
  32. package/dist/commonjs/models/account-deletion.d.ts +1 -1
  33. package/dist/commonjs/models/account.d.ts +3 -3
  34. package/dist/commonjs/models/assessment-deletion.d.ts +1 -1
  35. package/dist/commonjs/models/assessment-detail-auth-context.d.ts +1 -1
  36. package/dist/commonjs/models/assessment-detail.d.ts +4 -4
  37. package/dist/commonjs/models/assessment-list.d.ts +3 -3
  38. package/dist/commonjs/models/assessment-outcome-request.d.ts +2 -2
  39. package/dist/commonjs/models/assessment-outcome.d.ts +3 -3
  40. package/dist/commonjs/models/assessment-query.d.ts +2 -2
  41. package/dist/commonjs/models/assessment-request-client-context.d.ts +4 -4
  42. package/dist/commonjs/models/assessment-request-identifiers.d.ts +1 -1
  43. package/dist/commonjs/models/assessment-request-issued-credential.d.ts +1 -1
  44. package/dist/commonjs/models/assessment-request-policy-context.d.ts +1 -1
  45. package/dist/commonjs/models/assessment-request.d.ts +5 -5
  46. package/dist/commonjs/models/assessment.d.ts +2 -2
  47. package/dist/commonjs/models/auth-context.d.ts +1 -1
  48. package/dist/commonjs/models/flow.d.ts +3 -3
  49. package/dist/commonjs/models/flow.js +2 -2
  50. package/dist/commonjs/models/flow.js.map +1 -1
  51. package/dist/commonjs/models/integration-list.d.ts +1 -1
  52. package/dist/commonjs/models/integration-request.d.ts +1 -1
  53. package/dist/commonjs/models/integration.d.ts +1 -1
  54. package/dist/commonjs/models/ip-summary.d.ts +3 -3
  55. package/dist/commonjs/models/ip-summary.d.ts.map +1 -1
  56. package/dist/commonjs/models/ip-summary.js +2 -2
  57. package/dist/commonjs/models/ip-summary.js.map +1 -1
  58. package/dist/commonjs/models/key-rotation-request.d.ts +1 -1
  59. package/dist/commonjs/models/key-usage-batch-request.d.ts +1 -1
  60. package/dist/commonjs/models/operations/create-assessment.d.ts +1 -1
  61. package/dist/commonjs/models/operations/delete-account.d.ts +1 -1
  62. package/dist/commonjs/models/operations/delete-integration.d.ts +1 -1
  63. package/dist/commonjs/models/operations/delete-webhook-endpoint.d.ts +1 -1
  64. package/dist/commonjs/models/operations/get-account.d.ts +1 -1
  65. package/dist/commonjs/models/operations/list-account-assessments.d.ts +1 -1
  66. package/dist/commonjs/models/operations/list-webhook-deliveries.d.ts +1 -1
  67. package/dist/commonjs/models/operations/record-assessment-outcome.d.ts +1 -1
  68. package/dist/commonjs/models/operations/record-key-usage.d.ts +1 -1
  69. package/dist/commonjs/models/operations/replay-webhook-delivery.d.ts +2 -2
  70. package/dist/commonjs/models/operations/rotate-integration-secret.d.ts +1 -1
  71. package/dist/commonjs/models/operations/rotate-webhook-signing-key.d.ts +1 -1
  72. package/dist/commonjs/models/operations/send-webhook-test-event.d.ts +1 -1
  73. package/dist/commonjs/models/outcome.d.ts +2 -2
  74. package/dist/commonjs/models/outcome.js +1 -1
  75. package/dist/commonjs/models/permission-denied-error-code.d.ts +1 -1
  76. package/dist/commonjs/models/permission-denied-error-code.js +1 -1
  77. package/dist/commonjs/models/permission-denied-error-code.js.map +1 -1
  78. package/dist/commonjs/models/reason-code.d.ts +1 -1
  79. package/dist/commonjs/models/reason-code.js +1 -1
  80. package/dist/commonjs/models/reason-code.js.map +1 -1
  81. package/dist/commonjs/models/risk-summary.d.ts +1 -1
  82. package/dist/commonjs/models/risk.d.ts +3 -3
  83. package/dist/commonjs/models/signal.d.ts +1 -1
  84. package/dist/commonjs/models/webhook-delivery-list.d.ts +2 -2
  85. package/dist/commonjs/models/webhook-endpoint-created.d.ts +1 -1
  86. package/dist/commonjs/models/webhook-endpoint-list.d.ts +1 -1
  87. package/dist/commonjs/models/webhook-endpoint-request.d.ts +1 -1
  88. package/dist/commonjs/models/webhook-endpoint.d.ts +1 -1
  89. package/dist/commonjs/sdk/accounts.d.ts +1 -1
  90. package/dist/commonjs/sdk/accounts.js +1 -1
  91. package/dist/commonjs/sdk/assessments.d.ts +3 -3
  92. package/dist/commonjs/sdk/assessments.js +3 -3
  93. package/dist/commonjs/sdk/integrations.d.ts +1 -1
  94. package/dist/commonjs/sdk/integrations.js +1 -1
  95. package/dist/commonjs/sdk/key-usage.d.ts +2 -2
  96. package/dist/commonjs/sdk/key-usage.js +2 -2
  97. package/dist/commonjs/sdk/webhook-endpoints.d.ts +2 -2
  98. package/dist/commonjs/sdk/webhook-endpoints.js +2 -2
  99. package/dist/commonjs/webhooks.d.ts +5 -5
  100. package/dist/commonjs/webhooks.d.ts.map +1 -1
  101. package/dist/commonjs/webhooks.js +2 -2
  102. package/dist/commonjs/webhooks.js.map +1 -1
  103. package/dist/esm/client.d.ts +2 -2
  104. package/dist/esm/client.js +2 -2
  105. package/dist/esm/funcs/accounts-list-assessments.d.ts +1 -1
  106. package/dist/esm/funcs/accounts-list-assessments.js +1 -1
  107. package/dist/esm/funcs/assessments-create.d.ts +1 -1
  108. package/dist/esm/funcs/assessments-create.js +1 -1
  109. package/dist/esm/funcs/assessments-get.d.ts +1 -1
  110. package/dist/esm/funcs/assessments-get.js +1 -1
  111. package/dist/esm/funcs/assessments-query.d.ts +1 -1
  112. package/dist/esm/funcs/assessments-query.js +1 -1
  113. package/dist/esm/funcs/integrations-list.d.ts +1 -1
  114. package/dist/esm/funcs/integrations-list.js +1 -1
  115. package/dist/esm/funcs/key-usage-record.d.ts +2 -2
  116. package/dist/esm/funcs/key-usage-record.js +2 -2
  117. package/dist/esm/funcs/webhook-endpoints-list-deliveries.d.ts +1 -1
  118. package/dist/esm/funcs/webhook-endpoints-list-deliveries.js +1 -1
  119. package/dist/esm/funcs/webhook-endpoints-list.d.ts +1 -1
  120. package/dist/esm/funcs/webhook-endpoints-list.js +1 -1
  121. package/dist/esm/index.d.ts +1 -1
  122. package/dist/esm/index.d.ts.map +1 -1
  123. package/dist/esm/issued-credential.d.ts +1 -1
  124. package/dist/esm/issued-credential.js +1 -1
  125. package/dist/esm/key-usage.js +2 -2
  126. package/dist/esm/lib/config.d.ts +2 -2
  127. package/dist/esm/lib/config.js +2 -2
  128. package/dist/esm/models/account-decisions-by-flow.d.ts +2 -2
  129. package/dist/esm/models/account-decisions-by-flow.d.ts.map +1 -1
  130. package/dist/esm/models/account-decisions-by-flow.js +8 -3
  131. package/dist/esm/models/account-decisions-by-flow.js.map +1 -1
  132. package/dist/esm/models/account-deletion.d.ts +1 -1
  133. package/dist/esm/models/account.d.ts +3 -3
  134. package/dist/esm/models/assessment-deletion.d.ts +1 -1
  135. package/dist/esm/models/assessment-detail-auth-context.d.ts +1 -1
  136. package/dist/esm/models/assessment-detail.d.ts +4 -4
  137. package/dist/esm/models/assessment-list.d.ts +3 -3
  138. package/dist/esm/models/assessment-outcome-request.d.ts +2 -2
  139. package/dist/esm/models/assessment-outcome.d.ts +3 -3
  140. package/dist/esm/models/assessment-query.d.ts +2 -2
  141. package/dist/esm/models/assessment-request-client-context.d.ts +4 -4
  142. package/dist/esm/models/assessment-request-identifiers.d.ts +1 -1
  143. package/dist/esm/models/assessment-request-issued-credential.d.ts +1 -1
  144. package/dist/esm/models/assessment-request-policy-context.d.ts +1 -1
  145. package/dist/esm/models/assessment-request.d.ts +5 -5
  146. package/dist/esm/models/assessment.d.ts +2 -2
  147. package/dist/esm/models/auth-context.d.ts +1 -1
  148. package/dist/esm/models/flow.d.ts +3 -3
  149. package/dist/esm/models/flow.js +2 -2
  150. package/dist/esm/models/flow.js.map +1 -1
  151. package/dist/esm/models/integration-list.d.ts +1 -1
  152. package/dist/esm/models/integration-request.d.ts +1 -1
  153. package/dist/esm/models/integration.d.ts +1 -1
  154. package/dist/esm/models/ip-summary.d.ts +3 -3
  155. package/dist/esm/models/ip-summary.d.ts.map +1 -1
  156. package/dist/esm/models/ip-summary.js +2 -2
  157. package/dist/esm/models/ip-summary.js.map +1 -1
  158. package/dist/esm/models/key-rotation-request.d.ts +1 -1
  159. package/dist/esm/models/key-usage-batch-request.d.ts +1 -1
  160. package/dist/esm/models/operations/create-assessment.d.ts +1 -1
  161. package/dist/esm/models/operations/delete-account.d.ts +1 -1
  162. package/dist/esm/models/operations/delete-integration.d.ts +1 -1
  163. package/dist/esm/models/operations/delete-webhook-endpoint.d.ts +1 -1
  164. package/dist/esm/models/operations/get-account.d.ts +1 -1
  165. package/dist/esm/models/operations/list-account-assessments.d.ts +1 -1
  166. package/dist/esm/models/operations/list-webhook-deliveries.d.ts +1 -1
  167. package/dist/esm/models/operations/record-assessment-outcome.d.ts +1 -1
  168. package/dist/esm/models/operations/record-key-usage.d.ts +1 -1
  169. package/dist/esm/models/operations/replay-webhook-delivery.d.ts +2 -2
  170. package/dist/esm/models/operations/rotate-integration-secret.d.ts +1 -1
  171. package/dist/esm/models/operations/rotate-webhook-signing-key.d.ts +1 -1
  172. package/dist/esm/models/operations/send-webhook-test-event.d.ts +1 -1
  173. package/dist/esm/models/outcome.d.ts +2 -2
  174. package/dist/esm/models/outcome.js +1 -1
  175. package/dist/esm/models/permission-denied-error-code.d.ts +1 -1
  176. package/dist/esm/models/permission-denied-error-code.js +1 -1
  177. package/dist/esm/models/permission-denied-error-code.js.map +1 -1
  178. package/dist/esm/models/reason-code.d.ts +1 -1
  179. package/dist/esm/models/reason-code.js +1 -1
  180. package/dist/esm/models/reason-code.js.map +1 -1
  181. package/dist/esm/models/risk-summary.d.ts +1 -1
  182. package/dist/esm/models/risk.d.ts +3 -3
  183. package/dist/esm/models/signal.d.ts +1 -1
  184. package/dist/esm/models/webhook-delivery-list.d.ts +2 -2
  185. package/dist/esm/models/webhook-endpoint-created.d.ts +1 -1
  186. package/dist/esm/models/webhook-endpoint-list.d.ts +1 -1
  187. package/dist/esm/models/webhook-endpoint-request.d.ts +1 -1
  188. package/dist/esm/models/webhook-endpoint.d.ts +1 -1
  189. package/dist/esm/sdk/accounts.d.ts +1 -1
  190. package/dist/esm/sdk/accounts.js +1 -1
  191. package/dist/esm/sdk/assessments.d.ts +3 -3
  192. package/dist/esm/sdk/assessments.js +3 -3
  193. package/dist/esm/sdk/integrations.d.ts +1 -1
  194. package/dist/esm/sdk/integrations.js +1 -1
  195. package/dist/esm/sdk/key-usage.d.ts +2 -2
  196. package/dist/esm/sdk/key-usage.js +2 -2
  197. package/dist/esm/sdk/webhook-endpoints.d.ts +2 -2
  198. package/dist/esm/sdk/webhook-endpoints.js +2 -2
  199. package/dist/esm/webhooks.d.ts +5 -5
  200. package/dist/esm/webhooks.d.ts.map +1 -1
  201. package/dist/esm/webhooks.js +2 -2
  202. package/dist/esm/webhooks.js.map +1 -1
  203. package/package.json +1 -1
@@ -3,7 +3,7 @@ import { Result as SafeParseResult } from "../types/fp.js";
3
3
  import { AssessmentDetail } from "./assessment-detail.js";
4
4
  import { SDKValidationError } from "./errors/sdk-validation-error.js";
5
5
  /**
6
- * Body of the 200 answer to POST /v1/assessments/query: one page of the calling tenant's unexpired assessments for one account, newest first, each at its latest assessment_version, as its detail; the account's current risk is GET /v1/accounts/{account_id}. Every item's account_id equals the page's. An assessment past its expires_at is not listed. next_cursor is present only when another page exists.
6
+ * Body of the 200 answer to POST /v1/assessments/query: one page of the calling workspace's unexpired assessments for one account, newest first, each at its latest assessment_version, as its detail; the account's current risk is GET /v1/accounts/{account_id}. Every item's account_id equals the page's. An assessment past its expires_at is not listed. next_cursor is present only when another page exists.
7
7
  */
8
8
  export type AssessmentList = {
9
9
  /**
@@ -11,12 +11,12 @@ export type AssessmentList = {
11
11
  */
12
12
  schemaVersion: "1";
13
13
  /**
14
- * Your own opaque identifier for the account being checked, scoped to your tenant. Use an id you mint, with no direct identifier (email, phone, name or national id) in it. '|' is accepted so an Auth0 user id such as 'auth0|64abc' passes unchanged; '@', '+', '$' and whitespace are refused by the pattern, as is an exact-shape JWT; a hex digest such as a SHA-256 is allowed, because hashing an internal id is a common pseudonymous scheme. A value such as '07700900123' or 'jane.doe.gmail.com' cannot be told apart from an opaque id. It travels in bodies, and in a URL only as the path segment of GET /v1/accounts/{account_id} and its /assessments. An assessment requested by a provider hook at pre_registration, which has no account yet, carries the server-issued account_id pre: followed by its assessment_id.
14
+ * Your own opaque identifier for the account being checked, scoped to your workspace. Use an id you mint, with no direct identifier (email, phone, name or national id) in it. '|' is accepted so an Auth0 user id such as 'auth0|64abc' passes unchanged; '@', '+', '$' and whitespace are refused by the pattern, as is an exact-shape JWT; a hex digest such as a SHA-256 is allowed, because hashing an internal id is a common pseudonymous scheme. A value such as '07700900123' or 'jane.doe.gmail.com' cannot be told apart from an opaque id. It travels in bodies, and in a URL only as the path segment of GET /v1/accounts/{account_id} and its /assessments. An assessment requested by a provider hook at pre_registration, which has no account yet, carries the server-issued account_id pre: followed by its assessment_id.
15
15
  */
16
16
  accountId: string;
17
17
  items: Array<AssessmentDetail>;
18
18
  /**
19
- * Opaque cursor for the next page, bound to your tenant and the account_id it was issued for. Pass it back unchanged in the next query; a tampered, foreign or expired cursor answers 400 invalid_cursor.
19
+ * Opaque cursor for the next page, bound to your workspace and the account_id it was issued for. Pass it back unchanged in the next query; a tampered, foreign or expired cursor answers 400 invalid_cursor.
20
20
  */
21
21
  nextCursor?: string | undefined;
22
22
  /**
@@ -1,11 +1,11 @@
1
1
  import * as z from "zod/v4-mini";
2
2
  import { Outcome } from "./outcome.js";
3
3
  /**
4
- * POST /v1/assessments/{assessment_id}/outcomes body: what the provider later learned about the account it assessed. The assessment is named by the path and the tenant by the API key, so neither is a body member. Idempotency-Key is required and binds the body as it does on POST /v1/assessments.
4
+ * POST /v1/assessments/{assessment_id}/outcomes body: what the provider later learned about the account it assessed. The assessment is named by the path and the workspace by the API key, so neither is a body member. Idempotency-Key is required and binds the body as it does on POST /v1/assessments.
5
5
  */
6
6
  export type AssessmentOutcomeRequest = {
7
7
  /**
8
- * What the provider later learned about the assessed account. confirmed_abuse, account_takeover and chargeback report abuse; false_positive and legitimate withdraw an earlier abuse report of this tenant for the assessment; unknown is recorded only. Outcomes are append-only and the latest one recorded for an assessment wins.
8
+ * What the provider later learned about the assessed account. confirmed_abuse, account_takeover and chargeback report abuse; false_positive and legitimate withdraw an earlier abuse report of this workspace for the assessment; unknown is recorded only. Outcomes are append-only and the latest one recorded for an assessment wins.
9
9
  */
10
10
  outcome: Outcome;
11
11
  /**
@@ -7,15 +7,15 @@ import { Outcome } from "./outcome.js";
7
7
  */
8
8
  export type AssessmentOutcome = {
9
9
  /**
10
- * Opaque, server-assigned id of one recorded outcome: 'out_' and a 26-character Crockford base32 ULID. Unique within the tenant.
10
+ * Opaque, server-assigned id of one recorded outcome: 'out_' and a 26-character Crockford base32 ULID. Unique within the workspace.
11
11
  */
12
12
  id: string;
13
13
  /**
14
- * Opaque, server-assigned assessment id: 'asm_' and a 26-character Crockford base32 ULID. Unique within the tenant; another tenant's assessment id answers 404.
14
+ * Opaque, server-assigned assessment id: 'asm_' and a 26-character Crockford base32 ULID. Unique within the workspace; another workspace's assessment id answers 404.
15
15
  */
16
16
  assessmentId: string;
17
17
  /**
18
- * What the provider later learned about the assessed account. confirmed_abuse, account_takeover and chargeback report abuse; false_positive and legitimate withdraw an earlier abuse report of this tenant for the assessment; unknown is recorded only. Outcomes are append-only and the latest one recorded for an assessment wins.
18
+ * What the provider later learned about the assessed account. confirmed_abuse, account_takeover and chargeback report abuse; false_positive and legitimate withdraw an earlier abuse report of this workspace for the assessment; unknown is recorded only. Outcomes are append-only and the latest one recorded for an assessment wins.
19
19
  */
20
20
  outcome: Outcome;
21
21
  /**
@@ -5,12 +5,12 @@ import { ResponseMode } from "./response-mode.js";
5
5
  */
6
6
  export type AssessmentQuery = {
7
7
  /**
8
- * Your own opaque identifier for the account being checked, scoped to your tenant. Use an id you mint, with no direct identifier (email, phone, name or national id) in it. '|' is accepted so an Auth0 user id such as 'auth0|64abc' passes unchanged; '@', '+', '$' and whitespace are refused by the pattern, as is an exact-shape JWT; a hex digest such as a SHA-256 is allowed, because hashing an internal id is a common pseudonymous scheme. A value such as '07700900123' or 'jane.doe.gmail.com' cannot be told apart from an opaque id. It travels in bodies, and in a URL only as the path segment of GET /v1/accounts/{account_id} and its /assessments. An assessment requested by a provider hook at pre_registration, which has no account yet, carries the server-issued account_id pre: followed by its assessment_id.
8
+ * Your own opaque identifier for the account being checked, scoped to your workspace. Use an id you mint, with no direct identifier (email, phone, name or national id) in it. '|' is accepted so an Auth0 user id such as 'auth0|64abc' passes unchanged; '@', '+', '$' and whitespace are refused by the pattern, as is an exact-shape JWT; a hex digest such as a SHA-256 is allowed, because hashing an internal id is a common pseudonymous scheme. A value such as '07700900123' or 'jane.doe.gmail.com' cannot be told apart from an opaque id. It travels in bodies, and in a URL only as the path segment of GET /v1/accounts/{account_id} and its /assessments. An assessment requested by a provider hook at pre_registration, which has no account yet, carries the server-issued account_id pre: followed by its assessment_id.
9
9
  */
10
10
  accountId: string;
11
11
  limit?: number | undefined;
12
12
  /**
13
- * next_cursor from the previous page, unchanged. Opaque, MAC'd and bound to the tenant and account_id.
13
+ * next_cursor from the previous page, unchanged. Opaque, MAC'd and bound to the workspace and account_id.
14
14
  */
15
15
  cursor?: string | undefined;
16
16
  /**
@@ -1,7 +1,7 @@
1
1
  import * as z from "zod/v4-mini";
2
2
  import { Platform } from "./platform.js";
3
3
  /**
4
- * Optional context observed by your signup client. The server parses these hints into coarse features, leaves raw user_agent and opaque ids out of every answer, and weighs a mismatch with the other evidence.
4
+ * Optional context observed by the client of the user. The server parses these hints into coarse features, leaves raw user_agent and opaque ids out of every answer, and weighs a mismatch with the other evidence.
5
5
  */
6
6
  export type AssessmentRequestClientContext = {
7
7
  /**
@@ -21,15 +21,15 @@ export type AssessmentRequestClientContext = {
21
21
  */
22
22
  appVersion?: string | undefined;
23
23
  /**
24
- * The raw User-Agent header of the signup request, at most 512 characters. It is parsed into coarse features and left out of every answer.
24
+ * The raw User-Agent header of the request that the user sent, at most 512 characters. It is parsed into coarse features and left out of every answer.
25
25
  */
26
26
  userAgent?: string | undefined;
27
27
  /**
28
- * Tenant-scoped opaque identifier your application mints and rotates when the account or device changes. Send an id of your own, not a hardware fingerprint.
28
+ * Workspace-scoped opaque identifier your application mints and rotates when the account or device changes. Send an id of your own, not a hardware fingerprint.
29
29
  */
30
30
  deviceId?: string | undefined;
31
31
  /**
32
- * Opaque signup session identifier. It is used for tenant-scoped velocity and replay checks only.
32
+ * Opaque signup session identifier. It is used for workspace-scoped velocity and replay checks only.
33
33
  */
34
34
  sessionId?: string | undefined;
35
35
  /**
@@ -20,7 +20,7 @@ export type AssessmentRequestIdentifiers = {
20
20
  */
21
21
  name?: string | undefined;
22
22
  /**
23
- * The signup's client IP address: an IPv4 dotted quad without leading zeros, or an IPv6 address in its RFC 5952 text form (lower case, no leading zeros, the longest zero run compressed). Send an IPv4 client as a dotted quad, not IPv4-mapped. No zone, port or prefix. The server refuses a non-canonical IPv6 spelling, and every private, loopback, link-local, multicast, documentation or otherwise reserved address (the IANA special-purpose registries), with 400: only a public address says anything about a signup.
23
+ * The account_creation's client IP address: an IPv4 dotted quad without leading zeros, or an IPv6 address in its RFC 5952 text form (lower case, no leading zeros, the longest zero run compressed). Send an IPv4 client as a dotted quad, not IPv4-mapped. No zone, port or prefix. The server refuses a non-canonical IPv6 spelling, and every private, loopback, link-local, multicast, documentation or otherwise reserved address (the IANA special-purpose registries), with 400: only a public address says anything about a signup.
24
24
  */
25
25
  ip?: string | undefined;
26
26
  };
@@ -1,6 +1,6 @@
1
1
  import * as z from "zod/v4-mini";
2
2
  /**
3
- * Optional. When the signup gate issues an API key to the new account, send SHA-256 of that key, so later usage of the key, or a leaked copy, ties back to this assessment. Each SDK has a helper that computes it. Send only the hash: customer keys are high-entropy, so the hash reveals nothing about them. The assessment stores it, and no response, webhook or log carries it.
3
+ * Optional. When your platform issues an API key to the new account, send SHA-256 of that key, so later usage of the key, or a leaked copy, ties back to this assessment. Each SDK has a helper that computes it. Send only the hash: customer keys are high-entropy, so the hash reveals nothing about them. The assessment stores it, and no response, webhook or log carries it.
4
4
  */
5
5
  export type AssessmentRequestIssuedCredential = {
6
6
  /**
@@ -4,7 +4,7 @@ import * as z from "zod/v4-mini";
4
4
  */
5
5
  export type AssessmentRequestPolicyContext = {
6
6
  /**
7
- * ISO 3166-1 alpha-2 region of the signup, as the provider determines it.
7
+ * ISO 3166-1 alpha-2 region of the user, as the provider determines it.
8
8
  */
9
9
  region?: string | undefined;
10
10
  };
@@ -8,15 +8,15 @@ import { Depth } from "./depth.js";
8
8
  import { Flow } from "./flow.js";
9
9
  import { ResponseMode } from "./response-mode.js";
10
10
  /**
11
- * POST /v1/assessments body. At least one of email, username or phone is required; name and ip only refine an assessment. No field carries a password, hash, token or breach value, and unknown members are refused. The email local part is kept as received and only the domain is lower-cased; the username is compared case-insensitively; the phone is strict E.164 and is assessed asynchronously. The whole body is capped at 32768 bytes. client_context holds bounded hints from the signup client; auth_context holds normalised claims from a session your backend has verified. Raw tokens are refused.
11
+ * POST /v1/assessments body. At least one of email, username or phone is required; name and ip only refine an assessment. No field carries a password, hash, token or breach value, and unknown members are refused. The email local part is kept as received and only the domain is lower-cased; the username is compared case-insensitively; the phone is strict E.164 and is assessed asynchronously. The whole body is capped at 32768 bytes. client_context holds bounded hints from the client of the user; auth_context holds normalised claims from a session your backend has verified. Raw tokens are refused.
12
12
  */
13
13
  export type AssessmentRequest = {
14
14
  /**
15
- * Your own opaque identifier for the account being checked, scoped to your tenant. Use an id you mint, with no direct identifier (email, phone, name or national id) in it. '|' is accepted so an Auth0 user id such as 'auth0|64abc' passes unchanged; '@', '+', '$' and whitespace are refused by the pattern, as is an exact-shape JWT; a hex digest such as a SHA-256 is allowed, because hashing an internal id is a common pseudonymous scheme. A value such as '07700900123' or 'jane.doe.gmail.com' cannot be told apart from an opaque id. It travels in bodies, and in a URL only as the path segment of GET /v1/accounts/{account_id} and its /assessments. An assessment requested by a provider hook at pre_registration, which has no account yet, carries the server-issued account_id pre: followed by its assessment_id.
15
+ * Your own opaque identifier for the account being checked, scoped to your workspace. Use an id you mint, with no direct identifier (email, phone, name or national id) in it. '|' is accepted so an Auth0 user id such as 'auth0|64abc' passes unchanged; '@', '+', '$' and whitespace are refused by the pattern, as is an exact-shape JWT; a hex digest such as a SHA-256 is allowed, because hashing an internal id is a common pseudonymous scheme. A value such as '07700900123' or 'jane.doe.gmail.com' cannot be told apart from an opaque id. It travels in bodies, and in a URL only as the path segment of GET /v1/accounts/{account_id} and its /assessments. An assessment requested by a provider hook at pre_registration, which has no account yet, carries the server-issued account_id pre: followed by its assessment_id.
16
16
  */
17
17
  accountId: string;
18
18
  /**
19
- * The customer event an assessment is made for: signup (a new account), login (a returning sign-in) or purchase (a payment or credit grant). The account's risk is reported with the decision for this flow.
19
+ * The event an assessment is made for: account_creation (a user creates an account), login (a user returns to an existing account) or purchase (a payment or a credit grant). The account's risk is reported with the decision for this flow.
20
20
  */
21
21
  flow: Flow;
22
22
  /**
@@ -44,7 +44,7 @@ export type AssessmentRequest = {
44
44
  */
45
45
  responseMode?: ResponseMode | undefined;
46
46
  /**
47
- * Optional context observed by your signup client. The server parses these hints into coarse features, leaves raw user_agent and opaque ids out of every answer, and weighs a mismatch with the other evidence.
47
+ * Optional context observed by the client of the user. The server parses these hints into coarse features, leaves raw user_agent and opaque ids out of every answer, and weighs a mismatch with the other evidence.
48
48
  */
49
49
  clientContext?: AssessmentRequestClientContext | undefined;
50
50
  /**
@@ -52,7 +52,7 @@ export type AssessmentRequest = {
52
52
  */
53
53
  authContext?: AuthContext | undefined;
54
54
  /**
55
- * Optional. When the signup gate issues an API key to the new account, send SHA-256 of that key, so later usage of the key, or a leaked copy, ties back to this assessment. Each SDK has a helper that computes it. Send only the hash: customer keys are high-entropy, so the hash reveals nothing about them. The assessment stores it, and no response, webhook or log carries it.
55
+ * Optional. When your platform issues an API key to the new account, send SHA-256 of that key, so later usage of the key, or a leaked copy, ties back to this assessment. Each SDK has a helper that computes it. Send only the hash: customer keys are high-entropy, so the hash reveals nothing about them. The assessment stores it, and no response, webhook or log carries it.
56
56
  */
57
57
  issuedCredential?: AssessmentRequestIssuedCredential | undefined;
58
58
  };
@@ -23,7 +23,7 @@ export type Assessment = {
23
23
  */
24
24
  status: Status;
25
25
  /**
26
- * The customer event an assessment is made for: signup (a new account), login (a returning sign-in) or purchase (a payment or credit grant). The account's risk is reported with the decision for this flow.
26
+ * The event an assessment is made for: account_creation (a user creates an account), login (a user returns to an existing account) or purchase (a payment or a credit grant). The account's risk is reported with the decision for this flow.
27
27
  */
28
28
  flow: Flow;
29
29
  /**
@@ -31,7 +31,7 @@ export type Assessment = {
31
31
  */
32
32
  depth: Depth;
33
33
  /**
34
- * Body of the 200 answer to GET /v1/accounts/{account_id}: the one current risk of one of the calling tenant's accounts. It is the risk of the account's latest assessment that has a decision (status complete or partial), by created_at and then assessment_id, scored exactly as GET /v1/assessments/{assessment_id} scores that assessment, plus the account's own reason shared_api_key when a key issued to the account was used from many IP addresses or countries (POST /v1/key_usage/batches). Its assessments are the account's history (GET /v1/accounts/{account_id}/assessments).
34
+ * Body of the 200 answer to GET /v1/accounts/{account_id}: the one current risk of one of the calling workspace's accounts. It is the risk of the account's latest assessment that has a decision (status complete or partial), by created_at and then assessment_id, scored exactly as GET /v1/assessments/{assessment_id} scores that assessment, plus the account's own reason shared_api_key when a key issued to the account was used from many IP addresses or countries (POST /v1/key_usage/batches). Its assessments are the account's history (GET /v1/accounts/{account_id}/assessments).
35
35
  */
36
36
  account?: Account | undefined;
37
37
  /**
@@ -36,7 +36,7 @@ export type AuthContext = {
36
36
  */
37
37
  organizationId?: string | undefined;
38
38
  /**
39
- * The provider tenant identifier, when distinct from organization_id.
39
+ * The provider workspace identifier, when distinct from organization_id.
40
40
  */
41
41
  tenantId?: string | undefined;
42
42
  /**
@@ -1,15 +1,15 @@
1
1
  import * as z from "zod/v4-mini";
2
2
  import { OpenEnum } from "../types/enums.js";
3
3
  /**
4
- * The customer event an assessment is made for: signup (a new account), login (a returning sign-in) or purchase (a payment or credit grant). The account's risk is reported with the decision for this flow.
4
+ * The event an assessment is made for: account_creation (a user creates an account), login (a user returns to an existing account) or purchase (a payment or a credit grant). The account's risk is reported with the decision for this flow.
5
5
  */
6
6
  export declare const Flow: {
7
- readonly Signup: "signup";
7
+ readonly AccountCreation: "account_creation";
8
8
  readonly Login: "login";
9
9
  readonly Purchase: "purchase";
10
10
  };
11
11
  /**
12
- * The customer event an assessment is made for: signup (a new account), login (a returning sign-in) or purchase (a payment or credit grant). The account's risk is reported with the decision for this flow.
12
+ * The event an assessment is made for: account_creation (a user creates an account), login (a user returns to an existing account) or purchase (a payment or a credit grant). The account's risk is reported with the decision for this flow.
13
13
  */
14
14
  export type Flow = OpenEnum<typeof Flow>;
15
15
  /** @internal */
@@ -36,10 +36,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
36
36
  exports.Flow$outboundSchema = exports.Flow$inboundSchema = exports.Flow = void 0;
37
37
  const openEnums = __importStar(require("../types/enums.js"));
38
38
  /**
39
- * The customer event an assessment is made for: signup (a new account), login (a returning sign-in) or purchase (a payment or credit grant). The account's risk is reported with the decision for this flow.
39
+ * The event an assessment is made for: account_creation (a user creates an account), login (a user returns to an existing account) or purchase (a payment or a credit grant). The account's risk is reported with the decision for this flow.
40
40
  */
41
41
  exports.Flow = {
42
- Signup: "signup",
42
+ AccountCreation: "account_creation",
43
43
  Login: "login",
44
44
  Purchase: "purchase",
45
45
  };
@@ -1 +1 @@
1
- {"version":3,"file":"flow.js","sourceRoot":"","sources":["../../../src/models/flow.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,MAAY,SAAS,8CAA0B;AAG/C;;GAEG;AACU,QAAA,IAAI,GAAG;IAClB,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;CACZ,CAAC;AAMX,gBAAgB;AACH,QAAA,kBAAkB,GAAiC,SAAS;KACtE,aAAa,CAAC,QAAA,IAAI,CAAC,CAAC;AACvB,gBAAgB;AACH,QAAA,mBAAmB,GAAgC,SAAS;KACtE,cAAc,CAAC,QAAA,IAAI,CAAC,CAAC"}
1
+ {"version":3,"file":"flow.js","sourceRoot":"","sources":["../../../src/models/flow.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,MAAY,SAAS,8CAA0B;AAG/C;;GAEG;AACU,QAAA,IAAI,GAAG;IAClB,eAAe,EAAE,kBAAkB;IACnC,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;CACZ,CAAC;AAMX,gBAAgB;AACH,QAAA,kBAAkB,GAAiC,SAAS;KACtE,aAAa,CAAC,QAAA,IAAI,CAAC,CAAC;AACvB,gBAAgB;AACH,QAAA,mBAAmB,GAAgC,SAAS;KACtE,cAAc,CAAC,QAAA,IAAI,CAAC,CAAC"}
@@ -3,7 +3,7 @@ import { Result as SafeParseResult } from "../types/fp.js";
3
3
  import { SDKValidationError } from "./errors/sdk-validation-error.js";
4
4
  import { Integration } from "./integration.js";
5
5
  /**
6
- * GET /v1/integrations: every integration of the tenant, oldest first, at most 10. No secret is ever listed.
6
+ * GET /v1/integrations: every integration of the workspace, oldest first, at most 10. No secret is ever listed.
7
7
  */
8
8
  export type IntegrationList = {
9
9
  items: Array<Integration>;
@@ -2,7 +2,7 @@ import * as z from "zod/v4-mini";
2
2
  import { IntegrationHookPoint } from "./integration-hook-point.js";
3
3
  import { IntegrationPlatform } from "./integration-platform.js";
4
4
  /**
5
- * POST /v1/integrations body. Registers a hosted endpoint for one authentication provider. The tenant is the API key that signs the request, so the body has no tenant field and refuses one like any other unknown member. A WorkOS integration needs signing_secret, the Actions secret shown in the WorkOS dashboard, which NoResponse uses to verify each Action request and to sign its answer. An Auth0 integration sends no signing_secret: NoResponse generates the shared secret and returns it once.
5
+ * POST /v1/integrations body. Registers a hosted endpoint for one authentication provider. The workspace is the API key that signs the request, so the body has no workspace field and refuses one like any other unknown member. A WorkOS integration needs signing_secret, the Actions secret shown in the WorkOS dashboard, which NoResponse uses to verify each Action request and to sign its answer. An Auth0 integration sends no signing_secret: NoResponse generates the shared secret and returns it once.
6
6
  */
7
7
  export type IntegrationRequest = {
8
8
  /**
@@ -8,7 +8,7 @@ import { IntegrationPlatform } from "./integration-platform.js";
8
8
  */
9
9
  export type Integration = {
10
10
  /**
11
- * Opaque, server-assigned integration id: int_ and a 26-character Crockford base32 ULID. Another tenant's integration id answers 404.
11
+ * Opaque, server-assigned integration id: int_ and a 26-character Crockford base32 ULID. Another workspace's integration id answers 404.
12
12
  */
13
13
  integrationId: string;
14
14
  /**
@@ -3,7 +3,7 @@ import { Result as SafeParseResult } from "../types/fp.js";
3
3
  import { SDKValidationError } from "./errors/sdk-validation-error.js";
4
4
  import { IpSummaryType } from "./ip-summary-type.js";
5
5
  /**
6
- * Facts about the submitted IP from the offline database and this tenant's own recent assessments. Every member is optional; absent makes no claim.
6
+ * Facts about the submitted IP from the offline database and this workspace's own recent assessments. Every member is optional; absent makes no claim.
7
7
  */
8
8
  export type IpSummary = {
9
9
  /**
@@ -15,9 +15,9 @@ export type IpSummary = {
15
15
  */
16
16
  type?: IpSummaryType | undefined;
17
17
  /**
18
- * Assessments in this tenant with the same IP in the last 24 hours, this one included. A count only.
18
+ * Assessments in this workspace with the same IP in the last 24 hours, this one included. A count only.
19
19
  */
20
- seenInTenant?: number | undefined;
20
+ seenInWorkspace?: number | undefined;
21
21
  };
22
22
  /** @internal */
23
23
  export declare const IpSummary$inboundSchema: z.ZodMiniType<IpSummary, unknown>;
@@ -1 +1 @@
1
- {"version":3,"file":"ip-summary.d.ts","sourceRoot":"","sources":["../../../src/models/ip-summary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AAGjC,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EACL,aAAa,EAEd,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACnC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,CAYnE,CAAC;AAEJ,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAMhD"}
1
+ {"version":3,"file":"ip-summary.d.ts","sourceRoot":"","sources":["../../../src/models/ip-summary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AAGjC,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EACL,aAAa,EAEd,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACtC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,CAYnE,CAAC;AAEJ,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAMhD"}
@@ -45,10 +45,10 @@ exports.IpSummary$inboundSchema = z
45
45
  .pipe(z.object({
46
46
  country: types.optional(types.string()),
47
47
  type: types.optional(ip_summary_type_js_1.IpSummaryType$inboundSchema),
48
- seen_in_tenant: types.optional(types.number()),
48
+ seen_in_workspace: types.optional(types.number()),
49
49
  }), z.transform((v) => {
50
50
  return (0, primitives_js_1.remap)(v, {
51
- "seen_in_tenant": "seenInTenant",
51
+ "seen_in_workspace": "seenInWorkspace",
52
52
  });
53
53
  }));
54
54
  function ipSummaryFromJSON(jsonString) {
@@ -1 +1 @@
1
- {"version":3,"file":"ip-summary.js","sourceRoot":"","sources":["../../../src/models/ip-summary.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,MAAY,CAAC,wCAAoB;AACjC,wDAAuD;AACvD,kDAA8C;AAE9C,MAAY,KAAK,mDAA+B;AAEhD,6DAG8B;AAoB9B,gBAAgB;AACH,QAAA,uBAAuB,GAAsC,CAAC;KACxE,IAAI,CACH,CAAC,CAAC,MAAM,CAAC;IACP,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IACvC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,gDAA2B,CAAC;IACjD,cAAc,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;CAC/C,CAAC,EACF,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,gBAAgB,EAAE,cAAc;KACjC,CAAC,CAAC;AAAA,CACJ,CAAC,CACH,CAAC;AAEJ,2BACE,UAAkB,EAC8B;IAChD,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,QAAA,uBAAuB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACnD,uCAAuC,CACxC,CAAC;AAAA,CACH"}
1
+ {"version":3,"file":"ip-summary.js","sourceRoot":"","sources":["../../../src/models/ip-summary.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,MAAY,CAAC,wCAAoB;AACjC,wDAAuD;AACvD,kDAA8C;AAE9C,MAAY,KAAK,mDAA+B;AAEhD,6DAG8B;AAoB9B,gBAAgB;AACH,QAAA,uBAAuB,GAAsC,CAAC;KACxE,IAAI,CACH,CAAC,CAAC,MAAM,CAAC;IACP,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IACvC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,gDAA2B,CAAC;IACjD,iBAAiB,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;CAClD,CAAC,EACF,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,mBAAmB,EAAE,iBAAiB;KACvC,CAAC,CAAC;AAAA,CACJ,CAAC,CACH,CAAC;AAEJ,2BACE,UAAkB,EAC8B;IAChD,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,QAAA,uBAAuB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACnD,uCAAuC,CACxC,CAAC;AAAA,CACH"}
@@ -1,6 +1,6 @@
1
1
  import * as z from "zod/v4-mini";
2
2
  /**
3
- * POST /v1/keys/rotate body. The tenant and the key being rotated are the API key that signs the request, so neither is a body member. An empty object takes the default overlap.
3
+ * POST /v1/keys/rotate body. The workspace and the key being rotated are the API key that signs the request, so neither is a body member. An empty object takes the default overlap.
4
4
  */
5
5
  export type KeyRotationRequest = {
6
6
  /**
@@ -1,7 +1,7 @@
1
1
  import * as z from "zod/v4-mini";
2
2
  import { KeyUsageEvent, KeyUsageEvent$Outbound } from "./key-usage-event.js";
3
3
  /**
4
- * POST /v1/key_usage/batches body: facts about requests made with API keys your signup gate issued to your accounts, one event per request. Each event names the key by the SHA-256 that the assessment's issued_credential.sha256 carried, not the key itself. The SDKs buffer events and send them in the background. A batch holds 1 to 500 events and at most 256 KiB. Idempotency-Key is required and binds the body as on POST /v1/assessments, so a retried batch is counted once.
4
+ * POST /v1/key_usage/batches body: facts about requests made with API keys your platform issued to your accounts, one event per request. Each event names the key by the SHA-256 that the assessment's issued_credential.sha256 carried, not the key itself. The SDKs buffer events and send them in the background. A batch holds 1 to 500 events and at most 256 KiB. Idempotency-Key is required and binds the body as on POST /v1/assessments, so a retried batch is counted once.
5
5
  */
6
6
  export type KeyUsageBatchRequest = {
7
7
  events: Array<KeyUsageEvent>;
@@ -4,7 +4,7 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
4
4
  import * as models from "../index.js";
5
5
  export type CreateAssessmentRequest = {
6
6
  /**
7
- * Opaque client key, 16 to 128 characters of [A-Za-z0-9._:-] (a UUID or ULID fits). Scoped to the tenant principal and bound to the canonical body for 24 hours.
7
+ * Opaque client key, 16 to 128 characters of [A-Za-z0-9._:-] (a UUID or ULID fits). Scoped to the workspace principal and bound to the canonical body for 24 hours.
8
8
  */
9
9
  idempotencyKey: string;
10
10
  body: models.AssessmentRequest;
@@ -4,7 +4,7 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
4
4
  import * as models from "../index.js";
5
5
  export type DeleteAccountRequest = {
6
6
  /**
7
- * The account_id the tenant sends with its assessments, as one path segment (percent-encode '|' and ':' if the client requires it). A value that does not match the account_id shape answers 400 invalid_request.
7
+ * The account_id the workspace sends with its assessments, as one path segment (percent-encode '|' and ':' if the client requires it). A value that does not match the account_id shape answers 400 invalid_request.
8
8
  */
9
9
  accountId: string;
10
10
  };
@@ -3,7 +3,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
3
3
  import { SDKValidationError } from "../errors/sdk-validation-error.js";
4
4
  export type DeleteIntegrationRequest = {
5
5
  /**
6
- * Path segment, matched case-sensitively. A value that does not match the integration_id shape, or another tenant's id, answers 404.
6
+ * Path segment, matched case-sensitively. A value that does not match the integration_id shape, or another workspace's id, answers 404.
7
7
  */
8
8
  integrationId: string;
9
9
  };
@@ -3,7 +3,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
3
3
  import { SDKValidationError } from "../errors/sdk-validation-error.js";
4
4
  export type DeleteWebhookEndpointRequest = {
5
5
  /**
6
- * The endpoint's whe_ id. An id that is unknown, malformed or another tenant's answers 404.
6
+ * The endpoint's whe_ id. An id that is unknown, malformed or another workspace's answers 404.
7
7
  */
8
8
  endpointId: string;
9
9
  };
@@ -4,7 +4,7 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
4
4
  import * as models from "../index.js";
5
5
  export type GetAccountRequest = {
6
6
  /**
7
- * The account_id the tenant sends with its assessments, as one path segment (percent-encode '|' and ':' if the client requires it). A value that does not match the account_id shape answers 400 invalid_request.
7
+ * The account_id the workspace sends with its assessments, as one path segment (percent-encode '|' and ':' if the client requires it). A value that does not match the account_id shape answers 400 invalid_request.
8
8
  */
9
9
  accountId: string;
10
10
  };
@@ -4,7 +4,7 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
4
4
  import * as models from "../index.js";
5
5
  export type ListAccountAssessmentsRequest = {
6
6
  /**
7
- * The account_id the tenant sends with its assessments, as one path segment (percent-encode '|' and ':' if the client requires it). A value that does not match the account_id shape answers 400 invalid_request.
7
+ * The account_id the workspace sends with its assessments, as one path segment (percent-encode '|' and ':' if the client requires it). A value that does not match the account_id shape answers 400 invalid_request.
8
8
  */
9
9
  accountId: string;
10
10
  /**
@@ -4,7 +4,7 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
4
4
  import * as models from "../index.js";
5
5
  export type ListWebhookDeliveriesRequest = {
6
6
  /**
7
- * The endpoint's whe_ id. An id that is unknown, malformed or another tenant's answers 404.
7
+ * The endpoint's whe_ id. An id that is unknown, malformed or another workspace's answers 404.
8
8
  */
9
9
  endpointId: string;
10
10
  /**
@@ -8,7 +8,7 @@ export type RecordAssessmentOutcomeRequest = {
8
8
  */
9
9
  assessmentId: string;
10
10
  /**
11
- * Opaque client key, 16 to 128 characters of [A-Za-z0-9._:-] (a UUID or ULID fits). Scoped to the tenant principal and bound to the canonical body for 24 hours.
11
+ * Opaque client key, 16 to 128 characters of [A-Za-z0-9._:-] (a UUID or ULID fits). Scoped to the workspace principal and bound to the canonical body for 24 hours.
12
12
  */
13
13
  idempotencyKey: string;
14
14
  body: models.AssessmentOutcomeRequest;
@@ -4,7 +4,7 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
4
4
  import * as models from "../index.js";
5
5
  export type RecordKeyUsageRequest = {
6
6
  /**
7
- * Opaque client key, 16 to 128 characters of [A-Za-z0-9._:-] (a UUID or ULID fits). Scoped to the tenant principal and bound to the canonical body for 24 hours.
7
+ * Opaque client key, 16 to 128 characters of [A-Za-z0-9._:-] (a UUID or ULID fits). Scoped to the workspace principal and bound to the canonical body for 24 hours.
8
8
  */
9
9
  idempotencyKey: string;
10
10
  body: models.KeyUsageBatchRequest;
@@ -4,11 +4,11 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
4
4
  import * as models from "../index.js";
5
5
  export type ReplayWebhookDeliveryRequest = {
6
6
  /**
7
- * The endpoint's whe_ id. An id that is unknown, malformed or another tenant's answers 404.
7
+ * The endpoint's whe_ id. An id that is unknown, malformed or another workspace's answers 404.
8
8
  */
9
9
  endpointId: string;
10
10
  /**
11
- * The evt_ id of a delivery the endpoint's log holds, as GET /v1/webhooks/{endpoint_id}/deliveries lists it. An id that is malformed, not sent to this endpoint, past the log's retention or another tenant's answers 404.
11
+ * The evt_ id of a delivery the endpoint's log holds, as GET /v1/webhooks/{endpoint_id}/deliveries lists it. An id that is malformed, not sent to this endpoint, past the log's retention or another workspace's answers 404.
12
12
  */
13
13
  eventId: string;
14
14
  body: models.WebhookReplayRequest;
@@ -4,7 +4,7 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
4
4
  import * as models from "../index.js";
5
5
  export type RotateIntegrationSecretRequest = {
6
6
  /**
7
- * Path segment, matched case-sensitively. A value that does not match the integration_id shape, or another tenant's id, answers 404.
7
+ * Path segment, matched case-sensitively. A value that does not match the integration_id shape, or another workspace's id, answers 404.
8
8
  */
9
9
  integrationId: string;
10
10
  body: models.IntegrationRotationRequest;
@@ -4,7 +4,7 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
4
4
  import * as models from "../index.js";
5
5
  export type RotateWebhookSigningKeyRequest = {
6
6
  /**
7
- * The endpoint's whe_ id. An id that is unknown, malformed or another tenant's answers 404.
7
+ * The endpoint's whe_ id. An id that is unknown, malformed or another workspace's answers 404.
8
8
  */
9
9
  endpointId: string;
10
10
  body: models.WebhookKeyRotationRequest;
@@ -4,7 +4,7 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
4
4
  import * as models from "../index.js";
5
5
  export type SendWebhookTestEventRequest = {
6
6
  /**
7
- * The endpoint's whe_ id. An id that is unknown, malformed or another tenant's answers 404.
7
+ * The endpoint's whe_ id. An id that is unknown, malformed or another workspace's answers 404.
8
8
  */
9
9
  endpointId: string;
10
10
  body: models.WebhookTestRequest;
@@ -1,7 +1,7 @@
1
1
  import * as z from "zod/v4-mini";
2
2
  import { OpenEnum } from "../types/enums.js";
3
3
  /**
4
- * What the provider later learned about the assessed account. confirmed_abuse, account_takeover and chargeback report abuse; false_positive and legitimate withdraw an earlier abuse report of this tenant for the assessment; unknown is recorded only. Outcomes are append-only and the latest one recorded for an assessment wins.
4
+ * What the provider later learned about the assessed account. confirmed_abuse, account_takeover and chargeback report abuse; false_positive and legitimate withdraw an earlier abuse report of this workspace for the assessment; unknown is recorded only. Outcomes are append-only and the latest one recorded for an assessment wins.
5
5
  */
6
6
  export declare const Outcome: {
7
7
  readonly ConfirmedAbuse: "confirmed_abuse";
@@ -12,7 +12,7 @@ export declare const Outcome: {
12
12
  readonly Unknown: "unknown";
13
13
  };
14
14
  /**
15
- * What the provider later learned about the assessed account. confirmed_abuse, account_takeover and chargeback report abuse; false_positive and legitimate withdraw an earlier abuse report of this tenant for the assessment; unknown is recorded only. Outcomes are append-only and the latest one recorded for an assessment wins.
15
+ * What the provider later learned about the assessed account. confirmed_abuse, account_takeover and chargeback report abuse; false_positive and legitimate withdraw an earlier abuse report of this workspace for the assessment; unknown is recorded only. Outcomes are append-only and the latest one recorded for an assessment wins.
16
16
  */
17
17
  export type Outcome = OpenEnum<typeof Outcome>;
18
18
  /** @internal */
@@ -36,7 +36,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
36
36
  exports.Outcome$outboundSchema = exports.Outcome$inboundSchema = exports.Outcome = void 0;
37
37
  const openEnums = __importStar(require("../types/enums.js"));
38
38
  /**
39
- * What the provider later learned about the assessed account. confirmed_abuse, account_takeover and chargeback report abuse; false_positive and legitimate withdraw an earlier abuse report of this tenant for the assessment; unknown is recorded only. Outcomes are append-only and the latest one recorded for an assessment wins.
39
+ * What the provider later learned about the assessed account. confirmed_abuse, account_takeover and chargeback report abuse; false_positive and legitimate withdraw an earlier abuse report of this workspace for the assessment; unknown is recorded only. Outcomes are append-only and the latest one recorded for an assessment wins.
40
40
  */
41
41
  exports.Outcome = {
42
42
  ConfirmedAbuse: "confirmed_abuse",
@@ -4,7 +4,7 @@ import { OpenEnum } from "../types/enums.js";
4
4
  * Machine codes an HTTP 403 answer can carry.
5
5
  */
6
6
  export declare const PermissionDeniedErrorCode: {
7
- readonly TenantForbidden: "tenant_forbidden";
7
+ readonly WorkspaceForbidden: "workspace_forbidden";
8
8
  };
9
9
  /**
10
10
  * Machine codes an HTTP 403 answer can carry.
@@ -39,7 +39,7 @@ const openEnums = __importStar(require("../types/enums.js"));
39
39
  * Machine codes an HTTP 403 answer can carry.
40
40
  */
41
41
  exports.PermissionDeniedErrorCode = {
42
- TenantForbidden: "tenant_forbidden",
42
+ WorkspaceForbidden: "workspace_forbidden",
43
43
  };
44
44
  /** @internal */
45
45
  exports.PermissionDeniedErrorCode$inboundSchema = openEnums.inboundSchema(exports.PermissionDeniedErrorCode);
@@ -1 +1 @@
1
- {"version":3,"file":"permission-denied-error-code.js","sourceRoot":"","sources":["../../../src/models/permission-denied-error-code.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,MAAY,SAAS,8CAA0B;AAG/C;;GAEG;AACU,QAAA,yBAAyB,GAAG;IACvC,eAAe,EAAE,kBAAkB;CAC3B,CAAC;AAQX,gBAAgB;AACH,QAAA,uCAAuC,GAGhD,SAAS,CAAC,aAAa,CAAC,QAAA,yBAAyB,CAAC,CAAC"}
1
+ {"version":3,"file":"permission-denied-error-code.js","sourceRoot":"","sources":["../../../src/models/permission-denied-error-code.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,MAAY,SAAS,8CAA0B;AAG/C;;GAEG;AACU,QAAA,yBAAyB,GAAG;IACvC,kBAAkB,EAAE,qBAAqB;CACjC,CAAC;AAQX,gBAAgB;AACH,QAAA,uCAAuC,GAGhD,SAAS,CAAC,aAAa,CAAC,QAAA,yBAAyB,CAAC,CAAC"}
@@ -15,7 +15,7 @@ export declare const ReasonCode: {
15
15
  readonly ProxyIp: "proxy_ip";
16
16
  readonly SeenBefore: "seen_before";
17
17
  readonly SharedIp: "shared_ip";
18
- readonly ManyRecentSignups: "many_recent_signups";
18
+ readonly ManyRecentAccounts: "many_recent_accounts";
19
19
  readonly EstablishedAccounts: "established_accounts";
20
20
  readonly AgedIdentity: "aged_identity";
21
21
  readonly BreachNameMatch: "breach_name_match";
@@ -50,7 +50,7 @@ exports.ReasonCode = {
50
50
  ProxyIp: "proxy_ip",
51
51
  SeenBefore: "seen_before",
52
52
  SharedIp: "shared_ip",
53
- ManyRecentSignups: "many_recent_signups",
53
+ ManyRecentAccounts: "many_recent_accounts",
54
54
  EstablishedAccounts: "established_accounts",
55
55
  AgedIdentity: "aged_identity",
56
56
  BreachNameMatch: "breach_name_match",
@@ -1 +1 @@
1
- {"version":3,"file":"reason-code.js","sourceRoot":"","sources":["../../../src/models/reason-code.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,MAAY,SAAS,8CAA0B;AAG/C;;GAEG;AACU,QAAA,UAAU,GAAG;IACxB,kBAAkB,EAAE,sBAAsB;IAC1C,UAAU,EAAE,aAAa;IACzB,eAAe,EAAE,kBAAkB;IACnC,QAAQ,EAAE,WAAW;IACrB,WAAW,EAAE,cAAc;IAC3B,SAAS,EAAE,YAAY;IACvB,gBAAgB,EAAE,mBAAmB;IACrC,eAAe,EAAE,kBAAkB;IACnC,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE,aAAa;IACzB,QAAQ,EAAE,WAAW;IACrB,iBAAiB,EAAE,qBAAqB;IACxC,mBAAmB,EAAE,sBAAsB;IAC3C,YAAY,EAAE,eAAe;IAC7B,eAAe,EAAE,mBAAmB;IACpC,kBAAkB,EAAE,qBAAqB;IACzC,kBAAkB,EAAE,sBAAsB;IAC1C,mBAAmB,EAAE,uBAAuB;IAC5C,sBAAsB,EAAE,0BAA0B;IAClD,sBAAsB,EAAE,0BAA0B;IAClD,oBAAoB,EAAE,wBAAwB;IAC9C,eAAe,EAAE,mBAAmB;IACpC,oBAAoB,EAAE,wBAAwB;IAC9C,eAAe,EAAE,mBAAmB;IACpC,eAAe,EAAE,mBAAmB;IACpC,iBAAiB,EAAE,qBAAqB;IACxC,iBAAiB,EAAE,qBAAqB;IACxC,aAAa,EAAE,iBAAiB;IAChC,cAAc,EAAE,kBAAkB;IAClC,cAAc,EAAE,kBAAkB;IAClC,gBAAgB,EAAE,mBAAmB;IACrC,uBAAuB,EAAE,2BAA2B;IACpD,qBAAqB,EAAE,yBAAyB;IAChD,0BAA0B,EAAE,+BAA+B;IAC3D,cAAc,EAAE,kBAAkB;IAClC,YAAY,EAAE,eAAe;IAC7B,YAAY,EAAE,gBAAgB;CACtB,CAAC;AAMX,gBAAgB;AACH,QAAA,wBAAwB,GACnC,SAAS,CAAC,aAAa,CAAC,QAAA,UAAU,CAAC,CAAC"}
1
+ {"version":3,"file":"reason-code.js","sourceRoot":"","sources":["../../../src/models/reason-code.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,MAAY,SAAS,8CAA0B;AAG/C;;GAEG;AACU,QAAA,UAAU,GAAG;IACxB,kBAAkB,EAAE,sBAAsB;IAC1C,UAAU,EAAE,aAAa;IACzB,eAAe,EAAE,kBAAkB;IACnC,QAAQ,EAAE,WAAW;IACrB,WAAW,EAAE,cAAc;IAC3B,SAAS,EAAE,YAAY;IACvB,gBAAgB,EAAE,mBAAmB;IACrC,eAAe,EAAE,kBAAkB;IACnC,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE,aAAa;IACzB,QAAQ,EAAE,WAAW;IACrB,kBAAkB,EAAE,sBAAsB;IAC1C,mBAAmB,EAAE,sBAAsB;IAC3C,YAAY,EAAE,eAAe;IAC7B,eAAe,EAAE,mBAAmB;IACpC,kBAAkB,EAAE,qBAAqB;IACzC,kBAAkB,EAAE,sBAAsB;IAC1C,mBAAmB,EAAE,uBAAuB;IAC5C,sBAAsB,EAAE,0BAA0B;IAClD,sBAAsB,EAAE,0BAA0B;IAClD,oBAAoB,EAAE,wBAAwB;IAC9C,eAAe,EAAE,mBAAmB;IACpC,oBAAoB,EAAE,wBAAwB;IAC9C,eAAe,EAAE,mBAAmB;IACpC,eAAe,EAAE,mBAAmB;IACpC,iBAAiB,EAAE,qBAAqB;IACxC,iBAAiB,EAAE,qBAAqB;IACxC,aAAa,EAAE,iBAAiB;IAChC,cAAc,EAAE,kBAAkB;IAClC,cAAc,EAAE,kBAAkB;IAClC,gBAAgB,EAAE,mBAAmB;IACrC,uBAAuB,EAAE,2BAA2B;IACpD,qBAAqB,EAAE,yBAAyB;IAChD,0BAA0B,EAAE,+BAA+B;IAC3D,cAAc,EAAE,kBAAkB;IAClC,YAAY,EAAE,eAAe;IAC7B,YAAY,EAAE,gBAAgB;CACtB,CAAC;AAMX,gBAAgB;AACH,QAAA,wBAAwB,GACnC,SAAS,CAAC,aAAa,CAAC,QAAA,UAAU,CAAC,CAAC"}
@@ -14,7 +14,7 @@ export type RiskSummary = {
14
14
  email?: RiskSummaryEmail | undefined;
15
15
  username?: RiskSummaryUsername | undefined;
16
16
  /**
17
- * Facts about the submitted IP from the offline database and this tenant's own recent assessments. Every member is optional; absent makes no claim.
17
+ * Facts about the submitted IP from the offline database and this workspace's own recent assessments. Every member is optional; absent makes no claim.
18
18
  */
19
19
  ip?: IpSummary | undefined;
20
20
  /**