@theholocron/checkly-client 1.52.0 → 1.53.1

package/README.md

@@ -96,17 +96,23 @@ const channel = await checkly.alertChannels.create({
   sendFailure: true,
   sendRecovery: true,
   sendDegraded: true,
-  // Checks made through the API are never auto-subscribed: list each one.
-  subscriptions: [{ checkId: check.id, activated: true }],
 });
 
+// Checks made through the API are never auto-subscribed. Subscribe each one with `subscribe`, then read the channel
+// back: Checkly's create and update accept a `subscriptions` list but have been seen not to apply it.
+await checkly.alertChannels.subscribe(channel.id, {
+  checkId: check.id,
+  activated: true,
+});
+const subscribed = (await checkly.alertChannels.get(channel.id)).subscriptions;
+
 const all = await checkly.alertChannels.list(); // every page
 const one = await checkly.alertChannels.get(channel.id);
 await checkly.alertChannels.update(channel.id, {/* the complete channel */});
 await checkly.alertChannels.delete(channel.id);
 ```
 
-`update` replaces the whole channel (settings and subscriptions), so send everything you want to keep. Checkly offers
+`update` replaces the whole channel (settings and subscriptions), so send everything you want to keep, and re-read the channel before updating it if anything may have subscribed a check since you last did. Checkly offers
 no version check, so do not update one channel from two places at once.
 
 > **Note:** This client covers API checks (`checks.*`) and alert channels (`alertChannels.*`) — the subset this org

package/dist/index.d.mts

@@ -173,6 +173,7 @@ declare function createChecklyClient(opts: ChecklyClientOptions): {
     get: (id: number) => Promise<AlertChannel>;
     create: (input: AlertChannelInput) => Promise<AlertChannel>;
     update: (id: number, input: AlertChannelInput) => Promise<AlertChannel>;
+    subscribe: (id: number, subscription: AlertChannelSubscription) => Promise<AlertChannelSubscription>;
     delete: (id: number) => Promise<void>;
   };
   checks: {

package/dist/index.mjs

@@ -90,6 +90,15 @@ function alertChannels(rest) {
 			method: "PUT",
 			body: { ...input }
 		}),
+		/**
+		* Subscribe one check (or group) to a channel, or switch that subscription on or off. This is the call that makes
+		* a subscription take effect: Checkly's create and update accept a `subscriptions` list but have been seen not to
+		* apply it, so read the channel back after writing it and use this for whatever is missing.
+		*/
+		subscribe: (id, subscription) => rest.request(`/alert-channels/${id}/subscriptions`, {
+			method: "PUT",
+			body: { ...subscription }
+		}),
 		delete: (id) => rest.request(`/alert-channels/${id}`, { method: "DELETE" })
 	};
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/checkly-client",
-  "version": "1.52.0",
+  "version": "1.53.1",
   "description": "A TypeScript client for the Checkly monitoring API",
   "keywords": [
     "checkly",
@@ -34,7 +34,7 @@
   ],
   "dependencies": {
     "@theholocron/observability": "^0.3.0",
-    "@theholocron/http-client": "^1.52.0"
+    "@theholocron/http-client": "^1.53.1"
   },
   "devDependencies": {
     "@theholocron/cli": "5.0.0-alpha.79",