@inkress/admin-sdk
Version:
Official Inkress Commerce API SDK for JavaScript/TypeScript
49 lines • 1.66 kB
TypeScript
import { HttpClient } from '../client';
import { WebhookUrl, CreateWebhookUrlData, UpdateWebhookUrlData, ApiResponse } from '../types';
import { WebhookUrlQueryBuilder } from '../utils/query-builders';
import { WebhookUrlFilterParams, WebhookUrlQueryParams, WebhookUrlListResponse } from '../types/resources';
export declare class WebhookUrlsResource {
private client;
constructor(client: HttpClient);
/**
* List webhook URLs with filtering
*/
list(params?: WebhookUrlFilterParams): Promise<ApiResponse<WebhookUrlListResponse>>;
/**
* Get webhook URL by ID
*/
get(id: number): Promise<ApiResponse<WebhookUrl>>;
/**
* Create a new webhook URL
*/
create(data: CreateWebhookUrlData): Promise<ApiResponse<WebhookUrl>>;
/**
* Update a webhook URL
*/
update(id: number, data: UpdateWebhookUrlData): Promise<ApiResponse<WebhookUrl>>;
/**
* Delete a webhook URL
*/
delete(id: number): Promise<ApiResponse<void>>;
/**
* Advanced query interface with full type safety
*
* @example
* const webhooks = await sdk.webhookUrls.query({
* event: 'order.created',
* merchant_id: 123
* });
*/
query(params: WebhookUrlQueryParams): Promise<ApiResponse<WebhookUrlListResponse>>;
/**
* Create a fluent query builder for webhook URLs
*
* @example
* const webhooks = await sdk.webhookUrls.createQueryBuilder()
* .whereEventEquals('order.created')
* .whereMerchantIdEquals(123)
* .execute();
*/
createQueryBuilder(): WebhookUrlQueryBuilder;
}
//# sourceMappingURL=webhook-urls.d.ts.map