@carddb/client 0.3.15 → 0.4.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as _carddb_core from '@carddb/core';
-import { Logger, LogLevel, Cache, ResourceType, CardDBConfig, RateLimitInfo, GraphQLErrorInfo, Collection, Publisher, Game, GameCreateInput, GameUpdateInput, Dataset, DatasetSchema, Deck, ViewerDecksFilterInput, AppDecksFilterInput, PublicDecksFilterInput, DeckVersion, DeckDiff, DeckValidateInput, DeckValidation, DeckHydrateEntriesInput, DeckHydrateEntriesPayload, DeckExportFormat, DeckExportPayload, DeckSectionDefinition, DeckCollaborator, DeckPreviewToken, DeckEmbedToken, DeckAccessTokenIssuer, DeckAPIApplicationAccess, DeckCreateInput, DeckUpdateInput, DeckUpsertByExternalRefInput, DeckUpsertByExternalRefPayload, DeckClaimInput, DeckOwnershipTransferPayload, DeckTransferOwnershipInput, DeckCopyInput, DeckCopyPayload, DeckEntryAddInput, DeckEntryMutationPayload, DeckEntryUpdateInput, DeckEntryReorderInput, DeckEntryReorderPayload, DeckEntriesReplaceInput, DeckEntriesReplacePayload, DeckImportInput, DeckImportPayload, DeckImportFormatDefinition, DeckImportFormatTestInput, DeckImportFormatTestPayload, DeckImportFormatCreateInput, DeckImportFormatUpdateInput, DeckPublishInput, DeckPublishPayload, DeckRemoveInvalidEntriesInput, DeckCollaboratorRole, DeckPreviewTokenCreateInput, DeckPreviewTokenCreatePayload, DeckEmbedTokenCreateInput, DeckEmbedTokenCreatePayload, DeckAccessTokenIssuerCreateInput, DeckAPIApplicationAccessGrantInput, DeckAccessTokenExchangeInput, DeckAccessTokenExchangePayload, DeckSessionTokenExchangeInput, DeckSessionTokenExchangePayload, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, DatasetRecordsUpsertInput, DatasetRecordsUpsertPayload, DatasetRecordsDeleteInput, DatasetRecordDeleteJob, DatasetRecordDeleteJobStatus, DatasetImportPreviewInput, DatasetImportPreviewResult, DatasetImportValidateInput, BulkImportResult, DatasetImportRunInput, ImportJob, ImportJobStatus, ImportLogLevel, ImportJobLog, GameImportPreviewInput, GameImportPreview, GameImportRunInput, GameImportJob, DatasetExportInput, ExportJob, ExportJobStatus, File, FileUploadInput, PresignedUpload, APIKeyInfo } from '@carddb/core';
+import { Logger, LogLevel, Cache, ResourceType, CardDBConfig, RateLimitInfo, GraphQLErrorInfo, Collection, Publisher, Game, GameCreateInput, GameUpdateInput, GameScanRegion, Dataset, DatasetSchema, Deck, ViewerDecksFilterInput, AppDecksFilterInput, PublicDecksFilterInput, DeckVersion, DeckDiff, DeckValidateInput, DeckValidation, DeckHydrateEntriesInput, DeckHydrateEntriesPayload, DeckExportFormat, DeckExportPayload, DeckSectionDefinition, DeckCollaborator, DeckPreviewToken, DeckEmbedToken, DeckAccessTokenIssuer, DeckAPIApplicationAccess, DeckCreateInput, DeckUpdateInput, DeckUpsertByExternalRefInput, DeckUpsertByExternalRefPayload, DeckClaimInput, DeckOwnershipTransferPayload, DeckTransferOwnershipInput, DeckCopyInput, DeckCopyPayload, DeckEntryAddInput, DeckEntryMutationPayload, DeckEntryUpdateInput, DeckEntryReorderInput, DeckEntryReorderPayload, DeckEntriesReplaceInput, DeckEntriesReplacePayload, DeckImportInput, DeckImportPayload, DeckImportFormatDefinition, DeckImportFormatTestInput, DeckImportFormatTestPayload, DeckImportFormatCreateInput, DeckImportFormatUpdateInput, DeckPublishInput, DeckPublishPayload, DeckRemoveInvalidEntriesInput, DeckCollaboratorRole, DeckPreviewTokenCreateInput, DeckPreviewTokenCreatePayload, DeckEmbedTokenCreateInput, DeckEmbedTokenCreatePayload, DeckAccessTokenIssuerCreateInput, DeckAPIApplicationAccessGrantInput, DeckAccessTokenExchangeInput, DeckAccessTokenExchangePayload, DeckSessionTokenExchangeInput, DeckSessionTokenExchangePayload, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, DatasetRecordsUpsertInput, DatasetRecordsUpsertPayload, DatasetRecordsDeleteInput, DatasetRecordDeleteJob, DatasetRecordDeleteJobStatus, DatasetImportPreviewInput, DatasetImportPreviewResult, DatasetImportValidateInput, BulkImportResult, DatasetImportRunInput, ImportJob, ImportJobStatus, ImportLogLevel, ImportJobLog, GameImportPreviewInput, GameImportPreview, GameImportRunInput, GameImportJob, DatasetExportInput, ExportJob, ExportJobStatus, File, FileUploadInput, PresignedUpload, UploadPurpose, CreateScanJobInput, ScanJobPayload, ScanJob, SubmitScanFeedbackInput, ScanFeedbackPayload, ScanMetricsInput, ScanMetrics, ResolveScanTemplateInput, ScanTemplateResolution, ScanTemplatesInput, ScanTemplate, SaveScanTemplateInput, ScanTemplatePayload, PreviewScanTemplateInput, ScanTemplatePreview, APIKeyInfo } from '@carddb/core';
 export * from '@carddb/core';
 
 /**
@@ -256,6 +256,14 @@ interface GetGameBySlugOptions extends GetGameOptions {
     /** Stable game slug, currently backed by metafyGameSlug */
     gameSlug: string;
 }
