@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
|
@@ -180,22 +180,84 @@ export interface paths {
|
|
|
180
180
|
export type webhooks = Record<string, never>;
|
|
181
181
|
export interface components {
|
|
182
182
|
schemas: {
|
|
183
|
-
/**
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
/**
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
183
|
+
/**
|
|
184
|
+
* VariantItem
|
|
185
|
+
* @description Product variant (maps to product_variants_tbl)
|
|
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;
|
|
199
261
|
};
|
|
200
262
|
/**
|
|
201
263
|
* WebinarCreateRequest
|
|
@@ -246,77 +308,38 @@ export interface components {
|
|
|
246
308
|
/** @description Webinar-specific configuration */
|
|
247
309
|
webinar: components["schemas"]["WebinarSection"];
|
|
248
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
|
+
};
|
|
249
317
|
/**
|
|
250
|
-
*
|
|
251
|
-
*
|
|
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
|
+
* }
|
|
252
332
|
*/
|
|
253
|
-
|
|
254
|
-
/**
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
/**
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
currency: string;
|
|
264
|
-
/**
|
|
265
|
-
* Amount
|
|
266
|
-
* @description Price amount
|
|
267
|
-
*/
|
|
268
|
-
amount: number;
|
|
269
|
-
/**
|
|
270
|
-
* Compare At Amount
|
|
271
|
-
* @description Original/strike-through price
|
|
272
|
-
*/
|
|
273
|
-
compare_at_amount?: number | null;
|
|
274
|
-
/**
|
|
275
|
-
* Interval
|
|
276
|
-
* @description day, week, month, year (for subscription)
|
|
277
|
-
*/
|
|
278
|
-
interval?: string | null;
|
|
279
|
-
/**
|
|
280
|
-
* Interval Count
|
|
281
|
-
* @description Number of intervals
|
|
282
|
-
*/
|
|
283
|
-
interval_count?: number | null;
|
|
284
|
-
/**
|
|
285
|
-
* Trial Period Days
|
|
286
|
-
* @description Free trial days
|
|
287
|
-
*/
|
|
288
|
-
trial_period_days?: number | null;
|
|
289
|
-
/**
|
|
290
|
-
* Initial Amount
|
|
291
|
-
* @description First payment amount
|
|
292
|
-
*/
|
|
293
|
-
initial_amount?: number | null;
|
|
294
|
-
/**
|
|
295
|
-
* Gateway
|
|
296
|
-
* @description stripe, razorpay, paypal, etc.
|
|
297
|
-
*/
|
|
298
|
-
gateway?: string | null;
|
|
299
|
-
/**
|
|
300
|
-
* Requires Payment Method Upfront
|
|
301
|
-
* @description Require payment method before trial
|
|
302
|
-
* @default true
|
|
303
|
-
*/
|
|
304
|
-
requires_payment_method_upfront: boolean;
|
|
305
|
-
};
|
|
306
|
-
ErrorResponse: {
|
|
307
|
-
/** @example about:blank */
|
|
308
|
-
type?: string;
|
|
309
|
-
/** @example GENERIC_ERROR */
|
|
310
|
-
code?: string;
|
|
311
|
-
/** @example Client Error */
|
|
312
|
-
title?: string;
|
|
313
|
-
/** @example 400 */
|
|
314
|
-
status?: number;
|
|
315
|
-
/** @example An error occurred */
|
|
316
|
-
detail?: string;
|
|
317
|
-
/** @example /v1/cart/items */
|
|
318
|
-
instance?: string;
|
|
319
|
-
extensions?: components["schemas"]["Extensions"];
|
|
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"];
|
|
320
343
|
};
|
|
321
344
|
/**
|
|
322
345
|
* MediaItem
|
|
@@ -389,68 +412,6 @@ export interface components {
|
|
|
389
412
|
*/
|
|
390
413
|
is_primary: boolean;
|
|
391
414
|
};
|
|
392
|
-
/**
|
|
393
|
-
* MediaSection
|
|
394
|
-
* @description Product media files - direct media data
|
|
395
|
-
*/
|
|
396
|
-
MediaSection: {
|
|
397
|
-
/**
|
|
398
|
-
* Media Items
|
|
399
|
-
* @description List of media files to attach to product
|
|
400
|
-
*/
|
|
401
|
-
media_items?: components["schemas"]["MediaItem"][] | null;
|
|
402
|
-
};
|
|
403
|
-
/**
|
|
404
|
-
* ProductSection
|
|
405
|
-
* @description Base product fields (maps to product_tbl)
|
|
406
|
-
*/
|
|
407
|
-
ProductSection: {
|
|
408
|
-
/**
|
|
409
|
-
* Visibility
|
|
410
|
-
* @description public, private, hidden, unlisted
|
|
411
|
-
* @default public
|
|
412
|
-
*/
|
|
413
|
-
visibility: string;
|
|
414
|
-
/**
|
|
415
|
-
* Is Digital
|
|
416
|
-
* @description Digital product flag
|
|
417
|
-
* @default true
|
|
418
|
-
*/
|
|
419
|
-
is_digital: boolean;
|
|
420
|
-
/**
|
|
421
|
-
* Company Id
|
|
422
|
-
* @description Multi-company support
|
|
423
|
-
*/
|
|
424
|
-
company_id?: number | null;
|
|
425
|
-
/**
|
|
426
|
-
* Status
|
|
427
|
-
* @description draft, published, archived, review_required, deleted
|
|
428
|
-
* @default draft
|
|
429
|
-
*/
|
|
430
|
-
status: string;
|
|
431
|
-
/**
|
|
432
|
-
* Is Org Level
|
|
433
|
-
* @description Org-level vs user-created product
|
|
434
|
-
* @default true
|
|
435
|
-
*/
|
|
436
|
-
is_org_level: boolean;
|
|
437
|
-
/**
|
|
438
|
-
* Staff Id
|
|
439
|
-
* @description Staff/instructor delivering product
|
|
440
|
-
*/
|
|
441
|
-
staff_id?: number | null;
|
|
442
|
-
/**
|
|
443
|
-
* Owner Id
|
|
444
|
-
* @description Owner of the product
|
|
445
|
-
*/
|
|
446
|
-
owner_id?: number | null;
|
|
447
|
-
/**
|
|
448
|
-
* Featured
|
|
449
|
-
* @description Featured product flag
|
|
450
|
-
* @default false
|
|
451
|
-
*/
|
|
452
|
-
featured: boolean;
|
|
453
|
-
};
|
|
454
415
|
/**
|
|
455
416
|
* WebinarSection
|
|
456
417
|
* @description Webinar-specific fields (maps to webinars_tbl)
|
|
@@ -592,7 +553,35 @@ export interface components {
|
|
|
592
553
|
*/
|
|
593
554
|
locale?: string | null;
|
|
594
555
|
};
|
|
595
|
-
|
|
556
|
+
/** Body_updateWebinar */
|
|
557
|
+
Body_updateWebinar: {
|
|
558
|
+
/** Starts At */
|
|
559
|
+
starts_at?: string | null;
|
|
560
|
+
/** Ends At */
|
|
561
|
+
ends_at?: string | null;
|
|
562
|
+
/** Duration Minutes */
|
|
563
|
+
duration_minutes?: number | null;
|
|
564
|
+
/** Max Attendees */
|
|
565
|
+
max_attendees?: number | null;
|
|
566
|
+
/** Status */
|
|
567
|
+
status?: string | null;
|
|
568
|
+
/** Qa Enabled */
|
|
569
|
+
qa_enabled?: boolean | null;
|
|
570
|
+
/** Polling Enabled */
|
|
571
|
+
polling_enabled?: boolean | null;
|
|
572
|
+
};
|
|
573
|
+
/**
|
|
574
|
+
* MediaSection
|
|
575
|
+
* @description Product media files - direct media data
|
|
576
|
+
*/
|
|
577
|
+
MediaSection: {
|
|
578
|
+
/**
|
|
579
|
+
* Media Items
|
|
580
|
+
* @description List of media files to attach to product
|
|
581
|
+
*/
|
|
582
|
+
media_items?: components["schemas"]["MediaItem"][] | null;
|
|
583
|
+
};
|
|
584
|
+
Extensions: {
|
|
596
585
|
/** @example GENERIC_ERROR */
|
|
597
586
|
message_code?: string;
|
|
598
587
|
/** @example [] */
|
|
@@ -602,42 +591,42 @@ export interface components {
|
|
|
602
591
|
debug?: string | null;
|
|
603
592
|
};
|
|
604
593
|
/**
|
|
605
|
-
*
|
|
606
|
-
*
|
|
607
|
-
* "message": "Operation successful",
|
|
608
|
-
* "message_code": "api_suc_20001",
|
|
609
|
-
* "data": {},
|
|
610
|
-
* "metadata": {
|
|
611
|
-
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
612
|
-
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
613
|
-
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
614
|
-
* "version": "v1",
|
|
615
|
-
* "executionTime": 42,
|
|
616
|
-
* "language": "en-US"
|
|
617
|
-
* }
|
|
618
|
-
* }
|
|
594
|
+
* IdentitySection
|
|
595
|
+
* @description Localized product content (maps to product_identity_tbl)
|
|
619
596
|
*/
|
|
620
|
-
|
|
621
|
-
/**
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
597
|
+
IdentitySection: {
|
|
598
|
+
/**
|
|
599
|
+
* Locale
|
|
600
|
+
* @description Locale: en-US, es-PR, fr-FR, pt-BR, etc.
|
|
601
|
+
* @default en-US
|
|
602
|
+
*/
|
|
603
|
+
locale: string;
|
|
604
|
+
/**
|
|
605
|
+
* Title
|
|
606
|
+
* @description Product title
|
|
607
|
+
*/
|
|
608
|
+
title: string;
|
|
609
|
+
/**
|
|
610
|
+
* Subtitle
|
|
611
|
+
* @description Product subtitle
|
|
612
|
+
*/
|
|
613
|
+
subtitle?: string | null;
|
|
614
|
+
/**
|
|
615
|
+
* Description
|
|
616
|
+
* @description Full product description
|
|
617
|
+
*/
|
|
618
|
+
description?: string | null;
|
|
619
|
+
/**
|
|
620
|
+
* Short Description
|
|
621
|
+
* @description Short description for listings/previews
|
|
622
|
+
*/
|
|
623
|
+
short_description?: string | null;
|
|
630
624
|
};
|
|
631
625
|
/**
|
|
632
|
-
*
|
|
633
|
-
* @description
|
|
626
|
+
* ProductPrice
|
|
627
|
+
* @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
|
|
634
628
|
*/
|
|
635
|
-
|
|
636
|
-
/**
|
|
637
|
-
* Variant Index
|
|
638
|
-
* @description Index in variants array (0-based)
|
|
639
|
-
*/
|
|
640
|
-
variant_index: number;
|
|
629
|
+
ProductPrice: {
|
|
641
630
|
/**
|
|
642
631
|
* Price Type
|
|
643
632
|
* @description free, one_time, subscription, monthly_plan
|
|
@@ -645,7 +634,7 @@ export interface components {
|
|
|
645
634
|
price_type: string;
|
|
646
635
|
/**
|
|
647
636
|
* Currency
|
|
648
|
-
* @description Currency code
|
|
637
|
+
* @description Currency code: INR, USD, EUR, etc.
|
|
649
638
|
*/
|
|
650
639
|
currency: string;
|
|
651
640
|
/**
|
|
@@ -660,7 +649,7 @@ export interface components {
|
|
|
660
649
|
compare_at_amount?: number | null;
|
|
661
650
|
/**
|
|
662
651
|
* Interval
|
|
663
|
-
* @description day, week, month, year
|
|
652
|
+
* @description day, week, month, year (for subscription)
|
|
664
653
|
*/
|
|
665
654
|
interval?: string | null;
|
|
666
655
|
/**
|
|
@@ -691,115 +680,132 @@ export interface components {
|
|
|
691
680
|
requires_payment_method_upfront: boolean;
|
|
692
681
|
};
|
|
693
682
|
/**
|
|
694
|
-
*
|
|
695
|
-
* @description
|
|
683
|
+
* VariantPrice
|
|
684
|
+
* @description Variant-specific pricing (maps to product_pricings_tbl with variant_id set)
|
|
696
685
|
*/
|
|
697
|
-
|
|
686
|
+
VariantPrice: {
|
|
698
687
|
/**
|
|
699
|
-
*
|
|
700
|
-
* @description
|
|
701
|
-
* @default en-US
|
|
688
|
+
* Variant Index
|
|
689
|
+
* @description Index in variants array (0-based)
|
|
702
690
|
*/
|
|
703
|
-
|
|
691
|
+
variant_index: number;
|
|
704
692
|
/**
|
|
705
|
-
*
|
|
706
|
-
* @description
|
|
693
|
+
* Price Type
|
|
694
|
+
* @description free, one_time, subscription, monthly_plan
|
|
707
695
|
*/
|
|
708
|
-
|
|
696
|
+
price_type: string;
|
|
709
697
|
/**
|
|
710
|
-
*
|
|
711
|
-
* @description
|
|
698
|
+
* Currency
|
|
699
|
+
* @description Currency code
|
|
712
700
|
*/
|
|
713
|
-
|
|
701
|
+
currency: string;
|
|
714
702
|
/**
|
|
715
|
-
*
|
|
716
|
-
* @description
|
|
703
|
+
* Amount
|
|
704
|
+
* @description Price amount
|
|
717
705
|
*/
|
|
718
|
-
|
|
706
|
+
amount: number;
|
|
719
707
|
/**
|
|
720
|
-
*
|
|
721
|
-
* @description
|
|
708
|
+
* Compare At Amount
|
|
709
|
+
* @description Original/strike-through price
|
|
722
710
|
*/
|
|
723
|
-
|
|
724
|
-
};
|
|
725
|
-
/**
|
|
726
|
-
* VariantItem
|
|
727
|
-
* @description Product variant (maps to product_variants_tbl)
|
|
728
|
-
*/
|
|
729
|
-
VariantItem: {
|
|
711
|
+
compare_at_amount?: number | null;
|
|
730
712
|
/**
|
|
731
|
-
*
|
|
732
|
-
* @description
|
|
713
|
+
* Interval
|
|
714
|
+
* @description day, week, month, year
|
|
733
715
|
*/
|
|
734
|
-
|
|
716
|
+
interval?: string | null;
|
|
735
717
|
/**
|
|
736
|
-
*
|
|
737
|
-
* @description
|
|
718
|
+
* Interval Count
|
|
719
|
+
* @description Number of intervals
|
|
738
720
|
*/
|
|
739
|
-
|
|
721
|
+
interval_count?: number | null;
|
|
740
722
|
/**
|
|
741
|
-
*
|
|
742
|
-
* @description
|
|
723
|
+
* Trial Period Days
|
|
724
|
+
* @description Free trial days
|
|
743
725
|
*/
|
|
744
|
-
|
|
745
|
-
[key: string]: unknown;
|
|
746
|
-
} | null;
|
|
726
|
+
trial_period_days?: number | null;
|
|
747
727
|
/**
|
|
748
|
-
*
|
|
749
|
-
* @description
|
|
750
|
-
* @default false
|
|
728
|
+
* Initial Amount
|
|
729
|
+
* @description First payment amount
|
|
751
730
|
*/
|
|
752
|
-
|
|
731
|
+
initial_amount?: number | null;
|
|
753
732
|
/**
|
|
754
|
-
*
|
|
755
|
-
* @description
|
|
756
|
-
* @default false
|
|
733
|
+
* Gateway
|
|
734
|
+
* @description stripe, razorpay, paypal, etc.
|
|
757
735
|
*/
|
|
758
|
-
|
|
736
|
+
gateway?: string | null;
|
|
759
737
|
/**
|
|
760
|
-
*
|
|
761
|
-
* @description
|
|
738
|
+
* Requires Payment Method Upfront
|
|
739
|
+
* @description Require payment method before trial
|
|
740
|
+
* @default true
|
|
762
741
|
*/
|
|
763
|
-
|
|
742
|
+
requires_payment_method_upfront: boolean;
|
|
743
|
+
};
|
|
744
|
+
ErrorResponse: {
|
|
745
|
+
/** @example about:blank */
|
|
746
|
+
type?: string;
|
|
747
|
+
/** @example GENERIC_ERROR */
|
|
748
|
+
code?: string;
|
|
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"];
|
|
758
|
+
};
|
|
759
|
+
/**
|
|
760
|
+
* ProductSection
|
|
761
|
+
* @description Base product fields (maps to product_tbl)
|
|
762
|
+
*/
|
|
763
|
+
ProductSection: {
|
|
764
764
|
/**
|
|
765
|
-
*
|
|
766
|
-
* @description
|
|
767
|
-
* @default
|
|
765
|
+
* Visibility
|
|
766
|
+
* @description public, private, hidden, unlisted
|
|
767
|
+
* @default public
|
|
768
768
|
*/
|
|
769
|
-
|
|
769
|
+
visibility: string;
|
|
770
770
|
/**
|
|
771
|
-
*
|
|
772
|
-
* @description
|
|
771
|
+
* Is Digital
|
|
772
|
+
* @description Digital product flag
|
|
773
|
+
* @default true
|
|
773
774
|
*/
|
|
774
|
-
|
|
775
|
+
is_digital: boolean;
|
|
775
776
|
/**
|
|
776
|
-
*
|
|
777
|
-
* @description
|
|
777
|
+
* Company Id
|
|
778
|
+
* @description Multi-company support
|
|
778
779
|
*/
|
|
779
|
-
|
|
780
|
+
company_id?: number | null;
|
|
780
781
|
/**
|
|
781
|
-
*
|
|
782
|
-
* @description
|
|
782
|
+
* Status
|
|
783
|
+
* @description draft, published, archived, review_required, deleted
|
|
784
|
+
* @default draft
|
|
783
785
|
*/
|
|
784
|
-
|
|
786
|
+
status: string;
|
|
785
787
|
/**
|
|
786
|
-
*
|
|
787
|
-
* @description
|
|
788
|
+
* Is Org Level
|
|
789
|
+
* @description Org-level vs user-created product
|
|
790
|
+
* @default true
|
|
788
791
|
*/
|
|
789
|
-
|
|
792
|
+
is_org_level: boolean;
|
|
790
793
|
/**
|
|
791
|
-
*
|
|
792
|
-
* @description
|
|
793
|
-
* @default 100
|
|
794
|
+
* Staff Id
|
|
795
|
+
* @description Staff/instructor delivering product
|
|
794
796
|
*/
|
|
795
|
-
|
|
797
|
+
staff_id?: number | null;
|
|
796
798
|
/**
|
|
797
|
-
*
|
|
798
|
-
* @description
|
|
799
|
+
* Owner Id
|
|
800
|
+
* @description Owner of the product
|
|
799
801
|
*/
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
802
|
+
owner_id?: number | null;
|
|
803
|
+
/**
|
|
804
|
+
* Featured
|
|
805
|
+
* @description Featured product flag
|
|
806
|
+
* @default false
|
|
807
|
+
*/
|
|
808
|
+
featured: boolean;
|
|
803
809
|
};
|
|
804
810
|
/**
|
|
805
811
|
* PricingSection
|
|
@@ -814,12 +820,6 @@ export interface components {
|
|
|
814
820
|
*/
|
|
815
821
|
variant_prices?: components["schemas"]["VariantPrice"][] | null;
|
|
816
822
|
};
|
|
817
|
-
InvalidParam: {
|
|
818
|
-
/** @example items[0].quantity */
|
|
819
|
-
field?: string;
|
|
820
|
-
/** @example Input should be greater than or equal to 1 */
|
|
821
|
-
error?: string;
|
|
822
|
-
};
|
|
823
823
|
};
|
|
824
824
|
responses: never;
|
|
825
825
|
parameters: never;
|