SdkGenSdk Python SDK 1.0.0

Welcome to the SdkGenSdk SDK documentation. This guide will help you get started with integrating and using the SdkGenSdk SDK in your project.

Versions

• SDK version: 1.0.0

About the API

REST API for Postman SDK generation: builds, artifacts, SDK downloads, GitHub connections, snippets, and documentation.

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Authentication
  • Basic Authentication
  • API Key Authentication
• Setting a Custom Timeout
• Sample Usage
• Services
• Models

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

To get started with the SDK, we recommend installing using pip:

pip install sdk_gen_sdk

If you are using Python 3, you can use pip3 instead:

pip3 install sdk_gen_sdk

Authentication

Basic Authentication

The SdkGenSdk API uses Basic Authentication.

You need to provide your username and password when initializing the SDK.

Setting the Username and Password

When you initialize the SDK, you can set the username and password as follows:

SdkGenSdk(
    username="YOUR_USERNAME",
    password="YOUR_PASSWORD",
    timeout=10000
)

If you need to set or update the username and password after initializing the SDK, you can use:

sdk.set_basic_auth("YOUR_USERNAME", "YOUR_PASSWORD")

API Key Authentication

The SdkGenSdk API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or a program that is calling the API.

Setting the API key

When you initialize the SDK, you can set the API key as follows:

SdkGenSdk(
    username="YOUR_USERNAME",
    password="YOUR_PASSWORD",
    timeout=10000
)

If you need to set or update the API key after initializing the SDK, you can use:

sdk.set_api_key("YOUR_API_KEY", "YOUR_API_KEY_HEADER")

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

from sdk_gen_sdk import SdkGenSdk

sdk = SdkGenSdk(timeout=10000)

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

from sdk_gen_sdk import SdkGenSdk

sdk = SdkGenSdk(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    timeout=10000
)

result = sdk.build.get_build_summary(
    collection_id="1401852-88d69471-e9ea-47d2-b342-1f9d221812b2",
    build_id=1,
    specification_id="4575688a-8370-42a7-b35e-9bac2571dcc7"
)

print(result)

Async Usage

The SDK includes an Async Client for making asynchronous API requests. This is useful for applications that need non-blocking operations, like web servers or apps with a graphical user interface.

import asyncio
from sdk_gen_sdk import SdkGenSdkAsync

sdk = SdkGenSdkAsync(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    timeout=10000
)


async def main():
  result = await sdk.build.get_build_summary(
    collection_id="1401852-88d69471-e9ea-47d2-b342-1f9d221812b2",
    build_id=1,
    specification_id="4575688a-8370-42a7-b35e-9bac2571dcc7"
)
  print(result)

asyncio.run(main())

Services

The SDK provides various services to interact with the API.

Below is a list of all available services:

Name
build
artifact
users
sdk
github
snippets
health_check
ping
doc

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models:

Name	Description
BuildSummaryResponseDto
BatchBuildSummariesResponseDto
BuildDto
BuildListItemResponseDto
CreateBuildRequest
BuildJobAcceptedResponseDto
WebhookResponseDto
CreateOneOffBuildRequest
CustomCodeUploadFormSchema
CustomCodeUploadResponseDto
UploadBuildRequest
UploadBuildSuccessResponseDto
BackfillResultResponseDto
SdkLanguageSchema
CurrentUserResponse
SdkExistsResponse
PublishedSdkResponse
SdkDownloadResponseDto
GithubConnectionsListResponseDto
CreateConnectionDto
GithubRepoConnectionResponseDto
SnippetResponse
HealthResponse
PingResponse
AuthenticatedPingResponseDto
BuildMetadataDto
BuildSummaryDetailsDto
BuildSummaryDownloadDto
BuildSummaryLogDto
BuildSummariesItemDto
ArtifactResponse
SdkResponse
BucketLocationDto
FillWorkspaceIdsResultDto
RegisterSdksResultDto
BackfillFailureItemDto
RegistrationFailureItemDto
TeamResponse
PingUserSummaryDto
ErrorResponse