palbase 0.0.0-stage → 0.2.0

package/types/internal/src/modules/stores.d.ts

@@ -0,0 +1,1516 @@
+import { type Reply, type Transport } from '../transport.js';
+/**
+ * A step that changes something at Apple for good: planned, then run only when a person confirms it with its hash, within a day.
+ */
+export type Action = {
+    /**
+     * When it was planned.
+     */
+    created_at: string;
+    /**
+     * When it was confirmed or declined.
+     */
+    decided_at: string | null;
+    /**
+     * Who confirmed or declined it.
+     */
+    decided_by: string | null;
+    /**
+     * When it can no longer be confirmed.
+     */
+    expires_at: string;
+    /**
+     * The plan's hash: a confirmation names it.
+     */
+    hash: string;
+    /**
+     * The action's id.
+     */
+    id: string;
+    /**
+     * What it does.
+     */
+    kind: "beta_review" | "export_compliance" | "expire_build";
+    /**
+     * Its package.
+     */
+    package_id: string;
+    /**
+     * What it does, exactly.
+     */
+    payload: {
+        [key: string]: unknown;
+    };
+    /**
+     * Who planned it.
+     */
+    planned_by: string;
+    /**
+     * What Apple answered.
+     */
+    result?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Where it is.
+     */
+    status: "planned" | "done" | "declined" | "failed";
+    /**
+     * What it does, for the person who confirms it.
+     */
+    summary: string;
+};
+/**
+ * stores.action.changed: an action was planned, done, declined or failed.
+ */
+export type ActionChangedEvent = {
+    /**
+     * The action.
+     */
+    action_id: string;
+    /**
+     * What it does.
+     */
+    kind: string;
+    /**
+     * Its package.
+     */
+    package_id: string;
+    /**
+     * Where it is.
+     */
+    status: string;
+    /**
+     * What it does.
+     */
+    summary: string;
+};
+/**
+ * A page of actions, newest first.
+ */
+export type ActionPage = {
+    /**
+     * The actions.
+     */
+    actions: Action[];
+    /**
+     * The next page's cursor; absent on the last.
+     */
+    next_cursor?: string;
+};
+/**
+ * An app of the project linked to its store.
+ */
+export type App = {
+    /**
+     * The app's id (the registry's).
+     */
+    app_id: string;
+    /**
+     * Its App Store Connect record's id; null until a person made the record on the website.
+     */
+    asc_app_id: string | null;
+    /**
+     * Its bundle id.
+     */
+    bundle_id: string;
+    /**
+     * Apple's id of the bundle id.
+     */
+    bundle_resource_id: string;
+    /**
+     * When it was first linked.
+     */
+    linked_at: string;
+    /**
+     * Its name at Apple.
+     */
+    name: string;
+    /**
+     * The platform.
+     */
+    platform: "ios";
+    /**
+     * Its Apple team.
+     */
+    team_id: string;
+    /**
+     * When it was last linked.
+     */
+    updated_at: string;
+};
+/**
+ * stores.app.changed: an app was linked to its store.
+ */
+export type AppChangedEvent = {
+    /**
+     * The app.
+     */
+    app_id: string;
+    /**
+     * Its App Store Connect record.
+     */
+    asc_app_id?: string | null;
+    /**
+     * Its bundle id.
+     */
+    bundle_id: string;
+    /**
+     * What happened.
+     */
+    change: "linked";
+};
+/**
+ * The project's linked apps.
+ */
+export type AppPage = {
+    /**
+     * The apps.
+     */
+    apps: App[];
+};
+/**
+ * The project's Apple account (App Store Connect API key) as the API shows it: never the key itself.
+ */
+export type AppleAccount = {
+    /**
+     * What the person has to do, when Apple waits on them.
+     */
+    action?: string;
+    /**
+     * What the key reached when it was last checked: apps, certificates, testflight, users. A role that lacks one is refused it by Apple.
+     */
+    capabilities?: ("apps" | "certificates" | "testflight" | "users")[];
+    /**
+     * When Apple was last asked.
+     */
+    checked_at?: string;
+    /**
+     * Whether the project has an Apple account connected.
+     */
+    connected: boolean;
+    /**
+     * When the key was connected.
+     */
+    connected_at?: string;
+    /**
+     * Who asked for the grant the key was connected with (the API key that asked).
+     */
+    connected_by?: string;
+    /**
+     * The account's issuer id (team-wide, a UUID).
+     */
+    issuer_id?: string;
+    /**
+     * The connected key's id (10 characters).
+     */
+    key_id?: string;
+    /**
+     * What Apple last said of the key: active (answers it), agreement (refuses every call until the account holder accepts the account's agreements in App Store Connect), refused (does not accept the key).
+     */
+    status?: "active" | "agreement" | "refused";
+};
+/**
+ * stores.apple.changed: the project's Apple account was connected, checked (and Apple's answer changed) or disconnected. Never the key.
+ */
+export type AppleChangedEvent = {
+    /**
+     * What the key reaches (connected, checked).
+     */
+    capabilities?: string[];
+    /**
+     * What happened.
+     */
+    change: "connected" | "checked" | "disconnected";
+    /**
+     * The account's issuer id.
+     */
+    issuer_id: string;
+    /**
+     * The key's id.
+     */
+    key_id: string;
+    /**
+     * What Apple said of the key (connected, checked).
+     */
+    status?: "active" | "agreement" | "refused";
+};
+/**
+ * A one-time grant to connect an Apple key: the key goes from the person's browser (connect_url) or terminal (POST /stores/connect with the grant) straight to the module.
+ */
+export type AppleGrant = {
+    /**
+     * The page that takes the key from a browser. The grant rides in the URL's fragment, which a browser never sends to a server.
+     */
+    connect_url: string;
+    /**
+     * When the grant stops working.
+     */
+    expires_at: string;
+    /**
+     * The grant: spent by the first key Apple accepts, or after 30 minutes.
+     */
+    grant: string;
+};
+/**
+ * The sandbox testers whose purchases Apple forgets.
+ */
+export type ClearPurchaseHistoryRequest = {
+    /**
+     * Their ids (1-100).
+     */
+    tester_ids: string[];
+};
+/**
+ * The person's export compliance answer.
+ */
+export type ComplianceRequest = {
+    /**
+     * Whether the app uses encryption beyond HTTPS and what iOS provides.
+     */
+    uses_non_exempt_encryption: boolean;
+};
+/**
+ * A confirmation, with the hash of the plan shown.
+ */
+export type ConfirmRequest = {
+    /**
+     * The plan's hash.
+     */
+    hash: string;
+};
+/**
+ * An App Store Connect API key handed over with a grant.
+ */
+export type ConnectAppleKeyRequest = {
+    /**
+     * The .p8's file name, when a file was picked: Apple names it after the key (AuthKey_<KEYID>.p8), so a mismatch is caught.
+     */
+    file_name?: string;
+    /**
+     * The grant a connect link carries.
+     */
+    grant: string;
+    /**
+     * The account's issuer id (App Store Connect → Users and Access → Integrations).
+     */
+    issuer_id: string;
+    /**
+     * The key's id: 10 capital letters and digits.
+     */
+    key_id: string;
+    /**
+     * The .p8 file's text (PEM, a P-256 private key).
+     */
+    private_key: string;
+};
+/**
+ * A package of an app.
+ */
+export type CreatePackageRequest = {
+    /**
+     * Names the request: sent again, the same package (and a new upload token while it waits for its build).
+     */
+    command_id: string;
+    /**
+     * What each bundle asked for, by bundle id, as the build machine read it from the target (an unsigned build carries none): the build is signed with them, bounded by what Apple grants.
+     */
+    entitlements?: {
+        [key: string]: {
+            [key: string]: unknown;
+        };
+    };
+    /**
+     * Notes (a commit, a branch).
+     */
+    notes?: string;
+};
+/**
+ * A package sent to a channel.
+ */
+export type DeliverRequest = {
+    /**
+     * The channel.
+     */
+    channel: "testflight";
+    /**
+     * The groups it goes to once ready.
+     */
+    groups?: string[];
+    what_to_test?: WhatToTest;
+};
+/**
+ * A package's way to a channel's testers.
+ */
+export type Delivery = {
+    /**
+     * Apple's build id, once Apple has it.
+     */
+    asc_build_id: string | null;
+    /**
+     * The channel.
+     */
+    channel: "testflight";
+    /**
+     * When it was first sent.
+     */
+    created_at: string;
+    /**
+     * What to do about it.
+     */
+    error: string | null;
+    /**
+     * Why it failed: apple_agreement, apple_key_refused, certificate_limit, app_record_missing, manual_step, capability_missing, not_an_ipa, apple_refused, upload_failed, processing_failed, build_changed (the kept build is not the one uploaded), build_gone (no longer kept: builds are kept 90 days), step_timed_out (signing or handing it over took more than 45 minutes), worker_stopped (it stopped the module's worker three times), gave_up.
+     */
+    error_code: string | null;
+    /**
+     * The groups it goes to once ready.
+     */
+    groups: string[];
+    /**
+     * The package.
+     */
+    package_id: string;
+    /**
+     * Apple's processing state.
+     */
+    processing_state: string | null;
+    /**
+     * Who sent it.
+     */
+    requested_by: string;
+    /**
+     * queued, signing, uploading, processing (Apple processes it), compliance (waits on the export compliance answer: POST /stores/packages/{id}/export-compliance), ready, failed.
+     */
+    status: "queued" | "signing" | "uploading" | "processing" | "compliance" | "ready" | "failed";
+    /**
+     * When it last moved.
+     */
+    updated_at: string;
+    /**
+     * The note testers read.
+     */
+    what_to_test: string | null;
+};
+/**
+ * stores.delivery.changed: a delivery moved: queued, signing, uploading, processing, compliance, ready or failed.
+ */
+export type DeliveryChangedEvent = {
+    /**
+     * Apple's build id, once known.
+     */
+    asc_build_id?: string;
+    /**
+     * The channel.
+     */
+    channel: string;
+    /**
+     * What to do about it.
+     */
+    error?: string;
+    /**
+     * Why it failed.
+     */
+    error_code?: string;
+    /**
+     * The package.
+     */
+    package_id: string;
+    /**
+     * Where it is now.
+     */
+    status: "queued" | "signing" | "uploading" | "processing" | "compliance" | "ready" | "failed";
+};
+/**
+ * A package's deliveries.
+ */
+export type DeliveryPage = {
+    /**
+     * The deliveries.
+     */
+    deliveries: Delivery[];
+};
+/**
+ * stores.delivery.requested: a delivery was sent (or sent again); the stores module runs it.
+ */
+export type DeliveryRequestedEvent = {
+    /**
+     * The channel.
+     */
+    channel: "testflight";
+    /**
+     * The package.
+     */
+    package_id: string;
+};
+export type ErrorResponse = {
+    /**
+     * Machine-readable error code (snake_case)
+     */
+    error: string;
+    /**
+     * Human-readable explanation
+     */
+    error_description: string;
+    /**
+     * Correlation ID for log/audit lookup
+     */
+    request_id: string;
+    /**
+     * Seconds to wait before retrying; present on a refusal that ends with time.
+     */
+    retry_after?: number;
+    /**
+     * HTTP status code (mirrors the response status)
+     */
+    status: number;
+};
+/**
+ * A tester's TestFlight feedback.
+ */
+export type Feedback = {
+    /**
+     * What the tester wrote.
+     */
+    comment?: string;
+    /**
+     * When it was sent.
+     */
+    created_at: string;
+    /**
+     * The tester's address.
+     */
+    email?: string;
+    /**
+     * Apple's id.
+     */
+    id: string;
+    /**
+     * What it is.
+     */
+    kind: "screenshot" | "crash";
+};
+/**
+ * An app's newest tester feedback.
+ */
+export type FeedbackPage = {
+    /**
+     * The feedback, newest first.
+     */
+    feedback: Feedback[];
+};
+/**
+ * A group of people who test an app: in TestFlight an internal group (the account's App Store Connect users, who get a build at once) and an external one (everyone else, after Beta App Review).
+ */
+export type Group = {
+    /**
+     * Its app.
+     */
+    app_id: string;
+    /**
+     * Its external TestFlight group.
+     */
+    asc_external_group_id: string | null;
+    /**
+     * Its internal TestFlight group.
+     */
+    asc_internal_group_id: string | null;
+    /**
+     * When it was made.
+     */
+    created_at: string;
+    /**
+     * The group's id.
+     */
+    id: string;
+    /**
+     * Its name.
+     */
+    name: string;
+    /**
+     * How many testers it holds.
+     */
+    testers: number;
+    /**
+     * When it last changed.
+     */
+    updated_at: string;
+};
+/**
+ * A package to give a group.
+ */
+export type GroupBuildRequest = {
+    /**
+     * A package of the group's app that TestFlight has.
+     */
+    package_id: string;
+};
+/**
+ * stores.group.changed: a group was made, renamed, deleted, its testers set, or a build given to it.
+ */
+export type GroupChangedEvent = {
+    /**
+     * Its app.
+     */
+    app_id: string;
+    /**
+     * What happened.
+     */
+    change: "created" | "renamed" | "deleted" | "testers" | "build";
+    /**
+     * The group.
+     */
+    group_id: string;
+    /**
+     * Its name.
+     */
+    name: string;
+    /**
+     * The package given (build).
+     */
+    package_id?: string;
+    /**
+     * How many testers it holds.
+     */
+    testers?: number;
+};
+/**
+ * An app's groups.
+ */
+export type GroupPage = {
+    /**
+     * The groups.
+     */
+    groups: Group[];
+};
+/**
+ * A group's name.
+ */
+export type GroupRequest = {
+    /**
+     * 1 to 40 characters on one line.
+     */
+    name: string;
+};
+/**
+ * A person in a group.
+ */
+export type GroupTester = {
+    /**
+     * When they were added.
+     */
+    added_at: string;
+    /**
+     * Their address (lowercase).
+     */
+    email: string;
+    /**
+     * First name.
+     */
+    first_name: string | null;
+    /**
+     * Last name.
+     */
+    last_name: string | null;
+    /**
+     * Which TestFlight group serves them: internal for the account's App Store Connect users.
+     */
+    side: "internal" | "external";
+};
+/**
+ * The unsigned .ipa, as the build machine made it.
+ */
+export type IPAFile = Blob;
+/**
+ * How the app is called at Apple.
+ */
+export type LinkAppRequest = {
+    /**
+     * Its name at Apple (folded to letters, digits and spaces); the bundle id when absent.
+     */
+    name?: string;
+};
+/**
+ * A build handed to the stores.
+ */
+export type Package = {
+    /**
+     * Its app.
+     */
+    app_id: string;
+    /**
+     * Its build number: above every number Apple and the stores have seen for the app. The build is made with it (CFBundleVersion).
+     */
+    build_number: number;
+    /**
+     * The bundles in the build.
+     */
+    bundles: PackageBundle[];
+    /**
+     * The request that made it.
+     */
+    command_id: string;
+    /**
+     * When it was made.
+     */
+    created_at: string;
+    /**
+     * Who asked for it.
+     */
+    created_by: string;
+    /**
+     * Its deliveries.
+     */
+    deliveries: Delivery[];
+    /**
+     * The package's id.
+     */
+    id: string;
+    /**
+     * The caller's notes.
+     */
+    notes: string | null;
+    /**
+     * The .ipa's SHA-256.
+     */
+    sha256: string | null;
+    /**
+     * The .ipa's size in bytes.
+     */
+    size: number | null;
+    /**
+     * awaiting_upload until the build machine hands the build over.
+     */
+    status: "awaiting_upload" | "uploaded";
+    upload?: PackageUpload;
+    /**
+     * When its build arrived.
+     */
+    uploaded_at: string | null;
+    /**
+     * What the build says it is (CFBundleShortVersionString), once uploaded.
+     */
+    version: string | null;
+};
+/**
+ * One bundle of a build.
+ */
+export type PackageBundle = {
+    /**
+     * Its bundle id.
+     */
+    bundle_id: string;
+    /**
+     * Its CFBundleName: the name its bundle id is registered with at Apple.
+     */
+    name?: string;
+    /**
+     * Its path in the app (empty for the app itself).
+     */
+    path: string;
+};
+/**
+ * stores.package.changed: a package was made, or its build arrived.
+ */
+export type PackageChangedEvent = {
+    /**
+     * Its app.
+     */
+    app_id: string;
+    /**
+     * Its build number.
+     */
+    build_number: number;
+    /**
+     * What happened.
+     */
+    change: "created" | "uploaded";
+    /**
+     * The package.
+     */
+    package_id: string;
+    /**
+     * Its version (uploaded).
+     */
+    version?: string;
+};
+/**
+ * A page of packages, newest first.
+ */
+export type PackagePage = {
+    /**
+     * The next page's cursor; absent on the last.
+     */
+    next_cursor?: string;
+    /**
+     * The packages.
+     */
+    packages: Package[];
+};
+/**
+ * Where and how a build machine hands the build over: a PUT of the .ipa to url, the token in the Palbase-Upload-Token header.
+ */
+export type PackageUpload = {
+    /**
+     * When the token stops working.
+     */
+    expires_at: string;
+    /**
+     * The upload token: shown once, the last one handed out works.
+     */
+    token: string;
+    /**
+     * Where the .ipa is PUT.
+     */
+    url: string;
+};
+/**
+ * One thing the sandbox needs.
+ */
+export type ReadinessCheck = {
+    /**
+     * What to do: a palbase command, or the place in App Store Connect where only a person can do it; empty when the check holds.
+     */
+    fix: string;
+    /**
+     * The check's stable id: apple_account, apple_agreements, app_linked, server_notifications, sandbox_testers, products, or product:<product id>.
+     */
+    id: string;
+    /**
+     * What holds or does not, in a sentence.
+     */
+    message: string;
+    /**
+     * Whether it holds.
+     */
+    ok: boolean;
+};
+/**
+ * What Beta App Review needs to know about an app; only the fields given are written.
+ */
+export type ReviewInfo = {
+    /**
+     * Email.
+     */
+    contact_email?: string;
+    /**
+     * Whom Apple calls: first name.
+     */
+    contact_first_name?: string;
+    /**
+     * Last name.
+     */
+    contact_last_name?: string;
+    /**
+     * Phone.
+     */
+    contact_phone?: string;
+    /**
+     * A sign-in for the reviewer, when the app needs one.
+     */
+    demo_account_name?: string;
+    /**
+     * Its password.
+     */
+    demo_account_password?: string;
+    /**
+     * What testers should test.
+     */
+    description?: string;
+    /**
+     * Where testers send feedback.
+     */
+    feedback_email?: string;
+    /**
+     * The locale of the description and feedback address; the app's primary one when absent.
+     */
+    locale?: string;
+    /**
+     * Notes to the reviewer.
+     */
+    notes?: string;
+};
+/**
+ * What Beta App Review still lacks.
+ */
+export type ReviewInfoAnswer = {
+    /**
+     * beta_description, feedback_email, contact_first_name, contact_last_name, contact_phone, contact_email, demo_account.
+     */
+    missing: string[];
+};
+/**
+ * The app's TestFlight test information as Apple holds it, in one locale, and what Beta App Review still lacks. The demo account's password is never read out: only whether one is set.
+ */
+export type ReviewInfoState = {
+    /**
+     * Beta App Review's contact.
+     */
+    contact_email: string;
+    /**
+     * Beta App Review's contact.
+     */
+    contact_first_name: string;
+    /**
+     * Beta App Review's contact.
+     */
+    contact_last_name: string;
+    /**
+     * Beta App Review's contact.
+     */
+    contact_phone: string;
+    /**
+     * The demo account's name.
+     */
+    demo_account_name: string;
+    /**
+     * Whether the demo account's password is set (it is never read out).
+     */
+    demo_account_password_set: boolean;
+    /**
+     * Whether Beta App Review signs in with a demo account.
+     */
+    demo_account_required: boolean;
+    /**
+     * What testers should test, in that locale.
+     */
+    description: string;
+    /**
+     * Where testers send feedback, in that locale.
+     */
+    feedback_email: string;
+    /**
+     * The locale read (the app's primary one unless asked).
+     */
+    locale: string;
+    /**
+     * The locales the app has test information in.
+     */
+    locales: string[];
+    /**
+     * What Beta App Review still lacks: beta_description, feedback_email, contact_first_name, contact_last_name, contact_phone, contact_email, demo_account.
+     */
+    missing: string[];
+    /**
+     * Notes for Beta App Review.
+     */
+    notes: string;
+};
+/**
+ * Whether an app can buy in the App Store's sandbox now, check by check.
+ */
+export type SandboxReadiness = {
+    /**
+     * The app checked (the registry's id); null when the environment links none.
+     */
+    app_id: string | null;
+    /**
+     * The checks, in a stable order: the account's, the app's, then each product's.
+     */
+    checks: ReadinessCheck[];
+    /**
+     * Every check holds.
+     */
+    ready: boolean;
+};
+/**
+ * One of the Apple team's sandbox testers.
+ */
+export type SandboxTester = {
+    /**
+     * The sandbox Apple Account it signs in with.
+     */
+    email: string;
+    /**
+     * As made in App Store Connect.
+     */
+    first_name: string;
+    /**
+     * Apple's id for it.
+     */
+    id: string;
+    /**
+     * Whether its purchases stop for an action of the buyer's (a purchase that needs it).
+     */
+    interrupt_purchases: boolean;
+    /**
+     * As made in App Store Connect.
+     */
+    last_name: string;
+    /**
+     * How fast its monthly subscriptions renew.
+     */
+    subscription_renewal_rate: string;
+    /**
+     * The storefront it buys in (three letters: TUR, USA …).
+     */
+    territory: string;
+};
+/**
+ * What changes of a sandbox tester: what is left out stays; at least one.
+ */
+export type SandboxTesterChange = {
+    /**
+     * Whether its purchases stop for an action of the buyer's.
+     */
+    interrupt_purchases?: boolean;
+    /**
+     * How fast its monthly subscriptions renew.
+     */
+    subscription_renewal_rate?: "MONTHLY_RENEWAL_EVERY_ONE_HOUR" | "MONTHLY_RENEWAL_EVERY_THIRTY_MINUTES" | "MONTHLY_RENEWAL_EVERY_FIFTEEN_MINUTES" | "MONTHLY_RENEWAL_EVERY_FIVE_MINUTES" | "MONTHLY_RENEWAL_EVERY_THREE_MINUTES";
+    /**
+     * The storefront it buys in: three letters (TUR, USA, DEU …).
+     */
+    territory?: string;
+};
+/**
+ * The team's sandbox testers.
+ */
+export type SandboxTesterPage = {
+    /**
+     * Where a person makes another: Apple's API makes none.
+     */
+    create_in: string;
+    /**
+     * The testers.
+     */
+    testers: SandboxTester[];
+};
+/**
+ * A person to have in a group.
+ */
+export type TesterInput = {
+    /**
+     * Their address.
+     */
+    email: string;
+    /**
+     * First name.
+     */
+    first_name?: string;
+    /**
+     * Last name.
+     */
+    last_name?: string;
+};
+/**
+ * A group's testers.
+ */
+export type TesterPage = {
+    /**
+     * The testers.
+     */
+    testers: GroupTester[];
+};
+/**
+ * Who a group holds, whole: those not named leave it.
+ */
+export type TestersRequest = {
+    /**
+     * The testers (100 at most).
+     */
+    testers: TesterInput[];
+};
+/**
+ * A build's note to testers.
+ */
+export type WhatToTest = {
+    /**
+     * Its locale; the app's primary one when absent.
+     */
+    locale?: string;
+    /**
+     * The note.
+     */
+    text: string;
+};
+/** The events this module sends the project's webhooks (x-palbase-events), by type: each one's payload, the event's data. */
+export interface Events {
+    /**
+     * stores.action.changed: an action was planned, done, declined or failed.
+     */
+    "stores.action.changed": ActionChangedEvent;
+    /**
+     * stores.app.changed: an app was linked to its store.
+     */
+    "stores.app.changed": AppChangedEvent;
+    /**
+     * stores.apple.changed: the project's Apple account was connected, checked (and Apple's answer changed) or disconnected. Never the key.
+     */
+    "stores.apple.changed": AppleChangedEvent;
+    /**
+     * stores.delivery.changed: a delivery moved: queued, signing, uploading, processing, compliance, ready or failed.
+     */
+    "stores.delivery.changed": DeliveryChangedEvent;
+    /**
+     * stores.delivery.requested: a delivery was sent (or sent again); the stores module runs it.
+     */
+    "stores.delivery.requested": DeliveryRequestedEvent;
+    /**
+     * stores.group.changed: a group was made, renamed, deleted, its testers set, or a build given to it.
+     */
+    "stores.group.changed": GroupChangedEvent;
+    /**
+     * stores.package.changed: a package was made, or its build arrived.
+     */
+    "stores.package.changed": PackageChangedEvent;
+}
+/** Palbase Stores */
+export declare function client(t: Transport): {
+    /**
+     * List actions
+     *
+     * The project's planned and decided actions, newest first.
+     */
+    listActions(input?: {
+        query?: {
+            status?: "planned" | "done" | "declined" | "failed"; /** How many to answer (1-200, default 50). */
+            limit?: number; /** The next_cursor of the previous page. */
+            cursor?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, ActionPage>>;
+    /**
+     * Read an action
+     *
+     * An action, its summary and hash.
+     */
+    getAction(input: {
+        path: {
+            action_id: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Action>>;
+    /**
+     * Confirm an action
+     *
+     * Runs a planned action: only with its hash, only once, only before it expires. Emits `stores.action.changed`.
+     */
+    confirmAction(input: {
+        path: {
+            action_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: ConfirmRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Action>>;
+    /**
+     * Decline an action
+     *
+     * Declines a planned action: it will not run. Emits `stores.action.changed`.
+     */
+    declineAction(input: {
+        path: {
+            action_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Action>>;
+    /**
+     * Read the project's Apple account
+     *
+     * The connected App Store Connect API key's account, its status and what it reaches — never the key.
+     */
+    getAppleAccount(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, AppleAccount>>;
+    /**
+     * Disconnect the Apple account
+     *
+     * Forgets the key for good: nothing of it is kept. Emits `stores.apple.changed` (disconnected).
+     */
+    disconnectApple(input?: {
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * Check the Apple account again
+     *
+     * Asks Apple again what the connected key can do: after the account holder accepted Apple's agreements, or a key's role changed. Emits `stores.apple.changed` (checked) when Apple's answer changed.
+     */
+    checkAppleAccount(input?: {
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, AppleAccount>>;
+    /**
+     * Grant a key's connection
+     *
+     * A one-time grant, good for 30 minutes, to hand the project an App Store Connect API key. Whoever asks for it never holds the key: the person opens `connect_url` in a browser, or a terminal posts the key to `POST /stores/connect` with the grant. A project holds 10 open grants at most (429 `too_many_grants`).
+     */
+    createAppleGrant(input?: {
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<201, AppleGrant>>;
+    /**
+     * Check whether an app can buy in the sandbox
+     *
+     * Reads Apple live and answers whether the app can buy in the App Store's sandbox now, check by check, each with what to do when it does not hold: the connected key (`apple_account`), Apple's agreements (`apple_agreements` — the Account Holder accepts them in App Store Connect › Business), the app's link to its App Store Connect record (`app_linked`), where its App Store Server Notifications go (`server_notifications`), the team's sandbox testers (`sandbox_testers` — only a person makes one, in App Store Connect › Users and Access › Sandbox), whether the app has products at Apple (`products`) and each product's state (`product:<product id>`: READY_TO_SUBMIT and later sell in the sandbox; MISSING_METADATA names what is missing). A check that could not run says why. Nothing is written.
+     */
+    getSandboxReadiness(input?: {
+        query?: {
+            app?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, SandboxReadiness>>;
+    /**
+     * List the sandbox testers
+     *
+     * The Apple team's sandbox testers — the accounts that buy in the App Store's sandbox, every environment on the team alike — and where a person makes another (Apple's API makes none).
+     */
+    listSandboxTesters(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, SandboxTesterPage>>;
+    /**
+     * Clear sandbox testers' purchases
+     *
+     * Asks Apple to forget what the sandbox testers bought: each buys again as for the first time, a subscription's introductory offer among it. Apple clears them after it answers.
+     */
+    clearSandboxPurchaseHistory(input: {
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: ClearPurchaseHistoryRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<202, ClearPurchaseHistoryRequest>>;
+    /**
+     * Change how a sandbox tester buys
+     *
+     * Changes a sandbox tester at Apple: how fast its monthly subscriptions renew, whether its purchases are interrupted (to test a purchase that needs the buyer's action), its storefront. What the request leaves out stays.
+     */
+    updateSandboxTester(input: {
+        path: {
+            tester_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: SandboxTesterChange; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, SandboxTester>>;
+    /**
+     * List linked apps
+     *
+     * The project's apps linked to their store.
+     */
+    listApps(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, AppPage>>;
+    /**
+     * Read tester feedback
+     *
+     * The app's newest TestFlight feedback (screenshots with comments, crashes), as Apple keeps it.
+     */
+    listFeedback(input: {
+        path: {
+            app_id: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, FeedbackPage>>;
+    /**
+     * List an app's groups
+     *
+     * The app's groups of testers.
+     */
+    listGroups(input: {
+        path: {
+            app_id: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, GroupPage>>;
+    /**
+     * Make a group
+     *
+     * Makes a group of testers and its two TestFlight groups. Emits `stores.group.changed` (created).
+     */
+    createGroup(input: {
+        path: {
+            app_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: GroupRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<201, Group>>;
+    /**
+     * Link an app to its store
+     *
+     * Links one of the project's registered iOS apps (this environment's bundle and team) to the App Store: its bundle id is registered on the Apple account when it is not, and its App Store Connect record is looked up — Apple lets only a person make that, once, on the website. Linking again refreshes both. Emits `stores.app.changed`.
+     */
+    linkApp(input: {
+        path: {
+            app_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: LinkAppRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, App>>;
+    /**
+     * Make a package
+     *
+     * Hands out a build number — above every number Apple and the stores have seen for the app — and a token to upload the build made with it. The same command_id answers the same package (200) with a new token while it waits for its build. Emits `stores.package.changed` (created).
+     */
+    createPackage(input: {
+        path: {
+            app_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: CreatePackageRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Package> | Reply<201, Package>>;
+    /**
+     * Read the app's test information
+     *
+     * What Beta App Review and testers are told about the app, as App Store Connect holds it — in the locale asked, or the app's primary one — and what is still missing. The demo account's password is never read out.
+     */
+    getReviewInfo(input: {
+        path: {
+            app_id: string;
+        };
+        query?: {
+            locale?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, ReviewInfoState>>;
+    /**
+     * Write the app's test information
+     *
+     * Writes what Beta App Review needs (test description, feedback address, contact, demo account); only the fields given. Answers what is still missing.
+     */
+    setReviewInfo(input: {
+        path: {
+            app_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: ReviewInfo; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, ReviewInfoAnswer>>;
+    /**
+     * The connect page
+     *
+     * The page a connect link opens: it names the project the key goes to, reads the grant from the link's fragment and posts the key with it. No credential: the grant is the authorization.
+     */
+    getConnectPage(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Response>>;
+    /**
+     * Hand over an Apple key with a grant
+     *
+     * Takes an App Store Connect API key with a grant, checks it with Apple, keeps it sealed with the project's own key and spends the grant. A key Apple does not accept, or a file that is not a key, leaves the grant for the right file. An account whose agreements wait is connected with status `agreement`. Emits `stores.apple.changed` (connected).
+     */
+    connectAppleKey(input: {
+        body: ConnectAppleKeyRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, AppleAccount>>;
+    /**
+     * Delete a group
+     *
+     * Deletes a group and its TestFlight groups; its testers keep what other groups gave them. Emits `stores.group.changed` (deleted).
+     */
+    deleteGroup(input: {
+        path: {
+            group_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * Rename a group
+     *
+     * Renames a group and its TestFlight groups. Emits `stores.group.changed` (renamed).
+     */
+    renameGroup(input: {
+        path: {
+            group_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: GroupRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Group>>;
+    /**
+     * Give a group a build
+     *
+     * Gives the group a package of its app that TestFlight has (its delivery is ready). Emits `stores.group.changed` (build).
+     */
+    addGroupBuild(input: {
+        path: {
+            group_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: GroupBuildRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * List a group's testers
+     *
+     * The group's testers, and which TestFlight group serves each.
+     */
+    listTesters(input: {
+        path: {
+            group_id: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, TesterPage>>;
+    /**
+     * Set a group's testers
+     *
+     * Makes the group hold exactly the testers named: the account's App Store Connect users go to its internal TestFlight group (a build reaches them at once), everyone else to its external one (after Beta App Review). Apple mails each new tester. Emits `stores.group.changed` (testers).
+     */
+    setTesters(input: {
+        path: {
+            group_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: TestersRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, TesterPage>>;
+    /**
+     * List packages
+     *
+     * The project's packages, newest first.
+     */
+    listPackages(input?: {
+        query?: {
+            app_id?: string; /** How many to answer (1-200, default 50). */
+            limit?: number; /** The next_cursor of the previous page. */
+            cursor?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, PackagePage>>;
+    /**
+     * Read a package
+     *
+     * A package and its deliveries.
+     */
+    getPackage(input: {
+        path: {
+            package_id: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Package>>;
+    /**
+     * Hand over a package's build
+     *
+     * A build machine hands over the unsigned .ipa with the package's upload token (Palbase-Upload-Token header) and its Content-Length. It must be the app's — its bundle id, and the build number the package was given — or it is refused and the package keeps waiting for the right file. One upload of a package at a time, two of a project's at once (409 `upload_in_progress`); an upload ends within an hour and waits a minute at most for its next bytes. Sent again after it arrived, the same token answers 409 `package_uploaded`. Emits `stores.package.changed` (uploaded).
+     */
+    uploadArtifact(input: {
+        path: {
+            package_id: string;
+        };
+        headers: {
+            "Palbase-Upload-Token": string;
+        };
+        body: BodyInit;
+        contentType?: string; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Package>>;
+    /**
+     * Plan a Beta App Review
+     *
+     * Plans sending the package's TestFlight build to Beta App Review, which external testers need first. Nothing is sent until the plan is confirmed (POST /stores/actions/{id}/confirm with its hash). Refused with what is missing when the app's test information is incomplete.
+     */
+    planBetaReview(input: {
+        path: {
+            package_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<201, Action>>;
+    /**
+     * List a package's deliveries
+     *
+     * Where the package is on its way to testers.
+     */
+    listDeliveries(input: {
+        path: {
+            package_id: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, DeliveryPage>>;
+    /**
+     * Send a package to TestFlight
+     *
+     * Signs the build with the Apple account's certificate (bundle by bundle), hands it to App Store Connect, follows Apple's processing and gives it to the groups named. Answers 202 at once; `stores.delivery.changed` says where it is. A project's builds are signed and handed over one at a time, and it has 10 deliveries under way at most (429 `too_many_deliveries`). Sending it again restarts one that failed, and changes nothing about one under way (200).
+     */
+    deliver(input: {
+        path: {
+            package_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: DeliverRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Delivery> | Reply<202, Delivery>>;
+    /**
+     * Plan expiring a build
+     *
+     * Plans expiring the package's TestFlight build: no tester can install it after. Runs only when confirmed.
+     */
+    planExpire(input: {
+        path: {
+            package_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<201, Action>>;
+    /**
+     * Plan the export compliance answer
+     *
+     * Plans the build's export compliance answer — the person's legal statement, which Apple needs before anyone tests it. Runs only when confirmed; the delivery waiting on it then goes on.
+     */
+    planExportCompliance(input: {
+        path: {
+            package_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: ComplianceRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<201, Action>>;
+    /**
+     * Change a build's note to testers
+     *
+     * Changes what testers read with the package's TestFlight build, once Apple holds the build (409 `build_not_at_apple` before): the build's note in App Store Connect, in the locale given or the app's primary one, and the delivery's own.
+     */
+    setWhatToTest(input: {
+        path: {
+            package_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: WhatToTest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Delivery>>;
+};
+export type Client = ReturnType<typeof client>;