Skip to content
Open
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
2 changes: 1 addition & 1 deletion .github/workflows/release-typescript.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
fern generate --group ts-sdk --version ${{ inputs.version }} --api 2025-02-24 --log-level debug

- name: Update Code Snippets
env:
FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
Expand Down
53 changes: 53 additions & 0 deletions fern/apis/2025-02-24/openapi-overrides.yml
Original file line number Diff line number Diff line change
Expand Up @@ -160,3 +160,56 @@ paths:
x-fern-sdk-group-name:
- inboundTransfers
x-fern-sdk-method-name: cancel
/v1/donor_accounts:
get:
x-fern-pagination:
cursor: $request.pageToken
next_cursor: $response.next_page_token
results: $response.items
x-fern-sdk-group-name:
- donorAccounts
x-fern-sdk-method-name: list
/v1/donor_accounts/{id}:
get:
x-fern-sdk-group-name:
- donorAccounts
x-fern-sdk-method-name: get
/v1/donor_accounts/{id}/approve:
post:
x-fern-sdk-group-name:
- donorAccounts
x-fern-sdk-method-name: approve
/v1/donor_accounts/{id}/reject:
post:
x-fern-sdk-group-name:
- donorAccounts
x-fern-sdk-method-name: reject
/v1/donor_accounts/{id}/close:
post:
x-fern-sdk-group-name:
- donorAccounts
x-fern-sdk-method-name: close
/v1/grant_requests:
get:
x-fern-pagination:
cursor: $request.pageToken
next_cursor: $response.next_page_token
results: $response.items
x-fern-sdk-group-name:
- grantRequests
x-fern-sdk-method-name: list
/v1/grant_requests/{id}:
get:
x-fern-sdk-group-name:
- grantRequests
x-fern-sdk-method-name: get
/v1/grant_requests/{id}/approve:
post:
x-fern-sdk-group-name:
- grantRequests
x-fern-sdk-method-name: approve
/v1/grant_requests/{id}/reject:
post:
x-fern-sdk-group-name:
- grantRequests
x-fern-sdk-method-name: reject
3 changes: 3 additions & 0 deletions fern/apis/api/definition/api.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
name: api
error-discrimination:
strategy: status-code
60 changes: 60 additions & 0 deletions fern/apis/api/definition/imdb.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/fern-api/fern/main/fern.schema.json

service:
auth: false
base-path: /movies
endpoints:
createMovie:
docs: Add a movie to the database
method: POST
path: /create-movie
request: CreateMovieRequest
response: MovieId

getMovie:
docs: Retrieve a movie from the database based on the ID
method: GET
path: /{id}
path-parameters:
id: MovieId
response: Movie
errors:
- MovieDoesNotExistError
examples:
# Success response
- path-parameters:
id: tt0111161
response:
body:
id: tt0111161
title: The Shawshank Redemption
rating: 9.3
# Error response
- path-parameters:
id: tt1234
response:
error: MovieDoesNotExistError
body: tt1234

types:
MovieId:
type: string
docs: The unique identifier for a Movie in the database

Movie:
properties:
id: MovieId
title: string
rating:
type: double
docs: The rating scale out of ten stars

CreateMovieRequest:
properties:
title: string
rating: double

