perspectapi-ts-sdk 6.5.7 → 7.0.0
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.
- package/README.md +46 -1011
- package/dist/chunk-K3T2AFYA.mjs +1393 -0
- package/dist/index-CWvUyMt3.d.mts +2224 -0
- package/dist/index-CWvUyMt3.d.ts +2224 -0
- package/dist/index.d.mts +130 -2201
- package/dist/index.d.ts +130 -2201
- package/dist/index.js +15 -2
- package/dist/index.mjs +13 -1357
- package/dist/v2/index.d.mts +1 -0
- package/dist/v2/index.d.ts +1 -0
- package/dist/v2/index.js +1419 -0
- package/dist/v2/index.mjs +40 -0
- package/docs/README.md +15 -0
- package/docs/v1-deprecated/README.md +9 -0
- package/docs/v1-deprecated/examples/README.md +324 -0
- package/docs/v1-deprecated/examples/basic-usage.ts +258 -0
- package/docs/v1-deprecated/examples/cloudflare-worker.ts +274 -0
- package/docs/v1-deprecated/examples/content-query-with-slug-prefix.ts +237 -0
- package/docs/v1-deprecated/examples/image-transforms.ts +200 -0
- package/docs/v1-deprecated/examples/site-user-checkout.ts +186 -0
- package/docs/v1-deprecated/examples/slug-prefix-examples.ts +491 -0
- package/docs/v1-deprecated/legacy-docs/caching.md +667 -0
- package/docs/v1-deprecated/legacy-docs/contact.md +1396 -0
- package/docs/v1-deprecated/legacy-docs/csrf-protection.md +664 -0
- package/docs/v1-deprecated/legacy-docs/image-transforms.md +523 -0
- package/docs/v1-deprecated/legacy-docs/loaders.md +304 -0
- package/docs/v1-deprecated/legacy-docs/newsletter.md +811 -0
- package/docs/v1-deprecated/legacy-docs/site-users.md +817 -0
- package/docs/v1-deprecated/legacy-notes/CHANGELOG-CHECKOUT.md +143 -0
- package/docs/v1-deprecated/legacy-notes/CSRF-CHECKOUT.md +271 -0
- package/docs/v1-deprecated/legacy-notes/IMAGE_TRANSFORMS_PORT.md +298 -0
- package/docs/v1-deprecated/sdk-readme.md +1076 -0
- package/examples/README.md +19 -0
- package/examples/basic-v2.ts +37 -0
- package/llms.txt +25 -0
- package/package.json +18 -7
- package/src/client/api-keys-client.ts +4 -0
- package/src/client/auth-client.ts +4 -0
- package/src/client/base-client.ts +7 -0
- package/src/client/bundles-client.ts +4 -0
- package/src/client/categories-client.ts +4 -0
- package/src/client/checkout-client.ts +4 -0
- package/src/client/contact-client.ts +4 -0
- package/src/client/content-client.ts +4 -0
- package/src/client/newsletter-client.ts +4 -0
- package/src/client/newsletter-management-client.ts +4 -0
- package/src/client/organizations-client.ts +4 -0
- package/src/client/products-client.ts +4 -0
- package/src/client/site-users-client.ts +10 -1
- package/src/client/sites-client.ts +4 -0
- package/src/client/webhooks-client.ts +4 -0
- package/src/deprecation.ts +2 -1
- package/src/index.ts +2 -1
- package/src/loaders.ts +59 -0
- package/src/perspect-api-client.ts +2 -2
- package/src/v2/client/orders-client.ts +6 -1
- package/src/v2/client/subscriptions-client.ts +15 -0
- package/src/v2/types.ts +23 -0
package/dist/index.js
CHANGED
|
@@ -76,7 +76,7 @@ module.exports = __toCommonJS(index_exports);
|
|
|
76
76
|
|
|
77
77
|
// src/deprecation.ts
|
|
78
78
|
var V1_SUNSET_DATE = "2026-06-01";
|
|
79
|
-
var V1_DEPRECATION_NOTICE = "perspectapi-ts-sdk v1 client is deprecated; sunsets 2026-06-01.
|
|
79
|
+
var V1_DEPRECATION_NOTICE = "perspectapi-ts-sdk v1 client is deprecated; sunsets 2026-06-01. Do not use it for new code. Use createPerspectApiV2Client from perspectapi-ts-sdk/v2.";
|
|
80
80
|
var warned = false;
|
|
81
81
|
function warnV1Deprecated() {
|
|
82
82
|
if (warned) return;
|
|
@@ -999,7 +999,12 @@ var OrdersV2Client = class extends BaseV2Client {
|
|
|
999
999
|
data
|
|
1000
1000
|
);
|
|
1001
1001
|
}
|
|
1002
|
-
/**
|
|
1002
|
+
/**
|
|
1003
|
+
* Update fulfillment status, tracking number, and/or notes on an order.
|
|
1004
|
+
*
|
|
1005
|
+
* Set `notify_customer: true` when moving the order into a terminal
|
|
1006
|
+
* fulfillment state to send the customer fulfillment email.
|
|
1007
|
+
*/
|
|
1003
1008
|
async updateFulfillment(siteName, id, data) {
|
|
1004
1009
|
return this.patchOne(
|
|
1005
1010
|
this.sitePath(siteName, "orders", `${id}/fulfillment`),
|
|
@@ -1346,6 +1351,13 @@ var SubscriptionsV2Client = class extends BaseV2Client {
|
|
|
1346
1351
|
params ?? {}
|
|
1347
1352
|
);
|
|
1348
1353
|
}
|
|
1354
|
+
/** Charge a user's subscription once (admin). */
|
|
1355
|
+
async chargeUserSubscription(siteName, userId, subId, params) {
|
|
1356
|
+
return this.post(
|
|
1357
|
+
this.sitePath(siteName, "users", `${userId}/subscriptions/${subId}/charges`),
|
|
1358
|
+
params
|
|
1359
|
+
);
|
|
1360
|
+
}
|
|
1349
1361
|
};
|
|
1350
1362
|
|
|
1351
1363
|
// src/v2/client/credits-client.ts
|
|
@@ -1446,6 +1458,7 @@ var BaseClient = class {
|
|
|
1446
1458
|
basePath;
|
|
1447
1459
|
cache;
|
|
1448
1460
|
constructor(http, basePath, cache) {
|
|
1461
|
+
warnV1Deprecated();
|
|
1449
1462
|
this.http = http;
|
|
1450
1463
|
this.basePath = basePath;
|
|
1451
1464
|
this.cache = cache && cache.isEnabled() ? cache : void 0;
|