@blezgo/api-sdk 0.1.5 → 0.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/account/generated.d.ts +238 -238
- package/dist/account/generated.d.ts.map +1 -1
- package/dist/activity/generated.d.ts +57 -57
- package/dist/activity/generated.d.ts.map +1 -1
- package/dist/addon/generated.d.ts +82 -82
- package/dist/addon/generated.d.ts.map +1 -1
- package/dist/admin/generated.d.ts +102 -102
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +81 -81
- package/dist/affiliate/generated.d.ts.map +1 -1
- package/dist/analytics/generated.d.ts +22 -22
- package/dist/analytics/generated.d.ts.map +1 -1
- package/dist/announcements/generated.d.ts +134 -134
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +69 -69
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +22 -22
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +61 -61
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +206 -206
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +84 -84
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +38 -38
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +28 -28
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +174 -174
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +28 -28
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +107 -107
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +224 -224
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +43 -43
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +74 -74
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +68 -68
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +541 -541
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +36 -36
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +436 -436
- package/dist/courses/generated.d.ts.map +1 -1
- package/dist/custom/generated.d.ts +83 -83
- package/dist/custom/generated.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +214 -214
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +22 -22
- package/dist/elasticsearch/generated.d.ts.map +1 -1
- package/dist/enrollments/generated.d.ts +22 -22
- package/dist/enrollments/generated.d.ts.map +1 -1
- package/dist/errors/generated.d.ts +51 -51
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +113 -113
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +124 -124
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +194 -194
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +35 -35
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +138 -138
- package/dist/inbox/generated.d.ts.map +1 -1
- package/dist/internal/generated.d.ts +22 -22
- package/dist/internal/generated.d.ts.map +1 -1
- package/dist/internationalization/generated.d.ts +22 -22
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +111 -111
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +323 -323
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +160 -160
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +246 -246
- package/dist/notification/generated.d.ts.map +1 -1
- package/dist/notifications/generated.d.ts +22 -22
- package/dist/notifications/generated.d.ts.map +1 -1
- package/dist/onboarding/generated.d.ts +118 -118
- package/dist/onboarding/generated.d.ts.map +1 -1
- package/dist/packages/generated.d.ts +80 -80
- package/dist/packages/generated.d.ts.map +1 -1
- package/dist/payments/generated.d.ts +557 -557
- package/dist/payments/generated.d.ts.map +1 -1
- package/dist/payouts/generated.d.ts +22 -22
- package/dist/payouts/generated.d.ts.map +1 -1
- package/dist/plans/generated.d.ts +472 -472
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +100 -100
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +617 -617
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +328 -328
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +97 -97
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +184 -184
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +69 -69
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +210 -210
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +80 -80
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +937 -937
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +363 -363
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +403 -403
- package/dist/spaces/generated.d.ts.map +1 -1
- package/dist/storefront/generated.d.ts +22 -22
- package/dist/storefront/generated.d.ts.map +1 -1
- package/dist/support/generated.d.ts +1440 -1440
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +193 -193
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +482 -482
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +65 -65
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +445 -445
- package/dist/tests/generated.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +39 -39
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/uploads/generated.d.ts +20 -20
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +108 -108
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +107 -107
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +308 -308
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -180,186 +180,18 @@ export interface paths {
|
|
|
180
180
|
export type webhooks = Record<string, never>;
|
|
181
181
|
export interface components {
|
|
182
182
|
schemas: {
|
|
183
|
-
/** Body_updateWebinar */
|
|
184
|
-
Body_updateWebinar: {
|
|
185
|
-
/** Starts At */
|
|
186
|
-
starts_at?: string | null;
|
|
187
|
-
/** Ends At */
|
|
188
|
-
ends_at?: string | null;
|
|
189
|
-
/** Duration Minutes */
|
|
190
|
-
duration_minutes?: number | null;
|
|
191
|
-
/** Max Attendees */
|
|
192
|
-
max_attendees?: number | null;
|
|
193
|
-
/** Status */
|
|
194
|
-
status?: string | null;
|
|
195
|
-
/** Qa Enabled */
|
|
196
|
-
qa_enabled?: boolean | null;
|
|
197
|
-
/** Polling Enabled */
|
|
198
|
-
polling_enabled?: boolean | null;
|
|
199
|
-
};
|
|
200
|
-
/**
|
|
201
|
-
* @example {
|
|
202
|
-
* "status": "success",
|
|
203
|
-
* "message": "Operation successful",
|
|
204
|
-
* "message_code": "api_suc_20001",
|
|
205
|
-
* "data": {},
|
|
206
|
-
* "metadata": {
|
|
207
|
-
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
208
|
-
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
209
|
-
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
210
|
-
* "version": "v1",
|
|
211
|
-
* "executionTime": 42,
|
|
212
|
-
* "language": "en-US"
|
|
213
|
-
* }
|
|
214
|
-
* }
|
|
215
|
-
*/
|
|
216
|
-
StandardResponse: {
|
|
217
|
-
/** @example success */
|
|
218
|
-
status?: string;
|
|
219
|
-
data?: Record<string, never> | null;
|
|
220
|
-
/** @example Operation successful */
|
|
221
|
-
message?: string | null;
|
|
222
|
-
/** @example api_suc_20001 */
|
|
223
|
-
message_code?: string | null;
|
|
224
|
-
metadata?: Record<string, never> | null;
|
|
225
|
-
error?: components["schemas"]["ErrorResponse"];
|
|
226
|
-
};
|
|
227
|
-
/**
|
|
228
|
-
* VariantItem
|
|
229
|
-
* @description Product variant (maps to product_variants_tbl)
|
|
230
|
-
*/
|
|
231
|
-
VariantItem: {
|
|
232
|
-
/**
|
|
233
|
-
* Name
|
|
234
|
-
* @description Variant display name
|
|
235
|
-
*/
|
|
236
|
-
name: string;
|
|
237
|
-
/**
|
|
238
|
-
* Sku
|
|
239
|
-
* @description Stock Keeping Unit
|
|
240
|
-
*/
|
|
241
|
-
sku?: string | null;
|
|
242
|
-
/**
|
|
243
|
-
* Attributes
|
|
244
|
-
* @description Custom attributes
|
|
245
|
-
*/
|
|
246
|
-
attributes?: {
|
|
247
|
-
[key: string]: unknown;
|
|
248
|
-
} | null;
|
|
249
|
-
/**
|
|
250
|
-
* Is Default
|
|
251
|
-
* @description Set as default variant
|
|
252
|
-
* @default false
|
|
253
|
-
*/
|
|
254
|
-
is_default: boolean;
|
|
255
|
-
/**
|
|
256
|
-
* Track Inventory
|
|
257
|
-
* @description Track stock for this variant
|
|
258
|
-
* @default false
|
|
259
|
-
*/
|
|
260
|
-
track_inventory: boolean;
|
|
261
|
-
/**
|
|
262
|
-
* Stock Quantity
|
|
263
|
-
* @description Initial stock
|
|
264
|
-
*/
|
|
265
|
-
stock_quantity?: number | null;
|
|
266
|
-
/**
|
|
267
|
-
* Allow Backorder
|
|
268
|
-
* @description Allow orders when out of stock
|
|
269
|
-
* @default false
|
|
270
|
-
*/
|
|
271
|
-
allow_backorder: boolean;
|
|
272
|
-
/**
|
|
273
|
-
* Weight
|
|
274
|
-
* @description Weight in kg
|
|
275
|
-
*/
|
|
276
|
-
weight?: number | null;
|
|
277
|
-
/**
|
|
278
|
-
* Length
|
|
279
|
-
* @description Length in cm
|
|
280
|
-
*/
|
|
281
|
-
length?: number | null;
|
|
282
|
-
/**
|
|
283
|
-
* Width
|
|
284
|
-
* @description Width in cm
|
|
285
|
-
*/
|
|
286
|
-
width?: number | null;
|
|
287
|
-
/**
|
|
288
|
-
* Height
|
|
289
|
-
* @description Height in cm
|
|
290
|
-
*/
|
|
291
|
-
height?: number | null;
|
|
292
|
-
/**
|
|
293
|
-
* Display Order
|
|
294
|
-
* @description Display order
|
|
295
|
-
* @default 100
|
|
296
|
-
*/
|
|
297
|
-
display_order: number;
|
|
298
|
-
/**
|
|
299
|
-
* Metadata
|
|
300
|
-
* @description Flexible metadata
|
|
301
|
-
*/
|
|
302
|
-
metadata?: {
|
|
303
|
-
[key: string]: unknown;
|
|
304
|
-
} | null;
|
|
305
|
-
};
|
|
306
|
-
Extensions: {
|
|
307
|
-
/** @example GENERIC_ERROR */
|
|
308
|
-
message_code?: string;
|
|
309
|
-
/** @example [] */
|
|
310
|
-
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
311
|
-
extra_data?: Record<string, never> | null;
|
|
312
|
-
/** @example Detailed debug information */
|
|
313
|
-
debug?: string | null;
|
|
314
|
-
};
|
|
315
183
|
/**
|
|
316
|
-
*
|
|
317
|
-
* @description
|
|
318
|
-
* @example {
|
|
319
|
-
* "identity": {
|
|
320
|
-
* "description": "Learn the latest marketing strategies...",
|
|
321
|
-
* "locale": "en-US",
|
|
322
|
-
* "title": "Marketing Strategies 2025"
|
|
323
|
-
* },
|
|
324
|
-
* "product": {
|
|
325
|
-
* "is_digital": true,
|
|
326
|
-
* "status": "draft",
|
|
327
|
-
* "visibility": "public"
|
|
328
|
-
* },
|
|
329
|
-
* "webinar": {
|
|
330
|
-
* "conferencing_platform": "zoom",
|
|
331
|
-
* "duration_minutes": 120,
|
|
332
|
-
* "ends_at": "2025-12-25T17:00:00Z",
|
|
333
|
-
* "max_attendees": 1000,
|
|
334
|
-
* "primary_presenter_id": "usr_abc123def456",
|
|
335
|
-
* "qa_enabled": true,
|
|
336
|
-
* "recording_enabled": true,
|
|
337
|
-
* "registration_required": true,
|
|
338
|
-
* "starts_at": "2025-12-25T15:00:00Z"
|
|
339
|
-
* }
|
|
340
|
-
* }
|
|
184
|
+
* PricingSection
|
|
185
|
+
* @description Pricing configuration (optional - can have product price, variant prices, or both)
|
|
341
186
|
*/
|
|
342
|
-
|
|
343
|
-
/** @description Base product
|
|
344
|
-
|
|
345
|
-
/** @description Localized content (title, description) */
|
|
346
|
-
identity: components["schemas"]["IdentitySection"];
|
|
347
|
-
/** @description Pre-uploaded image IDs */
|
|
348
|
-
media?: components["schemas"]["MediaSection"] | null;
|
|
349
|
-
/**
|
|
350
|
-
* Tags
|
|
351
|
-
* @description Tag IDs to associate with product
|
|
352
|
-
*/
|
|
353
|
-
tags?: number[] | null;
|
|
187
|
+
PricingSection: {
|
|
188
|
+
/** @description Base product price (no variant) */
|
|
189
|
+
product_price?: components["schemas"]["ProductPrice"] | null;
|
|
354
190
|
/**
|
|
355
|
-
*
|
|
356
|
-
* @description
|
|
191
|
+
* Variant Prices
|
|
192
|
+
* @description Variant-specific prices
|
|
357
193
|
*/
|
|
358
|
-
|
|
359
|
-
/** @description Pricing for product and variants */
|
|
360
|
-
pricing?: components["schemas"]["PricingSection"] | null;
|
|
361
|
-
/** @description Webinar-specific configuration */
|
|
362
|
-
webinar: components["schemas"]["WebinarSection"];
|
|
194
|
+
variant_prices?: components["schemas"]["VariantPrice"][] | null;
|
|
363
195
|
};
|
|
364
196
|
/**
|
|
365
197
|
* WebinarSection
|
|
@@ -502,94 +334,99 @@ export interface components {
|
|
|
502
334
|
*/
|
|
503
335
|
locale?: string | null;
|
|
504
336
|
};
|
|
337
|
+
/** Body_updateWebinar */
|
|
338
|
+
Body_updateWebinar: {
|
|
339
|
+
/** Starts At */
|
|
340
|
+
starts_at?: string | null;
|
|
341
|
+
/** Ends At */
|
|
342
|
+
ends_at?: string | null;
|
|
343
|
+
/** Duration Minutes */
|
|
344
|
+
duration_minutes?: number | null;
|
|
345
|
+
/** Max Attendees */
|
|
346
|
+
max_attendees?: number | null;
|
|
347
|
+
/** Status */
|
|
348
|
+
status?: string | null;
|
|
349
|
+
/** Qa Enabled */
|
|
350
|
+
qa_enabled?: boolean | null;
|
|
351
|
+
/** Polling Enabled */
|
|
352
|
+
polling_enabled?: boolean | null;
|
|
353
|
+
};
|
|
505
354
|
/**
|
|
506
|
-
*
|
|
507
|
-
* @description
|
|
355
|
+
* MediaSection
|
|
356
|
+
* @description Product media files - direct media data
|
|
508
357
|
*/
|
|
509
|
-
|
|
358
|
+
MediaSection: {
|
|
510
359
|
/**
|
|
511
|
-
*
|
|
512
|
-
* @description
|
|
360
|
+
* Media Items
|
|
361
|
+
* @description List of media files to attach to product
|
|
513
362
|
*/
|
|
514
|
-
|
|
363
|
+
media_items?: components["schemas"]["MediaItem"][] | null;
|
|
364
|
+
};
|
|
365
|
+
/**
|
|
366
|
+
* ProductSection
|
|
367
|
+
* @description Base product fields (maps to product_tbl)
|
|
368
|
+
*/
|
|
369
|
+
ProductSection: {
|
|
515
370
|
/**
|
|
516
|
-
*
|
|
517
|
-
* @description
|
|
371
|
+
* Visibility
|
|
372
|
+
* @description public, private, hidden, unlisted
|
|
373
|
+
* @default public
|
|
518
374
|
*/
|
|
519
|
-
|
|
375
|
+
visibility: string;
|
|
520
376
|
/**
|
|
521
|
-
*
|
|
522
|
-
* @description
|
|
377
|
+
* Is Digital
|
|
378
|
+
* @description Digital product flag
|
|
379
|
+
* @default true
|
|
523
380
|
*/
|
|
524
|
-
|
|
381
|
+
is_digital: boolean;
|
|
525
382
|
/**
|
|
526
|
-
*
|
|
527
|
-
* @description
|
|
383
|
+
* Company Id
|
|
384
|
+
* @description Multi-company support
|
|
528
385
|
*/
|
|
529
|
-
|
|
386
|
+
company_id?: number | null;
|
|
530
387
|
/**
|
|
531
|
-
*
|
|
532
|
-
* @description
|
|
388
|
+
* Status
|
|
389
|
+
* @description draft, published, archived, review_required, deleted
|
|
390
|
+
* @default draft
|
|
533
391
|
*/
|
|
534
|
-
|
|
392
|
+
status: string;
|
|
535
393
|
/**
|
|
536
|
-
*
|
|
537
|
-
* @description
|
|
394
|
+
* Is Org Level
|
|
395
|
+
* @description Org-level vs user-created product
|
|
396
|
+
* @default true
|
|
538
397
|
*/
|
|
539
|
-
|
|
398
|
+
is_org_level: boolean;
|
|
540
399
|
/**
|
|
541
|
-
*
|
|
542
|
-
* @description
|
|
543
|
-
*/
|
|
544
|
-
trial_period_days?: number | null;
|
|
545
|
-
/**
|
|
546
|
-
* Initial Amount
|
|
547
|
-
* @description First payment amount
|
|
400
|
+
* Staff Id
|
|
401
|
+
* @description Staff/instructor delivering product
|
|
548
402
|
*/
|
|
549
|
-
|
|
403
|
+
staff_id?: number | null;
|
|
550
404
|
/**
|
|
551
|
-
*
|
|
552
|
-
* @description
|
|
405
|
+
* Owner Id
|
|
406
|
+
* @description Owner of the product
|
|
553
407
|
*/
|
|
554
|
-
|
|
408
|
+
owner_id?: number | null;
|
|
555
409
|
/**
|
|
556
|
-
*
|
|
557
|
-
* @description
|
|
558
|
-
* @default
|
|
410
|
+
* Featured
|
|
411
|
+
* @description Featured product flag
|
|
412
|
+
* @default false
|
|
559
413
|
*/
|
|
560
|
-
|
|
414
|
+
featured: boolean;
|
|
561
415
|
};
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
/**
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
/**
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
*/
|
|
577
|
-
title: string;
|
|
578
|
-
/**
|
|
579
|
-
* Subtitle
|
|
580
|
-
* @description Product subtitle
|
|
581
|
-
*/
|
|
582
|
-
subtitle?: string | null;
|
|
583
|
-
/**
|
|
584
|
-
* Description
|
|
585
|
-
* @description Full product description
|
|
586
|
-
*/
|
|
587
|
-
description?: string | null;
|
|
588
|
-
/**
|
|
589
|
-
* Short Description
|
|
590
|
-
* @description Short description for listings/previews
|
|
591
|
-
*/
|
|
592
|
-
short_description?: string | null;
|
|
416
|
+
ErrorResponse: {
|
|
417
|
+
/** @example about:blank */
|
|
418
|
+
type?: string;
|
|
419
|
+
/** @example GENERIC_ERROR */
|
|
420
|
+
code?: string;
|
|
421
|
+
/** @example Client Error */
|
|
422
|
+
title?: string;
|
|
423
|
+
/** @example 400 */
|
|
424
|
+
status?: number;
|
|
425
|
+
/** @example An error occurred */
|
|
426
|
+
detail?: string;
|
|
427
|
+
/** @example /v1/cart/items */
|
|
428
|
+
instance?: string;
|
|
429
|
+
extensions?: components["schemas"]["Extensions"];
|
|
593
430
|
};
|
|
594
431
|
/**
|
|
595
432
|
* MediaItem
|
|
@@ -662,11 +499,14 @@ export interface components {
|
|
|
662
499
|
*/
|
|
663
500
|
is_primary: boolean;
|
|
664
501
|
};
|
|
665
|
-
|
|
666
|
-
/** @example
|
|
667
|
-
|
|
668
|
-
/** @example
|
|
669
|
-
|
|
502
|
+
Extensions: {
|
|
503
|
+
/** @example GENERIC_ERROR */
|
|
504
|
+
message_code?: string;
|
|
505
|
+
/** @example [] */
|
|
506
|
+
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
507
|
+
extra_data?: Record<string, never> | null;
|
|
508
|
+
/** @example Detailed debug information */
|
|
509
|
+
debug?: string | null;
|
|
670
510
|
};
|
|
671
511
|
/**
|
|
672
512
|
* VariantPrice
|
|
@@ -731,94 +571,254 @@ export interface components {
|
|
|
731
571
|
requires_payment_method_upfront: boolean;
|
|
732
572
|
};
|
|
733
573
|
/**
|
|
734
|
-
*
|
|
735
|
-
* @description
|
|
574
|
+
* VariantItem
|
|
575
|
+
* @description Product variant (maps to product_variants_tbl)
|
|
736
576
|
*/
|
|
737
|
-
|
|
577
|
+
VariantItem: {
|
|
738
578
|
/**
|
|
739
|
-
*
|
|
740
|
-
* @description
|
|
741
|
-
* @default public
|
|
579
|
+
* Name
|
|
580
|
+
* @description Variant display name
|
|
742
581
|
*/
|
|
743
|
-
|
|
582
|
+
name: string;
|
|
744
583
|
/**
|
|
745
|
-
*
|
|
746
|
-
* @description
|
|
747
|
-
* @default true
|
|
584
|
+
* Sku
|
|
585
|
+
* @description Stock Keeping Unit
|
|
748
586
|
*/
|
|
749
|
-
|
|
587
|
+
sku?: string | null;
|
|
750
588
|
/**
|
|
751
|
-
*
|
|
752
|
-
* @description
|
|
589
|
+
* Attributes
|
|
590
|
+
* @description Custom attributes
|
|
753
591
|
*/
|
|
754
|
-
|
|
592
|
+
attributes?: {
|
|
593
|
+
[key: string]: unknown;
|
|
594
|
+
} | null;
|
|
755
595
|
/**
|
|
756
|
-
*
|
|
757
|
-
* @description
|
|
758
|
-
* @default
|
|
596
|
+
* Is Default
|
|
597
|
+
* @description Set as default variant
|
|
598
|
+
* @default false
|
|
759
599
|
*/
|
|
760
|
-
|
|
600
|
+
is_default: boolean;
|
|
761
601
|
/**
|
|
762
|
-
*
|
|
763
|
-
* @description
|
|
764
|
-
* @default
|
|
602
|
+
* Track Inventory
|
|
603
|
+
* @description Track stock for this variant
|
|
604
|
+
* @default false
|
|
765
605
|
*/
|
|
766
|
-
|
|
606
|
+
track_inventory: boolean;
|
|
767
607
|
/**
|
|
768
|
-
*
|
|
769
|
-
* @description
|
|
608
|
+
* Stock Quantity
|
|
609
|
+
* @description Initial stock
|
|
770
610
|
*/
|
|
771
|
-
|
|
611
|
+
stock_quantity?: number | null;
|
|
772
612
|
/**
|
|
773
|
-
*
|
|
774
|
-
* @description
|
|
613
|
+
* Allow Backorder
|
|
614
|
+
* @description Allow orders when out of stock
|
|
615
|
+
* @default false
|
|
775
616
|
*/
|
|
776
|
-
|
|
617
|
+
allow_backorder: boolean;
|
|
777
618
|
/**
|
|
778
|
-
*
|
|
779
|
-
* @description
|
|
780
|
-
* @default false
|
|
619
|
+
* Weight
|
|
620
|
+
* @description Weight in kg
|
|
781
621
|
*/
|
|
782
|
-
|
|
622
|
+
weight?: number | null;
|
|
623
|
+
/**
|
|
624
|
+
* Length
|
|
625
|
+
* @description Length in cm
|
|
626
|
+
*/
|
|
627
|
+
length?: number | null;
|
|
628
|
+
/**
|
|
629
|
+
* Width
|
|
630
|
+
* @description Width in cm
|
|
631
|
+
*/
|
|
632
|
+
width?: number | null;
|
|
633
|
+
/**
|
|
634
|
+
* Height
|
|
635
|
+
* @description Height in cm
|
|
636
|
+
*/
|
|
637
|
+
height?: number | null;
|
|
638
|
+
/**
|
|
639
|
+
* Display Order
|
|
640
|
+
* @description Display order
|
|
641
|
+
* @default 100
|
|
642
|
+
*/
|
|
643
|
+
display_order: number;
|
|
644
|
+
/**
|
|
645
|
+
* Metadata
|
|
646
|
+
* @description Flexible metadata
|
|
647
|
+
*/
|
|
648
|
+
metadata?: {
|
|
649
|
+
[key: string]: unknown;
|
|
650
|
+
} | null;
|
|
783
651
|
};
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
/**
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
652
|
+
/**
|
|
653
|
+
* ProductPrice
|
|
654
|
+
* @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
|
|
655
|
+
*/
|
|
656
|
+
ProductPrice: {
|
|
657
|
+
/**
|
|
658
|
+
* Price Type
|
|
659
|
+
* @description free, one_time, subscription, monthly_plan
|
|
660
|
+
*/
|
|
661
|
+
price_type: string;
|
|
662
|
+
/**
|
|
663
|
+
* Currency
|
|
664
|
+
* @description Currency code: INR, USD, EUR, etc.
|
|
665
|
+
*/
|
|
666
|
+
currency: string;
|
|
667
|
+
/**
|
|
668
|
+
* Amount
|
|
669
|
+
* @description Price amount
|
|
670
|
+
*/
|
|
671
|
+
amount: number;
|
|
672
|
+
/**
|
|
673
|
+
* Compare At Amount
|
|
674
|
+
* @description Original/strike-through price
|
|
675
|
+
*/
|
|
676
|
+
compare_at_amount?: number | null;
|
|
677
|
+
/**
|
|
678
|
+
* Interval
|
|
679
|
+
* @description day, week, month, year (for subscription)
|
|
680
|
+
*/
|
|
681
|
+
interval?: string | null;
|
|
682
|
+
/**
|
|
683
|
+
* Interval Count
|
|
684
|
+
* @description Number of intervals
|
|
685
|
+
*/
|
|
686
|
+
interval_count?: number | null;
|
|
687
|
+
/**
|
|
688
|
+
* Trial Period Days
|
|
689
|
+
* @description Free trial days
|
|
690
|
+
*/
|
|
691
|
+
trial_period_days?: number | null;
|
|
692
|
+
/**
|
|
693
|
+
* Initial Amount
|
|
694
|
+
* @description First payment amount
|
|
695
|
+
*/
|
|
696
|
+
initial_amount?: number | null;
|
|
697
|
+
/**
|
|
698
|
+
* Gateway
|
|
699
|
+
* @description stripe, razorpay, paypal, etc.
|
|
700
|
+
*/
|
|
701
|
+
gateway?: string | null;
|
|
702
|
+
/**
|
|
703
|
+
* Requires Payment Method Upfront
|
|
704
|
+
* @description Require payment method before trial
|
|
705
|
+
* @default true
|
|
706
|
+
*/
|
|
707
|
+
requires_payment_method_upfront: boolean;
|
|
708
|
+
};
|
|
709
|
+
InvalidParam: {
|
|
710
|
+
/** @example items[0].quantity */
|
|
711
|
+
field?: string;
|
|
712
|
+
/** @example Input should be greater than or equal to 1 */
|
|
713
|
+
error?: string;
|
|
798
714
|
};
|
|
799
715
|
/**
|
|
800
|
-
*
|
|
801
|
-
* @description
|
|
716
|
+
* WebinarCreateRequest
|
|
717
|
+
* @description Webinar creation request - inherits common fields, adds webinar-specific section
|
|
718
|
+
* @example {
|
|
719
|
+
* "identity": {
|
|
720
|
+
* "description": "Learn the latest marketing strategies...",
|
|
721
|
+
* "locale": "en-US",
|
|
722
|
+
* "title": "Marketing Strategies 2025"
|
|
723
|
+
* },
|
|
724
|
+
* "product": {
|
|
725
|
+
* "is_digital": true,
|
|
726
|
+
* "status": "draft",
|
|
727
|
+
* "visibility": "public"
|
|
728
|
+
* },
|
|
729
|
+
* "webinar": {
|
|
730
|
+
* "conferencing_platform": "zoom",
|
|
731
|
+
* "duration_minutes": 120,
|
|
732
|
+
* "ends_at": "2025-12-25T17:00:00Z",
|
|
733
|
+
* "max_attendees": 1000,
|
|
734
|
+
* "primary_presenter_id": "usr_abc123def456",
|
|
735
|
+
* "qa_enabled": true,
|
|
736
|
+
* "recording_enabled": true,
|
|
737
|
+
* "registration_required": true,
|
|
738
|
+
* "starts_at": "2025-12-25T15:00:00Z"
|
|
739
|
+
* }
|
|
740
|
+
* }
|
|
802
741
|
*/
|
|
803
|
-
|
|
742
|
+
WebinarCreateRequest: {
|
|
743
|
+
/** @description Base product configuration */
|
|
744
|
+
product: components["schemas"]["ProductSection"];
|
|
745
|
+
/** @description Localized content (title, description) */
|
|
746
|
+
identity: components["schemas"]["IdentitySection"];
|
|
747
|
+
/** @description Pre-uploaded image IDs */
|
|
748
|
+
media?: components["schemas"]["MediaSection"] | null;
|
|
804
749
|
/**
|
|
805
|
-
*
|
|
806
|
-
* @description
|
|
750
|
+
* Tags
|
|
751
|
+
* @description Tag IDs to associate with product
|
|
807
752
|
*/
|
|
808
|
-
|
|
753
|
+
tags?: number[] | null;
|
|
754
|
+
/**
|
|
755
|
+
* Variants
|
|
756
|
+
* @description Product variants (optional)
|
|
757
|
+
*/
|
|
758
|
+
variants?: components["schemas"]["VariantItem"][] | null;
|
|
759
|
+
/** @description Pricing for product and variants */
|
|
760
|
+
pricing?: components["schemas"]["PricingSection"] | null;
|
|
761
|
+
/** @description Webinar-specific configuration */
|
|
762
|
+
webinar: components["schemas"]["WebinarSection"];
|
|
809
763
|
};
|
|
810
764
|
/**
|
|
811
|
-
*
|
|
812
|
-
*
|
|
765
|
+
* @example {
|
|
766
|
+
* "status": "success",
|
|
767
|
+
* "message": "Operation successful",
|
|
768
|
+
* "message_code": "api_suc_20001",
|
|
769
|
+
* "data": {},
|
|
770
|
+
* "metadata": {
|
|
771
|
+
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
772
|
+
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
773
|
+
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
774
|
+
* "version": "v1",
|
|
775
|
+
* "executionTime": 42,
|
|
776
|
+
* "language": "en-US"
|
|
777
|
+
* }
|
|
778
|
+
* }
|
|
813
779
|
*/
|
|
814
|
-
|
|
815
|
-
/** @
|
|
816
|
-
|
|
780
|
+
StandardResponse: {
|
|
781
|
+
/** @example success */
|
|
782
|
+
status?: string;
|
|
783
|
+
data?: Record<string, never> | null;
|
|
784
|
+
/** @example Operation successful */
|
|
785
|
+
message?: string | null;
|
|
786
|
+
/** @example api_suc_20001 */
|
|
787
|
+
message_code?: string | null;
|
|
788
|
+
metadata?: Record<string, never> | null;
|
|
789
|
+
error?: components["schemas"]["ErrorResponse"];
|
|
790
|
+
};
|
|
791
|
+
/**
|
|
792
|
+
* IdentitySection
|
|
793
|
+
* @description Localized product content (maps to product_identity_tbl)
|
|
794
|
+
*/
|
|
795
|
+
IdentitySection: {
|
|
817
796
|
/**
|
|
818
|
-
*
|
|
819
|
-
* @description
|
|
797
|
+
* Locale
|
|
798
|
+
* @description Locale: en-US, es-PR, fr-FR, pt-BR, etc.
|
|
799
|
+
* @default en-US
|
|
820
800
|
*/
|
|
821
|
-
|
|
801
|
+
locale: string;
|
|
802
|
+
/**
|
|
803
|
+
* Title
|
|
804
|
+
* @description Product title
|
|
805
|
+
*/
|
|
806
|
+
title: string;
|
|
807
|
+
/**
|
|
808
|
+
* Subtitle
|
|
809
|
+
* @description Product subtitle
|
|
810
|
+
*/
|
|
811
|
+
subtitle?: string | null;
|
|
812
|
+
/**
|
|
813
|
+
* Description
|
|
814
|
+
* @description Full product description
|
|
815
|
+
*/
|
|
816
|
+
description?: string | null;
|
|
817
|
+
/**
|
|
818
|
+
* Short Description
|
|
819
|
+
* @description Short description for listings/previews
|
|
820
|
+
*/
|
|
821
|
+
short_description?: string | null;
|
|
822
822
|
};
|
|
823
823
|
};
|
|
824
824
|
responses: never;
|