Skip to content

Commit e42cbd4

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.4.0 ., Speakeasy CLI 1.295.2
1 parent af30e84 commit e42cbd4

File tree

12 files changed

+6859
-998
lines changed

12 files changed

+6859
-998
lines changed

‎.speakeasy/gen.lock

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
lockVersion: 2.0.0
22
id: 89968bf0-a755-4d50-9acb-d47410010f05
33
management:
4-
docChecksum: f85cf38fea71c78f79ca43b23b176863
4+
docChecksum: c1d828d0e8ecf8fac6bec9e95f0ca086
55
docVersion: 0.4.0 .
6-
speakeasyVersion: 1.294.0
7-
generationVersion: 2.333.3
8-
releaseVersion: 3.3.2
9-
configChecksum: 20388f246d8d129879fb505fba89efc6
6+
speakeasyVersion: 1.295.2
7+
generationVersion: 2.335.5
8+
releaseVersion: 3.3.3
9+
configChecksum: cbbb7f5c89a3b545efe7057a5f101858
1010
repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript.git
1111
repoSubDirectory: .
1212
installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript
@@ -98,6 +98,7 @@ generatedFiles:
9898
- src/sdk/models/operations/githubcheckaccess.ts
9999
- src/sdk/models/operations/githubconfiguretarget.ts
100100
- src/sdk/models/operations/githubtriggeraction.ts
101+
- src/sdk/models/operations/createfreetrial.ts
101102
- src/sdk/models/operations/getorganizationusage.ts
102103
- src/sdk/models/operations/getorganizations.ts
103104
- src/sdk/models/operations/getchangesreportsignedurl.ts
@@ -239,6 +240,7 @@ generatedFiles:
239240
- docs/sdk/models/operations/githubcheckaccessresponse.md
240241
- docs/sdk/models/operations/githubconfiguretargetresponse.md
241242
- docs/sdk/models/operations/githubtriggeractionresponse.md
243+
- docs/sdk/models/operations/createfreetrialresponse.md
242244
- docs/sdk/models/operations/getorganizationusageresponse.md
243245
- docs/sdk/models/operations/getorganizationsresponse.md
244246
- docs/sdk/models/operations/getchangesreportsignedurlrequest.md

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ run();
121121

122122
### [organizations](docs/sdks/organizations/README.md)
123123

124+
* [createFreeTrial](docs/sdks/organizations/README.md#createfreetrial) - Create a free trial for an organization
124125
* [getOrganizationUsage](docs/sdks/organizations/README.md#getorganizationusage) - Get billing usage summary for a particular organization
125126
* [getOrganizations](docs/sdks/organizations/README.md#getorganizations) - Get organizations for a user
126127

‎RELEASES.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -1486,4 +1486,14 @@ Based on:
14861486
### Generated
14871487
- [typescript v3.3.2] .
14881488
### Releases
1489-
- [NPM v3.3.2] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.3.2 - .
1489+
- [NPM v3.3.2] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.3.2 - .
1490+
1491+
## 2024-05-24 00:12:24
1492+
### Changes
1493+
Based on:
1494+
- OpenAPI Doc 0.4.0 . https://docs.speakeasyapi.dev/openapi.yaml
1495+
- Speakeasy CLI 1.295.2 (2.335.5) https://github.com/speakeasy-api/speakeasy
1496+
### Generated
1497+
- [typescript v3.3.3] .
1498+
### Releases
1499+
- [NPM v3.3.3] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.3.3 - .

‎docs/sdk/models/operations/createfreetrialresponse.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CreateFreeTrialResponse
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
8+
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9+
| `error` | [shared.ErrorT](../../../sdk/models/shared/errort.md) | :heavy_minus_sign: | Default error response |
10+
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
11+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

‎docs/sdks/organizations/README.md

+43
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,52 @@
33

44
### Available Operations
55

6+
* [createFreeTrial](#createfreetrial) - Create a free trial for an organization
67
* [getOrganizationUsage](#getorganizationusage) - Get billing usage summary for a particular organization
78
* [getOrganizations](#getorganizations) - Get organizations for a user
89

10+
## createFreeTrial
11+
12+
Creates a free trial for an organization
13+
14+
### Example Usage
15+
16+
```typescript
17+
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
18+
19+
async function run() {
20+
const sdk = new Speakeasy({
21+
security: {
22+
apiKey: "<YOUR_API_KEY_HERE>",
23+
},
24+
});
25+
26+
const res = await sdk.organizations.createFreeTrial();
27+
28+
if (res.statusCode == 200) {
29+
// handle response
30+
}
31+
}
32+
33+
run();
34+
```
35+
36+
### Parameters
37+
38+
| Parameter | Type | Required | Description |
39+
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
40+
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
41+
42+
43+
### Response
44+
45+
**Promise<[operations.CreateFreeTrialResponse](../../sdk/models/operations/createfreetrialresponse.md)>**
46+
### Errors
47+
48+
| Error Object | Status Code | Content Type |
49+
| --------------- | --------------- | --------------- |
50+
| errors.SDKError | 4xx-5xx | */* |
51+
952
## getOrganizationUsage
1053

1154
Returns a billing usage summary by target languages for a particular organization

‎gen.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ generation:
1010
auth:
1111
oAuth2ClientCredentialsEnabled: false
1212
typescript:
13-
version: 3.3.2
13+
version: 3.3.3
1414
author: Speakeasy
1515
clientServerStatusCodesAsErrors: false
1616
flattenGlobalSecurity: false

0 commit comments

Comments
 (0)