vairified 0.2.0 → 0.3.0

package/dist/index.d.cts

@@ -339,6 +339,50 @@ interface PlayerRankOptions {
     /** Number of players on either side of the target. Default 5. */
     readonly contextSize?: number;
 }
+/**
+ * Wire shape for tournament import response.
+ *
+ * @category Matches
+ */
+interface TournamentImportResultWire {
+    readonly success: boolean;
+    readonly matchesImported: number;
+    readonly gamesRecorded: number;
+    readonly ghostPlayersCreated: number;
+    readonly existingPlayersMatched: number;
+    readonly dryRun?: boolean;
+    readonly message?: string;
+    readonly errors?: readonly string[];
+}
+/**
+ * Wire shape for a single webhook delivery attempt.
+ *
+ * @category Webhooks
+ */
+interface WebhookDeliveryWire {
+    readonly id: string;
+    readonly event: string;
+    readonly url: string;
+    readonly statusCode: number | null;
+    readonly responseBody: string | null;
+    readonly errorMessage: string | null;
+    readonly attempts: number;
+    readonly maxAttempts: number;
+    readonly lastAttemptAt: string;
+    readonly nextRetryAt: string | null;
+    readonly completedAt: string | null;
+    readonly createdAt: string;
+    readonly payload: Record<string, unknown>;
+}
+/**
+ * Wire shape for paginated webhook delivery results.
+ *
+ * @category Webhooks
+ */
+interface WebhookDeliveriesResultWire {
+    readonly deliveries: readonly WebhookDeliveryWire[];
+    readonly total: number;
+}
 /**
  * Error envelope commonly returned by the Partner API on non-2xx status.
  *
@@ -402,6 +446,32 @@ declare class MatchBatchResult {
     toString(): string;
 }
 
+/**
+ * {@link TournamentImportResult} — result of a tournament import submission.
+ *
+ * @module
+ */
+
+/**
+ * Result of a tournament import submission.
+ *
+ * @category Matches
+ */
+declare class TournamentImportResult {
+    readonly success: boolean;
+    readonly matchesImported: number;
+    readonly gamesRecorded: number;
+    readonly ghostPlayersCreated: number;
+    readonly existingPlayersMatched: number;
+    readonly dryRun: boolean;
+    readonly message: string | undefined;
+    readonly errors: readonly string[];
+    /** @internal */
+    constructor(wire: TournamentImportResultWire);
+    /** True when the import succeeded without errors. */
+    get ok(): boolean;
+}
+
 /**
  * {@link MatchesResource} — bulk match submission.
  *
@@ -420,9 +490,9 @@ declare class MatchesResource {
     /**
      * Submit a {@link MatchBatch} for rating calculation.
      *
-     * All players in every match must have granted the `match:submit`
+     * All players in every match must have granted the `user:match:submit`
      * scope via OAuth (unless your API key has the
-     * `match:submit:trusted` scope, which skips per-player consent).
+     * `user:match:submit:trusted` scope, which skips per-player consent).
      *
      * Set `batch.dryRun = true` to validate without persisting.
      *
@@ -449,6 +519,30 @@ declare class MatchesResource {
      * ```
      */
     submit(batch: MatchBatch): Promise<MatchBatchResult>;
+    /**
+     * Import tournament results.
+     *
+     * The request body is a free-form JSON object whose structure is
+     * defined by the Vairified tournament import schema. Set
+     * `body.dryRun = true` to validate without persisting.
+     *
+     * @param body - Tournament import payload.
+     * @returns {@link TournamentImportResult} with match/game counts.
+     * @category Matches
+     *
+     * @example
+     * ```ts
+     * const result = await client.matches.tournamentImport({
+     *   sport: 'pickleball',
+     *   tournamentName: 'Spring Classic',
+     *   matches: [...],
+     * });
+     * if (result.ok) {
+     *   console.log(`Imported ${result.matchesImported} matches`);
+     * }
+     * ```
+     */
+    tournamentImport(body: Record<string, unknown>): Promise<TournamentImportResult>;
     /** Send a test payload to a webhook URL. */
     testWebhook(webhookUrl: string): Promise<Record<string, unknown>>;
 }
