chore(internal): codegen related update

Author: stainless-app[bot]

.editorconfig

@@ -23,4 +23,4 @@ insert_final_newline = true
 
 dotnet_diagnostic.IDE0060.severity = none # Caused by resource with no methods and no subresources
 dotnet_diagnostic.IDE1006.severity = none # Some names may not match up with C# conventions
-dotnet_diagnostic.IDE0290.severity = none # Don't prefer primary constructors
+dotnet_diagnostic.IDE0290.severity = none # Don't prefer primary constructors

.github/workflows/ci.yml

@@ -29,6 +29,23 @@ jobs:
 
       - name: Run lints
         run: ./scripts/lint
+  build:
+    timeout-minutes: 10
+    name: build
+    runs-on: ${{ github.repository == 'stainless-sdks/orb-csharp' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up .NET
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: '8.0.x'
+
+      - name: Build SDK
+        run: ./scripts/build
+
   test:
     timeout-minutes: 10
     name: test

README.md

@@ -13,31 +13,37 @@ The REST API documentation can be found on [docs.withorb.com](https://docs.witho
 
 ## Installation
 
-### Dotnet
-
 ```bash
-dotnet add reference /path/to/orb-csharp/src/Orb/
+git clone git@github.com:orbcorp/orb-csharp.git
+dotnet add reference orb-csharp/src/Orb
 ```
 
+## Requirements
+
+This library requires .NET 8 or later.
+
+> [!NOTE]
+> The library is currently in **beta**. The requirements will be lowered in the future.
+
 ## Usage
 
 See the [`examples`](examples) directory for complete and runnable examples.
 
-```C#
+```csharp
+using System;
 using Orb;
 using Orb.Models.Customers;
-using System;
 
 // Configured using the ORB_API_KEY, ORB_WEBHOOK_SECRET and ORB_BASE_URL environment variables
 OrbClient client = new();
 
-CustomerCreateParams param = new()
+CustomerCreateParams parameters = new()
 {
     Email = "example-customer@withorb.com",
     Name = "My Customer",
 };
 
-var customer = await client.Customers.Create(param);
+var customer = await client.Customers.Create(parameters);
 
 Console.WriteLine(customer);
 ```
@@ -46,7 +52,7 @@ Console.WriteLine(customer);
 
 Configure the client using environment variables:
 
-```C#
+```csharp
 using Orb;
 
 // Configured using the ORB_API_KEY, ORB_WEBHOOK_SECRET and ORB_BASE_URL environment variables
@@ -55,10 +61,35 @@ OrbClient client = new();
 
 Or manually:
 
-```C#
+```csharp
 using Orb;
 
 OrbClient client = new() { APIKey = "My API Key" };
 ```
 
-Alternatively, you can use a combination of the two approaches.
+Or using a combination of the two approaches.
+
+See this table for the available options:
+
+| Property        | Environment variable | Required | Default value                  |
+| --------------- | -------------------- | -------- | ------------------------------ |
+| `APIKey`        | `ORB_API_KEY`        | true     | -                              |
+| `WebhookSecret` | `ORB_WEBHOOK_SECRET` | false    | -                              |
+| `BaseUrl`       | `ORB_BASE_URL`       | true     | `"https://api.withorb.com/v1"` |
+
+## Requests and responses
+
+To send a request to the Orb API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a C# class.
+
+For example, `client.Customers.Create` should be called with an instance of `CustomerCreateParams`, and it will return an instance of `Task<Customer>`.
+
+## Semantic versioning
+
+This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
+
+1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_
+2. Changes that we do not expect to impact the vast majority of users in practice.
+
+We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
+
+We are keen for your feedback; please open an [issue](https://www.github.com/orbcorp/orb-csharp/issues) with questions, bugs, or suggestions.

release-please-config.json

@@ -61,6 +61,11 @@
   ],
   "release-type": "simple",
   "extra-files": [
-    "README.md"
+    "README.md",
+    {
+      "type": "xml",
+      "path": "src/Orb/Orb.csproj",
+      "xpath": "//Project/PropertyGroup/VersionPrefix"
+    }
   ]
 }

scripts/mock

@@ -21,7 +21,7 @@ echo "==> Starting mock server with URL ${URL}"
 
 # Run prism mock on the given spec
 if [ "$1" == "--daemon" ]; then
-  npm exec --package=@stainless-api/prism-cli@5.8.5 -- prism mock "$URL" &> .prism.log &
+  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" &> .prism.log &
 
   # Wait for server to come online
   echo -n "Waiting for server"
@@ -37,5 +37,5 @@ if [ "$1" == "--daemon" ]; then
 
   echo
 else
-  npm exec --package=@stainless-api/prism-cli@5.8.5 -- prism mock "$URL"
+  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL"
 fi

scripts/test

@@ -43,7 +43,7 @@ elif ! prism_is_running ; then
   echo -e "To run the server, pass in the path or url of your OpenAPI"
   echo -e "spec to the prism command:"
   echo
-  echo -e "  \$ ${YELLOW}npm exec --package=@stoplight/prism-cli@~5.3.2 -- prism mock path/to/your.openapi.yml${NC}"
+  echo -e "  \$ ${YELLOW}npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock path/to/your.openapi.yml${NC}"
   echo
 
   exit 1

src/Orb.Tests/Orb.Tests.csproj

@@ -4,6 +4,8 @@
     <IsPackable>false</IsPackable>
     <IsTestProject>true</IsTestProject>
     <ImplicitUsings>disable</ImplicitUsings>
+    <!-- Disable skipped tests warnings -->
+    <NoWarn>$(NoWarn),xUnit1004</NoWarn>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="coverlet.collector" Version="6.0.0" />

src/Orb.Tests/Services/Alerts/AlertServiceTest.cs

@@ -1,6 +1,5 @@
-using System;
 using System.Threading.Tasks;
-using AlertCreateForCustomerParamsProperties = Orb.Models.Alerts.AlertCreateForCustomerParamsProperties;
+using Orb.Models.Alerts.AlertCreateForCustomerParamsProperties;
 using AlertCreateForExternalCustomerParamsProperties = Orb.Models.Alerts.AlertCreateForExternalCustomerParamsProperties;
 using AlertCreateForSubscriptionParamsProperties = Orb.Models.Alerts.AlertCreateForSubscriptionParamsProperties;
 
@@ -24,23 +23,10 @@ public async Task Update_Works()
         alert.Validate();
     }
 
-    [Fact]
+    [Fact(Skip = "plan_version=0 breaks Prism")]
     public async Task List_Works()
     {
-        var page = await this.client.Alerts.List(
-            new()
-            {
-                CreatedAtGt = DateTime.Parse("2019-12-27T18:11:19.117Z"),
-                CreatedAtGte = DateTime.Parse("2019-12-27T18:11:19.117Z"),
-                CreatedAtLt = DateTime.Parse("2019-12-27T18:11:19.117Z"),
-                CreatedAtLte = DateTime.Parse("2019-12-27T18:11:19.117Z"),
-                Cursor = "cursor",
-                CustomerID = "customer_id",
-                ExternalCustomerID = "external_customer_id",
-                Limit = 1,
-                SubscriptionID = "subscription_id",
-            }
-        );
+        var page = await this.client.Alerts.List();
         page.Validate();
     }
 
@@ -52,8 +38,7 @@ public async Task CreateForCustomer_Works()
             {
                 CustomerID = "customer_id",
                 Currency = "currency",
-                Type = AlertCreateForCustomerParamsProperties::Type.CreditBalanceDepleted,
-                Thresholds = [new(0)],
+                Type = Type.CreditBalanceDepleted,
             }
         );
         alert.Validate();
