@blezgo/api-sdk 0.1.4 → 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 +230 -230
- package/dist/account/generated.d.ts.map +1 -1
- package/dist/activity/generated.d.ts +46 -46
- package/dist/activity/generated.d.ts.map +1 -1
- package/dist/addon/generated.d.ts +101 -101
- package/dist/addon/generated.d.ts.map +1 -1
- package/dist/admin/generated.d.ts +122 -122
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +82 -82
- package/dist/affiliate/generated.d.ts.map +1 -1
- package/dist/analytics/generated.d.ts +21 -21
- package/dist/analytics/generated.d.ts.map +1 -1
- package/dist/announcements/generated.d.ts +119 -119
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +129 -129
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +21 -21
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +83 -83
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +212 -212
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +185 -185
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +27 -27
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +54 -54
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +206 -206
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +42 -42
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +101 -101
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +213 -213
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +57 -57
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +109 -109
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +55 -55
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +613 -613
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +71 -71
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +453 -453
- package/dist/courses/generated.d.ts.map +1 -1
- package/dist/custom/generated.d.ts +78 -78
- package/dist/custom/generated.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +138 -138
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +21 -21
- 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 +54 -54
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +53 -53
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +117 -117
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +177 -177
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +52 -52
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +122 -122
- 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 +21 -21
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +156 -156
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +372 -372
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +199 -199
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +356 -356
- 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 +77 -77
- package/dist/onboarding/generated.d.ts.map +1 -1
- package/dist/packages/generated.d.ts +59 -59
- package/dist/packages/generated.d.ts.map +1 -1
- package/dist/payments/generated.d.ts +523 -523
- 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 +323 -323
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +38 -38
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +443 -443
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +354 -354
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +101 -101
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +171 -171
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +57 -57
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +191 -191
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +103 -103
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +1017 -1017
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +362 -362
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +600 -600
- 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 +1403 -1403
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +182 -182
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +737 -737
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +50 -50
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +472 -472
- 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 +69 -69
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +130 -130
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +72 -72
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +329 -329
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -181,236 +181,17 @@ export type webhooks = Record<string, never>;
|
|
|
181
181
|
export interface components {
|
|
182
182
|
schemas: {
|
|
183
183
|
/**
|
|
184
|
-
*
|
|
185
|
-
* @description
|
|
186
|
-
*/
|
|
187
|
-
VariantItem: {
|
|
188
|
-
/**
|
|
189
|
-
* Name
|
|
190
|
-
* @description Variant display name
|
|
191
|
-
*/
|
|
192
|
-
name: string;
|
|
193
|
-
/**
|
|
194
|
-
* Sku
|
|
195
|
-
* @description Stock Keeping Unit
|
|
196
|
-
*/
|
|
197
|
-
sku?: string | null;
|
|
198
|
-
/**
|
|
199
|
-
* Attributes
|
|
200
|
-
* @description Custom attributes
|
|
201
|
-
*/
|
|
202
|
-
attributes?: {
|
|
203
|
-
[key: string]: unknown;
|
|
204
|
-
} | null;
|
|
205
|
-
/**
|
|
206
|
-
* Is Default
|
|
207
|
-
* @description Set as default variant
|
|
208
|
-
* @default false
|
|
209
|
-
*/
|
|
210
|
-
is_default: boolean;
|
|
211
|
-
/**
|
|
212
|
-
* Track Inventory
|
|
213
|
-
* @description Track stock for this variant
|
|
214
|
-
* @default false
|
|
215
|
-
*/
|
|
216
|
-
track_inventory: boolean;
|
|
217
|
-
/**
|
|
218
|
-
* Stock Quantity
|
|
219
|
-
* @description Initial stock
|
|
220
|
-
*/
|
|
221
|
-
stock_quantity?: number | null;
|
|
222
|
-
/**
|
|
223
|
-
* Allow Backorder
|
|
224
|
-
* @description Allow orders when out of stock
|
|
225
|
-
* @default false
|
|
226
|
-
*/
|
|
227
|
-
allow_backorder: boolean;
|
|
228
|
-
/**
|
|
229
|
-
* Weight
|
|
230
|
-
* @description Weight in kg
|
|
231
|
-
*/
|
|
232
|
-
weight?: number | null;
|
|
233
|
-
/**
|
|
234
|
-
* Length
|
|
235
|
-
* @description Length in cm
|
|
236
|
-
*/
|
|
237
|
-
length?: number | null;
|
|
238
|
-
/**
|
|
239
|
-
* Width
|
|
240
|
-
* @description Width in cm
|
|
241
|
-
*/
|
|
242
|
-
width?: number | null;
|
|
243
|
-
/**
|
|
244
|
-
* Height
|
|
245
|
-
* @description Height in cm
|
|
246
|
-
*/
|
|
247
|
-
height?: number | null;
|
|
248
|
-
/**
|
|
249
|
-
* Display Order
|
|
250
|
-
* @description Display order
|
|
251
|
-
* @default 100
|
|
252
|
-
*/
|
|
253
|
-
display_order: number;
|
|
254
|
-
/**
|
|
255
|
-
* Metadata
|
|
256
|
-
* @description Flexible metadata
|
|
257
|
-
*/
|
|
258
|
-
metadata?: {
|
|
259
|
-
[key: string]: unknown;
|
|
260
|
-
} | null;
|
|
261
|
-
};
|
|
262
|
-
/**
|
|
263
|
-
* WebinarCreateRequest
|
|
264
|
-
* @description Webinar creation request - inherits common fields, adds webinar-specific section
|
|
265
|
-
* @example {
|
|
266
|
-
* "identity": {
|
|
267
|
-
* "description": "Learn the latest marketing strategies...",
|
|
268
|
-
* "locale": "en-US",
|
|
269
|
-
* "title": "Marketing Strategies 2025"
|
|
270
|
-
* },
|
|
271
|
-
* "product": {
|
|
272
|
-
* "is_digital": true,
|
|
273
|
-
* "status": "draft",
|
|
274
|
-
* "visibility": "public"
|
|
275
|
-
* },
|
|
276
|
-
* "webinar": {
|
|
277
|
-
* "conferencing_platform": "zoom",
|
|
278
|
-
* "duration_minutes": 120,
|
|
279
|
-
* "ends_at": "2025-12-25T17:00:00Z",
|
|
280
|
-
* "max_attendees": 1000,
|
|
281
|
-
* "primary_presenter_id": "usr_abc123def456",
|
|
282
|
-
* "qa_enabled": true,
|
|
283
|
-
* "recording_enabled": true,
|
|
284
|
-
* "registration_required": true,
|
|
285
|
-
* "starts_at": "2025-12-25T15:00:00Z"
|
|
286
|
-
* }
|
|
287
|
-
* }
|
|
288
|
-
*/
|
|
289
|
-
WebinarCreateRequest: {
|
|
290
|
-
/** @description Base product configuration */
|
|
291
|
-
product: components["schemas"]["ProductSection"];
|
|
292
|
-
/** @description Localized content (title, description) */
|
|
293
|
-
identity: components["schemas"]["IdentitySection"];
|
|
294
|
-
/** @description Pre-uploaded image IDs */
|
|
295
|
-
media?: components["schemas"]["MediaSection"] | null;
|
|
296
|
-
/**
|
|
297
|
-
* Tags
|
|
298
|
-
* @description Tag IDs to associate with product
|
|
299
|
-
*/
|
|
300
|
-
tags?: number[] | null;
|
|
301
|
-
/**
|
|
302
|
-
* Variants
|
|
303
|
-
* @description Product variants (optional)
|
|
304
|
-
*/
|
|
305
|
-
variants?: components["schemas"]["VariantItem"][] | null;
|
|
306
|
-
/** @description Pricing for product and variants */
|
|
307
|
-
pricing?: components["schemas"]["PricingSection"] | null;
|
|
308
|
-
/** @description Webinar-specific configuration */
|
|
309
|
-
webinar: components["schemas"]["WebinarSection"];
|
|
310
|
-
};
|
|
311
|
-
InvalidParam: {
|
|
312
|
-
/** @example items[0].quantity */
|
|
313
|
-
field?: string;
|
|
314
|
-
/** @example Input should be greater than or equal to 1 */
|
|
315
|
-
error?: string;
|
|
316
|
-
};
|
|
317
|
-
/**
|
|
318
|
-
* @example {
|
|
319
|
-
* "status": "success",
|
|
320
|
-
* "message": "Operation successful",
|
|
321
|
-
* "message_code": "api_suc_20001",
|
|
322
|
-
* "data": {},
|
|
323
|
-
* "metadata": {
|
|
324
|
-
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
325
|
-
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
326
|
-
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
327
|
-
* "version": "v1",
|
|
328
|
-
* "executionTime": 42,
|
|
329
|
-
* "language": "en-US"
|
|
330
|
-
* }
|
|
331
|
-
* }
|
|
332
|
-
*/
|
|
333
|
-
StandardResponse: {
|
|
334
|
-
/** @example success */
|
|
335
|
-
status?: string;
|
|
336
|
-
data?: Record<string, never> | null;
|
|
337
|
-
/** @example Operation successful */
|
|
338
|
-
message?: string | null;
|
|
339
|
-
/** @example api_suc_20001 */
|
|
340
|
-
message_code?: string | null;
|
|
341
|
-
metadata?: Record<string, never> | null;
|
|
342
|
-
error?: components["schemas"]["ErrorResponse"];
|
|
343
|
-
};
|
|
344
|
-
/**
|
|
345
|
-
* MediaItem
|
|
346
|
-
* @description Single media file item
|
|
184
|
+
* PricingSection
|
|
185
|
+
* @description Pricing configuration (optional - can have product price, variant prices, or both)
|
|
347
186
|
*/
|
|
348
|
-
|
|
349
|
-
/**
|
|
350
|
-
|
|
351
|
-
* @description logo, banner, promo_video, gallery_image, gallery_video, swatch
|
|
352
|
-
*/
|
|
353
|
-
media_type: string;
|
|
354
|
-
/**
|
|
355
|
-
* File Path
|
|
356
|
-
* @description Path to media file on storage (S3, CDN, local)
|
|
357
|
-
*/
|
|
358
|
-
file_path: string;
|
|
359
|
-
/**
|
|
360
|
-
* File Name
|
|
361
|
-
* @description Original filename
|
|
362
|
-
*/
|
|
363
|
-
file_name: string;
|
|
364
|
-
/**
|
|
365
|
-
* File Size
|
|
366
|
-
* @description File size in bytes
|
|
367
|
-
*/
|
|
368
|
-
file_size?: number | null;
|
|
369
|
-
/**
|
|
370
|
-
* Mime Type
|
|
371
|
-
* @description MIME type (image/png, video/mp4, etc.)
|
|
372
|
-
*/
|
|
373
|
-
mime_type?: string | null;
|
|
374
|
-
/**
|
|
375
|
-
* Width
|
|
376
|
-
* @description Width in pixels (for images/videos)
|
|
377
|
-
*/
|
|
378
|
-
width?: number | null;
|
|
379
|
-
/**
|
|
380
|
-
* Height
|
|
381
|
-
* @description Height in pixels (for images/videos)
|
|
382
|
-
*/
|
|
383
|
-
height?: number | null;
|
|
384
|
-
/**
|
|
385
|
-
* Responsive Versions
|
|
386
|
-
* @description JSON with thumbnail, small, medium, large, xlarge, original paths
|
|
387
|
-
*/
|
|
388
|
-
responsive_versions?: {
|
|
389
|
-
[key: string]: string;
|
|
390
|
-
} | null;
|
|
391
|
-
/**
|
|
392
|
-
* Alt Text
|
|
393
|
-
* @description Alt text for SEO/accessibility
|
|
394
|
-
*/
|
|
395
|
-
alt_text?: string | null;
|
|
396
|
-
/**
|
|
397
|
-
* Locale
|
|
398
|
-
* @description Media locale (en-US, es-PR, etc.)
|
|
399
|
-
* @default en-US
|
|
400
|
-
*/
|
|
401
|
-
locale: string;
|
|
402
|
-
/**
|
|
403
|
-
* Display Order
|
|
404
|
-
* @description Display order
|
|
405
|
-
* @default 0
|
|
406
|
-
*/
|
|
407
|
-
display_order: number;
|
|
187
|
+
PricingSection: {
|
|
188
|
+
/** @description Base product price (no variant) */
|
|
189
|
+
product_price?: components["schemas"]["ProductPrice"] | null;
|
|
408
190
|
/**
|
|
409
|
-
*
|
|
410
|
-
* @description
|
|
411
|
-
* @default false
|
|
191
|
+
* Variant Prices
|
|
192
|
+
* @description Variant-specific prices
|
|
412
193
|
*/
|
|
413
|
-
|
|
194
|
+
variant_prices?: components["schemas"]["VariantPrice"][] | null;
|
|
414
195
|
};
|
|
415
196
|
/**
|
|
416
197
|
* WebinarSection
|
|
@@ -581,52 +362,162 @@ export interface components {
|
|
|
581
362
|
*/
|
|
582
363
|
media_items?: components["schemas"]["MediaItem"][] | null;
|
|
583
364
|
};
|
|
584
|
-
Extensions: {
|
|
585
|
-
/** @example GENERIC_ERROR */
|
|
586
|
-
message_code?: string;
|
|
587
|
-
/** @example [] */
|
|
588
|
-
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
589
|
-
extra_data?: Record<string, never> | null;
|
|
590
|
-
/** @example Detailed debug information */
|
|
591
|
-
debug?: string | null;
|
|
592
|
-
};
|
|
593
365
|
/**
|
|
594
|
-
*
|
|
595
|
-
* @description
|
|
366
|
+
* ProductSection
|
|
367
|
+
* @description Base product fields (maps to product_tbl)
|
|
596
368
|
*/
|
|
597
|
-
|
|
369
|
+
ProductSection: {
|
|
598
370
|
/**
|
|
599
|
-
*
|
|
600
|
-
* @description
|
|
601
|
-
* @default
|
|
371
|
+
* Visibility
|
|
372
|
+
* @description public, private, hidden, unlisted
|
|
373
|
+
* @default public
|
|
602
374
|
*/
|
|
603
|
-
|
|
375
|
+
visibility: string;
|
|
604
376
|
/**
|
|
605
|
-
*
|
|
606
|
-
* @description
|
|
377
|
+
* Is Digital
|
|
378
|
+
* @description Digital product flag
|
|
379
|
+
* @default true
|
|
607
380
|
*/
|
|
608
|
-
|
|
381
|
+
is_digital: boolean;
|
|
609
382
|
/**
|
|
610
|
-
*
|
|
611
|
-
* @description
|
|
383
|
+
* Company Id
|
|
384
|
+
* @description Multi-company support
|
|
612
385
|
*/
|
|
613
|
-
|
|
386
|
+
company_id?: number | null;
|
|
614
387
|
/**
|
|
615
|
-
*
|
|
616
|
-
* @description
|
|
388
|
+
* Status
|
|
389
|
+
* @description draft, published, archived, review_required, deleted
|
|
390
|
+
* @default draft
|
|
617
391
|
*/
|
|
618
|
-
|
|
392
|
+
status: string;
|
|
619
393
|
/**
|
|
620
|
-
*
|
|
621
|
-
* @description
|
|
394
|
+
* Is Org Level
|
|
395
|
+
* @description Org-level vs user-created product
|
|
396
|
+
* @default true
|
|
622
397
|
*/
|
|
623
|
-
|
|
398
|
+
is_org_level: boolean;
|
|
399
|
+
/**
|
|
400
|
+
* Staff Id
|
|
401
|
+
* @description Staff/instructor delivering product
|
|
402
|
+
*/
|
|
403
|
+
staff_id?: number | null;
|
|
404
|
+
/**
|
|
405
|
+
* Owner Id
|
|
406
|
+
* @description Owner of the product
|
|
407
|
+
*/
|
|
408
|
+
owner_id?: number | null;
|
|
409
|
+
/**
|
|
410
|
+
* Featured
|
|
411
|
+
* @description Featured product flag
|
|
412
|
+
* @default false
|
|
413
|
+
*/
|
|
414
|
+
featured: boolean;
|
|
415
|
+
};
|
|
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"];
|
|
624
430
|
};
|
|
625
431
|
/**
|
|
626
|
-
*
|
|
627
|
-
* @description
|
|
432
|
+
* MediaItem
|
|
433
|
+
* @description Single media file item
|
|
628
434
|
*/
|
|
629
|
-
|
|
435
|
+
MediaItem: {
|
|
436
|
+
/**
|
|
437
|
+
* Media Type
|
|
438
|
+
* @description logo, banner, promo_video, gallery_image, gallery_video, swatch
|
|
439
|
+
*/
|
|
440
|
+
media_type: string;
|
|
441
|
+
/**
|
|
442
|
+
* File Path
|
|
443
|
+
* @description Path to media file on storage (S3, CDN, local)
|
|
444
|
+
*/
|
|
445
|
+
file_path: string;
|
|
446
|
+
/**
|
|
447
|
+
* File Name
|
|
448
|
+
* @description Original filename
|
|
449
|
+
*/
|
|
450
|
+
file_name: string;
|
|
451
|
+
/**
|
|
452
|
+
* File Size
|
|
453
|
+
* @description File size in bytes
|
|
454
|
+
*/
|
|
455
|
+
file_size?: number | null;
|
|
456
|
+
/**
|
|
457
|
+
* Mime Type
|
|
458
|
+
* @description MIME type (image/png, video/mp4, etc.)
|
|
459
|
+
*/
|
|
460
|
+
mime_type?: string | null;
|
|
461
|
+
/**
|
|
462
|
+
* Width
|
|
463
|
+
* @description Width in pixels (for images/videos)
|
|
464
|
+
*/
|
|
465
|
+
width?: number | null;
|
|
466
|
+
/**
|
|
467
|
+
* Height
|
|
468
|
+
* @description Height in pixels (for images/videos)
|
|
469
|
+
*/
|
|
470
|
+
height?: number | null;
|
|
471
|
+
/**
|
|
472
|
+
* Responsive Versions
|
|
473
|
+
* @description JSON with thumbnail, small, medium, large, xlarge, original paths
|
|
474
|
+
*/
|
|
475
|
+
responsive_versions?: {
|
|
476
|
+
[key: string]: string;
|
|
477
|
+
} | null;
|
|
478
|
+
/**
|
|
479
|
+
* Alt Text
|
|
480
|
+
* @description Alt text for SEO/accessibility
|
|
481
|
+
*/
|
|
482
|
+
alt_text?: string | null;
|
|
483
|
+
/**
|
|
484
|
+
* Locale
|
|
485
|
+
* @description Media locale (en-US, es-PR, etc.)
|
|
486
|
+
* @default en-US
|
|
487
|
+
*/
|
|
488
|
+
locale: string;
|
|
489
|
+
/**
|
|
490
|
+
* Display Order
|
|
491
|
+
* @description Display order
|
|
492
|
+
* @default 0
|
|
493
|
+
*/
|
|
494
|
+
display_order: number;
|
|
495
|
+
/**
|
|
496
|
+
* Is Primary
|
|
497
|
+
* @description Mark as primary media
|
|
498
|
+
* @default false
|
|
499
|
+
*/
|
|
500
|
+
is_primary: boolean;
|
|
501
|
+
};
|
|
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;
|
|
510
|
+
};
|
|
511
|
+
/**
|
|
512
|
+
* VariantPrice
|
|
513
|
+
* @description Variant-specific pricing (maps to product_pricings_tbl with variant_id set)
|
|
514
|
+
*/
|
|
515
|
+
VariantPrice: {
|
|
516
|
+
/**
|
|
517
|
+
* Variant Index
|
|
518
|
+
* @description Index in variants array (0-based)
|
|
519
|
+
*/
|
|
520
|
+
variant_index: number;
|
|
630
521
|
/**
|
|
631
522
|
* Price Type
|
|
632
523
|
* @description free, one_time, subscription, monthly_plan
|
|
@@ -634,7 +525,7 @@ export interface components {
|
|
|
634
525
|
price_type: string;
|
|
635
526
|
/**
|
|
636
527
|
* Currency
|
|
637
|
-
* @description Currency code
|
|
528
|
+
* @description Currency code
|
|
638
529
|
*/
|
|
639
530
|
currency: string;
|
|
640
531
|
/**
|
|
@@ -649,7 +540,7 @@ export interface components {
|
|
|
649
540
|
compare_at_amount?: number | null;
|
|
650
541
|
/**
|
|
651
542
|
* Interval
|
|
652
|
-
* @description day, week, month, year
|
|
543
|
+
* @description day, week, month, year
|
|
653
544
|
*/
|
|
654
545
|
interval?: string | null;
|
|
655
546
|
/**
|
|
@@ -680,15 +571,89 @@ export interface components {
|
|
|
680
571
|
requires_payment_method_upfront: boolean;
|
|
681
572
|
};
|
|
682
573
|
/**
|
|
683
|
-
*
|
|
684
|
-
* @description
|
|
574
|
+
* VariantItem
|
|
575
|
+
* @description Product variant (maps to product_variants_tbl)
|
|
685
576
|
*/
|
|
686
|
-
|
|
577
|
+
VariantItem: {
|
|
687
578
|
/**
|
|
688
|
-
*
|
|
689
|
-
* @description
|
|
579
|
+
* Name
|
|
580
|
+
* @description Variant display name
|
|
690
581
|
*/
|
|
691
|
-
|
|
582
|
+
name: string;
|
|
583
|
+
/**
|
|
584
|
+
* Sku
|
|
585
|
+
* @description Stock Keeping Unit
|
|
586
|
+
*/
|
|
587
|
+
sku?: string | null;
|
|
588
|
+
/**
|
|
589
|
+
* Attributes
|
|
590
|
+
* @description Custom attributes
|
|
591
|
+
*/
|
|
592
|
+
attributes?: {
|
|
593
|
+
[key: string]: unknown;
|
|
594
|
+
} | null;
|
|
595
|
+
/**
|
|
596
|
+
* Is Default
|
|
597
|
+
* @description Set as default variant
|
|
598
|
+
* @default false
|
|
599
|
+
*/
|
|
600
|
+
is_default: boolean;
|
|
601
|
+
/**
|
|
602
|
+
* Track Inventory
|
|
603
|
+
* @description Track stock for this variant
|
|
604
|
+
* @default false
|
|
605
|
+
*/
|
|
606
|
+
track_inventory: boolean;
|
|
607
|
+
/**
|
|
608
|
+
* Stock Quantity
|
|
609
|
+
* @description Initial stock
|
|
610
|
+
*/
|
|
611
|
+
stock_quantity?: number | null;
|
|
612
|
+
/**
|
|
613
|
+
* Allow Backorder
|
|
614
|
+
* @description Allow orders when out of stock
|
|
615
|
+
* @default false
|
|
616
|
+
*/
|
|
617
|
+
allow_backorder: boolean;
|
|
618
|
+
/**
|
|
619
|
+
* Weight
|
|
620
|
+
* @description Weight in kg
|
|
621
|
+
*/
|
|
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;
|
|
651
|
+
};
|
|
652
|
+
/**
|
|
653
|
+
* ProductPrice
|
|
654
|
+
* @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
|
|
655
|
+
*/
|
|
656
|
+
ProductPrice: {
|
|
692
657
|
/**
|
|
693
658
|
* Price Type
|
|
694
659
|
* @description free, one_time, subscription, monthly_plan
|
|
@@ -696,7 +661,7 @@ export interface components {
|
|
|
696
661
|
price_type: string;
|
|
697
662
|
/**
|
|
698
663
|
* Currency
|
|
699
|
-
* @description Currency code
|
|
664
|
+
* @description Currency code: INR, USD, EUR, etc.
|
|
700
665
|
*/
|
|
701
666
|
currency: string;
|
|
702
667
|
/**
|
|
@@ -711,7 +676,7 @@ export interface components {
|
|
|
711
676
|
compare_at_amount?: number | null;
|
|
712
677
|
/**
|
|
713
678
|
* Interval
|
|
714
|
-
* @description day, week, month, year
|
|
679
|
+
* @description day, week, month, year (for subscription)
|
|
715
680
|
*/
|
|
716
681
|
interval?: string | null;
|
|
717
682
|
/**
|
|
@@ -741,84 +706,119 @@ export interface components {
|
|
|
741
706
|
*/
|
|
742
707
|
requires_payment_method_upfront: boolean;
|
|
743
708
|
};
|
|
744
|
-
|
|
745
|
-
/** @example
|
|
746
|
-
|
|
747
|
-
/** @example
|
|
748
|
-
|
|
749
|
-
/** @example Client Error */
|
|
750
|
-
title?: string;
|
|
751
|
-
/** @example 400 */
|
|
752
|
-
status?: number;
|
|
753
|
-
/** @example An error occurred */
|
|
754
|
-
detail?: string;
|
|
755
|
-
/** @example /v1/cart/items */
|
|
756
|
-
instance?: string;
|
|
757
|
-
extensions?: components["schemas"]["Extensions"];
|
|
709
|
+
InvalidParam: {
|
|
710
|
+
/** @example items[0].quantity */
|
|
711
|
+
field?: string;
|
|
712
|
+
/** @example Input should be greater than or equal to 1 */
|
|
713
|
+
error?: string;
|
|
758
714
|
};
|
|
759
715
|
/**
|
|
760
|
-
*
|
|
761
|
-
* @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
|
+
* }
|
|
762
741
|
*/
|
|
763
|
-
|
|
764
|
-
/**
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
/**
|
|
771
|
-
* Is Digital
|
|
772
|
-
* @description Digital product flag
|
|
773
|
-
* @default true
|
|
774
|
-
*/
|
|
775
|
-
is_digital: boolean;
|
|
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;
|
|
776
749
|
/**
|
|
777
|
-
*
|
|
778
|
-
* @description
|
|
750
|
+
* Tags
|
|
751
|
+
* @description Tag IDs to associate with product
|
|
779
752
|
*/
|
|
780
|
-
|
|
753
|
+
tags?: number[] | null;
|
|
781
754
|
/**
|
|
782
|
-
*
|
|
783
|
-
* @description
|
|
784
|
-
* @default draft
|
|
755
|
+
* Variants
|
|
756
|
+
* @description Product variants (optional)
|
|
785
757
|
*/
|
|
786
|
-
|
|
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"];
|
|
763
|
+
};
|
|
764
|
+
/**
|
|
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
|
+
* }
|
|
779
|
+
*/
|
|
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: {
|
|
787
796
|
/**
|
|
788
|
-
*
|
|
789
|
-
* @description
|
|
790
|
-
* @default
|
|
797
|
+
* Locale
|
|
798
|
+
* @description Locale: en-US, es-PR, fr-FR, pt-BR, etc.
|
|
799
|
+
* @default en-US
|
|
791
800
|
*/
|
|
792
|
-
|
|
801
|
+
locale: string;
|
|
793
802
|
/**
|
|
794
|
-
*
|
|
795
|
-
* @description
|
|
803
|
+
* Title
|
|
804
|
+
* @description Product title
|
|
796
805
|
*/
|
|
797
|
-
|
|
806
|
+
title: string;
|
|
798
807
|
/**
|
|
799
|
-
*
|
|
800
|
-
* @description
|
|
808
|
+
* Subtitle
|
|
809
|
+
* @description Product subtitle
|
|
801
810
|
*/
|
|
802
|
-
|
|
811
|
+
subtitle?: string | null;
|
|
803
812
|
/**
|
|
804
|
-
*
|
|
805
|
-
* @description
|
|
806
|
-
* @default false
|
|
813
|
+
* Description
|
|
814
|
+
* @description Full product description
|
|
807
815
|
*/
|
|
808
|
-
|
|
809
|
-
};
|
|
810
|
-
/**
|
|
811
|
-
* PricingSection
|
|
812
|
-
* @description Pricing configuration (optional - can have product price, variant prices, or both)
|
|
813
|
-
*/
|
|
814
|
-
PricingSection: {
|
|
815
|
-
/** @description Base product price (no variant) */
|
|
816
|
-
product_price?: components["schemas"]["ProductPrice"] | null;
|
|
816
|
+
description?: string | null;
|
|
817
817
|
/**
|
|
818
|
-
*
|
|
819
|
-
* @description
|
|
818
|
+
* Short Description
|
|
819
|
+
* @description Short description for listings/previews
|
|
820
820
|
*/
|
|
821
|
-
|
|
821
|
+
short_description?: string | null;
|
|
822
822
|
};
|
|
823
823
|
};
|
|
824
824
|
responses: never;
|