Skip to content

Commit

Permalink
chore: speakeasy sdk regeneration - Generate (#22)
Browse files Browse the repository at this point in the history
* ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.35.0

* ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.40.2

---------

Co-authored-by: speakeasybot <[email protected]>
Co-authored-by: Roopak Venkatakrishnan <[email protected]>
  • Loading branch information
3 people authored Jun 1, 2023
1 parent 46f6ac9 commit 2de5896
Show file tree
Hide file tree
Showing 114 changed files with 22,369 additions and 12,810 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
dist/
node_modules/
.idea/
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,15 @@ sdk.context.addEnvironmentVariableToContext({
* [getJobDetails](docs/job/README.md#getjobdetails) - Get job details
* [getTests](docs/job/README.md#gettests) - Get test metadata

### [oidcTokenManagement](docs/oidctokenmanagement/README.md)

* [deleteOrgClaims](docs/oidctokenmanagement/README.md#deleteorgclaims) - Delete org-level claims
* [deleteProjectClaims](docs/oidctokenmanagement/README.md#deleteprojectclaims) - Delete project-level claims
* [getOrgClaims](docs/oidctokenmanagement/README.md#getorgclaims) - Get org-level claims
* [getProjectClaims](docs/oidctokenmanagement/README.md#getprojectclaims) - Get project-level claims
* [patchOrgClaims](docs/oidctokenmanagement/README.md#patchorgclaims) - Patch org-level claims
* [patchProjectClaims](docs/oidctokenmanagement/README.md#patchprojectclaims) - Patch project-level claims

### [pipeline](docs/pipeline/README.md)

* [continuePipeline](docs/pipeline/README.md#continuepipeline) - Continue a pipeline
Expand All @@ -89,6 +98,18 @@ sdk.context.addEnvironmentVariableToContext({
* [listWorkflowsByPipelineId](docs/pipeline/README.md#listworkflowsbypipelineid) - Get a pipeline's workflows
* [triggerPipeline](docs/pipeline/README.md#triggerpipeline) - Trigger a new pipeline

### [policyManagement](docs/policymanagement/README.md)

* [createPolicyBundle](docs/policymanagement/README.md#createpolicybundle) - Creates policy bundle for the context
* [getDecisionLog](docs/policymanagement/README.md#getdecisionlog) - Retrieves the owner's decision audit log by given decisionID
* [getDecisionLogPolicyBundle](docs/policymanagement/README.md#getdecisionlogpolicybundle) - Retrieves Policy Bundle for a given decision log ID
* [getDecisionLogs](docs/policymanagement/README.md#getdecisionlogs) - Retrieves the owner's decision audit logs.
* [getDecisionSettings](docs/policymanagement/README.md#getdecisionsettings) - Get the decision settings
* [getPolicyBundle](docs/policymanagement/README.md#getpolicybundle) - Retrieves Policy Bundle
* [getPolicyDocument](docs/policymanagement/README.md#getpolicydocument) - Retrieves a policy document
* [makeDecision](docs/policymanagement/README.md#makedecision) - Makes a decision
* [setDecisionSettings](docs/policymanagement/README.md#setdecisionsettings) - Set the decision settings

### [project](docs/project/README.md)

* [createCheckoutKey](docs/project/README.md#createcheckoutkey) - Create a new checkout key
Expand Down
14 changes: 11 additions & 3 deletions RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -529,10 +529,18 @@ Based on:
### Releases
- [NPM v3.29.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.29.0 - .

## 2023-05-31 00:46:49
## 2023-05-19 00:48:08
### Changes
Based on:
- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json
- Speakeasy CLI 1.34.0 https://github.com/speakeasy-api/speakeasy
- Speakeasy CLI 1.35.0 https://github.com/speakeasy-api/speakeasy
### Releases
- [NPM v3.30.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.30.0 - .

## 2023-06-01 04:17:18
### Changes
Based on:
- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json
- Speakeasy CLI 1.40.2 (2.34.2) https://github.com/speakeasy-api/speakeasy
### Releases
- [NPM v3.30.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.29.0 - .
- [NPM v3.30.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.30.1 - .
10 changes: 5 additions & 5 deletions docs/context/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ Create a new context
```typescript
import { Circleci } from "circleci-v2-sdk";
import {
CreateContextRequestBodyOwner1TypeEnum,
CreateContextRequestBodyOwner2TypeEnum,
CreateContextRequestBodyOwner1Type,
CreateContextRequestBodyOwner2Type,
CreateContextResponse,
} from "circleci-v2-sdk/dist/sdk/models/operations";

Expand All @@ -63,7 +63,7 @@ sdk.context.createContext({
name: "Edna Mante II",
owner: {
slug: "sed",
type: CreateContextRequestBodyOwner2TypeEnum.Organization,
type: CreateContextRequestBodyOwner2Type.Organization,
},
}).then((res: CreateContextResponse) => {
if (res.statusCode == 200) {
Expand Down Expand Up @@ -156,7 +156,7 @@ List all contexts for an owner.

```typescript
import { Circleci } from "circleci-v2-sdk";
import { ListContextsOwnerTypeEnum, ListContextsResponse } from "circleci-v2-sdk/dist/sdk/models/operations";
import { ListContextsOwnerType, ListContextsResponse } from "circleci-v2-sdk/dist/sdk/models/operations";

const sdk = new Circleci({
security: {
Expand All @@ -167,7 +167,7 @@ const sdk = new Circleci({
sdk.context.listContexts({
ownerId: "b99d488e-1e91-4e45-8ad2-abd44269802d",
ownerSlug: "ipsam",
ownerType: ListContextsOwnerTypeEnum.Account,
ownerType: ListContextsOwnerType.Account,
pageToken: "fugit",
}).then((res: ListContextsResponse) => {
if (res.statusCode == 200) {
Expand Down
25 changes: 11 additions & 14 deletions docs/insights/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Get timeseries data for all jobs within a workflow.

```typescript
import { Circleci } from "circleci-v2-sdk";
import { GetJobTimeseriesGranularityEnum, GetJobTimeseriesResponse } from "circleci-v2-sdk/dist/sdk/models/operations";
import { GetJobTimeseriesGranularity, GetJobTimeseriesResponse } from "circleci-v2-sdk/dist/sdk/models/operations";

const sdk = new Circleci({
security: {
Expand All @@ -84,7 +84,7 @@ const sdk = new Circleci({
sdk.insights.getJobTimeseries({
branch: "enim",
endDate: new Date("2020-02-08T20:51:42.354Z"),
granularity: GetJobTimeseriesGranularityEnum.Hourly,
granularity: GetJobTimeseriesGranularity.Hourly,
projectSlug: "provident",
startDate: new Date("2021-09-06T10:36:33.442Z"),
workflowName: "blanditiis",
Expand All @@ -104,7 +104,7 @@ Gets aggregated summary metrics with trends for the entire org.

```typescript
import { Circleci } from "circleci-v2-sdk";
import { GetOrgSummaryDataReportingWindowEnum, GetOrgSummaryDataResponse } from "circleci-v2-sdk/dist/sdk/models/operations";
import { GetOrgSummaryDataReportingWindow, GetOrgSummaryDataResponse } from "circleci-v2-sdk/dist/sdk/models/operations";

const sdk = new Circleci({
security: {
Expand All @@ -120,7 +120,7 @@ sdk.insights.getOrgSummaryData({
"natus": "omnis",
"molestiae": "perferendis",
},
reportingWindow: GetOrgSummaryDataReportingWindowEnum.Last24Hours,
reportingWindow: GetOrgSummaryDataReportingWindow.Last24Hours,
}).then((res: GetOrgSummaryDataResponse) => {
if (res.statusCode == 200) {
// handle response
Expand All @@ -137,7 +137,7 @@ Get summary metrics for a project workflow's jobs. Job runs going back at most 9
```typescript
import { Circleci } from "circleci-v2-sdk";
import {
GetProjectWorkflowJobMetricsReportingWindowEnum,
GetProjectWorkflowJobMetricsReportingWindow,
GetProjectWorkflowJobMetricsResponse,
} from "circleci-v2-sdk/dist/sdk/models/operations";

Expand All @@ -152,7 +152,7 @@ sdk.insights.getProjectWorkflowJobMetrics({
branch: "magnam",
pageToken: "distinctio",
projectSlug: "id",
reportingWindow: GetProjectWorkflowJobMetricsReportingWindowEnum.Last90Days,
reportingWindow: GetProjectWorkflowJobMetricsReportingWindow.Last90Days,
workflowName: "labore",
}).then((res: GetProjectWorkflowJobMetricsResponse) => {
if (res.statusCode == 200) {
Expand All @@ -169,7 +169,7 @@ Get summary metrics for a project's workflows. Workflow runs going back at most

```typescript
import { Circleci } from "circleci-v2-sdk";
import { GetProjectWorkflowMetricsReportingWindowEnum, GetProjectWorkflowMetricsResponse } from "circleci-v2-sdk/dist/sdk/models/operations";
import { GetProjectWorkflowMetricsReportingWindow, GetProjectWorkflowMetricsResponse } from "circleci-v2-sdk/dist/sdk/models/operations";

const sdk = new Circleci({
security: {
Expand All @@ -182,7 +182,7 @@ sdk.insights.getProjectWorkflowMetrics({
branch: "suscipit",
pageToken: "natus",
projectSlug: "nobis",
reportingWindow: GetProjectWorkflowMetricsReportingWindowEnum.Last24Hours,
reportingWindow: GetProjectWorkflowMetricsReportingWindow.Last24Hours,
}).then((res: GetProjectWorkflowMetricsResponse) => {
if (res.statusCode == 200) {
// handle response
Expand All @@ -199,7 +199,7 @@ Get recent runs of a workflow. Runs going back at most 90 days are returned. Ple
```typescript
import { Circleci } from "circleci-v2-sdk";
import {
GetProjectWorkflowRuns200ApplicationJSONItemsStatusEnum,
GetProjectWorkflowRuns200ApplicationJSONItemsStatus,
GetProjectWorkflowRunsResponse,
} from "circleci-v2-sdk/dist/sdk/models/operations";

Expand Down Expand Up @@ -263,10 +263,7 @@ Get summary metrics and trends for a project at workflow and branch level.

```typescript
import { Circleci } from "circleci-v2-sdk";
import {
GetProjectWorkflowsPageDataReportingWindowEnum,
GetProjectWorkflowsPageDataResponse,
} from "circleci-v2-sdk/dist/sdk/models/operations";
import { GetProjectWorkflowsPageDataReportingWindow, GetProjectWorkflowsPageDataResponse } from "circleci-v2-sdk/dist/sdk/models/operations";

const sdk = new Circleci({
security: {
Expand All @@ -281,7 +278,7 @@ sdk.insights.getProjectWorkflowsPageData({
"dolor": "necessitatibus",
},
projectSlug: "odit",
reportingWindow: GetProjectWorkflowsPageDataReportingWindowEnum.Last90Days,
reportingWindow: GetProjectWorkflowsPageDataReportingWindow.Last90Days,
workflowNames: {
"iure": "doloribus",
},
Expand Down
2 changes: 1 addition & 1 deletion docs/job/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Returns job details.

```typescript
import { Circleci } from "circleci-v2-sdk";
import { GetJobDetailsJobDetailsStatusEnum, GetJobDetailsResponse } from "circleci-v2-sdk/dist/sdk/models/operations";
import { GetJobDetailsJobDetailsStatus, GetJobDetailsResponse } from "circleci-v2-sdk/dist/sdk/models/operations";

const sdk = new Circleci({
security: {
Expand Down
187 changes: 187 additions & 0 deletions docs/oidctokenmanagement/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
# oidcTokenManagement

## Overview

Endpoints related to manage oidc identity tokens

### Available Operations

* [deleteOrgClaims](#deleteorgclaims) - Delete org-level claims
* [deleteProjectClaims](#deleteprojectclaims) - Delete project-level claims
* [getOrgClaims](#getorgclaims) - Get org-level claims
* [getProjectClaims](#getprojectclaims) - Get project-level claims
* [patchOrgClaims](#patchorgclaims) - Patch org-level claims
* [patchProjectClaims](#patchprojectclaims) - Patch project-level claims

## deleteOrgClaims

Deletes org-level custom claims of OIDC identity tokens

### Example Usage

```typescript
import { Circleci } from "circleci-v2-sdk";
import { DeleteOrgClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations";

const sdk = new Circleci({
security: {
apiKeyHeader: "YOUR_API_KEY_HERE",
},
});

sdk.oidcTokenManagement.deleteOrgClaims({
claims: "praesentium",
orgID: "921cddc6-9260-41fb-976b-0d5f0d30c5fb",
}).then((res: DeleteOrgClaimsResponse) => {
if (res.statusCode == 200) {
// handle response
}
});
```

## deleteProjectClaims

Deletes project-level custom claims of OIDC identity tokens

### Example Usage

```typescript
import { Circleci } from "circleci-v2-sdk";
import { DeleteProjectClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations";

const sdk = new Circleci({
security: {
apiKeyHeader: "YOUR_API_KEY_HERE",
},
});

sdk.oidcTokenManagement.deleteProjectClaims({
claims: "nobis",
orgID: "25870532-02c7-43d5-be9b-90c28909b3fe",
projectID: "49a8d9cb-f486-4333-a3f9-b77f3a410067",
}).then((res: DeleteProjectClaimsResponse) => {
if (res.statusCode == 200) {
// handle response
}
});
```

## getOrgClaims

Fetches org-level custom claims of OIDC identity tokens

### Example Usage

```typescript
import { Circleci } from "circleci-v2-sdk";
import { GetOrgClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations";

const sdk = new Circleci({
security: {
apiKeyHeader: "YOUR_API_KEY_HERE",
},
});

sdk.oidcTokenManagement.getOrgClaims({
orgID: "4ebf6928-0d1b-4a77-a89e-bf737ae4203c",
}).then((res: GetOrgClaimsResponse) => {
if (res.statusCode == 200) {
// handle response
}
});
```

## getProjectClaims

Fetches project-level custom claims of OIDC identity tokens

### Example Usage

```typescript
import { Circleci } from "circleci-v2-sdk";
import { GetProjectClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations";

const sdk = new Circleci({
security: {
apiKeyHeader: "YOUR_API_KEY_HERE",
},
});

sdk.oidcTokenManagement.getProjectClaims({
orgID: "e5e6a95d-8a0d-4446-8e2a-f7a73cf3be45",
projectID: "3f870b32-6b5a-4734-a9cd-b1a8422bb679",
}).then((res: GetProjectClaimsResponse) => {
if (res.statusCode == 200) {
// handle response
}
});
```

## patchOrgClaims

Creates/Updates org-level custom claims of OIDC identity tokens

### Example Usage

```typescript
import { Circleci } from "circleci-v2-sdk";
import { PatchOrgClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations";

const sdk = new Circleci({
security: {
apiKeyHeader: "YOUR_API_KEY_HERE",
},
});

sdk.oidcTokenManagement.patchOrgClaims({
patchClaimsRequest: {
audience: [
"qui",
"neque",
"fugit",
"magni",
],
ttl: "odio",
},
orgID: "15bf0cbb-1e31-4b8b-90f3-443a1108e0ad",
}).then((res: PatchOrgClaimsResponse) => {
if (res.statusCode == 200) {
// handle response
}
});
```

## patchProjectClaims

Creates/Updates project-level custom claims of OIDC identity tokens

### Example Usage

```typescript
import { Circleci } from "circleci-v2-sdk";
import { PatchProjectClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations";

const sdk = new Circleci({
security: {
apiKeyHeader: "YOUR_API_KEY_HERE",
},
});

sdk.oidcTokenManagement.patchProjectClaims({
patchClaimsRequest: {
audience: [
"doloribus",
"ut",
"facilis",
"cupiditate",
],
ttl: "qui",
},
orgID: "1879fce9-53f7-43ef-bfbc-7abd74dd39c0",
projectID: "f5d2cff7-c70a-4456-a6d4-36813f16d9f5",
}).then((res: PatchProjectClaimsResponse) => {
if (res.statusCode == 200) {
// handle response
}
});
```
Loading

0 comments on commit 2de5896

Please sign in to comment.