@@ -68,7 +53,6 @@ public async Task CreateForExternalCustomer_Works()
                 ExternalCustomerID = "external_customer_id",
                 Currency = "currency",
                 Type = AlertCreateForExternalCustomerParamsProperties::Type.CreditBalanceDepleted,
-                Thresholds = [new(0)],
             }
         );
         alert.Validate();
@@ -83,7 +67,6 @@ public async Task CreateForSubscription_Works()
                 SubscriptionID = "subscription_id",
                 Thresholds = [new(0)],
                 Type = AlertCreateForSubscriptionParamsProperties::Type.UsageExceeded,
-                MetricID = "metric_id",
             }
         );
         alert.Validate();
@@ -93,11 +76,7 @@ public async Task CreateForSubscription_Works()
     public async Task Disable_Works()
     {
         var alert = await this.client.Alerts.Disable(
-            new()
-            {
-                AlertConfigurationID = "alert_configuration_id",
-                SubscriptionID = "subscription_id",
-            }
+            new() { AlertConfigurationID = "alert_configuration_id" }
         );
         alert.Validate();
     }
@@ -106,11 +85,7 @@ public async Task Disable_Works()
     public async Task Enable_Works()
     {
         var alert = await this.client.Alerts.Enable(
-            new()
-            {
-                AlertConfigurationID = "alert_configuration_id",
-                SubscriptionID = "subscription_id",
-            }
+            new() { AlertConfigurationID = "alert_configuration_id" }
         );
         alert.Validate();
     }