@atlasauth/types 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlasauth/types changelog
 
+## 0.4.0
+
+### Added
+
+- `WebhookEvent` gains `user.referral_attributed` (referral attribution resolved after `user.created` was sent).
+- `User` gains optional `referral` (`UserReferral`: `partner_id`, `referrer_external_id`, `referrer_user_id`, `matched_via`, `status`, `risk_level`, `flagged`), `referral_code` and `referral_link`.
+
 ## 0.3.0
 
 ### Added

package/dist/index.d.ts

@@ -12,7 +12,7 @@
 export type { SessionClaims } from './session';
 export type { AuthzClaims, ProtectCondition, ProtectOutcome, ProtectReason } from './authz';
 export type { VerifiedSessionClaims, AuthorizedSession, VerifyResult } from './verify';
-export type { Metadata, CursorPage, DataList, CursorParams, DeletedObject, User, EmailAddress, Session, Organization, OrganizationMembership, Invitation, ApiKey, ApiKeySubjectType, ApiKeyVerification, } from './resources';
+export type { Metadata, CursorPage, DataList, CursorParams, DeletedObject, User, UserReferral, EmailAddress, Session, Organization, OrganizationMembership, Invitation, ApiKey, ApiKeySubjectType, ApiKeyVerification, } from './resources';
 export type { WebhookEvent, WebhookPayload, WebhookVerifyResult, WebhookVerifyFailure, } from './webhooks';
 export type { Appearance, DesignTokens, ElementKey } from './appearance';
 export type { LocalizationResource, Localization, DeepPartial } from './localization';

package/dist/resources.d.ts

@@ -57,6 +57,33 @@ export interface User {
      * the one you hold. (Absent from servers older than this field.)
      */
     version?: number;
+    /**
+     * How the user arrived through a referral program, when the instance has
+     * referral attribution on and the referral platform matched a referrer.
+     * Null otherwise. (Absent from servers older than this field.)
+     */
+    referral?: UserReferral | null;
+    /** The user's own referral code, when they are a referrer. */
+    referral_code?: string | null;
+    /** The user's own referral link, when they are a referrer. */
+    referral_link?: string | null;
+}
+/** The inbound referral on a user (snake_case, as the BAPI serves it). */
+export interface UserReferral {
+    /** The referral platform's id for the referring partner. */
+    partner_id: string | null;
+    /** The referrer as the platform knows them (your external id for that user, or their Atlas id). */
+    referrer_external_id: string | null;
+    /** The referrer's Atlas user id, when they are a user of this instance. */
+    referrer_user_id: string | null;
+    /** How the platform matched the referral, e.g. code, click, coupon. */
+    matched_via: string | null;
+    /** The platform's own status for the referral. */
+    status: string | null;
+    /** The risk level Atlas assessed at sign-up, when one was. */
+    risk_level?: 'low' | 'medium' | 'high' | null;
+    /** An admin marked the referral fraudulent. */
+    flagged?: boolean;
 }
 export interface EmailAddress {
     object: 'email_address';

package/dist/webhooks.d.ts

@@ -10,7 +10,7 @@
 /**
  * §12.1 event catalog — the exact union off core's `WEBHOOK_EVENTS`.
  */
-export type WebhookEvent = 'user.created' | 'user.updated' | 'user.deleted' | 'user.banned' | 'user.unbanned' | 'user.locked' | 'user.deactivated' | 'user.graduated' | 'policy.imposed' | 'user.suspended' | 'user.unsuspended' | 'session.created' | 'session.revoked' | 'session.ended' | 'session.pending' | 'session.removed' | 'grant.revoked' | 'email.created' | 'sms.created' | 'organization.created' | 'organization.updated' | 'organization.deleted' | 'organizationMembership.created' | 'organizationMembership.updated' | 'organizationMembership.deleted' | 'organization.membership.deleted' | 'organizationInvitation.created' | 'organizationInvitation.accepted' | 'organizationInvitation.revoked' | 'organizationInvitation.declined' | 'role.created' | 'role.updated' | 'role.deleted' | 'permission.created' | 'permission.updated' | 'permission.deleted' | 'organizationDomain.created' | 'organizationDomain.updated' | 'organizationDomain.deleted' | 'organization.settings.updated' | 'waitlistEntry.created' | 'waitlistEntry.updated' | 'subscription.created' | 'subscription.updated' | 'subscription.deleted' | 'entitlement.created' | 'entitlement.updated' | 'entitlement.deleted' | 'entitlement.override.created' | 'entitlement.override.deleted' | 'entitlement.override.expired' | 'scimToken.created' | 'scimToken.revoked' | 'api_key.revoked' | 'api_key.created' | 'api_key.updated' | 'api_key.limit_reached' | 'ssoConnection.created' | 'ssoConnection.updated' | 'ssoConnection.deleted' | 'user.data_export.requested' | 'user.deletion_requested' | 'user.deletion_cancelled' | 'data_subject_request.scheduled' | 'data_subject_request.fulfilled' | 'data_subject_request.rejected' | 'machine.enrolled' | 'machine.revoked' | 'machine.updated' | 'user.deletion_scheduled' | 'user.deletion_canceled';
+export type WebhookEvent = 'user.created' | 'user.updated' | 'user.referral_attributed' | 'user.deleted' | 'user.banned' | 'user.unbanned' | 'user.locked' | 'user.deactivated' | 'user.graduated' | 'policy.imposed' | 'user.suspended' | 'user.unsuspended' | 'session.created' | 'session.revoked' | 'session.ended' | 'session.pending' | 'session.removed' | 'grant.revoked' | 'email.created' | 'sms.created' | 'organization.created' | 'organization.updated' | 'organization.deleted' | 'organizationMembership.created' | 'organizationMembership.updated' | 'organizationMembership.deleted' | 'organization.membership.deleted' | 'organizationInvitation.created' | 'organizationInvitation.accepted' | 'organizationInvitation.revoked' | 'organizationInvitation.declined' | 'role.created' | 'role.updated' | 'role.deleted' | 'permission.created' | 'permission.updated' | 'permission.deleted' | 'organizationDomain.created' | 'organizationDomain.updated' | 'organizationDomain.deleted' | 'organization.settings.updated' | 'waitlistEntry.created' | 'waitlistEntry.updated' | 'subscription.created' | 'subscription.updated' | 'subscription.deleted' | 'entitlement.created' | 'entitlement.updated' | 'entitlement.deleted' | 'entitlement.override.created' | 'entitlement.override.deleted' | 'entitlement.override.expired' | 'scimToken.created' | 'scimToken.revoked' | 'api_key.revoked' | 'api_key.created' | 'api_key.updated' | 'api_key.limit_reached' | 'ssoConnection.created' | 'ssoConnection.updated' | 'ssoConnection.deleted' | 'user.data_export.requested' | 'user.deletion_requested' | 'user.deletion_cancelled' | 'data_subject_request.scheduled' | 'data_subject_request.fulfilled' | 'data_subject_request.rejected' | 'machine.enrolled' | 'machine.revoked' | 'machine.updated' | 'user.deletion_scheduled' | 'user.deletion_canceled';
 /**
  * §12.2 payload. Full resource objects, not diffs — "consumers never need a
  * read-back call", which also means a consumer processing events out of order

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlasauth/types",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Shared public TypeScript types for Atlas — the Atlas peer of @clerk/types. Dependency-free, runtime-free: import type { User } from '@atlasauth/types' pulls in no runtime SDK.",
   "types": "./dist/index.d.ts",
   "exports": {