@makeplane/plane-node-sdk 0.1.5 → 0.2.1

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2025 Plane Software, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,95 +1,142 @@
-## @makeplane/plane-node-sdk@0.1.5
+# Plane Node SDK
 
-This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
+A comprehensive TypeScript/JavaScript SDK for the Plane API, providing a clean and type-safe interface for all Plane operations.
 
-Environment
-* Node.js
-* Webpack
-* Browserify
+## Installation
 
-Language level
-* ES5 - you must have a Promises/A+ library installed
-* ES6
+```bash
+npm install @makeplane/plane-node-sdk
+```
 
-Module system
-* CommonJS
-* ES6 module system
+## ⚠️ Version 0.2.0 Breaking Changes
 
-It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
+**Important:** Version 0.2.0 introduces breaking changes with new API signatures. If you're migrating from version 0.1.x, please review the following:
 
-### Building
+- **New PlaneClient Structure**: Instead of importing each API separately, you now use a single `PlaneClient` instance that provides access to all APIs
+- **Updated Method Signatures**: Method parameters and return types have been updated for better readability and consistency
 
-To build and compile the typescript sources to javascript use:
-```
-npm install
-npm run build
-```
+**Migration Guide:**
+
+- Replace individual API imports with the new `PlaneClient` approach
+- Review the new API documentation for updated method signatures
+- Test thoroughly in a development environment before upgrading
 
-### Publishing
+## Quick Start
 
-First build the package then run `npm publish`
+```typescript
+import { PlaneClient } from "@plane/node-sdk";
 
-### Consuming
+const client = new PlaneClient({
+  apiKey: "your-api-key",
+});
 
-navigate to the folder of your consuming project and run one of the following commands.
+// Or with custom base URL
+const client = new PlaneClient({
+  baseUrl: "https://your-custom-api.plane.so",
+  accessToken: "your-access-token",
+});
 
-_published:_
+// List projects
+const projects = await client.projects.list();
 
+// Create a project
+const project = await client.projects.create("workspace-slug", {
+  name: "My Project",
+  description: "A new project",
+});
 ```
-npm install @makeplane/plane-node-sdk@0.1.5 --save
+
+## Features
+
+- ✅ TypeScript support with full type safety
+- ✅ Centralized HTTP logic with BaseResource
+- ✅ Automatic authentication handling
+- ✅ Modern async/await patterns
+- ✅ Extensible architecture
+
+## API Resources
+
+- **Projects**: Project management and organization
+- **WorkItems**: Issue and task management with full CRUD operations
+- **WorkItemTypes**: Custom work item type definitions and management
+- **WorkItemProperties**: Custom properties for work items
+- **Labels**: Issue categorization and tagging
+- **States**: Workflow state management
+- **Users**: User management and profiles
+- **Members**: Team membership and permissions
+- **Modules**: Feature organization and module management
+- **Cycles**: Sprint and iteration management
+- **Customers**: Customer management and operations
+- **Pages**: Workspace and project page management
+- **Links**: Work item linking and relationships
+- **Workspace**: Workspace-level operations
+- **Epics**: Epic management and organization
+- **Intake**: Intake form and request management
+- **Stickies**: Stickies management
+- **Teamspaces**: Teamspace management
+- **Initiatives**: Initiative management
+- **Features**: Workspace and project features management
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build the project
+pnpm build
+
+# Run tests
+pnpm test
+
+# Lint code
+pnpm lint
+
+# Format code
+pnpm format
 ```
 
-_unPublished (not recommended):_
+## Testing
 
+### Setup Test Environment
+
+Before running tests, you need to configure your test environment:
+
+1. **Copy the environment template:**
+
+   ```bash
+   cp env.example .env.test
+   ```
+
+2. **Update `.env.test` with your test environment values:**
+
+   ```bash
+   # Edit the file with your actual test environment details
+   nano .env.test
+   ```
+
+3. **Required environment variables:**
+   - `TEST_WORKSPACE_SLUG`: Your test workspace slug
+   - `TEST_PROJECT_ID`: Your test project ID
+   - `TEST_USER_ID`: Your test user ID
+   - `TEST_WORK_ITEM_ID`: A test work item ID
+   - `TEST_CUSTOMER_ID`: A test customer ID
+   - And other test-specific IDs as needed
+
+### Running Tests
+
+```bash
+# Run all tests (recommended)
+npm test
+# or
+pnpm test
+
+# Run specific test files
+pnpx ts-node tests/page.test.ts
+# or
+pnpm test page.test.ts
 ```
-npm install PATH_TO_GENERATED_PACKAGE --save
-```
 
