@todoist/sdk 0.0.1 → 18.0.0

package/dist/types/types/apps/types.d.ts

@@ -0,0 +1,418 @@
+import { z } from 'zod';
+/**
+ * Available statuses for a developer application.
+ */
+export declare const APP_STATUSES: readonly ["public"];
+/**
+ * Status of a developer application.
+ */
+export type AppStatus = (typeof APP_STATUSES)[number];
+export declare const AppStatusSchema: z.ZodEnum<{
+    public: "public";
+}>;
+/**
+ * Webhook event types that can be subscribed to.
+ *
+ * These are the friendly public names the backend uses in webhook payloads.
+ * The on-the-wire config endpoint uses a different (legacy) form (see
+ * {@link WEBHOOK_EVENT_WIRE_NAMES}); the SDK converts between the two
+ * so consumers only ever work with these pretty names.
+ *
+ * @see https://developer.todoist.com/sync/v1/#webhooks
+ */
+export declare const WEBHOOK_EVENTS: readonly ["item:added", "item:updated", "item:completed", "item:uncompleted", "item:deleted", "note:added", "note:updated", "note:deleted", "project:added", "project:updated", "project:deleted", "project:archived", "project:unarchived", "section:added", "section:updated", "section:deleted", "section:archived", "section:unarchived", "label:added", "label:updated", "label:deleted", "filter:added", "filter:updated", "filter:deleted", "reminder:fired"];
+/**
+ * A webhook event that can be subscribed to.
+ */
+export type WebhookEvent = (typeof WEBHOOK_EVENTS)[number];
+export declare const WebhookEventSchema: z.ZodEnum<{
+    "project:added": "project:added";
+    "project:updated": "project:updated";
+    "project:deleted": "project:deleted";
+    "project:archived": "project:archived";
+    "project:unarchived": "project:unarchived";
+    "item:added": "item:added";
+    "item:updated": "item:updated";
+    "item:completed": "item:completed";
+    "item:uncompleted": "item:uncompleted";
+    "item:deleted": "item:deleted";
+    "note:added": "note:added";
+    "note:updated": "note:updated";
+    "note:deleted": "note:deleted";
+    "section:added": "section:added";
+    "section:updated": "section:updated";
+    "section:deleted": "section:deleted";
+    "section:archived": "section:archived";
+    "section:unarchived": "section:unarchived";
+    "label:added": "label:added";
+    "label:updated": "label:updated";
+    "label:deleted": "label:deleted";
+    "filter:added": "filter:added";
+    "filter:updated": "filter:updated";
+    "filter:deleted": "filter:deleted";
+    "reminder:fired": "reminder:fired";
+}>;
+/**
+ * Raw wire-format webhook event names used by the config endpoint
+ * (`POST/GET /apps/<id>/webhook`). Exported for completeness — prefer
+ * {@link WEBHOOK_EVENTS} when working with the SDK.
+ */
+export declare const WEBHOOK_EVENT_WIRE_NAMES: readonly ["e_item_added", "e_item_updated", "e_item_completed", "e_item_uncompleted", "e_item_deleted", "e_note_added", "e_note_updated", "e_note_deleted", "e_project_added", "e_project_updated", "e_project_deleted", "e_project_archived", "e_project_unarchived", "e_section_added", "e_section_updated", "e_section_deleted", "e_section_archived", "e_section_unarchived", "e_label_added", "e_label_updated", "e_label_deleted", "e_filter_added", "e_filter_updated", "e_filter_deleted", "e_reminder_fired"];
+/**
+ * Wire-format webhook event name (the `e_*` form).
+ */
+export type WebhookEventWireName = (typeof WEBHOOK_EVENT_WIRE_NAMES)[number];
+export declare const WebhookEventWireNameSchema: z.ZodEnum<{
+    e_item_added: "e_item_added";
+    e_item_updated: "e_item_updated";
+    e_item_completed: "e_item_completed";
+    e_item_uncompleted: "e_item_uncompleted";
+    e_item_deleted: "e_item_deleted";
+    e_note_added: "e_note_added";
+    e_note_updated: "e_note_updated";
+    e_note_deleted: "e_note_deleted";
+    e_project_added: "e_project_added";
+    e_project_updated: "e_project_updated";
+    e_project_deleted: "e_project_deleted";
+    e_project_archived: "e_project_archived";
+    e_project_unarchived: "e_project_unarchived";
+    e_section_added: "e_section_added";
+    e_section_updated: "e_section_updated";
+    e_section_deleted: "e_section_deleted";
+    e_section_archived: "e_section_archived";
+    e_section_unarchived: "e_section_unarchived";
+    e_label_added: "e_label_added";
+    e_label_updated: "e_label_updated";
+    e_label_deleted: "e_label_deleted";
+    e_filter_added: "e_filter_added";
+    e_filter_updated: "e_filter_updated";
+    e_filter_deleted: "e_filter_deleted";
+    e_reminder_fired: "e_reminder_fired";
+}>;
+/**
+ * Translates a wire-format event name (`'e_item_added'`) to its pretty form (`'item:added'`).
+ */
+export declare function webhookEventFromWireName(wireName: WebhookEventWireName): WebhookEvent;
+/**
+ * Translates a pretty event name (`'item:added'`) to its wire-format form (`'e_item_added'`).
+ */
+export declare function webhookEventToWireName(event: WebhookEvent): WebhookEventWireName;
+/**
+ * Available statuses for an app webhook.
+ */
+export declare const WEBHOOK_STATUSES: readonly ["active", "invalid"];
+/**
+ * Delivery status of an app webhook.
+ */
+export type WebhookStatus = (typeof WEBHOOK_STATUSES)[number];
+export declare const WebhookStatusSchema: z.ZodEnum<{
+    active: "active";
+    invalid: "invalid";
+}>;
+/**
+ * Supported webhook payload versions. v9 is deprecated and intentionally excluded.
+ */
+export declare const WEBHOOK_VERSIONS: readonly ["1"];
+/**
+ * Webhook payload version.
+ */
+export type WebhookVersion = (typeof WEBHOOK_VERSIONS)[number];
+export declare const WebhookVersionSchema: z.ZodEnum<{
+    1: "1";
+}>;
+/**
+ * Available installation types for an app installation.
+ */
+export declare const INSTALLATION_TYPES: readonly ["user"];
+/**
+ * Scope of an app installation.
+ */
+export type InstallationType = (typeof INSTALLATION_TYPES)[number];
+export declare const InstallationTypeSchema: z.ZodEnum<{
+    user: "user";
+}>;
+/**
+ * Transforms a comma-separated scope string into `string[] | null`.
+ *
+ * The backend stores `app_token_scopes` as a single comma-separated string
+ * (e.g. `"data:read,task:add"`). Reads are exposed as `string[]` (rather than
+ * `Permission[]`) so that newly added backend scopes don't break parsing —
+ * writes accept `Permission` for autocomplete while still permitting `string`
+ * (via `UpdateAppArgs`), so a fetched `App.appTokenScopes` can be round-tripped
+ * back into `updateApp()` without casts.
+ *
+ * Preserves `null` on read (backend returns `null` for apps that have had
+ * their scopes cleared via `updateApp({ appTokenScopes: null })`) so the
+ * read and write shapes line up and information is not lost.
+ */
+export declare const AppTokenScopesSchema: z.ZodPipe<z.ZodNullable<z.ZodString>, z.ZodTransform<string[] | null, string | null>>;
+/**
+ * Schema for a developer application.
+ * @see https://developer.todoist.com/api/v1/#tag/Apps
+ */
+export declare const AppSchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    clientId: z.ZodString;
+    status: z.ZodEnum<{
+        public: "public";
+    }>;
+    displayName: z.ZodString;
+    userId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    createdAt: z.ZodCoercedDate<unknown>;
+    serviceUrl: z.ZodNullable<z.ZodString>;
+    oauthRedirectUri: z.ZodNullable<z.ZodString>;
+    description: z.ZodNullable<z.ZodString>;
+    iconSm: z.ZodNullable<z.ZodString>;
+    iconMd: z.ZodNullable<z.ZodString>;
+    iconLg: z.ZodNullable<z.ZodString>;
+    appTokenScopes: z.ZodPipe<z.ZodNullable<z.ZodString>, z.ZodTransform<string[] | null, string | null>>;
+}, z.core.$strip>;
+/**
+ * A developer application.
+ */
+export type App = z.infer<typeof AppSchema>;
+/**
+ * Schema for a developer application that includes the user count.
+ * Returned by most endpoints that manage a single app (get, update, delete).
+ */
+export declare const AppWithUserCountSchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    clientId: z.ZodString;
+    status: z.ZodEnum<{
+        public: "public";
+    }>;
+    displayName: z.ZodString;
+    userId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    createdAt: z.ZodCoercedDate<unknown>;
+    serviceUrl: z.ZodNullable<z.ZodString>;
+    oauthRedirectUri: z.ZodNullable<z.ZodString>;
+    description: z.ZodNullable<z.ZodString>;
+    iconSm: z.ZodNullable<z.ZodString>;
+    iconMd: z.ZodNullable<z.ZodString>;
+    iconLg: z.ZodNullable<z.ZodString>;
+    appTokenScopes: z.ZodPipe<z.ZodNullable<z.ZodString>, z.ZodTransform<string[] | null, string | null>>;
+    userCount: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * A developer application with authorized user count.
+ */
+export type AppWithUserCount = z.infer<typeof AppWithUserCountSchema>;
+/**
+ * OAuth client credentials for a developer application.
+ */
+export declare const AppSecretsSchema: z.ZodObject<{
+    clientId: z.ZodString;
+    clientSecret: z.ZodString;
+}, z.core.$strip>;
+/**
+ * OAuth client credentials for a developer application.
+ */
+export type AppSecrets = z.infer<typeof AppSecretsSchema>;
+/**
+ * Webhook verification token for a developer application.
+ */
+export declare const AppVerificationTokenSchema: z.ZodObject<{
+    verificationToken: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Webhook verification token for a developer application.
+ */
+export type AppVerificationToken = z.infer<typeof AppVerificationTokenSchema>;
+/**
+ * Developer test access token for a developer application.
+ */
+export declare const AppTestTokenSchema: z.ZodObject<{
+    accessToken: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Developer test access token for a developer application.
+ */
+export type AppTestToken = z.infer<typeof AppTestTokenSchema>;
+/**
+ * Distribution token for a developer application.
+ */
+export declare const AppDistributionTokenSchema: z.ZodObject<{
+    distributionToken: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Distribution token for a developer application.
+ */
+export type AppDistributionToken = z.infer<typeof AppDistributionTokenSchema>;
+/**
+ * Subset of an app returned when resolving by distribution token — used by the installation flow.
+ * Includes a lightweight list of the app's UI extensions (not full `UIExtension` records).
+ */
+export declare const AppByDistributionTokenUiExtensionSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodString;
+    icon: z.ZodNullable<z.ZodString>;
+    extensionType: z.ZodEnum<{
+        "context-menu": "context-menu";
+        composer: "composer";
+        settings: "settings";
+    }>;
+}, z.core.$strip>;
+/**
+ * UI extension metadata returned by the `by_distribution_token` endpoint.
+ */
+export type AppByDistributionTokenUiExtension = z.infer<typeof AppByDistributionTokenUiExtensionSchema>;
+export declare const AppByDistributionTokenSchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    displayName: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    iconMd: z.ZodNullable<z.ZodString>;
+    appTokenScopes: z.ZodPipe<z.ZodNullable<z.ZodString>, z.ZodTransform<string[] | null, string | null>>;
+    uiExtensions: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodString;
+        icon: z.ZodNullable<z.ZodString>;
+        extensionType: z.ZodEnum<{
+            "context-menu": "context-menu";
+            composer: "composer";
+            settings: "settings";
+        }>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Public-facing app info resolved via distribution token — used during installation.
+ */
+export type AppByDistributionToken = z.infer<typeof AppByDistributionTokenSchema>;
+/**
+ * Schema for an app webhook.
+ *
+ * Events arrive from the wire in their `e_*` form and are transformed to
+ * their pretty `item:added`-style names for SDK consumers.
+ */
+export declare const AppWebhookSchema: z.ZodObject<{
+    status: z.ZodEnum<{
+        active: "active";
+        invalid: "invalid";
+    }>;
+    callbackUrl: z.ZodString;
+    version: z.ZodEnum<{
+        1: "1";
+    }>;
+    events: z.ZodArray<z.ZodPipe<z.ZodEnum<{
+        e_item_added: "e_item_added";
+        e_item_updated: "e_item_updated";
+        e_item_completed: "e_item_completed";
+        e_item_uncompleted: "e_item_uncompleted";
+        e_item_deleted: "e_item_deleted";
+        e_note_added: "e_note_added";
+        e_note_updated: "e_note_updated";
+        e_note_deleted: "e_note_deleted";
+        e_project_added: "e_project_added";
+        e_project_updated: "e_project_updated";
+        e_project_deleted: "e_project_deleted";
+        e_project_archived: "e_project_archived";
+        e_project_unarchived: "e_project_unarchived";
+        e_section_added: "e_section_added";
+        e_section_updated: "e_section_updated";
+        e_section_deleted: "e_section_deleted";
+        e_section_archived: "e_section_archived";
+        e_section_unarchived: "e_section_unarchived";
+        e_label_added: "e_label_added";
+        e_label_updated: "e_label_updated";
+        e_label_deleted: "e_label_deleted";
+        e_filter_added: "e_filter_added";
+        e_filter_updated: "e_filter_updated";
+        e_filter_deleted: "e_filter_deleted";
+        e_reminder_fired: "e_reminder_fired";
+    }>, z.ZodTransform<"project:added" | "project:updated" | "project:deleted" | "project:archived" | "project:unarchived" | "item:added" | "item:updated" | "item:completed" | "item:uncompleted" | "item:deleted" | "note:added" | "note:updated" | "note:deleted" | "section:added" | "section:updated" | "section:deleted" | "section:archived" | "section:unarchived" | "label:added" | "label:updated" | "label:deleted" | "filter:added" | "filter:updated" | "filter:deleted" | "reminder:fired", "e_item_added" | "e_item_updated" | "e_item_completed" | "e_item_uncompleted" | "e_item_deleted" | "e_note_added" | "e_note_updated" | "e_note_deleted" | "e_project_added" | "e_project_updated" | "e_project_deleted" | "e_project_archived" | "e_project_unarchived" | "e_section_added" | "e_section_updated" | "e_section_deleted" | "e_section_archived" | "e_section_unarchived" | "e_label_added" | "e_label_updated" | "e_label_deleted" | "e_filter_added" | "e_filter_updated" | "e_filter_deleted" | "e_reminder_fired">>>;
+}, z.core.$strip>;
+/**
+ * Webhook configuration for a developer application.
+ */
+export type AppWebhook = z.infer<typeof AppWebhookSchema>;
+/**
+ * Lightweight view of an app embedded in an installation record.
+ * Mirrors `AppSchema` shape — backend returns the same `ApplicationRestView`.
+ */
+export declare const InstalledIntegrationSchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    clientId: z.ZodString;
+    status: z.ZodEnum<{
+        public: "public";
+    }>;
+    displayName: z.ZodString;
+    userId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    createdAt: z.ZodCoercedDate<unknown>;
+    serviceUrl: z.ZodNullable<z.ZodString>;
+    oauthRedirectUri: z.ZodNullable<z.ZodString>;
+    description: z.ZodNullable<z.ZodString>;
+    iconSm: z.ZodNullable<z.ZodString>;
+    iconMd: z.ZodNullable<z.ZodString>;
+    iconLg: z.ZodNullable<z.ZodString>;
+    appTokenScopes: z.ZodPipe<z.ZodNullable<z.ZodString>, z.ZodTransform<string[] | null, string | null>>;
+}, z.core.$strip>;
+/**
+ * Embedded app info on an installation record.
+ */
+export type InstalledIntegration = z.infer<typeof InstalledIntegrationSchema>;
+/**
+ * Schema for an installed application (integration installed to a user's account).
+ */
+export declare const AppInstallationSchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    creator: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    createdTs: z.ZodNumber;
+    installationType: z.ZodEnum<{
+        user: "user";
+    }>;
+    appTokenScopesValidated: z.ZodBoolean;
+    integration: z.ZodNullable<z.ZodObject<{
+        id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+        clientId: z.ZodString;
+        status: z.ZodEnum<{
+            public: "public";
+        }>;
+        displayName: z.ZodString;
+        userId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+        createdAt: z.ZodCoercedDate<unknown>;
+        serviceUrl: z.ZodNullable<z.ZodString>;
+        oauthRedirectUri: z.ZodNullable<z.ZodString>;
+        description: z.ZodNullable<z.ZodString>;
+        iconSm: z.ZodNullable<z.ZodString>;
+        iconMd: z.ZodNullable<z.ZodString>;
+        iconLg: z.ZodNullable<z.ZodString>;
+        appTokenScopes: z.ZodPipe<z.ZodNullable<z.ZodString>, z.ZodTransform<string[] | null, string | null>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Installation of a developer application on a user's account.
+ */
+export type AppInstallation = z.infer<typeof AppInstallationSchema>;
+/**
+ * Lightweight app info included on a user authorization record.
+ */
+export declare const UserAuthorizationAppSchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    displayName: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    serviceUrl: z.ZodNullable<z.ZodString>;
+    iconMd: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * App info attached to a user authorization entry.
+ */
+export type UserAuthorizationApp = z.infer<typeof UserAuthorizationAppSchema>;
+/**
+ * Schema for a user authorization entry — a token the user has granted to a third-party app.
+ */
+export declare const UserAuthorizationSchema: z.ZodObject<{
+    accessTokenId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    scope: z.ZodArray<z.ZodString>;
+    scopeDescriptions: z.ZodArray<z.ZodString>;
+    createdAt: z.ZodCoercedDate<unknown>;
+    app: z.ZodNullable<z.ZodObject<{
+        id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+        displayName: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        serviceUrl: z.ZodNullable<z.ZodString>;
+        iconMd: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * A user authorization entry (access token granted to a third-party app).
+ */
+export type UserAuthorization = z.infer<typeof UserAuthorizationSchema>;

package/dist/types/types/backups/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './requests.js';

package/dist/types/types/backups/requests.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Arguments for listing backups.
+ * @see https://developer.todoist.com/api/v1/#tag/Backups/operation/get_backups_api_v1_backups_get
+ */
+export type GetBackupsArgs = {
+    /** MFA token if required. Not needed when using an OAuth token with the `backups:read` scope. */
+    mfaToken?: string | null;
+};
+/**
+ * Arguments for downloading a backup.
+ * @see https://developer.todoist.com/api/v1/#tag/Backups/operation/download_backup_api_v1_backups_download_get
+ */
+export type DownloadBackupArgs = {
+    /** The backup file URL. */
+    file: string;
+};

package/dist/types/types/backups/types.d.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+export declare const BackupSchema: z.ZodObject<{
+    version: z.ZodString;
+    url: z.ZodString;
+}, z.core.$strip>;
+/** Represents a backup snapshot. */
+export type Backup = z.infer<typeof BackupSchema>;

package/dist/types/types/billing/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './requests.js';

package/dist/types/types/billing/requests.d.ts

@@ -0,0 +1,62 @@
+import type { BillingCycle } from './types.js';
+/** Arguments for cancelling the current plan. */
+export type CancelPlanArgs = {
+    /** Short identifier of the cancellation reason category. */
+    reasonFlag?: string;
+    /** Human-readable label of the cancellation reason. */
+    reasonDescription?: string;
+    /** Free-form feedback from the user about the cancellation. */
+    reasonText?: string;
+    /** URL the user is redirected to after completing the flow. */
+    returnUrl?: string;
+};
+/** Common arguments for any Stripe checkout (upgrade or trial) request. */
+export type CheckoutArgs = {
+    currency: string;
+    billingCycle: BillingCycle;
+    successUrl: string;
+    cancelUrl: string;
+};
+/** Optional promotion/partnership attribution shared by upgrade requests. */
+export type UpgradeOptions = {
+    promotionCode?: string | null;
+    partnershipId?: string | null;
+};
+/** Arguments for upgrading to a Pro plan. */
+export type UpgradeToProArgs = CheckoutArgs & UpgradeOptions & {
+    trialPeriodDays?: number | null;
+};
+/** Arguments for starting a Pro trial. */
+export type StartProTrialArgs = CheckoutArgs;
+/** Arguments for opening the Pro billing portal. */
+export type ProBillingPortalArgs = {
+    returnUrl: string;
+    flowType?: string | null;
+    promotionCode?: string | null;
+};
+/** Arguments for upgrading a workspace. */
+export type UpgradeWorkspaceArgs = CheckoutArgs & UpgradeOptions & {
+    workspaceId: string;
+};
+/** Arguments for starting a workspace trial. */
+export type StartWorkspaceTrialArgs = CheckoutArgs & {
+    workspaceId: string;
+};
+/** Arguments for opening the workspace billing portal. */
+export type WorkspaceBillingPortalArgs = {
+    workspaceId: string;
+    returnUrl: string;
+    flowType?: string | null;
+};
+/** Arguments for fetching pricing. */
+export type GetPricingArgs = {
+    formatted?: boolean;
+};
+/** Response containing a Stripe checkout session URL. */
+export type CheckoutSessionResponse = {
+    checkoutSessionUrl: string;
+};
+/** Response containing a Stripe billing portal URL. */
+export type BillingPortalUrlResponse = {
+    billingPortalUrl: string;
+};