import { BooleanResponse } from '..';
import { Coupon, CouponName, Nullable, PaymentMethodDescription, PublicUser, Subscription, SubscriptionCancelReason, SubscriptionId, SubscriptionIntent, SubscriptionPlan, SubscriptionPlanName, UserId } from '../../models';
import { AuthRequest, OptionalAuthRequest } from '../common';
/**
 * StripePaymentsWebhook
 */
export interface StripePaymentsWebhookRequest {
    type: string;
    data: any;
}
export interface StripePaymentsWebhookResponse {
    received: boolean;
}
export declare const StripePaymentsWebhook: import("..").ProtocolFunction<StripePaymentsWebhookRequest, StripePaymentsWebhookResponse>;
/**
 * SubscribeToPlan
 */
export interface SubscribeToPlanRequest extends AuthRequest {
    plan: SubscriptionPlanName;
    paymentMethod: string;
    coupon?: CouponName;
}
export declare type SubscribeToPlanResponse = Nullable<{
    subscriptionId: SubscriptionId;
    clientSecret: string;
    paymentStatus: string;
}>;
/**
 * Subscribes a user to a paid plan.
 * @param userToken The token of the user subscribing to the plan.
 * @param paymentMethod The unique string payment method from the payment provider.
 * @returns An object containing a client secret and a payment ID.
 */
export declare const SubscribeToPlan: import("..").ProtocolFunction<SubscribeToPlanRequest, Nullable<{
    subscriptionId: SubscriptionId;
    clientSecret: string;
    paymentStatus: string;
}>>;
/**
 * UpdatePaymentMethod
 */
export interface UpdatePaymentMethodRequest extends AuthRequest {
    paymentMethod: string;
}
export declare type UpdatePaymentMethodResponse = BooleanResponse;
export declare const UpdatePaymentMethod: import("..").ProtocolFunction<UpdatePaymentMethodRequest, BooleanResponse>;
/**
 * GetSubscriptionIntent
 */
export interface GetSubscriptionIntentRequest extends AuthRequest {
    plan: SubscriptionPlanName;
    currency?: string;
    couponName?: CouponName;
}
export declare type GetSubscriptionIntentResponse = Nullable<SubscriptionIntent>;
/**
 * Generates a client secret to send back to set up a checkout screen.
 * @param userToken The token of the user subscribing to the plan.
 * @param plan The name of the plan to check out for.
 * @param currency Three-letter ISO currency code, in lowercase. Must be a supported currency by Stripe. (https://www.iso.org/iso-4217-currency-codes.html)
 * @param couponName The user-facing name of the coupon being used.
 * @returns An object containing a client secret and a payment ID.
 */
export declare const GetSubscriptionIntent: import("..").ProtocolFunction<GetSubscriptionIntentRequest, Nullable<SubscriptionIntent>>;
/**
 * GetCoupon
 */
export interface GetCouponRequest extends AuthRequest {
    couponName: CouponName;
    plan?: SubscriptionPlanName;
}
export declare type GetCouponResponse = Nullable<Coupon>;
export declare const GetCoupon: import("..").ProtocolFunction<GetCouponRequest, Nullable<Coupon>>;
/**
 * GetPaymentMethod
 */
export interface GetPaymentMethodRequest extends AuthRequest {
}
export declare type GetPaymentMethodResponse = Nullable<PaymentMethodDescription>;
export declare const GetPaymentMethod: import("..").ProtocolFunction<GetPaymentMethodRequest, Nullable<PaymentMethodDescription>>;
/**
 * UnsubscribeFromPlan
 */
export interface UnsubscribeFromPlanRequest extends AuthRequest {
    subscriptionId: SubscriptionId;
    cancelReason?: SubscriptionCancelReason;
}
export declare type UnsubscribeFromPlanResponse = BooleanResponse;
export declare const UnsubscribeFromPlan: import("..").ProtocolFunction<UnsubscribeFromPlanRequest, BooleanResponse>;
/**
 * GetUserSubscriptions
 */
export interface GetUserSubscriptionsRequest extends AuthRequest {
}
export declare type GetUserSubscriptionsResponse = Subscription[];
/**
 * Gets a list of the user's subscriptions.
 * @param userToken The token of the user.
 * @returns A list of the user's subscriptions.
 */
export declare const GetUserSubscriptions: import("..").ProtocolFunction<GetUserSubscriptionsRequest, GetUserSubscriptionsResponse>;
/**
 * GetUserActiveSubscriptions
 */
export interface GetUserActiveSubscriptionsRequest extends AuthRequest {
}
export declare type GetUserActiveSubscriptionsResponse = Subscription[];
/**
 * Gets a list of the user's active subscriptions.
 * @param userToken The token of the user.
 * @returns A list of the user's active subscriptions.
 */
export declare const GetUserActiveSubscriptions: import("..").ProtocolFunction<GetUserActiveSubscriptionsRequest, GetUserActiveSubscriptionsResponse>;
/**
 * AddUserToPlan
 */
export interface AddUserToPlanRequest extends AuthRequest {
    subscriptionId: SubscriptionId;
    userToAdd: UserId;
}
export declare type AddUserToPlanResponse = BooleanResponse;
/**
 * Adds a user to a plan.
 * @param userToken The token of the user who owns the plan.
 * @param subsriptionId The ID of the subscription to modify.
 * @param userToAdd The ID of the user to add.
 * @returns True on success, false otherwise.
 */
export declare const AddUserToPlan: import("..").ProtocolFunction<AddUserToPlanRequest, BooleanResponse>;
/**
 * RemoveUserFromPlan
 */
export interface RemoveUserFromPlanRequest extends AuthRequest {
    subscriptionId: SubscriptionId;
    userToRemove: UserId;
}
export declare type RemoveUserFromPlanResponse = BooleanResponse;
/**
 * Removes a user from a plan.
 * @param userToken The token of the user who owns the plan.
 * @param subsriptionId The ID of the subscription to modify.
 * @param userToAdd The ID of the user to remove.
 * @returns True on success, false otherwise.
 */
export declare const RemoveUserFromPlan: import("..").ProtocolFunction<RemoveUserFromPlanRequest, BooleanResponse>;
/**
 * GetUsersByPlan
 */
export interface GetUsersByPlanRequest extends AuthRequest {
    subscriptionId: SubscriptionId;
}
export declare type GetUsersByPlanResponse = PublicUser[];
/**
 * Gets a list of users associated with the plan.
 * @param userToken The token of the user who owns the plan.
 * @param subsriptionId The ID of the subscription plan.
 * @returns A list of users.
 */
export declare const GetUsersByPlan: import("..").ProtocolFunction<GetUsersByPlanRequest, GetUsersByPlanResponse>;
/**
 * GetAllPlans
 */
export interface GetAllPlansRequest extends OptionalAuthRequest {
}
export declare type GetAllPlansResponse = SubscriptionPlan[];
export declare const GetAllPlans: import("..").ProtocolFunction<GetAllPlansRequest, GetAllPlansResponse>;
/**
 * GetPlanByName
 */
export interface GetPlanByNameRequest extends OptionalAuthRequest {
    plan: SubscriptionPlanName;
}
export declare type GetPlanByNameResponse = Nullable<SubscriptionPlan>;
export declare const GetPlanByName: import("..").ProtocolFunction<GetPlanByNameRequest, Nullable<SubscriptionPlan>>;