Skip to content

Commit dbcfabd

Browse files
authored
Merge pull request #93 from codatio/speakeasy-sdk-regen-1682409468
chore: speakeasy sdk regeneration - Generate Commerce SDK
2 parents be5223a + 6779141 commit dbcfabd

40 files changed

+595
-589
lines changed

commerce/README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ pip install codat-commerce
1515
<!-- Start SDK Example Usage -->
1616
```python
1717
import codatcommerce
18-
from codatcommerce.models import operations, shared
18+
from codatcommerce.models import operations
1919

2020
s = codatcommerce.CodatCommerce(
2121
security=shared.Security(
@@ -28,8 +28,8 @@ req = operations.GetCompanyInfoRequest(
2828
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
2929
connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
3030
)
31-
32-
res = s.company_info.get_company_info(req)
31+
32+
res = s.company_info.get(req)
3333

3434
if res.company_info is not None:
3535
# handle response
@@ -40,43 +40,43 @@ if res.company_info is not None:
4040
## Available Resources and Operations
4141

4242

43-
### company_info
43+
### [company_info](docs/companyinfo/README.md)
4444

45-
* `get_company_info` - Get company info
45+
* [get](docs/companyinfo/README.md#get) - Get company info
4646

47-
### customers
47+
### [customers](docs/customers/README.md)
4848

49-
* `list_customers` - List customers
49+
* [list](docs/customers/README.md#list) - List customers
5050

51-
### disputes
51+
### [disputes](docs/disputes/README.md)
5252

53-
* `list_disputes` - List disputes
53+
* [list](docs/disputes/README.md#list) - List disputes
5454

55-
### locations
55+
### [locations](docs/locations/README.md)
5656

57-
* `list_locations` - List locations
57+
* [list](docs/locations/README.md#list) - List locations
5858

59-
### orders
59+
### [orders](docs/orders/README.md)
6060

61-
* `list_orders` - List orders
61+
* [list](docs/orders/README.md#list) - List orders
6262

63-
### payments
63+
### [payments](docs/payments/README.md)
6464

65-
* `list_payment_methods` - List payment methods
66-
* `list_payments` - List payments
65+
* [list](docs/payments/README.md#list) - List payments
66+
* [list_methods](docs/payments/README.md#list_methods) - List payment methods
6767

68-
### products
68+
### [products](docs/products/README.md)
6969

70-
* `list_product_categories` - List product categories
71-
* `list_products` - List products
70+
* [list](docs/products/README.md#list) - List products
71+
* [list_categories](docs/products/README.md#list_categories) - List product categories
7272

73-
### tax_components
73+
### [tax_components](docs/taxcomponents/README.md)
7474

75-
* `get_tax_components` - List tax components
75+
* [get](docs/taxcomponents/README.md#get) - List tax components
7676

77-
### transactions
77+
### [transactions](docs/transactions/README.md)
7878

79-
* `list_transactions` - List transactions
79+
* [list](docs/transactions/README.md#list) - List transactions
8080
<!-- End SDK Available Operations -->
8181

8282
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

commerce/RELEASES.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,4 +230,36 @@ Based on:
230230
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Commerce.yaml
231231
- Speakeasy CLI 1.20.1 (2.18.1) https://github.com/speakeasy-api/speakeasy
232232
### Releases
233-
- [PyPI v0.11.1] https://pypi.org/project/codat-commerce/0.11.1 - commerce
233+
- [PyPI v0.11.1] https://pypi.org/project/codat-commerce/0.11.1 - commerce
234+
235+
## 2023-04-25 07:57:46
236+
### Changes
237+
Based on:
238+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Commerce.yaml
239+
- Speakeasy CLI 1.23.0 (2.21.0) https://github.com/speakeasy-api/speakeasy
240+
### Releases
241+
- [PyPI v0.12.0] https://pypi.org/project/codat-commerce/0.12.0 - commerce
242+
243+
## 2023-04-25 14:17:50
244+
### Changes
245+
Based on:
246+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Commerce.yaml
247+
- Speakeasy CLI 1.23.1 (2.21.1) https://github.com/speakeasy-api/speakeasy
248+
### Releases
249+
- [PyPI v0.12.1] https://pypi.org/project/codat-commerce/0.12.1 - commerce
250+
251+
## 2023-04-26 01:19:21
252+
### Changes
253+
Based on:
254+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Commerce.yaml
255+
- Speakeasy CLI 1.23.1 (2.21.1) https://github.com/speakeasy-api/speakeasy
256+
### Releases
257+
- [PyPI v0.12.2] https://pypi.org/project/codat-commerce/0.12.2 - commerce
258+
259+
## 2023-04-26 14:59:31
260+
### Changes
261+
Based on:
262+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Commerce.yaml
263+
- Speakeasy CLI 1.25.1 (2.22.0) https://github.com/speakeasy-api/speakeasy
264+
### Releases
265+
- [PyPI v0.13.0] https://pypi.org/project/codat-commerce/0.13.0 - commerce

commerce/USAGE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- Start SDK Example Usage -->
22
```python
33
import codatcommerce
4-
from codatcommerce.models import operations, shared
4+
from codatcommerce.models import operations
55