+interface GetGameRegionsOptions extends GetGameOptions {
+    /** Publisher slug, defaults to client defaultPublisher */
+    publisherSlug?: string;
+    /** Stable game key, defaults to client defaultGame */
+    gameKey?: string;
+    /** Include inactive publisher-managed scan regions */
+    includeInactive?: boolean;
+}
 declare class GamesResource extends BaseResource {
     constructor(connection: Connection, config: Configuration);
     /**
@@ -278,6 +286,10 @@ declare class GamesResource extends BaseResource {
      * Update a publisher-managed game. Requires a server-side secret credential.
      */
     update(id: string, input: GameUpdateInput): Promise<Game>;
+    /**
+     * Get publisher-defined game region metadata for scan-capable clients.
+     */
+    getRegions(options?: GetGameRegionsOptions): Promise<GameScanRegion[]>;
     /**
      * Search for games
      *
@@ -1324,6 +1336,22 @@ interface GetFileOptions {
     /** Whether to use cache (defaults to client config) */
     cache?: boolean;
 }
+interface UploadFileInput {
+    filename: string;
+    contentType: string;
+    body: unknown;
+    /** File size in bytes. Inferred for strings, ArrayBuffers, typed arrays, Blob/File-like values. */
+    size?: number;
+    /** Defaults to false. */
+    isPublic?: boolean;
+    /** Convenience purpose mapped onto existing file metadata. */
+    purpose?: UploadPurpose;
+    /** Override the entity type sent to the API. */
+    entityType?: string;
+    entityId?: string;
+    publisherId?: string;
+    datasetId?: string;
+}
 declare class FilesResource extends BaseResource {
     constructor(connection: Connection, config: Configuration);
     /**
@@ -1338,12 +1366,149 @@ declare class FilesResource extends BaseResource {
      * Confirm that a presigned upload completed.
      */
     confirmUpload(id: string): Promise<File>;
+    /**
+     * Request a presigned upload URL, PUT bytes directly to storage, then confirm the file.
+     */
+    upload(input: UploadFileInput): Promise<File>;
     /**
      * Delete a file. Requires a server-side secret credential.
      */
     delete(id: string): Promise<boolean>;
 }
 