-### Example Usage
-```ts
-import {
-  Configuration,
-  ProjectsApi,
-  UsersApi,
-} from "@makeplane/plane-node-sdk";
-
-async function testPlaneSDK() {
-  console.log("🚀 Testing Plane Node SDK...\n");
-
-  try {
-    // Create configuration using API Key Authentication
-    const config = new Configuration({
-      apiKey: "<PLANE_API_KEY>",
-    });
-
-    // Create configuration using OAuth Client Credentials Authentication
-    // const config = new Configuration({
-    //   accessToken: "<PLANE_ACCESS_TOKEN>",
-    // });
-
-    console.log("✅ Configuration created successfully");
-    console.log(`Base URL: ${config.basePath}\n`);
-
-    // Initialize APIs
-    const projectsApi = new ProjectsApi(config);
-    const usersApi = new UsersApi(config);
-
-    console.log("✅ APIs initialized successfully\n");
-
-    const user = await usersApi.getCurrentUser();
-    console.log(user);
-
-    const projectsResponse = await projectsApi.listProjects({
-      slug: "<workspace-slug>",
-    });
-    for (const project of projectsResponse.results) {
-      console.log(`${project.id} - ${project.name}`);
-    }
-  } catch (error) {
-    console.error("❌ Error initializing SDK:", error);
-  }
-}
-
-// Run the test
-testPlaneSDK().catch(console.error);
-```
+## License
+
+MIT

package/dist/Configuration.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Configuration class for Plane SDK
+ * Handles authentication and base URL configuration
+ */
+export declare class Configuration {
+    baseUrl: string;
+    apiKey?: string;
+    accessToken?: string;
+    enableLogging: boolean;
+    constructor(config: {
+        baseUrl?: string;
+        apiKey?: string;
+        accessToken?: string;
+        enableLogging?: boolean;
+    });
+    /**
+     * Validates that required configuration is present
+     */
+    validate(): void;
+}
+//# sourceMappingURL=Configuration.d.ts.map

package/dist/Configuration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Configuration.d.ts","sourceRoot":"","sources":["../src/Configuration.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,qBAAa,aAAa;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,OAAO,CAAC;gBAElB,MAAM,EAAE;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB;IAOD;;OAEG;IACI,QAAQ,IAAI,IAAI;CASxB"}

package/dist/Configuration.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Configuration = void 0;
+/**
+ * Configuration class for Plane SDK
+ * Handles authentication and base URL configuration
+ */
+class Configuration {
+    constructor(config) {
+        this.baseUrl = config.baseUrl || 'https://api.plane.so';
+        this.apiKey = config.apiKey;
+        this.accessToken = config.accessToken;
+        this.enableLogging = config.enableLogging || false;
+    }
+    /**
+     * Validates that required configuration is present
+     */
+    validate() {
+        if (!this.baseUrl) {
+            throw new Error('Base URL is required');
+        }
+        if (!this.apiKey && !this.accessToken) {
+            throw new Error('Either apiKey or accessToken must be provided');
+        }
+    }
+}
+exports.Configuration = Configuration;
+//# sourceMappingURL=Configuration.js.map

