celitech-sdk - npm Package Compare versions

Comparing version 1.1.86 to 1.1.87

dist/index.d.ts

@@ -7,3 +7,3 @@ import { ZodType, z } from 'zod';
 
-type HttpMethod$1 = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+type HttpMethod$1 = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD';
 interface HttpRequest {
@@ -101,3 +101,3 @@ baseUrl: string;
 
-type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD';
 interface SdkConfig {
@@ -117,3 +117,3 @@ baseUrl?: string;
 }
-interface HttpResponse<T> {
+interface HttpResponse<T = unknown> {
     data?: T;
@@ -120,0 +120,0 @@ metadata: HttpMetadata;

package.json

 {
   "name": "celitech-sdk",
-  "version": "1.1.86",
+  "version": "1.1.87",
   "description": "Welcome to the CELITECH API documentation!  Useful links: [Homepage](https://www.celitech.com) | [Support email](mailto:[e-mail]) | [Blog](https://www.celitech.com/blog/) ",
@@ -12,2 +12,3 @@ "source": "./src/index.ts",
   "scripts": {
+    "test": "tsc --noEmit",
     "build": "tsup-node src/index.ts --format cjs,esm --dts --clean",
@@ -33,3 +34,4 @@ "prepublishOnly": "npm run build"
   "dependencies": {
-    "zod": "3.22.0"
+    "zod": "3.22.0",
+    "axios": "^1.7.4"
   },
@@ -36,0 +38,0 @@ "exports": {

README.md

@@ -1,2 +0,2 @@
-# Celitech TypeScript SDK 1.1.86
+# Celitech TypeScript SDK 1.1.87
 
@@ -8,3 +8,3 @@ Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
 - API version: `1.1.0`
-- SDK version: `1.1.86`
+- SDK version: `1.1.87`
 
@@ -22,2 +22,3 @@ ## About the API
 - [Setting a Custom Timeout](#setting-a-custom-timeout)
+- [Sample Usage](#sample-usage)
 - [Services](#services)
@@ -62,2 +63,21 @@ - [Models](#models)
 
+# Sample Usage
+
+Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
+
+```ts
+import { Celitech } from 'celitech-sdk';
+
+(async () => {
+  const celitech = new Celitech({
+    clientId: 'client-id',
+    clientSecret: 'client-secret',
+  });
+
+  const { data } = await celitech.destinations.listDestinations();
+
+  console.log(data);
+})();
+```
+
 ## Services
@@ -64,0 +84,0 @@

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

223536

increased by1.01%

Lines of code

5639

increased by0.43%

Number of lines in readme file

127

increased by18.69%

Number of medium supply chain risk alerts

2

decreased by-60%

Worsened metrics

Dependency count

2

increased by100%

Dependency changes

• + Addedaxios@^1.7.4

• + Addedasynckit@0.4.0(transitive)

• + Addedaxios@1.7.9(transitive)

• + Addedcombined-stream@1.0.8(transitive)

• + Addeddelayed-stream@1.0.0(transitive)

• + Addedfollow-redirects@1.15.9(transitive)

• + Addedform-data@4.0.1(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedproxy-from-env@1.1.0(transitive)