+/**
+ * Scan job resource for CardDB API
+ */
+
+type CreateScanJobOptions = Omit<CreateScanJobInput, 'publisherSlug' | 'gameKey'> & {
+    /** Publisher slug, defaults to client defaultPublisher */
+    publisherSlug?: string;
+    /** Game key, defaults to client defaultGame */
+    gameKey?: string;
+};
+type ScanMetricsOptions = Omit<ScanMetricsInput, 'publisherSlug' | 'gameKey'> & {
+    /** Publisher slug, defaults to client defaultPublisher */
+    publisherSlug?: string;
+    /** Game key, defaults to client defaultGame */
+    gameKey?: string;
+};
+interface GetScanJobOptions {
+    /** Whether to use cache (defaults to client config) */
+    cache?: boolean;
+}
+interface PollScanJobOptions {
+    /** First delay between polling attempts in milliseconds */
+    intervalMs?: number;
+    /** Maximum total polling time in milliseconds */
+    timeoutMs?: number;
+    /** Multiplier applied to the delay after each non-terminal response */
+    backoffFactor?: number;
+    /** Maximum delay between polling attempts in milliseconds */
+    maxIntervalMs?: number;
+    /** Abort-like signal. The SDK checks `aborted` before each request and sleep. */
+    signal?: PollSignal;
+}
+interface PollSignal {
+    aborted: boolean;
+    reason?: unknown;
+    throwIfAborted?: () => void;
+}
+interface VerifyWebhookSignatureInput {
+    body: string | ArrayBuffer | ArrayBufferView;
+    signature: string;
+    secret: string;
+}
+declare class ScansResource extends BaseResource {
+    constructor(connection: Connection, config: Configuration);
+    /**
+     * Create a scan job for an already uploaded image file.
+     */
+    createJob(input: CreateScanJobOptions): Promise<ScanJobPayload>;
+    /**
+     * Get a scan job and its latest processing result.
+     */
+    getJob(id: string, options?: GetScanJobOptions): Promise<ScanJob | null>;
+    /**
+     * Poll a scan job until it reaches a terminal status.
+     */
+    pollJob(id: string, options?: PollScanJobOptions): Promise<ScanJob>;
+    /**
+     * Submit correctness feedback for a completed scan job.
+     */
+    submitFeedback(input: SubmitScanFeedbackInput): Promise<ScanFeedbackPayload>;
+    /**
+     * Aggregate scan metrics for a publisher/game/dataset scope.
+     */
+    metrics(input: ScanMetricsOptions): Promise<ScanMetrics>;
+    /**
+     * Verify an `X-CardDB-Signature` value for a webhook body.
+     */
+    verifyWebhookSignature(input: VerifyWebhookSignatureInput): Promise<boolean>;
+    private resolveCreateJobInput;
+    private resolveMetricsInput;
+}
+
+/**
+ * Scan template resource for CardDB API
+ */
+
+type ResolveScanTemplateOptions = Omit<ResolveScanTemplateInput, 'publisherSlug' | 'gameKey'> & {
+    /** Publisher slug, defaults to client defaultPublisher */
+    publisherSlug?: string;
+    /** Game key, defaults to client defaultGame */
+    gameKey?: string;
+    /** Whether to use cache (defaults to client config) */
+    cache?: boolean;
+};
+type ListScanTemplatesOptions = Omit<ScanTemplatesInput, 'publisherSlug' | 'gameKey'> & {
+    /** Publisher slug, defaults to client defaultPublisher */
+    publisherSlug?: string;
+    /** Game key, defaults to client defaultGame */
+    gameKey?: string;
+    /** Whether to use cache (defaults to client config) */
+    cache?: boolean;
+};
+type SaveScanTemplateOptions = Omit<SaveScanTemplateInput, 'publisherSlug' | 'gameKey'> & {
+    /** Publisher slug, defaults to client defaultPublisher */
+    publisherSlug?: string;
+    /** Game key, defaults to client defaultGame */
+    gameKey?: string;
+};
+type PreviewScanTemplateOptions = Omit<PreviewScanTemplateInput, 'publisherSlug' | 'gameKey'> & {
+    /** Publisher slug, defaults to client defaultPublisher */
+    publisherSlug?: string;
+    /** Game key, defaults to client defaultGame */
+    gameKey?: string;
+};
+type UpdateScanTemplateOptions = SaveScanTemplateOptions & {
+    id: string;
+};
+declare class ScanTemplatesResource extends BaseResource {
+    constructor(connection: Connection, config: Configuration);
+    /**
+     * Resolve the active scan template for a game or dataset scope.
+     */
+    resolve(input: ResolveScanTemplateOptions): Promise<ScanTemplateResolution>;
+    /**
+     * List publisher-managed scan templates for a game or dataset scope.
+     */
+    list(input: ListScanTemplatesOptions): Promise<ScanTemplate[]>;
+    /**
+     * Create a publisher-managed scan template. Requires a server-side secret credential.
+     */
+    create(input: SaveScanTemplateOptions): Promise<ScanTemplatePayload>;
+    update(input: UpdateScanTemplateOptions): Promise<ScanTemplatePayload>;
+    update(id: string, input: SaveScanTemplateOptions): Promise<ScanTemplatePayload>;
+    /**
+     * Validate a draft scan template and normalize provided region OCR hints.
+     */
+    preview(input: PreviewScanTemplateOptions): Promise<ScanTemplatePreview>;
+    private resolveTemplateScope;
+    private resolveListScope;
+    private resolveSaveInput;
+    private resolvePreviewInput;
+}
+
 /**
  * CardDB API Client
  *
@@ -1415,6 +1580,10 @@ declare class CardDBClient {
     readonly exports: ExportsResource;
     /** File upload helper resource */
     readonly files: FilesResource;
+    /** Scan job helper resource */
+    readonly scans: ScansResource;
+    /** Scan template helper resource */
+    readonly scanTemplates: ScanTemplatesResource;
     /**
      * Create a new CardDB client
      *
@@ -1496,4 +1665,4 @@ declare function readCache<T>(cache: Cache, key: string): Promise<T | null>;
  */
 declare function writeCache<T>(cache: Cache, key: string, value: T, ttl: number): Promise<void>;
 