package/dist/Configuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Configuration.js","sourceRoot":"","sources":["../src/Configuration.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,MAAa,aAAa;IAMxB,YAAY,MAKX;QACC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,sBAAsB,CAAC;QACxD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,IAAI,KAAK,CAAC;IACrD,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC1C,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;CACF;AA9BD,sCA8BC"}

package/dist/api/BaseResource.d.ts

@@ -0,0 +1,55 @@
+import { Configuration } from "../Configuration";
+/**
+ * Base resource class containing HTTP logic and authentication
+ * All API resources should extend this class
+ */
+export declare abstract class BaseResource {
+    protected config: Configuration;
+    protected apiBasePath: string;
+    constructor(config: Configuration);
+    /**
+     * Sanitize headers to remove sensitive information
+     */
+    private sanitizeHeaders;
+    /**
+     * Sanitize data to remove sensitive information and limit size
+     */
+    private sanitizeData;
+    /**
+     * GET request
+     */
+    protected get<T>(endpoint: string, params?: any): Promise<T>;
+    /**
+     * POST request
+     */
+    protected post<T>(endpoint: string, data?: any): Promise<T>;
+    /**
+     * PUT request
+     */
+    protected put<T>(endpoint: string, data?: any): Promise<T>;
+    /**
+     * PATCH request
+     */
+    protected patch<T>(endpoint: string, data?: any): Promise<T>;
+    /**
+     * DELETE request
+     */
+    protected httpDelete(endpoint: string, data?: any): Promise<void>;
+    /**
+     * Builds the complete URL for API requests
+     */
+    protected buildUrl(endpoint: string): string;
+    /**
+     * Gets headers for API requests including authentication
+     */
+    protected getHeaders(): Record<string, string>;
+    /**
+     * Centralized error handling
+     */
+    protected handleError(error: any): never;
+    /**
+     * Setup axios interceptors for request and response logging
+     */
+    private setupInterceptors;
+}
+//# sourceMappingURL=BaseResource.d.ts.map

package/dist/api/BaseResource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseResource.d.ts","sourceRoot":"","sources":["../../src/api/BaseResource.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGjD;;;GAGG;AACH,8BAAsB,YAAY;IAChC,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC;IAChC,SAAS,CAAC,WAAW,EAAE,MAAM,CAAa;gBAE9B,MAAM,EAAE,aAAa;IAOjC;;OAEG;IACH,OAAO,CAAC,eAAe;IAgBvB;;OAEG;IACH,OAAO,CAAC,YAAY;IAYpB;;OAEG;cACa,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAYlE;;OAEG;cACa,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAWjE;;OAEG;cACa,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAWhE;;OAEG;cACa,KAAK,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAWlE;;OAEG;cACa,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAWvE;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAI5C;;OAEG;IACH,SAAS,CAAC,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAkB9C;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK;IAgBxC;;OAEG;IACH,OAAO,CAAC,iBAAiB;CAmB1B"}

package/dist/api/BaseResource.js