66
s = codatcommerce.CodatCommerce(
77
security=shared.Security(
@@ -14,8 +14,8 @@ req = operations.GetCompanyInfoRequest(
1414
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
1515
connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
1616
)
17-
18-
res = s.company_info.get_company_info(req)
17+
18+
res = s.company_info.get(req)
1919

2020
if res.company_info is not None:
2121
# handle response
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# CodatCommerce SDK
2+
3+
## Overview
4+
5+
Codat's Commerce API allows you to access standardised data from over 11 commerce and POS systems.
6+
7+
Standardize how you connect to your customers’ payment, PoS, and eCommerce systems. Retrieve orders, payouts, payments, and product data in the same way for all the leading commerce platforms.
8+
9+
[Read more...](https://docs.codat.io/commerce-api/overview)
10+
11+
[See our OpenAPI spec](https://github.com/codatio/oas)
12+
13+
### Available Operations
14+
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# company_info
2+
3+
## Overview
4+
5+
Retrieve standardized data from linked commerce platforms.
6+
7+
### Available Operations
8+
9+
* [get](#get) - Get company info
10+
11+
## get
12+
13+
Retrieve information about the company, as seen in the commerce platform.
14+
15+
This may include information like addresses, tax registration details and social media or website information.
16+
17+
### Example Usage
18+
19+
```python
20+
import codatcommerce
21+
from codatcommerce.models import operations
22+
23+
s = codatcommerce.CodatCommerce(
24+
security=shared.Security(
25+
auth_header="YOUR_API_KEY_HERE",
26+
),
27+
)
28+
29+
30+
req = operations.GetCompanyInfoRequest(
31+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
32+
connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
33+
)
34+
35+
res = s.company_info.get(req)
36+
37+
if res.company_info is not None:
38+
# handle response
39+
```

commerce/docs/customers/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# customers
2+
3+
## Overview
4+
5+
Retrieve standardized data from linked commerce platforms.
6+
7+
### Available Operations
8+
9+
* [list](#list) - List customers
10+
11+
## list
12+
13+
List all commerce customers for the given company and data connection
14+
15+
### Example Usage
16+
17+
```python
18+
import codatcommerce
19+
from codatcommerce.models import operations
20+
21+
s = codatcommerce.CodatCommerce(
22+
security=shared.Security(
23+
auth_header="YOUR_API_KEY_HERE",
24+
),
25+
)
26+
27+
28+
req = operations.ListCustomersRequest(
29+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
30+
connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
31+
order_by="-modifiedDate",
32+
page=1,
33+
page_size=100,
34+
query="corrupti",
35+
)
36+
37+
res = s.customers.list(req)
38+
39+
if res.customers is not None:
40+
# handle response
41+
```

commerce/docs/disputes/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# disputes
2+
3+
## Overview
4+
5+
Retrieve standardized data from linked commerce platforms.
6+
7+
### Available Operations
8+
9+
* [list](#list) - List disputes
10+
11+
## list
12+
13+
List commerce disputes
14+
15+
### Example Usage
16+
17+
```python
18+
import codatcommerce
19+
from codatcommerce.models import operations
20+
21+
s = codatcommerce.CodatCommerce(
22+
security=shared.Security(
23+
auth_header="YOUR_API_KEY_HERE",
24+
),
25+
)
26+
27+
28+
req = operations.ListDisputesRequest(
29+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
30+
connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
31+
order_by="-modifiedDate",
32+
page=1,
33+
page_size=100,
34+
query="provident",
35+
)
36+
37+
res = s.disputes.list(req)
38+
39+
if res.disputes is not None:
40+
# handle response
41+
```

commerce/docs/locations/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# locations
2+
3+
## Overview
4+
5+
Retrieve standardized data from linked commerce platforms.
6+
7+
### Available Operations
8+
9+
* [list](#list) - List locations
10+
11+
## list
12+
13+
Retrieve a list of locations as seen in the commerce platform.
14+
15+
A `location` is a geographic place at which stocks of products may be held, or from where orders were placed.
16+
17+
### Example Usage
18+
19+
```python
20+
import codatcommerce
21+
from codatcommerce.models import operations
22+
23+
s = codatcommerce.CodatCommerce(
24+
security=shared.Security(
25+
auth_header="YOUR_API_KEY_HERE",
26+
),
27+
)
28+
29+
30+
req = operations.ListLocationsRequest(
31+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
32+
connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
33+
)
34+
35+
res = s.locations.list(req)
36+
37+
if res.locations_response is not None:
38+
# handle response
39+
```

commerce/docs/orders/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# orders
2+
3+
## Overview
4+
5+
Retrieve standardized data from linked commerce platforms.
6+
7+
### Available Operations
8+
9+
* [list](#list) - List orders
10+
11+
## list
12+
13+
Get a list of orders placed or held on the linked commerce platform
14+
15+
### Example Usage
16+
17+
```python
18+
import codatcommerce
19+
from codatcommerce.models import operations
20+
21+
s = codatcommerce.CodatCommerce(
22+
security=shared.Security(
23+
auth_header="YOUR_API_KEY_HERE",
24+
),
25+
)
26+
27+
28+
req = operations.ListOrdersRequest(
29+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
30+
connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
31+
order_by="-modifiedDate",
32+
page=1,
33+
page_size=100,
34+
query="distinctio",
35+
)
36+
37+
res = s.orders.list(req)
38+
39+
if res.orders is not None:
40+
# handle response
41+
```

0 commit comments

Comments
 (0)