-export { BaseResource, CardDBClient, Configuration, Connection, DEFAULT_CACHE_TTL, DEFAULT_ENDPOINT, DEFAULT_MAX_NETWORK_RETRIES, DEFAULT_MAX_RETRIES, DEFAULT_OPEN_TIMEOUT, DEFAULT_RETRY_BASE_DELAY, DEFAULT_RETRY_MAX_DELAY, DEFAULT_TIMEOUT, DatasetsResource, type DeckSectionDefinitionsOptions, DecksResource, ExportsResource, type FetchDeckByExternalRefOptions, type FetchDeckBySlugOptions, type FetchDeckOptions, FilesResource, GamesResource, type GetDatasetByKeyOptions, type GetDatasetOptions, type GetFileOptions, type GetGameByKeyOptions, type GetGameBySlugOptions, type GetGameOptions, type GetImportFormatByKeyOptions, type GetImportFormatOptions, type GetPublisherOptions, type GetRecordByDatasetIdentifierOptions, type GetRecordByIdentifierOptions, type GetRecordOptions, type GetRecordsByIdentifierOptions, type GraphQLResponse, type HydrateDeckEntriesOptions, ImportFormatsResource, ImportsResource, type ListAppDecksOptions, type ListDatasetsOptions, type ListDeckAccessTokenIssuersOptions, type ListDeckApiApplicationAccessesOptions, type ListDeckCollaboratorsOptions, type ListDeckEmbedTokensOptions, type ListDeckImportFormatsOptions, type ListDeckPreviewTokensOptions, type ListDeckVersionsOptions, type ListDecksOptions, type ListExportJobsOptions, type ListFormatsOptions, type ListGameImportJobsOptions, type ListGamesOptions, type ListImportFormatsOptions, type ListImportJobLogsOptions, type ListImportJobsOptions, type ListMyDeckApiApplicationAccessesOptions, type ListPublicDecksOptions, type ListRecordDeleteJobsOptions, type ListRecordsOptions, type ListRuleDatasetsOptions, type ListRulesOptions, type ListViewerDecksOptions, PublishersResource, RecordsResource, RulesResource, type SearchDatasetsOptions, type SearchGamesOptions, type SearchPublishersOptions, type SearchRecordsOptions, type WaitForExportJobOptions, type WaitForImportJobOptions, type WaitForRecordDeleteJobOptions, cacheKey, getRateLimitInfo, getSDKVersion, getUserAgent, readCache, writeCache };
+export { BaseResource, CardDBClient, Configuration, Connection, type CreateScanJobOptions, DEFAULT_CACHE_TTL, DEFAULT_ENDPOINT, DEFAULT_MAX_NETWORK_RETRIES, DEFAULT_MAX_RETRIES, DEFAULT_OPEN_TIMEOUT, DEFAULT_RETRY_BASE_DELAY, DEFAULT_RETRY_MAX_DELAY, DEFAULT_TIMEOUT, DatasetsResource, type DeckSectionDefinitionsOptions, DecksResource, ExportsResource, type FetchDeckByExternalRefOptions, type FetchDeckBySlugOptions, type FetchDeckOptions, FilesResource, GamesResource, type GetDatasetByKeyOptions, type GetDatasetOptions, type GetFileOptions, type GetGameByKeyOptions, type GetGameBySlugOptions, type GetGameOptions, type GetGameRegionsOptions, type GetImportFormatByKeyOptions, type GetImportFormatOptions, type GetPublisherOptions, type GetRecordByDatasetIdentifierOptions, type GetRecordByIdentifierOptions, type GetRecordOptions, type GetRecordsByIdentifierOptions, type GetScanJobOptions, type GraphQLResponse, type HydrateDeckEntriesOptions, ImportFormatsResource, ImportsResource, type ListAppDecksOptions, type ListDatasetsOptions, type ListDeckAccessTokenIssuersOptions, type ListDeckApiApplicationAccessesOptions, type ListDeckCollaboratorsOptions, type ListDeckEmbedTokensOptions, type ListDeckImportFormatsOptions, type ListDeckPreviewTokensOptions, type ListDeckVersionsOptions, type ListDecksOptions, type ListExportJobsOptions, type ListFormatsOptions, type ListGameImportJobsOptions, type ListGamesOptions, type ListImportFormatsOptions, type ListImportJobLogsOptions, type ListImportJobsOptions, type ListMyDeckApiApplicationAccessesOptions, type ListPublicDecksOptions, type ListRecordDeleteJobsOptions, type ListRecordsOptions, type ListRuleDatasetsOptions, type ListRulesOptions, type ListScanTemplatesOptions, type ListViewerDecksOptions, type PollScanJobOptions, type PollSignal, type PreviewScanTemplateOptions, PublishersResource, RecordsResource, type ResolveScanTemplateOptions, RulesResource, type SaveScanTemplateOptions, type ScanMetricsOptions, ScanTemplatesResource, ScansResource, type SearchDatasetsOptions, type SearchGamesOptions, type SearchPublishersOptions, type SearchRecordsOptions, type UpdateScanTemplateOptions, type UploadFileInput, type VerifyWebhookSignatureInput, type WaitForExportJobOptions, type WaitForImportJobOptions, type WaitForRecordDeleteJobOptions, cacheKey, getRateLimitInfo, getSDKVersion, getUserAgent, readCache, writeCache };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _carddb_core from '@carddb/core';
-import { Logger, LogLevel, Cache, ResourceType, CardDBConfig, RateLimitInfo, GraphQLErrorInfo, Collection, Publisher, Game, GameCreateInput, GameUpdateInput, Dataset, DatasetSchema, Deck, ViewerDecksFilterInput, AppDecksFilterInput, PublicDecksFilterInput, DeckVersion, DeckDiff, DeckValidateInput, DeckValidation, DeckHydrateEntriesInput, DeckHydrateEntriesPayload, DeckExportFormat, DeckExportPayload, DeckSectionDefinition, DeckCollaborator, DeckPreviewToken, DeckEmbedToken, DeckAccessTokenIssuer, DeckAPIApplicationAccess, DeckCreateInput, DeckUpdateInput, DeckUpsertByExternalRefInput, DeckUpsertByExternalRefPayload, DeckClaimInput, DeckOwnershipTransferPayload, DeckTransferOwnershipInput, DeckCopyInput, DeckCopyPayload, DeckEntryAddInput, DeckEntryMutationPayload, DeckEntryUpdateInput, DeckEntryReorderInput, DeckEntryReorderPayload, DeckEntriesReplaceInput, DeckEntriesReplacePayload, DeckImportInput, DeckImportPayload, DeckImportFormatDefinition, DeckImportFormatTestInput, DeckImportFormatTestPayload, DeckImportFormatCreateInput, DeckImportFormatUpdateInput, DeckPublishInput, DeckPublishPayload, DeckRemoveInvalidEntriesInput, DeckCollaboratorRole, DeckPreviewTokenCreateInput, DeckPreviewTokenCreatePayload, DeckEmbedTokenCreateInput, DeckEmbedTokenCreatePayload, DeckAccessTokenIssuerCreateInput, DeckAPIApplicationAccessGrantInput, DeckAccessTokenExchangeInput, DeckAccessTokenExchangePayload, DeckSessionTokenExchangeInput, DeckSessionTokenExchangePayload, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, DatasetRecordsUpsertInput, DatasetRecordsUpsertPayload, DatasetRecordsDeleteInput, DatasetRecordDeleteJob, DatasetRecordDeleteJobStatus, DatasetImportPreviewInput, DatasetImportPreviewResult, DatasetImportValidateInput, BulkImportResult, DatasetImportRunInput, ImportJob, ImportJobStatus, ImportLogLevel, ImportJobLog, GameImportPreviewInput, GameImportPreview, GameImportRunInput, GameImportJob, DatasetExportInput, ExportJob, ExportJobStatus, File, FileUploadInput, PresignedUpload, APIKeyInfo } from '@carddb/core';
+import { Logger, LogLevel, Cache, ResourceType, CardDBConfig, RateLimitInfo, GraphQLErrorInfo, Collection, Publisher, Game, GameCreateInput, GameUpdateInput, GameScanRegion, Dataset, DatasetSchema, Deck, ViewerDecksFilterInput, AppDecksFilterInput, PublicDecksFilterInput, DeckVersion, DeckDiff, DeckValidateInput, DeckValidation, DeckHydrateEntriesInput, DeckHydrateEntriesPayload, DeckExportFormat, DeckExportPayload, DeckSectionDefinition, DeckCollaborator, DeckPreviewToken, DeckEmbedToken, DeckAccessTokenIssuer, DeckAPIApplicationAccess, DeckCreateInput, DeckUpdateInput, DeckUpsertByExternalRefInput, DeckUpsertByExternalRefPayload, DeckClaimInput, DeckOwnershipTransferPayload, DeckTransferOwnershipInput, DeckCopyInput, DeckCopyPayload, DeckEntryAddInput, DeckEntryMutationPayload, DeckEntryUpdateInput, DeckEntryReorderInput, DeckEntryReorderPayload, DeckEntriesReplaceInput, DeckEntriesReplacePayload, DeckImportInput, DeckImportPayload, DeckImportFormatDefinition, DeckImportFormatTestInput, DeckImportFormatTestPayload, DeckImportFormatCreateInput, DeckImportFormatUpdateInput, DeckPublishInput, DeckPublishPayload, DeckRemoveInvalidEntriesInput, DeckCollaboratorRole, DeckPreviewTokenCreateInput, DeckPreviewTokenCreatePayload, DeckEmbedTokenCreateInput, DeckEmbedTokenCreatePayload, DeckAccessTokenIssuerCreateInput, DeckAPIApplicationAccessGrantInput, DeckAccessTokenExchangeInput, DeckAccessTokenExchangePayload, DeckSessionTokenExchangeInput, DeckSessionTokenExchangePayload, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, DatasetRecordsUpsertInput, DatasetRecordsUpsertPayload, DatasetRecordsDeleteInput, DatasetRecordDeleteJob, DatasetRecordDeleteJobStatus, DatasetImportPreviewInput, DatasetImportPreviewResult, DatasetImportValidateInput, BulkImportResult, DatasetImportRunInput, ImportJob, ImportJobStatus, ImportLogLevel, ImportJobLog, GameImportPreviewInput, GameImportPreview, GameImportRunInput, GameImportJob, DatasetExportInput, ExportJob, ExportJobStatus, File, FileUploadInput, PresignedUpload, UploadPurpose, CreateScanJobInput, ScanJobPayload, ScanJob, SubmitScanFeedbackInput, ScanFeedbackPayload, ScanMetricsInput, ScanMetrics, ResolveScanTemplateInput, ScanTemplateResolution, ScanTemplatesInput, ScanTemplate, SaveScanTemplateInput, ScanTemplatePayload, PreviewScanTemplateInput, ScanTemplatePreview, APIKeyInfo } from '@carddb/core';
 export * from '@carddb/core';
 
 /**
@@ -256,6 +256,14 @@ interface GetGameBySlugOptions extends GetGameOptions {
     /** Stable game slug, currently backed by metafyGameSlug */
     gameSlug: string;
 }
