Class: DropsResource

Defined in: src/resources/drops.ts:36

Drops 리소스 〔Client 인증 · 드롭스 Scope(법인 인증 필요)〕 https://chzzk.gitbook.io/chzzk/chzzk-api/drops

실측 검증 보류 상태 (docs/api-notes.md #18, #19) — 스코프 미보유 시 403 "드롭스 스코프가 필요합니다."가 반환된다.

Constructors

Constructor

new DropsResource(deps): DropsResource;

Defined in: src/resources/drops.ts:37

Parameters

deps

ResourceDeps

Returns

DropsResource

Methods

iterateRewardClaims()

iterateRewardClaims(params?): AsyncGenerator<{
[key: string]: unknown;
  campaignId: string;
  categoryId: string;
  categoryName: string;
  channelId: string;
  claimedDate: string;
  claimId: string;
  fulfillmentState: FulfillmentState;
  rewardId: string;
  updatedDate: string;
}, void>;

Defined in: src/resources/drops.ts:75

리워드 지급 요청 전체 자동 순회 (page.cursor 소진까지).

Parameters

params?

Omit<DropsRewardClaimsParams, "from"> = {}

Returns

AsyncGenerator<{ [key: string]: unknown; campaignId: string; categoryId: string; categoryName: string; channelId: string; claimedDate: string; claimId: string; fulfillmentState: FulfillmentState; rewardId: string; updatedDate: string; }, void>

---

rewardClaims()

rewardClaims(params?): Promise<{
[key: string]: unknown;
  data: object[];
  page?:   | {
   [key: string]: unknown;
     cursor?: string | null;
   }
     | null;
}>;

Defined in: src/resources/drops.ts:45

리워드 지급 요청 조회(단일 페이지) — GET /open/v1/drops/reward-claims

page.from/page.size 쿼리 키는 문서의 중첩 표기를 따름 — 실서버 직렬화 방식은 스코프 확보 후 검증 예정 (api-notes #18).

Parameters

params?

DropsRewardClaimsParams = {}

Returns

Promise<{ [key: string]: unknown; data: object[]; page?: | { [key: string]: unknown; cursor?: string | null; } | null; }>

---

updateRewardClaims()

updateRewardClaims(params): Promise<object[]>;

Defined in: src/resources/drops.ts:90

리워드 지급 상태 갱신 — PUT /open/v1/drops/reward-claims 응답 data[]는 status별로 묶인 지급 요청 ID 목록이다.

Parameters

params

claimIds

readonly string[]

fulfillmentState

FulfillmentState

Returns

Promise<object[]>