deliveryapi 0.1.1 → 0.1.2

package/dist/index.cjs

@@ -107,11 +107,19 @@ var SubscriptionsResource = class {
     this.http = http;
   }
   /**
-   * 택배 구독 생성
+   * 택배 구독 생성 (단건)
    * 상태 변경 시 등록된 웹훅 엔드포인트로 알림 전송
    */
   async create(data) {
-    return this.http.post("/v1/tracking/subscriptions", data);
+    return this.http.post("/v1/tracking/subscriptions", {
+      items: [data]
+    });
+  }
+  /**
+   * 택배 구독 일괄 생성 (최대 100건)
+   */
+  async createBatch(items) {
+    return this.http.post("/v1/tracking/subscriptions", { items });
   }
   /**
    * 택배 구독 목록 조회
@@ -119,8 +127,8 @@ var SubscriptionsResource = class {
   async list(options) {
     const params = {};
     if (options?.status) params["status"] = options.status;
-    if (options?.page) params["page"] = String(options.page);
-    if (options?.pageSize) params["pageSize"] = String(options.pageSize);
+    if (options?.limit) params["limit"] = String(options.limit);
+    if (options?.cursor) params["cursor"] = options.cursor;
     return this.http.get("/v1/tracking/subscriptions", params);
   }
   /**
@@ -130,11 +138,19 @@ var SubscriptionsResource = class {
     return this.http.get(`/v1/tracking/subscriptions/${subscriptionId}`);
   }
   /**
-   * 택배 구독 취소
+   * 택배 구독 취소 (ID)
    */
   async cancel(subscriptionId) {
     await this.http.delete(`/v1/tracking/subscriptions/${subscriptionId}`);
   }
+  /**
+   * 택배 구독 취소 (송장번호)
+   */
+  async cancelByTracking(courierCode, trackingNumber) {
+    return this.http.delete(
+      `/v1/tracking/subscriptions?courierCode=${encodeURIComponent(courierCode)}&trackingNumber=${encodeURIComponent(trackingNumber)}`
+    );
+  }
 };
 
 // src/resources/webhooks.ts
@@ -155,10 +171,10 @@ var WebhooksResource = class {
     return this.http.get("/v1/webhook-v2/endpoints");
   }
   /**
-   * 웹훅 엔드포인트 상세 조회
+   * 웹훅 엔드포인트 이름 수정
    */