+interface GetGameRegionsOptions extends GetGameOptions {
+    /** Publisher slug, defaults to client defaultPublisher */
+    publisherSlug?: string;
+    /** Stable game key, defaults to client defaultGame */
+    gameKey?: string;
+    /** Include inactive publisher-managed scan regions */
+    includeInactive?: boolean;
+}
 declare class GamesResource extends BaseResource {
     constructor(connection: Connection, config: Configuration);
     /**
@@ -278,6 +286,10 @@ declare class GamesResource extends BaseResource {
      * Update a publisher-managed game. Requires a server-side secret credential.
      */
     update(id: string, input: GameUpdateInput): Promise<Game>;
+    /**
+     * Get publisher-defined game region metadata for scan-capable clients.
+     */
+    getRegions(options?: GetGameRegionsOptions): Promise<GameScanRegion[]>;
     /**
      * Search for games
      *
@@ -1324,6 +1336,22 @@ interface GetFileOptions {
     /** Whether to use cache (defaults to client config) */
     cache?: boolean;
 }
+interface UploadFileInput {
+    filename: string;
+    contentType: string;
+    body: unknown;
+    /** File size in bytes. Inferred for strings, ArrayBuffers, typed arrays, Blob/File-like values. */
+    size?: number;
+    /** Defaults to false. */
+    isPublic?: boolean;
+    /** Convenience purpose mapped onto existing file metadata. */
+    purpose?: UploadPurpose;
+    /** Override the entity type sent to the API. */
+    entityType?: string;
+    entityId?: string;
+    publisherId?: string;
+    datasetId?: string;
+}
 declare class FilesResource extends BaseResource {
     constructor(connection: Connection, config: Configuration);
     /**
@@ -1338,12 +1366,149 @@ declare class FilesResource extends BaseResource {
      * Confirm that a presigned upload completed.
      */
     confirmUpload(id: string): Promise<File>;
+    /**
+     * Request a presigned upload URL, PUT bytes directly to storage, then confirm the file.
+     */
+    upload(input: UploadFileInput): Promise<File>;
     /**
      * Delete a file. Requires a server-side secret credential.
      */
     delete(id: string): Promise<boolean>;
 }
 
