@jokoor/sdk
Version:
Jokoor SMS API SDK for JavaScript/TypeScript
50 lines • 1.51 kB
TypeScript
/**
* Contacts resource - User-friendly wrapper for SMS contacts API
*/
import { BaseResource, PaginatedResponse } from './base';
import type { ContactResponse, ContactCreateParams, ContactUpdateParams } from '../types/responses';
import { Result } from '../types/result';
export declare class Contacts extends BaseResource {
private api;
constructor(configuration: any);
/**
* Create a new contact
* @param params Contact creation parameters
* @returns Created contact
*/
create(params: ContactCreateParams): Promise<Result<ContactResponse>>;
/**
* Get a contact by ID
* @param id Contact ID
* @returns Contact details
*/
get(id: string): Promise<Result<ContactResponse>>;
/**
* Update a contact
* @param id Contact ID
* @param params Update parameters
* @returns Updated contact
*/
update(id: string, params: ContactUpdateParams): Promise<Result<ContactResponse>>;
/**
* Delete a contact
* @param id Contact ID
* @returns Deletion confirmation
*/
delete(id: string): Promise<Result<{
message: string;
}>>;
/**
* List contacts
* @param options List options
* @returns Paginated list of contacts
*/
list(options?: {
limit?: number;
offset?: number;
search?: string;
groupId?: string;
sort?: string;
}): Promise<Result<PaginatedResponse<ContactResponse>>>;
}
//# sourceMappingURL=contacts.d.ts.map