release: 6.4.0-alpha0

.github/workflows/publish-pypi.yml

@@ -0,0 +1,31 @@
+# This workflow is triggered when a GitHub release is created.
+# It can also be run manually to re-publish to PyPI in case it failed for some reason.
+# You can run this workflow by navigating to https://www.github.com/trycourier/courier-python/actions/workflows/publish-pypi.yml
+name: Publish PyPI
+on:
+  workflow_dispatch:
+
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    name: publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rye
+        run: |
+          curl -sSf https://rye.astral.sh/get | bash
+          echo "$HOME/.rye/shims" >> $GITHUB_PATH
+        env:
+          RYE_VERSION: '0.44.0'
+          RYE_INSTALL_OPTION: '--yes'
+
+      - name: Publish to PyPI
+        run: |
+          bash ./bin/publish-pypi
+        env:
+          PYPI_TOKEN: ${{ secrets.COURIER_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.github/workflows/release-doctor.yml

@@ -0,0 +1,21 @@
+name: Release Doctor
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  release_doctor:
+    name: release doctor
+    runs-on: ubuntu-latest
+    if: github.repository == 'trycourier/courier-python' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check release environment
+        run: |
+          bash ./bin/check-release-environment
+        env:
+          PYPI_TOKEN: ${{ secrets.COURIER_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "6.4.0-alpha0"
+}

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 75
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/courier%2Fcourier-9edfa04d0cd081138f4834ed9b8d45403d7ee75a5f02f8eecc8e45575df21bb8.yml
 openapi_spec_hash: 195e8cd1061046ffc3009f50262d92b2
-config_hash: b55b2c9e5e02889f4d064330de42fa3e
+config_hash: e7f646e730e7b27205b2bd6a6dc3e572

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## 6.4.0-alpha0 (2025-10-02)
+
+Full Changelog: [v0.0.1...v6.4.0-alpha0](https://github.com/trycourier/courier-python/compare/v0.0.1...v6.4.0-alpha0)
+
+### Features
+
+* **api:** manual updates ([2e6a07a](https://github.com/trycourier/courier-python/commit/2e6a07ab17a63673de30d2dd088a492e1ecf5073))
+* **api:** manual updates ([51a28ef](https://github.com/trycourier/courier-python/commit/51a28efc4e1d20328556ae691fe4a768bbb277b4))
+* **api:** manual updates ([b16bac2](https://github.com/trycourier/courier-python/commit/b16bac2553d106e3ddc040bdfe3beac79f8c0408))
+* **api:** manual updates ([cd9ed1b](https://github.com/trycourier/courier-python/commit/cd9ed1b563215b6896734669bd041c091f0db29a))
+
+
+### Chores
+
+* configure new SDK language ([f004f07](https://github.com/trycourier/courier-python/commit/f004f07aabba46f78d7834c62b4ef1ce4ec11759))
+* **internal:** codegen related update ([6fb395b](https://github.com/trycourier/courier-python/commit/6fb395bb3062bb749130c8f6345fbfcd693d2584))
+* update SDK settings ([3317d9e](https://github.com/trycourier/courier-python/commit/3317d9ec8f294d05ddd89e3b2e7f5da9a8716127))
+* update SDK settings ([2677204](https://github.com/trycourier/courier-python/commit/2677204576bea283de2c5f7e17cad008a0ca497b))

CONTRIBUTING.md

@@ -62,7 +62,7 @@ If you’d like to use the repository from source, you can either install from g
 To install via git:
 
 ```sh
-$ pip install git+ssh://git@github.com/stainless-sdks/courier-python.git
+$ pip install git+ssh://git@github.com/trycourier/courier-python.git
 ```
 
 Alternatively, you can build from source and install the wheel file:
@@ -120,7 +120,7 @@ the changes aren't made through the automated pipeline, you may want to make rel
 
 ### Publish with a GitHub workflow
 
-You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/stainless-sdks/courier-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
+You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/trycourier/courier-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
 
 ### Publish manually
 

README.md

@@ -16,13 +16,10 @@ The full API of this library can be found in [api.md](api.md).
 ## Installation
 
 ```sh
-# install from this staging repo
-pip install git+ssh://git@github.com/stainless-sdks/courier-python.git
+# install from PyPI
+pip install --pre courier
 ```
 
-> [!NOTE]
-> Once this package is [published to PyPI](https://www.stainless.com/docs/guides/publish), this will become: `pip install courier`
-
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
@@ -35,12 +32,11 @@ client = Courier(
     api_key=os.environ.get("COURIER_API_KEY"),  # This is the default and can be omitted
 )
 
-response = client.send.send_message(
+response = client.send.message(
     message={
-        "content": {
-            "elements": [{}],
-            "version": "version",
-        }
+        "to": {"user_id": "your_user_id"},
+        "template": "your_template",
+        "data": {"foo": "bar"},
     },
 )
 print(response.request_id)
@@ -66,12 +62,11 @@ client = AsyncCourier(
 
 
 async def main() -> None:
-    response = await client.send.send_message(
+    response = await client.send.message(
         message={
-            "content": {
-                "elements": [{}],
-                "version": "version",
-            }
+            "to": {"user_id": "your_user_id"},
+            "template": "your_template",
+            "data": {"foo": "bar"},
         },
     )
     print(response.request_id)
@@ -89,8 +84,8 @@ By default, the async client uses `httpx` for HTTP requests. However, for improv
 You can enable this by installing `aiohttp`:
 
 ```sh
-# install from this staging repo
-pip install 'courier[aiohttp] @ git+ssh://git@github.com/stainless-sdks/courier-python.git'
+# install from PyPI
+pip install --pre courier[aiohttp]
 ```
 
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
@@ -106,12 +101,11 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        response = await client.send.send_message(
+        response = await client.send.message(
             message={
-                "content": {
-                    "elements": [{}],
-                    "version": "version",
-                }
+                "to": {"user_id": "your_user_id"},
+                "template": "your_template",
+                "data": {"foo": "bar"},
             },
         )
         print(response.request_id)
@@ -167,12 +161,11 @@ from courier import Courier
 client = Courier()
 
 try:
-    client.send.send_message(
+    client.send.message(
         message={
-            "content": {
-                "elements": [{}],
-                "version": "version",
-            }
+            "to": {"user_id": "your_user_id"},
+            "template": "your_template",
+            "data": {"foo": "bar"},
         },
     )
 except courier.APIConnectionError as e:
@@ -217,12 +210,11 @@ client = Courier(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).send.send_message(
+client.with_options(max_retries=5).send.message(
     message={
-        "content": {
-            "elements": [{}],
-            "version": "version",
-        }
+        "to": {"user_id": "your_user_id"},
+        "template": "your_template",
+        "data": {"foo": "bar"},
     },
 )
 ```
@@ -247,12 +239,11 @@ client = Courier(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).send.send_message(
+client.with_options(timeout=5.0).send.message(
     message={
-        "content": {
-            "elements": [{}],
-            "version": "version",
-        }
+        "to": {"user_id": "your_user_id"},
+        "template": "your_template",
+        "data": {"foo": "bar"},
     },
 )
 ```
@@ -295,23 +286,26 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from courier import Courier
 
 client = Courier()
-response = client.send.with_raw_response.send_message(
+response = client.send.with_raw_response.message(
     message={
-        "content": {
-            "elements": [{}],
-            "version": "version",
-        }
+        "to": {
+            "user_id": "your_user_id"
+        },
+        "template": "your_template",
+        "data": {
+            "foo": "bar"
+        },
     },
 )
 print(response.headers.get('X-My-Header'))
 
-send = response.parse()  # get the object that `send.send_message()` would have returned
+send = response.parse()  # get the object that `send.message()` would have returned
 print(send.request_id)
 ```
 
-These methods return an [`APIResponse`](https://github.com/stainless-sdks/courier-python/tree/main/src/courier/_response.py) object.
+These methods return an [`APIResponse`](https://github.com/trycourier/courier-python/tree/main/src/courier/_response.py) object.
 
-The async client returns an [`AsyncAPIResponse`](https://github.com/stainless-sdks/courier-python/tree/main/src/courier/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
+The async client returns an [`AsyncAPIResponse`](https://github.com/trycourier/courier-python/tree/main/src/courier/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
 
 #### `.with_streaming_response`
 
@@ -320,12 +314,11 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.send.with_streaming_response.send_message(
+with client.send.with_streaming_response.message(
     message={
-        "content": {
-            "elements": [{}],
-            "version": "version",
-        }
+        "to": {"user_id": "your_user_id"},
+        "template": "your_template",
+        "data": {"foo": "bar"},
     },
 ) as response:
     print(response.headers.get("X-My-Header"))
@@ -422,7 +415,7 @@ This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) con
 
 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/stainless-sdks/courier-python/issues) with questions, bugs, or suggestions.
+We are keen for your feedback; please open an [issue](https://www.github.com/trycourier/courier-python/issues) with questions, bugs, or suggestions.
 
 ### Determining the installed version
 

api.md

@@ -17,13 +17,13 @@ from courier.types import (
     RoutingMethod,
     SlackBaseProperties,
     Utm,
-    SendSendMessageResponse,
+    SendMessageResponse,
 )
 ```
 
 Methods:
 
-- <code title="post /send">client.send.<a href="./src/courier/resources/send.py">send_message</a>(\*\*<a href="src/courier/types/send_send_message_params.py">params</a>) -> <a href="./src/courier/types/send_send_message_response.py">SendSendMessageResponse</a></code>
+- <code title="post /send">client.send.<a href="./src/courier/resources/send.py">message</a>(\*\*<a href="src/courier/types/send_message_params.py">params</a>) -> <a href="./src/courier/types/send_message_response.py">SendMessageResponse</a></code>
 
 # Audiences
 

bin/check-release-environment

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+errors=()
+
+if [ -z "${PYPI_TOKEN}" ]; then
+  errors+=("The PYPI_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets.")
+fi
+
+lenErrors=${#errors[@]}
+
+if [[ lenErrors -gt 0 ]]; then
+  echo -e "Found the following errors in the release environment:\n"
+
+  for error in "${errors[@]}"; do
+    echo -e "- $error\n"
+  done
+
+  exit 1
+fi
+
+echo "The environment is ready to push releases!"

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "courier"
-version = "0.0.1"
+version = "6.4.0-alpha0"
 description = "The official Python library for the courier API"
 dynamic = ["readme"]
 license = "Apache-2.0"
@@ -35,8 +35,8 @@ classifiers = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/stainless-sdks/courier-python"
-Repository = "https://github.com/stainless-sdks/courier-python"
+Homepage = "https://github.com/trycourier/courier-python"
+Repository = "https://github.com/trycourier/courier-python"
 
 [project.optional-dependencies]
 aiohttp = ["aiohttp", "httpx_aiohttp>=0.1.8"]
@@ -124,7 +124,7 @@ path = "README.md"
 [[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
 # replace relative links with absolute links
 pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)'
-replacement = '[\1](https://github.com/stainless-sdks/courier-python/tree/main/\g<2>)'
+replacement = '[\1](https://github.com/trycourier/courier-python/tree/main/\g<2>)'
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]