+/**
+ * Scan job resource for CardDB API
+ */
+
+type CreateScanJobOptions = Omit<CreateScanJobInput, 'publisherSlug' | 'gameKey'> & {
+    /** Publisher slug, defaults to client defaultPublisher */
+    publisherSlug?: string;
+    /** Game key, defaults to client defaultGame */
+    gameKey?: string;
+};
+type ScanMetricsOptions = Omit<ScanMetricsInput, 'publisherSlug' | 'gameKey'> & {
+    /** Publisher slug, defaults to client defaultPublisher */
+    publisherSlug?: string;
+    /** Game key, defaults to client defaultGame */
+    gameKey?: string;
+};
+interface GetScanJobOptions {
+    /** Whether to use cache (defaults to client config) */
+    cache?: boolean;
+}
+interface PollScanJobOptions {
+    /** First delay between polling attempts in milliseconds */
+    intervalMs?: number;
+    /** Maximum total polling time in milliseconds */
+    timeoutMs?: number;
+    /** Multiplier applied to the delay after each non-terminal response */
+    backoffFactor?: number;
+    /** Maximum delay between polling attempts in milliseconds */
+    maxIntervalMs?: number;
+    /** Abort-like signal. The SDK checks `aborted` before each request and sleep. */
+    signal?: PollSignal;
+}
+interface PollSignal {
+    aborted: boolean;
+    reason?: unknown;
+    throwIfAborted?: () => void;
+}
+interface VerifyWebhookSignatureInput {
+    body: string | ArrayBuffer | ArrayBufferView;
+    signature: string;
+    secret: string;
+}
+declare class ScansResource extends BaseResource {
+    constructor(connection: Connection, config: Configuration);
+    /**
+     * Create a scan job for an already uploaded image file.
+     */
+    createJob(input: CreateScanJobOptions): Promise<ScanJobPayload>;
+    /**
+     * Get a scan job and its latest processing result.
+     */
+    getJob(id: string, options?: GetScanJobOptions): Promise<ScanJob | null>;
+    /**
+     * Poll a scan job until it reaches a terminal status.
+     */
+    pollJob(id: string, options?: PollScanJobOptions): Promise<ScanJob>;
+    /**
+     * Submit correctness feedback for a completed scan job.
+     */
+    submitFeedback(input: SubmitScanFeedbackInput): Promise<ScanFeedbackPayload>;
+    /**
+     * Aggregate scan metrics for a publisher/game/dataset scope.
+     */
+    metrics(input: ScanMetricsOptions): Promise<ScanMetrics>;
+    /**
+     * Verify an `X-CardDB-Signature` value for a webhook body.
+     */
+    verifyWebhookSignature(input: VerifyWebhookSignatureInput): Promise<boolean>;
+    private resolveCreateJobInput;
+    private resolveMetricsInput;
+}
+
+/**
+ * Scan template resource for CardDB API
+ */
+
+type ResolveScanTemplateOptions = Omit<ResolveScanTemplateInput, 'publisherSlug' | 'gameKey'> & {
+    /** Publisher slug, defaults to client defaultPublisher */
+    publisherSlug?: string;
+    /** Game key, defaults to client defaultGame */
+    gameKey?: string;
+    /** Whether to use cache (defaults to client config) */
+    cache?: boolean;
+};
+type ListScanTemplatesOptions = Omit<ScanTemplatesInput, 'publisherSlug' | 'gameKey'> & {
+    /** Publisher slug, defaults to client defaultPublisher */
+    publisherSlug?: string;
+    /** Game key, defaults to client defaultGame */
+    gameKey?: string;
+    /** Whether to use cache (defaults to client config) */
+    cache?: boolean;
+};
+type SaveScanTemplateOptions = Omit<SaveScanTemplateInput, 'publisherSlug' | 'gameKey'> & {
+    /** Publisher slug, defaults to client defaultPublisher */
+    publisherSlug?: string;
+    /** Game key, defaults to client defaultGame */
+    gameKey?: string;
+};
+type PreviewScanTemplateOptions = Omit<PreviewScanTemplateInput, 'publisherSlug' | 'gameKey'> & {
+    /** Publisher slug, defaults to client defaultPublisher */
+    publisherSlug?: string;
+    /** Game key, defaults to client defaultGame */
+    gameKey?: string;
+};
+type UpdateScanTemplateOptions = SaveScanTemplateOptions & {
+    id: string;
+};
+declare class ScanTemplatesResource extends BaseResource {
+    constructor(connection: Connection, config: Configuration);
+    /**
+     * Resolve the active scan template for a game or dataset scope.
+     */
+    resolve(input: ResolveScanTemplateOptions): Promise<ScanTemplateResolution>;
+    /**
+     * List publisher-managed scan templates for a game or dataset scope.
+     */
+    list(input: ListScanTemplatesOptions): Promise<ScanTemplate[]>;
+    /**
+     * Create a publisher-managed scan template. Requires a server-side secret credential.
+     */
+    create(input: SaveScanTemplateOptions): Promise<ScanTemplatePayload>;
+    update(input: UpdateScanTemplateOptions): Promise<ScanTemplatePayload>;
+    update(id: string, input: SaveScanTemplateOptions): Promise<ScanTemplatePayload>;
+    /**
+     * Validate a draft scan template and normalize provided region OCR hints.
+     */
+    preview(input: PreviewScanTemplateOptions): Promise<ScanTemplatePreview>;
+    private resolveTemplateScope;
+    private resolveListScope;
+    private resolveSaveInput;
+    private resolvePreviewInput;
+}
+
 /**
  * CardDB API Client
  *
@@ -1415,6 +1580,10 @@ declare class CardDBClient {
     readonly exports: ExportsResource;
     /** File upload helper resource */
     readonly files: FilesResource;
