Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🌿 Fern Regeneration -- Introduce v3 SDK #66

Merged
merged 1 commit into from
Jan 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .fernignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Specify files that shouldn't be modified by Fern

LICENSE
CHANGELOG.md

README.v1.md
README.v2.md
README.md
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

27 changes: 0 additions & 27 deletions .github/PULL_REQUEST_TEMPLATE.md

This file was deleted.

27 changes: 27 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: ci

on: [push]

jobs:
compile:
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v3

- name: Set up go
uses: actions/setup-go@v4

- name: Compile
run: go build ./...
test:
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v3

- name: Set up go
uses: actions/setup-go@v4

- name: Test
run: go test ./...
19 changes: 0 additions & 19 deletions .gitignore

This file was deleted.

17 changes: 16 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased][unreleased]

## [v3.0.0]
We now use :herb: [Fern](https://buildwithfern.com/) to generate our Go
SDK. WHile this releasing has breaking changes, it comes with several
quality of life upgrades:
- **Endpoint coverage**: All endpoints that are supported in our Node SDK are
now also supported in Go.
- **Resource-scoped SDK methods**: Endpoints are scoped under their resource. For
example, instead of `courier.DeleteBrands` the SDK now reads `courier.Brands.Delete(...)`
- **Docs on Hover**: All endpoint and parameter level documentation that you see
on our docs website are now embedded directly within the SDKs.
- **Strongly Typed**: The SDK now contains types for all of our modles -- including
complex unions like `ContentMessage` and `TemplateMessage`.
- **Retries with Exponential Backoffs**: The SDK now supports retries with exponential
backoff.

## [v2.12.0]

- Adds support for the cancel message endpoint (@BenAlderfer)
Expand Down Expand Up @@ -116,4 +131,4 @@ This project adheres to [Semantic Versioning](http://semver.org/).
- `GetProfile` now requires a `context` argument
- `GetProfile` now returns a `map[string]json.RawMessage{}` instead of hydrating a struct reference
- removed `MergeProfile`; use `client.API.SendRequestWithBytes(context.Background(), "PUT", "/profiles/"+recipientID, profile)` instead
- removed `UpdateProfile`; use `client.API.SendRequestWithBytes(context.Background(), "PUT", "/profiles/"+recipientID, profile)` instead
- removed `UpdateProfile`; use `client.API.SendRequestWithBytes(context.Background(), "PUT", "/profiles/"+recipientID, profile)` instead
14 changes: 0 additions & 14 deletions CONTRIBUTING.md

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
Loading
Loading