@dazl/internal-api-client 1.0.0

package/src/types.gen.ts

@@ -0,0 +1,510 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};
+
+export type BillingPrice = {
+    credits: number;
+    priceCents: number;
+    priceId: string;
+    productId: string;
+    lookup_key: string | null;
+    isDefaultFree: boolean;
+};
+
+export type StripeProduct = {
+    id: string;
+    name: string;
+    description: string | null;
+    active: boolean;
+    created: number;
+    updated: number;
+    images: Array<string>;
+    livemode: boolean;
+    default_price?: string | null;
+    marketing_features: Array<{
+        name?: string;
+    }>;
+    metadata: {
+        [key: string]: string;
+    };
+    object: 'product';
+    package_dimensions: null;
+    shippable: null;
+    tax_code: null;
+    type: 'service';
+    url: string | null;
+};
+
+export type ScheduledUpdate = {
+    type: 'downgrade';
+    scheduleId: string;
+    targetPriceId: string;
+    updateTime: number;
+} | {
+    type: 'cancel';
+    updateTime: number;
+};
+
+export type GetBalanceByDazlIdData = {
+    body?: never;
+    path: {
+        dazlId: string;
+    };
+    query?: never;
+    url: '/billing/balance/{dazlId}';
+};
+
+export type GetBalanceByDazlIdErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: {
+        message: string;
+    };
+    /**
+     * Internal server error
+     */
+    500: {
+        message: string;
+    };
+};
+
+export type GetBalanceByDazlIdError = GetBalanceByDazlIdErrors[keyof GetBalanceByDazlIdErrors];
+
+export type GetBalanceByDazlIdResponses = {
+    /**
+     * Returns user credit balance
+     */
+    200: {
+        balance: number;
+        productId?: string;
+        priceId?: string;
+        isSubscriptionFree?: boolean;
+    };
+};
+
+export type GetBalanceByDazlIdResponse = GetBalanceByDazlIdResponses[keyof GetBalanceByDazlIdResponses];
+
+export type GetHasSufficientCreditsByDazlIdData = {
+    body?: never;
+    path: {
+        dazlId: string;
+    };
+    query?: never;
+    url: '/billing/has-sufficient-credits/{dazlId}';
+};
+
+export type GetHasSufficientCreditsByDazlIdErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: {
+        message: string;
+    };
+    /**
+     * Internal server error
+     */
+    500: {
+        message: string;
+    };
+};
+
+export type GetHasSufficientCreditsByDazlIdError = GetHasSufficientCreditsByDazlIdErrors[keyof GetHasSufficientCreditsByDazlIdErrors];
+
+export type GetHasSufficientCreditsByDazlIdResponses = {
+    /**
+     * Returns whether user has sufficient credits
+     */
+    200: {
+        hasSufficientCredits: boolean;
+    };
+};
+
+export type GetHasSufficientCreditsByDazlIdResponse = GetHasSufficientCreditsByDazlIdResponses[keyof GetHasSufficientCreditsByDazlIdResponses];
+
+export type GetAllProductsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/billing/prices';
+};
+
+export type GetAllProductsErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: {
+        message: string;
+    };
+    /**
+     * Internal server error
+     */
+    500: {
+        message: string;
+    };
+};
+
+export type GetAllProductsError = GetAllProductsErrors[keyof GetAllProductsErrors];
+
+export type GetAllProductsResponses = {
+    /**
+     * Returns all available products and prices
+     */
+    200: {
+        [key: string]: {
+            prices: Array<BillingPrice>;
+            product: StripeProduct;
+            isDefaultFree?: boolean;
+        };
+    };
+};
+
+export type GetAllProductsResponse = GetAllProductsResponses[keyof GetAllProductsResponses];
+
+export type GetPriceByPriceIdData = {
+    body?: never;
+    path: {
+        priceId: string;
+    };
+    query?: never;
+    url: '/billing/price/{priceId}';
+};
+
+export type GetPriceByPriceIdErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: {
+        message: string;
+    };
+    /**
+     * Internal server error
+     */
+    500: {
+        message: string;
+    };
+};
+
+export type GetPriceByPriceIdError = GetPriceByPriceIdErrors[keyof GetPriceByPriceIdErrors];
+
+export type GetPriceByPriceIdResponses = {
+    /**
+     * Returns price details
+     */
+    200: {
+        credits: number;
+        priceCents: number;
+        priceId: string;
+        productId: string;
+        lookup_key: string | null;
+        isDefaultFree: boolean;
+    };
+};
+
+export type GetPriceByPriceIdResponse = GetPriceByPriceIdResponses[keyof GetPriceByPriceIdResponses];
+
+export type GetMaxCreditsForDefaultFreeData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/billing/max-credits-for-default-free';
+};
+
+export type GetMaxCreditsForDefaultFreeResponses = {
+    /**
+     * Returns maximum credits for free tier
+     */
+    200: {
+        maxCreditsForDefaultFree: number;
+    };
+};
+
+export type GetMaxCreditsForDefaultFreeResponse = GetMaxCreditsForDefaultFreeResponses[keyof GetMaxCreditsForDefaultFreeResponses];
+
+export type GetCustomerInfoByDazlIdData = {
+    body?: never;
+    path: {
+        dazlId: string;
+    };
+    query?: never;
+    url: '/billing/customer-info/{dazlId}';
+};
+
+export type GetCustomerInfoByDazlIdErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: {
+        message: string;
+    };
+    /**
+     * Internal server error
+     */
+    500: {
+        message: string;
+    };
+};
+
+export type GetCustomerInfoByDazlIdError = GetCustomerInfoByDazlIdErrors[keyof GetCustomerInfoByDazlIdErrors];
+
+export type GetCustomerInfoByDazlIdResponses = {
+    /**
+     * Returns customer subscription information
+     */
+    200: {
+        productId: string;
+        credits: number;
+        isDefaultFree: boolean;
+        priceId: string;
+        subscriptionItemId: string;
+        subscriptionId: string;
+        currentCycle: {
+            start: number;
+            end: number;
+        };
+        scheduledUpdate?: ScheduledUpdate;
+        defaultFreePriceId?: string;
+        customerId: string;
+        hasEarlyAccessCoupon: boolean;
+    };
+};
+
+export type GetCustomerInfoByDazlIdResponse = GetCustomerInfoByDazlIdResponses[keyof GetCustomerInfoByDazlIdResponses];
+
+export type UpdateUserSubscriptionData = {
+    body: {
+        dazlId: string;
+        targetPriceId: string;
+        successUrl: string;
+        cancelUrl: string;
+    };
+    path?: never;
+    query?: never;
+    url: '/billing/update-subscription';
+};
+
+export type UpdateUserSubscriptionErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: {
+        message: string;
+    };
+    /**
+     * Internal server error
+     */
+    500: {
+        message: string;
+    };
+};
+
+export type UpdateUserSubscriptionError = UpdateUserSubscriptionErrors[keyof UpdateUserSubscriptionErrors];
+
+export type UpdateUserSubscriptionResponses = {
+    /**
+     * Returns updated subscription details
+     */
+    200: {
+        type: 'checkout';
+        session: string;
+    } | {
+        type: 'update';
+        newPrice: {
+            credits: number;
+            priceCents: number;
+            priceId: string;
+            productId: string;
+            lookup_key: string | null;
+            isDefaultFree: boolean;
+        };
+    } | {
+        type: 'cancel';
+    };
+};
+
+export type UpdateUserSubscriptionResponse = UpdateUserSubscriptionResponses[keyof UpdateUserSubscriptionResponses];
+
+export type CancelScheduledUpdateByDazlIdData = {
+    body?: never;
+    path: {
+        dazlId: string;
+    };
+    query?: never;
+    url: '/billing/cancel-scheduled-update/{dazlId}';
+};
+
+export type CancelScheduledUpdateByDazlIdErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: {
+        message: string;
+    };
+    /**
+     * Internal server error
+     */
+    500: {
+        message: string;
+    };
+};
+
+export type CancelScheduledUpdateByDazlIdError = CancelScheduledUpdateByDazlIdErrors[keyof CancelScheduledUpdateByDazlIdErrors];
+
+export type CancelScheduledUpdateByDazlIdResponses = {
+    /**
+     * Returns cancellation status
+     */
+    200: {
+        success: boolean;
+    };
+};
+
+export type CancelScheduledUpdateByDazlIdResponse = CancelScheduledUpdateByDazlIdResponses[keyof CancelScheduledUpdateByDazlIdResponses];
+
+export type CreateCustomerPortalSessionData = {
+    body: {
+        dazlId: string;
+        returnUrl?: string;
+    };
+    path?: never;
+    query?: never;
+    url: '/billing/create-portal-session';
+};
+
+export type CreateCustomerPortalSessionErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: {
+        message: string;
+    };
+    /**
+     * Internal server error
+     */
+    500: {
+        message: string;
+    };
+};
+
+export type CreateCustomerPortalSessionError = CreateCustomerPortalSessionErrors[keyof CreateCustomerPortalSessionErrors];
+
+export type CreateCustomerPortalSessionResponses = {
+    /**
+     * Returns billing portal session URL
+     */
+    200: {
+        url: string;
+    };
+};
+
+export type CreateCustomerPortalSessionResponse = CreateCustomerPortalSessionResponses[keyof CreateCustomerPortalSessionResponses];
+
+export type CreateCustomerWithDefaultSubscriptionData = {
+    body: {
+        email: string;
+        name?: string;
+        customerOptions?: {
+            idempotencyKey: string;
+        };
+        subscriptionOptions?: {
+            idempotencyKey: string;
+        };
+    };
+    path?: never;
+    query?: never;
+    url: '/billing/create-customer-with-default-subscription';
+};
+
+export type CreateCustomerWithDefaultSubscriptionErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: {
+        message: string;
+    };
+    /**
+     * Internal server error
+     */
+    500: {
+        message: string;
+    };
+};
+
+export type CreateCustomerWithDefaultSubscriptionError = CreateCustomerWithDefaultSubscriptionErrors[keyof CreateCustomerWithDefaultSubscriptionErrors];
+
+export type CreateCustomerWithDefaultSubscriptionResponses = {
+    /**
+     * Returns created customer ID
+     */
+    200: {
+        customerId: string;
+        noStripe: boolean;
+    };
+};
+
+export type CreateCustomerWithDefaultSubscriptionResponse = CreateCustomerWithDefaultSubscriptionResponses[keyof CreateCustomerWithDefaultSubscriptionResponses];