Skip to content

Commit 188b641

Browse files
authored
Merge pull request #415 from codatio/library-update
Automated PR created by OAS bot
2 parents 6978b14 + a82ca0a commit 188b641

File tree

14 files changed

+36
-29
lines changed

14 files changed

+36
-29
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,38 @@
1-
<div align="center">
1+
<div align="center">
22
<picture>
33
<source srcset="https://user-images.githubusercontent.com/6267663/221800355-0995e4ad-a386-4943-a4c2-e620341a5155.svg" media="(prefers-color-scheme: dark)">
44
<img src="https://user-images.githubusercontent.com/6267663/221800359-b7f7776c-a44f-4384-8dd0-d9f7d5caef7d.svg">
55
</picture>
66
<h1>Codat Python</h1>
7-
<p><strong>The universal API for small business data</strong></p>
8-
<p>Codat solves the connectivity challenge for developers building the next generation of financial products for small businesses. We're experts in how your application interacts with the other software your customer use, so you can focus on what makes you superior.</p>
7+
<p><strong>The API for lending and embedded accounting automation</strong></p>
8+
<p>Codat makes it quicker and easier to build fintech products, like corporate cards, business dashboards, or SMB lending applications, that are integrated with the other systems small businesses use.</p>
99
<a href="https://docs.codat.io/using-the-api/overview"><img src="https://img.shields.io/static/v1?label=Docs&message=API Ref&color=4c2cec&style=for-the-badge" /></a>
1010
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" /></a>
1111
</div>
1212

1313
> **Beta Release**
14-
>
14+
>
1515
> Exciting news! Our first Python library beta release is here, simplifying your development workflow with an effortless build process.
1616
1717
## Authentication
1818