@@ -0,0 +1,180 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseResource = void 0;
+const axios_1 = __importDefault(require("axios"));
+const errors_1 = require("../errors");
+/**
+ * Base resource class containing HTTP logic and authentication
+ * All API resources should extend this class
+ */
+class BaseResource {
+    constructor(config) {
+        this.apiBasePath = "/api/v1";
+        this.config = config;
+        if (config.enableLogging) {
+            this.setupInterceptors();
+        }
+    }
+    /**
+     * Sanitize headers to remove sensitive information
+     */
+    sanitizeHeaders(headers) {
+        if (!headers)
+            return headers;
+        const sanitized = { ...headers };
+        const sensitiveKeys = ["authorization", "x-api-key", "cookie", "set-cookie"];
+        // iterate through sanitized and remove the sensitive keys
+        for (const key in sanitized) {
+            if (sensitiveKeys.includes(key.toLowerCase())) {
+                sanitized[key] = "[REDACTED]";
+            }
+        }
+        return sanitized;
+    }
+    /**
+     * Sanitize data to remove sensitive information and limit size
+     */
+    sanitizeData(data) {
+        if (!data)
+            return data;
+        // If data is too large, truncate it
+        const dataStr = JSON.stringify(data);
+        if (dataStr.length > 1000) {
+            return JSON.parse(dataStr.substring(0, 1000)) + "... [TRUNCATED]";
+        }
+        return data;
+    }
+    /**
+     * GET request
+     */
+    async get(endpoint, params) {
+        try {
+            const response = await axios_1.default.get(this.buildUrl(endpoint), {
+                headers: this.getHeaders(),
+                params,
+            });
+            return response.data;
+        }
+        catch (error) {
+            throw this.handleError(error);
+        }
+    }
+    /**
+     * POST request
+     */
+    async post(endpoint, data) {
+        try {
+            const response = await axios_1.default.post(this.buildUrl(endpoint), data, {
+                headers: this.getHeaders(),
+            });
+            return response.data;
+        }
+        catch (error) {
+            throw this.handleError(error);
+        }
+    }
+    /**
+     * PUT request
+     */
+    async put(endpoint, data) {
+        try {
+            const response = await axios_1.default.put(this.buildUrl(endpoint), data, {
+                headers: this.getHeaders(),
+            });
+            return response.data;
+        }
+        catch (error) {
+            throw this.handleError(error);
+        }
+    }
+    /**
+     * PATCH request
+     */
+    async patch(endpoint, data) {
+        try {
+            const response = await axios_1.default.patch(this.buildUrl(endpoint), data, {
+                headers: this.getHeaders(),
+            });
+            return response.data;
+        }
+        catch (error) {
+            throw this.handleError(error);
+        }
+    }
+    /**
+     * DELETE request
+     */
+    async httpDelete(endpoint, data) {
+        try {
+            await axios_1.default.delete(this.buildUrl(endpoint), {
+                headers: this.getHeaders(),
+                data,
+            });
+        }
+        catch (error) {
+            throw this.handleError(error);
+        }
+    }
+    /**
+     * Builds the complete URL for API requests
+     */
+    buildUrl(endpoint) {
+        return `${this.config.baseUrl}${this.apiBasePath}${endpoint}`;
+    }
+    /**
+     * Gets headers for API requests including authentication
+     */
+    getHeaders() {
+        const headers = {
+            "Content-Type": "application/json",
+        };
+        // Add API Key if available
+        if (this.config.apiKey) {
+            headers["X-Api-Key"] = this.config.apiKey;
+        }
+        // Add Access Token if available
+        if (this.config.accessToken) {
+            headers["Authorization"] = `Bearer ${this.config.accessToken}`;
+        }
+        return headers;
+    }
+    /**
+     * Centralized error handling
+     */
+    handleError(error) {
+        console.error("❌ [ERROR]", error);
+        if (error instanceof errors_1.HttpError) {
+            throw error;
+        }
+        if (axios_1.default.isAxiosError(error)) {
+            const statusCode = error.response?.status || 500;
+            const message = error.response?.data?.message || error.message || "Request failed";
+            throw new errors_1.HttpError(message, statusCode, error.response?.data);
+        }
+        throw new Error(`Unexpected error: ${error.message}`);
+    }
+    /**
+     * Setup axios interceptors for request and response logging
+     */
+    setupInterceptors() {
+        // Request interceptor
+        axios_1.default.interceptors.request.use((config) => {
+            console.log("🚀 [REQUEST]", {
+                method: config.method?.toUpperCase(),
+                url: config.url,
+                headers: this.sanitizeHeaders(config.headers),
+                data: config.data ? this.sanitizeData(config.data) : undefined,
+                params: config.params,
+            });
+            return config;
+        }, (error) => {
+            console.error("❌ [REQUEST ERROR]", error);
+            return Promise.reject(error);
+        });
+    }
+}
+exports.BaseResource = BaseResource;
+//# sourceMappingURL=BaseResource.js.map

package/dist/api/BaseResource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseResource.js","sourceRoot":"","sources":["../../src/api/BaseResource.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0D;AAE1D,sCAAsC;AAEtC;;;GAGG;AACH,MAAsB,YAAY;IAIhC,YAAY,MAAqB;QAFvB,gBAAW,GAAW,SAAS,CAAC;QAGxC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;YACzB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;OAEG;IACK,eAAe,CAAC,OAAY;QAClC,IAAI,CAAC,OAAO;YAAE,OAAO,OAAO,CAAC;QAE7B,MAAM,SAAS,GAAG,EAAE,GAAG,OAAO,EAAE,CAAC;QACjC,MAAM,aAAa,GAAG,CAAC,eAAe,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;QAE7E,0DAA0D;QAC1D,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC5B,IAAI,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;gBAC9C,SAAS,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;YAChC,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACK,YAAY,CAAC,IAAS;QAC5B,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QAEvB,oCAAoC;QACpC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,iBAAiB,CAAC;QACpE,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,GAAG,CAAI,QAAgB,EAAE,MAAY;QACnD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;gBAC3D,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;gBAC1B,MAAM;aACP,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,IAAI,CAAI,QAAgB,EAAE,IAAU;QAClD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,IAAI,CAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE;gBAClE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;aAC3B,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,GAAG,CAAI,QAAgB,EAAE,IAAU;QACjD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE;gBACjE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;aAC3B,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,KAAK,CAAI,QAAgB,EAAE,IAAU;QACnD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,KAAK,CAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE;gBACnE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;aAC3B,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,IAAU;QACrD,IAAI,CAAC;YACH,MAAM,eAAK,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;gBAC1C,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;gBAC1B,IAAI;aACL,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,QAAgB;QACjC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,GAAG,QAAQ,EAAE,CAAC;IAChE,CAAC;IAED;;OAEG;IACO,UAAU;QAClB,MAAM,OAAO,GAA2B;YACtC,cAAc,EAAE,kBAAkB;SACnC,CAAC;QAEF,2BAA2B;QAC3B,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACvB,OAAO,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;QAC5C,CAAC;QAED,gCAAgC;QAChC,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YAC5B,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QACjE,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACO,WAAW,CAAC,KAAU;QAC9B,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QAElC,IAAI,KAAK,YAAY,kBAAS,EAAE,CAAC;YAC/B,MAAM,KAAK,CAAC;QACd,CAAC;QAED,IAAI,eAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,CAAC;YACjD,MAAM,OAAO,GAAG,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,IAAI,KAAK,CAAC,OAAO,IAAI,gBAAgB,CAAC;YACnF,MAAM,IAAI,kBAAS,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACjE,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,qBAAqB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACK,iBAAiB;QACvB,sBAAsB;QACtB,eAAK,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAC5B,CAAC,MAAkC,EAAE,EAAE;YACrC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;gBAC1B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE;gBACpC,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC;gBAC7C,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;gBAC9D,MAAM,EAAE,MAAM,CAAC,MAAM;aACtB,CAAC,CAAC;YACH,OAAO,MAAM,CAAC;QAChB,CAAC,EACD,CAAC,KAAK,EAAE,EAAE;YACR,OAAO,CAAC,KAAK,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;YAC1C,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC,CACF,CAAC;IACJ,CAAC;CACF;AAzLD,oCAyLC"}

package/dist/api/Customers/Properties.d.ts

@@ -0,0 +1,44 @@
+import { BaseResource } from "../BaseResource";
+import { Configuration } from "../../Configuration";
+import { CustomerProperty, CustomerPropertyValue, UpdateCustomerPropertyValue, ListCustomerPropertyValuesParams, ListCustomerPropertiesParams, CreateCustomerPropertyRequest, UpdateCustomerPropertyRequest, CustomPropertyValueResponse } from "../../models/Customer";
+import { PaginatedResponse } from "../../models/common";
+/**
+ * Customer Properties API resource
+ * Handles customer property definitions and property value operations
+ */
+export declare class Properties extends BaseResource {
+    constructor(config: Configuration);
+    /**
+     * List customer properties
+     */
+    listPropertyDefinitions(workspaceSlug: string, params?: ListCustomerPropertiesParams): Promise<PaginatedResponse<CustomerProperty>>;
+    /**
+     * Create customer property
+     */
+    createPropertyDefinition(workspaceSlug: string, createProperty: CreateCustomerPropertyRequest): Promise<CustomerProperty>;
+    /**
+     * Retrieve customer property
+     */
+    retrievePropertyDefinition(workspaceSlug: string, propertyId: string): Promise<CustomerProperty>;
+    /**
+     * Update customer property
+     */
+    updatePropertyDefinition(workspaceSlug: string, propertyId: string, updateProperty: UpdateCustomerPropertyRequest): Promise<CustomerProperty>;
+    /**
+     * Delete customer property
+     */
+    deletePropertyDefinition(workspaceSlug: string, propertyId: string): Promise<void>;
+    /**
+     * Get customer property values
+     */
+    listValues(workspaceSlug: string, customerId: string, params?: ListCustomerPropertyValuesParams): Promise<CustomPropertyValueResponse>;
+    /**
+     * Get single property value
+     */
+    retrieveValue(workspaceSlug: string, customerId: string, propertyId: string): Promise<CustomerPropertyValue>;
+    /**
+     * Update single property value
+     */
+    updateValue(workspaceSlug: string, customerId: string, propertyId: string, updatePropertyValue: UpdateCustomerPropertyValue): Promise<CustomerPropertyValue>;
+}
+//# sourceMappingURL=Properties.d.ts.map

package/dist/api/Customers/Properties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Properties.d.ts","sourceRoot":"","sources":["../../../src/api/Customers/Properties.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,2BAA2B,EAC3B,gCAAgC,EAChC,4BAA4B,EAC5B,6BAA6B,EAC7B,6BAA6B,EAC7B,2BAA2B,EAC5B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;GAGG;AACH,qBAAa,UAAW,SAAQ,YAAY;gBAC9B,MAAM,EAAE,aAAa;IAMjC;;OAEG;IACG,uBAAuB,CAC3B,aAAa,EAAE,MAAM,EACrB,MAAM,CAAC,EAAE,4BAA4B,GACpC,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;IAI/C;;OAEG;IACG,wBAAwB,CAC5B,aAAa,EAAE,MAAM,EACrB,cAAc,EAAE,6BAA6B,GAC5C,OAAO,CAAC,gBAAgB,CAAC;IAI5B;;OAEG;IACG,0BAA0B,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAItG;;OAEG;IACG,wBAAwB,CAC5B,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,6BAA6B,GAC5C,OAAO,CAAC,gBAAgB,CAAC;IAO5B;;OAEG;IACG,wBAAwB,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxF;;OAEG;IACG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,gCAAgC,GACxC,OAAO,CAAC,2BAA2B,CAAC;IAOvC;;OAEG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAMlH;;OAEG;IACG,WAAW,CACf,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,mBAAmB,EAAE,2BAA2B,GAC/C,OAAO,CAAC,qBAAqB,CAAC;CAMlC"}

package/dist/api/Customers/Properties.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Properties = void 0;
+const BaseResource_1 = require("../BaseResource");
+/**
+ * Customer Properties API resource
+ * Handles customer property definitions and property value operations
+ */
+class Properties extends BaseResource_1.BaseResource {
+    constructor(config) {
+        super(config);
+    }
+    // ===== CUSTOMER PROPERTY DEFINITIONS API METHODS =====
+    /**
+     * List customer properties
+     */
+    async listPropertyDefinitions(workspaceSlug, params) {
+        return this.get(`/workspaces/${workspaceSlug}/customer-properties/`, params);
+    }
+    /**
+     * Create customer property
+     */
+    async createPropertyDefinition(workspaceSlug, createProperty) {
+        return this.post(`/workspaces/${workspaceSlug}/customer-properties/`, createProperty);
+    }
+    /**
+     * Retrieve customer property
+     */
+    async retrievePropertyDefinition(workspaceSlug, propertyId) {
+        return this.get(`/workspaces/${workspaceSlug}/customer-properties/${propertyId}/`);
+    }
+    /**
+     * Update customer property
+     */
+    async updatePropertyDefinition(workspaceSlug, propertyId, updateProperty) {
+        return this.patch(`/workspaces/${workspaceSlug}/customer-properties/${propertyId}/`, updateProperty);
+    }
+    /**
+     * Delete customer property
+     */
+    async deletePropertyDefinition(workspaceSlug, propertyId) {
+        return this.httpDelete(`/workspaces/${workspaceSlug}/customer-properties/${propertyId}/`);
+    }
+    // ===== CUSTOMER PROPERTY VALUES API METHODS =====
+    /**
+     * Get customer property values
+     */
+    async listValues(workspaceSlug, customerId, params) {
+        return this.get(`/workspaces/${workspaceSlug}/customers/${customerId}/property-values/`, params);
+    }
+    /**
+     * Get single property value
+     */
+    async retrieveValue(workspaceSlug, customerId, propertyId) {
+        return this.get(`/workspaces/${workspaceSlug}/customers/${customerId}/property-values/${propertyId}/`);
+    }
+    /**
+     * Update single property value
+     */
+    async updateValue(workspaceSlug, customerId, propertyId, updatePropertyValue) {
+        return this.patch(`/workspaces/${workspaceSlug}/customers/${customerId}/property-values/${propertyId}/`, updatePropertyValue);
+    }
+}
+exports.Properties = Properties;
+//# sourceMappingURL=Properties.js.map

package/dist/api/Customers/Properties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Properties.js","sourceRoot":"","sources":["../../../src/api/Customers/Properties.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAc/C;;;GAGG;AACH,MAAa,UAAW,SAAQ,2BAAY;IAC1C,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED,wDAAwD;IAExD;;OAEG;IACH,KAAK,CAAC,uBAAuB,CAC3B,aAAqB,EACrB,MAAqC;QAErC,OAAO,IAAI,CAAC,GAAG,CAAsC,eAAe,aAAa,uBAAuB,EAAE,MAAM,CAAC,CAAC;IACpH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB,CAC5B,aAAqB,EACrB,cAA6C;QAE7C,OAAO,IAAI,CAAC,IAAI,CAAmB,eAAe,aAAa,uBAAuB,EAAE,cAAc,CAAC,CAAC;IAC1G,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,0BAA0B,CAAC,aAAqB,EAAE,UAAkB;QACxE,OAAO,IAAI,CAAC,GAAG,CAAmB,eAAe,aAAa,wBAAwB,UAAU,GAAG,CAAC,CAAC;IACvG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB,CAC5B,aAAqB,EACrB,UAAkB,EAClB,cAA6C;QAE7C,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,wBAAwB,UAAU,GAAG,EACjE,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB,CAAC,aAAqB,EAAE,UAAkB;QACtE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,wBAAwB,UAAU,GAAG,CAAC,CAAC;IAC5F,CAAC;IAED,mDAAmD;IAEnD;;OAEG;IACH,KAAK,CAAC,UAAU,CACd,aAAqB,EACrB,UAAkB,EAClB,MAAyC;QAEzC,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,cAAc,UAAU,mBAAmB,EACvE,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,aAAqB,EAAE,UAAkB,EAAE,UAAkB;QAC/E,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,cAAc,UAAU,oBAAoB,UAAU,GAAG,CACtF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CACf,aAAqB,EACrB,UAAkB,EAClB,UAAkB,EAClB,mBAAgD;QAEhD,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,cAAc,UAAU,oBAAoB,UAAU,GAAG,EACrF,mBAAmB,CACpB,CAAC;IACJ,CAAC;CACF;AA9FD,gCA8FC"}