@doist/todoist-sdk 10.2.0 → 10.3.0

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;
+};

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

@@ -0,0 +1,207 @@
+import { z } from 'zod';
+/** Available subscription statuses. */
+export declare const BILLING_SUBSCRIPTION_STATUSES: readonly ["none", "autorenew", "canceled", "expired", "trial", "trial_canceled"];
+/** Current subscription status. */
+export type BillingSubscriptionStatus = (typeof BILLING_SUBSCRIPTION_STATUSES)[number];
+/** Available plan tiers. */
+export declare const BILLING_PLANS: readonly ["free", "pro", "pro_gifted", "pro_legacy"];
+/** Plan tier a user is currently on. */
+export type BillingPlan = (typeof BILLING_PLANS)[number];
+/** Ways an active subscription can be purchased. */
+export declare const BILLING_ACTIVATION_METHODS: readonly ["stripe", "appstore", "playstore", "teams", "manual"];
+/** How an active subscription was purchased. */
+export type BillingActivationMethod = (typeof BILLING_ACTIVATION_METHODS)[number];
+/** Available billing cycles. */
+export declare const BILLING_CYCLES: readonly ["monthly", "yearly"];
+/** Billing cycle for a plan price. */
+export type BillingCycle = (typeof BILLING_CYCLES)[number];
+/** Available tax behaviors for a price. */
+export declare const TAX_BEHAVIORS: readonly ["exclusive", "inclusive", "unspecified"];
+/** Tax behavior for a plan price. */
+export type TaxBehavior = (typeof TAX_BEHAVIORS)[number];
+export declare const BillingPlanPriceSchema: z.ZodObject<{
+    amount: z.ZodString;
+    rawAmount: z.ZodNumber;
+    currency: z.ZodString;
+    billingCycle: z.ZodNullable<z.ZodEnum<{
+        monthly: "monthly";
+        yearly: "yearly";
+    }>>;
+    taxBehavior: z.ZodEnum<{
+        inclusive: "inclusive";
+        exclusive: "exclusive";
+        unspecified: "unspecified";
+    }>;
+}, z.core.$strip>;
+/** Price of an active plan. */
+export type BillingPlanPrice = z.infer<typeof BillingPlanPriceSchema>;
+export declare const SubscriptionInfoSchema: z.ZodObject<{
+    status: z.ZodEnum<{
+        none: "none";
+        autorenew: "autorenew";
+        canceled: "canceled";
+        expired: "expired";
+        trial: "trial";
+        trial_canceled: "trial_canceled";
+    }>;
+    plan: z.ZodEnum<{
+        free: "free";
+        pro: "pro";
+        pro_gifted: "pro_gifted";
+        pro_legacy: "pro_legacy";
+    }>;
+    expirationDate: z.ZodNullable<z.ZodString>;
+    activationMethod: z.ZodEnum<{
+        manual: "manual";
+        stripe: "stripe";
+        appstore: "appstore";
+        playstore: "playstore";
+        teams: "teams";
+    }>;
+    planPrice: z.ZodNullable<z.ZodObject<{
+        amount: z.ZodString;
+        rawAmount: z.ZodNumber;
+        currency: z.ZodString;
+        billingCycle: z.ZodNullable<z.ZodEnum<{
+            monthly: "monthly";
+            yearly: "yearly";
+        }>>;
+        taxBehavior: z.ZodEnum<{
+            inclusive: "inclusive";
+            exclusive: "exclusive";
+            unspecified: "unspecified";
+        }>;
+    }, z.core.$strip>>;
+    billingPortalUrl: z.ZodNullable<z.ZodString>;
+    billingPortalSwitchToAnnualUrl: z.ZodNullable<z.ZodString>;
+    hasBillingPortal: z.ZodBoolean;
+    hasBillingPortalSwitchToAnnual: z.ZodBoolean;
+    invoiceCreditBalance: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+    hasSwitchLegacyToCurrent: z.ZodBoolean;
+}, z.core.$strip>;
+/** Current subscription state of a user. */
+export type SubscriptionInfo = z.infer<typeof SubscriptionInfoSchema>;
+export declare const FormattedPriceSchema: z.ZodObject<{
+    currency: z.ZodString;
+    unitAmount: z.ZodNumber;
+    taxBehavior: z.ZodEnum<{
+        inclusive: "inclusive";
+        exclusive: "exclusive";
+        unspecified: "unspecified";
+    }>;
+}, z.core.$strip>;
+/** A single price within a billing-cycle listing. */
+export type FormattedPrice = z.infer<typeof FormattedPriceSchema>;
+export declare const PriceListingSchema: z.ZodObject<{
+    billingCycle: z.ZodEnum<{
+        monthly: "monthly";
+        yearly: "yearly";
+    }>;
+    prices: z.ZodArray<z.ZodObject<{
+        currency: z.ZodString;
+        unitAmount: z.ZodNumber;
+        taxBehavior: z.ZodEnum<{
+            inclusive: "inclusive";
+            exclusive: "exclusive";
+            unspecified: "unspecified";
+        }>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** Prices available for a given billing cycle. */
+export type PriceListing = z.infer<typeof PriceListingSchema>;
+export declare const ProPlanDetailsSchema: z.ZodObject<{
+    currentPlanStatus: z.ZodEnum<{
+        Active: "Active";
+        Downgraded: "Downgraded";
+        Cancelled: "Cancelled";
+        NeverSubscribed: "NeverSubscribed";
+    }>;
+    downgradeAt: z.ZodNullable<z.ZodString>;
+    priceList: z.ZodArray<z.ZodObject<{
+        billingCycle: z.ZodEnum<{
+            monthly: "monthly";
+            yearly: "yearly";
+        }>;
+        prices: z.ZodArray<z.ZodObject<{
+            currency: z.ZodString;
+            unitAmount: z.ZodNumber;
+            taxBehavior: z.ZodEnum<{
+                inclusive: "inclusive";
+                exclusive: "exclusive";
+                unspecified: "unspecified";
+            }>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** Pro plan and billing details. */
+export type ProPlanDetails = z.infer<typeof ProPlanDetailsSchema>;
+export declare const PricesResponseSchema: z.ZodObject<{
+    pro: z.ZodArray<z.ZodObject<{
+        billingCycle: z.ZodEnum<{
+            monthly: "monthly";
+            yearly: "yearly";
+        }>;
+        prices: z.ZodArray<z.ZodObject<{
+            currency: z.ZodString;
+            unitAmount: z.ZodNumber;
+            taxBehavior: z.ZodEnum<{
+                inclusive: "inclusive";
+                exclusive: "exclusive";
+                unspecified: "unspecified";
+            }>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    teams: z.ZodArray<z.ZodObject<{
+        billingCycle: z.ZodEnum<{
+            monthly: "monthly";
+            yearly: "yearly";
+        }>;
+        prices: z.ZodArray<z.ZodObject<{
+            currency: z.ZodString;
+            unitAmount: z.ZodNumber;
+            taxBehavior: z.ZodEnum<{
+                inclusive: "inclusive";
+                exclusive: "exclusive";
+                unspecified: "unspecified";
+            }>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** Available Pro and Teams prices. */
+export type PricesResponse = z.infer<typeof PricesResponseSchema>;
+/**
+ * Monthly and yearly amounts for a single currency. Each amount is a number in
+ * the currency's smallest unit, or a localized formatted string when the
+ * `pricing` endpoint is called with `formatted: true`.
+ */
+export declare const PricingTermsSchema: z.ZodObject<{
+    monthly: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+    yearly: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+}, z.core.$strip>;
+/** Monthly/yearly amounts for one currency. */
+export type PricingTerms = z.infer<typeof PricingTermsSchema>;
+/**
+ * A pricing version entry: plan name (`pro` / `biz`) → currency code →
+ * {@link PricingTerms}.
+ */
+export declare const PricingVersionSchema: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodObject<{
+    monthly: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+    yearly: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+}, z.core.$strip>>>;
+/** Prices for one pricing version, keyed by plan then currency. */
+export type PricingVersion = z.infer<typeof PricingVersionSchema>;
+/**
+ * Response of the `pricing` endpoint: fixed version-pointer string fields plus
+ * dynamic version keys (`v1`, `v2`, …), each a {@link PricingVersion}.
+ */
+export declare const PricingResponseSchema: z.ZodObject<{
+    latestPro: z.ZodString;
+    latestBiz: z.ZodString;
+    sessionPro: z.ZodString;
+    sessionBiz: z.ZodString;
+}, z.core.$catchall<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodObject<{
+    monthly: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+    yearly: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+}, z.core.$strip>>>>>;
+/** Current and legacy Pro/Teams pricing keyed by version. */
+export type PricingResponse = z.infer<typeof PricingResponseSchema>;

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

@@ -10,6 +10,7 @@ export * from './activity/index.js';
 export * from './workspaces/index.js';
 export * from './folders/index.js';
 export * from './goals/index.js';
+export * from './billing/index.js';
 export * from './insights/index.js';
 export * from './backups/index.js';
 export * from './id-mappings/index.js';

package/dist/types/utils/validators.d.ts

@@ -865,6 +865,65 @@ export declare const validateGoal: (input: unknown) => {
         percentage: number;
     } | undefined;
 }[];
+export declare const validateSubscriptionInfo: (input: unknown) => {
+    status: "none" | "autorenew" | "canceled" | "expired" | "trial" | "trial_canceled";
+    plan: "free" | "pro" | "pro_gifted" | "pro_legacy";
+    expirationDate: string | null;
+    activationMethod: "manual" | "stripe" | "appstore" | "playstore" | "teams";
+    planPrice: {
+        amount: string;
+        rawAmount: number;
+        currency: string;
+        billingCycle: "monthly" | "yearly" | null;
+        taxBehavior: "inclusive" | "exclusive" | "unspecified";
+    } | null;
+    billingPortalUrl: string | null;
+    billingPortalSwitchToAnnualUrl: string | null;
+    hasBillingPortal: boolean;
+    hasBillingPortalSwitchToAnnual: boolean;
+    invoiceCreditBalance: Record<string, number> | null;
+    hasSwitchLegacyToCurrent: boolean;
+};
+export declare const validateProPlanDetails: (input: unknown) => {
+    currentPlanStatus: "Active" | "Downgraded" | "Cancelled" | "NeverSubscribed";
+    downgradeAt: string | null;
+    priceList: {
+        billingCycle: "monthly" | "yearly";
+        prices: {
+            currency: string;
+            unitAmount: number;
+            taxBehavior: "inclusive" | "exclusive" | "unspecified";
+        }[];
+    }[];
+};
+export declare const validatePrices: (input: unknown) => {
+    pro: {
+        billingCycle: "monthly" | "yearly";
+        prices: {
+            currency: string;
+            unitAmount: number;
+            taxBehavior: "inclusive" | "exclusive" | "unspecified";
+        }[];
+    }[];
+    teams: {
+        billingCycle: "monthly" | "yearly";
+        prices: {
+            currency: string;
+            unitAmount: number;
+            taxBehavior: "inclusive" | "exclusive" | "unspecified";
+        }[];
+    }[];
+};
+export declare const validatePricing: (input: unknown) => {
+    [x: string]: Record<string, Record<string, {
+        monthly: string | number;
+        yearly: string | number;
+    }>>;
+    latestPro: string;
+    latestBiz: string;
+    sessionPro: string;
+    sessionBiz: string;
+};
 export declare const validateNote: (input: unknown) => {
     [x: string]: unknown;
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-sdk",
-    "version": "10.2.0",
+    "version": "10.3.0",
     "description": "The official TypeScript SDK for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-sdk-typescript",