Merge pull request #129 from Space-DF/feat/implement-api-get-org-feature

feat: implement api get org feature

Author: huyphan02

api.doc.md

@@ -27,6 +27,7 @@
 -   [Trip](#trip)
 -   [Telemetry](#telemetry)
 -   [Custom Domains](#custom-domains)
+-   [Plans](#plans)
 
 # Auth
 
@@ -4625,3 +4626,119 @@ console.log(response.org_name);
 ```
 
 </details>
+
+---
+
+# Plans
+
+## Overview
+
+The `Plans` class provides methods for retrieving subscription plans, including their pricing items, features, and support entitlements.
+
+## Types
+
+### PlanCode
+
+```typescript
+type PlanCode = 'free' | 'pro';
+```
+
+### BillingCycle
+
+```typescript
+type BillingCycle = 'monthly' | 'yearly';
+```
+
+### FeatureValueType
+
+```typescript
+type FeatureValueType = 'limit' | 'boolean' | 'quota';
+```
+
+### Plan
+
+```typescript
+interface Plan {
+    id: string; // Unique identifier of the plan
+    name: string; // Human-readable plan name (e.g. "Free")
+    code: PlanCode; // Machine-readable plan code (e.g. "free")
+    description: string; // Description of the plan
+    plan_items: PlanItem[]; // Pricing options for each billing cycle
+    is_current_plan: boolean; // Whether this is the caller's current plan
+    created_at: string; // Creation timestamp (ISO 8601 format)
+    updated_at: string; // Last update timestamp (ISO 8601 format)
+    features: PlanFeature[]; // Feature entitlements for the plan
+    support: PlanFeature[]; // Support entitlements for the plan
+}
+```
+
+### PlanItem
+
+```typescript
+interface PlanItem {
+    id: string; // Unique identifier of the plan item
+    price: string; // Price as a decimal string (e.g. "0.00")
+    icon: string; // Icon reference for the plan item
+    currency: string; // Currency code (e.g. "USD")
+    discount: number; // Discount applied to the price
+    billing_cycle: BillingCycle; // Billing cycle for this item
+    is_active: boolean; // Whether this item is currently active
+    created_at: string; // Creation timestamp (ISO 8601 format)
+    updated_at: string; // Last update timestamp (ISO 8601 format)
+}
+```
+
+### PlanFeature
+
+```typescript
+interface PlanFeature {
+    id: string; // Unique identifier of the plan feature
+    feature: Feature; // The underlying feature definition
+    enabled: boolean; // Whether the feature is enabled for the plan
+    limit_value: number | null; // Numeric limit/quota, or null for boolean features
+    metadata: Record<string, unknown>; // Additional feature metadata
+}
+```
+
+### Feature
+
+```typescript
+interface Feature {
+    id: string; // Unique identifier of the feature
+    code: string; // Machine-readable feature code (e.g. "device.max_count")
+    name: string; // Human-readable feature name
+    description: string; // Description of the feature
+    value_type: FeatureValueType; // How the feature's value is interpreted
+}
+```
+
+## Methods
+
+<details>
+  <summary><strong>retrieve</strong></summary>
+
+Retrieve a plan by its code.
+
+**Signature:**
+
+```typescript
+retrieve(plan: PlanCode, options?: Core.RequestOptions): Core.APIPromise<Plan>
+```
+
+**Parameters:**
+
+-   `plan` _(PlanCode)_: The plan code identifying the plan (`'free'` or `'pro'`).
+-   `options` _(Core.RequestOptions, optional)_: Additional request options.
+
+**Returns:** `Promise<Plan>`
+
+**Example:**
+
+```typescript
+const plan = await client.plans.retrieve('free');
+console.log(plan.name);
+console.log(plan.is_current_plan);
+console.log(plan.features.map((f) => f.feature.code));
+```
+
+</details>

src/index.ts

@@ -151,6 +151,7 @@ export class SpaceDFSDK extends Core.APIClient {
     organizations: API.Organizations = new API.Organizations(this);
     telemetry: API.Telemetry = new API.Telemetry(this);
     customDomains: API.CustomDomain = new API.CustomDomain(this);
+    plans: API.Plans = new API.Plans(this);
 
     protected override defaultQuery(): Core.DefaultQuery | undefined {
         return this._options.defaultQuery;

src/resources/index.ts

@@ -11,3 +11,4 @@ export * from './device/index';
 export * from './organizations/index';
 export * from './telemetry/index';
 export * from './custom-domains/index';
+export * from './plans/index';

src/resources/plans/index.ts

@@ -0,0 +1 @@
+export * from './plans';

src/resources/plans/plans.ts

@@ -0,0 +1,56 @@
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+
+export class Plans extends APIResource {
+    retrieve(plan: PlanCode, options?: Core.RequestOptions): Core.APIPromise<Plan> {
+        Core.ensurePresent(plan);
+        return this._client.get(`/plans/${plan}`, options);
+    }
+}
+
+export type PlanCode = 'free' | 'pro';
+
+export type BillingCycle = 'monthly' | 'yearly';
+
+export type FeatureValueType = 'limit' | 'boolean' | 'quota';
+
+export interface Plan {
+    id: string;
+    name: string;
+    code: PlanCode;
+    description: string;
+    plan_items: PlanItem[];
+    is_current_plan: boolean;
+    created_at: string;
+    updated_at: string;
+    features: PlanFeature[];
+    support: PlanFeature[];
+}
+
+export interface PlanItem {
+    id: string;
+    price: string;
+    icon: string;
+    currency: string;
+    discount: number;
+    billing_cycle: BillingCycle;
+    is_active: boolean;
+    created_at: string;
+    updated_at: string;
+}
+
+export interface PlanFeature {
+    id: string;
+    feature: Feature;
+    enabled: boolean;
+    limit_value: number | null;
+    metadata: Record<string, unknown>;
+}
+
+export interface Feature {
+    id: string;
+    code: string;
+    name: string;
+    description: string;
+    value_type: FeatureValueType;
+}