npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

postman_client

v1.0.0

Published

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](https://learning.postman.com/docs/introduction/o

Downloads

5

Readme

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

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 |