@blezgo/api-sdk 0.1.4 → 0.1.5
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 +193 -193
- 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 +96 -96
- package/dist/addon/generated.d.ts.map +1 -1
- package/dist/admin/generated.d.ts +85 -85
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +87 -87
- package/dist/affiliate/generated.d.ts.map +1 -1
- package/dist/analytics/generated.d.ts +15 -15
- package/dist/analytics/generated.d.ts.map +1 -1
- package/dist/announcements/generated.d.ts +34 -34
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +99 -99
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +15 -15
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +74 -74
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +144 -144
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +177 -177
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +37 -37
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +69 -69
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +215 -215
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +57 -57
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +103 -103
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +221 -221
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +35 -35
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +155 -155
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +44 -44
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +500 -500
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +89 -89
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +350 -350
- package/dist/courses/generated.d.ts.map +1 -1
- package/dist/custom/generated.d.ts +70 -70
- package/dist/custom/generated.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +185 -185
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +15 -15
- package/dist/elasticsearch/generated.d.ts.map +1 -1
- package/dist/enrollments/generated.d.ts +15 -15
- package/dist/enrollments/generated.d.ts.map +1 -1
- package/dist/errors/generated.d.ts +15 -15
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +95 -95
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +131 -131
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +144 -144
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +60 -60
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +133 -133
- package/dist/inbox/generated.d.ts.map +1 -1
- package/dist/internal/generated.d.ts +15 -15
- package/dist/internal/generated.d.ts.map +1 -1
- package/dist/internationalization/generated.d.ts +15 -15
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +124 -124
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +213 -213
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +169 -169
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +411 -411
- package/dist/notification/generated.d.ts.map +1 -1
- package/dist/notifications/generated.d.ts +15 -15
- package/dist/notifications/generated.d.ts.map +1 -1
- package/dist/onboarding/generated.d.ts +96 -96
- package/dist/onboarding/generated.d.ts.map +1 -1
- package/dist/packages/generated.d.ts +78 -78
- package/dist/packages/generated.d.ts.map +1 -1
- package/dist/payments/generated.d.ts +530 -530
- package/dist/payments/generated.d.ts.map +1 -1
- package/dist/payouts/generated.d.ts +15 -15
- package/dist/payouts/generated.d.ts.map +1 -1
- package/dist/plans/generated.d.ts +281 -281
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +97 -97
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +491 -491
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +265 -265
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +100 -100
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +140 -140
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +67 -67
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +216 -216
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +118 -118
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +819 -819
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +236 -236
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +423 -423
- package/dist/spaces/generated.d.ts.map +1 -1
- package/dist/storefront/generated.d.ts +15 -15
- package/dist/storefront/generated.d.ts.map +1 -1
- package/dist/support/generated.d.ts +1605 -1605
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +156 -156
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +435 -435
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +60 -60
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +415 -415
- package/dist/tests/generated.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +48 -48
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/uploads/generated.d.ts +56 -56
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +86 -86
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +99 -99
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +185 -185
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -224,6 +224,170 @@ export interface paths {
|
|
|
224
224
|
export type webhooks = Record<string, never>;
|
|
225
225
|
export interface components {
|
|
226
226
|
schemas: {
|
|
227
|
+
/**
|
|
228
|
+
* @example {
|
|
229
|
+
* "status": "success",
|
|
230
|
+
* "message": "Operation successful",
|
|
231
|
+
* "message_code": "api_suc_20001",
|
|
232
|
+
* "data": {},
|
|
233
|
+
* "metadata": {
|
|
234
|
+
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
235
|
+
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
236
|
+
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
237
|
+
* "version": "v1",
|
|
238
|
+
* "executionTime": 42,
|
|
239
|
+
* "language": "en-US"
|
|
240
|
+
* }
|
|
241
|
+
* }
|
|
242
|
+
*/
|
|
243
|
+
StandardResponse: {
|
|
244
|
+
/** @example success */
|
|
245
|
+
status?: string;
|
|
246
|
+
data?: Record<string, never> | null;
|
|
247
|
+
/** @example Operation successful */
|
|
248
|
+
message?: string | null;
|
|
249
|
+
/** @example api_suc_20001 */
|
|
250
|
+
message_code?: string | null;
|
|
251
|
+
metadata?: Record<string, never> | null;
|
|
252
|
+
error?: components["schemas"]["ErrorResponse"];
|
|
253
|
+
};
|
|
254
|
+
/**
|
|
255
|
+
* TenantPlanCreateRequest
|
|
256
|
+
* @description Tenant Plan creation request - inherits common fields, adds plan-specific sections
|
|
257
|
+
* @example {
|
|
258
|
+
* "features": {
|
|
259
|
+
* "collections": {
|
|
260
|
+
* "enabled": true,
|
|
261
|
+
* "max_collections": 50
|
|
262
|
+
* },
|
|
263
|
+
* "corporate_products": {
|
|
264
|
+
* "enabled": true
|
|
265
|
+
* },
|
|
266
|
+
* "multilingual": {
|
|
267
|
+
* "enabled": true,
|
|
268
|
+
* "languages": [
|
|
269
|
+
* "en-US",
|
|
270
|
+
* "es-ES",
|
|
271
|
+
* "fr-FR"
|
|
272
|
+
* ]
|
|
273
|
+
* },
|
|
274
|
+
* "products": [
|
|
275
|
+
* "session",
|
|
276
|
+
* "webinar",
|
|
277
|
+
* "meeting"
|
|
278
|
+
* ]
|
|
279
|
+
* },
|
|
280
|
+
* "identity": {
|
|
281
|
+
* "description": "Comprehensive features for professional use with advanced virtual classroom capabilities...",
|
|
282
|
+
* "locale": "en-US",
|
|
283
|
+
* "short_description": "Professional tier with advanced features",
|
|
284
|
+
* "subtitle": "Perfect for growing teams",
|
|
285
|
+
* "title": "Professional Plan"
|
|
286
|
+
* },
|
|
287
|
+
* "media": {
|
|
288
|
+
* "media_items": [
|
|
289
|
+
* {
|
|
290
|
+
* "alt_text": "Professional Plan Logo",
|
|
291
|
+
* "file_name": "logo.png",
|
|
292
|
+
* "file_path": "/plans/123/logo.png",
|
|
293
|
+
* "is_primary": true,
|
|
294
|
+
* "media_type": "logo",
|
|
295
|
+
* "mime_type": "image/png"
|
|
296
|
+
* }
|
|
297
|
+
* ]
|
|
298
|
+
* },
|
|
299
|
+
* "plan": {
|
|
300
|
+
* "active_user_limit": 50,
|
|
301
|
+
* "attendee_limit": 100,
|
|
302
|
+
* "bandwidth_gb_per_month": 500,
|
|
303
|
+
* "class_duration_minutes": 120,
|
|
304
|
+
* "concurrent_rooms": 10,
|
|
305
|
+
* "is_standard": false,
|
|
306
|
+
* "status": "active",
|
|
307
|
+
* "storage_limit_gb": 100,
|
|
308
|
+
* "virtual_classroom_enabled": true
|
|
309
|
+
* },
|
|
310
|
+
* "pricing": {
|
|
311
|
+
* "product_price": {
|
|
312
|
+
* "amount": 99,
|
|
313
|
+
* "currency": "USD",
|
|
314
|
+
* "interval": "month",
|
|
315
|
+
* "price_type": "recurring"
|
|
316
|
+
* },
|
|
317
|
+
* "variant_prices": [
|
|
318
|
+
* {
|
|
319
|
+
* "amount": 99,
|
|
320
|
+
* "currency": "USD",
|
|
321
|
+
* "interval": "month",
|
|
322
|
+
* "price_type": "recurring",
|
|
323
|
+
* "variant_index": 0
|
|
324
|
+
* },
|
|
325
|
+
* {
|
|
326
|
+
* "amount": 950,
|
|
327
|
+
* "currency": "USD",
|
|
328
|
+
* "interval": "year",
|
|
329
|
+
* "price_type": "recurring",
|
|
330
|
+
* "variant_index": 1
|
|
331
|
+
* }
|
|
332
|
+
* ]
|
|
333
|
+
* },
|
|
334
|
+
* "product": {
|
|
335
|
+
* "company_id": 2,
|
|
336
|
+
* "featured": false,
|
|
337
|
+
* "is_digital": true,
|
|
338
|
+
* "is_org_level": true,
|
|
339
|
+
* "status": "active",
|
|
340
|
+
* "visibility": "public"
|
|
341
|
+
* },
|
|
342
|
+
* "tags": [
|
|
343
|
+
* 1,
|
|
344
|
+
* 5,
|
|
345
|
+
* 8
|
|
346
|
+
* ],
|
|
347
|
+
* "variants": [
|
|
348
|
+
* {
|
|
349
|
+
* "attributes": {
|
|
350
|
+
* "billing_cycle": "monthly"
|
|
351
|
+
* },
|
|
352
|
+
* "is_default": true,
|
|
353
|
+
* "name": "Monthly",
|
|
354
|
+
* "sku": "PROF-MONTHLY"
|
|
355
|
+
* },
|
|
356
|
+
* {
|
|
357
|
+
* "attributes": {
|
|
358
|
+
* "billing_cycle": "annual",
|
|
359
|
+
* "discount": "20%"
|
|
360
|
+
* },
|
|
361
|
+
* "name": "Annual",
|
|
362
|
+
* "sku": "PROF-ANNUAL"
|
|
363
|
+
* }
|
|
364
|
+
* ]
|
|
365
|
+
* }
|
|
366
|
+
*/
|
|
367
|
+
TenantPlanCreateRequest: {
|
|
368
|
+
/** @description Base product configuration */
|
|
369
|
+
product: components["schemas"]["ProductSection"];
|
|
370
|
+
/** @description Localized content (title, description) */
|
|
371
|
+
identity: components["schemas"]["IdentitySection"];
|
|
372
|
+
/** @description Pre-uploaded image IDs */
|
|
373
|
+
media?: components["schemas"]["MediaSection"] | null;
|
|
374
|
+
/**
|
|
375
|
+
* Tags
|
|
376
|
+
* @description Tag IDs to associate with product
|
|
377
|
+
*/
|
|
378
|
+
tags?: number[] | null;
|
|
379
|
+
/**
|
|
380
|
+
* Variants
|
|
381
|
+
* @description Product variants (optional)
|
|
382
|
+
*/
|
|
383
|
+
variants?: components["schemas"]["VariantItem"][] | null;
|
|
384
|
+
/** @description Pricing for product and variants */
|
|
385
|
+
pricing?: components["schemas"]["PricingSection"] | null;
|
|
386
|
+
/** @description Tenant plan configuration and limits */
|
|
387
|
+
plan: components["schemas"]["TenantPlanSection"];
|
|
388
|
+
/** @description Optional plan features and add-ons */
|
|
389
|
+
features?: components["schemas"]["TenantPlanFeaturesSection"] | null;
|
|
390
|
+
};
|
|
227
391
|
/**
|
|
228
392
|
* VariantItem
|
|
229
393
|
* @description Product variant (maps to product_variants_tbl)
|
|
@@ -303,12 +467,6 @@ export interface components {
|
|
|
303
467
|
[key: string]: unknown;
|
|
304
468
|
} | null;
|
|
305
469
|
};
|
|
306
|
-
InvalidParam: {
|
|
307
|
-
/** @example items[0].quantity */
|
|
308
|
-
field?: string;
|
|
309
|
-
/** @example Input should be greater than or equal to 1 */
|
|
310
|
-
error?: string;
|
|
311
|
-
};
|
|
312
470
|
/**
|
|
313
471
|
* TenantPlanFeaturesSection
|
|
314
472
|
* @description Tenant Plan Features - Optional add-ons (maps to tenant_plan_features_tbl)
|
|
@@ -362,123 +520,71 @@ export interface components {
|
|
|
362
520
|
[key: string]: unknown;
|
|
363
521
|
} | null;
|
|
364
522
|
};
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
374
|
-
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
375
|
-
* "version": "v1",
|
|
376
|
-
* "executionTime": 42,
|
|
377
|
-
* "language": "en-US"
|
|
378
|
-
* }
|
|
379
|
-
* }
|
|
380
|
-
*/
|
|
381
|
-
StandardResponse: {
|
|
382
|
-
/** @example success */
|
|
383
|
-
status?: string;
|
|
384
|
-
data?: Record<string, never> | null;
|
|
385
|
-
/** @example Operation successful */
|
|
386
|
-
message?: string | null;
|
|
387
|
-
/** @example api_suc_20001 */
|
|
388
|
-
message_code?: string | null;
|
|
389
|
-
metadata?: Record<string, never> | null;
|
|
390
|
-
error?: components["schemas"]["ErrorResponse"];
|
|
523
|
+
Extensions: {
|
|
524
|
+
/** @example GENERIC_ERROR */
|
|
525
|
+
message_code?: string;
|
|
526
|
+
/** @example [] */
|
|
527
|
+
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
528
|
+
extra_data?: Record<string, never> | null;
|
|
529
|
+
/** @example Detailed debug information */
|
|
530
|
+
debug?: string | null;
|
|
391
531
|
};
|
|
392
532
|
/**
|
|
393
|
-
*
|
|
394
|
-
* @description
|
|
533
|
+
* ProductPrice
|
|
534
|
+
* @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
|
|
395
535
|
*/
|
|
396
|
-
|
|
397
|
-
/**
|
|
398
|
-
* Media Type
|
|
399
|
-
* @description logo, banner, promo_video, gallery_image, gallery_video, swatch
|
|
400
|
-
*/
|
|
401
|
-
media_type: string;
|
|
402
|
-
/**
|
|
403
|
-
* File Path
|
|
404
|
-
* @description Path to media file on storage (S3, CDN, local)
|
|
405
|
-
*/
|
|
406
|
-
file_path: string;
|
|
407
|
-
/**
|
|
408
|
-
* File Name
|
|
409
|
-
* @description Original filename
|
|
410
|
-
*/
|
|
411
|
-
file_name: string;
|
|
536
|
+
ProductPrice: {
|
|
412
537
|
/**
|
|
413
|
-
*
|
|
414
|
-
* @description
|
|
538
|
+
* Price Type
|
|
539
|
+
* @description free, one_time, subscription, monthly_plan
|
|
415
540
|
*/
|
|
416
|
-
|
|
541
|
+
price_type: string;
|
|
417
542
|
/**
|
|
418
|
-
*
|
|
419
|
-
* @description
|
|
543
|
+
* Currency
|
|
544
|
+
* @description Currency code: INR, USD, EUR, etc.
|
|
420
545
|
*/
|
|
421
|
-
|
|
546
|
+
currency: string;
|
|
422
547
|
/**
|
|
423
|
-
*
|
|
424
|
-
* @description
|
|
548
|
+
* Amount
|
|
549
|
+
* @description Price amount
|
|
425
550
|
*/
|
|
426
|
-
|
|
551
|
+
amount: number;
|
|
427
552
|
/**
|
|
428
|
-
*
|
|
429
|
-
* @description
|
|
553
|
+
* Compare At Amount
|
|
554
|
+
* @description Original/strike-through price
|
|
430
555
|
*/
|
|
431
|
-
|
|
556
|
+
compare_at_amount?: number | null;
|
|
432
557
|
/**
|
|
433
|
-
*
|
|
434
|
-
* @description
|
|
558
|
+
* Interval
|
|
559
|
+
* @description day, week, month, year (for subscription)
|
|
435
560
|
*/
|
|
436
|
-
|
|
437
|
-
[key: string]: string;
|
|
438
|
-
} | null;
|
|
561
|
+
interval?: string | null;
|
|
439
562
|
/**
|
|
440
|
-
*
|
|
441
|
-
* @description
|
|
563
|
+
* Interval Count
|
|
564
|
+
* @description Number of intervals
|
|
442
565
|
*/
|
|
443
|
-
|
|
566
|
+
interval_count?: number | null;
|
|
444
567
|
/**
|
|
445
|
-
*
|
|
446
|
-
* @description
|
|
447
|
-
* @default en-US
|
|
568
|
+
* Trial Period Days
|
|
569
|
+
* @description Free trial days
|
|
448
570
|
*/
|
|
449
|
-
|
|
571
|
+
trial_period_days?: number | null;
|
|
450
572
|
/**
|
|
451
|
-
*
|
|
452
|
-
* @description
|
|
453
|
-
* @default 0
|
|
573
|
+
* Initial Amount
|
|
574
|
+
* @description First payment amount
|
|
454
575
|
*/
|
|
455
|
-
|
|
576
|
+
initial_amount?: number | null;
|
|
456
577
|
/**
|
|
457
|
-
*
|
|
458
|
-
* @description
|
|
459
|
-
* @default false
|
|
578
|
+
* Gateway
|
|
579
|
+
* @description stripe, razorpay, paypal, etc.
|
|
460
580
|
*/
|
|
461
|
-
|
|
462
|
-
};
|
|
463
|
-
/**
|
|
464
|
-
* MediaSection
|
|
465
|
-
* @description Product media files - direct media data
|
|
466
|
-
*/
|
|
467
|
-
MediaSection: {
|
|
581
|
+
gateway?: string | null;
|
|
468
582
|
/**
|
|
469
|
-
*
|
|
470
|
-
* @description
|
|
583
|
+
* Requires Payment Method Upfront
|
|
584
|
+
* @description Require payment method before trial
|
|
585
|
+
* @default true
|
|
471
586
|
*/
|
|
472
|
-
|
|
473
|
-
};
|
|
474
|
-
Extensions: {
|
|
475
|
-
/** @example GENERIC_ERROR */
|
|
476
|
-
message_code?: string;
|
|
477
|
-
/** @example [] */
|
|
478
|
-
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
479
|
-
extra_data?: Record<string, never> | null;
|
|
480
|
-
/** @example Detailed debug information */
|
|
481
|
-
debug?: string | null;
|
|
587
|
+
requires_payment_method_upfront: boolean;
|
|
482
588
|
};
|
|
483
589
|
/**
|
|
484
590
|
* IdentitySection
|
|
@@ -513,61 +619,81 @@ export interface components {
|
|
|
513
619
|
short_description?: string | null;
|
|
514
620
|
};
|
|
515
621
|
/**
|
|
516
|
-
*
|
|
517
|
-
* @description
|
|
622
|
+
* MediaItem
|
|
623
|
+
* @description Single media file item
|
|
518
624
|
*/
|
|
519
|
-
|
|
625
|
+
MediaItem: {
|
|
520
626
|
/**
|
|
521
|
-
*
|
|
522
|
-
* @description
|
|
627
|
+
* Media Type
|
|
628
|
+
* @description logo, banner, promo_video, gallery_image, gallery_video, swatch
|
|
523
629
|
*/
|
|
524
|
-
|
|
630
|
+
media_type: string;
|
|
525
631
|
/**
|
|
526
|
-
*
|
|
527
|
-
* @description
|
|
632
|
+
* File Path
|
|
633
|
+
* @description Path to media file on storage (S3, CDN, local)
|
|
528
634
|
*/
|
|
529
|
-
|
|
635
|
+
file_path: string;
|
|
530
636
|
/**
|
|
531
|
-
*
|
|
532
|
-
* @description
|
|
637
|
+
* File Name
|
|
638
|
+
* @description Original filename
|
|
533
639
|
*/
|
|
534
|
-
|
|
640
|
+
file_name: string;
|
|
535
641
|
/**
|
|
536
|
-
*
|
|
537
|
-
* @description
|
|
642
|
+
* File Size
|
|
643
|
+
* @description File size in bytes
|
|
538
644
|
*/
|
|
539
|
-
|
|
645
|
+
file_size?: number | null;
|
|
540
646
|
/**
|
|
541
|
-
*
|
|
542
|
-
* @description
|
|
647
|
+
* Mime Type
|
|
648
|
+
* @description MIME type (image/png, video/mp4, etc.)
|
|
543
649
|
*/
|
|
544
|
-
|
|
650
|
+
mime_type?: string | null;
|
|
545
651
|
/**
|
|
546
|
-
*
|
|
547
|
-
* @description
|
|
652
|
+
* Width
|
|
653
|
+
* @description Width in pixels (for images/videos)
|
|
548
654
|
*/
|
|
549
|
-
|
|
655
|
+
width?: number | null;
|
|
550
656
|
/**
|
|
551
|
-
*
|
|
552
|
-
* @description
|
|
657
|
+
* Height
|
|
658
|
+
* @description Height in pixels (for images/videos)
|
|
553
659
|
*/
|
|
554
|
-
|
|
660
|
+
height?: number | null;
|
|
555
661
|
/**
|
|
556
|
-
*
|
|
557
|
-
* @description
|
|
662
|
+
* Responsive Versions
|
|
663
|
+
* @description JSON with thumbnail, small, medium, large, xlarge, original paths
|
|
558
664
|
*/
|
|
559
|
-
|
|
665
|
+
responsive_versions?: {
|
|
666
|
+
[key: string]: string;
|
|
667
|
+
} | null;
|
|
560
668
|
/**
|
|
561
|
-
*
|
|
562
|
-
* @description
|
|
669
|
+
* Alt Text
|
|
670
|
+
* @description Alt text for SEO/accessibility
|
|
563
671
|
*/
|
|
564
|
-
|
|
672
|
+
alt_text?: string | null;
|
|
565
673
|
/**
|
|
566
|
-
*
|
|
567
|
-
* @description
|
|
568
|
-
* @default
|
|
674
|
+
* Locale
|
|
675
|
+
* @description Media locale (en-US, es-PR, etc.)
|
|
676
|
+
* @default en-US
|
|
569
677
|
*/
|
|
570
|
-
|
|
678
|
+
locale: string;
|
|
679
|
+
/**
|
|
680
|
+
* Display Order
|
|
681
|
+
* @description Display order
|
|
682
|
+
* @default 0
|
|
683
|
+
*/
|
|
684
|
+
display_order: number;
|
|
685
|
+
/**
|
|
686
|
+
* Is Primary
|
|
687
|
+
* @description Mark as primary media
|
|
688
|
+
* @default false
|
|
689
|
+
*/
|
|
690
|
+
is_primary: boolean;
|
|
691
|
+
};
|
|
692
|
+
InvalidParam: {
|
|
693
|
+
/** @example items[0].quantity */
|
|
694
|
+
field?: string;
|
|
695
|
+
/** @example Input should be greater than or equal to 1 */
|
|
696
|
+
error?: string;
|
|
571
697
|
};
|
|
572
698
|
/**
|
|
573
699
|
* VariantPrice
|
|
@@ -695,21 +821,6 @@ export interface components {
|
|
|
695
821
|
*/
|
|
696
822
|
status: string;
|
|
697
823
|
};
|
|
698
|
-
ErrorResponse: {
|
|
699
|
-
/** @example about:blank */
|
|
700
|
-
type?: string;
|
|
701
|
-
/** @example GENERIC_ERROR */
|
|
702
|
-
code?: string;
|
|
703
|
-
/** @example Client Error */
|
|
704
|
-
title?: string;
|
|
705
|
-
/** @example 400 */
|
|
706
|
-
status?: number;
|
|
707
|
-
/** @example An error occurred */
|
|
708
|
-
detail?: string;
|
|
709
|
-
/** @example /v1/cart/items */
|
|
710
|
-
instance?: string;
|
|
711
|
-
extensions?: components["schemas"]["Extensions"];
|
|
712
|
-
};
|
|
713
824
|
/**
|
|
714
825
|
* ProductSection
|
|
715
826
|
* @description Base product fields (maps to product_tbl)
|
|
@@ -761,142 +872,31 @@ export interface components {
|
|
|
761
872
|
*/
|
|
762
873
|
featured: boolean;
|
|
763
874
|
};
|
|
875
|
+
ErrorResponse: {
|
|
876
|
+
/** @example about:blank */
|
|
877
|
+
type?: string;
|
|
878
|
+
/** @example GENERIC_ERROR */
|
|
879
|
+
code?: string;
|
|
880
|
+
/** @example Client Error */
|
|
881
|
+
title?: string;
|
|
882
|
+
/** @example 400 */
|
|
883
|
+
status?: number;
|
|
884
|
+
/** @example An error occurred */
|
|
885
|
+
detail?: string;
|
|
886
|
+
/** @example /v1/cart/items */
|
|
887
|
+
instance?: string;
|
|
888
|
+
extensions?: components["schemas"]["Extensions"];
|
|
889
|
+
};
|
|
764
890
|
/**
|
|
765
|
-
*
|
|
766
|
-
* @description
|
|
767
|
-
* @example {
|
|
768
|
-
* "features": {
|
|
769
|
-
* "collections": {
|
|
770
|
-
* "enabled": true,
|
|
771
|
-
* "max_collections": 50
|
|
772
|
-
* },
|
|
773
|
-
* "corporate_products": {
|
|
774
|
-
* "enabled": true
|
|
775
|
-
* },
|
|
776
|
-
* "multilingual": {
|
|
777
|
-
* "enabled": true,
|
|
778
|
-
* "languages": [
|
|
779
|
-
* "en-US",
|
|
780
|
-
* "es-ES",
|
|
781
|
-
* "fr-FR"
|
|
782
|
-
* ]
|
|
783
|
-
* },
|
|
784
|
-
* "products": [
|
|
785
|
-
* "session",
|
|
786
|
-
* "webinar",
|
|
787
|
-
* "meeting"
|
|
788
|
-
* ]
|
|
789
|
-
* },
|
|
790
|
-
* "identity": {
|
|
791
|
-
* "description": "Comprehensive features for professional use with advanced virtual classroom capabilities...",
|
|
792
|
-
* "locale": "en-US",
|
|
793
|
-
* "short_description": "Professional tier with advanced features",
|
|
794
|
-
* "subtitle": "Perfect for growing teams",
|
|
795
|
-
* "title": "Professional Plan"
|
|
796
|
-
* },
|
|
797
|
-
* "media": {
|
|
798
|
-
* "media_items": [
|
|
799
|
-
* {
|
|
800
|
-
* "alt_text": "Professional Plan Logo",
|
|
801
|
-
* "file_name": "logo.png",
|
|
802
|
-
* "file_path": "/plans/123/logo.png",
|
|
803
|
-
* "is_primary": true,
|
|
804
|
-
* "media_type": "logo",
|
|
805
|
-
* "mime_type": "image/png"
|
|
806
|
-
* }
|
|
807
|
-
* ]
|
|
808
|
-
* },
|
|
809
|
-
* "plan": {
|
|
810
|
-
* "active_user_limit": 50,
|
|
811
|
-
* "attendee_limit": 100,
|
|
812
|
-
* "bandwidth_gb_per_month": 500,
|
|
813
|
-
* "class_duration_minutes": 120,
|
|
814
|
-
* "concurrent_rooms": 10,
|
|
815
|
-
* "is_standard": false,
|
|
816
|
-
* "status": "active",
|
|
817
|
-
* "storage_limit_gb": 100,
|
|
818
|
-
* "virtual_classroom_enabled": true
|
|
819
|
-
* },
|
|
820
|
-
* "pricing": {
|
|
821
|
-
* "product_price": {
|
|
822
|
-
* "amount": 99,
|
|
823
|
-
* "currency": "USD",
|
|
824
|
-
* "interval": "month",
|
|
825
|
-
* "price_type": "recurring"
|
|
826
|
-
* },
|
|
827
|
-
* "variant_prices": [
|
|
828
|
-
* {
|
|
829
|
-
* "amount": 99,
|
|
830
|
-
* "currency": "USD",
|
|
831
|
-
* "interval": "month",
|
|
832
|
-
* "price_type": "recurring",
|
|
833
|
-
* "variant_index": 0
|
|
834
|
-
* },
|
|
835
|
-
* {
|
|
836
|
-
* "amount": 950,
|
|
837
|
-
* "currency": "USD",
|
|
838
|
-
* "interval": "year",
|
|
839
|
-
* "price_type": "recurring",
|
|
840
|
-
* "variant_index": 1
|
|
841
|
-
* }
|
|
842
|
-
* ]
|
|
843
|
-
* },
|
|
844
|
-
* "product": {
|
|
845
|
-
* "company_id": 2,
|
|
846
|
-
* "featured": false,
|
|
847
|
-
* "is_digital": true,
|
|
848
|
-
* "is_org_level": true,
|
|
849
|
-
* "status": "active",
|
|
850
|
-
* "visibility": "public"
|
|
851
|
-
* },
|
|
852
|
-
* "tags": [
|
|
853
|
-
* 1,
|
|
854
|
-
* 5,
|
|
855
|
-
* 8
|
|
856
|
-
* ],
|
|
857
|
-
* "variants": [
|
|
858
|
-
* {
|
|
859
|
-
* "attributes": {
|
|
860
|
-
* "billing_cycle": "monthly"
|
|
861
|
-
* },
|
|
862
|
-
* "is_default": true,
|
|
863
|
-
* "name": "Monthly",
|
|
864
|
-
* "sku": "PROF-MONTHLY"
|
|
865
|
-
* },
|
|
866
|
-
* {
|
|
867
|
-
* "attributes": {
|
|
868
|
-
* "billing_cycle": "annual",
|
|
869
|
-
* "discount": "20%"
|
|
870
|
-
* },
|
|
871
|
-
* "name": "Annual",
|
|
872
|
-
* "sku": "PROF-ANNUAL"
|
|
873
|
-
* }
|
|
874
|
-
* ]
|
|
875
|
-
* }
|
|
891
|
+
* MediaSection
|
|
892
|
+
* @description Product media files - direct media data
|
|
876
893
|
*/
|
|
877
|
-
|
|
878
|
-
/** @description Base product configuration */
|
|
879
|
-
product: components["schemas"]["ProductSection"];
|
|
880
|
-
/** @description Localized content (title, description) */
|
|
881
|
-
identity: components["schemas"]["IdentitySection"];
|
|
882
|
-
/** @description Pre-uploaded image IDs */
|
|
883
|
-
media?: components["schemas"]["MediaSection"] | null;
|
|
884
|
-
/**
|
|
885
|
-
* Tags
|
|
886
|
-
* @description Tag IDs to associate with product
|
|
887
|
-
*/
|
|
888
|
-
tags?: number[] | null;
|
|
894
|
+
MediaSection: {
|
|
889
895
|
/**
|
|
890
|
-
*
|
|
891
|
-
* @description
|
|
896
|
+
* Media Items
|
|
897
|
+
* @description List of media files to attach to product
|
|
892
898
|
*/
|
|
893
|
-
|
|
894
|
-
/** @description Pricing for product and variants */
|
|
895
|
-
pricing?: components["schemas"]["PricingSection"] | null;
|
|
896
|
-
/** @description Tenant plan configuration and limits */
|
|
897
|
-
plan: components["schemas"]["TenantPlanSection"];
|
|
898
|
-
/** @description Optional plan features and add-ons */
|
|
899
|
-
features?: components["schemas"]["TenantPlanFeaturesSection"] | null;
|
|
899
|
+
media_items?: components["schemas"]["MediaItem"][] | null;
|
|
900
900
|
};
|
|
901
901
|
/**
|
|
902
902
|
* PricingSection
|