@blezgo/api-sdk 0.1.2 → 0.1.4
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 +183 -183
- package/dist/account/generated.d.ts.map +1 -1
- package/dist/activity/generated.d.ts +82 -82
- package/dist/activity/generated.d.ts.map +1 -1
- package/dist/addon/generated.d.ts +88 -88
- package/dist/addon/generated.d.ts.map +1 -1
- package/dist/admin/generated.d.ts +42 -42
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +97 -98
- package/dist/affiliate/generated.d.ts.map +1 -1
- package/dist/analytics/generated.d.ts +27 -27
- package/dist/analytics/generated.d.ts.map +1 -1
- package/dist/announcements/generated.d.ts +118 -118
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +46 -46
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +24 -24
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +73 -73
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +142 -142
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +124 -124
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +32 -32
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +59 -59
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +151 -151
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +41 -41
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +90 -90
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +256 -256
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +73 -73
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +160 -160
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +57 -57
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +620 -620
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +85 -85
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +381 -381
- package/dist/courses/generated.d.ts.map +1 -1
- package/dist/custom/generated.d.ts +103 -103
- package/dist/custom/generated.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +148 -148
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +37 -37
- package/dist/elasticsearch/generated.d.ts.map +1 -1
- package/dist/enrollments/generated.d.ts +21 -21
- package/dist/enrollments/generated.d.ts.map +1 -1
- package/dist/errors/generated.d.ts +21 -21
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +88 -88
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +124 -125
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +151 -151
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +33 -33
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +154 -154
- package/dist/inbox/generated.d.ts.map +1 -1
- package/dist/internal/generated.d.ts +21 -21
- package/dist/internal/generated.d.ts.map +1 -1
- package/dist/internationalization/generated.d.ts +23 -23
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +107 -107
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +332 -332
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +200 -200
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +279 -279
- package/dist/notification/generated.d.ts.map +1 -1
- package/dist/notifications/generated.d.ts +21 -21
- package/dist/notifications/generated.d.ts.map +1 -1
- package/dist/onboarding/generated.d.ts +95 -95
- package/dist/onboarding/generated.d.ts.map +1 -1
- package/dist/packages/generated.d.ts +77 -77
- package/dist/packages/generated.d.ts.map +1 -1
- package/dist/payments/generated.d.ts +628 -631
- package/dist/payments/generated.d.ts.map +1 -1
- package/dist/payouts/generated.d.ts +21 -21
- package/dist/payouts/generated.d.ts.map +1 -1
- package/dist/plans/generated.d.ts +405 -405
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +75 -75
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +420 -420
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +310 -310
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +64 -64
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +163 -163
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +47 -47
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +944 -446
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +76 -76
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +1119 -1119
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +313 -313
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +340 -340
- package/dist/spaces/generated.d.ts.map +1 -1
- package/dist/storefront/generated.d.ts +21 -21
- package/dist/storefront/generated.d.ts.map +1 -1
- package/dist/support/generated.d.ts +1624 -1624
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +176 -176
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +487 -487
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +86 -86
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +456 -456
- package/dist/tests/generated.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +54 -54
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/uploads/generated.d.ts +65 -65
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +105 -105
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +272 -527
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +260 -260
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
- package/test-commit.txt +1 -0
|
@@ -224,101 +224,116 @@ export type webhooks = Record<string, never>;
|
|
|
224
224
|
export interface components {
|
|
225
225
|
schemas: {
|
|
226
226
|
/**
|
|
227
|
-
*
|
|
228
|
-
* @description
|
|
227
|
+
* VariantItem
|
|
228
|
+
* @description Product variant (maps to product_variants_tbl)
|
|
229
229
|
*/
|
|
230
|
-
|
|
231
|
-
/**
|
|
232
|
-
* Instructor Id
|
|
233
|
-
* @description External user ID of session instructor (usr_xxx)
|
|
234
|
-
*/
|
|
235
|
-
instructor_id?: string | null;
|
|
230
|
+
VariantItem: {
|
|
236
231
|
/**
|
|
237
|
-
*
|
|
238
|
-
*
|
|
239
|
-
* @description Session start time (UTC)
|
|
232
|
+
* Name
|
|
233
|
+
* @description Variant display name
|
|
240
234
|
*/
|
|
241
|
-
|
|
235
|
+
name: string;
|
|
242
236
|
/**
|
|
243
|
-
*
|
|
244
|
-
*
|
|
245
|
-
* @description Session end time (UTC)
|
|
237
|
+
* Sku
|
|
238
|
+
* @description Stock Keeping Unit
|
|
246
239
|
*/
|
|
247
|
-
|
|
240
|
+
sku?: string | null;
|
|
248
241
|
/**
|
|
249
|
-
*
|
|
250
|
-
* @description
|
|
242
|
+
* Attributes
|
|
243
|
+
* @description Custom attributes
|
|
251
244
|
*/
|
|
252
|
-
|
|
245
|
+
attributes?: {
|
|
246
|
+
[key: string]: unknown;
|
|
247
|
+
} | null;
|
|
253
248
|
/**
|
|
254
|
-
* Is
|
|
255
|
-
* @description
|
|
249
|
+
* Is Default
|
|
250
|
+
* @description Set as default variant
|
|
256
251
|
* @default false
|
|
257
252
|
*/
|
|
258
|
-
|
|
259
|
-
/**
|
|
260
|
-
* Recurrence Rule
|
|
261
|
-
* @description RRULE format for recurrence
|
|
262
|
-
*/
|
|
263
|
-
recurrence_rule?: string | null;
|
|
264
|
-
/**
|
|
265
|
-
* Recurrence End Date
|
|
266
|
-
* @description End date for recurring sessions
|
|
267
|
-
*/
|
|
268
|
-
recurrence_end_date?: string | null;
|
|
269
|
-
/**
|
|
270
|
-
* Max Participants
|
|
271
|
-
* @description Maximum number of participants
|
|
272
|
-
*/
|
|
273
|
-
max_participants?: number | null;
|
|
253
|
+
is_default: boolean;
|
|
274
254
|
/**
|
|
275
|
-
*
|
|
276
|
-
* @description
|
|
255
|
+
* Track Inventory
|
|
256
|
+
* @description Track stock for this variant
|
|
257
|
+
* @default false
|
|
277
258
|
*/
|
|
278
|
-
|
|
259
|
+
track_inventory: boolean;
|
|
279
260
|
/**
|
|
280
|
-
*
|
|
281
|
-
* @description
|
|
261
|
+
* Stock Quantity
|
|
262
|
+
* @description Initial stock
|
|
282
263
|
*/
|
|
283
|
-
|
|
264
|
+
stock_quantity?: number | null;
|
|
284
265
|
/**
|
|
285
|
-
*
|
|
286
|
-
* @description
|
|
266
|
+
* Allow Backorder
|
|
267
|
+
* @description Allow orders when out of stock
|
|
268
|
+
* @default false
|
|
287
269
|
*/
|
|
288
|
-
|
|
270
|
+
allow_backorder: boolean;
|
|
289
271
|
/**
|
|
290
|
-
*
|
|
291
|
-
* @description
|
|
272
|
+
* Weight
|
|
273
|
+
* @description Weight in kg
|
|
292
274
|
*/
|
|
293
|
-
|
|
275
|
+
weight?: number | null;
|
|
294
276
|
/**
|
|
295
|
-
*
|
|
296
|
-
* @description
|
|
297
|
-
* @default true
|
|
277
|
+
* Length
|
|
278
|
+
* @description Length in cm
|
|
298
279
|
*/
|
|
299
|
-
|
|
280
|
+
length?: number | null;
|
|
300
281
|
/**
|
|
301
|
-
*
|
|
302
|
-
* @description
|
|
303
|
-
* @default false
|
|
282
|
+
* Width
|
|
283
|
+
* @description Width in cm
|
|
304
284
|
*/
|
|
305
|
-
|
|
285
|
+
width?: number | null;
|
|
306
286
|
/**
|
|
307
|
-
*
|
|
308
|
-
* @description
|
|
287
|
+
* Height
|
|
288
|
+
* @description Height in cm
|
|
309
289
|
*/
|
|
310
|
-
|
|
290
|
+
height?: number | null;
|
|
311
291
|
/**
|
|
312
|
-
*
|
|
313
|
-
* @description
|
|
314
|
-
* @default
|
|
292
|
+
* Display Order
|
|
293
|
+
* @description Display order
|
|
294
|
+
* @default 100
|
|
315
295
|
*/
|
|
316
|
-
|
|
296
|
+
display_order: number;
|
|
317
297
|
/**
|
|
318
|
-
*
|
|
319
|
-
* @description
|
|
298
|
+
* Metadata
|
|
299
|
+
* @description Flexible metadata
|
|
320
300
|
*/
|
|
321
|
-
|
|
301
|
+
metadata?: {
|
|
302
|
+
[key: string]: unknown;
|
|
303
|
+
} | null;
|
|
304
|
+
};
|
|
305
|
+
InvalidParam: {
|
|
306
|
+
/** @example items[0].quantity */
|
|
307
|
+
field?: string;
|
|
308
|
+
/** @example Input should be greater than or equal to 1 */
|
|
309
|
+
error?: string;
|
|
310
|
+
};
|
|
311
|
+
/**
|
|
312
|
+
* @example {
|
|
313
|
+
* "status": "success",
|
|
314
|
+
* "message": "Operation successful",
|
|
315
|
+
* "message_code": "api_suc_20001",
|
|
316
|
+
* "data": {},
|
|
317
|
+
* "metadata": {
|
|
318
|
+
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
319
|
+
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
320
|
+
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
321
|
+
* "version": "v1",
|
|
322
|
+
* "executionTime": 42,
|
|
323
|
+
* "language": "en-US"
|
|
324
|
+
* }
|
|
325
|
+
* }
|
|
326
|
+
*/
|
|
327
|
+
StandardResponse: {
|
|
328
|
+
/** @example success */
|
|
329
|
+
status?: string;
|
|
330
|
+
data?: Record<string, never> | null;
|
|
331
|
+
/** @example Operation successful */
|
|
332
|
+
message?: string | null;
|
|
333
|
+
/** @example api_suc_20001 */
|
|
334
|
+
message_code?: string | null;
|
|
335
|
+
metadata?: Record<string, never> | null;
|
|
336
|
+
error?: components["schemas"]["ErrorResponse"];
|
|
322
337
|
};
|
|
323
338
|
/** Body_updateSession */
|
|
324
339
|
Body_updateSession: {
|
|
@@ -337,78 +352,6 @@ export interface components {
|
|
|
337
352
|
/** Requires Camera */
|
|
338
353
|
requires_camera?: boolean | null;
|
|
339
354
|
};
|
|
340
|
-
/**
|
|
341
|
-
* ProductPrice
|
|
342
|
-
* @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
|
|
343
|
-
*/
|
|
344
|
-
ProductPrice: {
|
|
345
|
-
/**
|
|
346
|
-
* Price Type
|
|
347
|
-
* @description free, one_time, subscription, monthly_plan
|
|
348
|
-
*/
|
|
349
|
-
price_type: string;
|
|
350
|
-
/**
|
|
351
|
-
* Currency
|
|
352
|
-
* @description Currency code: INR, USD, EUR, etc.
|
|
353
|
-
*/
|
|
354
|
-
currency: string;
|
|
355
|
-
/**
|
|
356
|
-
* Amount
|
|
357
|
-
* @description Price amount
|
|
358
|
-
*/
|
|
359
|
-
amount: number;
|
|
360
|
-
/**
|
|
361
|
-
* Compare At Amount
|
|
362
|
-
* @description Original/strike-through price
|
|
363
|
-
*/
|
|
364
|
-
compare_at_amount?: number | null;
|
|
365
|
-
/**
|
|
366
|
-
* Interval
|
|
367
|
-
* @description day, week, month, year (for subscription)
|
|
368
|
-
*/
|
|
369
|
-
interval?: string | null;
|
|
370
|
-
/**
|
|
371
|
-
* Interval Count
|
|
372
|
-
* @description Number of intervals
|
|
373
|
-
*/
|
|
374
|
-
interval_count?: number | null;
|
|
375
|
-
/**
|
|
376
|
-
* Trial Period Days
|
|
377
|
-
* @description Free trial days
|
|
378
|
-
*/
|
|
379
|
-
trial_period_days?: number | null;
|
|
380
|
-
/**
|
|
381
|
-
* Initial Amount
|
|
382
|
-
* @description First payment amount
|
|
383
|
-
*/
|
|
384
|
-
initial_amount?: number | null;
|
|
385
|
-
/**
|
|
386
|
-
* Gateway
|
|
387
|
-
* @description stripe, razorpay, paypal, etc.
|
|
388
|
-
*/
|
|
389
|
-
gateway?: string | null;
|
|
390
|
-
/**
|
|
391
|
-
* Requires Payment Method Upfront
|
|
392
|
-
* @description Require payment method before trial
|
|
393
|
-
* @default true
|
|
394
|
-
*/
|
|
395
|
-
requires_payment_method_upfront: boolean;
|
|
396
|
-
};
|
|
397
|
-
ErrorResponse: {
|
|
398
|
-
/** @example about:blank */
|
|
399
|
-
type?: string;
|
|
400
|
-
/** @example GENERIC_ERROR */
|
|
401
|
-
code?: string;
|
|
402
|
-
/** @example Client Error */
|
|
403
|
-
title?: string;
|
|
404
|
-
/** @example 400 */
|
|
405
|
-
status?: number;
|
|
406
|
-
/** @example An error occurred */
|
|
407
|
-
detail?: string;
|
|
408
|
-
/** @example /v1/cart/items */
|
|
409
|
-
instance?: string;
|
|
410
|
-
extensions?: components["schemas"]["Extensions"];
|
|
411
|
-
};
|
|
412
355
|
/**
|
|
413
356
|
* MediaItem
|
|
414
357
|
* @description Single media file item
|
|
@@ -480,6 +423,155 @@ export interface components {
|
|
|
480
423
|
*/
|
|
481
424
|
is_primary: boolean;
|
|
482
425
|
};
|
|
426
|
+
/**
|
|
427
|
+
* MediaSection
|
|
428
|
+
* @description Product media files - direct media data
|
|
429
|
+
*/
|
|
430
|
+
MediaSection: {
|
|
431
|
+
/**
|
|
432
|
+
* Media Items
|
|
433
|
+
* @description List of media files to attach to product
|
|
434
|
+
*/
|
|
435
|
+
media_items?: components["schemas"]["MediaItem"][] | null;
|
|
436
|
+
};
|
|
437
|
+
/**
|
|
438
|
+
* SessionSection
|
|
439
|
+
* @description Session-specific fields (maps to sessions_tbl)
|
|
440
|
+
*/
|
|
441
|
+
SessionSection: {
|
|
442
|
+
/**
|
|
443
|
+
* Instructor Id
|
|
444
|
+
* @description External user ID of session instructor (usr_xxx)
|
|
445
|
+
*/
|
|
446
|
+
instructor_id?: string | null;
|
|
447
|
+
/**
|
|
448
|
+
* Starts At
|
|
449
|
+
* Format: date-time
|
|
450
|
+
* @description Session start time (UTC)
|
|
451
|
+
*/
|
|
452
|
+
starts_at: string;
|
|
453
|
+
/**
|
|
454
|
+
* Ends At
|
|
455
|
+
* Format: date-time
|
|
456
|
+
* @description Session end time (UTC)
|
|
457
|
+
*/
|
|
458
|
+
ends_at: string;
|
|
459
|
+
/**
|
|
460
|
+
* Duration Minutes
|
|
461
|
+
* @description Session duration in minutes
|
|
462
|
+
*/
|
|
463
|
+
duration_minutes?: number | null;
|
|
464
|
+
/**
|
|
465
|
+
* Is Recurring
|
|
466
|
+
* @description Is this a recurring session
|
|
467
|
+
* @default false
|
|
468
|
+
*/
|
|
469
|
+
is_recurring: boolean;
|
|
470
|
+
/**
|
|
471
|
+
* Recurrence Rule
|
|
472
|
+
* @description RRULE format for recurrence
|
|
473
|
+
*/
|
|
474
|
+
recurrence_rule?: string | null;
|
|
475
|
+
/**
|
|
476
|
+
* Recurrence End Date
|
|
477
|
+
* @description End date for recurring sessions
|
|
478
|
+
*/
|
|
479
|
+
recurrence_end_date?: string | null;
|
|
480
|
+
/**
|
|
481
|
+
* Max Participants
|
|
482
|
+
* @description Maximum number of participants
|
|
483
|
+
*/
|
|
484
|
+
max_participants?: number | null;
|
|
485
|
+
/**
|
|
486
|
+
* Location Type
|
|
487
|
+
* @description virtual, physical, hybrid
|
|
488
|
+
*/
|
|
489
|
+
location_type?: string | null;
|
|
490
|
+
/**
|
|
491
|
+
* Physical Location
|
|
492
|
+
* @description Physical location address
|
|
493
|
+
*/
|
|
494
|
+
physical_location?: string | null;
|
|
495
|
+
/**
|
|
496
|
+
* Conferencing Platform
|
|
497
|
+
* @description zoom, teams, google_meet, webex, physical, none
|
|
498
|
+
*/
|
|
499
|
+
conferencing_platform?: string | null;
|
|
500
|
+
/**
|
|
501
|
+
* Conference Account Id
|
|
502
|
+
* @description Specific conference account to use
|
|
503
|
+
*/
|
|
504
|
+
conference_account_id?: number | null;
|
|
505
|
+
/**
|
|
506
|
+
* Allows Questions
|
|
507
|
+
* @description Allow participants to ask questions
|
|
508
|
+
* @default true
|
|
509
|
+
*/
|
|
510
|
+
allows_questions: boolean;
|
|
511
|
+
/**
|
|
512
|
+
* Requires Camera
|
|
513
|
+
* @description Require participants to turn on camera
|
|
514
|
+
* @default false
|
|
515
|
+
*/
|
|
516
|
+
requires_camera: boolean;
|
|
517
|
+
/**
|
|
518
|
+
* Interactive Mode
|
|
519
|
+
* @description full_interactive, semi_interactive, lecture_only
|
|
520
|
+
*/
|
|
521
|
+
interactive_mode?: string | null;
|
|
522
|
+
/**
|
|
523
|
+
* Status
|
|
524
|
+
* @description scheduled, in_progress, completed, cancelled
|
|
525
|
+
* @default scheduled
|
|
526
|
+
*/
|
|
527
|
+
status: string;
|
|
528
|
+
/**
|
|
529
|
+
* Locale
|
|
530
|
+
* @description Defaults to identity.locale if not provided
|
|
531
|
+
*/
|
|
532
|
+
locale?: string | null;
|
|
533
|
+
};
|
|
534
|
+
Extensions: {
|
|
535
|
+
/** @example GENERIC_ERROR */
|
|
536
|
+
message_code?: string;
|
|
537
|
+
/** @example [] */
|
|
538
|
+
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
539
|
+
extra_data?: Record<string, never> | null;
|
|
540
|
+
/** @example Detailed debug information */
|
|
541
|
+
debug?: string | null;
|
|
542
|
+
};
|
|
543
|
+
/**
|
|
544
|
+
* IdentitySection
|
|
545
|
+
* @description Localized product content (maps to product_identity_tbl)
|
|
546
|
+
*/
|
|
547
|
+
IdentitySection: {
|
|
548
|
+
/**
|
|
549
|
+
* Locale
|
|
550
|
+
* @description Locale: en-US, es-PR, fr-FR, pt-BR, etc.
|
|
551
|
+
* @default en-US
|
|
552
|
+
*/
|
|
553
|
+
locale: string;
|
|
554
|
+
/**
|
|
555
|
+
* Title
|
|
556
|
+
* @description Product title
|
|
557
|
+
*/
|
|
558
|
+
title: string;
|
|
559
|
+
/**
|
|
560
|
+
* Subtitle
|
|
561
|
+
* @description Product subtitle
|
|
562
|
+
*/
|
|
563
|
+
subtitle?: string | null;
|
|
564
|
+
/**
|
|
565
|
+
* Description
|
|
566
|
+
* @description Full product description
|
|
567
|
+
*/
|
|
568
|
+
description?: string | null;
|
|
569
|
+
/**
|
|
570
|
+
* Short Description
|
|
571
|
+
* @description Short description for listings/previews
|
|
572
|
+
*/
|
|
573
|
+
short_description?: string | null;
|
|
574
|
+
};
|
|
483
575
|
/**
|
|
484
576
|
* SessionCreateRequest
|
|
485
577
|
* @description Session creation request - inherits common fields, adds session-specific section
|
|
@@ -543,102 +635,61 @@ export interface components {
|
|
|
543
635
|
session: components["schemas"]["SessionSection"];
|
|
544
636
|
};
|
|
545
637
|
/**
|
|
546
|
-
*
|
|
547
|
-
* @description
|
|
638
|
+
* ProductPrice
|
|
639
|
+
* @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
|
|
548
640
|
*/
|
|
549
|
-
|
|
641
|
+
ProductPrice: {
|
|
550
642
|
/**
|
|
551
|
-
*
|
|
552
|
-
* @description
|
|
643
|
+
* Price Type
|
|
644
|
+
* @description free, one_time, subscription, monthly_plan
|
|
553
645
|
*/
|
|
554
|
-
|
|
555
|
-
};
|
|
556
|
-
/**
|
|
557
|
-
* ProductSection
|
|
558
|
-
* @description Base product fields (maps to product_tbl)
|
|
559
|
-
*/
|
|
560
|
-
ProductSection: {
|
|
646
|
+
price_type: string;
|
|
561
647
|
/**
|
|
562
|
-
*
|
|
563
|
-
* @description
|
|
564
|
-
* @default public
|
|
648
|
+
* Currency
|
|
649
|
+
* @description Currency code: INR, USD, EUR, etc.
|
|
565
650
|
*/
|
|
566
|
-
|
|
651
|
+
currency: string;
|
|
567
652
|
/**
|
|
568
|
-
*
|
|
569
|
-
* @description
|
|
570
|
-
* @default true
|
|
653
|
+
* Amount
|
|
654
|
+
* @description Price amount
|
|
571
655
|
*/
|
|
572
|
-
|
|
656
|
+
amount: number;
|
|
573
657
|
/**
|
|
574
|
-
*
|
|
575
|
-
* @description
|
|
658
|
+
* Compare At Amount
|
|
659
|
+
* @description Original/strike-through price
|
|
576
660
|
*/
|
|
577
|
-
|
|
661
|
+
compare_at_amount?: number | null;
|
|
578
662
|
/**
|
|
579
|
-
*
|
|
580
|
-
* @description
|
|
581
|
-
* @default draft
|
|
663
|
+
* Interval
|
|
664
|
+
* @description day, week, month, year (for subscription)
|
|
582
665
|
*/
|
|
583
|
-
|
|
666
|
+
interval?: string | null;
|
|
584
667
|
/**
|
|
585
|
-
*
|
|
586
|
-
* @description
|
|
587
|
-
* @default true
|
|
668
|
+
* Interval Count
|
|
669
|
+
* @description Number of intervals
|
|
588
670
|
*/
|
|
589
|
-
|
|
671
|
+
interval_count?: number | null;
|
|
590
672
|
/**
|
|
591
|
-
*
|
|
592
|
-
* @description
|
|
673
|
+
* Trial Period Days
|
|
674
|
+
* @description Free trial days
|
|
593
675
|
*/
|
|
594
|
-
|
|
676
|
+
trial_period_days?: number | null;
|
|
595
677
|
/**
|
|
596
|
-
*
|
|
597
|
-
* @description
|
|
678
|
+
* Initial Amount
|
|
679
|
+
* @description First payment amount
|
|
598
680
|
*/
|
|
599
|
-
|
|
681
|
+
initial_amount?: number | null;
|
|
600
682
|
/**
|
|
601
|
-
*
|
|
602
|
-
* @description
|
|
603
|
-
* @default false
|
|
683
|
+
* Gateway
|
|
684
|
+
* @description stripe, razorpay, paypal, etc.
|
|
604
685
|
*/
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
extra_data?: Record<string, never> | null;
|
|
613
|
-
/** @example Detailed debug information */
|
|
614
|
-
debug?: string | null;
|
|
615
|
-
};
|
|
616
|
-
/**
|
|
617
|
-
* @example {
|
|
618
|
-
* "status": "success",
|
|
619
|
-
* "message": "Operation successful",
|
|
620
|
-
* "message_code": "api_suc_20001",
|
|
621
|
-
* "data": {},
|
|
622
|
-
* "metadata": {
|
|
623
|
-
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
624
|
-
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
625
|
-
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
626
|
-
* "version": "v1",
|
|
627
|
-
* "executionTime": 42,
|
|
628
|
-
* "language": "en-US"
|
|
629
|
-
* }
|
|
630
|
-
* }
|
|
631
|
-
*/
|
|
632
|
-
StandardResponse: {
|
|
633
|
-
/** @example success */
|
|
634
|
-
status?: string;
|
|
635
|
-
data?: Record<string, never> | null;
|
|
636
|
-
/** @example Operation successful */
|
|
637
|
-
message?: string | null;
|
|
638
|
-
/** @example api_suc_20001 */
|
|
639
|
-
message_code?: string | null;
|
|
640
|
-
metadata?: Record<string, never> | null;
|
|
641
|
-
error?: components["schemas"]["ErrorResponse"];
|
|
686
|
+
gateway?: string | null;
|
|
687
|
+
/**
|
|
688
|
+
* Requires Payment Method Upfront
|
|
689
|
+
* @description Require payment method before trial
|
|
690
|
+
* @default true
|
|
691
|
+
*/
|
|
692
|
+
requires_payment_method_upfront: boolean;
|
|
642
693
|
};
|
|
643
694
|
/**
|
|
644
695
|
* VariantPrice
|
|
@@ -702,116 +753,71 @@ export interface components {
|
|
|
702
753
|
*/
|
|
703
754
|
requires_payment_method_upfront: boolean;
|
|
704
755
|
};
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
/**
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
/**
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
*/
|
|
720
|
-
title: string;
|
|
721
|
-
/**
|
|
722
|
-
* Subtitle
|
|
723
|
-
* @description Product subtitle
|
|
724
|
-
*/
|
|
725
|
-
subtitle?: string | null;
|
|
726
|
-
/**
|
|
727
|
-
* Description
|
|
728
|
-
* @description Full product description
|
|
729
|
-
*/
|
|
730
|
-
description?: string | null;
|
|
731
|
-
/**
|
|
732
|
-
* Short Description
|
|
733
|
-
* @description Short description for listings/previews
|
|
734
|
-
*/
|
|
735
|
-
short_description?: string | null;
|
|
756
|
+
ErrorResponse: {
|
|
757
|
+
/** @example about:blank */
|
|
758
|
+
type?: string;
|
|
759
|
+
/** @example GENERIC_ERROR */
|
|
760
|
+
code?: string;
|
|
761
|
+
/** @example Client Error */
|
|
762
|
+
title?: string;
|
|
763
|
+
/** @example 400 */
|
|
764
|
+
status?: number;
|
|
765
|
+
/** @example An error occurred */
|
|
766
|
+
detail?: string;
|
|
767
|
+
/** @example /v1/cart/items */
|
|
768
|
+
instance?: string;
|
|
769
|
+
extensions?: components["schemas"]["Extensions"];
|
|
736
770
|
};
|
|
737
771
|
/**
|
|
738
|
-
*
|
|
739
|
-
* @description
|
|
772
|
+
* ProductSection
|
|
773
|
+
* @description Base product fields (maps to product_tbl)
|
|
740
774
|
*/
|
|
741
|
-
|
|
742
|
-
/**
|
|
743
|
-
* Name
|
|
744
|
-
* @description Variant display name
|
|
745
|
-
*/
|
|
746
|
-
name: string;
|
|
747
|
-
/**
|
|
748
|
-
* Sku
|
|
749
|
-
* @description Stock Keeping Unit
|
|
750
|
-
*/
|
|
751
|
-
sku?: string | null;
|
|
752
|
-
/**
|
|
753
|
-
* Attributes
|
|
754
|
-
* @description Custom attributes
|
|
755
|
-
*/
|
|
756
|
-
attributes?: {
|
|
757
|
-
[key: string]: unknown;
|
|
758
|
-
} | null;
|
|
759
|
-
/**
|
|
760
|
-
* Is Default
|
|
761
|
-
* @description Set as default variant
|
|
762
|
-
* @default false
|
|
763
|
-
*/
|
|
764
|
-
is_default: boolean;
|
|
765
|
-
/**
|
|
766
|
-
* Track Inventory
|
|
767
|
-
* @description Track stock for this variant
|
|
768
|
-
* @default false
|
|
769
|
-
*/
|
|
770
|
-
track_inventory: boolean;
|
|
775
|
+
ProductSection: {
|
|
771
776
|
/**
|
|
772
|
-
*
|
|
773
|
-
* @description
|
|
777
|
+
* Visibility
|
|
778
|
+
* @description public, private, hidden, unlisted
|
|
779
|
+
* @default public
|
|
774
780
|
*/
|
|
775
|
-
|
|
781
|
+
visibility: string;
|
|
776
782
|
/**
|
|
777
|
-
*
|
|
778
|
-
* @description
|
|
779
|
-
* @default
|
|
783
|
+
* Is Digital
|
|
784
|
+
* @description Digital product flag
|
|
785
|
+
* @default true
|
|
780
786
|
*/
|
|
781
|
-
|
|
787
|
+
is_digital: boolean;
|
|
782
788
|
/**
|
|
783
|
-
*
|
|
784
|
-
* @description
|
|
789
|
+
* Company Id
|
|
790
|
+
* @description Multi-company support
|
|
785
791
|
*/
|
|
786
|
-
|
|
792
|
+
company_id?: number | null;
|
|
787
793
|
/**
|
|
788
|
-
*
|
|
789
|
-
* @description
|
|
794
|
+
* Status
|
|
795
|
+
* @description draft, published, archived, review_required, deleted
|
|
796
|
+
* @default draft
|
|
790
797
|
*/
|
|
791
|
-
|
|
798
|
+
status: string;
|
|
792
799
|
/**
|
|
793
|
-
*
|
|
794
|
-
* @description
|
|
800
|
+
* Is Org Level
|
|
801
|
+
* @description Org-level vs user-created product
|
|
802
|
+
* @default true
|
|
795
803
|
*/
|
|
796
|
-
|
|
804
|
+
is_org_level: boolean;
|
|
797
805
|
/**
|
|
798
|
-
*
|
|
799
|
-
* @description
|
|
806
|
+
* Staff Id
|
|
807
|
+
* @description Staff/instructor delivering product
|
|
800
808
|
*/
|
|
801
|
-
|
|
809
|
+
staff_id?: number | null;
|
|
802
810
|
/**
|
|
803
|
-
*
|
|
804
|
-
* @description
|
|
805
|
-
* @default 100
|
|
811
|
+
* Owner Id
|
|
812
|
+
* @description Owner of the product
|
|
806
813
|
*/
|
|
807
|
-
|
|
814
|
+
owner_id?: number | null;
|
|
808
815
|
/**
|
|
809
|
-
*
|
|
810
|
-
* @description
|
|
816
|
+
* Featured
|
|
817
|
+
* @description Featured product flag
|
|
818
|
+
* @default false
|
|
811
819
|
*/
|
|
812
|
-
|
|
813
|
-
[key: string]: unknown;
|
|
814
|
-
} | null;
|
|
820
|
+
featured: boolean;
|
|
815
821
|
};
|
|
816
822
|
/**
|
|
817
823
|
* PricingSection
|
|
@@ -826,12 +832,6 @@ export interface components {
|
|
|
826
832
|
*/
|
|
827
833
|
variant_prices?: components["schemas"]["VariantPrice"][] | null;
|
|
828
834
|
};
|
|
829
|
-
InvalidParam: {
|
|
830
|
-
/** @example items[0].quantity */
|
|
831
|
-
field?: string;
|
|
832
|
-
/** @example Input should be greater than or equal to 1 */
|
|
833
|
-
error?: string;
|
|
834
|
-
};
|
|
835
835
|
};
|
|
836
836
|
responses: never;
|
|
837
837
|
parameters: never;
|