Skip to content

Commit b77828a

Browse files
chore: speakeasy sdk regeneration - Generate Common SDK (#11)
* ci: regenerated with OpenAPI Doc 2.1.0, Speakeay CLI 1.8.2 * ci: regenerated with OpenAPI Doc 2.1.0, Speakeay CLI 1.8.4 * ci: regenerated with OpenAPI Doc 2.1.0, Speakeay CLI 1.8.5 * ci: regenerated with OpenAPI Doc 2.1.0, Speakeay CLI 1.8.6 * ci: regenerated with OpenAPI Doc 2.1.0, Speakeay CLI 1.8.7 * ci: regenerated with OpenAPI Doc 2.1.0, Speakeay CLI 1.9.1 * ci: regenerated with OpenAPI Doc 2.1.0, Speakeay CLI 1.9.2 * ci: regenerated with OpenAPI Doc 2.1.0, Speakeay CLI 1.11.0 --------- Co-authored-by: speakeasybot <bot@speakeasyapi.dev>
1 parent 0cd4fde commit b77828a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+10555
-2
lines changed

common/README.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# @codat/common
2+
3+
<!-- Start SDK Installation -->
4+
## SDK Installation
5+
6+
### NPM
7+
8+
```bash
9+
npm add @codat/common
10+
```
11+
12+
### Yarn
13+
14+
```bash
15+
yarn add @codat/common
16+
```
17+
<!-- End SDK Installation -->
18+
19+
## SDK Example Usage
20+
<!-- Start SDK Example Usage -->
21+
```typescript
22+
import {
23+
CreateCompanyRequest,
24+
CreateCompanyResponse
25+
} from "@codat/common/dist/sdk/models/operations";
26+
27+
import { AxiosError } from "axios";
28+
import { Codat } from "@codat/common";
29+
const sdk = new Codat({
30+
security: {
31+
authHeader: "YOUR_API_KEY_HERE",
32+
},
33+
});
34+
35+
const req: CreateCompanyRequest = {
36+
request: {
37+
description: "unde",
38+
name: "deserunt",
39+
},
40+
};
41+
42+
sdk.companies.createCompany(req).then((res: CreateCompanyResponse | AxiosError) => {
43+
// handle response
44+
});
45+
```
46+
<!-- End SDK Example Usage -->
47+
48+
<!-- Start SDK Available Operations -->
49+
## SDK Available Operations
50+
51+
52+
### companies
53+
54+
* `createCompany` - Create company
55+
* `deleteCompany` - Delete a company
56+
* `getCompany` - Get company
57+
* `listCompanies` - List companies
58+
* `updateCompany` - Update company
59+
60+
### connections
61+
62+
* `createDataConnection` - Create a data connection
63+
* `deleteCompanyConnection` - Delete connection
64+
* `getCompanyAuthorization` - Update authorization
65+
* `getCompanyConnection` - Get connection
66+
* `listCompanyConnections` - List connections
67+
* `unlinkCompanyConnection` - Unlink connection
68+
69+
### dataStatus
70+
71+
* `getCompaniesCompanyIdDataStatus` - Get data status
72+
* `getCompanyDataHistory` - Get pull operations
73+
* `getPullOperation` - Get pull operation
74+
75+
### integrations
76+
77+
* `getIntegrationsPlatformKey` - Get integration
78+
* `getIntegrationsPlatformKeyBranding` - Get branding
79+
* `listIntegrations` - List integrations
80+
81+
### pushData
82+
83+
* `getCompaniesCompanyIdConnectionsConnectionIdPush` - List push options
84+
* `getCompaniesCompanyIdPush` - List push operations
85+
* `getCompaniesCompanyIdPushPushOperationKey` - Get push operation
86+
87+
### refreshData
88+
89+
* `createManyPullOperations` - Queue pull operations
90+
* `createPullOperation` - Queue pull operation
91+
92+
### settings
93+
94+
* `getProfileSyncSettings` - Get sync settings
95+
* `getSettingsProfile` - Get profile
96+
* `postProfileSyncSettings` - Update all sync settings
97+
* `putProfile` - Update profile
98+
99+
### webhooks
100+
101+
* `createRule` - Create webhook
102+
* `getWebhook` - Get webhook
103+
* `listRules` - List webhooks
104+
<!-- End SDK Available Operations -->
105+
106+
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

common/RELEASES.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
2+
3+
## 2023-03-05 11:35:14
4+
### Changes
5+
Based on:
6+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
7+
- Speakeasy CLI 1.8.2 https://github.com/speakeasy-api/speakeasy
8+
### Releases
9+
- [NPM v0.1.0] https://www.npmjs.com/package/@codat/common/v/0.1.0 - common
10+
11+
## 2023-03-06 00:03:40
12+
### Changes
13+
Based on:
14+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
15+
- Speakeasy CLI 1.8.4 https://github.com/speakeasy-api/speakeasy
16+
### Releases
17+
- [NPM v0.1.1] https://www.npmjs.com/package/@codat/common/v/0.1.1 - common
18+
19+
## 2023-03-07 00:03:45
20+
### Changes
21+
Based on:
22+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
23+
- Speakeasy CLI 1.8.5 https://github.com/speakeasy-api/speakeasy
24+
### Releases
25+
- [NPM v0.1.2] https://www.npmjs.com/package/@codat/common/v/0.1.2 - common
26+
27+
## 2023-03-08 00:03:33
28+
### Changes
29+
Based on:
30+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
31+
- Speakeasy CLI 1.8.6 https://github.com/speakeasy-api/speakeasy
32+
### Releases
33+
- [NPM v0.1.3] https://www.npmjs.com/package/@codat/common/v/0.1.3 - common
34+
35+
## 2023-03-09 00:03:35
36+
### Changes
37+
Based on:
38+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
39+
- Speakeasy CLI 1.8.7 https://github.com/speakeasy-api/speakeasy
40+
### Releases
41+
- [NPM v0.1.4] https://www.npmjs.com/package/@codat/common/v/0.1.4 - common
42+
43+
## 2023-03-10 00:03:33
44+
### Changes
45+
Based on:
46+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
47+
- Speakeasy CLI 1.9.1 https://github.com/speakeasy-api/speakeasy
48+
### Releases
49+
- [NPM v0.2.0] https://www.npmjs.com/package/@codat/common/v/0.2.0 - common
50+
51+
## 2023-03-11 00:03:13
52+
### Changes
53+
Based on:
54+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
55+
- Speakeasy CLI 1.9.2 https://github.com/speakeasy-api/speakeasy
56+
### Releases
57+
- [NPM v0.2.1] https://www.npmjs.com/package/@codat/common/v/0.2.1 - common
58+
59+
## 2023-03-15 00:03:03
60+
### Changes
61+
Based on:
62+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
63+
- Speakeasy CLI 1.11.0 https://github.com/speakeasy-api/speakeasy
64+
### Releases
65+
- [NPM v0.3.0] https://www.npmjs.com/package/@codat/common/v/0.3.0 - common

common/USAGE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!-- Start SDK Example Usage -->
2+
```typescript
3+
import {
4+
CreateCompanyRequest,
5+
CreateCompanyResponse
6+
} from "@codat/common/dist/sdk/models/operations";
7+
8+
import { AxiosError } from "axios";
9+
import { Codat } from "@codat/common";
10+
const sdk = new Codat({
11+
security: {
12+
authHeader: "YOUR_API_KEY_HERE",
13+
},
14+
});
15+
16+
const req: CreateCompanyRequest = {
17+
request: {
18+
description: "unde",
19+
name: "deserunt",
20+
},
21+
};
22+
23+
sdk.companies.createCompany(req).then((res: CreateCompanyResponse | AxiosError) => {
24+
// handle response
25+
});
26+
```
27+
<!-- End SDK Example Usage -->

common/files.gen

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
src/sdk/companies.ts
2+
src/sdk/connections.ts
3+
src/sdk/datastatus.ts
4+
src/sdk/integrations.ts
5+
src/sdk/pushdata.ts
6+
src/sdk/refreshdata.ts
7+
src/sdk/settings.ts
8+
src/sdk/webhooks.ts
9+
src/sdk/sdk.ts
10+
jest.config.js
11+
package-lock.json
12+
package.json
13+
src/index.ts
14+
src/internal/utils/contenttype.ts
15+
src/internal/utils/headers.ts
16+
src/internal/utils/index.ts
17+
src/internal/utils/pathparams.ts
18+
src/internal/utils/queryparams.ts
19+
src/internal/utils/requestbody.ts
20+
src/internal/utils/retries.ts
21+
src/internal/utils/security.ts
22+
src/internal/utils/utils.ts
23+
src/sdk/index.ts
24+
tsconfig.json
25+
src/sdk/models/operations/createcompany.ts
26+
src/sdk/models/operations/deletecompany.ts
27+
src/sdk/models/operations/getcompany.ts
28+
src/sdk/models/operations/listcompanies.ts
29+
src/sdk/models/operations/updatecompany.ts
30+
src/sdk/models/operations/createdataconnection.ts
31+
src/sdk/models/operations/deletecompanyconnection.ts
32+
src/sdk/models/operations/getcompanyauthorization.ts
33+
src/sdk/models/operations/getcompanyconnection.ts
34+
src/sdk/models/operations/listcompanyconnections.ts
35+
src/sdk/models/operations/unlinkcompanyconnection.ts
36+
src/sdk/models/operations/getcompaniescompanyiddatastatus.ts
37+
src/sdk/models/operations/getcompanydatahistory.ts
38+
src/sdk/models/operations/getpulloperation.ts
39+
src/sdk/models/operations/getintegrationsplatformkey.ts
40+
src/sdk/models/operations/getintegrationsplatformkeybranding.ts
41+
src/sdk/models/operations/listintegrations.ts
42+
src/sdk/models/operations/getcompaniescompanyidconnectionsconnectionidpush.ts
43+
src/sdk/models/operations/getcompaniescompanyidpush.ts
44+
src/sdk/models/operations/getcompaniescompanyidpushpushoperationkey.ts
45+
src/sdk/models/operations/createmanypulloperations.ts
46+
src/sdk/models/operations/createpulloperation.ts
47+
src/sdk/models/operations/getprofilesyncsettings.ts
48+
src/sdk/models/operations/getsettingsprofile.ts
49+
src/sdk/models/operations/postprofilesyncsettings.ts
50+
src/sdk/models/operations/putprofile.ts
51+
src/sdk/models/operations/createrule.ts
52+
src/sdk/models/operations/getwebhook.ts
53+
src/sdk/models/operations/listrules.ts
54+
src/sdk/models/operations/index.ts
55+
src/sdk/models/shared/security.ts
56+
src/sdk/models/shared/index.ts
57+
src/sdk/models/webhooks/companydataconnectionstatuschanged.ts
58+
src/sdk/models/webhooks/datasynccompleted.ts
59+
src/sdk/models/webhooks/datasetdatachanged.ts
60+
src/sdk/models/webhooks/datasetstatushaschangedtoanerrorstate.ts
61+
src/sdk/models/webhooks/newcompanysynchronized.ts
62+
src/sdk/models/webhooks/pushoperationhastimedout.ts
63+
src/sdk/models/webhooks/pushoperationstatushaschanged.ts
64+
src/sdk/models/webhooks/index.ts
65+
USAGE.md

common/gen.yaml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
configVersion: 1.0.0
2+
management:
3+
docChecksum: c45d111816d2a80343cf68432dd3b89b
4+
docVersion: 2.1.0
5+
speakeasyVersion: 1.11.0
26
generation:
7+
telemetryEnabled: false
38
sdkClassName: codat
49
sdkFlattening: true
510
typescript:
6-
version: 0.0.1
7-
packageName: "@codat/common"
11+
version: 0.3.0
12+
author: Speakeasy
13+
packageName: '@codat/common'

common/jest.config.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module.exports = {
2+
preset: 'ts-jest',
3+
testEnvironment: 'node',
4+
verbose: false,
5+
testPathIgnorePatterns: [
6+
"<rootDir>/__tests__/helpers.ts"
7+
]
8+
};

0 commit comments

Comments
 (0)