/** * Auto-generated types for general module * Generated from: wildberries_api_doc/01-general.yaml * DO NOT EDIT MANUALLY - Changes will be overwritten on regeneration */ /** * Response structure for ping endpoint */ export interface PingResponse { /** Timestamp запроса */ TS?: string; /** Статус подключения */ Status?: 'OK'; } /** * News item structure from news endpoint */ export interface NewsItem { /** ID новости */ id: number; /** Заголовок новости */ header: string; /** Дата и время публикации новости */ date: string; /** Текст новости */ content: string; /** Теги новости */ types: NewsTag[]; } /** * News tag structure */ export interface NewsTag { /** ID тега */ id: number; /** Название тега */ name: string; } /** * Response structure for news endpoint */ export interface NewsResponse { /** Массив новостей */ data: NewsItem[]; } /** * Parameters for news endpoint request */ export interface NewsRequestParams { /** Дата, от которой необходимо выдать новости (format: YYYY-MM-DD) */ from?: string; /** ID новости, начиная с которой нужно получить список */ fromID?: number; } /** * Response structure for seller info endpoint */ export interface SellerInfoResponse { /** Наименование продавца */ name?: string; /** Уникальный ID продавца на Wildberries */ sid?: string; /** Торговое наименование продавца */ tradeMark?: string; /** ИНН продавца (Taxpayer Identification Number) */ tin?: string; } /** * Access code for user permissions * Determines which sections of the seller profile the user can access */ export type AccessCode = 'balance' | 'brands' | 'changeJam' | 'discountPrice' | 'finance' | 'showcase' | 'suppliersDocuments' | 'supply' | 'feedbacksQuestions' | 'questions' | 'pinFeedbacks' | 'pointsForReviews' | 'feedbacks' | 'wbPoint'; /** * Access permission item */ export interface AccessItem { /** Section code */ code: AccessCode; /** true - access denied, false - access allowed */ disabled: boolean; } /** * Invite information */ export interface InviteInfo { /** Phone number to invite */ phoneNumber: string; /** User position (max 150 chars) */ position?: string; } /** * Request to create user invitation */ export interface CreateInviteRequest { /** Access permissions for the user */ access?: AccessItem[]; /** Invitation details */ invite: InviteInfo; } /** * Response from create invitation endpoint */ export interface CreateInviteResponse { /** Invitation ID (UUID) */ inviteID: string; /** Invitation expiration date/time */ expiredAt: string; /** Whether invitation was created successfully */ isSuccess: boolean; /** URL for the user to accept the invitation */ inviteUrl: string; } /** * Invitee information (for invited users) */ export interface InviteeInfo { /** Phone number of invited user */ phoneNumber: string; /** User position */ position: string; /** Invitation UUID */ inviteUuid: string; /** Invitation expiration date/time */ expiredAt: string; /** Whether invitation is active */ isActive: boolean; } /** * User information */ export interface UserInfo { /** User ID */ id: number; /** User role: "user" for activated users, "" for non-activated */ role: 'user' | ''; /** User position */ position: string; /** Phone number */ phone: string; /** Email */ email: string; /** Whether user is the profile owner */ isOwner: boolean; /** First name */ firstName: string; /** Last name */ secondName: string; /** Patronymic */ patronymic: string; /** Whether user can approve goods returns */ goodsReturn: boolean; /** Whether user was invited */ isInvitee: boolean; /** Invitation info (null if not invited) */ inviteeInfo: InviteeInfo | null; /** Access permissions */ access: AccessItem[]; } /** * Parameters for getting users list */ export interface GetUsersParams { /** Number of users in response (max 100, default 100) */ limit?: number; /** Number of elements to skip (default 0) */ offset?: number; /** true - invited users only, false - active users only */ isInviteOnly?: boolean; } /** * Response from get users endpoint */ export interface GetUsersResponse { /** Total number of users */ total: number; /** Number of users in current response */ countInResponse: number; /** Users list */ users: UserInfo[]; } /** * User access update item */ export interface UserAccessUpdate { /** User ID to update */ userId: number; /** New access permissions */ access: AccessItem[]; } /** * Request to update user access */ export interface UpdateUserAccessRequest { /** Array of user access updates */ usersAccesses: UserAccessUpdate[]; } /** * User Management error response */ export interface UserManagementErrorResponse { /** Error title */ title: string; /** Error details */ detail: string; /** Request ID */ requestId: string; /** Internal service name */ origin: string; /** HTTP status code */ status: number; } /** * Jam (Джем) subscription tier * * Wildberries offers tiered "Jam" subscriptions that unlock higher limits * on analytics endpoints (e.g., search-texts limit field). * * - `'none'` — No Jam subscription (analytics search-texts unavailable) * - `'standard'` — Standard tier (limit ≤ 30) * - `'advanced'` — Advanced tier (limit ≤ 50) */ export type JamSubscriptionTier = 'none' | 'standard' | 'advanced'; /** * Result of a Jam subscription status probe */ export interface JamSubscriptionStatus { /** Detected subscription tier */ tier: JamSubscriptionTier; /** ISO 8601 timestamp when the check was performed */ checkedAt: string; /** Number of probe API calls made (1 for advanced, 2 for standard/none) */ probeCallsMade: number; } /** * Parameters for the Jam subscription status check */ export interface GetJamSubscriptionStatusParams { /** One or more WB article IDs (nmIds) to use in the probe request */ nmIds: number[]; } /** * Detailed Jam subscription information from GET /api/common/v1/subscriptions * * - If seller never subscribed: empty 200 response (all fields undefined) * - If active: state='active', since/till populated * - If expired/cancelled then resubscribed: since = first activation, till = current period end * - If inactive: since = first activation, till = last paid period end * * @since 3.5.0 */ export interface JamSubscriptionDetails { /** Subscription state: 'active' or other values when inactive */ state?: string; /** How the subscription was activated (e.g., 'jam') */ activationSource?: string; /** Subscription level (e.g., 'premium', 'standard') */ level?: string; /** Date of first subscription activation (ISO 8601) */ since?: string; /** End date of current/last paid period (ISO 8601) */ till?: string; } /** * Seller rating and review count from GET /api/common/v1/rating * @since 3.5.0 */ export interface SellerRatingResponse { /** Total number of customer reviews */ feedbackCount?: number; /** Seller rating (e.g., 4.55) */ valuation?: number; } //# sourceMappingURL=general.types.d.ts.map