@back23/promptly-sdk 2.0.1 → 2.2.0

package/dist/index.d.mts

@@ -621,6 +621,25 @@ interface UpdateEntityRecordData {
     data?: Record<string, any>;
     status?: 'active' | 'archived' | 'draft';
 }
+interface CreateEntityData {
+    name: string;
+    slug?: string;
+    description?: string;
+    schema: EntitySchema;
+    settings?: Record<string, any>;
+    icon?: string;
+    is_active?: boolean;
+}
+interface UpdateEntityData {
+    name?: string;
+    slug?: string;
+    description?: string;
+    schema?: EntitySchema;
+    settings?: Record<string, any>;
+    icon?: string;
+    is_active?: boolean;
+    sort_order?: number;
+}
 
 /**
  * Reservation types for Promptly SDK
@@ -805,7 +824,7 @@ declare class HttpClient {
     /**
      * DELETE request
      */
-    delete<T>(endpoint: string): Promise<T>;
+    delete<T>(endpoint: string, params?: Record<string, any>): Promise<T>;
     /**
      * Upload file
      */
@@ -1159,25 +1178,80 @@ declare class EntitiesResource {
     private http;
     constructor(http: HttpClient);
     /**
-     * List all active custom entities
-     * @returns Array of entities (always an array)
+     * List all custom entities
+     * @returns Array of entities
      *
      * @example
      * ```typescript
      * const entities = await client.entities.list();
-     * // [{ id: 1, name: 'Customer', slug: 'customer', ... }]
+     * // [{ id: 1, name: 'Customer', slug: 'customer', records_count: 150, ... }]
      * ```
      */
     list(): Promise<CustomEntity[]>;
     /**
-     * Get entity schema by slug
+     * Create a new entity definition
      *
      * @example
      * ```typescript
-     * const schema = await client.entities.getSchema('customer');
-     * // { fields: [{ name: 'company', label: '회사명', type: 'text', ... }] }
+     * const entity = await client.entities.create({
+     *   name: '고객',
+     *   slug: 'customers',  // optional, auto-generated from name
+     *   description: '고객 관리',
+     *   schema: {
+     *     fields: [
+     *       { name: 'company', label: '회사명', type: 'text', required: true },
+     *       { name: 'email', label: '이메일', type: 'email', required: true },
+     *       { name: 'status', label: '상태', type: 'select', options: [
+     *         { value: 'active', label: '활성' },
+     *         { value: 'inactive', label: '비활성' }
+     *       ]}
+     *     ]
+     *   },
+     *   icon: 'users'
+     * });
      * ```
      */
+    create(data: CreateEntityData): Promise<CustomEntity>;
+    /**
+     * Get entity definition by slug (includes schema)
+     *
+     * @example
+     * ```typescript
+     * const entity = await client.entities.get('customers');
+     * console.log(entity.schema.fields);
+     * ```
+     */
+    get(slug: string): Promise<CustomEntity>;
+    /**
+     * Update an entity definition
+     *
+     * @example
+     * ```typescript
+     * const updated = await client.entities.update('customers', {
+     *   name: '고객사',
+     *   description: '고객사 관리'
+     * });
+     * ```
+     */
+    update(slug: string, data: UpdateEntityData): Promise<CustomEntity>;
+    /**
+     * Delete an entity definition
+     * If entity has records, use force=true to delete anyway
+     *
+     * @example
+     * ```typescript
+     * // Will fail if entity has records
+     * await client.entities.delete('customers');
+     *
+     * // Force delete with all records
+     * await client.entities.delete('customers', true);
+     * ```
+     */
+    delete(slug: string, force?: boolean): Promise<void>;
+    /**
+     * Get entity schema (convenience method)
+     * @deprecated Use get(slug) instead - it includes schema
+     */
     getSchema(slug: string): Promise<EntitySchema>;
     /**
      * List records for an entity
@@ -1186,18 +1260,20 @@ declare class EntitiesResource {
      * @example
      * ```typescript
      * // Basic listing
-     * const customers = await client.entities.listRecords('customer');
+     * const customers = await client.entities.listRecords('customers');
      *
-     * // With pagination
-     * const customers = await client.entities.listRecords('customer', {
+     * // With pagination and search
+     * const customers = await client.entities.listRecords('customers', {
      *   page: 1,
      *   per_page: 20,
-     *   status: 'active',
+     *   search: 'ACME',
+     *   sort: 'company',
+     *   dir: 'asc'
      * });
      *
-     * // With filtering by data fields
-     * const vipCustomers = await client.entities.listRecords('customer', {
-     *   'data.tier': 'vip',
+     * // With filtering
+     * const vipCustomers = await client.entities.listRecords('customers', {
+     *   filters: JSON.stringify({ tier: 'vip' })
      * });
      * ```
      */
@@ -1207,46 +1283,44 @@ declare class EntitiesResource {
      *
      * @example
      * ```typescript
-     * const customer = await client.entities.getRecord('customer', 1);
+     * const customer = await client.entities.getRecord('customers', 1);
      * console.log(customer.data.company); // 'ABC Corp'
      * ```
      */
     getRecord(slug: string, id: number): Promise<EntityRecord>;
     /**
      * Create a new record
+     * Request body fields are defined by entity schema
      *
      * @example
      * ```typescript
-     * const newCustomer = await client.entities.createRecord('customer', {
-     *   data: {
-     *     company: 'ABC Corp',
-     *     email: 'contact@abc.com',
-     *     tier: 'standard',
-     *   },
-     *   status: 'active',
+     * const newCustomer = await client.entities.createRecord('customers', {
+     *   company: 'ABC Corp',
+     *   email: 'contact@abc.com',
+     *   tier: 'standard',
      * });
      * ```
      */
-    createRecord(slug: string, data: CreateEntityRecordData): Promise<EntityRecord>;
+    createRecord(slug: string, data: Record<string, any>): Promise<EntityRecord>;
     /**
      * Update a record
+     * Only provided fields will be updated, existing data is preserved
      *
      * @example
      * ```typescript
-     * const updated = await client.entities.updateRecord('customer', 1, {
-     *   data: {
-     *     tier: 'vip',
-     *   },
+     * const updated = await client.entities.updateRecord('customers', 1, {
+     *   tier: 'vip',
+     *   email: 'new@abc.com'
      * });
      * ```
      */
-    updateRecord(slug: string, id: number, data: UpdateEntityRecordData): Promise<EntityRecord>;
+    updateRecord(slug: string, id: number, data: Record<string, any>): Promise<EntityRecord>;
     /**
      * Delete a record
      *
      * @example
      * ```typescript
-     * await client.entities.deleteRecord('customer', 1);
+     * await client.entities.deleteRecord('customers', 1);
      * ```
      */
     deleteRecord(slug: string, id: number): Promise<void>;
@@ -1255,7 +1329,7 @@ declare class EntitiesResource {
      *
      * @example
      * ```typescript
-     * const record = await client.entities.getRecord('customer', 1);
+     * const record = await client.entities.getRecord('customers', 1);
      * const company = client.entities.getValue(record, 'company');
      * ```
      */
@@ -1271,7 +1345,7 @@ declare class EntitiesResource {
      *   tier: 'standard' | 'vip';
      * }
      *
-     * const customers = client.entities.typed<Customer>('customer');
+     * const customers = client.entities.typed<Customer>('customers');
      * const list = await customers.list(); // Typed records
      * const record = await customers.get(1);
      * console.log(record.data.company); // TypeScript knows this is string
@@ -1287,10 +1361,10 @@ declare class EntitiesResource {
         get: (id: number) => Promise<Omit<EntityRecord, "data"> & {
             data: T;
         }>;
-        create: (data: T, status?: EntityRecord["status"]) => Promise<Omit<EntityRecord, "data"> & {
+        create: (data: T) => Promise<Omit<EntityRecord, "data"> & {
             data: T;
         }>;
-        update: (id: number, data: Partial<T>, status?: EntityRecord["status"]) => Promise<Omit<EntityRecord, "data"> & {
+        update: (id: number, data: Partial<T>) => Promise<Omit<EntityRecord, "data"> & {
             data: T;
         }>;
         delete: (id: number) => Promise<void>;
@@ -1448,4 +1522,4 @@ declare class Promptly {
     getApiKey(): string | null;
 }
 
-export { type AddToCartData, type ApiError, type ApiResponse, type ApplyCouponData, type AuthResponse, type AvailableDatesParams, type AvailableSlotsParams, type BlogListParams, type BlogPost, type Board, type BoardComment, type BoardListParams, type BoardPost, type BoardSettings, type Cart, type CartItem, type Coupon, type CouponType, type CouponValidation, type CreateCommentData, type CreateEntityRecordData, type CreateOrderData, type CreatePostData, type CreateReservationData, type CreateReservationResult, type CustomEntity, type EntityField, type EntityListParams, type EntityRecord, type EntitySchema, type ForgotPasswordData, type Form, type FormField, type FormFieldOption, type FormFieldType, type FormFieldValidation, type FormListParams, type FormSettings, type FormSubmission, type ListParams, type ListResponse, type LoginCredentials, type Media, type Member, type Order, type OrderItem, type OrderListParams, type OrderStatus, type PaginatedResponse, type PaginationMeta, type Payment, type PaymentCancelData, type PaymentConfirmData, type PaymentMethod, type PaymentReadyData, type PaymentStatus, type PostListParams, type Product, type ProductCategory, type ProductListParams, type ProductOption, type ProductOptionValue, type ProductStatus, type ProductVariant, Promptly, type PromptlyConfig, PromptlyError, type RegisterData, type Reservation, type ReservationListParams, type ReservationService, type ReservationSettings, type ReservationSlot, type ReservationStaff, type ReservationStaffSummary, type ResetPasswordData, type SocialAuthUrl, type SocialProvider, type SubmissionListParams, type SubmitFormData, type UpdateCartItemData, type UpdateCommentData, type UpdateEntityRecordData, type UpdatePostData, type UpdateProfileData, Promptly as default };
+export { type AddToCartData, type ApiError, type ApiResponse, type ApplyCouponData, type AuthResponse, type AvailableDatesParams, type AvailableSlotsParams, type BlogListParams, type BlogPost, type Board, type BoardComment, type BoardListParams, type BoardPost, type BoardSettings, type Cart, type CartItem, type Coupon, type CouponType, type CouponValidation, type CreateCommentData, type CreateEntityData, type CreateEntityRecordData, type CreateOrderData, type CreatePostData, type CreateReservationData, type CreateReservationResult, type CustomEntity, type EntityField, type EntityListParams, type EntityRecord, type EntitySchema, type ForgotPasswordData, type Form, type FormField, type FormFieldOption, type FormFieldType, type FormFieldValidation, type FormListParams, type FormSettings, type FormSubmission, type ListParams, type ListResponse, type LoginCredentials, type Media, type Member, type Order, type OrderItem, type OrderListParams, type OrderStatus, type PaginatedResponse, type PaginationMeta, type Payment, type PaymentCancelData, type PaymentConfirmData, type PaymentMethod, type PaymentReadyData, type PaymentStatus, type PostListParams, type Product, type ProductCategory, type ProductListParams, type ProductOption, type ProductOptionValue, type ProductStatus, type ProductVariant, Promptly, type PromptlyConfig, PromptlyError, type RegisterData, type Reservation, type ReservationListParams, type ReservationService, type ReservationSettings, type ReservationSlot, type ReservationStaff, type ReservationStaffSummary, type ResetPasswordData, type SocialAuthUrl, type SocialProvider, type SubmissionListParams, type SubmitFormData, type UpdateCartItemData, type UpdateCommentData, type UpdateEntityData, type UpdateEntityRecordData, type UpdatePostData, type UpdateProfileData, Promptly as default };

package/dist/index.d.ts

@@ -621,6 +621,25 @@ interface UpdateEntityRecordData {
     data?: Record<string, any>;
     status?: 'active' | 'archived' | 'draft';
 }
+interface CreateEntityData {
+    name: string;
+    slug?: string;
+    description?: string;
+    schema: EntitySchema;
+    settings?: Record<string, any>;
+    icon?: string;
+    is_active?: boolean;
+}
+interface UpdateEntityData {
+    name?: string;
+    slug?: string;
+    description?: string;
+    schema?: EntitySchema;
+    settings?: Record<string, any>;
+    icon?: string;
+    is_active?: boolean;
+    sort_order?: number;
+}
 
 /**
  * Reservation types for Promptly SDK
@@ -805,7 +824,7 @@ declare class HttpClient {
     /**
      * DELETE request
      */
-    delete<T>(endpoint: string): Promise<T>;
+    delete<T>(endpoint: string, params?: Record<string, any>): Promise<T>;
     /**
      * Upload file
      */
@@ -1159,25 +1178,80 @@ declare class EntitiesResource {
     private http;
     constructor(http: HttpClient);
     /**
-     * List all active custom entities
-     * @returns Array of entities (always an array)
+     * List all custom entities
+     * @returns Array of entities
      *
      * @example
      * ```typescript
      * const entities = await client.entities.list();
-     * // [{ id: 1, name: 'Customer', slug: 'customer', ... }]
+     * // [{ id: 1, name: 'Customer', slug: 'customer', records_count: 150, ... }]
      * ```
      */
     list(): Promise<CustomEntity[]>;
     /**
-     * Get entity schema by slug
+     * Create a new entity definition
      *
      * @example
      * ```typescript
-     * const schema = await client.entities.getSchema('customer');
-     * // { fields: [{ name: 'company', label: '회사명', type: 'text', ... }] }
+     * const entity = await client.entities.create({
+     *   name: '고객',
+     *   slug: 'customers',  // optional, auto-generated from name
+     *   description: '고객 관리',
+     *   schema: {
+     *     fields: [
+     *       { name: 'company', label: '회사명', type: 'text', required: true },
+     *       { name: 'email', label: '이메일', type: 'email', required: true },
+     *       { name: 'status', label: '상태', type: 'select', options: [
+     *         { value: 'active', label: '활성' },
+     *         { value: 'inactive', label: '비활성' }
+     *       ]}
+     *     ]
+     *   },
+     *   icon: 'users'
+     * });
      * ```
      */
+    create(data: CreateEntityData): Promise<CustomEntity>;
+    /**
+     * Get entity definition by slug (includes schema)
+     *
+     * @example
+     * ```typescript
+     * const entity = await client.entities.get('customers');
+     * console.log(entity.schema.fields);
+     * ```
+     */
+    get(slug: string): Promise<CustomEntity>;
+    /**
+     * Update an entity definition
+     *
+     * @example
+     * ```typescript
+     * const updated = await client.entities.update('customers', {
+     *   name: '고객사',
+     *   description: '고객사 관리'
+     * });
+     * ```
+     */
+    update(slug: string, data: UpdateEntityData): Promise<CustomEntity>;
+    /**
+     * Delete an entity definition
+     * If entity has records, use force=true to delete anyway
+     *
+     * @example
+     * ```typescript
+     * // Will fail if entity has records
+     * await client.entities.delete('customers');
+     *
+     * // Force delete with all records
+     * await client.entities.delete('customers', true);
+     * ```
+     */
+    delete(slug: string, force?: boolean): Promise<void>;
+    /**
+     * Get entity schema (convenience method)
+     * @deprecated Use get(slug) instead - it includes schema
+     */
     getSchema(slug: string): Promise<EntitySchema>;
     /**
      * List records for an entity
@@ -1186,18 +1260,20 @@ declare class EntitiesResource {
      * @example
      * ```typescript
      * // Basic listing
-     * const customers = await client.entities.listRecords('customer');
+     * const customers = await client.entities.listRecords('customers');
      *
-     * // With pagination
-     * const customers = await client.entities.listRecords('customer', {
+     * // With pagination and search
+     * const customers = await client.entities.listRecords('customers', {
      *   page: 1,
      *   per_page: 20,
-     *   status: 'active',
+     *   search: 'ACME',
+     *   sort: 'company',
+     *   dir: 'asc'
      * });
      *
-     * // With filtering by data fields
-     * const vipCustomers = await client.entities.listRecords('customer', {
-     *   'data.tier': 'vip',
+     * // With filtering
+     * const vipCustomers = await client.entities.listRecords('customers', {
+     *   filters: JSON.stringify({ tier: 'vip' })
      * });
      * ```
      */
@@ -1207,46 +1283,44 @@ declare class EntitiesResource {
      *
      * @example
      * ```typescript
-     * const customer = await client.entities.getRecord('customer', 1);
+     * const customer = await client.entities.getRecord('customers', 1);
      * console.log(customer.data.company); // 'ABC Corp'
      * ```
      */
     getRecord(slug: string, id: number): Promise<EntityRecord>;
     /**
      * Create a new record
+     * Request body fields are defined by entity schema
      *
      * @example
      * ```typescript
-     * const newCustomer = await client.entities.createRecord('customer', {
-     *   data: {
-     *     company: 'ABC Corp',
-     *     email: 'contact@abc.com',
-     *     tier: 'standard',
-     *   },
-     *   status: 'active',
+     * const newCustomer = await client.entities.createRecord('customers', {
+     *   company: 'ABC Corp',
+     *   email: 'contact@abc.com',
+     *   tier: 'standard',
      * });
      * ```
      */
-    createRecord(slug: string, data: CreateEntityRecordData): Promise<EntityRecord>;
+    createRecord(slug: string, data: Record<string, any>): Promise<EntityRecord>;
     /**
      * Update a record
+     * Only provided fields will be updated, existing data is preserved
      *
      * @example
      * ```typescript
-     * const updated = await client.entities.updateRecord('customer', 1, {
-     *   data: {
-     *     tier: 'vip',
-     *   },
+     * const updated = await client.entities.updateRecord('customers', 1, {
+     *   tier: 'vip',
+     *   email: 'new@abc.com'
      * });
      * ```
      */
-    updateRecord(slug: string, id: number, data: UpdateEntityRecordData): Promise<EntityRecord>;
+    updateRecord(slug: string, id: number, data: Record<string, any>): Promise<EntityRecord>;
     /**
      * Delete a record
      *
      * @example
      * ```typescript
-     * await client.entities.deleteRecord('customer', 1);
+     * await client.entities.deleteRecord('customers', 1);
      * ```
      */
     deleteRecord(slug: string, id: number): Promise<void>;
@@ -1255,7 +1329,7 @@ declare class EntitiesResource {
      *
      * @example
      * ```typescript
-     * const record = await client.entities.getRecord('customer', 1);
+     * const record = await client.entities.getRecord('customers', 1);
      * const company = client.entities.getValue(record, 'company');
      * ```
      */
@@ -1271,7 +1345,7 @@ declare class EntitiesResource {
      *   tier: 'standard' | 'vip';
      * }
      *
-     * const customers = client.entities.typed<Customer>('customer');
+     * const customers = client.entities.typed<Customer>('customers');
      * const list = await customers.list(); // Typed records
      * const record = await customers.get(1);
      * console.log(record.data.company); // TypeScript knows this is string
@@ -1287,10 +1361,10 @@ declare class EntitiesResource {
         get: (id: number) => Promise<Omit<EntityRecord, "data"> & {
             data: T;
         }>;
-        create: (data: T, status?: EntityRecord["status"]) => Promise<Omit<EntityRecord, "data"> & {
+        create: (data: T) => Promise<Omit<EntityRecord, "data"> & {
             data: T;
         }>;
-        update: (id: number, data: Partial<T>, status?: EntityRecord["status"]) => Promise<Omit<EntityRecord, "data"> & {
+        update: (id: number, data: Partial<T>) => Promise<Omit<EntityRecord, "data"> & {
             data: T;
         }>;
         delete: (id: number) => Promise<void>;
@@ -1448,4 +1522,4 @@ declare class Promptly {
     getApiKey(): string | null;
 }
 
-export { type AddToCartData, type ApiError, type ApiResponse, type ApplyCouponData, type AuthResponse, type AvailableDatesParams, type AvailableSlotsParams, type BlogListParams, type BlogPost, type Board, type BoardComment, type BoardListParams, type BoardPost, type BoardSettings, type Cart, type CartItem, type Coupon, type CouponType, type CouponValidation, type CreateCommentData, type CreateEntityRecordData, type CreateOrderData, type CreatePostData, type CreateReservationData, type CreateReservationResult, type CustomEntity, type EntityField, type EntityListParams, type EntityRecord, type EntitySchema, type ForgotPasswordData, type Form, type FormField, type FormFieldOption, type FormFieldType, type FormFieldValidation, type FormListParams, type FormSettings, type FormSubmission, type ListParams, type ListResponse, type LoginCredentials, type Media, type Member, type Order, type OrderItem, type OrderListParams, type OrderStatus, type PaginatedResponse, type PaginationMeta, type Payment, type PaymentCancelData, type PaymentConfirmData, type PaymentMethod, type PaymentReadyData, type PaymentStatus, type PostListParams, type Product, type ProductCategory, type ProductListParams, type ProductOption, type ProductOptionValue, type ProductStatus, type ProductVariant, Promptly, type PromptlyConfig, PromptlyError, type RegisterData, type Reservation, type ReservationListParams, type ReservationService, type ReservationSettings, type ReservationSlot, type ReservationStaff, type ReservationStaffSummary, type ResetPasswordData, type SocialAuthUrl, type SocialProvider, type SubmissionListParams, type SubmitFormData, type UpdateCartItemData, type UpdateCommentData, type UpdateEntityRecordData, type UpdatePostData, type UpdateProfileData, Promptly as default };
+export { type AddToCartData, type ApiError, type ApiResponse, type ApplyCouponData, type AuthResponse, type AvailableDatesParams, type AvailableSlotsParams, type BlogListParams, type BlogPost, type Board, type BoardComment, type BoardListParams, type BoardPost, type BoardSettings, type Cart, type CartItem, type Coupon, type CouponType, type CouponValidation, type CreateCommentData, type CreateEntityData, type CreateEntityRecordData, type CreateOrderData, type CreatePostData, type CreateReservationData, type CreateReservationResult, type CustomEntity, type EntityField, type EntityListParams, type EntityRecord, type EntitySchema, type ForgotPasswordData, type Form, type FormField, type FormFieldOption, type FormFieldType, type FormFieldValidation, type FormListParams, type FormSettings, type FormSubmission, type ListParams, type ListResponse, type LoginCredentials, type Media, type Member, type Order, type OrderItem, type OrderListParams, type OrderStatus, type PaginatedResponse, type PaginationMeta, type Payment, type PaymentCancelData, type PaymentConfirmData, type PaymentMethod, type PaymentReadyData, type PaymentStatus, type PostListParams, type Product, type ProductCategory, type ProductListParams, type ProductOption, type ProductOptionValue, type ProductStatus, type ProductVariant, Promptly, type PromptlyConfig, PromptlyError, type RegisterData, type Reservation, type ReservationListParams, type ReservationService, type ReservationSettings, type ReservationSlot, type ReservationStaff, type ReservationStaffSummary, type ResetPasswordData, type SocialAuthUrl, type SocialProvider, type SubmissionListParams, type SubmitFormData, type UpdateCartItemData, type UpdateCommentData, type UpdateEntityData, type UpdateEntityRecordData, type UpdatePostData, type UpdateProfileData, Promptly as default };