@leadping/sdk 1.0.34 → 1.0.35

package/README.md

@@ -5,47 +5,77 @@
 
 # ![Leadping](https://leadping.ai/favicon.ico) Leadping TypeScript SDK
 
-Type-safe TypeScript client for the Leadping API.
+The official, type-safe TypeScript and JavaScript SDK for the Leadping API. Use it to integrate lead management, conversations, SMS and calling, automations, reporting, billing, and business settings into Node.js and server-side TypeScript applications.
 
-## Install
+The package is generated from the [Leadping OpenAPI specification](https://leadping.ai/docs/openapi.json) with Microsoft Kiota. It contains request builders and models; your application supplies the fetch request adapter, credentials, retry policy, and credential storage.
 
-```bash
-npm install @leadping/sdk
-```
+## Installation
 
-The generated client uses a Kiota request adapter. Install the default fetch adapter:
+Install the SDK and Kiota's fetch adapter:
 
 ```bash
-npm install @microsoft/kiota-http-fetchlibrary
+npm install @leadping/sdk @microsoft/kiota-http-fetchlibrary
 ```
 
-GitHub Packages is also available:
+The SDK package is `@leadping/sdk`. The similarly named `@leadpingai/sdk` package is only used when consuming releases from GitHub Packages.
 
-```bash
-npm config set @leadpingai:registry https://npm.pkg.github.com
-npm install @leadpingai/sdk
-```
+## Authentication
+
+Set `LEADPING_API_KEY` to a WorkOS organization API key (`sk_...`). The SDK sends it as `Authorization: Bearer <credential>`. User access tokens are also supported when acting for a signed-in user; `lp_src_...` keys are only for lead-ingestion endpoints. See [API authentication](https://leadping.ai/docs/api-authentication). Do not expose organization or source keys in browser code.
+
+## Create a client
 
-## Use
+Kiota's API-key authentication provider can place the complete Bearer value in the `Authorization` header:
 
 ```ts
 import { createLeadpingOpenApiClient } from "@leadping/sdk";
-
-const adapter = createLeadpingRequestAdapter();
+import {
+  ApiKeyAuthenticationProvider,
+  ApiKeyLocation,
+} from "@microsoft/kiota-abstractions";
+import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
+
+const credential = process.env.LEADPING_API_KEY;
+if (!credential) {
+  throw new Error("LEADPING_API_KEY is not set.");
+}
+
+const authProvider = new ApiKeyAuthenticationProvider(
+  `Bearer ${credential}`,
+  "Authorization",
+  ApiKeyLocation.Header,
+  new Set(["api.leadping.ai"]),
+);
+
+const adapter = new FetchRequestAdapter(authProvider);
 const client = createLeadpingOpenApiClient(adapter);
 
-const me = await client.users.me.get();
+const lead = await client.leads.byId("lead-id").get();
+console.log(lead?.id);
 ```
 
-`createLeadpingRequestAdapter` is application code. Configure it to send one of:
+The client defaults to `https://api.leadping.ai`.
+
+## Common operations
+
+Request builders mirror the API path. Methods such as `byId()` select a resource; terminal methods send the request.
 
-- `Authorization: Bearer <token>`
-- `X-Leadping-Api-Key: <key>`
+```ts
+// Requires a user access token.
+const currentUser = await client.users.me.get();
+
+// Retrieve organization resources by ID.
+const source = await client.sources.byId("source-id").get();
+const lead = await client.leads.byId("lead-id").get();
+```
 
-The client defaults to `https://api.leadping.ai` when the adapter does not already have a base URL.
+Create and update operations accept generated request-body types exported by `@leadping/sdk`.
 
-## Links
+## Resources
 
-- [Documentation](https://leadping.ai/docs)
+- [Leadping introduction](https://leadping.ai/docs/introduction)
+- [API authentication](https://leadping.ai/docs/api-authentication)
 - [API reference](https://leadping.ai/docs/api-reference)
+- [OpenAPI specification](https://leadping.ai/docs/openapi.json)
+- [npm package](https://www.npmjs.com/package/@leadping/sdk)
 - [License](LICENSE)

package/dist/sources/item/metrics/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface MetricsRequestBuilder extends BaseRequestBuilder<MetricsRequestBuilder> {
     /**
-     * Returns lead creation metrics for one organization intake source, including accepted, rejected, duplicate, validation, and recent activity counts for monitoring.
+     * View lead creation metrics for an organization intake source, including accepted, rejected, duplicate, validation, and recent activity counts.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<SourceMetricsResponse>}
      * @throws {ProblemDetails} error when the service returns a 401 status code
@@ -13,14 +13,14 @@ export interface MetricsRequestBuilder extends BaseRequestBuilder<MetricsRequest
      */
     get(requestConfiguration?: RequestConfiguration<MetricsRequestBuilderGetQueryParameters> | undefined): Promise<SourceMetricsResponse | undefined>;
     /**
-     * Returns lead creation metrics for one organization intake source, including accepted, rejected, duplicate, validation, and recent activity counts for monitoring.
+     * View lead creation metrics for an organization intake source, including accepted, rejected, duplicate, validation, and recent activity counts.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */
     toGetRequestInformation(requestConfiguration?: RequestConfiguration<MetricsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
 }
 /**
- * Returns lead creation metrics for one organization intake source, including accepted, rejected, duplicate, validation, and recent activity counts for monitoring.
+ * View lead creation metrics for an organization intake source, including accepted, rejected, duplicate, validation, and recent activity counts.
  */
 export interface MetricsRequestBuilderGetQueryParameters {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leadping/sdk",
-  "version": "1.0.34",
+  "version": "1.0.35",
   "description": "Typed TypeScript client for the Leadping API, generated from the Leadping OpenAPI document with Microsoft Kiota.",
   "type": "module",
   "license": "MIT",