From ce2aef92e21b29a7a9aa539bfb0c23210f255bf4 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 10 Nov 2023 01:09:35 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc 1.0.0, Speakeasy CLI 1.118.3 --- .eslintrc.yml | 0 .gitattributes | 0 README.md | 20 ++++++------ RELEASES.md | 10 +++++- USAGE.md | 2 -- .../models/operations/createpetsresponse.md | 0 docs/sdk/models/operations/listpetsrequest.md | 0 .../sdk/models/operations/listpetsresponse.md | 0 .../models/operations/showpetbyidrequest.md | 0 .../models/operations/showpetbyidresponse.md | 0 docs/sdk/models/shared/errort.md | 0 docs/sdk/models/shared/pet.md | 0 docs/sdks/pets/README.md | 0 docs/sdks/swaggerpetstore/README.md | 0 gen.yaml | 10 +++--- jest.config.js | 0 package-lock.json | 4 +-- package.json | 2 +- src/index.ts | 0 src/internal/utils/contenttype.ts | 0 src/internal/utils/headers.ts | 0 src/internal/utils/index.ts | 0 src/internal/utils/pathparams.ts | 0 src/internal/utils/queryparams.ts | 0 src/internal/utils/requestbody.ts | 0 src/internal/utils/retries.ts | 0 src/internal/utils/security.ts | 0 src/internal/utils/utils.ts | 0 src/sdk/index.ts | 0 src/sdk/models/errors/index.ts | 0 src/sdk/models/errors/sdkerror.ts | 0 src/sdk/models/operations/createpets.ts | 0 src/sdk/models/operations/index.ts | 0 src/sdk/models/operations/listpets.ts | 0 src/sdk/models/operations/showpetbyid.ts | 0 src/sdk/models/shared/error.ts | 0 src/sdk/models/shared/index.ts | 0 src/sdk/models/shared/pet.ts | 0 src/sdk/pets.ts | 32 +++++++++---------- src/sdk/sdk.ts | 6 ++-- src/sdk/types/index.ts | 0 src/sdk/types/rfcdate.ts | 0 tsconfig.json | 0 43 files changed, 46 insertions(+), 40 deletions(-) mode change 100755 => 100644 .eslintrc.yml mode change 100755 => 100644 .gitattributes mode change 100755 => 100644 USAGE.md mode change 100755 => 100644 docs/sdk/models/operations/createpetsresponse.md mode change 100755 => 100644 docs/sdk/models/operations/listpetsrequest.md mode change 100755 => 100644 docs/sdk/models/operations/listpetsresponse.md mode change 100755 => 100644 docs/sdk/models/operations/showpetbyidrequest.md mode change 100755 => 100644 docs/sdk/models/operations/showpetbyidresponse.md mode change 100755 => 100644 docs/sdk/models/shared/errort.md mode change 100755 => 100644 docs/sdk/models/shared/pet.md mode change 100755 => 100644 docs/sdks/pets/README.md mode change 100755 => 100644 docs/sdks/swaggerpetstore/README.md mode change 100755 => 100644 jest.config.js mode change 100755 => 100644 package-lock.json mode change 100755 => 100644 package.json mode change 100755 => 100644 src/index.ts mode change 100755 => 100644 src/internal/utils/contenttype.ts mode change 100755 => 100644 src/internal/utils/headers.ts mode change 100755 => 100644 src/internal/utils/index.ts mode change 100755 => 100644 src/internal/utils/pathparams.ts mode change 100755 => 100644 src/internal/utils/queryparams.ts mode change 100755 => 100644 src/internal/utils/requestbody.ts mode change 100755 => 100644 src/internal/utils/retries.ts mode change 100755 => 100644 src/internal/utils/security.ts mode change 100755 => 100644 src/internal/utils/utils.ts mode change 100755 => 100644 src/sdk/index.ts mode change 100755 => 100644 src/sdk/models/errors/index.ts mode change 100755 => 100644 src/sdk/models/errors/sdkerror.ts mode change 100755 => 100644 src/sdk/models/operations/createpets.ts mode change 100755 => 100644 src/sdk/models/operations/index.ts mode change 100755 => 100644 src/sdk/models/operations/listpets.ts mode change 100755 => 100644 src/sdk/models/operations/showpetbyid.ts mode change 100755 => 100644 src/sdk/models/shared/error.ts mode change 100755 => 100644 src/sdk/models/shared/index.ts mode change 100755 => 100644 src/sdk/models/shared/pet.ts mode change 100755 => 100644 src/sdk/pets.ts mode change 100755 => 100644 src/sdk/sdk.ts mode change 100755 => 100644 src/sdk/types/index.ts mode change 100755 => 100644 src/sdk/types/rfcdate.ts mode change 100755 => 100644 tsconfig.json diff --git a/.eslintrc.yml b/.eslintrc.yml old mode 100755 new mode 100644 diff --git a/.gitattributes b/.gitattributes old mode 100755 new mode 100644 diff --git a/README.md b/README.md index f403107..d67d2cd 100755 --- a/README.md +++ b/README.md @@ -24,6 +24,8 @@ yarn add https://github.com/speakeasy-sdks/petstore-typescript-sdk ## SDK Example Usage +### Example + ```typescript import { SwaggerPetstore } from "Swagger-Petstore"; @@ -68,7 +70,7 @@ Here's an example of one such pagination call: -# Error Handling +## Error Handling Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type. @@ -76,8 +78,7 @@ Handling errors in this SDK should largely match your expectations. All operati | --------------- | --------------- | --------------- | | errors.SDKError | 400-600 | */* | - -## Example +Example ```typescript import { SwaggerPetstore } from "Swagger-Petstore"; @@ -101,9 +102,9 @@ import { SwaggerPetstore } from "Swagger-Petstore"; -# Server Selection +## Server Selection -## Select Server by Index +### Select Server by Index You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers: @@ -111,7 +112,7 @@ You can override the default server globally by passing a server index to the `s | - | ------ | --------- | | 0 | `http://petstore.swagger.io/v1` | None | -For example: +#### Example ```typescript import { SwaggerPetstore } from "Swagger-Petstore"; @@ -131,10 +132,9 @@ import { SwaggerPetstore } from "Swagger-Petstore"; ``` -## Override Server URL Per-Client +### Override Server URL Per-Client The default server can also be overridden globally by passing a URL to the `serverURL: str` optional parameter when initializing the SDK client instance. For example: - ```typescript import { SwaggerPetstore } from "Swagger-Petstore"; @@ -156,11 +156,10 @@ import { SwaggerPetstore } from "Swagger-Petstore"; -# Custom HTTP Client +## Custom HTTP Client The Typescript SDK makes API calls using the (axios)[https://axios-http.com/docs/intro] HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `AxiosInstance` object. - For example, you could specify a header for every request that your sdk makes as follows: ```typescript @@ -171,7 +170,6 @@ const httpClient = axios.create({ headers: {'x-custom-header': 'someValue'} }) - const sdk = new SwaggerPetstore({defaultClient: httpClient}); ``` diff --git a/RELEASES.md b/RELEASES.md index 42304a2..5069434 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -46,4 +46,12 @@ Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.116.0 (2.185.0) https://github.com/speakeasy-api/speakeasy ### Generated -- [typescript v0.4.1] . \ No newline at end of file +- [typescript v0.4.1] . + +## 2023-11-10 01:09:18 +### Changes +Based on: +- OpenAPI Doc 1.0.0 +- Speakeasy CLI 1.118.3 (2.187.7) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.4.2] . \ No newline at end of file diff --git a/USAGE.md b/USAGE.md old mode 100755 new mode 100644 index 8406397..f597e99 --- a/USAGE.md +++ b/USAGE.md @@ -1,6 +1,4 @@ - - ```typescript import { SwaggerPetstore } from "Swagger-Petstore"; diff --git a/docs/sdk/models/operations/createpetsresponse.md b/docs/sdk/models/operations/createpetsresponse.md old mode 100755 new mode 100644 diff --git a/docs/sdk/models/operations/listpetsrequest.md b/docs/sdk/models/operations/listpetsrequest.md old mode 100755 new mode 100644 diff --git a/docs/sdk/models/operations/listpetsresponse.md b/docs/sdk/models/operations/listpetsresponse.md old mode 100755 new mode 100644 diff --git a/docs/sdk/models/operations/showpetbyidrequest.md b/docs/sdk/models/operations/showpetbyidrequest.md old mode 100755 new mode 100644 diff --git a/docs/sdk/models/operations/showpetbyidresponse.md b/docs/sdk/models/operations/showpetbyidresponse.md old mode 100755 new mode 100644 diff --git a/docs/sdk/models/shared/errort.md b/docs/sdk/models/shared/errort.md old mode 100755 new mode 100644 diff --git a/docs/sdk/models/shared/pet.md b/docs/sdk/models/shared/pet.md old mode 100755 new mode 100644 diff --git a/docs/sdks/pets/README.md b/docs/sdks/pets/README.md old mode 100755 new mode 100644 diff --git a/docs/sdks/swaggerpetstore/README.md b/docs/sdks/swaggerpetstore/README.md old mode 100755 new mode 100644 diff --git a/gen.yaml b/gen.yaml index cbb7cd8..3ba8a7d 100644 --- a/gen.yaml +++ b/gen.yaml @@ -2,18 +2,20 @@ configVersion: 1.0.0 management: docChecksum: 2516596125ef223fbbef6c434d22eaac docVersion: 1.0.0 - speakeasyVersion: 1.116.0 - generationVersion: 2.185.0 + speakeasyVersion: 1.118.3 + generationVersion: 2.187.7 generation: comments: {} sdkClassName: Swagger-Petstore repoURL: https://github.com/speakeasy-sdks/petstore-typescript-sdk.git + usageSnippets: + optionalPropertyRendering: withExample features: typescript: - core: 3.1.2 + core: 3.1.3 globalServerURLs: 2.82.0 typescript: - version: 0.4.1 + version: 0.4.2 author: demo clientServerStatusCodesAsErrors: true flattenGlobalSecurity: true diff --git a/jest.config.js b/jest.config.js old mode 100755 new mode 100644 diff --git a/package-lock.json b/package-lock.json old mode 100755 new mode 100644 index 222db73..debad4f --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "Swagger-Petstore", - "version": "0.4.1", + "version": "0.4.2", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "Swagger-Petstore", - "version": "0.4.1", + "version": "0.4.2", "dependencies": { "axios": "^1.1.3", "class-transformer": "^0.5.1", diff --git a/package.json b/package.json old mode 100755 new mode 100644 index 7f1c2f5..b767541 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "Swagger-Petstore", - "version": "0.4.1", + "version": "0.4.2", "author": "demo", "scripts": { "prepare": "tsc --build", diff --git a/src/index.ts b/src/index.ts old mode 100755 new mode 100644 diff --git a/src/internal/utils/contenttype.ts b/src/internal/utils/contenttype.ts old mode 100755 new mode 100644 diff --git a/src/internal/utils/headers.ts b/src/internal/utils/headers.ts old mode 100755 new mode 100644 diff --git a/src/internal/utils/index.ts b/src/internal/utils/index.ts old mode 100755 new mode 100644 diff --git a/src/internal/utils/pathparams.ts b/src/internal/utils/pathparams.ts old mode 100755 new mode 100644 diff --git a/src/internal/utils/queryparams.ts b/src/internal/utils/queryparams.ts old mode 100755 new mode 100644 diff --git a/src/internal/utils/requestbody.ts b/src/internal/utils/requestbody.ts old mode 100755 new mode 100644 diff --git a/src/internal/utils/retries.ts b/src/internal/utils/retries.ts old mode 100755 new mode 100644 diff --git a/src/internal/utils/security.ts b/src/internal/utils/security.ts old mode 100755 new mode 100644 diff --git a/src/internal/utils/utils.ts b/src/internal/utils/utils.ts old mode 100755 new mode 100644 diff --git a/src/sdk/index.ts b/src/sdk/index.ts old mode 100755 new mode 100644 diff --git a/src/sdk/models/errors/index.ts b/src/sdk/models/errors/index.ts old mode 100755 new mode 100644 diff --git a/src/sdk/models/errors/sdkerror.ts b/src/sdk/models/errors/sdkerror.ts old mode 100755 new mode 100644 diff --git a/src/sdk/models/operations/createpets.ts b/src/sdk/models/operations/createpets.ts old mode 100755 new mode 100644 diff --git a/src/sdk/models/operations/index.ts b/src/sdk/models/operations/index.ts old mode 100755 new mode 100644 diff --git a/src/sdk/models/operations/listpets.ts b/src/sdk/models/operations/listpets.ts old mode 100755 new mode 100644 diff --git a/src/sdk/models/operations/showpetbyid.ts b/src/sdk/models/operations/showpetbyid.ts old mode 100755 new mode 100644 diff --git a/src/sdk/models/shared/error.ts b/src/sdk/models/shared/error.ts old mode 100755 new mode 100644 diff --git a/src/sdk/models/shared/index.ts b/src/sdk/models/shared/index.ts old mode 100755 new mode 100644 diff --git a/src/sdk/models/shared/pet.ts b/src/sdk/models/shared/pet.ts old mode 100755 new mode 100644 diff --git a/src/sdk/pets.ts b/src/sdk/pets.ts old mode 100755 new mode 100644 index 1a6e04b..bee89dd --- a/src/sdk/pets.ts +++ b/src/sdk/pets.ts @@ -40,7 +40,7 @@ export class Pets { ...config, }); - const contentType: string = httpRes?.headers?.["content-type"] ?? ""; + const responseContentType: string = httpRes?.headers?.["content-type"] ?? ""; if (httpRes?.status == null) { throw new Error(`status code not found in response: ${httpRes}`); @@ -48,7 +48,7 @@ export class Pets { const res: operations.CreatePetsResponse = new operations.CreatePetsResponse({ statusCode: httpRes.status, - contentType: contentType, + contentType: responseContentType, rawResponse: httpRes, }); const decodedRes = new TextDecoder().decode(httpRes?.data); @@ -64,11 +64,11 @@ export class Pets { httpRes ); default: - if (utils.matchContentType(contentType, `application/json`)) { + if (utils.matchContentType(responseContentType, `application/json`)) { res.error = utils.objectToClass(JSON.parse(decodedRes), shared.ErrorT); } else { throw new errors.SDKError( - "unknown content-type received: " + contentType, + "unknown content-type received: " + responseContentType, httpRes.status, decodedRes, httpRes @@ -112,7 +112,7 @@ export class Pets { ...config, }); - const contentType: string = httpRes?.headers?.["content-type"] ?? ""; + const responseContentType: string = httpRes?.headers?.["content-type"] ?? ""; if (httpRes?.status == null) { throw new Error(`status code not found in response: ${httpRes}`); @@ -120,14 +120,14 @@ export class Pets { const res: operations.ListPetsResponse = new operations.ListPetsResponse({ statusCode: httpRes.status, - contentType: contentType, + contentType: responseContentType, rawResponse: httpRes, headers: utils.getHeadersFromResponse(httpRes.headers), }); const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: - if (utils.matchContentType(contentType, `application/json`)) { + if (utils.matchContentType(responseContentType, `application/json`)) { res.pets = []; const resFieldDepth: number = utils.getResFieldDepth(res); res.pets = utils.objectToClass( @@ -137,7 +137,7 @@ export class Pets { ); } else { throw new errors.SDKError( - "unknown content-type received: " + contentType, + "unknown content-type received: " + responseContentType, httpRes.status, decodedRes, httpRes @@ -153,11 +153,11 @@ export class Pets { httpRes ); default: - if (utils.matchContentType(contentType, `application/json`)) { + if (utils.matchContentType(responseContentType, `application/json`)) { res.error = utils.objectToClass(JSON.parse(decodedRes), shared.ErrorT); } else { throw new errors.SDKError( - "unknown content-type received: " + contentType, + "unknown content-type received: " + responseContentType, httpRes.status, decodedRes, httpRes @@ -200,7 +200,7 @@ export class Pets { ...config, }); - const contentType: string = httpRes?.headers?.["content-type"] ?? ""; + const responseContentType: string = httpRes?.headers?.["content-type"] ?? ""; if (httpRes?.status == null) { throw new Error(`status code not found in response: ${httpRes}`); @@ -208,17 +208,17 @@ export class Pets { const res: operations.ShowPetByIdResponse = new operations.ShowPetByIdResponse({ statusCode: httpRes.status, - contentType: contentType, + contentType: responseContentType, rawResponse: httpRes, }); const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: - if (utils.matchContentType(contentType, `application/json`)) { + if (utils.matchContentType(responseContentType, `application/json`)) { res.pet = utils.objectToClass(JSON.parse(decodedRes), shared.Pet); } else { throw new errors.SDKError( - "unknown content-type received: " + contentType, + "unknown content-type received: " + responseContentType, httpRes.status, decodedRes, httpRes @@ -234,11 +234,11 @@ export class Pets { httpRes ); default: - if (utils.matchContentType(contentType, `application/json`)) { + if (utils.matchContentType(responseContentType, `application/json`)) { res.error = utils.objectToClass(JSON.parse(decodedRes), shared.ErrorT); } else { throw new errors.SDKError( - "unknown content-type received: " + contentType, + "unknown content-type received: " + responseContentType, httpRes.status, decodedRes, httpRes diff --git a/src/sdk/sdk.ts b/src/sdk/sdk.ts old mode 100755 new mode 100644 index 464535a..640bd1b --- a/src/sdk/sdk.ts +++ b/src/sdk/sdk.ts @@ -42,9 +42,9 @@ export class SDKConfiguration { serverDefaults: any; language = "typescript"; openapiDocVersion = "1.0.0"; - sdkVersion = "0.4.1"; - genVersion = "2.185.0"; - userAgent = "speakeasy-sdk/typescript 0.4.1 2.185.0 1.0.0 Swagger-Petstore"; + sdkVersion = "0.4.2"; + genVersion = "2.187.7"; + userAgent = "speakeasy-sdk/typescript 0.4.2 2.187.7 1.0.0 Swagger-Petstore"; retryConfig?: utils.RetryConfig; public constructor(init?: Partial) { Object.assign(this, init); diff --git a/src/sdk/types/index.ts b/src/sdk/types/index.ts old mode 100755 new mode 100644 diff --git a/src/sdk/types/rfcdate.ts b/src/sdk/types/rfcdate.ts old mode 100755 new mode 100644 diff --git a/tsconfig.json b/tsconfig.json old mode 100755 new mode 100644