perspectapi-ts-sdk 5.4.5 → 6.0.1

package/src/v2/types.ts

@@ -250,6 +250,96 @@ export interface V2OrderListParams extends V2PaginationParams {
   date_to?: string;
 }
 
+// --- Order create (checkout session creation) ---
+
+export interface V2OrderLineItemPriceData {
+  currency: string;
+  product_data: {
+    name: string;
+    description?: string;
+    images?: string[];
+  };
+  unit_amount: number;
+}
+
+export interface V2OrderLineItem {
+  sku_id?: number;
+  product_id?: number;
+  price_data?: V2OrderLineItemPriceData;
+  price?: string;
+  quantity: number;
+}
+
+export interface V2OrderAddress {
+  line1?: string;
+  line2?: string;
+  city?: string;
+  state?: string;
+  postal_code?: string;
+  country?: string;
+}
+
+export interface V2OrderTaxRequest {
+  strategy?: string;
+  customer_identifier?: string;
+  customer_profile_id?: string;
+  customer_display_name?: string;
+  allow_exemption?: boolean;
+  save_profile?: boolean;
+  customer_exemption?: {
+    status?: "none" | "exempt" | "reverse_charge";
+    reason?: string;
+    tax_id?: string;
+    tax_id_type?: string;
+    certificate_url?: string;
+    metadata?: Record<string, unknown>;
+    expires_at?: string;
+  };
+}
+
+export interface V2OrderCreateParams {
+  line_items: V2OrderLineItem[];
+  success_url: string;
+  cancel_url: string;
+  customer_email?: string;
+  site_user_id?: string;
+  mode?: "payment" | "subscription";
+  metadata?: Record<string, string | number | boolean>;
+  tax?: V2OrderTaxRequest;
+  shipping_amount?: number;
+  shipping_address?: V2OrderAddress;
+  billing_address?: V2OrderAddress;
+  currency?: string;
+  referral_code?: string;
+  referrer_site_user_id?: string;
+}
+
+export interface V2OrderFulfillmentUpdate {
+  fulfillment_status: string;
+  tracking_number?: string;
+  notes?: string;
+}
+
+export interface V2OrderCreateResult extends V2Object {
+  object: "checkout_session";
+  checkout_url: string | null;
+  payment_status: string | null;
+  tax: {
+    amount: number;
+    currency: string;
+    strategy: string;
+    exemption_applied: boolean;
+    exemption_status: string;
+    breakdown: Array<{
+      jurisdiction?: string;
+      rate_percent: number;
+      tax_amount: number;
+      taxable_amount: number;
+      source: string;
+    }>;
+  };
+}
+
 // --- Site Users ---
 
 export interface V2SiteUser extends V2Object {
@@ -275,11 +365,41 @@ export interface V2SiteUserUpdateParams {
   metadata?: Record<string, unknown>;
 }
 
+/**
+ * Patch shape for the authenticated `/me` endpoint. Unlike the admin update,
+ * end users cannot change their own `status`.
+ */
+export interface V2SiteUserMeUpdateParams {
+  first_name?: string;
+  last_name?: string;
+  avatar_url?: string;
+  metadata?: Record<string, unknown>;
+}
+
 export interface V2SiteUserListParams extends V2PaginationParams {
   status?: "active" | "suspended" | "pending_verification";
   email?: string;
 }
 
+/**
+ * Response shape of `GET /sites/{siteName}/users/me`. Extends V2SiteUser with
+ * a `profile` side-channel populated from the `site_user_profiles` KV table.
+ */
+export interface V2SiteUserWithProfile extends V2SiteUser {
+  profile: Record<string, unknown>;
+}
+
+/**
+ * Standalone profile envelope returned by
+ * `GET|PUT /sites/{siteName}/users/me/profile[/:key]`. Each `data` entry is a
+ * parsed value (arbitrary JSON).
+ */
+export interface V2SiteUserProfile {
+  object: "site_user_profile";
+  site_user_id: string;
+  data: Record<string, unknown>;
+}
+
 // --- Newsletter ---
 
 export interface V2NewsletterSubscription extends V2Object {
@@ -332,6 +452,84 @@ export interface V2NewsletterTrackingResponse {
   success: boolean;
 }
 
+// --- Newsletter admin writes ---
+
+export interface V2NewsletterListCreateParams {
+  list_name: string;
+  slug: string;
+  description?: string | null;
+  is_public?: boolean;
+  is_default?: boolean;
+  welcome_email_enabled?: boolean;
+}
+
+export interface V2NewsletterListUpdateParams {
+  list_name?: string;
+  slug?: string;
+  description?: string | null;
+  is_public?: boolean;
+  is_default?: boolean;
+  welcome_email_enabled?: boolean;
+  status?: "active" | "archived";
+}
+
+export interface V2NewsletterSyncInput {
+  email: string;
+  name?: string | null;
+  status?: "pending" | "confirmed" | "unsubscribed" | "bounced" | "complained";
+  list_ids?: string[];
+  frequency?: "instant" | "daily" | "weekly" | "monthly";
+  topics?: string[];
+  language?: string | null;
+  source?: string | null;
+  source_url?: string | null;
+  notes?: string | null;
+  tags?: string[];
+  metadata?: Record<string, unknown>;
+  resubscribe_override?: boolean;
+}
+
+export interface V2NewsletterSyncResult {
+  object: "newsletter_sync_result";
+  applied: boolean;
+  code: "CREATED" | "UPDATED" | "RESUBSCRIBED" | "ALREADY_UNSUBSCRIBED";
+  skipped_unsubscribed: boolean;
+  resubscribed: boolean;
+  created: boolean;
+  updated: boolean;
+  subscription: Record<string, unknown>;
+}
+
+export interface V2NewsletterSubscriptionListMembershipUpdate {
+  mode: "add" | "remove" | "replace";
+  list_ids: string[];
+}
+
+export interface V2NewsletterImportRequest {
+  rows: V2NewsletterSyncInput[];
+  resubscribe_override?: boolean;
+}
+
+export interface V2NewsletterImportResult {
+  object: "newsletter_import_result";
+  total: number;
+  processed: number;
+  applied: number;
+  created: number;
+  updated: number;
+  resubscribed: number;
+  skipped_unsubscribed: number;
+  rows: Array<{
+    index: number;
+    email: string;
+    applied: boolean;
+    code: V2NewsletterSyncResult["code"];
+    skipped_unsubscribed: boolean;
+    resubscribed: boolean;
+    subscription_id: string;
+  }>;
+}
+
 // --- Contact ---
 
 export interface V2ContactSubmission extends V2Object {
@@ -414,3 +612,81 @@ export interface V2WebhookCreateParams {
 }
 
 export interface V2WebhookUpdateParams extends Partial<V2WebhookCreateParams> {}
+
+// --- Site User Subscriptions ---
+
+export interface V2SiteUserSubscription extends V2Object {
+  object: "site_user_subscription";
+  site_user_id: string;
+  provider: string | null;
+  provider_subscription_id: string | null;
+  plan_name: string | null;
+  plan_id: string | null;
+  status: string;
+  amount: number | null;
+  currency: string | null;
+  billing_interval: string | null;
+  billing_interval_count: number | null;
+  current_period_start: string | null;
+  current_period_end: string | null;
+  trial_start: string | null;
+  trial_end: string | null;
+  canceled_at: string | null;
+  cancel_at_period_end: boolean;
+  metadata: Record<string, unknown> | null;
+  created_at: string | null;
+  updated_at: string | null;
+}
+
+export interface V2SubscriptionPauseParams {
+  resumes_at?: number;
+}
+
+export interface V2SubscriptionCancelParams {
+  mode?: "immediate" | "period_end" | "scheduled";
+  cancel_at?: string;
+}
+
+export interface V2SubscriptionChangePlanParams {
+  product_id: string;
+}
+
+export interface V2CancelSubscriptionResult {
+  object: "subscription_cancel_result";
+  mode: string;
+  status: string;
+  cancel_at_period_end: boolean;
+  effective_at: string | null;
+  scheduled_cancel_at: string | null;
+  message: string;
+}
+
+// --- Credits ---
+
+export interface V2CreditTransaction extends V2Object {
+  object: "credit_transaction";
+  site_user_id: string;
+  amount_cents: number;
+  balance_after_cents: number;
+  type: string;
+  description: string | null;
+  reference_id: string | null;
+  reference_type: string | null;
+  created_at: string | null;
+}
+
+export interface V2CreditBalance {
+  object: "credit_balance";
+  balance_cents: number;
+  transactions?: V2CreditTransaction[];
+}
+
+export interface V2GrantCreditParams {
+  amount_cents: number;
+  description: string;
+}
+
+export interface V2GrantCreditResult {
+  object: "grant_credit_result";
+  new_balance_cents: number;
+}