errors:
MovieDoesNotExistError:
status-code: 404
type: MovieId
10 changes: 10 additions & 0 deletions fern/apis/api/generators.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
default-group: local
groups:
local:
generators:
- name: fernapi/fern-typescript-node-sdk
version: 3.33.0
output:
location: local-file-system
path: ../sdks/typescript
4 changes: 2 additions & 2 deletions fern/fern.config.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"organization": "chariot",
"version": "0.56.6"
}
"version": "2.0.3"
}
128 changes: 77 additions & 51 deletions fern/versions/v2025-02-24/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,60 +25,78 @@ navigation:
- page: Navigating the Docs
slug: getting-started/navigating-the-docs
path: ./pages/getting-started/navigating-the-docs.mdx
- section: DAFpay
slug: dafpay
- section: For Fundraisers
slug: for-fundraisers
contents:
- page: Overview
slug: overview
path: ./pages/integrating-dafpay/overview.mdx
- section: Integrating DAFpay
slug: integrating-dafpay
- section: DAFpay
slug: dafpay
contents:
- page: Checklist
slug: checklist
path: ./pages/integrating-dafpay/checklist.mdx
- page: Set Up
slug: set-up
path: ./pages/integrating-dafpay/set-up.mdx
- page: Installing Connect
slug: installation
path: ./pages/integrating-dafpay/installation.mdx
- page: Integrating Connect
slug: integration
path: ./pages/integrating-dafpay/integration.mdx
- page: Transaction Management
slug: transactions
path: ./pages/integrating-dafpay/transactions.mdx
- page: Production API Keys
slug: prod-keys
path: ./pages/integrating-dafpay/prod-keys.mdx
- page: FAQ
slug: faq
path: ./pages/integrating-dafpay/faq.mdx
- section: Disbursements
slug: disbursements
- page: Overview
slug: overview
path: ./pages/integrating-dafpay/overview.mdx
- section: Integrating DAFpay
slug: integrating-dafpay
contents:
- page: Checklist
slug: checklist
path: ./pages/integrating-dafpay/checklist.mdx
- page: Set Up
slug: set-up
path: ./pages/integrating-dafpay/set-up.mdx
- page: Installing Connect
slug: installation
path: ./pages/integrating-dafpay/installation.mdx
- page: Integrating Connect
slug: integration
path: ./pages/integrating-dafpay/integration.mdx
- page: Transaction Management
slug: transactions
path: ./pages/integrating-dafpay/transactions.mdx
- page: Production API Keys
slug: prod-keys
path: ./pages/integrating-dafpay/prod-keys.mdx
- page: FAQ
slug: faq
path: ./pages/integrating-dafpay/faq.mdx
- section: For Grantmakers
slug: for-grantmakers
contents:
- page: Overview
slug: /
path: ./pages/disbursements/overview.mdx
- page: How It Works
slug: how-it-works
path: ./pages/disbursements/how-it-works.mdx
- page: Disbursement Lifecycle
slug: disbursement-lifecycle
path: ./pages/disbursements/disbursement-lifecycle.mdx
- page: Compliance
slug: compliance
path: ./pages/disbursements/compliance.mdx
- page: Sandbox
slug: sandbox
path: ./pages/disbursements/sandbox.mdx
- page: How Chariot Compares
slug: comparisons
path: ./pages/disbursements/how-chariot-compares.mdx
- page: FAQ
slug: faq
path: ./pages/disbursements/faq.mdx
- section: Disbursements
slug: disbursements
contents:
- page: Overview
slug: /
path: ./pages/disbursements/overview.mdx
- page: How It Works
slug: how-it-works
path: ./pages/disbursements/how-it-works.mdx
- page: Disbursement Lifecycle
slug: disbursement-lifecycle
path: ./pages/disbursements/disbursement-lifecycle.mdx
- page: Compliance
slug: compliance
path: ./pages/disbursements/compliance.mdx
- page: Sandbox
slug: sandbox
path: ./pages/disbursements/sandbox.mdx
- page: How Chariot Compares
slug: comparisons
path: ./pages/disbursements/how-chariot-compares.mdx
- page: FAQ
slug: faq
path: ./pages/disbursements/faq.mdx
- section: Donor Accounts
slug: donor-accounts
contents:
- page: Overview
slug: /
path: ./pages/donor-accounts/overview.mdx
- page: How It Works
slug: how-it-works
path: ./pages/donor-accounts/how-it-works.mdx
- page: FAQ
slug: faq
path: ./pages/donor-accounts/faq.mdx
- tab: api
layout:
- api: API Reference
Expand Down Expand Up @@ -143,4 +161,12 @@ navigation:
- inboundTransfers:
title: Inbound Transfers
- disbursements
- section: Donor Accounts
skip-slug: true
icon: user-plus
contents:
- donorAccounts:
title: Donor Accounts
- grantRequests:
title: Grant Requests
- tab: changelog
4 changes: 2 additions & 2 deletions fern/versions/v2025-02-24/pages/api/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ For faster support, include the request_id when contacting support regarding a s

### Not a Developer?

