SdkGenSdk 1.0.0

SdkGenSdk C# 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: C# >= .NET 6

Installation

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

dotnet add package SdkGenSdk

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:

using SdkGenSdk;
using SdkGenSdk.Config;

var config = new SdkGenSdkConfig()
{
	BasicAuth = new BasicAuthConfig("YOUR_USERNAME", "YOUR_PASSWORD")
};

var client = new SdkGenSdkClient(config);

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

client.SetBasicAuth("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:

using SdkGenSdk;
using SdkGenSdk.Config;

var config = new SdkGenSdkConfig()
{
	ApiKeyAuth = new ApiKeyAuthConfig("YOUR_API_KEY")
};

var client = new SdkGenSdkClient(config);

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

client.SetApiKey("YOUR_API_KEY")

Setting a Custom Timeout

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

client.SetTimeout(TimeSpan.FromSeconds(10))

Sample Usage

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

using SdkGenSdk;
using SdkGenSdk.Config;
using Environment = SdkGenSdk.Http.Environment;

var apiKeyConfig = new ApiKeyAuthConfig("YOUR_API_KEY");

var config = new SdkGenSdkConfig
{
  ApiKeyAuth = apiKeyConfig
};

var client = new SdkGenSdkClient(config);

var response = await client.Build.GetBuildSummaryAsync("1401852-88d69471-e9ea-47d2-b342-1f9d221812b2", 1, "4575688a-8370-42a7-b35e-9bac2571dcc7");

Console.WriteLine(response);

Services

The SDK provides various services to interact with the API.

Below is a list of all available services:

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: