ugcinc 1.1.5 → 1.1.7

package/README.md

@@ -1,100 +1,125 @@
-# ugcinc
-
-Official TypeScript/JavaScript client for the UGC Inc API.
-
-## Installation
-
-```bash
-npm install ugcinc
-```
-
-## Quick Start
-
-```typescript
-import { UGCClient } from 'ugcinc';
-
-const client = new UGCClient({
-  apiKey: 'your-api-key-here'
-});
-
-// Example: Get accounts
-const response = await client.accounts.getAccounts();
-
-if (response.ok) {
-  console.log(response.data);
-}
-```
-
-## Get Your API Key
-
-To get your API key:
-
-1. Visit [ugc.inc](https://ugc.inc)
-2. Schedule a call with our team
-3. You'll receive your API key after the call
-
-**Important:** Keep your API key secure! Never commit it to version control or expose it in client-side code.
-
-## Documentation
-
-For complete API documentation, including all endpoints, parameters, and examples, visit:
-
-**[docs.ugc.inc](https://docs.ugc.inc)**
-
-## API Features
-
-### Accounts
-- Get accounts with filters
-- Get account status
-- Update account info (tags, groups)
-- Update social profile (avatar, nickname, bio)
-
-### Posts
-- Create video posts
-- Create slideshow posts
-- Get post status
-- Get post statistics
-
-### Tasks
-- Get scheduled tasks
-- View task history
-
-### Statistics
-- Get account statistics
-- Get post statistics
-- Refresh statistics
-
-### Organization
-- Get API keys (metadata only, excludes key values for security)
-
-### Examples
-
-**Get your organization's API keys:**
-```typescript
-const response = await client.org.getApiKeys(); // POST /org/api-key
-
-if (response.ok) {
-  console.log(response.data); // [{ id: "...", created_at: "..." }]
-}
-```
-
-**Create a video post:**
-```typescript
-const response = await client.posts.createVideo({
-  accountId: 'account-uuid',
-  videoUrl: 'https://example.com/video.mp4',
-  caption: 'Check out this video!',
-});
-```
-
-## TypeScript Support
-
-This package is written in TypeScript and provides full type definitions:
-
-```typescript
-import type { Account, Post, Task, ApiKey, ApiResponse } from 'ugcinc';
-```
-
-## License
-
-MIT
+# ugcinc
+
+Official TypeScript/JavaScript client for the UGC Inc API.
+
+## Installation
+
+```bash
+npm install ugcinc
+```
+
+## Quick Start
+
+```typescript
+import { UGCClient } from 'ugcinc';
+
+const client = new UGCClient({
+  apiKey: 'your-api-key-here'
+});
+
+// Example: Get accounts
+const response = await client.accounts.getAccounts();
+
+if (response.ok) {
+  console.log(response.data);
+}
+```
+
+## Get Your API Key
+
+To get your API key:
+
+1. Visit [ugc.inc](https://ugc.inc)
+2. Schedule a call with our team
+3. You'll receive your API key after the call
+
+**Important:** Keep your API key secure! Never commit it to version control or expose it in client-side code.
+
+## Documentation
+
+For complete API documentation, including all endpoints, parameters, and examples, visit:
+
+**[docs.ugc.inc](https://docs.ugc.inc)**
+
+## API Features
+
+### Accounts
+- Get accounts with filters
+- Get account status
+- Update account info (tags, groups)
+- Update social profile (avatar, nickname, bio)
+
+### Posts
+- Create video posts
+- Create slideshow posts
+- Get post status
+- Get post statistics
+
+### Tasks
+- Get scheduled tasks
+- View task history
+
+### Statistics
+- Get account statistics
+- Get post statistics
+- Refresh statistics
+
+### Organization
+- Get API keys (metadata only, excludes key values for security)
+- Delete API keys
+- Edit API key names
+
+### Examples
+
+**Get your organization's API keys:**
+```typescript
+const response = await client.org.getApiKeys(); // POST /org/api-key
+
+if (response.ok) {
+  console.log(response.data); // [{ id: "...", name: "...", created_at: "..." }]
+}
+```
+
+**Delete an API key:**
+```typescript
+const response = await client.org.deleteApiKey({
+  apiKeyId: 'api-key-uuid'
+}); // POST /org/api-key/delete
+
+if (response.ok) {
+  console.log('API key deleted:', response.data.id);
+}
+```
+
+**Edit an API key's name:**
+```typescript
+const response = await client.org.editApiKey({
+  apiKeyId: 'api-key-uuid',
+  name: 'New Key Name'
+}); // POST /org/api-key/edit
+
+if (response.ok) {
+  console.log('Updated API key:', response.data); // { id, name, created_at }
+}
+```
+
+**Create a video post:**
+```typescript
+const response = await client.posts.createVideo({
+  accountId: 'account-uuid',
+  videoUrl: 'https://example.com/video.mp4',
+  caption: 'Check out this video!',
+});
+```
+
+## TypeScript Support
+
+This package is written in TypeScript and provides full type definitions:
+
+```typescript
+import type { Account, Post, Task, ApiKey, ApiResponse } from 'ugcinc';
+```
+
+## License
+
+MIT

package/dist/org.d.ts

@@ -1,5 +1,5 @@
 import { BaseClient } from './base';
-import type { ApiKey, ApiResponse } from './types';
+import type { ApiKey, ApiResponse, DeleteApiKeyParams, EditApiKeyParams } from './types';
 /**
  * Client for managing organization resources
  */
@@ -9,4 +9,16 @@ export declare class OrganizationClient extends BaseClient {
      * Note: The actual key values are not returned for security reasons
      */
     getApiKeys(): Promise<ApiResponse<ApiKey[]>>;
+    /**
+     * Delete an API key from your organization
+     * @param params - The parameters including the apiKeyId to delete
+     */
+    deleteApiKey(params: DeleteApiKeyParams): Promise<ApiResponse<{
+        id: string;
+    }>>;
+    /**
+     * Edit an API key's name
+     * @param params - The parameters including the apiKeyId and new name
+     */
+    editApiKey(params: EditApiKeyParams): Promise<ApiResponse<ApiKey>>;
 }

package/dist/org.js

@@ -13,5 +13,19 @@ class OrganizationClient extends base_1.BaseClient {
     async getApiKeys() {
         return this.post('/org/api-key');
     }
+    /**
+     * Delete an API key from your organization
+     * @param params - The parameters including the apiKeyId to delete
+     */
+    async deleteApiKey(params) {
+        return this.post('/org/api-key/delete', params);
+    }
+    /**
+     * Edit an API key's name
+     * @param params - The parameters including the apiKeyId and new name
+     */
+    async editApiKey(params) {
+        return this.post('/org/api-key/edit', params);
+    }
 }
 exports.OrganizationClient = OrganizationClient;

package/dist/types.d.ts

@@ -178,5 +178,13 @@ export interface RefreshStatsResponse {
  */
 export interface ApiKey {
     id: string;
+    name: string;
     created_at: string;
 }
+export interface DeleteApiKeyParams {
+    apiKeyId: string;
+}
+export interface EditApiKeyParams {
+    apiKeyId: string;
+    name: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ugcinc",
-  "version": "1.1.5",
+  "version": "1.1.7",
   "description": "TypeScript/JavaScript client for the UGC Inc API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",