+    /** Scan job helper resource */
+    readonly scans: ScansResource;
+    /** Scan template helper resource */
+    readonly scanTemplates: ScanTemplatesResource;
     /**
      * Create a new CardDB client
      *
@@ -1496,4 +1665,4 @@ declare function readCache<T>(cache: Cache, key: string): Promise<T | null>;
  */
 declare function writeCache<T>(cache: Cache, key: string, value: T, ttl: number): Promise<void>;
 
-export { BaseResource, CardDBClient, Configuration, Connection, DEFAULT_CACHE_TTL, DEFAULT_ENDPOINT, DEFAULT_MAX_NETWORK_RETRIES, DEFAULT_MAX_RETRIES, DEFAULT_OPEN_TIMEOUT, DEFAULT_RETRY_BASE_DELAY, DEFAULT_RETRY_MAX_DELAY, DEFAULT_TIMEOUT, DatasetsResource, type DeckSectionDefinitionsOptions, DecksResource, ExportsResource, type FetchDeckByExternalRefOptions, type FetchDeckBySlugOptions, type FetchDeckOptions, FilesResource, GamesResource, type GetDatasetByKeyOptions, type GetDatasetOptions, type GetFileOptions, type GetGameByKeyOptions, type GetGameBySlugOptions, type GetGameOptions, type GetImportFormatByKeyOptions, type GetImportFormatOptions, type GetPublisherOptions, type GetRecordByDatasetIdentifierOptions, type GetRecordByIdentifierOptions, type GetRecordOptions, type GetRecordsByIdentifierOptions, type GraphQLResponse, type HydrateDeckEntriesOptions, ImportFormatsResource, ImportsResource, type ListAppDecksOptions, type ListDatasetsOptions, type ListDeckAccessTokenIssuersOptions, type ListDeckApiApplicationAccessesOptions, type ListDeckCollaboratorsOptions, type ListDeckEmbedTokensOptions, type ListDeckImportFormatsOptions, type ListDeckPreviewTokensOptions, type ListDeckVersionsOptions, type ListDecksOptions, type ListExportJobsOptions, type ListFormatsOptions, type ListGameImportJobsOptions, type ListGamesOptions, type ListImportFormatsOptions, type ListImportJobLogsOptions, type ListImportJobsOptions, type ListMyDeckApiApplicationAccessesOptions, type ListPublicDecksOptions, type ListRecordDeleteJobsOptions, type ListRecordsOptions, type ListRuleDatasetsOptions, type ListRulesOptions, type ListViewerDecksOptions, PublishersResource, RecordsResource, RulesResource, type SearchDatasetsOptions, type SearchGamesOptions, type SearchPublishersOptions, type SearchRecordsOptions, type WaitForExportJobOptions, type WaitForImportJobOptions, type WaitForRecordDeleteJobOptions, cacheKey, getRateLimitInfo, getSDKVersion, getUserAgent, readCache, writeCache };
+export { BaseResource, CardDBClient, Configuration, Connection, type CreateScanJobOptions, DEFAULT_CACHE_TTL, DEFAULT_ENDPOINT, DEFAULT_MAX_NETWORK_RETRIES, DEFAULT_MAX_RETRIES, DEFAULT_OPEN_TIMEOUT, DEFAULT_RETRY_BASE_DELAY, DEFAULT_RETRY_MAX_DELAY, DEFAULT_TIMEOUT, DatasetsResource, type DeckSectionDefinitionsOptions, DecksResource, ExportsResource, type FetchDeckByExternalRefOptions, type FetchDeckBySlugOptions, type FetchDeckOptions, FilesResource, GamesResource, type GetDatasetByKeyOptions, type GetDatasetOptions, type GetFileOptions, type GetGameByKeyOptions, type GetGameBySlugOptions, type GetGameOptions, type GetGameRegionsOptions, type GetImportFormatByKeyOptions, type GetImportFormatOptions, type GetPublisherOptions, type GetRecordByDatasetIdentifierOptions, type GetRecordByIdentifierOptions, type GetRecordOptions, type GetRecordsByIdentifierOptions, type GetScanJobOptions, type GraphQLResponse, type HydrateDeckEntriesOptions, ImportFormatsResource, ImportsResource, type ListAppDecksOptions, type ListDatasetsOptions, type ListDeckAccessTokenIssuersOptions, type ListDeckApiApplicationAccessesOptions, type ListDeckCollaboratorsOptions, type ListDeckEmbedTokensOptions, type ListDeckImportFormatsOptions, type ListDeckPreviewTokensOptions, type ListDeckVersionsOptions, type ListDecksOptions, type ListExportJobsOptions, type ListFormatsOptions, type ListGameImportJobsOptions, type ListGamesOptions, type ListImportFormatsOptions, type ListImportJobLogsOptions, type ListImportJobsOptions, type ListMyDeckApiApplicationAccessesOptions, type ListPublicDecksOptions, type ListRecordDeleteJobsOptions, type ListRecordsOptions, type ListRuleDatasetsOptions, type ListRulesOptions, type ListScanTemplatesOptions, type ListViewerDecksOptions, type PollScanJobOptions, type PollSignal, type PreviewScanTemplateOptions, PublishersResource, RecordsResource, type ResolveScanTemplateOptions, RulesResource, type SaveScanTemplateOptions, type ScanMetricsOptions, ScanTemplatesResource, ScansResource, type SearchDatasetsOptions, type SearchGamesOptions, type SearchPublishersOptions, type SearchRecordsOptions, type UpdateScanTemplateOptions, type UploadFileInput, type VerifyWebhookSignatureInput, type WaitForExportJobOptions, type WaitForImportJobOptions, type WaitForRecordDeleteJobOptions, cacheKey, getRateLimitInfo, getSDKVersion, getUserAgent, readCache, writeCache };