19-
Codat uses API keys to control access to the API.
19+
Codat uses API keys to control access to the API.
20+
Learn more about authentication and managing API keys [here](https://docs.codat.io/using-the-api/authentication).
2021

21-
You must keep the API key secret, so make sure it isn't available in publicly accessible areas, such as GitHub and client-side code. Codat recommends the API key is only inserted at release time, and the number of people at your organization with access to your API key is minimised.
22+
You must keep the API key secret, so make sure it isn't available in publicly accessible areas, such as GitHub and client-side code.
23+
Codat recommends the API key is only inserted at release time, and the number of people at your organization with access to your API key is minimised.
2224

2325
Codat expects the API key to be included in all API requests to the server, Base64 encoded within an 'Authorization' header.
2426

2527
```bash
26-
Authorization: Basic YOUR_ENCODED_API_KEY
28+
Authorization: Basic BASE_64_ENCODED(API_KEY)
2729
```
2830

2931
### Getting your Authorization Header
3032

31-
To get your authorization header from the Codat Portal:
33+
To get your authorization header from the [Codat Portal](https://app.codat.io):
3234

33-
1. In the navigation bar, click **Developers > API keys**.
35+
1. In the navigation bar, click [**Developers > API keys**](https://app.codat.io/developers/api-keys).
3436
2. In the **API Keys** section, copy your authorization header rather than the API key itself.
3537

3638
## Client Libraries
@@ -45,6 +47,7 @@ To get your authorization header from the Codat Portal:
4547
| **[Lending](https://github.com/codatio/client-sdk-python/tree/main/lending)** | Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features. | [codat-lending](https://pypi.org/project/codat-lending) |
4648
| **[Sync for Payroll](https://github.com/codatio/client-sdk-python/tree/main/sync-for-payroll)** | Push payroll to accounting platforms. | [codat-sync-for-payroll](https://pypi.org/project/codat-sync-for-payroll) |
4749
| **[Sync for Payables](https://github.com/codatio/client-sdk-python/tree/main/sync-for-payables)** | Streamline your customers' accounts payable workflow. | [codat-sync-for-payables](https://pypi.org/project/codat-sync-for-payables) |
50+
4851
### Previous products and versions
4952

5053
| Library | Description | PyPI |

bank-feeds/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Bank Feeds
22

33
<!-- Start Codat Library Description -->
4-
<!-- End Codat Library Description -->
54
Bank Feeds API enables your SMB users to set up bank feeds from accounts in your application to supported accounting platforms.
5+
<!-- End Codat Library Description -->
66

77
<!-- Start SDK Installation -->
88
## SDK Installation

bank-feeds/gen.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ features:
2020
python:
2121
version: 3.1.0
2222
author: Codat
23-
description: Set up bank feeds from accounts in your application to supported accounting platforms.
23+
description: Set up bank feeds from accounts in your application to supported accounting
24+
platforms.
2425
maxMethodParams: 0
2526
packageName: codat-bankfeeds

lending/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Lending
22

33
<!-- Start Codat Library Description -->
4-
<!-- End Codat Library Description -->
54
Lending helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from the operating systems they are already using. You can use that data for automating decisioning and surfacing new insights on the customer, all via one API.
5+
<!-- End Codat Library Description -->
66

77
<!-- Start SDK Installation -->
88
## SDK Installation

lending/gen.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ features:
2121
python:
2222
version: 4.2.0
2323
author: Codat
24-
description: Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features.
24+
description: Make credit decisions backed by enhanced financials, metrics, reports,
25+
and data integrity features.
2526
maxMethodParams: 0
2627
packageName: codat-lending

platform/gen.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ features:
2020
python:
2121
version: 1.1.0
2222
author: Codat
23-
description: Manage the building blocks of Codat, including companies, connections, and more.
23+
description: Manage the building blocks of Codat, including companies, connections,
24+
and more.
2425
maxMethodParams: 0
2526
packageName: codat-platform

previous-versions/accounting/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Accounting
22

33
<!-- Start Codat Library Description -->
4-
<!-- End Codat Library Description -->
54
Codat's Accounting API is a flexible API for pulling and pushing up-to-date accounting data to your customer's accounting software.
65
It gives you a simple way to view, create, update adn delete data without having to worry about each platform's specific complexities.
6+
<!-- End Codat Library Description -->
77

88

99
<!-- Start SDK Installation -->
@@ -247,4 +247,4 @@ if res.account_transaction is not None:
247247
* [list](docs/sdks/transfers/README.md#list) - List transfers
248248
* [upload_attachment](docs/sdks/transfers/README.md#upload_attachment) - Push invoice attachment
249249
<!-- End SDK Available Operations -->
250-
### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
250+
### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

previous-versions/banking/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Banking
22

33
<!-- Start Codat Library Description -->
4-
<!-- End Codat Library Description -->
54
Use Codat's API to connect to your SMB customer's banks and pull up-to-date standardized account and transaction data from their bank accounts via our partner providers.
5+
<!-- End Codat Library Description -->
66

77
<!-- Start SDK Installation -->
88
## SDK Installation

previous-versions/commerce/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# Commerce API
1+
# Commerce
22

33
<!-- Start Codat Library Description -->
4+
Codat's Commerce API enables you to pull up-date-date commerce data from several leading payments, point-of-sale, and eCommerce systems.
5+
You can view your SMB customers' products, orders, payments, payouts, disputes, and more - all standardized to our Commerce data model.
46
<!-- End Codat Library Description -->
57

68
<!-- Start SDK Installation -->
@@ -15,4 +17,4 @@ replace me
1517
<!-- Start SDK Available Operations -->
1618
replace me
1719
<!-- End SDK Available Operations -->
18-
### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
20+
### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

previous-versions/sync-for-commerce-version-1/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Sync for Commerce version 1
22

33
<!-- Start Codat Library Description -->
4-
<!-- End Codat Library Description -->
54
Embedded accounting integrations for POS and eCommerce platforms.
5+
<!-- End Codat Library Description -->
66

77
<!-- Start SDK Installation -->
88
## SDK Installation

0 commit comments

Comments
 (0)