@talosjs/payment 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,562 @@
+import { Exception } from "@talosjs/exception";
+declare class PaymentException extends Exception {
+	constructor(message: string, key: string, data?: Record<string, unknown>);
+}
+import { AppEnv } from "@talosjs/app-env";
+import { CurrencyCodeType } from "@talosjs/currencies";
+import { IBase, ScalarType } from "@talosjs/types";
+declare enum EPriceType {
+	FIXED = "fixed",
+	CUSTOM = "custom",
+	FREE = "free"
+}
+type PriceTypeType = `${EPriceType}`;
+type ProductImageType = {
+	id: string;
+	url: string;
+};
+type PriceType = {
+	type: PriceTypeType;
+	priceCurrency?: string;
+	priceAmount?: number;
+	minimumAmount?: number;
+	maximumAmount?: number;
+	presetAmount?: number;
+};
+type CustomFieldType = {
+	customFieldId: string;
+	required: boolean;
+};
+declare enum EDiscountType {
+	PERCENTAGE = "percentage",
+	FIXED = "fixed"
+}
+declare enum EDiscountDuration {
+	ONCE = "once",
+	REPEATING = "repeating",
+	FOREVER = "forever"
+}
+type DiscountDurationType = `${EDiscountDuration}`;
+declare enum ESubscriptionPeriod {
+	MONTHLY = "monthly",
+	YEARLY = "yearly",
+	WEEKLY = "weekly",
+	DAILY = "daily"
+}
+type DiscountType = `${EDiscountType}`;
+type SubscriptionPeriodType = `${ESubscriptionPeriod}`;
+declare enum EBenefitType {
+	CREDITS = "credits",
+	LICENSE_KEYS = "license_keys",
+	FILE_DOWNLOADS = "file_downloads",
+	GITHUB_REPOSITORY_ACCESS = "github_repository_access",
+	DISCORD_ACCESS = "discord_access",
+	CUSTOM = "custom"
+}
+type BenefitTypeType = `${EBenefitType}`;
+declare enum EGitHubPermission {
+	READ = "read",
+	TRIAGE = "triage",
+	WRITE = "write",
+	MAINTAIN = "maintain",
+	ADMIN = "admin"
+}
+type GitHubPermissionType = `${EGitHubPermission}`;
+type BenefitBaseType = {
+	type: BenefitTypeType;
+	name: string;
+	description?: string;
+	isSelectable?: boolean;
+	isDeletable?: boolean;
+	organizationId?: string;
+};
+type CreditsBenefitType = BenefitBaseType & {
+	type: typeof EBenefitType.CREDITS;
+	amount: number;
+	rollover?: boolean;
+};
+type LicenseKeysBenefitType = BenefitBaseType & {
+	type: typeof EBenefitType.LICENSE_KEYS;
+	prefix?: string;
+	expiresInDays?: number;
+	expiresInMonths?: number;
+	expiresInYears?: number;
+	activationLimit?: number;
+	usageLimit?: number;
+};
+type FileDownloadsBenefitType = BenefitBaseType & {
+	type: typeof EBenefitType.FILE_DOWNLOADS;
+	files?: BenefitFileType[];
+};
+type BenefitFileType = {
+	id: string;
+	name: string;
+	size: number;
+	mimeType?: string;
+	checksum?: string;
+	isEnabled?: boolean;
+};
+type GitHubRepositoryAccessBenefitType = BenefitBaseType & {
+	type: typeof EBenefitType.GITHUB_REPOSITORY_ACCESS;
+	repositoryOwner: string;
+	repositoryName: string;
+	permission?: GitHubPermissionType;
+};
+type DiscordAccessBenefitType = BenefitBaseType & {
+	type: typeof EBenefitType.DISCORD_ACCESS;
+	guildId: string;
+	roleId: string;
+};
+type CustomBenefitType = BenefitBaseType & {
+	type: typeof EBenefitType.CUSTOM;
+	note?: string;
+};
+type BenefitType = CreditsBenefitType | LicenseKeysBenefitType | FileDownloadsBenefitType | GitHubRepositoryAccessBenefitType | DiscordAccessBenefitType | CustomBenefitType;
+interface IProduct extends IBase {
+	key?: string;
+	name: string;
+	description?: string;
+	categories?: string[];
+	currency?: CurrencyCodeType;
+	price?: number;
+	barcode?: string;
+	images?: ProductImageType[];
+	attributes?: Record<string, ScalarType>;
+	tags?: string[];
+	isRecurring?: boolean;
+	isArchived?: boolean;
+	organizationId?: string;
+	recurringInterval?: SubscriptionPeriodType;
+	metadata?: Record<string, string | number | boolean>;
+	prices?: PriceType[];
+	benefits?: BenefitType[];
+	attachedCustomFields?: CustomFieldType[];
+}
+interface IFeature extends IBase {
+	name: string;
+	description?: string;
+	isEnabled?: boolean;
+	limit?: number;
+}
+interface IPlan extends IBase {
+	name: string;
+	description?: string;
+	currency: CurrencyCodeType;
+	price: number;
+	period: ESubscriptionPeriod;
+	periodCount?: number;
+	features?: IFeature[];
+	isActive?: boolean;
+	trialDays?: number;
+}
+interface ICredit extends IBase {
+	balance: number;
+	currency?: CurrencyCodeType;
+	expiresAt?: Date;
+	description?: string;
+}
+interface ISubscription extends IBase {
+	discounts?: IDiscount[];
+	plans?: IPlan[];
+	credits?: ICredit[];
+	startAt: Date;
+	endAt?: Date;
+	isTrial?: boolean;
+	isActive?: boolean;
+}
+interface IDiscount extends IBase {
+	key?: string;
+	name: string;
+	description?: string;
+	code?: string;
+	type: DiscountType;
+	amount: number;
+	currency?: CurrencyCodeType;
+	duration: DiscountDurationType;
+	durationInMonths?: number;
+	startAt?: Date;
+	endAt?: Date;
+	maxUses?: number;
+	usedCount?: number;
+	maxRedemptions?: number;
+	redemptionsCount?: number;
+	isActive?: boolean;
+	minimumAmount?: number;
+	applicableProducts?: IProduct[];
+	applicablePlans?: IPlan[];
+	organizationId?: string;
+	metadata?: Record<string, string | number | boolean>;
+}
+declare enum ECheckoutStatus {
+	OPEN = "open",
+	EXPIRED = "expired",
+	CONFIRMED = "confirmed",
+	SUCCEEDED = "succeeded",
+	FAILED = "failed"
+}
+type CheckoutStatusType = `${ECheckoutStatus}`;
+type CheckoutCustomerType = {
+	id?: string;
+	email?: string;
+	name?: string;
+	externalId?: string;
+	billingAddress?: CheckoutAddressType;
+	taxId?: string;
+};
+type CheckoutAddressType = {
+	line1?: string;
+	line2?: string;
+	city?: string;
+	state?: string;
+	postalCode?: string;
+	country?: string;
+};
+type CheckoutCreateType = {
+	products: string[];
+	customerExternalId?: string;
+	customerId?: string;
+	customerEmail?: string;
+	customerName?: string;
+	customerBillingAddress?: CheckoutAddressType;
+	customerTaxId?: string;
+	discountId?: string;
+	allowDiscountCodes?: boolean;
+	successUrl?: string;
+	embedOrigin?: string;
+	metadata?: Record<string, string | number | boolean>;
+};
+type CheckoutType = {
+	id: string;
+	url?: string;
+	embedId?: string;
+	status: CheckoutStatusType;
+	clientSecret: string;
+	createdAt?: Date;
+	updatedAt?: Date;
+	expiresAt?: Date;
+	successUrl?: string;
+	embedOrigin?: string;
+	amount?: number;
+	taxAmount?: number;
+	currency?: CurrencyCodeType;
+	subtotalAmount?: number;
+	totalAmount?: number;
+	productId?: string;
+	productPriceId?: string;
+	discountId?: string;
+	allowDiscountCodes?: boolean;
+	isDiscountApplicable?: boolean;
+	isPaymentRequired?: boolean;
+	customer?: CheckoutCustomerType;
+	metadata?: Record<string, string | number | boolean>;
+};
+type CustomerSessionCreateType = {
+	customerId: string;
+};
+type CustomerSessionType = {
+	id: string;
+	token: string;
+	customerPortalUrl: string;
+	createdAt?: Date;
+	expiresAt?: Date;
+	customerId?: string;
+};
+type CustomerAddressType = {
+	line1?: string;
+	line2?: string;
+	city?: string;
+	state?: string;
+	postalCode?: string;
+	country?: string;
+};
+type CustomerCreateType = {
+	email: string;
+	name?: string;
+	externalId?: string;
+	billingAddress?: CustomerAddressType;
+	taxId?: string;
+	organizationId?: string;
+	metadata?: Record<string, string | number | boolean>;
+};
+type CustomerUpdateType = {
+	email?: string;
+	name?: string;
+	billingAddress?: CustomerAddressType;
+	taxId?: string;
+	metadata?: Record<string, string | number | boolean>;
+};
+type CustomerType = {
+	id: string;
+	email: string;
+	emailVerified: boolean;
+	name?: string;
+	externalId?: string;
+	avatarUrl?: string;
+	billingAddress?: CustomerAddressType;
+	taxId?: string;
+	organizationId?: string;
+	metadata?: Record<string, string | number | boolean>;
+	createdAt?: Date;
+	updatedAt?: Date;
+	deletedAt?: Date;
+};
+type CustomerListOptionsType = {
+	organizationId?: string;
+	email?: string;
+	query?: string;
+	page?: number;
+	limit?: number;
+};
+type CustomerListResultType = {
+	items: CustomerType[];
+	pagination: {
+		totalCount: number;
+		maxPage: number;
+	};
+};
+declare enum EAnalyticsInterval {
+	YEAR = "year",
+	MONTH = "month",
+	WEEK = "week",
+	DAY = "day",
+	HOUR = "hour"
+}
+type AnalyticsIntervalType = `${EAnalyticsInterval}`;
+declare enum EBillingType {
+	ONE_TIME = "one_time",
+	RECURRING = "recurring"
+}
+type BillingTypeType = `${EBillingType}`;
+type AnalyticsOptionsType = {
+	startDate: Date;
+	endDate: Date;
+	interval: AnalyticsIntervalType;
+	organizationId?: string | string[];
+	productId?: string | string[];
+	billingType?: BillingTypeType | BillingTypeType[];
+	customerId?: string | string[];
+};
+type AnalyticsPeriodType = {
+	timestamp: Date;
+	orders: number;
+	revenue: number;
+	cumulativeRevenue: number;
+	averageOrderValue: number;
+	oneTimeProducts: number;
+	oneTimeProductsRevenue: number;
+	newSubscriptions: number;
+	newSubscriptionsRevenue: number;
+	renewedSubscriptions: number;
+	renewedSubscriptionsRevenue: number;
+	activeSubscriptions: number;
+	monthlyRecurringRevenue: number;
+};
+type AnalyticsMetricInfoType = {
+	slug: string;
+	displayName: string;
+	type: string;
+};
+type AnalyticsMetricsType = {
+	orders: AnalyticsMetricInfoType;
+	revenue: AnalyticsMetricInfoType;
+	cumulativeRevenue: AnalyticsMetricInfoType;
+	averageOrderValue: AnalyticsMetricInfoType;
+	oneTimeProducts: AnalyticsMetricInfoType;
+	oneTimeProductsRevenue: AnalyticsMetricInfoType;
+	newSubscriptions: AnalyticsMetricInfoType;
+	newSubscriptionsRevenue: AnalyticsMetricInfoType;
+	renewedSubscriptions: AnalyticsMetricInfoType;
+	renewedSubscriptionsRevenue: AnalyticsMetricInfoType;
+	activeSubscriptions: AnalyticsMetricInfoType;
+	monthlyRecurringRevenue: AnalyticsMetricInfoType;
+};
+type AnalyticsResponseType = {
+	periods: AnalyticsPeriodType[];
+	metrics: AnalyticsMetricsType;
+};
+type AnalyticsIntervalLimitType = {
+	maxDays: number;
+};
+type AnalyticsIntervalsLimitsType = {
+	hour: AnalyticsIntervalLimitType;
+	day: AnalyticsIntervalLimitType;
+	week: AnalyticsIntervalLimitType;
+	month: AnalyticsIntervalLimitType;
+	year: AnalyticsIntervalLimitType;
+};
+type AnalyticsLimitsType = {
+	minDate: Date;
+	intervals: AnalyticsIntervalsLimitsType;
+};
+type CustomerSessionResponseType = {
+	id: string;
+	token: string;
+	customerPortalUrl: string;
+	createdAt?: Date;
+	expiresAt?: Date;
+	customerId?: string;
+};
+type DiscountResponseType = {
+	id: string;
+	createdAt?: Date;
+	modifiedAt?: Date;
+	name: string;
+	code?: string;
+	type: string;
+	basisPoints?: number;
+	amount?: number;
+	currency?: string;
+	duration: string;
+	durationInMonths?: number;
+	startsAt?: Date;
+	endsAt?: Date;
+	maxRedemptions?: number;
+	redemptionsCount: number;
+	organizationId?: string;
+	metadata: Record<string, string | number | boolean>;
+	products?: {
+		id: string;
+		name: string;
+	}[];
+};
+type CheckoutResponseType = {
+	id: string;
+	createdAt?: Date;
+	modifiedAt?: Date;
+	url?: string;
+	embedId?: string;
+	status: string;
+	clientSecret: string;
+	expiresAt?: Date;
+	successUrl?: string;
+	embedOrigin?: string;
+	amount?: number;
+	taxAmount?: number;
+	currency?: string;
+	subtotalAmount?: number;
+	totalAmount?: number;
+	productId?: string;
+	productPriceId?: string;
+	discountId?: string;
+	allowDiscountCodes?: boolean;
+	isDiscountApplicable?: boolean;
+	isPaymentRequired?: boolean;
+	customer?: {
+		id?: string;
+		email?: string;
+		name?: string;
+		externalId?: string;
+		billingAddress?: {
+			line1?: string;
+			line2?: string;
+			city?: string;
+			state?: string;
+			postalCode?: string;
+			country?: string;
+		};
+		taxId?: string;
+	};
+	metadata: Record<string, string | number | boolean>;
+};
+type CustomerResponseType = {
+	id: string;
+	createdAt?: Date;
+	modifiedAt?: Date;
+	deletedAt?: Date;
+	email: string;
+	emailVerified?: boolean;
+	name?: string;
+	externalId?: string;
+	avatarUrl?: string;
+	billingAddress?: {
+		line1?: string;
+		line2?: string;
+		city?: string;
+		state?: string;
+		postalCode?: string;
+		country?: string;
+	};
+	taxId?: string | [string, string];
+	organizationId?: string;
+	metadata?: Record<string, string | number | boolean>;
+};
+type CustomerListResponseType = {
+	result: {
+		items: CustomerResponseType[];
+		pagination: {
+			totalCount: number;
+			maxPage: number;
+		};
+	};
+};
+declare class PolarAnalytics {
+	private readonly env;
+	private client;
+	constructor(env: AppEnv);
+	get(options: AnalyticsOptionsType): Promise<AnalyticsResponseType>;
+	getLimits(): Promise<AnalyticsLimitsType>;
+	private toRFCDate;
+	private mapPeriod;
+	private mapMetricInfo;
+	private mapMetrics;
+	private mapIntervalsLimits;
+}
+import { AppEnv as AppEnv2 } from "@talosjs/app-env";
+declare class PolarCheckout {
+	private readonly env;
+	private client;
+	constructor(env: AppEnv2);
+	create(data: CheckoutCreateType): Promise<CheckoutType>;
+	get(id: string): Promise<CheckoutType>;
+	private mapResponse;
+}
+import { AppEnv as AppEnv3 } from "@talosjs/app-env";
+declare class PolarCustomer {
+	private readonly env;
+	private client;
+	constructor(env: AppEnv3);
+	create(data: CustomerCreateType): Promise<CustomerType>;
+	update(id: string, data: CustomerUpdateType): Promise<CustomerType>;
+	remove(id: string): Promise<void>;
+	get(id: string): Promise<CustomerType>;
+	list(options?: CustomerListOptionsType): Promise<CustomerListResultType>;
+	getByExternalId(externalId: string): Promise<CustomerType>;
+	updateByExternalId(externalId: string, data: CustomerUpdateType): Promise<CustomerType>;
+	removeByExternalId(externalId: string): Promise<void>;
+	private toBillingAddress;
+	private mapResponse;
+}
+import { AppEnv as AppEnv4 } from "@talosjs/app-env";
+declare class PolarCustomerPortal {
+	private readonly env;
+	private client;
+	constructor(env: AppEnv4);
+	create(data: CustomerSessionCreateType): Promise<CustomerSessionType>;
+	getPortalUrl(organizationSlug: string): string;
+	private mapResponse;
+}
+import { AppEnv as AppEnv5 } from "@talosjs/app-env";
+declare class PolarDiscount {
+	private readonly env;
+	private client;
+	constructor(env: AppEnv5);
+	private toDiscountType;
+	private toDiscountDuration;
+	create(data: IDiscount): Promise<IDiscount>;
+	update(id: string, data: Partial<IDiscount>): Promise<IDiscount>;
+	remove(id: string): Promise<void>;
+	get(id: string): Promise<IDiscount>;
+	private mapResponse;
+}
+import { AppEnv as AppEnv6 } from "@talosjs/app-env";
+declare class PolarProduct {
+	private readonly env;
+	private client;
+	constructor(env: AppEnv6);
+	private toRecurringInterval;
+	create(data: IProduct): Promise<Omit<IProduct, "id">>;
+	update(id: string, data: Partial<IProduct>): Promise<Omit<IProduct, "id">>;
+	remove(id: string): Promise<void>;
+	private mapResponse;
+}
+export { SubscriptionPeriodType, ProductImageType, PriceTypeType, PriceType, PolarProduct, PolarDiscount, PolarCustomerPortal, PolarCustomer, PolarCheckout, PolarAnalytics, PaymentException, LicenseKeysBenefitType, ISubscription, IProduct, IPlan, IFeature, IDiscount, ICredit, GitHubRepositoryAccessBenefitType, GitHubPermissionType, FileDownloadsBenefitType, ESubscriptionPeriod, EPriceType, EGitHubPermission, EDiscountType, EDiscountDuration, ECheckoutStatus, EBillingType, EBenefitType, EAnalyticsInterval, DiscountType, DiscountResponseType, DiscountDurationType, DiscordAccessBenefitType, CustomerUpdateType, CustomerType, CustomerSessionType, CustomerSessionResponseType, CustomerSessionCreateType, CustomerResponseType, CustomerListResultType, CustomerListResponseType, CustomerListOptionsType, CustomerCreateType, CustomerAddressType, CustomFieldType, CustomBenefitType, CreditsBenefitType, CheckoutType, CheckoutStatusType, CheckoutResponseType, CheckoutCustomerType, CheckoutCreateType, CheckoutAddressType, BillingTypeType, BenefitTypeType, BenefitType, BenefitFileType, BenefitBaseType, AnalyticsResponseType, AnalyticsPeriodType, AnalyticsOptionsType, AnalyticsMetricsType, AnalyticsMetricInfoType, AnalyticsLimitsType, AnalyticsIntervalsLimitsType, AnalyticsIntervalType, AnalyticsIntervalLimitType };