PostmanClient TypeScript SDK 1.0.0

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

Versions

• API version: 1.0
• SDK version: 1.0.0

About the API

The Postman API enables you to programmatically access data stored in your Postman account. For more information on the API, rate limiting, authentication, and policies click visit Postman's Documentation

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Authentication
  • API Key Authentication
• Services
• Models
• License

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: TypeScript >= 4.8.4

Installation

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

npm install postman_client

Authentication

API Key Authentication

The PostmanClient 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:

const sdk = new PostmanClient({ apiKey: 'YOUR_API_KEY' });

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

const sdk = new PostmanClient();
sdk.apiKey = 'YOUR_API_KEY';

Services

The SDK provides various services to interact with the API.

| Name | | :--------------------------------------------------------------------------------- | | BillingService | | ApiService | | TagsService | | AuditLogsService | | CollectionsService | | CollectionItemsService | | CollectionFoldersService | | CollectionRequestsService | | CollectionResponsesService | | SecretScannerService | | EnvironmentsService | | Import_Service | | UserService | | MocksService | | MonitorsService | | PrivateApiNetworkService | | PullRequestsService | | ApiSecurityService | | ScimService | | WebhooksService | | WorkspacesService |

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.

| Name | Description | | :----------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | InvoicesAccountInfo | Information about the account. | | GetAccountInvoices | | | GetAccountInvoicesStatus | | | GetApis | Information about the API schema. | | Accept | | | CreateApiRequest | Information about the API. | | CreateApiOkResponse | The API's base data schema. | | GetApi | | | GetApiInclude | | | UpdateApiRequest | Information about the API. | | UpdateApiOkResponse | Information about the API. | | AddApiCollectionRequest | | | AddApiCollectionOkResponse | | | SyncCollectionWithSchema | | | CommentResponse | | | CommentCreateUpdate | Information about the comment. | | CommentCreatedUpdated | | | CreateApiSchemaRequest | Information about the API schema. | | CreateApiSchemaOkResponse | Information about the created API schema. | | GetApiSchema | | | GetApiSchemaFiles | Information about the schema files and its meta information. | | GetApiSchemaFileContents | Information about the schema file. | | CreateUpdateApiSchemaFileRequest | Information about schema file. | | CreateUpdateApiSchemaFileOkResponse | Information about the schema file. | | GetStatusOfAnAsyncTask | | | GetApiVersions | Information about the API's versions. | | CreateApiVersionRequest | | | CreateApiVersionAcceptedResponse | | | GetApiVersion | | | UpdateApiVersionRequest | Information about the API version. | | UpdateApiVersionOkResponse | | | TagGetPut | | | TagUpdateTags | | | GetTaggedEntities | | | AscDescDefaultDesc | | | GetTaggedEntitiesEntityType | | | GetAuditLogs | | | GetCollections | | | CollectionsCreateCollectionRequest | | | CreateCollectionOkResponse | | | CreateCollectionForkRequest | | | CreateCollectionForkOkResponse | | | MergeCollectionForkRequest | | | MergeCollectionForkOkResponse | | | GetCollection | | | GetCollectionModel | | | PutCollectionRequest | | | PutCollectionOkResponse | | | PatchCollectionRequest | | | PatchCollectionOkResponse | | | DeleteCollection | | | GetCollectionsForkedByUser | | | AscDesc | | | GetCollectionForks | | | PullCollectionChanges | | | GetCollectionPullRequests | | | PullRequestCreate | Information about the pull request. | | PullRequestCreated | | | GetCollectionRoles | Information about the collection's roles. | | UpdateCollectionRoles | | | GetSourceCollectionStatus | | | TransformCollectionToOpenApi | | | Format | | | TransferCollectionItems | | | TransferCollectionItems200Error | | | CreateCollectionFolder |