@heymantle/core-api-client 0.1.14 → 0.1.16

package/dist/index.d.mts

@@ -306,7 +306,7 @@ interface AccountOwnersListResponse {
 interface CustomField {
     id: string;
     name: string;
-    type: 'string' | 'number' | 'boolean' | 'date' | 'select';
+    type: 'string' | 'number' | 'boolean' | 'date' | 'select' | 'select_single' | 'select_multiple' | 'url' | 'date_time' | 'json' | 'number_integer' | 'number_decimal';
     defaultValue?: unknown;
     options?: string[];
     appLevel?: boolean;
@@ -322,7 +322,7 @@ interface CustomField {
 interface CustomFieldCreateParams {
     appId: string;
     name: string;
-    type: 'string' | 'number' | 'boolean' | 'date' | 'select';
+    type: 'string' | 'number' | 'boolean' | 'date' | 'select' | 'select_single' | 'select_multiple' | 'url' | 'date_time' | 'json' | 'number_integer' | 'number_decimal';
     defaultValue?: unknown;
     options?: string[];
     appLevel?: boolean;
@@ -2168,7 +2168,11 @@ interface EntitiesSearchResponse {
 /**
  * Resource type for custom data
  */
-type CustomDataResourceType = 'ticket' | 'customer' | 'contact';
+type CustomDataResourceType = 'ticket' | 'customer' | 'contact' | 'deal' | 'conversation';
+/**
+ * Field type for custom data
+ */
+type CustomDataFieldType = 'string' | 'boolean' | 'url' | 'date' | 'date_time' | 'json' | 'number_integer' | 'number_decimal' | 'select_single' | 'select_multiple';
 /**
  * Parameters for setting custom data
  */
@@ -2176,7 +2180,7 @@ interface CustomDataSetParams {
     resourceId: string;
     resourceType: CustomDataResourceType;
     key: string;
-    value: string;
+    value: string | string[];
 }
 /**
  * Parameters for getting custom data
@@ -2193,7 +2197,10 @@ interface CustomDataResponse {
     resourceId: string;
     resourceType: CustomDataResourceType;
     key: string;
-    value: string;
+    value: string | boolean | number | object | string[];
+    type?: CustomDataFieldType;
+    name?: string;
+    options?: string[] | null;
 }
 /**
  * Parameters for deleting custom data
@@ -2327,6 +2334,69 @@ interface TimelineCommentUpdateResponse {
     dealEventId?: string | null;
 }
 
+interface List {
+    id: string;
+    name: string;
+    description: string | null;
+    customerCount?: number;
+    contactCount?: number;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ListEntity {
+    _type: 'customer' | 'contact';
+    id: string;
+    name: string;
+    email: string;
+    tags: string[];
+    createdAt: string;
+    domain?: string;
+    shopifyDomain?: string;
+    phone?: string;
+    jobTitle?: string;
+}
+interface ListListParams extends ListParams {
+    all?: boolean;
+}
+interface ListListResponse extends PaginatedResponse {
+    lists: List[];
+}
+interface ListRetrieveParams {
+    page?: number;
+    take?: number;
+    type?: 'customer' | 'contact';
+    search?: string;
+    sort?: 'name' | 'email' | 'createdAt' | 'updatedAt';
+    sortDirection?: 'asc' | 'desc';
+}
+interface ListRetrieveResponse extends PaginatedResponse {
+    list: List;
+    entities: ListEntity[];
+}
+interface ListCreateParams {
+    name: string;
+    description?: string;
+}
+interface ListUpdateParams {
+    name?: string;
+    description?: string;
+}
+interface ListAddEntitiesParams {
+    customerIds?: string[];
+    contactIds?: string[];
+}
+interface ListAddEntitiesResponse {
+    added: number;
+    skipped: number;
+}
+interface ListRemoveEntitiesParams {
+    customerIds?: string[];
+    contactIds?: string[];
+}
+interface ListRemoveEntitiesResponse {
+    removed: number;
+}
+
 /**
  * Resource for managing customers
  */
@@ -3574,6 +3644,66 @@ declare class TimelineCommentsResource extends BaseResource {
     del(id: string): Promise<DeleteResponse>;
 }
 
+declare class ListsResource extends BaseResource {
+    /**
+     * List all lists
+     *
+     * @param params - Optional list parameters
+     * @returns Paginated list of lists
+     */
+    list(params?: ListListParams): Promise<ListListResponse>;
+    /**
+     * Retrieve a specific list with its entities
+     *
+     * @param listId - The ID of the list
+     * @param params - Optional parameters to filter entities
+     * @returns The list with its entities
+     */
+    retrieve(listId: string, params?: ListRetrieveParams): Promise<ListRetrieveResponse>;
+    /**
+     * Create a new list
+     *
+     * @param data - List creation parameters
+     * @returns The created list
+     */
+    create(data: ListCreateParams): Promise<{
+        list: List;
+    }>;
+    /**
+     * Update an existing list
+     *
+     * @param listId - The ID of the list to update
+     * @param data - List update parameters
+     * @returns The updated list
+     */
+    update(listId: string, data: ListUpdateParams): Promise<{
+        list: List;
+    }>;
+    /**
+     * Delete a list
+     *
+     * @param listId - The ID of the list to delete
+     * @returns Delete confirmation
+     */
+    del(listId: string): Promise<DeleteResponse>;
+    /**
+     * Add customers and/or contacts to a list
+     *
+     * @param listId - The ID of the list
+     * @param data - IDs of customers and/or contacts to add
+     * @returns Count of added and skipped entities
+     */
+    addEntities(listId: string, data: ListAddEntitiesParams): Promise<ListAddEntitiesResponse>;
+    /**
+     * Remove customers and/or contacts from a list
+     *
+     * @param listId - The ID of the list
+     * @param data - IDs of customers and/or contacts to remove
+     * @returns Count of removed entities
+     */
+    removeEntities(listId: string, data: ListRemoveEntitiesParams): Promise<ListRemoveEntitiesResponse>;
+}
+
 /**
  * Mantle Core API Client
  *
@@ -3630,6 +3760,7 @@ declare class MantleCoreClient {
     readonly entities: EntitiesResource;
     readonly customData: CustomDataResource;
     readonly timelineComments: TimelineCommentsResource;
+    readonly lists: ListsResource;
     constructor(config: MantleCoreClientConfig);
     /**
      * Register a middleware function
@@ -3918,4 +4049,4 @@ interface RateLimitOptions {
  */
 declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
 
-export { type AccountOwner, type AccountOwnersListResponse, type Affiliate, type AffiliateCommission, type AffiliateCommissionListParams, type AffiliateCommissionListResponse, AffiliateCommissionsResource, type AffiliateListParams, type AffiliateListResponse, type AffiliatePayout, type AffiliatePayoutListParams, type AffiliatePayoutListResponse, AffiliatePayoutsResource, type AffiliateProgram, type AffiliateProgramCreateParams, type AffiliateProgramUpdateParams, AffiliateProgramsResource, type AffiliateReferral, type AffiliateReferralListParams, type AffiliateReferralListResponse, AffiliateReferralsResource, type AffiliateUpdateParams, AffiliatesResource, type Agent, type AgentCreateParams, type AgentListResponse, type AgentResponse, AgentsResource, type App, type AppEvent, type AppEventListParams, type AppEventListResponse, type AppInstallation, type AppInstallationParams, type AppListParams, AppsResource, type AuthRefreshOptions, BaseResource, type Channel, type ChannelCreateParams, type ChannelListParams, ChannelsResource, type Charge, type ChargeListParams, type ChargeListResponse, ChargesResource, CompaniesResource, type Company, type CompanyCreateParams, type CompanyListParams, type CompanyListResponse, type CompanyUpdateParams, type Contact, type ContactCreateParams, type ContactCreateResponse, type ContactEntity, type ContactListParams, type ContactListResponse, type ContactUpdateParams, ContactsResource, type CustomDataDeleteParams, type CustomDataGetParams, CustomDataResource, type CustomDataResourceType, type CustomDataResponse, type CustomDataSetParams, type CustomField, type CustomFieldCreateParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerEntity, type CustomerListParams, type CustomerListResponse, type CustomerRetrieveParams, type CustomerSegment, type CustomerSegmentListParams, type CustomerSegmentListResponse, CustomerSegmentsResource, type CustomerUpdateParams, CustomersResource, type DateRangeType, type Deal, DealActivitiesResource, type DealActivity, type DealActivityCreateParams, type DealActivityUpdateParams, type DealContactInput, type DealCreateParams, type DealCustomerInput, type DealEvent, type DealEventCreateParams, type DealEventCreateResponse, type DealEventListResponse, type DealFlow, type DealFlowCreateParams, type DealFlowUpdateParams, DealFlowsResource, type DealListParams, type DealListResponse, type DealProgression, type DealStage, type DealUpdateParams, DealsResource, type DeleteResponse, type DocCollection, type DocCollectionCreateParams, type DocCollectionUpdateParams, type DocGroup, type DocGroupCreateParams, type DocGroupUpdateParams, type DocPage, type DocPageCreateParams, type DocPageListParams, type DocPageListResponse, type DocPageStatus, type DocPageUpdateParams, type DocTreeNode, type DocTreeResponse, DocsResource, EntitiesResource, type EntitiesSearchParams, type EntitiesSearchResponse, type Entity, type EntityType, type Feature, type FeatureCreateParams, type FeatureUpdateParams, type Flow, type FlowCreateParams, type FlowListParams, type FlowListResponse, type FlowStatus, type FlowUpdateParams, FlowsResource, type HttpMethod, type ListParams, MantleAPIError, MantleAuthenticationError, MantleCoreClient, type MantleCoreClientConfig, MantleNotFoundError, MantlePermissionError, MantleRateLimitError, MantleValidationError, MeResource, type MeResponse, type MessageAttachment, type MetricDataPoint, type MetricType, type MetricsBaseParams, type MetricsGetParams, MetricsResource, type MetricsResponse, type Middleware, type MiddlewareContext, MiddlewareManager, type MiddlewareOptions, type MiddlewareRequest, type MiddlewareResponse, type NextFunction, type Organization, OrganizationResource, type PaginatedResponse, type Plan, type PlanCreateParams, type PlanFeature, type PlanListParams, type PlanListResponse, type PlanUpdateParams, type PlanUsageCharge, type RateLimitOptions, type RequestOptions, type Review, type ReviewCreateParams, type ReviewUpdateParams, type SocialProfile, type SocialProfileType, type Subscription, type SubscriptionListParams, type SubscriptionListResponse, SubscriptionsResource, type Task, type TaskCreateParams, type TaskListParams, type TaskListResponse, type TaskPriority, type TaskStatus, type TaskUpdateParams, type TaskUpdateResponse, TasksResource, type Ticket, type TicketContactData, type TicketCreateParams, type TicketListParams, type TicketListResponse, type TicketMessage, type TicketMessageCreateParams, type TicketMessageUpdateParams, type TicketUpdateParams, TicketsResource, type TimelineComment, type TimelineCommentAttachment, type TimelineCommentAttachmentInput, type TimelineCommentCreateParams, type TimelineCommentCreateResponse, type TimelineCommentListParams, type TimelineCommentListResponse, type TimelineCommentTaggedUser, type TimelineCommentTaggedUserInput, type TimelineCommentUpdateParams, type TimelineCommentUpdateResponse, type TimelineCommentUser, type TimelineEvent, type TimelineListParams, type TimelineListResponse, type TodoItem, type TodoItemCreateParams, type TodoItemInput, type TodoItemListResponse, type TodoItemUpdateParams, type Transaction, type TransactionListParams, type TransactionListResponse, TransactionsResource, type UsageEvent, type UsageEventCreateData, type UsageEventCreateParams, type UsageEventCreateResponse, type UsageEventListParams, type UsageEventListResponse, type UsageEventMetricsParams, UsageEventsResource, type UsageMetric, type UsageMetricCreateParams, type UsageMetricParams, type UsageMetricUpdateParams, type User, type UserListParams, type UserListResponse, UsersResource, type Webhook, type WebhookCreateParams, type WebhookFilter, type WebhookListResponse, type WebhookTopic, type WebhookUpdateParams, WebhooksResource, createAuthRefreshMiddleware, createRateLimitMiddleware };
+export { type AccountOwner, type AccountOwnersListResponse, type Affiliate, type AffiliateCommission, type AffiliateCommissionListParams, type AffiliateCommissionListResponse, AffiliateCommissionsResource, type AffiliateListParams, type AffiliateListResponse, type AffiliatePayout, type AffiliatePayoutListParams, type AffiliatePayoutListResponse, AffiliatePayoutsResource, type AffiliateProgram, type AffiliateProgramCreateParams, type AffiliateProgramUpdateParams, AffiliateProgramsResource, type AffiliateReferral, type AffiliateReferralListParams, type AffiliateReferralListResponse, AffiliateReferralsResource, type AffiliateUpdateParams, AffiliatesResource, type Agent, type AgentCreateParams, type AgentListResponse, type AgentResponse, AgentsResource, type App, type AppEvent, type AppEventListParams, type AppEventListResponse, type AppInstallation, type AppInstallationParams, type AppListParams, AppsResource, type AuthRefreshOptions, BaseResource, type Channel, type ChannelCreateParams, type ChannelListParams, ChannelsResource, type Charge, type ChargeListParams, type ChargeListResponse, ChargesResource, CompaniesResource, type Company, type CompanyCreateParams, type CompanyListParams, type CompanyListResponse, type CompanyUpdateParams, type Contact, type ContactCreateParams, type ContactCreateResponse, type ContactEntity, type ContactListParams, type ContactListResponse, type ContactUpdateParams, ContactsResource, type CustomDataDeleteParams, type CustomDataGetParams, CustomDataResource, type CustomDataResourceType, type CustomDataResponse, type CustomDataSetParams, type CustomField, type CustomFieldCreateParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerEntity, type CustomerListParams, type CustomerListResponse, type CustomerRetrieveParams, type CustomerSegment, type CustomerSegmentListParams, type CustomerSegmentListResponse, CustomerSegmentsResource, type CustomerUpdateParams, CustomersResource, type DateRangeType, type Deal, DealActivitiesResource, type DealActivity, type DealActivityCreateParams, type DealActivityUpdateParams, type DealContactInput, type DealCreateParams, type DealCustomerInput, type DealEvent, type DealEventCreateParams, type DealEventCreateResponse, type DealEventListResponse, type DealFlow, type DealFlowCreateParams, type DealFlowUpdateParams, DealFlowsResource, type DealListParams, type DealListResponse, type DealProgression, type DealStage, type DealUpdateParams, DealsResource, type DeleteResponse, type DocCollection, type DocCollectionCreateParams, type DocCollectionUpdateParams, type DocGroup, type DocGroupCreateParams, type DocGroupUpdateParams, type DocPage, type DocPageCreateParams, type DocPageListParams, type DocPageListResponse, type DocPageStatus, type DocPageUpdateParams, type DocTreeNode, type DocTreeResponse, DocsResource, EntitiesResource, type EntitiesSearchParams, type EntitiesSearchResponse, type Entity, type EntityType, type Feature, type FeatureCreateParams, type FeatureUpdateParams, type Flow, type FlowCreateParams, type FlowListParams, type FlowListResponse, type FlowStatus, type FlowUpdateParams, FlowsResource, type HttpMethod, type List, type ListAddEntitiesParams, type ListAddEntitiesResponse, type ListCreateParams, type ListEntity, type ListListParams, type ListListResponse, type ListParams, type ListRemoveEntitiesParams, type ListRemoveEntitiesResponse, type ListRetrieveParams, type ListRetrieveResponse, type ListUpdateParams, MantleAPIError, MantleAuthenticationError, MantleCoreClient, type MantleCoreClientConfig, MantleNotFoundError, MantlePermissionError, MantleRateLimitError, MantleValidationError, MeResource, type MeResponse, type MessageAttachment, type MetricDataPoint, type MetricType, type MetricsBaseParams, type MetricsGetParams, MetricsResource, type MetricsResponse, type Middleware, type MiddlewareContext, MiddlewareManager, type MiddlewareOptions, type MiddlewareRequest, type MiddlewareResponse, type NextFunction, type Organization, OrganizationResource, type PaginatedResponse, type Plan, type PlanCreateParams, type PlanFeature, type PlanListParams, type PlanListResponse, type PlanUpdateParams, type PlanUsageCharge, type RateLimitOptions, type RequestOptions, type Review, type ReviewCreateParams, type ReviewUpdateParams, type SocialProfile, type SocialProfileType, type Subscription, type SubscriptionListParams, type SubscriptionListResponse, SubscriptionsResource, type Task, type TaskCreateParams, type TaskListParams, type TaskListResponse, type TaskPriority, type TaskStatus, type TaskUpdateParams, type TaskUpdateResponse, TasksResource, type Ticket, type TicketContactData, type TicketCreateParams, type TicketListParams, type TicketListResponse, type TicketMessage, type TicketMessageCreateParams, type TicketMessageUpdateParams, type TicketUpdateParams, TicketsResource, type TimelineComment, type TimelineCommentAttachment, type TimelineCommentAttachmentInput, type TimelineCommentCreateParams, type TimelineCommentCreateResponse, type TimelineCommentListParams, type TimelineCommentListResponse, type TimelineCommentTaggedUser, type TimelineCommentTaggedUserInput, type TimelineCommentUpdateParams, type TimelineCommentUpdateResponse, type TimelineCommentUser, type TimelineEvent, type TimelineListParams, type TimelineListResponse, type TodoItem, type TodoItemCreateParams, type TodoItemInput, type TodoItemListResponse, type TodoItemUpdateParams, type Transaction, type TransactionListParams, type TransactionListResponse, TransactionsResource, type UsageEvent, type UsageEventCreateData, type UsageEventCreateParams, type UsageEventCreateResponse, type UsageEventListParams, type UsageEventListResponse, type UsageEventMetricsParams, UsageEventsResource, type UsageMetric, type UsageMetricCreateParams, type UsageMetricParams, type UsageMetricUpdateParams, type User, type UserListParams, type UserListResponse, UsersResource, type Webhook, type WebhookCreateParams, type WebhookFilter, type WebhookListResponse, type WebhookTopic, type WebhookUpdateParams, WebhooksResource, createAuthRefreshMiddleware, createRateLimitMiddleware };

package/dist/index.d.ts

@@ -306,7 +306,7 @@ interface AccountOwnersListResponse {
 interface CustomField {
     id: string;
     name: string;
-    type: 'string' | 'number' | 'boolean' | 'date' | 'select';
+    type: 'string' | 'number' | 'boolean' | 'date' | 'select' | 'select_single' | 'select_multiple' | 'url' | 'date_time' | 'json' | 'number_integer' | 'number_decimal';
     defaultValue?: unknown;
     options?: string[];
     appLevel?: boolean;
@@ -322,7 +322,7 @@ interface CustomField {
 interface CustomFieldCreateParams {
     appId: string;
     name: string;
-    type: 'string' | 'number' | 'boolean' | 'date' | 'select';
+    type: 'string' | 'number' | 'boolean' | 'date' | 'select' | 'select_single' | 'select_multiple' | 'url' | 'date_time' | 'json' | 'number_integer' | 'number_decimal';
     defaultValue?: unknown;
     options?: string[];
     appLevel?: boolean;
@@ -2168,7 +2168,11 @@ interface EntitiesSearchResponse {
 /**
  * Resource type for custom data
  */
-type CustomDataResourceType = 'ticket' | 'customer' | 'contact';
+type CustomDataResourceType = 'ticket' | 'customer' | 'contact' | 'deal' | 'conversation';
+/**
+ * Field type for custom data
+ */
+type CustomDataFieldType = 'string' | 'boolean' | 'url' | 'date' | 'date_time' | 'json' | 'number_integer' | 'number_decimal' | 'select_single' | 'select_multiple';
 /**
  * Parameters for setting custom data
  */
@@ -2176,7 +2180,7 @@ interface CustomDataSetParams {
     resourceId: string;
     resourceType: CustomDataResourceType;
     key: string;
-    value: string;
+    value: string | string[];
 }
 /**
  * Parameters for getting custom data
@@ -2193,7 +2197,10 @@ interface CustomDataResponse {
     resourceId: string;
     resourceType: CustomDataResourceType;
     key: string;
-    value: string;
+    value: string | boolean | number | object | string[];
+    type?: CustomDataFieldType;
+    name?: string;
+    options?: string[] | null;
 }
 /**
  * Parameters for deleting custom data
@@ -2327,6 +2334,69 @@ interface TimelineCommentUpdateResponse {
     dealEventId?: string | null;
 }
 
+interface List {
+    id: string;
+    name: string;
+    description: string | null;
+    customerCount?: number;
+    contactCount?: number;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ListEntity {
+    _type: 'customer' | 'contact';
+    id: string;
+    name: string;
+    email: string;
+    tags: string[];
+    createdAt: string;
+    domain?: string;
+    shopifyDomain?: string;
+    phone?: string;
+    jobTitle?: string;
+}
+interface ListListParams extends ListParams {
+    all?: boolean;
+}
+interface ListListResponse extends PaginatedResponse {
+    lists: List[];
+}
+interface ListRetrieveParams {
+    page?: number;
+    take?: number;
+    type?: 'customer' | 'contact';
+    search?: string;
+    sort?: 'name' | 'email' | 'createdAt' | 'updatedAt';
+    sortDirection?: 'asc' | 'desc';
+}
+interface ListRetrieveResponse extends PaginatedResponse {
+    list: List;
+    entities: ListEntity[];
+}
+interface ListCreateParams {
+    name: string;
+    description?: string;
+}
+interface ListUpdateParams {
+    name?: string;
+    description?: string;
+}
+interface ListAddEntitiesParams {
+    customerIds?: string[];
+    contactIds?: string[];
+}
+interface ListAddEntitiesResponse {
+    added: number;
+    skipped: number;
+}
+interface ListRemoveEntitiesParams {
+    customerIds?: string[];
+    contactIds?: string[];
+}
+interface ListRemoveEntitiesResponse {
+    removed: number;
+}
+
 /**
  * Resource for managing customers
  */
@@ -3574,6 +3644,66 @@ declare class TimelineCommentsResource extends BaseResource {
     del(id: string): Promise<DeleteResponse>;
 }
 
+declare class ListsResource extends BaseResource {
+    /**
+     * List all lists
+     *
+     * @param params - Optional list parameters
+     * @returns Paginated list of lists
+     */
+    list(params?: ListListParams): Promise<ListListResponse>;
+    /**
+     * Retrieve a specific list with its entities
+     *
+     * @param listId - The ID of the list
+     * @param params - Optional parameters to filter entities
+     * @returns The list with its entities
+     */
+    retrieve(listId: string, params?: ListRetrieveParams): Promise<ListRetrieveResponse>;
+    /**
+     * Create a new list
+     *
+     * @param data - List creation parameters
+     * @returns The created list
+     */
+    create(data: ListCreateParams): Promise<{
+        list: List;
+    }>;
+    /**
+     * Update an existing list
+     *
+     * @param listId - The ID of the list to update
+     * @param data - List update parameters
+     * @returns The updated list
+     */
+    update(listId: string, data: ListUpdateParams): Promise<{
+        list: List;
+    }>;
+    /**
+     * Delete a list
+     *
+     * @param listId - The ID of the list to delete
+     * @returns Delete confirmation
+     */
+    del(listId: string): Promise<DeleteResponse>;
+    /**
+     * Add customers and/or contacts to a list
+     *
+     * @param listId - The ID of the list
+     * @param data - IDs of customers and/or contacts to add
+     * @returns Count of added and skipped entities
+     */
+    addEntities(listId: string, data: ListAddEntitiesParams): Promise<ListAddEntitiesResponse>;
+    /**
+     * Remove customers and/or contacts from a list
+     *
+     * @param listId - The ID of the list
+     * @param data - IDs of customers and/or contacts to remove
+     * @returns Count of removed entities
+     */
+    removeEntities(listId: string, data: ListRemoveEntitiesParams): Promise<ListRemoveEntitiesResponse>;
+}
+
 /**
  * Mantle Core API Client
  *
@@ -3630,6 +3760,7 @@ declare class MantleCoreClient {
     readonly entities: EntitiesResource;
     readonly customData: CustomDataResource;
     readonly timelineComments: TimelineCommentsResource;
+    readonly lists: ListsResource;
     constructor(config: MantleCoreClientConfig);
     /**
      * Register a middleware function
@@ -3918,4 +4049,4 @@ interface RateLimitOptions {
  */
 declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
 
-export { type AccountOwner, type AccountOwnersListResponse, type Affiliate, type AffiliateCommission, type AffiliateCommissionListParams, type AffiliateCommissionListResponse, AffiliateCommissionsResource, type AffiliateListParams, type AffiliateListResponse, type AffiliatePayout, type AffiliatePayoutListParams, type AffiliatePayoutListResponse, AffiliatePayoutsResource, type AffiliateProgram, type AffiliateProgramCreateParams, type AffiliateProgramUpdateParams, AffiliateProgramsResource, type AffiliateReferral, type AffiliateReferralListParams, type AffiliateReferralListResponse, AffiliateReferralsResource, type AffiliateUpdateParams, AffiliatesResource, type Agent, type AgentCreateParams, type AgentListResponse, type AgentResponse, AgentsResource, type App, type AppEvent, type AppEventListParams, type AppEventListResponse, type AppInstallation, type AppInstallationParams, type AppListParams, AppsResource, type AuthRefreshOptions, BaseResource, type Channel, type ChannelCreateParams, type ChannelListParams, ChannelsResource, type Charge, type ChargeListParams, type ChargeListResponse, ChargesResource, CompaniesResource, type Company, type CompanyCreateParams, type CompanyListParams, type CompanyListResponse, type CompanyUpdateParams, type Contact, type ContactCreateParams, type ContactCreateResponse, type ContactEntity, type ContactListParams, type ContactListResponse, type ContactUpdateParams, ContactsResource, type CustomDataDeleteParams, type CustomDataGetParams, CustomDataResource, type CustomDataResourceType, type CustomDataResponse, type CustomDataSetParams, type CustomField, type CustomFieldCreateParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerEntity, type CustomerListParams, type CustomerListResponse, type CustomerRetrieveParams, type CustomerSegment, type CustomerSegmentListParams, type CustomerSegmentListResponse, CustomerSegmentsResource, type CustomerUpdateParams, CustomersResource, type DateRangeType, type Deal, DealActivitiesResource, type DealActivity, type DealActivityCreateParams, type DealActivityUpdateParams, type DealContactInput, type DealCreateParams, type DealCustomerInput, type DealEvent, type DealEventCreateParams, type DealEventCreateResponse, type DealEventListResponse, type DealFlow, type DealFlowCreateParams, type DealFlowUpdateParams, DealFlowsResource, type DealListParams, type DealListResponse, type DealProgression, type DealStage, type DealUpdateParams, DealsResource, type DeleteResponse, type DocCollection, type DocCollectionCreateParams, type DocCollectionUpdateParams, type DocGroup, type DocGroupCreateParams, type DocGroupUpdateParams, type DocPage, type DocPageCreateParams, type DocPageListParams, type DocPageListResponse, type DocPageStatus, type DocPageUpdateParams, type DocTreeNode, type DocTreeResponse, DocsResource, EntitiesResource, type EntitiesSearchParams, type EntitiesSearchResponse, type Entity, type EntityType, type Feature, type FeatureCreateParams, type FeatureUpdateParams, type Flow, type FlowCreateParams, type FlowListParams, type FlowListResponse, type FlowStatus, type FlowUpdateParams, FlowsResource, type HttpMethod, type ListParams, MantleAPIError, MantleAuthenticationError, MantleCoreClient, type MantleCoreClientConfig, MantleNotFoundError, MantlePermissionError, MantleRateLimitError, MantleValidationError, MeResource, type MeResponse, type MessageAttachment, type MetricDataPoint, type MetricType, type MetricsBaseParams, type MetricsGetParams, MetricsResource, type MetricsResponse, type Middleware, type MiddlewareContext, MiddlewareManager, type MiddlewareOptions, type MiddlewareRequest, type MiddlewareResponse, type NextFunction, type Organization, OrganizationResource, type PaginatedResponse, type Plan, type PlanCreateParams, type PlanFeature, type PlanListParams, type PlanListResponse, type PlanUpdateParams, type PlanUsageCharge, type RateLimitOptions, type RequestOptions, type Review, type ReviewCreateParams, type ReviewUpdateParams, type SocialProfile, type SocialProfileType, type Subscription, type SubscriptionListParams, type SubscriptionListResponse, SubscriptionsResource, type Task, type TaskCreateParams, type TaskListParams, type TaskListResponse, type TaskPriority, type TaskStatus, type TaskUpdateParams, type TaskUpdateResponse, TasksResource, type Ticket, type TicketContactData, type TicketCreateParams, type TicketListParams, type TicketListResponse, type TicketMessage, type TicketMessageCreateParams, type TicketMessageUpdateParams, type TicketUpdateParams, TicketsResource, type TimelineComment, type TimelineCommentAttachment, type TimelineCommentAttachmentInput, type TimelineCommentCreateParams, type TimelineCommentCreateResponse, type TimelineCommentListParams, type TimelineCommentListResponse, type TimelineCommentTaggedUser, type TimelineCommentTaggedUserInput, type TimelineCommentUpdateParams, type TimelineCommentUpdateResponse, type TimelineCommentUser, type TimelineEvent, type TimelineListParams, type TimelineListResponse, type TodoItem, type TodoItemCreateParams, type TodoItemInput, type TodoItemListResponse, type TodoItemUpdateParams, type Transaction, type TransactionListParams, type TransactionListResponse, TransactionsResource, type UsageEvent, type UsageEventCreateData, type UsageEventCreateParams, type UsageEventCreateResponse, type UsageEventListParams, type UsageEventListResponse, type UsageEventMetricsParams, UsageEventsResource, type UsageMetric, type UsageMetricCreateParams, type UsageMetricParams, type UsageMetricUpdateParams, type User, type UserListParams, type UserListResponse, UsersResource, type Webhook, type WebhookCreateParams, type WebhookFilter, type WebhookListResponse, type WebhookTopic, type WebhookUpdateParams, WebhooksResource, createAuthRefreshMiddleware, createRateLimitMiddleware };
+export { type AccountOwner, type AccountOwnersListResponse, type Affiliate, type AffiliateCommission, type AffiliateCommissionListParams, type AffiliateCommissionListResponse, AffiliateCommissionsResource, type AffiliateListParams, type AffiliateListResponse, type AffiliatePayout, type AffiliatePayoutListParams, type AffiliatePayoutListResponse, AffiliatePayoutsResource, type AffiliateProgram, type AffiliateProgramCreateParams, type AffiliateProgramUpdateParams, AffiliateProgramsResource, type AffiliateReferral, type AffiliateReferralListParams, type AffiliateReferralListResponse, AffiliateReferralsResource, type AffiliateUpdateParams, AffiliatesResource, type Agent, type AgentCreateParams, type AgentListResponse, type AgentResponse, AgentsResource, type App, type AppEvent, type AppEventListParams, type AppEventListResponse, type AppInstallation, type AppInstallationParams, type AppListParams, AppsResource, type AuthRefreshOptions, BaseResource, type Channel, type ChannelCreateParams, type ChannelListParams, ChannelsResource, type Charge, type ChargeListParams, type ChargeListResponse, ChargesResource, CompaniesResource, type Company, type CompanyCreateParams, type CompanyListParams, type CompanyListResponse, type CompanyUpdateParams, type Contact, type ContactCreateParams, type ContactCreateResponse, type ContactEntity, type ContactListParams, type ContactListResponse, type ContactUpdateParams, ContactsResource, type CustomDataDeleteParams, type CustomDataGetParams, CustomDataResource, type CustomDataResourceType, type CustomDataResponse, type CustomDataSetParams, type CustomField, type CustomFieldCreateParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerEntity, type CustomerListParams, type CustomerListResponse, type CustomerRetrieveParams, type CustomerSegment, type CustomerSegmentListParams, type CustomerSegmentListResponse, CustomerSegmentsResource, type CustomerUpdateParams, CustomersResource, type DateRangeType, type Deal, DealActivitiesResource, type DealActivity, type DealActivityCreateParams, type DealActivityUpdateParams, type DealContactInput, type DealCreateParams, type DealCustomerInput, type DealEvent, type DealEventCreateParams, type DealEventCreateResponse, type DealEventListResponse, type DealFlow, type DealFlowCreateParams, type DealFlowUpdateParams, DealFlowsResource, type DealListParams, type DealListResponse, type DealProgression, type DealStage, type DealUpdateParams, DealsResource, type DeleteResponse, type DocCollection, type DocCollectionCreateParams, type DocCollectionUpdateParams, type DocGroup, type DocGroupCreateParams, type DocGroupUpdateParams, type DocPage, type DocPageCreateParams, type DocPageListParams, type DocPageListResponse, type DocPageStatus, type DocPageUpdateParams, type DocTreeNode, type DocTreeResponse, DocsResource, EntitiesResource, type EntitiesSearchParams, type EntitiesSearchResponse, type Entity, type EntityType, type Feature, type FeatureCreateParams, type FeatureUpdateParams, type Flow, type FlowCreateParams, type FlowListParams, type FlowListResponse, type FlowStatus, type FlowUpdateParams, FlowsResource, type HttpMethod, type List, type ListAddEntitiesParams, type ListAddEntitiesResponse, type ListCreateParams, type ListEntity, type ListListParams, type ListListResponse, type ListParams, type ListRemoveEntitiesParams, type ListRemoveEntitiesResponse, type ListRetrieveParams, type ListRetrieveResponse, type ListUpdateParams, MantleAPIError, MantleAuthenticationError, MantleCoreClient, type MantleCoreClientConfig, MantleNotFoundError, MantlePermissionError, MantleRateLimitError, MantleValidationError, MeResource, type MeResponse, type MessageAttachment, type MetricDataPoint, type MetricType, type MetricsBaseParams, type MetricsGetParams, MetricsResource, type MetricsResponse, type Middleware, type MiddlewareContext, MiddlewareManager, type MiddlewareOptions, type MiddlewareRequest, type MiddlewareResponse, type NextFunction, type Organization, OrganizationResource, type PaginatedResponse, type Plan, type PlanCreateParams, type PlanFeature, type PlanListParams, type PlanListResponse, type PlanUpdateParams, type PlanUsageCharge, type RateLimitOptions, type RequestOptions, type Review, type ReviewCreateParams, type ReviewUpdateParams, type SocialProfile, type SocialProfileType, type Subscription, type SubscriptionListParams, type SubscriptionListResponse, SubscriptionsResource, type Task, type TaskCreateParams, type TaskListParams, type TaskListResponse, type TaskPriority, type TaskStatus, type TaskUpdateParams, type TaskUpdateResponse, TasksResource, type Ticket, type TicketContactData, type TicketCreateParams, type TicketListParams, type TicketListResponse, type TicketMessage, type TicketMessageCreateParams, type TicketMessageUpdateParams, type TicketUpdateParams, TicketsResource, type TimelineComment, type TimelineCommentAttachment, type TimelineCommentAttachmentInput, type TimelineCommentCreateParams, type TimelineCommentCreateResponse, type TimelineCommentListParams, type TimelineCommentListResponse, type TimelineCommentTaggedUser, type TimelineCommentTaggedUserInput, type TimelineCommentUpdateParams, type TimelineCommentUpdateResponse, type TimelineCommentUser, type TimelineEvent, type TimelineListParams, type TimelineListResponse, type TodoItem, type TodoItemCreateParams, type TodoItemInput, type TodoItemListResponse, type TodoItemUpdateParams, type Transaction, type TransactionListParams, type TransactionListResponse, TransactionsResource, type UsageEvent, type UsageEventCreateData, type UsageEventCreateParams, type UsageEventCreateResponse, type UsageEventListParams, type UsageEventListResponse, type UsageEventMetricsParams, UsageEventsResource, type UsageMetric, type UsageMetricCreateParams, type UsageMetricParams, type UsageMetricUpdateParams, type User, type UserListParams, type UserListResponse, UsersResource, type Webhook, type WebhookCreateParams, type WebhookFilter, type WebhookListResponse, type WebhookTopic, type WebhookUpdateParams, WebhooksResource, createAuthRefreshMiddleware, createRateLimitMiddleware };

package/dist/index.js

@@ -2013,6 +2013,90 @@ var TimelineCommentsResource = class extends BaseResource {
   }
 };
 
+// src/resources/lists.ts
+var ListsResource = class extends BaseResource {
+  /**
+   * List all lists
+   *
+   * @param params - Optional list parameters
+   * @returns Paginated list of lists
+   */
+  async list(params) {
+    const response = await this.get("/lists", params);
+    return {
+      lists: response.lists || [],
+      hasNextPage: response.hasNextPage || false,
+      hasPreviousPage: response.hasPreviousPage || false,
+      total: response.total
+    };
+  }
+  /**
+   * Retrieve a specific list with its entities
+   *
+   * @param listId - The ID of the list
+   * @param params - Optional parameters to filter entities
+   * @returns The list with its entities
+   */
+  async retrieve(listId, params) {
+    const response = await this.get(`/lists/${listId}`, params);
+    return {
+      list: response.list,
+      entities: response.entities || [],
+      hasNextPage: response.hasNextPage || false,
+      hasPreviousPage: response.hasPreviousPage || false,
+      total: response.total
+    };
+  }
+  /**
+   * Create a new list
+   *
+   * @param data - List creation parameters
+   * @returns The created list
+   */
+  async create(data) {
+    return this.post("/lists", data);
+  }
+  /**
+   * Update an existing list
+   *
+   * @param listId - The ID of the list to update
+   * @param data - List update parameters
+   * @returns The updated list
+   */
+  async update(listId, data) {
+    return this.put(`/lists/${listId}`, data);
+  }
+  /**
+   * Delete a list
+   *
+   * @param listId - The ID of the list to delete
+   * @returns Delete confirmation
+   */
+  async del(listId) {
+    return this._delete(`/lists/${listId}`);
+  }
+  /**
+   * Add customers and/or contacts to a list
+   *
+   * @param listId - The ID of the list
+   * @param data - IDs of customers and/or contacts to add
+   * @returns Count of added and skipped entities
+   */
+  async addEntities(listId, data) {
+    return this.post(`/lists/${listId}/add`, data);
+  }
+  /**
+   * Remove customers and/or contacts from a list
+   *
+   * @param listId - The ID of the list
+   * @param data - IDs of customers and/or contacts to remove
+   * @returns Count of removed entities
+   */
+  async removeEntities(listId, data) {
+    return this.post(`/lists/${listId}/remove`, data);
+  }
+};
+
 // src/client.ts
 var MantleCoreClient = class {
   constructor(config) {
@@ -2066,6 +2150,7 @@ var MantleCoreClient = class {
     this.entities = new EntitiesResource(this);
     this.customData = new CustomDataResource(this);
     this.timelineComments = new TimelineCommentsResource(this);
+    this.lists = new ListsResource(this);
   }
   /**
    * Register a middleware function

package/dist/index.mjs

@@ -1947,6 +1947,90 @@ var TimelineCommentsResource = class extends BaseResource {
   }
 };
 
+// src/resources/lists.ts
+var ListsResource = class extends BaseResource {
+  /**
+   * List all lists
+   *
+   * @param params - Optional list parameters
+   * @returns Paginated list of lists
+   */
+  async list(params) {
+    const response = await this.get("/lists", params);
+    return {
+      lists: response.lists || [],
+      hasNextPage: response.hasNextPage || false,
+      hasPreviousPage: response.hasPreviousPage || false,
+      total: response.total
+    };
+  }
+  /**
+   * Retrieve a specific list with its entities
+   *
+   * @param listId - The ID of the list
+   * @param params - Optional parameters to filter entities
+   * @returns The list with its entities
+   */
+  async retrieve(listId, params) {
+    const response = await this.get(`/lists/${listId}`, params);
+    return {
+      list: response.list,
+      entities: response.entities || [],
+      hasNextPage: response.hasNextPage || false,
+      hasPreviousPage: response.hasPreviousPage || false,
+      total: response.total
+    };
+  }
+  /**
+   * Create a new list
+   *
+   * @param data - List creation parameters
+   * @returns The created list
+   */
+  async create(data) {
+    return this.post("/lists", data);
+  }
+  /**
+   * Update an existing list
+   *
+   * @param listId - The ID of the list to update
+   * @param data - List update parameters
+   * @returns The updated list
+   */
+  async update(listId, data) {
+    return this.put(`/lists/${listId}`, data);
+  }
+  /**
+   * Delete a list
+   *
+   * @param listId - The ID of the list to delete
+   * @returns Delete confirmation
+   */
+  async del(listId) {
+    return this._delete(`/lists/${listId}`);
+  }
+  /**
+   * Add customers and/or contacts to a list
+   *
+   * @param listId - The ID of the list
+   * @param data - IDs of customers and/or contacts to add
+   * @returns Count of added and skipped entities
+   */
+  async addEntities(listId, data) {
+    return this.post(`/lists/${listId}/add`, data);
+  }
+  /**
+   * Remove customers and/or contacts from a list
+   *
+   * @param listId - The ID of the list
+   * @param data - IDs of customers and/or contacts to remove
+   * @returns Count of removed entities
+   */
+  async removeEntities(listId, data) {
+    return this.post(`/lists/${listId}/remove`, data);
+  }
+};
+
 // src/client.ts
 var MantleCoreClient = class {
   constructor(config) {
@@ -2000,6 +2084,7 @@ var MantleCoreClient = class {
     this.entities = new EntitiesResource(this);
     this.customData = new CustomDataResource(this);
     this.timelineComments = new TimelineCommentsResource(this);
+    this.lists = new ListsResource(this);
   }
   /**
    * Register a middleware function

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heymantle/core-api-client",
-  "version": "0.1.14",
+  "version": "0.1.16",
   "description": "TypeScript SDK for the Mantle Core API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",