-  async retrieve(endpointId) {
-    return this.http.get(`/v1/webhook-v2/endpoints/${endpointId}`);
+  async update(endpointId, data) {
+    await this.http.patch(`/v1/webhook-v2/endpoints/${endpointId}`, data);
   }
   /**
    * 웹훅 엔드포인트 삭제
@@ -167,10 +183,13 @@ var WebhooksResource = class {
     await this.http.delete(`/v1/webhook-v2/endpoints/${endpointId}`);
   }
   /**
-   * 웹훅 엔드포인트 테스트 전송
+   * 웹훅 시크릿 재발급
    */
-  async test(endpointId) {
-    return this.http.post(`/v1/webhook-v2/endpoints/${endpointId}/test`);
+  async rotateSecret(endpointId, webhookSecret) {
+    return this.http.post(
+      `/v1/webhook-v2/endpoints/${endpointId}/rotate`,
+      webhookSecret ? { webhookSecret } : void 0
+    );
   }
 };
 

package/dist/index.d.cts

@@ -268,25 +268,55 @@ export interface SubscriptionCreateInput {
 	trackingNumber: string;
 	endpointId: string;
 	subscribedStatuses?: CourierDeliveryStatus[];
-	clientId?: string;
+	id?: string;
 	metadata?: Record<string, string>;
 }
+export interface SubscriptionCreateResult {
+	id?: string;
+	courierCode: string;
+	trackingNumber: string;
+	subscriptionId?: string;
+	success: boolean;
+	currentStatus?: CourierDeliveryStatus;
+	error?: string;
+}
+export interface SubscriptionCreateBatchResult {
+	results: SubscriptionCreateResult[];
+	summary: {
+		total: number;
+		successful: number;
+		failed: number;
+	};
+}
 export interface SubscriptionListResult {
-	subscriptions: TrackingSubscription[];
+	subscriptions: {
+		id: string;
+		courierCode: string;
+		trackingNumber: string;
+		endpointId: string;
+		subscribedStatuses: CourierDeliveryStatus[];
+		currentStatus: CourierDeliveryStatus;
+		status: "active" | "completed" | "cancelled" | "failed";
+		metadata?: Record<string, string>;
+		dateCreated: string;
+		dateModified: string;
+	}[];
 	total: number;
+	nextCursor?: string;
 }
 export interface WebhookCreateInput {
 	url: string;
 	name?: string;
 }
+export interface WebhookUpdateInput {
+	name: string;
+}
 export interface WebhookListResult {
 	endpoints: WebhookEndpoint[];
 	total: number;
 }
-export interface WebhookTestResult {
-	success: boolean;
-	statusCode?: number;
-	message?: string;
+export interface WebhookRotateSecretResult {
+	webhookSecret: string;
 }
 export interface CourierListResult {
 	couriers: CourierInfo[];
@@ -312,26 +342,36 @@ declare class SubscriptionsResource {
 	private readonly http;
 	constructor(http: HttpClient);
 	/**
-	 * 택배 구독 생성
+	 * 택배 구독 생성 (단건)
 	 * 상태 변경 시 등록된 웹훅 엔드포인트로 알림 전송
 	 */
-	create(data: SubscriptionCreateInput): Promise<TrackingSubscription>;
+	create(data: SubscriptionCreateInput): Promise<SubscriptionCreateBatchResult>;
+	/**
+	 * 택배 구독 일괄 생성 (최대 100건)
+	 */
+	createBatch(items: SubscriptionCreateInput[]): Promise<SubscriptionCreateBatchResult>;
 	/**
 	 * 택배 구독 목록 조회
 	 */
 	list(options?: {
-		status?: string;
-		page?: number;
-		pageSize?: number;
+		status?: "active" | "completed" | "cancelled" | "failed";
+		limit?: number;
+		cursor?: string;
 	}): Promise<SubscriptionListResult>;
 	/**
 	 * 택배 구독 상세 조회
 	 */
-	retrieve(subscriptionId: string): Promise<TrackingSubscription>;
+	retrieve(subscriptionId: string): Promise<SubscriptionListResult["subscriptions"][number]>;
 	/**
-	 * 택배 구독 취소
+	 * 택배 구독 취소 (ID)
 	 */
 	cancel(subscriptionId: string): Promise<void>;
+	/**
+	 * 택배 구독 취소 (송장번호)
+	 */
+	cancelByTracking(courierCode: string, trackingNumber: string): Promise<{
+		cancelledCount: number;
+	}>;
 }
 declare class WebhooksResource {
 	private readonly http;
@@ -345,17 +385,17 @@ declare class WebhooksResource {
 	 */
 	list(): Promise<WebhookListResult>;
 	/**
-	 * 웹훅 엔드포인트 상세 조회
+	 * 웹훅 엔드포인트 이름 수정
 	 */
-	retrieve(endpointId: string): Promise<WebhookEndpoint>;
+	update(endpointId: string, data: WebhookUpdateInput): Promise<void>;
 	/**
 	 * 웹훅 엔드포인트 삭제
 	 */
 	delete(endpointId: string): Promise<void>;
 	/**
-	 * 웹훅 엔드포인트 테스트 전송
+	 * 웹훅 시크릿 재발급
 	 */
-	test(endpointId: string): Promise<WebhookTestResult>;
+	rotateSecret(endpointId: string, webhookSecret?: string): Promise<WebhookRotateSecretResult>;
 }
 declare class CouriersResource {
 	private readonly http;

package/dist/index.d.ts

@@ -268,25 +268,55 @@ export interface SubscriptionCreateInput {
 	trackingNumber: string;
 	endpointId: string;
 	subscribedStatuses?: CourierDeliveryStatus[];
-	clientId?: string;
+	id?: string;
 	metadata?: Record<string, string>;
 }
+export interface SubscriptionCreateResult {
+	id?: string;
+	courierCode: string;
+	trackingNumber: string;
+	subscriptionId?: string;
+	success: boolean;
+	currentStatus?: CourierDeliveryStatus;
+	error?: string;
+}
+export interface SubscriptionCreateBatchResult {
+	results: SubscriptionCreateResult[];
+	summary: {
+		total: number;
+		successful: number;
+		failed: number;
+	};
+}
 export interface SubscriptionListResult {
-	subscriptions: TrackingSubscription[];
+	subscriptions: {
+		id: string;
+		courierCode: string;
+		trackingNumber: string;
+		endpointId: string;
+		subscribedStatuses: CourierDeliveryStatus[];
+		currentStatus: CourierDeliveryStatus;
+		status: "active" | "completed" | "cancelled" | "failed";
+		metadata?: Record<string, string>;
+		dateCreated: string;
+		dateModified: string;
+	}[];
 	total: number;
+	nextCursor?: string;
 }
 export interface WebhookCreateInput {
 	url: string;
 	name?: string;
 }
+export interface WebhookUpdateInput {
+	name: string;
+}
 export interface WebhookListResult {
 	endpoints: WebhookEndpoint[];
 	total: number;
 }
-export interface WebhookTestResult {
-	success: boolean;
-	statusCode?: number;
-	message?: string;
+export interface WebhookRotateSecretResult {
+	webhookSecret: string;
 }
 export interface CourierListResult {
 	couriers: CourierInfo[];
@@ -312,26 +342,36 @@ declare class SubscriptionsResource {
 	private readonly http;
 	constructor(http: HttpClient);
 	/**
-	 * 택배 구독 생성
+	 * 택배 구독 생성 (단건)
 	 * 상태 변경 시 등록된 웹훅 엔드포인트로 알림 전송
 	 */
-	create(data: SubscriptionCreateInput): Promise<TrackingSubscription>;
+	create(data: SubscriptionCreateInput): Promise<SubscriptionCreateBatchResult>;
+	/**
+	 * 택배 구독 일괄 생성 (최대 100건)
+	 */
+	createBatch(items: SubscriptionCreateInput[]): Promise<SubscriptionCreateBatchResult>;
 	/**
 	 * 택배 구독 목록 조회
 	 */
 	list(options?: {
-		status?: string;
-		page?: number;
-		pageSize?: number;
+		status?: "active" | "completed" | "cancelled" | "failed";
+		limit?: number;
+		cursor?: string;
 	}): Promise<SubscriptionListResult>;
 	/**
 	 * 택배 구독 상세 조회
 	 */
-	retrieve(subscriptionId: string): Promise<TrackingSubscription>;
+	retrieve(subscriptionId: string): Promise<SubscriptionListResult["subscriptions"][number]>;
 	/**
-	 * 택배 구독 취소
+	 * 택배 구독 취소 (ID)
 	 */
 	cancel(subscriptionId: string): Promise<void>;
+	/**
+	 * 택배 구독 취소 (송장번호)
+	 */
+	cancelByTracking(courierCode: string, trackingNumber: string): Promise<{
+		cancelledCount: number;
+	}>;
 }
 declare class WebhooksResource {
 	private readonly http;
@@ -345,17 +385,17 @@ declare class WebhooksResource {
 	 */
 	list(): Promise<WebhookListResult>;
 	/**
-	 * 웹훅 엔드포인트 상세 조회
+	 * 웹훅 엔드포인트 이름 수정
 	 */
-	retrieve(endpointId: string): Promise<WebhookEndpoint>;
+	update(endpointId: string, data: WebhookUpdateInput): Promise<void>;
 	/**
 	 * 웹훅 엔드포인트 삭제
 	 */
 	delete(endpointId: string): Promise<void>;
 	/**
-	 * 웹훅 엔드포인트 테스트 전송
+	 * 웹훅 시크릿 재발급
 	 */
-	test(endpointId: string): Promise<WebhookTestResult>;
+	rotateSecret(endpointId: string, webhookSecret?: string): Promise<WebhookRotateSecretResult>;
 }
 declare class CouriersResource {
 	private readonly http;

package/dist/index.js

@@ -105,11 +105,19 @@ var SubscriptionsResource = class {
     this.http = http;
   }
   /**
-   * 택배 구독 생성
+   * 택배 구독 생성 (단건)
    * 상태 변경 시 등록된 웹훅 엔드포인트로 알림 전송
    */
   async create(data) {
-    return this.http.post("/v1/tracking/subscriptions", data);
+    return this.http.post("/v1/tracking/subscriptions", {
+      items: [data]
+    });
+  }
+  /**
+   * 택배 구독 일괄 생성 (최대 100건)
+   */
+  async createBatch(items) {
+    return this.http.post("/v1/tracking/subscriptions", { items });
   }
   /**
    * 택배 구독 목록 조회
@@ -117,8 +125,8 @@ var SubscriptionsResource = class {
   async list(options) {
     const params = {};
     if (options?.status) params["status"] = options.status;
-    if (options?.page) params["page"] = String(options.page);
-    if (options?.pageSize) params["pageSize"] = String(options.pageSize);
+    if (options?.limit) params["limit"] = String(options.limit);
+    if (options?.cursor) params["cursor"] = options.cursor;
     return this.http.get("/v1/tracking/subscriptions", params);
   }
   /**
@@ -128,11 +136,19 @@ var SubscriptionsResource = class {
     return this.http.get(`/v1/tracking/subscriptions/${subscriptionId}`);
   }
   /**
-   * 택배 구독 취소
+   * 택배 구독 취소 (ID)
    */
   async cancel(subscriptionId) {
     await this.http.delete(`/v1/tracking/subscriptions/${subscriptionId}`);
   }
+  /**
+   * 택배 구독 취소 (송장번호)
+   */
+  async cancelByTracking(courierCode, trackingNumber) {
+    return this.http.delete(
+      `/v1/tracking/subscriptions?courierCode=${encodeURIComponent(courierCode)}&trackingNumber=${encodeURIComponent(trackingNumber)}`
+    );
+  }
 };
 
 // src/resources/webhooks.ts
@@ -153,10 +169,10 @@ var WebhooksResource = class {
     return this.http.get("/v1/webhook-v2/endpoints");
   }
   /**
-   * 웹훅 엔드포인트 상세 조회
+   * 웹훅 엔드포인트 이름 수정
    */
-  async retrieve(endpointId) {
-    return this.http.get(`/v1/webhook-v2/endpoints/${endpointId}`);
+  async update(endpointId, data) {
+    await this.http.patch(`/v1/webhook-v2/endpoints/${endpointId}`, data);
   }
   /**
    * 웹훅 엔드포인트 삭제
@@ -165,10 +181,13 @@ var WebhooksResource = class {
     await this.http.delete(`/v1/webhook-v2/endpoints/${endpointId}`);
   }
   /**
-   * 웹훅 엔드포인트 테스트 전송
+   * 웹훅 시크릿 재발급
    */
-  async test(endpointId) {
-    return this.http.post(`/v1/webhook-v2/endpoints/${endpointId}/test`);
+  async rotateSecret(endpointId, webhookSecret) {
+    return this.http.post(
+      `/v1/webhook-v2/endpoints/${endpointId}/rotate`,
+      webhookSecret ? { webhookSecret } : void 0
+    );
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "deliveryapi",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Official JavaScript/TypeScript SDK for the DeliveryAPI",
   "keywords": [
     "delivery",