apick-api 4.4.0 → 4.8.1

package/src/index.d.ts

@@ -153,102 +153,120 @@ export interface XPost {
 	readonly author: { readonly followers: number | null; readonly is_verified: boolean };
 }
 
-export interface TiktokVideo {
-	readonly video_id: string;
+export interface CoupangProduct {
+	readonly product_id: string;
 	readonly url: string;
-	readonly username: string;
-	readonly description: string;
-	readonly posted_at: string;
-	readonly views: number | null;
-	readonly likes: number | null;
-	readonly comments: number | null;
-	readonly shares: number | null;
-	readonly saves: number | null;
-	readonly duration_sec: number | null;
-	readonly hashtags: readonly string[];
-	readonly region: string;
-	readonly cover_image_url: string;
-	readonly author: { readonly followers: number | null; readonly is_verified: boolean };
-}
-
-/** 댓글 작성자는 공개 사용자명만 제공한다. */
-export interface SocialComment {
-	readonly comment_id: string;
-	readonly username: string;
-	readonly text: string;
-	readonly posted_at: string;
-	readonly likes: number | null;
-	readonly replies: number | null;
-}
-
-export interface AmazonReview {
-	readonly review_id: string;
+	readonly title: string;
 	readonly rating: number | null;
+	readonly reviews: number | null;
+	readonly initial_price: string;
+	readonly final_price: string;
+	readonly discount_rate: number | null;
+	readonly currency: string;
+	readonly seller_name: string;
+	readonly shop_url: string;
+	readonly seller_rating: number | null;
+	readonly seller_reviews: number | null;
+	readonly images: readonly string[];
+	readonly main_image: string;
+	readonly categories: readonly { readonly name: string; readonly url: string }[];
+	readonly root_category: string;
+	readonly root_category_url: string;
+	readonly shipping_details: readonly string[];
+	readonly variations: readonly { readonly name: string; readonly variations: readonly string[] }[];
+	readonly is_in_stock: boolean;
+}
+
+/** 네이버 브랜드스토어 상품. 상품 주소는 `/{스토어}/products/{번호}` 형식만 받는다. */
+export interface NaverShoppingProduct {
+	readonly product_id: string;
+	readonly url: string;
 	readonly title: string;
-	readonly text: string;
-	readonly author: string;
-	readonly posted_at: string;
-	readonly country: string;
-	readonly is_verified_purchase: boolean;
-	readonly helpful_count: number | null;
-	readonly variant: string;
-}
-
-export interface GoogleMapsPlace {
+	readonly original_price: string;
+	readonly final_price: number | null;
+	readonly discount_rate: number | null;
+	readonly currency: string;
+	readonly description: string;
+	readonly total_reviews: number | null;
+	readonly average_rating: number | null;
+	readonly sold_out: boolean;
+	readonly delivery_fee_type: string;
+	readonly arrival_guarantee: boolean;
+	readonly category_name: string;
+	readonly tags: readonly string[];
+	readonly breadcrumbs: readonly string[];
+	readonly images: readonly string[];
+	readonly sellers: readonly { readonly seller_name: string; readonly final_price: number | null; readonly currency: string; readonly seller_link: string }[];
+	readonly product_information: readonly { readonly label: string; readonly value: string }[];
+}
+
+export interface LinkedinProfile {
+	readonly linkedin_id: string;
 	readonly name: string;
-	readonly category: string;
-	readonly categories: readonly string[];
-	readonly address: string;
+	readonly first_name: string;
+	readonly last_name: string;
+	readonly position: string;
+	readonly about: string;
+	readonly location: string;
 	readonly country_code: string;
-	readonly phone: string;
-	readonly website: string;
-	readonly description: string;
-	readonly rating: number | null;
-	readonly reviews_count: number | null;
-	/** 별점별 리뷰 수. */
-	readonly rating_distribution: Readonly<Record<"1" | "2" | "3" | "4" | "5", number | null>>;
-	/** 대표 리뷰(최대 10건). 작성자는 공개 표시 이름만. */
-	readonly top_reviews: readonly { readonly reviewer_name: string; readonly rating: number | null; readonly posted_at: string; readonly text: string }[];
-	readonly open_hours: Readonly<Record<string, string>>;
-	/** day: 1=월 … 7=일 */
-	readonly popular_times: readonly { readonly day: number | null; readonly hours: readonly { readonly hour: string; readonly busy_percent: number | null }[] }[];
-	readonly similar_places: readonly { readonly name: string; readonly category: string; readonly rating: number | null; readonly reviews_count: number | null }[];
-	readonly photo_urls: readonly string[];
-	readonly main_image_url: string;
-	readonly is_claimed: boolean;
-	readonly permanently_closed: boolean;
-	readonly temporarily_closed: boolean;
-	readonly latitude: number | null;
-	readonly longitude: number | null;
-	readonly place_id: string;
-	readonly map_url: string;
+	readonly followers: number | null;
+	readonly connections: number | null;
+	readonly current_company_name: string;
+	readonly avatar: string;
+	readonly banner_image: string;
+	readonly url: string;
+	readonly is_influencer: boolean;
+	readonly experience: readonly { readonly company: string; readonly title: string; readonly start: string; readonly end: string; readonly location: string }[];
+	readonly education: readonly { readonly school: string; readonly degree: string; readonly start: string; readonly end: string }[];
+	readonly certifications: readonly string[];
+	readonly languages: readonly string[];
+	readonly posts: readonly { readonly title: string; readonly link: string; readonly created_at: string; readonly interaction: string }[];
 }
 
-export type ScrapeJobProduct = "instagram_posts" | "instagram_comments" | "tiktok_search" | "tiktok_video" | "tiktok_comments" | "amazon_reviews" | "google_maps_place";
-
-export interface ScrapeJobOptions {
-	/** 최대 결과 수. 이 수 × 단가를 예약하고 실제 결과 건수만 차감한다(instagram_comments 15, tiktok_search 50, 그 밖 100). */
-	readonly maxResults?: number;
-	/** 응답을 못 받아 다시 보낼 때 같은 접수로 처리할 키(8~128자). */
-	readonly idempotencyKey?: string;
+export interface LinkedinCompany {
+	readonly company_id: string;
+	readonly name: string;
+	readonly about: string;
+	readonly description: string;
+	readonly slogan: string;
+	readonly website: string;
+	readonly industries: string;
+	readonly company_size: string;
+	readonly organization_type: string;
+	readonly founded: number | null;
+	readonly followers: number | null;
+	readonly employees_on_linkedin: number | null;
+	readonly headquarters: string;
+	readonly locations: readonly string[];
+	readonly specialties: string;
+	readonly logo: string;
+	readonly image: string;
+	readonly url: string;
+	readonly funding: Readonly<Record<string, unknown>> | null;
+	readonly updates: readonly { readonly title: string; readonly link: string; readonly date: string; readonly text: string }[];
 }
 
-export interface ScrapeJob<T = unknown> {
-	readonly job_id: string;
-	readonly product: ScrapeJobProduct;
-	readonly status: "waiting" | "processing" | "completed" | "failed";
-	readonly max_results: number;
-	readonly unit_point: number;
-	readonly reserved_point: number;
-	readonly charged_point: number;
-	readonly result_count: number;
-	readonly created_at: string;
-	readonly completed_at: string | null;
-	/** 결과 보관 기한(완료 후 72시간). */
-	readonly result_expires_at?: string;
-	readonly result_expired?: boolean;
-	readonly items?: readonly T[];
-	readonly error?: { readonly code: string; readonly message: string };
+export interface LinkedinJob {
+	readonly job_posting_id: string;
+	readonly title: string;
+	readonly company_name: string;
+	readonly company_id: string;
+	readonly company_url: string;
+	readonly company_logo: string;
+	readonly location: string;
+	readonly employment_type: string;
+	readonly seniority_level: string;
+	readonly industries: string;
+	readonly summary: string;
+	readonly description_html: string;
+	readonly posted_time: string;
+	readonly posted_date: string;
+	readonly applicants: number | null;
+	readonly apply_link: string;
+	readonly is_easy_apply: boolean;
+	readonly base_salary: Readonly<Record<string, unknown>> | null;
+	readonly salary_standards: string;
+	readonly url: string;
 }
 
 export interface InstagramProfile {
@@ -353,6 +371,8 @@ export interface DataRequestInput {
 export interface RequestEmploymentInput extends DataRequestInput { insuranceYears?: number; }
 export interface RequestPersonalIncomeInput extends DataRequestInput { incomeYears?: number; }
 export interface RequestNpsJoinHistoryInput extends DataRequestInput { from?: string; to?: string; }
+export interface RequestNpsDeductionCertInput extends DataRequestInput { years?: number; }
+export interface RequestNpsCareerHistoryInput extends DataRequestInput { from?: string; to?: string; }
 export interface RequestDrivingLicenseInput extends DataRequestInput {}
 export interface RequestHealthCheckupInput extends DataRequestInput {}
 export interface RequestCashReceiptDeductionInput extends DataRequestInput { incomeYears?: number; }
@@ -436,6 +456,33 @@ export interface NpsJoinHistoryInfo {
 }
 export interface NpsJoinHistoryResultPayload { npsJoinHistory: NpsJoinHistoryInfo; }
 
+export interface NpsDeductionCertYearEntry {
+	발급연도: string; 사업장가입자고지금액: number; 지역가입자등납부금액: number;
+	사업장가입자소급금액: number; 추납보험료납부금액: number; 실업크레딧납부금액: number; 총합계: number;
+}
+export interface NpsDeductionCertInfo {
+	조회기간: { 시작: string; 끝: string };
+	신청인: string;
+	생년월일: string;
+	연도별내역: NpsDeductionCertYearEntry[];
+}
+export interface NpsDeductionCertResultPayload { npsDeductionCert: NpsDeductionCertInfo; }
+
+export interface NpsCareerHistoryEntry {
+	사업장: string; 시작: string; 종료: string;
+	기준소득월액: number; 납부개월: number; 미납개월: number; 납부금액: number;
+}
+export interface NpsCareerHistoryOtherEntry {
+	시작: string; 종료: string; 가입자구분: string; 납부개월: number; 납부금액: number;
+}
+export interface NpsCareerHistoryInfo {
+	조회기간: { 시작: string; 끝: string };
+	합계: { 사업장수: number; 경력건수: number; 사업장납부개월: number; 사업장납부금액: number; 사업장외납부개월: number };
+	경력: NpsCareerHistoryEntry[];
+	사업장외가입: NpsCareerHistoryOtherEntry[];
+}
+export interface NpsCareerHistoryResultPayload { npsCareerHistory: NpsCareerHistoryInfo; }
+
 export interface DrivingLicenseAcquisition {
 	면허종류코드: string; 발급일자: string; 합격일자: string; 발급지역: string; 발급일련번호: string;
 	학원명: string; 졸업일자: string; 공고시험장: string; 등록일자: string; 면허조건: string;
@@ -593,12 +640,19 @@ export class ApickBinaryResult {
 }
 
 export const DEFAULT_BASE_URL: 'https://apick.app';
-
 export const SERVICES: Readonly<Record<string, Readonly<{
 	endpoint: string;
 	output: 'json' | 'binary';
 }>>>;
 
+/** Brand, model name, model year and trim — all optional. With no `model` the call returns the brand/model list and is free. */
+export interface VehicleModelInfoOptions {
+	maker?: string;
+	model?: string;
+	modelYear?: string;
+	trim?: string;
+}
+
 export class ApickClient {
 	createVideoJob(model: VideoModel, prompt: string, options?: VideoJobOptions): Promise<ApickResult<VideoJobData>>;
 	getVideoJob(model: VideoModel, jobId: string): Promise<ApickResult<VideoJobData>>;
@@ -612,6 +666,8 @@ export class ApickClient {
 	validatePhone(number: string): Promise<ApickResult>;
 	holidays(year: number | string, month: number | string): Promise<ApickResult>;
 	searchAddress(query: string, options?: { page?: number }): Promise<ApickResult>;
+	/** Look up Korean-market vehicle specifications. Values use fixed standard notation (fuel, drive type, transmission, body type, efficiency grade; multiple values joined with `+`). */
+	vehicleModelInfo(options?: VehicleModelInfoOptions): Promise<ApickResult>;
 	ocr(image: string | BinaryInput | ArrayBuffer | ArrayBufferView, options?: OcrOptions): Promise<ApickResult>;
 	maskResidentNumber(image: string | BinaryInput | ArrayBuffer | ArrayBufferView, options: MaskResidentNumberOptions): Promise<ApickBinaryResult>;
 	maskResidenceCard(image: string | BinaryInput | ArrayBuffer | ArrayBufferView, options?: OcrOptions): Promise<ApickResult>;
@@ -633,15 +689,11 @@ export class ApickClient {
 	amazonProduct(urlOrAsin: string): Promise<ApickResult<AmazonProduct>>;
 	xProfile(usernameOrUrl: string): Promise<ApickResult<XProfile>>;
 	xPost(url: string): Promise<ApickResult<XPost>>;
-	createInstagramPostsJob(usernameOrUrl: string, options?: ScrapeJobOptions): Promise<ApickResult<ScrapeJob<InstagramPost>>>;
-	createInstagramCommentsJob(url: string, options?: ScrapeJobOptions): Promise<ApickResult<ScrapeJob<SocialComment>>>;
-	createTiktokSearchJob(keyword: string, options?: ScrapeJobOptions): Promise<ApickResult<ScrapeJob<TiktokVideo>>>;
-	createTiktokVideoJob(url: string, options?: Pick<ScrapeJobOptions, "idempotencyKey">): Promise<ApickResult<ScrapeJob<TiktokVideo>>>;
-	createTiktokCommentsJob(url: string, options?: ScrapeJobOptions): Promise<ApickResult<ScrapeJob<SocialComment>>>;
-	createAmazonReviewsJob(urlOrAsin: string, options?: ScrapeJobOptions): Promise<ApickResult<ScrapeJob<AmazonReview>>>;
-	createGoogleMapsPlaceJob(placeIdOrUrl: string, options?: Pick<ScrapeJobOptions, "idempotencyKey">): Promise<ApickResult<ScrapeJob<GoogleMapsPlace>>>;
-	getScrapeJob<T = unknown>(jobId: string): Promise<ApickResult<ScrapeJob<T>>>;
-	waitForScrapeJob<T = unknown>(jobId: string, options?: { intervalMs?: number; timeoutMs?: number }): Promise<ApickResult<ScrapeJob<T>>>;
+	coupangProduct(urlOrProductId: string): Promise<ApickResult<CoupangProduct>>;
+	naverShoppingProduct(url: string): Promise<ApickResult<NaverShoppingProduct>>;
+	linkedinProfile(url: string): Promise<ApickResult<LinkedinProfile>>;
+	linkedinCompany(url: string): Promise<ApickResult<LinkedinCompany>>;
+	linkedinJob(url: string): Promise<ApickResult<LinkedinJob>>;
 	screenshot(url: string): Promise<ApickBinaryResult>;
 	youtubeMetadata(url: string): Promise<ApickResult<YoutubeMetadata>>;
 	youtubeThumbnail(url: string): Promise<ApickBinaryResult>;
@@ -686,6 +738,10 @@ export class ApickClient {
 	getPersonalIncome(transactionId: string): Promise<ApickResult<DataRequestResult<PersonalIncomeResultPayload>>>;
 	requestNpsJoinHistory(input: RequestNpsJoinHistoryInput): Promise<ApickResult<DataRequestAcceptedData>>;
 	getNpsJoinHistory(transactionId: string): Promise<ApickResult<DataRequestResult<NpsJoinHistoryResultPayload>>>;
+	requestNpsDeductionCert(input: RequestNpsDeductionCertInput): Promise<ApickResult<DataRequestAcceptedData>>;
+	getNpsDeductionCert(transactionId: string): Promise<ApickResult<DataRequestResult<NpsDeductionCertResultPayload>>>;
+	requestNpsCareerHistory(input: RequestNpsCareerHistoryInput): Promise<ApickResult<DataRequestAcceptedData>>;
+	getNpsCareerHistory(transactionId: string): Promise<ApickResult<DataRequestResult<NpsCareerHistoryResultPayload>>>;
 	requestDrivingLicense(input: RequestDrivingLicenseInput): Promise<ApickResult<DataRequestAcceptedData>>;
 	getDrivingLicense(transactionId: string): Promise<ApickResult<DataRequestResult<DrivingLicenseResultPayload>>>;
 	requestHealthCheckup(input: RequestHealthCheckupInput): Promise<ApickResult<DataRequestAcceptedData>>;