sdks: Add v1.message.create-precheck (#2197)

Author: svix-jplatte

ChangeLog.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## Unreleased
+* Libs/All: Add support for `v1.message.create-precheck` (Svix Cloud exclusive endpoint)
+
 ## Version 1.85.0
 * Server: Fix non-determinism with regards to overrides of specific header names
 * Server: Bump MSRV to 1.88.0

codegen/generated_files.json

@@ -168,6 +168,8 @@
         "csharp/Svix/Models/MessageEndpointOut.cs",
         "csharp/Svix/Models/MessageIn.cs",
         "csharp/Svix/Models/MessageOut.cs",
+        "csharp/Svix/Models/MessagePrecheckIn.cs",
+        "csharp/Svix/Models/MessagePrecheckOut.cs",
         "csharp/Svix/Models/MessageStatus.cs",
         "csharp/Svix/Models/MessageStatusText.cs",
         "csharp/Svix/Models/OperationalWebhookEndpointHeadersIn.cs",
@@ -412,6 +414,8 @@
         "go/models/message_endpoint_out.go",
         "go/models/message_in.go",
         "go/models/message_out.go",
+        "go/models/message_precheck_in.go",
+        "go/models/message_precheck_out.go",
         "go/models/message_status.go",
         "go/models/message_status_text.go",
         "go/models/operational_webhook_endpoint_headers_in.go",
@@ -577,6 +581,7 @@
         "java/lib/src/main/java/com/svix/api/MessagePollerConsumerPollOptions.java",
         "java/lib/src/main/java/com/svix/api/MessagePollerConsumerSeekOptions.java",
         "java/lib/src/main/java/com/svix/api/MessagePollerPollOptions.java",
+        "java/lib/src/main/java/com/svix/api/MessagePrecheckOptions.java",
         "java/lib/src/main/java/com/svix/api/OperationalWebhookEndpointCreateOptions.java",
         "java/lib/src/main/java/com/svix/api/OperationalWebhookEndpointListOptions.java",
         "java/lib/src/main/java/com/svix/api/OperationalWebhookEndpointRotateSecretOptions.java",
@@ -738,6 +743,8 @@
         "java/lib/src/main/java/com/svix/models/MessageEndpointOut.java",
         "java/lib/src/main/java/com/svix/models/MessageIn.java",
         "java/lib/src/main/java/com/svix/models/MessageOut.java",
+        "java/lib/src/main/java/com/svix/models/MessagePrecheckIn.java",
+        "java/lib/src/main/java/com/svix/models/MessagePrecheckOut.java",
         "java/lib/src/main/java/com/svix/models/MessageStatus.java",
         "java/lib/src/main/java/com/svix/models/MessageStatusText.java",
         "java/lib/src/main/java/com/svix/models/OperationalWebhookEndpointHeadersIn.java",
@@ -980,6 +987,8 @@
         "javascript/src/models/messageEndpointOut.ts",
         "javascript/src/models/messageIn.ts",
         "javascript/src/models/messageOut.ts",
+        "javascript/src/models/messagePrecheckIn.ts",
+        "javascript/src/models/messagePrecheckOut.ts",
         "javascript/src/models/messageStatus.ts",
         "javascript/src/models/messageStatusText.ts",
         "javascript/src/models/operationalWebhookEndpointHeadersIn.ts",
@@ -1219,6 +1228,8 @@
         "kotlin/lib/src/main/kotlin/models/MessageEndpointOut.kt",
         "kotlin/lib/src/main/kotlin/models/MessageIn.kt",
         "kotlin/lib/src/main/kotlin/models/MessageOut.kt",
+        "kotlin/lib/src/main/kotlin/models/MessagePrecheckIn.kt",
+        "kotlin/lib/src/main/kotlin/models/MessagePrecheckOut.kt",
         "kotlin/lib/src/main/kotlin/models/MessageStatus.kt",
         "kotlin/lib/src/main/kotlin/models/MessageStatusText.kt",
         "kotlin/lib/src/main/kotlin/models/OperationalWebhookEndpointHeadersIn.kt",
@@ -1355,6 +1366,7 @@
         "php/src/Api/MessagePollerConsumerPollOptions.php",
         "php/src/Api/MessagePollerConsumerSeekOptions.php",
         "php/src/Api/MessagePollerPollOptions.php",
+        "php/src/Api/MessagePrecheckOptions.php",
         "php/src/Api/OperationalWebhookEndpointCreateOptions.php",
         "php/src/Api/OperationalWebhookEndpointListOptions.php",
         "php/src/Api/OperationalWebhookEndpointRotateSecretOptions.php",
@@ -1496,6 +1508,8 @@
         "php/src/Models/MessageEndpointOut.php",
         "php/src/Models/MessageIn.php",
         "php/src/Models/MessageOut.php",
+        "php/src/Models/MessagePrecheckIn.php",
+        "php/src/Models/MessagePrecheckOut.php",
         "php/src/Models/MessageStatus.php",
         "php/src/Models/MessageStatusText.php",
         "php/src/Models/OperationalWebhookEndpointHeadersIn.php",
@@ -1717,6 +1731,8 @@
         "python/svix/models/message_endpoint_out.py",
         "python/svix/models/message_in.py",
         "python/svix/models/message_out.py",
+        "python/svix/models/message_precheck_in.py",
+        "python/svix/models/message_precheck_out.py",
         "python/svix/models/message_status.py",
         "python/svix/models/message_status_text.py",
         "python/svix/models/operational_webhook_endpoint_headers_in.py",
@@ -1956,6 +1972,8 @@
         "ruby/lib/svix/models/message_endpoint_out.rb",
         "ruby/lib/svix/models/message_in.rb",
         "ruby/lib/svix/models/message_out.rb",
+        "ruby/lib/svix/models/message_precheck_in.rb",
+        "ruby/lib/svix/models/message_precheck_out.rb",
         "ruby/lib/svix/models/message_status.rb",
         "ruby/lib/svix/models/message_status_text.rb",
         "ruby/lib/svix/models/operational_webhook_endpoint_headers_in.rb",
@@ -2194,6 +2212,8 @@
         "rust/src/models/message_endpoint_out.rs",
         "rust/src/models/message_in.rs",
         "rust/src/models/message_out.rs",
+        "rust/src/models/message_precheck_in.rs",
+        "rust/src/models/message_precheck_out.rs",
         "rust/src/models/message_status.rs",
         "rust/src/models/message_status_text.rs",
         "rust/src/models/operational_webhook_endpoint_headers_in.rs",

codegen/lib-openapi.json

@@ -8251,6 +8251,7 @@
             "MessagePrecheckOut": {
                 "properties": {
                     "active": {
+                        "description": "Whether there are any active endpoint that would get sent such a message.",
                         "type": "boolean"
                     }
                 },
@@ -21588,7 +21589,7 @@
         },
         "/api/v1/app/{app_id}/msg/precheck/active": {
             "post": {
-                "description": "A pre-check call for `create.message` that checks whether endpoints are actively listening to\nthis message.",
+                "description": "A pre-check call for `message.create` that checks whether any active endpoints are\nlistening to this message.\n\nNote: most people shouldn't be using this API. Svix doesn't bill you for\nmessages not actually sent, so using this API doesn't save money.\nIf unsure, please ask Svix support before using this API.",
                 "operationId": "v1.message.precheck",
                 "parameters": [
                     {
@@ -21717,7 +21718,73 @@
                 "tags": [
                     "Message"
                 ],
-                "x-internal": true
+                "x-codeSamples": [
+                    {
+                        "label": "JavaScript",
+                        "lang": "JavaScript",
+                        "source": "const response = await svix.message.precheck(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n  eventType: \"user.signup\",\n  channels: [\"project_123\", \"group_2\"],\n});"
+                    },
+                    {
+                        "label": "TypeScript",
+                        "lang": "TypeScript",
+                        "source": "const response = await svix.message.precheck(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n  eventType: \"user.signup\",\n  channels: [\"project_123\", \"group_2\"],\n});"
+                    },
+                    {
+                        "label": "Python",
+                        "lang": "Python",
+                        "source": "response = svix.message.precheck(\n    \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n    MessagePrecheckIn(\n        event_type=\"user.signup\",\n        channels=[\n            \"project_123\",\n            \"group_2\",\n        ],\n    ),\n)"
+                    },
+                    {
+                        "label": "Python (Async)",
+                        "lang": "Python (Async)",
+                        "source": "response = await svix.message.precheck(\n    \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n    MessagePrecheckIn(\n        event_type=\"user.signup\",\n        channels=[\n            \"project_123\",\n            \"group_2\",\n        ],\n    ),\n)"
+                    },
+                    {
+                        "label": "Go",
+                        "lang": "Go",
+                        "source": "response, err := svix.Message.Precheck(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\tMessagePrecheckIn{EventType: \"user.signup\", Channels: []string{\"project_123\", \"group_2\"}},\n\tnil,\n)"
+                    },
+                    {
+                        "label": "Kotlin",
+                        "lang": "Kotlin",
+                        "source": "val response =\n    svix.message.precheck(\n        \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n        MessagePrecheckIn(eventType = \"user.signup\", channels = setOf(\"project_123\", \"group_2\")),\n    )"
+                    },
+                    {
+                        "label": "Java",
+                        "lang": "Java",
+                        "source": "var response = svix.getMessage()\n        .precheck(\n            \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n            new MessagePrecheckIn()\n                .eventType(\"user.signup\")\n                .channels(Set.of(\"project_123\", \"group_2\")));"
+                    },
+                    {
+                        "label": "Ruby",
+                        "lang": "Ruby",
+                        "source": "response = svix\n  .message\n  .precheck(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {eventType: \"user.signup\", channels: [\"project_123\", \"group_2\"]})"
+                    },
+                    {
+                        "label": "Rust",
+                        "lang": "Rust",
+                        "source": "let response = svix\n    .message()\n    .precheck(\n        \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n        MessagePrecheckIn {\n            event_type: \"user.signup\".to_string(),\n            channels: Some(vec![\"project_123\".to_string(), \"group_2\".to_string()]),\n        },\n        None,\n    )\n    .await?;"
+                    },
+                    {
+                        "label": "C#",
+                        "lang": "C#",
+                        "source": "var response = svix.Message.Precheck(\n    \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n    new MessagePrecheckIn { EventType = \"user.signup\", Channels = [\"project_123\", \"group_2\"] }\n);"
+                    },
+                    {
+                        "label": "PHP",
+                        "lang": "PHP",
+                        "source": "$response = $svix->message->precheck(\n    \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n    MessagePrecheckIn::create(\n        eventType: \"user.signup\"\n    )\n    ->withChannels([\"project_123\",\"group_2\"])\n);"
+                    },
+                    {
+                        "label": "CLI",
+                        "lang": "CLI",
+                        "source": "svix message precheck \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" '{\n    \"channels\": [\n      \"project_123\",\n      \"group_2\"\n    ],\n    \"eventType\": \"user.signup\"\n  }'"
+                    },
+                    {
+                        "label": "cURL",
+                        "lang": "cURL",
+                        "source": "curl -X 'POST' \\\n  'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/msg/precheck/active' \\\n  -H 'Authorization: Bearer AUTH_TOKEN' \\\n  -H 'Accept: application/json' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\n    \"channels\": [\n      \"project_123\",\n      \"group_2\"\n    ],\n    \"eventType\": \"user.signup\"\n  }'"
+                    }
+                ]
             }
         },
         "/api/v1/app/{app_id}/msg/{msg_id}": {

csharp/Svix/Message.cs

@@ -66,6 +66,18 @@ public class MessageExpungeAllContentsOptions : SvixOptionsBase
         }
     }
 
+    public class MessagePrecheckOptions : SvixOptionsBase
+    {
+        public string? IdempotencyKey { get; set; }
+
+        public new Dictionary<string, string> HeaderParams()
+        {
+            return SerializeParams(
+                new Dictionary<string, object?> { { "idempotency-key", IdempotencyKey } }
+            );
+        }
+    }
+
     public class MessageGetOptions : SvixOptionsBase
     {
         public bool? WithContent { get; set; }
@@ -372,6 +384,80 @@ public ExpungeAllContentsOut ExpungeAllContents(
             }
         }
 
+        /// <summary>
+        /// A pre-check call for `message.create` that checks whether any active endpoints are
+        /// listening to this message.
+        ///
+        /// Note: most people shouldn't be using this API. Svix doesn't bill you for
+        /// messages not actually sent, so using this API doesn't save money.
+        /// If unsure, please ask Svix support before using this API.
+        /// </summary>
+        public async Task<MessagePrecheckOut> PrecheckAsync(
+            string appId,
+            MessagePrecheckIn messagePrecheckIn,
+            MessagePrecheckOptions? options = null,
+            CancellationToken cancellationToken = default
+        )
+        {
+            messagePrecheckIn =
+                messagePrecheckIn ?? throw new ArgumentNullException(nameof(messagePrecheckIn));
+            try
+            {
+                var response = await _client.SvixHttpClient.SendRequestAsync<MessagePrecheckOut>(
+                    method: HttpMethod.Post,
+                    path: "/api/v1/app/{app_id}/msg/precheck/active",
+                    pathParams: new Dictionary<string, string> { { "app_id", appId } },
+                    queryParams: options?.QueryParams(),
+                    headerParams: options?.HeaderParams(),
+                    content: messagePrecheckIn,
+                    cancellationToken: cancellationToken
+                );
+                return response.Data;
+            }
+            catch (ApiException e)
+            {
+                _client.Logger?.LogError(e, $"{nameof(PrecheckAsync)} failed");
+
+                throw;
+            }
+        }
+
+        /// <summary>
+        /// A pre-check call for `message.create` that checks whether any active endpoints are
+        /// listening to this message.
+        ///
+        /// Note: most people shouldn't be using this API. Svix doesn't bill you for
+        /// messages not actually sent, so using this API doesn't save money.
+        /// If unsure, please ask Svix support before using this API.
+        /// </summary>
+        public MessagePrecheckOut Precheck(
+            string appId,
+            MessagePrecheckIn messagePrecheckIn,
+            MessagePrecheckOptions? options = null
+        )
+        {
+            messagePrecheckIn =
+                messagePrecheckIn ?? throw new ArgumentNullException(nameof(messagePrecheckIn));
+            try
+            {
+                var response = _client.SvixHttpClient.SendRequest<MessagePrecheckOut>(
+                    method: HttpMethod.Post,
+                    path: "/api/v1/app/{app_id}/msg/precheck/active",
+                    pathParams: new Dictionary<string, string> { { "app_id", appId } },
+                    queryParams: options?.QueryParams(),
+                    headerParams: options?.HeaderParams(),
+                    content: messagePrecheckIn
+                );
+                return response.Data;
+            }
+            catch (ApiException e)
+            {
+                _client.Logger?.LogError(e, $"{nameof(Precheck)} failed");
+
+                throw;
+            }
+        }
+
         /// <summary>
         /// Get a message by its ID or eventID.
         /// </summary>

csharp/Svix/Models/MessagePrecheckIn.cs

@@ -0,0 +1,26 @@
+// this file is @generated
+using System.Text;
+using Newtonsoft.Json;
+
+namespace Svix.Models
+{
+    public class MessagePrecheckIn
+    {
+        [JsonProperty("channels")]
+        public List<string>? Channels { get; set; } = null;
+
+        [JsonProperty("eventType", Required = Required.Always)]
+        public required string EventType { get; set; }
+
+        public override string ToString()
+        {
+            StringBuilder sb = new StringBuilder();
+
+            sb.Append("class MessagePrecheckIn {\n");
+            sb.Append("  Channels: ").Append(Channels).Append('\n');
+            sb.Append("  EventType: ").Append(EventType).Append('\n');
+            sb.Append("}\n");
+            return sb.ToString();
+        }
+    }
+}

csharp/Svix/Models/MessagePrecheckOut.cs

@@ -0,0 +1,22 @@
+// this file is @generated
+using System.Text;
+using Newtonsoft.Json;
+
+namespace Svix.Models
+{
+    public class MessagePrecheckOut
+    {
+        [JsonProperty("active", Required = Required.Always)]
+        public required bool Active { get; set; }
+
+        public override string ToString()
+        {
+            StringBuilder sb = new StringBuilder();
+
+            sb.Append("class MessagePrecheckOut {\n");
+            sb.Append("  Active: ").Append(Active).Append('\n');
+            sb.Append("}\n");
+            return sb.ToString();
+        }
+    }
+}