perspectapi-ts-sdk 4.1.0 → 5.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. package/README.md +25 -1
  2. package/dist/index.d.mts +649 -11
  3. package/dist/index.d.ts +649 -11
  4. package/dist/index.js +453 -5
  5. package/dist/index.mjs +450 -5
  6. package/package.json +1 -1
  7. package/src/client/site-users-client.ts +15 -9
  8. package/src/index.ts +5 -1
  9. package/src/types/index.ts +24 -1
  10. package/src/v2/client/api-keys-client.ts +21 -0
  11. package/src/v2/client/base-v2-client.ts +156 -0
  12. package/src/v2/client/categories-client.ts +32 -0
  13. package/src/v2/client/collections-client.ts +64 -0
  14. package/src/v2/client/contacts-client.ts +37 -0
  15. package/src/v2/client/content-client.ts +44 -0
  16. package/src/v2/client/newsletter-client.ts +95 -0
  17. package/src/v2/client/orders-client.ts +21 -0
  18. package/src/v2/client/organizations-client.ts +17 -0
  19. package/src/v2/client/products-client.ts +36 -0
  20. package/src/v2/client/site-users-client.ts +53 -0
  21. package/src/v2/client/sites-client.ts +17 -0
  22. package/src/v2/client/webhooks-client.ts +32 -0
  23. package/src/v2/index.ts +105 -0
  24. package/src/v2/types.ts +395 -0
package/README.md CHANGED
@@ -824,9 +824,33 @@ const orders = await client.siteUsers.getOrders(siteName, {
824
824
  // Get subscriptions
825
825
  const subscriptions = await client.siteUsers.getSubscriptions(siteName);
826
826
 
827
- // Cancel subscription
827
+ // Cancel at end of billing period (default)
828
828
  await client.siteUsers.cancelSubscription(siteName, 'sub_123', csrfToken);
829
829
 
830
+ // Cancel immediately
831
+ await client.siteUsers.cancelSubscription(
832
+ siteName,
833
+ 'sub_123',
834
+ csrfToken,
835
+ { mode: 'immediate' }
836
+ );
837
+
838
+ // Cancel at a scheduled time (absolute)
839
+ await client.siteUsers.cancelSubscription(
840
+ siteName,
841
+ 'sub_123',
842
+ csrfToken,
843
+ { mode: 'scheduled', cancel_at: '2026-05-01T15:30:00Z' }
844
+ );
845
+
846
+ // Cancel after a configured delay (days/hours/minutes)
847
+ await client.siteUsers.cancelSubscription(
848
+ siteName,
849
+ 'sub_123',
850
+ csrfToken,
851
+ { mode: 'scheduled', delay_days: 7, delay_hours: 2 }
852
+ );
853
+
830
854
  // Logout
831
855
  await client.siteUsers.logout(siteName);
832
856
  client.setAuth(null);