Check out our [Implementation Guide](/guides/dafpay/implementation) for a high-level overview of how to integrate Chariot into your website.
Check out our [Implementation Guide](/guides/for-fundraisers/dafpay) for a high-level overview of how to integrate Chariot into your website.

```curl Base URL
https://api.givechariot.com
Expand All @@ -56,5 +56,5 @@ All activity in the Production environment is real.
Production API requests should be to `https://api.givechariot.com` and sandbox requests should be to `https://sandboxapi.givechariot.com`.

When you’re getting ready to launch into production, please let us know by emailing [support@givechariot.com](mailto:support@givechariot.com) to get your production credentials.
We strongly encourage you to read through the [Implementation Guide](/guides/dafpay/implementation) to understand best practices for creating
We strongly encourage you to read through the [Implementation Guide](/guides/for-fundraisers/dafpay) to understand best practices for creating
a successful DAFpay integration with Chariot.
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ updatedAt: "Wed May 01 2024 21:30:05 GMT+0000 (Coordinated Universal Time)"
</Card>
</CardGroup>

To get started with Chariot Disbursements<span title="Chariot is a financial technology company, not a bank. Chariot Accounts come with a Demand Deposit Account through our banking services partner, Column N.A., Member FDIC. Deposits in Chariot Accounts are eligible for FDIC insurance up to $250,000 per depositor, for each insurable capacity in which the account is held."><sup><Icon icon="fa-regular fa-circle-info" size="2.5"/></sup></span>, you’ll need to register for an account with Chariot, open a Chariot Deposit Account, and go through the onboarding processes for both.
To get started with Chariot Disbursements<span title="Chariot is a financial technology company, not a bank. Chariot Accounts come with a Demand Deposit Account through our banking services partner, Column N.A., Member FDIC. Deposits in Chariot Accounts are eligible for FDIC insurance up to $250,000 per depositor, for each insurable capacity in which the account is held."><sup><Icon icon="fa-regular fa-circle-info" size="2.5"/></sup></span>, you’ll need to register for an account with Chariot, open a Chariot Deposit Account, and go through the onboarding processes for both.

After you are approved and verified, you'll be given access to a dashboard where you will be able to manage and create `API Keys`.

Expand Down Expand Up @@ -67,7 +67,7 @@ and then creating a `Transaction` with the `attachment_file_id` field populated.
Once you receive a successful response, Chariot will use the funds in your account to push a payment to the organization.
You can call the [GET Disbursement](/api/disbursements/get) endpoint to see the status of the submission.

To learn more about how to handle errors, please refer to the [FAQ](/guides/disbursements/faq).
To learn more about how to handle errors, please refer to the [FAQ](/guides/for-grantmakers/disbursements/faq).


</Steps>
Expand Down
8 changes: 4 additions & 4 deletions fern/versions/v2025-02-24/pages/disbursements/sandbox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ If you have a sandbox Event Subscription configured, calling these APIs will als

## Sandbox Lifecycle

To adequately test the various [disbursement payment rails](/guides/disbursements/disbursement-lifecycle#payment-rail-lifecycle) (Account, ACH, Check),
To adequately test the various [disbursement payment rails](/guides/for-grantmakers/disbursements/disbursement-lifecycle#payment-rail-lifecycle) (Account, ACH, Check),
you'll need to make use of a fixed set of test nonprofit Organizations that have been pre-configured in the Sandbox environment.

The following Organizations will allow you test the various disbursement payment rails:

| EIN | Transfer Type |
| --- | ------------ |
| 752456162 | [Account transfer](/guides/disbursements/disbursement-lifecycle#account-transfer) |
| 861649851 | [ACH transfer](/guides/disbursements/disbursement-lifecycle#ach) |
| 132555281 | [Check transfer](/guides/disbursements/disbursement-lifecycle#mailed-check) |
| 752456162 | [Account transfer](/guides/for-grantmakers/disbursements/disbursement-lifecycle#account-transfer) |
| 861649851 | [ACH transfer](/guides/for-grantmakers/disbursements/disbursement-lifecycle#ach) |
| 132555281 | [Check transfer](/guides/for-grantmakers/disbursements/disbursement-lifecycle#mailed-check) |
Loading