@@ -711,13 +805,38 @@ declare class MembersResource {
      * ```
      */
     find(name: string): Promise<Member | null>;
+    /**
+     * Fetch up to 100 members by their member IDs in one call.
+     *
+     * Unknown IDs are silently omitted — the returned array may be
+     * shorter than the input. Results are returned in the same order
+     * as the input IDs.
+     *
+     * @param ids - Array of integer member IDs (max 100).
+     * @param options - Optional filters.
+     * @param options.sport - Sport code to scope ratings (e.g. `'pickleball'`).
+     * @returns Array of {@link Member} instances.
+     * @throws {@link ValidationError} If more than 100 IDs are provided.
+     * @category Members
+     *
+     * @example
+     * ```ts
+     * const members = await client.members.getBulk([4873327, 4873328]);
+     * for (const m of members) {
+     *   console.log(m.name, m.ratingFor('pickleball'));
+     * }
+     * ```
+     */
+    getBulk(ids: number[], options?: {
+        sport?: string;
+    }): Promise<Member[]>;
     /**
      * Poll for rating change notifications.
      *
      * Returns a list of {@link RatingUpdate} objects for every player
      * whose rating has changed since the last poll. Members are
      * considered subscribed when they have an active OAuth connection
-     * with the `webhook:subscribe` scope.
+     * with the `user:webhook:subscribe` scope.
      */
     ratingUpdates(): Promise<readonly RatingUpdate[]>;
 }
@@ -739,13 +858,13 @@ declare class MembersResource {
  * lets TypeScript catch typos at authoring time:
  *
  * ```ts
- * const scopes: OAuthScope[] = ['profile:read', 'rating:read']; // ok
- * const bad: OAuthScope[] = ['profile:read', 'rating']; // type error
+ * const scopes: OAuthScope[] = ['user:profile:read', 'user:rating:read']; // ok
+ * const bad: OAuthScope[] = ['user:profile:read', 'rating']; // type error
  * ```
  *
  * @category OAuth
  */
-type OAuthScope = 'profile:read' | 'profile:email' | 'rating:read' | 'rating:history' | 'match:submit' | 'webhook:subscribe';
+type OAuthScope = 'user:profile:read' | 'user:profile:email' | 'user:rating:read' | 'user:rating:history' | 'user:match:submit' | 'user:webhook:subscribe';
 /**
  * Human-readable description for every OAuth scope.
  *
@@ -892,6 +1011,93 @@ declare class OAuthResource {
     }[]>;
 }
 
+/**
+ * {@link WebhookDelivery} and {@link WebhookDeliveriesResult} — webhook
+ * delivery inspection models.
+ *
+ * @module
+ */
+
+/**
+ * A single webhook delivery attempt.
+ *
+ * @category Webhooks
+ */
+declare class WebhookDelivery {
+    readonly id: string;
+    readonly event: string;
+    readonly url: string;
+    readonly statusCode: number | null;
+    readonly responseBody: string | null;
+    readonly errorMessage: string | null;
+    readonly attempts: number;
+    readonly maxAttempts: number;
+    readonly lastAttemptAt: string;
+    readonly nextRetryAt: string | null;
+    readonly completedAt: string | null;
+    readonly createdAt: string;
+    readonly payload: Readonly<Record<string, unknown>>;
+    /** @internal */
+    constructor(wire: WebhookDeliveryWire);
+    /** Whether delivery completed successfully (2xx status). */
+    get succeeded(): boolean;
+    /** Whether delivery failed definitively (completed with non-2xx). */
+    get failed(): boolean;
+}
+/**
+ * Paginated list of webhook delivery attempts.
+ *
+ * @category Webhooks
+ */
+declare class WebhookDeliveriesResult {
+    readonly deliveries: readonly WebhookDelivery[];
+    readonly total: number;
+    /** @internal */
+    constructor(wire: WebhookDeliveriesResultWire);
+}
+
+/**
+ * {@link WebhooksResource} — webhook delivery inspection.
+ *
+ * @module
+ */
+
+/**
+ * Webhook delivery inspection.
+ *
+ * @category Resources
+ */
+declare class WebhooksResource {
+    #private;
+    /** @internal */
+    constructor(http: HttpTransport);
+    /**
+     * List recent webhook delivery attempts.
+     *
+     * @param options - Optional filters and pagination.
+     * @param options.event - Filter by event type (e.g. `'rating.updated'`).
+     * @param options.status - Filter: `'all'`, `'pending'`, `'success'`, or `'failed'`.
+     * @param options.limit - Results per page (1-100, default 20).
+     * @param options.offset - Pagination offset.
+     * @returns {@link WebhookDeliveriesResult} with entries and total.
+     * @category Webhooks
+     *
+     * @example
+     * ```ts
+     * const result = await client.webhooks.deliveries({ status: 'failed' });
+     * for (const d of result.deliveries) {
+     *   console.log(d.event, d.statusCode, d.errorMessage);
+     * }
+     * ```
+     */
+    deliveries(options?: {
+        event?: string;
+        status?: 'all' | 'pending' | 'success' | 'failed';
+        limit?: number;
+        offset?: number;
+    }): Promise<WebhookDeliveriesResult>;
+}
+
 /**
  * {@link Vairified} — the main entry point of the SDK.
  *
@@ -955,6 +1161,8 @@ declare class Vairified {
     readonly oauth: OAuthResource;
     /** Leaderboard queries — list, rank, categories. */
     readonly leaderboard: LeaderboardResource;
+    /** Webhook delivery inspection — deliveries. */
+    readonly webhooks: WebhooksResource;
     constructor(options?: VairifiedOptions);
     /**
      * API usage statistics for the current API key.
@@ -1053,4 +1261,4 @@ declare class OAuthError extends VairifiedError {
     constructor(message?: string, errorCode?: string, response?: unknown);
 }
 
-export { type ApiErrorResponse, AuthenticationError, type AuthorizationResponse, DEFAULT_SCOPES, ENVIRONMENTS, type GameInput, type Gender, type LeaderboardOptions, LeaderboardResource, type MatchBatch, MatchBatchResult, type MatchBatchResultWire, type MatchInput, MatchesResource, Member, MemberSportMap, type MemberStatusWire, MembersResource, NotFoundError, type OAuthConfig, OAuthError, OAuthResource, type OAuthScope, type PartnerMemberWire, type PartnerRatingUpdateWire, type PlayerRankOptions, RateLimitError, type RatingSplitWire, RatingUpdate, SCOPES, type SearchFilters, SportRating, type SportRatingWire, type TokenResponse, Vairified, type VairifiedEnvironment, VairifiedError, type VairifiedOptions, ValidationError, describeScope, describeScopes, generateState, getAuthorizationUrl, validateScope };
+export { type ApiErrorResponse, AuthenticationError, type AuthorizationResponse, DEFAULT_SCOPES, ENVIRONMENTS, type GameInput, type Gender, type LeaderboardOptions, LeaderboardResource, type MatchBatch, MatchBatchResult, type MatchBatchResultWire, type MatchInput, MatchesResource, Member, MemberSportMap, type MemberStatusWire, MembersResource, NotFoundError, type OAuthConfig, OAuthError, OAuthResource, type OAuthScope, type PartnerMemberWire, type PartnerRatingUpdateWire, type PlayerRankOptions, RateLimitError, type RatingSplitWire, RatingUpdate, SCOPES, type SearchFilters, SportRating, type SportRatingWire, type TokenResponse, TournamentImportResult, type TournamentImportResultWire, Vairified, type VairifiedEnvironment, VairifiedError, type VairifiedOptions, ValidationError, WebhookDeliveriesResult, type WebhookDeliveriesResultWire, WebhookDelivery, type WebhookDeliveryWire, WebhooksResource, describeScope, describeScopes, generateState, getAuthorizationUrl, validateScope };

package/dist/index.d.ts

@@ -339,6 +339,50 @@ interface PlayerRankOptions {
     /** Number of players on either side of the target. Default 5. */
     readonly contextSize?: number;
 }
+/**
+ * Wire shape for tournament import response.
+ *
+ * @category Matches
+ */
+interface TournamentImportResultWire {
+    readonly success: boolean;
+    readonly matchesImported: number;
+    readonly gamesRecorded: number;
+    readonly ghostPlayersCreated: number;
+    readonly existingPlayersMatched: number;
+    readonly dryRun?: boolean;
+    readonly message?: string;
+    readonly errors?: readonly string[];
+}
+/**
+ * Wire shape for a single webhook delivery attempt.
+ *
+ * @category Webhooks
+ */
+interface WebhookDeliveryWire {
+    readonly id: string;
+    readonly event: string;
+    readonly url: string;
+    readonly statusCode: number | null;
+    readonly responseBody: string | null;
+    readonly errorMessage: string | null;
+    readonly attempts: number;
+    readonly maxAttempts: number;
+    readonly lastAttemptAt: string;
+    readonly nextRetryAt: string | null;
+    readonly completedAt: string | null;
+    readonly createdAt: string;
+    readonly payload: Record<string, unknown>;
+}
+/**
+ * Wire shape for paginated webhook delivery results.
+ *
+ * @category Webhooks
+ */
+interface WebhookDeliveriesResultWire {
+    readonly deliveries: readonly WebhookDeliveryWire[];
+    readonly total: number;
+}
 /**
  * Error envelope commonly returned by the Partner API on non-2xx status.
  *
@@ -402,6 +446,32 @@ declare class MatchBatchResult {
     toString(): string;
 }
 
+/**
+ * {@link TournamentImportResult} — result of a tournament import submission.
+ *
+ * @module
+ */
+
+/**
+ * Result of a tournament import submission.
+ *
+ * @category Matches
+ */
+declare class TournamentImportResult {
+    readonly success: boolean;
+    readonly matchesImported: number;
+    readonly gamesRecorded: number;
+    readonly ghostPlayersCreated: number;
+    readonly existingPlayersMatched: number;
+    readonly dryRun: boolean;
+    readonly message: string | undefined;
+    readonly errors: readonly string[];
+    /** @internal */
+    constructor(wire: TournamentImportResultWire);
+    /** True when the import succeeded without errors. */
+    get ok(): boolean;
+}
+
 /**
  * {@link MatchesResource} — bulk match submission.
  *
@@ -420,9 +490,9 @@ declare class MatchesResource {
     /**
      * Submit a {@link MatchBatch} for rating calculation.
      *
-     * All players in every match must have granted the `match:submit`
+     * All players in every match must have granted the `user:match:submit`
      * scope via OAuth (unless your API key has the
-     * `match:submit:trusted` scope, which skips per-player consent).
+     * `user:match:submit:trusted` scope, which skips per-player consent).
      *
      * Set `batch.dryRun = true` to validate without persisting.
      *
@@ -449,6 +519,30 @@ declare class MatchesResource {
      * ```
      */
     submit(batch: MatchBatch): Promise<MatchBatchResult>;
+    /**
+     * Import tournament results.
+     *
+     * The request body is a free-form JSON object whose structure is
+     * defined by the Vairified tournament import schema. Set
+     * `body.dryRun = true` to validate without persisting.
+     *
+     * @param body - Tournament import payload.
+     * @returns {@link TournamentImportResult} with match/game counts.
+     * @category Matches
+     *
+     * @example
+     * ```ts
+     * const result = await client.matches.tournamentImport({
+     *   sport: 'pickleball',
+     *   tournamentName: 'Spring Classic',
+     *   matches: [...],
+     * });
+     * if (result.ok) {
+     *   console.log(`Imported ${result.matchesImported} matches`);
+     * }
+     * ```
+     */
+    tournamentImport(body: Record<string, unknown>): Promise<TournamentImportResult>;
     /** Send a test payload to a webhook URL. */
     testWebhook(webhookUrl: string): Promise<Record<string, unknown>>;
 }
@@ -711,13 +805,38 @@ declare class MembersResource {
      * ```
      */
     find(name: string): Promise<Member | null>;
+    /**
+     * Fetch up to 100 members by their member IDs in one call.
+     *
+     * Unknown IDs are silently omitted — the returned array may be
+     * shorter than the input. Results are returned in the same order
+     * as the input IDs.
+     *
+     * @param ids - Array of integer member IDs (max 100).
+     * @param options - Optional filters.
+     * @param options.sport - Sport code to scope ratings (e.g. `'pickleball'`).
+     * @returns Array of {@link Member} instances.
+     * @throws {@link ValidationError} If more than 100 IDs are provided.
+     * @category Members
+     *
+     * @example
+     * ```ts
+     * const members = await client.members.getBulk([4873327, 4873328]);
+     * for (const m of members) {
+     *   console.log(m.name, m.ratingFor('pickleball'));
+     * }
+     * ```
+     */
+    getBulk(ids: number[], options?: {
+        sport?: string;
+    }): Promise<Member[]>;
     /**
      * Poll for rating change notifications.
      *
      * Returns a list of {@link RatingUpdate} objects for every player
      * whose rating has changed since the last poll. Members are
      * considered subscribed when they have an active OAuth connection
-     * with the `webhook:subscribe` scope.
+     * with the `user:webhook:subscribe` scope.
      */
     ratingUpdates(): Promise<readonly RatingUpdate[]>;
 }
@@ -739,13 +858,13 @@ declare class MembersResource {
  * lets TypeScript catch typos at authoring time:
  *
  * ```ts
- * const scopes: OAuthScope[] = ['profile:read', 'rating:read']; // ok
- * const bad: OAuthScope[] = ['profile:read', 'rating']; // type error
+ * const scopes: OAuthScope[] = ['user:profile:read', 'user:rating:read']; // ok
+ * const bad: OAuthScope[] = ['user:profile:read', 'rating']; // type error
  * ```
  *
  * @category OAuth
  */
-type OAuthScope = 'profile:read' | 'profile:email' | 'rating:read' | 'rating:history' | 'match:submit' | 'webhook:subscribe';
+type OAuthScope = 'user:profile:read' | 'user:profile:email' | 'user:rating:read' | 'user:rating:history' | 'user:match:submit' | 'user:webhook:subscribe';
 /**
  * Human-readable description for every OAuth scope.
  *
@@ -892,6 +1011,93 @@ declare class OAuthResource {
     }[]>;
 }
 
+/**
+ * {@link WebhookDelivery} and {@link WebhookDeliveriesResult} — webhook
+ * delivery inspection models.
+ *
+ * @module
+ */
+
+/**
+ * A single webhook delivery attempt.
+ *
+ * @category Webhooks
+ */
+declare class WebhookDelivery {
+    readonly id: string;
+    readonly event: string;
+    readonly url: string;
+    readonly statusCode: number | null;
+    readonly responseBody: string | null;
+    readonly errorMessage: string | null;
+    readonly attempts: number;
+    readonly maxAttempts: number;
+    readonly lastAttemptAt: string;
+    readonly nextRetryAt: string | null;
+    readonly completedAt: string | null;
+    readonly createdAt: string;
+    readonly payload: Readonly<Record<string, unknown>>;
+    /** @internal */
+    constructor(wire: WebhookDeliveryWire);
+    /** Whether delivery completed successfully (2xx status). */
+    get succeeded(): boolean;
+    /** Whether delivery failed definitively (completed with non-2xx). */
+    get failed(): boolean;
+}
+/**
+ * Paginated list of webhook delivery attempts.
+ *
+ * @category Webhooks
+ */
+declare class WebhookDeliveriesResult {
+    readonly deliveries: readonly WebhookDelivery[];
+    readonly total: number;
+    /** @internal */
+    constructor(wire: WebhookDeliveriesResultWire);
+}
+
+/**
+ * {@link WebhooksResource} — webhook delivery inspection.
+ *
+ * @module
+ */
+
+/**
+ * Webhook delivery inspection.
+ *
+ * @category Resources
+ */
+declare class WebhooksResource {
+    #private;
+    /** @internal */
+    constructor(http: HttpTransport);
+    /**
+     * List recent webhook delivery attempts.
+     *
+     * @param options - Optional filters and pagination.
+     * @param options.event - Filter by event type (e.g. `'rating.updated'`).
+     * @param options.status - Filter: `'all'`, `'pending'`, `'success'`, or `'failed'`.
+     * @param options.limit - Results per page (1-100, default 20).
+     * @param options.offset - Pagination offset.
+     * @returns {@link WebhookDeliveriesResult} with entries and total.
+     * @category Webhooks
+     *
+     * @example
+     * ```ts
+     * const result = await client.webhooks.deliveries({ status: 'failed' });
+     * for (const d of result.deliveries) {
+     *   console.log(d.event, d.statusCode, d.errorMessage);
+     * }
+     * ```
+     */
+    deliveries(options?: {
+        event?: string;
+        status?: 'all' | 'pending' | 'success' | 'failed';
+        limit?: number;
+        offset?: number;
+    }): Promise<WebhookDeliveriesResult>;
+}
+
 /**
  * {@link Vairified} — the main entry point of the SDK.
  *
@@ -955,6 +1161,8 @@ declare class Vairified {
     readonly oauth: OAuthResource;
     /** Leaderboard queries — list, rank, categories. */
     readonly leaderboard: LeaderboardResource;
+    /** Webhook delivery inspection — deliveries. */
+    readonly webhooks: WebhooksResource;
     constructor(options?: VairifiedOptions);
     /**
      * API usage statistics for the current API key.
@@ -1053,4 +1261,4 @@ declare class OAuthError extends VairifiedError {
     constructor(message?: string, errorCode?: string, response?: unknown);
 }
 
-export { type ApiErrorResponse, AuthenticationError, type AuthorizationResponse, DEFAULT_SCOPES, ENVIRONMENTS, type GameInput, type Gender, type LeaderboardOptions, LeaderboardResource, type MatchBatch, MatchBatchResult, type MatchBatchResultWire, type MatchInput, MatchesResource, Member, MemberSportMap, type MemberStatusWire, MembersResource, NotFoundError, type OAuthConfig, OAuthError, OAuthResource, type OAuthScope, type PartnerMemberWire, type PartnerRatingUpdateWire, type PlayerRankOptions, RateLimitError, type RatingSplitWire, RatingUpdate, SCOPES, type SearchFilters, SportRating, type SportRatingWire, type TokenResponse, Vairified, type VairifiedEnvironment, VairifiedError, type VairifiedOptions, ValidationError, describeScope, describeScopes, generateState, getAuthorizationUrl, validateScope };
+export { type ApiErrorResponse, AuthenticationError, type AuthorizationResponse, DEFAULT_SCOPES, ENVIRONMENTS, type GameInput, type Gender, type LeaderboardOptions, LeaderboardResource, type MatchBatch, MatchBatchResult, type MatchBatchResultWire, type MatchInput, MatchesResource, Member, MemberSportMap, type MemberStatusWire, MembersResource, NotFoundError, type OAuthConfig, OAuthError, OAuthResource, type OAuthScope, type PartnerMemberWire, type PartnerRatingUpdateWire, type PlayerRankOptions, RateLimitError, type RatingSplitWire, RatingUpdate, SCOPES, type SearchFilters, SportRating, type SportRatingWire, type TokenResponse, TournamentImportResult, type TournamentImportResultWire, Vairified, type VairifiedEnvironment, VairifiedError, type VairifiedOptions, ValidationError, WebhookDeliveriesResult, type WebhookDeliveriesResultWire, WebhookDelivery, type WebhookDeliveryWire, WebhooksResource, describeScope, describeScopes, generateState, getAuthorizationUrl, validateScope };